8 * Class representing a MediaWiki article and history.
10 * See design.txt for an overview.
11 * Note: edit user interface and cache support functions have been
12 * moved to separate EditPage and HTMLFileCache classes.
14 * @internal documentation reviewed 15 Mar 2010
20 var $mComment = ''; // !<
22 var $mContentLoaded = false; // !<
23 var $mCounter = -1; // !< Not loaded
24 var $mCurID = -1; // !< Not loaded
25 var $mDataLoaded = false; // !<
26 var $mForUpdate = false; // !<
27 var $mGoodAdjustment = 0; // !<
28 var $mIsRedirect = false; // !<
29 var $mLatest = false; // !<
30 var $mMinorEdit; // !<
32 var $mPreparedEdit = false; // !< Title object if set
33 var $mRedirectedFrom = null; // !< Title object if set
34 var $mRedirectTarget = null; // !< Title object if set
35 var $mRedirectUrl = false; // !<
36 var $mRevIdFetched = 0; // !<
37 var $mRevision; // !< Revision object if set
38 var $mTimestamp = ''; // !<
39 var $mTitle; // !< Title object
40 var $mTotalAdjustment = 0; // !<
41 var $mTouched = '19700101000000'; // !<
42 var $mUser = -1; // !< Not loaded
43 var $mUserText = ''; // !< username from Revision if set
44 var $mParserOptions; // !< ParserOptions object
45 var $mParserOutput; // !< ParserCache object if set
49 * Constructor and clear the article
50 * @param $title Reference to a Title object.
51 * @param $oldId Integer revision ID, null to fetch from request, zero for current
53 public function __construct( Title
$title, $oldId = null ) {
54 // FIXME: does the reference play any role here?
55 $this->mTitle
=& $title;
56 $this->mOldId
= $oldId;
60 * Constructor from an page id
61 * @param $id The article ID to load
63 public static function newFromID( $id ) {
64 $t = Title
::newFromID( $id );
65 # FIXME: doesn't inherit right
66 return $t == null ?
null : new self( $t );
67 # return $t == null ? null : new static( $t ); // PHP 5.3
71 * Tell the page view functions that this view was redirected
72 * from another page on the wiki.
73 * @param $from Title object.
75 public function setRedirectedFrom( Title
$from ) {
76 $this->mRedirectedFrom
= $from;
80 * If this page is a redirect, get its target
82 * The target will be fetched from the redirect table if possible.
83 * If this page doesn't have an entry there, call insertRedirect()
84 * @return mixed Title object, or null if this page is not a redirect
86 public function getRedirectTarget() {
87 if ( !$this->mTitle
->isRedirect() ) {
91 if ( $this->mRedirectTarget
!== null ) {
92 return $this->mRedirectTarget
;
95 # Query the redirect table
96 $dbr = wfGetDB( DB_SLAVE
);
97 $row = $dbr->selectRow( 'redirect',
98 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
99 array( 'rd_from' => $this->getID() ),
103 // rd_fragment and rd_interwiki were added later, populate them if empty
104 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
105 return $this->mRedirectTarget
= Title
::makeTitle(
106 $row->rd_namespace
, $row->rd_title
,
107 $row->rd_fragment
, $row->rd_interwiki
);
110 # This page doesn't have an entry in the redirect table
111 return $this->mRedirectTarget
= $this->insertRedirect();
115 * Insert an entry for this page into the redirect table.
117 * Don't call this function directly unless you know what you're doing.
118 * @return Title object or null if not a redirect
120 public function insertRedirect() {
121 // recurse through to only get the final target
122 $retval = Title
::newFromRedirectRecurse( $this->getContent() );
126 $this->insertRedirectEntry( $retval );
131 * Insert or update the redirect table entry for this page to indicate
132 * it redirects to $rt .
133 * @param $rt Title redirect target
135 public function insertRedirectEntry( $rt ) {
136 $dbw = wfGetDB( DB_MASTER
);
137 $dbw->replace( 'redirect', array( 'rd_from' ),
139 'rd_from' => $this->getID(),
140 'rd_namespace' => $rt->getNamespace(),
141 'rd_title' => $rt->getDBkey(),
142 'rd_fragment' => $rt->getFragment(),
143 'rd_interwiki' => $rt->getInterwiki(),
150 * Get the Title object or URL this page redirects to
152 * @return mixed false, Title of in-wiki target, or string with URL
154 public function followRedirect() {
155 return $this->getRedirectURL( $this->getRedirectTarget() );
159 * Get the Title object this text redirects to
161 * @param $text string article content containing redirect info
162 * @return mixed false, Title of in-wiki target, or string with URL
165 public function followRedirectText( $text ) {
166 // recurse through to only get the final target
167 return $this->getRedirectURL( Title
::newFromRedirectRecurse( $text ) );
171 * Get the Title object or URL to use for a redirect. We use Title
172 * objects for same-wiki, non-special redirects and URLs for everything
174 * @param $rt Title Redirect target
175 * @return mixed false, Title object of local target, or string with URL
177 public function getRedirectURL( $rt ) {
179 if ( $rt->getInterwiki() != '' ) {
180 if ( $rt->isLocal() ) {
181 // Offsite wikis need an HTTP redirect.
183 // This can be hard to reverse and may produce loops,
184 // so they may be disabled in the site configuration.
185 $source = $this->mTitle
->getFullURL( 'redirect=no' );
186 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
189 if ( $rt->getNamespace() == NS_SPECIAL
) {
190 // Gotta handle redirects to special pages differently:
191 // Fill the HTTP response "Location" header and ignore
192 // the rest of the page we're on.
194 // This can be hard to reverse, so they may be disabled.
195 if ( $rt->isSpecial( 'Userlogout' ) ) {
198 return $rt->getFullURL();
206 // No or invalid redirect
211 * Get the title object of the article
212 * @return Title object of this page
214 public function getTitle() {
215 return $this->mTitle
;
220 * FIXME: shouldn't this be public?
223 public function clear() {
224 $this->mDataLoaded
= false;
225 $this->mContentLoaded
= false;
227 $this->mCurID
= $this->mUser
= $this->mCounter
= -1; # Not loaded
228 $this->mRedirectedFrom
= null; # Title object if set
229 $this->mRedirectTarget
= null; # Title object if set
231 $this->mTimestamp
= $this->mComment
= '';
232 $this->mGoodAdjustment
= $this->mTotalAdjustment
= 0;
233 $this->mTouched
= '19700101000000';
234 $this->mForUpdate
= false;
235 $this->mIsRedirect
= false;
236 $this->mRevIdFetched
= 0;
237 $this->mRedirectUrl
= false;
238 $this->mLatest
= false;
239 $this->mPreparedEdit
= false;
243 * Note that getContent/loadContent do not follow redirects anymore.
244 * If you need to fetch redirectable content easily, try
245 * the shortcut in Article::followRedirect()
247 * This function has side effects! Do not use this function if you
248 * only want the real revision text if any.
250 * @return Return the text of this revision
252 public function getContent() {
253 global $wgUser, $wgContLang, $wgMessageCache;
255 wfProfileIn( __METHOD__
);
257 if ( $this->getID() === 0 ) {
258 # If this is a MediaWiki:x message, then load the messages
259 # and return the message value for x.
260 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
261 # If this is a system message, get the default text.
262 list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle
->getText() ) );
263 $text = wfMsgGetKey( $message, false, $lang, false );
265 if ( wfEmptyMsg( $message, $text ) )
268 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
270 wfProfileOut( __METHOD__
);
274 $this->loadContent();
275 wfProfileOut( __METHOD__
);
277 return $this->mContent
;
282 * Get the text of the current revision. No side-effects...
284 * @return Return the text of the current revision
286 public function getRawText() {
287 // Check process cache for current revision
288 if ( $this->mContentLoaded
&& $this->mOldId
== 0 ) {
289 return $this->mContent
;
292 $rev = Revision
::newFromTitle( $this->mTitle
);
293 $text = $rev ?
$rev->getRawText() : false;
299 * This function returns the text of a section, specified by a number ($section).
300 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
301 * the first section before any such heading (section 0).
303 * If a section contains subsections, these are also returned.
305 * @param $text String: text to look in
306 * @param $section Integer: section number
307 * @return string text of the requested section
310 public function getSection( $text, $section ) {
312 return $wgParser->getSection( $text, $section );
316 * Get the text that needs to be saved in order to undo all revisions
317 * between $undo and $undoafter. Revisions must belong to the same page,
318 * must exist and must not be deleted
319 * @param $undo Revision
320 * @param $undoafter Revision Must be an earlier revision than $undo
321 * @return mixed string on success, false on failure
323 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
324 $undo_text = $undo->getText();
325 $undoafter_text = $undoafter->getText();
326 $cur_text = $this->getContent();
328 if ( $cur_text == $undo_text ) {
329 # No use doing a merge if it's just a straight revert.
330 return $undoafter_text;
335 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
343 * @return int The oldid of the article that is to be shown, 0 for the
346 public function getOldID() {
347 if ( is_null( $this->mOldId
) ) {
348 $this->mOldId
= $this->getOldIDFromRequest();
351 return $this->mOldId
;
355 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
357 * @return int The old id for the request
359 public function getOldIDFromRequest() {
362 $this->mRedirectUrl
= false;
364 $oldid = $wgRequest->getVal( 'oldid' );
366 if ( isset( $oldid ) ) {
367 $oldid = intval( $oldid );
368 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
369 $nextid = $this->mTitle
->getNextRevisionID( $oldid );
373 $this->mRedirectUrl
= $this->mTitle
->getFullURL( 'redirect=no' );
375 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
376 $previd = $this->mTitle
->getPreviousRevisionID( $oldid );
391 * Load the revision (including text) into this object
393 function loadContent() {
394 if ( $this->mContentLoaded
) {
398 wfProfileIn( __METHOD__
);
400 $oldid = $this->getOldID();
401 $this->mOldId
= $oldid;
402 $this->fetchContent( $oldid );
404 wfProfileOut( __METHOD__
);
408 * Fetch a page record with the given conditions
409 * @param $dbr Database object
410 * @param $conditions Array
411 * @return mixed Database result resource, or false on failure
413 protected function pageData( $dbr, $conditions ) {
428 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
430 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
);
432 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
438 * Fetch a page record matching the Title object's namespace and title
439 * using a sanitized title string
441 * @param $dbr Database object
442 * @param $title Title object
443 * @return mixed Database result resource, or false on failure
445 public function pageDataFromTitle( $dbr, $title ) {
446 return $this->pageData( $dbr, array(
447 'page_namespace' => $title->getNamespace(),
448 'page_title' => $title->getDBkey() ) );
452 * Fetch a page record matching the requested ID
454 * @param $dbr Database
457 protected function pageDataFromId( $dbr, $id ) {
458 return $this->pageData( $dbr, array( 'page_id' => $id ) );
462 * Set the general counter, title etc data loaded from
465 * @param $data Database row object or "fromdb"
467 public function loadPageData( $data = 'fromdb' ) {
468 if ( $data === 'fromdb' ) {
469 $dbr = wfGetDB( DB_MASTER
);
470 $data = $this->pageDataFromId( $dbr, $this->getId() );
473 $lc = LinkCache
::singleton();
476 $lc->addGoodLinkObj( $data->page_id
, $this->mTitle
, $data->page_len
, $data->page_is_redirect
, $data->page_latest
);
478 $this->mTitle
->mArticleID
= intval( $data->page_id
);
480 # Old-fashioned restrictions
481 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
483 $this->mCounter
= intval( $data->page_counter
);
484 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
485 $this->mIsRedirect
= intval( $data->page_is_redirect
);
486 $this->mLatest
= intval( $data->page_latest
);
488 $lc->addBadLinkObj( $this->mTitle
);
489 $this->mTitle
->mArticleID
= 0;
492 $this->mDataLoaded
= true;
496 * Get text of an article from database
497 * Does *NOT* follow redirects.
499 * @param $oldid Int: 0 for whatever the latest revision is
500 * @return mixed string containing article contents, or false if null
502 function fetchContent( $oldid = 0 ) {
503 if ( $this->mContentLoaded
) {
504 return $this->mContent
;
507 $dbr = wfGetDB( DB_MASTER
);
509 # Pre-fill content with error message so that if something
510 # fails we'll have something telling us what we intended.
511 $t = $this->mTitle
->getPrefixedText();
512 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
513 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
516 $revision = Revision
::newFromId( $oldid );
517 if ( $revision === null ) {
518 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
522 $data = $this->pageDataFromId( $dbr, $revision->getPage() );
525 wfDebug( __METHOD__
. " failed to get page data linked to revision id $oldid\n" );
529 $this->mTitle
= Title
::makeTitle( $data->page_namespace
, $data->page_title
);
530 $this->loadPageData( $data );
532 if ( !$this->mDataLoaded
) {
533 $data = $this->pageDataFromTitle( $dbr, $this->mTitle
);
536 wfDebug( __METHOD__
. " failed to find page data for title " . $this->mTitle
->getPrefixedText() . "\n" );
540 $this->loadPageData( $data );
542 $revision = Revision
::newFromId( $this->mLatest
);
543 if ( $revision === null ) {
544 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id {$this->mLatest}\n" );
549 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
550 // We should instead work with the Revision object when we need it...
551 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
553 $this->mUser
= $revision->getUser();
554 $this->mUserText
= $revision->getUserText();
555 $this->mComment
= $revision->getComment();
556 $this->mTimestamp
= wfTimestamp( TS_MW
, $revision->getTimestamp() );
558 $this->mRevIdFetched
= $revision->getId();
559 $this->mContentLoaded
= true;
560 $this->mRevision
=& $revision;
562 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) );
564 return $this->mContent
;
568 * Read/write accessor to select FOR UPDATE
570 * @param $x Mixed: FIXME
571 * @return mixed value of $x, or value stored in Article::mForUpdate
573 public function forUpdate( $x = null ) {
574 return wfSetVar( $this->mForUpdate
, $x );
578 * Get options for all SELECT statements
580 * @param $options Array: an optional options array which'll be appended to
582 * @return Array: options
584 protected function getSelectOptions( $options = '' ) {
585 if ( $this->mForUpdate
) {
586 if ( is_array( $options ) ) {
587 $options[] = 'FOR UPDATE';
589 $options = 'FOR UPDATE';
597 * @return int Page ID
599 public function getID() {
600 return $this->mTitle
->getArticleID();
604 * @return bool Whether or not the page exists in the database
606 public function exists() {
607 return $this->getId() > 0;
611 * Check if this page is something we're going to be showing
612 * some sort of sensible content for. If we return false, page
613 * views (plain action=view) will return an HTTP 404 response,
614 * so spiders and robots can know they're following a bad link.
618 public function hasViewableContent() {
619 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
623 * @return int The view count for the page
625 public function getCount() {
626 if ( -1 == $this->mCounter
) {
627 $id = $this->getID();
632 $dbr = wfGetDB( DB_SLAVE
);
633 $this->mCounter
= $dbr->selectField( 'page',
635 array( 'page_id' => $id ),
637 $this->getSelectOptions()
642 return $this->mCounter
;
646 * Determine whether a page would be suitable for being counted as an
647 * article in the site_stats table based on the title & its content
649 * @param $text String: text to analyze
652 public function isCountable( $text ) {
653 global $wgUseCommaCount;
655 $token = $wgUseCommaCount ?
',' : '[[';
657 return $this->mTitle
->isContentPage() && !$this->isRedirect( $text ) && in_string( $token, $text );
661 * Tests if the article text represents a redirect
663 * @param $text mixed string containing article contents, or boolean
666 public function isRedirect( $text = false ) {
667 if ( $text === false ) {
668 if ( $this->mDataLoaded
) {
669 return $this->mIsRedirect
;
672 // Apparently loadPageData was never called
673 $this->loadContent();
674 $titleObj = Title
::newFromRedirectRecurse( $this->fetchContent() );
676 $titleObj = Title
::newFromRedirect( $text );
679 return $titleObj !== null;
683 * Returns true if the currently-referenced revision is the current edit
684 * to this page (and it exists).
687 public function isCurrent() {
688 # If no oldid, this is the current version.
689 if ( $this->getOldID() == 0 ) {
693 return $this->exists() && isset( $this->mRevision
) && $this->mRevision
->isCurrent();
697 * Loads everything except the text
698 * This isn't necessary for all uses, so it's only done if needed.
700 protected function loadLastEdit() {
701 if ( -1 != $this->mUser
) {
705 # New or non-existent articles have no user information
706 $id = $this->getID();
711 $this->mLastRevision
= Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $id );
712 if ( !is_null( $this->mLastRevision
) ) {
713 $this->mUser
= $this->mLastRevision
->getUser();
714 $this->mUserText
= $this->mLastRevision
->getUserText();
715 $this->mTimestamp
= $this->mLastRevision
->getTimestamp();
716 $this->mComment
= $this->mLastRevision
->getComment();
717 $this->mMinorEdit
= $this->mLastRevision
->isMinor();
718 $this->mRevIdFetched
= $this->mLastRevision
->getId();
723 * @return string GMT timestamp of last article revision
726 public function getTimestamp() {
727 // Check if the field has been filled by ParserCache::get()
728 if ( !$this->mTimestamp
) {
729 $this->loadLastEdit();
732 return wfTimestamp( TS_MW
, $this->mTimestamp
);
736 * @return int user ID for the user that made the last article revision
738 public function getUser() {
739 $this->loadLastEdit();
744 * @return string username of the user that made the last article revision
746 public function getUserText() {
747 $this->loadLastEdit();
748 return $this->mUserText
;
752 * @return string Comment stored for the last article revision
754 public function getComment() {
755 $this->loadLastEdit();
756 return $this->mComment
;
760 * Returns true if last revision was marked as "minor edit"
762 * @return boolean Minor edit indicator for the last article revision.
764 public function getMinorEdit() {
765 $this->loadLastEdit();
766 return $this->mMinorEdit
;
770 * Use this to fetch the rev ID used on page views
772 * @return int revision ID of last article revision
774 public function getRevIdFetched() {
775 $this->loadLastEdit();
776 return $this->mRevIdFetched
;
780 * FIXME: this does what?
781 * @param $limit Integer: default 0.
782 * @param $offset Integer: default 0.
783 * @return UserArrayFromResult object with User objects of article contributors for requested range
785 public function getContributors( $limit = 0, $offset = 0 ) {
786 # FIXME: this is expensive; cache this info somewhere.
788 $dbr = wfGetDB( DB_SLAVE
);
789 $revTable = $dbr->tableName( 'revision' );
790 $userTable = $dbr->tableName( 'user' );
792 $pageId = $this->getId();
794 $user = $this->getUser();
797 $excludeCond = "AND rev_user != $user";
799 $userText = $dbr->addQuotes( $this->getUserText() );
800 $excludeCond = "AND rev_user_text != $userText";
803 $deletedBit = $dbr->bitAnd( 'rev_deleted', Revision
::DELETED_USER
); // username hidden?
805 $sql = "SELECT {$userTable}.*, rev_user_text as user_name, MAX(rev_timestamp) as timestamp
806 FROM $revTable LEFT JOIN $userTable ON rev_user = user_id
807 WHERE rev_page = $pageId
810 GROUP BY rev_user, rev_user_text
811 ORDER BY timestamp DESC";
814 $sql = $dbr->limitResult( $sql, $limit, $offset );
817 $sql .= ' ' . $this->getSelectOptions();
818 $res = $dbr->query( $sql, __METHOD__
);
820 return new UserArrayFromResult( $res );
824 * This is the default action of the index.php entry point: just view the
825 * page of the given title.
827 public function view() {
828 global $wgUser, $wgOut, $wgRequest, $wgParser;
829 global $wgUseFileCache, $wgUseETag;
831 wfProfileIn( __METHOD__
);
833 # Get variables from query string
834 $oldid = $this->getOldID();
835 $parserCache = ParserCache
::singleton();
837 $parserOptions = clone $this->getParserOptions();
838 # Render printable version, use printable version cache
839 if ( $wgOut->isPrintable() ) {
840 $parserOptions->setIsPrintable( true );
841 $parserOptions->setEditSection( false );
842 } else if ( $wgUseETag && !$this->mTitle
->quickUserCan( 'edit' ) ) {
843 $parserOptions->setEditSection( false );
846 # Try client and file cache
847 if ( $oldid === 0 && $this->checkTouched() ) {
849 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
852 # Is is client cached?
853 if ( $wgOut->checkLastModified( $this->getTouched() ) ) {
854 wfDebug( __METHOD__
. ": done 304\n" );
855 wfProfileOut( __METHOD__
);
859 } else if ( $wgUseFileCache && $this->tryFileCache() ) {
860 wfDebug( __METHOD__
. ": done file cache\n" );
861 # tell wgOut that output is taken care of
863 $this->viewUpdates();
864 wfProfileOut( __METHOD__
);
870 # getOldID may want us to redirect somewhere else
871 if ( $this->mRedirectUrl
) {
872 $wgOut->redirect( $this->mRedirectUrl
);
873 wfDebug( __METHOD__
. ": redirecting due to oldid\n" );
874 wfProfileOut( __METHOD__
);
879 $wgOut->setArticleFlag( true );
880 # Set page title (may be overridden by DISPLAYTITLE)
881 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
883 # If we got diff in the query, we want to see a diff page instead of the article.
884 if ( $wgRequest->getCheck( 'diff' ) ) {
885 wfDebug( __METHOD__
. ": showing diff page\n" );
886 $this->showDiffPage();
887 wfProfileOut( __METHOD__
);
892 if ( !$wgUseETag && !$this->mTitle
->quickUserCan( 'edit' ) ) {
893 $parserOptions->setEditSection( false );
896 # Should the parser cache be used?
897 $useParserCache = $this->useParserCache( $oldid );
898 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
899 if ( $wgUser->getStubThreshold() ) {
900 wfIncrStats( 'pcache_miss_stub' );
903 $wasRedirected = $this->showRedirectedFromHeader();
904 $this->showNamespaceHeader();
906 # Iterate through the possible ways of constructing the output text.
907 # Keep going until $outputDone is set, or we run out of things to do.
910 $this->mParserOutput
= false;
912 while ( !$outputDone && ++
$pass ) {
915 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
918 # Try the parser cache
919 if ( $useParserCache ) {
920 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
922 if ( $this->mParserOutput
!== false ) {
923 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
924 $wgOut->addParserOutput( $this->mParserOutput
);
925 # Ensure that UI elements requiring revision ID have
926 # the correct version information.
927 $wgOut->setRevisionId( $this->mLatest
);
933 $text = $this->getContent();
934 if ( $text === false ||
$this->getID() == 0 ) {
935 wfDebug( __METHOD__
. ": showing missing article\n" );
936 $this->showMissingArticle();
937 wfProfileOut( __METHOD__
);
941 # Another whitelist check in case oldid is altering the title
942 if ( !$this->mTitle
->userCanRead() ) {
943 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
944 $wgOut->loginToUse();
947 wfProfileOut( __METHOD__
);
951 # Are we looking at an old revision
952 if ( $oldid && !is_null( $this->mRevision
) ) {
953 $this->setOldSubtitle( $oldid );
955 if ( !$this->showDeletedRevisionHeader() ) {
956 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
957 wfProfileOut( __METHOD__
);
961 # If this "old" version is the current, then try the parser cache...
962 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
963 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
964 if ( $this->mParserOutput
) {
965 wfDebug( __METHOD__
. ": showing parser cache for current rev permalink\n" );
966 $wgOut->addParserOutput( $this->mParserOutput
);
967 $wgOut->setRevisionId( $this->mLatest
);
968 $this->showViewFooter();
969 $this->viewUpdates();
970 wfProfileOut( __METHOD__
);
976 # Ensure that UI elements requiring revision ID have
977 # the correct version information.
978 $wgOut->setRevisionId( $this->getRevIdFetched() );
980 # Pages containing custom CSS or JavaScript get special treatment
981 if ( $this->mTitle
->isCssOrJsPage() ||
$this->mTitle
->isCssJsSubpage() ) {
982 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
983 $this->showCssOrJsPage();
985 } else if ( $rt = Title
::newFromRedirectArray( $text ) ) {
986 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
987 # Viewing a redirect page (e.g. with parameter redirect=no)
988 # Don't append the subtitle if this was an old revision
989 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
990 # Parse just to get categories, displaytitle, etc.
991 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
, $parserOptions );
992 $wgOut->addParserOutputNoText( $this->mParserOutput
);
997 # Run the parse, protected by a pool counter
998 wfDebug( __METHOD__
. ": doing uncached parse\n" );
999 $key = $parserCache->getKey( $this, $parserOptions );
1000 $poolCounter = PoolCounter
::factory( 'Article::view', $key );
1001 $dirtyCallback = $useParserCache ?
array( $this, 'tryDirtyCache' ) : false;
1002 $status = $poolCounter->executeProtected( array( $this, 'doViewParse' ), $dirtyCallback );
1004 if ( !$status->isOK() ) {
1005 # Connection or timeout error
1006 $this->showPoolError( $status );
1007 wfProfileOut( __METHOD__
);
1013 # Should be unreachable, but just in case...
1019 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
1020 if ( $this->mParserOutput
) {
1021 $titleText = $this->mParserOutput
->getTitleText();
1023 if ( strval( $titleText ) !== '' ) {
1024 $wgOut->setPageTitle( $titleText );
1028 # For the main page, overwrite the <title> element with the con-
1029 # tents of 'pagetitle-view-mainpage' instead of the default (if
1030 # that's not empty).
1031 # This message always exists because it is in the i18n files
1032 if ( $this->mTitle
->equals( Title
::newMainPage() )
1033 && ( $m = wfMsgForContent( 'pagetitle-view-mainpage' ) ) !== '' )
1035 $wgOut->setHTMLTitle( $m );
1038 # Now that we've filled $this->mParserOutput, we know whether
1039 # there are any __NOINDEX__ tags on the page
1040 $policy = $this->getRobotPolicy( 'view' );
1041 $wgOut->setIndexPolicy( $policy['index'] );
1042 $wgOut->setFollowPolicy( $policy['follow'] );
1044 $this->showViewFooter();
1045 $this->viewUpdates();
1046 wfProfileOut( __METHOD__
);
1050 * Show a diff page according to current request variables. For use within
1051 * Article::view() only, other callers should use the DifferenceEngine class.
1053 public function showDiffPage() {
1054 global $wgRequest, $wgUser;
1056 $diff = $wgRequest->getVal( 'diff' );
1057 $rcid = $wgRequest->getVal( 'rcid' );
1058 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
1059 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1060 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1061 $oldid = $this->getOldID();
1063 $de = new DifferenceEngine( $this->mTitle
, $oldid, $diff, $rcid, $purge, $unhide );
1064 // DifferenceEngine directly fetched the revision:
1065 $this->mRevIdFetched
= $de->mNewid
;
1066 $de->showDiffPage( $diffOnly );
1068 // Needed to get the page's current revision
1069 $this->loadPageData();
1070 if ( $diff == 0 ||
$diff == $this->mLatest
) {
1071 # Run view updates for current revision only
1072 $this->viewUpdates();
1077 * Show a page view for a page formatted as CSS or JavaScript. To be called by
1078 * Article::view() only.
1080 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
1083 protected function showCssOrJsPage() {
1086 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache'>\n$1\n</div>", 'clearyourcache' );
1088 // Give hooks a chance to customise the output
1089 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->mTitle
, $wgOut ) ) ) {
1090 // Wrap the whole lot in a <pre> and don't parse
1092 preg_match( '!\.(css|js)$!u', $this->mTitle
->getText(), $m );
1093 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
1094 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
1095 $wgOut->addHTML( "\n</pre>\n" );
1100 * Get the robot policy to be used for the current view
1101 * @param $action String the action= GET parameter
1102 * @return Array the policy that should be set
1103 * TODO: actions other than 'view'
1105 public function getRobotPolicy( $action ) {
1106 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1107 global $wgDefaultRobotPolicy, $wgRequest;
1109 $ns = $this->mTitle
->getNamespace();
1111 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
1112 # Don't index user and user talk pages for blocked users (bug 11443)
1113 if ( !$this->mTitle
->isSubpage() ) {
1114 $block = new Block();
1115 if ( $block->load( $this->mTitle
->getText() ) ) {
1117 'index' => 'noindex',
1118 'follow' => 'nofollow'
1124 if ( $this->getID() === 0 ||
$this->getOldID() ) {
1125 # Non-articles (special pages etc), and old revisions
1127 'index' => 'noindex',
1128 'follow' => 'nofollow'
1130 } elseif ( $wgOut->isPrintable() ) {
1131 # Discourage indexing of printable versions, but encourage following
1133 'index' => 'noindex',
1134 'follow' => 'follow'
1136 } elseif ( $wgRequest->getInt( 'curid' ) ) {
1137 # For ?curid=x urls, disallow indexing
1139 'index' => 'noindex',
1140 'follow' => 'follow'
1144 # Otherwise, construct the policy based on the various config variables.
1145 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
1147 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
1148 # Honour customised robot policies for this namespace
1149 $policy = array_merge(
1151 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
1154 if ( $this->mTitle
->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ) {
1155 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1156 # a final sanity check that we have really got the parser output.
1157 $policy = array_merge(
1159 array( 'index' => $this->mParserOutput
->getIndexPolicy() )
1163 if ( isset( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) ) {
1164 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1165 $policy = array_merge(
1167 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] )
1175 * Converts a String robot policy into an associative array, to allow
1176 * merging of several policies using array_merge().
1177 * @param $policy Mixed, returns empty array on null/false/'', transparent
1178 * to already-converted arrays, converts String.
1179 * @return associative Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1181 public static function formatRobotPolicy( $policy ) {
1182 if ( is_array( $policy ) ) {
1184 } elseif ( !$policy ) {
1188 $policy = explode( ',', $policy );
1189 $policy = array_map( 'trim', $policy );
1192 foreach ( $policy as $var ) {
1193 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
1194 $arr['index'] = $var;
1195 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
1196 $arr['follow'] = $var;
1204 * If this request is a redirect view, send "redirected from" subtitle to
1205 * $wgOut. Returns true if the header was needed, false if this is not a
1206 * redirect view. Handles both local and remote redirects.
1210 public function showRedirectedFromHeader() {
1211 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1213 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1214 $sk = $wgUser->getSkin();
1216 if ( isset( $this->mRedirectedFrom
) ) {
1217 // This is an internally redirected page view.
1218 // We'll need a backlink to the source page for navigation.
1219 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1221 $this->mRedirectedFrom
,
1224 array( 'redirect' => 'no' ),
1225 array( 'known', 'noclasses' )
1228 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1229 $wgOut->setSubtitle( $s );
1231 // Set the fragment if one was specified in the redirect
1232 if ( strval( $this->mTitle
->getFragment() ) != '' ) {
1233 $fragment = Xml
::escapeJsString( $this->mTitle
->getFragmentForURL() );
1234 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1237 // Add a <link rel="canonical"> tag
1238 $wgOut->addLink( array( 'rel' => 'canonical',
1239 'href' => $this->mTitle
->getLocalURL() )
1244 } elseif ( $rdfrom ) {
1245 // This is an externally redirected view, from some other wiki.
1246 // If it was reported from a trusted site, supply a backlink.
1247 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1248 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1249 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1250 $wgOut->setSubtitle( $s );
1260 * Show a header specific to the namespace currently being viewed, like
1261 * [[MediaWiki:Talkpagetext]]. For Article::view().
1263 public function showNamespaceHeader() {
1266 if ( $this->mTitle
->isTalkPage() ) {
1267 $msg = wfMsgNoTrans( 'talkpageheader' );
1268 if ( $msg !== '-' && !wfEmptyMsg( 'talkpageheader', $msg ) ) {
1269 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1275 * Show the footer section of an ordinary page view
1277 public function showViewFooter() {
1278 global $wgOut, $wgUseTrackbacks;
1280 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1281 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->mTitle
->getText() ) ) {
1282 $wgOut->addWikiMsg( 'anontalkpagetext' );
1285 # If we have been passed an &rcid= parameter, we want to give the user a
1286 # chance to mark this new article as patrolled.
1287 $this->showPatrolFooter();
1290 if ( $wgUseTrackbacks ) {
1291 $this->addTrackbacks();
1296 * If patrol is possible, output a patrol UI box. This is called from the
1297 * footer section of ordinary page views. If patrol is not possible or not
1298 * desired, does nothing.
1300 public function showPatrolFooter() {
1301 global $wgOut, $wgRequest, $wgUser;
1303 $rcid = $wgRequest->getVal( 'rcid' );
1305 if ( !$rcid ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1309 $sk = $wgUser->getSkin();
1310 $token = $wgUser->editToken();
1313 "<div class='patrollink'>" .
1315 'markaspatrolledlink',
1318 wfMsgHtml( 'markaspatrolledtext' ),
1321 'action' => 'markpatrolled',
1325 array( 'known', 'noclasses' )
1333 * Show the error text for a missing article. For articles in the MediaWiki
1334 * namespace, show the default message text. To be called from Article::view().
1336 public function showMissingArticle() {
1337 global $wgOut, $wgRequest, $wgUser;
1339 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1340 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1341 $parts = explode( '/', $this->mTitle
->getText() );
1342 $rootPart = $parts[0];
1343 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1344 $ip = User
::isIP( $rootPart );
1346 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1347 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1348 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1349 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1350 LogEventsList
::showLogExtract(
1353 $user->getUserPage()->getPrefixedText(),
1357 'showIfEmpty' => false,
1359 'blocked-notice-logextract',
1360 $user->getName() # Support GENDER in notice
1367 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1369 # Show delete and move logs
1370 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1372 'conds' => array( "log_action != 'revision'" ),
1373 'showIfEmpty' => false,
1374 'msgKey' => array( 'moveddeleted-notice' ) )
1377 # Show error message
1378 $oldid = $this->getOldID();
1380 $text = wfMsgNoTrans( 'missing-article',
1381 $this->mTitle
->getPrefixedText(),
1382 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1383 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1384 // Use the default message text
1385 $text = $this->getContent();
1387 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1388 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1389 $errors = array_merge( $createErrors, $editErrors );
1391 if ( !count( $errors ) ) {
1392 $text = wfMsgNoTrans( 'noarticletext' );
1394 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1397 $text = "<div class='noarticletext'>\n$text\n</div>";
1399 if ( !$this->hasViewableContent() ) {
1400 // If there's no backing content, send a 404 Not Found
1401 // for better machine handling of broken links.
1402 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1405 $wgOut->addWikiText( $text );
1409 * If the revision requested for view is deleted, check permissions.
1410 * Send either an error message or a warning header to $wgOut.
1412 * @return boolean true if the view is allowed, false if not.
1414 public function showDeletedRevisionHeader() {
1415 global $wgOut, $wgRequest;
1417 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1422 // If the user is not allowed to see it...
1423 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
1424 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1425 'rev-deleted-text-permission' );
1428 // If the user needs to confirm that they want to see it...
1429 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1430 # Give explanation and add a link to view the revision...
1431 $oldid = intval( $this->getOldID() );
1432 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1433 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1434 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1435 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1436 array( $msg, $link ) );
1439 // We are allowed to see...
1441 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1442 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1443 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1450 * Should the parser cache be used?
1454 public function useParserCache( $oldid ) {
1455 global $wgUser, $wgEnableParserCache;
1457 return $wgEnableParserCache
1458 && $wgUser->getStubThreshold() == 0
1461 && !$this->mTitle
->isCssOrJsPage()
1462 && !$this->mTitle
->isCssJsSubpage();
1466 * Execute the uncached parse for action=view
1468 public function doViewParse() {
1471 $oldid = $this->getOldID();
1472 $useParserCache = $this->useParserCache( $oldid );
1473 $parserOptions = clone $this->getParserOptions();
1475 # Render printable version, use printable version cache
1476 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1478 # Don't show section-edit links on old revisions... this way lies madness.
1479 if ( !$this->isCurrent() ||
$wgOut->isPrintable() ) {
1480 $parserOptions->setEditSection( false );
1483 $useParserCache = $this->useParserCache( $oldid );
1484 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1488 * Try to fetch an expired entry from the parser cache. If it is present,
1489 * output it and return true. If it is not present, output nothing and
1490 * return false. This is used as a callback function for
1491 * PoolCounter::executeProtected().
1495 public function tryDirtyCache() {
1498 $parserCache = ParserCache
::singleton();
1499 $options = $this->getParserOptions();
1501 if ( $wgOut->isPrintable() ) {
1502 $options->setIsPrintable( true );
1503 $parserOptions->setEditSection( false );
1506 $output = $parserCache->getDirty( $this, $options );
1509 wfDebug( __METHOD__
. ": sending dirty output\n" );
1510 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1511 $wgOut->setSquidMaxage( 0 );
1512 $this->mParserOutput
= $output;
1513 $wgOut->addParserOutput( $output );
1514 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1518 wfDebugLog( 'dirty', "dirty missing\n" );
1519 wfDebug( __METHOD__
. ": no dirty cache\n" );
1526 * Show an error page for an error from the pool counter.
1527 * @param $status Status
1529 public function showPoolError( $status ) {
1532 $wgOut->clearHTML(); // for release() errors
1533 $wgOut->enableClientCache( false );
1534 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1535 $wgOut->addWikiText(
1536 '<div class="errorbox">' .
1537 $status->getWikiText( false, 'view-pool-error' ) .
1545 * @param $target Title object or Array of destination(s) to redirect
1546 * @param $appendSubtitle Boolean [optional]
1547 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1548 * @return string containing HMTL with redirect link
1550 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1551 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1553 if ( !is_array( $target ) ) {
1554 $target = array( $target );
1557 $imageDir = $wgContLang->getDir();
1559 if ( $appendSubtitle ) {
1560 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1563 $sk = $wgUser->getSkin();
1564 // the loop prepends the arrow image before the link, so the first case needs to be outside
1565 $title = array_shift( $target );
1567 if ( $forceKnown ) {
1568 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1570 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1573 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1574 $alt = $wgContLang->isRTL() ?
'←' : '→';
1575 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1576 // FIXME: where this happens?
1577 foreach ( $target as $rt ) {
1578 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1579 if ( $forceKnown ) {
1580 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1582 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1586 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1587 return Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1588 '<span class="redirectText">' . $link . '</span>';
1592 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1594 public function addTrackbacks() {
1595 global $wgOut, $wgUser;
1597 $dbr = wfGetDB( DB_SLAVE
);
1598 $tbs = $dbr->select( 'trackbacks',
1599 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1600 array( 'tb_page' => $this->getID() )
1603 if ( !$dbr->numRows( $tbs ) ) {
1608 while ( $o = $dbr->fetchObject( $tbs ) ) {
1611 if ( $wgUser->isAllowed( 'trackback' ) ) {
1612 $delurl = $this->mTitle
->getFullURL( "action=deletetrackback&tbid=" .
1613 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1614 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1618 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1626 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1630 * Removes trackback record for current article from trackbacks table
1632 public function deletetrackback() {
1633 global $wgUser, $wgRequest, $wgOut;
1635 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1636 $wgOut->addWikiMsg( 'sessionfailure' );
1641 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1643 if ( count( $permission_errors ) ) {
1644 $wgOut->showPermissionsErrorPage( $permission_errors );
1649 $db = wfGetDB( DB_MASTER
);
1650 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1652 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1653 $this->mTitle
->invalidateCache();
1657 * Handle action=render
1660 public function render() {
1663 $wgOut->setArticleBodyOnly( true );
1668 * Handle action=purge
1670 public function purge() {
1671 global $wgUser, $wgRequest, $wgOut;
1673 if ( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1674 //FIXME: shouldn't this be in doPurge()?
1675 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1680 $formParams = array(
1682 'action' => $wgRequest->getRequestURL(),
1685 $wgOut->addWikiMsg( 'confirm-purge-top' );
1687 $form = Html
::openElement( 'form', $formParams );
1688 $form .= Xml
::submitButton( wfMsg( 'confirm_purge_button' ) );
1689 $form .= Html
::closeElement( 'form' );
1691 $wgOut->addHTML( $form );
1692 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1694 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1695 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1700 * Perform the actions of a page purging
1702 public function doPurge() {
1705 // Invalidate the cache
1706 $this->mTitle
->invalidateCache();
1708 if ( $wgUseSquid ) {
1709 // Commit the transaction before the purge is sent
1710 $dbw = wfGetDB( DB_MASTER
);
1714 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1715 $update->doUpdate();
1718 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1719 global $wgMessageCache;
1721 if ( $this->getID() == 0 ) {
1724 $text = $this->getRawText();
1727 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1732 * Insert a new empty page record for this article.
1733 * This *must* be followed up by creating a revision
1734 * and running $this->updateRevisionOn( ... );
1735 * or else the record will be left in a funky state.
1736 * Best if all done inside a transaction.
1738 * @param $dbw Database
1739 * @return int The newly created page_id key, or false if the title already existed
1742 public function insertOn( $dbw ) {
1743 wfProfileIn( __METHOD__
);
1745 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1746 $dbw->insert( 'page', array(
1747 'page_id' => $page_id,
1748 'page_namespace' => $this->mTitle
->getNamespace(),
1749 'page_title' => $this->mTitle
->getDBkey(),
1750 'page_counter' => 0,
1751 'page_restrictions' => '',
1752 'page_is_redirect' => 0, # Will set this shortly...
1754 'page_random' => wfRandom(),
1755 'page_touched' => $dbw->timestamp(),
1756 'page_latest' => 0, # Fill this in shortly...
1757 'page_len' => 0, # Fill this in shortly...
1758 ), __METHOD__
, 'IGNORE' );
1760 $affected = $dbw->affectedRows();
1763 $newid = $dbw->insertId();
1764 $this->mTitle
->resetArticleId( $newid );
1766 wfProfileOut( __METHOD__
);
1768 return $affected ?
$newid : false;
1772 * Update the page record to point to a newly saved revision.
1774 * @param $dbw Database object
1775 * @param $revision Revision: For ID number, and text used to set
1776 length and redirect status fields
1777 * @param $lastRevision Integer: if given, will not overwrite the page field
1778 * when different from the currently set value.
1779 * Giving 0 indicates the new page flag should be set
1781 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1782 * removing rows in redirect table.
1783 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1784 * Needed when $lastRevision has to be set to sth. !=0
1785 * @return bool true on success, false on failure
1788 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1789 wfProfileIn( __METHOD__
);
1791 $text = $revision->getText();
1792 $rt = Title
::newFromRedirectRecurse( $text );
1794 $conditions = array( 'page_id' => $this->getId() );
1796 if ( !is_null( $lastRevision ) ) {
1797 # An extra check against threads stepping on each other
1798 $conditions['page_latest'] = $lastRevision;
1801 if ( !$setNewFlag ) {
1802 $setNewFlag = ( $lastRevision === 0 );
1805 $dbw->update( 'page',
1807 'page_latest' => $revision->getId(),
1808 'page_touched' => $dbw->timestamp(),
1809 'page_is_new' => $setNewFlag,
1810 'page_is_redirect' => $rt !== null ?
1 : 0,
1811 'page_len' => strlen( $text ),
1816 $result = $dbw->affectedRows() != 0;
1818 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1821 wfProfileOut( __METHOD__
);
1826 * Add row to the redirect table if this is a redirect, remove otherwise.
1828 * @param $dbw Database
1829 * @param $redirectTitle a title object pointing to the redirect target,
1830 * or NULL if this is not a redirect
1831 * @param $lastRevIsRedirect If given, will optimize adding and
1832 * removing rows in redirect table.
1833 * @return bool true on success, false on failure
1836 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1837 // Always update redirects (target link might have changed)
1838 // Update/Insert if we don't know if the last revision was a redirect or not
1839 // Delete if changing from redirect to non-redirect
1840 $isRedirect = !is_null( $redirectTitle );
1842 if ( $isRedirect ||
is_null( $lastRevIsRedirect ) ||
$lastRevIsRedirect !== $isRedirect ) {
1843 wfProfileIn( __METHOD__
);
1844 if ( $isRedirect ) {
1845 $this->insertRedirectEntry( $redirectTitle );
1847 // This is not a redirect, remove row from redirect table
1848 $where = array( 'rd_from' => $this->getId() );
1849 $dbw->delete( 'redirect', $where, __METHOD__
);
1852 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1853 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1855 wfProfileOut( __METHOD__
);
1857 return ( $dbw->affectedRows() != 0 );
1864 * If the given revision is newer than the currently set page_latest,
1865 * update the page record. Otherwise, do nothing.
1867 * @param $dbw Database object
1868 * @param $revision Revision object
1871 public function updateIfNewerOn( &$dbw, $revision ) {
1872 wfProfileIn( __METHOD__
);
1874 $row = $dbw->selectRow(
1875 array( 'revision', 'page' ),
1876 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1878 'page_id' => $this->getId(),
1879 'page_latest=rev_id' ),
1883 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1884 wfProfileOut( __METHOD__
);
1887 $prev = $row->rev_id
;
1888 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1890 # No or missing previous revision; mark the page as new
1892 $lastRevIsRedirect = null;
1895 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1897 wfProfileOut( __METHOD__
);
1902 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1903 * @param $text String: new text of the section
1904 * @param $summary String: new section's subject, only if $section is 'new'
1905 * @param $edittime String: revision timestamp or null to use the current revision
1906 * @return string Complete article text, or null if error
1908 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1909 wfProfileIn( __METHOD__
);
1911 if ( strval( $section ) == '' ) {
1912 // Whole-page edit; let the whole text through
1914 if ( is_null( $edittime ) ) {
1915 $rev = Revision
::newFromTitle( $this->mTitle
);
1917 $dbw = wfGetDB( DB_MASTER
);
1918 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1922 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1923 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1927 $oldtext = $rev->getText();
1929 if ( $section == 'new' ) {
1930 # Inserting a new section
1931 $subject = $summary ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1932 $text = strlen( trim( $oldtext ) ) > 0
1933 ?
"{$oldtext}\n\n{$subject}{$text}"
1934 : "{$subject}{$text}";
1936 # Replacing an existing section; roll out the big guns
1939 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1943 wfProfileOut( __METHOD__
);
1948 * @deprecated use Article::doEdit()
1950 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1951 wfDeprecated( __METHOD__
);
1952 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1953 ( $isminor ? EDIT_MINOR
: 0 ) |
1954 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1955 ( $bot ? EDIT_FORCE_BOT
: 0 );
1957 $this->doEdit( $text, $summary, $flags, false, null, $watchthis, $comment, '', true );
1961 * @deprecated use Article::doEdit()
1963 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1964 wfDeprecated( __METHOD__
);
1965 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1966 ( $minor ? EDIT_MINOR
: 0 ) |
1967 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1969 $status = $this->doEdit( $text, $summary, $flags, false, null, $watchthis, false, $sectionanchor, true );
1971 if ( !$status->isOK() ) {
1979 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1981 * @return Int updated $flags
1983 function checkFlags( $flags ) {
1984 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1985 if ( $this->mTitle
->getArticleID() ) {
1986 $flags |
= EDIT_UPDATE
;
1998 * Change an existing article or create a new article. Updates RC and all necessary caches,
1999 * optionally via the deferred update array.
2001 * $wgUser must be set before calling this function.
2003 * @param $text String: new text
2004 * @param $summary String: edit summary
2005 * @param $flags Integer bitfield:
2007 * Article is known or assumed to be non-existent, create a new one
2009 * Article is known or assumed to be pre-existing, update it
2011 * Mark this edit minor, if the user is allowed to do so
2013 * Do not log the change in recentchanges
2015 * Mark the edit a "bot" edit regardless of user rights
2016 * EDIT_DEFER_UPDATES
2017 * Defer some of the updates until the end of index.php
2019 * Fill in blank summaries with generated text where possible
2021 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2022 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2023 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2024 * edit-already-exists error will be returned. These two conditions are also possible with
2025 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2027 * @param $baseRevId the revision ID this edit was based off, if any
2028 * @param $user Optional user object, $wgUser will be used if not passed
2029 * @param $watchthis Watch the page if true, unwatch the page if false, do nothing if null
2030 * @param $comment Boolean: whether the edit is a new section
2031 * @param $sectionanchor The section anchor for the page; used for redirecting the user back to the page
2032 * after the edit is successfully committed
2033 * @param $redirect If true, redirect the user back to the page after the edit is successfully committed
2035 * @return Status object. Possible errors:
2036 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2037 * edit-gone-missing: In update mode, but the article didn't exist
2038 * edit-conflict: In update mode, the article changed unexpectedly
2039 * edit-no-change: Warning that the text was the same as before
2040 * edit-already-exists: In creation mode, but the article already exists
2042 * Extensions may define additional errors.
2044 * $return->value will contain an associative array with members as follows:
2045 * new: Boolean indicating if the function attempted to create a new article
2046 * revision: The revision object for the inserted revision, or null
2048 * Compatibility note: this function previously returned a boolean value indicating success/failure
2050 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null , $watchthis = null,
2051 $comment = false, $sectionanchor = '', $redirect = false) {
2052 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2054 # Low-level sanity check
2055 if ( $this->mTitle
->getText() === '' ) {
2056 throw new MWException( 'Something is trying to edit an article with an empty title' );
2059 wfProfileIn( __METHOD__
);
2061 $user = is_null( $user ) ?
$wgUser : $user;
2062 $status = Status
::newGood( array() );
2064 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2065 $this->loadPageData();
2067 $flags = $this->checkFlags( $flags );
2069 # If this is a comment, add the summary as headline
2070 if ( $comment && $summary != "" ) {
2071 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
2074 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2075 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, &$status) ) )
2077 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
2078 wfProfileOut( __METHOD__
);
2080 if ( $status->isOK() ) {
2081 $status->fatal( 'edit-hook-aborted' );
2087 # Silently ignore EDIT_MINOR if not allowed
2088 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
2089 $bot = $flags & EDIT_FORCE_BOT
;
2091 $oldtext = $this->getRawText(); // current revision
2092 $oldsize = strlen( $oldtext );
2094 # Provide autosummaries if one is not provided and autosummaries are enabled.
2095 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
2096 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2099 $editInfo = $this->prepareTextForEdit( $text );
2100 $text = $editInfo->pst
;
2101 $newsize = strlen( $text );
2103 $dbw = wfGetDB( DB_MASTER
);
2104 $now = wfTimestampNow();
2105 $this->mTimestamp
= $now;
2107 if ( $flags & EDIT_UPDATE
) {
2108 # Update article, but only if changed.
2109 $status->value
['new'] = false;
2111 # Make sure the revision is either completely inserted or not inserted at all
2112 if ( !$wgDBtransactions ) {
2113 $userAbort = ignore_user_abort( true );
2118 $changed = ( strcmp( $text, $oldtext ) != 0 );
2121 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
2122 - (int)$this->isCountable( $oldtext );
2123 $this->mTotalAdjustment
= 0;
2125 if ( !$this->mLatest
) {
2126 # Article gone missing
2127 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
2128 $status->fatal( 'edit-gone-missing' );
2130 wfProfileOut( __METHOD__
);
2134 $revision = new Revision( array(
2135 'page' => $this->getId(),
2136 'comment' => $summary,
2137 'minor_edit' => $isminor,
2139 'parent_id' => $this->mLatest
,
2140 'user' => $user->getId(),
2141 'user_text' => $user->getName(),
2145 $revisionId = $revision->insertOn( $dbw );
2149 # Note that we use $this->mLatest instead of fetching a value from the master DB
2150 # during the course of this function. This makes sure that EditPage can detect
2151 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2152 # before this function is called. A previous function used a separate query, this
2153 # creates a window where concurrent edits can cause an ignored edit conflict.
2154 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
2157 /* Belated edit conflict! Run away!! */
2158 $status->fatal( 'edit-conflict' );
2160 # Delete the invalid revision if the DB is not transactional
2161 if ( !$wgDBtransactions ) {
2162 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
2168 global $wgUseRCPatrol;
2169 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2170 # Update recentchanges
2171 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2172 # Mark as patrolled if the user can do so
2173 $patrolled = $wgUseRCPatrol && $this->mTitle
->userCan( 'autopatrol' );
2174 # Add RC row to the DB
2175 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
2176 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2177 $revisionId, $patrolled
2180 # Log auto-patrolled edits
2182 PatrolLog
::record( $rc, true );
2185 $user->incEditCount();
2189 $status->warning( 'edit-no-change' );
2191 // Keep the same revision ID, but do some updates on it
2192 $revisionId = $this->getRevIdFetched();
2193 // Update page_touched, this is usually implicit in the page update
2194 // Other cache updates are done in onArticleEdit()
2195 $this->mTitle
->invalidateCache();
2198 if ( !$wgDBtransactions ) {
2199 ignore_user_abort( $userAbort );
2202 // Now that ignore_user_abort is restored, we can respond to fatal errors
2203 if ( !$status->isOK() ) {
2204 wfProfileOut( __METHOD__
);
2208 # Invalidate cache of this article and all pages using this article
2209 # as a template. Partly deferred.
2210 Article
::onArticleEdit( $this->mTitle
);
2211 # Update links tables, site stats, etc.
2212 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed );
2214 # Create new article
2215 $status->value
['new'] = true;
2217 # Set statistics members
2218 # We work out if it's countable after PST to avoid counter drift
2219 # when articles are created with {{subst:}}
2220 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2221 $this->mTotalAdjustment
= 1;
2225 # Add the page record; stake our claim on this title!
2226 # This will return false if the article already exists
2227 $newid = $this->insertOn( $dbw );
2229 if ( $newid === false ) {
2231 $status->fatal( 'edit-already-exists' );
2233 wfProfileOut( __METHOD__
);
2237 # Save the revision text...
2238 $revision = new Revision( array(
2240 'comment' => $summary,
2241 'minor_edit' => $isminor,
2243 'user' => $user->getId(),
2244 'user_text' => $user->getName(),
2246 $revisionId = $revision->insertOn( $dbw );
2248 $this->mTitle
->resetArticleID( $newid );
2250 # Update the page record with revision data
2251 $this->updateRevisionOn( $dbw, $revision, 0 );
2253 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2255 # Update recentchanges
2256 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2257 global $wgUseRCPatrol, $wgUseNPPatrol;
2259 # Mark as patrolled if the user can do so
2260 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && $this->mTitle
->userCan( 'autopatrol' );
2261 # Add RC row to the DB
2262 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2263 '', strlen( $text ), $revisionId, $patrolled );
2265 # Log auto-patrolled edits
2267 PatrolLog
::record( $rc, true );
2270 $user->incEditCount();
2273 # Update links, etc.
2274 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true );
2277 Article
::onArticleCreate( $this->mTitle
);
2279 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2280 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, $revision ) );
2283 # Do updates right now unless deferral was requested
2284 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
2288 // Return the new revision (or null) to the caller
2289 $status->value
['revision'] = $revision;
2291 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2292 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, $revision, &$status, $baseRevId,
2295 # Watch or unwatch the page
2296 if ( $watchthis === true ) {
2297 if ( !$this->mTitle
->userIsWatching() ) {
2302 } elseif ( $watchthis === false ) {
2303 if ( $this->mTitle
->userIsWatching() ) {
2310 # Give extensions a chance to modify URL query on update
2313 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
2316 if ( $sectionanchor ||
$extraQuery ) {
2317 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
2319 $this->doRedirect( $this->isRedirect( $text ) );
2323 wfProfileOut( __METHOD__
);
2329 * @deprecated wrapper for doRedirect
2331 public function showArticle( $text, $subtitle , $sectionanchor = '', $me2, $now, $summary, $oldid ) {
2332 wfDeprecated( __METHOD__
);
2333 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor );
2337 * Output a redirect back to the article.
2338 * This is typically used after an edit.
2340 * @param $noRedir Boolean: add redirect=no
2341 * @param $sectionAnchor String: section to redirect to, including "#"
2342 * @param $extraQuery String: extra query params
2344 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2348 $query = 'redirect=no';
2350 $query .= "&$extraQuery";
2352 $query = $extraQuery;
2355 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2359 * Mark this particular edit/page as patrolled
2361 public function markpatrolled() {
2362 global $wgOut, $wgUser, $wgRequest;
2364 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2366 # If we haven't been given an rc_id value, we can't do anything
2367 $rcid = (int) $wgRequest->getVal( 'rcid' );
2369 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
2370 $wgOut->showErrorPage( 'sessionfailure-title', 'sessionfailure' );
2374 $rc = RecentChange
::newFromId( $rcid );
2376 if ( is_null( $rc ) ) {
2377 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2381 # It would be nice to see where the user had actually come from, but for now just guess
2382 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2383 $return = SpecialPage
::getTitleFor( $returnto );
2385 $errors = $rc->doMarkPatrolled();
2387 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2388 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2393 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2394 // The hook itself has handled any output
2398 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2399 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2400 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2401 $wgOut->returnToMain( false, $return );
2406 if ( !empty( $errors ) ) {
2407 $wgOut->showPermissionsErrorPage( $errors );
2413 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2414 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2415 $wgOut->returnToMain( false, $return );
2419 * User-interface handler for the "watch" action
2421 public function watch() {
2422 global $wgUser, $wgOut;
2424 if ( $wgUser->isAnon() ) {
2425 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2429 if ( wfReadOnly() ) {
2430 $wgOut->readOnlyPage();
2434 if ( $this->doWatch() ) {
2435 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2436 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2437 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2440 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2444 * Add this page to $wgUser's watchlist
2445 * @return bool true on successful watch operation
2447 public function doWatch() {
2450 if ( $wgUser->isAnon() ) {
2454 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2455 $wgUser->addWatch( $this->mTitle
);
2456 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2463 * User interface handler for the "unwatch" action.
2465 public function unwatch() {
2466 global $wgUser, $wgOut;
2468 if ( $wgUser->isAnon() ) {
2469 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2473 if ( wfReadOnly() ) {
2474 $wgOut->readOnlyPage();
2478 if ( $this->doUnwatch() ) {
2479 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2480 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2481 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2484 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2488 * Stop watching a page
2489 * @return bool true on successful unwatch
2491 public function doUnwatch() {
2494 if ( $wgUser->isAnon() ) {
2498 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2499 $wgUser->removeWatch( $this->mTitle
);
2500 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2507 * action=protect handler
2509 public function protect() {
2510 $form = new ProtectionForm( $this );
2515 * action=unprotect handler (alias)
2517 public function unprotect() {
2522 * Update the article's restriction field, and leave a log entry.
2524 * @param $limit Array: set of restriction keys
2525 * @param $reason String
2526 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2527 * @param $expiry Array: per restriction type expiration
2528 * @return bool true on success
2530 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2531 global $wgUser, $wgContLang;
2533 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2535 $id = $this->mTitle
->getArticleID();
2538 wfDebug( "updateRestrictions failed: $id <= 0\n" );
2542 if ( wfReadOnly() ) {
2543 wfDebug( "updateRestrictions failed: read-only\n" );
2547 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2548 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2556 // Take this opportunity to purge out expired restrictions
2557 Title
::purgeExpiredRestrictions();
2559 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2560 # we expect a single selection, but the schema allows otherwise.
2562 $updated = Article
::flattenRestrictions( $limit );
2565 foreach ( $restrictionTypes as $action ) {
2566 if ( isset( $expiry[$action] ) ) {
2567 # Get current restrictions on $action
2568 $aLimits = $this->mTitle
->getRestrictions( $action );
2569 $current[$action] = implode( '', $aLimits );
2570 # Are any actual restrictions being dealt with here?
2571 $aRChanged = count( $aLimits ) ||
!empty( $limit[$action] );
2573 # If something changed, we need to log it. Checking $aRChanged
2574 # assures that "unprotecting" a page that is not protected does
2575 # not log just because the expiry was "changed".
2576 if ( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2582 $current = Article
::flattenRestrictions( $current );
2584 $changed = ( $changed ||
$current != $updated );
2585 $changed = $changed ||
( $updated && $this->mTitle
->areRestrictionsCascading() != $cascade );
2586 $protect = ( $updated != '' );
2588 # If nothing's changed, do nothing
2590 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2591 $dbw = wfGetDB( DB_MASTER
);
2593 # Prepare a null revision to be added to the history
2594 $modified = $current != '' && $protect;
2597 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2599 $comment_type = 'unprotectedarticle';
2602 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2604 # Only restrictions with the 'protect' right can cascade...
2605 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2606 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2608 # The schema allows multiple restrictions
2609 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2613 $cascade_description = '';
2616 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2620 $comment .= ": $reason";
2623 $editComment = $comment;
2624 $encodedExpiry = array();
2625 $protect_description = '';
2626 foreach ( $limit as $action => $restrictions ) {
2627 if ( !isset( $expiry[$action] ) )
2628 $expiry[$action] = 'infinite';
2630 $encodedExpiry[$action] = Block
::encodeExpiry( $expiry[$action], $dbw );
2631 if ( $restrictions != '' ) {
2632 $protect_description .= "[$action=$restrictions] (";
2633 if ( $encodedExpiry[$action] != 'infinity' ) {
2634 $protect_description .= wfMsgForContent( 'protect-expiring',
2635 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2636 $wgContLang->date( $expiry[$action], false, false ) ,
2637 $wgContLang->time( $expiry[$action], false, false ) );
2639 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2642 $protect_description .= ') ';
2645 $protect_description = trim( $protect_description );
2647 if ( $protect_description && $protect ) {
2648 $editComment .= " ($protect_description)";
2652 $editComment .= "$cascade_description";
2655 # Update restrictions table
2656 foreach ( $limit as $action => $restrictions ) {
2657 if ( $restrictions != '' ) {
2658 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2659 array( 'pr_page' => $id,
2660 'pr_type' => $action,
2661 'pr_level' => $restrictions,
2662 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2663 'pr_expiry' => $encodedExpiry[$action]
2668 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2669 'pr_type' => $action ), __METHOD__
);
2673 # Insert a null revision
2674 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2675 $nullRevId = $nullRevision->insertOn( $dbw );
2677 $latest = $this->getLatest();
2678 # Update page record
2679 $dbw->update( 'page',
2681 'page_touched' => $dbw->timestamp(),
2682 'page_restrictions' => '',
2683 'page_latest' => $nullRevId
2684 ), array( /* WHERE */
2686 ), 'Article::protect'
2689 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2690 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2692 # Update the protection log
2693 $log = new LogPage( 'protect' );
2695 $params = array( $protect_description, $cascade ?
'cascade' : '' );
2696 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason ), $params );
2698 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2701 } # End "changed" check
2707 * Take an array of page restrictions and flatten it to a string
2708 * suitable for insertion into the page_restrictions field.
2709 * @param $limit Array
2712 protected static function flattenRestrictions( $limit ) {
2713 if ( !is_array( $limit ) ) {
2714 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2720 foreach ( $limit as $action => $restrictions ) {
2721 if ( $restrictions != '' ) {
2722 $bits[] = "$action=$restrictions";
2726 return implode( ':', $bits );
2730 * Auto-generates a deletion reason
2732 * @param &$hasHistory Boolean: whether the page has a history
2733 * @return mixed String containing deletion reason or empty string, or boolean false
2734 * if no revision occurred
2736 public function generateReason( &$hasHistory ) {
2739 $dbw = wfGetDB( DB_MASTER
);
2740 // Get the last revision
2741 $rev = Revision
::newFromTitle( $this->mTitle
);
2743 if ( is_null( $rev ) ) {
2747 // Get the article's contents
2748 $contents = $rev->getText();
2751 // If the page is blank, use the text from the previous revision,
2752 // which can only be blank if there's a move/import/protect dummy revision involved
2753 if ( $contents == '' ) {
2754 $prev = $rev->getPrevious();
2757 $contents = $prev->getText();
2762 // Find out if there was only one contributor
2763 // Only scan the last 20 revisions
2764 $res = $dbw->select( 'revision', 'rev_user_text',
2765 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2767 array( 'LIMIT' => 20 )
2770 if ( $res === false ) {
2771 // This page has no revisions, which is very weird
2775 $hasHistory = ( $res->numRows() > 1 );
2776 $row = $dbw->fetchObject( $res );
2778 if ( $row ) { // $row is false if the only contributor is hidden
2779 $onlyAuthor = $row->rev_user_text
;
2780 // Try to find a second contributor
2781 foreach ( $res as $row ) {
2782 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2783 $onlyAuthor = false;
2788 $onlyAuthor = false;
2791 // Generate the summary with a '$1' placeholder
2793 // The current revision is blank and the one before is also
2794 // blank. It's just not our lucky day
2795 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2797 if ( $onlyAuthor ) {
2798 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2800 $reason = wfMsgForContent( 'excontent', '$1' );
2804 if ( $reason == '-' ) {
2805 // Allow these UI messages to be blanked out cleanly
2809 // Replace newlines with spaces to prevent uglyness
2810 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2811 // Calculate the maximum amount of chars to get
2812 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2813 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2814 $contents = $wgContLang->truncate( $contents, $maxLength );
2815 // Remove possible unfinished links
2816 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2817 // Now replace the '$1' placeholder
2818 $reason = str_replace( '$1', $contents, $reason );
2825 * UI entry point for page deletion
2827 public function delete() {
2828 global $wgUser, $wgOut, $wgRequest;
2830 $confirm = $wgRequest->wasPosted() &&
2831 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2833 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2834 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2836 $reason = $this->DeleteReasonList
;
2838 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
2839 // Entry from drop down menu + additional comment
2840 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2841 } elseif ( $reason == 'other' ) {
2842 $reason = $this->DeleteReason
;
2845 # Flag to hide all contents of the archived revisions
2846 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2848 # This code desperately needs to be totally rewritten
2850 # Read-only check...
2851 if ( wfReadOnly() ) {
2852 $wgOut->readOnlyPage();
2858 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2860 if ( count( $permission_errors ) > 0 ) {
2861 $wgOut->showPermissionsErrorPage( $permission_errors );
2866 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2868 # Better double-check that it hasn't been deleted yet!
2869 $dbw = wfGetDB( DB_MASTER
);
2870 $conds = $this->mTitle
->pageCond();
2871 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2872 if ( $latest === false ) {
2873 $wgOut->showFatalError(
2876 array( 'class' => 'error mw-error-cannotdelete' ),
2877 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2880 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2881 LogEventsList
::showLogExtract(
2884 $this->mTitle
->getPrefixedText()
2890 # Hack for big sites
2891 $bigHistory = $this->isBigDeletion();
2892 if ( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2893 global $wgLang, $wgDeleteRevisionsLimit;
2895 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2896 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2902 $this->doDelete( $reason, $suppress );
2904 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2906 } elseif ( $this->mTitle
->userIsWatching() ) {
2913 // Generate deletion reason
2914 $hasHistory = false;
2916 $reason = $this->generateReason( $hasHistory );
2919 // If the page has a history, insert a warning
2920 if ( $hasHistory && !$confirm ) {
2923 $skin = $wgUser->getSkin();
2924 $revisions = $this->estimateRevisionCount();
2926 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2927 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2928 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2932 if ( $bigHistory ) {
2933 global $wgDeleteRevisionsLimit;
2934 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2935 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2939 return $this->confirmDelete( $reason );
2943 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2945 public function isBigDeletion() {
2946 global $wgDeleteRevisionsLimit;
2948 if ( $wgDeleteRevisionsLimit ) {
2949 $revCount = $this->estimateRevisionCount();
2951 return $revCount > $wgDeleteRevisionsLimit;
2958 * @return int approximate revision count
2960 public function estimateRevisionCount() {
2961 $dbr = wfGetDB( DB_SLAVE
);
2963 // For an exact count...
2964 // return $dbr->selectField( 'revision', 'COUNT(*)',
2965 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2966 return $dbr->estimateRowCount( 'revision', '*',
2967 array( 'rev_page' => $this->getId() ), __METHOD__
);
2971 * Get the last N authors
2972 * @param $num Integer: number of revisions to get
2973 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2974 * @return array Array of authors, duplicates not removed
2976 public function getLastNAuthors( $num, $revLatest = 0 ) {
2977 wfProfileIn( __METHOD__
);
2978 // First try the slave
2979 // If that doesn't have the latest revision, try the master
2981 $db = wfGetDB( DB_SLAVE
);
2984 $res = $db->select( array( 'page', 'revision' ),
2985 array( 'rev_id', 'rev_user_text' ),
2987 'page_namespace' => $this->mTitle
->getNamespace(),
2988 'page_title' => $this->mTitle
->getDBkey(),
2989 'rev_page = page_id'
2990 ), __METHOD__
, $this->getSelectOptions( array(
2991 'ORDER BY' => 'rev_timestamp DESC',
2997 wfProfileOut( __METHOD__
);
3001 $row = $db->fetchObject( $res );
3003 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
3004 $db = wfGetDB( DB_MASTER
);
3009 } while ( $continue );
3011 $authors = array( $row->rev_user_text
);
3013 while ( $row = $db->fetchObject( $res ) ) {
3014 $authors[] = $row->rev_user_text
;
3017 wfProfileOut( __METHOD__
);
3022 * Output deletion confirmation dialog
3023 * FIXME: Move to another file?
3024 * @param $reason String: prefilled reason
3026 public function confirmDelete( $reason ) {
3027 global $wgOut, $wgUser;
3029 wfDebug( "Article::confirmDelete\n" );
3031 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle
);
3032 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3033 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3034 $wgOut->addWikiMsg( 'confirmdeletetext' );
3036 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3038 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3039 $suppress = "<tr id=\"wpDeleteSuppressRow\" name=\"wpDeleteSuppressRow\">
3041 <td class='mw-input'><strong>" .
3042 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
3043 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3049 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
3051 $form = Xml
::openElement( 'form', array( 'method' => 'post',
3052 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3053 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3054 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3055 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3056 "<tr id=\"wpDeleteReasonListRow\">
3057 <td class='mw-label'>" .
3058 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3060 <td class='mw-input'>" .
3061 Xml
::listDropDown( 'wpDeleteReasonList',
3062 wfMsgForContent( 'deletereason-dropdown' ),
3063 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3066 <tr id=\"wpDeleteReasonRow\">
3067 <td class='mw-label'>" .
3068 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3070 <td class='mw-input'>" .
3071 Html
::input( 'wpReason', $reason, 'text', array(
3073 'maxlength' => '255',
3081 # Disallow watching if user is not logged in
3082 if ( $wgUser->isLoggedIn() ) {
3086 <td class='mw-input'>" .
3087 Xml
::checkLabel( wfMsg( 'watchthis' ),
3088 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3097 <td class='mw-submit'>" .
3098 Xml
::submitButton( wfMsg( 'deletepage' ),
3099 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3102 Xml
::closeElement( 'table' ) .
3103 Xml
::closeElement( 'fieldset' ) .
3104 Xml
::hidden( 'wpEditToken', $wgUser->editToken() ) .
3105 Xml
::closeElement( 'form' );
3107 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3108 $skin = $wgUser->getSkin();
3109 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
3110 $link = $skin->link(
3112 wfMsgHtml( 'delete-edit-reasonlist' ),
3114 array( 'action' => 'edit' )
3116 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3119 $wgOut->addHTML( $form );
3120 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3121 LogEventsList
::showLogExtract( $wgOut, 'delete',
3122 $this->mTitle
->getPrefixedText()
3127 * Perform a deletion and output success or failure messages
3129 public function doDelete( $reason, $suppress = false ) {
3130 global $wgOut, $wgUser;
3132 $id = $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
3135 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3136 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3137 $deleted = $this->mTitle
->getPrefixedText();
3139 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3140 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3142 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3144 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3145 $wgOut->returnToMain( false );
3146 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3149 if ( $error == '' ) {
3150 $wgOut->showFatalError(
3153 array( 'class' => 'error mw-error-cannotdelete' ),
3154 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
3158 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3160 LogEventsList
::showLogExtract(
3163 $this->mTitle
->getPrefixedText()
3166 $wgOut->showFatalError( $error );
3172 * Back-end article deletion
3173 * Deletes the article with database consistency, writes logs, purges caches
3175 * @param $reason string delete reason for deletion log
3176 * @param suppress bitfield
3177 * Revision::DELETED_TEXT
3178 * Revision::DELETED_COMMENT
3179 * Revision::DELETED_USER
3180 * Revision::DELETED_RESTRICTED
3181 * @param $id int article ID
3182 * @param $commit boolean defaults to true, triggers transaction end
3183 * @return boolean true if successful
3185 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3186 global $wgDeferredUpdateList, $wgUseTrackbacks;
3188 wfDebug( __METHOD__
. "\n" );
3190 $dbw = wfGetDB( DB_MASTER
);
3191 $ns = $this->mTitle
->getNamespace();
3192 $t = $this->mTitle
->getDBkey();
3193 $id = $id ?
$id : $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
3195 if ( $t === '' ||
$id == 0 ) {
3199 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3200 array_push( $wgDeferredUpdateList, $u );
3202 // Bitfields to further suppress the content
3205 // This should be 15...
3206 $bitfield |
= Revision
::DELETED_TEXT
;
3207 $bitfield |
= Revision
::DELETED_COMMENT
;
3208 $bitfield |
= Revision
::DELETED_USER
;
3209 $bitfield |
= Revision
::DELETED_RESTRICTED
;
3211 $bitfield = 'rev_deleted';
3215 // For now, shunt the revision data into the archive table.
3216 // Text is *not* removed from the text table; bulk storage
3217 // is left intact to avoid breaking block-compression or
3218 // immutable storage schemes.
3220 // For backwards compatibility, note that some older archive
3221 // table entries will have ar_text and ar_flags fields still.
3223 // In the future, we may keep revisions and mark them with
3224 // the rev_deleted field, which is reserved for this purpose.
3225 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3227 'ar_namespace' => 'page_namespace',
3228 'ar_title' => 'page_title',
3229 'ar_comment' => 'rev_comment',
3230 'ar_user' => 'rev_user',
3231 'ar_user_text' => 'rev_user_text',
3232 'ar_timestamp' => 'rev_timestamp',
3233 'ar_minor_edit' => 'rev_minor_edit',
3234 'ar_rev_id' => 'rev_id',
3235 'ar_text_id' => 'rev_text_id',
3236 'ar_text' => '\'\'', // Be explicit to appease
3237 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3238 'ar_len' => 'rev_len',
3239 'ar_page_id' => 'page_id',
3240 'ar_deleted' => $bitfield
3243 'page_id = rev_page'
3247 # Delete restrictions for it
3248 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
3250 # Now that it's safely backed up, delete it
3251 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
3252 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3259 # Fix category table counts
3261 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
3263 foreach ( $res as $row ) {
3264 $cats [] = $row->cl_to
;
3267 $this->updateCategoryCounts( array(), $cats );
3269 # If using cascading deletes, we can skip some explicit deletes
3270 if ( !$dbw->cascadingDeletes() ) {
3271 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
3273 if ( $wgUseTrackbacks )
3274 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
3276 # Delete outgoing links
3277 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3278 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3279 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3280 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3281 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3282 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3283 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3286 # If using cleanup triggers, we can skip some manual deletes
3287 if ( !$dbw->cleanupTriggers() ) {
3288 # Clean up recentchanges entries...
3289 $dbw->delete( 'recentchanges',
3290 array( 'rc_type != ' . RC_LOG
,
3291 'rc_namespace' => $this->mTitle
->getNamespace(),
3292 'rc_title' => $this->mTitle
->getDBkey() ),
3294 $dbw->delete( 'recentchanges',
3295 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
3300 Article
::onArticleDelete( $this->mTitle
);
3302 # Clear the cached article id so the interface doesn't act like we exist
3303 $this->mTitle
->resetArticleID( 0 );
3305 # Log the deletion, if the page was suppressed, log it at Oversight instead
3306 $logtype = $suppress ?
'suppress' : 'delete';
3307 $log = new LogPage( $logtype );
3309 # Make sure logging got through
3310 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
3320 * Roll back the most recent consecutive set of edits to a page
3321 * from the same user; fails if there are no eligible edits to
3322 * roll back to, e.g. user is the sole contributor. This function
3323 * performs permissions checks on $wgUser, then calls commitRollback()
3324 * to do the dirty work
3326 * @param $fromP String: Name of the user whose edits to rollback.
3327 * @param $summary String: Custom summary. Set to default summary if empty.
3328 * @param $token String: Rollback token.
3329 * @param $bot Boolean: If true, mark all reverted edits as bot.
3331 * @param $resultDetails Array: contains result-specific array of additional values
3332 * 'alreadyrolled' : 'current' (rev)
3333 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3335 * @return array of errors, each error formatted as
3336 * array(messagekey, param1, param2, ...).
3337 * On success, the array is empty. This array can also be passed to
3338 * OutputPage::showPermissionsErrorPage().
3340 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3343 $resultDetails = null;
3346 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
3347 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
3348 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3350 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
3351 $errors[] = array( 'sessionfailure' );
3354 if ( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3355 $errors[] = array( 'actionthrottledtext' );
3358 # If there were errors, bail out now
3359 if ( !empty( $errors ) ) {
3363 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3367 * Backend implementation of doRollback(), please refer there for parameter
3368 * and return value documentation
3370 * NOTE: This function does NOT check ANY permissions, it just commits the
3371 * rollback to the DB Therefore, you should only call this function direct-
3372 * ly if you want to use custom permissions checks. If you don't, use
3373 * doRollback() instead.
3375 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3376 global $wgUseRCPatrol, $wgUser, $wgLang;
3378 $dbw = wfGetDB( DB_MASTER
);
3380 if ( wfReadOnly() ) {
3381 return array( array( 'readonlytext' ) );
3384 # Get the last editor
3385 $current = Revision
::newFromTitle( $this->mTitle
);
3386 if ( is_null( $current ) ) {
3387 # Something wrong... no page?
3388 return array( array( 'notanarticle' ) );
3391 $from = str_replace( '_', ' ', $fromP );
3392 # User name given should match up with the top revision.
3393 # If the user was deleted then $from should be empty.
3394 if ( $from != $current->getUserText() ) {
3395 $resultDetails = array( 'current' => $current );
3396 return array( array( 'alreadyrolled',
3397 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3398 htmlspecialchars( $fromP ),
3399 htmlspecialchars( $current->getUserText() )
3403 # Get the last edit not by this guy...
3404 # Note: these may not be public values
3405 $user = intval( $current->getRawUser() );
3406 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3407 $s = $dbw->selectRow( 'revision',
3408 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3409 array( 'rev_page' => $current->getPage(),
3410 "rev_user != {$user} OR rev_user_text != {$user_text}"
3412 array( 'USE INDEX' => 'page_timestamp',
3413 'ORDER BY' => 'rev_timestamp DESC' )
3415 if ( $s === false ) {
3416 # No one else ever edited this page
3417 return array( array( 'cantrollback' ) );
3418 } else if ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
3419 # Only admins can see this text
3420 return array( array( 'notvisiblerev' ) );
3424 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3425 # Mark all reverted edits as bot
3429 if ( $wgUseRCPatrol ) {
3430 # Mark all reverted edits as patrolled
3431 $set['rc_patrolled'] = 1;
3434 if ( count( $set ) ) {
3435 $dbw->update( 'recentchanges', $set,
3437 'rc_cur_id' => $current->getPage(),
3438 'rc_user_text' => $current->getUserText(),
3439 "rc_timestamp > '{$s->rev_timestamp}'",
3444 # Generate the edit summary if necessary
3445 $target = Revision
::newFromId( $s->rev_id
);
3446 if ( empty( $summary ) ) {
3447 if ( $from == '' ) { // no public user name
3448 $summary = wfMsgForContent( 'revertpage-nouser' );
3450 $summary = wfMsgForContent( 'revertpage' );
3454 # Allow the custom summary to use the same args as the default message
3456 $target->getUserText(), $from, $s->rev_id
,
3457 $wgLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
), true ),
3458 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3460 $summary = wfMsgReplaceArgs( $summary, $args );
3463 $flags = EDIT_UPDATE
;
3465 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3466 $flags |
= EDIT_MINOR
;
3469 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) ||
$wgUser->isAllowed( 'bot' ) ) ) {
3470 $flags |
= EDIT_FORCE_BOT
;
3473 # Actually store the edit
3474 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3475 if ( !empty( $status->value
['revision'] ) ) {
3476 $revId = $status->value
['revision']->getId();
3481 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3483 $resultDetails = array(
3484 'summary' => $summary,
3485 'current' => $current,
3486 'target' => $target,
3494 * User interface for rollback operations
3496 public function rollback() {
3497 global $wgUser, $wgOut, $wgRequest;
3501 $result = $this->doRollback(
3502 $wgRequest->getVal( 'from' ),
3503 $wgRequest->getText( 'summary' ),
3504 $wgRequest->getVal( 'token' ),
3505 $wgRequest->getBool( 'bot' ),
3509 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3510 $wgOut->rateLimited();
3514 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3515 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3516 $errArray = $result[0];
3517 $errMsg = array_shift( $errArray );
3518 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3520 if ( isset( $details['current'] ) ) {
3521 $current = $details['current'];
3523 if ( $current->getComment() != '' ) {
3524 $wgOut->addWikiMsgArray( 'editcomment', array(
3525 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3532 # Display permissions errors before read-only message -- there's no
3533 # point in misleading the user into thinking the inability to rollback
3534 # is only temporary.
3535 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3536 # array_diff is completely broken for arrays of arrays, sigh.
3537 # Remove any 'readonlytext' error manually.
3539 foreach ( $result as $error ) {
3540 if ( $error != array( 'readonlytext' ) ) {
3544 $wgOut->showPermissionsErrorPage( $out );
3549 if ( $result == array( array( 'readonlytext' ) ) ) {
3550 $wgOut->readOnlyPage();
3555 $current = $details['current'];
3556 $target = $details['target'];
3557 $newId = $details['newid'];
3558 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3559 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3561 if ( $current->getUserText() === '' ) {
3562 $old = wfMsg( 'rev-deleted-user' );
3564 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3565 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3568 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3569 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3570 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3571 $wgOut->returnToMain( false, $this->mTitle
);
3573 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3574 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3575 $de->showDiff( '', '' );
3580 * Do standard deferred updates after page view
3582 public function viewUpdates() {
3583 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3584 if ( wfReadOnly() ) {
3588 # Don't update page view counters on views from bot users (bug 14044)
3589 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3590 Article
::incViewCount( $this->getID() );
3591 $u = new SiteStatsUpdate( 1, 0, 0 );
3592 array_push( $wgDeferredUpdateList, $u );
3595 # Update newtalk / watchlist notification status
3596 $wgUser->clearNotification( $this->mTitle
);
3600 * Prepare text which is about to be saved.
3601 * Returns a stdclass with source, pst and output members
3603 public function prepareTextForEdit( $text, $revid = null ) {
3604 if ( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid ) {
3606 return $this->mPreparedEdit
;
3611 $edit = (object)array();
3612 $edit->revid
= $revid;
3613 $edit->newText
= $text;
3614 $edit->pst
= $this->preSaveTransform( $text );
3615 $options = $this->getParserOptions();
3616 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $options, true, true, $revid );
3617 $edit->oldText
= $this->getContent();
3619 $this->mPreparedEdit
= $edit;
3625 * Do standard deferred updates after page edit.
3626 * Update links tables, site stats, search index and message cache.
3627 * Purges pages that include this page if the text was changed here.
3628 * Every 100th edit, prune the recent changes table.
3631 * @param $text New text of the article
3632 * @param $summary Edit summary
3633 * @param $minoredit Minor edit
3634 * @param $timestamp_of_pagechange Timestamp associated with the page change
3635 * @param $newid rev_id value of the new revision
3636 * @param $changed Whether or not the content actually changed
3638 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true ) {
3639 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3641 wfProfileIn( __METHOD__
);
3644 # Be careful not to double-PST: $text is usually already PST-ed once
3645 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3646 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3647 $editInfo = $this->prepareTextForEdit( $text, $newid );
3649 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3650 $editInfo = $this->mPreparedEdit
;
3653 # Save it to the parser cache
3654 if ( $wgEnableParserCache ) {
3655 $popts = $this->getParserOptions();
3656 $parserCache = ParserCache
::singleton();
3657 $parserCache->save( $editInfo->output
, $this, $popts );
3660 # Update the links tables
3661 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3664 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3666 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3667 if ( 0 == mt_rand( 0, 99 ) ) {
3668 // Flush old entries from the `recentchanges` table; we do this on
3669 // random requests so as to avoid an increase in writes for no good reason
3672 $dbw = wfGetDB( DB_MASTER
);
3673 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3674 $recentchanges = $dbw->tableName( 'recentchanges' );
3675 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3677 $dbw->query( $sql );
3681 $id = $this->getID();
3682 $title = $this->mTitle
->getPrefixedDBkey();
3683 $shortTitle = $this->mTitle
->getDBkey();
3686 wfProfileOut( __METHOD__
);
3690 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3691 array_push( $wgDeferredUpdateList, $u );
3692 $u = new SearchUpdate( $id, $title, $text );
3693 array_push( $wgDeferredUpdateList, $u );
3695 # If this is another user's talk page, update newtalk
3696 # Don't do this if $changed = false otherwise some idiot can null-edit a
3697 # load of user talk pages and piss people off, nor if it's a minor edit
3698 # by a properly-flagged bot.
3699 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3700 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3702 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3703 $other = User
::newFromName( $shortTitle, false );
3705 wfDebug( __METHOD__
. ": invalid username\n" );
3706 } elseif ( User
::isIP( $shortTitle ) ) {
3707 // An anonymous user
3708 $other->setNewtalk( true );
3709 } elseif ( $other->isLoggedIn() ) {
3710 $other->setNewtalk( true );
3712 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3717 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3718 $wgMessageCache->replace( $shortTitle, $text );
3721 wfProfileOut( __METHOD__
);
3725 * Perform article updates on a special page creation.
3727 * @param $rev Revision object
3729 * @todo This is a shitty interface function. Kill it and replace the
3730 * other shitty functions like editUpdates and such so it's not needed
3733 public function createUpdates( $rev ) {
3734 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3735 $this->mTotalAdjustment
= 1;
3736 $this->editUpdates( $rev->getText(), $rev->getComment(),
3737 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3741 * Generate the navigation links when browsing through an article revisions
3742 * It shows the information as:
3743 * Revision as of \<date\>; view current revision
3744 * \<- Previous version | Next Version -\>
3746 * @param $oldid String: revision ID of this article revision
3748 public function setOldSubtitle( $oldid = 0 ) {
3749 global $wgLang, $wgOut, $wgUser, $wgRequest;
3751 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3755 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3757 # Cascade unhide param in links for easy deletion browsing
3758 $extraParams = array();
3759 if ( $wgRequest->getVal( 'unhide' ) ) {
3760 $extraParams['unhide'] = 1;
3763 $revision = Revision
::newFromId( $oldid );
3765 $current = ( $oldid == $this->mLatest
);
3766 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3767 $tddate = $wgLang->date( $this->mTimestamp
, true );
3768 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3769 $sk = $wgUser->getSkin();
3771 ?
wfMsgHtml( 'currentrevisionlink' )
3774 wfMsgHtml( 'currentrevisionlink' ),
3777 array( 'known', 'noclasses' )
3780 ?
wfMsgHtml( 'diff' )
3783 wfMsgHtml( 'diff' ),
3789 array( 'known', 'noclasses' )
3791 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3795 wfMsgHtml( 'previousrevision' ),
3798 'direction' => 'prev',
3801 array( 'known', 'noclasses' )
3803 : wfMsgHtml( 'previousrevision' );
3807 wfMsgHtml( 'diff' ),
3813 array( 'known', 'noclasses' )
3815 : wfMsgHtml( 'diff' );
3816 $nextlink = $current
3817 ?
wfMsgHtml( 'nextrevision' )
3820 wfMsgHtml( 'nextrevision' ),
3823 'direction' => 'next',
3826 array( 'known', 'noclasses' )
3828 $nextdiff = $current
3829 ?
wfMsgHtml( 'diff' )
3832 wfMsgHtml( 'diff' ),
3838 array( 'known', 'noclasses' )
3843 // User can delete revisions or view deleted revisions...
3844 $canHide = $wgUser->isAllowed( 'deleterevision' );
3845 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3846 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3847 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3850 'type' => 'revision',
3851 'target' => $this->mTitle
->getPrefixedDbkey(),
3854 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
3859 # Show user links if allowed to see them. If hidden, then show them only if requested...
3860 $userlinks = $sk->revUserTools( $revision, !$unhide );
3862 $m = wfMsg( 'revision-info-current' );
3863 $infomsg = $current && !wfEmptyMsg( 'revision-info-current', $m ) && $m != '-'
3864 ?
'revision-info-current'
3867 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3870 array( 'parseinline', 'replaceafter' ),
3876 $revision->getUser()
3879 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3880 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3882 $wgOut->setSubtitle( $r );
3886 * This function is called right before saving the wikitext,
3887 * so we can do things like signatures and links-in-context.
3889 * @param $text String article contents
3890 * @return string article contents with altered wikitext markup (signatures
3891 * converted, {{subst:}}, templates, etc.)
3893 public function preSaveTransform( $text ) {
3894 global $wgParser, $wgUser;
3896 return $wgParser->preSaveTransform( $text, $this->mTitle
, $wgUser, ParserOptions
::newFromUser( $wgUser ) );
3899 /* Caching functions */
3902 * checkLastModified returns true if it has taken care of all
3903 * output to the client that is necessary for this request.
3904 * (that is, it has sent a cached version of the page)
3906 * @return boolean true if cached version send, false otherwise
3908 protected function tryFileCache() {
3909 static $called = false;
3912 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3917 if ( $this->isFileCacheable() ) {
3918 $cache = new HTMLFileCache( $this->mTitle
);
3919 if ( $cache->isFileCacheGood( $this->mTouched
) ) {
3920 wfDebug( "Article::tryFileCache(): about to load file\n" );
3921 $cache->loadFromFileCache();
3924 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3925 ob_start( array( &$cache, 'saveToFileCache' ) );
3928 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3935 * Check if the page can be cached
3938 public function isFileCacheable() {
3941 if ( HTMLFileCache
::useFileCache() ) {
3942 $cacheable = $this->getID() && !$this->mRedirectedFrom
;
3943 // Extension may have reason to disable file caching on some pages.
3945 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3953 * Loads page_touched and returns a value indicating if it should be used
3954 * @return boolean true if not a redirect
3956 public function checkTouched() {
3957 if ( !$this->mDataLoaded
) {
3958 $this->loadPageData();
3961 return !$this->mIsRedirect
;
3965 * Get the page_touched field
3966 * @return string containing GMT timestamp
3968 public function getTouched() {
3969 if ( !$this->mDataLoaded
) {
3970 $this->loadPageData();
3973 return $this->mTouched
;
3977 * Get the page_latest field
3978 * @return integer rev_id of current revision
3980 public function getLatest() {
3981 if ( !$this->mDataLoaded
) {
3982 $this->loadPageData();
3985 return (int)$this->mLatest
;
3989 * Edit an article without doing all that other stuff
3990 * The article must already exist; link tables etc
3991 * are not updated, caches are not flushed.
3993 * @param $text String: text submitted
3994 * @param $comment String: comment submitted
3995 * @param $minor Boolean: whereas it's a minor modification
3997 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3998 wfProfileIn( __METHOD__
);
4000 $dbw = wfGetDB( DB_MASTER
);
4001 $revision = new Revision( array(
4002 'page' => $this->getId(),
4004 'comment' => $comment,
4005 'minor_edit' => $minor ?
1 : 0,
4007 $revision->insertOn( $dbw );
4008 $this->updateRevisionOn( $dbw, $revision );
4011 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
4013 wfProfileOut( __METHOD__
);
4017 * Used to increment the view counter
4019 * @param $id Integer: article id
4021 public static function incViewCount( $id ) {
4022 $id = intval( $id );
4024 global $wgHitcounterUpdateFreq;
4026 $dbw = wfGetDB( DB_MASTER
);
4027 $pageTable = $dbw->tableName( 'page' );
4028 $hitcounterTable = $dbw->tableName( 'hitcounter' );
4029 $acchitsTable = $dbw->tableName( 'acchits' );
4030 $dbType = $dbw->getType();
4032 if ( $wgHitcounterUpdateFreq <= 1 ||
$dbType == 'sqlite' ) {
4033 $dbw->query( "UPDATE $pageTable SET page_counter = page_counter + 1 WHERE page_id = $id" );
4038 # Not important enough to warrant an error page in case of failure
4039 $oldignore = $dbw->ignoreErrors( true );
4041 $dbw->query( "INSERT INTO $hitcounterTable (hc_id) VALUES ({$id})" );
4043 $checkfreq = intval( $wgHitcounterUpdateFreq / 25 +
1 );
4044 if ( ( rand() %
$checkfreq != 0 ) or ( $dbw->lastErrno() != 0 ) ) {
4045 # Most of the time (or on SQL errors), skip row count check
4046 $dbw->ignoreErrors( $oldignore );
4051 $res = $dbw->query( "SELECT COUNT(*) as n FROM $hitcounterTable" );
4052 $row = $dbw->fetchObject( $res );
4053 $rown = intval( $row->n
);
4055 if ( $rown >= $wgHitcounterUpdateFreq ) {
4056 wfProfileIn( 'Article::incViewCount-collect' );
4057 $old_user_abort = ignore_user_abort( true );
4059 $dbw->lockTables( array(), array( 'hitcounter' ), __METHOD__
, false );
4060 $tabletype = $dbType == 'mysql' ?
"ENGINE=HEAP " : '';
4061 $dbw->query( "CREATE TEMPORARY TABLE $acchitsTable $tabletype AS " .
4062 "SELECT hc_id,COUNT(*) AS hc_n FROM $hitcounterTable " .
4063 'GROUP BY hc_id', __METHOD__
);
4064 $dbw->delete( 'hitcounter', '*', __METHOD__
);
4065 $dbw->unlockTables( __METHOD__
);
4067 if ( $dbType == 'mysql' ) {
4068 $dbw->query( "UPDATE $pageTable,$acchitsTable SET page_counter=page_counter + hc_n " .
4069 'WHERE page_id = hc_id', __METHOD__
);
4071 $dbw->query( "UPDATE $pageTable SET page_counter=page_counter + hc_n " .
4072 "FROM $acchitsTable WHERE page_id = hc_id", __METHOD__
);
4074 $dbw->query( "DROP TABLE $acchitsTable", __METHOD__
);
4076 ignore_user_abort( $old_user_abort );
4077 wfProfileOut( 'Article::incViewCount-collect' );
4080 $dbw->ignoreErrors( $oldignore );
4084 * The onArticle*() functions are supposed to be a kind of hooks
4085 * which should be called whenever any of the specified actions
4088 * This is a good place to put code to clear caches, for instance.
4090 * This is called on page move and undelete, as well as edit
4092 * @param $title a title object
4094 public static function onArticleCreate( $title ) {
4095 # Update existence markers on article/talk tabs...
4096 if ( $title->isTalkPage() ) {
4097 $other = $title->getSubjectPage();
4099 $other = $title->getTalkPage();
4102 $other->invalidateCache();
4103 $other->purgeSquid();
4105 $title->touchLinks();
4106 $title->purgeSquid();
4107 $title->deleteTitleProtection();
4111 * Clears caches when article is deleted
4113 public static function onArticleDelete( $title ) {
4114 global $wgMessageCache;
4116 # Update existence markers on article/talk tabs...
4117 if ( $title->isTalkPage() ) {
4118 $other = $title->getSubjectPage();
4120 $other = $title->getTalkPage();
4123 $other->invalidateCache();
4124 $other->purgeSquid();
4126 $title->touchLinks();
4127 $title->purgeSquid();
4130 HTMLFileCache
::clearFileCache( $title );
4133 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
4134 $wgMessageCache->replace( $title->getDBkey(), false );
4138 if ( $title->getNamespace() == NS_FILE
) {
4139 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4140 $update->doUpdate();
4144 if ( $title->getNamespace() == NS_USER_TALK
) {
4145 $user = User
::newFromName( $title->getText(), false );
4146 $user->setNewtalk( false );
4150 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4154 * Purge caches on page update etc
4156 * @param $title Title object
4157 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4159 public static function onArticleEdit( $title ) {
4160 global $wgDeferredUpdateList;
4162 // Invalidate caches of articles which include this page
4163 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4165 // Invalidate the caches of all pages which redirect here
4166 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4168 # Purge squid for this page only
4169 $title->purgeSquid();
4171 # Clear file cache for this page only
4172 HTMLFileCache
::clearFileCache( $title );
4178 * Overriden by ImagePage class, only present here to avoid a fatal error
4179 * Called for ?action=revert
4181 public function revert() {
4183 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4187 * Info about this page
4188 * Called for ?action=info when $wgAllowPageInfo is on.
4190 public function info() {
4191 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4193 if ( !$wgAllowPageInfo ) {
4194 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4198 $page = $this->mTitle
->getSubjectPage();
4200 $wgOut->setPagetitle( $page->getPrefixedText() );
4201 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4202 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4204 if ( !$this->mTitle
->exists() ) {
4205 $wgOut->addHTML( '<div class="noarticletext">' );
4206 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
4207 // This doesn't quite make sense; the user is asking for
4208 // information about the _page_, not the message... -- RC
4209 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
4211 $msg = $wgUser->isLoggedIn()
4213 : 'noarticletextanon';
4214 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4217 $wgOut->addHTML( '</div>' );
4219 $dbr = wfGetDB( DB_SLAVE
);
4221 'wl_title' => $page->getDBkey(),
4222 'wl_namespace' => $page->getNamespace() );
4223 $numwatchers = $dbr->selectField(
4228 $this->getSelectOptions() );
4230 $pageInfo = $this->pageCountInfo( $page );
4231 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4234 //FIXME: unescaped messages
4235 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4236 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4239 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4242 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4245 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4248 $wgOut->addHTML( '</ul>' );
4253 * Return the total number of edits and number of unique editors
4254 * on a given page. If page does not exist, returns false.
4256 * @param $title Title object
4257 * @return mixed array or boolean false
4259 public function pageCountInfo( $title ) {
4260 $id = $title->getArticleId();
4266 $dbr = wfGetDB( DB_SLAVE
);
4267 $rev_clause = array( 'rev_page' => $id );
4268 $edits = $dbr->selectField(
4273 $this->getSelectOptions()
4275 $authors = $dbr->selectField(
4277 'COUNT(DISTINCT rev_user_text)',
4280 $this->getSelectOptions()
4283 return array( 'edits' => $edits, 'authors' => $authors );
4287 * Return a list of templates used by this article.
4288 * Uses the templatelinks table
4290 * @return Array of Title objects
4292 public function getUsedTemplates() {
4294 $id = $this->mTitle
->getArticleID();
4300 $dbr = wfGetDB( DB_SLAVE
);
4301 $res = $dbr->select( array( 'templatelinks' ),
4302 array( 'tl_namespace', 'tl_title' ),
4303 array( 'tl_from' => $id ),
4306 if ( $res !== false ) {
4307 foreach ( $res as $row ) {
4308 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
4316 * Returns a list of hidden categories this page is a member of.
4317 * Uses the page_props and categorylinks tables.
4319 * @return Array of Title objects
4321 public function getHiddenCategories() {
4323 $id = $this->mTitle
->getArticleID();
4329 $dbr = wfGetDB( DB_SLAVE
);
4330 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4332 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4333 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
4336 if ( $res !== false ) {
4337 foreach ( $res as $row ) {
4338 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
4346 * Return an applicable autosummary if one exists for the given edit.
4347 * @param $oldtext String: the previous text of the page.
4348 * @param $newtext String: The submitted text of the page.
4349 * @param $flags Bitmask: a bitmask of flags submitted for the edit.
4350 * @return string An appropriate autosummary, or an empty string.
4352 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4355 # Decide what kind of autosummary is needed.
4357 # Redirect autosummaries
4358 $ot = Title
::newFromRedirect( $oldtext );
4359 $rt = Title
::newFromRedirect( $newtext );
4361 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
4362 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4365 # New page autosummaries
4366 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
4367 # If they're making a new article, give its text, truncated, in the summary.
4369 $truncatedtext = $wgContLang->truncate(
4370 str_replace( "\n", ' ', $newtext ),
4371 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4373 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4376 # Blanking autosummaries
4377 if ( $oldtext != '' && $newtext == '' ) {
4378 return wfMsgForContent( 'autosumm-blank' );
4379 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4380 # Removing more than 90% of the article
4382 $truncatedtext = $wgContLang->truncate(
4384 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4386 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4389 # If we reach this point, there's no applicable autosummary for our case, so our
4390 # autosummary is empty.
4395 * Add the primary page-view wikitext to the output buffer
4396 * Saves the text into the parser cache if possible.
4397 * Updates templatelinks if it is out of date.
4399 * @param $text String
4400 * @param $cache Boolean
4401 * @param $parserOptions mixed ParserOptions object, or boolean false
4403 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4406 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4407 $wgOut->addParserOutput( $this->mParserOutput
);
4411 * This does all the heavy lifting for outputWikitext, except it returns the parser
4412 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4413 * say, embedding thread pages within a discussion system (LiquidThreads)
4415 * @param $text string
4416 * @param $cache boolean
4417 * @param $parserOptions parsing options, defaults to false
4418 * @return string containing parsed output
4420 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4421 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4423 if ( !$parserOptions ) {
4424 $parserOptions = $this->getParserOptions();
4428 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
4429 $parserOptions, true, true, $this->getRevIdFetched() );
4434 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4435 $this->mTitle
->getPrefixedDBkey() ) );
4438 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
4439 $parserCache = ParserCache
::singleton();
4440 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4443 // Make sure file cache is not used on uncacheable content.
4444 // Output that has magic words in it can still use the parser cache
4445 // (if enabled), though it will generally expire sooner.
4446 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
4447 $wgUseFileCache = false;
4450 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4452 return $this->mParserOutput
;
4456 * Get parser options suitable for rendering the primary article wikitext
4457 * @return mixed ParserOptions object or boolean false
4459 public function getParserOptions() {
4462 if ( !$this->mParserOptions
) {
4463 $this->mParserOptions
= new ParserOptions( $wgUser );
4464 $this->mParserOptions
->setTidy( true );
4465 $this->mParserOptions
->enableLimitReport();
4468 return $this->mParserOptions
;
4472 * Updates cascading protections
4474 * @param $parserOutput mixed ParserOptions object, or boolean false
4477 protected function doCascadeProtectionUpdates( $parserOutput ) {
4478 if ( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4482 // templatelinks table may have become out of sync,
4483 // especially if using variable-based transclusions.
4484 // For paranoia, check if things have changed and if
4485 // so apply updates to the database. This will ensure
4486 // that cascaded protections apply as soon as the changes
4489 # Get templates from templatelinks
4490 $id = $this->mTitle
->getArticleID();
4492 $tlTemplates = array();
4494 $dbr = wfGetDB( DB_SLAVE
);
4495 $res = $dbr->select( array( 'templatelinks' ),
4496 array( 'tl_namespace', 'tl_title' ),
4497 array( 'tl_from' => $id ),
4501 foreach ( $res as $row ) {
4502 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4505 # Get templates from parser output.
4506 $poTemplates = array();
4507 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4508 foreach ( $templates as $dbk => $id ) {
4509 $poTemplates["$ns:$dbk"] = true;
4514 # Note that we simulate array_diff_key in PHP <5.0.x
4515 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4517 if ( count( $templates_diff ) > 0 ) {
4518 # Whee, link updates time.
4519 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4525 * Update all the appropriate counts in the category table, given that
4526 * we've added the categories $added and deleted the categories $deleted.
4528 * @param $added array The names of categories that were added
4529 * @param $deleted array The names of categories that were deleted
4531 public function updateCategoryCounts( $added, $deleted ) {
4532 $ns = $this->mTitle
->getNamespace();
4533 $dbw = wfGetDB( DB_MASTER
);
4535 # First make sure the rows exist. If one of the "deleted" ones didn't
4536 # exist, we might legitimately not create it, but it's simpler to just
4537 # create it and then give it a negative value, since the value is bogus
4540 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4541 $insertCats = array_merge( $added, $deleted );
4542 if ( !$insertCats ) {
4543 # Okay, nothing to do
4547 $insertRows = array();
4549 foreach ( $insertCats as $cat ) {
4550 $insertRows[] = array(
4551 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4555 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4557 $addFields = array( 'cat_pages = cat_pages + 1' );
4558 $removeFields = array( 'cat_pages = cat_pages - 1' );
4560 if ( $ns == NS_CATEGORY
) {
4561 $addFields[] = 'cat_subcats = cat_subcats + 1';
4562 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4563 } elseif ( $ns == NS_FILE
) {
4564 $addFields[] = 'cat_files = cat_files + 1';
4565 $removeFields[] = 'cat_files = cat_files - 1';
4572 array( 'cat_title' => $added ),
4581 array( 'cat_title' => $deleted ),
4588 * Lightweight method to get the parser output for a page, checking the parser cache
4589 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4590 * consider, so it's not appropriate to use there.
4592 * @since 1.16 (r52326) for LiquidThreads
4594 * @param $oldid mixed integer Revision ID or null
4596 public function getParserOutput( $oldid = null ) {
4597 global $wgEnableParserCache, $wgUser;
4599 // Should the parser cache be used?
4600 $useParserCache = $wgEnableParserCache &&
4601 $wgUser->getStubThreshold() == 0 &&
4605 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4607 if ( $wgUser->getStubThreshold() ) {
4608 wfIncrStats( 'pcache_miss_stub' );
4611 $parserOutput = false;
4612 if ( $useParserCache ) {
4613 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4616 if ( $parserOutput === false ) {
4617 // Cache miss; parse and output it.
4618 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4620 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4622 return $parserOutput;
4626 // Deprecated methods
4628 * Get the database which should be used for reads
4631 * @deprecated - just call wfGetDB( DB_MASTER ) instead
4634 wfDeprecated( __METHOD__
);
4635 return wfGetDB( DB_MASTER
);