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.
19 var $mComment = ''; //!<
21 var $mContentLoaded = false; //!<
22 var $mCounter = -1; //!< Not loaded
23 var $mCurID = -1; //!< Not loaded
24 var $mDataLoaded = false; //!<
25 var $mForUpdate = false; //!<
26 var $mGoodAdjustment = 0; //!<
27 var $mIsRedirect = false; //!<
28 var $mLatest = false; //!<
31 var $mPreparedEdit = false; //!< Title object if set
32 var $mRedirectedFrom = null; //!< Title object if set
33 var $mRedirectTarget = null; //!< Title object if set
34 var $mRedirectUrl = false; //!<
35 var $mRevIdFetched = 0; //!<
37 var $mTimestamp = ''; //!<
39 var $mTotalAdjustment = 0; //!<
40 var $mTouched = '19700101000000'; //!<
41 var $mUser = -1; //!< Not loaded
42 var $mUserText = ''; //!<
43 var $mParserOptions; //!<
44 var $mParserOutput; //!<
48 * Constructor and clear the article
49 * @param $title Reference to a Title object.
50 * @param $oldId Integer revision ID, null to fetch from request, zero for current
52 public function __construct( Title
$title, $oldId = null ) {
53 $this->mTitle
=& $title;
54 $this->mOldId
= $oldId;
58 * Constructor from an article article
59 * @param $id The article ID to load
61 public static function newFromID( $id ) {
62 $t = Title
::newFromID( $id );
63 return $t == null ?
null : new Article( $t );
67 * Tell the page view functions that this view was redirected
68 * from another page on the wiki.
69 * @param $from Title object.
71 public function setRedirectedFrom( $from ) {
72 $this->mRedirectedFrom
= $from;
76 * If this page is a redirect, get its target
78 * The target will be fetched from the redirect table if possible.
79 * If this page doesn't have an entry there, call insertRedirect()
80 * @return mixed Title object, or null if this page is not a redirect
82 public function getRedirectTarget() {
83 if( !$this->mTitle ||
!$this->mTitle
->isRedirect() )
85 if( !is_null($this->mRedirectTarget
) )
86 return $this->mRedirectTarget
;
87 # Query the redirect table
88 $dbr = wfGetDB( DB_SLAVE
);
89 $row = $dbr->selectRow( 'redirect',
90 array('rd_namespace', 'rd_title'),
91 array('rd_from' => $this->getID() ),
95 return $this->mRedirectTarget
= Title
::makeTitle($row->rd_namespace
, $row->rd_title
);
97 # This page doesn't have an entry in the redirect table
98 return $this->mRedirectTarget
= $this->insertRedirect();
102 * Insert an entry for this page into the redirect table.
104 * Don't call this function directly unless you know what you're doing.
105 * @return Title object
107 public function insertRedirect() {
108 $retval = Title
::newFromRedirect( $this->getContent() );
112 $dbw = wfGetDB( DB_MASTER
);
113 $dbw->replace( 'redirect', array('rd_from'),
115 'rd_from' => $this->getID(),
116 'rd_namespace' => $retval->getNamespace(),
117 'rd_title' => $retval->getDBkey()
125 * Get the Title object this page redirects to
127 * @return mixed false, Title of in-wiki target, or string with URL
129 public function followRedirect() {
130 $text = $this->getContent();
131 return $this->followRedirectText( $text );
135 * Get the Title object this text redirects to
137 * @return mixed false, Title of in-wiki target, or string with URL
139 public function followRedirectText( $text ) {
140 $rt = Title
::newFromRedirectRecurse( $text ); // recurse through to only get the final target
141 # process if title object is valid and not special:userlogout
143 if( $rt->getInterwiki() != '' ) {
144 if( $rt->isLocal() ) {
145 // Offsite wikis need an HTTP redirect.
147 // This can be hard to reverse and may produce loops,
148 // so they may be disabled in the site configuration.
149 $source = $this->mTitle
->getFullURL( 'redirect=no' );
150 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
153 if( $rt->getNamespace() == NS_SPECIAL
) {
154 // Gotta handle redirects to special pages differently:
155 // Fill the HTTP response "Location" header and ignore
156 // the rest of the page we're on.
158 // This can be hard to reverse, so they may be disabled.
159 if( $rt->isSpecial( 'Userlogout' ) ) {
162 return $rt->getFullURL();
168 // No or invalid redirect
173 * get the title object of the article
175 public function getTitle() {
176 return $this->mTitle
;
183 public function clear() {
184 $this->mDataLoaded
= false;
185 $this->mContentLoaded
= false;
187 $this->mCurID
= $this->mUser
= $this->mCounter
= -1; # Not loaded
188 $this->mRedirectedFrom
= null; # Title object if set
189 $this->mRedirectTarget
= null; # Title object if set
191 $this->mTimestamp
= $this->mComment
= '';
192 $this->mGoodAdjustment
= $this->mTotalAdjustment
= 0;
193 $this->mTouched
= '19700101000000';
194 $this->mForUpdate
= false;
195 $this->mIsRedirect
= false;
196 $this->mRevIdFetched
= 0;
197 $this->mRedirectUrl
= false;
198 $this->mLatest
= false;
199 $this->mPreparedEdit
= false;
203 * Note that getContent/loadContent do not follow redirects anymore.
204 * If you need to fetch redirectable content easily, try
205 * the shortcut in Article::followContent()
207 * @return Return the text of this revision
209 public function getContent() {
210 global $wgUser, $wgContLang, $wgOut, $wgMessageCache;
211 wfProfileIn( __METHOD__
);
212 if( $this->getID() === 0 ) {
213 # If this is a MediaWiki:x message, then load the messages
214 # and return the message value for x.
215 if( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
216 # If this is a system message, get the default text.
217 list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle
->getText() ) );
218 $wgMessageCache->loadAllMessages( $lang );
219 $text = wfMsgGetKey( $message, false, $lang, false );
220 if( wfEmptyMsg( $message, $text ) )
223 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
225 wfProfileOut( __METHOD__
);
228 $this->loadContent();
229 wfProfileOut( __METHOD__
);
230 return $this->mContent
;
235 * Get the text of the current revision. No side-effects...
237 * @return Return the text of the current revision
239 public function getRawText() {
240 // Check process cache for current revision
241 if( $this->mContentLoaded
&& $this->mOldId
== 0 ) {
242 return $this->mContent
;
244 $rev = Revision
::newFromTitle( $this->mTitle
);
245 $text = $rev ?
$rev->getRawText() : false;
250 * This function returns the text of a section, specified by a number ($section).
251 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
252 * the first section before any such heading (section 0).
254 * If a section contains subsections, these are also returned.
256 * @param $text String: text to look in
257 * @param $section Integer: section number
258 * @return string text of the requested section
261 public function getSection( $text, $section ) {
263 return $wgParser->getSection( $text, $section );
267 * Get the text that needs to be saved in order to undo all revisions
268 * between $undo and $undoafter. Revisions must belong to the same page,
269 * must exist and must not be deleted
270 * @param $undo Revision
271 * @param $undoafter Revision Must be an earlier revision than $undo
272 * @return mixed string on success, false on failure
274 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
275 $undo_text = $undo->getText();
276 $undoafter_text = $undoafter->getText();
277 $cur_text = $this->getContent();
278 if ( $cur_text == $undo_text ) {
279 # No use doing a merge if it's just a straight revert.
280 return $undoafter_text;
283 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) )
289 * @return int The oldid of the article that is to be shown, 0 for the
292 public function getOldID() {
293 if( is_null( $this->mOldId
) ) {
294 $this->mOldId
= $this->getOldIDFromRequest();
296 return $this->mOldId
;
300 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
302 * @return int The old id for the request
304 public function getOldIDFromRequest() {
306 $this->mRedirectUrl
= false;
307 $oldid = $wgRequest->getVal( 'oldid' );
308 if( isset( $oldid ) ) {
309 $oldid = intval( $oldid );
310 if( $wgRequest->getVal( 'direction' ) == 'next' ) {
311 $nextid = $this->mTitle
->getNextRevisionID( $oldid );
315 $this->mRedirectUrl
= $this->mTitle
->getFullURL( 'redirect=no' );
317 } elseif( $wgRequest->getVal( 'direction' ) == 'prev' ) {
318 $previd = $this->mTitle
->getPreviousRevisionID( $oldid );
331 * Load the revision (including text) into this object
333 function loadContent() {
334 if( $this->mContentLoaded
) return;
335 wfProfileIn( __METHOD__
);
337 $oldid = $this->getOldID();
338 # Pre-fill content with error message so that if something
339 # fails we'll have something telling us what we intended.
340 $this->mOldId
= $oldid;
341 $this->fetchContent( $oldid );
342 wfProfileOut( __METHOD__
);
347 * Fetch a page record with the given conditions
348 * @param $dbr Database object
349 * @param $conditions Array
351 protected function pageData( $dbr, $conditions ) {
365 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
366 $row = $dbr->selectRow(
372 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
377 * @param $dbr Database object
378 * @param $title Title object
380 public function pageDataFromTitle( $dbr, $title ) {
381 return $this->pageData( $dbr, array(
382 'page_namespace' => $title->getNamespace(),
383 'page_title' => $title->getDBkey() ) );
387 * @param $dbr Database
390 protected function pageDataFromId( $dbr, $id ) {
391 return $this->pageData( $dbr, array( 'page_id' => $id ) );
395 * Set the general counter, title etc data loaded from
398 * @param $data Database row object or "fromdb"
400 public function loadPageData( $data = 'fromdb' ) {
401 if( $data === 'fromdb' ) {
402 $dbr = wfGetDB( DB_MASTER
);
403 $data = $this->pageDataFromId( $dbr, $this->getId() );
406 $lc = LinkCache
::singleton();
408 $lc->addGoodLinkObj( $data->page_id
, $this->mTitle
, $data->page_len
, $data->page_is_redirect
);
410 $this->mTitle
->mArticleID
= intval( $data->page_id
);
412 # Old-fashioned restrictions
413 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
415 $this->mCounter
= intval( $data->page_counter
);
416 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
417 $this->mIsRedirect
= intval( $data->page_is_redirect
);
418 $this->mLatest
= intval( $data->page_latest
);
420 if( is_object( $this->mTitle
) ) {
421 $lc->addBadLinkObj( $this->mTitle
);
423 $this->mTitle
->mArticleID
= 0;
426 $this->mDataLoaded
= true;
430 * Get text of an article from database
431 * Does *NOT* follow redirects.
432 * @param $oldid Int: 0 for whatever the latest revision is
435 function fetchContent( $oldid = 0 ) {
436 if( $this->mContentLoaded
) {
437 return $this->mContent
;
440 $dbr = wfGetDB( DB_MASTER
);
442 # Pre-fill content with error message so that if something
443 # fails we'll have something telling us what we intended.
444 $t = $this->mTitle
->getPrefixedText();
445 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
446 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
449 $revision = Revision
::newFromId( $oldid );
450 if( is_null( $revision ) ) {
451 wfDebug( __METHOD__
." failed to retrieve specified revision, id $oldid\n" );
454 $data = $this->pageDataFromId( $dbr, $revision->getPage() );
456 wfDebug( __METHOD__
." failed to get page data linked to revision id $oldid\n" );
459 $this->mTitle
= Title
::makeTitle( $data->page_namespace
, $data->page_title
);
460 $this->loadPageData( $data );
462 if( !$this->mDataLoaded
) {
463 $data = $this->pageDataFromTitle( $dbr, $this->mTitle
);
465 wfDebug( __METHOD__
." failed to find page data for title " . $this->mTitle
->getPrefixedText() . "\n" );
468 $this->loadPageData( $data );
470 $revision = Revision
::newFromId( $this->mLatest
);
471 if( is_null( $revision ) ) {
472 wfDebug( __METHOD__
." failed to retrieve current page, rev_id {$this->mLatest}\n" );
477 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
478 // We should instead work with the Revision object when we need it...
479 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
481 $this->mUser
= $revision->getUser();
482 $this->mUserText
= $revision->getUserText();
483 $this->mComment
= $revision->getComment();
484 $this->mTimestamp
= wfTimestamp( TS_MW
, $revision->getTimestamp() );
486 $this->mRevIdFetched
= $revision->getId();
487 $this->mContentLoaded
= true;
488 $this->mRevision
=& $revision;
490 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) ) ;
492 return $this->mContent
;
496 * Read/write accessor to select FOR UPDATE
498 * @param $x Mixed: FIXME
500 public function forUpdate( $x = NULL ) {
501 return wfSetVar( $this->mForUpdate
, $x );
505 * Get the database which should be used for reads
508 * @deprecated - just call wfGetDB( DB_MASTER ) instead
511 wfDeprecated( __METHOD__
);
512 return wfGetDB( DB_MASTER
);
516 * Get options for all SELECT statements
518 * @param $options Array: an optional options array which'll be appended to
520 * @return Array: options
522 protected function getSelectOptions( $options = '' ) {
523 if( $this->mForUpdate
) {
524 if( is_array( $options ) ) {
525 $options[] = 'FOR UPDATE';
527 $options = 'FOR UPDATE';
534 * @return int Page ID
536 public function getID() {
537 if( $this->mTitle
) {
538 return $this->mTitle
->getArticleID();
545 * @return bool Whether or not the page exists in the database
547 public function exists() {
548 return $this->getId() > 0;
552 * Check if this page is something we're going to be showing
553 * some sort of sensible content for. If we return false, page
554 * views (plain action=view) will return an HTTP 404 response,
555 * so spiders and robots can know they're following a bad link.
559 public function hasViewableContent() {
560 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
564 * @return int The view count for the page
566 public function getCount() {
567 if( -1 == $this->mCounter
) {
568 $id = $this->getID();
572 $dbr = wfGetDB( DB_SLAVE
);
573 $this->mCounter
= $dbr->selectField( 'page',
575 array( 'page_id' => $id ),
577 $this->getSelectOptions()
581 return $this->mCounter
;
585 * Determine whether a page would be suitable for being counted as an
586 * article in the site_stats table based on the title & its content
588 * @param $text String: text to analyze
591 public function isCountable( $text ) {
592 global $wgUseCommaCount;
594 $token = $wgUseCommaCount ?
',' : '[[';
595 return $this->mTitle
->isContentPage() && !$this->isRedirect($text) && in_string($token,$text);
599 * Tests if the article text represents a redirect
601 * @param $text String: FIXME
604 public function isRedirect( $text = false ) {
605 if( $text === false ) {
606 if( $this->mDataLoaded
) {
607 return $this->mIsRedirect
;
609 // Apparently loadPageData was never called
610 $this->loadContent();
611 $titleObj = Title
::newFromRedirectRecurse( $this->fetchContent() );
613 $titleObj = Title
::newFromRedirect( $text );
615 return $titleObj !== NULL;
619 * Returns true if the currently-referenced revision is the current edit
620 * to this page (and it exists).
623 public function isCurrent() {
624 # If no oldid, this is the current version.
625 if( $this->getOldID() == 0 ) {
628 return $this->exists() && isset($this->mRevision
) && $this->mRevision
->isCurrent();
632 * Loads everything except the text
633 * This isn't necessary for all uses, so it's only done if needed.
635 protected function loadLastEdit() {
636 if( -1 != $this->mUser
)
639 # New or non-existent articles have no user information
640 $id = $this->getID();
641 if( 0 == $id ) return;
643 $this->mLastRevision
= Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $id );
644 if( !is_null( $this->mLastRevision
) ) {
645 $this->mUser
= $this->mLastRevision
->getUser();
646 $this->mUserText
= $this->mLastRevision
->getUserText();
647 $this->mTimestamp
= $this->mLastRevision
->getTimestamp();
648 $this->mComment
= $this->mLastRevision
->getComment();
649 $this->mMinorEdit
= $this->mLastRevision
->isMinor();
650 $this->mRevIdFetched
= $this->mLastRevision
->getId();
654 public function getTimestamp() {
655 // Check if the field has been filled by ParserCache::get()
656 if( !$this->mTimestamp
) {
657 $this->loadLastEdit();
659 return wfTimestamp(TS_MW
, $this->mTimestamp
);
662 public function getUser() {
663 $this->loadLastEdit();
667 public function getUserText() {
668 $this->loadLastEdit();
669 return $this->mUserText
;
672 public function getComment() {
673 $this->loadLastEdit();
674 return $this->mComment
;
677 public function getMinorEdit() {
678 $this->loadLastEdit();
679 return $this->mMinorEdit
;
682 /* Use this to fetch the rev ID used on page views */
683 public function getRevIdFetched() {
684 $this->loadLastEdit();
685 return $this->mRevIdFetched
;
689 * @param $limit Integer: default 0.
690 * @param $offset Integer: default 0.
692 public function getContributors($limit = 0, $offset = 0) {
693 # XXX: this is expensive; cache this info somewhere.
695 $dbr = wfGetDB( DB_SLAVE
);
696 $revTable = $dbr->tableName( 'revision' );
697 $userTable = $dbr->tableName( 'user' );
699 $pageId = $this->getId();
701 $user = $this->getUser();
703 $excludeCond = "AND rev_user != $user";
705 $userText = $dbr->addQuotes( $this->getUserText() );
706 $excludeCond = "AND rev_user_text != $userText";
709 $deletedBit = $dbr->bitAnd( 'rev_deleted', Revision
::DELETED_USER
); // username hidden?
711 $sql = "SELECT {$userTable}.*, rev_user_text as user_name, MAX(rev_timestamp) as timestamp
712 FROM $revTable LEFT JOIN $userTable ON rev_user = user_id
713 WHERE rev_page = $pageId
716 GROUP BY rev_user, rev_user_text
717 ORDER BY timestamp DESC";
720 $sql = $dbr->limitResult( $sql, $limit, $offset );
722 $sql .= ' ' . $this->getSelectOptions();
723 $res = $dbr->query( $sql, __METHOD__
);
725 return new UserArrayFromResult( $res );
729 * This is the default action of the index.php entry point: just view the
730 * page of the given title.
732 public function view() {
733 global $wgUser, $wgOut, $wgRequest, $wgContLang;
734 global $wgEnableParserCache, $wgStylePath, $wgParser;
735 global $wgUseTrackbacks, $wgUseFileCache;
737 wfProfileIn( __METHOD__
);
739 # Get variables from query string
740 $oldid = $this->getOldID();
741 $parserCache = ParserCache
::singleton();
743 $parserOptions = clone $this->getParserOptions();
744 # Render printable version, use printable version cache
745 if ( $wgOut->isPrintable() ) {
746 $parserOptions->setIsPrintable( true );
749 # Try client and file cache
750 if( $oldid === 0 && $this->checkTouched() ) {
753 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
755 # Is is client cached?
756 if( $wgOut->checkLastModified( $this->getTouched() ) ) {
757 wfDebug( __METHOD__
.": done 304\n" );
758 wfProfileOut( __METHOD__
);
761 } else if( $wgUseFileCache && $this->tryFileCache() ) {
762 wfDebug( __METHOD__
.": done file cache\n" );
763 # tell wgOut that output is taken care of
765 $this->viewUpdates();
766 wfProfileOut( __METHOD__
);
771 $sk = $wgUser->getSkin();
773 # getOldID may want us to redirect somewhere else
774 if( $this->mRedirectUrl
) {
775 $wgOut->redirect( $this->mRedirectUrl
);
776 wfDebug( __METHOD__
.": redirecting due to oldid\n" );
777 wfProfileOut( __METHOD__
);
781 $wgOut->setArticleFlag( true );
782 # Set page title (may be overridden by DISPLAYTITLE)
783 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
785 # If we got diff in the query, we want to see a diff page instead of the article.
786 if( !is_null( $wgRequest->getVal( 'diff' ) ) ) {
787 wfDebug( __METHOD__
.": showing diff page\n" );
788 $this->showDiffPage();
789 wfProfileOut( __METHOD__
);
793 # Should the parser cache be used?
794 $useParserCache = $this->useParserCache( $oldid );
795 wfDebug( 'Article::view using parser cache: ' . ($useParserCache ?
'yes' : 'no' ) . "\n" );
796 if( $wgUser->getOption( 'stubthreshold' ) ) {
797 wfIncrStats( 'pcache_miss_stub' );
800 # For the main page, overwrite the <title> element with the con-
801 # tents of 'pagetitle-view-mainpage' instead of the default (if
803 if( $this->mTitle
->equals( Title
::newMainPage() )
804 && ($m=wfMsgForContent( 'pagetitle-view-mainpage' )) !== '' )
806 $wgOut->setHTMLTitle( $m );
809 $wasRedirected = $this->showRedirectedFromHeader();
810 $this->showNamespaceHeader();
812 # Iterate through the possible ways of constructing the output text.
813 # Keep going until $outputDone is set, or we run out of things to do.
816 while( !$outputDone && ++
$pass ){
819 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
823 # Try the parser cache
824 if( $useParserCache ) {
825 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
826 if ( $this->mParserOutput
!== false ) {
827 wfDebug( __METHOD__
.": showing parser cache contents\n" );
828 $wgOut->addParserOutput( $this->mParserOutput
);
829 # Ensure that UI elements requiring revision ID have
830 # the correct version information.
831 $wgOut->setRevisionId( $this->mLatest
);
838 $text = $this->getContent();
839 if( $text === false ||
$this->getID() == 0 ) {
840 wfDebug( __METHOD__
.": showing missing article\n" );
841 $this->showMissingArticle();
842 wfProfileOut( __METHOD__
);
846 # Another whitelist check in case oldid is altering the title
847 if( !$this->mTitle
->userCanRead() ) {
848 wfDebug( __METHOD__
.": denied on secondary read check\n" );
849 $wgOut->loginToUse();
852 wfProfileOut( __METHOD__
);
856 # Are we looking at an old revision
857 if( $oldid && !is_null( $this->mRevision
) ) {
858 $this->setOldSubtitle( $oldid );
859 if ( !$this->showDeletedRevisionHeader() ) {
860 wfDebug( __METHOD__
.": cannot view deleted revision\n" );
861 wfProfileOut( __METHOD__
);
864 # If this "old" version is the current, then try the parser cache...
865 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
866 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
867 if ( $this->mParserOutput
) {
868 wfDebug( __METHOD__
.": showing parser cache for current rev permalink\n" );
869 $wgOut->addParserOutput( $this->mParserOutput
);
870 $wgOut->setRevisionId( $this->mLatest
);
871 $this->showViewFooter();
872 $this->viewUpdates();
873 wfProfileOut( __METHOD__
);
879 # Ensure that UI elements requiring revision ID have
880 # the correct version information.
881 $wgOut->setRevisionId( $this->getRevIdFetched() );
883 # Pages containing custom CSS or JavaScript get special treatment
884 if( $this->mTitle
->isCssOrJsPage() ||
$this->mTitle
->isCssJsSubpage() ) {
885 wfDebug( __METHOD__
.": showing CSS/JS source\n" );
886 $this->showCssOrJsPage();
888 } else if( $rt = Title
::newFromRedirectArray( $text ) ) {
889 wfDebug( __METHOD__
.": showing redirect=no page\n" );
890 # Viewing a redirect page (e.g. with parameter redirect=no)
891 # Don't append the subtitle if this was an old revision
892 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
893 # Parse just to get categories, displaytitle, etc.
894 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
, $parserOptions );
895 $wgOut->addParserOutputNoText( $this->mParserOutput
);
901 # Run the parse, protected by a pool counter
902 wfDebug( __METHOD__
.": doing uncached parse\n" );
903 $key = $parserCache->getKey( $this, $parserOptions );
904 $poolCounter = PoolCounter
::factory( 'Article::view', $key );
905 $dirtyCallback = $useParserCache ?
array( $this, 'tryDirtyCache' ) : false;
906 $status = $poolCounter->executeProtected( array( $this, 'doViewParse' ), $dirtyCallback );
908 if ( !$status->isOK() ) {
909 # Connection or timeout error
910 $this->showPoolError( $status );
911 wfProfileOut( __METHOD__
);
918 # Should be unreachable, but just in case...
924 # Now that we've filled $this->mParserOutput, we know whether
925 # there are any __NOINDEX__ tags on the page
926 $policy = $this->getRobotPolicy( 'view' );
927 $wgOut->setIndexPolicy( $policy['index'] );
928 $wgOut->setFollowPolicy( $policy['follow'] );
930 $this->showViewFooter();
931 $this->viewUpdates();
932 wfProfileOut( __METHOD__
);
936 * Show a diff page according to current request variables. For use within
937 * Article::view() only, other callers should use the DifferenceEngine class.
939 public function showDiffPage() {
940 global $wgOut, $wgRequest, $wgUser;
942 $diff = $wgRequest->getVal( 'diff' );
943 $rcid = $wgRequest->getVal( 'rcid' );
944 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
945 $purge = $wgRequest->getVal( 'action' ) == 'purge';
946 $htmldiff = $wgRequest->getBool( 'htmldiff' );
947 $unhide = $wgRequest->getInt('unhide') == 1;
948 $oldid = $this->getOldID();
950 $de = new DifferenceEngine( $this->mTitle
, $oldid, $diff, $rcid, $purge, $htmldiff, $unhide );
951 // DifferenceEngine directly fetched the revision:
952 $this->mRevIdFetched
= $de->mNewid
;
953 $de->showDiffPage( $diffOnly );
955 // Needed to get the page's current revision
956 $this->loadPageData();
957 if( $diff == 0 ||
$diff == $this->mLatest
) {
958 # Run view updates for current revision only
959 $this->viewUpdates();
964 * Show a page view for a page formatted as CSS or JavaScript. To be called by
965 * Article::view() only.
967 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
970 public function showCssOrJsPage() {
972 $wgOut->addHTML( wfMsgExt( 'clearyourcache', 'parse' ) );
973 // Give hooks a chance to customise the output
974 if( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->mTitle
, $wgOut ) ) ) {
975 // Wrap the whole lot in a <pre> and don't parse
977 preg_match( '!\.(css|js)$!u', $this->mTitle
->getText(), $m );
978 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
979 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
980 $wgOut->addHTML( "\n</pre>\n" );
985 * Get the robot policy to be used for the current action=view request.
986 * @return String the policy that should be set
987 * @deprecated use getRobotPolicy() instead, which returns an associative
990 public function getRobotPolicyForView() {
991 wfDeprecated( __FUNC__
);
992 $policy = $this->getRobotPolicy( 'view' );
993 return $policy['index'] . ',' . $policy['follow'];
997 * Get the robot policy to be used for the current view
998 * @param $action String the action= GET parameter
999 * @return Array the policy that should be set
1000 * TODO: actions other than 'view'
1002 public function getRobotPolicy( $action ){
1004 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1005 global $wgDefaultRobotPolicy, $wgRequest;
1007 $ns = $this->mTitle
->getNamespace();
1008 if( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
1009 # Don't index user and user talk pages for blocked users (bug 11443)
1010 if( !$this->mTitle
->isSubpage() ) {
1011 $block = new Block();
1012 if( $block->load( $this->mTitle
->getText() ) ) {
1013 return array( 'index' => 'noindex',
1014 'follow' => 'nofollow' );
1019 if( $this->getID() === 0 ||
$this->getOldID() ) {
1020 # Non-articles (special pages etc), and old revisions
1021 return array( 'index' => 'noindex',
1022 'follow' => 'nofollow' );
1023 } elseif( $wgOut->isPrintable() ) {
1024 # Discourage indexing of printable versions, but encourage following
1025 return array( 'index' => 'noindex',
1026 'follow' => 'follow' );
1027 } elseif( $wgRequest->getInt('curid') ) {
1028 # For ?curid=x urls, disallow indexing
1029 return array( 'index' => 'noindex',
1030 'follow' => 'follow' );
1033 # Otherwise, construct the policy based on the various config variables.
1034 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
1036 if( isset( $wgNamespaceRobotPolicies[$ns] ) ){
1037 # Honour customised robot policies for this namespace
1038 $policy = array_merge( $policy,
1039 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] ) );
1041 if( $this->mTitle
->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ){
1042 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1043 # a final sanity check that we have really got the parser output.
1044 $policy = array_merge( $policy,
1045 array( 'index' => $this->mParserOutput
->getIndexPolicy() ) );
1048 if( isset( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) ){
1049 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1050 $policy = array_merge( $policy,
1051 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) );
1059 * Converts a String robot policy into an associative array, to allow
1060 * merging of several policies using array_merge().
1061 * @param $policy Mixed, returns empty array on null/false/'', transparent
1062 * to already-converted arrays, converts String.
1063 * @return associative Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1065 public static function formatRobotPolicy( $policy ){
1066 if( is_array( $policy ) ){
1068 } elseif( !$policy ){
1072 $policy = explode( ',', $policy );
1073 $policy = array_map( 'trim', $policy );
1076 foreach( $policy as $var ){
1077 if( in_array( $var, array('index','noindex') ) ){
1078 $arr['index'] = $var;
1079 } elseif( in_array( $var, array('follow','nofollow') ) ){
1080 $arr['follow'] = $var;
1087 * If this request is a redirect view, send "redirected from" subtitle to
1088 * $wgOut. Returns true if the header was needed, false if this is not a
1089 * redirect view. Handles both local and remote redirects.
1091 public function showRedirectedFromHeader() {
1092 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1094 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1095 $sk = $wgUser->getSkin();
1096 if( isset( $this->mRedirectedFrom
) ) {
1097 // This is an internally redirected page view.
1098 // We'll need a backlink to the source page for navigation.
1099 if( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1101 $this->mRedirectedFrom
,
1104 array( 'redirect' => 'no' ),
1105 array( 'known', 'noclasses' )
1107 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1108 $wgOut->setSubtitle( $s );
1110 // Set the fragment if one was specified in the redirect
1111 if( strval( $this->mTitle
->getFragment() ) != '' ) {
1112 $fragment = Xml
::escapeJsString( $this->mTitle
->getFragmentForURL() );
1113 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1116 // Add a <link rel="canonical"> tag
1117 $wgOut->addLink( array( 'rel' => 'canonical',
1118 'href' => $this->mTitle
->getLocalURL() )
1122 } elseif( $rdfrom ) {
1123 // This is an externally redirected view, from some other wiki.
1124 // If it was reported from a trusted site, supply a backlink.
1125 if( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1126 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1127 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1128 $wgOut->setSubtitle( $s );
1136 * Show a header specific to the namespace currently being viewed, like
1137 * [[MediaWiki:Talkpagetext]]. For Article::view().
1139 public function showNamespaceHeader() {
1141 if( $this->mTitle
->isTalkPage() ) {
1142 $msg = wfMsgNoTrans( 'talkpageheader' );
1143 if ( $msg !== '-' && !wfEmptyMsg( 'talkpageheader', $msg ) ) {
1144 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1</div>", array( 'talkpageheader' ) );
1150 * Show the footer section of an ordinary page view
1152 public function showViewFooter() {
1153 global $wgOut, $wgUseTrackbacks, $wgRequest;
1154 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1155 if( $this->mTitle
->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->mTitle
->getText() ) ) {
1156 $wgOut->addWikiMsg('anontalkpagetext');
1159 # If we have been passed an &rcid= parameter, we want to give the user a
1160 # chance to mark this new article as patrolled.
1161 $this->showPatrolFooter();
1164 if( $wgUseTrackbacks ) {
1165 $this->addTrackbacks();
1170 * If patrol is possible, output a patrol UI box. This is called from the
1171 * footer section of ordinary page views. If patrol is not possible or not
1172 * desired, does nothing.
1174 public function showPatrolFooter() {
1175 global $wgOut, $wgRequest, $wgUser;
1176 $rcid = $wgRequest->getVal( 'rcid' );
1178 if( !$rcid ||
!$this->mTitle
->exists() ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1182 $sk = $wgUser->getSkin();
1185 "<div class='patrollink'>" .
1187 'markaspatrolledlink',
1190 wfMsgHtml( 'markaspatrolledtext' ),
1193 'action' => 'markpatrolled',
1196 array( 'known', 'noclasses' )
1204 * Show the error text for a missing article. For articles in the MediaWiki
1205 * namespace, show the default message text. To be called from Article::view().
1207 public function showMissingArticle() {
1208 global $wgOut, $wgRequest, $wgUser;
1210 # Show info in user (talk) namespace. Does the user exist?
1211 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1212 $parts = explode( '/', $this->mTitle
->getText() );
1213 $rootPart = $parts[0];
1214 $id = User
::idFromName( $rootPart );
1215 $ip = User
::isIP( $rootPart );
1216 if ( $id == 0 && !$ip ) { # User does not exist
1217 $wgOut->wrapWikiMsg( '<div class="mw-userpage-userdoesnotexist error">$1</div>',
1218 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1221 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1222 # Show delete and move logs
1223 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1225 'conds' => array( "log_action != 'revision'" ),
1226 'showIfEmpty' => false,
1227 'msgKey' => array( 'moveddeleted-notice' ) )
1230 # Show error message
1231 $oldid = $this->getOldID();
1233 $text = wfMsgNoTrans( 'missing-article',
1234 $this->mTitle
->getPrefixedText(),
1235 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1236 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1237 // Use the default message text
1238 $text = $this->getContent();
1240 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1241 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1242 $errors = array_merge( $createErrors, $editErrors );
1244 if ( !count($errors) )
1245 $text = wfMsgNoTrans( 'noarticletext' );
1247 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1249 $text = "<div class='noarticletext'>\n$text\n</div>";
1250 if( !$this->hasViewableContent() ) {
1251 // If there's no backing content, send a 404 Not Found
1252 // for better machine handling of broken links.
1253 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1255 $wgOut->addWikiText( $text );
1259 * If the revision requested for view is deleted, check permissions.
1260 * Send either an error message or a warning header to $wgOut.
1261 * Returns true if the view is allowed, false if not.
1263 public function showDeletedRevisionHeader() {
1264 global $wgOut, $wgRequest;
1265 if( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1269 // If the user is not allowed to see it...
1270 if( !$this->mRevision
->userCan(Revision
::DELETED_TEXT
) ) {
1271 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1</div>\n",
1272 'rev-deleted-text-permission' );
1274 // If the user needs to confirm that they want to see it...
1275 } else if( $wgRequest->getInt('unhide') != 1 ) {
1276 # Give explanation and add a link to view the revision...
1277 $oldid = intval( $this->getOldID() );
1278 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1279 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1280 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1281 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1</div>\n",
1282 array($msg,$link) );
1284 // We are allowed to see...
1286 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1287 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1288 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1</div>\n", $msg );
1294 * Should the parser cache be used?
1296 public function useParserCache( $oldid ) {
1297 global $wgUser, $wgEnableParserCache;
1299 return $wgEnableParserCache
1300 && intval( $wgUser->getOption( 'stubthreshold' ) ) == 0
1303 && !$this->mTitle
->isCssOrJsPage()
1304 && !$this->mTitle
->isCssJsSubpage();
1308 * Execute the uncached parse for action=view
1310 public function doViewParse() {
1312 $oldid = $this->getOldID();
1313 $useParserCache = $this->useParserCache( $oldid );
1314 $parserOptions = clone $this->getParserOptions();
1315 # Render printable version, use printable version cache
1316 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1317 # Don't show section-edit links on old revisions... this way lies madness.
1318 $parserOptions->setEditSection( $this->isCurrent() );
1319 $useParserCache = $this->useParserCache( $oldid );
1320 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1324 * Try to fetch an expired entry from the parser cache. If it is present,
1325 * output it and return true. If it is not present, output nothing and
1326 * return false. This is used as a callback function for
1327 * PoolCounter::executeProtected().
1329 public function tryDirtyCache() {
1331 $parserCache = ParserCache
::singleton();
1332 $options = $this->getParserOptions();
1333 $options->setIsPrintable( $wgOut->isPrintable() );
1334 $output = $parserCache->getDirty( $this, $options );
1336 wfDebug( __METHOD__
.": sending dirty output\n" );
1337 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1338 $wgOut->setSquidMaxage( 0 );
1339 $this->mParserOutput
= $output;
1340 $wgOut->addParserOutput( $output );
1341 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1344 wfDebugLog( 'dirty', "dirty missing\n" );
1345 wfDebug( __METHOD__
.": no dirty cache\n" );
1351 * Show an error page for an error from the pool counter.
1352 * @param $status Status
1354 public function showPoolError( $status ) {
1356 $wgOut->clearHTML(); // for release() errors
1357 $wgOut->enableClientCache( false );
1358 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1359 $wgOut->addWikiText(
1360 '<div class="errorbox">' .
1361 $status->getWikiText( false, 'view-pool-error' ) .
1368 * @param $target Title object or Array of destination(s) to redirect
1369 * @param $appendSubtitle Boolean [optional]
1370 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1372 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1373 global $wgParser, $wgOut, $wgContLang, $wgStylePath, $wgUser;
1375 if( !is_array( $target ) ) {
1376 $target = array( $target );
1378 $imageDir = $wgContLang->getDir();
1379 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1380 $imageUrl2 = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1381 $alt2 = $wgContLang->isRTL() ?
'←' : '→'; // should -> and <- be used instead of entities?
1383 if( $appendSubtitle ) {
1384 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1386 $sk = $wgUser->getSkin();
1387 // the loop prepends the arrow image before the link, so the first case needs to be outside
1388 $title = array_shift( $target );
1392 htmlspecialchars( $title->getFullText() ),
1395 array( 'known', 'noclasses' )
1398 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1400 // automatically append redirect=no to each link, since most of them are redirect pages themselves
1401 foreach( $target as $rt ) {
1403 $link .= '<img src="'.$imageUrl2.'" alt="'.$alt2.' " />'
1406 htmlspecialchars( $rt->getFullText() ),
1409 array( 'known', 'noclasses' )
1412 $link .= '<img src="'.$imageUrl2.'" alt="'.$alt2.' " />'
1413 . $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1416 return '<img src="'.$imageUrl.'" alt="#REDIRECT " />' .
1417 '<span class="redirectText">'.$link.'</span>';
1421 public function addTrackbacks() {
1422 global $wgOut, $wgUser;
1423 $dbr = wfGetDB( DB_SLAVE
);
1424 $tbs = $dbr->select( 'trackbacks',
1425 array('tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name'),
1426 array('tb_page' => $this->getID() )
1428 if( !$dbr->numRows($tbs) ) return;
1431 while( $o = $dbr->fetchObject($tbs) ) {
1433 if( $wgUser->isAllowed( 'trackback' ) ) {
1434 $delurl = $this->mTitle
->getFullURL("action=deletetrackback&tbid=" .
1435 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1436 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1439 $tbtext .= wfMsg(strlen($o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1446 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>$1</div>\n", array( 'trackbackbox', $tbtext ) );
1447 $this->mTitle
->invalidateCache();
1450 public function deletetrackback() {
1451 global $wgUser, $wgRequest, $wgOut;
1452 if( !$wgUser->matchEditToken($wgRequest->getVal('token')) ) {
1453 $wgOut->addWikiMsg( 'sessionfailure' );
1457 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1458 if( count($permission_errors) ) {
1459 $wgOut->showPermissionsErrorPage( $permission_errors );
1463 $db = wfGetDB( DB_MASTER
);
1464 $db->delete( 'trackbacks', array('tb_id' => $wgRequest->getInt('tbid')) );
1466 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1467 $this->mTitle
->invalidateCache();
1470 public function render() {
1472 $wgOut->setArticleBodyOnly(true);
1477 * Handle action=purge
1479 public function purge() {
1480 global $wgUser, $wgRequest, $wgOut;
1481 if( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1482 if( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1487 $action = htmlspecialchars( $wgRequest->getRequestURL() );
1488 $button = wfMsgExt( 'confirm_purge_button', array('escapenoentities') );
1489 $form = "<form method=\"post\" action=\"$action\">\n" .
1490 "<input type=\"submit\" name=\"submit\" value=\"$button\" />\n" .
1492 $top = wfMsgExt( 'confirm-purge-top', array('parse') );
1493 $bottom = wfMsgExt( 'confirm-purge-bottom', array('parse') );
1494 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1495 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1496 $wgOut->addHTML( $top . $form . $bottom );
1501 * Perform the actions of a page purging
1503 public function doPurge() {
1505 // Invalidate the cache
1506 $this->mTitle
->invalidateCache();
1509 // Commit the transaction before the purge is sent
1510 $dbw = wfGetDB( DB_MASTER
);
1511 $dbw->immediateCommit();
1514 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1515 $update->doUpdate();
1517 if( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1518 global $wgMessageCache;
1519 if( $this->getID() == 0 ) {
1522 $text = $this->getRawText();
1524 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1529 * Insert a new empty page record for this article.
1530 * This *must* be followed up by creating a revision
1531 * and running $this->updateToLatest( $rev_id );
1532 * or else the record will be left in a funky state.
1533 * Best if all done inside a transaction.
1535 * @param $dbw Database
1536 * @return int The newly created page_id key, or false if the title already existed
1539 public function insertOn( $dbw ) {
1540 wfProfileIn( __METHOD__
);
1542 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1543 $dbw->insert( 'page', array(
1544 'page_id' => $page_id,
1545 'page_namespace' => $this->mTitle
->getNamespace(),
1546 'page_title' => $this->mTitle
->getDBkey(),
1547 'page_counter' => 0,
1548 'page_restrictions' => '',
1549 'page_is_redirect' => 0, # Will set this shortly...
1551 'page_random' => wfRandom(),
1552 'page_touched' => $dbw->timestamp(),
1553 'page_latest' => 0, # Fill this in shortly...
1554 'page_len' => 0, # Fill this in shortly...
1555 ), __METHOD__
, 'IGNORE' );
1557 $affected = $dbw->affectedRows();
1559 $newid = $dbw->insertId();
1560 $this->mTitle
->resetArticleId( $newid );
1562 wfProfileOut( __METHOD__
);
1563 return $affected ?
$newid : false;
1567 * Update the page record to point to a newly saved revision.
1569 * @param $dbw Database object
1570 * @param $revision Revision: For ID number, and text used to set
1571 length and redirect status fields
1572 * @param $lastRevision Integer: if given, will not overwrite the page field
1573 * when different from the currently set value.
1574 * Giving 0 indicates the new page flag should be set
1576 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1577 * removing rows in redirect table.
1578 * @return bool true on success, false on failure
1581 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null ) {
1582 wfProfileIn( __METHOD__
);
1584 $text = $revision->getText();
1585 $rt = Title
::newFromRedirect( $text );
1587 $conditions = array( 'page_id' => $this->getId() );
1588 if( !is_null( $lastRevision ) ) {
1589 # An extra check against threads stepping on each other
1590 $conditions['page_latest'] = $lastRevision;
1593 $dbw->update( 'page',
1595 'page_latest' => $revision->getId(),
1596 'page_touched' => $dbw->timestamp(),
1597 'page_is_new' => ($lastRevision === 0) ?
1 : 0,
1598 'page_is_redirect' => $rt !== NULL ?
1 : 0,
1599 'page_len' => strlen( $text ),
1604 $result = $dbw->affectedRows() != 0;
1606 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1609 wfProfileOut( __METHOD__
);
1614 * Add row to the redirect table if this is a redirect, remove otherwise.
1616 * @param $dbw Database
1617 * @param $redirectTitle a title object pointing to the redirect target,
1618 * or NULL if this is not a redirect
1619 * @param $lastRevIsRedirect If given, will optimize adding and
1620 * removing rows in redirect table.
1621 * @return bool true on success, false on failure
1624 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1625 // Always update redirects (target link might have changed)
1626 // Update/Insert if we don't know if the last revision was a redirect or not
1627 // Delete if changing from redirect to non-redirect
1628 $isRedirect = !is_null($redirectTitle);
1629 if($isRedirect ||
is_null($lastRevIsRedirect) ||
$lastRevIsRedirect !== $isRedirect) {
1630 wfProfileIn( __METHOD__
);
1632 // This title is a redirect, Add/Update row in the redirect table
1633 $set = array( /* SET */
1634 'rd_namespace' => $redirectTitle->getNamespace(),
1635 'rd_title' => $redirectTitle->getDBkey(),
1636 'rd_from' => $this->getId(),
1638 $dbw->replace( 'redirect', array( 'rd_from' ), $set, __METHOD__
);
1640 // This is not a redirect, remove row from redirect table
1641 $where = array( 'rd_from' => $this->getId() );
1642 $dbw->delete( 'redirect', $where, __METHOD__
);
1644 if( $this->getTitle()->getNamespace() == NS_FILE
) {
1645 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1647 wfProfileOut( __METHOD__
);
1648 return ( $dbw->affectedRows() != 0 );
1654 * If the given revision is newer than the currently set page_latest,
1655 * update the page record. Otherwise, do nothing.
1657 * @param $dbw Database object
1658 * @param $revision Revision object
1660 public function updateIfNewerOn( &$dbw, $revision ) {
1661 wfProfileIn( __METHOD__
);
1662 $row = $dbw->selectRow(
1663 array( 'revision', 'page' ),
1664 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1666 'page_id' => $this->getId(),
1667 'page_latest=rev_id' ),
1670 if( wfTimestamp(TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1671 wfProfileOut( __METHOD__
);
1674 $prev = $row->rev_id
;
1675 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1677 # No or missing previous revision; mark the page as new
1679 $lastRevIsRedirect = null;
1681 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1682 wfProfileOut( __METHOD__
);
1687 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1688 * @return string Complete article text, or null if error
1690 public function replaceSection( $section, $text, $summary = '', $edittime = NULL ) {
1691 wfProfileIn( __METHOD__
);
1692 if( strval( $section ) == '' ) {
1693 // Whole-page edit; let the whole text through
1695 if( is_null($edittime) ) {
1696 $rev = Revision
::newFromTitle( $this->mTitle
);
1698 $dbw = wfGetDB( DB_MASTER
);
1699 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1702 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1703 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1706 $oldtext = $rev->getText();
1708 if( $section == 'new' ) {
1709 # Inserting a new section
1710 $subject = $summary ?
wfMsgForContent('newsectionheaderdefaultlevel',$summary) . "\n\n" : '';
1711 $text = strlen( trim( $oldtext ) ) > 0
1712 ?
"{$oldtext}\n\n{$subject}{$text}"
1713 : "{$subject}{$text}";
1715 # Replacing an existing section; roll out the big guns
1717 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1720 wfProfileOut( __METHOD__
);
1725 * This function is not deprecated until somebody fixes the core not to use
1726 * it. Nevertheless, use Article::doEdit() instead.
1728 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC=false, $comment=false, $bot=false ) {
1729 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1730 ( $isminor ? EDIT_MINOR
: 0 ) |
1731 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1732 ( $bot ? EDIT_FORCE_BOT
: 0 );
1734 # If this is a comment, add the summary as headline
1735 if( $comment && $summary != "" ) {
1736 $text = wfMsgForContent('newsectionheaderdefaultlevel',$summary) . "\n\n".$text;
1739 $this->doEdit( $text, $summary, $flags );
1741 $dbw = wfGetDB( DB_MASTER
);
1743 if(!$this->mTitle
->userIsWatching()) {
1749 if( $this->mTitle
->userIsWatching() ) {
1755 $this->doRedirect( $this->isRedirect( $text ) );
1759 * @deprecated use Article::doEdit()
1761 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1762 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1763 ( $minor ? EDIT_MINOR
: 0 ) |
1764 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1766 $status = $this->doEdit( $text, $summary, $flags );
1767 if( !$status->isOK() ) {
1771 $dbw = wfGetDB( DB_MASTER
);
1773 if(!$this->mTitle
->userIsWatching()) {
1779 if( $this->mTitle
->userIsWatching() ) {
1786 $extraQuery = ''; // Give extensions a chance to modify URL query on update
1787 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
1789 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
1796 * Change an existing article or create a new article. Updates RC and all necessary caches,
1797 * optionally via the deferred update array.
1799 * $wgUser must be set before calling this function.
1801 * @param $text String: new text
1802 * @param $summary String: edit summary
1803 * @param $flags Integer bitfield:
1805 * Article is known or assumed to be non-existent, create a new one
1807 * Article is known or assumed to be pre-existing, update it
1809 * Mark this edit minor, if the user is allowed to do so
1811 * Do not log the change in recentchanges
1813 * Mark the edit a "bot" edit regardless of user rights
1814 * EDIT_DEFER_UPDATES
1815 * Defer some of the updates until the end of index.php
1817 * Fill in blank summaries with generated text where possible
1819 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1820 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
1821 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1822 * edit-already-exists error will be returned. These two conditions are also possible with
1823 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1825 * @param $baseRevId the revision ID this edit was based off, if any
1826 * @param $user Optional user object, $wgUser will be used if not passed
1828 * @return Status object. Possible errors:
1829 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1830 * edit-gone-missing: In update mode, but the article didn't exist
1831 * edit-conflict: In update mode, the article changed unexpectedly
1832 * edit-no-change: Warning that the text was the same as before
1833 * edit-already-exists: In creation mode, but the article already exists
1835 * Extensions may define additional errors.
1837 * $return->value will contain an associative array with members as follows:
1838 * new: Boolean indicating if the function attempted to create a new article
1839 * revision: The revision object for the inserted revision, or null
1841 * Compatibility note: this function previously returned a boolean value indicating success/failure
1843 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1844 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
1846 # Low-level sanity check
1847 if( $this->mTitle
->getText() == '' ) {
1848 throw new MWException( 'Something is trying to edit an article with an empty title' );
1851 wfProfileIn( __METHOD__
);
1853 $user = is_null($user) ?
$wgUser : $user;
1854 $status = Status
::newGood( array() );
1856 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
1857 $this->loadPageData();
1859 if( !($flags & EDIT_NEW
) && !($flags & EDIT_UPDATE
) ) {
1860 $aid = $this->mTitle
->getArticleID();
1862 $flags |
= EDIT_UPDATE
;
1868 if( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
1869 $flags & EDIT_MINOR
, null, null, &$flags, &$status ) ) )
1871 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
1872 wfProfileOut( __METHOD__
);
1873 if( $status->isOK() ) {
1874 $status->fatal( 'edit-hook-aborted');
1879 # Silently ignore EDIT_MINOR if not allowed
1880 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed('minoredit');
1881 $bot = $flags & EDIT_FORCE_BOT
;
1883 $oldtext = $this->getRawText(); // current revision
1884 $oldsize = strlen( $oldtext );
1886 # Provide autosummaries if one is not provided and autosummaries are enabled.
1887 if( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
1888 $summary = $this->getAutosummary( $oldtext, $text, $flags );
1891 $editInfo = $this->prepareTextForEdit( $text );
1892 $text = $editInfo->pst
;
1893 $newsize = strlen( $text );
1895 $dbw = wfGetDB( DB_MASTER
);
1896 $now = wfTimestampNow();
1897 $this->mTimestamp
=$now;
1899 if( $flags & EDIT_UPDATE
) {
1900 # Update article, but only if changed.
1901 $status->value
['new'] = false;
1902 # Make sure the revision is either completely inserted or not inserted at all
1903 if( !$wgDBtransactions ) {
1904 $userAbort = ignore_user_abort( true );
1909 $changed = ( strcmp( $text, $oldtext ) != 0 );
1912 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
1913 - (int)$this->isCountable( $oldtext );
1914 $this->mTotalAdjustment
= 0;
1916 if( !$this->mLatest
) {
1917 # Article gone missing
1918 wfDebug( __METHOD__
.": EDIT_UPDATE specified but article doesn't exist\n" );
1919 $status->fatal( 'edit-gone-missing' );
1920 wfProfileOut( __METHOD__
);
1924 $revision = new Revision( array(
1925 'page' => $this->getId(),
1926 'comment' => $summary,
1927 'minor_edit' => $isminor,
1929 'parent_id' => $this->mLatest
,
1930 'user' => $user->getId(),
1931 'user_text' => $user->getName(),
1935 $revisionId = $revision->insertOn( $dbw );
1939 # Note that we use $this->mLatest instead of fetching a value from the master DB
1940 # during the course of this function. This makes sure that EditPage can detect
1941 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
1942 # before this function is called. A previous function used a separate query, this
1943 # creates a window where concurrent edits can cause an ignored edit conflict.
1944 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
1947 /* Belated edit conflict! Run away!! */
1948 $status->fatal( 'edit-conflict' );
1949 # Delete the invalid revision if the DB is not transactional
1950 if( !$wgDBtransactions ) {
1951 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
1956 global $wgUseRCPatrol;
1957 wfRunHooks( 'NewRevisionFromEditComplete', array($this, $revision, $baseRevId, $user) );
1958 # Update recentchanges
1959 if( !( $flags & EDIT_SUPPRESS_RC
) ) {
1960 # Mark as patrolled if the user can do so
1961 $patrolled = $wgUseRCPatrol && $this->mTitle
->userCan('autopatrol');
1962 # Add RC row to the DB
1963 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
1964 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1965 $revisionId, $patrolled
1967 # Log auto-patrolled edits
1969 PatrolLog
::record( $rc, true );
1972 $user->incEditCount();
1976 $status->warning( 'edit-no-change' );
1978 // Keep the same revision ID, but do some updates on it
1979 $revisionId = $this->getRevIdFetched();
1980 // Update page_touched, this is usually implicit in the page update
1981 // Other cache updates are done in onArticleEdit()
1982 $this->mTitle
->invalidateCache();
1985 if( !$wgDBtransactions ) {
1986 ignore_user_abort( $userAbort );
1988 // Now that ignore_user_abort is restored, we can respond to fatal errors
1989 if( !$status->isOK() ) {
1990 wfProfileOut( __METHOD__
);
1994 # Invalidate cache of this article and all pages using this article
1995 # as a template. Partly deferred.
1996 Article
::onArticleEdit( $this->mTitle
);
1997 # Update links tables, site stats, etc.
1998 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed );
2000 # Create new article
2001 $status->value
['new'] = true;
2003 # Set statistics members
2004 # We work out if it's countable after PST to avoid counter drift
2005 # when articles are created with {{subst:}}
2006 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2007 $this->mTotalAdjustment
= 1;
2011 # Add the page record; stake our claim on this title!
2012 # This will return false if the article already exists
2013 $newid = $this->insertOn( $dbw );
2015 if( $newid === false ) {
2017 $status->fatal( 'edit-already-exists' );
2018 wfProfileOut( __METHOD__
);
2022 # Save the revision text...
2023 $revision = new Revision( array(
2025 'comment' => $summary,
2026 'minor_edit' => $isminor,
2028 'user' => $user->getId(),
2029 'user_text' => $user->getName(),
2031 $revisionId = $revision->insertOn( $dbw );
2033 $this->mTitle
->resetArticleID( $newid );
2035 # Update the page record with revision data
2036 $this->updateRevisionOn( $dbw, $revision, 0 );
2038 wfRunHooks( 'NewRevisionFromEditComplete', array($this, $revision, false, $user) );
2039 # Update recentchanges
2040 if( !( $flags & EDIT_SUPPRESS_RC
) ) {
2041 global $wgUseRCPatrol, $wgUseNPPatrol;
2042 # Mark as patrolled if the user can do so
2043 $patrolled = ($wgUseRCPatrol ||
$wgUseNPPatrol) && $this->mTitle
->userCan('autopatrol');
2044 # Add RC row to the DB
2045 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2046 '', strlen($text), $revisionId, $patrolled );
2047 # Log auto-patrolled edits
2049 PatrolLog
::record( $rc, true );
2052 $user->incEditCount();
2055 # Update links, etc.
2056 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true );
2059 Article
::onArticleCreate( $this->mTitle
);
2061 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2062 $flags & EDIT_MINOR
, null, null, &$flags, $revision ) );
2065 # Do updates right now unless deferral was requested
2066 if( !( $flags & EDIT_DEFER_UPDATES
) ) {
2070 // Return the new revision (or null) to the caller
2071 $status->value
['revision'] = $revision;
2073 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2074 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId ) );
2076 wfProfileOut( __METHOD__
);
2081 * @deprecated wrapper for doRedirect
2083 public function showArticle( $text, $subtitle , $sectionanchor = '', $me2, $now, $summary, $oldid ) {
2084 wfDeprecated( __METHOD__
);
2085 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor );
2089 * Output a redirect back to the article.
2090 * This is typically used after an edit.
2092 * @param $noRedir Boolean: add redirect=no
2093 * @param $sectionAnchor String: section to redirect to, including "#"
2094 * @param $extraQuery String: extra query params
2096 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2099 $query = 'redirect=no';
2101 $query .= "&$query";
2103 $query = $extraQuery;
2105 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2109 * Mark this particular edit/page as patrolled
2111 public function markpatrolled() {
2112 global $wgOut, $wgRequest, $wgUseRCPatrol, $wgUseNPPatrol, $wgUser;
2113 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2115 # If we haven't been given an rc_id value, we can't do anything
2116 $rcid = (int) $wgRequest->getVal('rcid');
2117 $rc = RecentChange
::newFromId($rcid);
2118 if( is_null($rc) ) {
2119 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2123 #It would be nice to see where the user had actually come from, but for now just guess
2124 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2125 $return = SpecialPage
::getTitleFor( $returnto );
2127 $dbw = wfGetDB( DB_MASTER
);
2128 $errors = $rc->doMarkPatrolled();
2130 if( in_array(array('rcpatroldisabled'), $errors) ) {
2131 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2135 if( in_array(array('hookaborted'), $errors) ) {
2136 // The hook itself has handled any output
2140 if( in_array(array('markedaspatrollederror-noautopatrol'), $errors) ) {
2141 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2142 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2143 $wgOut->returnToMain( false, $return );
2147 if( !empty($errors) ) {
2148 $wgOut->showPermissionsErrorPage( $errors );
2153 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2154 $wgOut->addWikiMsg( 'markedaspatrolledtext' );
2155 $wgOut->returnToMain( false, $return );
2159 * User-interface handler for the "watch" action
2162 public function watch() {
2163 global $wgUser, $wgOut;
2164 if( $wgUser->isAnon() ) {
2165 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2168 if( wfReadOnly() ) {
2169 $wgOut->readOnlyPage();
2172 if( $this->doWatch() ) {
2173 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2174 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2175 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2177 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2181 * Add this page to $wgUser's watchlist
2182 * @return bool true on successful watch operation
2184 public function doWatch() {
2186 if( $wgUser->isAnon() ) {
2189 if( wfRunHooks('WatchArticle', array(&$wgUser, &$this)) ) {
2190 $wgUser->addWatch( $this->mTitle
);
2191 return wfRunHooks('WatchArticleComplete', array(&$wgUser, &$this));
2197 * User interface handler for the "unwatch" action.
2199 public function unwatch() {
2200 global $wgUser, $wgOut;
2201 if( $wgUser->isAnon() ) {
2202 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2205 if( wfReadOnly() ) {
2206 $wgOut->readOnlyPage();
2209 if( $this->doUnwatch() ) {
2210 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2211 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2212 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2214 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2218 * Stop watching a page
2219 * @return bool true on successful unwatch
2221 public function doUnwatch() {
2223 if( $wgUser->isAnon() ) {
2226 if( wfRunHooks('UnwatchArticle', array(&$wgUser, &$this)) ) {
2227 $wgUser->removeWatch( $this->mTitle
);
2228 return wfRunHooks('UnwatchArticleComplete', array(&$wgUser, &$this));
2234 * action=protect handler
2236 public function protect() {
2237 $form = new ProtectionForm( $this );
2242 * action=unprotect handler (alias)
2244 public function unprotect() {
2249 * Update the article's restriction field, and leave a log entry.
2251 * @param $limit Array: set of restriction keys
2252 * @param $reason String
2253 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2254 * @param $expiry Array: per restriction type expiration
2255 * @return bool true on success
2257 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2258 global $wgUser, $wgRestrictionTypes, $wgContLang;
2260 $id = $this->mTitle
->getArticleID();
2262 wfDebug( "updateRestrictions failed: $id <= 0\n" );
2266 if ( wfReadOnly() ) {
2267 wfDebug( "updateRestrictions failed: read-only\n" );
2271 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2272 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2280 // Take this opportunity to purge out expired restrictions
2281 Title
::purgeExpiredRestrictions();
2283 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2284 # we expect a single selection, but the schema allows otherwise.
2286 $updated = Article
::flattenRestrictions( $limit );
2288 foreach( $wgRestrictionTypes as $action ) {
2289 if( isset( $expiry[$action] ) ) {
2290 # Get current restrictions on $action
2291 $aLimits = $this->mTitle
->getRestrictions( $action );
2292 $current[$action] = implode( '', $aLimits );
2293 # Are any actual restrictions being dealt with here?
2294 $aRChanged = count($aLimits) ||
!empty($limit[$action]);
2295 # If something changed, we need to log it. Checking $aRChanged
2296 # assures that "unprotecting" a page that is not protected does
2297 # not log just because the expiry was "changed".
2298 if( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2304 $current = Article
::flattenRestrictions( $current );
2306 $changed = ($changed ||
$current != $updated );
2307 $changed = $changed ||
($updated && $this->mTitle
->areRestrictionsCascading() != $cascade);
2308 $protect = ( $updated != '' );
2310 # If nothing's changed, do nothing
2312 if( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2314 $dbw = wfGetDB( DB_MASTER
);
2316 # Prepare a null revision to be added to the history
2317 $modified = $current != '' && $protect;
2319 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2321 $comment_type = 'unprotectedarticle';
2323 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2325 # Only restrictions with the 'protect' right can cascade...
2326 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2327 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2328 # The schema allows multiple restrictions
2329 if(!in_array('protect', $editrestriction) && !in_array('sysop', $editrestriction))
2331 $cascade_description = '';
2333 $cascade_description = ' ['.wfMsgForContent('protect-summary-cascade').']';
2337 $comment .= ": $reason";
2339 $editComment = $comment;
2340 $encodedExpiry = array();
2341 $protect_description = '';
2342 foreach( $limit as $action => $restrictions ) {
2343 if ( !isset($expiry[$action]) )
2344 $expiry[$action] = 'infinite';
2346 $encodedExpiry[$action] = Block
::encodeExpiry($expiry[$action], $dbw );
2347 if( $restrictions != '' ) {
2348 $protect_description .= "[$action=$restrictions] (";
2349 if( $encodedExpiry[$action] != 'infinity' ) {
2350 $protect_description .= wfMsgForContent( 'protect-expiring',
2351 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2352 $wgContLang->date( $expiry[$action], false, false ) ,
2353 $wgContLang->time( $expiry[$action], false, false ) );
2355 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2357 $protect_description .= ') ';
2360 $protect_description = trim($protect_description);
2362 if( $protect_description && $protect )
2363 $editComment .= " ($protect_description)";
2365 $editComment .= "$cascade_description";
2366 # Update restrictions table
2367 foreach( $limit as $action => $restrictions ) {
2368 if($restrictions != '' ) {
2369 $dbw->replace( 'page_restrictions', array(array('pr_page', 'pr_type')),
2370 array( 'pr_page' => $id,
2371 'pr_type' => $action,
2372 'pr_level' => $restrictions,
2373 'pr_cascade' => ($cascade && $action == 'edit') ?
1 : 0,
2374 'pr_expiry' => $encodedExpiry[$action] ), __METHOD__
);
2376 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2377 'pr_type' => $action ), __METHOD__
);
2381 # Insert a null revision
2382 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2383 $nullRevId = $nullRevision->insertOn( $dbw );
2385 $latest = $this->getLatest();
2386 # Update page record
2387 $dbw->update( 'page',
2389 'page_touched' => $dbw->timestamp(),
2390 'page_restrictions' => '',
2391 'page_latest' => $nullRevId
2392 ), array( /* WHERE */
2394 ), 'Article::protect'
2397 wfRunHooks( 'NewRevisionFromEditComplete', array($this, $nullRevision, $latest, $wgUser) );
2398 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2400 # Update the protection log
2401 $log = new LogPage( 'protect' );
2403 $params = array($protect_description,$cascade ?
'cascade' : '');
2404 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason), $params );
2406 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2410 } # End "changed" check
2416 * Take an array of page restrictions and flatten it to a string
2417 * suitable for insertion into the page_restrictions field.
2418 * @param $limit Array
2421 protected static function flattenRestrictions( $limit ) {
2422 if( !is_array( $limit ) ) {
2423 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2427 foreach( $limit as $action => $restrictions ) {
2428 if( $restrictions != '' ) {
2429 $bits[] = "$action=$restrictions";
2432 return implode( ':', $bits );
2436 * Auto-generates a deletion reason
2437 * @param &$hasHistory Boolean: whether the page has a history
2439 public function generateReason( &$hasHistory ) {
2441 $dbw = wfGetDB( DB_MASTER
);
2442 // Get the last revision
2443 $rev = Revision
::newFromTitle( $this->mTitle
);
2444 if( is_null( $rev ) )
2447 // Get the article's contents
2448 $contents = $rev->getText();
2450 // If the page is blank, use the text from the previous revision,
2451 // which can only be blank if there's a move/import/protect dummy revision involved
2452 if( $contents == '' ) {
2453 $prev = $rev->getPrevious();
2455 $contents = $prev->getText();
2460 // Find out if there was only one contributor
2461 // Only scan the last 20 revisions
2462 $res = $dbw->select( 'revision', 'rev_user_text',
2463 array( 'rev_page' => $this->getID(), $dbw->bitAnd('rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2465 array( 'LIMIT' => 20 )
2467 if( $res === false )
2468 // This page has no revisions, which is very weird
2471 $hasHistory = ( $res->numRows() > 1 );
2472 $row = $dbw->fetchObject( $res );
2473 $onlyAuthor = $row->rev_user_text
;
2474 // Try to find a second contributor
2475 foreach( $res as $row ) {
2476 if( $row->rev_user_text
!= $onlyAuthor ) {
2477 $onlyAuthor = false;
2481 $dbw->freeResult( $res );
2483 // Generate the summary with a '$1' placeholder
2485 // The current revision is blank and the one before is also
2486 // blank. It's just not our lucky day
2487 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2490 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2492 $reason = wfMsgForContent( 'excontent', '$1' );
2495 if( $reason == '-' ) {
2496 // Allow these UI messages to be blanked out cleanly
2500 // Replace newlines with spaces to prevent uglyness
2501 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2502 // Calculate the maximum amount of chars to get
2503 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2504 $maxLength = 255 - (strlen( $reason ) - 2) - 3;
2505 $contents = $wgContLang->truncate( $contents, $maxLength );
2506 // Remove possible unfinished links
2507 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2508 // Now replace the '$1' placeholder
2509 $reason = str_replace( '$1', $contents, $reason );
2515 * UI entry point for page deletion
2517 public function delete() {
2518 global $wgUser, $wgOut, $wgRequest;
2520 $confirm = $wgRequest->wasPosted() &&
2521 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2523 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2524 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2526 $reason = $this->DeleteReasonList
;
2528 if( $reason != 'other' && $this->DeleteReason
!= '' ) {
2529 // Entry from drop down menu + additional comment
2530 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2531 } elseif( $reason == 'other' ) {
2532 $reason = $this->DeleteReason
;
2534 # Flag to hide all contents of the archived revisions
2535 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2537 # This code desperately needs to be totally rewritten
2539 # Read-only check...
2540 if( wfReadOnly() ) {
2541 $wgOut->readOnlyPage();
2546 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2548 if( count( $permission_errors ) > 0 ) {
2549 $wgOut->showPermissionsErrorPage( $permission_errors );
2553 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2555 # Better double-check that it hasn't been deleted yet!
2556 $dbw = wfGetDB( DB_MASTER
);
2557 $conds = $this->mTitle
->pageCond();
2558 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2559 if( $latest === false ) {
2560 $wgOut->showFatalError(
2563 array( 'class' => 'error mw-error-cannotdelete' ),
2564 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2567 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2568 LogEventsList
::showLogExtract(
2571 $this->mTitle
->getPrefixedText()
2576 # Hack for big sites
2577 $bigHistory = $this->isBigDeletion();
2578 if( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2579 global $wgLang, $wgDeleteRevisionsLimit;
2580 $wgOut->wrapWikiMsg( "<div class='error'>\n$1</div>\n",
2581 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2586 $this->doDelete( $reason, $suppress );
2587 if( $wgRequest->getCheck( 'wpWatch' ) ) {
2589 } elseif( $this->mTitle
->userIsWatching() ) {
2595 // Generate deletion reason
2596 $hasHistory = false;
2597 if( !$reason ) $reason = $this->generateReason($hasHistory);
2599 // If the page has a history, insert a warning
2600 if( $hasHistory && !$confirm ) {
2602 $skin = $wgUser->getSkin();
2603 $revisions = $this->estimateRevisionCount();
2604 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2605 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .' ' .
2606 $skin->historyLink() .
2610 global $wgDeleteRevisionsLimit;
2611 $wgOut->wrapWikiMsg( "<div class='error'>\n$1</div>\n",
2612 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2616 return $this->confirmDelete( $reason );
2620 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2622 public function isBigDeletion() {
2623 global $wgDeleteRevisionsLimit;
2624 if( $wgDeleteRevisionsLimit ) {
2625 $revCount = $this->estimateRevisionCount();
2626 return $revCount > $wgDeleteRevisionsLimit;
2632 * @return int approximate revision count
2634 public function estimateRevisionCount() {
2635 $dbr = wfGetDB( DB_SLAVE
);
2636 // For an exact count...
2637 //return $dbr->selectField( 'revision', 'COUNT(*)',
2638 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2639 return $dbr->estimateRowCount( 'revision', '*',
2640 array( 'rev_page' => $this->getId() ), __METHOD__
);
2644 * Get the last N authors
2645 * @param $num Integer: number of revisions to get
2646 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2647 * @return array Array of authors, duplicates not removed
2649 public function getLastNAuthors( $num, $revLatest = 0 ) {
2650 wfProfileIn( __METHOD__
);
2651 // First try the slave
2652 // If that doesn't have the latest revision, try the master
2654 $db = wfGetDB( DB_SLAVE
);
2656 $res = $db->select( array( 'page', 'revision' ),
2657 array( 'rev_id', 'rev_user_text' ),
2659 'page_namespace' => $this->mTitle
->getNamespace(),
2660 'page_title' => $this->mTitle
->getDBkey(),
2661 'rev_page = page_id'
2662 ), __METHOD__
, $this->getSelectOptions( array(
2663 'ORDER BY' => 'rev_timestamp DESC',
2668 wfProfileOut( __METHOD__
);
2671 $row = $db->fetchObject( $res );
2672 if( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
2673 $db = wfGetDB( DB_MASTER
);
2678 } while ( $continue );
2680 $authors = array( $row->rev_user_text
);
2681 while ( $row = $db->fetchObject( $res ) ) {
2682 $authors[] = $row->rev_user_text
;
2684 wfProfileOut( __METHOD__
);
2689 * Output deletion confirmation dialog
2690 * @param $reason String: prefilled reason
2692 public function confirmDelete( $reason ) {
2693 global $wgOut, $wgUser;
2695 wfDebug( "Article::confirmDelete\n" );
2697 $deleteBackLink = $wgUser->getSkin()->link(
2702 array( 'known', 'noclasses' )
2704 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
2705 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2706 $wgOut->addWikiMsg( 'confirmdeletetext' );
2708 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
2710 if( $wgUser->isAllowed( 'suppressrevision' ) ) {
2711 $suppress = "<tr id=\"wpDeleteSuppressRow\" name=\"wpDeleteSuppressRow\">
2713 <td class='mw-input'><strong>" .
2714 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
2715 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
2721 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
2723 $form = Xml
::openElement( 'form', array( 'method' => 'post',
2724 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
2725 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
2726 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
2727 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
2728 "<tr id=\"wpDeleteReasonListRow\">
2729 <td class='mw-label'>" .
2730 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
2732 <td class='mw-input'>" .
2733 Xml
::listDropDown( 'wpDeleteReasonList',
2734 wfMsgForContent( 'deletereason-dropdown' ),
2735 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
2738 <tr id=\"wpDeleteReasonRow\">
2739 <td class='mw-label'>" .
2740 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
2742 <td class='mw-input'>" .
2743 Html
::input( 'wpReason', $reason, 'text', array(
2745 'maxlength' => '255',
2754 <td class='mw-input'>" .
2755 Xml
::checkLabel( wfMsg( 'watchthis' ),
2756 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
2762 <td class='mw-submit'>" .
2763 Xml
::submitButton( wfMsg( 'deletepage' ),
2764 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
2767 Xml
::closeElement( 'table' ) .
2768 Xml
::closeElement( 'fieldset' ) .
2769 Xml
::hidden( 'wpEditToken', $wgUser->editToken() ) .
2770 Xml
::closeElement( 'form' );
2772 if( $wgUser->isAllowed( 'editinterface' ) ) {
2773 $skin = $wgUser->getSkin();
2774 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
2775 $link = $skin->link(
2777 wfMsgHtml( 'delete-edit-reasonlist' ),
2779 array( 'action' => 'edit' )
2781 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
2784 $wgOut->addHTML( $form );
2785 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2786 LogEventsList
::showLogExtract(
2789 $this->mTitle
->getPrefixedText()
2794 * Perform a deletion and output success or failure messages
2796 public function doDelete( $reason, $suppress = false ) {
2797 global $wgOut, $wgUser;
2798 $id = $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
2801 if( wfRunHooks('ArticleDelete', array(&$this, &$wgUser, &$reason, &$error)) ) {
2802 if( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
2803 $deleted = $this->mTitle
->getPrefixedText();
2805 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
2806 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2808 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
2810 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
2811 $wgOut->returnToMain( false );
2812 wfRunHooks('ArticleDeleteComplete', array(&$this, &$wgUser, $reason, $id));
2815 if( $error == '' ) {
2816 $wgOut->showFatalError(
2819 array( 'class' => 'error mw-error-cannotdelete' ),
2820 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2823 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2824 LogEventsList
::showLogExtract(
2827 $this->mTitle
->getPrefixedText()
2830 $wgOut->showFatalError( $error );
2836 * Back-end article deletion
2837 * Deletes the article with database consistency, writes logs, purges caches
2840 public function doDeleteArticle( $reason, $suppress = false, $id = 0 ) {
2841 global $wgUseSquid, $wgDeferredUpdateList;
2842 global $wgUseTrackbacks;
2844 wfDebug( __METHOD__
."\n" );
2846 $dbw = wfGetDB( DB_MASTER
);
2847 $ns = $this->mTitle
->getNamespace();
2848 $t = $this->mTitle
->getDBkey();
2849 $id = $id ?
$id : $this->mTitle
->getArticleID( GAID_FOR_UPDATE
);
2851 if( $t == '' ||
$id == 0 ) {
2855 $u = new SiteStatsUpdate( 0, 1, -(int)$this->isCountable( $this->getRawText() ), -1 );
2856 array_push( $wgDeferredUpdateList, $u );
2858 // Bitfields to further suppress the content
2861 // This should be 15...
2862 $bitfield |
= Revision
::DELETED_TEXT
;
2863 $bitfield |
= Revision
::DELETED_COMMENT
;
2864 $bitfield |
= Revision
::DELETED_USER
;
2865 $bitfield |
= Revision
::DELETED_RESTRICTED
;
2867 $bitfield = 'rev_deleted';
2871 // For now, shunt the revision data into the archive table.
2872 // Text is *not* removed from the text table; bulk storage
2873 // is left intact to avoid breaking block-compression or
2874 // immutable storage schemes.
2876 // For backwards compatibility, note that some older archive
2877 // table entries will have ar_text and ar_flags fields still.
2879 // In the future, we may keep revisions and mark them with
2880 // the rev_deleted field, which is reserved for this purpose.
2881 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
2883 'ar_namespace' => 'page_namespace',
2884 'ar_title' => 'page_title',
2885 'ar_comment' => 'rev_comment',
2886 'ar_user' => 'rev_user',
2887 'ar_user_text' => 'rev_user_text',
2888 'ar_timestamp' => 'rev_timestamp',
2889 'ar_minor_edit' => 'rev_minor_edit',
2890 'ar_rev_id' => 'rev_id',
2891 'ar_text_id' => 'rev_text_id',
2892 'ar_text' => '\'\'', // Be explicit to appease
2893 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2894 'ar_len' => 'rev_len',
2895 'ar_page_id' => 'page_id',
2896 'ar_deleted' => $bitfield
2899 'page_id = rev_page'
2903 # Delete restrictions for it
2904 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
2906 # Now that it's safely backed up, delete it
2907 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
2908 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
2914 # Fix category table counts
2916 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
2917 foreach( $res as $row ) {
2918 $cats []= $row->cl_to
;
2920 $this->updateCategoryCounts( array(), $cats );
2922 # If using cascading deletes, we can skip some explicit deletes
2923 if( !$dbw->cascadingDeletes() ) {
2924 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
2926 if($wgUseTrackbacks)
2927 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
2929 # Delete outgoing links
2930 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
2931 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
2932 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
2933 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
2934 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
2935 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
2936 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
2939 # If using cleanup triggers, we can skip some manual deletes
2940 if( !$dbw->cleanupTriggers() ) {
2941 # Clean up recentchanges entries...
2942 $dbw->delete( 'recentchanges',
2943 array( 'rc_type != '.RC_LOG
,
2944 'rc_namespace' => $this->mTitle
->getNamespace(),
2945 'rc_title' => $this->mTitle
->getDBkey() ),
2947 $dbw->delete( 'recentchanges',
2948 array( 'rc_type != '.RC_LOG
, 'rc_cur_id' => $id ),
2953 Article
::onArticleDelete( $this->mTitle
);
2955 # Clear the cached article id so the interface doesn't act like we exist
2956 $this->mTitle
->resetArticleID( 0 );
2958 # Log the deletion, if the page was suppressed, log it at Oversight instead
2959 $logtype = $suppress ?
'suppress' : 'delete';
2960 $log = new LogPage( $logtype );
2962 # Make sure logging got through
2963 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
2971 * Roll back the most recent consecutive set of edits to a page
2972 * from the same user; fails if there are no eligible edits to
2973 * roll back to, e.g. user is the sole contributor. This function
2974 * performs permissions checks on $wgUser, then calls commitRollback()
2975 * to do the dirty work
2977 * @param $fromP String: Name of the user whose edits to rollback.
2978 * @param $summary String: Custom summary. Set to default summary if empty.
2979 * @param $token String: Rollback token.
2980 * @param $bot Boolean: If true, mark all reverted edits as bot.
2982 * @param $resultDetails Array: contains result-specific array of additional values
2983 * 'alreadyrolled' : 'current' (rev)
2984 * success : 'summary' (str), 'current' (rev), 'target' (rev)
2986 * @return array of errors, each error formatted as
2987 * array(messagekey, param1, param2, ...).
2988 * On success, the array is empty. This array can also be passed to
2989 * OutputPage::showPermissionsErrorPage().
2991 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
2993 $resultDetails = null;
2996 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
2997 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
2998 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3000 if( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) )
3001 $errors[] = array( 'sessionfailure' );
3003 if( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3004 $errors[] = array( 'actionthrottledtext' );
3006 # If there were errors, bail out now
3007 if( !empty( $errors ) )
3010 return $this->commitRollback($fromP, $summary, $bot, $resultDetails);
3014 * Backend implementation of doRollback(), please refer there for parameter
3015 * and return value documentation
3017 * NOTE: This function does NOT check ANY permissions, it just commits the
3018 * rollback to the DB Therefore, you should only call this function direct-
3019 * ly if you want to use custom permissions checks. If you don't, use
3020 * doRollback() instead.
3022 public function commitRollback($fromP, $summary, $bot, &$resultDetails) {
3023 global $wgUseRCPatrol, $wgUser, $wgLang;
3024 $dbw = wfGetDB( DB_MASTER
);
3026 if( wfReadOnly() ) {
3027 return array( array( 'readonlytext' ) );
3030 # Get the last editor
3031 $current = Revision
::newFromTitle( $this->mTitle
);
3032 if( is_null( $current ) ) {
3033 # Something wrong... no page?
3034 return array(array('notanarticle'));
3037 $from = str_replace( '_', ' ', $fromP );
3038 # User name given should match up with the top revision.
3039 # If the user was deleted then $from should be empty.
3040 if( $from != $current->getUserText() ) {
3041 $resultDetails = array( 'current' => $current );
3042 return array(array('alreadyrolled',
3043 htmlspecialchars($this->mTitle
->getPrefixedText()),
3044 htmlspecialchars($fromP),
3045 htmlspecialchars($current->getUserText())
3049 # Get the last edit not by this guy...
3050 # Note: these may not be public values
3051 $user = intval( $current->getRawUser() );
3052 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3053 $s = $dbw->selectRow( 'revision',
3054 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3055 array( 'rev_page' => $current->getPage(),
3056 "rev_user != {$user} OR rev_user_text != {$user_text}"
3058 array( 'USE INDEX' => 'page_timestamp',
3059 'ORDER BY' => 'rev_timestamp DESC' )
3061 if( $s === false ) {
3062 # No one else ever edited this page
3063 return array(array('cantrollback'));
3064 } else if( $s->rev_deleted
& REVISION
::DELETED_TEXT ||
$s->rev_deleted
& REVISION
::DELETED_USER
) {
3065 # Only admins can see this text
3066 return array(array('notvisiblerev'));
3070 if( $bot && $wgUser->isAllowed('markbotedits') ) {
3071 # Mark all reverted edits as bot
3074 if( $wgUseRCPatrol ) {
3075 # Mark all reverted edits as patrolled
3076 $set['rc_patrolled'] = 1;
3080 $dbw->update( 'recentchanges', $set,
3082 'rc_cur_id' => $current->getPage(),
3083 'rc_user_text' => $current->getUserText(),
3084 "rc_timestamp > '{$s->rev_timestamp}'",
3089 # Generate the edit summary if necessary
3090 $target = Revision
::newFromId( $s->rev_id
);
3091 if( empty( $summary ) ) {
3092 if( $from == '' ) { // no public user name
3093 $summary = wfMsgForContent( 'revertpage-nouser' );
3095 $summary = wfMsgForContent( 'revertpage' );
3099 # Allow the custom summary to use the same args as the default message
3101 $target->getUserText(), $from, $s->rev_id
,
3102 $wgLang->timeanddate(wfTimestamp(TS_MW
, $s->rev_timestamp
), true),
3103 $current->getId(), $wgLang->timeanddate($current->getTimestamp())
3105 $summary = wfMsgReplaceArgs( $summary, $args );
3108 $flags = EDIT_UPDATE
;
3110 if( $wgUser->isAllowed('minoredit') )
3111 $flags |
= EDIT_MINOR
;
3113 if( $bot && ($wgUser->isAllowed('markbotedits') ||
$wgUser->isAllowed('bot')) )
3114 $flags |
= EDIT_FORCE_BOT
;
3115 # Actually store the edit
3116 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3117 if( !empty( $status->value
['revision'] ) ) {
3118 $revId = $status->value
['revision']->getId();
3123 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3125 $resultDetails = array(
3126 'summary' => $summary,
3127 'current' => $current,
3128 'target' => $target,
3135 * User interface for rollback operations
3137 public function rollback() {
3138 global $wgUser, $wgOut, $wgRequest, $wgUseRCPatrol;
3141 $result = $this->doRollback(
3142 $wgRequest->getVal( 'from' ),
3143 $wgRequest->getText( 'summary' ),
3144 $wgRequest->getVal( 'token' ),
3145 $wgRequest->getBool( 'bot' ),
3149 if( in_array( array( 'actionthrottledtext' ), $result ) ) {
3150 $wgOut->rateLimited();
3153 if( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3154 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3155 $errArray = $result[0];
3156 $errMsg = array_shift( $errArray );
3157 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3158 if( isset( $details['current'] ) ){
3159 $current = $details['current'];
3160 if( $current->getComment() != '' ) {
3161 $wgOut->addWikiMsgArray( 'editcomment', array(
3162 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3167 # Display permissions errors before read-only message -- there's no
3168 # point in misleading the user into thinking the inability to rollback
3169 # is only temporary.
3170 if( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3171 # array_diff is completely broken for arrays of arrays, sigh. Re-
3172 # move any 'readonlytext' error manually.
3174 foreach( $result as $error ) {
3175 if( $error != array( 'readonlytext' ) ) {
3179 $wgOut->showPermissionsErrorPage( $out );
3182 if( $result == array( array( 'readonlytext' ) ) ) {
3183 $wgOut->readOnlyPage();
3187 $current = $details['current'];
3188 $target = $details['target'];
3189 $newId = $details['newid'];
3190 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3191 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3192 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3193 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3194 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3195 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3196 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3197 $wgOut->returnToMain( false, $this->mTitle
);
3199 if( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3200 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3201 $de->showDiff( '', '' );
3207 * Do standard deferred updates after page view
3209 public function viewUpdates() {
3210 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3211 if ( wfReadOnly() ) {
3214 # Don't update page view counters on views from bot users (bug 14044)
3215 if( !$wgDisableCounters && !$wgUser->isAllowed('bot') && $this->getID() ) {
3216 Article
::incViewCount( $this->getID() );
3217 $u = new SiteStatsUpdate( 1, 0, 0 );
3218 array_push( $wgDeferredUpdateList, $u );
3220 # Update newtalk / watchlist notification status
3221 $wgUser->clearNotification( $this->mTitle
);
3225 * Prepare text which is about to be saved.
3226 * Returns a stdclass with source, pst and output members
3228 public function prepareTextForEdit( $text, $revid=null ) {
3229 if( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid) {
3231 return $this->mPreparedEdit
;
3234 $edit = (object)array();
3235 $edit->revid
= $revid;
3236 $edit->newText
= $text;
3237 $edit->pst
= $this->preSaveTransform( $text );
3238 $options = $this->getParserOptions();
3239 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $options, true, true, $revid );
3240 $edit->oldText
= $this->getContent();
3241 $this->mPreparedEdit
= $edit;
3246 * Do standard deferred updates after page edit.
3247 * Update links tables, site stats, search index and message cache.
3248 * Purges pages that include this page if the text was changed here.
3249 * Every 100th edit, prune the recent changes table.
3252 * @param $text New text of the article
3253 * @param $summary Edit summary
3254 * @param $minoredit Minor edit
3255 * @param $timestamp_of_pagechange Timestamp associated with the page change
3256 * @param $newid rev_id value of the new revision
3257 * @param $changed Whether or not the content actually changed
3259 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true ) {
3260 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgParser, $wgEnableParserCache;
3262 wfProfileIn( __METHOD__
);
3265 # Be careful not to double-PST: $text is usually already PST-ed once
3266 if( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3267 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3268 $editInfo = $this->prepareTextForEdit( $text, $newid );
3270 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3271 $editInfo = $this->mPreparedEdit
;
3274 # Save it to the parser cache
3275 if( $wgEnableParserCache ) {
3276 $popts = $this->getParserOptions();
3277 $parserCache = ParserCache
::singleton();
3278 $parserCache->save( $editInfo->output
, $this, $popts );
3281 # Update the links tables
3282 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3285 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3287 if( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3288 if( 0 == mt_rand( 0, 99 ) ) {
3289 // Flush old entries from the `recentchanges` table; we do this on
3290 // random requests so as to avoid an increase in writes for no good reason
3292 $dbw = wfGetDB( DB_MASTER
);
3293 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3294 $recentchanges = $dbw->tableName( 'recentchanges' );
3295 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3296 $dbw->query( $sql );
3300 $id = $this->getID();
3301 $title = $this->mTitle
->getPrefixedDBkey();
3302 $shortTitle = $this->mTitle
->getDBkey();
3305 wfProfileOut( __METHOD__
);
3309 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3310 array_push( $wgDeferredUpdateList, $u );
3311 $u = new SearchUpdate( $id, $title, $text );
3312 array_push( $wgDeferredUpdateList, $u );
3314 # If this is another user's talk page, update newtalk
3315 # Don't do this if $changed = false otherwise some idiot can null-edit a
3316 # load of user talk pages and piss people off, nor if it's a minor edit
3317 # by a properly-flagged bot.
3318 if( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3319 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) ) ) {
3320 if( wfRunHooks('ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3321 $other = User
::newFromName( $shortTitle, false );
3323 wfDebug( __METHOD__
.": invalid username\n" );
3324 } elseif( User
::isIP( $shortTitle ) ) {
3325 // An anonymous user
3326 $other->setNewtalk( true );
3327 } elseif( $other->isLoggedIn() ) {
3328 $other->setNewtalk( true );
3330 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3335 if( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3336 $wgMessageCache->replace( $shortTitle, $text );
3339 wfProfileOut( __METHOD__
);
3343 * Perform article updates on a special page creation.
3345 * @param $rev Revision object
3347 * @todo This is a shitty interface function. Kill it and replace the
3348 * other shitty functions like editUpdates and such so it's not needed
3351 public function createUpdates( $rev ) {
3352 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3353 $this->mTotalAdjustment
= 1;
3354 $this->editUpdates( $rev->getText(), $rev->getComment(),
3355 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3359 * Generate the navigation links when browsing through an article revisions
3360 * It shows the information as:
3361 * Revision as of \<date\>; view current revision
3362 * \<- Previous version | Next Version -\>
3364 * @param $oldid String: revision ID of this article revision
3366 public function setOldSubtitle( $oldid = 0 ) {
3367 global $wgLang, $wgOut, $wgUser, $wgRequest;
3369 if( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3373 $revision = Revision
::newFromId( $oldid );
3375 $current = ( $oldid == $this->mLatest
);
3376 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3377 $tddate = $wgLang->date( $this->mTimestamp
, true );
3378 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3379 $sk = $wgUser->getSkin();
3381 ?
wfMsgHtml( 'currentrevisionlink' )
3384 wfMsgHtml( 'currentrevisionlink' ),
3387 array( 'known', 'noclasses' )
3390 ?
wfMsgHtml( 'diff' )
3393 wfMsgHtml( 'diff' ),
3399 array( 'known', 'noclasses' )
3401 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3405 wfMsgHtml( 'previousrevision' ),
3408 'direction' => 'prev',
3411 array( 'known', 'noclasses' )
3413 : wfMsgHtml( 'previousrevision' );
3417 wfMsgHtml( 'diff' ),
3423 array( 'known', 'noclasses' )
3425 : wfMsgHtml( 'diff' );
3426 $nextlink = $current
3427 ?
wfMsgHtml( 'nextrevision' )
3430 wfMsgHtml( 'nextrevision' ),
3433 'direction' => 'next',
3436 array( 'known', 'noclasses' )
3438 $nextdiff = $current
3439 ?
wfMsgHtml( 'diff' )
3442 wfMsgHtml( 'diff' ),
3448 array( 'known', 'noclasses' )
3452 // Don't show useless link to people who cannot hide revisions
3453 if( $wgUser->isAllowed('deleterevision') ||
($revision->getVisibility() && $wgUser->isAllowed('deletedhistory')) ) {
3454 if( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3455 // If revision was hidden from sysops
3456 $cdel = wfMsgHtml( 'rev-delundel' );
3459 SpecialPage
::getTitleFor( 'Revisiondelete' ),
3460 wfMsgHtml('rev-delundel'),
3463 'type' => 'revision',
3464 'target' => urlencode( $this->mTitle
->getPrefixedDbkey() ),
3465 'ids' => urlencode( $oldid )
3467 array( 'known', 'noclasses' )
3469 // Bolden oversighted content
3470 if( $revision->isDeleted( Revision
::DELETED_RESTRICTED
) )
3471 $cdel = "<strong>$cdel</strong>";
3473 $cdel = "(<small>$cdel</small>) ";
3475 $unhide = $wgRequest->getInt('unhide') == 1 && $wgUser->matchEditToken( $wgRequest->getVal('token'), $oldid );
3476 # Show user links if allowed to see them. If hidden, then show them only if requested...
3477 $userlinks = $sk->revUserTools( $revision, !$unhide );
3479 $m = wfMsg( 'revision-info-current' );
3480 $infomsg = $current && !wfEmptyMsg( 'revision-info-current', $m ) && $m != '-'
3481 ?
'revision-info-current'
3484 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3487 array( 'parseinline', 'replaceafter' ),
3493 $revision->getUser()
3496 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3497 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3498 $wgOut->setSubtitle( $r );
3502 * This function is called right before saving the wikitext,
3503 * so we can do things like signatures and links-in-context.
3505 * @param $text String
3507 public function preSaveTransform( $text ) {
3508 global $wgParser, $wgUser;
3509 return $wgParser->preSaveTransform( $text, $this->mTitle
, $wgUser, ParserOptions
::newFromUser( $wgUser ) );
3512 /* Caching functions */
3515 * checkLastModified returns true if it has taken care of all
3516 * output to the client that is necessary for this request.
3517 * (that is, it has sent a cached version of the page)
3519 protected function tryFileCache() {
3520 static $called = false;
3522 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3526 if( $this->isFileCacheable() ) {
3527 $cache = new HTMLFileCache( $this->mTitle
);
3528 if( $cache->isFileCacheGood( $this->mTouched
) ) {
3529 wfDebug( "Article::tryFileCache(): about to load file\n" );
3530 $cache->loadFromFileCache();
3533 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3534 ob_start( array(&$cache, 'saveToFileCache' ) );
3537 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3543 * Check if the page can be cached
3546 public function isFileCacheable() {
3548 if( HTMLFileCache
::useFileCache() ) {
3549 $cacheable = $this->getID() && !$this->mRedirectedFrom
;
3550 // Extension may have reason to disable file caching on some pages.
3552 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3559 * Loads page_touched and returns a value indicating if it should be used
3562 public function checkTouched() {
3563 if( !$this->mDataLoaded
) {
3564 $this->loadPageData();
3566 return !$this->mIsRedirect
;
3570 * Get the page_touched field
3572 public function getTouched() {
3573 # Ensure that page data has been loaded
3574 if( !$this->mDataLoaded
) {
3575 $this->loadPageData();
3577 return $this->mTouched
;
3581 * Get the page_latest field
3583 public function getLatest() {
3584 if( !$this->mDataLoaded
) {
3585 $this->loadPageData();
3587 return (int)$this->mLatest
;
3591 * Edit an article without doing all that other stuff
3592 * The article must already exist; link tables etc
3593 * are not updated, caches are not flushed.
3595 * @param $text String: text submitted
3596 * @param $comment String: comment submitted
3597 * @param $minor Boolean: whereas it's a minor modification
3599 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3600 wfProfileIn( __METHOD__
);
3602 $dbw = wfGetDB( DB_MASTER
);
3603 $revision = new Revision( array(
3604 'page' => $this->getId(),
3606 'comment' => $comment,
3607 'minor_edit' => $minor ?
1 : 0,
3609 $revision->insertOn( $dbw );
3610 $this->updateRevisionOn( $dbw, $revision );
3612 wfRunHooks( 'NewRevisionFromEditComplete', array($this, $revision, false, $wgUser) );
3614 wfProfileOut( __METHOD__
);
3618 * Used to increment the view counter
3620 * @param $id Integer: article id
3622 public static function incViewCount( $id ) {
3623 $id = intval( $id );
3624 global $wgHitcounterUpdateFreq, $wgDBtype;
3626 $dbw = wfGetDB( DB_MASTER
);
3627 $pageTable = $dbw->tableName( 'page' );
3628 $hitcounterTable = $dbw->tableName( 'hitcounter' );
3629 $acchitsTable = $dbw->tableName( 'acchits' );
3631 if( $wgHitcounterUpdateFreq <= 1 ) {
3632 $dbw->query( "UPDATE $pageTable SET page_counter = page_counter + 1 WHERE page_id = $id" );
3636 # Not important enough to warrant an error page in case of failure
3637 $oldignore = $dbw->ignoreErrors( true );
3639 $dbw->query( "INSERT INTO $hitcounterTable (hc_id) VALUES ({$id})" );
3641 $checkfreq = intval( $wgHitcounterUpdateFreq/25 +
1 );
3642 if( (rand() %
$checkfreq != 0) or ($dbw->lastErrno() != 0) ){
3643 # Most of the time (or on SQL errors), skip row count check
3644 $dbw->ignoreErrors( $oldignore );
3648 $res = $dbw->query("SELECT COUNT(*) as n FROM $hitcounterTable");
3649 $row = $dbw->fetchObject( $res );
3650 $rown = intval( $row->n
);
3651 if( $rown >= $wgHitcounterUpdateFreq ){
3652 wfProfileIn( 'Article::incViewCount-collect' );
3653 $old_user_abort = ignore_user_abort( true );
3655 if($wgDBtype == 'mysql')
3656 $dbw->query("LOCK TABLES $hitcounterTable WRITE");
3657 $tabletype = $wgDBtype == 'mysql' ?
"ENGINE=HEAP " : '';
3658 $dbw->query("CREATE TEMPORARY TABLE $acchitsTable $tabletype AS ".
3659 "SELECT hc_id,COUNT(*) AS hc_n FROM $hitcounterTable ".
3661 $dbw->query("DELETE FROM $hitcounterTable");
3662 if($wgDBtype == 'mysql') {
3663 $dbw->query('UNLOCK TABLES');
3664 $dbw->query("UPDATE $pageTable,$acchitsTable SET page_counter=page_counter + hc_n ".
3665 'WHERE page_id = hc_id');
3668 $dbw->query("UPDATE $pageTable SET page_counter=page_counter + hc_n ".
3669 "FROM $acchitsTable WHERE page_id = hc_id");
3671 $dbw->query("DROP TABLE $acchitsTable");
3673 ignore_user_abort( $old_user_abort );
3674 wfProfileOut( 'Article::incViewCount-collect' );
3676 $dbw->ignoreErrors( $oldignore );
3680 * The onArticle*() functions are supposed to be a kind of hooks
3681 * which should be called whenever any of the specified actions
3684 * This is a good place to put code to clear caches, for instance.
3686 * This is called on page move and undelete, as well as edit
3688 * @param $title a title object
3691 public static function onArticleCreate( $title ) {
3692 # Update existence markers on article/talk tabs...
3693 if( $title->isTalkPage() ) {
3694 $other = $title->getSubjectPage();
3696 $other = $title->getTalkPage();
3698 $other->invalidateCache();
3699 $other->purgeSquid();
3701 $title->touchLinks();
3702 $title->purgeSquid();
3703 $title->deleteTitleProtection();
3706 public static function onArticleDelete( $title ) {
3707 global $wgMessageCache;
3708 # Update existence markers on article/talk tabs...
3709 if( $title->isTalkPage() ) {
3710 $other = $title->getSubjectPage();
3712 $other = $title->getTalkPage();
3714 $other->invalidateCache();
3715 $other->purgeSquid();
3717 $title->touchLinks();
3718 $title->purgeSquid();
3721 HTMLFileCache
::clearFileCache( $title );
3724 if( $title->getNamespace() == NS_MEDIAWIKI
) {
3725 $wgMessageCache->replace( $title->getDBkey(), false );
3728 if( $title->getNamespace() == NS_FILE
) {
3729 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
3730 $update->doUpdate();
3733 if( $title->getNamespace() == NS_USER_TALK
) {
3734 $user = User
::newFromName( $title->getText(), false );
3735 $user->setNewtalk( false );
3738 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3742 * Purge caches on page update etc
3744 public static function onArticleEdit( $title, $flags = '' ) {
3745 global $wgDeferredUpdateList;
3747 // Invalidate caches of articles which include this page
3748 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
3750 // Invalidate the caches of all pages which redirect here
3751 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
3753 # Purge squid for this page only
3754 $title->purgeSquid();
3756 # Clear file cache for this page only
3757 HTMLFileCache
::clearFileCache( $title );
3763 * Overriden by ImagePage class, only present here to avoid a fatal error
3764 * Called for ?action=revert
3766 public function revert() {
3768 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
3772 * Info about this page
3773 * Called for ?action=info when $wgAllowPageInfo is on.
3775 public function info() {
3776 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
3778 if( !$wgAllowPageInfo ) {
3779 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
3783 $page = $this->mTitle
->getSubjectPage();
3785 $wgOut->setPagetitle( $page->getPrefixedText() );
3786 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
3787 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
3789 if( !$this->mTitle
->exists() ) {
3790 $wgOut->addHTML( '<div class="noarticletext">' );
3791 if( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3792 // This doesn't quite make sense; the user is asking for
3793 // information about the _page_, not the message... -- RC
3794 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
3796 $msg = $wgUser->isLoggedIn()
3798 : 'noarticletextanon';
3799 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
3801 $wgOut->addHTML( '</div>' );
3803 $dbr = wfGetDB( DB_SLAVE
);
3805 'wl_title' => $page->getDBkey(),
3806 'wl_namespace' => $page->getNamespace() );
3807 $numwatchers = $dbr->selectField(
3812 $this->getSelectOptions() );
3814 $pageInfo = $this->pageCountInfo( $page );
3815 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
3817 $wgOut->addHTML( "<ul><li>" . wfMsg("numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
3818 $wgOut->addHTML( "<li>" . wfMsg('numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>');
3820 $wgOut->addHTML( '<li>' . wfMsg("numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>');
3822 $wgOut->addHTML( '<li>' . wfMsg("numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
3824 $wgOut->addHTML( '<li>' . wfMsg('numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
3826 $wgOut->addHTML( '</ul>' );
3831 * Return the total number of edits and number of unique editors
3832 * on a given page. If page does not exist, returns false.
3834 * @param $title Title object
3837 public function pageCountInfo( $title ) {
3838 $id = $title->getArticleId();
3842 $dbr = wfGetDB( DB_SLAVE
);
3843 $rev_clause = array( 'rev_page' => $id );
3844 $edits = $dbr->selectField(
3849 $this->getSelectOptions()
3851 $authors = $dbr->selectField(
3853 'COUNT(DISTINCT rev_user_text)',
3856 $this->getSelectOptions()
3858 return array( 'edits' => $edits, 'authors' => $authors );
3862 * Return a list of templates used by this article.
3863 * Uses the templatelinks table
3865 * @return Array of Title objects
3867 public function getUsedTemplates() {
3869 $id = $this->mTitle
->getArticleID();
3873 $dbr = wfGetDB( DB_SLAVE
);
3874 $res = $dbr->select( array( 'templatelinks' ),
3875 array( 'tl_namespace', 'tl_title' ),
3876 array( 'tl_from' => $id ),
3878 if( $res !== false ) {
3879 foreach( $res as $row ) {
3880 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
3883 $dbr->freeResult( $res );
3888 * Returns a list of hidden categories this page is a member of.
3889 * Uses the page_props and categorylinks tables.
3891 * @return Array of Title objects
3893 public function getHiddenCategories() {
3895 $id = $this->mTitle
->getArticleID();
3899 $dbr = wfGetDB( DB_SLAVE
);
3900 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3902 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3903 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to'),
3905 if( $res !== false ) {
3906 foreach( $res as $row ) {
3907 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3910 $dbr->freeResult( $res );
3915 * Return an applicable autosummary if one exists for the given edit.
3916 * @param $oldtext String: the previous text of the page.
3917 * @param $newtext String: The submitted text of the page.
3918 * @param $flags Bitmask: a bitmask of flags submitted for the edit.
3919 * @return string An appropriate autosummary, or an empty string.
3921 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3922 # Decide what kind of autosummary is needed.
3924 # Redirect autosummaries
3925 $ot = Title
::newFromRedirect( $oldtext );
3926 $rt = Title
::newFromRedirect( $newtext );
3927 if( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
3928 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
3931 # New page autosummaries
3932 if( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
3933 # If they're making a new article, give its text, truncated, in the summary.
3935 $truncatedtext = $wgContLang->truncate(
3936 str_replace("\n", ' ', $newtext),
3937 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
3938 return wfMsgForContent( 'autosumm-new', $truncatedtext );
3941 # Blanking autosummaries
3942 if( $oldtext != '' && $newtext == '' ) {
3943 return wfMsgForContent( 'autosumm-blank' );
3944 } elseif( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500) {
3945 # Removing more than 90% of the article
3947 $truncatedtext = $wgContLang->truncate(
3949 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
3950 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
3953 # If we reach this point, there's no applicable autosummary for our case, so our
3954 # autosummary is empty.
3959 * Add the primary page-view wikitext to the output buffer
3960 * Saves the text into the parser cache if possible.
3961 * Updates templatelinks if it is out of date.
3963 * @param $text String
3964 * @param $cache Boolean
3966 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
3969 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
3970 $wgOut->addParserOutput( $this->mParserOutput
);
3974 * This does all the heavy lifting for outputWikitext, except it returns the parser
3975 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
3976 * say, embedding thread pages within a discussion system (LiquidThreads)
3978 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
3979 global $wgParser, $wgOut, $wgEnableParserCache, $wgUseFileCache;
3981 if ( !$parserOptions ) {
3982 $parserOptions = $this->getParserOptions();
3986 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
3987 $parserOptions, true, true, $this->getRevIdFetched() );
3992 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
3993 $this->mTitle
->getPrefixedDBkey()));
3996 if( $wgEnableParserCache && $cache && $this && $this->mParserOutput
->getCacheTime() != -1 ) {
3997 $parserCache = ParserCache
::singleton();
3998 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4000 // Make sure file cache is not used on uncacheable content.
4001 // Output that has magic words in it can still use the parser cache
4002 // (if enabled), though it will generally expire sooner.
4003 if( $this->mParserOutput
->getCacheTime() == -1 ||
$this->mParserOutput
->containsOldMagic() ) {
4004 $wgUseFileCache = false;
4006 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4007 return $this->mParserOutput
;
4011 * Get parser options suitable for rendering the primary article wikitext
4013 public function getParserOptions() {
4015 if ( !$this->mParserOptions
) {
4016 $this->mParserOptions
= new ParserOptions( $wgUser );
4017 $this->mParserOptions
->setTidy( true );
4018 $this->mParserOptions
->enableLimitReport();
4020 return $this->mParserOptions
;
4023 protected function doCascadeProtectionUpdates( $parserOutput ) {
4024 if( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4028 // templatelinks table may have become out of sync,
4029 // especially if using variable-based transclusions.
4030 // For paranoia, check if things have changed and if
4031 // so apply updates to the database. This will ensure
4032 // that cascaded protections apply as soon as the changes
4035 # Get templates from templatelinks
4036 $id = $this->mTitle
->getArticleID();
4038 $tlTemplates = array();
4040 $dbr = wfGetDB( DB_SLAVE
);
4041 $res = $dbr->select( array( 'templatelinks' ),
4042 array( 'tl_namespace', 'tl_title' ),
4043 array( 'tl_from' => $id ),
4047 foreach( $res as $row ) {
4048 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4051 # Get templates from parser output.
4052 $poTemplates = array();
4053 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4054 foreach ( $templates as $dbk => $id ) {
4055 $poTemplates["$ns:$dbk"] = true;
4060 # Note that we simulate array_diff_key in PHP <5.0.x
4061 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4063 if( count( $templates_diff ) > 0 ) {
4064 # Whee, link updates time.
4065 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4071 * Update all the appropriate counts in the category table, given that
4072 * we've added the categories $added and deleted the categories $deleted.
4074 * @param $added array The names of categories that were added
4075 * @param $deleted array The names of categories that were deleted
4078 public function updateCategoryCounts( $added, $deleted ) {
4079 $ns = $this->mTitle
->getNamespace();
4080 $dbw = wfGetDB( DB_MASTER
);
4082 # First make sure the rows exist. If one of the "deleted" ones didn't
4083 # exist, we might legitimately not create it, but it's simpler to just
4084 # create it and then give it a negative value, since the value is bogus
4087 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4088 $insertCats = array_merge( $added, $deleted );
4089 if( !$insertCats ) {
4090 # Okay, nothing to do
4093 $insertRows = array();
4094 foreach( $insertCats as $cat ) {
4095 $insertRows[] = array( 'cat_id' => $dbw->nextSequenceValue( 'category_id_seq' ),
4096 'cat_title' => $cat );
4098 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4100 $addFields = array( 'cat_pages = cat_pages + 1' );
4101 $removeFields = array( 'cat_pages = cat_pages - 1' );
4102 if( $ns == NS_CATEGORY
) {
4103 $addFields[] = 'cat_subcats = cat_subcats + 1';
4104 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4105 } elseif( $ns == NS_FILE
) {
4106 $addFields[] = 'cat_files = cat_files + 1';
4107 $removeFields[] = 'cat_files = cat_files - 1';
4114 array( 'cat_title' => $added ),
4122 array( 'cat_title' => $deleted ),
4128 /** Lightweight method to get the parser output for a page, checking the parser cache
4129 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4130 * consider, so it's not appropriate to use there. */
4131 function getParserOutput( $oldid = null ) {
4132 global $wgEnableParserCache, $wgUser, $wgOut;
4134 // Should the parser cache be used?
4135 $useParserCache = $wgEnableParserCache &&
4136 intval( $wgUser->getOption( 'stubthreshold' ) ) == 0 &&
4140 wfDebug( __METHOD__
.': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4141 if ( $wgUser->getOption( 'stubthreshold' ) ) {
4142 wfIncrStats( 'pcache_miss_stub' );
4145 $parserOutput = false;
4146 if ( $useParserCache ) {
4147 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4150 if ( $parserOutput === false ) {
4151 // Cache miss; parse and output it.
4152 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4154 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4156 return $parserOutput;