8 * Class representing a MediaWiki article and history.
10 * See design.txt for an overview.
11 * Note: edit user interface and cache support functions have been
12 * moved to separate EditPage and HTMLFileCache classes.
14 * @internal documentation reviewed 15 Mar 2010
20 var $mComment = ''; // !<
22 var $mContentLoaded = false; // !<
23 var $mCounter = -1; // !< Not loaded
24 var $mCurID = -1; // !< Not loaded
25 var $mDataLoaded = false; // !<
26 var $mForUpdate = false; // !<
27 var $mGoodAdjustment = 0; // !<
28 var $mIsRedirect = false; // !<
29 var $mLatest = false; // !<
30 var $mMinorEdit; // !<
32 var $mPreparedEdit = false; // !< Title object if set
33 var $mRedirectedFrom = null; // !< Title object if set
34 var $mRedirectTarget = null; // !< Title object if set
35 var $mRedirectUrl = false; // !<
36 var $mRevIdFetched = 0; // !<
37 var $mRevision; // !< Revision object if set
38 var $mTimestamp = ''; // !<
39 var $mTitle; // !< Title object
40 var $mTotalAdjustment = 0; // !<
41 var $mTouched = '19700101000000'; // !<
42 var $mUser = -1; // !< Not loaded
43 var $mUserText = ''; // !< username from Revision if set
44 var $mParserOptions; // !< ParserOptions object for $wgUser articles
45 var $mParserOutput; // !< ParserCache object if set
49 * Constructor and clear the article
50 * @param $title Reference to a Title object.
51 * @param $oldId Integer revision ID, null to fetch from request, zero for current
53 public function __construct( Title
$title, $oldId = null ) {
54 // FIXME: does the reference play any role here?
55 $this->mTitle
=& $title;
56 $this->mOldId
= $oldId;
60 * Constructor from an page id
61 * @param $id Int article ID to load
63 public static function newFromID( $id ) {
64 $t = Title
::newFromID( $id );
65 # FIXME: doesn't inherit right
66 return $t == null ?
null : new self( $t );
67 # return $t == null ? null : new static( $t ); // PHP 5.3
71 * Tell the page view functions that this view was redirected
72 * from another page on the wiki.
73 * @param $from Title object.
75 public function setRedirectedFrom( Title
$from ) {
76 $this->mRedirectedFrom
= $from;
80 * If this page is a redirect, get its target
82 * The target will be fetched from the redirect table if possible.
83 * If this page doesn't have an entry there, call insertRedirect()
84 * @return mixed Title object, or null if this page is not a redirect
86 public function getRedirectTarget() {
87 if ( !$this->mTitle
->isRedirect() ) {
91 if ( $this->mRedirectTarget
!== null ) {
92 return $this->mRedirectTarget
;
95 # Query the redirect table
96 $dbr = wfGetDB( DB_SLAVE
);
97 $row = $dbr->selectRow( 'redirect',
98 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
99 array( 'rd_from' => $this->getID() ),
103 // rd_fragment and rd_interwiki were added later, populate them if empty
104 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
105 return $this->mRedirectTarget
= Title
::makeTitle(
106 $row->rd_namespace
, $row->rd_title
,
107 $row->rd_fragment
, $row->rd_interwiki
);
110 # This page doesn't have an entry in the redirect table
111 return $this->mRedirectTarget
= $this->insertRedirect();
115 * Insert an entry for this page into the redirect table.
117 * Don't call this function directly unless you know what you're doing.
118 * @return Title object or null if not a redirect
120 public function insertRedirect() {
121 // recurse through to only get the final target
122 $retval = Title
::newFromRedirectRecurse( $this->getContent() );
126 $this->insertRedirectEntry( $retval );
131 * Insert or update the redirect table entry for this page to indicate
132 * it redirects to $rt .
133 * @param $rt Title redirect target
135 public function insertRedirectEntry( $rt ) {
136 $dbw = wfGetDB( DB_MASTER
);
137 $dbw->replace( 'redirect', array( 'rd_from' ),
139 'rd_from' => $this->getID(),
140 'rd_namespace' => $rt->getNamespace(),
141 'rd_title' => $rt->getDBkey(),
142 'rd_fragment' => $rt->getFragment(),
143 'rd_interwiki' => $rt->getInterwiki(),
150 * Get the Title object or URL this page redirects to
152 * @return mixed false, Title of in-wiki target, or string with URL
154 public function followRedirect() {
155 return $this->getRedirectURL( $this->getRedirectTarget() );
159 * Get the Title object this text redirects to
161 * @param $text string article content containing redirect info
162 * @return mixed false, Title of in-wiki target, or string with URL
163 * @deprecated @since 1.17
165 public function followRedirectText( $text ) {
166 // recurse through to only get the final target
167 return $this->getRedirectURL( Title
::newFromRedirectRecurse( $text ) );
171 * Get the Title object or URL to use for a redirect. We use Title
172 * objects for same-wiki, non-special redirects and URLs for everything
174 * @param $rt Title Redirect target
175 * @return mixed false, Title object of local target, or string with URL
177 public function getRedirectURL( $rt ) {
179 if ( $rt->getInterwiki() != '' ) {
180 if ( $rt->isLocal() ) {
181 // Offsite wikis need an HTTP redirect.
183 // This can be hard to reverse and may produce loops,
184 // so they may be disabled in the site configuration.
185 $source = $this->mTitle
->getFullURL( 'redirect=no' );
186 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
189 if ( $rt->getNamespace() == NS_SPECIAL
) {
190 // Gotta handle redirects to special pages differently:
191 // Fill the HTTP response "Location" header and ignore
192 // the rest of the page we're on.
194 // This can be hard to reverse, so they may be disabled.
195 if ( $rt->isSpecial( 'Userlogout' ) ) {
198 return $rt->getFullURL();
206 // No or invalid redirect
211 * Get the title object of the article
212 * @return Title object of this page
214 public function getTitle() {
215 return $this->mTitle
;
220 * FIXME: shouldn't this be public?
223 public function clear() {
224 $this->mDataLoaded
= false;
225 $this->mContentLoaded
= false;
227 $this->mCurID
= $this->mUser
= $this->mCounter
= -1; # Not loaded
228 $this->mRedirectedFrom
= null; # Title object if set
229 $this->mRedirectTarget
= null; # Title object if set
231 $this->mTimestamp
= $this->mComment
= '';
232 $this->mGoodAdjustment
= $this->mTotalAdjustment
= 0;
233 $this->mTouched
= '19700101000000';
234 $this->mForUpdate
= false;
235 $this->mIsRedirect
= false;
236 $this->mRevIdFetched
= 0;
237 $this->mRedirectUrl
= false;
238 $this->mLatest
= false;
239 $this->mPreparedEdit
= false;
243 * Note that getContent/loadContent do not follow redirects anymore.
244 * If you need to fetch redirectable content easily, try
245 * the shortcut in Article::followRedirect()
247 * This function has side effects! Do not use this function if you
248 * only want the real revision text if any.
250 * @return Return the text of this revision
252 public function getContent() {
253 global $wgUser, $wgContLang, $wgMessageCache;
255 wfProfileIn( __METHOD__
);
257 if ( $this->getID() === 0 ) {
258 # If this is a MediaWiki:x message, then load the messages
259 # and return the message value for x.
260 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
261 # If this is a system message, get the default text.
262 list( $message, $lang ) = $wgMessageCache->figureMessage( $wgContLang->lcfirst( $this->mTitle
->getText() ) );
263 $text = wfMsgGetKey( $message, false, $lang, false );
265 if ( wfEmptyMsg( $message, $text ) )
268 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
270 wfProfileOut( __METHOD__
);
274 $this->loadContent();
275 wfProfileOut( __METHOD__
);
277 return $this->mContent
;
282 * Get the text of the current revision. No side-effects...
284 * @return Return the text of the current revision
286 public function getRawText() {
287 // Check process cache for current revision
288 if ( $this->mContentLoaded
&& $this->mOldId
== 0 ) {
289 return $this->mContent
;
292 $rev = Revision
::newFromTitle( $this->mTitle
);
293 $text = $rev ?
$rev->getRawText() : false;
299 * This function returns the text of a section, specified by a number ($section).
300 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
301 * the first section before any such heading (section 0).
303 * If a section contains subsections, these are also returned.
305 * @param $text String: text to look in
306 * @param $section Integer: section number
307 * @return string text of the requested section
310 public function getSection( $text, $section ) {
312 return $wgParser->getSection( $text, $section );
316 * Get the text that needs to be saved in order to undo all revisions
317 * between $undo and $undoafter. Revisions must belong to the same page,
318 * must exist and must not be deleted
319 * @param $undo Revision
320 * @param $undoafter Revision Must be an earlier revision than $undo
321 * @return mixed string on success, false on failure
323 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
324 $currentRev = Revision
::newFromTitle( $this->mTitle
);
325 if ( !$currentRev ) {
326 return false; // no page
328 $undo_text = $undo->getText();
329 $undoafter_text = $undoafter->getText();
330 $cur_text = $currentRev->getText();
332 if ( $cur_text == $undo_text ) {
333 # No use doing a merge if it's just a straight revert.
334 return $undoafter_text;
339 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
347 * @return int The oldid of the article that is to be shown, 0 for the
350 public function getOldID() {
351 if ( is_null( $this->mOldId
) ) {
352 $this->mOldId
= $this->getOldIDFromRequest();
355 return $this->mOldId
;
359 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
361 * @return int The old id for the request
363 public function getOldIDFromRequest() {
366 $this->mRedirectUrl
= false;
368 $oldid = $wgRequest->getVal( 'oldid' );
370 if ( isset( $oldid ) ) {
371 $oldid = intval( $oldid );
372 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
373 $nextid = $this->mTitle
->getNextRevisionID( $oldid );
377 $this->mRedirectUrl
= $this->mTitle
->getFullURL( 'redirect=no' );
379 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
380 $previd = $this->mTitle
->getPreviousRevisionID( $oldid );
395 * Load the revision (including text) into this object
397 function loadContent() {
398 if ( $this->mContentLoaded
) {
402 wfProfileIn( __METHOD__
);
404 $this->fetchContent( $this->getOldID() );
406 wfProfileOut( __METHOD__
);
410 * Fetch a page record with the given conditions
411 * @param $dbr Database object
412 * @param $conditions Array
413 * @return mixed Database result resource, or false on failure
415 protected function pageData( $dbr, $conditions ) {
430 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
432 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
);
434 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
440 * Fetch a page record matching the Title object's namespace and title
441 * using a sanitized title string
443 * @param $dbr Database object
444 * @param $title Title object
445 * @return mixed Database result resource, or false on failure
447 public function pageDataFromTitle( $dbr, $title ) {
448 return $this->pageData( $dbr, array(
449 'page_namespace' => $title->getNamespace(),
450 'page_title' => $title->getDBkey() ) );
454 * Fetch a page record matching the requested ID
456 * @param $dbr Database
459 protected function pageDataFromId( $dbr, $id ) {
460 return $this->pageData( $dbr, array( 'page_id' => $id ) );
464 * Set the general counter, title etc data loaded from
467 * @param $data Database row object or "fromdb"
469 public function loadPageData( $data = 'fromdb' ) {
470 if ( $data === 'fromdb' ) {
471 $dbr = wfGetDB( DB_SLAVE
);
472 $data = $this->pageDataFromTitle( $dbr, $this->mTitle
);
475 $lc = LinkCache
::singleton();
478 $lc->addGoodLinkObj( $data->page_id
, $this->mTitle
, $data->page_len
, $data->page_is_redirect
, $data->page_latest
);
480 $this->mTitle
->mArticleID
= intval( $data->page_id
);
482 # Old-fashioned restrictions
483 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
485 $this->mCounter
= intval( $data->page_counter
);
486 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
487 $this->mIsRedirect
= intval( $data->page_is_redirect
);
488 $this->mLatest
= intval( $data->page_latest
);
490 $lc->addBadLinkObj( $this->mTitle
);
491 $this->mTitle
->mArticleID
= 0;
494 $this->mDataLoaded
= true;
498 * Get text of an article from database
499 * Does *NOT* follow redirects.
501 * @param $oldid Int: 0 for whatever the latest revision is
502 * @return mixed string containing article contents, or false if null
504 function fetchContent( $oldid = 0 ) {
505 if ( $this->mContentLoaded
) {
506 return $this->mContent
;
509 # Pre-fill content with error message so that if something
510 # fails we'll have something telling us what we intended.
511 $t = $this->mTitle
->getPrefixedText();
512 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
513 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
516 $revision = Revision
::newFromId( $oldid );
517 if ( $revision === null ) {
518 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
522 if ( !$this->mDataLoaded ||
$this->getID() != $revision->getPage() ) {
523 $data = $this->pageDataFromId( wfGetDB( DB_SLAVE
), $revision->getPage() );
526 wfDebug( __METHOD__
. " failed to get page data linked to revision id $oldid\n" );
530 $this->mTitle
= Title
::makeTitle( $data->page_namespace
, $data->page_title
);
531 $this->loadPageData( $data );
534 if ( !$this->mDataLoaded
) {
535 $this->loadPageData();
538 if ( $this->mLatest
=== false ) {
539 wfDebug( __METHOD__
. " failed to find page data for title " . $this->mTitle
->getPrefixedText() . "\n" );
543 $revision = Revision
::newFromId( $this->mLatest
);
544 if ( $revision === null ) {
545 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id {$this->mLatest}\n" );
550 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
551 // We should instead work with the Revision object when we need it...
552 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
554 $this->mUser
= $revision->getUser();
555 $this->mUserText
= $revision->getUserText();
556 $this->mComment
= $revision->getComment();
557 $this->mTimestamp
= wfTimestamp( TS_MW
, $revision->getTimestamp() );
559 $this->mRevIdFetched
= $revision->getId();
560 $this->mContentLoaded
= true;
561 $this->mRevision
=& $revision;
563 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) );
565 return $this->mContent
;
569 * Read/write accessor to select FOR UPDATE
571 * @param $x Mixed: FIXME
572 * @return mixed value of $x, or value stored in Article::mForUpdate
574 public function forUpdate( $x = null ) {
575 return wfSetVar( $this->mForUpdate
, $x );
579 * Get options for all SELECT statements
581 * @param $options Array: an optional options array which'll be appended to
583 * @return Array: options
585 protected function getSelectOptions( $options = '' ) {
586 if ( $this->mForUpdate
) {
587 if ( is_array( $options ) ) {
588 $options[] = 'FOR UPDATE';
590 $options = 'FOR UPDATE';
598 * @return int Page ID
600 public function getID() {
601 return $this->mTitle
->getArticleID();
605 * @return bool Whether or not the page exists in the database
607 public function exists() {
608 return $this->getId() > 0;
612 * Check if this page is something we're going to be showing
613 * some sort of sensible content for. If we return false, page
614 * views (plain action=view) will return an HTTP 404 response,
615 * so spiders and robots can know they're following a bad link.
619 public function hasViewableContent() {
620 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
624 * @return int The view count for the page
626 public function getCount() {
627 if ( -1 == $this->mCounter
) {
628 $id = $this->getID();
633 $dbr = wfGetDB( DB_SLAVE
);
634 $this->mCounter
= $dbr->selectField( 'page',
636 array( 'page_id' => $id ),
638 $this->getSelectOptions()
643 return $this->mCounter
;
647 * Determine whether a page would be suitable for being counted as an
648 * article in the site_stats table based on the title & its content
650 * @param $text String: text to analyze
653 public function isCountable( $text ) {
654 global $wgUseCommaCount;
656 $token = $wgUseCommaCount ?
',' : '[[';
658 return $this->mTitle
->isContentPage() && !$this->isRedirect( $text ) && in_string( $token, $text );
662 * Tests if the article text represents a redirect
664 * @param $text mixed string containing article contents, or boolean
667 public function isRedirect( $text = false ) {
668 if ( $text === false ) {
669 if ( !$this->mDataLoaded
) {
670 $this->loadPageData();
673 return (bool)$this->mIsRedirect
;
675 return Title
::newFromRedirect( $text ) !== null;
680 * Returns true if the currently-referenced revision is the current edit
681 * to this page (and it exists).
684 public function isCurrent() {
685 # If no oldid, this is the current version.
686 if ( $this->getOldID() == 0 ) {
690 return $this->exists() && isset( $this->mRevision
) && $this->mRevision
->isCurrent();
694 * Loads everything except the text
695 * This isn't necessary for all uses, so it's only done if needed.
697 protected function loadLastEdit() {
698 if ( -1 != $this->mUser
) {
702 # New or non-existent articles have no user information
703 $id = $this->getID();
708 $this->mLastRevision
= Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $id );
709 if ( !is_null( $this->mLastRevision
) ) {
710 $this->mUser
= $this->mLastRevision
->getUser();
711 $this->mUserText
= $this->mLastRevision
->getUserText();
712 $this->mTimestamp
= $this->mLastRevision
->getTimestamp();
713 $this->mComment
= $this->mLastRevision
->getComment();
714 $this->mMinorEdit
= $this->mLastRevision
->isMinor();
715 $this->mRevIdFetched
= $this->mLastRevision
->getId();
720 * @return string GMT timestamp of last article revision
723 public function getTimestamp() {
724 // Check if the field has been filled by ParserCache::get()
725 if ( !$this->mTimestamp
) {
726 $this->loadLastEdit();
729 return wfTimestamp( TS_MW
, $this->mTimestamp
);
733 * @return int user ID for the user that made the last article revision
735 public function getUser() {
736 $this->loadLastEdit();
741 * @return string username of the user that made the last article revision
743 public function getUserText() {
744 $this->loadLastEdit();
745 return $this->mUserText
;
749 * @return string Comment stored for the last article revision
751 public function getComment() {
752 $this->loadLastEdit();
753 return $this->mComment
;
757 * Returns true if last revision was marked as "minor edit"
759 * @return boolean Minor edit indicator for the last article revision.
761 public function getMinorEdit() {
762 $this->loadLastEdit();
763 return $this->mMinorEdit
;
767 * Use this to fetch the rev ID used on page views
769 * @return int revision ID of last article revision
771 public function getRevIdFetched() {
772 $this->loadLastEdit();
773 return $this->mRevIdFetched
;
777 * FIXME: this does what?
778 * @param $limit Integer: default 0.
779 * @param $offset Integer: default 0.
780 * @return UserArrayFromResult object with User objects of article contributors for requested range
782 public function getContributors( $limit = 0, $offset = 0 ) {
783 # FIXME: this is expensive; cache this info somewhere.
785 $dbr = wfGetDB( DB_SLAVE
);
786 $revTable = $dbr->tableName( 'revision' );
787 $userTable = $dbr->tableName( 'user' );
789 $pageId = $this->getId();
791 $user = $this->getUser();
794 $excludeCond = "AND rev_user != $user";
796 $userText = $dbr->addQuotes( $this->getUserText() );
797 $excludeCond = "AND rev_user_text != $userText";
800 $deletedBit = $dbr->bitAnd( 'rev_deleted', Revision
::DELETED_USER
); // username hidden?
802 $sql = "SELECT {$userTable}.*, rev_user_text as user_name, MAX(rev_timestamp) as timestamp
803 FROM $revTable LEFT JOIN $userTable ON rev_user = user_id
804 WHERE rev_page = $pageId
807 GROUP BY rev_user, rev_user_text
808 ORDER BY timestamp DESC";
811 $sql = $dbr->limitResult( $sql, $limit, $offset );
814 $sql .= ' ' . $this->getSelectOptions();
815 $res = $dbr->query( $sql, __METHOD__
);
817 return new UserArrayFromResult( $res );
821 * This is the default action of the index.php entry point: just view the
822 * page of the given title.
824 public function view() {
825 global $wgUser, $wgOut, $wgRequest, $wgParser;
826 global $wgUseFileCache, $wgUseETag;
828 wfProfileIn( __METHOD__
);
830 # Get variables from query string
831 $oldid = $this->getOldID();
832 $parserCache = ParserCache
::singleton();
834 $parserOptions = $this->getParserOptions();
835 # Render printable version, use printable version cache
836 if ( $wgOut->isPrintable() ) {
837 $parserOptions->setIsPrintable( true );
838 $parserOptions->setEditSection( false );
839 } else if ( $wgUseETag && !$this->mTitle
->quickUserCan( 'edit' ) ) {
840 $parserOptions->setEditSection( false );
843 # Try client and file cache
844 if ( $oldid === 0 && $this->checkTouched() ) {
846 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
849 # Is it client cached?
850 if ( $wgOut->checkLastModified( $this->getTouched() ) ) {
851 wfDebug( __METHOD__
. ": done 304\n" );
852 wfProfileOut( __METHOD__
);
856 } else if ( $wgUseFileCache && $this->tryFileCache() ) {
857 wfDebug( __METHOD__
. ": done file cache\n" );
858 # tell wgOut that output is taken care of
860 $this->viewUpdates();
861 wfProfileOut( __METHOD__
);
867 # getOldID may want us to redirect somewhere else
868 if ( $this->mRedirectUrl
) {
869 $wgOut->redirect( $this->mRedirectUrl
);
870 wfDebug( __METHOD__
. ": redirecting due to oldid\n" );
871 wfProfileOut( __METHOD__
);
876 $wgOut->setArticleFlag( true );
877 # Set page title (may be overridden by DISPLAYTITLE)
878 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
880 # If we got diff in the query, we want to see a diff page instead of the article.
881 if ( $wgRequest->getCheck( 'diff' ) ) {
882 wfDebug( __METHOD__
. ": showing diff page\n" );
883 $this->showDiffPage();
884 wfProfileOut( __METHOD__
);
889 # Allow frames by default
890 $wgOut->allowClickjacking();
892 if ( !$wgUseETag && !$this->mTitle
->quickUserCan( 'edit' ) ) {
893 $parserOptions->setEditSection( false );
896 # Should the parser cache be used?
897 $useParserCache = $this->useParserCache( $oldid );
898 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
899 if ( $wgUser->getStubThreshold() ) {
900 wfIncrStats( 'pcache_miss_stub' );
903 $wasRedirected = $this->showRedirectedFromHeader();
904 $this->showNamespaceHeader();
906 # Iterate through the possible ways of constructing the output text.
907 # Keep going until $outputDone is set, or we run out of things to do.
910 $this->mParserOutput
= false;
912 while ( !$outputDone && ++
$pass ) {
915 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
918 # Try the parser cache
919 if ( $useParserCache ) {
920 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
922 if ( $this->mParserOutput
!== false ) {
923 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
924 $wgOut->addParserOutput( $this->mParserOutput
);
925 # Ensure that UI elements requiring revision ID have
926 # the correct version information.
927 $wgOut->setRevisionId( $this->mLatest
);
933 $text = $this->getContent();
934 if ( $text === false ||
$this->getID() == 0 ) {
935 wfDebug( __METHOD__
. ": showing missing article\n" );
936 $this->showMissingArticle();
937 wfProfileOut( __METHOD__
);
941 # Another whitelist check in case oldid is altering the title
942 if ( !$this->mTitle
->userCanRead() ) {
943 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
944 $wgOut->loginToUse();
947 wfProfileOut( __METHOD__
);
951 # Are we looking at an old revision
952 if ( $oldid && !is_null( $this->mRevision
) ) {
953 $this->setOldSubtitle( $oldid );
955 if ( !$this->showDeletedRevisionHeader() ) {
956 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
957 wfProfileOut( __METHOD__
);
961 # If this "old" version is the current, then try the parser cache...
962 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
963 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
964 if ( $this->mParserOutput
) {
965 wfDebug( __METHOD__
. ": showing parser cache for current rev permalink\n" );
966 $wgOut->addParserOutput( $this->mParserOutput
);
967 $wgOut->setRevisionId( $this->mLatest
);
974 # Ensure that UI elements requiring revision ID have
975 # the correct version information.
976 $wgOut->setRevisionId( $this->getRevIdFetched() );
978 # Pages containing custom CSS or JavaScript get special treatment
979 if ( $this->mTitle
->isCssOrJsPage() ||
$this->mTitle
->isCssJsSubpage() ) {
980 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
981 $this->showCssOrJsPage();
984 $rt = Title
::newFromRedirectArray( $text );
986 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
987 # Viewing a redirect page (e.g. with parameter redirect=no)
988 # Don't append the subtitle if this was an old revision
989 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
990 # Parse just to get categories, displaytitle, etc.
991 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
, $parserOptions );
992 $wgOut->addParserOutputNoText( $this->mParserOutput
);
998 # Run the parse, protected by a pool counter
999 wfDebug( __METHOD__
. ": doing uncached parse\n" );
1001 $key = $parserCache->getKey( $this, $parserOptions );
1002 $poolArticleView = new PoolWorkArticleView( $this, $key, $useParserCache, $parserOptions );
1004 if ( !$poolArticleView->execute() ) {
1005 # Connection or timeout error
1006 wfProfileOut( __METHOD__
);
1012 # Should be unreachable, but just in case...
1018 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
1019 if ( $this->mParserOutput
) {
1020 $titleText = $this->mParserOutput
->getTitleText();
1022 if ( strval( $titleText ) !== '' ) {
1023 $wgOut->setPageTitle( $titleText );
1027 # For the main page, overwrite the <title> element with the con-
1028 # tents of 'pagetitle-view-mainpage' instead of the default (if
1029 # that's not empty).
1030 # This message always exists because it is in the i18n files
1031 if ( $this->mTitle
->equals( Title
::newMainPage() )
1032 && ( $m = wfMsgForContent( 'pagetitle-view-mainpage' ) ) !== '' )
1034 $wgOut->setHTMLTitle( $m );
1037 # Now that we've filled $this->mParserOutput, we know whether
1038 # there are any __NOINDEX__ tags on the page
1039 $policy = $this->getRobotPolicy( 'view' );
1040 $wgOut->setIndexPolicy( $policy['index'] );
1041 $wgOut->setFollowPolicy( $policy['follow'] );
1043 $this->showViewFooter();
1044 $this->viewUpdates();
1045 wfProfileOut( __METHOD__
);
1049 * Show a diff page according to current request variables. For use within
1050 * Article::view() only, other callers should use the DifferenceEngine class.
1052 public function showDiffPage() {
1053 global $wgRequest, $wgUser;
1055 $diff = $wgRequest->getVal( 'diff' );
1056 $rcid = $wgRequest->getVal( 'rcid' );
1057 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
1058 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1059 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1060 $oldid = $this->getOldID();
1062 $de = new DifferenceEngine( $this->mTitle
, $oldid, $diff, $rcid, $purge, $unhide );
1063 // DifferenceEngine directly fetched the revision:
1064 $this->mRevIdFetched
= $de->mNewid
;
1065 $de->showDiffPage( $diffOnly );
1067 // Needed to get the page's current revision
1068 $this->loadPageData();
1069 if ( $diff == 0 ||
$diff == $this->mLatest
) {
1070 # Run view updates for current revision only
1071 $this->viewUpdates();
1076 * Show a page view for a page formatted as CSS or JavaScript. To be called by
1077 * Article::view() only.
1079 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
1082 protected function showCssOrJsPage() {
1085 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache'>\n$1\n</div>", 'clearyourcache' );
1087 // Give hooks a chance to customise the output
1088 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->mTitle
, $wgOut ) ) ) {
1089 // Wrap the whole lot in a <pre> and don't parse
1091 preg_match( '!\.(css|js)$!u', $this->mTitle
->getText(), $m );
1092 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
1093 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
1094 $wgOut->addHTML( "\n</pre>\n" );
1099 * Get the robot policy to be used for the current view
1100 * @param $action String the action= GET parameter
1101 * @return Array the policy that should be set
1102 * TODO: actions other than 'view'
1104 public function getRobotPolicy( $action ) {
1105 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1106 global $wgDefaultRobotPolicy, $wgRequest;
1108 $ns = $this->mTitle
->getNamespace();
1110 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
1111 # Don't index user and user talk pages for blocked users (bug 11443)
1112 if ( !$this->mTitle
->isSubpage() ) {
1113 $block = new Block();
1114 if ( $block->load( $this->mTitle
->getText() ) ) {
1116 'index' => 'noindex',
1117 'follow' => 'nofollow'
1123 if ( $this->getID() === 0 ||
$this->getOldID() ) {
1124 # Non-articles (special pages etc), and old revisions
1126 'index' => 'noindex',
1127 'follow' => 'nofollow'
1129 } elseif ( $wgOut->isPrintable() ) {
1130 # Discourage indexing of printable versions, but encourage following
1132 'index' => 'noindex',
1133 'follow' => 'follow'
1135 } elseif ( $wgRequest->getInt( 'curid' ) ) {
1136 # For ?curid=x urls, disallow indexing
1138 'index' => 'noindex',
1139 'follow' => 'follow'
1143 # Otherwise, construct the policy based on the various config variables.
1144 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
1146 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
1147 # Honour customised robot policies for this namespace
1148 $policy = array_merge(
1150 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
1153 if ( $this->mTitle
->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ) {
1154 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1155 # a final sanity check that we have really got the parser output.
1156 $policy = array_merge(
1158 array( 'index' => $this->mParserOutput
->getIndexPolicy() )
1162 if ( isset( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) ) {
1163 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1164 $policy = array_merge(
1166 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] )
1174 * Converts a String robot policy into an associative array, to allow
1175 * merging of several policies using array_merge().
1176 * @param $policy Mixed, returns empty array on null/false/'', transparent
1177 * to already-converted arrays, converts String.
1178 * @return Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1180 public static function formatRobotPolicy( $policy ) {
1181 if ( is_array( $policy ) ) {
1183 } elseif ( !$policy ) {
1187 $policy = explode( ',', $policy );
1188 $policy = array_map( 'trim', $policy );
1191 foreach ( $policy as $var ) {
1192 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
1193 $arr['index'] = $var;
1194 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
1195 $arr['follow'] = $var;
1203 * If this request is a redirect view, send "redirected from" subtitle to
1204 * $wgOut. Returns true if the header was needed, false if this is not a
1205 * redirect view. Handles both local and remote redirects.
1209 public function showRedirectedFromHeader() {
1210 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1212 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1213 $sk = $wgUser->getSkin();
1215 if ( isset( $this->mRedirectedFrom
) ) {
1216 // This is an internally redirected page view.
1217 // We'll need a backlink to the source page for navigation.
1218 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1220 $this->mRedirectedFrom
,
1223 array( 'redirect' => 'no' ),
1224 array( 'known', 'noclasses' )
1227 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1228 $wgOut->setSubtitle( $s );
1230 // Set the fragment if one was specified in the redirect
1231 if ( strval( $this->mTitle
->getFragment() ) != '' ) {
1232 $fragment = Xml
::escapeJsString( $this->mTitle
->getFragmentForURL() );
1233 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1236 // Add a <link rel="canonical"> tag
1237 $wgOut->addLink( array( 'rel' => 'canonical',
1238 'href' => $this->mTitle
->getLocalURL() )
1243 } elseif ( $rdfrom ) {
1244 // This is an externally redirected view, from some other wiki.
1245 // If it was reported from a trusted site, supply a backlink.
1246 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1247 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1248 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1249 $wgOut->setSubtitle( $s );
1259 * Show a header specific to the namespace currently being viewed, like
1260 * [[MediaWiki:Talkpagetext]]. For Article::view().
1262 public function showNamespaceHeader() {
1265 if ( $this->mTitle
->isTalkPage() ) {
1266 $msg = wfMsgNoTrans( 'talkpageheader' );
1267 if ( $msg !== '-' && !wfEmptyMsg( 'talkpageheader', $msg ) ) {
1268 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1274 * Show the footer section of an ordinary page view
1276 public function showViewFooter() {
1277 global $wgOut, $wgUseTrackbacks;
1279 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1280 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->mTitle
->getText() ) ) {
1281 $wgOut->addWikiMsg( 'anontalkpagetext' );
1284 # If we have been passed an &rcid= parameter, we want to give the user a
1285 # chance to mark this new article as patrolled.
1286 $this->showPatrolFooter();
1289 if ( $wgUseTrackbacks ) {
1290 $this->addTrackbacks();
1295 * If patrol is possible, output a patrol UI box. This is called from the
1296 * footer section of ordinary page views. If patrol is not possible or not
1297 * desired, does nothing.
1299 public function showPatrolFooter() {
1300 global $wgOut, $wgRequest, $wgUser;
1302 $rcid = $wgRequest->getVal( 'rcid' );
1304 if ( !$rcid ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1308 $sk = $wgUser->getSkin();
1309 $token = $wgUser->editToken( $rcid );
1310 $wgOut->preventClickjacking();
1313 "<div class='patrollink'>" .
1315 'markaspatrolledlink',
1318 wfMsgHtml( 'markaspatrolledtext' ),
1321 'action' => 'markpatrolled',
1325 array( 'known', 'noclasses' )
1333 * Show the error text for a missing article. For articles in the MediaWiki
1334 * namespace, show the default message text. To be called from Article::view().
1336 public function showMissingArticle() {
1337 global $wgOut, $wgRequest, $wgUser;
1339 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1340 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1341 $parts = explode( '/', $this->mTitle
->getText() );
1342 $rootPart = $parts[0];
1343 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1344 $ip = User
::isIP( $rootPart );
1346 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1347 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1348 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1349 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1350 LogEventsList
::showLogExtract(
1353 $user->getUserPage()->getPrefixedText(),
1357 'showIfEmpty' => false,
1359 'blocked-notice-logextract',
1360 $user->getName() # Support GENDER in notice
1367 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1369 # Show delete and move logs
1370 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1372 'conds' => array( "log_action != 'revision'" ),
1373 'showIfEmpty' => false,
1374 'msgKey' => array( 'moveddeleted-notice' ) )
1377 # Show error message
1378 $oldid = $this->getOldID();
1380 $text = wfMsgNoTrans( 'missing-article',
1381 $this->mTitle
->getPrefixedText(),
1382 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1383 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1384 // Use the default message text
1385 $text = $this->getContent();
1387 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1388 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1389 $errors = array_merge( $createErrors, $editErrors );
1391 if ( !count( $errors ) ) {
1392 $text = wfMsgNoTrans( 'noarticletext' );
1394 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1397 $text = "<div class='noarticletext'>\n$text\n</div>";
1399 if ( !$this->hasViewableContent() ) {
1400 // If there's no backing content, send a 404 Not Found
1401 // for better machine handling of broken links.
1402 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1405 $wgOut->addWikiText( $text );
1409 * If the revision requested for view is deleted, check permissions.
1410 * Send either an error message or a warning header to $wgOut.
1412 * @return boolean true if the view is allowed, false if not.
1414 public function showDeletedRevisionHeader() {
1415 global $wgOut, $wgRequest;
1417 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1422 // If the user is not allowed to see it...
1423 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
1424 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1425 'rev-deleted-text-permission' );
1428 // If the user needs to confirm that they want to see it...
1429 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1430 # Give explanation and add a link to view the revision...
1431 $oldid = intval( $this->getOldID() );
1432 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1433 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1434 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1435 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1436 array( $msg, $link ) );
1439 // We are allowed to see...
1441 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1442 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1443 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1450 * Should the parser cache be used?
1454 public function useParserCache( $oldid ) {
1455 global $wgUser, $wgEnableParserCache;
1457 return $wgEnableParserCache
1458 && $wgUser->getStubThreshold() == 0
1461 && !$this->mTitle
->isCssOrJsPage()
1462 && !$this->mTitle
->isCssJsSubpage();
1466 * Execute the uncached parse for action=view
1468 public function doViewParse() {
1471 $oldid = $this->getOldID();
1472 $parserOptions = $this->getParserOptions();
1474 # Render printable version, use printable version cache
1475 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1477 # Don't show section-edit links on old revisions... this way lies madness.
1478 if ( !$this->isCurrent() ||
$wgOut->isPrintable() ||
!$this->mTitle
->quickUserCan( 'edit' ) ) {
1479 $parserOptions->setEditSection( false );
1482 $useParserCache = $this->useParserCache( $oldid );
1483 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1489 * Try to fetch an expired entry from the parser cache. If it is present,
1490 * output it and return true. If it is not present, output nothing and
1491 * return false. This is used as a callback function for
1492 * PoolCounter::executeProtected().
1496 public function tryDirtyCache() {
1498 $parserCache = ParserCache
::singleton();
1499 $options = $this->getParserOptions();
1501 if ( $wgOut->isPrintable() ) {
1502 $options->setIsPrintable( true );
1503 $options->setEditSection( false );
1506 $output = $parserCache->getDirty( $this, $options );
1509 wfDebug( __METHOD__
. ": sending dirty output\n" );
1510 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1511 $wgOut->setSquidMaxage( 0 );
1512 $this->mParserOutput
= $output;
1513 $wgOut->addParserOutput( $output );
1514 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1518 wfDebugLog( 'dirty', "dirty missing\n" );
1519 wfDebug( __METHOD__
. ": no dirty cache\n" );
1528 * @param $target Title|Array of destination(s) to redirect
1529 * @param $appendSubtitle Boolean [optional]
1530 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1531 * @return string containing HMTL with redirect link
1533 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1534 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1536 if ( !is_array( $target ) ) {
1537 $target = array( $target );
1540 $imageDir = $wgContLang->getDir();
1542 if ( $appendSubtitle ) {
1543 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1546 $sk = $wgUser->getSkin();
1547 // the loop prepends the arrow image before the link, so the first case needs to be outside
1548 $title = array_shift( $target );
1550 if ( $forceKnown ) {
1551 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1553 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1556 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1557 $alt = $wgContLang->isRTL() ?
'←' : '→';
1558 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1559 // FIXME: where this happens?
1560 foreach ( $target as $rt ) {
1561 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1562 if ( $forceKnown ) {
1563 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1565 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1569 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1570 return '<div class="redirectMsg">' .
1571 Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1572 '<span class="redirectText">' . $link . '</span></div>';
1576 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1578 public function addTrackbacks() {
1579 global $wgOut, $wgUser;
1581 $dbr = wfGetDB( DB_SLAVE
);
1582 $tbs = $dbr->select( 'trackbacks',
1583 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1584 array( 'tb_page' => $this->getID() )
1587 if ( !$dbr->numRows( $tbs ) ) {
1591 $wgOut->preventClickjacking();
1594 foreach ( $tbs as $o ) {
1597 if ( $wgUser->isAllowed( 'trackback' ) ) {
1598 $delurl = $this->mTitle
->getFullURL( "action=deletetrackback&tbid=" .
1599 $o->tb_id
. "&token=" . urlencode( $wgUser->editToken() ) );
1600 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1604 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1612 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1616 * Removes trackback record for current article from trackbacks table
1618 public function deletetrackback() {
1619 global $wgUser, $wgRequest, $wgOut;
1621 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1622 $wgOut->addWikiMsg( 'sessionfailure' );
1627 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
1629 if ( count( $permission_errors ) ) {
1630 $wgOut->showPermissionsErrorPage( $permission_errors );
1635 $db = wfGetDB( DB_MASTER
);
1636 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1638 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1639 $this->mTitle
->invalidateCache();
1643 * Handle action=render
1646 public function render() {
1649 $wgOut->setArticleBodyOnly( true );
1654 * Handle action=purge
1656 public function purge() {
1657 global $wgUser, $wgRequest, $wgOut;
1659 if ( $wgUser->isAllowed( 'purge' ) ||
$wgRequest->wasPosted() ) {
1660 //FIXME: shouldn't this be in doPurge()?
1661 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1666 $formParams = array(
1668 'action' => $wgRequest->getRequestURL(),
1671 $wgOut->addWikiMsg( 'confirm-purge-top' );
1673 $form = Html
::openElement( 'form', $formParams );
1674 $form .= Xml
::submitButton( wfMsg( 'confirm_purge_button' ) );
1675 $form .= Html
::closeElement( 'form' );
1677 $wgOut->addHTML( $form );
1678 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1680 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
1681 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1686 * Perform the actions of a page purging
1688 public function doPurge() {
1691 // Invalidate the cache
1692 $this->mTitle
->invalidateCache();
1695 if ( $wgUseSquid ) {
1696 // Commit the transaction before the purge is sent
1697 $dbw = wfGetDB( DB_MASTER
);
1701 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1702 $update->doUpdate();
1705 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1706 global $wgMessageCache;
1708 if ( $this->getID() == 0 ) {
1711 $text = $this->getRawText();
1714 $wgMessageCache->replace( $this->mTitle
->getDBkey(), $text );
1719 * Insert a new empty page record for this article.
1720 * This *must* be followed up by creating a revision
1721 * and running $this->updateRevisionOn( ... );
1722 * or else the record will be left in a funky state.
1723 * Best if all done inside a transaction.
1725 * @param $dbw Database
1726 * @return int The newly created page_id key, or false if the title already existed
1729 public function insertOn( $dbw ) {
1730 wfProfileIn( __METHOD__
);
1732 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1733 $dbw->insert( 'page', array(
1734 'page_id' => $page_id,
1735 'page_namespace' => $this->mTitle
->getNamespace(),
1736 'page_title' => $this->mTitle
->getDBkey(),
1737 'page_counter' => 0,
1738 'page_restrictions' => '',
1739 'page_is_redirect' => 0, # Will set this shortly...
1741 'page_random' => wfRandom(),
1742 'page_touched' => $dbw->timestamp(),
1743 'page_latest' => 0, # Fill this in shortly...
1744 'page_len' => 0, # Fill this in shortly...
1745 ), __METHOD__
, 'IGNORE' );
1747 $affected = $dbw->affectedRows();
1750 $newid = $dbw->insertId();
1751 $this->mTitle
->resetArticleId( $newid );
1753 wfProfileOut( __METHOD__
);
1755 return $affected ?
$newid : false;
1759 * Update the page record to point to a newly saved revision.
1761 * @param $dbw DatabaseBase: object
1762 * @param $revision Revision: For ID number, and text used to set
1763 length and redirect status fields
1764 * @param $lastRevision Integer: if given, will not overwrite the page field
1765 * when different from the currently set value.
1766 * Giving 0 indicates the new page flag should be set
1768 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1769 * removing rows in redirect table.
1770 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1771 * Needed when $lastRevision has to be set to sth. !=0
1772 * @return bool true on success, false on failure
1775 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1776 wfProfileIn( __METHOD__
);
1778 $text = $revision->getText();
1779 $rt = Title
::newFromRedirectRecurse( $text );
1781 $conditions = array( 'page_id' => $this->getId() );
1783 if ( !is_null( $lastRevision ) ) {
1784 # An extra check against threads stepping on each other
1785 $conditions['page_latest'] = $lastRevision;
1788 if ( !$setNewFlag ) {
1789 $setNewFlag = ( $lastRevision === 0 );
1792 $dbw->update( 'page',
1794 'page_latest' => $revision->getId(),
1795 'page_touched' => $dbw->timestamp(),
1796 'page_is_new' => $setNewFlag,
1797 'page_is_redirect' => $rt !== null ?
1 : 0,
1798 'page_len' => strlen( $text ),
1803 $result = $dbw->affectedRows() != 0;
1805 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1808 wfProfileOut( __METHOD__
);
1813 * Add row to the redirect table if this is a redirect, remove otherwise.
1815 * @param $dbw Database
1816 * @param $redirectTitle Title object pointing to the redirect target,
1817 * or NULL if this is not a redirect
1818 * @param $lastRevIsRedirect If given, will optimize adding and
1819 * removing rows in redirect table.
1820 * @return bool true on success, false on failure
1823 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1824 // Always update redirects (target link might have changed)
1825 // Update/Insert if we don't know if the last revision was a redirect or not
1826 // Delete if changing from redirect to non-redirect
1827 $isRedirect = !is_null( $redirectTitle );
1829 if ( $isRedirect ||
is_null( $lastRevIsRedirect ) ||
$lastRevIsRedirect !== $isRedirect ) {
1830 wfProfileIn( __METHOD__
);
1831 if ( $isRedirect ) {
1832 $this->insertRedirectEntry( $redirectTitle );
1834 // This is not a redirect, remove row from redirect table
1835 $where = array( 'rd_from' => $this->getId() );
1836 $dbw->delete( 'redirect', $where, __METHOD__
);
1839 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1840 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1842 wfProfileOut( __METHOD__
);
1844 return ( $dbw->affectedRows() != 0 );
1851 * If the given revision is newer than the currently set page_latest,
1852 * update the page record. Otherwise, do nothing.
1854 * @param $dbw Database object
1855 * @param $revision Revision object
1858 public function updateIfNewerOn( &$dbw, $revision ) {
1859 wfProfileIn( __METHOD__
);
1861 $row = $dbw->selectRow(
1862 array( 'revision', 'page' ),
1863 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1865 'page_id' => $this->getId(),
1866 'page_latest=rev_id' ),
1870 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1871 wfProfileOut( __METHOD__
);
1874 $prev = $row->rev_id
;
1875 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1877 # No or missing previous revision; mark the page as new
1879 $lastRevIsRedirect = null;
1882 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1884 wfProfileOut( __METHOD__
);
1889 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1890 * @param $text String: new text of the section
1891 * @param $summary String: new section's subject, only if $section is 'new'
1892 * @param $edittime String: revision timestamp or null to use the current revision
1893 * @return string Complete article text, or null if error
1895 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1896 wfProfileIn( __METHOD__
);
1898 if ( strval( $section ) == '' ) {
1899 // Whole-page edit; let the whole text through
1901 if ( is_null( $edittime ) ) {
1902 $rev = Revision
::newFromTitle( $this->mTitle
);
1904 $dbw = wfGetDB( DB_MASTER
);
1905 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1909 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1910 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1914 $oldtext = $rev->getText();
1916 if ( $section == 'new' ) {
1917 # Inserting a new section
1918 $subject = $summary ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1919 $text = strlen( trim( $oldtext ) ) > 0
1920 ?
"{$oldtext}\n\n{$subject}{$text}"
1921 : "{$subject}{$text}";
1923 # Replacing an existing section; roll out the big guns
1926 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1930 wfProfileOut( __METHOD__
);
1935 * This function is not deprecated until somebody fixes the core not to use
1936 * it. Nevertheless, use Article::doEdit() instead.
1937 * @deprecated @since 1.7
1939 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1940 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1941 ( $isminor ? EDIT_MINOR
: 0 ) |
1942 ( $suppressRC ? EDIT_SUPPRESS_RC
: 0 ) |
1943 ( $bot ? EDIT_FORCE_BOT
: 0 );
1945 # If this is a comment, add the summary as headline
1946 if ( $comment && $summary != "" ) {
1947 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
1949 $this->doEdit( $text, $summary, $flags );
1951 $dbw = wfGetDB( DB_MASTER
);
1953 if ( !$this->mTitle
->userIsWatching() ) {
1959 if ( $this->mTitle
->userIsWatching() ) {
1965 $this->doRedirect( $this->isRedirect( $text ) );
1969 * @deprecated @since 1.7 use Article::doEdit()
1971 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1972 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1973 ( $minor ? EDIT_MINOR
: 0 ) |
1974 ( $forceBot ? EDIT_FORCE_BOT
: 0 );
1976 $status = $this->doEdit( $text, $summary, $flags );
1978 if ( !$status->isOK() ) {
1982 $dbw = wfGetDB( DB_MASTER
);
1984 if ( !$this->mTitle
->userIsWatching() ) {
1990 if ( $this->mTitle
->userIsWatching() ) {
1997 $extraQuery = ''; // Give extensions a chance to modify URL query on update
1998 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
2000 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
2005 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
2007 * @return Int updated $flags
2009 function checkFlags( $flags ) {
2010 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
2011 if ( $this->mTitle
->getArticleID() ) {
2012 $flags |
= EDIT_UPDATE
;
2024 * Change an existing article or create a new article. Updates RC and all necessary caches,
2025 * optionally via the deferred update array.
2027 * $wgUser must be set before calling this function.
2029 * @param $text String: new text
2030 * @param $summary String: edit summary
2031 * @param $flags Integer bitfield:
2033 * Article is known or assumed to be non-existent, create a new one
2035 * Article is known or assumed to be pre-existing, update it
2037 * Mark this edit minor, if the user is allowed to do so
2039 * Do not log the change in recentchanges
2041 * Mark the edit a "bot" edit regardless of user rights
2042 * EDIT_DEFER_UPDATES
2043 * Defer some of the updates until the end of index.php
2045 * Fill in blank summaries with generated text where possible
2047 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2048 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2049 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2050 * edit-already-exists error will be returned. These two conditions are also possible with
2051 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2053 * @param $baseRevId the revision ID this edit was based off, if any
2054 * @param $user User (optional), $wgUser will be used if not passed
2056 * @return Status object. Possible errors:
2057 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2058 * edit-gone-missing: In update mode, but the article didn't exist
2059 * edit-conflict: In update mode, the article changed unexpectedly
2060 * edit-no-change: Warning that the text was the same as before
2061 * edit-already-exists: In creation mode, but the article already exists
2063 * Extensions may define additional errors.
2065 * $return->value will contain an associative array with members as follows:
2066 * new: Boolean indicating if the function attempted to create a new article
2067 * revision: The revision object for the inserted revision, or null
2069 * Compatibility note: this function previously returned a boolean value indicating success/failure
2071 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
2072 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2074 # Low-level sanity check
2075 if ( $this->mTitle
->getText() === '' ) {
2076 throw new MWException( 'Something is trying to edit an article with an empty title' );
2079 wfProfileIn( __METHOD__
);
2081 $user = is_null( $user ) ?
$wgUser : $user;
2082 $status = Status
::newGood( array() );
2084 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2085 $this->loadPageData();
2087 $flags = $this->checkFlags( $flags );
2089 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2090 $flags & EDIT_MINOR
, null, null, &$flags, &$status ) ) )
2092 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
2093 wfProfileOut( __METHOD__
);
2095 if ( $status->isOK() ) {
2096 $status->fatal( 'edit-hook-aborted' );
2102 # Silently ignore EDIT_MINOR if not allowed
2103 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
2104 $bot = $flags & EDIT_FORCE_BOT
;
2106 $oldtext = $this->getRawText(); // current revision
2107 $oldsize = strlen( $oldtext );
2109 # Provide autosummaries if one is not provided and autosummaries are enabled.
2110 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
2111 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2114 $editInfo = $this->prepareTextForEdit( $text, null, $user );
2115 $text = $editInfo->pst
;
2116 $newsize = strlen( $text );
2118 $dbw = wfGetDB( DB_MASTER
);
2119 $now = wfTimestampNow();
2120 $this->mTimestamp
= $now;
2122 if ( $flags & EDIT_UPDATE
) {
2123 # Update article, but only if changed.
2124 $status->value
['new'] = false;
2126 # Make sure the revision is either completely inserted or not inserted at all
2127 if ( !$wgDBtransactions ) {
2128 $userAbort = ignore_user_abort( true );
2131 $changed = ( strcmp( $text, $oldtext ) != 0 );
2134 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
2135 - (int)$this->isCountable( $oldtext );
2136 $this->mTotalAdjustment
= 0;
2138 if ( !$this->mLatest
) {
2139 # Article gone missing
2140 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
2141 $status->fatal( 'edit-gone-missing' );
2143 wfProfileOut( __METHOD__
);
2147 $revision = new Revision( array(
2148 'page' => $this->getId(),
2149 'comment' => $summary,
2150 'minor_edit' => $isminor,
2152 'parent_id' => $this->mLatest
,
2153 'user' => $user->getId(),
2154 'user_text' => $user->getName(),
2159 $revisionId = $revision->insertOn( $dbw );
2163 # Note that we use $this->mLatest instead of fetching a value from the master DB
2164 # during the course of this function. This makes sure that EditPage can detect
2165 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2166 # before this function is called. A previous function used a separate query, this
2167 # creates a window where concurrent edits can cause an ignored edit conflict.
2168 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
2171 /* Belated edit conflict! Run away!! */
2172 $status->fatal( 'edit-conflict' );
2174 # Delete the invalid revision if the DB is not transactional
2175 if ( !$wgDBtransactions ) {
2176 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
2182 global $wgUseRCPatrol;
2183 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2184 # Update recentchanges
2185 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2186 # Mark as patrolled if the user can do so
2187 $patrolled = $wgUseRCPatrol && !count(
2188 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
2189 # Add RC row to the DB
2190 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
2191 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2192 $revisionId, $patrolled
2195 # Log auto-patrolled edits
2197 PatrolLog
::record( $rc, true );
2200 $user->incEditCount();
2204 $status->warning( 'edit-no-change' );
2206 // Keep the same revision ID, but do some updates on it
2207 $revisionId = $this->getRevIdFetched();
2208 // Update page_touched, this is usually implicit in the page update
2209 // Other cache updates are done in onArticleEdit()
2210 $this->mTitle
->invalidateCache();
2213 if ( !$wgDBtransactions ) {
2214 ignore_user_abort( $userAbort );
2217 // Now that ignore_user_abort is restored, we can respond to fatal errors
2218 if ( !$status->isOK() ) {
2219 wfProfileOut( __METHOD__
);
2223 # Invalidate cache of this article and all pages using this article
2224 # as a template. Partly deferred.
2225 Article
::onArticleEdit( $this->mTitle
);
2226 # Update links tables, site stats, etc.
2227 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed, $user );
2229 # Create new article
2230 $status->value
['new'] = true;
2232 # Set statistics members
2233 # We work out if it's countable after PST to avoid counter drift
2234 # when articles are created with {{subst:}}
2235 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2236 $this->mTotalAdjustment
= 1;
2240 # Add the page record; stake our claim on this title!
2241 # This will return false if the article already exists
2242 $newid = $this->insertOn( $dbw );
2244 if ( $newid === false ) {
2246 $status->fatal( 'edit-already-exists' );
2248 wfProfileOut( __METHOD__
);
2252 # Save the revision text...
2253 $revision = new Revision( array(
2255 'comment' => $summary,
2256 'minor_edit' => $isminor,
2258 'user' => $user->getId(),
2259 'user_text' => $user->getName(),
2262 $revisionId = $revision->insertOn( $dbw );
2264 $this->mTitle
->resetArticleID( $newid );
2266 # Update the page record with revision data
2267 $this->updateRevisionOn( $dbw, $revision, 0 );
2269 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2271 # Update recentchanges
2272 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2273 global $wgUseRCPatrol, $wgUseNPPatrol;
2275 # Mark as patrolled if the user can do so
2276 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && !count(
2277 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
2278 # Add RC row to the DB
2279 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2280 '', strlen( $text ), $revisionId, $patrolled );
2282 # Log auto-patrolled edits
2284 PatrolLog
::record( $rc, true );
2287 $user->incEditCount();
2290 # Update links, etc.
2291 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true, $user );
2294 Article
::onArticleCreate( $this->mTitle
);
2296 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2297 $flags & EDIT_MINOR
, null, null, &$flags, $revision ) );
2300 # Do updates right now unless deferral was requested
2301 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
2305 // Return the new revision (or null) to the caller
2306 $status->value
['revision'] = $revision;
2308 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2309 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId ) );
2311 wfProfileOut( __METHOD__
);
2316 * Output a redirect back to the article.
2317 * This is typically used after an edit.
2319 * @param $noRedir Boolean: add redirect=no
2320 * @param $sectionAnchor String: section to redirect to, including "#"
2321 * @param $extraQuery String: extra query params
2323 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2327 $query = 'redirect=no';
2329 $query .= "&$extraQuery";
2331 $query = $extraQuery;
2334 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2338 * Mark this particular edit/page as patrolled
2340 public function markpatrolled() {
2341 global $wgOut, $wgUser, $wgRequest;
2343 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2345 # If we haven't been given an rc_id value, we can't do anything
2346 $rcid = (int) $wgRequest->getVal( 'rcid' );
2348 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ), $rcid ) ) {
2349 $wgOut->showErrorPage( 'sessionfailure-title', 'sessionfailure' );
2353 $rc = RecentChange
::newFromId( $rcid );
2355 if ( is_null( $rc ) ) {
2356 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2360 # It would be nice to see where the user had actually come from, but for now just guess
2361 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2362 $return = SpecialPage
::getTitleFor( $returnto );
2364 $errors = $rc->doMarkPatrolled();
2366 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2367 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2372 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2373 // The hook itself has handled any output
2377 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2378 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2379 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2380 $wgOut->returnToMain( false, $return );
2385 if ( !empty( $errors ) ) {
2386 $wgOut->showPermissionsErrorPage( $errors );
2392 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2393 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2394 $wgOut->returnToMain( false, $return );
2398 * User-interface handler for the "watch" action
2400 public function watch() {
2401 global $wgUser, $wgOut;
2403 if ( $wgUser->isAnon() ) {
2404 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2408 if ( wfReadOnly() ) {
2409 $wgOut->readOnlyPage();
2413 if ( $this->doWatch() ) {
2414 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2415 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2416 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle
->getPrefixedText() );
2419 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2423 * Add this page to $wgUser's watchlist
2424 * @return bool true on successful watch operation
2426 public function doWatch() {
2429 if ( $wgUser->isAnon() ) {
2433 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2434 $wgUser->addWatch( $this->mTitle
);
2435 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2442 * User interface handler for the "unwatch" action.
2444 public function unwatch() {
2445 global $wgUser, $wgOut;
2447 if ( $wgUser->isAnon() ) {
2448 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2452 if ( wfReadOnly() ) {
2453 $wgOut->readOnlyPage();
2457 if ( $this->doUnwatch() ) {
2458 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2459 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2460 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle
->getPrefixedText() );
2463 $wgOut->returnToMain( true, $this->mTitle
->getPrefixedText() );
2467 * Stop watching a page
2468 * @return bool true on successful unwatch
2470 public function doUnwatch() {
2473 if ( $wgUser->isAnon() ) {
2477 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2478 $wgUser->removeWatch( $this->mTitle
);
2479 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2486 * action=protect handler
2488 public function protect() {
2489 $form = new ProtectionForm( $this );
2494 * action=unprotect handler (alias)
2496 public function unprotect() {
2501 * Update the article's restriction field, and leave a log entry.
2503 * @param $limit Array: set of restriction keys
2504 * @param $reason String
2505 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2506 * @param $expiry Array: per restriction type expiration
2507 * @return bool true on success
2509 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2510 global $wgUser, $wgContLang;
2512 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2514 $id = $this->mTitle
->getArticleID();
2517 wfDebug( "updateRestrictions failed: article id $id <= 0\n" );
2521 if ( wfReadOnly() ) {
2522 wfDebug( "updateRestrictions failed: read-only\n" );
2526 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2527 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2535 // Take this opportunity to purge out expired restrictions
2536 Title
::purgeExpiredRestrictions();
2538 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2539 # we expect a single selection, but the schema allows otherwise.
2541 $updated = Article
::flattenRestrictions( $limit );
2544 foreach ( $restrictionTypes as $action ) {
2545 if ( isset( $expiry[$action] ) ) {
2546 # Get current restrictions on $action
2547 $aLimits = $this->mTitle
->getRestrictions( $action );
2548 $current[$action] = implode( '', $aLimits );
2549 # Are any actual restrictions being dealt with here?
2550 $aRChanged = count( $aLimits ) ||
!empty( $limit[$action] );
2552 # If something changed, we need to log it. Checking $aRChanged
2553 # assures that "unprotecting" a page that is not protected does
2554 # not log just because the expiry was "changed".
2555 if ( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2561 $current = Article
::flattenRestrictions( $current );
2563 $changed = ( $changed ||
$current != $updated );
2564 $changed = $changed ||
( $updated && $this->mTitle
->areRestrictionsCascading() != $cascade );
2565 $protect = ( $updated != '' );
2567 # If nothing's changed, do nothing
2569 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2570 $dbw = wfGetDB( DB_MASTER
);
2572 # Prepare a null revision to be added to the history
2573 $modified = $current != '' && $protect;
2576 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2578 $comment_type = 'unprotectedarticle';
2581 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2583 # Only restrictions with the 'protect' right can cascade...
2584 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2585 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2587 # The schema allows multiple restrictions
2588 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2592 $cascade_description = '';
2595 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2599 $comment .= ": $reason";
2602 $editComment = $comment;
2603 $encodedExpiry = array();
2604 $protect_description = '';
2605 foreach ( $limit as $action => $restrictions ) {
2606 if ( !isset( $expiry[$action] ) )
2607 $expiry[$action] = Block
::infinity();
2609 $encodedExpiry[$action] = Block
::encodeExpiry( $expiry[$action], $dbw );
2610 if ( $restrictions != '' ) {
2611 $protect_description .= "[$action=$restrictions] (";
2612 if ( $encodedExpiry[$action] != 'infinity' ) {
2613 $protect_description .= wfMsgForContent( 'protect-expiring',
2614 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2615 $wgContLang->date( $expiry[$action], false, false ) ,
2616 $wgContLang->time( $expiry[$action], false, false ) );
2618 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2621 $protect_description .= ') ';
2624 $protect_description = trim( $protect_description );
2626 if ( $protect_description && $protect ) {
2627 $editComment .= " ($protect_description)";
2631 $editComment .= "$cascade_description";
2634 # Update restrictions table
2635 foreach ( $limit as $action => $restrictions ) {
2636 if ( $restrictions != '' ) {
2637 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2638 array( 'pr_page' => $id,
2639 'pr_type' => $action,
2640 'pr_level' => $restrictions,
2641 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2642 'pr_expiry' => $encodedExpiry[$action]
2647 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2648 'pr_type' => $action ), __METHOD__
);
2652 # Insert a null revision
2653 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2654 $nullRevId = $nullRevision->insertOn( $dbw );
2656 $latest = $this->getLatest();
2657 # Update page record
2658 $dbw->update( 'page',
2660 'page_touched' => $dbw->timestamp(),
2661 'page_restrictions' => '',
2662 'page_latest' => $nullRevId
2663 ), array( /* WHERE */
2665 ), 'Article::protect'
2668 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2669 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2671 # Update the protection log
2672 $log = new LogPage( 'protect' );
2674 $params = array( $protect_description, $cascade ?
'cascade' : '' );
2675 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason ), $params );
2677 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2680 } # End "changed" check
2686 * Take an array of page restrictions and flatten it to a string
2687 * suitable for insertion into the page_restrictions field.
2688 * @param $limit Array
2691 protected static function flattenRestrictions( $limit ) {
2692 if ( !is_array( $limit ) ) {
2693 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2699 foreach ( $limit as $action => $restrictions ) {
2700 if ( $restrictions != '' ) {
2701 $bits[] = "$action=$restrictions";
2705 return implode( ':', $bits );
2709 * Auto-generates a deletion reason
2711 * @param &$hasHistory Boolean: whether the page has a history
2712 * @return mixed String containing deletion reason or empty string, or boolean false
2713 * if no revision occurred
2715 public function generateReason( &$hasHistory ) {
2718 $dbw = wfGetDB( DB_MASTER
);
2719 // Get the last revision
2720 $rev = Revision
::newFromTitle( $this->mTitle
);
2722 if ( is_null( $rev ) ) {
2726 // Get the article's contents
2727 $contents = $rev->getText();
2730 // If the page is blank, use the text from the previous revision,
2731 // which can only be blank if there's a move/import/protect dummy revision involved
2732 if ( $contents == '' ) {
2733 $prev = $rev->getPrevious();
2736 $contents = $prev->getText();
2741 // Find out if there was only one contributor
2742 // Only scan the last 20 revisions
2743 $res = $dbw->select( 'revision', 'rev_user_text',
2744 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2746 array( 'LIMIT' => 20 )
2749 if ( $res === false ) {
2750 // This page has no revisions, which is very weird
2754 $hasHistory = ( $res->numRows() > 1 );
2755 $row = $dbw->fetchObject( $res );
2757 if ( $row ) { // $row is false if the only contributor is hidden
2758 $onlyAuthor = $row->rev_user_text
;
2759 // Try to find a second contributor
2760 foreach ( $res as $row ) {
2761 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2762 $onlyAuthor = false;
2767 $onlyAuthor = false;
2770 // Generate the summary with a '$1' placeholder
2772 // The current revision is blank and the one before is also
2773 // blank. It's just not our lucky day
2774 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2776 if ( $onlyAuthor ) {
2777 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2779 $reason = wfMsgForContent( 'excontent', '$1' );
2783 if ( $reason == '-' ) {
2784 // Allow these UI messages to be blanked out cleanly
2788 // Replace newlines with spaces to prevent uglyness
2789 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2790 // Calculate the maximum amount of chars to get
2791 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2792 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2793 $contents = $wgContLang->truncate( $contents, $maxLength );
2794 // Remove possible unfinished links
2795 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2796 // Now replace the '$1' placeholder
2797 $reason = str_replace( '$1', $contents, $reason );
2804 * UI entry point for page deletion
2806 public function delete() {
2807 global $wgUser, $wgOut, $wgRequest;
2809 $confirm = $wgRequest->wasPosted() &&
2810 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2812 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2813 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2815 $reason = $this->DeleteReasonList
;
2817 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
2818 // Entry from drop down menu + additional comment
2819 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2820 } elseif ( $reason == 'other' ) {
2821 $reason = $this->DeleteReason
;
2824 # Flag to hide all contents of the archived revisions
2825 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2827 # This code desperately needs to be totally rewritten
2829 # Read-only check...
2830 if ( wfReadOnly() ) {
2831 $wgOut->readOnlyPage();
2837 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgUser );
2839 if ( count( $permission_errors ) > 0 ) {
2840 $wgOut->showPermissionsErrorPage( $permission_errors );
2845 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2847 # Better double-check that it hasn't been deleted yet!
2848 $dbw = wfGetDB( DB_MASTER
);
2849 $conds = $this->mTitle
->pageCond();
2850 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2851 if ( $latest === false ) {
2852 $wgOut->showFatalError(
2855 array( 'class' => 'error mw-error-cannotdelete' ),
2856 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2859 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2860 LogEventsList
::showLogExtract(
2863 $this->mTitle
->getPrefixedText()
2869 # Hack for big sites
2870 $bigHistory = $this->isBigDeletion();
2871 if ( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2872 global $wgLang, $wgDeleteRevisionsLimit;
2874 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2875 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2881 $this->doDelete( $reason, $suppress );
2883 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2885 } elseif ( $this->mTitle
->userIsWatching() ) {
2892 // Generate deletion reason
2893 $hasHistory = false;
2895 $reason = $this->generateReason( $hasHistory );
2898 // If the page has a history, insert a warning
2899 if ( $hasHistory && !$confirm ) {
2902 $skin = $wgUser->getSkin();
2903 $revisions = $this->estimateRevisionCount();
2905 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2906 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2907 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2911 if ( $bigHistory ) {
2912 global $wgDeleteRevisionsLimit;
2913 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2914 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2918 return $this->confirmDelete( $reason );
2922 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2924 public function isBigDeletion() {
2925 global $wgDeleteRevisionsLimit;
2927 if ( $wgDeleteRevisionsLimit ) {
2928 $revCount = $this->estimateRevisionCount();
2930 return $revCount > $wgDeleteRevisionsLimit;
2937 * @return int approximate revision count
2939 public function estimateRevisionCount() {
2940 $dbr = wfGetDB( DB_SLAVE
);
2942 // For an exact count...
2943 // return $dbr->selectField( 'revision', 'COUNT(*)',
2944 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2945 return $dbr->estimateRowCount( 'revision', '*',
2946 array( 'rev_page' => $this->getId() ), __METHOD__
);
2950 * Get the last N authors
2951 * @param $num Integer: number of revisions to get
2952 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2953 * @return array Array of authors, duplicates not removed
2955 public function getLastNAuthors( $num, $revLatest = 0 ) {
2956 wfProfileIn( __METHOD__
);
2957 // First try the slave
2958 // If that doesn't have the latest revision, try the master
2960 $db = wfGetDB( DB_SLAVE
);
2963 $res = $db->select( array( 'page', 'revision' ),
2964 array( 'rev_id', 'rev_user_text' ),
2966 'page_namespace' => $this->mTitle
->getNamespace(),
2967 'page_title' => $this->mTitle
->getDBkey(),
2968 'rev_page = page_id'
2969 ), __METHOD__
, $this->getSelectOptions( array(
2970 'ORDER BY' => 'rev_timestamp DESC',
2976 wfProfileOut( __METHOD__
);
2980 $row = $db->fetchObject( $res );
2982 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
2983 $db = wfGetDB( DB_MASTER
);
2988 } while ( $continue );
2990 $authors = array( $row->rev_user_text
);
2992 foreach ( $res as $row ) {
2993 $authors[] = $row->rev_user_text
;
2996 wfProfileOut( __METHOD__
);
3001 * Output deletion confirmation dialog
3002 * FIXME: Move to another file?
3003 * @param $reason String: prefilled reason
3005 public function confirmDelete( $reason ) {
3006 global $wgOut, $wgUser;
3008 wfDebug( "Article::confirmDelete\n" );
3010 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle
);
3011 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3012 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3013 $wgOut->addWikiMsg( 'confirmdeletetext' );
3015 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3017 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3018 $suppress = "<tr id=\"wpDeleteSuppressRow\">
3020 <td class='mw-input'><strong>" .
3021 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
3022 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3028 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
3030 $form = Xml
::openElement( 'form', array( 'method' => 'post',
3031 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3032 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3033 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3034 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3035 "<tr id=\"wpDeleteReasonListRow\">
3036 <td class='mw-label'>" .
3037 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3039 <td class='mw-input'>" .
3040 Xml
::listDropDown( 'wpDeleteReasonList',
3041 wfMsgForContent( 'deletereason-dropdown' ),
3042 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3045 <tr id=\"wpDeleteReasonRow\">
3046 <td class='mw-label'>" .
3047 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3049 <td class='mw-input'>" .
3050 Html
::input( 'wpReason', $reason, 'text', array(
3052 'maxlength' => '255',
3060 # Disallow watching if user is not logged in
3061 if ( $wgUser->isLoggedIn() ) {
3065 <td class='mw-input'>" .
3066 Xml
::checkLabel( wfMsg( 'watchthis' ),
3067 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3076 <td class='mw-submit'>" .
3077 Xml
::submitButton( wfMsg( 'deletepage' ),
3078 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3081 Xml
::closeElement( 'table' ) .
3082 Xml
::closeElement( 'fieldset' ) .
3083 Html
::hidden( 'wpEditToken', $wgUser->editToken() ) .
3084 Xml
::closeElement( 'form' );
3086 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3087 $skin = $wgUser->getSkin();
3088 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
3089 $link = $skin->link(
3091 wfMsgHtml( 'delete-edit-reasonlist' ),
3093 array( 'action' => 'edit' )
3095 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3098 $wgOut->addHTML( $form );
3099 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3100 LogEventsList
::showLogExtract( $wgOut, 'delete',
3101 $this->mTitle
->getPrefixedText()
3106 * Perform a deletion and output success or failure messages
3108 public function doDelete( $reason, $suppress = false ) {
3109 global $wgOut, $wgUser;
3111 $id = $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
3114 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3115 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3116 $deleted = $this->mTitle
->getPrefixedText();
3118 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3119 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3121 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3123 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3124 $wgOut->returnToMain( false );
3125 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3128 if ( $error == '' ) {
3129 $wgOut->showFatalError(
3132 array( 'class' => 'error mw-error-cannotdelete' ),
3133 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
3137 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3139 LogEventsList
::showLogExtract(
3142 $this->mTitle
->getPrefixedText()
3145 $wgOut->showFatalError( $error );
3151 * Back-end article deletion
3152 * Deletes the article with database consistency, writes logs, purges caches
3154 * @param $reason string delete reason for deletion log
3155 * @param suppress bitfield
3156 * Revision::DELETED_TEXT
3157 * Revision::DELETED_COMMENT
3158 * Revision::DELETED_USER
3159 * Revision::DELETED_RESTRICTED
3160 * @param $id int article ID
3161 * @param $commit boolean defaults to true, triggers transaction end
3162 * @return boolean true if successful
3164 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3165 global $wgDeferredUpdateList, $wgUseTrackbacks;
3167 wfDebug( __METHOD__
. "\n" );
3169 $dbw = wfGetDB( DB_MASTER
);
3170 $t = $this->mTitle
->getDBkey();
3171 $id = $id ?
$id : $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
3173 if ( $t === '' ||
$id == 0 ) {
3177 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3178 array_push( $wgDeferredUpdateList, $u );
3180 // Bitfields to further suppress the content
3183 // This should be 15...
3184 $bitfield |
= Revision
::DELETED_TEXT
;
3185 $bitfield |
= Revision
::DELETED_COMMENT
;
3186 $bitfield |
= Revision
::DELETED_USER
;
3187 $bitfield |
= Revision
::DELETED_RESTRICTED
;
3189 $bitfield = 'rev_deleted';
3193 // For now, shunt the revision data into the archive table.
3194 // Text is *not* removed from the text table; bulk storage
3195 // is left intact to avoid breaking block-compression or
3196 // immutable storage schemes.
3198 // For backwards compatibility, note that some older archive
3199 // table entries will have ar_text and ar_flags fields still.
3201 // In the future, we may keep revisions and mark them with
3202 // the rev_deleted field, which is reserved for this purpose.
3203 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3205 'ar_namespace' => 'page_namespace',
3206 'ar_title' => 'page_title',
3207 'ar_comment' => 'rev_comment',
3208 'ar_user' => 'rev_user',
3209 'ar_user_text' => 'rev_user_text',
3210 'ar_timestamp' => 'rev_timestamp',
3211 'ar_minor_edit' => 'rev_minor_edit',
3212 'ar_rev_id' => 'rev_id',
3213 'ar_text_id' => 'rev_text_id',
3214 'ar_text' => '\'\'', // Be explicit to appease
3215 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3216 'ar_len' => 'rev_len',
3217 'ar_page_id' => 'page_id',
3218 'ar_deleted' => $bitfield
3221 'page_id = rev_page'
3225 # Delete restrictions for it
3226 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
3228 # Now that it's safely backed up, delete it
3229 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
3230 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3237 # Fix category table counts
3239 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
3241 foreach ( $res as $row ) {
3242 $cats [] = $row->cl_to
;
3245 $this->updateCategoryCounts( array(), $cats );
3247 # If using cascading deletes, we can skip some explicit deletes
3248 if ( !$dbw->cascadingDeletes() ) {
3249 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
3251 if ( $wgUseTrackbacks )
3252 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
3254 # Delete outgoing links
3255 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3256 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3257 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3258 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3259 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3260 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3261 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3264 # If using cleanup triggers, we can skip some manual deletes
3265 if ( !$dbw->cleanupTriggers() ) {
3266 # Clean up recentchanges entries...
3267 $dbw->delete( 'recentchanges',
3268 array( 'rc_type != ' . RC_LOG
,
3269 'rc_namespace' => $this->mTitle
->getNamespace(),
3270 'rc_title' => $this->mTitle
->getDBkey() ),
3272 $dbw->delete( 'recentchanges',
3273 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
3278 Article
::onArticleDelete( $this->mTitle
);
3280 # Clear the cached article id so the interface doesn't act like we exist
3281 $this->mTitle
->resetArticleID( 0 );
3283 # Log the deletion, if the page was suppressed, log it at Oversight instead
3284 $logtype = $suppress ?
'suppress' : 'delete';
3285 $log = new LogPage( $logtype );
3287 # Make sure logging got through
3288 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
3298 * Roll back the most recent consecutive set of edits to a page
3299 * from the same user; fails if there are no eligible edits to
3300 * roll back to, e.g. user is the sole contributor. This function
3301 * performs permissions checks on $wgUser, then calls commitRollback()
3302 * to do the dirty work
3304 * @param $fromP String: Name of the user whose edits to rollback.
3305 * @param $summary String: Custom summary. Set to default summary if empty.
3306 * @param $token String: Rollback token.
3307 * @param $bot Boolean: If true, mark all reverted edits as bot.
3309 * @param $resultDetails Array: contains result-specific array of additional values
3310 * 'alreadyrolled' : 'current' (rev)
3311 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3313 * @return array of errors, each error formatted as
3314 * array(messagekey, param1, param2, ...).
3315 * On success, the array is empty. This array can also be passed to
3316 * OutputPage::showPermissionsErrorPage().
3318 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3321 $resultDetails = null;
3324 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
3325 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
3326 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3328 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
3329 $errors[] = array( 'sessionfailure' );
3332 if ( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3333 $errors[] = array( 'actionthrottledtext' );
3336 # If there were errors, bail out now
3337 if ( !empty( $errors ) ) {
3341 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3345 * Backend implementation of doRollback(), please refer there for parameter
3346 * and return value documentation
3348 * NOTE: This function does NOT check ANY permissions, it just commits the
3349 * rollback to the DB Therefore, you should only call this function direct-
3350 * ly if you want to use custom permissions checks. If you don't, use
3351 * doRollback() instead.
3353 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3354 global $wgUseRCPatrol, $wgUser, $wgLang;
3356 $dbw = wfGetDB( DB_MASTER
);
3358 if ( wfReadOnly() ) {
3359 return array( array( 'readonlytext' ) );
3362 # Get the last editor
3363 $current = Revision
::newFromTitle( $this->mTitle
);
3364 if ( is_null( $current ) ) {
3365 # Something wrong... no page?
3366 return array( array( 'notanarticle' ) );
3369 $from = str_replace( '_', ' ', $fromP );
3370 # User name given should match up with the top revision.
3371 # If the user was deleted then $from should be empty.
3372 if ( $from != $current->getUserText() ) {
3373 $resultDetails = array( 'current' => $current );
3374 return array( array( 'alreadyrolled',
3375 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3376 htmlspecialchars( $fromP ),
3377 htmlspecialchars( $current->getUserText() )
3381 # Get the last edit not by this guy...
3382 # Note: these may not be public values
3383 $user = intval( $current->getRawUser() );
3384 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3385 $s = $dbw->selectRow( 'revision',
3386 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3387 array( 'rev_page' => $current->getPage(),
3388 "rev_user != {$user} OR rev_user_text != {$user_text}"
3390 array( 'USE INDEX' => 'page_timestamp',
3391 'ORDER BY' => 'rev_timestamp DESC' )
3393 if ( $s === false ) {
3394 # No one else ever edited this page
3395 return array( array( 'cantrollback' ) );
3396 } else if ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
3397 # Only admins can see this text
3398 return array( array( 'notvisiblerev' ) );
3402 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3403 # Mark all reverted edits as bot
3407 if ( $wgUseRCPatrol ) {
3408 # Mark all reverted edits as patrolled
3409 $set['rc_patrolled'] = 1;
3412 if ( count( $set ) ) {
3413 $dbw->update( 'recentchanges', $set,
3415 'rc_cur_id' => $current->getPage(),
3416 'rc_user_text' => $current->getUserText(),
3417 "rc_timestamp > '{$s->rev_timestamp}'",
3422 # Generate the edit summary if necessary
3423 $target = Revision
::newFromId( $s->rev_id
);
3424 if ( empty( $summary ) ) {
3425 if ( $from == '' ) { // no public user name
3426 $summary = wfMsgForContent( 'revertpage-nouser' );
3428 $summary = wfMsgForContent( 'revertpage' );
3432 # Allow the custom summary to use the same args as the default message
3434 $target->getUserText(), $from, $s->rev_id
,
3435 $wgLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
), true ),
3436 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3438 $summary = wfMsgReplaceArgs( $summary, $args );
3441 $flags = EDIT_UPDATE
;
3443 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3444 $flags |
= EDIT_MINOR
;
3447 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) ||
$wgUser->isAllowed( 'bot' ) ) ) {
3448 $flags |
= EDIT_FORCE_BOT
;
3451 # Actually store the edit
3452 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3453 if ( !empty( $status->value
['revision'] ) ) {
3454 $revId = $status->value
['revision']->getId();
3459 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3461 $resultDetails = array(
3462 'summary' => $summary,
3463 'current' => $current,
3464 'target' => $target,
3472 * User interface for rollback operations
3474 public function rollback() {
3475 global $wgUser, $wgOut, $wgRequest;
3479 $result = $this->doRollback(
3480 $wgRequest->getVal( 'from' ),
3481 $wgRequest->getText( 'summary' ),
3482 $wgRequest->getVal( 'token' ),
3483 $wgRequest->getBool( 'bot' ),
3487 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3488 $wgOut->rateLimited();
3492 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3493 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3494 $errArray = $result[0];
3495 $errMsg = array_shift( $errArray );
3496 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3498 if ( isset( $details['current'] ) ) {
3499 $current = $details['current'];
3501 if ( $current->getComment() != '' ) {
3502 $wgOut->addWikiMsgArray( 'editcomment', array(
3503 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3510 # Display permissions errors before read-only message -- there's no
3511 # point in misleading the user into thinking the inability to rollback
3512 # is only temporary.
3513 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3514 # array_diff is completely broken for arrays of arrays, sigh.
3515 # Remove any 'readonlytext' error manually.
3517 foreach ( $result as $error ) {
3518 if ( $error != array( 'readonlytext' ) ) {
3522 $wgOut->showPermissionsErrorPage( $out );
3527 if ( $result == array( array( 'readonlytext' ) ) ) {
3528 $wgOut->readOnlyPage();
3533 $current = $details['current'];
3534 $target = $details['target'];
3535 $newId = $details['newid'];
3536 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3537 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3539 if ( $current->getUserText() === '' ) {
3540 $old = wfMsg( 'rev-deleted-user' );
3542 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3543 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3546 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3547 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3548 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3549 $wgOut->returnToMain( false, $this->mTitle
);
3551 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3552 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3553 $de->showDiff( '', '' );
3558 * Do standard deferred updates after page view
3560 public function viewUpdates() {
3561 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3562 if ( wfReadOnly() ) {
3566 # Don't update page view counters on views from bot users (bug 14044)
3567 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3568 $wgDeferredUpdateList[] = new ViewCountUpdate( $this->getID() );
3569 $wgDeferredUpdateList[] = new SiteStatsUpdate( 1, 0, 0 );
3572 # Update newtalk / watchlist notification status
3573 $wgUser->clearNotification( $this->mTitle
);
3577 * Prepare text which is about to be saved.
3578 * Returns a stdclass with source, pst and output members
3580 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
3581 if ( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid ) {
3583 return $this->mPreparedEdit
;
3588 $edit = (object)array();
3589 $edit->revid
= $revid;
3590 $edit->newText
= $text;
3591 $edit->pst
= $this->preSaveTransform( $text, $user );
3592 $edit->popts
= $this->getParserOptions( true );
3593 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $edit->popts
, true, true, $revid );
3594 $edit->oldText
= $this->getContent();
3596 $this->mPreparedEdit
= $edit;
3602 * Do standard deferred updates after page edit.
3603 * Update links tables, site stats, search index and message cache.
3604 * Purges pages that include this page if the text was changed here.
3605 * Every 100th edit, prune the recent changes table.
3608 * @param $text String: New text of the article
3609 * @param $summary String: Edit summary
3610 * @param $minoredit Boolean: Minor edit
3611 * @param $timestamp_of_pagechange String timestamp associated with the page change
3612 * @param $newid Integer: rev_id value of the new revision
3613 * @param $changed Boolean: Whether or not the content actually changed
3614 * @param $user User object: User doing the edit
3616 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true, User
$user = null ) {
3617 global $wgDeferredUpdateList, $wgMessageCache, $wgUser, $wgEnableParserCache;
3619 wfProfileIn( __METHOD__
);
3622 # Be careful not to double-PST: $text is usually already PST-ed once
3623 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3624 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3625 $editInfo = $this->prepareTextForEdit( $text, $newid, $user );
3627 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3628 $editInfo = $this->mPreparedEdit
;
3631 # Save it to the parser cache
3632 if ( $wgEnableParserCache ) {
3633 $parserCache = ParserCache
::singleton();
3634 $parserCache->save( $editInfo->output
, $this, $editInfo->popts
);
3637 # Update the links tables
3638 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3641 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3643 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3644 if ( 0 == mt_rand( 0, 99 ) ) {
3645 // Flush old entries from the `recentchanges` table; we do this on
3646 // random requests so as to avoid an increase in writes for no good reason
3649 $dbw = wfGetDB( DB_MASTER
);
3650 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3651 $recentchanges = $dbw->tableName( 'recentchanges' );
3652 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3654 $dbw->query( $sql );
3658 $id = $this->getID();
3659 $title = $this->mTitle
->getPrefixedDBkey();
3660 $shortTitle = $this->mTitle
->getDBkey();
3663 wfProfileOut( __METHOD__
);
3667 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3668 array_push( $wgDeferredUpdateList, $u );
3669 $u = new SearchUpdate( $id, $title, $text );
3670 array_push( $wgDeferredUpdateList, $u );
3672 # If this is another user's talk page, update newtalk
3673 # Don't do this if $changed = false otherwise some idiot can null-edit a
3674 # load of user talk pages and piss people off, nor if it's a minor edit
3675 # by a properly-flagged bot.
3676 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3677 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3679 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3680 $other = User
::newFromName( $shortTitle, false );
3682 wfDebug( __METHOD__
. ": invalid username\n" );
3683 } elseif ( User
::isIP( $shortTitle ) ) {
3684 // An anonymous user
3685 $other->setNewtalk( true );
3686 } elseif ( $other->isLoggedIn() ) {
3687 $other->setNewtalk( true );
3689 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3694 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3695 $wgMessageCache->replace( $shortTitle, $text );
3698 wfProfileOut( __METHOD__
);
3702 * Perform article updates on a special page creation.
3704 * @param $rev Revision object
3706 * @todo This is a shitty interface function. Kill it and replace the
3707 * other shitty functions like editUpdates and such so it's not needed
3710 public function createUpdates( $rev ) {
3711 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3712 $this->mTotalAdjustment
= 1;
3713 $this->editUpdates( $rev->getText(), $rev->getComment(),
3714 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3718 * Generate the navigation links when browsing through an article revisions
3719 * It shows the information as:
3720 * Revision as of \<date\>; view current revision
3721 * \<- Previous version | Next Version -\>
3723 * @param $oldid String: revision ID of this article revision
3725 public function setOldSubtitle( $oldid = 0 ) {
3726 global $wgLang, $wgOut, $wgUser, $wgRequest;
3728 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3732 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3734 # Cascade unhide param in links for easy deletion browsing
3735 $extraParams = array();
3736 if ( $wgRequest->getVal( 'unhide' ) ) {
3737 $extraParams['unhide'] = 1;
3740 $revision = Revision
::newFromId( $oldid );
3742 $current = ( $oldid == $this->mLatest
);
3743 $td = $wgLang->timeanddate( $this->mTimestamp
, true );
3744 $tddate = $wgLang->date( $this->mTimestamp
, true );
3745 $tdtime = $wgLang->time( $this->mTimestamp
, true );
3746 $sk = $wgUser->getSkin();
3748 ?
wfMsgHtml( 'currentrevisionlink' )
3751 wfMsgHtml( 'currentrevisionlink' ),
3754 array( 'known', 'noclasses' )
3757 ?
wfMsgHtml( 'diff' )
3760 wfMsgHtml( 'diff' ),
3766 array( 'known', 'noclasses' )
3768 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3772 wfMsgHtml( 'previousrevision' ),
3775 'direction' => 'prev',
3778 array( 'known', 'noclasses' )
3780 : wfMsgHtml( 'previousrevision' );
3784 wfMsgHtml( 'diff' ),
3790 array( 'known', 'noclasses' )
3792 : wfMsgHtml( 'diff' );
3793 $nextlink = $current
3794 ?
wfMsgHtml( 'nextrevision' )
3797 wfMsgHtml( 'nextrevision' ),
3800 'direction' => 'next',
3803 array( 'known', 'noclasses' )
3805 $nextdiff = $current
3806 ?
wfMsgHtml( 'diff' )
3809 wfMsgHtml( 'diff' ),
3815 array( 'known', 'noclasses' )
3820 // User can delete revisions or view deleted revisions...
3821 $canHide = $wgUser->isAllowed( 'deleterevision' );
3822 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3823 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3824 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3827 'type' => 'revision',
3828 'target' => $this->mTitle
->getPrefixedDbkey(),
3831 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
3836 # Show user links if allowed to see them. If hidden, then show them only if requested...
3837 $userlinks = $sk->revUserTools( $revision, !$unhide );
3839 $m = wfMsg( 'revision-info-current' );
3840 $infomsg = $current && !wfEmptyMsg( 'revision-info-current', $m ) && $m != '-'
3841 ?
'revision-info-current'
3844 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3847 array( 'parseinline', 'replaceafter' ),
3853 $revision->getUser()
3856 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3857 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3859 $wgOut->setSubtitle( $r );
3863 * This function is called right before saving the wikitext,
3864 * so we can do things like signatures and links-in-context.
3866 * @param $text String article contents
3867 * @param $user User object: user doing the edit, $wgUser will be used if
3869 * @return string article contents with altered wikitext markup (signatures
3870 * converted, {{subst:}}, templates, etc.)
3872 public function preSaveTransform( $text, User
$user = null ) {
3875 if ( $user === null ) {
3880 return $wgParser->preSaveTransform( $text, $this->mTitle
, $user, ParserOptions
::newFromUser( $user ) );
3883 /* Caching functions */
3886 * checkLastModified returns true if it has taken care of all
3887 * output to the client that is necessary for this request.
3888 * (that is, it has sent a cached version of the page)
3890 * @return boolean true if cached version send, false otherwise
3892 protected function tryFileCache() {
3893 static $called = false;
3896 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3901 if ( $this->isFileCacheable() ) {
3902 $cache = new HTMLFileCache( $this->mTitle
);
3903 if ( $cache->isFileCacheGood( $this->mTouched
) ) {
3904 wfDebug( "Article::tryFileCache(): about to load file\n" );
3905 $cache->loadFromFileCache();
3908 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3909 ob_start( array( &$cache, 'saveToFileCache' ) );
3912 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3919 * Check if the page can be cached
3922 public function isFileCacheable() {
3925 if ( HTMLFileCache
::useFileCache() ) {
3926 $cacheable = $this->getID() && !$this->mRedirectedFrom
&& !$this->mTitle
->isRedirect();
3927 // Extension may have reason to disable file caching on some pages.
3929 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3937 * Loads page_touched and returns a value indicating if it should be used
3938 * @return boolean true if not a redirect
3940 public function checkTouched() {
3941 if ( !$this->mDataLoaded
) {
3942 $this->loadPageData();
3945 return !$this->mIsRedirect
;
3949 * Get the page_touched field
3950 * @return string containing GMT timestamp
3952 public function getTouched() {
3953 if ( !$this->mDataLoaded
) {
3954 $this->loadPageData();
3957 return $this->mTouched
;
3961 * Get the page_latest field
3962 * @return integer rev_id of current revision
3964 public function getLatest() {
3965 if ( !$this->mDataLoaded
) {
3966 $this->loadPageData();
3969 return (int)$this->mLatest
;
3973 * Edit an article without doing all that other stuff
3974 * The article must already exist; link tables etc
3975 * are not updated, caches are not flushed.
3977 * @param $text String: text submitted
3978 * @param $comment String: comment submitted
3979 * @param $minor Boolean: whereas it's a minor modification
3981 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3982 wfProfileIn( __METHOD__
);
3984 $dbw = wfGetDB( DB_MASTER
);
3985 $revision = new Revision( array(
3986 'page' => $this->getId(),
3988 'comment' => $comment,
3989 'minor_edit' => $minor ?
1 : 0,
3991 $revision->insertOn( $dbw );
3992 $this->updateRevisionOn( $dbw, $revision );
3995 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
3997 wfProfileOut( __METHOD__
);
4001 * The onArticle*() functions are supposed to be a kind of hooks
4002 * which should be called whenever any of the specified actions
4005 * This is a good place to put code to clear caches, for instance.
4007 * This is called on page move and undelete, as well as edit
4009 * @param $title Title object
4011 public static function onArticleCreate( $title ) {
4012 # Update existence markers on article/talk tabs...
4013 if ( $title->isTalkPage() ) {
4014 $other = $title->getSubjectPage();
4016 $other = $title->getTalkPage();
4019 $other->invalidateCache();
4020 $other->purgeSquid();
4022 $title->touchLinks();
4023 $title->purgeSquid();
4024 $title->deleteTitleProtection();
4028 * Clears caches when article is deleted
4030 public static function onArticleDelete( $title ) {
4031 global $wgMessageCache;
4033 # Update existence markers on article/talk tabs...
4034 if ( $title->isTalkPage() ) {
4035 $other = $title->getSubjectPage();
4037 $other = $title->getTalkPage();
4040 $other->invalidateCache();
4041 $other->purgeSquid();
4043 $title->touchLinks();
4044 $title->purgeSquid();
4047 HTMLFileCache
::clearFileCache( $title );
4050 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
4051 $wgMessageCache->replace( $title->getDBkey(), false );
4055 if ( $title->getNamespace() == NS_FILE
) {
4056 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4057 $update->doUpdate();
4061 if ( $title->getNamespace() == NS_USER_TALK
) {
4062 $user = User
::newFromName( $title->getText(), false );
4063 $user->setNewtalk( false );
4067 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4071 * Purge caches on page update etc
4073 * @param $title Title object
4074 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4076 public static function onArticleEdit( $title ) {
4077 global $wgDeferredUpdateList;
4079 // Invalidate caches of articles which include this page
4080 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4082 // Invalidate the caches of all pages which redirect here
4083 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4085 # Purge squid for this page only
4086 $title->purgeSquid();
4088 # Clear file cache for this page only
4089 HTMLFileCache
::clearFileCache( $title );
4095 * Overriden by ImagePage class, only present here to avoid a fatal error
4096 * Called for ?action=revert
4098 public function revert() {
4100 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4104 * Info about this page
4105 * Called for ?action=info when $wgAllowPageInfo is on.
4107 public function info() {
4108 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4110 if ( !$wgAllowPageInfo ) {
4111 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4115 $page = $this->mTitle
->getSubjectPage();
4117 $wgOut->setPagetitle( $page->getPrefixedText() );
4118 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4119 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4121 if ( !$this->mTitle
->exists() ) {
4122 $wgOut->addHTML( '<div class="noarticletext">' );
4123 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
4124 // This doesn't quite make sense; the user is asking for
4125 // information about the _page_, not the message... -- RC
4126 $wgOut->addHTML( htmlspecialchars( wfMsgWeirdKey( $this->mTitle
->getText() ) ) );
4128 $msg = $wgUser->isLoggedIn()
4130 : 'noarticletextanon';
4131 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4134 $wgOut->addHTML( '</div>' );
4136 $dbr = wfGetDB( DB_SLAVE
);
4138 'wl_title' => $page->getDBkey(),
4139 'wl_namespace' => $page->getNamespace() );
4140 $numwatchers = $dbr->selectField(
4145 $this->getSelectOptions() );
4147 $pageInfo = $this->pageCountInfo( $page );
4148 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4151 //FIXME: unescaped messages
4152 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4153 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4156 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4159 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4162 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4165 $wgOut->addHTML( '</ul>' );
4170 * Return the total number of edits and number of unique editors
4171 * on a given page. If page does not exist, returns false.
4173 * @param $title Title object
4174 * @return mixed array or boolean false
4176 public function pageCountInfo( $title ) {
4177 $id = $title->getArticleId();
4183 $dbr = wfGetDB( DB_SLAVE
);
4184 $rev_clause = array( 'rev_page' => $id );
4185 $edits = $dbr->selectField(
4190 $this->getSelectOptions()
4192 $authors = $dbr->selectField(
4194 'COUNT(DISTINCT rev_user_text)',
4197 $this->getSelectOptions()
4200 return array( 'edits' => $edits, 'authors' => $authors );
4204 * Return a list of templates used by this article.
4205 * Uses the templatelinks table
4207 * @return Array of Title objects
4209 public function getUsedTemplates() {
4211 $id = $this->mTitle
->getArticleID();
4217 $dbr = wfGetDB( DB_SLAVE
);
4218 $res = $dbr->select( array( 'templatelinks' ),
4219 array( 'tl_namespace', 'tl_title' ),
4220 array( 'tl_from' => $id ),
4223 if ( $res !== false ) {
4224 foreach ( $res as $row ) {
4225 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
4233 * Returns a list of hidden categories this page is a member of.
4234 * Uses the page_props and categorylinks tables.
4236 * @return Array of Title objects
4238 public function getHiddenCategories() {
4240 $id = $this->mTitle
->getArticleID();
4246 $dbr = wfGetDB( DB_SLAVE
);
4247 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4249 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4250 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
4253 if ( $res !== false ) {
4254 foreach ( $res as $row ) {
4255 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
4263 * Return an applicable autosummary if one exists for the given edit.
4264 * @param $oldtext String: the previous text of the page.
4265 * @param $newtext String: The submitted text of the page.
4266 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
4267 * @return string An appropriate autosummary, or an empty string.
4269 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4272 # Decide what kind of autosummary is needed.
4274 # Redirect autosummaries
4275 $ot = Title
::newFromRedirect( $oldtext );
4276 $rt = Title
::newFromRedirect( $newtext );
4278 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
4279 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4282 # New page autosummaries
4283 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
4284 # If they're making a new article, give its text, truncated, in the summary.
4286 $truncatedtext = $wgContLang->truncate(
4287 str_replace( "\n", ' ', $newtext ),
4288 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4290 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4293 # Blanking autosummaries
4294 if ( $oldtext != '' && $newtext == '' ) {
4295 return wfMsgForContent( 'autosumm-blank' );
4296 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4297 # Removing more than 90% of the article
4299 $truncatedtext = $wgContLang->truncate(
4301 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4303 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4306 # If we reach this point, there's no applicable autosummary for our case, so our
4307 # autosummary is empty.
4312 * Add the primary page-view wikitext to the output buffer
4313 * Saves the text into the parser cache if possible.
4314 * Updates templatelinks if it is out of date.
4316 * @param $text String
4317 * @param $cache Boolean
4318 * @param $parserOptions mixed ParserOptions object, or boolean false
4320 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4323 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4324 $wgOut->addParserOutput( $this->mParserOutput
);
4328 * This does all the heavy lifting for outputWikitext, except it returns the parser
4329 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4330 * say, embedding thread pages within a discussion system (LiquidThreads)
4332 * @param $text string
4333 * @param $cache boolean
4334 * @param $parserOptions parsing options, defaults to false
4335 * @return string containing parsed output
4337 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4338 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4340 if ( !$parserOptions ) {
4341 $parserOptions = $this->getParserOptions();
4345 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
4346 $parserOptions, true, true, $this->getRevIdFetched() );
4351 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4352 $this->mTitle
->getPrefixedDBkey() ) );
4355 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
4356 $parserCache = ParserCache
::singleton();
4357 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4360 // Make sure file cache is not used on uncacheable content.
4361 // Output that has magic words in it can still use the parser cache
4362 // (if enabled), though it will generally expire sooner.
4363 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
4364 $wgUseFileCache = false;
4367 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4369 return $this->mParserOutput
;
4373 * Get parser options suitable for rendering the primary article wikitext
4374 * @param $canonical boolean Determines that the generated must not depend on user preferences (see bug 14404)
4375 * @return mixed ParserOptions object or boolean false
4377 public function getParserOptions( $canonical = false ) {
4378 global $wgUser, $wgLanguageCode;
4380 if ( !$this->mParserOptions ||
$canonical ) {
4381 $user = !$canonical ?
$wgUser : new User
;
4382 $parserOptions = new ParserOptions( $user );
4383 $parserOptions->setTidy( true );
4384 $parserOptions->enableLimitReport();
4387 $parserOptions->setUserLang( $wgLanguageCode ); # Must be set explicitely
4388 return $parserOptions;
4390 $this->mParserOptions
= $parserOptions;
4393 // Clone to allow modifications of the return value without affecting
4395 return clone $this->mParserOptions
;
4399 * Updates cascading protections
4401 * @param $parserOutput mixed ParserOptions object, or boolean false
4403 protected function doCascadeProtectionUpdates( $parserOutput ) {
4404 if ( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4408 // templatelinks table may have become out of sync,
4409 // especially if using variable-based transclusions.
4410 // For paranoia, check if things have changed and if
4411 // so apply updates to the database. This will ensure
4412 // that cascaded protections apply as soon as the changes
4415 # Get templates from templatelinks
4416 $id = $this->mTitle
->getArticleID();
4418 $tlTemplates = array();
4420 $dbr = wfGetDB( DB_SLAVE
);
4421 $res = $dbr->select( array( 'templatelinks' ),
4422 array( 'tl_namespace', 'tl_title' ),
4423 array( 'tl_from' => $id ),
4427 foreach ( $res as $row ) {
4428 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4431 # Get templates from parser output.
4432 $poTemplates = array();
4433 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4434 foreach ( $templates as $dbk => $id ) {
4435 $poTemplates["$ns:$dbk"] = true;
4440 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4442 if ( count( $templates_diff ) > 0 ) {
4443 # Whee, link updates time.
4444 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4450 * Update all the appropriate counts in the category table, given that
4451 * we've added the categories $added and deleted the categories $deleted.
4453 * @param $added array The names of categories that were added
4454 * @param $deleted array The names of categories that were deleted
4456 public function updateCategoryCounts( $added, $deleted ) {
4457 $ns = $this->mTitle
->getNamespace();
4458 $dbw = wfGetDB( DB_MASTER
);
4460 # First make sure the rows exist. If one of the "deleted" ones didn't
4461 # exist, we might legitimately not create it, but it's simpler to just
4462 # create it and then give it a negative value, since the value is bogus
4465 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4466 $insertCats = array_merge( $added, $deleted );
4467 if ( !$insertCats ) {
4468 # Okay, nothing to do
4472 $insertRows = array();
4474 foreach ( $insertCats as $cat ) {
4475 $insertRows[] = array(
4476 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4480 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4482 $addFields = array( 'cat_pages = cat_pages + 1' );
4483 $removeFields = array( 'cat_pages = cat_pages - 1' );
4485 if ( $ns == NS_CATEGORY
) {
4486 $addFields[] = 'cat_subcats = cat_subcats + 1';
4487 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4488 } elseif ( $ns == NS_FILE
) {
4489 $addFields[] = 'cat_files = cat_files + 1';
4490 $removeFields[] = 'cat_files = cat_files - 1';
4497 array( 'cat_title' => $added ),
4506 array( 'cat_title' => $deleted ),
4513 * Lightweight method to get the parser output for a page, checking the parser cache
4514 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4515 * consider, so it's not appropriate to use there.
4517 * @since 1.16 (r52326) for LiquidThreads
4519 * @param $oldid mixed integer Revision ID or null
4520 * @return ParserOutput
4522 public function getParserOutput( $oldid = null ) {
4523 global $wgEnableParserCache, $wgUser;
4525 // Should the parser cache be used?
4526 $useParserCache = $wgEnableParserCache &&
4527 $wgUser->getStubThreshold() == 0 &&
4531 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4533 if ( $wgUser->getStubThreshold() ) {
4534 wfIncrStats( 'pcache_miss_stub' );
4537 $parserOutput = false;
4538 if ( $useParserCache ) {
4539 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4542 if ( $parserOutput === false ) {
4543 // Cache miss; parse and output it.
4544 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4546 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4548 return $parserOutput;
4554 class PoolWorkArticleView
extends PoolCounterWork
{
4557 function __construct( $article, $key, $useParserCache, $parserOptions ) {
4558 parent
::__construct( 'ArticleView', $key );
4559 $this->mArticle
= $article;
4560 $this->cacheable
= $useParserCache;
4561 $this->parserOptions
= $parserOptions;
4565 return $this->mArticle
->doViewParse();
4568 function getCachedWork() {
4571 $parserCache = ParserCache
::singleton();
4572 $this->mArticle
->mParserOutput
= $parserCache->get( $this->mArticle
, $this->parserOptions
);
4574 if ( $this->mArticle
->mParserOutput
!== false ) {
4575 wfDebug( __METHOD__
. ": showing contents parsed by someone else\n" );
4576 $wgOut->addParserOutput( $this->mArticle
->mParserOutput
);
4577 # Ensure that UI elements requiring revision ID have
4578 # the correct version information.
4579 $wgOut->setRevisionId( $this->mArticle
->getLatest() );
4585 function fallback() {
4586 return $this->mArticle
->tryDirtyCache();
4589 function error( $status ) {
4592 $wgOut->clearHTML(); // for release() errors
4593 $wgOut->enableClientCache( false );
4594 $wgOut->setRobotPolicy( 'noindex,nofollow' );
4596 $errortext = $status->getWikiText( false, 'view-pool-error' );
4597 $wgOut->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );