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 protected $mContext; // !< RequestContext
23 var $mContentLoaded = false; // !<
24 var $mCounter = -1; // !< Not loaded
25 var $mDataLoaded = false; // !<
26 var $mForUpdate = false; // !<
27 var $mGoodAdjustment = 0; // !<
28 var $mIsRedirect = false; // !<
29 var $mLatest = false; // !<
31 var $mPreparedEdit = false; // !< Title object if set
32 var $mRedirectedFrom = null; // !< Title object if set
33 var $mRedirectTarget = null; // !< Title object if set
34 var $mRedirectUrl = false; // !<
35 var $mRevIdFetched = 0; // !<
36 var $mLastRevision = null; // !< Latest revision if set
37 var $mRevision = null; // !< Loaded revision object if set
38 var $mTimestamp = ''; // !<
39 var $mTitle; // !< Title object
40 var $mTotalAdjustment = 0; // !<
41 var $mTouched = '19700101000000'; // !<
42 var $mParserOptions; // !< ParserOptions object
43 var $mParserOutput; // !< ParserCache object if set
47 * Constructor and clear the article
48 * @param $title Reference to a Title object.
49 * @param $oldId Integer revision ID, null to fetch from request, zero for current
51 public function __construct( Title
$title, $oldId = null ) {
52 // FIXME: does the reference play any role here?
53 $this->mTitle
=& $title;
54 $this->mOldId
= $oldId;
58 * Constructor from an page id
59 * @param $id Int article ID to load
61 public static function newFromID( $id ) {
62 $t = Title
::newFromID( $id );
63 # FIXME: doesn't inherit right
64 return $t == null ?
null : new self( $t );
65 # return $t == null ? null : new static( $t ); // PHP 5.3
69 * Tell the page view functions that this view was redirected
70 * from another page on the wiki.
71 * @param $from Title object.
73 public function setRedirectedFrom( Title
$from ) {
74 $this->mRedirectedFrom
= $from;
78 * If this page is a redirect, get its target
80 * The target will be fetched from the redirect table if possible.
81 * If this page doesn't have an entry there, call insertRedirect()
82 * @return mixed Title object, or null if this page is not a redirect
84 public function getRedirectTarget() {
85 if ( !$this->mTitle
->isRedirect() ) {
89 if ( $this->mRedirectTarget
!== null ) {
90 return $this->mRedirectTarget
;
93 # Query the redirect table
94 $dbr = wfGetDB( DB_SLAVE
);
95 $row = $dbr->selectRow( 'redirect',
96 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
97 array( 'rd_from' => $this->getID() ),
101 // rd_fragment and rd_interwiki were added later, populate them if empty
102 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
103 return $this->mRedirectTarget
= Title
::makeTitle(
104 $row->rd_namespace
, $row->rd_title
,
105 $row->rd_fragment
, $row->rd_interwiki
);
108 # This page doesn't have an entry in the redirect table
109 return $this->mRedirectTarget
= $this->insertRedirect();
113 * Insert an entry for this page into the redirect table.
115 * Don't call this function directly unless you know what you're doing.
116 * @return Title object or null if not a redirect
118 public function insertRedirect() {
119 // recurse through to only get the final target
120 $retval = Title
::newFromRedirectRecurse( $this->getRawText() );
124 $this->insertRedirectEntry( $retval );
129 * Insert or update the redirect table entry for this page to indicate
130 * it redirects to $rt .
131 * @param $rt Title redirect target
133 public function insertRedirectEntry( $rt ) {
134 $dbw = wfGetDB( DB_MASTER
);
135 $dbw->replace( 'redirect', array( 'rd_from' ),
137 'rd_from' => $this->getID(),
138 'rd_namespace' => $rt->getNamespace(),
139 'rd_title' => $rt->getDBkey(),
140 'rd_fragment' => $rt->getFragment(),
141 'rd_interwiki' => $rt->getInterwiki(),
148 * Get the Title object or URL this page redirects to
150 * @return mixed false, Title of in-wiki target, or string with URL
152 public function followRedirect() {
153 return $this->getRedirectURL( $this->getRedirectTarget() );
157 * Get the Title object this text redirects to
159 * @param $text string article content containing redirect info
160 * @return mixed false, Title of in-wiki target, or string with URL
161 * @deprecated since 1.17
163 public function followRedirectText( $text ) {
164 // recurse through to only get the final target
165 return $this->getRedirectURL( Title
::newFromRedirectRecurse( $text ) );
169 * Get the Title object or URL to use for a redirect. We use Title
170 * objects for same-wiki, non-special redirects and URLs for everything
172 * @param $rt Title Redirect target
173 * @return mixed false, Title object of local target, or string with URL
175 public function getRedirectURL( $rt ) {
177 if ( $rt->getInterwiki() != '' ) {
178 if ( $rt->isLocal() ) {
179 // Offsite wikis need an HTTP redirect.
181 // This can be hard to reverse and may produce loops,
182 // so they may be disabled in the site configuration.
183 $source = $this->mTitle
->getFullURL( 'redirect=no' );
184 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
187 if ( $rt->getNamespace() == NS_SPECIAL
) {
188 // Gotta handle redirects to special pages differently:
189 // Fill the HTTP response "Location" header and ignore
190 // the rest of the page we're on.
192 // This can be hard to reverse, so they may be disabled.
193 if ( $rt->isSpecial( 'Userlogout' ) ) {
196 return $rt->getFullURL();
204 // No or invalid redirect
209 * Get the title object of the article
210 * @return Title object of this page
212 public function getTitle() {
213 return $this->mTitle
;
218 * FIXME: shouldn't this be public?
221 public function clear() {
222 $this->mDataLoaded
= false;
223 $this->mContentLoaded
= false;
225 $this->mCounter
= -1; # Not loaded
226 $this->mRedirectedFrom
= null; # Title object if set
227 $this->mRedirectTarget
= null; # Title object if set
228 $this->mLastRevision
= null; # Latest revision
229 $this->mTimestamp
= '';
230 $this->mGoodAdjustment
= $this->mTotalAdjustment
= 0;
231 $this->mTouched
= '19700101000000';
232 $this->mForUpdate
= false;
233 $this->mIsRedirect
= false;
234 $this->mRevIdFetched
= 0;
235 $this->mRedirectUrl
= false;
236 $this->mLatest
= false;
237 $this->mPreparedEdit
= false;
241 * Note that getContent/loadContent do not follow redirects anymore.
242 * If you need to fetch redirectable content easily, try
243 * the shortcut in Article::followRedirect()
245 * This function has side effects! Do not use this function if you
246 * only want the real revision text if any.
248 * @return Return the text of this revision
250 public function getContent() {
253 wfProfileIn( __METHOD__
);
255 if ( $this->getID() === 0 ) {
256 # If this is a MediaWiki:x message, then load the messages
257 # and return the message value for x.
258 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
259 $text = $this->mTitle
->getDefaultMessageText();
260 if ( $text === false ) {
264 $text = wfMsgExt( $wgUser->isLoggedIn() ?
'noarticletext' : 'noarticletextanon', 'parsemag' );
266 wfProfileOut( __METHOD__
);
270 $this->loadContent();
271 wfProfileOut( __METHOD__
);
273 return $this->mContent
;
278 * Get the text of the current revision. No side-effects...
280 * @return Return the text of the current revision
282 public function getRawText() {
283 // Check process cache for current revision
284 if ( $this->mContentLoaded
&& $this->mOldId
== 0 ) {
285 return $this->mContent
;
288 $rev = Revision
::newFromTitle( $this->mTitle
);
289 $text = $rev ?
$rev->getRawText() : false;
295 * This function returns the text of a section, specified by a number ($section).
296 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
297 * the first section before any such heading (section 0).
299 * If a section contains subsections, these are also returned.
301 * @param $text String: text to look in
302 * @param $section Integer: section number
303 * @return string text of the requested section
306 public function getSection( $text, $section ) {
308 return $wgParser->getSection( $text, $section );
312 * Get the text that needs to be saved in order to undo all revisions
313 * between $undo and $undoafter. Revisions must belong to the same page,
314 * must exist and must not be deleted
315 * @param $undo Revision
316 * @param $undoafter Revision Must be an earlier revision than $undo
317 * @return mixed string on success, false on failure
319 public function getUndoText( Revision
$undo, Revision
$undoafter = null ) {
320 $currentRev = Revision
::newFromTitle( $this->mTitle
);
321 if ( !$currentRev ) {
322 return false; // no page
324 $undo_text = $undo->getText();
325 $undoafter_text = $undoafter->getText();
326 $cur_text = $currentRev->getText();
328 if ( $cur_text == $undo_text ) {
329 # No use doing a merge if it's just a straight revert.
330 return $undoafter_text;
335 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
343 * @return int The oldid of the article that is to be shown, 0 for the
346 public function getOldID() {
347 if ( is_null( $this->mOldId
) ) {
348 $this->mOldId
= $this->getOldIDFromRequest();
351 return $this->mOldId
;
355 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
357 * @return int The old id for the request
359 public function getOldIDFromRequest() {
362 $this->mRedirectUrl
= false;
364 $oldid = $wgRequest->getVal( 'oldid' );
366 if ( isset( $oldid ) ) {
367 $oldid = intval( $oldid );
368 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
369 $nextid = $this->mTitle
->getNextRevisionID( $oldid );
373 $this->mRedirectUrl
= $this->mTitle
->getFullURL( 'redirect=no' );
375 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
376 $previd = $this->mTitle
->getPreviousRevisionID( $oldid );
391 * Load the revision (including text) into this object
393 function loadContent() {
394 if ( $this->mContentLoaded
) {
398 wfProfileIn( __METHOD__
);
400 $this->fetchContent( $this->getOldID() );
402 wfProfileOut( __METHOD__
);
406 * Return the list of revision fields that should be selected to create
409 public static function selectFields() {
426 * Fetch a page record with the given conditions
427 * @param $dbr Database object
428 * @param $conditions Array
429 * @return mixed Database result resource, or false on failure
431 protected function pageData( $dbr, $conditions ) {
432 $fields = self
::selectFields();
434 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
436 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
);
438 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
444 * Fetch a page record matching the Title object's namespace and title
445 * using a sanitized title string
447 * @param $dbr Database object
448 * @param $title Title object
449 * @return mixed Database result resource, or false on failure
451 protected function pageDataFromTitle( $dbr, $title ) {
452 return $this->pageData( $dbr, array(
453 'page_namespace' => $title->getNamespace(),
454 'page_title' => $title->getDBkey() ) );
458 * Fetch a page record matching the requested ID
460 * @param $dbr Database
462 * @return mixed Database result resource, or false on failure
464 protected function pageDataFromId( $dbr, $id ) {
465 return $this->pageData( $dbr, array( 'page_id' => $id ) );
469 * Set the general counter, title etc data loaded from
472 * @param $data Database row object or "fromdb"
474 public function loadPageData( $data = 'fromdb' ) {
475 if ( $data === 'fromdb' ) {
476 $dbr = wfGetDB( DB_SLAVE
);
477 $data = $this->pageDataFromTitle( $dbr, $this->mTitle
);
480 $lc = LinkCache
::singleton();
483 $lc->addGoodLinkObj( $data->page_id
, $this->mTitle
, $data->page_len
, $data->page_is_redirect
, $data->page_latest
);
485 $this->mTitle
->mArticleID
= intval( $data->page_id
);
487 # Old-fashioned restrictions
488 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
490 $this->mCounter
= intval( $data->page_counter
);
491 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
492 $this->mIsRedirect
= intval( $data->page_is_redirect
);
493 $this->mLatest
= intval( $data->page_latest
);
495 $lc->addBadLinkObj( $this->mTitle
);
496 $this->mTitle
->mArticleID
= 0;
499 $this->mDataLoaded
= true;
503 * Get text of an article from database
504 * Does *NOT* follow redirects.
506 * @param $oldid Int: 0 for whatever the latest revision is
507 * @return mixed string containing article contents, or false if null
509 function fetchContent( $oldid = 0 ) {
510 if ( $this->mContentLoaded
) {
511 return $this->mContent
;
514 # Pre-fill content with error message so that if something
515 # fails we'll have something telling us what we intended.
516 $t = $this->mTitle
->getPrefixedText();
517 $d = $oldid ?
wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
518 $this->mContent
= wfMsgNoTrans( 'missing-article', $t, $d ) ;
521 $revision = Revision
::newFromId( $oldid );
522 if ( $revision === null ) {
523 wfDebug( __METHOD__
. " failed to retrieve specified revision, id $oldid\n" );
527 if ( !$this->mDataLoaded ||
$this->getID() != $revision->getPage() ) {
528 $data = $this->pageDataFromId( wfGetDB( DB_SLAVE
), $revision->getPage() );
531 wfDebug( __METHOD__
. " failed to get page data linked to revision id $oldid\n" );
535 $this->mTitle
= Title
::makeTitle( $data->page_namespace
, $data->page_title
);
536 $this->loadPageData( $data );
539 if ( !$this->mDataLoaded
) {
540 $this->loadPageData();
543 if ( $this->mLatest
=== false ) {
544 wfDebug( __METHOD__
. " failed to find page data for title " . $this->mTitle
->getPrefixedText() . "\n" );
548 $revision = Revision
::newFromId( $this->mLatest
);
549 if ( $revision === null ) {
550 wfDebug( __METHOD__
. " failed to retrieve current page, rev_id {$this->mLatest}\n" );
555 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
556 // We should instead work with the Revision object when we need it...
557 $this->mContent
= $revision->getText( Revision
::FOR_THIS_USER
); // Loads if user is allowed
559 if ( $revision->getId() == $this->mLatest
) {
560 $this->setLastEdit( $revision );
563 $this->mRevIdFetched
= $revision->getId();
564 $this->mContentLoaded
= true;
565 $this->mRevision
=& $revision;
567 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent
) );
569 return $this->mContent
;
573 * Read/write accessor to select FOR UPDATE
574 * @FIXME: remove, does nothing
576 * @param $x Mixed: FIXME
577 * @return mixed value of $x, or value stored in Article::mForUpdate
579 public function forUpdate( $x = null ) {
580 wfDeprecated( __METHOD__
);
581 return wfSetVar( $this->mForUpdate
, $x );
585 * @return int Page ID
587 public function getID() {
588 return $this->mTitle
->getArticleID();
592 * @return bool Whether or not the page exists in the database
594 public function exists() {
595 return $this->getId() > 0;
599 * Check if this page is something we're going to be showing
600 * some sort of sensible content for. If we return false, page
601 * views (plain action=view) will return an HTTP 404 response,
602 * so spiders and robots can know they're following a bad link.
606 public function hasViewableContent() {
607 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
611 * @return int The view count for the page
613 public function getCount() {
614 if ( -1 == $this->mCounter
) {
615 $id = $this->getID();
620 $dbr = wfGetDB( DB_SLAVE
);
621 $this->mCounter
= $dbr->selectField( 'page',
623 array( 'page_id' => $id ),
629 return $this->mCounter
;
633 * Determine whether a page would be suitable for being counted as an
634 * article in the site_stats table based on the title & its content
636 * @param $text String: text to analyze
639 public function isCountable( $text ) {
640 global $wgUseCommaCount;
642 $token = $wgUseCommaCount ?
',' : '[[';
644 return $this->mTitle
->isContentPage() && !$this->isRedirect( $text ) && in_string( $token, $text );
648 * Tests if the article text represents a redirect
650 * @param $text mixed string containing article contents, or boolean
653 public function isRedirect( $text = false ) {
654 if ( $text === false ) {
655 if ( !$this->mDataLoaded
) {
656 $this->loadPageData();
659 return (bool)$this->mIsRedirect
;
661 return Title
::newFromRedirect( $text ) !== null;
666 * Returns true if the currently-referenced revision is the current edit
667 * to this page (and it exists).
670 public function isCurrent() {
671 # If no oldid, this is the current version.
672 if ( $this->getOldID() == 0 ) {
676 return $this->exists() && $this->mRevision
&& $this->mRevision
->isCurrent();
680 * Loads everything except the text
681 * This isn't necessary for all uses, so it's only done if needed.
683 protected function loadLastEdit() {
684 if ( $this->mLastRevision
!== null ) {
685 return; // already loaded
688 # New or non-existent articles have no user information
689 $id = $this->getID();
694 $revision = Revision
::loadFromPageId( wfGetDB( DB_MASTER
), $id );
696 $this->setLastEdit( $revision );
701 * Set the latest revision
703 protected function setLastEdit( Revision
$revision ) {
704 $this->mLastRevision
= $revision;
705 $this->mTimestamp
= $revision->getTimestamp();
709 * @return string GMT timestamp of last article revision
711 public function getTimestamp() {
712 // Check if the field has been filled by ParserCache::get()
713 if ( !$this->mTimestamp
) {
714 $this->loadLastEdit();
716 return wfTimestamp( TS_MW
, $this->mTimestamp
);
720 * @param $audience Integer: one of:
721 * Revision::FOR_PUBLIC to be displayed to all users
722 * Revision::FOR_THIS_USER to be displayed to $wgUser
723 * Revision::RAW get the text regardless of permissions
724 * @return int user ID for the user that made the last article revision
726 public function getUser( $audience = Revision
::FOR_PUBLIC
) {
727 $this->loadLastEdit();
728 if ( $this->mLastRevision
) {
729 return $this->mLastRevision
->getUser( $audience );
736 * @param $audience Integer: one of:
737 * Revision::FOR_PUBLIC to be displayed to all users
738 * Revision::FOR_THIS_USER to be displayed to $wgUser
739 * Revision::RAW get the text regardless of permissions
740 * @return string username of the user that made the last article revision
742 public function getUserText( $audience = Revision
::FOR_PUBLIC
) {
743 $this->loadLastEdit();
744 if ( $this->mLastRevision
) {
745 return $this->mLastRevision
->getUserText( $audience );
752 * @param $audience Integer: one of:
753 * Revision::FOR_PUBLIC to be displayed to all users
754 * Revision::FOR_THIS_USER to be displayed to $wgUser
755 * Revision::RAW get the text regardless of permissions
756 * @return string Comment stored for the last article revision
758 public function getComment( $audience = Revision
::FOR_PUBLIC
) {
759 $this->loadLastEdit();
760 if ( $this->mLastRevision
) {
761 return $this->mLastRevision
->getComment( $audience );
768 * Returns true if last revision was marked as "minor edit"
770 * @return boolean Minor edit indicator for the last article revision.
772 public function getMinorEdit() {
773 $this->loadLastEdit();
774 if ( $this->mLastRevision
) {
775 return $this->mLastRevision
->isMinor();
782 * Use this to fetch the rev ID used on page views
784 * @return int revision ID of last article revision
786 public function getRevIdFetched() {
787 if ( $this->mRevIdFetched
) {
788 return $this->mRevIdFetched
;
790 return $this->getLatest();
795 * Get a list of users who have edited this article, not including the user who made
796 * the most recent revision, which you can get from $article->getUser() if you want it
799 public function getContributors() {
800 # FIXME: this is expensive; cache this info somewhere.
802 $dbr = wfGetDB( DB_SLAVE
);
803 $userTable = $dbr->tableName( 'user' );
805 $tables = array( 'revision', 'user' );
809 'rev_user_text AS user_name',
810 'MAX(rev_timestamp) AS timestamp',
813 $conds = array( 'rev_page' => $this->getId() );
815 // The user who made the top revision gets credited as "this page was last edited by
816 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
817 $user = $this->getUser();
819 $conds[] = "rev_user != $user";
821 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
824 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0"; // username hidden?
827 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
831 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
832 'ORDER BY' => 'timestamp DESC',
835 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
836 return new UserArrayFromResult( $res );
840 * This is the default action of the index.php entry point: just view the
841 * page of the given title.
843 public function view() {
844 global $wgUser, $wgOut, $wgRequest, $wgParser;
845 global $wgUseFileCache, $wgUseETag;
847 wfProfileIn( __METHOD__
);
849 # Get variables from query string
850 $oldid = $this->getOldID();
852 # getOldID may want us to redirect somewhere else
853 if ( $this->mRedirectUrl
) {
854 $wgOut->redirect( $this->mRedirectUrl
);
855 wfDebug( __METHOD__
. ": redirecting due to oldid\n" );
856 wfProfileOut( __METHOD__
);
861 $wgOut->setArticleFlag( true );
862 # Set page title (may be overridden by DISPLAYTITLE)
863 $wgOut->setPageTitle( $this->mTitle
->getPrefixedText() );
865 # If we got diff in the query, we want to see a diff page instead of the article.
866 if ( $wgRequest->getCheck( 'diff' ) ) {
867 wfDebug( __METHOD__
. ": showing diff page\n" );
868 $this->showDiffPage();
869 wfProfileOut( __METHOD__
);
874 # Allow frames by default
875 $wgOut->allowClickjacking();
877 $parserCache = ParserCache
::singleton();
879 $parserOptions = $this->getParserOptions();
880 # Render printable version, use printable version cache
881 if ( $wgOut->isPrintable() ) {
882 $parserOptions->setIsPrintable( true );
883 $parserOptions->setEditSection( false );
884 } else if ( $wgUseETag && !$this->mTitle
->quickUserCan( 'edit' ) ) {
885 $parserOptions->setEditSection( false );
888 # Try client and file cache
889 if ( $oldid === 0 && $this->checkTouched() ) {
891 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
894 # Is it client cached?
895 if ( $wgOut->checkLastModified( $this->getTouched() ) ) {
896 wfDebug( __METHOD__
. ": done 304\n" );
897 wfProfileOut( __METHOD__
);
901 } else if ( $wgUseFileCache && $this->tryFileCache() ) {
902 wfDebug( __METHOD__
. ": done file cache\n" );
903 # tell wgOut that output is taken care of
905 $this->viewUpdates();
906 wfProfileOut( __METHOD__
);
912 if ( !$wgUseETag && !$this->mTitle
->quickUserCan( 'edit' ) ) {
913 $parserOptions->setEditSection( false );
916 # Should the parser cache be used?
917 $useParserCache = $this->useParserCache( $oldid );
918 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
919 if ( $wgUser->getStubThreshold() ) {
920 wfIncrStats( 'pcache_miss_stub' );
923 $wasRedirected = $this->showRedirectedFromHeader();
924 $this->showNamespaceHeader();
926 # Iterate through the possible ways of constructing the output text.
927 # Keep going until $outputDone is set, or we run out of things to do.
930 $this->mParserOutput
= false;
932 while ( !$outputDone && ++
$pass ) {
935 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
938 # Try the parser cache
939 if ( $useParserCache ) {
940 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
942 if ( $this->mParserOutput
!== false ) {
943 wfDebug( __METHOD__
. ": showing parser cache contents\n" );
944 $wgOut->addParserOutput( $this->mParserOutput
);
945 # Ensure that UI elements requiring revision ID have
946 # the correct version information.
947 $wgOut->setRevisionId( $this->mLatest
);
953 $text = $this->getContent();
954 if ( $text === false ||
$this->getID() == 0 ) {
955 wfDebug( __METHOD__
. ": showing missing article\n" );
956 $this->showMissingArticle();
957 wfProfileOut( __METHOD__
);
961 # Another whitelist check in case oldid is altering the title
962 if ( !$this->mTitle
->userCanRead() ) {
963 wfDebug( __METHOD__
. ": denied on secondary read check\n" );
964 $wgOut->loginToUse();
967 wfProfileOut( __METHOD__
);
971 # Are we looking at an old revision
972 if ( $oldid && !is_null( $this->mRevision
) ) {
973 $this->setOldSubtitle( $oldid );
975 if ( !$this->showDeletedRevisionHeader() ) {
976 wfDebug( __METHOD__
. ": cannot view deleted revision\n" );
977 wfProfileOut( __METHOD__
);
981 # If this "old" version is the current, then try the parser cache...
982 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
983 $this->mParserOutput
= $parserCache->get( $this, $parserOptions );
984 if ( $this->mParserOutput
) {
985 wfDebug( __METHOD__
. ": showing parser cache for current rev permalink\n" );
986 $wgOut->addParserOutput( $this->mParserOutput
);
987 $wgOut->setRevisionId( $this->mLatest
);
994 # Ensure that UI elements requiring revision ID have
995 # the correct version information.
996 $wgOut->setRevisionId( $this->getRevIdFetched() );
998 # Pages containing custom CSS or JavaScript get special treatment
999 if ( $this->mTitle
->isCssOrJsPage() ||
$this->mTitle
->isCssJsSubpage() ) {
1000 wfDebug( __METHOD__
. ": showing CSS/JS source\n" );
1001 $this->showCssOrJsPage();
1004 $rt = Title
::newFromRedirectArray( $text );
1006 wfDebug( __METHOD__
. ": showing redirect=no page\n" );
1007 # Viewing a redirect page (e.g. with parameter redirect=no)
1008 # Don't append the subtitle if this was an old revision
1009 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
1010 # Parse just to get categories, displaytitle, etc.
1011 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
, $parserOptions );
1012 $wgOut->addParserOutputNoText( $this->mParserOutput
);
1018 # Run the parse, protected by a pool counter
1019 wfDebug( __METHOD__
. ": doing uncached parse\n" );
1021 $key = $parserCache->getKey( $this, $parserOptions );
1022 $poolArticleView = new PoolWorkArticleView( $this, $key, $useParserCache, $parserOptions );
1024 if ( !$poolArticleView->execute() ) {
1025 # Connection or timeout error
1026 wfProfileOut( __METHOD__
);
1032 # Should be unreachable, but just in case...
1038 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
1039 if ( $this->mParserOutput
) {
1040 $titleText = $this->mParserOutput
->getTitleText();
1042 if ( strval( $titleText ) !== '' ) {
1043 $wgOut->setPageTitle( $titleText );
1047 # For the main page, overwrite the <title> element with the con-
1048 # tents of 'pagetitle-view-mainpage' instead of the default (if
1049 # that's not empty).
1050 # This message always exists because it is in the i18n files
1051 if ( $this->mTitle
->equals( Title
::newMainPage() ) ) {
1052 $msg = wfMessage( 'pagetitle-view-mainpage' )->inContentLanguage();
1053 if ( !$msg->isDisabled() ) {
1054 $wgOut->setHTMLTitle( $msg->title( $this->mTitle
)->text() );
1058 # Now that we've filled $this->mParserOutput, we know whether
1059 # there are any __NOINDEX__ tags on the page
1060 $policy = $this->getRobotPolicy( 'view' );
1061 $wgOut->setIndexPolicy( $policy['index'] );
1062 $wgOut->setFollowPolicy( $policy['follow'] );
1064 $this->showViewFooter();
1065 $this->viewUpdates();
1066 wfProfileOut( __METHOD__
);
1070 * Show a diff page according to current request variables. For use within
1071 * Article::view() only, other callers should use the DifferenceEngine class.
1073 public function showDiffPage() {
1074 global $wgRequest, $wgUser;
1076 $diff = $wgRequest->getVal( 'diff' );
1077 $rcid = $wgRequest->getVal( 'rcid' );
1078 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
1079 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1080 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1081 $oldid = $this->getOldID();
1083 $de = new DifferenceEngine( $this->mTitle
, $oldid, $diff, $rcid, $purge, $unhide );
1084 // DifferenceEngine directly fetched the revision:
1085 $this->mRevIdFetched
= $de->mNewid
;
1086 $de->showDiffPage( $diffOnly );
1088 if ( $diff == 0 ||
$diff == $this->getLatest() ) {
1089 # Run view updates for current revision only
1090 $this->viewUpdates();
1095 * Show a page view for a page formatted as CSS or JavaScript. To be called by
1096 * Article::view() only.
1098 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
1101 protected function showCssOrJsPage() {
1104 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache'>\n$1\n</div>", 'clearyourcache' );
1106 // Give hooks a chance to customise the output
1107 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent
, $this->mTitle
, $wgOut ) ) ) {
1108 // Wrap the whole lot in a <pre> and don't parse
1110 preg_match( '!\.(css|js)$!u', $this->mTitle
->getText(), $m );
1111 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
1112 $wgOut->addHTML( htmlspecialchars( $this->mContent
) );
1113 $wgOut->addHTML( "\n</pre>\n" );
1118 * Get the robot policy to be used for the current view
1119 * @param $action String the action= GET parameter
1120 * @return Array the policy that should be set
1121 * TODO: actions other than 'view'
1123 public function getRobotPolicy( $action ) {
1124 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1125 global $wgDefaultRobotPolicy, $wgRequest;
1127 $ns = $this->mTitle
->getNamespace();
1129 if ( $ns == NS_USER ||
$ns == NS_USER_TALK
) {
1130 # Don't index user and user talk pages for blocked users (bug 11443)
1131 if ( !$this->mTitle
->isSubpage() ) {
1132 if ( Block
::newFromTarget( null, $this->mTitle
->getText() ) instanceof Block
) {
1134 'index' => 'noindex',
1135 'follow' => 'nofollow'
1141 if ( $this->getID() === 0 ||
$this->getOldID() ) {
1142 # Non-articles (special pages etc), and old revisions
1144 'index' => 'noindex',
1145 'follow' => 'nofollow'
1147 } elseif ( $wgOut->isPrintable() ) {
1148 # Discourage indexing of printable versions, but encourage following
1150 'index' => 'noindex',
1151 'follow' => 'follow'
1153 } elseif ( $wgRequest->getInt( 'curid' ) ) {
1154 # For ?curid=x urls, disallow indexing
1156 'index' => 'noindex',
1157 'follow' => 'follow'
1161 # Otherwise, construct the policy based on the various config variables.
1162 $policy = self
::formatRobotPolicy( $wgDefaultRobotPolicy );
1164 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
1165 # Honour customised robot policies for this namespace
1166 $policy = array_merge(
1168 self
::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
1171 if ( $this->mTitle
->canUseNoindex() && is_object( $this->mParserOutput
) && $this->mParserOutput
->getIndexPolicy() ) {
1172 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1173 # a final sanity check that we have really got the parser output.
1174 $policy = array_merge(
1176 array( 'index' => $this->mParserOutput
->getIndexPolicy() )
1180 if ( isset( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] ) ) {
1181 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1182 $policy = array_merge(
1184 self
::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle
->getPrefixedText()] )
1192 * Converts a String robot policy into an associative array, to allow
1193 * merging of several policies using array_merge().
1194 * @param $policy Mixed, returns empty array on null/false/'', transparent
1195 * to already-converted arrays, converts String.
1196 * @return Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1198 public static function formatRobotPolicy( $policy ) {
1199 if ( is_array( $policy ) ) {
1201 } elseif ( !$policy ) {
1205 $policy = explode( ',', $policy );
1206 $policy = array_map( 'trim', $policy );
1209 foreach ( $policy as $var ) {
1210 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
1211 $arr['index'] = $var;
1212 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
1213 $arr['follow'] = $var;
1221 * If this request is a redirect view, send "redirected from" subtitle to
1222 * $wgOut. Returns true if the header was needed, false if this is not a
1223 * redirect view. Handles both local and remote redirects.
1227 public function showRedirectedFromHeader() {
1228 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1230 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1232 if ( isset( $this->mRedirectedFrom
) ) {
1233 // This is an internally redirected page view.
1234 // We'll need a backlink to the source page for navigation.
1235 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1236 $redir = $wgUser->getSkin()->link(
1237 $this->mRedirectedFrom
,
1240 array( 'redirect' => 'no' ),
1241 array( 'known', 'noclasses' )
1244 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1245 $wgOut->setSubtitle( $s );
1247 // Set the fragment if one was specified in the redirect
1248 if ( strval( $this->mTitle
->getFragment() ) != '' ) {
1249 $fragment = Xml
::escapeJsString( $this->mTitle
->getFragmentForURL() );
1250 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1253 // Add a <link rel="canonical"> tag
1254 $wgOut->addLink( array( 'rel' => 'canonical',
1255 'href' => $this->mTitle
->getLocalURL() )
1260 } elseif ( $rdfrom ) {
1261 // This is an externally redirected view, from some other wiki.
1262 // If it was reported from a trusted site, supply a backlink.
1263 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1264 $redir = $wgUser->getSkin()->makeExternalLink( $rdfrom, $rdfrom );
1265 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1266 $wgOut->setSubtitle( $s );
1276 * Show a header specific to the namespace currently being viewed, like
1277 * [[MediaWiki:Talkpagetext]]. For Article::view().
1279 public function showNamespaceHeader() {
1282 if ( $this->mTitle
->isTalkPage() ) {
1283 if ( !wfMessage( 'talkpageheader' )->isDisabled() ) {
1284 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1290 * Show the footer section of an ordinary page view
1292 public function showViewFooter() {
1293 global $wgOut, $wgUseTrackbacks;
1295 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1296 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& IP
::isValid( $this->mTitle
->getText() ) ) {
1297 $wgOut->addWikiMsg( 'anontalkpagetext' );
1300 # If we have been passed an &rcid= parameter, we want to give the user a
1301 # chance to mark this new article as patrolled.
1302 $this->showPatrolFooter();
1305 if ( $wgUseTrackbacks ) {
1306 $this->addTrackbacks();
1309 wfRunHooks( 'ArticleViewFooter', array( $this ) );
1314 * If patrol is possible, output a patrol UI box. This is called from the
1315 * footer section of ordinary page views. If patrol is not possible or not
1316 * desired, does nothing.
1318 public function showPatrolFooter() {
1319 global $wgOut, $wgRequest, $wgUser;
1321 $rcid = $wgRequest->getVal( 'rcid' );
1323 if ( !$rcid ||
!$this->mTitle
->quickUserCan( 'patrol' ) ) {
1327 $sk = $wgUser->getSkin();
1328 $token = $wgUser->editToken( $rcid );
1329 $wgOut->preventClickjacking();
1332 "<div class='patrollink'>" .
1334 'markaspatrolledlink',
1337 wfMsgHtml( 'markaspatrolledtext' ),
1340 'action' => 'markpatrolled',
1344 array( 'known', 'noclasses' )
1352 * Show the error text for a missing article. For articles in the MediaWiki
1353 * namespace, show the default message text. To be called from Article::view().
1355 public function showMissingArticle() {
1356 global $wgOut, $wgRequest, $wgUser;
1358 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1359 if ( $this->mTitle
->getNamespace() == NS_USER ||
$this->mTitle
->getNamespace() == NS_USER_TALK
) {
1360 $parts = explode( '/', $this->mTitle
->getText() );
1361 $rootPart = $parts[0];
1362 $user = User
::newFromName( $rootPart, false /* allow IP users*/ );
1363 $ip = User
::isIP( $rootPart );
1365 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1366 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1367 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1368 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1369 LogEventsList
::showLogExtract(
1372 $user->getUserPage()->getPrefixedText(),
1376 'showIfEmpty' => false,
1378 'blocked-notice-logextract',
1379 $user->getName() # Support GENDER in notice
1386 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1388 # Show delete and move logs
1389 LogEventsList
::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle
->getPrefixedText(), '',
1391 'conds' => array( "log_action != 'revision'" ),
1392 'showIfEmpty' => false,
1393 'msgKey' => array( 'moveddeleted-notice' ) )
1396 # Show error message
1397 $oldid = $this->getOldID();
1399 $text = wfMsgNoTrans( 'missing-article',
1400 $this->mTitle
->getPrefixedText(),
1401 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1402 } elseif ( $this->mTitle
->getNamespace() === NS_MEDIAWIKI
) {
1403 // Use the default message text
1404 $text = $this->mTitle
->getDefaultMessageText();
1406 $createErrors = $this->mTitle
->getUserPermissionsErrors( 'create', $wgUser );
1407 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
1408 $errors = array_merge( $createErrors, $editErrors );
1410 if ( !count( $errors ) ) {
1411 $text = wfMsgNoTrans( 'noarticletext' );
1413 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1416 $text = "<div class='noarticletext'>\n$text\n</div>";
1418 if ( !$this->hasViewableContent() ) {
1419 // If there's no backing content, send a 404 Not Found
1420 // for better machine handling of broken links.
1421 $wgRequest->response()->header( "HTTP/1.1 404 Not Found" );
1424 $wgOut->addWikiText( $text );
1428 * If the revision requested for view is deleted, check permissions.
1429 * Send either an error message or a warning header to $wgOut.
1431 * @return boolean true if the view is allowed, false if not.
1433 public function showDeletedRevisionHeader() {
1434 global $wgOut, $wgRequest;
1436 if ( !$this->mRevision
->isDeleted( Revision
::DELETED_TEXT
) ) {
1441 // If the user is not allowed to see it...
1442 if ( !$this->mRevision
->userCan( Revision
::DELETED_TEXT
) ) {
1443 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1444 'rev-deleted-text-permission' );
1447 // If the user needs to confirm that they want to see it...
1448 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1449 # Give explanation and add a link to view the revision...
1450 $oldid = intval( $this->getOldID() );
1451 $link = $this->mTitle
->getFullUrl( "oldid={$oldid}&unhide=1" );
1452 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1453 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1454 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1455 array( $msg, $link ) );
1458 // We are allowed to see...
1460 $msg = $this->mRevision
->isDeleted( Revision
::DELETED_RESTRICTED
) ?
1461 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1462 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1469 * Should the parser cache be used?
1473 public function useParserCache( $oldid ) {
1474 global $wgUser, $wgEnableParserCache;
1476 return $wgEnableParserCache
1477 && $wgUser->getStubThreshold() == 0
1480 && !$this->mTitle
->isCssOrJsPage()
1481 && !$this->mTitle
->isCssJsSubpage();
1485 * Execute the uncached parse for action=view
1487 public function doViewParse() {
1490 $oldid = $this->getOldID();
1491 $parserOptions = $this->getParserOptions();
1493 # Render printable version, use printable version cache
1494 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1496 # Don't show section-edit links on old revisions... this way lies madness.
1497 if ( !$this->isCurrent() ||
$wgOut->isPrintable() ||
!$this->mTitle
->quickUserCan( 'edit' ) ) {
1498 $parserOptions->setEditSection( false );
1501 $useParserCache = $this->useParserCache( $oldid );
1502 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1508 * Try to fetch an expired entry from the parser cache. If it is present,
1509 * output it and return true. If it is not present, output nothing and
1510 * return false. This is used as a callback function for
1511 * PoolCounter::executeProtected().
1515 public function tryDirtyCache() {
1517 $parserCache = ParserCache
::singleton();
1518 $options = $this->getParserOptions();
1520 if ( $wgOut->isPrintable() ) {
1521 $options->setIsPrintable( true );
1522 $options->setEditSection( false );
1525 $output = $parserCache->getDirty( $this, $options );
1528 wfDebug( __METHOD__
. ": sending dirty output\n" );
1529 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1530 $wgOut->setSquidMaxage( 0 );
1531 $this->mParserOutput
= $output;
1532 $wgOut->addParserOutput( $output );
1533 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1537 wfDebugLog( 'dirty', "dirty missing\n" );
1538 wfDebug( __METHOD__
. ": no dirty cache\n" );
1547 * @param $target Title|Array of destination(s) to redirect
1548 * @param $appendSubtitle Boolean [optional]
1549 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1550 * @return string containing HMTL with redirect link
1552 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1553 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1555 if ( !is_array( $target ) ) {
1556 $target = array( $target );
1559 $imageDir = $wgContLang->getDir();
1561 if ( $appendSubtitle ) {
1562 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1565 $sk = $wgUser->getSkin();
1566 // the loop prepends the arrow image before the link, so the first case needs to be outside
1567 $title = array_shift( $target );
1569 if ( $forceKnown ) {
1570 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1572 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1575 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1576 $alt = $wgContLang->isRTL() ?
'←' : '→';
1577 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1578 foreach ( $target as $rt ) {
1579 $link .= Html
::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1580 if ( $forceKnown ) {
1581 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText(), array(), array( 'redirect' => 'no' ) ) );
1583 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ), array(), array( 'redirect' => 'no' ) );
1587 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1588 return '<div class="redirectMsg">' .
1589 Html
::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1590 '<span class="redirectText">' . $link . '</span></div>';
1594 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1596 public function addTrackbacks() {
1599 $dbr = wfGetDB( DB_SLAVE
);
1600 $tbs = $dbr->select( 'trackbacks',
1601 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1602 array( 'tb_page' => $this->getID() )
1605 if ( !$dbr->numRows( $tbs ) ) {
1609 $wgOut->preventClickjacking();
1612 foreach ( $tbs as $o ) {
1615 if ( $wgOut->getUser()->isAllowed( 'trackback' ) ) {
1616 $delurl = $this->mTitle
->getFullURL( "action=deletetrackback&tbid=" .
1617 $o->tb_id
. "&token=" . urlencode( $wgOut->getUser()->editToken() ) );
1618 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1622 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex
) ?
'trackbackexcerpt' : 'trackback',
1630 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1634 * Removes trackback record for current article from trackbacks table
1636 public function deletetrackback() {
1637 global $wgRequest, $wgOut;
1639 if ( !$wgOut->getUser()->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1640 $wgOut->addWikiMsg( 'sessionfailure' );
1645 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgOut->getUser() );
1647 if ( count( $permission_errors ) ) {
1648 $wgOut->showPermissionsErrorPage( $permission_errors );
1653 $db = wfGetDB( DB_MASTER
);
1654 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1656 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1657 $this->mTitle
->invalidateCache();
1661 * Handle action=render
1664 public function render() {
1667 $wgOut->setArticleBodyOnly( true );
1672 * Handle action=purge
1674 public function purge() {
1675 return Action
::factory( 'purge', $this )->show();
1679 * Perform the actions of a page purging
1681 public function doPurge() {
1684 if( !wfRunHooks( 'ArticlePurge', array( &$this ) ) ){
1688 // Invalidate the cache
1689 $this->mTitle
->invalidateCache();
1692 if ( $wgUseSquid ) {
1693 // Commit the transaction before the purge is sent
1694 $dbw = wfGetDB( DB_MASTER
);
1698 $update = SquidUpdate
::newSimplePurge( $this->mTitle
);
1699 $update->doUpdate();
1702 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1703 if ( $this->getID() == 0 ) {
1706 $text = $this->getRawText();
1709 MessageCache
::singleton()->replace( $this->mTitle
->getDBkey(), $text );
1714 * Insert a new empty page record for this article.
1715 * This *must* be followed up by creating a revision
1716 * and running $this->updateRevisionOn( ... );
1717 * or else the record will be left in a funky state.
1718 * Best if all done inside a transaction.
1720 * @param $dbw Database
1721 * @return int The newly created page_id key, or false if the title already existed
1724 public function insertOn( $dbw ) {
1725 wfProfileIn( __METHOD__
);
1727 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1728 $dbw->insert( 'page', array(
1729 'page_id' => $page_id,
1730 'page_namespace' => $this->mTitle
->getNamespace(),
1731 'page_title' => $this->mTitle
->getDBkey(),
1732 'page_counter' => 0,
1733 'page_restrictions' => '',
1734 'page_is_redirect' => 0, # Will set this shortly...
1736 'page_random' => wfRandom(),
1737 'page_touched' => $dbw->timestamp(),
1738 'page_latest' => 0, # Fill this in shortly...
1739 'page_len' => 0, # Fill this in shortly...
1740 ), __METHOD__
, 'IGNORE' );
1742 $affected = $dbw->affectedRows();
1745 $newid = $dbw->insertId();
1746 $this->mTitle
->resetArticleID( $newid );
1748 wfProfileOut( __METHOD__
);
1750 return $affected ?
$newid : false;
1754 * Update the page record to point to a newly saved revision.
1756 * @param $dbw DatabaseBase: object
1757 * @param $revision Revision: For ID number, and text used to set
1758 length and redirect status fields
1759 * @param $lastRevision Integer: if given, will not overwrite the page field
1760 * when different from the currently set value.
1761 * Giving 0 indicates the new page flag should be set
1763 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1764 * removing rows in redirect table.
1765 * @return bool true on success, false on failure
1768 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null ) {
1769 wfProfileIn( __METHOD__
);
1771 $text = $revision->getText();
1772 $rt = Title
::newFromRedirectRecurse( $text );
1774 $conditions = array( 'page_id' => $this->getId() );
1776 if ( !is_null( $lastRevision ) ) {
1777 # An extra check against threads stepping on each other
1778 $conditions['page_latest'] = $lastRevision;
1781 $dbw->update( 'page',
1783 'page_latest' => $revision->getId(),
1784 'page_touched' => $dbw->timestamp(),
1785 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1786 'page_is_redirect' => $rt !== null ?
1 : 0,
1787 'page_len' => strlen( $text ),
1792 $result = $dbw->affectedRows() != 0;
1794 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1797 wfProfileOut( __METHOD__
);
1802 * Add row to the redirect table if this is a redirect, remove otherwise.
1804 * @param $dbw Database
1805 * @param $redirectTitle Title object pointing to the redirect target,
1806 * or NULL if this is not a redirect
1807 * @param $lastRevIsRedirect If given, will optimize adding and
1808 * removing rows in redirect table.
1809 * @return bool true on success, false on failure
1812 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1813 // Always update redirects (target link might have changed)
1814 // Update/Insert if we don't know if the last revision was a redirect or not
1815 // Delete if changing from redirect to non-redirect
1816 $isRedirect = !is_null( $redirectTitle );
1818 if ( !$isRedirect && !is_null( $lastRevIsRedirect ) && $lastRevIsRedirect === $isRedirect ) {
1822 wfProfileIn( __METHOD__
);
1823 if ( $isRedirect ) {
1824 $this->insertRedirectEntry( $redirectTitle );
1826 // This is not a redirect, remove row from redirect table
1827 $where = array( 'rd_from' => $this->getId() );
1828 $dbw->delete( 'redirect', $where, __METHOD__
);
1831 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1832 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1834 wfProfileOut( __METHOD__
);
1836 return ( $dbw->affectedRows() != 0 );
1840 * If the given revision is newer than the currently set page_latest,
1841 * update the page record. Otherwise, do nothing.
1843 * @param $dbw Database object
1844 * @param $revision Revision object
1847 public function updateIfNewerOn( &$dbw, $revision ) {
1848 wfProfileIn( __METHOD__
);
1850 $row = $dbw->selectRow(
1851 array( 'revision', 'page' ),
1852 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1854 'page_id' => $this->getId(),
1855 'page_latest=rev_id' ),
1859 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1860 wfProfileOut( __METHOD__
);
1863 $prev = $row->rev_id
;
1864 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1866 # No or missing previous revision; mark the page as new
1868 $lastRevIsRedirect = null;
1871 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1873 wfProfileOut( __METHOD__
);
1878 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1879 * @param $text String: new text of the section
1880 * @param $summary String: new section's subject, only if $section is 'new'
1881 * @param $edittime String: revision timestamp or null to use the current revision
1882 * @return string Complete article text, or null if error
1884 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1885 wfProfileIn( __METHOD__
);
1887 if ( strval( $section ) == '' ) {
1888 // Whole-page edit; let the whole text through
1890 if ( is_null( $edittime ) ) {
1891 $rev = Revision
::newFromTitle( $this->mTitle
);
1893 $dbw = wfGetDB( DB_MASTER
);
1894 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1898 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1899 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1900 wfProfileOut( __METHOD__
);
1904 $oldtext = $rev->getText();
1906 if ( $section == 'new' ) {
1907 # Inserting a new section
1908 $subject = $summary ?
wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1909 $text = strlen( trim( $oldtext ) ) > 0
1910 ?
"{$oldtext}\n\n{$subject}{$text}"
1911 : "{$subject}{$text}";
1913 # Replacing an existing section; roll out the big guns
1916 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1920 wfProfileOut( __METHOD__
);
1925 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1927 * @return Int updated $flags
1929 function checkFlags( $flags ) {
1930 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1931 if ( $this->mTitle
->getArticleID() ) {
1932 $flags |
= EDIT_UPDATE
;
1944 * Change an existing article or create a new article. Updates RC and all necessary caches,
1945 * optionally via the deferred update array.
1947 * $wgUser must be set before calling this function.
1949 * @param $text String: new text
1950 * @param $summary String: edit summary
1951 * @param $flags Integer bitfield:
1953 * Article is known or assumed to be non-existent, create a new one
1955 * Article is known or assumed to be pre-existing, update it
1957 * Mark this edit minor, if the user is allowed to do so
1959 * Do not log the change in recentchanges
1961 * Mark the edit a "bot" edit regardless of user rights
1962 * EDIT_DEFER_UPDATES
1963 * Defer some of the updates until the end of index.php
1965 * Fill in blank summaries with generated text where possible
1967 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
1968 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
1969 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
1970 * edit-already-exists error will be returned. These two conditions are also possible with
1971 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1973 * @param $baseRevId the revision ID this edit was based off, if any
1974 * @param $user User (optional), $wgUser will be used if not passed
1976 * @return Status object. Possible errors:
1977 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
1978 * edit-gone-missing: In update mode, but the article didn't exist
1979 * edit-conflict: In update mode, the article changed unexpectedly
1980 * edit-no-change: Warning that the text was the same as before
1981 * edit-already-exists: In creation mode, but the article already exists
1983 * Extensions may define additional errors.
1985 * $return->value will contain an associative array with members as follows:
1986 * new: Boolean indicating if the function attempted to create a new article
1987 * revision: The revision object for the inserted revision, or null
1989 * Compatibility note: this function previously returned a boolean value indicating success/failure
1991 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1992 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
1994 # Low-level sanity check
1995 if ( $this->mTitle
->getText() === '' ) {
1996 throw new MWException( 'Something is trying to edit an article with an empty title' );
1999 wfProfileIn( __METHOD__
);
2001 $user = is_null( $user ) ?
$wgUser : $user;
2002 $status = Status
::newGood( array() );
2004 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2005 $this->loadPageData();
2007 $flags = $this->checkFlags( $flags );
2009 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2010 $flags & EDIT_MINOR
, null, null, &$flags, &$status ) ) )
2012 wfDebug( __METHOD__
. ": ArticleSave hook aborted save!\n" );
2014 if ( $status->isOK() ) {
2015 $status->fatal( 'edit-hook-aborted' );
2018 wfProfileOut( __METHOD__
);
2022 # Silently ignore EDIT_MINOR if not allowed
2023 $isminor = ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' );
2024 $bot = $flags & EDIT_FORCE_BOT
;
2026 $oldtext = $this->getRawText(); // current revision
2027 $oldsize = strlen( $oldtext );
2029 # Provide autosummaries if one is not provided and autosummaries are enabled.
2030 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY
&& $summary == '' ) {
2031 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2034 $editInfo = $this->prepareTextForEdit( $text, null, $user );
2035 $text = $editInfo->pst
;
2036 $newsize = strlen( $text );
2038 $dbw = wfGetDB( DB_MASTER
);
2039 $now = wfTimestampNow();
2040 $this->mTimestamp
= $now;
2042 if ( $flags & EDIT_UPDATE
) {
2043 # Update article, but only if changed.
2044 $status->value
['new'] = false;
2046 # Make sure the revision is either completely inserted or not inserted at all
2047 if ( !$wgDBtransactions ) {
2048 $userAbort = ignore_user_abort( true );
2051 $changed = ( strcmp( $text, $oldtext ) != 0 );
2054 $this->mGoodAdjustment
= (int)$this->isCountable( $text )
2055 - (int)$this->isCountable( $oldtext );
2056 $this->mTotalAdjustment
= 0;
2058 if ( !$this->mLatest
) {
2059 # Article gone missing
2060 wfDebug( __METHOD__
. ": EDIT_UPDATE specified but article doesn't exist\n" );
2061 $status->fatal( 'edit-gone-missing' );
2063 wfProfileOut( __METHOD__
);
2067 $revision = new Revision( array(
2068 'page' => $this->getId(),
2069 'comment' => $summary,
2070 'minor_edit' => $isminor,
2072 'parent_id' => $this->mLatest
,
2073 'user' => $user->getId(),
2074 'user_text' => $user->getName(),
2079 $revisionId = $revision->insertOn( $dbw );
2083 # Note that we use $this->mLatest instead of fetching a value from the master DB
2084 # during the course of this function. This makes sure that EditPage can detect
2085 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2086 # before this function is called. A previous function used a separate query, this
2087 # creates a window where concurrent edits can cause an ignored edit conflict.
2088 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest
);
2091 /* Belated edit conflict! Run away!! */
2092 $status->fatal( 'edit-conflict' );
2094 # Delete the invalid revision if the DB is not transactional
2095 if ( !$wgDBtransactions ) {
2096 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__
);
2102 global $wgUseRCPatrol;
2103 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2104 # Update recentchanges
2105 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2106 # Mark as patrolled if the user can do so
2107 $patrolled = $wgUseRCPatrol && !count(
2108 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
2109 # Add RC row to the DB
2110 $rc = RecentChange
::notifyEdit( $now, $this->mTitle
, $isminor, $user, $summary,
2111 $this->mLatest
, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2112 $revisionId, $patrolled
2115 # Log auto-patrolled edits
2117 PatrolLog
::record( $rc, true );
2120 $user->incEditCount();
2124 $status->warning( 'edit-no-change' );
2126 // Keep the same revision ID, but do some updates on it
2127 $revisionId = $this->getLatest();
2128 // Update page_touched, this is usually implicit in the page update
2129 // Other cache updates are done in onArticleEdit()
2130 $this->mTitle
->invalidateCache();
2133 if ( !$wgDBtransactions ) {
2134 ignore_user_abort( $userAbort );
2137 // Now that ignore_user_abort is restored, we can respond to fatal errors
2138 if ( !$status->isOK() ) {
2139 wfProfileOut( __METHOD__
);
2143 # Invalidate cache of this article and all pages using this article
2144 # as a template. Partly deferred.
2145 Article
::onArticleEdit( $this->mTitle
);
2146 # Update links tables, site stats, etc.
2147 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed, $user );
2149 # Create new article
2150 $status->value
['new'] = true;
2152 # Set statistics members
2153 # We work out if it's countable after PST to avoid counter drift
2154 # when articles are created with {{subst:}}
2155 $this->mGoodAdjustment
= (int)$this->isCountable( $text );
2156 $this->mTotalAdjustment
= 1;
2160 # Add the page record; stake our claim on this title!
2161 # This will return false if the article already exists
2162 $newid = $this->insertOn( $dbw );
2164 if ( $newid === false ) {
2166 $status->fatal( 'edit-already-exists' );
2168 wfProfileOut( __METHOD__
);
2172 # Save the revision text...
2173 $revision = new Revision( array(
2175 'comment' => $summary,
2176 'minor_edit' => $isminor,
2178 'user' => $user->getId(),
2179 'user_text' => $user->getName(),
2182 $revisionId = $revision->insertOn( $dbw );
2184 $this->mTitle
->resetArticleID( $newid );
2185 # Update the LinkCache. Resetting the Title ArticleID means it will rely on having that already cached (FIXME?)
2186 LinkCache
::singleton()->addGoodLinkObj( $newid, $this->mTitle
, strlen( $text ), (bool)Title
::newFromRedirect( $text ), $revisionId );
2188 # Update the page record with revision data
2189 $this->updateRevisionOn( $dbw, $revision, 0 );
2191 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2193 # Update recentchanges
2194 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
2195 global $wgUseRCPatrol, $wgUseNPPatrol;
2197 # Mark as patrolled if the user can do so
2198 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && !count(
2199 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
2200 # Add RC row to the DB
2201 $rc = RecentChange
::notifyNew( $now, $this->mTitle
, $isminor, $user, $summary, $bot,
2202 '', strlen( $text ), $revisionId, $patrolled );
2204 # Log auto-patrolled edits
2206 PatrolLog
::record( $rc, true );
2209 $user->incEditCount();
2212 # Update links, etc.
2213 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true, $user );
2216 Article
::onArticleCreate( $this->mTitle
);
2218 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2219 $flags & EDIT_MINOR
, null, null, &$flags, $revision ) );
2222 # Do updates right now unless deferral was requested
2223 if ( !( $flags & EDIT_DEFER_UPDATES
) ) {
2227 // Return the new revision (or null) to the caller
2228 $status->value
['revision'] = $revision;
2230 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2231 $flags & EDIT_MINOR
, null, null, &$flags, $revision, &$status, $baseRevId ) );
2233 wfProfileOut( __METHOD__
);
2238 * Output a redirect back to the article.
2239 * This is typically used after an edit.
2241 * @param $noRedir Boolean: add redirect=no
2242 * @param $sectionAnchor String: section to redirect to, including "#"
2243 * @param $extraQuery String: extra query params
2245 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2249 $query = 'redirect=no';
2251 $query .= "&$extraQuery";
2253 $query = $extraQuery;
2256 $wgOut->redirect( $this->mTitle
->getFullURL( $query ) . $sectionAnchor );
2260 * Mark this particular edit/page as patrolled
2262 public function markpatrolled() {
2263 global $wgOut, $wgRequest;
2265 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2267 # If we haven't been given an rc_id value, we can't do anything
2268 $rcid = (int) $wgRequest->getVal( 'rcid' );
2270 if ( !$wgOut->getUser()->matchEditToken( $wgRequest->getVal( 'token' ), $rcid ) ) {
2271 $wgOut->showErrorPage( 'sessionfailure-title', 'sessionfailure' );
2275 $rc = RecentChange
::newFromId( $rcid );
2277 if ( is_null( $rc ) ) {
2278 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2282 # It would be nice to see where the user had actually come from, but for now just guess
2283 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ?
'Newpages' : 'Recentchanges';
2284 $return = SpecialPage
::getTitleFor( $returnto );
2286 $errors = $rc->doMarkPatrolled();
2288 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2289 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2294 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2295 // The hook itself has handled any output
2299 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2300 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2301 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2302 $wgOut->returnToMain( false, $return );
2307 if ( !empty( $errors ) ) {
2308 $wgOut->showPermissionsErrorPage( $errors );
2314 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2315 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2316 $wgOut->returnToMain( false, $return );
2320 * User-interface handler for the "watch" action
2321 * @deprecated since 1.18
2323 public function watch() {
2324 Action
::factory( 'watch', $this )->show();
2328 * Add this page to $wgUser's watchlist
2330 * This is safe to be called multiple times
2332 * @return bool true on successful watch operation
2333 * @deprecated since 1.18
2335 public function doWatch() {
2336 return Action
::factory( 'watch', $this )->execute();
2340 * User interface handler for the "unwatch" action.
2341 * @deprecated since 1.18
2343 public function unwatch() {
2344 Action
::factory( 'unwatch', $this )->show();
2348 * Stop watching a page
2349 * @return bool true on successful unwatch
2350 * @deprecated since 1.18
2352 public function doUnwatch() {
2353 return Action
::factory( 'unwatch', $this )->execute();
2357 * action=protect handler
2359 public function protect() {
2360 $form = new ProtectionForm( $this );
2365 * action=unprotect handler (alias)
2367 public function unprotect() {
2372 * Update the article's restriction field, and leave a log entry.
2374 * @param $limit Array: set of restriction keys
2375 * @param $reason String
2376 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2377 * @param $expiry Array: per restriction type expiration
2378 * @return bool true on success
2380 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2381 global $wgUser, $wgContLang;
2383 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2385 $id = $this->mTitle
->getArticleID();
2388 wfDebug( "updateRestrictions failed: article id $id <= 0\n" );
2392 if ( wfReadOnly() ) {
2393 wfDebug( "updateRestrictions failed: read-only\n" );
2397 if ( !$this->mTitle
->userCan( 'protect' ) ) {
2398 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2406 // Take this opportunity to purge out expired restrictions
2407 Title
::purgeExpiredRestrictions();
2409 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2410 # we expect a single selection, but the schema allows otherwise.
2412 $updated = Article
::flattenRestrictions( $limit );
2415 foreach ( $restrictionTypes as $action ) {
2416 if ( isset( $expiry[$action] ) ) {
2417 # Get current restrictions on $action
2418 $aLimits = $this->mTitle
->getRestrictions( $action );
2419 $current[$action] = implode( '', $aLimits );
2420 # Are any actual restrictions being dealt with here?
2421 $aRChanged = count( $aLimits ) ||
!empty( $limit[$action] );
2423 # If something changed, we need to log it. Checking $aRChanged
2424 # assures that "unprotecting" a page that is not protected does
2425 # not log just because the expiry was "changed".
2426 if ( $aRChanged && $this->mTitle
->mRestrictionsExpiry
[$action] != $expiry[$action] ) {
2432 $current = Article
::flattenRestrictions( $current );
2434 $changed = ( $changed ||
$current != $updated );
2435 $changed = $changed ||
( $updated && $this->mTitle
->areRestrictionsCascading() != $cascade );
2436 $protect = ( $updated != '' );
2438 # If nothing's changed, do nothing
2440 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2441 $dbw = wfGetDB( DB_MASTER
);
2443 # Prepare a null revision to be added to the history
2444 $modified = $current != '' && $protect;
2447 $comment_type = $modified ?
'modifiedarticleprotection' : 'protectedarticle';
2449 $comment_type = 'unprotectedarticle';
2452 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle
->getPrefixedText() ) );
2454 # Only restrictions with the 'protect' right can cascade...
2455 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2456 $editrestriction = isset( $limit['edit'] ) ?
array( $limit['edit'] ) : $this->mTitle
->getRestrictions( 'edit' );
2458 # The schema allows multiple restrictions
2459 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2463 $cascade_description = '';
2466 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2470 $comment .= ": $reason";
2473 $editComment = $comment;
2474 $encodedExpiry = array();
2475 $protect_description = '';
2476 foreach ( $limit as $action => $restrictions ) {
2477 if ( !isset( $expiry[$action] ) )
2478 $expiry[$action] = $dbw->getInfinity();
2480 $encodedExpiry[$action] = $dbw->encodeExpiry( $expiry[$action] );
2481 if ( $restrictions != '' ) {
2482 $protect_description .= "[$action=$restrictions] (";
2483 if ( $encodedExpiry[$action] != 'infinity' ) {
2484 $protect_description .= wfMsgForContent( 'protect-expiring',
2485 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2486 $wgContLang->date( $expiry[$action], false, false ) ,
2487 $wgContLang->time( $expiry[$action], false, false ) );
2489 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2492 $protect_description .= ') ';
2495 $protect_description = trim( $protect_description );
2497 if ( $protect_description && $protect ) {
2498 $editComment .= " ($protect_description)";
2502 $editComment .= "$cascade_description";
2505 # Update restrictions table
2506 foreach ( $limit as $action => $restrictions ) {
2507 if ( $restrictions != '' ) {
2508 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2509 array( 'pr_page' => $id,
2510 'pr_type' => $action,
2511 'pr_level' => $restrictions,
2512 'pr_cascade' => ( $cascade && $action == 'edit' ) ?
1 : 0,
2513 'pr_expiry' => $encodedExpiry[$action]
2518 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2519 'pr_type' => $action ), __METHOD__
);
2523 # Insert a null revision
2524 $nullRevision = Revision
::newNullRevision( $dbw, $id, $editComment, true );
2525 $nullRevId = $nullRevision->insertOn( $dbw );
2527 $latest = $this->getLatest();
2528 # Update page record
2529 $dbw->update( 'page',
2531 'page_touched' => $dbw->timestamp(),
2532 'page_restrictions' => '',
2533 'page_latest' => $nullRevId
2534 ), array( /* WHERE */
2536 ), 'Article::protect'
2539 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2540 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2542 # Update the protection log
2543 $log = new LogPage( 'protect' );
2545 $params = array( $protect_description, $cascade ?
'cascade' : '' );
2546 $log->addEntry( $modified ?
'modify' : 'protect', $this->mTitle
, trim( $reason ), $params );
2548 $log->addEntry( 'unprotect', $this->mTitle
, $reason );
2551 } # End "changed" check
2557 * Take an array of page restrictions and flatten it to a string
2558 * suitable for insertion into the page_restrictions field.
2559 * @param $limit Array
2562 protected static function flattenRestrictions( $limit ) {
2563 if ( !is_array( $limit ) ) {
2564 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2570 foreach ( $limit as $action => $restrictions ) {
2571 if ( $restrictions != '' ) {
2572 $bits[] = "$action=$restrictions";
2576 return implode( ':', $bits );
2580 * Auto-generates a deletion reason
2582 * @param &$hasHistory Boolean: whether the page has a history
2583 * @return mixed String containing deletion reason or empty string, or boolean false
2584 * if no revision occurred
2586 public function generateReason( &$hasHistory ) {
2589 $dbw = wfGetDB( DB_MASTER
);
2590 // Get the last revision
2591 $rev = Revision
::newFromTitle( $this->mTitle
);
2593 if ( is_null( $rev ) ) {
2597 // Get the article's contents
2598 $contents = $rev->getText();
2601 // If the page is blank, use the text from the previous revision,
2602 // which can only be blank if there's a move/import/protect dummy revision involved
2603 if ( $contents == '' ) {
2604 $prev = $rev->getPrevious();
2607 $contents = $prev->getText();
2612 // Find out if there was only one contributor
2613 // Only scan the last 20 revisions
2614 $res = $dbw->select( 'revision', 'rev_user_text',
2615 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0' ),
2617 array( 'LIMIT' => 20 )
2620 if ( $res === false ) {
2621 // This page has no revisions, which is very weird
2625 $hasHistory = ( $res->numRows() > 1 );
2626 $row = $dbw->fetchObject( $res );
2628 if ( $row ) { // $row is false if the only contributor is hidden
2629 $onlyAuthor = $row->rev_user_text
;
2630 // Try to find a second contributor
2631 foreach ( $res as $row ) {
2632 if ( $row->rev_user_text
!= $onlyAuthor ) { // Bug 22999
2633 $onlyAuthor = false;
2638 $onlyAuthor = false;
2641 // Generate the summary with a '$1' placeholder
2643 // The current revision is blank and the one before is also
2644 // blank. It's just not our lucky day
2645 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2647 if ( $onlyAuthor ) {
2648 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2650 $reason = wfMsgForContent( 'excontent', '$1' );
2654 if ( $reason == '-' ) {
2655 // Allow these UI messages to be blanked out cleanly
2659 // Replace newlines with spaces to prevent uglyness
2660 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2661 // Calculate the maximum amount of chars to get
2662 // Max content length = max comment length - length of the comment (excl. $1)
2663 $maxLength = 255 - ( strlen( $reason ) - 2 );
2664 $contents = $wgContLang->truncate( $contents, $maxLength );
2665 // Remove possible unfinished links
2666 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2667 // Now replace the '$1' placeholder
2668 $reason = str_replace( '$1', $contents, $reason );
2675 * UI entry point for page deletion
2677 public function delete() {
2678 global $wgOut, $wgRequest;
2680 $confirm = $wgRequest->wasPosted() &&
2681 $wgOut->getUser()->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2683 $this->DeleteReasonList
= $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2684 $this->DeleteReason
= $wgRequest->getText( 'wpReason' );
2686 $reason = $this->DeleteReasonList
;
2688 if ( $reason != 'other' && $this->DeleteReason
!= '' ) {
2689 // Entry from drop down menu + additional comment
2690 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason
;
2691 } elseif ( $reason == 'other' ) {
2692 $reason = $this->DeleteReason
;
2695 # Flag to hide all contents of the archived revisions
2696 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgOut->getUser()->isAllowed( 'suppressrevision' );
2698 # This code desperately needs to be totally rewritten
2700 # Read-only check...
2701 if ( wfReadOnly() ) {
2702 $wgOut->readOnlyPage();
2708 $permission_errors = $this->mTitle
->getUserPermissionsErrors( 'delete', $wgOut->getUser() );
2710 if ( count( $permission_errors ) > 0 ) {
2711 $wgOut->showPermissionsErrorPage( $permission_errors );
2716 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle
->getPrefixedText() ) );
2718 # Better double-check that it hasn't been deleted yet!
2719 $dbw = wfGetDB( DB_MASTER
);
2720 $conds = $this->mTitle
->pageCond();
2721 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
2722 if ( $latest === false ) {
2723 $wgOut->showFatalError(
2726 array( 'class' => 'error mw-error-cannotdelete' ),
2727 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
2730 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2731 LogEventsList
::showLogExtract(
2734 $this->mTitle
->getPrefixedText()
2740 # Hack for big sites
2741 $bigHistory = $this->isBigDeletion();
2742 if ( $bigHistory && !$this->mTitle
->userCan( 'bigdelete' ) ) {
2743 global $wgLang, $wgDeleteRevisionsLimit;
2745 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2746 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2752 $this->doDelete( $reason, $suppress );
2754 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgOut->getUser()->isLoggedIn() ) {
2756 } elseif ( $this->mTitle
->userIsWatching() ) {
2763 // Generate deletion reason
2764 $hasHistory = false;
2766 $reason = $this->generateReason( $hasHistory );
2769 // If the page has a history, insert a warning
2770 if ( $hasHistory && !$confirm ) {
2773 $skin = $wgOut->getSkin();
2774 $revisions = $this->estimateRevisionCount();
2776 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2777 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2778 wfMsgHtml( 'word-separator' ) . $skin->link( $this->mTitle
,
2779 wfMsgHtml( 'history' ),
2780 array( 'rel' => 'archives' ),
2781 array( 'action' => 'history' ) ) .
2785 if ( $bigHistory ) {
2786 global $wgDeleteRevisionsLimit;
2787 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2788 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2792 return $this->confirmDelete( $reason );
2796 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2798 public function isBigDeletion() {
2799 global $wgDeleteRevisionsLimit;
2801 if ( $wgDeleteRevisionsLimit ) {
2802 $revCount = $this->estimateRevisionCount();
2804 return $revCount > $wgDeleteRevisionsLimit;
2811 * @return int approximate revision count
2813 public function estimateRevisionCount() {
2814 $dbr = wfGetDB( DB_SLAVE
);
2816 // For an exact count...
2817 // return $dbr->selectField( 'revision', 'COUNT(*)',
2818 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2819 return $dbr->estimateRowCount( 'revision', '*',
2820 array( 'rev_page' => $this->getId() ), __METHOD__
);
2824 * Get the last N authors
2825 * @param $num Integer: number of revisions to get
2826 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2827 * @return array Array of authors, duplicates not removed
2829 public function getLastNAuthors( $num, $revLatest = 0 ) {
2830 wfProfileIn( __METHOD__
);
2831 // First try the slave
2832 // If that doesn't have the latest revision, try the master
2834 $db = wfGetDB( DB_SLAVE
);
2837 $res = $db->select( array( 'page', 'revision' ),
2838 array( 'rev_id', 'rev_user_text' ),
2840 'page_namespace' => $this->mTitle
->getNamespace(),
2841 'page_title' => $this->mTitle
->getDBkey(),
2842 'rev_page = page_id'
2845 'ORDER BY' => 'rev_timestamp DESC',
2851 wfProfileOut( __METHOD__
);
2855 $row = $db->fetchObject( $res );
2857 if ( $continue == 2 && $revLatest && $row->rev_id
!= $revLatest ) {
2858 $db = wfGetDB( DB_MASTER
);
2863 } while ( $continue );
2865 $authors = array( $row->rev_user_text
);
2867 foreach ( $res as $row ) {
2868 $authors[] = $row->rev_user_text
;
2871 wfProfileOut( __METHOD__
);
2876 * Output deletion confirmation dialog
2877 * FIXME: Move to another file?
2878 * @param $reason String: prefilled reason
2880 public function confirmDelete( $reason ) {
2883 wfDebug( "Article::confirmDelete\n" );
2885 $deleteBackLink = $wgOut->getSkin()->linkKnown( $this->mTitle
);
2886 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
2887 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2888 $wgOut->addWikiMsg( 'confirmdeletetext' );
2890 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
2892 if ( $wgOut->getUser()->isAllowed( 'suppressrevision' ) ) {
2893 $suppress = "<tr id=\"wpDeleteSuppressRow\">
2895 <td class='mw-input'><strong>" .
2896 Xml
::checkLabel( wfMsg( 'revdelete-suppress' ),
2897 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
2903 $checkWatch = $wgOut->getUser()->getBoolOption( 'watchdeletion' ) ||
$this->mTitle
->userIsWatching();
2905 $form = Xml
::openElement( 'form', array( 'method' => 'post',
2906 'action' => $this->mTitle
->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
2907 Xml
::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
2908 Xml
::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
2909 Xml
::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
2910 "<tr id=\"wpDeleteReasonListRow\">
2911 <td class='mw-label'>" .
2912 Xml
::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
2914 <td class='mw-input'>" .
2915 Xml
::listDropDown( 'wpDeleteReasonList',
2916 wfMsgForContent( 'deletereason-dropdown' ),
2917 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
2920 <tr id=\"wpDeleteReasonRow\">
2921 <td class='mw-label'>" .
2922 Xml
::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
2924 <td class='mw-input'>" .
2925 Html
::input( 'wpReason', $reason, 'text', array(
2927 'maxlength' => '255',
2935 # Disallow watching if user is not logged in
2936 if ( $wgOut->getUser()->isLoggedIn() ) {
2940 <td class='mw-input'>" .
2941 Xml
::checkLabel( wfMsg( 'watchthis' ),
2942 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
2951 <td class='mw-submit'>" .
2952 Xml
::submitButton( wfMsg( 'deletepage' ),
2953 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
2956 Xml
::closeElement( 'table' ) .
2957 Xml
::closeElement( 'fieldset' ) .
2958 Html
::hidden( 'wpEditToken', $wgOut->getUser()->editToken() ) .
2959 Xml
::closeElement( 'form' );
2961 if ( $wgOut->getUser()->isAllowed( 'editinterface' ) ) {
2962 $skin = $wgOut->getSkin();
2963 $title = Title
::makeTitle( NS_MEDIAWIKI
, 'Deletereason-dropdown' );
2964 $link = $skin->link(
2966 wfMsgHtml( 'delete-edit-reasonlist' ),
2968 array( 'action' => 'edit' )
2970 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
2973 $wgOut->addHTML( $form );
2974 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
2975 LogEventsList
::showLogExtract( $wgOut, 'delete',
2976 $this->mTitle
->getPrefixedText()
2981 * Perform a deletion and output success or failure messages
2983 public function doDelete( $reason, $suppress = false ) {
2986 $id = $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
2989 if ( $this->doDeleteArticle( $reason, $suppress, $id, $error ) ) {
2990 $deleted = $this->mTitle
->getPrefixedText();
2992 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
2993 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2995 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
2997 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
2998 $wgOut->returnToMain( false );
3000 if ( $error == '' ) {
3001 $wgOut->showFatalError(
3004 array( 'class' => 'error mw-error-cannotdelete' ),
3005 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle
->getPrefixedText() )
3009 $wgOut->addHTML( Xml
::element( 'h2', null, LogPage
::logName( 'delete' ) ) );
3011 LogEventsList
::showLogExtract(
3014 $this->mTitle
->getPrefixedText()
3017 $wgOut->showFatalError( $error );
3023 * Back-end article deletion
3024 * Deletes the article with database consistency, writes logs, purges caches
3026 * @param $reason string delete reason for deletion log
3027 * @param suppress bitfield
3028 * Revision::DELETED_TEXT
3029 * Revision::DELETED_COMMENT
3030 * Revision::DELETED_USER
3031 * Revision::DELETED_RESTRICTED
3032 * @param $id int article ID
3033 * @param $commit boolean defaults to true, triggers transaction end
3034 * @return boolean true if successful
3036 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true, &$error = '' ) {
3037 global $wgDeferredUpdateList, $wgUseTrackbacks;
3040 wfDebug( __METHOD__
. "\n" );
3042 if ( ! wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3045 $dbw = wfGetDB( DB_MASTER
);
3046 $t = $this->mTitle
->getDBkey();
3047 $id = $id ?
$id : $this->mTitle
->getArticleID( Title
::GAID_FOR_UPDATE
);
3049 if ( $t === '' ||
$id == 0 ) {
3053 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3054 array_push( $wgDeferredUpdateList, $u );
3056 // Bitfields to further suppress the content
3059 // This should be 15...
3060 $bitfield |
= Revision
::DELETED_TEXT
;
3061 $bitfield |
= Revision
::DELETED_COMMENT
;
3062 $bitfield |
= Revision
::DELETED_USER
;
3063 $bitfield |
= Revision
::DELETED_RESTRICTED
;
3065 $bitfield = 'rev_deleted';
3069 // For now, shunt the revision data into the archive table.
3070 // Text is *not* removed from the text table; bulk storage
3071 // is left intact to avoid breaking block-compression or
3072 // immutable storage schemes.
3074 // For backwards compatibility, note that some older archive
3075 // table entries will have ar_text and ar_flags fields still.
3077 // In the future, we may keep revisions and mark them with
3078 // the rev_deleted field, which is reserved for this purpose.
3079 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3081 'ar_namespace' => 'page_namespace',
3082 'ar_title' => 'page_title',
3083 'ar_comment' => 'rev_comment',
3084 'ar_user' => 'rev_user',
3085 'ar_user_text' => 'rev_user_text',
3086 'ar_timestamp' => 'rev_timestamp',
3087 'ar_minor_edit' => 'rev_minor_edit',
3088 'ar_rev_id' => 'rev_id',
3089 'ar_text_id' => 'rev_text_id',
3090 'ar_text' => '\'\'', // Be explicit to appease
3091 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3092 'ar_len' => 'rev_len',
3093 'ar_page_id' => 'page_id',
3094 'ar_deleted' => $bitfield
3097 'page_id = rev_page'
3101 # Delete restrictions for it
3102 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__
);
3104 # Now that it's safely backed up, delete it
3105 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__
);
3106 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3113 # Fix category table counts
3115 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__
);
3117 foreach ( $res as $row ) {
3118 $cats [] = $row->cl_to
;
3121 $this->updateCategoryCounts( array(), $cats );
3123 # If using cascading deletes, we can skip some explicit deletes
3124 if ( !$dbw->cascadingDeletes() ) {
3125 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__
);
3127 if ( $wgUseTrackbacks )
3128 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__
);
3130 # Delete outgoing links
3131 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3132 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3133 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3134 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3135 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3136 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3137 $dbw->delete( 'iwlinks', array( 'iwl_from' => $id ) );
3138 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3141 # If using cleanup triggers, we can skip some manual deletes
3142 if ( !$dbw->cleanupTriggers() ) {
3143 # Clean up recentchanges entries...
3144 $dbw->delete( 'recentchanges',
3145 array( 'rc_type != ' . RC_LOG
,
3146 'rc_namespace' => $this->mTitle
->getNamespace(),
3147 'rc_title' => $this->mTitle
->getDBkey() ),
3149 $dbw->delete( 'recentchanges',
3150 array( 'rc_type != ' . RC_LOG
, 'rc_cur_id' => $id ),
3155 Article
::onArticleDelete( $this->mTitle
);
3157 # Clear the cached article id so the interface doesn't act like we exist
3158 $this->mTitle
->resetArticleID( 0 );
3160 # Log the deletion, if the page was suppressed, log it at Oversight instead
3161 $logtype = $suppress ?
'suppress' : 'delete';
3162 $log = new LogPage( $logtype );
3164 # Make sure logging got through
3165 $log->addEntry( 'delete', $this->mTitle
, $reason, array() );
3171 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3176 * Roll back the most recent consecutive set of edits to a page
3177 * from the same user; fails if there are no eligible edits to
3178 * roll back to, e.g. user is the sole contributor. This function
3179 * performs permissions checks on $wgUser, then calls commitRollback()
3180 * to do the dirty work
3182 * @param $fromP String: Name of the user whose edits to rollback.
3183 * @param $summary String: Custom summary. Set to default summary if empty.
3184 * @param $token String: Rollback token.
3185 * @param $bot Boolean: If true, mark all reverted edits as bot.
3187 * @param $resultDetails Array: contains result-specific array of additional values
3188 * 'alreadyrolled' : 'current' (rev)
3189 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3191 * @return array of errors, each error formatted as
3192 * array(messagekey, param1, param2, ...).
3193 * On success, the array is empty. This array can also be passed to
3194 * OutputPage::showPermissionsErrorPage().
3196 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3199 $resultDetails = null;
3202 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $wgUser );
3203 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $wgUser );
3204 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3206 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle
->getPrefixedText(), $fromP ) ) ) {
3207 $errors[] = array( 'sessionfailure' );
3210 if ( $wgUser->pingLimiter( 'rollback' ) ||
$wgUser->pingLimiter() ) {
3211 $errors[] = array( 'actionthrottledtext' );
3214 # If there were errors, bail out now
3215 if ( !empty( $errors ) ) {
3219 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3223 * Backend implementation of doRollback(), please refer there for parameter
3224 * and return value documentation
3226 * NOTE: This function does NOT check ANY permissions, it just commits the
3227 * rollback to the DB Therefore, you should only call this function direct-
3228 * ly if you want to use custom permissions checks. If you don't, use
3229 * doRollback() instead.
3231 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3232 global $wgUseRCPatrol, $wgUser, $wgLang;
3234 $dbw = wfGetDB( DB_MASTER
);
3236 if ( wfReadOnly() ) {
3237 return array( array( 'readonlytext' ) );
3240 # Get the last editor
3241 $current = Revision
::newFromTitle( $this->mTitle
);
3242 if ( is_null( $current ) ) {
3243 # Something wrong... no page?
3244 return array( array( 'notanarticle' ) );
3247 $from = str_replace( '_', ' ', $fromP );
3248 # User name given should match up with the top revision.
3249 # If the user was deleted then $from should be empty.
3250 if ( $from != $current->getUserText() ) {
3251 $resultDetails = array( 'current' => $current );
3252 return array( array( 'alreadyrolled',
3253 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3254 htmlspecialchars( $fromP ),
3255 htmlspecialchars( $current->getUserText() )
3259 # Get the last edit not by this guy...
3260 # Note: these may not be public values
3261 $user = intval( $current->getRawUser() );
3262 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3263 $s = $dbw->selectRow( 'revision',
3264 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3265 array( 'rev_page' => $current->getPage(),
3266 "rev_user != {$user} OR rev_user_text != {$user_text}"
3268 array( 'USE INDEX' => 'page_timestamp',
3269 'ORDER BY' => 'rev_timestamp DESC' )
3271 if ( $s === false ) {
3272 # No one else ever edited this page
3273 return array( array( 'cantrollback' ) );
3274 } else if ( $s->rev_deleted
& Revision
::DELETED_TEXT ||
$s->rev_deleted
& Revision
::DELETED_USER
) {
3275 # Only admins can see this text
3276 return array( array( 'notvisiblerev' ) );
3280 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3281 # Mark all reverted edits as bot
3285 if ( $wgUseRCPatrol ) {
3286 # Mark all reverted edits as patrolled
3287 $set['rc_patrolled'] = 1;
3290 if ( count( $set ) ) {
3291 $dbw->update( 'recentchanges', $set,
3293 'rc_cur_id' => $current->getPage(),
3294 'rc_user_text' => $current->getUserText(),
3295 "rc_timestamp > '{$s->rev_timestamp}'",
3300 # Generate the edit summary if necessary
3301 $target = Revision
::newFromId( $s->rev_id
);
3302 if ( empty( $summary ) ) {
3303 if ( $from == '' ) { // no public user name
3304 $summary = wfMsgForContent( 'revertpage-nouser' );
3306 $summary = wfMsgForContent( 'revertpage' );
3310 # Allow the custom summary to use the same args as the default message
3312 $target->getUserText(), $from, $s->rev_id
,
3313 $wgLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
), true ),
3314 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3316 $summary = wfMsgReplaceArgs( $summary, $args );
3319 $flags = EDIT_UPDATE
;
3321 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3322 $flags |
= EDIT_MINOR
;
3325 if ( $bot && ( $wgUser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3326 $flags |
= EDIT_FORCE_BOT
;
3329 # Actually store the edit
3330 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3331 if ( !empty( $status->value
['revision'] ) ) {
3332 $revId = $status->value
['revision']->getId();
3337 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3339 $resultDetails = array(
3340 'summary' => $summary,
3341 'current' => $current,
3342 'target' => $target,
3350 * User interface for rollback operations
3352 public function rollback() {
3353 global $wgUser, $wgOut, $wgRequest;
3357 $result = $this->doRollback(
3358 $wgRequest->getVal( 'from' ),
3359 $wgRequest->getText( 'summary' ),
3360 $wgRequest->getVal( 'token' ),
3361 $wgRequest->getBool( 'bot' ),
3365 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3366 $wgOut->rateLimited();
3370 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' ||
$result[0][0] == 'cantrollback' ) ) {
3371 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3372 $errArray = $result[0];
3373 $errMsg = array_shift( $errArray );
3374 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3376 if ( isset( $details['current'] ) ) {
3377 $current = $details['current'];
3379 if ( $current->getComment() != '' ) {
3380 $wgOut->addWikiMsgArray( 'editcomment', array(
3381 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3388 # Display permissions errors before read-only message -- there's no
3389 # point in misleading the user into thinking the inability to rollback
3390 # is only temporary.
3391 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3392 # array_diff is completely broken for arrays of arrays, sigh.
3393 # Remove any 'readonlytext' error manually.
3395 foreach ( $result as $error ) {
3396 if ( $error != array( 'readonlytext' ) ) {
3400 $wgOut->showPermissionsErrorPage( $out );
3405 if ( $result == array( array( 'readonlytext' ) ) ) {
3406 $wgOut->readOnlyPage();
3411 $current = $details['current'];
3412 $target = $details['target'];
3413 $newId = $details['newid'];
3414 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3415 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3417 if ( $current->getUserText() === '' ) {
3418 $old = wfMsg( 'rev-deleted-user' );
3420 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3421 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3424 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3425 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3426 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3427 $wgOut->returnToMain( false, $this->mTitle
);
3429 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3430 $de = new DifferenceEngine( $this->mTitle
, $current->getId(), $newId, false, true );
3431 $de->showDiff( '', '' );
3436 * Do standard deferred updates after page view
3438 public function viewUpdates() {
3439 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3440 if ( wfReadOnly() ) {
3444 # Don't update page view counters on views from bot users (bug 14044)
3445 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3446 $wgDeferredUpdateList[] = new ViewCountUpdate( $this->getID() );
3447 $wgDeferredUpdateList[] = new SiteStatsUpdate( 1, 0, 0 );
3450 # Update newtalk / watchlist notification status
3451 $wgUser->clearNotification( $this->mTitle
);
3455 * Prepare text which is about to be saved.
3456 * Returns a stdclass with source, pst and output members
3458 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
3459 if ( $this->mPreparedEdit
&& $this->mPreparedEdit
->newText
== $text && $this->mPreparedEdit
->revid
== $revid ) {
3461 return $this->mPreparedEdit
;
3466 if( $user === null ) {
3470 $popts = ParserOptions
::newFromUser( $user );
3471 wfRunHooks( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
3473 $edit = (object)array();
3474 $edit->revid
= $revid;
3475 $edit->newText
= $text;
3476 $edit->pst
= $this->preSaveTransform( $text, $user, $popts );
3477 $edit->popts
= $this->getParserOptions();
3478 $edit->output
= $wgParser->parse( $edit->pst
, $this->mTitle
, $edit->popts
, true, true, $revid );
3479 $edit->oldText
= $this->getRawText();
3481 $this->mPreparedEdit
= $edit;
3487 * Do standard deferred updates after page edit.
3488 * Update links tables, site stats, search index and message cache.
3489 * Purges pages that include this page if the text was changed here.
3490 * Every 100th edit, prune the recent changes table.
3493 * @param $text String: New text of the article
3494 * @param $summary String: Edit summary
3495 * @param $minoredit Boolean: Minor edit
3496 * @param $timestamp_of_pagechange String timestamp associated with the page change
3497 * @param $newid Integer: rev_id value of the new revision
3498 * @param $changed Boolean: Whether or not the content actually changed
3499 * @param $user User object: User doing the edit
3501 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true, User
$user = null ) {
3502 global $wgDeferredUpdateList, $wgUser, $wgEnableParserCache;
3504 wfProfileIn( __METHOD__
);
3507 # Be careful not to double-PST: $text is usually already PST-ed once
3508 if ( !$this->mPreparedEdit ||
$this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
3509 wfDebug( __METHOD__
. ": No prepared edit or vary-revision is set...\n" );
3510 $editInfo = $this->prepareTextForEdit( $text, $newid, $user );
3512 wfDebug( __METHOD__
. ": No vary-revision, using prepared edit...\n" );
3513 $editInfo = $this->mPreparedEdit
;
3516 # Save it to the parser cache
3517 if ( $wgEnableParserCache ) {
3518 $parserCache = ParserCache
::singleton();
3519 $parserCache->save( $editInfo->output
, $this, $editInfo->popts
);
3522 # Update the links tables
3523 $u = new LinksUpdate( $this->mTitle
, $editInfo->output
);
3526 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3528 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3529 if ( 0 == mt_rand( 0, 99 ) ) {
3530 // Flush old entries from the `recentchanges` table; we do this on
3531 // random requests so as to avoid an increase in writes for no good reason
3534 $dbw = wfGetDB( DB_MASTER
);
3535 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3538 array( "rc_timestamp < '$cutoff'" ),
3544 $id = $this->getID();
3545 $title = $this->mTitle
->getPrefixedDBkey();
3546 $shortTitle = $this->mTitle
->getDBkey();
3549 wfProfileOut( __METHOD__
);
3553 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment
, $this->mTotalAdjustment
);
3554 array_push( $wgDeferredUpdateList, $u );
3555 $u = new SearchUpdate( $id, $title, $text );
3556 array_push( $wgDeferredUpdateList, $u );
3558 # If this is another user's talk page, update newtalk
3559 # Don't do this if $changed = false otherwise some idiot can null-edit a
3560 # load of user talk pages and piss people off, nor if it's a minor edit
3561 # by a properly-flagged bot.
3562 if ( $this->mTitle
->getNamespace() == NS_USER_TALK
&& $shortTitle != $wgUser->getTitleKey() && $changed
3563 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3565 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3566 $other = User
::newFromName( $shortTitle, false );
3568 wfDebug( __METHOD__
. ": invalid username\n" );
3569 } elseif ( User
::isIP( $shortTitle ) ) {
3570 // An anonymous user
3571 $other->setNewtalk( true );
3572 } elseif ( $other->isLoggedIn() ) {
3573 $other->setNewtalk( true );
3575 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
3580 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
3581 MessageCache
::singleton()->replace( $shortTitle, $text );
3584 wfProfileOut( __METHOD__
);
3588 * Perform article updates on a special page creation.
3590 * @param $rev Revision object
3592 * @todo This is a shitty interface function. Kill it and replace the
3593 * other shitty functions like editUpdates and such so it's not needed
3596 public function createUpdates( $rev ) {
3597 $this->mGoodAdjustment
= $this->isCountable( $rev->getText() );
3598 $this->mTotalAdjustment
= 1;
3599 $this->editUpdates( $rev->getText(), $rev->getComment(),
3600 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3604 * Generate the navigation links when browsing through an article revisions
3605 * It shows the information as:
3606 * Revision as of \<date\>; view current revision
3607 * \<- Previous version | Next Version -\>
3609 * @param $oldid String: revision ID of this article revision
3611 public function setOldSubtitle( $oldid = 0 ) {
3612 global $wgLang, $wgOut, $wgUser, $wgRequest;
3614 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3618 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3620 # Cascade unhide param in links for easy deletion browsing
3621 $extraParams = array();
3622 if ( $wgRequest->getVal( 'unhide' ) ) {
3623 $extraParams['unhide'] = 1;
3626 $revision = Revision
::newFromId( $oldid );
3627 $timestamp = $revision->getTimestamp();
3629 $current = ( $oldid == $this->mLatest
);
3630 $td = $wgLang->timeanddate( $timestamp, true );
3631 $tddate = $wgLang->date( $timestamp, true );
3632 $tdtime = $wgLang->time( $timestamp, true );
3633 $sk = $wgUser->getSkin();
3635 ?
wfMsgHtml( 'currentrevisionlink' )
3638 wfMsgHtml( 'currentrevisionlink' ),
3641 array( 'known', 'noclasses' )
3644 ?
wfMsgHtml( 'diff' )
3647 wfMsgHtml( 'diff' ),
3653 array( 'known', 'noclasses' )
3655 $prev = $this->mTitle
->getPreviousRevisionID( $oldid ) ;
3659 wfMsgHtml( 'previousrevision' ),
3662 'direction' => 'prev',
3665 array( 'known', 'noclasses' )
3667 : wfMsgHtml( 'previousrevision' );
3671 wfMsgHtml( 'diff' ),
3677 array( 'known', 'noclasses' )
3679 : wfMsgHtml( 'diff' );
3680 $nextlink = $current
3681 ?
wfMsgHtml( 'nextrevision' )
3684 wfMsgHtml( 'nextrevision' ),
3687 'direction' => 'next',
3690 array( 'known', 'noclasses' )
3692 $nextdiff = $current
3693 ?
wfMsgHtml( 'diff' )
3696 wfMsgHtml( 'diff' ),
3702 array( 'known', 'noclasses' )
3707 // User can delete revisions or view deleted revisions...
3708 $canHide = $wgUser->isAllowed( 'deleterevision' );
3709 if ( $canHide ||
( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3710 if ( !$revision->userCan( Revision
::DELETED_RESTRICTED
) ) {
3711 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3714 'type' => 'revision',
3715 'target' => $this->mTitle
->getPrefixedDbkey(),
3718 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File
::DELETED_RESTRICTED
), $canHide );
3723 # Show user links if allowed to see them. If hidden, then show them only if requested...
3724 $userlinks = $sk->revUserTools( $revision, !$unhide );
3726 $infomsg = $current && !wfMessage( 'revision-info-current' )->isDisabled()
3727 ?
'revision-info-current'
3730 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3733 array( 'parseinline', 'replaceafter' ),
3739 $revision->getUser()
3742 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3743 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3745 $wgOut->addHTML( $r );
3749 * This function is called right before saving the wikitext,
3750 * so we can do things like signatures and links-in-context.
3752 * @param $text String article contents
3753 * @param $user User object: user doing the edit, $wgUser will be used if
3755 * @param $popts ParserOptions object: parser options, default options for
3756 * the user loaded if null given
3757 * @return string article contents with altered wikitext markup (signatures
3758 * converted, {{subst:}}, templates, etc.)
3760 public function preSaveTransform( $text, User
$user = null, ParserOptions
$popts = null ) {
3763 if ( $user === null ) {
3768 if ( $popts === null ) {
3769 $popts = ParserOptions
::newFromUser( $user );
3772 return $wgParser->preSaveTransform( $text, $this->mTitle
, $user, $popts );
3775 /* Caching functions */
3778 * checkLastModified returns true if it has taken care of all
3779 * output to the client that is necessary for this request.
3780 * (that is, it has sent a cached version of the page)
3782 * @return boolean true if cached version send, false otherwise
3784 protected function tryFileCache() {
3785 static $called = false;
3788 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3793 if ( $this->isFileCacheable() ) {
3794 $cache = new HTMLFileCache( $this->mTitle
);
3795 if ( $cache->isFileCacheGood( $this->mTouched
) ) {
3796 wfDebug( "Article::tryFileCache(): about to load file\n" );
3797 $cache->loadFromFileCache();
3800 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3801 ob_start( array( &$cache, 'saveToFileCache' ) );
3804 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3811 * Check if the page can be cached
3814 public function isFileCacheable() {
3817 if ( HTMLFileCache
::useFileCache() ) {
3818 $cacheable = $this->getID() && !$this->mRedirectedFrom
&& !$this->mTitle
->isRedirect();
3819 // Extension may have reason to disable file caching on some pages.
3821 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3829 * Loads page_touched and returns a value indicating if it should be used
3830 * @return boolean true if not a redirect
3832 public function checkTouched() {
3833 if ( !$this->mDataLoaded
) {
3834 $this->loadPageData();
3837 return !$this->mIsRedirect
;
3841 * Get the page_touched field
3842 * @return string containing GMT timestamp
3844 public function getTouched() {
3845 if ( !$this->mDataLoaded
) {
3846 $this->loadPageData();
3849 return $this->mTouched
;
3853 * Get the page_latest field
3854 * @return integer rev_id of current revision
3856 public function getLatest() {
3857 if ( !$this->mDataLoaded
) {
3858 $this->loadPageData();
3861 return (int)$this->mLatest
;
3865 * Edit an article without doing all that other stuff
3866 * The article must already exist; link tables etc
3867 * are not updated, caches are not flushed.
3869 * @param $text String: text submitted
3870 * @param $comment String: comment submitted
3871 * @param $minor Boolean: whereas it's a minor modification
3873 public function quickEdit( $text, $comment = '', $minor = 0 ) {
3874 wfProfileIn( __METHOD__
);
3876 $dbw = wfGetDB( DB_MASTER
);
3877 $revision = new Revision( array(
3878 'page' => $this->getId(),
3880 'comment' => $comment,
3881 'minor_edit' => $minor ?
1 : 0,
3883 $revision->insertOn( $dbw );
3884 $this->updateRevisionOn( $dbw, $revision );
3887 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
3889 wfProfileOut( __METHOD__
);
3893 * The onArticle*() functions are supposed to be a kind of hooks
3894 * which should be called whenever any of the specified actions
3897 * This is a good place to put code to clear caches, for instance.
3899 * This is called on page move and undelete, as well as edit
3901 * @param $title Title object
3903 public static function onArticleCreate( $title ) {
3904 # Update existence markers on article/talk tabs...
3905 if ( $title->isTalkPage() ) {
3906 $other = $title->getSubjectPage();
3908 $other = $title->getTalkPage();
3911 $other->invalidateCache();
3912 $other->purgeSquid();
3914 $title->touchLinks();
3915 $title->purgeSquid();
3916 $title->deleteTitleProtection();
3920 * Clears caches when article is deleted
3922 public static function onArticleDelete( $title ) {
3923 # Update existence markers on article/talk tabs...
3924 if ( $title->isTalkPage() ) {
3925 $other = $title->getSubjectPage();
3927 $other = $title->getTalkPage();
3930 $other->invalidateCache();
3931 $other->purgeSquid();
3933 $title->touchLinks();
3934 $title->purgeSquid();
3937 HTMLFileCache
::clearFileCache( $title );
3940 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3941 MessageCache
::singleton()->replace( $title->getDBkey(), false );
3945 if ( $title->getNamespace() == NS_FILE
) {
3946 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
3947 $update->doUpdate();
3951 if ( $title->getNamespace() == NS_USER_TALK
) {
3952 $user = User
::newFromName( $title->getText(), false );
3953 $user->setNewtalk( false );
3957 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3961 * Purge caches on page update etc
3963 * @param $title Title object
3964 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
3966 public static function onArticleEdit( $title ) {
3967 global $wgDeferredUpdateList;
3969 // Invalidate caches of articles which include this page
3970 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
3972 // Invalidate the caches of all pages which redirect here
3973 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
3975 # Purge squid for this page only
3976 $title->purgeSquid();
3978 # Clear file cache for this page only
3979 HTMLFileCache
::clearFileCache( $title );
3985 * Overriden by ImagePage class, only present here to avoid a fatal error
3986 * Called for ?action=revert
3988 public function revert() {
3990 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
3994 * Info about this page
3995 * Called for ?action=info when $wgAllowPageInfo is on.
3997 public function info() {
3998 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4000 if ( !$wgAllowPageInfo ) {
4001 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4005 $page = $this->mTitle
->getSubjectPage();
4007 $wgOut->setPagetitle( $page->getPrefixedText() );
4008 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4009 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4011 if ( !$this->mTitle
->exists() ) {
4012 $wgOut->addHTML( '<div class="noarticletext">' );
4013 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
4014 // This doesn't quite make sense; the user is asking for
4015 // information about the _page_, not the message... -- RC
4016 $wgOut->addHTML( htmlspecialchars( $this->mTitle
->getDefaultMessageText() ) );
4018 $msg = $wgUser->isLoggedIn()
4020 : 'noarticletextanon';
4021 $wgOut->addWikiMsg( $msg );
4024 $wgOut->addHTML( '</div>' );
4026 $dbr = wfGetDB( DB_SLAVE
);
4028 'wl_title' => $page->getDBkey(),
4029 'wl_namespace' => $page->getNamespace() );
4030 $numwatchers = $dbr->selectField(
4036 $pageInfo = $this->pageCountInfo( $page );
4037 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4040 //FIXME: unescaped messages
4041 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4042 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4045 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4048 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4051 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4054 $wgOut->addHTML( '</ul>' );
4059 * Return the total number of edits and number of unique editors
4060 * on a given page. If page does not exist, returns false.
4062 * @param $title Title object
4063 * @return mixed array or boolean false
4065 public function pageCountInfo( $title ) {
4066 $id = $title->getArticleId();
4072 $dbr = wfGetDB( DB_SLAVE
);
4073 $rev_clause = array( 'rev_page' => $id );
4074 $edits = $dbr->selectField(
4080 $authors = $dbr->selectField(
4082 'COUNT(DISTINCT rev_user_text)',
4087 return array( 'edits' => $edits, 'authors' => $authors );
4091 * Return a list of templates used by this article.
4092 * Uses the templatelinks table
4094 * @return Array of Title objects
4096 public function getUsedTemplates() {
4098 $id = $this->mTitle
->getArticleID();
4104 $dbr = wfGetDB( DB_SLAVE
);
4105 $res = $dbr->select( array( 'templatelinks' ),
4106 array( 'tl_namespace', 'tl_title' ),
4107 array( 'tl_from' => $id ),
4110 if ( $res !== false ) {
4111 foreach ( $res as $row ) {
4112 $result[] = Title
::makeTitle( $row->tl_namespace
, $row->tl_title
);
4120 * Returns a list of hidden categories this page is a member of.
4121 * Uses the page_props and categorylinks tables.
4123 * @return Array of Title objects
4125 public function getHiddenCategories() {
4127 $id = $this->mTitle
->getArticleID();
4133 $dbr = wfGetDB( DB_SLAVE
);
4134 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4136 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4137 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ),
4140 if ( $res !== false ) {
4141 foreach ( $res as $row ) {
4142 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
4150 * Return an applicable autosummary if one exists for the given edit.
4151 * @param $oldtext String: the previous text of the page.
4152 * @param $newtext String: The submitted text of the page.
4153 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
4154 * @return string An appropriate autosummary, or an empty string.
4156 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4159 # Decide what kind of autosummary is needed.
4161 # Redirect autosummaries
4162 $ot = Title
::newFromRedirect( $oldtext );
4163 $rt = Title
::newFromRedirect( $newtext );
4165 if ( is_object( $rt ) && ( !is_object( $ot ) ||
!$rt->equals( $ot ) ||
$ot->getFragment() != $rt->getFragment() ) ) {
4166 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4169 # New page autosummaries
4170 if ( $flags & EDIT_NEW
&& strlen( $newtext ) ) {
4171 # If they're making a new article, give its text, truncated, in the summary.
4173 $truncatedtext = $wgContLang->truncate(
4174 str_replace( "\n", ' ', $newtext ),
4175 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4177 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4180 # Blanking autosummaries
4181 if ( $oldtext != '' && $newtext == '' ) {
4182 return wfMsgForContent( 'autosumm-blank' );
4183 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4184 # Removing more than 90% of the article
4186 $truncatedtext = $wgContLang->truncate(
4188 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4190 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4193 # If we reach this point, there's no applicable autosummary for our case, so our
4194 # autosummary is empty.
4199 * Add the primary page-view wikitext to the output buffer
4200 * Saves the text into the parser cache if possible.
4201 * Updates templatelinks if it is out of date.
4203 * @param $text String
4204 * @param $cache Boolean
4205 * @param $parserOptions mixed ParserOptions object, or boolean false
4207 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4210 $this->mParserOutput
= $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4211 $wgOut->addParserOutput( $this->mParserOutput
);
4215 * This does all the heavy lifting for outputWikitext, except it returns the parser
4216 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4217 * say, embedding thread pages within a discussion system (LiquidThreads)
4219 * @param $text string
4220 * @param $cache boolean
4221 * @param $parserOptions parsing options, defaults to false
4222 * @return string containing parsed output
4224 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4225 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4227 if ( !$parserOptions ) {
4228 $parserOptions = $this->getParserOptions();
4232 $this->mParserOutput
= $wgParser->parse( $text, $this->mTitle
,
4233 $parserOptions, true, true, $this->getRevIdFetched() );
4238 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4239 $this->mTitle
->getPrefixedDBkey() ) );
4242 if ( $wgEnableParserCache && $cache && $this->mParserOutput
->isCacheable() ) {
4243 $parserCache = ParserCache
::singleton();
4244 $parserCache->save( $this->mParserOutput
, $this, $parserOptions );
4247 // Make sure file cache is not used on uncacheable content.
4248 // Output that has magic words in it can still use the parser cache
4249 // (if enabled), though it will generally expire sooner.
4250 if ( !$this->mParserOutput
->isCacheable() ||
$this->mParserOutput
->containsOldMagic() ) {
4251 $wgUseFileCache = false;
4254 $this->doCascadeProtectionUpdates( $this->mParserOutput
);
4256 return $this->mParserOutput
;
4260 * Get parser options suitable for rendering the primary article wikitext
4261 * @return ParserOptions object
4263 public function getParserOptions() {
4265 if ( !$this->mParserOptions
) {
4266 $this->mParserOptions
= $this->makeParserOptions( $wgUser );
4268 // Clone to allow modifications of the return value without affecting cache
4269 return clone $this->mParserOptions
;
4273 * Get parser options suitable for rendering the primary article wikitext
4275 * @return ParserOptions
4277 public function makeParserOptions( User
$user ) {
4278 $options = ParserOptions
::newFromUser( $user );
4279 $options->enableLimitReport(); // show inclusion/loop reports
4280 $options->setTidy( true ); // fix bad HTML
4285 * Updates cascading protections
4287 * @param $parserOutput mixed ParserOptions object, or boolean false
4289 protected function doCascadeProtectionUpdates( $parserOutput ) {
4290 if ( !$this->isCurrent() ||
wfReadOnly() ||
!$this->mTitle
->areRestrictionsCascading() ) {
4294 // templatelinks table may have become out of sync,
4295 // especially if using variable-based transclusions.
4296 // For paranoia, check if things have changed and if
4297 // so apply updates to the database. This will ensure
4298 // that cascaded protections apply as soon as the changes
4301 # Get templates from templatelinks
4302 $id = $this->mTitle
->getArticleID();
4304 $tlTemplates = array();
4306 $dbr = wfGetDB( DB_SLAVE
);
4307 $res = $dbr->select( array( 'templatelinks' ),
4308 array( 'tl_namespace', 'tl_title' ),
4309 array( 'tl_from' => $id ),
4313 foreach ( $res as $row ) {
4314 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4317 # Get templates from parser output.
4318 $poTemplates = array();
4319 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4320 foreach ( $templates as $dbk => $id ) {
4321 $poTemplates["$ns:$dbk"] = true;
4326 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4328 if ( count( $templates_diff ) > 0 ) {
4329 # Whee, link updates time.
4330 $u = new LinksUpdate( $this->mTitle
, $parserOutput, false );
4336 * Update all the appropriate counts in the category table, given that
4337 * we've added the categories $added and deleted the categories $deleted.
4339 * @param $added array The names of categories that were added
4340 * @param $deleted array The names of categories that were deleted
4342 public function updateCategoryCounts( $added, $deleted ) {
4343 $ns = $this->mTitle
->getNamespace();
4344 $dbw = wfGetDB( DB_MASTER
);
4346 # First make sure the rows exist. If one of the "deleted" ones didn't
4347 # exist, we might legitimately not create it, but it's simpler to just
4348 # create it and then give it a negative value, since the value is bogus
4351 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4352 $insertCats = array_merge( $added, $deleted );
4353 if ( !$insertCats ) {
4354 # Okay, nothing to do
4358 $insertRows = array();
4360 foreach ( $insertCats as $cat ) {
4361 $insertRows[] = array(
4362 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4366 $dbw->insert( 'category', $insertRows, __METHOD__
, 'IGNORE' );
4368 $addFields = array( 'cat_pages = cat_pages + 1' );
4369 $removeFields = array( 'cat_pages = cat_pages - 1' );
4371 if ( $ns == NS_CATEGORY
) {
4372 $addFields[] = 'cat_subcats = cat_subcats + 1';
4373 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4374 } elseif ( $ns == NS_FILE
) {
4375 $addFields[] = 'cat_files = cat_files + 1';
4376 $removeFields[] = 'cat_files = cat_files - 1';
4383 array( 'cat_title' => $added ),
4392 array( 'cat_title' => $deleted ),
4399 * Lightweight method to get the parser output for a page, checking the parser cache
4400 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4401 * consider, so it's not appropriate to use there.
4403 * @since 1.16 (r52326) for LiquidThreads
4405 * @param $oldid mixed integer Revision ID or null
4406 * @return ParserOutput or false if the given revsion ID is not found
4408 public function getParserOutput( $oldid = null ) {
4409 global $wgEnableParserCache, $wgUser;
4411 // Should the parser cache be used?
4412 $useParserCache = $wgEnableParserCache &&
4413 $wgUser->getStubThreshold() == 0 &&
4417 wfDebug( __METHOD__
. ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
4419 if ( $wgUser->getStubThreshold() ) {
4420 wfIncrStats( 'pcache_miss_stub' );
4423 if ( $useParserCache ) {
4424 $parserOutput = ParserCache
::singleton()->get( $this, $this->getParserOptions() );
4425 if ( $parserOutput !== false ) {
4426 return $parserOutput;
4430 // Cache miss; parse and output it.
4431 if ( $oldid === null ) {
4432 $text = $this->getRawText();
4434 $rev = Revision
::newFromTitle( $this->getTitle(), $oldid );
4435 if ( $rev === null ) {
4438 $text = $rev->getText();
4441 return $this->getOutputFromWikitext( $text, $useParserCache );
4445 * Sets the context this Article is executed in
4447 * @param $context RequestContext
4450 public function setContext( $context ) {
4451 $this->mContext
= $context;
4455 * Gets the context this Article is executed in
4457 * @return RequestContext
4460 public function getContext() {
4461 if ( $this->mContext
instanceof RequestContext
) {
4462 return $this->mContext
;
4464 wfDebug( __METHOD__
. " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" );
4465 return RequestContext
::getMain();
4471 class PoolWorkArticleView
extends PoolCounterWork
{
4474 function __construct( $article, $key, $useParserCache, $parserOptions ) {
4475 parent
::__construct( 'ArticleView', $key );
4476 $this->mArticle
= $article;
4477 $this->cacheable
= $useParserCache;
4478 $this->parserOptions
= $parserOptions;
4482 return $this->mArticle
->doViewParse();
4485 function getCachedWork() {
4488 $parserCache = ParserCache
::singleton();
4489 $this->mArticle
->mParserOutput
= $parserCache->get( $this->mArticle
, $this->parserOptions
);
4491 if ( $this->mArticle
->mParserOutput
!== false ) {
4492 wfDebug( __METHOD__
. ": showing contents parsed by someone else\n" );
4493 $wgOut->addParserOutput( $this->mArticle
->mParserOutput
);
4494 # Ensure that UI elements requiring revision ID have
4495 # the correct version information.
4496 $wgOut->setRevisionId( $this->mArticle
->getLatest() );
4502 function fallback() {
4503 return $this->mArticle
->tryDirtyCache();
4506 function error( $status ) {
4509 $wgOut->clearHTML(); // for release() errors
4510 $wgOut->enableClientCache( false );
4511 $wgOut->setRobotPolicy( 'noindex,nofollow' );
4513 $errortext = $status->getWikiText( false, 'view-pool-error' );
4514 $wgOut->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );