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 $this->mTitle
=& $title;
55 $this->mOldId
= $oldId;
59 * Constructor from an article article
60 * @param $id The article ID to load
62 public static function newFromID( $id ) {
63 $t = Title
::newFromID( $id );
64 # FIXME: doesn't inherit right
65 return $t == null ?
null : new self( $t );
66 # return $t == null ? null : new static( $t ); // PHP 5.3
70 * Tell the page view functions that this view was redirected
71 * from another page on the wiki.
72 * @param $from Title object.
74 public function setRedirectedFrom( Title
$from ) {
75 $this->mRedirectedFrom
= $from;
79 * If this page is a redirect, get its target
81 * The target will be fetched from the redirect table if possible.
82 * If this page doesn't have an entry there, call insertRedirect()
83 * @return mixed Title object, or null if this page is not a redirect
85 public function getRedirectTarget() {
86 if ( !$this->mTitle ||
!$this->mTitle
->isRedirect() )
88 if ( !is_null( $this->mRedirectTarget
) )
89 return $this->mRedirectTarget
;
90 # Query the redirect table
91 $dbr = wfGetDB( DB_SLAVE
);
92 $row = $dbr->selectRow( 'redirect',
93 array( 'rd_namespace', 'rd_title' ),
94 array( 'rd_from' => $this->getID() ),
98 return $this->mRedirectTarget
= Title
::makeTitle( $row->rd_namespace
, $row->rd_title
);
100 # This page doesn't have an entry in the redirect table
101 return $this->mRedirectTarget
= $this->insertRedirect();
105 * Insert an entry for this page into the redirect table.
107 * Don't call this function directly unless you know what you're doing.
108 * @return Title object
110 public function insertRedirect() {
111 $retval = Title
::newFromRedirect( $this->getContent() );
115 $dbw = wfGetDB( DB_MASTER
);
116 $dbw->replace( 'redirect', array( 'rd_from' ),
118 'rd_from' => $this->getID(),
119 'rd_namespace' => $retval->getNamespace(),
120 'rd_title' => $retval->getDBkey()
128 * Get the Title object this page redirects to
130 * @return mixed false, Title of in-wiki target, or string with URL
132 public function followRedirect() {
133 $text = $this->getContent();
134 return $this->followRedirectText( $text );
138 * Get the Title object this text redirects to
140 * @param $text string article content containing redirect info
141 * @return mixed false, Title of in-wiki target, or string with URL
143 public function followRedirectText( $text ) {
144 $rt = Title
::newFromRedirectRecurse( $text ); // recurse through to only get the final target
145 # process if title object is valid and not special:userlogout
147 if ( $rt->getInterwiki() != '' ) {
148 if ( $rt->isLocal() ) {
149 // Offsite wikis need an HTTP redirect.
151 // This can be hard to reverse and may produce loops,
152 // so they may be disabled in the site configuration.
153 $source = $this->mTitle
->getFullURL( 'redirect=no' );
154 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
157 if ( $rt->getNamespace() == NS_SPECIAL
) {
158 // Gotta handle redirects to special pages differently:
159 // Fill the HTTP response "Location" header and ignore
160 // the rest of the page we're on.
162 // This can be hard to reverse, so they may be disabled.
163 if ( $rt->isSpecial( 'Userlogout' ) ) {
166 return $rt->getFullURL();
172 // No or invalid redirect
177 * get the title object of the article
178 * @return Title object of current title
180 public function getTitle() {
181 return $this->mTitle
;
188 public function clear() {
189 $this->mDataLoaded
= false;
190 $this->mContentLoaded
= false;
192 $this->mCurID
= $this->mUser
= $this->mCounter
= -1; # Not loaded
193 $this->mRedirectedFrom
= null; # Title object if set
194 $this->mRedirectTarget
= null; # Title object if set
196 $this->mTimestamp
= $this->mComment
= '';
197 $this->mGoodAdjustment
= $this->mTotalAdjustment
= 0;
198 $this->mTouched
= '19700101000000';
199 $this->mForUpdate
= false;
200 $this->mIsRedirect
= false;
201 $this->mRevIdFetched
= 0;
202 $this->mRedirectUrl
= false;
203 $this->mLatest
= false;
204 $this->mPreparedEdit
= false;
208 * Note that getContent/loadContent do not follow redirects anymore.
209 * If you need to fetch redirectable content easily, try
210 * the shortcut in Article::followContent()
212 * @return Return the text of this revision
214 public function getContent() {
215 global $wgUser, $wgContLang, $wgOut, $wgMessageCache;
216 wfProfileIn( __METHOD__
);
217 if ( $this->getID() === 0 ) {
218 # If this is a MediaWiki:x message, then load the messages
219 # and return the message value for x.
220 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
221 # If this is a system message, get the default text.
222 list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle
->getText() ) );
223 $wgMessageCache->loadAllMessages( $lang );
224 $text = wfMsgGetKey( $message, false, $lang, false );
225 if ( wfEmptyMsg( $message, $text ) )
228 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
230 wfProfileOut( __METHOD__
);
233 $this->loadContent();
234 wfProfileOut( __METHOD__
);
235 return $this->mContent
;
240 * Get the text of the current revision. No side-effects...
242 * @return Return the text of the current revision
244 public function getRawText() {
245 // Check process cache for current revision
246 if ( $this->mContentLoaded
&& $this->mOldId
== 0 ) {
247 return $this->mContent
;
249 $rev = Revision
::newFromTitle( $this->mTitle
);
250 $text = $rev ?
$rev->getRawText() : false;
255 * This function returns the text of a section, specified by a number ($section).
256 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
257 * the first section before any such heading (section 0).
259 * If a section contains subsections, these are also returned.
261 * @param $text String: text to look in
262 * @param $section Integer: section number
263 * @return string text of the requested section
266 public function getSection( $text, $section ) {
268 return $wgParser->getSection( $text, $section );
272 * Get the text that needs to be saved in order to undo all revisions
273 * between $undo and $undoafter. Revisions must belong to the same page,
274 * must exist and must not be deleted
275 * @param $undo Revision
276 * @param $undoafter Revision Must be an earlier revision than $undo
277 * @return mixed string on success, false on failure
279 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
280 $undo_text = $undo->getText();
281 $undoafter_text = $undoafter->getText();
282 $cur_text = $this->getContent();
283 if ( $cur_text == $undo_text ) {
284 # No use doing a merge if it's just a straight revert.
285 return $undoafter_text;
288 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) )
294 * @return int The oldid of the article that is to be shown, 0 for the
297 public function getOldID() {
298 if ( is_null( $this->mOldId
) ) {
299 $this->mOldId
= $this->getOldIDFromRequest();
301 return $this->mOldId
;
305 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
307 * @return int The old id for the request
309 public function getOldIDFromRequest() {
311 $this->mRedirectUrl
= false;
312 $oldid = $wgRequest->getVal( 'oldid' );
313 if ( isset( $oldid ) ) {
314 $oldid = intval( $oldid );
315 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
316 $nextid = $this->mTitle
->getNextRevisionID( $oldid );
320 $this->mRedirectUrl
= $this->mTitle
->getFullURL( 'redirect=no' );
322 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
323 $previd = $this->mTitle
->getPreviousRevisionID( $oldid );
336 * Load the revision (including text) into this object
338 function loadContent() {
339 if ( $this->mContentLoaded
) return;
340 wfProfileIn( __METHOD__
);
342 $oldid = $this->getOldID();
343 # Pre-fill content with error message so that if something
344 # fails we'll have something telling us what we intended.
345 $this->mOldId
= $oldid;
346 $this->fetchContent( $oldid );
347 wfProfileOut( __METHOD__
);
352 * Fetch a page record with the given conditions
353 * @param $dbr Database object
354 * @param $conditions Array
355 * @return mixed Database result resource, or false on failure
357 protected function pageData( $dbr, $conditions ) {
371 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
372 $row = $dbr->selectRow(
378 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
383 * Fetch a page record matching the Title object's namespace and title
384 * using a sanitized title string
386 * @param $dbr Database object
387 * @param $title Title object
388 * @return mixed Database result resource, or false on failure
390 public function pageDataFromTitle( $dbr, $title ) {
391 return $this->pageData( $dbr, array(
392 'page_namespace' => $title->getNamespace(),
393 'page_title' => $title->getDBkey() ) );
397 * Fetch a page record matching the requested ID
399 * @param $dbr Database
402 protected function pageDataFromId( $dbr, $id ) {
403 return $this->pageData( $dbr, array( 'page_id' => $id ) );
407 * Set the general counter, title etc data loaded from
410 * @param $data Database row object or "fromdb"
412 public function loadPageData( $data = 'fromdb' ) {
413 if ( $data === 'fromdb' ) {
414 $dbr = wfGetDB( DB_MASTER
);
415 $data = $this->pageDataFromId( $dbr, $this->getId() );
418 $lc = LinkCache
::singleton();
420 $lc->addGoodLinkObj( $data->page_id
, $this->mTitle
, $data->page_len
, $data->page_is_redirect
);
422 $this->mTitle
->mArticleID
= intval( $data->page_id
);
424 # Old-fashioned restrictions
425 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
427 $this->mCounter
= intval( $data->page_counter
);
428 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
429 $this->mIsRedirect
= intval( $data->page_is_redirect
);
430 $this->mLatest
= intval( $data->page_latest
);
432 if ( is_object( $this->mTitle
) ) {
433 $lc->addBadLinkObj( $this->mTitle
);
435 $this->mTitle
->mArticleID
= 0;
438 $this->mDataLoaded
= true;
442 * Get text of an article from database
443 * Does *NOT* follow redirects.
445 * @param $oldid Int: 0 for whatever the latest revision is
446 * @return mixed string containing article contents, or false if null
448 function fetchContent( $oldid = 0 ) {
449 if ( $this->mContentLoaded
) {
450 return $this->mContent
;
453 $dbr = wfGetDB( DB_MASTER
);
455 # Pre-fill content with error message so that if something
456 # fails we'll have something telling us what we intended.
457 $t = $this->mTitle
->getPrefixedText();
458 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
459 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
462 $revision = Revision
::newFromId( $oldid );
463 if ( is_null( $revision ) ) {
464 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
467 $data = $this->pageDataFromId( $dbr, $revision->getPage() );
469 wfDebug( __METHOD__
. " failed to get page data linked to revision id $oldid\n" );
472 $this->mTitle
= Title
::makeTitle( $data->page_namespace
, $data->page_title
);
473 $this->loadPageData( $data );
475 if ( !$this->mDataLoaded
) {
476 $data = $this->pageDataFromTitle( $dbr, $this->mTitle
);
478 wfDebug( __METHOD__
. " failed to find page data for title " . $this->mTitle
->getPrefixedText() . "\n" );
481 $this->loadPageData( $data );
483 $revision = Revision
::newFromId( $this->mLatest
);
484 if ( is_null( $revision ) ) {
485 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id {$this->mLatest}\n" );
490 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
491 // We should instead work with the Revision object when we need it...
492 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
494 $this->mUser
= $revision->getUser();
495 $this->mUserText
= $revision->getUserText();
496 $this->mComment
= $revision->getComment();
497 $this->mTimestamp
= wfTimestamp( TS_MW
, $revision->getTimestamp() );
499 $this->mRevIdFetched
= $revision->getId();
500 $this->mContentLoaded
= true;
501 $this->mRevision
=& $revision;
503 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) ) ;
505 return $this->mContent
;
509 * Read/write accessor to select FOR UPDATE
511 * @param $x Mixed: FIXME
512 * @return mixed value of $x, or value stored in Article::mForUpdate
514 public function forUpdate( $x = null ) {
515 return wfSetVar( $this->mForUpdate
, $x );
519 * Get the database which should be used for reads
522 * @deprecated - just call wfGetDB( DB_MASTER ) instead
525 wfDeprecated( __METHOD__
);
526 return wfGetDB( DB_MASTER
);
530 * Get options for all SELECT statements
532 * @param $options Array: an optional options array which'll be appended to
534 * @return Array: options
536 protected function getSelectOptions( $options = '' ) {
537 if ( $this->mForUpdate
) {
538 if ( is_array( $options ) ) {
539 $options[] = 'FOR UPDATE';
541 $options = 'FOR UPDATE';
548 * @return int Page ID
550 public function getID() {
551 if ( $this->mTitle
) {
552 return $this->mTitle
->getArticleID();
559 * @return bool Whether or not the page exists in the database
561 public function exists() {
562 return $this->getId() > 0;
566 * Check if this page is something we're going to be showing
567 * some sort of sensible content for. If we return false, page
568 * views (plain action=view) will return an HTTP 404 response,
569 * so spiders and robots can know they're following a bad link.
573 public function hasViewableContent() {
574 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
578 * @return int The view count for the page
580 public function getCount() {
581 if ( -1 == $this->mCounter
) {
582 $id = $this->getID();
586 $dbr = wfGetDB( DB_SLAVE
);
587 $this->mCounter
= $dbr->selectField( 'page',
589 array( 'page_id' => $id ),
591 $this->getSelectOptions()
595 return $this->mCounter
;
599 * Determine whether a page would be suitable for being counted as an
600 * article in the site_stats table based on the title & its content
602 * @param $text String: text to analyze
605 public function isCountable( $text ) {
606 global $wgUseCommaCount;
608 $token = $wgUseCommaCount ?
',' : '[[';
609 return $this->mTitle
->isContentPage() && !$this->isRedirect( $text ) && in_string( $token, $text );
613 * Tests if the article text represents a redirect
615 * @param $text mixed string containing article contents, or boolean
618 public function isRedirect( $text = false ) {
619 if ( $text === false ) {
620 if ( $this->mDataLoaded
) {
621 return $this->mIsRedirect
;
623 // Apparently loadPageData was never called
624 $this->loadContent();
625 $titleObj = Title
::newFromRedirectRecurse( $this->fetchContent() );
627 $titleObj = Title
::newFromRedirect( $text );
629 return $titleObj !== null;
633 * Returns true if the currently-referenced revision is the current edit
634 * to this page (and it exists).
637 public function isCurrent() {
638 # If no oldid, this is the current version.
639 if ( $this->getOldID() == 0 ) {
642 return $this->exists() && isset( $this->mRevision
) && $this->mRevision
->isCurrent();
646 * Loads everything except the text
647 * This isn't necessary for all uses, so it's only done if needed.
649 protected function loadLastEdit() {
650 if ( -1 != $this->mUser
)
653 # New or non-existent articles have no user information
654 $id = $this->getID();
655 if ( 0 == $id ) return;
657 $this->mLastRevision
= Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $id );
658 if ( !is_null( $this->mLastRevision
) ) {
659 $this->mUser
= $this->mLastRevision
->getUser();
660 $this->mUserText
= $this->mLastRevision
->getUserText();
661 $this->mTimestamp
= $this->mLastRevision
->getTimestamp();
662 $this->mComment
= $this->mLastRevision
->getComment();
663 $this->mMinorEdit
= $this->mLastRevision
->isMinor();
664 $this->mRevIdFetched
= $this->mLastRevision
->getId();
669 * @return string GMT timestamp of last article revision
672 public function getTimestamp() {
673 // Check if the field has been filled by ParserCache::get()
674 if ( !$this->mTimestamp
) {
675 $this->loadLastEdit();
677 return wfTimestamp( TS_MW
, $this->mTimestamp
);
681 * @return int user ID for the user that made the last article revision
683 public function getUser() {
684 $this->loadLastEdit();
689 * @return string username of the user that made the last article revision
691 public function getUserText() {
692 $this->loadLastEdit();
693 return $this->mUserText
;
697 * @return string Comment stored for the last article revision
699 public function getComment() {
700 $this->loadLastEdit();
701 return $this->mComment
;
705 * Returns true if last revision was marked as "minor edit"
707 * @return boolean Minor edit indicator for the last article revision.
709 public function getMinorEdit() {
710 $this->loadLastEdit();
711 return $this->mMinorEdit
;
715 * Use this to fetch the rev ID used on page views
717 * @return int revision ID of last article revision
719 public function getRevIdFetched() {
720 $this->loadLastEdit();
721 return $this->mRevIdFetched
;
725 * @param $limit Integer: default 0.
726 * @param $offset Integer: default 0.
727 * @return UserArrayFromResult object with User objects of article contributors for requested range
729 public function getContributors( $limit = 0, $offset = 0 ) {
730 # XXX: this is expensive; cache this info somewhere.
732 $dbr = wfGetDB( DB_SLAVE
);
733 $revTable = $dbr->tableName( 'revision' );
734 $userTable = $dbr->tableName( 'user' );
736 $pageId = $this->getId();
738 $user = $this->getUser();
740 $excludeCond = "AND rev_user != $user";
742 $userText = $dbr->addQuotes( $this->getUserText() );
743 $excludeCond = "AND rev_user_text != $userText";
746 $deletedBit = $dbr->bitAnd( 'rev_deleted', Revision
::DELETED_USER
); // username hidden?
748 $sql = "SELECT {$userTable}.*, rev_user_text as user_name, MAX(rev_timestamp) as timestamp
749 FROM $revTable LEFT JOIN $userTable ON rev_user = user_id
750 WHERE rev_page = $pageId
753 GROUP BY rev_user, rev_user_text
754 ORDER BY timestamp DESC";
757 $sql = $dbr->limitResult( $sql, $limit, $offset );
759 $sql .= ' ' . $this->getSelectOptions();
760 $res = $dbr->query( $sql, __METHOD__
);
762 return new UserArrayFromResult( $res );
766 * This is the default action of the index.php entry point: just view the
767 * page of the given title.
769 public function view() {
770 global $wgUser, $wgOut, $wgRequest, $wgContLang;
771 global $wgEnableParserCache, $wgStylePath, $wgParser;
772 global $wgUseTrackbacks, $wgUseFileCache;
774 wfProfileIn( __METHOD__
);
776 # Get variables from query string
777 $oldid = $this->getOldID();
778 $parserCache = ParserCache
::singleton();
780 $parserOptions = clone $this->getParserOptions();
781 # Render printable version, use printable version cache
782 if ( $wgOut->isPrintable() ) {
783 $parserOptions->setIsPrintable( true );
786 # Try client and file cache
787 if ( $oldid === 0 && $this->checkTouched() ) {
790 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
792 # Is is client cached?
793 if ( $wgOut->checkLastModified( $this->getTouched() ) ) {
794 wfDebug( __METHOD__
. ": done 304\n" );
795 wfProfileOut( __METHOD__
);
798 } else if ( $wgUseFileCache && $this->tryFileCache() ) {
799 wfDebug( __METHOD__
. ": done file cache\n" );
800 # tell wgOut that output is taken care of
802 $this->viewUpdates();
803 wfProfileOut( __METHOD__
);
808 # getOldID may want us to redirect somewhere else
809 if ( $this->mRedirectUrl
) {
810 $wgOut->redirect( $this->mRedirectUrl
);
811 wfDebug( __METHOD__
. ": redirecting due to oldid\n" );
812 wfProfileOut( __METHOD__
);
816 $wgOut->setArticleFlag( true );
817 # Set page title (may be overridden by DISPLAYTITLE)
818 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
820 # If we got diff in the query, we want to see a diff page instead of the article.
821 if ( !is_null( $wgRequest->getVal( 'diff' ) ) ) {
822 wfDebug( __METHOD__
. ": showing diff page\n" );
823 $this->showDiffPage();
824 wfProfileOut( __METHOD__
);
828 # Should the parser cache be used?
829 $useParserCache = $this->useParserCache( $oldid );
830 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
831 if ( $wgUser->getOption( 'stubthreshold' ) ) {
832 wfIncrStats( 'pcache_miss_stub' );
835 $wasRedirected = $this->showRedirectedFromHeader();
836 $this->showNamespaceHeader();
838 # Iterate through the possible ways of constructing the output text.
839 # Keep going until $outputDone is set, or we run out of things to do.
842 $this->mParserOutput
= false;
843 while ( !$outputDone && ++
$pass ) {
846 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
850 # Try the parser cache
851 if ( $useParserCache ) {
852 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
853 if ( $this->mParserOutput
!== false ) {
854 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
855 $wgOut->addParserOutput( $this->mParserOutput
);
856 # Ensure that UI elements requiring revision ID have
857 # the correct version information.
858 $wgOut->setRevisionId( $this->mLatest
);
865 $text = $this->getContent();
866 if ( $text === false ||
$this->getID() == 0 ) {
867 wfDebug( __METHOD__
. ": showing missing article\n" );
868 $this->showMissingArticle();
869 wfProfileOut( __METHOD__
);
873 # Another whitelist check in case oldid is altering the title
874 if ( !$this->mTitle
->userCanRead() ) {
875 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
876 $wgOut->loginToUse();
879 wfProfileOut( __METHOD__
);
883 # Are we looking at an old revision
884 if ( $oldid && !is_null( $this->mRevision
) ) {
885 $this->setOldSubtitle( $oldid );
886 if ( !$this->showDeletedRevisionHeader() ) {
887 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
888 wfProfileOut( __METHOD__
);
891 # If this "old" version is the current, then try the parser cache...
892 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
893 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
894 if ( $this->mParserOutput
) {
895 wfDebug( __METHOD__
. ": showing parser cache for current rev permalink\n" );
896 $wgOut->addParserOutput( $this->mParserOutput
);
897 $wgOut->setRevisionId( $this->mLatest
);
898 $this->showViewFooter();
899 $this->viewUpdates();
900 wfProfileOut( __METHOD__
);
906 # Ensure that UI elements requiring revision ID have
907 # the correct version information.
908 $wgOut->setRevisionId( $this->getRevIdFetched() );
910 # Pages containing custom CSS or JavaScript get special treatment
911 if ( $this->mTitle
->isCssOrJsPage() ||
$this->mTitle
->isCssJsSubpage() ) {
912 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
913 $this->showCssOrJsPage();
915 } else if ( $rt = Title
::newFromRedirectArray( $text ) ) {
916 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
917 # Viewing a redirect page (e.g. with parameter redirect=no)
918 # Don't append the subtitle if this was an old revision
919 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
920 # Parse just to get categories, displaytitle, etc.
921 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
, $parserOptions );
922 $wgOut->addParserOutputNoText( $this->mParserOutput
);
928 # Run the parse, protected by a pool counter
929 wfDebug( __METHOD__
. ": doing uncached parse\n" );
930 $key = $parserCache->getKey( $this, $parserOptions );
931 $poolCounter = PoolCounter
::factory( 'Article::view', $key );
932 $dirtyCallback = $useParserCache ?
array( $this, 'tryDirtyCache' ) : false;
933 $status = $poolCounter->executeProtected( array( $this, 'doViewParse' ), $dirtyCallback );
935 if ( !$status->isOK() ) {
936 # Connection or timeout error
937 $this->showPoolError( $status );
938 wfProfileOut( __METHOD__
);
945 # Should be unreachable, but just in case...
951 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
952 if ( $this->mParserOutput
) {
953 $titleText = $this->mParserOutput
->getTitleText();
954 if ( strval( $titleText ) !== '' ) {
955 $wgOut->setPageTitle( $titleText );
959 # For the main page, overwrite the <title> element with the con-
960 # tents of 'pagetitle-view-mainpage' instead of the default (if
962 if ( $this->mTitle
->equals( Title
::newMainPage() )
963 && ( $m = wfMsgForContent( 'pagetitle-view-mainpage' ) ) !== '' )
965 $wgOut->setHTMLTitle( $m );
968 # Now that we've filled $this->mParserOutput, we know whether
969 # there are any __NOINDEX__ tags on the page
970 $policy = $this->getRobotPolicy( 'view' );
971 $wgOut->setIndexPolicy( $policy['index'] );
972 $wgOut->setFollowPolicy( $policy['follow'] );
974 $this->showViewFooter();
975 $this->viewUpdates();
976 wfProfileOut( __METHOD__
);
980 * Show a diff page according to current request variables. For use within
981 * Article::view() only, other callers should use the DifferenceEngine class.
983 public function showDiffPage() {
984 global $wgOut, $wgRequest, $wgUser;
986 $diff = $wgRequest->getVal( 'diff' );
987 $rcid = $wgRequest->getVal( 'rcid' );
988 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
989 $purge = $wgRequest->getVal( 'action' ) == 'purge';
990 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
991 $oldid = $this->getOldID();
993 $de = new DifferenceEngine( $this->mTitle
, $oldid, $diff, $rcid, $purge, $unhide );
994 // DifferenceEngine directly fetched the revision:
995 $this->mRevIdFetched
= $de->mNewid
;
996 $de->showDiffPage( $diffOnly );
998 // Needed to get the page's current revision
999 $this->loadPageData();
1000 if ( $diff == 0 ||
$diff == $this->mLatest
) {
1001 # Run view updates for current revision only
1002 $this->viewUpdates();
1007 * Show a page view for a page formatted as CSS or JavaScript. To be called by
1008 * Article::view() only.
1010 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
1013 public function showCssOrJsPage() {
1015 $wgOut->addHTML( wfMsgExt( 'clearyourcache', 'parse' ) );
1016 // Give hooks a chance to customise the output
1017 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->mTitle
, $wgOut ) ) ) {
1018 // Wrap the whole lot in a <pre> and don't parse
1020 preg_match( '!\.(css|js)$!u', $this->mTitle
->getText(), $m );
1021 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
1022 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
1023 $wgOut->addHTML( "\n</pre>\n" );
1028 * Get the robot policy to be used for the current action=view request.
1029 * @return String the policy that should be set
1030 * @deprecated use getRobotPolicy() instead, which returns an associative
1033 public function getRobotPolicyForView() {
1034 wfDeprecated( __METHOD__
);
1035 $policy = $this->getRobotPolicy( 'view' );
1036 return $policy['index'] . ',' . $policy['follow'];
1040 * Get the robot policy to be used for the current view
1041 * @param $action String the action= GET parameter
1042 * @return Array the policy that should be set
1043 * TODO: actions other than 'view'
1045 public function getRobotPolicy( $action ) {
1047 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1048 global $wgDefaultRobotPolicy, $wgRequest;
1050 $ns = $this->mTitle
->getNamespace();
1051 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
1052 # Don't index user and user talk pages for blocked users (bug 11443)
1053 if ( !$this->mTitle
->isSubpage() ) {
1054 $block = new Block();
1055 if ( $block->load( $this->mTitle
->getText() ) ) {
1056 return array( 'index' => 'noindex',
1057 'follow' => 'nofollow' );
1062 if ( $this->getID() === 0 ||
$this->getOldID() ) {
1063 # Non-articles (special pages etc), and old revisions
1064 return array( 'index' => 'noindex',
1065 'follow' => 'nofollow' );
1066 } elseif ( $wgOut->isPrintable() ) {
1067 # Discourage indexing of printable versions, but encourage following
1068 return array( 'index' => 'noindex',
1069 'follow' => 'follow' );
1070 } elseif ( $wgRequest->getInt( 'curid' ) ) {
1071 # For ?curid=x urls, disallow indexing
1072 return array( 'index' => 'noindex',
1073 'follow' => 'follow' );
1076 # Otherwise, construct the policy based on the various config variables.
1077 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
1079 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
1080 # Honour customised robot policies for this namespace
1081 $policy = array_merge( $policy,
1082 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] ) );
1084 if ( $this->mTitle
->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ) {
1085 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1086 # a final sanity check that we have really got the parser output.
1087 $policy = array_merge( $policy,
1088 array( 'index' => $this->mParserOutput
->getIndexPolicy() ) );
1091 if ( isset( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) ) {
1092 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1093 $policy = array_merge( $policy,
1094 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) );
1102 * Converts a String robot policy into an associative array, to allow
1103 * merging of several policies using array_merge().
1104 * @param $policy Mixed, returns empty array on null/false/'', transparent
1105 * to already-converted arrays, converts String.
1106 * @return associative Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1108 public static function formatRobotPolicy( $policy ) {
1109 if ( is_array( $policy ) ) {
1111 } elseif ( !$policy ) {
1115 $policy = explode( ',', $policy );
1116 $policy = array_map( 'trim', $policy );
1119 foreach ( $policy as $var ) {
1120 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
1121 $arr['index'] = $var;
1122 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
1123 $arr['follow'] = $var;
1130 * If this request is a redirect view, send "redirected from" subtitle to
1131 * $wgOut. Returns true if the header was needed, false if this is not a
1132 * redirect view. Handles both local and remote redirects.
1136 public function showRedirectedFromHeader() {
1137 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1139 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1140 $sk = $wgUser->getSkin();
1141 if ( isset( $this->mRedirectedFrom
) ) {
1142 // This is an internally redirected page view.
1143 // We'll need a backlink to the source page for navigation.
1144 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1146 $this->mRedirectedFrom
,
1149 array( 'redirect' => 'no' ),
1150 array( 'known', 'noclasses' )
1152 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1153 $wgOut->setSubtitle( $s );
1155 // Set the fragment if one was specified in the redirect
1156 if ( strval( $this->mTitle
->getFragment() ) != '' ) {
1157 $fragment = Xml
::escapeJsString( $this->mTitle
->getFragmentForURL() );
1158 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1161 // Add a <link rel="canonical"> tag
1162 $wgOut->addLink( array( 'rel' => 'canonical',
1163 'href' => $this->mTitle
->getLocalURL() )
1167 } elseif ( $rdfrom ) {
1168 // This is an externally redirected view, from some other wiki.
1169 // If it was reported from a trusted site, supply a backlink.
1170 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1171 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1172 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1173 $wgOut->setSubtitle( $s );
1181 * Show a header specific to the namespace currently being viewed, like
1182 * [[MediaWiki:Talkpagetext]]. For Article::view().
1184 public function showNamespaceHeader() {
1186 if ( $this->mTitle
->isTalkPage() ) {
1187 $msg = wfMsgNoTrans( 'talkpageheader' );
1188 if ( $msg !== '-' && !wfEmptyMsg( 'talkpageheader', $msg ) ) {
1189 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1</div>", array( 'talkpageheader' ) );
1195 * Show the footer section of an ordinary page view
1197 public function showViewFooter() {
1198 global $wgOut, $wgUseTrackbacks, $wgRequest;
1199 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1200 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->mTitle
->getText() ) ) {
1201 $wgOut->addWikiMsg( 'anontalkpagetext' );
1204 # If we have been passed an &rcid= parameter, we want to give the user a
1205 # chance to mark this new article as patrolled.
1206 $this->showPatrolFooter();
1209 if ( $wgUseTrackbacks ) {
1210 $this->addTrackbacks();
1215 * If patrol is possible, output a patrol UI box. This is called from the
1216 * footer section of ordinary page views. If patrol is not possible or not
1217 * desired, does nothing.
1219 public function showPatrolFooter() {
1220 global $wgOut, $wgRequest, $wgUser;
1221 $rcid = $wgRequest->getVal( 'rcid' );
1223 if ( !$rcid ||
!$this->mTitle
->exists() ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1227 $sk = $wgUser->getSkin();
1230 "<div class='patrollink'>" .
1232 'markaspatrolledlink',
1235 wfMsgHtml( 'markaspatrolledtext' ),
1238 'action' => 'markpatrolled',
1241 array( 'known', 'noclasses' )
1249 * Show the error text for a missing article. For articles in the MediaWiki
1250 * namespace, show the default message text. To be called from Article::view().
1252 public function showMissingArticle() {
1253 global $wgOut, $wgRequest, $wgUser;
1255 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1256 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1257 $parts = explode( '/', $this->mTitle
->getText() );
1258 $rootPart = $parts[0];
1259 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1260 $ip = User
::isIP( $rootPart );
1261 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1262 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1</div>",
1263 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1264 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1265 LogEventsList
::showLogExtract(
1268 $user->getUserPage()->getPrefixedText(),
1272 'showIfEmpty' => false,
1274 'blocked-notice-logextract',
1275 $user->getName() # Support GENDER in notice
1281 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1282 # Show delete and move logs
1283 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1285 'conds' => array( "log_action != 'revision'" ),
1286 'showIfEmpty' => false,
1287 'msgKey' => array( 'moveddeleted-notice' ) )
1290 # Show error message
1291 $oldid = $this->getOldID();
1293 $text = wfMsgNoTrans( 'missing-article',
1294 $this->mTitle
->getPrefixedText(),
1295 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1296 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1297 // Use the default message text
1298 $text = $this->getContent();
1300 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1301 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1302 $errors = array_merge( $createErrors, $editErrors );
1304 if ( !count( $errors ) )
1305 $text = wfMsgNoTrans( 'noarticletext' );
1307 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1309 $text = "<div class='noarticletext'>\n$text\n</div>";
1310 if ( !$this->hasViewableContent() ) {
1311 // If there's no backing content, send a 404 Not Found
1312 // for better machine handling of broken links.
1313 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1315 $wgOut->addWikiText( $text );
1319 * If the revision requested for view is deleted, check permissions.
1320 * Send either an error message or a warning header to $wgOut.
1322 * @return boolean true if the view is allowed, false if not.
1324 public function showDeletedRevisionHeader() {
1325 global $wgOut, $wgRequest;
1326 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1330 // If the user is not allowed to see it...
1331 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
1332 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1</div>\n",
1333 'rev-deleted-text-permission' );
1335 // If the user needs to confirm that they want to see it...
1336 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1337 # Give explanation and add a link to view the revision...
1338 $oldid = intval( $this->getOldID() );
1339 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1340 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1341 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1342 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1</div>\n",
1343 array( $msg, $link ) );
1345 // We are allowed to see...
1347 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1348 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1349 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1</div>\n", $msg );
1355 * Should the parser cache be used?
1359 public function useParserCache( $oldid ) {
1360 global $wgUser, $wgEnableParserCache;
1362 return $wgEnableParserCache
1363 && intval( $wgUser->getOption( 'stubthreshold' ) ) == 0
1366 && !$this->mTitle
->isCssOrJsPage()
1367 && !$this->mTitle
->isCssJsSubpage();
1371 * Execute the uncached parse for action=view
1373 public function doViewParse() {
1375 $oldid = $this->getOldID();
1376 $useParserCache = $this->useParserCache( $oldid );
1377 $parserOptions = clone $this->getParserOptions();
1378 # Render printable version, use printable version cache
1379 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1380 # Don't show section-edit links on old revisions... this way lies madness.
1381 $parserOptions->setEditSection( $this->isCurrent() );
1382 $useParserCache = $this->useParserCache( $oldid );
1383 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1387 * Try to fetch an expired entry from the parser cache. If it is present,
1388 * output it and return true. If it is not present, output nothing and
1389 * return false. This is used as a callback function for
1390 * PoolCounter::executeProtected().
1394 public function tryDirtyCache() {
1396 $parserCache = ParserCache
::singleton();
1397 $options = $this->getParserOptions();
1398 $options->setIsPrintable( $wgOut->isPrintable() );
1399 $output = $parserCache->getDirty( $this, $options );
1401 wfDebug( __METHOD__
. ": sending dirty output\n" );
1402 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1403 $wgOut->setSquidMaxage( 0 );
1404 $this->mParserOutput
= $output;
1405 $wgOut->addParserOutput( $output );
1406 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1409 wfDebugLog( 'dirty', "dirty missing\n" );
1410 wfDebug( __METHOD__
. ": no dirty cache\n" );
1416 * Show an error page for an error from the pool counter.
1417 * @param $status Status
1419 public function showPoolError( $status ) {
1421 $wgOut->clearHTML(); // for release() errors
1422 $wgOut->enableClientCache( false );
1423 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1424 $wgOut->addWikiText(
1425 '<div class="errorbox">' .
1426 $status->getWikiText( false, 'view-pool-error' ) .
1434 * @param $target Title object or Array of destination(s) to redirect
1435 * @param $appendSubtitle Boolean [optional]
1436 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1437 * @return string containing HMTL with redirect link
1439 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1440 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1442 if ( !is_array( $target ) ) {
1443 $target = array( $target );
1445 $imageDir = $wgContLang->getDir();
1446 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1447 $imageUrl2 = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1448 $alt2 = $wgContLang->isRTL() ?
'←' : '→'; // should -> and <- be used instead of entities?
1450 if ( $appendSubtitle ) {
1451 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1453 $sk = $wgUser->getSkin();
1454 // the loop prepends the arrow image before the link, so the first case needs to be outside
1455 $title = array_shift( $target );
1456 if ( $forceKnown ) {
1459 htmlspecialchars( $title->getFullText() ),
1462 array( 'known', 'noclasses' )
1465 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1467 // automatically append redirect=no to each link, since most of them are redirect pages themselves
1468 foreach ( $target as $rt ) {
1469 if ( $forceKnown ) {
1470 $link .= '<img src="' . $imageUrl2 . '" alt="' . $alt2 . ' " />'
1473 htmlspecialchars( $rt->getFullText() ),
1476 array( 'known', 'noclasses' )
1479 $link .= '<img src="' . $imageUrl2 . '" alt="' . $alt2 . ' " />'
1480 . $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1483 return '<img src="' . $imageUrl . '" alt="#REDIRECT " />' .
1484 '<span class="redirectText">' . $link . '</span>';
1489 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1491 public function addTrackbacks() {
1492 global $wgOut, $wgUser;
1493 $dbr = wfGetDB( DB_SLAVE
);
1494 $tbs = $dbr->select( 'trackbacks',
1495 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1496 array( 'tb_page' => $this->getID() )
1498 if ( !$dbr->numRows( $tbs ) ) return;
1501 while ( $o = $dbr->fetchObject( $tbs ) ) {
1503 if ( $wgUser->isAllowed( 'trackback' ) ) {
1504 $delurl = $this->mTitle
->getFullURL( "action=deletetrackback&tbid=" .
1505 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1506 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1509 $tbtext .= wfMsg( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1516 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>$1</div>\n", array( 'trackbackbox', $tbtext ) );
1520 * Removes trackback record for current article from trackbacks table
1522 public function deletetrackback() {
1523 global $wgUser, $wgRequest, $wgOut;
1524 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1525 $wgOut->addWikiMsg( 'sessionfailure' );
1529 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1530 if ( count( $permission_errors ) ) {
1531 $wgOut->showPermissionsErrorPage( $permission_errors );
1535 $db = wfGetDB( DB_MASTER
);
1536 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1538 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1539 $this->mTitle
->invalidateCache();
1543 * Handle action=render
1546 public function render() {
1548 $wgOut->setArticleBodyOnly( true );
1553 * Handle action=purge
1555 public function purge() {
1556 global $wgUser, $wgRequest, $wgOut;
1557 if ( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1558 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1563 $action = htmlspecialchars( $wgRequest->getRequestURL() );
1564 $button = wfMsgExt( 'confirm_purge_button', array( 'escapenoentities' ) );
1565 $form = "<form method=\"post\" action=\"$action\">\n" .
1566 "<input type=\"submit\" name=\"submit\" value=\"$button\" />\n" .
1568 $top = wfMsgExt( 'confirm-purge-top', array( 'parse' ) );
1569 $bottom = wfMsgExt( 'confirm-purge-bottom', array( 'parse' ) );
1570 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1571 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1572 $wgOut->addHTML( $top . $form . $bottom );
1577 * Perform the actions of a page purging
1579 public function doPurge() {
1581 // Invalidate the cache
1582 $this->mTitle
->invalidateCache();
1584 if ( $wgUseSquid ) {
1585 // Commit the transaction before the purge is sent
1586 $dbw = wfGetDB( DB_MASTER
);
1590 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1591 $update->doUpdate();
1593 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1594 global $wgMessageCache;
1595 if ( $this->getID() == 0 ) {
1598 $text = $this->getRawText();
1600 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1605 * Insert a new empty page record for this article.
1606 * This *must* be followed up by creating a revision
1607 * and running $this->updateRevisionOn( ... );
1608 * or else the record will be left in a funky state.
1609 * Best if all done inside a transaction.
1611 * @param $dbw Database
1612 * @return int The newly created page_id key, or false if the title already existed
1615 public function insertOn( $dbw ) {
1616 wfProfileIn( __METHOD__
);
1618 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1619 $dbw->insert( 'page', array(
1620 'page_id' => $page_id,
1621 'page_namespace' => $this->mTitle
->getNamespace(),
1622 'page_title' => $this->mTitle
->getDBkey(),
1623 'page_counter' => 0,
1624 'page_restrictions' => '',
1625 'page_is_redirect' => 0, # Will set this shortly...
1627 'page_random' => wfRandom(),
1628 'page_touched' => $dbw->timestamp(),
1629 'page_latest' => 0, # Fill this in shortly...
1630 'page_len' => 0, # Fill this in shortly...
1631 ), __METHOD__
, 'IGNORE' );
1633 $affected = $dbw->affectedRows();
1635 $newid = $dbw->insertId();
1636 $this->mTitle
->resetArticleId( $newid );
1638 wfProfileOut( __METHOD__
);
1639 return $affected ?
$newid : false;
1643 * Update the page record to point to a newly saved revision.
1645 * @param $dbw Database object
1646 * @param $revision Revision: For ID number, and text used to set
1647 length and redirect status fields
1648 * @param $lastRevision Integer: if given, will not overwrite the page field
1649 * when different from the currently set value.
1650 * Giving 0 indicates the new page flag should be set
1652 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1653 * removing rows in redirect table.
1654 * @return bool true on success, false on failure
1657 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null ) {
1658 wfProfileIn( __METHOD__
);
1660 $text = $revision->getText();
1661 $rt = Title
::newFromRedirect( $text );
1663 $conditions = array( 'page_id' => $this->getId() );
1664 if ( !is_null( $lastRevision ) ) {
1665 # An extra check against threads stepping on each other
1666 $conditions['page_latest'] = $lastRevision;
1669 $dbw->update( 'page',
1671 'page_latest' => $revision->getId(),
1672 'page_touched' => $dbw->timestamp(),
1673 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1674 'page_is_redirect' => $rt !== null ?
1 : 0,
1675 'page_len' => strlen( $text ),
1680 $result = $dbw->affectedRows() != 0;
1682 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1685 wfProfileOut( __METHOD__
);
1690 * Add row to the redirect table if this is a redirect, remove otherwise.
1692 * @param $dbw Database
1693 * @param $redirectTitle a title object pointing to the redirect target,
1694 * or NULL if this is not a redirect
1695 * @param $lastRevIsRedirect If given, will optimize adding and
1696 * removing rows in redirect table.
1697 * @return bool true on success, false on failure
1700 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1701 // Always update redirects (target link might have changed)
1702 // Update/Insert if we don't know if the last revision was a redirect or not
1703 // Delete if changing from redirect to non-redirect
1704 $isRedirect = !is_null( $redirectTitle );
1705 if ( $isRedirect ||
is_null( $lastRevIsRedirect ) ||
$lastRevIsRedirect !== $isRedirect ) {
1706 wfProfileIn( __METHOD__
);
1707 if ( $isRedirect ) {
1708 // This title is a redirect, Add/Update row in the redirect table
1709 $set = array( /* SET */
1710 'rd_namespace' => $redirectTitle->getNamespace(),
1711 'rd_title' => $redirectTitle->getDBkey(),
1712 'rd_from' => $this->getId(),
1714 $dbw->replace( 'redirect', array( 'rd_from' ), $set, __METHOD__
);
1716 // This is not a redirect, remove row from redirect table
1717 $where = array( 'rd_from' => $this->getId() );
1718 $dbw->delete( 'redirect', $where, __METHOD__
);
1720 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1721 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1723 wfProfileOut( __METHOD__
);
1724 return ( $dbw->affectedRows() != 0 );
1730 * If the given revision is newer than the currently set page_latest,
1731 * update the page record. Otherwise, do nothing.
1733 * @param $dbw Database object
1734 * @param $revision Revision object
1737 public function updateIfNewerOn( &$dbw, $revision ) {
1738 wfProfileIn( __METHOD__
);
1739 $row = $dbw->selectRow(
1740 array( 'revision', 'page' ),
1741 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1743 'page_id' => $this->getId(),
1744 'page_latest=rev_id' ),
1747 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1748 wfProfileOut( __METHOD__
);
1751 $prev = $row->rev_id
;
1752 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1754 # No or missing previous revision; mark the page as new
1756 $lastRevIsRedirect = null;
1758 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1759 wfProfileOut( __METHOD__
);
1764 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1765 * @param $text String: new text of the section
1766 * @param $summary String: new section's subject, only if $section is 'new'
1767 * @param $edittime String: revision timestamp or null to use the current revision
1768 * @return string Complete article text, or null if error
1770 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1771 wfProfileIn( __METHOD__
);
1772 if ( strval( $section ) == '' ) {
1773 // Whole-page edit; let the whole text through
1775 if ( is_null( $edittime ) ) {
1776 $rev = Revision
::newFromTitle( $this->mTitle
);
1778 $dbw = wfGetDB( DB_MASTER
);
1779 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1782 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1783 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1786 $oldtext = $rev->getText();
1788 if ( $section == 'new' ) {
1789 # Inserting a new section
1790 $subject = $summary ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1791 $text = strlen( trim( $oldtext ) ) > 0
1792 ?
"{$oldtext}\n\n{$subject}{$text}"
1793 : "{$subject}{$text}";
1795 # Replacing an existing section; roll out the big guns
1797 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1800 wfProfileOut( __METHOD__
);
1805 * This function is not deprecated until somebody fixes the core not to use
1806 * it. Nevertheless, use Article::doEdit() instead.
1808 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1809 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1810 ( $isminor ? EDIT_MINOR
: 0 ) |
1811 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1812 ( $bot ? EDIT_FORCE_BOT
: 0 );
1814 # If this is a comment, add the summary as headline
1815 if ( $comment && $summary != "" ) {
1816 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
1819 $this->doEdit( $text, $summary, $flags );
1821 $dbw = wfGetDB( DB_MASTER
);
1823 if ( !$this->mTitle
->userIsWatching() ) {
1829 if ( $this->mTitle
->userIsWatching() ) {
1835 $this->doRedirect( $this->isRedirect( $text ) );
1839 * @deprecated use Article::doEdit()
1841 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1842 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1843 ( $minor ? EDIT_MINOR
: 0 ) |
1844 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1846 $status = $this->doEdit( $text, $summary, $flags );
1847 if ( !$status->isOK() ) {
1851 $dbw = wfGetDB( DB_MASTER
);
1853 if ( !$this->mTitle
->userIsWatching() ) {
1859 if ( $this->mTitle
->userIsWatching() ) {
1866 $extraQuery = ''; // Give extensions a chance to modify URL query on update
1867 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
1869 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
1874 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1876 * @return Int updated $flags
1878 function checkFlags( $flags ) {
1879 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1880 if ( $this->mTitle
->getArticleID() ) {
1881 $flags |
= EDIT_UPDATE
;
1892 * Change an existing article or create a new article. Updates RC and all necessary caches,
1893 * optionally via the deferred update array.
1895 * $wgUser must be set before calling this function.
1897 * @param $text String: new text
1898 * @param $summary String: edit summary
1899 * @param $flags Integer bitfield:
1901 * Article is known or assumed to be non-existent, create a new one
1903 * Article is known or assumed to be pre-existing, update it
1905 * Mark this edit minor, if the user is allowed to do so
1907 * Do not log the change in recentchanges
1909 * Mark the edit a "bot" edit regardless of user rights
1910 * EDIT_DEFER_UPDATES
1911 * Defer some of the updates until the end of index.php
1913 * Fill in blank summaries with generated text where possible
1915 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1916 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
1917 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1918 * edit-already-exists error will be returned. These two conditions are also possible with
1919 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1921 * @param $baseRevId the revision ID this edit was based off, if any
1922 * @param $user Optional user object, $wgUser will be used if not passed
1924 * @return Status object. Possible errors:
1925 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1926 * edit-gone-missing: In update mode, but the article didn't exist
1927 * edit-conflict: In update mode, the article changed unexpectedly
1928 * edit-no-change: Warning that the text was the same as before
1929 * edit-already-exists: In creation mode, but the article already exists
1931 * Extensions may define additional errors.
1933 * $return->value will contain an associative array with members as follows:
1934 * new: Boolean indicating if the function attempted to create a new article
1935 * revision: The revision object for the inserted revision, or null
1937 * Compatibility note: this function previously returned a boolean value indicating success/failure
1939 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1940 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
1942 # Low-level sanity check
1943 if ( $this->mTitle
->getText() == '' ) {
1944 throw new MWException( 'Something is trying to edit an article with an empty title' );
1947 wfProfileIn( __METHOD__
);
1949 $user = is_null( $user ) ?
$wgUser : $user;
1950 $status = Status
::newGood( array() );
1952 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
1953 $this->loadPageData();
1955 $flags = $this->checkFlags( $flags );
1957 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
1958 $flags & EDIT_MINOR
, null, null, &$flags, &$status ) ) )
1960 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
1961 wfProfileOut( __METHOD__
);
1962 if ( $status->isOK() ) {
1963 $status->fatal( 'edit-hook-aborted' );
1968 # Silently ignore EDIT_MINOR if not allowed
1969 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
1970 $bot = $flags & EDIT_FORCE_BOT
;
1972 $oldtext = $this->getRawText(); // current revision
1973 $oldsize = strlen( $oldtext );
1975 # Provide autosummaries if one is not provided and autosummaries are enabled.
1976 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
1977 $summary = $this->getAutosummary( $oldtext, $text, $flags );
1980 $editInfo = $this->prepareTextForEdit( $text );
1981 $text = $editInfo->pst
;
1982 $newsize = strlen( $text );
1984 $dbw = wfGetDB( DB_MASTER
);
1985 $now = wfTimestampNow();
1986 $this->mTimestamp
= $now;
1988 if ( $flags & EDIT_UPDATE
) {
1989 # Update article, but only if changed.
1990 $status->value
['new'] = false;
1991 # Make sure the revision is either completely inserted or not inserted at all
1992 if ( !$wgDBtransactions ) {
1993 $userAbort = ignore_user_abort( true );
1998 $changed = ( strcmp( $text, $oldtext ) != 0 );
2001 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
2002 - (int)$this->isCountable( $oldtext );
2003 $this->mTotalAdjustment
= 0;
2005 if ( !$this->mLatest
) {
2006 # Article gone missing
2007 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
2008 $status->fatal( 'edit-gone-missing' );
2009 wfProfileOut( __METHOD__
);
2013 $revision = new Revision( array(
2014 'page' => $this->getId(),
2015 'comment' => $summary,
2016 'minor_edit' => $isminor,
2018 'parent_id' => $this->mLatest
,
2019 'user' => $user->getId(),
2020 'user_text' => $user->getName(),
2024 $revisionId = $revision->insertOn( $dbw );
2028 # Note that we use $this->mLatest instead of fetching a value from the master DB
2029 # during the course of this function. This makes sure that EditPage can detect
2030 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2031 # before this function is called. A previous function used a separate query, this
2032 # creates a window where concurrent edits can cause an ignored edit conflict.
2033 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
2036 /* Belated edit conflict! Run away!! */
2037 $status->fatal( 'edit-conflict' );
2038 # Delete the invalid revision if the DB is not transactional
2039 if ( !$wgDBtransactions ) {
2040 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
2045 global $wgUseRCPatrol;
2046 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2047 # Update recentchanges
2048 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2049 # Mark as patrolled if the user can do so
2050 $patrolled = $wgUseRCPatrol && $this->mTitle
->userCan( 'autopatrol' );
2051 # Add RC row to the DB
2052 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
2053 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2054 $revisionId, $patrolled
2056 # Log auto-patrolled edits
2058 PatrolLog
::record( $rc, true );
2061 $user->incEditCount();
2065 $status->warning( 'edit-no-change' );
2067 // Keep the same revision ID, but do some updates on it
2068 $revisionId = $this->getRevIdFetched();
2069 // Update page_touched, this is usually implicit in the page update
2070 // Other cache updates are done in onArticleEdit()
2071 $this->mTitle
->invalidateCache();
2074 if ( !$wgDBtransactions ) {
2075 ignore_user_abort( $userAbort );
2077 // Now that ignore_user_abort is restored, we can respond to fatal errors
2078 if ( !$status->isOK() ) {
2079 wfProfileOut( __METHOD__
);
2083 # Invalidate cache of this article and all pages using this article
2084 # as a template. Partly deferred.
2085 Article
::onArticleEdit( $this->mTitle
);
2086 # Update links tables, site stats, etc.
2087 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed );
2089 # Create new article
2090 $status->value
['new'] = true;
2092 # Set statistics members
2093 # We work out if it's countable after PST to avoid counter drift
2094 # when articles are created with {{subst:}}
2095 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2096 $this->mTotalAdjustment
= 1;
2100 # Add the page record; stake our claim on this title!
2101 # This will return false if the article already exists
2102 $newid = $this->insertOn( $dbw );
2104 if ( $newid === false ) {
2106 $status->fatal( 'edit-already-exists' );
2107 wfProfileOut( __METHOD__
);
2111 # Save the revision text...
2112 $revision = new Revision( array(
2114 'comment' => $summary,
2115 'minor_edit' => $isminor,
2117 'user' => $user->getId(),
2118 'user_text' => $user->getName(),
2120 $revisionId = $revision->insertOn( $dbw );
2122 $this->mTitle
->resetArticleID( $newid );
2124 # Update the page record with revision data
2125 $this->updateRevisionOn( $dbw, $revision, 0 );
2127 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2128 # Update recentchanges
2129 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2130 global $wgUseRCPatrol, $wgUseNPPatrol;
2131 # Mark as patrolled if the user can do so
2132 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && $this->mTitle
->userCan( 'autopatrol' );
2133 # Add RC row to the DB
2134 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2135 '', strlen( $text ), $revisionId, $patrolled );
2136 # Log auto-patrolled edits
2138 PatrolLog
::record( $rc, true );
2141 $user->incEditCount();
2144 # Update links, etc.
2145 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true );
2148 Article
::onArticleCreate( $this->mTitle
);
2150 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2151 $flags & EDIT_MINOR
, null, null, &$flags, $revision ) );
2154 # Do updates right now unless deferral was requested
2155 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
2159 // Return the new revision (or null) to the caller
2160 $status->value
['revision'] = $revision;
2162 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2163 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId ) );
2165 wfProfileOut( __METHOD__
);
2170 * @deprecated wrapper for doRedirect
2172 public function showArticle( $text, $subtitle , $sectionanchor = '', $me2, $now, $summary, $oldid ) {
2173 wfDeprecated( __METHOD__
);
2174 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor );
2178 * Output a redirect back to the article.
2179 * This is typically used after an edit.
2181 * @param $noRedir Boolean: add redirect=no
2182 * @param $sectionAnchor String: section to redirect to, including "#"
2183 * @param $extraQuery String: extra query params
2185 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2188 $query = 'redirect=no';
2190 $query .= "&$query";
2192 $query = $extraQuery;
2194 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2198 * Mark this particular edit/page as patrolled
2200 public function markpatrolled() {
2201 global $wgOut, $wgRequest, $wgUseRCPatrol, $wgUseNPPatrol, $wgUser;
2202 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2204 # If we haven't been given an rc_id value, we can't do anything
2205 $rcid = (int) $wgRequest->getVal( 'rcid' );
2206 $rc = RecentChange
::newFromId( $rcid );
2207 if ( is_null( $rc ) ) {
2208 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2212 # It would be nice to see where the user had actually come from, but for now just guess
2213 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2214 $return = SpecialPage
::getTitleFor( $returnto );
2216 $dbw = wfGetDB( DB_MASTER
);
2217 $errors = $rc->doMarkPatrolled();
2219 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2220 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2224 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2225 // The hook itself has handled any output
2229 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2230 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2231 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2232 $wgOut->returnToMain( false, $return );
2236 if ( !empty( $errors ) ) {
2237 $wgOut->showPermissionsErrorPage( $errors );
2242 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2243 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2244 $wgOut->returnToMain( false, $return );
2248 * User-interface handler for the "watch" action
2250 public function watch() {
2251 global $wgUser, $wgOut;
2252 if ( $wgUser->isAnon() ) {
2253 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2256 if ( wfReadOnly() ) {
2257 $wgOut->readOnlyPage();
2260 if ( $this->doWatch() ) {
2261 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2262 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2263 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2265 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2269 * Add this page to $wgUser's watchlist
2270 * @return bool true on successful watch operation
2272 public function doWatch() {
2274 if ( $wgUser->isAnon() ) {
2277 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2278 $wgUser->addWatch( $this->mTitle
);
2279 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2285 * User interface handler for the "unwatch" action.
2287 public function unwatch() {
2288 global $wgUser, $wgOut;
2289 if ( $wgUser->isAnon() ) {
2290 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2293 if ( wfReadOnly() ) {
2294 $wgOut->readOnlyPage();
2297 if ( $this->doUnwatch() ) {
2298 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2299 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2300 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2302 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2306 * Stop watching a page
2307 * @return bool true on successful unwatch
2309 public function doUnwatch() {
2311 if ( $wgUser->isAnon() ) {
2314 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2315 $wgUser->removeWatch( $this->mTitle
);
2316 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2322 * action=protect handler
2324 public function protect() {
2325 $form = new ProtectionForm( $this );
2330 * action=unprotect handler (alias)
2332 public function unprotect() {
2337 * Update the article's restriction field, and leave a log entry.
2339 * @param $limit Array: set of restriction keys
2340 * @param $reason String
2341 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2342 * @param $expiry Array: per restriction type expiration
2343 * @return bool true on success
2345 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2346 global $wgUser, $wgContLang;
2348 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2350 $id = $this->mTitle
->getArticleID();
2352 wfDebug( "updateRestrictions failed: $id <= 0\n" );
2356 if ( wfReadOnly() ) {
2357 wfDebug( "updateRestrictions failed: read-only\n" );
2361 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2362 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2370 // Take this opportunity to purge out expired restrictions
2371 Title
::purgeExpiredRestrictions();
2373 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2374 # we expect a single selection, but the schema allows otherwise.
2376 $updated = Article
::flattenRestrictions( $limit );
2378 foreach ( $restrictionTypes as $action ) {
2379 if ( isset( $expiry[$action] ) ) {
2380 # Get current restrictions on $action
2381 $aLimits = $this->mTitle
->getRestrictions( $action );
2382 $current[$action] = implode( '', $aLimits );
2383 # Are any actual restrictions being dealt with here?
2384 $aRChanged = count( $aLimits ) ||
!empty( $limit[$action] );
2385 # If something changed, we need to log it. Checking $aRChanged
2386 # assures that "unprotecting" a page that is not protected does
2387 # not log just because the expiry was "changed".
2388 if ( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2394 $current = Article
::flattenRestrictions( $current );
2396 $changed = ( $changed ||
$current != $updated );
2397 $changed = $changed ||
( $updated && $this->mTitle
->areRestrictionsCascading() != $cascade );
2398 $protect = ( $updated != '' );
2400 # If nothing's changed, do nothing
2402 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2404 $dbw = wfGetDB( DB_MASTER
);
2406 # Prepare a null revision to be added to the history
2407 $modified = $current != '' && $protect;
2409 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2411 $comment_type = 'unprotectedarticle';
2413 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2415 # Only restrictions with the 'protect' right can cascade...
2416 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2417 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2418 # The schema allows multiple restrictions
2419 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) )
2421 $cascade_description = '';
2423 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2427 $comment .= ": $reason";
2429 $editComment = $comment;
2430 $encodedExpiry = array();
2431 $protect_description = '';
2432 foreach ( $limit as $action => $restrictions ) {
2433 if ( !isset( $expiry[$action] ) )
2434 $expiry[$action] = 'infinite';
2436 $encodedExpiry[$action] = Block
::encodeExpiry( $expiry[$action], $dbw );
2437 if ( $restrictions != '' ) {
2438 $protect_description .= "[$action=$restrictions] (";
2439 if ( $encodedExpiry[$action] != 'infinity' ) {
2440 $protect_description .= wfMsgForContent( 'protect-expiring',
2441 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2442 $wgContLang->date( $expiry[$action], false, false ) ,
2443 $wgContLang->time( $expiry[$action], false, false ) );
2445 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2447 $protect_description .= ') ';
2450 $protect_description = trim( $protect_description );
2452 if ( $protect_description && $protect )
2453 $editComment .= " ($protect_description)";
2455 $editComment .= "$cascade_description";
2456 # Update restrictions table
2457 foreach ( $limit as $action => $restrictions ) {
2458 if ( $restrictions != '' ) {
2459 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2460 array( 'pr_page' => $id,
2461 'pr_type' => $action,
2462 'pr_level' => $restrictions,
2463 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2464 'pr_expiry' => $encodedExpiry[$action] ), __METHOD__
);
2466 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2467 'pr_type' => $action ), __METHOD__
);
2471 # Insert a null revision
2472 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2473 $nullRevId = $nullRevision->insertOn( $dbw );
2475 $latest = $this->getLatest();
2476 # Update page record
2477 $dbw->update( 'page',
2479 'page_touched' => $dbw->timestamp(),
2480 'page_restrictions' => '',
2481 'page_latest' => $nullRevId
2482 ), array( /* WHERE */
2484 ), 'Article::protect'
2487 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2488 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2490 # Update the protection log
2491 $log = new LogPage( 'protect' );
2493 $params = array( $protect_description, $cascade ?
'cascade' : '' );
2494 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason ), $params );
2496 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2500 } # End "changed" check
2506 * Take an array of page restrictions and flatten it to a string
2507 * suitable for insertion into the page_restrictions field.
2508 * @param $limit Array
2511 protected static function flattenRestrictions( $limit ) {
2512 if ( !is_array( $limit ) ) {
2513 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2517 foreach ( $limit as $action => $restrictions ) {
2518 if ( $restrictions != '' ) {
2519 $bits[] = "$action=$restrictions";
2522 return implode( ':', $bits );
2526 * Auto-generates a deletion reason
2528 * @param &$hasHistory Boolean: whether the page has a history
2529 * @return mixed String containing deletion reason or empty string, or boolean false
2530 * if no revision occurred
2532 public function generateReason( &$hasHistory ) {
2534 $dbw = wfGetDB( DB_MASTER
);
2535 // Get the last revision
2536 $rev = Revision
::newFromTitle( $this->mTitle
);
2537 if ( is_null( $rev ) )
2540 // Get the article's contents
2541 $contents = $rev->getText();
2543 // If the page is blank, use the text from the previous revision,
2544 // which can only be blank if there's a move/import/protect dummy revision involved
2545 if ( $contents == '' ) {
2546 $prev = $rev->getPrevious();
2548 $contents = $prev->getText();
2553 // Find out if there was only one contributor
2554 // Only scan the last 20 revisions
2555 $res = $dbw->select( 'revision', 'rev_user_text',
2556 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2558 array( 'LIMIT' => 20 )
2560 if ( $res === false )
2561 // This page has no revisions, which is very weird
2564 $hasHistory = ( $res->numRows() > 1 );
2565 $row = $dbw->fetchObject( $res );
2566 if ( $row ) { // $row is false if the only contributor is hidden
2567 $onlyAuthor = $row->rev_user_text
;
2568 // Try to find a second contributor
2569 foreach ( $res as $row ) {
2570 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2571 $onlyAuthor = false;
2576 $onlyAuthor = false;
2578 $dbw->freeResult( $res );
2580 // Generate the summary with a '$1' placeholder
2582 // The current revision is blank and the one before is also
2583 // blank. It's just not our lucky day
2584 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2587 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2589 $reason = wfMsgForContent( 'excontent', '$1' );
2592 if ( $reason == '-' ) {
2593 // Allow these UI messages to be blanked out cleanly
2597 // Replace newlines with spaces to prevent uglyness
2598 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2599 // Calculate the maximum amount of chars to get
2600 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2601 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2602 $contents = $wgContLang->truncate( $contents, $maxLength );
2603 // Remove possible unfinished links
2604 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2605 // Now replace the '$1' placeholder
2606 $reason = str_replace( '$1', $contents, $reason );
2612 * UI entry point for page deletion
2614 public function delete() {
2615 global $wgUser, $wgOut, $wgRequest;
2617 $confirm = $wgRequest->wasPosted() &&
2618 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2620 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2621 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2623 $reason = $this->DeleteReasonList
;
2625 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
2626 // Entry from drop down menu + additional comment
2627 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2628 } elseif ( $reason == 'other' ) {
2629 $reason = $this->DeleteReason
;
2631 # Flag to hide all contents of the archived revisions
2632 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2634 # This code desperately needs to be totally rewritten
2636 # Read-only check...
2637 if ( wfReadOnly() ) {
2638 $wgOut->readOnlyPage();
2643 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2645 if ( count( $permission_errors ) > 0 ) {
2646 $wgOut->showPermissionsErrorPage( $permission_errors );
2650 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2652 # Better double-check that it hasn't been deleted yet!
2653 $dbw = wfGetDB( DB_MASTER
);
2654 $conds = $this->mTitle
->pageCond();
2655 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2656 if ( $latest === false ) {
2657 $wgOut->showFatalError(
2660 array( 'class' => 'error mw-error-cannotdelete' ),
2661 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2664 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2665 LogEventsList
::showLogExtract(
2668 $this->mTitle
->getPrefixedText()
2673 # Hack for big sites
2674 $bigHistory = $this->isBigDeletion();
2675 if ( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2676 global $wgLang, $wgDeleteRevisionsLimit;
2677 $wgOut->wrapWikiMsg( "<div class='error'>\n$1</div>\n",
2678 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2683 $this->doDelete( $reason, $suppress );
2684 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2686 } elseif ( $this->mTitle
->userIsWatching() ) {
2692 // Generate deletion reason
2693 $hasHistory = false;
2694 if ( !$reason ) $reason = $this->generateReason( $hasHistory );
2696 // If the page has a history, insert a warning
2697 if ( $hasHistory && !$confirm ) {
2699 $skin = $wgUser->getSkin();
2700 $revisions = $this->estimateRevisionCount();
2701 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2702 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2703 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2706 if ( $bigHistory ) {
2707 global $wgDeleteRevisionsLimit;
2708 $wgOut->wrapWikiMsg( "<div class='error'>\n$1</div>\n",
2709 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2713 return $this->confirmDelete( $reason );
2717 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2719 public function isBigDeletion() {
2720 global $wgDeleteRevisionsLimit;
2721 if ( $wgDeleteRevisionsLimit ) {
2722 $revCount = $this->estimateRevisionCount();
2723 return $revCount > $wgDeleteRevisionsLimit;
2729 * @return int approximate revision count
2731 public function estimateRevisionCount() {
2732 $dbr = wfGetDB( DB_SLAVE
);
2733 // For an exact count...
2734 // return $dbr->selectField( 'revision', 'COUNT(*)',
2735 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2736 return $dbr->estimateRowCount( 'revision', '*',
2737 array( 'rev_page' => $this->getId() ), __METHOD__
);
2741 * Get the last N authors
2742 * @param $num Integer: number of revisions to get
2743 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2744 * @return array Array of authors, duplicates not removed
2746 public function getLastNAuthors( $num, $revLatest = 0 ) {
2747 wfProfileIn( __METHOD__
);
2748 // First try the slave
2749 // If that doesn't have the latest revision, try the master
2751 $db = wfGetDB( DB_SLAVE
);
2753 $res = $db->select( array( 'page', 'revision' ),
2754 array( 'rev_id', 'rev_user_text' ),
2756 'page_namespace' => $this->mTitle
->getNamespace(),
2757 'page_title' => $this->mTitle
->getDBkey(),
2758 'rev_page = page_id'
2759 ), __METHOD__
, $this->getSelectOptions( array(
2760 'ORDER BY' => 'rev_timestamp DESC',
2765 wfProfileOut( __METHOD__
);
2768 $row = $db->fetchObject( $res );
2769 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
2770 $db = wfGetDB( DB_MASTER
);
2775 } while ( $continue );
2777 $authors = array( $row->rev_user_text
);
2778 while ( $row = $db->fetchObject( $res ) ) {
2779 $authors[] = $row->rev_user_text
;
2781 wfProfileOut( __METHOD__
);
2786 * Output deletion confirmation dialog
2787 * @param $reason String: prefilled reason
2789 public function confirmDelete( $reason ) {
2790 global $wgOut, $wgUser;
2792 wfDebug( "Article::confirmDelete\n" );
2794 $deleteBackLink = $wgUser->getSkin()->link(
2799 array( 'known', 'noclasses' )
2801 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
2802 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2803 $wgOut->addWikiMsg( 'confirmdeletetext' );
2805 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
2807 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
2808 $suppress = "<tr id=\"wpDeleteSuppressRow\" name=\"wpDeleteSuppressRow\">
2810 <td class='mw-input'><strong>" .
2811 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
2812 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
2818 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
2820 $form = Xml
::openElement( 'form', array( 'method' => 'post',
2821 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
2822 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
2823 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
2824 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
2825 "<tr id=\"wpDeleteReasonListRow\">
2826 <td class='mw-label'>" .
2827 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
2829 <td class='mw-input'>" .
2830 Xml
::listDropDown( 'wpDeleteReasonList',
2831 wfMsgForContent( 'deletereason-dropdown' ),
2832 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
2835 <tr id=\"wpDeleteReasonRow\">
2836 <td class='mw-label'>" .
2837 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
2839 <td class='mw-input'>" .
2840 Html
::input( 'wpReason', $reason, 'text', array(
2842 'maxlength' => '255',
2849 # Dissalow watching is user is not logged in
2850 if ( $wgUser->isLoggedIn() ) {
2854 <td class='mw-input'>" .
2855 Xml
::checkLabel( wfMsg( 'watchthis' ),
2856 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
2864 <td class='mw-submit'>" .
2865 Xml
::submitButton( wfMsg( 'deletepage' ),
2866 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
2869 Xml
::closeElement( 'table' ) .
2870 Xml
::closeElement( 'fieldset' ) .
2871 Xml
::hidden( 'wpEditToken', $wgUser->editToken() ) .
2872 Xml
::closeElement( 'form' );
2874 if ( $wgUser->isAllowed( 'editinterface' ) ) {
2875 $skin = $wgUser->getSkin();
2876 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
2877 $link = $skin->link(
2879 wfMsgHtml( 'delete-edit-reasonlist' ),
2881 array( 'action' => 'edit' )
2883 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
2886 $wgOut->addHTML( $form );
2887 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2888 LogEventsList
::showLogExtract(
2891 $this->mTitle
->getPrefixedText()
2896 * Perform a deletion and output success or failure messages
2898 public function doDelete( $reason, $suppress = false ) {
2899 global $wgOut, $wgUser;
2900 $id = $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
2903 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
2904 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
2905 $deleted = $this->mTitle
->getPrefixedText();
2907 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
2908 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2910 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
2912 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
2913 $wgOut->returnToMain( false );
2914 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
2917 if ( $error == '' ) {
2918 $wgOut->showFatalError(
2921 array( 'class' => 'error mw-error-cannotdelete' ),
2922 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2925 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2926 LogEventsList
::showLogExtract(
2929 $this->mTitle
->getPrefixedText()
2932 $wgOut->showFatalError( $error );
2938 * Back-end article deletion
2939 * Deletes the article with database consistency, writes logs, purges caches
2941 * @param $reason string delete reason for deletion log
2942 * @param suppress bitfield
2943 * Revision::DELETED_TEXT
2944 * Revision::DELETED_COMMENT
2945 * Revision::DELETED_USER
2946 * Revision::DELETED_RESTRICTED
2947 * @param $id int article ID
2948 * @param $commit boolean defaults to true, triggers transaction end
2949 * @return boolean true if successful
2951 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
2952 global $wgUseSquid, $wgDeferredUpdateList;
2953 global $wgUseTrackbacks;
2955 wfDebug( __METHOD__
. "\n" );
2957 $dbw = wfGetDB( DB_MASTER
);
2958 $ns = $this->mTitle
->getNamespace();
2959 $t = $this->mTitle
->getDBkey();
2960 $id = $id ?
$id : $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
2962 if ( $t == '' ||
$id == 0 ) {
2966 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
2967 array_push( $wgDeferredUpdateList, $u );
2969 // Bitfields to further suppress the content
2972 // This should be 15...
2973 $bitfield |
= Revision
::DELETED_TEXT
;
2974 $bitfield |
= Revision
::DELETED_COMMENT
;
2975 $bitfield |
= Revision
::DELETED_USER
;
2976 $bitfield |
= Revision
::DELETED_RESTRICTED
;
2978 $bitfield = 'rev_deleted';
2982 // For now, shunt the revision data into the archive table.
2983 // Text is *not* removed from the text table; bulk storage
2984 // is left intact to avoid breaking block-compression or
2985 // immutable storage schemes.
2987 // For backwards compatibility, note that some older archive
2988 // table entries will have ar_text and ar_flags fields still.
2990 // In the future, we may keep revisions and mark them with
2991 // the rev_deleted field, which is reserved for this purpose.
2992 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2994 'ar_namespace' => 'page_namespace',
2995 'ar_title' => 'page_title',
2996 'ar_comment' => 'rev_comment',
2997 'ar_user' => 'rev_user',
2998 'ar_user_text' => 'rev_user_text',
2999 'ar_timestamp' => 'rev_timestamp',
3000 'ar_minor_edit' => 'rev_minor_edit',
3001 'ar_rev_id' => 'rev_id',
3002 'ar_text_id' => 'rev_text_id',
3003 'ar_text' => '\'\'', // Be explicit to appease
3004 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3005 'ar_len' => 'rev_len',
3006 'ar_page_id' => 'page_id',
3007 'ar_deleted' => $bitfield
3010 'page_id = rev_page'
3014 # Delete restrictions for it
3015 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
3017 # Now that it's safely backed up, delete it
3018 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
3019 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3025 # Fix category table counts
3027 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
3028 foreach ( $res as $row ) {
3029 $cats [] = $row->cl_to
;
3031 $this->updateCategoryCounts( array(), $cats );
3033 # If using cascading deletes, we can skip some explicit deletes
3034 if ( !$dbw->cascadingDeletes() ) {
3035 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
3037 if ( $wgUseTrackbacks )
3038 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
3040 # Delete outgoing links
3041 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3042 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3043 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3044 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3045 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3046 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3047 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3050 # If using cleanup triggers, we can skip some manual deletes
3051 if ( !$dbw->cleanupTriggers() ) {
3052 # Clean up recentchanges entries...
3053 $dbw->delete( 'recentchanges',
3054 array( 'rc_type != ' . RC_LOG
,
3055 'rc_namespace' => $this->mTitle
->getNamespace(),
3056 'rc_title' => $this->mTitle
->getDBkey() ),
3058 $dbw->delete( 'recentchanges',
3059 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
3064 Article
::onArticleDelete( $this->mTitle
);
3066 # Clear the cached article id so the interface doesn't act like we exist
3067 $this->mTitle
->resetArticleID( 0 );
3069 # Log the deletion, if the page was suppressed, log it at Oversight instead
3070 $logtype = $suppress ?
'suppress' : 'delete';
3071 $log = new LogPage( $logtype );
3073 # Make sure logging got through
3074 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
3084 * Roll back the most recent consecutive set of edits to a page
3085 * from the same user; fails if there are no eligible edits to
3086 * roll back to, e.g. user is the sole contributor. This function
3087 * performs permissions checks on $wgUser, then calls commitRollback()
3088 * to do the dirty work
3090 * @param $fromP String: Name of the user whose edits to rollback.
3091 * @param $summary String: Custom summary. Set to default summary if empty.
3092 * @param $token String: Rollback token.
3093 * @param $bot Boolean: If true, mark all reverted edits as bot.
3095 * @param $resultDetails Array: contains result-specific array of additional values
3096 * 'alreadyrolled' : 'current' (rev)
3097 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3099 * @return array of errors, each error formatted as
3100 * array(messagekey, param1, param2, ...).
3101 * On success, the array is empty. This array can also be passed to
3102 * OutputPage::showPermissionsErrorPage().
3104 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3106 $resultDetails = null;
3109 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
3110 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
3111 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3113 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) )
3114 $errors[] = array( 'sessionfailure' );
3116 if ( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3117 $errors[] = array( 'actionthrottledtext' );
3119 # If there were errors, bail out now
3120 if ( !empty( $errors ) )
3123 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3127 * Backend implementation of doRollback(), please refer there for parameter
3128 * and return value documentation
3130 * NOTE: This function does NOT check ANY permissions, it just commits the
3131 * rollback to the DB Therefore, you should only call this function direct-
3132 * ly if you want to use custom permissions checks. If you don't, use
3133 * doRollback() instead.
3135 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3136 global $wgUseRCPatrol, $wgUser, $wgLang;
3137 $dbw = wfGetDB( DB_MASTER
);
3139 if ( wfReadOnly() ) {
3140 return array( array( 'readonlytext' ) );
3143 # Get the last editor
3144 $current = Revision
::newFromTitle( $this->mTitle
);
3145 if ( is_null( $current ) ) {
3146 # Something wrong... no page?
3147 return array( array( 'notanarticle' ) );
3150 $from = str_replace( '_', ' ', $fromP );
3151 # User name given should match up with the top revision.
3152 # If the user was deleted then $from should be empty.
3153 if ( $from != $current->getUserText() ) {
3154 $resultDetails = array( 'current' => $current );
3155 return array( array( 'alreadyrolled',
3156 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3157 htmlspecialchars( $fromP ),
3158 htmlspecialchars( $current->getUserText() )
3162 # Get the last edit not by this guy...
3163 # Note: these may not be public values
3164 $user = intval( $current->getRawUser() );
3165 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3166 $s = $dbw->selectRow( 'revision',
3167 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3168 array( 'rev_page' => $current->getPage(),
3169 "rev_user != {$user} OR rev_user_text != {$user_text}"
3171 array( 'USE INDEX' => 'page_timestamp',
3172 'ORDER BY' => 'rev_timestamp DESC' )
3174 if ( $s === false ) {
3175 # No one else ever edited this page
3176 return array( array( 'cantrollback' ) );
3177 } else if ( $s->rev_deleted
& REVISION
::DELETED_TEXT ||
$s->rev_deleted
& REVISION
::DELETED_USER
) {
3178 # Only admins can see this text
3179 return array( array( 'notvisiblerev' ) );
3183 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3184 # Mark all reverted edits as bot
3187 if ( $wgUseRCPatrol ) {
3188 # Mark all reverted edits as patrolled
3189 $set['rc_patrolled'] = 1;
3192 if ( count( $set ) ) {
3193 $dbw->update( 'recentchanges', $set,
3195 'rc_cur_id' => $current->getPage(),
3196 'rc_user_text' => $current->getUserText(),
3197 "rc_timestamp > '{$s->rev_timestamp}'",
3202 # Generate the edit summary if necessary
3203 $target = Revision
::newFromId( $s->rev_id
);
3204 if ( empty( $summary ) ) {
3205 if ( $from == '' ) { // no public user name
3206 $summary = wfMsgForContent( 'revertpage-nouser' );
3208 $summary = wfMsgForContent( 'revertpage' );
3212 # Allow the custom summary to use the same args as the default message
3214 $target->getUserText(), $from, $s->rev_id
,
3215 $wgLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
), true ),
3216 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3218 $summary = wfMsgReplaceArgs( $summary, $args );
3221 $flags = EDIT_UPDATE
;
3223 if ( $wgUser->isAllowed( 'minoredit' ) )
3224 $flags |
= EDIT_MINOR
;
3226 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) ||
$wgUser->isAllowed( 'bot' ) ) )
3227 $flags |
= EDIT_FORCE_BOT
;
3228 # Actually store the edit
3229 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3230 if ( !empty( $status->value
['revision'] ) ) {
3231 $revId = $status->value
['revision']->getId();
3236 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3238 $resultDetails = array(
3239 'summary' => $summary,
3240 'current' => $current,
3241 'target' => $target,
3248 * User interface for rollback operations
3250 public function rollback() {
3251 global $wgUser, $wgOut, $wgRequest, $wgUseRCPatrol;
3254 $result = $this->doRollback(
3255 $wgRequest->getVal( 'from' ),
3256 $wgRequest->getText( 'summary' ),
3257 $wgRequest->getVal( 'token' ),
3258 $wgRequest->getBool( 'bot' ),
3262 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3263 $wgOut->rateLimited();
3266 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3267 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3268 $errArray = $result[0];
3269 $errMsg = array_shift( $errArray );
3270 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3271 if ( isset( $details['current'] ) ) {
3272 $current = $details['current'];
3273 if ( $current->getComment() != '' ) {
3274 $wgOut->addWikiMsgArray( 'editcomment', array(
3275 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3280 # Display permissions errors before read-only message -- there's no
3281 # point in misleading the user into thinking the inability to rollback
3282 # is only temporary.
3283 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3284 # array_diff is completely broken for arrays of arrays, sigh. Re-
3285 # move any 'readonlytext' error manually.
3287 foreach ( $result as $error ) {
3288 if ( $error != array( 'readonlytext' ) ) {
3292 $wgOut->showPermissionsErrorPage( $out );
3295 if ( $result == array( array( 'readonlytext' ) ) ) {
3296 $wgOut->readOnlyPage();
3300 $current = $details['current'];
3301 $target = $details['target'];
3302 $newId = $details['newid'];
3303 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3304 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3305 if ( $current->getUserText() === '' ) {
3306 $old = wfMsg( 'rev-deleted-user' );
3308 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3309 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3311 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3312 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3313 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3314 $wgOut->returnToMain( false, $this->mTitle
);
3316 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3317 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3318 $de->showDiff( '', '' );
3324 * Do standard deferred updates after page view
3326 public function viewUpdates() {
3327 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3328 if ( wfReadOnly() ) {
3331 # Don't update page view counters on views from bot users (bug 14044)
3332 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3333 Article
::incViewCount( $this->getID() );
3334 $u = new SiteStatsUpdate( 1, 0, 0 );
3335 array_push( $wgDeferredUpdateList, $u );
3337 # Update newtalk / watchlist notification status
3338 $wgUser->clearNotification( $this->mTitle
);
3342 * Prepare text which is about to be saved.
3343 * Returns a stdclass with source, pst and output members
3345 public function prepareTextForEdit( $text, $revid = null ) {
3346 if ( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid ) {
3348 return $this->mPreparedEdit
;
3351 $edit = (object)array();
3352 $edit->revid
= $revid;
3353 $edit->newText
= $text;
3354 $edit->pst
= $this->preSaveTransform( $text );
3355 $options = $this->getParserOptions();
3356 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $options, true, true, $revid );
3357 $edit->oldText
= $this->getContent();
3358 $this->mPreparedEdit
= $edit;
3363 * Do standard deferred updates after page edit.
3364 * Update links tables, site stats, search index and message cache.
3365 * Purges pages that include this page if the text was changed here.
3366 * Every 100th edit, prune the recent changes table.
3369 * @param $text New text of the article
3370 * @param $summary Edit summary
3371 * @param $minoredit Minor edit
3372 * @param $timestamp_of_pagechange Timestamp associated with the page change
3373 * @param $newid rev_id value of the new revision
3374 * @param $changed Whether or not the content actually changed
3376 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true ) {
3377 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3379 wfProfileIn( __METHOD__
);
3382 # Be careful not to double-PST: $text is usually already PST-ed once
3383 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3384 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3385 $editInfo = $this->prepareTextForEdit( $text, $newid );
3387 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3388 $editInfo = $this->mPreparedEdit
;
3391 # Save it to the parser cache
3392 if ( $wgEnableParserCache ) {
3393 $popts = $this->getParserOptions();
3394 $parserCache = ParserCache
::singleton();
3395 $parserCache->save( $editInfo->output
, $this, $popts );
3398 # Update the links tables
3399 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3402 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3404 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3405 if ( 0 == mt_rand( 0, 99 ) ) {
3406 // Flush old entries from the `recentchanges` table; we do this on
3407 // random requests so as to avoid an increase in writes for no good reason
3409 $dbw = wfGetDB( DB_MASTER
);
3410 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3411 $recentchanges = $dbw->tableName( 'recentchanges' );
3412 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3413 $dbw->query( $sql );
3417 $id = $this->getID();
3418 $title = $this->mTitle
->getPrefixedDBkey();
3419 $shortTitle = $this->mTitle
->getDBkey();
3422 wfProfileOut( __METHOD__
);
3426 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3427 array_push( $wgDeferredUpdateList, $u );
3428 $u = new SearchUpdate( $id, $title, $text );
3429 array_push( $wgDeferredUpdateList, $u );
3431 # If this is another user's talk page, update newtalk
3432 # Don't do this if $changed = false otherwise some idiot can null-edit a
3433 # load of user talk pages and piss people off, nor if it's a minor edit
3434 # by a properly-flagged bot.
3435 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3436 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) ) ) {
3437 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3438 $other = User
::newFromName( $shortTitle, false );
3440 wfDebug( __METHOD__
. ": invalid username\n" );
3441 } elseif ( User
::isIP( $shortTitle ) ) {
3442 // An anonymous user
3443 $other->setNewtalk( true );
3444 } elseif ( $other->isLoggedIn() ) {
3445 $other->setNewtalk( true );
3447 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3452 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3453 $wgMessageCache->replace( $shortTitle, $text );
3456 wfProfileOut( __METHOD__
);
3460 * Perform article updates on a special page creation.
3462 * @param $rev Revision object
3464 * @todo This is a shitty interface function. Kill it and replace the
3465 * other shitty functions like editUpdates and such so it's not needed
3468 public function createUpdates( $rev ) {
3469 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3470 $this->mTotalAdjustment
= 1;
3471 $this->editUpdates( $rev->getText(), $rev->getComment(),
3472 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3476 * Generate the navigation links when browsing through an article revisions
3477 * It shows the information as:
3478 * Revision as of \<date\>; view current revision
3479 * \<- Previous version | Next Version -\>
3481 * @param $oldid String: revision ID of this article revision
3483 public function setOldSubtitle( $oldid = 0 ) {
3484 global $wgLang, $wgOut, $wgUser, $wgRequest;
3486 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3490 $unhide = $wgRequest->getInt( 'unhide' ) == 1 &&
3491 $wgUser->matchEditToken( $wgRequest->getVal( 'token' ), $oldid );
3492 # Cascade unhide param in links for easy deletion browsing
3493 $extraParams = array();
3494 if ( $wgRequest->getVal( 'unhide' ) ) {
3495 $extraParams['unhide'] = 1;
3497 $revision = Revision
::newFromId( $oldid );
3499 $current = ( $oldid == $this->mLatest
);
3500 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3501 $tddate = $wgLang->date( $this->mTimestamp
, true );
3502 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3503 $sk = $wgUser->getSkin();
3505 ?
wfMsgHtml( 'currentrevisionlink' )
3508 wfMsgHtml( 'currentrevisionlink' ),
3511 array( 'known', 'noclasses' )
3514 ?
wfMsgHtml( 'diff' )
3517 wfMsgHtml( 'diff' ),
3523 array( 'known', 'noclasses' )
3525 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3529 wfMsgHtml( 'previousrevision' ),
3532 'direction' => 'prev',
3535 array( 'known', 'noclasses' )
3537 : wfMsgHtml( 'previousrevision' );
3541 wfMsgHtml( 'diff' ),
3547 array( 'known', 'noclasses' )
3549 : wfMsgHtml( 'diff' );
3550 $nextlink = $current
3551 ?
wfMsgHtml( 'nextrevision' )
3554 wfMsgHtml( 'nextrevision' ),
3557 'direction' => 'next',
3560 array( 'known', 'noclasses' )
3562 $nextdiff = $current
3563 ?
wfMsgHtml( 'diff' )
3566 wfMsgHtml( 'diff' ),
3572 array( 'known', 'noclasses' )
3576 // User can delete revisions or view deleted revisions...
3577 $canHide = $wgUser->isAllowed( 'deleterevision' );
3578 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3579 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3580 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3583 'type' => 'revision',
3584 'target' => $this->mTitle
->getPrefixedDbkey(),
3587 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
3592 # Show user links if allowed to see them. If hidden, then show them only if requested...
3593 $userlinks = $sk->revUserTools( $revision, !$unhide );
3595 $m = wfMsg( 'revision-info-current' );
3596 $infomsg = $current && !wfEmptyMsg( 'revision-info-current', $m ) && $m != '-'
3597 ?
'revision-info-current'
3600 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3603 array( 'parseinline', 'replaceafter' ),
3609 $revision->getUser()
3612 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3613 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3614 $wgOut->setSubtitle( $r );
3618 * This function is called right before saving the wikitext,
3619 * so we can do things like signatures and links-in-context.
3621 * @param $text String article contents
3622 * @return string article contents with altered wikitext markup (signatures
3623 * converted, {{subst:}}, templates, etc.)
3625 public function preSaveTransform( $text ) {
3626 global $wgParser, $wgUser;
3627 return $wgParser->preSaveTransform( $text, $this->mTitle
, $wgUser, ParserOptions
::newFromUser( $wgUser ) );
3630 /* Caching functions */
3633 * checkLastModified returns true if it has taken care of all
3634 * output to the client that is necessary for this request.
3635 * (that is, it has sent a cached version of the page)
3637 * @return boolean true if cached version send, false otherwise
3639 protected function tryFileCache() {
3640 static $called = false;
3642 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3646 if ( $this->isFileCacheable() ) {
3647 $cache = new HTMLFileCache( $this->mTitle
);
3648 if ( $cache->isFileCacheGood( $this->mTouched
) ) {
3649 wfDebug( "Article::tryFileCache(): about to load file\n" );
3650 $cache->loadFromFileCache();
3653 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3654 ob_start( array( &$cache, 'saveToFileCache' ) );
3657 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3663 * Check if the page can be cached
3666 public function isFileCacheable() {
3668 if ( HTMLFileCache
::useFileCache() ) {
3669 $cacheable = $this->getID() && !$this->mRedirectedFrom
;
3670 // Extension may have reason to disable file caching on some pages.
3672 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3679 * Loads page_touched and returns a value indicating if it should be used
3680 * @return boolean true if not a redirect
3682 public function checkTouched() {
3683 if ( !$this->mDataLoaded
) {
3684 $this->loadPageData();
3686 return !$this->mIsRedirect
;
3690 * Get the page_touched field
3691 * @return string containing GMT timestamp
3693 public function getTouched() {
3694 # Ensure that page data has been loaded
3695 if ( !$this->mDataLoaded
) {
3696 $this->loadPageData();
3698 return $this->mTouched
;
3702 * Get the page_latest field
3703 * @return integer rev_id of current revision
3705 public function getLatest() {
3706 if ( !$this->mDataLoaded
) {
3707 $this->loadPageData();
3709 return (int)$this->mLatest
;
3713 * Edit an article without doing all that other stuff
3714 * The article must already exist; link tables etc
3715 * are not updated, caches are not flushed.
3717 * @param $text String: text submitted
3718 * @param $comment String: comment submitted
3719 * @param $minor Boolean: whereas it's a minor modification
3721 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3722 wfProfileIn( __METHOD__
);
3724 $dbw = wfGetDB( DB_MASTER
);
3725 $revision = new Revision( array(
3726 'page' => $this->getId(),
3728 'comment' => $comment,
3729 'minor_edit' => $minor ?
1 : 0,
3731 $revision->insertOn( $dbw );
3732 $this->updateRevisionOn( $dbw, $revision );
3734 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
3736 wfProfileOut( __METHOD__
);
3740 * Used to increment the view counter
3742 * @param $id Integer: article id
3744 public static function incViewCount( $id ) {
3745 $id = intval( $id );
3746 global $wgHitcounterUpdateFreq;
3748 $dbw = wfGetDB( DB_MASTER
);
3749 $pageTable = $dbw->tableName( 'page' );
3750 $hitcounterTable = $dbw->tableName( 'hitcounter' );
3751 $acchitsTable = $dbw->tableName( 'acchits' );
3753 if ( $wgHitcounterUpdateFreq <= 1 ) {
3754 $dbw->query( "UPDATE $pageTable SET page_counter = page_counter + 1 WHERE page_id = $id" );
3758 # Not important enough to warrant an error page in case of failure
3759 $oldignore = $dbw->ignoreErrors( true );
3761 $dbw->query( "INSERT INTO $hitcounterTable (hc_id) VALUES ({$id})" );
3763 $checkfreq = intval( $wgHitcounterUpdateFreq / 25 +
1 );
3764 if ( ( rand() %
$checkfreq != 0 ) or ( $dbw->lastErrno() != 0 ) ) {
3765 # Most of the time (or on SQL errors), skip row count check
3766 $dbw->ignoreErrors( $oldignore );
3770 $res = $dbw->query( "SELECT COUNT(*) as n FROM $hitcounterTable" );
3771 $row = $dbw->fetchObject( $res );
3772 $rown = intval( $row->n
);
3773 if ( $rown >= $wgHitcounterUpdateFreq ) {
3774 wfProfileIn( 'Article::incViewCount-collect' );
3775 $old_user_abort = ignore_user_abort( true );
3777 $dbType = $dbw->getType();
3778 $dbw->lockTables( array(), array( 'hitcounter' ), __METHOD__
, false );
3779 $tabletype = $dbType == 'mysql' ?
"ENGINE=HEAP " : '';
3780 $dbw->query( "CREATE TEMPORARY TABLE $acchitsTable $tabletype AS " .
3781 "SELECT hc_id,COUNT(*) AS hc_n FROM $hitcounterTable " .
3782 'GROUP BY hc_id', __METHOD__
);
3783 $dbw->delete( 'hitcounter', '*', __METHOD__
);
3784 $dbw->unlockTables( __METHOD__
);
3785 if ( $dbType == 'mysql' ) {
3786 $dbw->query( "UPDATE $pageTable,$acchitsTable SET page_counter=page_counter + hc_n " .
3787 'WHERE page_id = hc_id', __METHOD__
);
3790 $dbw->query( "UPDATE $pageTable SET page_counter=page_counter + hc_n " .
3791 "FROM $acchitsTable WHERE page_id = hc_id", __METHOD__
);
3793 $dbw->query( "DROP TABLE $acchitsTable", __METHOD__
);
3795 ignore_user_abort( $old_user_abort );
3796 wfProfileOut( 'Article::incViewCount-collect' );
3798 $dbw->ignoreErrors( $oldignore );
3802 * The onArticle*() functions are supposed to be a kind of hooks
3803 * which should be called whenever any of the specified actions
3806 * This is a good place to put code to clear caches, for instance.
3808 * This is called on page move and undelete, as well as edit
3810 * @param $title a title object
3812 public static function onArticleCreate( $title ) {
3813 # Update existence markers on article/talk tabs...
3814 if ( $title->isTalkPage() ) {
3815 $other = $title->getSubjectPage();
3817 $other = $title->getTalkPage();
3819 $other->invalidateCache();
3820 $other->purgeSquid();
3822 $title->touchLinks();
3823 $title->purgeSquid();
3824 $title->deleteTitleProtection();
3828 * Clears caches when article is deleted
3830 public static function onArticleDelete( $title ) {
3831 global $wgMessageCache;
3832 # Update existence markers on article/talk tabs...
3833 if ( $title->isTalkPage() ) {
3834 $other = $title->getSubjectPage();
3836 $other = $title->getTalkPage();
3838 $other->invalidateCache();
3839 $other->purgeSquid();
3841 $title->touchLinks();
3842 $title->purgeSquid();
3845 HTMLFileCache
::clearFileCache( $title );
3848 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3849 $wgMessageCache->replace( $title->getDBkey(), false );
3852 if ( $title->getNamespace() == NS_FILE
) {
3853 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
3854 $update->doUpdate();
3857 if ( $title->getNamespace() == NS_USER_TALK
) {
3858 $user = User
::newFromName( $title->getText(), false );
3859 $user->setNewtalk( false );
3862 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3866 * Purge caches on page update etc
3868 * @param $title Title object
3869 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
3871 public static function onArticleEdit( $title ) {
3872 global $wgDeferredUpdateList;
3874 // Invalidate caches of articles which include this page
3875 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
3877 // Invalidate the caches of all pages which redirect here
3878 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
3880 # Purge squid for this page only
3881 $title->purgeSquid();
3883 # Clear file cache for this page only
3884 HTMLFileCache
::clearFileCache( $title );
3890 * Overriden by ImagePage class, only present here to avoid a fatal error
3891 * Called for ?action=revert
3893 public function revert() {
3895 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
3899 * Info about this page
3900 * Called for ?action=info when $wgAllowPageInfo is on.
3902 public function info() {
3903 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
3905 if ( !$wgAllowPageInfo ) {
3906 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
3910 $page = $this->mTitle
->getSubjectPage();
3912 $wgOut->setPagetitle( $page->getPrefixedText() );
3913 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
3914 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
3916 if ( !$this->mTitle
->exists() ) {
3917 $wgOut->addHTML( '<div class="noarticletext">' );
3918 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3919 // This doesn't quite make sense; the user is asking for
3920 // information about the _page_, not the message... -- RC
3921 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
3923 $msg = $wgUser->isLoggedIn()
3925 : 'noarticletextanon';
3926 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
3928 $wgOut->addHTML( '</div>' );
3930 $dbr = wfGetDB( DB_SLAVE
);
3932 'wl_title' => $page->getDBkey(),
3933 'wl_namespace' => $page->getNamespace() );
3934 $numwatchers = $dbr->selectField(
3939 $this->getSelectOptions() );
3941 $pageInfo = $this->pageCountInfo( $page );
3942 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
3944 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
3945 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
3947 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
3949 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
3951 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
3953 $wgOut->addHTML( '</ul>' );
3958 * Return the total number of edits and number of unique editors
3959 * on a given page. If page does not exist, returns false.
3961 * @param $title Title object
3962 * @return mixed array or boolean false
3964 public function pageCountInfo( $title ) {
3965 $id = $title->getArticleId();
3969 $dbr = wfGetDB( DB_SLAVE
);
3970 $rev_clause = array( 'rev_page' => $id );
3971 $edits = $dbr->selectField(
3976 $this->getSelectOptions()
3978 $authors = $dbr->selectField(
3980 'COUNT(DISTINCT rev_user_text)',
3983 $this->getSelectOptions()
3985 return array( 'edits' => $edits, 'authors' => $authors );
3989 * Return a list of templates used by this article.
3990 * Uses the templatelinks table
3992 * @return Array of Title objects
3994 public function getUsedTemplates() {
3996 $id = $this->mTitle
->getArticleID();
4000 $dbr = wfGetDB( DB_SLAVE
);
4001 $res = $dbr->select( array( 'templatelinks' ),
4002 array( 'tl_namespace', 'tl_title' ),
4003 array( 'tl_from' => $id ),
4005 if ( $res !== false ) {
4006 foreach ( $res as $row ) {
4007 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
4010 $dbr->freeResult( $res );
4015 * Returns a list of hidden categories this page is a member of.
4016 * Uses the page_props and categorylinks tables.
4018 * @return Array of Title objects
4020 public function getHiddenCategories() {
4022 $id = $this->mTitle
->getArticleID();
4026 $dbr = wfGetDB( DB_SLAVE
);
4027 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4029 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4030 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
4032 if ( $res !== false ) {
4033 foreach ( $res as $row ) {
4034 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
4037 $dbr->freeResult( $res );
4042 * Return an applicable autosummary if one exists for the given edit.
4043 * @param $oldtext String: the previous text of the page.
4044 * @param $newtext String: The submitted text of the page.
4045 * @param $flags Bitmask: a bitmask of flags submitted for the edit.
4046 * @return string An appropriate autosummary, or an empty string.
4048 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4049 # Decide what kind of autosummary is needed.
4051 # Redirect autosummaries
4052 $ot = Title
::newFromRedirect( $oldtext );
4053 $rt = Title
::newFromRedirect( $newtext );
4054 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
4055 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4058 # New page autosummaries
4059 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
4060 # If they're making a new article, give its text, truncated, in the summary.
4062 $truncatedtext = $wgContLang->truncate(
4063 str_replace( "\n", ' ', $newtext ),
4064 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4065 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4068 # Blanking autosummaries
4069 if ( $oldtext != '' && $newtext == '' ) {
4070 return wfMsgForContent( 'autosumm-blank' );
4071 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4072 # Removing more than 90% of the article
4074 $truncatedtext = $wgContLang->truncate(
4076 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4077 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4080 # If we reach this point, there's no applicable autosummary for our case, so our
4081 # autosummary is empty.
4086 * Add the primary page-view wikitext to the output buffer
4087 * Saves the text into the parser cache if possible.
4088 * Updates templatelinks if it is out of date.
4090 * @param $text String
4091 * @param $cache Boolean
4092 * @param $parserOptions mixed ParserOptions object, or boolean false
4094 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4097 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4098 $wgOut->addParserOutput( $this->mParserOutput
);
4102 * This does all the heavy lifting for outputWikitext, except it returns the parser
4103 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4104 * say, embedding thread pages within a discussion system (LiquidThreads)
4106 * @param $text string
4107 * @param $cache boolean
4108 * @param $parserOptions parsing options, defaults to false
4109 * @return string containing parsed output
4111 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4112 global $wgParser, $wgOut, $wgEnableParserCache, $wgUseFileCache;
4114 if ( !$parserOptions ) {
4115 $parserOptions = $this->getParserOptions();
4119 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
4120 $parserOptions, true, true, $this->getRevIdFetched() );
4125 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4126 $this->mTitle
->getPrefixedDBkey() ) );
4129 if ( $wgEnableParserCache && $cache && $this && $this->mParserOutput
->getCacheTime() != -1 ) {
4130 $parserCache = ParserCache
::singleton();
4131 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4133 // Make sure file cache is not used on uncacheable content.
4134 // Output that has magic words in it can still use the parser cache
4135 // (if enabled), though it will generally expire sooner.
4136 if ( $this->mParserOutput
->getCacheTime() == -1 ||
$this->mParserOutput
->containsOldMagic() ) {
4137 $wgUseFileCache = false;
4139 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4140 return $this->mParserOutput
;
4144 * Get parser options suitable for rendering the primary article wikitext
4145 * @return mixed ParserOptions object or boolean false
4147 public function getParserOptions() {
4149 if ( !$this->mParserOptions
) {
4150 $this->mParserOptions
= new ParserOptions( $wgUser );
4151 $this->mParserOptions
->setTidy( true );
4152 $this->mParserOptions
->enableLimitReport();
4154 return $this->mParserOptions
;
4158 * Updates cascading protections
4160 * @param $parserOutput mixed ParserOptions object, or boolean false
4163 protected function doCascadeProtectionUpdates( $parserOutput ) {
4164 if ( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4168 // templatelinks table may have become out of sync,
4169 // especially if using variable-based transclusions.
4170 // For paranoia, check if things have changed and if
4171 // so apply updates to the database. This will ensure
4172 // that cascaded protections apply as soon as the changes
4175 # Get templates from templatelinks
4176 $id = $this->mTitle
->getArticleID();
4178 $tlTemplates = array();
4180 $dbr = wfGetDB( DB_SLAVE
);
4181 $res = $dbr->select( array( 'templatelinks' ),
4182 array( 'tl_namespace', 'tl_title' ),
4183 array( 'tl_from' => $id ),
4187 foreach ( $res as $row ) {
4188 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4191 # Get templates from parser output.
4192 $poTemplates = array();
4193 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4194 foreach ( $templates as $dbk => $id ) {
4195 $poTemplates["$ns:$dbk"] = true;
4200 # Note that we simulate array_diff_key in PHP <5.0.x
4201 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4203 if ( count( $templates_diff ) > 0 ) {
4204 # Whee, link updates time.
4205 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4211 * Update all the appropriate counts in the category table, given that
4212 * we've added the categories $added and deleted the categories $deleted.
4214 * @param $added array The names of categories that were added
4215 * @param $deleted array The names of categories that were deleted
4217 public function updateCategoryCounts( $added, $deleted ) {
4218 $ns = $this->mTitle
->getNamespace();
4219 $dbw = wfGetDB( DB_MASTER
);
4221 # First make sure the rows exist. If one of the "deleted" ones didn't
4222 # exist, we might legitimately not create it, but it's simpler to just
4223 # create it and then give it a negative value, since the value is bogus
4226 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4227 $insertCats = array_merge( $added, $deleted );
4228 if ( !$insertCats ) {
4229 # Okay, nothing to do
4232 $insertRows = array();
4233 foreach ( $insertCats as $cat ) {
4234 $insertRows[] = array(
4235 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4239 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4241 $addFields = array( 'cat_pages = cat_pages + 1' );
4242 $removeFields = array( 'cat_pages = cat_pages - 1' );
4243 if ( $ns == NS_CATEGORY
) {
4244 $addFields[] = 'cat_subcats = cat_subcats + 1';
4245 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4246 } elseif ( $ns == NS_FILE
) {
4247 $addFields[] = 'cat_files = cat_files + 1';
4248 $removeFields[] = 'cat_files = cat_files - 1';
4255 array( 'cat_title' => $added ),
4263 array( 'cat_title' => $deleted ),
4270 * Lightweight method to get the parser output for a page, checking the parser cache
4271 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4272 * consider, so it's not appropriate to use there.
4274 * @param $oldid mixed integer Revision ID or null
4276 public function getParserOutput( $oldid = null ) {
4277 global $wgEnableParserCache, $wgUser, $wgOut;
4279 // Should the parser cache be used?
4280 $useParserCache = $wgEnableParserCache &&
4281 intval( $wgUser->getOption( 'stubthreshold' ) ) == 0 &&
4285 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4286 if ( $wgUser->getOption( 'stubthreshold' ) ) {
4287 wfIncrStats( 'pcache_miss_stub' );
4290 $parserOutput = false;
4291 if ( $useParserCache ) {
4292 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4295 if ( $parserOutput === false ) {
4296 // Cache miss; parse and output it.
4297 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4299 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4301 return $parserOutput;