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' ),
99 array( 'rd_from' => $this->getID() ),
104 return $this->mRedirectTarget
= Title
::makeTitle( $row->rd_namespace
, $row->rd_title
);
107 # This page doesn't have an entry in the redirect table
108 return $this->mRedirectTarget
= $this->insertRedirect();
112 * Insert an entry for this page into the redirect table.
114 * Don't call this function directly unless you know what you're doing.
115 * @return Title object
117 public function insertRedirect() {
118 $retval = Title
::newFromRedirect( $this->getContent() );
124 $dbw = wfGetDB( DB_MASTER
);
125 $dbw->replace( 'redirect', array( 'rd_from' ),
127 'rd_from' => $this->getID(),
128 'rd_namespace' => $retval->getNamespace(),
129 'rd_title' => $retval->getDBkey()
138 * Get the Title object this page redirects to
140 * @return mixed false, Title of in-wiki target, or string with URL
142 public function followRedirect() {
143 $text = $this->getContent();
144 return $this->followRedirectText( $text );
148 * Get the Title object this text redirects to
150 * @param $text string article content containing redirect info
151 * @return mixed false, Title of in-wiki target, or string with URL
153 public function followRedirectText( $text ) {
154 // recurse through to only get the final target
155 $rt = Title
::newFromRedirectRecurse( $text );
158 if ( $rt->getInterwiki() != '' ) {
159 if ( $rt->isLocal() ) {
160 // Offsite wikis need an HTTP redirect.
162 // This can be hard to reverse and may produce loops,
163 // so they may be disabled in the site configuration.
164 $source = $this->mTitle
->getFullURL( 'redirect=no' );
165 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
168 if ( $rt->getNamespace() == NS_SPECIAL
) {
169 // Gotta handle redirects to special pages differently:
170 // Fill the HTTP response "Location" header and ignore
171 // the rest of the page we're on.
173 // This can be hard to reverse, so they may be disabled.
174 if ( $rt->isSpecial( 'Userlogout' ) ) {
177 return $rt->getFullURL();
185 // No or invalid redirect
190 * Get the title object of the article
191 * @return Title object of this page
193 public function getTitle() {
194 return $this->mTitle
;
199 * FIXME: shouldn't this be public?
202 public function clear() {
203 $this->mDataLoaded
= false;
204 $this->mContentLoaded
= false;
206 $this->mCurID
= $this->mUser
= $this->mCounter
= -1; # Not loaded
207 $this->mRedirectedFrom
= null; # Title object if set
208 $this->mRedirectTarget
= null; # Title object if set
210 $this->mTimestamp
= $this->mComment
= '';
211 $this->mGoodAdjustment
= $this->mTotalAdjustment
= 0;
212 $this->mTouched
= '19700101000000';
213 $this->mForUpdate
= false;
214 $this->mIsRedirect
= false;
215 $this->mRevIdFetched
= 0;
216 $this->mRedirectUrl
= false;
217 $this->mLatest
= false;
218 $this->mPreparedEdit
= false;
222 * Note that getContent/loadContent do not follow redirects anymore.
223 * If you need to fetch redirectable content easily, try
224 * the shortcut in Article::followRedirect()
226 * This function has side effects! Do not use this function if you
227 * only want the real revision text if any.
229 * @return Return the text of this revision
231 public function getContent() {
232 global $wgUser, $wgContLang, $wgOut, $wgMessageCache;
234 wfProfileIn( __METHOD__
);
236 if ( $this->getID() === 0 ) {
237 # If this is a MediaWiki:x message, then load the messages
238 # and return the message value for x.
239 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
240 # If this is a system message, get the default text.
241 list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle
->getText() ) );
242 $wgMessageCache->loadAllMessages( $lang );
243 $text = wfMsgGetKey( $message, false, $lang, false );
245 if ( wfEmptyMsg( $message, $text ) )
248 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
250 wfProfileOut( __METHOD__
);
254 $this->loadContent();
255 wfProfileOut( __METHOD__
);
257 return $this->mContent
;
262 * Get the text of the current revision. No side-effects...
264 * @return Return the text of the current revision
266 public function getRawText() {
267 // Check process cache for current revision
268 if ( $this->mContentLoaded
&& $this->mOldId
== 0 ) {
269 return $this->mContent
;
272 $rev = Revision
::newFromTitle( $this->mTitle
);
273 $text = $rev ?
$rev->getRawText() : false;
279 * This function returns the text of a section, specified by a number ($section).
280 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
281 * the first section before any such heading (section 0).
283 * If a section contains subsections, these are also returned.
285 * @param $text String: text to look in
286 * @param $section Integer: section number
287 * @return string text of the requested section
290 public function getSection( $text, $section ) {
292 return $wgParser->getSection( $text, $section );
296 * Get the text that needs to be saved in order to undo all revisions
297 * between $undo and $undoafter. Revisions must belong to the same page,
298 * must exist and must not be deleted
299 * @param $undo Revision
300 * @param $undoafter Revision Must be an earlier revision than $undo
301 * @return mixed string on success, false on failure
303 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
304 $undo_text = $undo->getText();
305 $undoafter_text = $undoafter->getText();
306 $cur_text = $this->getContent();
308 if ( $cur_text == $undo_text ) {
309 # No use doing a merge if it's just a straight revert.
310 return $undoafter_text;
315 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
323 * @return int The oldid of the article that is to be shown, 0 for the
326 public function getOldID() {
327 if ( is_null( $this->mOldId
) ) {
328 $this->mOldId
= $this->getOldIDFromRequest();
331 return $this->mOldId
;
335 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
337 * @return int The old id for the request
339 public function getOldIDFromRequest() {
342 $this->mRedirectUrl
= false;
344 $oldid = $wgRequest->getVal( 'oldid' );
346 if ( isset( $oldid ) ) {
347 $oldid = intval( $oldid );
348 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
349 $nextid = $this->mTitle
->getNextRevisionID( $oldid );
353 $this->mRedirectUrl
= $this->mTitle
->getFullURL( 'redirect=no' );
355 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
356 $previd = $this->mTitle
->getPreviousRevisionID( $oldid );
371 * Load the revision (including text) into this object
373 function loadContent() {
374 if ( $this->mContentLoaded
) {
378 wfProfileIn( __METHOD__
);
380 $oldid = $this->getOldID();
381 $this->mOldId
= $oldid;
382 $this->fetchContent( $oldid );
384 wfProfileOut( __METHOD__
);
388 * Fetch a page record with the given conditions
389 * @param $dbr Database object
390 * @param $conditions Array
391 * @return mixed Database result resource, or false on failure
393 protected function pageData( $dbr, $conditions ) {
408 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
410 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
);
412 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
418 * Fetch a page record matching the Title object's namespace and title
419 * using a sanitized title string
421 * @param $dbr Database object
422 * @param $title Title object
423 * @return mixed Database result resource, or false on failure
425 public function pageDataFromTitle( $dbr, $title ) {
426 return $this->pageData( $dbr, array(
427 'page_namespace' => $title->getNamespace(),
428 'page_title' => $title->getDBkey() ) );
432 * Fetch a page record matching the requested ID
434 * @param $dbr Database
437 protected function pageDataFromId( $dbr, $id ) {
438 return $this->pageData( $dbr, array( 'page_id' => $id ) );
442 * Set the general counter, title etc data loaded from
445 * @param $data Database row object or "fromdb"
447 public function loadPageData( $data = 'fromdb' ) {
448 if ( $data === 'fromdb' ) {
449 $dbr = wfGetDB( DB_MASTER
);
450 $data = $this->pageDataFromId( $dbr, $this->getId() );
453 $lc = LinkCache
::singleton();
456 $lc->addGoodLinkObj( $data->page_id
, $this->mTitle
, $data->page_len
, $data->page_is_redirect
, $data->page_latest
);
458 $this->mTitle
->mArticleID
= intval( $data->page_id
);
460 # Old-fashioned restrictions
461 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
463 $this->mCounter
= intval( $data->page_counter
);
464 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
465 $this->mIsRedirect
= intval( $data->page_is_redirect
);
466 $this->mLatest
= intval( $data->page_latest
);
468 $lc->addBadLinkObj( $this->mTitle
);
469 $this->mTitle
->mArticleID
= 0;
472 $this->mDataLoaded
= true;
476 * Get text of an article from database
477 * Does *NOT* follow redirects.
479 * @param $oldid Int: 0 for whatever the latest revision is
480 * @return mixed string containing article contents, or false if null
482 function fetchContent( $oldid = 0 ) {
483 if ( $this->mContentLoaded
) {
484 return $this->mContent
;
487 $dbr = wfGetDB( DB_MASTER
);
489 # Pre-fill content with error message so that if something
490 # fails we'll have something telling us what we intended.
491 $t = $this->mTitle
->getPrefixedText();
492 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
493 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
496 $revision = Revision
::newFromId( $oldid );
497 if ( $revision === null ) {
498 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
502 $data = $this->pageDataFromId( $dbr, $revision->getPage() );
505 wfDebug( __METHOD__
. " failed to get page data linked to revision id $oldid\n" );
509 $this->mTitle
= Title
::makeTitle( $data->page_namespace
, $data->page_title
);
510 $this->loadPageData( $data );
512 if ( !$this->mDataLoaded
) {
513 $data = $this->pageDataFromTitle( $dbr, $this->mTitle
);
516 wfDebug( __METHOD__
. " failed to find page data for title " . $this->mTitle
->getPrefixedText() . "\n" );
520 $this->loadPageData( $data );
522 $revision = Revision
::newFromId( $this->mLatest
);
523 if ( $revision === null ) {
524 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id {$this->mLatest}\n" );
529 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
530 // We should instead work with the Revision object when we need it...
531 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
533 $this->mUser
= $revision->getUser();
534 $this->mUserText
= $revision->getUserText();
535 $this->mComment
= $revision->getComment();
536 $this->mTimestamp
= wfTimestamp( TS_MW
, $revision->getTimestamp() );
538 $this->mRevIdFetched
= $revision->getId();
539 $this->mContentLoaded
= true;
540 $this->mRevision
=& $revision;
542 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) );
544 return $this->mContent
;
548 * Read/write accessor to select FOR UPDATE
550 * @param $x Mixed: FIXME
551 * @return mixed value of $x, or value stored in Article::mForUpdate
553 public function forUpdate( $x = null ) {
554 return wfSetVar( $this->mForUpdate
, $x );
558 * Get options for all SELECT statements
560 * @param $options Array: an optional options array which'll be appended to
562 * @return Array: options
564 protected function getSelectOptions( $options = '' ) {
565 if ( $this->mForUpdate
) {
566 if ( is_array( $options ) ) {
567 $options[] = 'FOR UPDATE';
569 $options = 'FOR UPDATE';
577 * @return int Page ID
579 public function getID() {
580 return $this->mTitle
->getArticleID();
584 * @return bool Whether or not the page exists in the database
586 public function exists() {
587 return $this->getId() > 0;
591 * Check if this page is something we're going to be showing
592 * some sort of sensible content for. If we return false, page
593 * views (plain action=view) will return an HTTP 404 response,
594 * so spiders and robots can know they're following a bad link.
598 public function hasViewableContent() {
599 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
603 * @return int The view count for the page
605 public function getCount() {
606 if ( -1 == $this->mCounter
) {
607 $id = $this->getID();
612 $dbr = wfGetDB( DB_SLAVE
);
613 $this->mCounter
= $dbr->selectField( 'page',
615 array( 'page_id' => $id ),
617 $this->getSelectOptions()
622 return $this->mCounter
;
626 * Determine whether a page would be suitable for being counted as an
627 * article in the site_stats table based on the title & its content
629 * @param $text String: text to analyze
632 public function isCountable( $text ) {
633 global $wgUseCommaCount;
635 $token = $wgUseCommaCount ?
',' : '[[';
637 return $this->mTitle
->isContentPage() && !$this->isRedirect( $text ) && in_string( $token, $text );
641 * Tests if the article text represents a redirect
643 * @param $text mixed string containing article contents, or boolean
646 public function isRedirect( $text = false ) {
647 if ( $text === false ) {
648 if ( $this->mDataLoaded
) {
649 return $this->mIsRedirect
;
652 // Apparently loadPageData was never called
653 $this->loadContent();
654 $titleObj = Title
::newFromRedirectRecurse( $this->fetchContent() );
656 $titleObj = Title
::newFromRedirect( $text );
659 return $titleObj !== null;
663 * Returns true if the currently-referenced revision is the current edit
664 * to this page (and it exists).
667 public function isCurrent() {
668 # If no oldid, this is the current version.
669 if ( $this->getOldID() == 0 ) {
673 return $this->exists() && isset( $this->mRevision
) && $this->mRevision
->isCurrent();
677 * Loads everything except the text
678 * This isn't necessary for all uses, so it's only done if needed.
680 protected function loadLastEdit() {
681 if ( -1 != $this->mUser
) {
685 # New or non-existent articles have no user information
686 $id = $this->getID();
691 $this->mLastRevision
= Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $id );
692 if ( !is_null( $this->mLastRevision
) ) {
693 $this->mUser
= $this->mLastRevision
->getUser();
694 $this->mUserText
= $this->mLastRevision
->getUserText();
695 $this->mTimestamp
= $this->mLastRevision
->getTimestamp();
696 $this->mComment
= $this->mLastRevision
->getComment();
697 $this->mMinorEdit
= $this->mLastRevision
->isMinor();
698 $this->mRevIdFetched
= $this->mLastRevision
->getId();
703 * @return string GMT timestamp of last article revision
706 public function getTimestamp() {
707 // Check if the field has been filled by ParserCache::get()
708 if ( !$this->mTimestamp
) {
709 $this->loadLastEdit();
712 return wfTimestamp( TS_MW
, $this->mTimestamp
);
716 * @return int user ID for the user that made the last article revision
718 public function getUser() {
719 $this->loadLastEdit();
724 * @return string username of the user that made the last article revision
726 public function getUserText() {
727 $this->loadLastEdit();
728 return $this->mUserText
;
732 * @return string Comment stored for the last article revision
734 public function getComment() {
735 $this->loadLastEdit();
736 return $this->mComment
;
740 * Returns true if last revision was marked as "minor edit"
742 * @return boolean Minor edit indicator for the last article revision.
744 public function getMinorEdit() {
745 $this->loadLastEdit();
746 return $this->mMinorEdit
;
750 * Use this to fetch the rev ID used on page views
752 * @return int revision ID of last article revision
754 public function getRevIdFetched() {
755 $this->loadLastEdit();
756 return $this->mRevIdFetched
;
760 * FIXME: this does what?
761 * @param $limit Integer: default 0.
762 * @param $offset Integer: default 0.
763 * @return UserArrayFromResult object with User objects of article contributors for requested range
765 public function getContributors( $limit = 0, $offset = 0 ) {
766 # FIXME: this is expensive; cache this info somewhere.
768 $dbr = wfGetDB( DB_SLAVE
);
769 $revTable = $dbr->tableName( 'revision' );
770 $userTable = $dbr->tableName( 'user' );
772 $pageId = $this->getId();
774 $user = $this->getUser();
777 $excludeCond = "AND rev_user != $user";
779 $userText = $dbr->addQuotes( $this->getUserText() );
780 $excludeCond = "AND rev_user_text != $userText";
783 $deletedBit = $dbr->bitAnd( 'rev_deleted', Revision
::DELETED_USER
); // username hidden?
785 $sql = "SELECT {$userTable}.*, rev_user_text as user_name, MAX(rev_timestamp) as timestamp
786 FROM $revTable LEFT JOIN $userTable ON rev_user = user_id
787 WHERE rev_page = $pageId
790 GROUP BY rev_user, rev_user_text
791 ORDER BY timestamp DESC";
794 $sql = $dbr->limitResult( $sql, $limit, $offset );
797 $sql .= ' ' . $this->getSelectOptions();
798 $res = $dbr->query( $sql, __METHOD__
);
800 return new UserArrayFromResult( $res );
804 * This is the default action of the index.php entry point: just view the
805 * page of the given title.
807 public function view() {
808 global $wgUser, $wgOut, $wgRequest, $wgContLang;
809 global $wgEnableParserCache, $wgStylePath, $wgParser;
810 global $wgUseTrackbacks, $wgUseFileCache;
812 wfProfileIn( __METHOD__
);
814 # Get variables from query string
815 $oldid = $this->getOldID();
816 $parserCache = ParserCache
::singleton();
818 $parserOptions = clone $this->getParserOptions();
819 # Render printable version, use printable version cache
820 if ( $wgOut->isPrintable() ) {
821 $parserOptions->setIsPrintable( true );
824 # Try client and file cache
825 if ( $oldid === 0 && $this->checkTouched() ) {
829 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
832 # Is is client cached?
833 if ( $wgOut->checkLastModified( $this->getTouched() ) ) {
834 wfDebug( __METHOD__
. ": done 304\n" );
835 wfProfileOut( __METHOD__
);
839 } else if ( $wgUseFileCache && $this->tryFileCache() ) {
840 wfDebug( __METHOD__
. ": done file cache\n" );
841 # tell wgOut that output is taken care of
843 $this->viewUpdates();
844 wfProfileOut( __METHOD__
);
850 # getOldID may want us to redirect somewhere else
851 if ( $this->mRedirectUrl
) {
852 $wgOut->redirect( $this->mRedirectUrl
);
853 wfDebug( __METHOD__
. ": redirecting due to oldid\n" );
854 wfProfileOut( __METHOD__
);
859 $wgOut->setArticleFlag( true );
860 # Set page title (may be overridden by DISPLAYTITLE)
861 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
863 # If we got diff in the query, we want to see a diff page instead of the article.
864 if ( $wgRequest->getCheck( 'diff' ) ) {
865 wfDebug( __METHOD__
. ": showing diff page\n" );
866 $this->showDiffPage();
867 wfProfileOut( __METHOD__
);
872 # Should the parser cache be used?
873 $useParserCache = $this->useParserCache( $oldid );
874 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
875 if ( $wgUser->getOption( 'stubthreshold' ) ) {
876 wfIncrStats( 'pcache_miss_stub' );
879 $wasRedirected = $this->showRedirectedFromHeader();
880 $this->showNamespaceHeader();
882 # Iterate through the possible ways of constructing the output text.
883 # Keep going until $outputDone is set, or we run out of things to do.
886 $this->mParserOutput
= false;
888 while ( !$outputDone && ++
$pass ) {
891 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
894 # Try the parser cache
895 if ( $useParserCache ) {
896 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
898 if ( $this->mParserOutput
!== false ) {
899 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
900 $wgOut->addParserOutput( $this->mParserOutput
);
901 # Ensure that UI elements requiring revision ID have
902 # the correct version information.
903 $wgOut->setRevisionId( $this->mLatest
);
909 $text = $this->getContent();
910 if ( $text === false ||
$this->getID() == 0 ) {
911 wfDebug( __METHOD__
. ": showing missing article\n" );
912 $this->showMissingArticle();
913 wfProfileOut( __METHOD__
);
917 # Another whitelist check in case oldid is altering the title
918 if ( !$this->mTitle
->userCanRead() ) {
919 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
920 $wgOut->loginToUse();
923 wfProfileOut( __METHOD__
);
927 # Are we looking at an old revision
928 if ( $oldid && !is_null( $this->mRevision
) ) {
929 $this->setOldSubtitle( $oldid );
931 if ( !$this->showDeletedRevisionHeader() ) {
932 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
933 wfProfileOut( __METHOD__
);
937 # If this "old" version is the current, then try the parser cache...
938 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
939 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
940 if ( $this->mParserOutput
) {
941 wfDebug( __METHOD__
. ": showing parser cache for current rev permalink\n" );
942 $wgOut->addParserOutput( $this->mParserOutput
);
943 $wgOut->setRevisionId( $this->mLatest
);
944 $this->showViewFooter();
945 $this->viewUpdates();
946 wfProfileOut( __METHOD__
);
952 # Ensure that UI elements requiring revision ID have
953 # the correct version information.
954 $wgOut->setRevisionId( $this->getRevIdFetched() );
956 # Pages containing custom CSS or JavaScript get special treatment
957 if ( $this->mTitle
->isCssOrJsPage() ||
$this->mTitle
->isCssJsSubpage() ) {
958 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
959 $this->showCssOrJsPage();
961 } else if ( $rt = Title
::newFromRedirectArray( $text ) ) {
962 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
963 # Viewing a redirect page (e.g. with parameter redirect=no)
964 # Don't append the subtitle if this was an old revision
965 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
966 # Parse just to get categories, displaytitle, etc.
967 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
, $parserOptions );
968 $wgOut->addParserOutputNoText( $this->mParserOutput
);
973 # Run the parse, protected by a pool counter
974 wfDebug( __METHOD__
. ": doing uncached parse\n" );
975 $key = $parserCache->getKey( $this, $parserOptions );
976 $poolCounter = PoolCounter
::factory( 'Article::view', $key );
977 $dirtyCallback = $useParserCache ?
array( $this, 'tryDirtyCache' ) : false;
978 $status = $poolCounter->executeProtected( array( $this, 'doViewParse' ), $dirtyCallback );
980 if ( !$status->isOK() ) {
981 # Connection or timeout error
982 $this->showPoolError( $status );
983 wfProfileOut( __METHOD__
);
989 # Should be unreachable, but just in case...
995 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
996 if ( $this->mParserOutput
) {
997 $titleText = $this->mParserOutput
->getTitleText();
999 if ( strval( $titleText ) !== '' ) {
1000 $wgOut->setPageTitle( $titleText );
1004 # For the main page, overwrite the <title> element with the con-
1005 # tents of 'pagetitle-view-mainpage' instead of the default (if
1006 # that's not empty).
1007 # This message always exists because it is in the i18n files
1008 if ( $this->mTitle
->equals( Title
::newMainPage() )
1009 && ( $m = wfMsgForContent( 'pagetitle-view-mainpage' ) ) !== '' )
1011 $wgOut->setHTMLTitle( $m );
1014 # Now that we've filled $this->mParserOutput, we know whether
1015 # there are any __NOINDEX__ tags on the page
1016 $policy = $this->getRobotPolicy( 'view' );
1017 $wgOut->setIndexPolicy( $policy['index'] );
1018 $wgOut->setFollowPolicy( $policy['follow'] );
1020 $this->showViewFooter();
1021 $this->viewUpdates();
1022 wfProfileOut( __METHOD__
);
1026 * Show a diff page according to current request variables. For use within
1027 * Article::view() only, other callers should use the DifferenceEngine class.
1029 public function showDiffPage() {
1030 global $wgOut, $wgRequest, $wgUser;
1032 $diff = $wgRequest->getVal( 'diff' );
1033 $rcid = $wgRequest->getVal( 'rcid' );
1034 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
1035 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1036 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1037 $oldid = $this->getOldID();
1039 $de = new DifferenceEngine( $this->mTitle
, $oldid, $diff, $rcid, $purge, $unhide );
1040 // DifferenceEngine directly fetched the revision:
1041 $this->mRevIdFetched
= $de->mNewid
;
1042 $de->showDiffPage( $diffOnly );
1044 // Needed to get the page's current revision
1045 $this->loadPageData();
1046 if ( $diff == 0 ||
$diff == $this->mLatest
) {
1047 # Run view updates for current revision only
1048 $this->viewUpdates();
1053 * Show a page view for a page formatted as CSS or JavaScript. To be called by
1054 * Article::view() only.
1056 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
1059 public function showCssOrJsPage() {
1062 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache'>\n$1\n</div>", 'clearyourcache' );
1064 // Give hooks a chance to customise the output
1065 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->mTitle
, $wgOut ) ) ) {
1066 // Wrap the whole lot in a <pre> and don't parse
1068 preg_match( '!\.(css|js)$!u', $this->mTitle
->getText(), $m );
1069 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
1070 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
1071 $wgOut->addHTML( "\n</pre>\n" );
1076 * Get the robot policy to be used for the current action=view request.
1077 * @return String the policy that should be set
1078 * @deprecated use getRobotPolicy() instead, which returns an associative
1081 public function getRobotPolicyForView() {
1082 wfDeprecated( __METHOD__
);
1083 $policy = $this->getRobotPolicy( 'view' );
1085 return $policy['index'] . ',' . $policy['follow'];
1089 * Get the robot policy to be used for the current view
1090 * @param $action String the action= GET parameter
1091 * @return Array the policy that should be set
1092 * TODO: actions other than 'view'
1094 public function getRobotPolicy( $action ) {
1095 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1096 global $wgDefaultRobotPolicy, $wgRequest;
1098 $ns = $this->mTitle
->getNamespace();
1100 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
1101 # Don't index user and user talk pages for blocked users (bug 11443)
1102 if ( !$this->mTitle
->isSubpage() ) {
1103 $block = new Block();
1104 if ( $block->load( $this->mTitle
->getText() ) ) {
1106 'index' => 'noindex',
1107 'follow' => 'nofollow'
1113 if ( $this->getID() === 0 ||
$this->getOldID() ) {
1114 # Non-articles (special pages etc), and old revisions
1116 'index' => 'noindex',
1117 'follow' => 'nofollow'
1119 } elseif ( $wgOut->isPrintable() ) {
1120 # Discourage indexing of printable versions, but encourage following
1122 'index' => 'noindex',
1123 'follow' => 'follow'
1125 } elseif ( $wgRequest->getInt( 'curid' ) ) {
1126 # For ?curid=x urls, disallow indexing
1128 'index' => 'noindex',
1129 'follow' => 'follow'
1133 # Otherwise, construct the policy based on the various config variables.
1134 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
1136 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
1137 # Honour customised robot policies for this namespace
1138 $policy = array_merge(
1140 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
1143 if ( $this->mTitle
->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ) {
1144 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1145 # a final sanity check that we have really got the parser output.
1146 $policy = array_merge(
1148 array( 'index' => $this->mParserOutput
->getIndexPolicy() )
1152 if ( isset( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) ) {
1153 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1154 $policy = array_merge(
1156 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] )
1164 * Converts a String robot policy into an associative array, to allow
1165 * merging of several policies using array_merge().
1166 * @param $policy Mixed, returns empty array on null/false/'', transparent
1167 * to already-converted arrays, converts String.
1168 * @return associative Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1170 public static function formatRobotPolicy( $policy ) {
1171 if ( is_array( $policy ) ) {
1173 } elseif ( !$policy ) {
1177 $policy = explode( ',', $policy );
1178 $policy = array_map( 'trim', $policy );
1181 foreach ( $policy as $var ) {
1182 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
1183 $arr['index'] = $var;
1184 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
1185 $arr['follow'] = $var;
1193 * If this request is a redirect view, send "redirected from" subtitle to
1194 * $wgOut. Returns true if the header was needed, false if this is not a
1195 * redirect view. Handles both local and remote redirects.
1199 public function showRedirectedFromHeader() {
1200 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1202 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1203 $sk = $wgUser->getSkin();
1205 if ( isset( $this->mRedirectedFrom
) ) {
1206 // This is an internally redirected page view.
1207 // We'll need a backlink to the source page for navigation.
1208 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1210 $this->mRedirectedFrom
,
1213 array( 'redirect' => 'no' ),
1214 array( 'known', 'noclasses' )
1217 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1218 $wgOut->setSubtitle( $s );
1220 // Set the fragment if one was specified in the redirect
1221 if ( strval( $this->mTitle
->getFragment() ) != '' ) {
1222 $fragment = Xml
::escapeJsString( $this->mTitle
->getFragmentForURL() );
1223 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1226 // Add a <link rel="canonical"> tag
1227 $wgOut->addLink( array( 'rel' => 'canonical',
1228 'href' => $this->mTitle
->getLocalURL() )
1233 } elseif ( $rdfrom ) {
1234 // This is an externally redirected view, from some other wiki.
1235 // If it was reported from a trusted site, supply a backlink.
1236 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1237 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1238 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1239 $wgOut->setSubtitle( $s );
1249 * Show a header specific to the namespace currently being viewed, like
1250 * [[MediaWiki:Talkpagetext]]. For Article::view().
1252 public function showNamespaceHeader() {
1255 if ( $this->mTitle
->isTalkPage() ) {
1256 $msg = wfMsgNoTrans( 'talkpageheader' );
1257 if ( $msg !== '-' && !wfEmptyMsg( 'talkpageheader', $msg ) ) {
1258 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1264 * Show the footer section of an ordinary page view
1266 public function showViewFooter() {
1267 global $wgOut, $wgUseTrackbacks, $wgRequest;
1269 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1270 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->mTitle
->getText() ) ) {
1271 $wgOut->addWikiMsg( 'anontalkpagetext' );
1274 # If we have been passed an &rcid= parameter, we want to give the user a
1275 # chance to mark this new article as patrolled.
1276 $this->showPatrolFooter();
1279 if ( $wgUseTrackbacks ) {
1280 $this->addTrackbacks();
1285 * If patrol is possible, output a patrol UI box. This is called from the
1286 * footer section of ordinary page views. If patrol is not possible or not
1287 * desired, does nothing.
1289 public function showPatrolFooter() {
1290 global $wgOut, $wgRequest, $wgUser;
1292 $rcid = $wgRequest->getVal( 'rcid' );
1294 if ( !$rcid ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1298 $sk = $wgUser->getSkin();
1301 "<div class='patrollink'>" .
1303 'markaspatrolledlink',
1306 wfMsgHtml( 'markaspatrolledtext' ),
1309 'action' => 'markpatrolled',
1312 array( 'known', 'noclasses' )
1320 * Show the error text for a missing article. For articles in the MediaWiki
1321 * namespace, show the default message text. To be called from Article::view().
1323 public function showMissingArticle() {
1324 global $wgOut, $wgRequest, $wgUser;
1326 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1327 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1328 $parts = explode( '/', $this->mTitle
->getText() );
1329 $rootPart = $parts[0];
1330 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1331 $ip = User
::isIP( $rootPart );
1333 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1334 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1335 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1336 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1337 LogEventsList
::showLogExtract(
1340 $user->getUserPage()->getPrefixedText(),
1344 'showIfEmpty' => false,
1346 'blocked-notice-logextract',
1347 $user->getName() # Support GENDER in notice
1354 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1356 # Show delete and move logs
1357 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1359 'conds' => array( "log_action != 'revision'" ),
1360 'showIfEmpty' => false,
1361 'msgKey' => array( 'moveddeleted-notice' ) )
1364 # Show error message
1365 $oldid = $this->getOldID();
1367 $text = wfMsgNoTrans( 'missing-article',
1368 $this->mTitle
->getPrefixedText(),
1369 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1370 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1371 // Use the default message text
1372 $text = $this->getContent();
1374 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1375 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1376 $errors = array_merge( $createErrors, $editErrors );
1378 if ( !count( $errors ) ) {
1379 $text = wfMsgNoTrans( 'noarticletext' );
1381 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1384 $text = "<div class='noarticletext'>\n$text\n</div>";
1386 if ( !$this->hasViewableContent() ) {
1387 // If there's no backing content, send a 404 Not Found
1388 // for better machine handling of broken links.
1389 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1392 $wgOut->addWikiText( $text );
1396 * If the revision requested for view is deleted, check permissions.
1397 * Send either an error message or a warning header to $wgOut.
1399 * @return boolean true if the view is allowed, false if not.
1401 public function showDeletedRevisionHeader() {
1402 global $wgOut, $wgRequest;
1404 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1409 // If the user is not allowed to see it...
1410 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
1411 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1412 'rev-deleted-text-permission' );
1415 // If the user needs to confirm that they want to see it...
1416 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1417 # Give explanation and add a link to view the revision...
1418 $oldid = intval( $this->getOldID() );
1419 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1420 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1421 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1422 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1423 array( $msg, $link ) );
1426 // We are allowed to see...
1428 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1429 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1430 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1437 * Should the parser cache be used?
1441 public function useParserCache( $oldid ) {
1442 global $wgUser, $wgEnableParserCache;
1444 return $wgEnableParserCache
1445 && intval( $wgUser->getOption( 'stubthreshold' ) ) == 0
1448 && !$this->mTitle
->isCssOrJsPage()
1449 && !$this->mTitle
->isCssJsSubpage();
1453 * Execute the uncached parse for action=view
1455 public function doViewParse() {
1458 $oldid = $this->getOldID();
1459 $useParserCache = $this->useParserCache( $oldid );
1460 $parserOptions = clone $this->getParserOptions();
1462 # Render printable version, use printable version cache
1463 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1465 # Don't show section-edit links on old revisions... this way lies madness.
1466 $parserOptions->setEditSection( $this->isCurrent() );
1467 $useParserCache = $this->useParserCache( $oldid );
1468 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1472 * Try to fetch an expired entry from the parser cache. If it is present,
1473 * output it and return true. If it is not present, output nothing and
1474 * return false. This is used as a callback function for
1475 * PoolCounter::executeProtected().
1479 public function tryDirtyCache() {
1482 $parserCache = ParserCache
::singleton();
1483 $options = $this->getParserOptions();
1484 $options->setIsPrintable( $wgOut->isPrintable() );
1485 $output = $parserCache->getDirty( $this, $options );
1488 wfDebug( __METHOD__
. ": sending dirty output\n" );
1489 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1490 $wgOut->setSquidMaxage( 0 );
1491 $this->mParserOutput
= $output;
1492 $wgOut->addParserOutput( $output );
1493 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1497 wfDebugLog( 'dirty', "dirty missing\n" );
1498 wfDebug( __METHOD__
. ": no dirty cache\n" );
1505 * Show an error page for an error from the pool counter.
1506 * @param $status Status
1508 public function showPoolError( $status ) {
1511 $wgOut->clearHTML(); // for release() errors
1512 $wgOut->enableClientCache( false );
1513 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1514 $wgOut->addWikiText(
1515 '<div class="errorbox">' .
1516 $status->getWikiText( false, 'view-pool-error' ) .
1524 * @param $target Title object or Array of destination(s) to redirect
1525 * @param $appendSubtitle Boolean [optional]
1526 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1527 * @return string containing HMTL with redirect link
1529 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1530 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1532 if ( !is_array( $target ) ) {
1533 $target = array( $target );
1536 $imageDir = $wgContLang->getDir();
1538 if ( $appendSubtitle ) {
1539 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1542 $sk = $wgUser->getSkin();
1543 // the loop prepends the arrow image before the link, so the first case needs to be outside
1544 $title = array_shift( $target );
1546 if ( $forceKnown ) {
1547 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1549 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1552 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1553 $alt = $wgContLang->isRTL() ?
'←' : '→';
1554 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1555 // FIXME: where this happens?
1556 foreach ( $target as $rt ) {
1557 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1558 if ( $forceKnown ) {
1559 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1561 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1565 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1566 return Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1567 '<span class="redirectText">' . $link . '</span>';
1571 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1573 public function addTrackbacks() {
1574 global $wgOut, $wgUser;
1576 $dbr = wfGetDB( DB_SLAVE
);
1577 $tbs = $dbr->select( 'trackbacks',
1578 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1579 array( 'tb_page' => $this->getID() )
1582 if ( !$dbr->numRows( $tbs ) ) {
1587 while ( $o = $dbr->fetchObject( $tbs ) ) {
1590 if ( $wgUser->isAllowed( 'trackback' ) ) {
1591 $delurl = $this->mTitle
->getFullURL( "action=deletetrackback&tbid=" .
1592 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1593 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1597 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1605 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1609 * Removes trackback record for current article from trackbacks table
1611 public function deletetrackback() {
1612 global $wgUser, $wgRequest, $wgOut;
1614 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1615 $wgOut->addWikiMsg( 'sessionfailure' );
1620 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1622 if ( count( $permission_errors ) ) {
1623 $wgOut->showPermissionsErrorPage( $permission_errors );
1628 $db = wfGetDB( DB_MASTER
);
1629 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1631 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1632 $this->mTitle
->invalidateCache();
1636 * Handle action=render
1639 public function render() {
1642 $wgOut->setArticleBodyOnly( true );
1647 * Handle action=purge
1649 public function purge() {
1650 global $wgUser, $wgRequest, $wgOut;
1652 if ( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1653 //FIXME: shouldn't this be in doPurge()?
1654 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1659 $formParams = array(
1661 'action' => $wgRequest->getRequestURL(),
1664 $wgOut->addWikiMsg( 'confirm-purge-top' );
1666 $form = Html
::openElement( 'form', $formParams );
1667 $form .= Xml
::submitButton( wfMsg( 'confirm_purge_button' ) );
1668 $form .= Html
::closeElement( 'form' );
1670 $wgOut->addHTML( $form );
1671 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1673 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1674 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1679 * Perform the actions of a page purging
1681 public function doPurge() {
1684 // Invalidate the cache
1685 $this->mTitle
->invalidateCache();
1687 if ( $wgUseSquid ) {
1688 // Commit the transaction before the purge is sent
1689 $dbw = wfGetDB( DB_MASTER
);
1693 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1694 $update->doUpdate();
1697 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1698 global $wgMessageCache;
1700 if ( $this->getID() == 0 ) {
1703 $text = $this->getRawText();
1706 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1711 * Insert a new empty page record for this article.
1712 * This *must* be followed up by creating a revision
1713 * and running $this->updateRevisionOn( ... );
1714 * or else the record will be left in a funky state.
1715 * Best if all done inside a transaction.
1717 * @param $dbw Database
1718 * @return int The newly created page_id key, or false if the title already existed
1721 public function insertOn( $dbw ) {
1722 wfProfileIn( __METHOD__
);
1724 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1725 $dbw->insert( 'page', array(
1726 'page_id' => $page_id,
1727 'page_namespace' => $this->mTitle
->getNamespace(),
1728 'page_title' => $this->mTitle
->getDBkey(),
1729 'page_counter' => 0,
1730 'page_restrictions' => '',
1731 'page_is_redirect' => 0, # Will set this shortly...
1733 'page_random' => wfRandom(),
1734 'page_touched' => $dbw->timestamp(),
1735 'page_latest' => 0, # Fill this in shortly...
1736 'page_len' => 0, # Fill this in shortly...
1737 ), __METHOD__
, 'IGNORE' );
1739 $affected = $dbw->affectedRows();
1742 $newid = $dbw->insertId();
1743 $this->mTitle
->resetArticleId( $newid );
1745 wfProfileOut( __METHOD__
);
1747 return $affected ?
$newid : false;
1751 * Update the page record to point to a newly saved revision.
1753 * @param $dbw Database object
1754 * @param $revision Revision: For ID number, and text used to set
1755 length and redirect status fields
1756 * @param $lastRevision Integer: if given, will not overwrite the page field
1757 * when different from the currently set value.
1758 * Giving 0 indicates the new page flag should be set
1760 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1761 * removing rows in redirect table.
1762 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1763 * Needed when $lastRevision has to be set to sth. !=0
1764 * @return bool true on success, false on failure
1767 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1768 wfProfileIn( __METHOD__
);
1770 $text = $revision->getText();
1771 $rt = Title
::newFromRedirect( $text );
1773 $conditions = array( 'page_id' => $this->getId() );
1775 if ( !is_null( $lastRevision ) ) {
1776 # An extra check against threads stepping on each other
1777 $conditions['page_latest'] = $lastRevision;
1780 if ( !$setNewFlag ) {
1781 $setNewFlag = ( $lastRevision === 0 );
1784 $dbw->update( 'page',
1786 'page_latest' => $revision->getId(),
1787 'page_touched' => $dbw->timestamp(),
1788 'page_is_new' => $setNewFlag,
1789 'page_is_redirect' => $rt !== null ?
1 : 0,
1790 'page_len' => strlen( $text ),
1795 $result = $dbw->affectedRows() != 0;
1797 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1800 wfProfileOut( __METHOD__
);
1805 * Add row to the redirect table if this is a redirect, remove otherwise.
1807 * @param $dbw Database
1808 * @param $redirectTitle a title object pointing to the redirect target,
1809 * or NULL if this is not a redirect
1810 * @param $lastRevIsRedirect If given, will optimize adding and
1811 * removing rows in redirect table.
1812 * @return bool true on success, false on failure
1815 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1816 // Always update redirects (target link might have changed)
1817 // Update/Insert if we don't know if the last revision was a redirect or not
1818 // Delete if changing from redirect to non-redirect
1819 $isRedirect = !is_null( $redirectTitle );
1821 if ( $isRedirect ||
is_null( $lastRevIsRedirect ) ||
$lastRevIsRedirect !== $isRedirect ) {
1822 wfProfileIn( __METHOD__
);
1823 if ( $isRedirect ) {
1824 // This title is a redirect, Add/Update row in the redirect table
1825 $set = array( /* SET */
1826 'rd_namespace' => $redirectTitle->getNamespace(),
1827 'rd_title' => $redirectTitle->getDBkey(),
1828 'rd_from' => $this->getId(),
1830 $dbw->replace( 'redirect', array( 'rd_from' ), $set, __METHOD__
);
1832 // This is not a redirect, remove row from redirect table
1833 $where = array( 'rd_from' => $this->getId() );
1834 $dbw->delete( 'redirect', $where, __METHOD__
);
1837 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1838 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1840 wfProfileOut( __METHOD__
);
1842 return ( $dbw->affectedRows() != 0 );
1849 * If the given revision is newer than the currently set page_latest,
1850 * update the page record. Otherwise, do nothing.
1852 * @param $dbw Database object
1853 * @param $revision Revision object
1856 public function updateIfNewerOn( &$dbw, $revision ) {
1857 wfProfileIn( __METHOD__
);
1859 $row = $dbw->selectRow(
1860 array( 'revision', 'page' ),
1861 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1863 'page_id' => $this->getId(),
1864 'page_latest=rev_id' ),
1868 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1869 wfProfileOut( __METHOD__
);
1872 $prev = $row->rev_id
;
1873 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1875 # No or missing previous revision; mark the page as new
1877 $lastRevIsRedirect = null;
1880 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1882 wfProfileOut( __METHOD__
);
1887 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1888 * @param $text String: new text of the section
1889 * @param $summary String: new section's subject, only if $section is 'new'
1890 * @param $edittime String: revision timestamp or null to use the current revision
1891 * @return string Complete article text, or null if error
1893 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1894 wfProfileIn( __METHOD__
);
1896 if ( strval( $section ) == '' ) {
1897 // Whole-page edit; let the whole text through
1899 if ( is_null( $edittime ) ) {
1900 $rev = Revision
::newFromTitle( $this->mTitle
);
1902 $dbw = wfGetDB( DB_MASTER
);
1903 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1907 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1908 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1912 $oldtext = $rev->getText();
1914 if ( $section == 'new' ) {
1915 # Inserting a new section
1916 $subject = $summary ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1917 $text = strlen( trim( $oldtext ) ) > 0
1918 ?
"{$oldtext}\n\n{$subject}{$text}"
1919 : "{$subject}{$text}";
1921 # Replacing an existing section; roll out the big guns
1924 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1928 wfProfileOut( __METHOD__
);
1933 * @deprecated use Article::doEdit()
1935 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1936 wfDeprecated( __METHOD__
);
1937 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1938 ( $isminor ? EDIT_MINOR
: 0 ) |
1939 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1940 ( $bot ? EDIT_FORCE_BOT
: 0 );
1942 $this->doEdit( $text, $summary, $flags, false, null, $watchthis, $comment, '', true );
1946 * @deprecated use Article::doEdit()
1948 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1949 wfDeprecated( __METHOD__
);
1950 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1951 ( $minor ? EDIT_MINOR
: 0 ) |
1952 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1954 $status = $this->doEdit( $text, $summary, $flags, false, null, $watchthis, false, $sectionanchor, true );
1956 if ( !$status->isOK() ) {
1964 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1966 * @return Int updated $flags
1968 function checkFlags( $flags ) {
1969 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1970 if ( $this->mTitle
->getArticleID() ) {
1971 $flags |
= EDIT_UPDATE
;
1983 * Change an existing article or create a new article. Updates RC and all necessary caches,
1984 * optionally via the deferred update array.
1986 * $wgUser must be set before calling this function.
1988 * @param $text String: new text
1989 * @param $summary String: edit summary
1990 * @param $flags Integer bitfield:
1992 * Article is known or assumed to be non-existent, create a new one
1994 * Article is known or assumed to be pre-existing, update it
1996 * Mark this edit minor, if the user is allowed to do so
1998 * Do not log the change in recentchanges
2000 * Mark the edit a "bot" edit regardless of user rights
2001 * EDIT_DEFER_UPDATES
2002 * Defer some of the updates until the end of index.php
2004 * Fill in blank summaries with generated text where possible
2006 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2007 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2008 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2009 * edit-already-exists error will be returned. These two conditions are also possible with
2010 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2012 * @param $baseRevId the revision ID this edit was based off, if any
2013 * @param $user Optional user object, $wgUser will be used if not passed
2014 * @param $watchthis Watch the page if true, unwatch the page if false, do nothing if null
2015 * @param $comment Boolean: whether the edit is a new section
2016 * @param $sectionanchor The section anchor for the page; used for redirecting the user back to the page
2017 * after the edit is successfully committed
2018 * @param $redirect If true, redirect the user back to the page after the edit is successfully committed
2020 * @return Status object. Possible errors:
2021 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2022 * edit-gone-missing: In update mode, but the article didn't exist
2023 * edit-conflict: In update mode, the article changed unexpectedly
2024 * edit-no-change: Warning that the text was the same as before
2025 * edit-already-exists: In creation mode, but the article already exists
2027 * Extensions may define additional errors.
2029 * $return->value will contain an associative array with members as follows:
2030 * new: Boolean indicating if the function attempted to create a new article
2031 * revision: The revision object for the inserted revision, or null
2033 * Compatibility note: this function previously returned a boolean value indicating success/failure
2035 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null , $watchthis = null,
2036 $comment = false, $sectionanchor = '', $redirect = false) {
2037 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2039 # Low-level sanity check
2040 if ( $this->mTitle
->getText() === '' ) {
2041 throw new MWException( 'Something is trying to edit an article with an empty title' );
2044 wfProfileIn( __METHOD__
);
2046 $user = is_null( $user ) ?
$wgUser : $user;
2047 $status = Status
::newGood( array() );
2049 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2050 $this->loadPageData();
2052 $flags = $this->checkFlags( $flags );
2054 # If this is a comment, add the summary as headline
2055 if ( $comment && $summary != "" ) {
2056 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
2059 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2060 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, &$status) ) )
2062 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
2063 wfProfileOut( __METHOD__
);
2065 if ( $status->isOK() ) {
2066 $status->fatal( 'edit-hook-aborted' );
2072 # Silently ignore EDIT_MINOR if not allowed
2073 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
2074 $bot = $flags & EDIT_FORCE_BOT
;
2076 $oldtext = $this->getRawText(); // current revision
2077 $oldsize = strlen( $oldtext );
2079 # Provide autosummaries if one is not provided and autosummaries are enabled.
2080 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
2081 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2084 $editInfo = $this->prepareTextForEdit( $text );
2085 $text = $editInfo->pst
;
2086 $newsize = strlen( $text );
2088 $dbw = wfGetDB( DB_MASTER
);
2089 $now = wfTimestampNow();
2090 $this->mTimestamp
= $now;
2092 if ( $flags & EDIT_UPDATE
) {
2093 # Update article, but only if changed.
2094 $status->value
['new'] = false;
2096 # Make sure the revision is either completely inserted or not inserted at all
2097 if ( !$wgDBtransactions ) {
2098 $userAbort = ignore_user_abort( true );
2103 $changed = ( strcmp( $text, $oldtext ) != 0 );
2106 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
2107 - (int)$this->isCountable( $oldtext );
2108 $this->mTotalAdjustment
= 0;
2110 if ( !$this->mLatest
) {
2111 # Article gone missing
2112 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
2113 $status->fatal( 'edit-gone-missing' );
2115 wfProfileOut( __METHOD__
);
2119 $revision = new Revision( array(
2120 'page' => $this->getId(),
2121 'comment' => $summary,
2122 'minor_edit' => $isminor,
2124 'parent_id' => $this->mLatest
,
2125 'user' => $user->getId(),
2126 'user_text' => $user->getName(),
2130 $revisionId = $revision->insertOn( $dbw );
2134 # Note that we use $this->mLatest instead of fetching a value from the master DB
2135 # during the course of this function. This makes sure that EditPage can detect
2136 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2137 # before this function is called. A previous function used a separate query, this
2138 # creates a window where concurrent edits can cause an ignored edit conflict.
2139 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
2142 /* Belated edit conflict! Run away!! */
2143 $status->fatal( 'edit-conflict' );
2145 # Delete the invalid revision if the DB is not transactional
2146 if ( !$wgDBtransactions ) {
2147 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
2153 global $wgUseRCPatrol;
2154 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2155 # Update recentchanges
2156 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2157 # Mark as patrolled if the user can do so
2158 $patrolled = $wgUseRCPatrol && $this->mTitle
->userCan( 'autopatrol' );
2159 # Add RC row to the DB
2160 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
2161 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2162 $revisionId, $patrolled
2165 # Log auto-patrolled edits
2167 PatrolLog
::record( $rc, true );
2170 $user->incEditCount();
2174 $status->warning( 'edit-no-change' );
2176 // Keep the same revision ID, but do some updates on it
2177 $revisionId = $this->getRevIdFetched();
2178 // Update page_touched, this is usually implicit in the page update
2179 // Other cache updates are done in onArticleEdit()
2180 $this->mTitle
->invalidateCache();
2183 if ( !$wgDBtransactions ) {
2184 ignore_user_abort( $userAbort );
2187 // Now that ignore_user_abort is restored, we can respond to fatal errors
2188 if ( !$status->isOK() ) {
2189 wfProfileOut( __METHOD__
);
2193 # Invalidate cache of this article and all pages using this article
2194 # as a template. Partly deferred.
2195 Article
::onArticleEdit( $this->mTitle
);
2196 # Update links tables, site stats, etc.
2197 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed );
2199 # Create new article
2200 $status->value
['new'] = true;
2202 # Set statistics members
2203 # We work out if it's countable after PST to avoid counter drift
2204 # when articles are created with {{subst:}}
2205 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2206 $this->mTotalAdjustment
= 1;
2210 # Add the page record; stake our claim on this title!
2211 # This will return false if the article already exists
2212 $newid = $this->insertOn( $dbw );
2214 if ( $newid === false ) {
2216 $status->fatal( 'edit-already-exists' );
2218 wfProfileOut( __METHOD__
);
2222 # Save the revision text...
2223 $revision = new Revision( array(
2225 'comment' => $summary,
2226 'minor_edit' => $isminor,
2228 'user' => $user->getId(),
2229 'user_text' => $user->getName(),
2231 $revisionId = $revision->insertOn( $dbw );
2233 $this->mTitle
->resetArticleID( $newid );
2235 # Update the page record with revision data
2236 $this->updateRevisionOn( $dbw, $revision, 0 );
2238 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2240 # Update recentchanges
2241 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2242 global $wgUseRCPatrol, $wgUseNPPatrol;
2244 # Mark as patrolled if the user can do so
2245 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && $this->mTitle
->userCan( 'autopatrol' );
2246 # Add RC row to the DB
2247 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2248 '', strlen( $text ), $revisionId, $patrolled );
2250 # Log auto-patrolled edits
2252 PatrolLog
::record( $rc, true );
2255 $user->incEditCount();
2258 # Update links, etc.
2259 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true );
2262 Article
::onArticleCreate( $this->mTitle
);
2264 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2265 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, $revision ) );
2268 # Do updates right now unless deferral was requested
2269 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
2273 // Return the new revision (or null) to the caller
2274 $status->value
['revision'] = $revision;
2276 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2277 $flags & EDIT_MINOR
, &$watchthis, null, &$flags, $revision, &$status, $baseRevId,
2280 # Watch or unwatch the page
2281 if ( $watchthis === true ) {
2282 if ( !$this->mTitle
->userIsWatching() ) {
2287 } elseif ( $watchthis === false ) {
2288 if ( $this->mTitle
->userIsWatching() ) {
2295 # Give extensions a chance to modify URL query on update
2298 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
2301 if ( $sectionanchor ||
$extraQuery ) {
2302 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
2304 $this->doRedirect( $this->isRedirect( $text ) );
2308 wfProfileOut( __METHOD__
);
2314 * @deprecated wrapper for doRedirect
2316 public function showArticle( $text, $subtitle , $sectionanchor = '', $me2, $now, $summary, $oldid ) {
2317 wfDeprecated( __METHOD__
);
2318 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor );
2322 * Output a redirect back to the article.
2323 * This is typically used after an edit.
2325 * @param $noRedir Boolean: add redirect=no
2326 * @param $sectionAnchor String: section to redirect to, including "#"
2327 * @param $extraQuery String: extra query params
2329 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2333 $query = 'redirect=no';
2335 $query .= "&$extraQuery";
2337 $query = $extraQuery;
2340 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2344 * Mark this particular edit/page as patrolled
2346 public function markpatrolled() {
2347 global $wgOut, $wgRequest, $wgUseRCPatrol, $wgUseNPPatrol, $wgUser;
2349 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2351 # If we haven't been given an rc_id value, we can't do anything
2352 $rcid = (int) $wgRequest->getVal( 'rcid' );
2353 $rc = RecentChange
::newFromId( $rcid );
2355 if ( is_null( $rc ) ) {
2356 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2360 # It would be nice to see where the user had actually come from, but for now just guess
2361 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2362 $return = SpecialPage
::getTitleFor( $returnto );
2364 $dbw = wfGetDB( DB_MASTER
);
2365 $errors = $rc->doMarkPatrolled();
2367 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2368 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2373 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2374 // The hook itself has handled any output
2378 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2379 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2380 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2381 $wgOut->returnToMain( false, $return );
2386 if ( !empty( $errors ) ) {
2387 $wgOut->showPermissionsErrorPage( $errors );
2393 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2394 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2395 $wgOut->returnToMain( false, $return );
2399 * User-interface handler for the "watch" action
2401 public function watch() {
2402 global $wgUser, $wgOut;
2404 if ( $wgUser->isAnon() ) {
2405 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2409 if ( wfReadOnly() ) {
2410 $wgOut->readOnlyPage();
2414 if ( $this->doWatch() ) {
2415 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2416 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2417 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2420 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2424 * Add this page to $wgUser's watchlist
2425 * @return bool true on successful watch operation
2427 public function doWatch() {
2430 if ( $wgUser->isAnon() ) {
2434 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2435 $wgUser->addWatch( $this->mTitle
);
2436 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2443 * User interface handler for the "unwatch" action.
2445 public function unwatch() {
2446 global $wgUser, $wgOut;
2448 if ( $wgUser->isAnon() ) {
2449 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2453 if ( wfReadOnly() ) {
2454 $wgOut->readOnlyPage();
2458 if ( $this->doUnwatch() ) {
2459 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2460 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2461 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2464 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2468 * Stop watching a page
2469 * @return bool true on successful unwatch
2471 public function doUnwatch() {
2474 if ( $wgUser->isAnon() ) {
2478 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2479 $wgUser->removeWatch( $this->mTitle
);
2480 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2487 * action=protect handler
2489 public function protect() {
2490 $form = new ProtectionForm( $this );
2495 * action=unprotect handler (alias)
2497 public function unprotect() {
2502 * Update the article's restriction field, and leave a log entry.
2504 * @param $limit Array: set of restriction keys
2505 * @param $reason String
2506 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2507 * @param $expiry Array: per restriction type expiration
2508 * @return bool true on success
2510 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2511 global $wgUser, $wgContLang;
2513 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2515 $id = $this->mTitle
->getArticleID();
2518 wfDebug( "updateRestrictions failed: $id <= 0\n" );
2522 if ( wfReadOnly() ) {
2523 wfDebug( "updateRestrictions failed: read-only\n" );
2527 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2528 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2536 // Take this opportunity to purge out expired restrictions
2537 Title
::purgeExpiredRestrictions();
2539 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2540 # we expect a single selection, but the schema allows otherwise.
2542 $updated = Article
::flattenRestrictions( $limit );
2545 foreach ( $restrictionTypes as $action ) {
2546 if ( isset( $expiry[$action] ) ) {
2547 # Get current restrictions on $action
2548 $aLimits = $this->mTitle
->getRestrictions( $action );
2549 $current[$action] = implode( '', $aLimits );
2550 # Are any actual restrictions being dealt with here?
2551 $aRChanged = count( $aLimits ) ||
!empty( $limit[$action] );
2553 # If something changed, we need to log it. Checking $aRChanged
2554 # assures that "unprotecting" a page that is not protected does
2555 # not log just because the expiry was "changed".
2556 if ( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2562 $current = Article
::flattenRestrictions( $current );
2564 $changed = ( $changed ||
$current != $updated );
2565 $changed = $changed ||
( $updated && $this->mTitle
->areRestrictionsCascading() != $cascade );
2566 $protect = ( $updated != '' );
2568 # If nothing's changed, do nothing
2570 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2571 $dbw = wfGetDB( DB_MASTER
);
2573 # Prepare a null revision to be added to the history
2574 $modified = $current != '' && $protect;
2577 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2579 $comment_type = 'unprotectedarticle';
2582 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2584 # Only restrictions with the 'protect' right can cascade...
2585 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2586 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2588 # The schema allows multiple restrictions
2589 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2593 $cascade_description = '';
2596 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2600 $comment .= ": $reason";
2603 $editComment = $comment;
2604 $encodedExpiry = array();
2605 $protect_description = '';
2606 foreach ( $limit as $action => $restrictions ) {
2607 if ( !isset( $expiry[$action] ) )
2608 $expiry[$action] = 'infinite';
2610 $encodedExpiry[$action] = Block
::encodeExpiry( $expiry[$action], $dbw );
2611 if ( $restrictions != '' ) {
2612 $protect_description .= "[$action=$restrictions] (";
2613 if ( $encodedExpiry[$action] != 'infinity' ) {
2614 $protect_description .= wfMsgForContent( 'protect-expiring',
2615 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2616 $wgContLang->date( $expiry[$action], false, false ) ,
2617 $wgContLang->time( $expiry[$action], false, false ) );
2619 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2622 $protect_description .= ') ';
2625 $protect_description = trim( $protect_description );
2627 if ( $protect_description && $protect ) {
2628 $editComment .= " ($protect_description)";
2632 $editComment .= "$cascade_description";
2635 # Update restrictions table
2636 foreach ( $limit as $action => $restrictions ) {
2637 if ( $restrictions != '' ) {
2638 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2639 array( 'pr_page' => $id,
2640 'pr_type' => $action,
2641 'pr_level' => $restrictions,
2642 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2643 'pr_expiry' => $encodedExpiry[$action]
2648 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2649 'pr_type' => $action ), __METHOD__
);
2653 # Insert a null revision
2654 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2655 $nullRevId = $nullRevision->insertOn( $dbw );
2657 $latest = $this->getLatest();
2658 # Update page record
2659 $dbw->update( 'page',
2661 'page_touched' => $dbw->timestamp(),
2662 'page_restrictions' => '',
2663 'page_latest' => $nullRevId
2664 ), array( /* WHERE */
2666 ), 'Article::protect'
2669 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2670 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2672 # Update the protection log
2673 $log = new LogPage( 'protect' );
2675 $params = array( $protect_description, $cascade ?
'cascade' : '' );
2676 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason ), $params );
2678 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2681 } # End "changed" check
2687 * Take an array of page restrictions and flatten it to a string
2688 * suitable for insertion into the page_restrictions field.
2689 * @param $limit Array
2692 protected static function flattenRestrictions( $limit ) {
2693 if ( !is_array( $limit ) ) {
2694 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2700 foreach ( $limit as $action => $restrictions ) {
2701 if ( $restrictions != '' ) {
2702 $bits[] = "$action=$restrictions";
2706 return implode( ':', $bits );
2710 * Auto-generates a deletion reason
2712 * @param &$hasHistory Boolean: whether the page has a history
2713 * @return mixed String containing deletion reason or empty string, or boolean false
2714 * if no revision occurred
2716 public function generateReason( &$hasHistory ) {
2719 $dbw = wfGetDB( DB_MASTER
);
2720 // Get the last revision
2721 $rev = Revision
::newFromTitle( $this->mTitle
);
2723 if ( is_null( $rev ) ) {
2727 // Get the article's contents
2728 $contents = $rev->getText();
2731 // If the page is blank, use the text from the previous revision,
2732 // which can only be blank if there's a move/import/protect dummy revision involved
2733 if ( $contents == '' ) {
2734 $prev = $rev->getPrevious();
2737 $contents = $prev->getText();
2742 // Find out if there was only one contributor
2743 // Only scan the last 20 revisions
2744 $res = $dbw->select( 'revision', 'rev_user_text',
2745 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2747 array( 'LIMIT' => 20 )
2750 if ( $res === false ) {
2751 // This page has no revisions, which is very weird
2755 $hasHistory = ( $res->numRows() > 1 );
2756 $row = $dbw->fetchObject( $res );
2758 if ( $row ) { // $row is false if the only contributor is hidden
2759 $onlyAuthor = $row->rev_user_text
;
2760 // Try to find a second contributor
2761 foreach ( $res as $row ) {
2762 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2763 $onlyAuthor = false;
2768 $onlyAuthor = false;
2771 $dbw->freeResult( $res );
2773 // Generate the summary with a '$1' placeholder
2775 // The current revision is blank and the one before is also
2776 // blank. It's just not our lucky day
2777 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2779 if ( $onlyAuthor ) {
2780 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2782 $reason = wfMsgForContent( 'excontent', '$1' );
2786 if ( $reason == '-' ) {
2787 // Allow these UI messages to be blanked out cleanly
2791 // Replace newlines with spaces to prevent uglyness
2792 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2793 // Calculate the maximum amount of chars to get
2794 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2795 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2796 $contents = $wgContLang->truncate( $contents, $maxLength );
2797 // Remove possible unfinished links
2798 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2799 // Now replace the '$1' placeholder
2800 $reason = str_replace( '$1', $contents, $reason );
2807 * UI entry point for page deletion
2809 public function delete() {
2810 global $wgUser, $wgOut, $wgRequest;
2812 $confirm = $wgRequest->wasPosted() &&
2813 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2815 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2816 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2818 $reason = $this->DeleteReasonList
;
2820 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
2821 // Entry from drop down menu + additional comment
2822 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2823 } elseif ( $reason == 'other' ) {
2824 $reason = $this->DeleteReason
;
2827 # Flag to hide all contents of the archived revisions
2828 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2830 # This code desperately needs to be totally rewritten
2832 # Read-only check...
2833 if ( wfReadOnly() ) {
2834 $wgOut->readOnlyPage();
2840 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2842 if ( count( $permission_errors ) > 0 ) {
2843 $wgOut->showPermissionsErrorPage( $permission_errors );
2848 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2850 # Better double-check that it hasn't been deleted yet!
2851 $dbw = wfGetDB( DB_MASTER
);
2852 $conds = $this->mTitle
->pageCond();
2853 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2854 if ( $latest === false ) {
2855 $wgOut->showFatalError(
2858 array( 'class' => 'error mw-error-cannotdelete' ),
2859 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2862 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2863 LogEventsList
::showLogExtract(
2866 $this->mTitle
->getPrefixedText()
2872 # Hack for big sites
2873 $bigHistory = $this->isBigDeletion();
2874 if ( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2875 global $wgLang, $wgDeleteRevisionsLimit;
2877 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2878 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2884 $this->doDelete( $reason, $suppress );
2886 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2888 } elseif ( $this->mTitle
->userIsWatching() ) {
2895 // Generate deletion reason
2896 $hasHistory = false;
2898 $reason = $this->generateReason( $hasHistory );
2901 // If the page has a history, insert a warning
2902 if ( $hasHistory && !$confirm ) {
2905 $skin = $wgUser->getSkin();
2906 $revisions = $this->estimateRevisionCount();
2908 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2909 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2910 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2914 if ( $bigHistory ) {
2915 global $wgDeleteRevisionsLimit;
2917 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2918 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2922 return $this->confirmDelete( $reason );
2926 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2928 public function isBigDeletion() {
2929 global $wgDeleteRevisionsLimit;
2931 if ( $wgDeleteRevisionsLimit ) {
2932 $revCount = $this->estimateRevisionCount();
2934 return $revCount > $wgDeleteRevisionsLimit;
2941 * @return int approximate revision count
2943 public function estimateRevisionCount() {
2944 $dbr = wfGetDB( DB_SLAVE
);
2946 // For an exact count...
2947 // return $dbr->selectField( 'revision', 'COUNT(*)',
2948 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2949 return $dbr->estimateRowCount( 'revision', '*',
2950 array( 'rev_page' => $this->getId() ), __METHOD__
);
2954 * Get the last N authors
2955 * @param $num Integer: number of revisions to get
2956 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2957 * @return array Array of authors, duplicates not removed
2959 public function getLastNAuthors( $num, $revLatest = 0 ) {
2960 wfProfileIn( __METHOD__
);
2961 // First try the slave
2962 // If that doesn't have the latest revision, try the master
2964 $db = wfGetDB( DB_SLAVE
);
2967 $res = $db->select( array( 'page', 'revision' ),
2968 array( 'rev_id', 'rev_user_text' ),
2970 'page_namespace' => $this->mTitle
->getNamespace(),
2971 'page_title' => $this->mTitle
->getDBkey(),
2972 'rev_page = page_id'
2973 ), __METHOD__
, $this->getSelectOptions( array(
2974 'ORDER BY' => 'rev_timestamp DESC',
2980 wfProfileOut( __METHOD__
);
2984 $row = $db->fetchObject( $res );
2986 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
2987 $db = wfGetDB( DB_MASTER
);
2992 } while ( $continue );
2994 $authors = array( $row->rev_user_text
);
2996 while ( $row = $db->fetchObject( $res ) ) {
2997 $authors[] = $row->rev_user_text
;
3000 wfProfileOut( __METHOD__
);
3005 * Output deletion confirmation dialog
3006 * FIXME: Move to another file?
3007 * @param $reason String: prefilled reason
3009 public function confirmDelete( $reason ) {
3010 global $wgOut, $wgUser;
3012 wfDebug( "Article::confirmDelete\n" );
3014 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle
);
3015 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3016 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3017 $wgOut->addWikiMsg( 'confirmdeletetext' );
3019 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3021 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3022 $suppress = "<tr id=\"wpDeleteSuppressRow\" name=\"wpDeleteSuppressRow\">
3024 <td class='mw-input'><strong>" .
3025 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
3026 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3032 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
3034 $form = Xml
::openElement( 'form', array( 'method' => 'post',
3035 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3036 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3037 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3038 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3039 "<tr id=\"wpDeleteReasonListRow\">
3040 <td class='mw-label'>" .
3041 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3043 <td class='mw-input'>" .
3044 Xml
::listDropDown( 'wpDeleteReasonList',
3045 wfMsgForContent( 'deletereason-dropdown' ),
3046 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3049 <tr id=\"wpDeleteReasonRow\">
3050 <td class='mw-label'>" .
3051 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3053 <td class='mw-input'>" .
3054 Html
::input( 'wpReason', $reason, 'text', array(
3056 'maxlength' => '255',
3064 # Disallow watching if user is not logged in
3065 if ( $wgUser->isLoggedIn() ) {
3069 <td class='mw-input'>" .
3070 Xml
::checkLabel( wfMsg( 'watchthis' ),
3071 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3080 <td class='mw-submit'>" .
3081 Xml
::submitButton( wfMsg( 'deletepage' ),
3082 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3085 Xml
::closeElement( 'table' ) .
3086 Xml
::closeElement( 'fieldset' ) .
3087 Xml
::hidden( 'wpEditToken', $wgUser->editToken() ) .
3088 Xml
::closeElement( 'form' );
3090 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3091 $skin = $wgUser->getSkin();
3092 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
3093 $link = $skin->link(
3095 wfMsgHtml( 'delete-edit-reasonlist' ),
3097 array( 'action' => 'edit' )
3099 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3102 $wgOut->addHTML( $form );
3103 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3104 LogEventsList
::showLogExtract( $wgOut, 'delete',
3105 $this->mTitle
->getPrefixedText()
3110 * Perform a deletion and output success or failure messages
3112 public function doDelete( $reason, $suppress = false ) {
3113 global $wgOut, $wgUser;
3115 $id = $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
3118 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3119 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3120 $deleted = $this->mTitle
->getPrefixedText();
3122 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3123 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3125 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3127 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3128 $wgOut->returnToMain( false );
3129 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3132 if ( $error == '' ) {
3133 $wgOut->showFatalError(
3136 array( 'class' => 'error mw-error-cannotdelete' ),
3137 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
3141 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3143 LogEventsList
::showLogExtract(
3146 $this->mTitle
->getPrefixedText()
3149 $wgOut->showFatalError( $error );
3155 * Back-end article deletion
3156 * Deletes the article with database consistency, writes logs, purges caches
3158 * @param $reason string delete reason for deletion log
3159 * @param suppress bitfield
3160 * Revision::DELETED_TEXT
3161 * Revision::DELETED_COMMENT
3162 * Revision::DELETED_USER
3163 * Revision::DELETED_RESTRICTED
3164 * @param $id int article ID
3165 * @param $commit boolean defaults to true, triggers transaction end
3166 * @return boolean true if successful
3168 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3169 global $wgUseSquid, $wgDeferredUpdateList;
3170 global $wgUseTrackbacks;
3172 wfDebug( __METHOD__
. "\n" );
3174 $dbw = wfGetDB( DB_MASTER
);
3175 $ns = $this->mTitle
->getNamespace();
3176 $t = $this->mTitle
->getDBkey();
3177 $id = $id ?
$id : $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
3179 if ( $t === '' ||
$id == 0 ) {
3183 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3184 array_push( $wgDeferredUpdateList, $u );
3186 // Bitfields to further suppress the content
3189 // This should be 15...
3190 $bitfield |
= Revision
::DELETED_TEXT
;
3191 $bitfield |
= Revision
::DELETED_COMMENT
;
3192 $bitfield |
= Revision
::DELETED_USER
;
3193 $bitfield |
= Revision
::DELETED_RESTRICTED
;
3195 $bitfield = 'rev_deleted';
3199 // For now, shunt the revision data into the archive table.
3200 // Text is *not* removed from the text table; bulk storage
3201 // is left intact to avoid breaking block-compression or
3202 // immutable storage schemes.
3204 // For backwards compatibility, note that some older archive
3205 // table entries will have ar_text and ar_flags fields still.
3207 // In the future, we may keep revisions and mark them with
3208 // the rev_deleted field, which is reserved for this purpose.
3209 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3211 'ar_namespace' => 'page_namespace',
3212 'ar_title' => 'page_title',
3213 'ar_comment' => 'rev_comment',
3214 'ar_user' => 'rev_user',
3215 'ar_user_text' => 'rev_user_text',
3216 'ar_timestamp' => 'rev_timestamp',
3217 'ar_minor_edit' => 'rev_minor_edit',
3218 'ar_rev_id' => 'rev_id',
3219 'ar_text_id' => 'rev_text_id',
3220 'ar_text' => '\'\'', // Be explicit to appease
3221 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3222 'ar_len' => 'rev_len',
3223 'ar_page_id' => 'page_id',
3224 'ar_deleted' => $bitfield
3227 'page_id = rev_page'
3231 # Delete restrictions for it
3232 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
3234 # Now that it's safely backed up, delete it
3235 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
3236 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3243 # Fix category table counts
3245 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
3247 foreach ( $res as $row ) {
3248 $cats [] = $row->cl_to
;
3251 $this->updateCategoryCounts( array(), $cats );
3253 # If using cascading deletes, we can skip some explicit deletes
3254 if ( !$dbw->cascadingDeletes() ) {
3255 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
3257 if ( $wgUseTrackbacks )
3258 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
3260 # Delete outgoing links
3261 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3262 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3263 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3264 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3265 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3266 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3267 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3270 # If using cleanup triggers, we can skip some manual deletes
3271 if ( !$dbw->cleanupTriggers() ) {
3272 # Clean up recentchanges entries...
3273 $dbw->delete( 'recentchanges',
3274 array( 'rc_type != ' . RC_LOG
,
3275 'rc_namespace' => $this->mTitle
->getNamespace(),
3276 'rc_title' => $this->mTitle
->getDBkey() ),
3278 $dbw->delete( 'recentchanges',
3279 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
3284 Article
::onArticleDelete( $this->mTitle
);
3286 # Clear the cached article id so the interface doesn't act like we exist
3287 $this->mTitle
->resetArticleID( 0 );
3289 # Log the deletion, if the page was suppressed, log it at Oversight instead
3290 $logtype = $suppress ?
'suppress' : 'delete';
3291 $log = new LogPage( $logtype );
3293 # Make sure logging got through
3294 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
3304 * Roll back the most recent consecutive set of edits to a page
3305 * from the same user; fails if there are no eligible edits to
3306 * roll back to, e.g. user is the sole contributor. This function
3307 * performs permissions checks on $wgUser, then calls commitRollback()
3308 * to do the dirty work
3310 * @param $fromP String: Name of the user whose edits to rollback.
3311 * @param $summary String: Custom summary. Set to default summary if empty.
3312 * @param $token String: Rollback token.
3313 * @param $bot Boolean: If true, mark all reverted edits as bot.
3315 * @param $resultDetails Array: contains result-specific array of additional values
3316 * 'alreadyrolled' : 'current' (rev)
3317 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3319 * @return array of errors, each error formatted as
3320 * array(messagekey, param1, param2, ...).
3321 * On success, the array is empty. This array can also be passed to
3322 * OutputPage::showPermissionsErrorPage().
3324 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3327 $resultDetails = null;
3330 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
3331 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
3332 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3334 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
3335 $errors[] = array( 'sessionfailure' );
3338 if ( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3339 $errors[] = array( 'actionthrottledtext' );
3342 # If there were errors, bail out now
3343 if ( !empty( $errors ) ) {
3347 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3351 * Backend implementation of doRollback(), please refer there for parameter
3352 * and return value documentation
3354 * NOTE: This function does NOT check ANY permissions, it just commits the
3355 * rollback to the DB Therefore, you should only call this function direct-
3356 * ly if you want to use custom permissions checks. If you don't, use
3357 * doRollback() instead.
3359 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3360 global $wgUseRCPatrol, $wgUser, $wgLang;
3362 $dbw = wfGetDB( DB_MASTER
);
3364 if ( wfReadOnly() ) {
3365 return array( array( 'readonlytext' ) );
3368 # Get the last editor
3369 $current = Revision
::newFromTitle( $this->mTitle
);
3370 if ( is_null( $current ) ) {
3371 # Something wrong... no page?
3372 return array( array( 'notanarticle' ) );
3375 $from = str_replace( '_', ' ', $fromP );
3376 # User name given should match up with the top revision.
3377 # If the user was deleted then $from should be empty.
3378 if ( $from != $current->getUserText() ) {
3379 $resultDetails = array( 'current' => $current );
3380 return array( array( 'alreadyrolled',
3381 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3382 htmlspecialchars( $fromP ),
3383 htmlspecialchars( $current->getUserText() )
3387 # Get the last edit not by this guy...
3388 # Note: these may not be public values
3389 $user = intval( $current->getRawUser() );
3390 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3391 $s = $dbw->selectRow( 'revision',
3392 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3393 array( 'rev_page' => $current->getPage(),
3394 "rev_user != {$user} OR rev_user_text != {$user_text}"
3396 array( 'USE INDEX' => 'page_timestamp',
3397 'ORDER BY' => 'rev_timestamp DESC' )
3399 if ( $s === false ) {
3400 # No one else ever edited this page
3401 return array( array( 'cantrollback' ) );
3402 } else if ( $s->rev_deleted
& REVISION
::DELETED_TEXT ||
$s->rev_deleted
& REVISION
::DELETED_USER
) {
3403 # Only admins can see this text
3404 return array( array( 'notvisiblerev' ) );
3408 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3409 # Mark all reverted edits as bot
3413 if ( $wgUseRCPatrol ) {
3414 # Mark all reverted edits as patrolled
3415 $set['rc_patrolled'] = 1;
3418 if ( count( $set ) ) {
3419 $dbw->update( 'recentchanges', $set,
3421 'rc_cur_id' => $current->getPage(),
3422 'rc_user_text' => $current->getUserText(),
3423 "rc_timestamp > '{$s->rev_timestamp}'",
3428 # Generate the edit summary if necessary
3429 $target = Revision
::newFromId( $s->rev_id
);
3430 if ( empty( $summary ) ) {
3431 if ( $from == '' ) { // no public user name
3432 $summary = wfMsgForContent( 'revertpage-nouser' );
3434 $summary = wfMsgForContent( 'revertpage' );
3438 # Allow the custom summary to use the same args as the default message
3440 $target->getUserText(), $from, $s->rev_id
,
3441 $wgLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
), true ),
3442 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3444 $summary = wfMsgReplaceArgs( $summary, $args );
3447 $flags = EDIT_UPDATE
;
3449 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3450 $flags |
= EDIT_MINOR
;
3453 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) ||
$wgUser->isAllowed( 'bot' ) ) ) {
3454 $flags |
= EDIT_FORCE_BOT
;
3457 # Actually store the edit
3458 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3459 if ( !empty( $status->value
['revision'] ) ) {
3460 $revId = $status->value
['revision']->getId();
3465 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3467 $resultDetails = array(
3468 'summary' => $summary,
3469 'current' => $current,
3470 'target' => $target,
3478 * User interface for rollback operations
3480 public function rollback() {
3481 global $wgUser, $wgOut, $wgRequest, $wgUseRCPatrol;
3485 $result = $this->doRollback(
3486 $wgRequest->getVal( 'from' ),
3487 $wgRequest->getText( 'summary' ),
3488 $wgRequest->getVal( 'token' ),
3489 $wgRequest->getBool( 'bot' ),
3493 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3494 $wgOut->rateLimited();
3498 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3499 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3500 $errArray = $result[0];
3501 $errMsg = array_shift( $errArray );
3502 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3504 if ( isset( $details['current'] ) ) {
3505 $current = $details['current'];
3507 if ( $current->getComment() != '' ) {
3508 $wgOut->addWikiMsgArray( 'editcomment', array(
3509 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3516 # Display permissions errors before read-only message -- there's no
3517 # point in misleading the user into thinking the inability to rollback
3518 # is only temporary.
3519 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3520 # array_diff is completely broken for arrays of arrays, sigh.
3521 # Remove any 'readonlytext' error manually.
3523 foreach ( $result as $error ) {
3524 if ( $error != array( 'readonlytext' ) ) {
3528 $wgOut->showPermissionsErrorPage( $out );
3533 if ( $result == array( array( 'readonlytext' ) ) ) {
3534 $wgOut->readOnlyPage();
3539 $current = $details['current'];
3540 $target = $details['target'];
3541 $newId = $details['newid'];
3542 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3543 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3545 if ( $current->getUserText() === '' ) {
3546 $old = wfMsg( 'rev-deleted-user' );
3548 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3549 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3552 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3553 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3554 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3555 $wgOut->returnToMain( false, $this->mTitle
);
3557 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3558 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3559 $de->showDiff( '', '' );
3564 * Do standard deferred updates after page view
3566 public function viewUpdates() {
3567 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3568 if ( wfReadOnly() ) {
3572 # Don't update page view counters on views from bot users (bug 14044)
3573 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3574 Article
::incViewCount( $this->getID() );
3575 $u = new SiteStatsUpdate( 1, 0, 0 );
3576 array_push( $wgDeferredUpdateList, $u );
3579 # Update newtalk / watchlist notification status
3580 $wgUser->clearNotification( $this->mTitle
);
3584 * Prepare text which is about to be saved.
3585 * Returns a stdclass with source, pst and output members
3587 public function prepareTextForEdit( $text, $revid = null ) {
3588 if ( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid ) {
3590 return $this->mPreparedEdit
;
3595 $edit = (object)array();
3596 $edit->revid
= $revid;
3597 $edit->newText
= $text;
3598 $edit->pst
= $this->preSaveTransform( $text );
3599 $options = $this->getParserOptions();
3600 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $options, true, true, $revid );
3601 $edit->oldText
= $this->getContent();
3603 $this->mPreparedEdit
= $edit;
3609 * Do standard deferred updates after page edit.
3610 * Update links tables, site stats, search index and message cache.
3611 * Purges pages that include this page if the text was changed here.
3612 * Every 100th edit, prune the recent changes table.
3615 * @param $text New text of the article
3616 * @param $summary Edit summary
3617 * @param $minoredit Minor edit
3618 * @param $timestamp_of_pagechange Timestamp associated with the page change
3619 * @param $newid rev_id value of the new revision
3620 * @param $changed Whether or not the content actually changed
3622 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true ) {
3623 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3625 wfProfileIn( __METHOD__
);
3628 # Be careful not to double-PST: $text is usually already PST-ed once
3629 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3630 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3631 $editInfo = $this->prepareTextForEdit( $text, $newid );
3633 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3634 $editInfo = $this->mPreparedEdit
;
3637 # Save it to the parser cache
3638 if ( $wgEnableParserCache ) {
3639 $popts = $this->getParserOptions();
3640 $parserCache = ParserCache
::singleton();
3641 $parserCache->save( $editInfo->output
, $this, $popts );
3644 # Update the links tables
3645 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3648 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3650 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3651 if ( 0 == mt_rand( 0, 99 ) ) {
3652 // Flush old entries from the `recentchanges` table; we do this on
3653 // random requests so as to avoid an increase in writes for no good reason
3656 $dbw = wfGetDB( DB_MASTER
);
3657 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3658 $recentchanges = $dbw->tableName( 'recentchanges' );
3659 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3661 $dbw->query( $sql );
3665 $id = $this->getID();
3666 $title = $this->mTitle
->getPrefixedDBkey();
3667 $shortTitle = $this->mTitle
->getDBkey();
3670 wfProfileOut( __METHOD__
);
3674 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3675 array_push( $wgDeferredUpdateList, $u );
3676 $u = new SearchUpdate( $id, $title, $text );
3677 array_push( $wgDeferredUpdateList, $u );
3679 # If this is another user's talk page, update newtalk
3680 # Don't do this if $changed = false otherwise some idiot can null-edit a
3681 # load of user talk pages and piss people off, nor if it's a minor edit
3682 # by a properly-flagged bot.
3683 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3684 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3686 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3687 $other = User
::newFromName( $shortTitle, false );
3689 wfDebug( __METHOD__
. ": invalid username\n" );
3690 } elseif ( User
::isIP( $shortTitle ) ) {
3691 // An anonymous user
3692 $other->setNewtalk( true );
3693 } elseif ( $other->isLoggedIn() ) {
3694 $other->setNewtalk( true );
3696 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3701 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3702 $wgMessageCache->replace( $shortTitle, $text );
3705 wfProfileOut( __METHOD__
);
3709 * Perform article updates on a special page creation.
3711 * @param $rev Revision object
3713 * @todo This is a shitty interface function. Kill it and replace the
3714 * other shitty functions like editUpdates and such so it's not needed
3717 public function createUpdates( $rev ) {
3718 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3719 $this->mTotalAdjustment
= 1;
3720 $this->editUpdates( $rev->getText(), $rev->getComment(),
3721 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3725 * Generate the navigation links when browsing through an article revisions
3726 * It shows the information as:
3727 * Revision as of \<date\>; view current revision
3728 * \<- Previous version | Next Version -\>
3730 * @param $oldid String: revision ID of this article revision
3732 public function setOldSubtitle( $oldid = 0 ) {
3733 global $wgLang, $wgOut, $wgUser, $wgRequest;
3735 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3739 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3741 # Cascade unhide param in links for easy deletion browsing
3742 $extraParams = array();
3743 if ( $wgRequest->getVal( 'unhide' ) ) {
3744 $extraParams['unhide'] = 1;
3747 $revision = Revision
::newFromId( $oldid );
3749 $current = ( $oldid == $this->mLatest
);
3750 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3751 $tddate = $wgLang->date( $this->mTimestamp
, true );
3752 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3753 $sk = $wgUser->getSkin();
3755 ?
wfMsgHtml( 'currentrevisionlink' )
3758 wfMsgHtml( 'currentrevisionlink' ),
3761 array( 'known', 'noclasses' )
3764 ?
wfMsgHtml( 'diff' )
3767 wfMsgHtml( 'diff' ),
3773 array( 'known', 'noclasses' )
3775 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3779 wfMsgHtml( 'previousrevision' ),
3782 'direction' => 'prev',
3785 array( 'known', 'noclasses' )
3787 : wfMsgHtml( 'previousrevision' );
3791 wfMsgHtml( 'diff' ),
3797 array( 'known', 'noclasses' )
3799 : wfMsgHtml( 'diff' );
3800 $nextlink = $current
3801 ?
wfMsgHtml( 'nextrevision' )
3804 wfMsgHtml( 'nextrevision' ),
3807 'direction' => 'next',
3810 array( 'known', 'noclasses' )
3812 $nextdiff = $current
3813 ?
wfMsgHtml( 'diff' )
3816 wfMsgHtml( 'diff' ),
3822 array( 'known', 'noclasses' )
3827 // User can delete revisions or view deleted revisions...
3828 $canHide = $wgUser->isAllowed( 'deleterevision' );
3829 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3830 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3831 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3834 'type' => 'revision',
3835 'target' => $this->mTitle
->getPrefixedDbkey(),
3838 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
3843 # Show user links if allowed to see them. If hidden, then show them only if requested...
3844 $userlinks = $sk->revUserTools( $revision, !$unhide );
3846 $m = wfMsg( 'revision-info-current' );
3847 $infomsg = $current && !wfEmptyMsg( 'revision-info-current', $m ) && $m != '-'
3848 ?
'revision-info-current'
3851 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3854 array( 'parseinline', 'replaceafter' ),
3860 $revision->getUser()
3863 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3864 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3866 $wgOut->setSubtitle( $r );
3870 * This function is called right before saving the wikitext,
3871 * so we can do things like signatures and links-in-context.
3873 * @param $text String article contents
3874 * @return string article contents with altered wikitext markup (signatures
3875 * converted, {{subst:}}, templates, etc.)
3877 public function preSaveTransform( $text ) {
3878 global $wgParser, $wgUser;
3880 return $wgParser->preSaveTransform( $text, $this->mTitle
, $wgUser, ParserOptions
::newFromUser( $wgUser ) );
3883 /* Caching functions */
3886 * checkLastModified returns true if it has taken care of all
3887 * output to the client that is necessary for this request.
3888 * (that is, it has sent a cached version of the page)
3890 * @return boolean true if cached version send, false otherwise
3892 protected function tryFileCache() {
3893 static $called = false;
3896 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3901 if ( $this->isFileCacheable() ) {
3902 $cache = new HTMLFileCache( $this->mTitle
);
3903 if ( $cache->isFileCacheGood( $this->mTouched
) ) {
3904 wfDebug( "Article::tryFileCache(): about to load file\n" );
3905 $cache->loadFromFileCache();
3908 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3909 ob_start( array( &$cache, 'saveToFileCache' ) );
3912 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3919 * Check if the page can be cached
3922 public function isFileCacheable() {
3925 if ( HTMLFileCache
::useFileCache() ) {
3926 $cacheable = $this->getID() && !$this->mRedirectedFrom
;
3927 // Extension may have reason to disable file caching on some pages.
3929 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3937 * Loads page_touched and returns a value indicating if it should be used
3938 * @return boolean true if not a redirect
3940 public function checkTouched() {
3941 if ( !$this->mDataLoaded
) {
3942 $this->loadPageData();
3945 return !$this->mIsRedirect
;
3949 * Get the page_touched field
3950 * @return string containing GMT timestamp
3952 public function getTouched() {
3953 if ( !$this->mDataLoaded
) {
3954 $this->loadPageData();
3957 return $this->mTouched
;
3961 * Get the page_latest field
3962 * @return integer rev_id of current revision
3964 public function getLatest() {
3965 if ( !$this->mDataLoaded
) {
3966 $this->loadPageData();
3969 return (int)$this->mLatest
;
3973 * Edit an article without doing all that other stuff
3974 * The article must already exist; link tables etc
3975 * are not updated, caches are not flushed.
3977 * @param $text String: text submitted
3978 * @param $comment String: comment submitted
3979 * @param $minor Boolean: whereas it's a minor modification
3981 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3982 wfProfileIn( __METHOD__
);
3984 $dbw = wfGetDB( DB_MASTER
);
3985 $revision = new Revision( array(
3986 'page' => $this->getId(),
3988 'comment' => $comment,
3989 'minor_edit' => $minor ?
1 : 0,
3991 $revision->insertOn( $dbw );
3992 $this->updateRevisionOn( $dbw, $revision );
3994 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
3996 wfProfileOut( __METHOD__
);
4000 * Used to increment the view counter
4002 * @param $id Integer: article id
4004 public static function incViewCount( $id ) {
4005 $id = intval( $id );
4007 global $wgHitcounterUpdateFreq;
4009 $dbw = wfGetDB( DB_MASTER
);
4010 $pageTable = $dbw->tableName( 'page' );
4011 $hitcounterTable = $dbw->tableName( 'hitcounter' );
4012 $acchitsTable = $dbw->tableName( 'acchits' );
4013 $dbType = $dbw->getType();
4015 if ( $wgHitcounterUpdateFreq <= 1 ||
$dbType == 'sqlite' ) {
4016 $dbw->query( "UPDATE $pageTable SET page_counter = page_counter + 1 WHERE page_id = $id" );
4021 # Not important enough to warrant an error page in case of failure
4022 $oldignore = $dbw->ignoreErrors( true );
4024 $dbw->query( "INSERT INTO $hitcounterTable (hc_id) VALUES ({$id})" );
4026 $checkfreq = intval( $wgHitcounterUpdateFreq / 25 +
1 );
4027 if ( ( rand() %
$checkfreq != 0 ) or ( $dbw->lastErrno() != 0 ) ) {
4028 # Most of the time (or on SQL errors), skip row count check
4029 $dbw->ignoreErrors( $oldignore );
4034 $res = $dbw->query( "SELECT COUNT(*) as n FROM $hitcounterTable" );
4035 $row = $dbw->fetchObject( $res );
4036 $rown = intval( $row->n
);
4038 if ( $rown >= $wgHitcounterUpdateFreq ) {
4039 wfProfileIn( 'Article::incViewCount-collect' );
4040 $old_user_abort = ignore_user_abort( true );
4042 $dbw->lockTables( array(), array( 'hitcounter' ), __METHOD__
, false );
4043 $tabletype = $dbType == 'mysql' ?
"ENGINE=HEAP " : '';
4044 $dbw->query( "CREATE TEMPORARY TABLE $acchitsTable $tabletype AS " .
4045 "SELECT hc_id,COUNT(*) AS hc_n FROM $hitcounterTable " .
4046 'GROUP BY hc_id', __METHOD__
);
4047 $dbw->delete( 'hitcounter', '*', __METHOD__
);
4048 $dbw->unlockTables( __METHOD__
);
4050 if ( $dbType == 'mysql' ) {
4051 $dbw->query( "UPDATE $pageTable,$acchitsTable SET page_counter=page_counter + hc_n " .
4052 'WHERE page_id = hc_id', __METHOD__
);
4054 $dbw->query( "UPDATE $pageTable SET page_counter=page_counter + hc_n " .
4055 "FROM $acchitsTable WHERE page_id = hc_id", __METHOD__
);
4057 $dbw->query( "DROP TABLE $acchitsTable", __METHOD__
);
4059 ignore_user_abort( $old_user_abort );
4060 wfProfileOut( 'Article::incViewCount-collect' );
4063 $dbw->ignoreErrors( $oldignore );
4067 * The onArticle*() functions are supposed to be a kind of hooks
4068 * which should be called whenever any of the specified actions
4071 * This is a good place to put code to clear caches, for instance.
4073 * This is called on page move and undelete, as well as edit
4075 * @param $title a title object
4077 public static function onArticleCreate( $title ) {
4078 # Update existence markers on article/talk tabs...
4079 if ( $title->isTalkPage() ) {
4080 $other = $title->getSubjectPage();
4082 $other = $title->getTalkPage();
4085 $other->invalidateCache();
4086 $other->purgeSquid();
4088 $title->touchLinks();
4089 $title->purgeSquid();
4090 $title->deleteTitleProtection();
4094 * Clears caches when article is deleted
4096 public static function onArticleDelete( $title ) {
4097 global $wgMessageCache;
4099 # Update existence markers on article/talk tabs...
4100 if ( $title->isTalkPage() ) {
4101 $other = $title->getSubjectPage();
4103 $other = $title->getTalkPage();
4106 $other->invalidateCache();
4107 $other->purgeSquid();
4109 $title->touchLinks();
4110 $title->purgeSquid();
4113 HTMLFileCache
::clearFileCache( $title );
4116 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
4117 $wgMessageCache->replace( $title->getDBkey(), false );
4121 if ( $title->getNamespace() == NS_FILE
) {
4122 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4123 $update->doUpdate();
4127 if ( $title->getNamespace() == NS_USER_TALK
) {
4128 $user = User
::newFromName( $title->getText(), false );
4129 $user->setNewtalk( false );
4133 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4137 * Purge caches on page update etc
4139 * @param $title Title object
4140 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4142 public static function onArticleEdit( $title ) {
4143 global $wgDeferredUpdateList;
4145 // Invalidate caches of articles which include this page
4146 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4148 // Invalidate the caches of all pages which redirect here
4149 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4151 # Purge squid for this page only
4152 $title->purgeSquid();
4154 # Clear file cache for this page only
4155 HTMLFileCache
::clearFileCache( $title );
4161 * Overriden by ImagePage class, only present here to avoid a fatal error
4162 * Called for ?action=revert
4164 public function revert() {
4166 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4170 * Info about this page
4171 * Called for ?action=info when $wgAllowPageInfo is on.
4173 public function info() {
4174 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4176 if ( !$wgAllowPageInfo ) {
4177 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4181 $page = $this->mTitle
->getSubjectPage();
4183 $wgOut->setPagetitle( $page->getPrefixedText() );
4184 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4185 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4187 if ( !$this->mTitle
->exists() ) {
4188 $wgOut->addHTML( '<div class="noarticletext">' );
4189 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
4190 // This doesn't quite make sense; the user is asking for
4191 // information about the _page_, not the message... -- RC
4192 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
4194 $msg = $wgUser->isLoggedIn()
4196 : 'noarticletextanon';
4197 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4200 $wgOut->addHTML( '</div>' );
4202 $dbr = wfGetDB( DB_SLAVE
);
4204 'wl_title' => $page->getDBkey(),
4205 'wl_namespace' => $page->getNamespace() );
4206 $numwatchers = $dbr->selectField(
4211 $this->getSelectOptions() );
4213 $pageInfo = $this->pageCountInfo( $page );
4214 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4217 //FIXME: unescaped messages
4218 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4219 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4222 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4225 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4228 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4231 $wgOut->addHTML( '</ul>' );
4236 * Return the total number of edits and number of unique editors
4237 * on a given page. If page does not exist, returns false.
4239 * @param $title Title object
4240 * @return mixed array or boolean false
4242 public function pageCountInfo( $title ) {
4243 $id = $title->getArticleId();
4249 $dbr = wfGetDB( DB_SLAVE
);
4250 $rev_clause = array( 'rev_page' => $id );
4251 $edits = $dbr->selectField(
4256 $this->getSelectOptions()
4258 $authors = $dbr->selectField(
4260 'COUNT(DISTINCT rev_user_text)',
4263 $this->getSelectOptions()
4266 return array( 'edits' => $edits, 'authors' => $authors );
4270 * Return a list of templates used by this article.
4271 * Uses the templatelinks table
4273 * @return Array of Title objects
4275 public function getUsedTemplates() {
4277 $id = $this->mTitle
->getArticleID();
4283 $dbr = wfGetDB( DB_SLAVE
);
4284 $res = $dbr->select( array( 'templatelinks' ),
4285 array( 'tl_namespace', 'tl_title' ),
4286 array( 'tl_from' => $id ),
4289 if ( $res !== false ) {
4290 foreach ( $res as $row ) {
4291 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
4295 $dbr->freeResult( $res );
4301 * Returns a list of hidden categories this page is a member of.
4302 * Uses the page_props and categorylinks tables.
4304 * @return Array of Title objects
4306 public function getHiddenCategories() {
4308 $id = $this->mTitle
->getArticleID();
4314 $dbr = wfGetDB( DB_SLAVE
);
4315 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4317 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4318 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
4321 if ( $res !== false ) {
4322 foreach ( $res as $row ) {
4323 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
4327 $dbr->freeResult( $res );
4333 * Return an applicable autosummary if one exists for the given edit.
4334 * @param $oldtext String: the previous text of the page.
4335 * @param $newtext String: The submitted text of the page.
4336 * @param $flags Bitmask: a bitmask of flags submitted for the edit.
4337 * @return string An appropriate autosummary, or an empty string.
4339 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4340 # Decide what kind of autosummary is needed.
4342 # Redirect autosummaries
4343 $ot = Title
::newFromRedirect( $oldtext );
4344 $rt = Title
::newFromRedirect( $newtext );
4346 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
4347 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4350 # New page autosummaries
4351 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
4352 # If they're making a new article, give its text, truncated, in the summary.
4355 $truncatedtext = $wgContLang->truncate(
4356 str_replace( "\n", ' ', $newtext ),
4357 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4359 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4362 # Blanking autosummaries
4363 if ( $oldtext != '' && $newtext == '' ) {
4364 return wfMsgForContent( 'autosumm-blank' );
4365 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4366 # Removing more than 90% of the article
4369 $truncatedtext = $wgContLang->truncate(
4371 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4373 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4376 # If we reach this point, there's no applicable autosummary for our case, so our
4377 # autosummary is empty.
4382 * Add the primary page-view wikitext to the output buffer
4383 * Saves the text into the parser cache if possible.
4384 * Updates templatelinks if it is out of date.
4386 * @param $text String
4387 * @param $cache Boolean
4388 * @param $parserOptions mixed ParserOptions object, or boolean false
4390 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4393 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4394 $wgOut->addParserOutput( $this->mParserOutput
);
4398 * This does all the heavy lifting for outputWikitext, except it returns the parser
4399 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4400 * say, embedding thread pages within a discussion system (LiquidThreads)
4402 * @param $text string
4403 * @param $cache boolean
4404 * @param $parserOptions parsing options, defaults to false
4405 * @return string containing parsed output
4407 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4408 global $wgParser, $wgOut, $wgEnableParserCache, $wgUseFileCache;
4410 if ( !$parserOptions ) {
4411 $parserOptions = $this->getParserOptions();
4415 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
4416 $parserOptions, true, true, $this->getRevIdFetched() );
4421 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4422 $this->mTitle
->getPrefixedDBkey() ) );
4425 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
4426 $parserCache = ParserCache
::singleton();
4427 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4430 // Make sure file cache is not used on uncacheable content.
4431 // Output that has magic words in it can still use the parser cache
4432 // (if enabled), though it will generally expire sooner.
4433 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
4434 $wgUseFileCache = false;
4437 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4439 return $this->mParserOutput
;
4443 * Get parser options suitable for rendering the primary article wikitext
4444 * @return mixed ParserOptions object or boolean false
4446 public function getParserOptions() {
4449 if ( !$this->mParserOptions
) {
4450 $this->mParserOptions
= new ParserOptions( $wgUser );
4451 $this->mParserOptions
->setTidy( true );
4452 $this->mParserOptions
->enableLimitReport();
4455 return $this->mParserOptions
;
4459 * Updates cascading protections
4461 * @param $parserOutput mixed ParserOptions object, or boolean false
4464 protected function doCascadeProtectionUpdates( $parserOutput ) {
4465 if ( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4469 // templatelinks table may have become out of sync,
4470 // especially if using variable-based transclusions.
4471 // For paranoia, check if things have changed and if
4472 // so apply updates to the database. This will ensure
4473 // that cascaded protections apply as soon as the changes
4476 # Get templates from templatelinks
4477 $id = $this->mTitle
->getArticleID();
4479 $tlTemplates = array();
4481 $dbr = wfGetDB( DB_SLAVE
);
4482 $res = $dbr->select( array( 'templatelinks' ),
4483 array( 'tl_namespace', 'tl_title' ),
4484 array( 'tl_from' => $id ),
4490 foreach ( $res as $row ) {
4491 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4494 # Get templates from parser output.
4495 $poTemplates = array();
4496 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4497 foreach ( $templates as $dbk => $id ) {
4498 $poTemplates["$ns:$dbk"] = true;
4503 # Note that we simulate array_diff_key in PHP <5.0.x
4504 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4506 if ( count( $templates_diff ) > 0 ) {
4507 # Whee, link updates time.
4508 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4514 * Update all the appropriate counts in the category table, given that
4515 * we've added the categories $added and deleted the categories $deleted.
4517 * @param $added array The names of categories that were added
4518 * @param $deleted array The names of categories that were deleted
4520 public function updateCategoryCounts( $added, $deleted ) {
4521 $ns = $this->mTitle
->getNamespace();
4522 $dbw = wfGetDB( DB_MASTER
);
4524 # First make sure the rows exist. If one of the "deleted" ones didn't
4525 # exist, we might legitimately not create it, but it's simpler to just
4526 # create it and then give it a negative value, since the value is bogus
4529 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4530 $insertCats = array_merge( $added, $deleted );
4531 if ( !$insertCats ) {
4532 # Okay, nothing to do
4536 $insertRows = array();
4538 foreach ( $insertCats as $cat ) {
4539 $insertRows[] = array(
4540 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4544 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4546 $addFields = array( 'cat_pages = cat_pages + 1' );
4547 $removeFields = array( 'cat_pages = cat_pages - 1' );
4549 if ( $ns == NS_CATEGORY
) {
4550 $addFields[] = 'cat_subcats = cat_subcats + 1';
4551 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4552 } elseif ( $ns == NS_FILE
) {
4553 $addFields[] = 'cat_files = cat_files + 1';
4554 $removeFields[] = 'cat_files = cat_files - 1';
4561 array( 'cat_title' => $added ),
4570 array( 'cat_title' => $deleted ),
4577 * Lightweight method to get the parser output for a page, checking the parser cache
4578 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4579 * consider, so it's not appropriate to use there.
4581 * @param $oldid mixed integer Revision ID or null
4583 public function getParserOutput( $oldid = null ) {
4584 global $wgEnableParserCache, $wgUser, $wgOut;
4586 // Should the parser cache be used?
4587 $useParserCache = $wgEnableParserCache &&
4588 intval( $wgUser->getOption( 'stubthreshold' ) ) == 0 &&
4592 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4594 if ( $wgUser->getOption( 'stubthreshold' ) ) {
4595 wfIncrStats( 'pcache_miss_stub' );
4598 $parserOutput = false;
4599 if ( $useParserCache ) {
4600 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4603 if ( $parserOutput === false ) {
4604 // Cache miss; parse and output it.
4605 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4607 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4609 return $parserOutput;
4613 // Deprecated methods
4615 * Get the database which should be used for reads
4618 * @deprecated - just call wfGetDB( DB_MASTER ) instead
4621 wfDeprecated( __METHOD__
);
4622 return wfGetDB( DB_MASTER
);