8 * Class representing a MediaWiki article and history.
10 * See design.txt for an overview.
11 * Note: edit user interface and cache support functions have been
12 * moved to separate EditPage and HTMLFileCache classes.
14 * @internal documentation reviewed 15 Mar 2010
20 var $mComment = ''; // !<
22 var $mContentLoaded = false; // !<
23 var $mCounter = -1; // !< Not loaded
24 var $mCurID = -1; // !< Not loaded
25 var $mDataLoaded = false; // !<
26 var $mForUpdate = false; // !<
27 var $mGoodAdjustment = 0; // !<
28 var $mIsRedirect = false; // !<
29 var $mLatest = false; // !<
30 var $mMinorEdit; // !<
32 var $mPreparedEdit = false; // !< Title object if set
33 var $mRedirectedFrom = null; // !< Title object if set
34 var $mRedirectTarget = null; // !< Title object if set
35 var $mRedirectUrl = false; // !<
36 var $mRevIdFetched = 0; // !<
37 var $mRevision; // !< Revision object if set
38 var $mTimestamp = ''; // !<
39 var $mTitle; // !< Title object
40 var $mTotalAdjustment = 0; // !<
41 var $mTouched = '19700101000000'; // !<
42 var $mUser = -1; // !< Not loaded
43 var $mUserText = ''; // !< username from Revision if set
44 var $mParserOptions; // !< ParserOptions object
45 var $mParserOutput; // !< ParserCache object if set
49 * Constructor and clear the article
50 * @param $title Reference to a Title object.
51 * @param $oldId Integer revision ID, null to fetch from request, zero for current
53 public function __construct( Title
$title, $oldId = null ) {
54 // FIXME: does the reference play any role here?
55 $this->mTitle
=& $title;
56 $this->mOldId
= $oldId;
60 * Constructor from an page id
61 * @param $id The article ID to load
63 public static function newFromID( $id ) {
64 $t = Title
::newFromID( $id );
65 # FIXME: doesn't inherit right
66 return $t == null ?
null : new self( $t );
67 # return $t == null ? null : new static( $t ); // PHP 5.3
71 * Tell the page view functions that this view was redirected
72 * from another page on the wiki.
73 * @param $from Title object.
75 public function setRedirectedFrom( Title
$from ) {
76 $this->mRedirectedFrom
= $from;
80 * If this page is a redirect, get its target
82 * The target will be fetched from the redirect table if possible.
83 * If this page doesn't have an entry there, call insertRedirect()
84 * @return mixed Title object, or null if this page is not a redirect
86 public function getRedirectTarget() {
87 if ( !$this->mTitle
->isRedirect() ) {
91 if ( $this->mRedirectTarget
!== null ) {
92 return $this->mRedirectTarget
;
95 # Query the redirect table
96 $dbr = wfGetDB( DB_SLAVE
);
97 $row = $dbr->selectRow( 'redirect',
98 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
99 array( 'rd_from' => $this->getID() ),
103 // rd_fragment and rd_interwiki were added later, populate them if empty
104 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
105 return $this->mRedirectTarget
= Title
::makeTitle(
106 $row->rd_namespace
, $row->rd_title
,
107 $row->rd_fragment
, $row->rd_interwiki
);
110 # This page doesn't have an entry in the redirect table
111 return $this->mRedirectTarget
= $this->insertRedirect();
115 * Insert an entry for this page into the redirect table.
117 * Don't call this function directly unless you know what you're doing.
118 * @return Title object or null if not a redirect
120 public function insertRedirect() {
121 // recurse through to only get the final target
122 $retval = Title
::newFromRedirectRecurse( $this->getContent() );
126 $this->insertRedirectEntry( $retval );
131 * Insert or update the redirect table entry for this page to indicate
132 * it redirects to $rt .
133 * @param $rt Title redirect target
135 public function insertRedirectEntry( $rt ) {
136 $dbw = wfGetDB( DB_MASTER
);
137 $dbw->replace( 'redirect', array( 'rd_from' ),
139 'rd_from' => $this->getID(),
140 'rd_namespace' => $rt->getNamespace(),
141 'rd_title' => $rt->getDBkey(),
142 'rd_fragment' => $rt->getFragment(),
143 'rd_interwiki' => $rt->getInterwiki(),
150 * Get the Title object or URL this page redirects to
152 * @return mixed false, Title of in-wiki target, or string with URL
154 public function followRedirect() {
155 return $this->getRedirectURL( $this->getRedirectTarget() );
159 * Get the Title object this text redirects to
161 * @param $text string article content containing redirect info
162 * @return mixed false, Title of in-wiki target, or string with URL
165 public function followRedirectText( $text ) {
166 // recurse through to only get the final target
167 return $this->getRedirectURL( Title
::newFromRedirectRecurse( $text ) );
171 * Get the Title object or URL to use for a redirect. We use Title
172 * objects for same-wiki, non-special redirects and URLs for everything
174 * @param $rt Title Redirect target
175 * @return mixed false, Title object of local target, or string with URL
177 public function getRedirectURL( $rt ) {
179 if ( $rt->getInterwiki() != '' ) {
180 if ( $rt->isLocal() ) {
181 // Offsite wikis need an HTTP redirect.
183 // This can be hard to reverse and may produce loops,
184 // so they may be disabled in the site configuration.
185 $source = $this->mTitle
->getFullURL( 'redirect=no' );
186 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
189 if ( $rt->getNamespace() == NS_SPECIAL
) {
190 // Gotta handle redirects to special pages differently:
191 // Fill the HTTP response "Location" header and ignore
192 // the rest of the page we're on.
194 // This can be hard to reverse, so they may be disabled.
195 if ( $rt->isSpecial( 'Userlogout' ) ) {
198 return $rt->getFullURL();
206 // No or invalid redirect
211 * Get the title object of the article
212 * @return Title object of this page
214 public function getTitle() {
215 return $this->mTitle
;
220 * FIXME: shouldn't this be public?
223 public function clear() {
224 $this->mDataLoaded
= false;
225 $this->mContentLoaded
= false;
227 $this->mCurID
= $this->mUser
= $this->mCounter
= -1; # Not loaded
228 $this->mRedirectedFrom
= null; # Title object if set
229 $this->mRedirectTarget
= null; # Title object if set
231 $this->mTimestamp
= $this->mComment
= '';
232 $this->mGoodAdjustment
= $this->mTotalAdjustment
= 0;
233 $this->mTouched
= '19700101000000';
234 $this->mForUpdate
= false;
235 $this->mIsRedirect
= false;
236 $this->mRevIdFetched
= 0;
237 $this->mRedirectUrl
= false;
238 $this->mLatest
= false;
239 $this->mPreparedEdit
= false;
243 * Note that getContent/loadContent do not follow redirects anymore.
244 * If you need to fetch redirectable content easily, try
245 * the shortcut in Article::followRedirect()
247 * This function has side effects! Do not use this function if you
248 * only want the real revision text if any.
250 * @return Return the text of this revision
252 public function getContent() {
253 global $wgUser, $wgContLang, $wgMessageCache;
255 wfProfileIn( __METHOD__
);
257 if ( $this->getID() === 0 ) {
258 # If this is a MediaWiki:x message, then load the messages
259 # and return the message value for x.
260 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
261 # If this is a system message, get the default text.
262 list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle
->getText() ) );
263 $text = wfMsgGetKey( $message, false, $lang, false );
265 if ( wfEmptyMsg( $message, $text ) )
268 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
270 wfProfileOut( __METHOD__
);
274 $this->loadContent();
275 wfProfileOut( __METHOD__
);
277 return $this->mContent
;
282 * Get the text of the current revision. No side-effects...
284 * @return Return the text of the current revision
286 public function getRawText() {
287 // Check process cache for current revision
288 if ( $this->mContentLoaded
&& $this->mOldId
== 0 ) {
289 return $this->mContent
;
292 $rev = Revision
::newFromTitle( $this->mTitle
);
293 $text = $rev ?
$rev->getRawText() : false;
299 * This function returns the text of a section, specified by a number ($section).
300 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
301 * the first section before any such heading (section 0).
303 * If a section contains subsections, these are also returned.
305 * @param $text String: text to look in
306 * @param $section Integer: section number
307 * @return string text of the requested section
310 public function getSection( $text, $section ) {
312 return $wgParser->getSection( $text, $section );
316 * Get the text that needs to be saved in order to undo all revisions
317 * between $undo and $undoafter. Revisions must belong to the same page,
318 * must exist and must not be deleted
319 * @param $undo Revision
320 * @param $undoafter Revision Must be an earlier revision than $undo
321 * @return mixed string on success, false on failure
323 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
324 $undo_text = $undo->getText();
325 $undoafter_text = $undoafter->getText();
326 $cur_text = $this->getContent();
328 if ( $cur_text == $undo_text ) {
329 # No use doing a merge if it's just a straight revert.
330 return $undoafter_text;
335 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
343 * @return int The oldid of the article that is to be shown, 0 for the
346 public function getOldID() {
347 if ( is_null( $this->mOldId
) ) {
348 $this->mOldId
= $this->getOldIDFromRequest();
351 return $this->mOldId
;
355 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
357 * @return int The old id for the request
359 public function getOldIDFromRequest() {
362 $this->mRedirectUrl
= false;
364 $oldid = $wgRequest->getVal( 'oldid' );
366 if ( isset( $oldid ) ) {
367 $oldid = intval( $oldid );
368 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
369 $nextid = $this->mTitle
->getNextRevisionID( $oldid );
373 $this->mRedirectUrl
= $this->mTitle
->getFullURL( 'redirect=no' );
375 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
376 $previd = $this->mTitle
->getPreviousRevisionID( $oldid );
391 * Load the revision (including text) into this object
393 function loadContent() {
394 if ( $this->mContentLoaded
) {
398 wfProfileIn( __METHOD__
);
400 $oldid = $this->getOldID();
401 $this->mOldId
= $oldid;
402 $this->fetchContent( $oldid );
404 wfProfileOut( __METHOD__
);
408 * Fetch a page record with the given conditions
409 * @param $dbr Database object
410 * @param $conditions Array
411 * @return mixed Database result resource, or false on failure
413 protected function pageData( $dbr, $conditions ) {
428 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
430 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
);
432 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
438 * Fetch a page record matching the Title object's namespace and title
439 * using a sanitized title string
441 * @param $dbr Database object
442 * @param $title Title object
443 * @return mixed Database result resource, or false on failure
445 public function pageDataFromTitle( $dbr, $title ) {
446 return $this->pageData( $dbr, array(
447 'page_namespace' => $title->getNamespace(),
448 'page_title' => $title->getDBkey() ) );
452 * Fetch a page record matching the requested ID
454 * @param $dbr Database
457 protected function pageDataFromId( $dbr, $id ) {
458 return $this->pageData( $dbr, array( 'page_id' => $id ) );
462 * Set the general counter, title etc data loaded from
465 * @param $data Database row object or "fromdb"
467 public function loadPageData( $data = 'fromdb' ) {
468 if ( $data === 'fromdb' ) {
469 $dbr = wfGetDB( DB_MASTER
);
470 $data = $this->pageDataFromId( $dbr, $this->getId() );
473 $lc = LinkCache
::singleton();
476 $lc->addGoodLinkObj( $data->page_id
, $this->mTitle
, $data->page_len
, $data->page_is_redirect
, $data->page_latest
);
478 $this->mTitle
->mArticleID
= intval( $data->page_id
);
480 # Old-fashioned restrictions
481 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
483 $this->mCounter
= intval( $data->page_counter
);
484 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
485 $this->mIsRedirect
= intval( $data->page_is_redirect
);
486 $this->mLatest
= intval( $data->page_latest
);
488 $lc->addBadLinkObj( $this->mTitle
);
489 $this->mTitle
->mArticleID
= 0;
492 $this->mDataLoaded
= true;
496 * Get text of an article from database
497 * Does *NOT* follow redirects.
499 * @param $oldid Int: 0 for whatever the latest revision is
500 * @return mixed string containing article contents, or false if null
502 function fetchContent( $oldid = 0 ) {
503 if ( $this->mContentLoaded
) {
504 return $this->mContent
;
507 $dbr = wfGetDB( DB_MASTER
);
509 # Pre-fill content with error message so that if something
510 # fails we'll have something telling us what we intended.
511 $t = $this->mTitle
->getPrefixedText();
512 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
513 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
516 $revision = Revision
::newFromId( $oldid );
517 if ( $revision === null ) {
518 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
522 $data = $this->pageDataFromId( $dbr, $revision->getPage() );
525 wfDebug( __METHOD__
. " failed to get page data linked to revision id $oldid\n" );
529 $this->mTitle
= Title
::makeTitle( $data->page_namespace
, $data->page_title
);
530 $this->loadPageData( $data );
532 if ( !$this->mDataLoaded
) {
533 $data = $this->pageDataFromTitle( $dbr, $this->mTitle
);
536 wfDebug( __METHOD__
. " failed to find page data for title " . $this->mTitle
->getPrefixedText() . "\n" );
540 $this->loadPageData( $data );
542 $revision = Revision
::newFromId( $this->mLatest
);
543 if ( $revision === null ) {
544 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id {$this->mLatest}\n" );
549 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
550 // We should instead work with the Revision object when we need it...
551 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
553 $this->mUser
= $revision->getUser();
554 $this->mUserText
= $revision->getUserText();
555 $this->mComment
= $revision->getComment();
556 $this->mTimestamp
= wfTimestamp( TS_MW
, $revision->getTimestamp() );
558 $this->mRevIdFetched
= $revision->getId();
559 $this->mContentLoaded
= true;
560 $this->mRevision
=& $revision;
562 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) );
564 return $this->mContent
;
568 * Read/write accessor to select FOR UPDATE
570 * @param $x Mixed: FIXME
571 * @return mixed value of $x, or value stored in Article::mForUpdate
573 public function forUpdate( $x = null ) {
574 return wfSetVar( $this->mForUpdate
, $x );
578 * Get options for all SELECT statements
580 * @param $options Array: an optional options array which'll be appended to
582 * @return Array: options
584 protected function getSelectOptions( $options = '' ) {
585 if ( $this->mForUpdate
) {
586 if ( is_array( $options ) ) {
587 $options[] = 'FOR UPDATE';
589 $options = 'FOR UPDATE';
597 * @return int Page ID
599 public function getID() {
600 return $this->mTitle
->getArticleID();
604 * @return bool Whether or not the page exists in the database
606 public function exists() {
607 return $this->getId() > 0;
611 * Check if this page is something we're going to be showing
612 * some sort of sensible content for. If we return false, page
613 * views (plain action=view) will return an HTTP 404 response,
614 * so spiders and robots can know they're following a bad link.
618 public function hasViewableContent() {
619 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
623 * @return int The view count for the page
625 public function getCount() {
626 if ( -1 == $this->mCounter
) {
627 $id = $this->getID();
632 $dbr = wfGetDB( DB_SLAVE
);
633 $this->mCounter
= $dbr->selectField( 'page',
635 array( 'page_id' => $id ),
637 $this->getSelectOptions()
642 return $this->mCounter
;
646 * Determine whether a page would be suitable for being counted as an
647 * article in the site_stats table based on the title & its content
649 * @param $text String: text to analyze
652 public function isCountable( $text ) {
653 global $wgUseCommaCount;
655 $token = $wgUseCommaCount ?
',' : '[[';
657 return $this->mTitle
->isContentPage() && !$this->isRedirect( $text ) && in_string( $token, $text );
661 * Tests if the article text represents a redirect
663 * @param $text mixed string containing article contents, or boolean
666 public function isRedirect( $text = false ) {
667 if ( $text === false ) {
668 if ( $this->mDataLoaded
) {
669 return $this->mIsRedirect
;
672 // Apparently loadPageData was never called
673 $this->loadContent();
674 $titleObj = Title
::newFromRedirectRecurse( $this->fetchContent() );
676 $titleObj = Title
::newFromRedirect( $text );
679 return $titleObj !== null;
683 * Returns true if the currently-referenced revision is the current edit
684 * to this page (and it exists).
687 public function isCurrent() {
688 # If no oldid, this is the current version.
689 if ( $this->getOldID() == 0 ) {
693 return $this->exists() && isset( $this->mRevision
) && $this->mRevision
->isCurrent();
697 * Loads everything except the text
698 * This isn't necessary for all uses, so it's only done if needed.
700 protected function loadLastEdit() {
701 if ( -1 != $this->mUser
) {
705 # New or non-existent articles have no user information
706 $id = $this->getID();
711 $this->mLastRevision
= Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $id );
712 if ( !is_null( $this->mLastRevision
) ) {
713 $this->mUser
= $this->mLastRevision
->getUser();
714 $this->mUserText
= $this->mLastRevision
->getUserText();
715 $this->mTimestamp
= $this->mLastRevision
->getTimestamp();
716 $this->mComment
= $this->mLastRevision
->getComment();
717 $this->mMinorEdit
= $this->mLastRevision
->isMinor();
718 $this->mRevIdFetched
= $this->mLastRevision
->getId();
723 * @return string GMT timestamp of last article revision
726 public function getTimestamp() {
727 // Check if the field has been filled by ParserCache::get()
728 if ( !$this->mTimestamp
) {
729 $this->loadLastEdit();
732 return wfTimestamp( TS_MW
, $this->mTimestamp
);
736 * @return int user ID for the user that made the last article revision
738 public function getUser() {
739 $this->loadLastEdit();
744 * @return string username of the user that made the last article revision
746 public function getUserText() {
747 $this->loadLastEdit();
748 return $this->mUserText
;
752 * @return string Comment stored for the last article revision
754 public function getComment() {
755 $this->loadLastEdit();
756 return $this->mComment
;
760 * Returns true if last revision was marked as "minor edit"
762 * @return boolean Minor edit indicator for the last article revision.
764 public function getMinorEdit() {
765 $this->loadLastEdit();
766 return $this->mMinorEdit
;
770 * Use this to fetch the rev ID used on page views
772 * @return int revision ID of last article revision
774 public function getRevIdFetched() {
775 $this->loadLastEdit();
776 return $this->mRevIdFetched
;
780 * FIXME: this does what?
781 * @param $limit Integer: default 0.
782 * @param $offset Integer: default 0.
783 * @return UserArrayFromResult object with User objects of article contributors for requested range
785 public function getContributors( $limit = 0, $offset = 0 ) {
786 # FIXME: this is expensive; cache this info somewhere.
788 $dbr = wfGetDB( DB_SLAVE
);
789 $revTable = $dbr->tableName( 'revision' );
790 $userTable = $dbr->tableName( 'user' );
792 $pageId = $this->getId();
794 $user = $this->getUser();
797 $excludeCond = "AND rev_user != $user";
799 $userText = $dbr->addQuotes( $this->getUserText() );
800 $excludeCond = "AND rev_user_text != $userText";
803 $deletedBit = $dbr->bitAnd( 'rev_deleted', Revision
::DELETED_USER
); // username hidden?
805 $sql = "SELECT {$userTable}.*, rev_user_text as user_name, MAX(rev_timestamp) as timestamp
806 FROM $revTable LEFT JOIN $userTable ON rev_user = user_id
807 WHERE rev_page = $pageId
810 GROUP BY rev_user, rev_user_text
811 ORDER BY timestamp DESC";
814 $sql = $dbr->limitResult( $sql, $limit, $offset );
817 $sql .= ' ' . $this->getSelectOptions();
818 $res = $dbr->query( $sql, __METHOD__
);
820 return new UserArrayFromResult( $res );
824 * This is the default action of the index.php entry point: just view the
825 * page of the given title.
827 public function view() {
828 global $wgUser, $wgOut, $wgRequest, $wgParser;
829 global $wgUseFileCache, $wgUseETag;
831 wfProfileIn( __METHOD__
);
833 # Get variables from query string
834 $oldid = $this->getOldID();
835 $parserCache = ParserCache
::singleton();
837 $parserOptions = $this->getParserOptions();
838 # Render printable version, use printable version cache
839 if ( $wgOut->isPrintable() ) {
840 $parserOptions->setIsPrintable( true );
841 $parserOptions->setEditSection( false );
842 } else if ( $wgUseETag && !$this->mTitle
->quickUserCan( 'edit' ) ) {
843 $parserOptions->setEditSection( false );
846 # Try client and file cache
847 if ( $oldid === 0 && $this->checkTouched() ) {
849 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
852 # Is is client cached?
853 if ( $wgOut->checkLastModified( $this->getTouched() ) ) {
854 wfDebug( __METHOD__
. ": done 304\n" );
855 wfProfileOut( __METHOD__
);
859 } else if ( $wgUseFileCache && $this->tryFileCache() ) {
860 wfDebug( __METHOD__
. ": done file cache\n" );
861 # tell wgOut that output is taken care of
863 $this->viewUpdates();
864 wfProfileOut( __METHOD__
);
870 # getOldID may want us to redirect somewhere else
871 if ( $this->mRedirectUrl
) {
872 $wgOut->redirect( $this->mRedirectUrl
);
873 wfDebug( __METHOD__
. ": redirecting due to oldid\n" );
874 wfProfileOut( __METHOD__
);
879 $wgOut->setArticleFlag( true );
880 # Set page title (may be overridden by DISPLAYTITLE)
881 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
883 # If we got diff in the query, we want to see a diff page instead of the article.
884 if ( $wgRequest->getCheck( 'diff' ) ) {
885 wfDebug( __METHOD__
. ": showing diff page\n" );
886 $this->showDiffPage();
887 wfProfileOut( __METHOD__
);
892 if ( !$wgUseETag && !$this->mTitle
->quickUserCan( 'edit' ) ) {
893 $parserOptions->setEditSection( false );
896 # Should the parser cache be used?
897 $useParserCache = $this->useParserCache( $oldid );
898 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
899 if ( $wgUser->getStubThreshold() ) {
900 wfIncrStats( 'pcache_miss_stub' );
903 $wasRedirected = $this->showRedirectedFromHeader();
904 $this->showNamespaceHeader();
906 # Iterate through the possible ways of constructing the output text.
907 # Keep going until $outputDone is set, or we run out of things to do.
910 $this->mParserOutput
= false;
912 while ( !$outputDone && ++
$pass ) {
915 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
918 # Try the parser cache
919 if ( $useParserCache ) {
920 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
922 if ( $this->mParserOutput
!== false ) {
923 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
924 $wgOut->addParserOutput( $this->mParserOutput
);
925 # Ensure that UI elements requiring revision ID have
926 # the correct version information.
927 $wgOut->setRevisionId( $this->mLatest
);
933 $text = $this->getContent();
934 if ( $text === false ||
$this->getID() == 0 ) {
935 wfDebug( __METHOD__
. ": showing missing article\n" );
936 $this->showMissingArticle();
937 wfProfileOut( __METHOD__
);
941 # Another whitelist check in case oldid is altering the title
942 if ( !$this->mTitle
->userCanRead() ) {
943 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
944 $wgOut->loginToUse();
947 wfProfileOut( __METHOD__
);
951 # Are we looking at an old revision
952 if ( $oldid && !is_null( $this->mRevision
) ) {
953 $this->setOldSubtitle( $oldid );
955 if ( !$this->showDeletedRevisionHeader() ) {
956 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
957 wfProfileOut( __METHOD__
);
961 # If this "old" version is the current, then try the parser cache...
962 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
963 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
964 if ( $this->mParserOutput
) {
965 wfDebug( __METHOD__
. ": showing parser cache for current rev permalink\n" );
966 $wgOut->addParserOutput( $this->mParserOutput
);
967 $wgOut->setRevisionId( $this->mLatest
);
974 # Ensure that UI elements requiring revision ID have
975 # the correct version information.
976 $wgOut->setRevisionId( $this->getRevIdFetched() );
978 # Pages containing custom CSS or JavaScript get special treatment
979 if ( $this->mTitle
->isCssOrJsPage() ||
$this->mTitle
->isCssJsSubpage() ) {
980 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
981 $this->showCssOrJsPage();
983 } else if ( $rt = Title
::newFromRedirectArray( $text ) ) {
984 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
985 # Viewing a redirect page (e.g. with parameter redirect=no)
986 # Don't append the subtitle if this was an old revision
987 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
988 # Parse just to get categories, displaytitle, etc.
989 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
, $parserOptions );
990 $wgOut->addParserOutputNoText( $this->mParserOutput
);
995 # Run the parse, protected by a pool counter
996 wfDebug( __METHOD__
. ": doing uncached parse\n" );
998 $this->checkTouched();
999 $key = $parserCache->getKey( $this, $parserOptions );
1000 $poolArticleView = new PoolWorkArticleView( $this, $key, $useParserCache, $parserOptions );
1002 if ( !$poolArticleView->execute() ) {
1003 # Connection or timeout error
1004 wfProfileOut( __METHOD__
);
1010 # Should be unreachable, but just in case...
1016 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
1017 if ( $this->mParserOutput
) {
1018 $titleText = $this->mParserOutput
->getTitleText();
1020 if ( strval( $titleText ) !== '' ) {
1021 $wgOut->setPageTitle( $titleText );
1025 # For the main page, overwrite the <title> element with the con-
1026 # tents of 'pagetitle-view-mainpage' instead of the default (if
1027 # that's not empty).
1028 # This message always exists because it is in the i18n files
1029 if ( $this->mTitle
->equals( Title
::newMainPage() )
1030 && ( $m = wfMsgForContent( 'pagetitle-view-mainpage' ) ) !== '' )
1032 $wgOut->setHTMLTitle( $m );
1035 # Now that we've filled $this->mParserOutput, we know whether
1036 # there are any __NOINDEX__ tags on the page
1037 $policy = $this->getRobotPolicy( 'view' );
1038 $wgOut->setIndexPolicy( $policy['index'] );
1039 $wgOut->setFollowPolicy( $policy['follow'] );
1041 $this->showViewFooter();
1042 $this->viewUpdates();
1043 wfProfileOut( __METHOD__
);
1047 * Show a diff page according to current request variables. For use within
1048 * Article::view() only, other callers should use the DifferenceEngine class.
1050 public function showDiffPage() {
1051 global $wgRequest, $wgUser;
1053 $diff = $wgRequest->getVal( 'diff' );
1054 $rcid = $wgRequest->getVal( 'rcid' );
1055 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
1056 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1057 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1058 $oldid = $this->getOldID();
1060 $de = new DifferenceEngine( $this->mTitle
, $oldid, $diff, $rcid, $purge, $unhide );
1061 // DifferenceEngine directly fetched the revision:
1062 $this->mRevIdFetched
= $de->mNewid
;
1063 $de->showDiffPage( $diffOnly );
1065 // Needed to get the page's current revision
1066 $this->loadPageData();
1067 if ( $diff == 0 ||
$diff == $this->mLatest
) {
1068 # Run view updates for current revision only
1069 $this->viewUpdates();
1074 * Show a page view for a page formatted as CSS or JavaScript. To be called by
1075 * Article::view() only.
1077 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
1080 protected function showCssOrJsPage() {
1083 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache'>\n$1\n</div>", 'clearyourcache' );
1085 // Give hooks a chance to customise the output
1086 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->mTitle
, $wgOut ) ) ) {
1087 // Wrap the whole lot in a <pre> and don't parse
1089 preg_match( '!\.(css|js)$!u', $this->mTitle
->getText(), $m );
1090 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
1091 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
1092 $wgOut->addHTML( "\n</pre>\n" );
1097 * Get the robot policy to be used for the current view
1098 * @param $action String the action= GET parameter
1099 * @return Array the policy that should be set
1100 * TODO: actions other than 'view'
1102 public function getRobotPolicy( $action ) {
1103 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1104 global $wgDefaultRobotPolicy, $wgRequest;
1106 $ns = $this->mTitle
->getNamespace();
1108 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
1109 # Don't index user and user talk pages for blocked users (bug 11443)
1110 if ( !$this->mTitle
->isSubpage() ) {
1111 $block = new Block();
1112 if ( $block->load( $this->mTitle
->getText() ) ) {
1114 'index' => 'noindex',
1115 'follow' => 'nofollow'
1121 if ( $this->getID() === 0 ||
$this->getOldID() ) {
1122 # Non-articles (special pages etc), and old revisions
1124 'index' => 'noindex',
1125 'follow' => 'nofollow'
1127 } elseif ( $wgOut->isPrintable() ) {
1128 # Discourage indexing of printable versions, but encourage following
1130 'index' => 'noindex',
1131 'follow' => 'follow'
1133 } elseif ( $wgRequest->getInt( 'curid' ) ) {
1134 # For ?curid=x urls, disallow indexing
1136 'index' => 'noindex',
1137 'follow' => 'follow'
1141 # Otherwise, construct the policy based on the various config variables.
1142 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
1144 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
1145 # Honour customised robot policies for this namespace
1146 $policy = array_merge(
1148 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
1151 if ( $this->mTitle
->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ) {
1152 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1153 # a final sanity check that we have really got the parser output.
1154 $policy = array_merge(
1156 array( 'index' => $this->mParserOutput
->getIndexPolicy() )
1160 if ( isset( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) ) {
1161 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1162 $policy = array_merge(
1164 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] )
1172 * Converts a String robot policy into an associative array, to allow
1173 * merging of several policies using array_merge().
1174 * @param $policy Mixed, returns empty array on null/false/'', transparent
1175 * to already-converted arrays, converts String.
1176 * @return associative Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1178 public static function formatRobotPolicy( $policy ) {
1179 if ( is_array( $policy ) ) {
1181 } elseif ( !$policy ) {
1185 $policy = explode( ',', $policy );
1186 $policy = array_map( 'trim', $policy );
1189 foreach ( $policy as $var ) {
1190 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
1191 $arr['index'] = $var;
1192 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
1193 $arr['follow'] = $var;
1201 * If this request is a redirect view, send "redirected from" subtitle to
1202 * $wgOut. Returns true if the header was needed, false if this is not a
1203 * redirect view. Handles both local and remote redirects.
1207 public function showRedirectedFromHeader() {
1208 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1210 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1211 $sk = $wgUser->getSkin();
1213 if ( isset( $this->mRedirectedFrom
) ) {
1214 // This is an internally redirected page view.
1215 // We'll need a backlink to the source page for navigation.
1216 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1218 $this->mRedirectedFrom
,
1221 array( 'redirect' => 'no' ),
1222 array( 'known', 'noclasses' )
1225 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1226 $wgOut->setSubtitle( $s );
1228 // Set the fragment if one was specified in the redirect
1229 if ( strval( $this->mTitle
->getFragment() ) != '' ) {
1230 $fragment = Xml
::escapeJsString( $this->mTitle
->getFragmentForURL() );
1231 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1234 // Add a <link rel="canonical"> tag
1235 $wgOut->addLink( array( 'rel' => 'canonical',
1236 'href' => $this->mTitle
->getLocalURL() )
1241 } elseif ( $rdfrom ) {
1242 // This is an externally redirected view, from some other wiki.
1243 // If it was reported from a trusted site, supply a backlink.
1244 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1245 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1246 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1247 $wgOut->setSubtitle( $s );
1257 * Show a header specific to the namespace currently being viewed, like
1258 * [[MediaWiki:Talkpagetext]]. For Article::view().
1260 public function showNamespaceHeader() {
1263 if ( $this->mTitle
->isTalkPage() ) {
1264 $msg = wfMsgNoTrans( 'talkpageheader' );
1265 if ( $msg !== '-' && !wfEmptyMsg( 'talkpageheader', $msg ) ) {
1266 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1272 * Show the footer section of an ordinary page view
1274 public function showViewFooter() {
1275 global $wgOut, $wgUseTrackbacks;
1277 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1278 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->mTitle
->getText() ) ) {
1279 $wgOut->addWikiMsg( 'anontalkpagetext' );
1282 # If we have been passed an &rcid= parameter, we want to give the user a
1283 # chance to mark this new article as patrolled.
1284 $this->showPatrolFooter();
1287 if ( $wgUseTrackbacks ) {
1288 $this->addTrackbacks();
1293 * If patrol is possible, output a patrol UI box. This is called from the
1294 * footer section of ordinary page views. If patrol is not possible or not
1295 * desired, does nothing.
1297 public function showPatrolFooter() {
1298 global $wgOut, $wgRequest, $wgUser;
1300 $rcid = $wgRequest->getVal( 'rcid' );
1302 if ( !$rcid ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1306 $sk = $wgUser->getSkin();
1307 $token = $wgUser->editToken();
1310 "<div class='patrollink'>" .
1312 'markaspatrolledlink',
1315 wfMsgHtml( 'markaspatrolledtext' ),
1318 'action' => 'markpatrolled',
1322 array( 'known', 'noclasses' )
1330 * Show the error text for a missing article. For articles in the MediaWiki
1331 * namespace, show the default message text. To be called from Article::view().
1333 public function showMissingArticle() {
1334 global $wgOut, $wgRequest, $wgUser;
1336 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1337 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1338 $parts = explode( '/', $this->mTitle
->getText() );
1339 $rootPart = $parts[0];
1340 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1341 $ip = User
::isIP( $rootPart );
1343 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1344 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1345 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1346 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1347 LogEventsList
::showLogExtract(
1350 $user->getUserPage()->getPrefixedText(),
1354 'showIfEmpty' => false,
1356 'blocked-notice-logextract',
1357 $user->getName() # Support GENDER in notice
1364 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1366 # Show delete and move logs
1367 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1369 'conds' => array( "log_action != 'revision'" ),
1370 'showIfEmpty' => false,
1371 'msgKey' => array( 'moveddeleted-notice' ) )
1374 # Show error message
1375 $oldid = $this->getOldID();
1377 $text = wfMsgNoTrans( 'missing-article',
1378 $this->mTitle
->getPrefixedText(),
1379 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1380 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1381 // Use the default message text
1382 $text = $this->getContent();
1384 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1385 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1386 $errors = array_merge( $createErrors, $editErrors );
1388 if ( !count( $errors ) ) {
1389 $text = wfMsgNoTrans( 'noarticletext' );
1391 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1394 $text = "<div class='noarticletext'>\n$text\n</div>";
1396 if ( !$this->hasViewableContent() ) {
1397 // If there's no backing content, send a 404 Not Found
1398 // for better machine handling of broken links.
1399 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1402 $wgOut->addWikiText( $text );
1406 * If the revision requested for view is deleted, check permissions.
1407 * Send either an error message or a warning header to $wgOut.
1409 * @return boolean true if the view is allowed, false if not.
1411 public function showDeletedRevisionHeader() {
1412 global $wgOut, $wgRequest;
1414 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1419 // If the user is not allowed to see it...
1420 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
1421 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1422 'rev-deleted-text-permission' );
1425 // If the user needs to confirm that they want to see it...
1426 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1427 # Give explanation and add a link to view the revision...
1428 $oldid = intval( $this->getOldID() );
1429 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1430 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1431 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1432 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1433 array( $msg, $link ) );
1436 // We are allowed to see...
1438 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1439 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1440 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1447 * Should the parser cache be used?
1451 public function useParserCache( $oldid ) {
1452 global $wgUser, $wgEnableParserCache;
1454 return $wgEnableParserCache
1455 && $wgUser->getStubThreshold() == 0
1458 && !$this->mTitle
->isCssOrJsPage()
1459 && !$this->mTitle
->isCssJsSubpage();
1463 * Execute the uncached parse for action=view
1465 public function doViewParse() {
1468 $oldid = $this->getOldID();
1469 $useParserCache = $this->useParserCache( $oldid );
1470 $parserOptions = $this->getParserOptions();
1472 # Render printable version, use printable version cache
1473 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1475 # Don't show section-edit links on old revisions... this way lies madness.
1476 if ( !$this->isCurrent() ||
$wgOut->isPrintable() ) {
1477 $parserOptions->setEditSection( false );
1480 $useParserCache = $this->useParserCache( $oldid );
1481 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1487 * Try to fetch an expired entry from the parser cache. If it is present,
1488 * output it and return true. If it is not present, output nothing and
1489 * return false. This is used as a callback function for
1490 * PoolCounter::executeProtected().
1494 public function tryDirtyCache() {
1496 $parserCache = ParserCache
::singleton();
1497 $options = clone $this->getParserOptions();
1499 if ( $wgOut->isPrintable() ) {
1500 $options->setIsPrintable( true );
1501 $options->setEditSection( false );
1504 $output = $parserCache->getDirty( $this, $options );
1507 wfDebug( __METHOD__
. ": sending dirty output\n" );
1508 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1509 $wgOut->setSquidMaxage( 0 );
1510 $this->mParserOutput
= $output;
1511 $wgOut->addParserOutput( $output );
1512 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1516 wfDebugLog( 'dirty', "dirty missing\n" );
1517 wfDebug( __METHOD__
. ": no dirty cache\n" );
1526 * @param $target Title object or Array of destination(s) to redirect
1527 * @param $appendSubtitle Boolean [optional]
1528 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1529 * @return string containing HMTL with redirect link
1531 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1532 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1534 if ( !is_array( $target ) ) {
1535 $target = array( $target );
1538 $imageDir = $wgContLang->getDir();
1540 if ( $appendSubtitle ) {
1541 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1544 $sk = $wgUser->getSkin();
1545 // the loop prepends the arrow image before the link, so the first case needs to be outside
1546 $title = array_shift( $target );
1548 if ( $forceKnown ) {
1549 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1551 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1554 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1555 $alt = $wgContLang->isRTL() ?
'←' : '→';
1556 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1557 // FIXME: where this happens?
1558 foreach ( $target as $rt ) {
1559 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1560 if ( $forceKnown ) {
1561 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1563 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1567 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1568 return Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1569 '<span class="redirectText">' . $link . '</span>';
1573 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1575 public function addTrackbacks() {
1576 global $wgOut, $wgUser;
1578 $dbr = wfGetDB( DB_SLAVE
);
1579 $tbs = $dbr->select( 'trackbacks',
1580 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1581 array( 'tb_page' => $this->getID() )
1584 if ( !$dbr->numRows( $tbs ) ) {
1589 while ( $o = $dbr->fetchObject( $tbs ) ) {
1592 if ( $wgUser->isAllowed( 'trackback' ) ) {
1593 $delurl = $this->mTitle
->getFullURL( "action=deletetrackback&tbid=" .
1594 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1595 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1599 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1607 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1611 * Removes trackback record for current article from trackbacks table
1613 public function deletetrackback() {
1614 global $wgUser, $wgRequest, $wgOut;
1616 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1617 $wgOut->addWikiMsg( 'sessionfailure' );
1622 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1624 if ( count( $permission_errors ) ) {
1625 $wgOut->showPermissionsErrorPage( $permission_errors );
1630 $db = wfGetDB( DB_MASTER
);
1631 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1633 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1634 $this->mTitle
->invalidateCache();
1638 * Handle action=render
1641 public function render() {
1644 $wgOut->setArticleBodyOnly( true );
1649 * Handle action=purge
1651 public function purge() {
1652 global $wgUser, $wgRequest, $wgOut;
1654 if ( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1655 //FIXME: shouldn't this be in doPurge()?
1656 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1661 $formParams = array(
1663 'action' => $wgRequest->getRequestURL(),
1666 $wgOut->addWikiMsg( 'confirm-purge-top' );
1668 $form = Html
::openElement( 'form', $formParams );
1669 $form .= Xml
::submitButton( wfMsg( 'confirm_purge_button' ) );
1670 $form .= Html
::closeElement( 'form' );
1672 $wgOut->addHTML( $form );
1673 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1675 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1676 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1681 * Perform the actions of a page purging
1683 public function doPurge() {
1686 // Invalidate the cache
1687 $this->mTitle
->invalidateCache();
1689 if ( $wgUseSquid ) {
1690 // Commit the transaction before the purge is sent
1691 $dbw = wfGetDB( DB_MASTER
);
1695 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1696 $update->doUpdate();
1699 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1700 global $wgMessageCache;
1702 if ( $this->getID() == 0 ) {
1705 $text = $this->getRawText();
1708 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1713 * Insert a new empty page record for this article.
1714 * This *must* be followed up by creating a revision
1715 * and running $this->updateRevisionOn( ... );
1716 * or else the record will be left in a funky state.
1717 * Best if all done inside a transaction.
1719 * @param $dbw Database
1720 * @return int The newly created page_id key, or false if the title already existed
1723 public function insertOn( $dbw ) {
1724 wfProfileIn( __METHOD__
);
1726 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1727 $dbw->insert( 'page', array(
1728 'page_id' => $page_id,
1729 'page_namespace' => $this->mTitle
->getNamespace(),
1730 'page_title' => $this->mTitle
->getDBkey(),
1731 'page_counter' => 0,
1732 'page_restrictions' => '',
1733 'page_is_redirect' => 0, # Will set this shortly...
1735 'page_random' => wfRandom(),
1736 'page_touched' => $dbw->timestamp(),
1737 'page_latest' => 0, # Fill this in shortly...
1738 'page_len' => 0, # Fill this in shortly...
1739 ), __METHOD__
, 'IGNORE' );
1741 $affected = $dbw->affectedRows();
1744 $newid = $dbw->insertId();
1745 $this->mTitle
->resetArticleId( $newid );
1747 wfProfileOut( __METHOD__
);
1749 return $affected ?
$newid : false;
1753 * Update the page record to point to a newly saved revision.
1755 * @param $dbw Database object
1756 * @param $revision Revision: For ID number, and text used to set
1757 length and redirect status fields
1758 * @param $lastRevision Integer: if given, will not overwrite the page field
1759 * when different from the currently set value.
1760 * Giving 0 indicates the new page flag should be set
1762 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1763 * removing rows in redirect table.
1764 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1765 * Needed when $lastRevision has to be set to sth. !=0
1766 * @return bool true on success, false on failure
1769 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1770 wfProfileIn( __METHOD__
);
1772 $text = $revision->getText();
1773 $rt = Title
::newFromRedirectRecurse( $text );
1775 $conditions = array( 'page_id' => $this->getId() );
1777 if ( !is_null( $lastRevision ) ) {
1778 # An extra check against threads stepping on each other
1779 $conditions['page_latest'] = $lastRevision;
1782 if ( !$setNewFlag ) {
1783 $setNewFlag = ( $lastRevision === 0 );
1786 $dbw->update( 'page',
1788 'page_latest' => $revision->getId(),
1789 'page_touched' => $dbw->timestamp(),
1790 'page_is_new' => $setNewFlag,
1791 'page_is_redirect' => $rt !== null ?
1 : 0,
1792 'page_len' => strlen( $text ),
1797 $result = $dbw->affectedRows() != 0;
1799 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1802 wfProfileOut( __METHOD__
);
1807 * Add row to the redirect table if this is a redirect, remove otherwise.
1809 * @param $dbw Database
1810 * @param $redirectTitle a title object pointing to the redirect target,
1811 * or NULL if this is not a redirect
1812 * @param $lastRevIsRedirect If given, will optimize adding and
1813 * removing rows in redirect table.
1814 * @return bool true on success, false on failure
1817 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1818 // Always update redirects (target link might have changed)
1819 // Update/Insert if we don't know if the last revision was a redirect or not
1820 // Delete if changing from redirect to non-redirect
1821 $isRedirect = !is_null( $redirectTitle );
1823 if ( $isRedirect ||
is_null( $lastRevIsRedirect ) ||
$lastRevIsRedirect !== $isRedirect ) {
1824 wfProfileIn( __METHOD__
);
1825 if ( $isRedirect ) {
1826 $this->insertRedirectEntry( $redirectTitle );
1828 // This is not a redirect, remove row from redirect table
1829 $where = array( 'rd_from' => $this->getId() );
1830 $dbw->delete( 'redirect', $where, __METHOD__
);
1833 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1834 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1836 wfProfileOut( __METHOD__
);
1838 return ( $dbw->affectedRows() != 0 );
1845 * If the given revision is newer than the currently set page_latest,
1846 * update the page record. Otherwise, do nothing.
1848 * @param $dbw Database object
1849 * @param $revision Revision object
1852 public function updateIfNewerOn( &$dbw, $revision ) {
1853 wfProfileIn( __METHOD__
);
1855 $row = $dbw->selectRow(
1856 array( 'revision', 'page' ),
1857 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1859 'page_id' => $this->getId(),
1860 'page_latest=rev_id' ),
1864 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1865 wfProfileOut( __METHOD__
);
1868 $prev = $row->rev_id
;
1869 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1871 # No or missing previous revision; mark the page as new
1873 $lastRevIsRedirect = null;
1876 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1878 wfProfileOut( __METHOD__
);
1883 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1884 * @param $text String: new text of the section
1885 * @param $summary String: new section's subject, only if $section is 'new'
1886 * @param $edittime String: revision timestamp or null to use the current revision
1887 * @return string Complete article text, or null if error
1889 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1890 wfProfileIn( __METHOD__
);
1892 if ( strval( $section ) == '' ) {
1893 // Whole-page edit; let the whole text through
1895 if ( is_null( $edittime ) ) {
1896 $rev = Revision
::newFromTitle( $this->mTitle
);
1898 $dbw = wfGetDB( DB_MASTER
);
1899 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1903 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1904 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1908 $oldtext = $rev->getText();
1910 if ( $section == 'new' ) {
1911 # Inserting a new section
1912 $subject = $summary ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1913 $text = strlen( trim( $oldtext ) ) > 0
1914 ?
"{$oldtext}\n\n{$subject}{$text}"
1915 : "{$subject}{$text}";
1917 # Replacing an existing section; roll out the big guns
1920 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1924 wfProfileOut( __METHOD__
);
1929 * This function is not deprecated until somebody fixes the core not to use
1930 * it. Nevertheless, use Article::doEdit() instead.
1932 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1933 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1934 ( $isminor ? EDIT_MINOR
: 0 ) |
1935 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1936 ( $bot ? EDIT_FORCE_BOT
: 0 );
1938 # If this is a comment, add the summary as headline
1939 if ( $comment && $summary != "" ) {
1940 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
1942 $this->doEdit( $text, $summary, $flags );
1944 $dbw = wfGetDB( DB_MASTER
);
1946 if ( !$this->mTitle
->userIsWatching() ) {
1952 if ( $this->mTitle
->userIsWatching() ) {
1958 $this->doRedirect( $this->isRedirect( $text ) );
1962 * @deprecated use Article::doEdit()
1964 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1965 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1966 ( $minor ? EDIT_MINOR
: 0 ) |
1967 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1969 $status = $this->doEdit( $text, $summary, $flags );
1971 if ( !$status->isOK() ) {
1975 $dbw = wfGetDB( DB_MASTER
);
1977 if ( !$this->mTitle
->userIsWatching() ) {
1983 if ( $this->mTitle
->userIsWatching() ) {
1990 $extraQuery = ''; // Give extensions a chance to modify URL query on update
1991 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
1993 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
1998 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
2000 * @return Int updated $flags
2002 function checkFlags( $flags ) {
2003 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
2004 if ( $this->mTitle
->getArticleID() ) {
2005 $flags |
= EDIT_UPDATE
;
2017 * Change an existing article or create a new article. Updates RC and all necessary caches,
2018 * optionally via the deferred update array.
2020 * $wgUser must be set before calling this function.
2022 * @param $text String: new text
2023 * @param $summary String: edit summary
2024 * @param $flags Integer bitfield:
2026 * Article is known or assumed to be non-existent, create a new one
2028 * Article is known or assumed to be pre-existing, update it
2030 * Mark this edit minor, if the user is allowed to do so
2032 * Do not log the change in recentchanges
2034 * Mark the edit a "bot" edit regardless of user rights
2035 * EDIT_DEFER_UPDATES
2036 * Defer some of the updates until the end of index.php
2038 * Fill in blank summaries with generated text where possible
2040 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2041 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2042 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2043 * edit-already-exists error will be returned. These two conditions are also possible with
2044 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2046 * @param $baseRevId the revision ID this edit was based off, if any
2047 * @param $user Optional user object, $wgUser will be used if not passed
2049 * @return Status object. Possible errors:
2050 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2051 * edit-gone-missing: In update mode, but the article didn't exist
2052 * edit-conflict: In update mode, the article changed unexpectedly
2053 * edit-no-change: Warning that the text was the same as before
2054 * edit-already-exists: In creation mode, but the article already exists
2056 * Extensions may define additional errors.
2058 * $return->value will contain an associative array with members as follows:
2059 * new: Boolean indicating if the function attempted to create a new article
2060 * revision: The revision object for the inserted revision, or null
2062 * Compatibility note: this function previously returned a boolean value indicating success/failure
2064 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
2065 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2067 # Low-level sanity check
2068 if ( $this->mTitle
->getText() === '' ) {
2069 throw new MWException( 'Something is trying to edit an article with an empty title' );
2072 wfProfileIn( __METHOD__
);
2074 $user = is_null( $user ) ?
$wgUser : $user;
2075 $status = Status
::newGood( array() );
2077 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2078 $this->loadPageData();
2080 $flags = $this->checkFlags( $flags );
2082 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2083 $flags & EDIT_MINOR
, null, null, &$flags, &$status ) ) )
2085 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
2086 wfProfileOut( __METHOD__
);
2088 if ( $status->isOK() ) {
2089 $status->fatal( 'edit-hook-aborted' );
2095 # Silently ignore EDIT_MINOR if not allowed
2096 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
2097 $bot = $flags & EDIT_FORCE_BOT
;
2099 $oldtext = $this->getRawText(); // current revision
2100 $oldsize = strlen( $oldtext );
2102 # Provide autosummaries if one is not provided and autosummaries are enabled.
2103 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
2104 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2107 $editInfo = $this->prepareTextForEdit( $text );
2108 $text = $editInfo->pst
;
2109 $newsize = strlen( $text );
2111 $dbw = wfGetDB( DB_MASTER
);
2112 $now = wfTimestampNow();
2113 $this->mTimestamp
= $now;
2115 if ( $flags & EDIT_UPDATE
) {
2116 # Update article, but only if changed.
2117 $status->value
['new'] = false;
2119 # Make sure the revision is either completely inserted or not inserted at all
2120 if ( !$wgDBtransactions ) {
2121 $userAbort = ignore_user_abort( true );
2126 $changed = ( strcmp( $text, $oldtext ) != 0 );
2129 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
2130 - (int)$this->isCountable( $oldtext );
2131 $this->mTotalAdjustment
= 0;
2133 if ( !$this->mLatest
) {
2134 # Article gone missing
2135 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
2136 $status->fatal( 'edit-gone-missing' );
2138 wfProfileOut( __METHOD__
);
2142 $revision = new Revision( array(
2143 'page' => $this->getId(),
2144 'comment' => $summary,
2145 'minor_edit' => $isminor,
2147 'parent_id' => $this->mLatest
,
2148 'user' => $user->getId(),
2149 'user_text' => $user->getName(),
2153 $revisionId = $revision->insertOn( $dbw );
2157 # Note that we use $this->mLatest instead of fetching a value from the master DB
2158 # during the course of this function. This makes sure that EditPage can detect
2159 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2160 # before this function is called. A previous function used a separate query, this
2161 # creates a window where concurrent edits can cause an ignored edit conflict.
2162 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
2165 /* Belated edit conflict! Run away!! */
2166 $status->fatal( 'edit-conflict' );
2168 # Delete the invalid revision if the DB is not transactional
2169 if ( !$wgDBtransactions ) {
2170 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
2176 global $wgUseRCPatrol;
2177 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2178 # Update recentchanges
2179 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2180 # Mark as patrolled if the user can do so
2181 $patrolled = $wgUseRCPatrol && $this->mTitle
->userCan( 'autopatrol' );
2182 # Add RC row to the DB
2183 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
2184 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2185 $revisionId, $patrolled
2188 # Log auto-patrolled edits
2190 PatrolLog
::record( $rc, true );
2193 $user->incEditCount();
2197 $status->warning( 'edit-no-change' );
2199 // Keep the same revision ID, but do some updates on it
2200 $revisionId = $this->getRevIdFetched();
2201 // Update page_touched, this is usually implicit in the page update
2202 // Other cache updates are done in onArticleEdit()
2203 $this->mTitle
->invalidateCache();
2206 if ( !$wgDBtransactions ) {
2207 ignore_user_abort( $userAbort );
2210 // Now that ignore_user_abort is restored, we can respond to fatal errors
2211 if ( !$status->isOK() ) {
2212 wfProfileOut( __METHOD__
);
2216 # Invalidate cache of this article and all pages using this article
2217 # as a template. Partly deferred.
2218 Article
::onArticleEdit( $this->mTitle
);
2219 # Update links tables, site stats, etc.
2220 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed );
2222 # Create new article
2223 $status->value
['new'] = true;
2225 # Set statistics members
2226 # We work out if it's countable after PST to avoid counter drift
2227 # when articles are created with {{subst:}}
2228 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2229 $this->mTotalAdjustment
= 1;
2233 # Add the page record; stake our claim on this title!
2234 # This will return false if the article already exists
2235 $newid = $this->insertOn( $dbw );
2237 if ( $newid === false ) {
2239 $status->fatal( 'edit-already-exists' );
2241 wfProfileOut( __METHOD__
);
2245 # Save the revision text...
2246 $revision = new Revision( array(
2248 'comment' => $summary,
2249 'minor_edit' => $isminor,
2251 'user' => $user->getId(),
2252 'user_text' => $user->getName(),
2254 $revisionId = $revision->insertOn( $dbw );
2256 $this->mTitle
->resetArticleID( $newid );
2258 # Update the page record with revision data
2259 $this->updateRevisionOn( $dbw, $revision, 0 );
2261 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2263 # Update recentchanges
2264 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2265 global $wgUseRCPatrol, $wgUseNPPatrol;
2267 # Mark as patrolled if the user can do so
2268 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && $this->mTitle
->userCan( 'autopatrol' );
2269 # Add RC row to the DB
2270 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2271 '', strlen( $text ), $revisionId, $patrolled );
2273 # Log auto-patrolled edits
2275 PatrolLog
::record( $rc, true );
2278 $user->incEditCount();
2281 # Update links, etc.
2282 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true );
2285 Article
::onArticleCreate( $this->mTitle
);
2287 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2288 $flags & EDIT_MINOR
, null, null, &$flags, $revision ) );
2291 # Do updates right now unless deferral was requested
2292 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
2296 // Return the new revision (or null) to the caller
2297 $status->value
['revision'] = $revision;
2299 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2300 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId ) );
2302 wfProfileOut( __METHOD__
);
2307 * @deprecated wrapper for doRedirect
2309 public function showArticle( $text, $subtitle , $sectionanchor = '', $me2, $now, $summary, $oldid ) {
2310 wfDeprecated( __METHOD__
);
2311 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor );
2315 * Output a redirect back to the article.
2316 * This is typically used after an edit.
2318 * @param $noRedir Boolean: add redirect=no
2319 * @param $sectionAnchor String: section to redirect to, including "#"
2320 * @param $extraQuery String: extra query params
2322 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2326 $query = 'redirect=no';
2328 $query .= "&$extraQuery";
2330 $query = $extraQuery;
2333 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2337 * Mark this particular edit/page as patrolled
2339 public function markpatrolled() {
2340 global $wgOut, $wgUser, $wgRequest;
2342 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2344 # If we haven't been given an rc_id value, we can't do anything
2345 $rcid = (int) $wgRequest->getVal( 'rcid' );
2347 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
2348 $wgOut->showErrorPage( 'sessionfailure-title', 'sessionfailure' );
2352 $rc = RecentChange
::newFromId( $rcid );
2354 if ( is_null( $rc ) ) {
2355 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2359 # It would be nice to see where the user had actually come from, but for now just guess
2360 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2361 $return = SpecialPage
::getTitleFor( $returnto );
2363 $errors = $rc->doMarkPatrolled();
2365 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2366 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2371 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2372 // The hook itself has handled any output
2376 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2377 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2378 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2379 $wgOut->returnToMain( false, $return );
2384 if ( !empty( $errors ) ) {
2385 $wgOut->showPermissionsErrorPage( $errors );
2391 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2392 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2393 $wgOut->returnToMain( false, $return );
2397 * User-interface handler for the "watch" action
2399 public function watch() {
2400 global $wgUser, $wgOut;
2402 if ( $wgUser->isAnon() ) {
2403 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2407 if ( wfReadOnly() ) {
2408 $wgOut->readOnlyPage();
2412 if ( $this->doWatch() ) {
2413 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2414 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2415 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2418 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2422 * Add this page to $wgUser's watchlist
2423 * @return bool true on successful watch operation
2425 public function doWatch() {
2428 if ( $wgUser->isAnon() ) {
2432 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2433 $wgUser->addWatch( $this->mTitle
);
2434 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2441 * User interface handler for the "unwatch" action.
2443 public function unwatch() {
2444 global $wgUser, $wgOut;
2446 if ( $wgUser->isAnon() ) {
2447 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2451 if ( wfReadOnly() ) {
2452 $wgOut->readOnlyPage();
2456 if ( $this->doUnwatch() ) {
2457 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2458 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2459 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2462 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2466 * Stop watching a page
2467 * @return bool true on successful unwatch
2469 public function doUnwatch() {
2472 if ( $wgUser->isAnon() ) {
2476 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2477 $wgUser->removeWatch( $this->mTitle
);
2478 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2485 * action=protect handler
2487 public function protect() {
2488 $form = new ProtectionForm( $this );
2493 * action=unprotect handler (alias)
2495 public function unprotect() {
2500 * Update the article's restriction field, and leave a log entry.
2502 * @param $limit Array: set of restriction keys
2503 * @param $reason String
2504 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2505 * @param $expiry Array: per restriction type expiration
2506 * @return bool true on success
2508 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2509 global $wgUser, $wgContLang;
2511 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2513 $id = $this->mTitle
->getArticleID();
2516 wfDebug( "updateRestrictions failed: $id <= 0\n" );
2520 if ( wfReadOnly() ) {
2521 wfDebug( "updateRestrictions failed: read-only\n" );
2525 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2526 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2534 // Take this opportunity to purge out expired restrictions
2535 Title
::purgeExpiredRestrictions();
2537 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2538 # we expect a single selection, but the schema allows otherwise.
2540 $updated = Article
::flattenRestrictions( $limit );
2543 foreach ( $restrictionTypes as $action ) {
2544 if ( isset( $expiry[$action] ) ) {
2545 # Get current restrictions on $action
2546 $aLimits = $this->mTitle
->getRestrictions( $action );
2547 $current[$action] = implode( '', $aLimits );
2548 # Are any actual restrictions being dealt with here?
2549 $aRChanged = count( $aLimits ) ||
!empty( $limit[$action] );
2551 # If something changed, we need to log it. Checking $aRChanged
2552 # assures that "unprotecting" a page that is not protected does
2553 # not log just because the expiry was "changed".
2554 if ( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2560 $current = Article
::flattenRestrictions( $current );
2562 $changed = ( $changed ||
$current != $updated );
2563 $changed = $changed ||
( $updated && $this->mTitle
->areRestrictionsCascading() != $cascade );
2564 $protect = ( $updated != '' );
2566 # If nothing's changed, do nothing
2568 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2569 $dbw = wfGetDB( DB_MASTER
);
2571 # Prepare a null revision to be added to the history
2572 $modified = $current != '' && $protect;
2575 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2577 $comment_type = 'unprotectedarticle';
2580 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2582 # Only restrictions with the 'protect' right can cascade...
2583 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2584 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2586 # The schema allows multiple restrictions
2587 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2591 $cascade_description = '';
2594 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2598 $comment .= ": $reason";
2601 $editComment = $comment;
2602 $encodedExpiry = array();
2603 $protect_description = '';
2604 foreach ( $limit as $action => $restrictions ) {
2605 if ( !isset( $expiry[$action] ) )
2606 $expiry[$action] = 'infinite';
2608 $encodedExpiry[$action] = Block
::encodeExpiry( $expiry[$action], $dbw );
2609 if ( $restrictions != '' ) {
2610 $protect_description .= "[$action=$restrictions] (";
2611 if ( $encodedExpiry[$action] != 'infinity' ) {
2612 $protect_description .= wfMsgForContent( 'protect-expiring',
2613 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2614 $wgContLang->date( $expiry[$action], false, false ) ,
2615 $wgContLang->time( $expiry[$action], false, false ) );
2617 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2620 $protect_description .= ') ';
2623 $protect_description = trim( $protect_description );
2625 if ( $protect_description && $protect ) {
2626 $editComment .= " ($protect_description)";
2630 $editComment .= "$cascade_description";
2633 # Update restrictions table
2634 foreach ( $limit as $action => $restrictions ) {
2635 if ( $restrictions != '' ) {
2636 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2637 array( 'pr_page' => $id,
2638 'pr_type' => $action,
2639 'pr_level' => $restrictions,
2640 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2641 'pr_expiry' => $encodedExpiry[$action]
2646 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2647 'pr_type' => $action ), __METHOD__
);
2651 # Insert a null revision
2652 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2653 $nullRevId = $nullRevision->insertOn( $dbw );
2655 $latest = $this->getLatest();
2656 # Update page record
2657 $dbw->update( 'page',
2659 'page_touched' => $dbw->timestamp(),
2660 'page_restrictions' => '',
2661 'page_latest' => $nullRevId
2662 ), array( /* WHERE */
2664 ), 'Article::protect'
2667 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2668 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2670 # Update the protection log
2671 $log = new LogPage( 'protect' );
2673 $params = array( $protect_description, $cascade ?
'cascade' : '' );
2674 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason ), $params );
2676 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2679 } # End "changed" check
2685 * Take an array of page restrictions and flatten it to a string
2686 * suitable for insertion into the page_restrictions field.
2687 * @param $limit Array
2690 protected static function flattenRestrictions( $limit ) {
2691 if ( !is_array( $limit ) ) {
2692 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2698 foreach ( $limit as $action => $restrictions ) {
2699 if ( $restrictions != '' ) {
2700 $bits[] = "$action=$restrictions";
2704 return implode( ':', $bits );
2708 * Auto-generates a deletion reason
2710 * @param &$hasHistory Boolean: whether the page has a history
2711 * @return mixed String containing deletion reason or empty string, or boolean false
2712 * if no revision occurred
2714 public function generateReason( &$hasHistory ) {
2717 $dbw = wfGetDB( DB_MASTER
);
2718 // Get the last revision
2719 $rev = Revision
::newFromTitle( $this->mTitle
);
2721 if ( is_null( $rev ) ) {
2725 // Get the article's contents
2726 $contents = $rev->getText();
2729 // If the page is blank, use the text from the previous revision,
2730 // which can only be blank if there's a move/import/protect dummy revision involved
2731 if ( $contents == '' ) {
2732 $prev = $rev->getPrevious();
2735 $contents = $prev->getText();
2740 // Find out if there was only one contributor
2741 // Only scan the last 20 revisions
2742 $res = $dbw->select( 'revision', 'rev_user_text',
2743 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2745 array( 'LIMIT' => 20 )
2748 if ( $res === false ) {
2749 // This page has no revisions, which is very weird
2753 $hasHistory = ( $res->numRows() > 1 );
2754 $row = $dbw->fetchObject( $res );
2756 if ( $row ) { // $row is false if the only contributor is hidden
2757 $onlyAuthor = $row->rev_user_text
;
2758 // Try to find a second contributor
2759 foreach ( $res as $row ) {
2760 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2761 $onlyAuthor = false;
2766 $onlyAuthor = false;
2769 // Generate the summary with a '$1' placeholder
2771 // The current revision is blank and the one before is also
2772 // blank. It's just not our lucky day
2773 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2775 if ( $onlyAuthor ) {
2776 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2778 $reason = wfMsgForContent( 'excontent', '$1' );
2782 if ( $reason == '-' ) {
2783 // Allow these UI messages to be blanked out cleanly
2787 // Replace newlines with spaces to prevent uglyness
2788 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2789 // Calculate the maximum amount of chars to get
2790 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2791 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2792 $contents = $wgContLang->truncate( $contents, $maxLength );
2793 // Remove possible unfinished links
2794 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2795 // Now replace the '$1' placeholder
2796 $reason = str_replace( '$1', $contents, $reason );
2803 * UI entry point for page deletion
2805 public function delete() {
2806 global $wgUser, $wgOut, $wgRequest;
2808 $confirm = $wgRequest->wasPosted() &&
2809 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2811 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2812 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2814 $reason = $this->DeleteReasonList
;
2816 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
2817 // Entry from drop down menu + additional comment
2818 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2819 } elseif ( $reason == 'other' ) {
2820 $reason = $this->DeleteReason
;
2823 # Flag to hide all contents of the archived revisions
2824 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2826 # This code desperately needs to be totally rewritten
2828 # Read-only check...
2829 if ( wfReadOnly() ) {
2830 $wgOut->readOnlyPage();
2836 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2838 if ( count( $permission_errors ) > 0 ) {
2839 $wgOut->showPermissionsErrorPage( $permission_errors );
2844 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2846 # Better double-check that it hasn't been deleted yet!
2847 $dbw = wfGetDB( DB_MASTER
);
2848 $conds = $this->mTitle
->pageCond();
2849 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2850 if ( $latest === false ) {
2851 $wgOut->showFatalError(
2854 array( 'class' => 'error mw-error-cannotdelete' ),
2855 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2858 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2859 LogEventsList
::showLogExtract(
2862 $this->mTitle
->getPrefixedText()
2868 # Hack for big sites
2869 $bigHistory = $this->isBigDeletion();
2870 if ( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2871 global $wgLang, $wgDeleteRevisionsLimit;
2873 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2874 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2880 $this->doDelete( $reason, $suppress );
2882 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2884 } elseif ( $this->mTitle
->userIsWatching() ) {
2891 // Generate deletion reason
2892 $hasHistory = false;
2894 $reason = $this->generateReason( $hasHistory );
2897 // If the page has a history, insert a warning
2898 if ( $hasHistory && !$confirm ) {
2901 $skin = $wgUser->getSkin();
2902 $revisions = $this->estimateRevisionCount();
2904 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2905 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2906 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2910 if ( $bigHistory ) {
2911 global $wgDeleteRevisionsLimit;
2912 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2913 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2917 return $this->confirmDelete( $reason );
2921 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2923 public function isBigDeletion() {
2924 global $wgDeleteRevisionsLimit;
2926 if ( $wgDeleteRevisionsLimit ) {
2927 $revCount = $this->estimateRevisionCount();
2929 return $revCount > $wgDeleteRevisionsLimit;
2936 * @return int approximate revision count
2938 public function estimateRevisionCount() {
2939 $dbr = wfGetDB( DB_SLAVE
);
2941 // For an exact count...
2942 // return $dbr->selectField( 'revision', 'COUNT(*)',
2943 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2944 return $dbr->estimateRowCount( 'revision', '*',
2945 array( 'rev_page' => $this->getId() ), __METHOD__
);
2949 * Get the last N authors
2950 * @param $num Integer: number of revisions to get
2951 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2952 * @return array Array of authors, duplicates not removed
2954 public function getLastNAuthors( $num, $revLatest = 0 ) {
2955 wfProfileIn( __METHOD__
);
2956 // First try the slave
2957 // If that doesn't have the latest revision, try the master
2959 $db = wfGetDB( DB_SLAVE
);
2962 $res = $db->select( array( 'page', 'revision' ),
2963 array( 'rev_id', 'rev_user_text' ),
2965 'page_namespace' => $this->mTitle
->getNamespace(),
2966 'page_title' => $this->mTitle
->getDBkey(),
2967 'rev_page = page_id'
2968 ), __METHOD__
, $this->getSelectOptions( array(
2969 'ORDER BY' => 'rev_timestamp DESC',
2975 wfProfileOut( __METHOD__
);
2979 $row = $db->fetchObject( $res );
2981 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
2982 $db = wfGetDB( DB_MASTER
);
2987 } while ( $continue );
2989 $authors = array( $row->rev_user_text
);
2991 while ( $row = $db->fetchObject( $res ) ) {
2992 $authors[] = $row->rev_user_text
;
2995 wfProfileOut( __METHOD__
);
3000 * Output deletion confirmation dialog
3001 * FIXME: Move to another file?
3002 * @param $reason String: prefilled reason
3004 public function confirmDelete( $reason ) {
3005 global $wgOut, $wgUser;
3007 wfDebug( "Article::confirmDelete\n" );
3009 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle
);
3010 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3011 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3012 $wgOut->addWikiMsg( 'confirmdeletetext' );
3014 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3016 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3017 $suppress = "<tr id=\"wpDeleteSuppressRow\" name=\"wpDeleteSuppressRow\">
3019 <td class='mw-input'><strong>" .
3020 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
3021 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3027 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
3029 $form = Xml
::openElement( 'form', array( 'method' => 'post',
3030 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3031 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3032 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3033 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3034 "<tr id=\"wpDeleteReasonListRow\">
3035 <td class='mw-label'>" .
3036 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3038 <td class='mw-input'>" .
3039 Xml
::listDropDown( 'wpDeleteReasonList',
3040 wfMsgForContent( 'deletereason-dropdown' ),
3041 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3044 <tr id=\"wpDeleteReasonRow\">
3045 <td class='mw-label'>" .
3046 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3048 <td class='mw-input'>" .
3049 Html
::input( 'wpReason', $reason, 'text', array(
3051 'maxlength' => '255',
3059 # Disallow watching if user is not logged in
3060 if ( $wgUser->isLoggedIn() ) {
3064 <td class='mw-input'>" .
3065 Xml
::checkLabel( wfMsg( 'watchthis' ),
3066 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3075 <td class='mw-submit'>" .
3076 Xml
::submitButton( wfMsg( 'deletepage' ),
3077 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3080 Xml
::closeElement( 'table' ) .
3081 Xml
::closeElement( 'fieldset' ) .
3082 Xml
::hidden( 'wpEditToken', $wgUser->editToken() ) .
3083 Xml
::closeElement( 'form' );
3085 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3086 $skin = $wgUser->getSkin();
3087 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
3088 $link = $skin->link(
3090 wfMsgHtml( 'delete-edit-reasonlist' ),
3092 array( 'action' => 'edit' )
3094 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3097 $wgOut->addHTML( $form );
3098 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3099 LogEventsList
::showLogExtract( $wgOut, 'delete',
3100 $this->mTitle
->getPrefixedText()
3105 * Perform a deletion and output success or failure messages
3107 public function doDelete( $reason, $suppress = false ) {
3108 global $wgOut, $wgUser;
3110 $id = $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
3113 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3114 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3115 $deleted = $this->mTitle
->getPrefixedText();
3117 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3118 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3120 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3122 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3123 $wgOut->returnToMain( false );
3124 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3127 if ( $error == '' ) {
3128 $wgOut->showFatalError(
3131 array( 'class' => 'error mw-error-cannotdelete' ),
3132 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
3136 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3138 LogEventsList
::showLogExtract(
3141 $this->mTitle
->getPrefixedText()
3144 $wgOut->showFatalError( $error );
3150 * Back-end article deletion
3151 * Deletes the article with database consistency, writes logs, purges caches
3153 * @param $reason string delete reason for deletion log
3154 * @param suppress bitfield
3155 * Revision::DELETED_TEXT
3156 * Revision::DELETED_COMMENT
3157 * Revision::DELETED_USER
3158 * Revision::DELETED_RESTRICTED
3159 * @param $id int article ID
3160 * @param $commit boolean defaults to true, triggers transaction end
3161 * @return boolean true if successful
3163 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3164 global $wgDeferredUpdateList, $wgUseTrackbacks;
3166 wfDebug( __METHOD__
. "\n" );
3168 $dbw = wfGetDB( DB_MASTER
);
3169 $t = $this->mTitle
->getDBkey();
3170 $id = $id ?
$id : $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
3172 if ( $t === '' ||
$id == 0 ) {
3176 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3177 array_push( $wgDeferredUpdateList, $u );
3179 // Bitfields to further suppress the content
3182 // This should be 15...
3183 $bitfield |
= Revision
::DELETED_TEXT
;
3184 $bitfield |
= Revision
::DELETED_COMMENT
;
3185 $bitfield |
= Revision
::DELETED_USER
;
3186 $bitfield |
= Revision
::DELETED_RESTRICTED
;
3188 $bitfield = 'rev_deleted';
3192 // For now, shunt the revision data into the archive table.
3193 // Text is *not* removed from the text table; bulk storage
3194 // is left intact to avoid breaking block-compression or
3195 // immutable storage schemes.
3197 // For backwards compatibility, note that some older archive
3198 // table entries will have ar_text and ar_flags fields still.
3200 // In the future, we may keep revisions and mark them with
3201 // the rev_deleted field, which is reserved for this purpose.
3202 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3204 'ar_namespace' => 'page_namespace',
3205 'ar_title' => 'page_title',
3206 'ar_comment' => 'rev_comment',
3207 'ar_user' => 'rev_user',
3208 'ar_user_text' => 'rev_user_text',
3209 'ar_timestamp' => 'rev_timestamp',
3210 'ar_minor_edit' => 'rev_minor_edit',
3211 'ar_rev_id' => 'rev_id',
3212 'ar_text_id' => 'rev_text_id',
3213 'ar_text' => '\'\'', // Be explicit to appease
3214 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3215 'ar_len' => 'rev_len',
3216 'ar_page_id' => 'page_id',
3217 'ar_deleted' => $bitfield
3220 'page_id = rev_page'
3224 # Delete restrictions for it
3225 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
3227 # Now that it's safely backed up, delete it
3228 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
3229 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3236 # Fix category table counts
3238 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
3240 foreach ( $res as $row ) {
3241 $cats [] = $row->cl_to
;
3244 $this->updateCategoryCounts( array(), $cats );
3246 # If using cascading deletes, we can skip some explicit deletes
3247 if ( !$dbw->cascadingDeletes() ) {
3248 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
3250 if ( $wgUseTrackbacks )
3251 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
3253 # Delete outgoing links
3254 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3255 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3256 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3257 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3258 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3259 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3260 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3263 # If using cleanup triggers, we can skip some manual deletes
3264 if ( !$dbw->cleanupTriggers() ) {
3265 # Clean up recentchanges entries...
3266 $dbw->delete( 'recentchanges',
3267 array( 'rc_type != ' . RC_LOG
,
3268 'rc_namespace' => $this->mTitle
->getNamespace(),
3269 'rc_title' => $this->mTitle
->getDBkey() ),
3271 $dbw->delete( 'recentchanges',
3272 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
3277 Article
::onArticleDelete( $this->mTitle
);
3279 # Clear the cached article id so the interface doesn't act like we exist
3280 $this->mTitle
->resetArticleID( 0 );
3282 # Log the deletion, if the page was suppressed, log it at Oversight instead
3283 $logtype = $suppress ?
'suppress' : 'delete';
3284 $log = new LogPage( $logtype );
3286 # Make sure logging got through
3287 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
3297 * Roll back the most recent consecutive set of edits to a page
3298 * from the same user; fails if there are no eligible edits to
3299 * roll back to, e.g. user is the sole contributor. This function
3300 * performs permissions checks on $wgUser, then calls commitRollback()
3301 * to do the dirty work
3303 * @param $fromP String: Name of the user whose edits to rollback.
3304 * @param $summary String: Custom summary. Set to default summary if empty.
3305 * @param $token String: Rollback token.
3306 * @param $bot Boolean: If true, mark all reverted edits as bot.
3308 * @param $resultDetails Array: contains result-specific array of additional values
3309 * 'alreadyrolled' : 'current' (rev)
3310 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3312 * @return array of errors, each error formatted as
3313 * array(messagekey, param1, param2, ...).
3314 * On success, the array is empty. This array can also be passed to
3315 * OutputPage::showPermissionsErrorPage().
3317 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3320 $resultDetails = null;
3323 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
3324 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
3325 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3327 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
3328 $errors[] = array( 'sessionfailure' );
3331 if ( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3332 $errors[] = array( 'actionthrottledtext' );
3335 # If there were errors, bail out now
3336 if ( !empty( $errors ) ) {
3340 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3344 * Backend implementation of doRollback(), please refer there for parameter
3345 * and return value documentation
3347 * NOTE: This function does NOT check ANY permissions, it just commits the
3348 * rollback to the DB Therefore, you should only call this function direct-
3349 * ly if you want to use custom permissions checks. If you don't, use
3350 * doRollback() instead.
3352 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3353 global $wgUseRCPatrol, $wgUser, $wgLang;
3355 $dbw = wfGetDB( DB_MASTER
);
3357 if ( wfReadOnly() ) {
3358 return array( array( 'readonlytext' ) );
3361 # Get the last editor
3362 $current = Revision
::newFromTitle( $this->mTitle
);
3363 if ( is_null( $current ) ) {
3364 # Something wrong... no page?
3365 return array( array( 'notanarticle' ) );
3368 $from = str_replace( '_', ' ', $fromP );
3369 # User name given should match up with the top revision.
3370 # If the user was deleted then $from should be empty.
3371 if ( $from != $current->getUserText() ) {
3372 $resultDetails = array( 'current' => $current );
3373 return array( array( 'alreadyrolled',
3374 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3375 htmlspecialchars( $fromP ),
3376 htmlspecialchars( $current->getUserText() )
3380 # Get the last edit not by this guy...
3381 # Note: these may not be public values
3382 $user = intval( $current->getRawUser() );
3383 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3384 $s = $dbw->selectRow( 'revision',
3385 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3386 array( 'rev_page' => $current->getPage(),
3387 "rev_user != {$user} OR rev_user_text != {$user_text}"
3389 array( 'USE INDEX' => 'page_timestamp',
3390 'ORDER BY' => 'rev_timestamp DESC' )
3392 if ( $s === false ) {
3393 # No one else ever edited this page
3394 return array( array( 'cantrollback' ) );
3395 } else if ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
3396 # Only admins can see this text
3397 return array( array( 'notvisiblerev' ) );
3401 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3402 # Mark all reverted edits as bot
3406 if ( $wgUseRCPatrol ) {
3407 # Mark all reverted edits as patrolled
3408 $set['rc_patrolled'] = 1;
3411 if ( count( $set ) ) {
3412 $dbw->update( 'recentchanges', $set,
3414 'rc_cur_id' => $current->getPage(),
3415 'rc_user_text' => $current->getUserText(),
3416 "rc_timestamp > '{$s->rev_timestamp}'",
3421 # Generate the edit summary if necessary
3422 $target = Revision
::newFromId( $s->rev_id
);
3423 if ( empty( $summary ) ) {
3424 if ( $from == '' ) { // no public user name
3425 $summary = wfMsgForContent( 'revertpage-nouser' );
3427 $summary = wfMsgForContent( 'revertpage' );
3431 # Allow the custom summary to use the same args as the default message
3433 $target->getUserText(), $from, $s->rev_id
,
3434 $wgLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
), true ),
3435 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3437 $summary = wfMsgReplaceArgs( $summary, $args );
3440 $flags = EDIT_UPDATE
;
3442 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3443 $flags |
= EDIT_MINOR
;
3446 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) ||
$wgUser->isAllowed( 'bot' ) ) ) {
3447 $flags |
= EDIT_FORCE_BOT
;
3450 # Actually store the edit
3451 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3452 if ( !empty( $status->value
['revision'] ) ) {
3453 $revId = $status->value
['revision']->getId();
3458 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3460 $resultDetails = array(
3461 'summary' => $summary,
3462 'current' => $current,
3463 'target' => $target,
3471 * User interface for rollback operations
3473 public function rollback() {
3474 global $wgUser, $wgOut, $wgRequest;
3478 $result = $this->doRollback(
3479 $wgRequest->getVal( 'from' ),
3480 $wgRequest->getText( 'summary' ),
3481 $wgRequest->getVal( 'token' ),
3482 $wgRequest->getBool( 'bot' ),
3486 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3487 $wgOut->rateLimited();
3491 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3492 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3493 $errArray = $result[0];
3494 $errMsg = array_shift( $errArray );
3495 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3497 if ( isset( $details['current'] ) ) {
3498 $current = $details['current'];
3500 if ( $current->getComment() != '' ) {
3501 $wgOut->addWikiMsgArray( 'editcomment', array(
3502 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3509 # Display permissions errors before read-only message -- there's no
3510 # point in misleading the user into thinking the inability to rollback
3511 # is only temporary.
3512 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3513 # array_diff is completely broken for arrays of arrays, sigh.
3514 # Remove any 'readonlytext' error manually.
3516 foreach ( $result as $error ) {
3517 if ( $error != array( 'readonlytext' ) ) {
3521 $wgOut->showPermissionsErrorPage( $out );
3526 if ( $result == array( array( 'readonlytext' ) ) ) {
3527 $wgOut->readOnlyPage();
3532 $current = $details['current'];
3533 $target = $details['target'];
3534 $newId = $details['newid'];
3535 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3536 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3538 if ( $current->getUserText() === '' ) {
3539 $old = wfMsg( 'rev-deleted-user' );
3541 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3542 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3545 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3546 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3547 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3548 $wgOut->returnToMain( false, $this->mTitle
);
3550 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3551 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3552 $de->showDiff( '', '' );
3557 * Do standard deferred updates after page view
3559 public function viewUpdates() {
3560 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3561 if ( wfReadOnly() ) {
3565 # Don't update page view counters on views from bot users (bug 14044)
3566 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3567 Article
::incViewCount( $this->getID() );
3568 $u = new SiteStatsUpdate( 1, 0, 0 );
3569 array_push( $wgDeferredUpdateList, $u );
3572 # Update newtalk / watchlist notification status
3573 $wgUser->clearNotification( $this->mTitle
);
3577 * Prepare text which is about to be saved.
3578 * Returns a stdclass with source, pst and output members
3580 public function prepareTextForEdit( $text, $revid = null ) {
3581 if ( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid ) {
3583 return $this->mPreparedEdit
;
3588 $edit = (object)array();
3589 $edit->revid
= $revid;
3590 $edit->newText
= $text;
3591 $edit->pst
= $this->preSaveTransform( $text );
3592 $edit->popts
= clone $this->getParserOptions();
3593 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $edit->popts
, true, true, $revid );
3594 $edit->oldText
= $this->getContent();
3596 $this->mPreparedEdit
= $edit;
3602 * Do standard deferred updates after page edit.
3603 * Update links tables, site stats, search index and message cache.
3604 * Purges pages that include this page if the text was changed here.
3605 * Every 100th edit, prune the recent changes table.
3608 * @param $text New text of the article
3609 * @param $summary Edit summary
3610 * @param $minoredit Minor edit
3611 * @param $timestamp_of_pagechange Timestamp associated with the page change
3612 * @param $newid rev_id value of the new revision
3613 * @param $changed Whether or not the content actually changed
3615 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true ) {
3616 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3618 wfProfileIn( __METHOD__
);
3621 # Be careful not to double-PST: $text is usually already PST-ed once
3622 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3623 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3624 $editInfo = $this->prepareTextForEdit( $text, $newid );
3626 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3627 $editInfo = $this->mPreparedEdit
;
3630 # Save it to the parser cache
3631 if ( $wgEnableParserCache ) {
3632 $parserCache = ParserCache
::singleton();
3633 $parserCache->save( $editInfo->output
, $this, $editInfo->popts
);
3636 # Update the links tables
3637 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3640 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3642 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3643 if ( 0 == mt_rand( 0, 99 ) ) {
3644 // Flush old entries from the `recentchanges` table; we do this on
3645 // random requests so as to avoid an increase in writes for no good reason
3648 $dbw = wfGetDB( DB_MASTER
);
3649 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3650 $recentchanges = $dbw->tableName( 'recentchanges' );
3651 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3653 $dbw->query( $sql );
3657 $id = $this->getID();
3658 $title = $this->mTitle
->getPrefixedDBkey();
3659 $shortTitle = $this->mTitle
->getDBkey();
3662 wfProfileOut( __METHOD__
);
3666 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3667 array_push( $wgDeferredUpdateList, $u );
3668 $u = new SearchUpdate( $id, $title, $text );
3669 array_push( $wgDeferredUpdateList, $u );
3671 # If this is another user's talk page, update newtalk
3672 # Don't do this if $changed = false otherwise some idiot can null-edit a
3673 # load of user talk pages and piss people off, nor if it's a minor edit
3674 # by a properly-flagged bot.
3675 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3676 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3678 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3679 $other = User
::newFromName( $shortTitle, false );
3681 wfDebug( __METHOD__
. ": invalid username\n" );
3682 } elseif ( User
::isIP( $shortTitle ) ) {
3683 // An anonymous user
3684 $other->setNewtalk( true );
3685 } elseif ( $other->isLoggedIn() ) {
3686 $other->setNewtalk( true );
3688 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3693 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3694 $wgMessageCache->replace( $shortTitle, $text );
3697 wfProfileOut( __METHOD__
);
3701 * Perform article updates on a special page creation.
3703 * @param $rev Revision object
3705 * @todo This is a shitty interface function. Kill it and replace the
3706 * other shitty functions like editUpdates and such so it's not needed
3709 public function createUpdates( $rev ) {
3710 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3711 $this->mTotalAdjustment
= 1;
3712 $this->editUpdates( $rev->getText(), $rev->getComment(),
3713 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3717 * Generate the navigation links when browsing through an article revisions
3718 * It shows the information as:
3719 * Revision as of \<date\>; view current revision
3720 * \<- Previous version | Next Version -\>
3722 * @param $oldid String: revision ID of this article revision
3724 public function setOldSubtitle( $oldid = 0 ) {
3725 global $wgLang, $wgOut, $wgUser, $wgRequest;
3727 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3731 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3733 # Cascade unhide param in links for easy deletion browsing
3734 $extraParams = array();
3735 if ( $wgRequest->getVal( 'unhide' ) ) {
3736 $extraParams['unhide'] = 1;
3739 $revision = Revision
::newFromId( $oldid );
3741 $current = ( $oldid == $this->mLatest
);
3742 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3743 $tddate = $wgLang->date( $this->mTimestamp
, true );
3744 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3745 $sk = $wgUser->getSkin();
3747 ?
wfMsgHtml( 'currentrevisionlink' )
3750 wfMsgHtml( 'currentrevisionlink' ),
3753 array( 'known', 'noclasses' )
3756 ?
wfMsgHtml( 'diff' )
3759 wfMsgHtml( 'diff' ),
3765 array( 'known', 'noclasses' )
3767 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3771 wfMsgHtml( 'previousrevision' ),
3774 'direction' => 'prev',
3777 array( 'known', 'noclasses' )
3779 : wfMsgHtml( 'previousrevision' );
3783 wfMsgHtml( 'diff' ),
3789 array( 'known', 'noclasses' )
3791 : wfMsgHtml( 'diff' );
3792 $nextlink = $current
3793 ?
wfMsgHtml( 'nextrevision' )
3796 wfMsgHtml( 'nextrevision' ),
3799 'direction' => 'next',
3802 array( 'known', 'noclasses' )
3804 $nextdiff = $current
3805 ?
wfMsgHtml( 'diff' )
3808 wfMsgHtml( 'diff' ),
3814 array( 'known', 'noclasses' )
3819 // User can delete revisions or view deleted revisions...
3820 $canHide = $wgUser->isAllowed( 'deleterevision' );
3821 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3822 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3823 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3826 'type' => 'revision',
3827 'target' => $this->mTitle
->getPrefixedDbkey(),
3830 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
3835 # Show user links if allowed to see them. If hidden, then show them only if requested...
3836 $userlinks = $sk->revUserTools( $revision, !$unhide );
3838 $m = wfMsg( 'revision-info-current' );
3839 $infomsg = $current && !wfEmptyMsg( 'revision-info-current', $m ) && $m != '-'
3840 ?
'revision-info-current'
3843 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3846 array( 'parseinline', 'replaceafter' ),
3852 $revision->getUser()
3855 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3856 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3858 $wgOut->setSubtitle( $r );
3862 * This function is called right before saving the wikitext,
3863 * so we can do things like signatures and links-in-context.
3865 * @param $text String article contents
3866 * @return string article contents with altered wikitext markup (signatures
3867 * converted, {{subst:}}, templates, etc.)
3869 public function preSaveTransform( $text ) {
3870 global $wgParser, $wgUser;
3872 return $wgParser->preSaveTransform( $text, $this->mTitle
, $wgUser, ParserOptions
::newFromUser( $wgUser ) );
3875 /* Caching functions */
3878 * checkLastModified returns true if it has taken care of all
3879 * output to the client that is necessary for this request.
3880 * (that is, it has sent a cached version of the page)
3882 * @return boolean true if cached version send, false otherwise
3884 protected function tryFileCache() {
3885 static $called = false;
3888 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3893 if ( $this->isFileCacheable() ) {
3894 $cache = new HTMLFileCache( $this->mTitle
);
3895 if ( $cache->isFileCacheGood( $this->mTouched
) ) {
3896 wfDebug( "Article::tryFileCache(): about to load file\n" );
3897 $cache->loadFromFileCache();
3900 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3901 ob_start( array( &$cache, 'saveToFileCache' ) );
3904 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3911 * Check if the page can be cached
3914 public function isFileCacheable() {
3917 if ( HTMLFileCache
::useFileCache() ) {
3918 $cacheable = $this->getID() && !$this->mRedirectedFrom
;
3919 // Extension may have reason to disable file caching on some pages.
3921 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3929 * Loads page_touched and returns a value indicating if it should be used
3930 * @return boolean true if not a redirect
3932 public function checkTouched() {
3933 if ( !$this->mDataLoaded
) {
3934 $this->loadPageData();
3937 return !$this->mIsRedirect
;
3941 * Get the page_touched field
3942 * @return string containing GMT timestamp
3944 public function getTouched() {
3945 if ( !$this->mDataLoaded
) {
3946 $this->loadPageData();
3949 return $this->mTouched
;
3953 * Get the page_latest field
3954 * @return integer rev_id of current revision
3956 public function getLatest() {
3957 if ( !$this->mDataLoaded
) {
3958 $this->loadPageData();
3961 return (int)$this->mLatest
;
3965 * Edit an article without doing all that other stuff
3966 * The article must already exist; link tables etc
3967 * are not updated, caches are not flushed.
3969 * @param $text String: text submitted
3970 * @param $comment String: comment submitted
3971 * @param $minor Boolean: whereas it's a minor modification
3973 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3974 wfProfileIn( __METHOD__
);
3976 $dbw = wfGetDB( DB_MASTER
);
3977 $revision = new Revision( array(
3978 'page' => $this->getId(),
3980 'comment' => $comment,
3981 'minor_edit' => $minor ?
1 : 0,
3983 $revision->insertOn( $dbw );
3984 $this->updateRevisionOn( $dbw, $revision );
3987 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
3989 wfProfileOut( __METHOD__
);
3993 * Used to increment the view counter
3995 * @param $id Integer: article id
3997 public static function incViewCount( $id ) {
3998 $id = intval( $id );
4000 global $wgHitcounterUpdateFreq;
4002 $dbw = wfGetDB( DB_MASTER
);
4003 $pageTable = $dbw->tableName( 'page' );
4004 $hitcounterTable = $dbw->tableName( 'hitcounter' );
4005 $acchitsTable = $dbw->tableName( 'acchits' );
4006 $dbType = $dbw->getType();
4008 if ( $wgHitcounterUpdateFreq <= 1 ||
$dbType == 'sqlite' ) {
4009 $dbw->query( "UPDATE $pageTable SET page_counter = page_counter + 1 WHERE page_id = $id" );
4014 # Not important enough to warrant an error page in case of failure
4015 $oldignore = $dbw->ignoreErrors( true );
4017 $dbw->query( "INSERT INTO $hitcounterTable (hc_id) VALUES ({$id})" );
4019 $checkfreq = intval( $wgHitcounterUpdateFreq / 25 +
1 );
4020 if ( ( rand() %
$checkfreq != 0 ) or ( $dbw->lastErrno() != 0 ) ) {
4021 # Most of the time (or on SQL errors), skip row count check
4022 $dbw->ignoreErrors( $oldignore );
4027 $res = $dbw->query( "SELECT COUNT(*) as n FROM $hitcounterTable" );
4028 $row = $dbw->fetchObject( $res );
4029 $rown = intval( $row->n
);
4031 if ( $rown >= $wgHitcounterUpdateFreq ) {
4032 wfProfileIn( 'Article::incViewCount-collect' );
4033 $old_user_abort = ignore_user_abort( true );
4035 $dbw->lockTables( array(), array( 'hitcounter' ), __METHOD__
, false );
4036 $tabletype = $dbType == 'mysql' ?
"ENGINE=HEAP " : '';
4037 $dbw->query( "CREATE TEMPORARY TABLE $acchitsTable $tabletype AS " .
4038 "SELECT hc_id,COUNT(*) AS hc_n FROM $hitcounterTable " .
4039 'GROUP BY hc_id', __METHOD__
);
4040 $dbw->delete( 'hitcounter', '*', __METHOD__
);
4041 $dbw->unlockTables( __METHOD__
);
4043 if ( $dbType == 'mysql' ) {
4044 $dbw->query( "UPDATE $pageTable,$acchitsTable SET page_counter=page_counter + hc_n " .
4045 'WHERE page_id = hc_id', __METHOD__
);
4047 $dbw->query( "UPDATE $pageTable SET page_counter=page_counter + hc_n " .
4048 "FROM $acchitsTable WHERE page_id = hc_id", __METHOD__
);
4050 $dbw->query( "DROP TABLE $acchitsTable", __METHOD__
);
4052 ignore_user_abort( $old_user_abort );
4053 wfProfileOut( 'Article::incViewCount-collect' );
4056 $dbw->ignoreErrors( $oldignore );
4060 * The onArticle*() functions are supposed to be a kind of hooks
4061 * which should be called whenever any of the specified actions
4064 * This is a good place to put code to clear caches, for instance.
4066 * This is called on page move and undelete, as well as edit
4068 * @param $title a title object
4070 public static function onArticleCreate( $title ) {
4071 # Update existence markers on article/talk tabs...
4072 if ( $title->isTalkPage() ) {
4073 $other = $title->getSubjectPage();
4075 $other = $title->getTalkPage();
4078 $other->invalidateCache();
4079 $other->purgeSquid();
4081 $title->touchLinks();
4082 $title->purgeSquid();
4083 $title->deleteTitleProtection();
4087 * Clears caches when article is deleted
4089 public static function onArticleDelete( $title ) {
4090 global $wgMessageCache;
4092 # Update existence markers on article/talk tabs...
4093 if ( $title->isTalkPage() ) {
4094 $other = $title->getSubjectPage();
4096 $other = $title->getTalkPage();
4099 $other->invalidateCache();
4100 $other->purgeSquid();
4102 $title->touchLinks();
4103 $title->purgeSquid();
4106 HTMLFileCache
::clearFileCache( $title );
4109 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
4110 $wgMessageCache->replace( $title->getDBkey(), false );
4114 if ( $title->getNamespace() == NS_FILE
) {
4115 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4116 $update->doUpdate();
4120 if ( $title->getNamespace() == NS_USER_TALK
) {
4121 $user = User
::newFromName( $title->getText(), false );
4122 $user->setNewtalk( false );
4126 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4130 * Purge caches on page update etc
4132 * @param $title Title object
4133 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4135 public static function onArticleEdit( $title ) {
4136 global $wgDeferredUpdateList;
4138 // Invalidate caches of articles which include this page
4139 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4141 // Invalidate the caches of all pages which redirect here
4142 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4144 # Purge squid for this page only
4145 $title->purgeSquid();
4147 # Clear file cache for this page only
4148 HTMLFileCache
::clearFileCache( $title );
4154 * Overriden by ImagePage class, only present here to avoid a fatal error
4155 * Called for ?action=revert
4157 public function revert() {
4159 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4163 * Info about this page
4164 * Called for ?action=info when $wgAllowPageInfo is on.
4166 public function info() {
4167 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4169 if ( !$wgAllowPageInfo ) {
4170 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4174 $page = $this->mTitle
->getSubjectPage();
4176 $wgOut->setPagetitle( $page->getPrefixedText() );
4177 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4178 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4180 if ( !$this->mTitle
->exists() ) {
4181 $wgOut->addHTML( '<div class="noarticletext">' );
4182 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
4183 // This doesn't quite make sense; the user is asking for
4184 // information about the _page_, not the message... -- RC
4185 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
4187 $msg = $wgUser->isLoggedIn()
4189 : 'noarticletextanon';
4190 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4193 $wgOut->addHTML( '</div>' );
4195 $dbr = wfGetDB( DB_SLAVE
);
4197 'wl_title' => $page->getDBkey(),
4198 'wl_namespace' => $page->getNamespace() );
4199 $numwatchers = $dbr->selectField(
4204 $this->getSelectOptions() );
4206 $pageInfo = $this->pageCountInfo( $page );
4207 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4210 //FIXME: unescaped messages
4211 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4212 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4215 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4218 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4221 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4224 $wgOut->addHTML( '</ul>' );
4229 * Return the total number of edits and number of unique editors
4230 * on a given page. If page does not exist, returns false.
4232 * @param $title Title object
4233 * @return mixed array or boolean false
4235 public function pageCountInfo( $title ) {
4236 $id = $title->getArticleId();
4242 $dbr = wfGetDB( DB_SLAVE
);
4243 $rev_clause = array( 'rev_page' => $id );
4244 $edits = $dbr->selectField(
4249 $this->getSelectOptions()
4251 $authors = $dbr->selectField(
4253 'COUNT(DISTINCT rev_user_text)',
4256 $this->getSelectOptions()
4259 return array( 'edits' => $edits, 'authors' => $authors );
4263 * Return a list of templates used by this article.
4264 * Uses the templatelinks table
4266 * @return Array of Title objects
4268 public function getUsedTemplates() {
4270 $id = $this->mTitle
->getArticleID();
4276 $dbr = wfGetDB( DB_SLAVE
);
4277 $res = $dbr->select( array( 'templatelinks' ),
4278 array( 'tl_namespace', 'tl_title' ),
4279 array( 'tl_from' => $id ),
4282 if ( $res !== false ) {
4283 foreach ( $res as $row ) {
4284 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
4292 * Returns a list of hidden categories this page is a member of.
4293 * Uses the page_props and categorylinks tables.
4295 * @return Array of Title objects
4297 public function getHiddenCategories() {
4299 $id = $this->mTitle
->getArticleID();
4305 $dbr = wfGetDB( DB_SLAVE
);
4306 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4308 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4309 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
4312 if ( $res !== false ) {
4313 foreach ( $res as $row ) {
4314 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
4322 * Return an applicable autosummary if one exists for the given edit.
4323 * @param $oldtext String: the previous text of the page.
4324 * @param $newtext String: The submitted text of the page.
4325 * @param $flags Bitmask: a bitmask of flags submitted for the edit.
4326 * @return string An appropriate autosummary, or an empty string.
4328 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4331 # Decide what kind of autosummary is needed.
4333 # Redirect autosummaries
4334 $ot = Title
::newFromRedirect( $oldtext );
4335 $rt = Title
::newFromRedirect( $newtext );
4337 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
4338 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4341 # New page autosummaries
4342 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
4343 # If they're making a new article, give its text, truncated, in the summary.
4345 $truncatedtext = $wgContLang->truncate(
4346 str_replace( "\n", ' ', $newtext ),
4347 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4349 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4352 # Blanking autosummaries
4353 if ( $oldtext != '' && $newtext == '' ) {
4354 return wfMsgForContent( 'autosumm-blank' );
4355 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4356 # Removing more than 90% of the article
4358 $truncatedtext = $wgContLang->truncate(
4360 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4362 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4365 # If we reach this point, there's no applicable autosummary for our case, so our
4366 # autosummary is empty.
4371 * Add the primary page-view wikitext to the output buffer
4372 * Saves the text into the parser cache if possible.
4373 * Updates templatelinks if it is out of date.
4375 * @param $text String
4376 * @param $cache Boolean
4377 * @param $parserOptions mixed ParserOptions object, or boolean false
4379 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4382 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4383 $wgOut->addParserOutput( $this->mParserOutput
);
4387 * This does all the heavy lifting for outputWikitext, except it returns the parser
4388 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4389 * say, embedding thread pages within a discussion system (LiquidThreads)
4391 * @param $text string
4392 * @param $cache boolean
4393 * @param $parserOptions parsing options, defaults to false
4394 * @return string containing parsed output
4396 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4397 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4399 if ( !$parserOptions ) {
4400 $parserOptions = clone $this->getParserOptions();
4404 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
4405 $parserOptions, true, true, $this->getRevIdFetched() );
4410 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4411 $this->mTitle
->getPrefixedDBkey() ) );
4414 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
4415 $parserCache = ParserCache
::singleton();
4416 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4419 // Make sure file cache is not used on uncacheable content.
4420 // Output that has magic words in it can still use the parser cache
4421 // (if enabled), though it will generally expire sooner.
4422 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
4423 $wgUseFileCache = false;
4426 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4428 return $this->mParserOutput
;
4432 * Get parser options suitable for rendering the primary article wikitext
4433 * @return mixed ParserOptions object or boolean false
4435 public function getParserOptions() {
4438 if ( !$this->mParserOptions
) {
4439 $this->mParserOptions
= new ParserOptions( $wgUser );
4440 $this->mParserOptions
->setTidy( true );
4441 $this->mParserOptions
->enableLimitReport();
4444 // Clone to allow modifications of the return value without affecting
4446 return clone $this->mParserOptions
;
4450 * Updates cascading protections
4452 * @param $parserOutput mixed ParserOptions object, or boolean false
4455 protected function doCascadeProtectionUpdates( $parserOutput ) {
4456 if ( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4460 // templatelinks table may have become out of sync,
4461 // especially if using variable-based transclusions.
4462 // For paranoia, check if things have changed and if
4463 // so apply updates to the database. This will ensure
4464 // that cascaded protections apply as soon as the changes
4467 # Get templates from templatelinks
4468 $id = $this->mTitle
->getArticleID();
4470 $tlTemplates = array();
4472 $dbr = wfGetDB( DB_SLAVE
);
4473 $res = $dbr->select( array( 'templatelinks' ),
4474 array( 'tl_namespace', 'tl_title' ),
4475 array( 'tl_from' => $id ),
4479 foreach ( $res as $row ) {
4480 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4483 # Get templates from parser output.
4484 $poTemplates = array();
4485 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4486 foreach ( $templates as $dbk => $id ) {
4487 $poTemplates["$ns:$dbk"] = true;
4492 # Note that we simulate array_diff_key in PHP <5.0.x
4493 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4495 if ( count( $templates_diff ) > 0 ) {
4496 # Whee, link updates time.
4497 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4503 * Update all the appropriate counts in the category table, given that
4504 * we've added the categories $added and deleted the categories $deleted.
4506 * @param $added array The names of categories that were added
4507 * @param $deleted array The names of categories that were deleted
4509 public function updateCategoryCounts( $added, $deleted ) {
4510 $ns = $this->mTitle
->getNamespace();
4511 $dbw = wfGetDB( DB_MASTER
);
4513 # First make sure the rows exist. If one of the "deleted" ones didn't
4514 # exist, we might legitimately not create it, but it's simpler to just
4515 # create it and then give it a negative value, since the value is bogus
4518 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4519 $insertCats = array_merge( $added, $deleted );
4520 if ( !$insertCats ) {
4521 # Okay, nothing to do
4525 $insertRows = array();
4527 foreach ( $insertCats as $cat ) {
4528 $insertRows[] = array(
4529 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4533 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4535 $addFields = array( 'cat_pages = cat_pages + 1' );
4536 $removeFields = array( 'cat_pages = cat_pages - 1' );
4538 if ( $ns == NS_CATEGORY
) {
4539 $addFields[] = 'cat_subcats = cat_subcats + 1';
4540 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4541 } elseif ( $ns == NS_FILE
) {
4542 $addFields[] = 'cat_files = cat_files + 1';
4543 $removeFields[] = 'cat_files = cat_files - 1';
4550 array( 'cat_title' => $added ),
4559 array( 'cat_title' => $deleted ),
4566 * Lightweight method to get the parser output for a page, checking the parser cache
4567 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4568 * consider, so it's not appropriate to use there.
4570 * @since 1.16 (r52326) for LiquidThreads
4572 * @param $oldid mixed integer Revision ID or null
4574 public function getParserOutput( $oldid = null ) {
4575 global $wgEnableParserCache, $wgUser;
4577 // Should the parser cache be used?
4578 $useParserCache = $wgEnableParserCache &&
4579 $wgUser->getStubThreshold() == 0 &&
4583 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4585 if ( $wgUser->getStubThreshold() ) {
4586 wfIncrStats( 'pcache_miss_stub' );
4589 $parserOutput = false;
4590 if ( $useParserCache ) {
4591 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4594 if ( $parserOutput === false ) {
4595 // Cache miss; parse and output it.
4596 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4598 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4600 return $parserOutput;
4604 // Deprecated methods
4606 * Get the database which should be used for reads
4609 * @deprecated - just call wfGetDB( DB_MASTER ) instead
4612 wfDeprecated( __METHOD__
);
4613 return wfGetDB( DB_MASTER
);
4618 class PoolWorkArticleView
extends PoolCounterWork
{
4621 function __construct( $article, $key, $useParserCache, $parserOptions ) {
4622 parent
::__construct( __CLASS__
, $key );
4623 $this->mArticle
= $article;
4624 $this->cacheable
= $useParserCache;
4625 $this->parserOptions
= $parserOptions;
4629 return $this->mArticle
->doViewParse();
4632 function getCachedWork() {
4635 $parserCache = ParserCache
::singleton();
4636 $this->mArticle
->mParserOutput
= $parserCache->get( $this->mArticle
, $this->parserOptions
);
4638 if ( $this->mArticle
->mParserOutput
!== false ) {
4639 wfDebug( __METHOD__
. ": showing contents parsed by someone else\n" );
4640 $wgOut->addParserOutput( $this->mArticle
->mParserOutput
);
4641 # Ensure that UI elements requiring revision ID have
4642 # the correct version information.
4643 $wgOut->setRevisionId( $this->mArticle
->getLatest() );
4649 function fallback() {
4650 return $this->mArticle
->tryDirtyCache();
4653 function error( $status ) {
4656 $wgOut->clearHTML(); // for release() errors
4657 $wgOut->enableClientCache( false );
4658 $wgOut->setRobotPolicy( 'noindex,nofollow' );
4660 if ( $status instanceof Status
) {
4661 $errortext = $status->getWikiText( false, 'view-pool-error' );
4663 $errortext = wfMsgNoTrans( 'view-pool-error', '' );
4665 $wgOut->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );