Localisation updates for core and extension messages from translatewiki.net (2011...
[mediawiki.git] / includes / Article.php
blob666b2ddb65348b867f3d95c92f5d689dcb30bdc1
1 <?php
2 /**
3 * File for articles
4 * @file
5 */
7 /**
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
16 class Article {
17 /**@{{
18 * @private
20 var $mComment = ''; // !<
21 var $mContent; // !<
22 var $mContentLoaded = false; // !<
23 var $mCounter = -1; // !< Not loaded
24 var $mDataLoaded = false; // !<
25 var $mForUpdate = false; // !<
26 var $mGoodAdjustment = 0; // !<
27 var $mIsRedirect = false; // !<
28 var $mLatest = false; // !<
29 var $mMinorEdit; // !<
30 var $mOldId; // !<
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 $mRevision = null; // !< Revision object if set
37 var $mTimestamp = ''; // !<
38 var $mTitle; // !< Title object
39 var $mTotalAdjustment = 0; // !<
40 var $mTouched = '19700101000000'; // !<
41 var $mUser = -1; // !< Not loaded
42 var $mUserText = ''; // !< username from Revision if set
43 var $mParserOptions; // !< ParserOptions object for $wgUser articles
44 var $mParserOutput; // !< ParserCache object if set
45 /**@}}*/
47 /**
48 * Constructor and clear the article
49 * @param $title Reference to a Title object.
50 * @param $oldId Integer revision ID, null to fetch from request, zero for current
52 public function __construct( Title $title, $oldId = null ) {
53 // FIXME: does the reference play any role here?
54 $this->mTitle =& $title;
55 $this->mOldId = $oldId;
58 /**
59 * Constructor from an page id
60 * @param $id Int article ID to load
62 public static function newFromID( $id ) {
63 $t = Title::newFromID( $id );
64 # FIXME: doesn't inherit right
65 return $t == null ? null : new self( $t );
66 # return $t == null ? null : new static( $t ); // PHP 5.3
69 /**
70 * Tell the page view functions that this view was redirected
71 * from another page on the wiki.
72 * @param $from Title object.
74 public function setRedirectedFrom( Title $from ) {
75 $this->mRedirectedFrom = $from;
78 /**
79 * If this page is a redirect, get its target
81 * The target will be fetched from the redirect table if possible.
82 * If this page doesn't have an entry there, call insertRedirect()
83 * @return mixed Title object, or null if this page is not a redirect
85 public function getRedirectTarget() {
86 if ( !$this->mTitle->isRedirect() ) {
87 return null;
90 if ( $this->mRedirectTarget !== null ) {
91 return $this->mRedirectTarget;
94 # Query the redirect table
95 $dbr = wfGetDB( DB_SLAVE );
96 $row = $dbr->selectRow( 'redirect',
97 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
98 array( 'rd_from' => $this->getID() ),
99 __METHOD__
102 // rd_fragment and rd_interwiki were added later, populate them if empty
103 if ( $row && !is_null( $row->rd_fragment ) && !is_null( $row->rd_interwiki ) ) {
104 return $this->mRedirectTarget = Title::makeTitle(
105 $row->rd_namespace, $row->rd_title,
106 $row->rd_fragment, $row->rd_interwiki );
109 # This page doesn't have an entry in the redirect table
110 return $this->mRedirectTarget = $this->insertRedirect();
114 * Insert an entry for this page into the redirect table.
116 * Don't call this function directly unless you know what you're doing.
117 * @return Title object or null if not a redirect
119 public function insertRedirect() {
120 // recurse through to only get the final target
121 $retval = Title::newFromRedirectRecurse( $this->getRawText() );
122 if ( !$retval ) {
123 return null;
125 $this->insertRedirectEntry( $retval );
126 return $retval;
130 * Insert or update the redirect table entry for this page to indicate
131 * it redirects to $rt .
132 * @param $rt Title redirect target
134 public function insertRedirectEntry( $rt ) {
135 $dbw = wfGetDB( DB_MASTER );
136 $dbw->replace( 'redirect', array( 'rd_from' ),
137 array(
138 'rd_from' => $this->getID(),
139 'rd_namespace' => $rt->getNamespace(),
140 'rd_title' => $rt->getDBkey(),
141 'rd_fragment' => $rt->getFragment(),
142 'rd_interwiki' => $rt->getInterwiki(),
144 __METHOD__
149 * Get the Title object or URL this page redirects to
151 * @return mixed false, Title of in-wiki target, or string with URL
153 public function followRedirect() {
154 return $this->getRedirectURL( $this->getRedirectTarget() );
158 * Get the Title object this text redirects to
160 * @param $text string article content containing redirect info
161 * @return mixed false, Title of in-wiki target, or string with URL
162 * @deprecated @since 1.17
164 public function followRedirectText( $text ) {
165 // recurse through to only get the final target
166 return $this->getRedirectURL( Title::newFromRedirectRecurse( $text ) );
170 * Get the Title object or URL to use for a redirect. We use Title
171 * objects for same-wiki, non-special redirects and URLs for everything
172 * else.
173 * @param $rt Title Redirect target
174 * @return mixed false, Title object of local target, or string with URL
176 public function getRedirectURL( $rt ) {
177 if ( $rt ) {
178 if ( $rt->getInterwiki() != '' ) {
179 if ( $rt->isLocal() ) {
180 // Offsite wikis need an HTTP redirect.
182 // This can be hard to reverse and may produce loops,
183 // so they may be disabled in the site configuration.
184 $source = $this->mTitle->getFullURL( 'redirect=no' );
185 return $rt->getFullURL( 'rdfrom=' . urlencode( $source ) );
187 } else {
188 if ( $rt->getNamespace() == NS_SPECIAL ) {
189 // Gotta handle redirects to special pages differently:
190 // Fill the HTTP response "Location" header and ignore
191 // the rest of the page we're on.
193 // This can be hard to reverse, so they may be disabled.
194 if ( $rt->isSpecial( 'Userlogout' ) ) {
195 // rolleyes
196 } else {
197 return $rt->getFullURL();
201 return $rt;
205 // No or invalid redirect
206 return false;
210 * Get the title object of the article
211 * @return Title object of this page
213 public function getTitle() {
214 return $this->mTitle;
218 * Clear the object
219 * FIXME: shouldn't this be public?
220 * @private
222 public function clear() {
223 $this->mDataLoaded = false;
224 $this->mContentLoaded = false;
226 $this->mUser = $this->mCounter = -1; # Not loaded
227 $this->mRedirectedFrom = null; # Title object if set
228 $this->mRedirectTarget = null; # Title object if set
229 $this->mUserText =
230 $this->mTimestamp = $this->mComment = '';
231 $this->mGoodAdjustment = $this->mTotalAdjustment = 0;
232 $this->mTouched = '19700101000000';
233 $this->mForUpdate = false;
234 $this->mIsRedirect = false;
235 $this->mRevIdFetched = 0;
236 $this->mRedirectUrl = false;
237 $this->mLatest = false;
238 $this->mPreparedEdit = false;
242 * Note that getContent/loadContent do not follow redirects anymore.
243 * If you need to fetch redirectable content easily, try
244 * the shortcut in Article::followRedirect()
246 * This function has side effects! Do not use this function if you
247 * only want the real revision text if any.
249 * @return Return the text of this revision
251 public function getContent() {
252 global $wgUser;
254 wfProfileIn( __METHOD__ );
256 if ( $this->getID() === 0 ) {
257 # If this is a MediaWiki:x message, then load the messages
258 # and return the message value for x.
259 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
260 $text = $this->mTitle->getDefaultMessageText();
261 if ( $text === false ) {
262 $text = '';
264 } else {
265 $text = wfMsgExt( $wgUser->isLoggedIn() ? 'noarticletext' : 'noarticletextanon', 'parsemag' );
267 wfProfileOut( __METHOD__ );
269 return $text;
270 } else {
271 $this->loadContent();
272 wfProfileOut( __METHOD__ );
274 return $this->mContent;
279 * Get the text of the current revision. No side-effects...
281 * @return Return the text of the current revision
283 public function getRawText() {
284 // Check process cache for current revision
285 if ( $this->mContentLoaded && $this->mOldId == 0 ) {
286 return $this->mContent;
289 $rev = Revision::newFromTitle( $this->mTitle );
290 $text = $rev ? $rev->getRawText() : false;
292 return $text;
296 * This function returns the text of a section, specified by a number ($section).
297 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
298 * the first section before any such heading (section 0).
300 * If a section contains subsections, these are also returned.
302 * @param $text String: text to look in
303 * @param $section Integer: section number
304 * @return string text of the requested section
305 * @deprecated
307 public function getSection( $text, $section ) {
308 global $wgParser;
309 return $wgParser->getSection( $text, $section );
313 * Get the text that needs to be saved in order to undo all revisions
314 * between $undo and $undoafter. Revisions must belong to the same page,
315 * must exist and must not be deleted
316 * @param $undo Revision
317 * @param $undoafter Revision Must be an earlier revision than $undo
318 * @return mixed string on success, false on failure
320 public function getUndoText( Revision $undo, Revision $undoafter = null ) {
321 $currentRev = Revision::newFromTitle( $this->mTitle );
322 if ( !$currentRev ) {
323 return false; // no page
325 $undo_text = $undo->getText();
326 $undoafter_text = $undoafter->getText();
327 $cur_text = $currentRev->getText();
329 if ( $cur_text == $undo_text ) {
330 # No use doing a merge if it's just a straight revert.
331 return $undoafter_text;
334 $undone_text = '';
336 if ( !wfMerge( $undo_text, $undoafter_text, $cur_text, $undone_text ) ) {
337 return false;
340 return $undone_text;
344 * @return int The oldid of the article that is to be shown, 0 for the
345 * current revision
347 public function getOldID() {
348 if ( is_null( $this->mOldId ) ) {
349 $this->mOldId = $this->getOldIDFromRequest();
352 return $this->mOldId;
356 * Sets $this->mRedirectUrl to a correct URL if the query parameters are incorrect
358 * @return int The old id for the request
360 public function getOldIDFromRequest() {
361 global $wgRequest;
363 $this->mRedirectUrl = false;
365 $oldid = $wgRequest->getVal( 'oldid' );
367 if ( isset( $oldid ) ) {
368 $oldid = intval( $oldid );
369 if ( $wgRequest->getVal( 'direction' ) == 'next' ) {
370 $nextid = $this->mTitle->getNextRevisionID( $oldid );
371 if ( $nextid ) {
372 $oldid = $nextid;
373 } else {
374 $this->mRedirectUrl = $this->mTitle->getFullURL( 'redirect=no' );
376 } elseif ( $wgRequest->getVal( 'direction' ) == 'prev' ) {
377 $previd = $this->mTitle->getPreviousRevisionID( $oldid );
378 if ( $previd ) {
379 $oldid = $previd;
384 if ( !$oldid ) {
385 $oldid = 0;
388 return $oldid;
392 * Load the revision (including text) into this object
394 function loadContent() {
395 if ( $this->mContentLoaded ) {
396 return;
399 wfProfileIn( __METHOD__ );
401 $this->fetchContent( $this->getOldID() );
403 wfProfileOut( __METHOD__ );
407 * Fetch a page record with the given conditions
408 * @param $dbr Database object
409 * @param $conditions Array
410 * @return mixed Database result resource, or false on failure
412 protected function pageData( $dbr, $conditions ) {
413 $fields = array(
414 'page_id',
415 'page_namespace',
416 'page_title',
417 'page_restrictions',
418 'page_counter',
419 'page_is_redirect',
420 'page_is_new',
421 'page_random',
422 'page_touched',
423 'page_latest',
424 'page_len',
427 wfRunHooks( 'ArticlePageDataBefore', array( &$this, &$fields ) );
429 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__ );
431 wfRunHooks( 'ArticlePageDataAfter', array( &$this, &$row ) );
433 return $row;
437 * Fetch a page record matching the Title object's namespace and title
438 * using a sanitized title string
440 * @param $dbr Database object
441 * @param $title Title object
442 * @return mixed Database result resource, or false on failure
444 public function pageDataFromTitle( $dbr, $title ) {
445 return $this->pageData( $dbr, array(
446 'page_namespace' => $title->getNamespace(),
447 'page_title' => $title->getDBkey() ) );
451 * Fetch a page record matching the requested ID
453 * @param $dbr Database
454 * @param $id Integer
456 protected function pageDataFromId( $dbr, $id ) {
457 return $this->pageData( $dbr, array( 'page_id' => $id ) );
461 * Set the general counter, title etc data loaded from
462 * some source.
464 * @param $data Database row object or "fromdb"
466 public function loadPageData( $data = 'fromdb' ) {
467 if ( $data === 'fromdb' ) {
468 $dbr = wfGetDB( DB_SLAVE );
469 $data = $this->pageDataFromTitle( $dbr, $this->mTitle );
472 $lc = LinkCache::singleton();
474 if ( $data ) {
475 $lc->addGoodLinkObj( $data->page_id, $this->mTitle, $data->page_len, $data->page_is_redirect, $data->page_latest );
477 $this->mTitle->mArticleID = intval( $data->page_id );
479 # Old-fashioned restrictions
480 $this->mTitle->loadRestrictions( $data->page_restrictions );
482 $this->mCounter = intval( $data->page_counter );
483 $this->mTouched = wfTimestamp( TS_MW, $data->page_touched );
484 $this->mIsRedirect = intval( $data->page_is_redirect );
485 $this->mLatest = intval( $data->page_latest );
486 } else {
487 $lc->addBadLinkObj( $this->mTitle );
488 $this->mTitle->mArticleID = 0;
491 $this->mDataLoaded = true;
495 * Get text of an article from database
496 * Does *NOT* follow redirects.
498 * @param $oldid Int: 0 for whatever the latest revision is
499 * @return mixed string containing article contents, or false if null
501 function fetchContent( $oldid = 0 ) {
502 if ( $this->mContentLoaded ) {
503 return $this->mContent;
506 # Pre-fill content with error message so that if something
507 # fails we'll have something telling us what we intended.
508 $t = $this->mTitle->getPrefixedText();
509 $d = $oldid ? wfMsgExt( 'missingarticle-rev', array( 'escape' ), $oldid ) : '';
510 $this->mContent = wfMsgNoTrans( 'missing-article', $t, $d ) ;
512 if ( $oldid ) {
513 $revision = Revision::newFromId( $oldid );
514 if ( $revision === null ) {
515 wfDebug( __METHOD__ . " failed to retrieve specified revision, id $oldid\n" );
516 return false;
519 if ( !$this->mDataLoaded || $this->getID() != $revision->getPage() ) {
520 $data = $this->pageDataFromId( wfGetDB( DB_SLAVE ), $revision->getPage() );
522 if ( !$data ) {
523 wfDebug( __METHOD__ . " failed to get page data linked to revision id $oldid\n" );
524 return false;
527 $this->mTitle = Title::makeTitle( $data->page_namespace, $data->page_title );
528 $this->loadPageData( $data );
530 } else {
531 if ( !$this->mDataLoaded ) {
532 $this->loadPageData();
535 if ( $this->mLatest === false ) {
536 wfDebug( __METHOD__ . " failed to find page data for title " . $this->mTitle->getPrefixedText() . "\n" );
537 return false;
540 $revision = Revision::newFromId( $this->mLatest );
541 if ( $revision === null ) {
542 wfDebug( __METHOD__ . " failed to retrieve current page, rev_id {$this->mLatest}\n" );
543 return false;
547 // FIXME: Horrible, horrible! This content-loading interface just plain sucks.
548 // We should instead work with the Revision object when we need it...
549 $this->mContent = $revision->getText( Revision::FOR_THIS_USER ); // Loads if user is allowed
551 if ( $revision->getId() == $this->mLatest ) {
552 $this->setLastEdit( $revision );
555 $this->mRevIdFetched = $revision->getId();
556 $this->mContentLoaded = true;
557 $this->mRevision =& $revision;
559 wfRunHooks( 'ArticleAfterFetchContent', array( &$this, &$this->mContent ) );
561 return $this->mContent;
565 * Read/write accessor to select FOR UPDATE
567 * @param $x Mixed: FIXME
568 * @return mixed value of $x, or value stored in Article::mForUpdate
570 public function forUpdate( $x = null ) {
571 return wfSetVar( $this->mForUpdate, $x );
575 * Get options for all SELECT statements
577 * @param $options Array: an optional options array which'll be appended to
578 * the default
579 * @return Array: options
581 protected function getSelectOptions( $options = '' ) {
582 if ( $this->mForUpdate ) {
583 if ( is_array( $options ) ) {
584 $options[] = 'FOR UPDATE';
585 } else {
586 $options = 'FOR UPDATE';
590 return $options;
594 * @return int Page ID
596 public function getID() {
597 return $this->mTitle->getArticleID();
601 * @return bool Whether or not the page exists in the database
603 public function exists() {
604 return $this->getId() > 0;
608 * Check if this page is something we're going to be showing
609 * some sort of sensible content for. If we return false, page
610 * views (plain action=view) will return an HTTP 404 response,
611 * so spiders and robots can know they're following a bad link.
613 * @return bool
615 public function hasViewableContent() {
616 return $this->exists() || $this->mTitle->isAlwaysKnown();
620 * @return int The view count for the page
622 public function getCount() {
623 if ( -1 == $this->mCounter ) {
624 $id = $this->getID();
626 if ( $id == 0 ) {
627 $this->mCounter = 0;
628 } else {
629 $dbr = wfGetDB( DB_SLAVE );
630 $this->mCounter = $dbr->selectField( 'page',
631 'page_counter',
632 array( 'page_id' => $id ),
633 __METHOD__,
634 $this->getSelectOptions()
639 return $this->mCounter;
643 * Determine whether a page would be suitable for being counted as an
644 * article in the site_stats table based on the title & its content
646 * @param $text String: text to analyze
647 * @return bool
649 public function isCountable( $text ) {
650 global $wgUseCommaCount;
652 $token = $wgUseCommaCount ? ',' : '[[';
654 return $this->mTitle->isContentPage() && !$this->isRedirect( $text ) && in_string( $token, $text );
658 * Tests if the article text represents a redirect
660 * @param $text mixed string containing article contents, or boolean
661 * @return bool
663 public function isRedirect( $text = false ) {
664 if ( $text === false ) {
665 if ( !$this->mDataLoaded ) {
666 $this->loadPageData();
669 return (bool)$this->mIsRedirect;
670 } else {
671 return Title::newFromRedirect( $text ) !== null;
676 * Returns true if the currently-referenced revision is the current edit
677 * to this page (and it exists).
678 * @return bool
680 public function isCurrent() {
681 # If no oldid, this is the current version.
682 if ( $this->getOldID() == 0 ) {
683 return true;
686 return $this->exists() && $this->mRevision && $this->mRevision->isCurrent();
690 * Loads everything except the text
691 * This isn't necessary for all uses, so it's only done if needed.
693 protected function loadLastEdit() {
694 if ( -1 != $this->mUser ) {
695 return;
698 # New or non-existent articles have no user information
699 $id = $this->getID();
700 if ( 0 == $id ) {
701 return;
704 $revision = Revision::loadFromPageId( wfGetDB( DB_MASTER ), $id );
705 if ( !is_null( $revision ) ) {
706 $this->setLastEdit( $revision );
711 * Set the latest revision
713 protected function setLastEdit( Revision $revision ) {
714 $this->mLastRevision = $revision;
715 $this->mUser = $revision->getUser();
716 $this->mUserText = $revision->getUserText();
717 $this->mTimestamp = $revision->getTimestamp();
718 $this->mComment = $revision->getComment();
719 $this->mMinorEdit = $revision->isMinor();
723 * @return string GMT timestamp of last article revision
725 public function getTimestamp() {
726 // Check if the field has been filled by ParserCache::get()
727 if ( !$this->mTimestamp ) {
728 $this->loadLastEdit();
731 return wfTimestamp( TS_MW, $this->mTimestamp );
735 * @return int user ID for the user that made the last article revision
737 public function getUser() {
738 $this->loadLastEdit();
739 return $this->mUser;
743 * @return string username of the user that made the last article revision
745 public function getUserText() {
746 $this->loadLastEdit();
747 return $this->mUserText;
751 * @return string Comment stored for the last article revision
753 public function getComment() {
754 $this->loadLastEdit();
755 return $this->mComment;
759 * Returns true if last revision was marked as "minor edit"
761 * @return boolean Minor edit indicator for the last article revision.
763 public function getMinorEdit() {
764 $this->loadLastEdit();
765 return $this->mMinorEdit;
769 * Use this to fetch the rev ID used on page views
771 * @return int revision ID of last article revision
773 public function getRevIdFetched() {
774 if ( $this->mRevIdFetched ) {
775 return $this->mRevIdFetched;
776 } else {
777 return $this->getLatest();
782 * FIXME: this does what?
783 * @param $limit Integer: default 0.
784 * @param $offset Integer: default 0.
785 * @return UserArrayFromResult object with User objects of article contributors for requested range
787 public function getContributors( $limit = 0, $offset = 0 ) {
788 # FIXME: this is expensive; cache this info somewhere.
790 $dbr = wfGetDB( DB_SLAVE );
791 $revTable = $dbr->tableName( 'revision' );
792 $userTable = $dbr->tableName( 'user' );
794 $pageId = $this->getId();
796 $user = $this->getUser();
798 if ( $user ) {
799 $excludeCond = "AND rev_user != $user";
800 } else {
801 $userText = $dbr->addQuotes( $this->getUserText() );
802 $excludeCond = "AND rev_user_text != $userText";
805 $deletedBit = $dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER ); // username hidden?
807 $sql = "SELECT {$userTable}.*, rev_user_text as user_name, MAX(rev_timestamp) as timestamp
808 FROM $revTable LEFT JOIN $userTable ON rev_user = user_id
809 WHERE rev_page = $pageId
810 $excludeCond
811 AND $deletedBit = 0
812 GROUP BY rev_user, rev_user_text
813 ORDER BY timestamp DESC";
815 if ( $limit > 0 ) {
816 $sql = $dbr->limitResult( $sql, $limit, $offset );
819 $sql .= ' ' . $this->getSelectOptions();
820 $res = $dbr->query( $sql, __METHOD__ );
822 return new UserArrayFromResult( $res );
826 * This is the default action of the index.php entry point: just view the
827 * page of the given title.
829 public function view() {
830 global $wgUser, $wgOut, $wgRequest, $wgParser;
831 global $wgUseFileCache, $wgUseETag;
833 wfProfileIn( __METHOD__ );
835 # Get variables from query string
836 $oldid = $this->getOldID();
837 $parserCache = ParserCache::singleton();
839 $parserOptions = $this->getParserOptions();
840 # Render printable version, use printable version cache
841 if ( $wgOut->isPrintable() ) {
842 $parserOptions->setIsPrintable( true );
843 $parserOptions->setEditSection( false );
844 } else if ( $wgUseETag && !$this->mTitle->quickUserCan( 'edit' ) ) {
845 $parserOptions->setEditSection( false );
848 # Try client and file cache
849 if ( $oldid === 0 && $this->checkTouched() ) {
850 if ( $wgUseETag ) {
851 $wgOut->setETag( $parserCache->getETag( $this, $parserOptions ) );
854 # Is it client cached?
855 if ( $wgOut->checkLastModified( $this->getTouched() ) ) {
856 wfDebug( __METHOD__ . ": done 304\n" );
857 wfProfileOut( __METHOD__ );
859 return;
860 # Try file cache
861 } else if ( $wgUseFileCache && $this->tryFileCache() ) {
862 wfDebug( __METHOD__ . ": done file cache\n" );
863 # tell wgOut that output is taken care of
864 $wgOut->disable();
865 $this->viewUpdates();
866 wfProfileOut( __METHOD__ );
868 return;
872 # getOldID may want us to redirect somewhere else
873 if ( $this->mRedirectUrl ) {
874 $wgOut->redirect( $this->mRedirectUrl );
875 wfDebug( __METHOD__ . ": redirecting due to oldid\n" );
876 wfProfileOut( __METHOD__ );
878 return;
881 $wgOut->setArticleFlag( true );
882 # Set page title (may be overridden by DISPLAYTITLE)
883 $wgOut->setPageTitle( $this->mTitle->getPrefixedText() );
885 # If we got diff in the query, we want to see a diff page instead of the article.
886 if ( $wgRequest->getCheck( 'diff' ) ) {
887 wfDebug( __METHOD__ . ": showing diff page\n" );
888 $this->showDiffPage();
889 wfProfileOut( __METHOD__ );
891 return;
894 # Allow frames by default
895 $wgOut->allowClickjacking();
897 if ( !$wgUseETag && !$this->mTitle->quickUserCan( 'edit' ) ) {
898 $parserOptions->setEditSection( false );
901 # Should the parser cache be used?
902 $useParserCache = $this->useParserCache( $oldid );
903 wfDebug( 'Article::view using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
904 if ( $wgUser->getStubThreshold() ) {
905 wfIncrStats( 'pcache_miss_stub' );
908 $wasRedirected = $this->showRedirectedFromHeader();
909 $this->showNamespaceHeader();
911 # Iterate through the possible ways of constructing the output text.
912 # Keep going until $outputDone is set, or we run out of things to do.
913 $pass = 0;
914 $outputDone = false;
915 $this->mParserOutput = false;
917 while ( !$outputDone && ++$pass ) {
918 switch( $pass ) {
919 case 1:
920 wfRunHooks( 'ArticleViewHeader', array( &$this, &$outputDone, &$useParserCache ) );
921 break;
922 case 2:
923 # Try the parser cache
924 if ( $useParserCache ) {
925 $this->mParserOutput = $parserCache->get( $this, $parserOptions );
927 if ( $this->mParserOutput !== false ) {
928 wfDebug( __METHOD__ . ": showing parser cache contents\n" );
929 $wgOut->addParserOutput( $this->mParserOutput );
930 # Ensure that UI elements requiring revision ID have
931 # the correct version information.
932 $wgOut->setRevisionId( $this->mLatest );
933 $outputDone = true;
936 break;
937 case 3:
938 $text = $this->getContent();
939 if ( $text === false || $this->getID() == 0 ) {
940 wfDebug( __METHOD__ . ": showing missing article\n" );
941 $this->showMissingArticle();
942 wfProfileOut( __METHOD__ );
943 return;
946 # Another whitelist check in case oldid is altering the title
947 if ( !$this->mTitle->userCanRead() ) {
948 wfDebug( __METHOD__ . ": denied on secondary read check\n" );
949 $wgOut->loginToUse();
950 $wgOut->output();
951 $wgOut->disable();
952 wfProfileOut( __METHOD__ );
953 return;
956 # Are we looking at an old revision
957 if ( $oldid && !is_null( $this->mRevision ) ) {
958 $this->setOldSubtitle( $oldid );
960 if ( !$this->showDeletedRevisionHeader() ) {
961 wfDebug( __METHOD__ . ": cannot view deleted revision\n" );
962 wfProfileOut( __METHOD__ );
963 return;
966 # If this "old" version is the current, then try the parser cache...
967 if ( $oldid === $this->getLatest() && $this->useParserCache( false ) ) {
968 $this->mParserOutput = $parserCache->get( $this, $parserOptions );
969 if ( $this->mParserOutput ) {
970 wfDebug( __METHOD__ . ": showing parser cache for current rev permalink\n" );
971 $wgOut->addParserOutput( $this->mParserOutput );
972 $wgOut->setRevisionId( $this->mLatest );
973 $outputDone = true;
974 break;
979 # Ensure that UI elements requiring revision ID have
980 # the correct version information.
981 $wgOut->setRevisionId( $this->getRevIdFetched() );
983 # Pages containing custom CSS or JavaScript get special treatment
984 if ( $this->mTitle->isCssOrJsPage() || $this->mTitle->isCssJsSubpage() ) {
985 wfDebug( __METHOD__ . ": showing CSS/JS source\n" );
986 $this->showCssOrJsPage();
987 $outputDone = true;
988 } else {
989 $rt = Title::newFromRedirectArray( $text );
990 if ( $rt ) {
991 wfDebug( __METHOD__ . ": showing redirect=no page\n" );
992 # Viewing a redirect page (e.g. with parameter redirect=no)
993 # Don't append the subtitle if this was an old revision
994 $wgOut->addHTML( $this->viewRedirect( $rt, !$wasRedirected && $this->isCurrent() ) );
995 # Parse just to get categories, displaytitle, etc.
996 $this->mParserOutput = $wgParser->parse( $text, $this->mTitle, $parserOptions );
997 $wgOut->addParserOutputNoText( $this->mParserOutput );
998 $outputDone = true;
1001 break;
1002 case 4:
1003 # Run the parse, protected by a pool counter
1004 wfDebug( __METHOD__ . ": doing uncached parse\n" );
1006 $key = $parserCache->getKey( $this, $parserOptions );
1007 $poolArticleView = new PoolWorkArticleView( $this, $key, $useParserCache, $parserOptions );
1009 if ( !$poolArticleView->execute() ) {
1010 # Connection or timeout error
1011 wfProfileOut( __METHOD__ );
1012 return;
1013 } else {
1014 $outputDone = true;
1016 break;
1017 # Should be unreachable, but just in case...
1018 default:
1019 break 2;
1023 # Adjust the title if it was set by displaytitle, -{T|}- or language conversion
1024 if ( $this->mParserOutput ) {
1025 $titleText = $this->mParserOutput->getTitleText();
1027 if ( strval( $titleText ) !== '' ) {
1028 $wgOut->setPageTitle( $titleText );
1032 # For the main page, overwrite the <title> element with the con-
1033 # tents of 'pagetitle-view-mainpage' instead of the default (if
1034 # that's not empty).
1035 # This message always exists because it is in the i18n files
1036 if ( $this->mTitle->equals( Title::newMainPage() )
1037 && ( $m = wfMsgForContent( 'pagetitle-view-mainpage' ) ) !== '' )
1039 $wgOut->setHTMLTitle( $m );
1042 # Now that we've filled $this->mParserOutput, we know whether
1043 # there are any __NOINDEX__ tags on the page
1044 $policy = $this->getRobotPolicy( 'view' );
1045 $wgOut->setIndexPolicy( $policy['index'] );
1046 $wgOut->setFollowPolicy( $policy['follow'] );
1048 $this->showViewFooter();
1049 $this->viewUpdates();
1050 wfProfileOut( __METHOD__ );
1054 * Show a diff page according to current request variables. For use within
1055 * Article::view() only, other callers should use the DifferenceEngine class.
1057 public function showDiffPage() {
1058 global $wgRequest, $wgUser;
1060 $diff = $wgRequest->getVal( 'diff' );
1061 $rcid = $wgRequest->getVal( 'rcid' );
1062 $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
1063 $purge = $wgRequest->getVal( 'action' ) == 'purge';
1064 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
1065 $oldid = $this->getOldID();
1067 $de = new DifferenceEngine( $this->mTitle, $oldid, $diff, $rcid, $purge, $unhide );
1068 // DifferenceEngine directly fetched the revision:
1069 $this->mRevIdFetched = $de->mNewid;
1070 $de->showDiffPage( $diffOnly );
1072 // Needed to get the page's current revision
1073 $this->loadPageData();
1074 if ( $diff == 0 || $diff == $this->mLatest ) {
1075 # Run view updates for current revision only
1076 $this->viewUpdates();
1081 * Show a page view for a page formatted as CSS or JavaScript. To be called by
1082 * Article::view() only.
1084 * This is hooked by SyntaxHighlight_GeSHi to do syntax highlighting of these
1085 * page views.
1087 protected function showCssOrJsPage() {
1088 global $wgOut;
1090 $wgOut->wrapWikiMsg( "<div id='mw-clearyourcache'>\n$1\n</div>", 'clearyourcache' );
1092 // Give hooks a chance to customise the output
1093 if ( wfRunHooks( 'ShowRawCssJs', array( $this->mContent, $this->mTitle, $wgOut ) ) ) {
1094 // Wrap the whole lot in a <pre> and don't parse
1095 $m = array();
1096 preg_match( '!\.(css|js)$!u', $this->mTitle->getText(), $m );
1097 $wgOut->addHTML( "<pre class=\"mw-code mw-{$m[1]}\" dir=\"ltr\">\n" );
1098 $wgOut->addHTML( htmlspecialchars( $this->mContent ) );
1099 $wgOut->addHTML( "\n</pre>\n" );
1104 * Get the robot policy to be used for the current view
1105 * @param $action String the action= GET parameter
1106 * @return Array the policy that should be set
1107 * TODO: actions other than 'view'
1109 public function getRobotPolicy( $action ) {
1110 global $wgOut, $wgArticleRobotPolicies, $wgNamespaceRobotPolicies;
1111 global $wgDefaultRobotPolicy, $wgRequest;
1113 $ns = $this->mTitle->getNamespace();
1115 if ( $ns == NS_USER || $ns == NS_USER_TALK ) {
1116 # Don't index user and user talk pages for blocked users (bug 11443)
1117 if ( !$this->mTitle->isSubpage() ) {
1118 $block = new Block();
1119 if ( $block->load( $this->mTitle->getText() ) ) {
1120 return array(
1121 'index' => 'noindex',
1122 'follow' => 'nofollow'
1128 if ( $this->getID() === 0 || $this->getOldID() ) {
1129 # Non-articles (special pages etc), and old revisions
1130 return array(
1131 'index' => 'noindex',
1132 'follow' => 'nofollow'
1134 } elseif ( $wgOut->isPrintable() ) {
1135 # Discourage indexing of printable versions, but encourage following
1136 return array(
1137 'index' => 'noindex',
1138 'follow' => 'follow'
1140 } elseif ( $wgRequest->getInt( 'curid' ) ) {
1141 # For ?curid=x urls, disallow indexing
1142 return array(
1143 'index' => 'noindex',
1144 'follow' => 'follow'
1148 # Otherwise, construct the policy based on the various config variables.
1149 $policy = self::formatRobotPolicy( $wgDefaultRobotPolicy );
1151 if ( isset( $wgNamespaceRobotPolicies[$ns] ) ) {
1152 # Honour customised robot policies for this namespace
1153 $policy = array_merge(
1154 $policy,
1155 self::formatRobotPolicy( $wgNamespaceRobotPolicies[$ns] )
1158 if ( $this->mTitle->canUseNoindex() && is_object( $this->mParserOutput ) && $this->mParserOutput->getIndexPolicy() ) {
1159 # __INDEX__ and __NOINDEX__ magic words, if allowed. Incorporates
1160 # a final sanity check that we have really got the parser output.
1161 $policy = array_merge(
1162 $policy,
1163 array( 'index' => $this->mParserOutput->getIndexPolicy() )
1167 if ( isset( $wgArticleRobotPolicies[$this->mTitle->getPrefixedText()] ) ) {
1168 # (bug 14900) site config can override user-defined __INDEX__ or __NOINDEX__
1169 $policy = array_merge(
1170 $policy,
1171 self::formatRobotPolicy( $wgArticleRobotPolicies[$this->mTitle->getPrefixedText()] )
1175 return $policy;
1179 * Converts a String robot policy into an associative array, to allow
1180 * merging of several policies using array_merge().
1181 * @param $policy Mixed, returns empty array on null/false/'', transparent
1182 * to already-converted arrays, converts String.
1183 * @return Array: 'index' => <indexpolicy>, 'follow' => <followpolicy>
1185 public static function formatRobotPolicy( $policy ) {
1186 if ( is_array( $policy ) ) {
1187 return $policy;
1188 } elseif ( !$policy ) {
1189 return array();
1192 $policy = explode( ',', $policy );
1193 $policy = array_map( 'trim', $policy );
1195 $arr = array();
1196 foreach ( $policy as $var ) {
1197 if ( in_array( $var, array( 'index', 'noindex' ) ) ) {
1198 $arr['index'] = $var;
1199 } elseif ( in_array( $var, array( 'follow', 'nofollow' ) ) ) {
1200 $arr['follow'] = $var;
1204 return $arr;
1208 * If this request is a redirect view, send "redirected from" subtitle to
1209 * $wgOut. Returns true if the header was needed, false if this is not a
1210 * redirect view. Handles both local and remote redirects.
1212 * @return boolean
1214 public function showRedirectedFromHeader() {
1215 global $wgOut, $wgUser, $wgRequest, $wgRedirectSources;
1217 $rdfrom = $wgRequest->getVal( 'rdfrom' );
1218 $sk = $wgUser->getSkin();
1220 if ( isset( $this->mRedirectedFrom ) ) {
1221 // This is an internally redirected page view.
1222 // We'll need a backlink to the source page for navigation.
1223 if ( wfRunHooks( 'ArticleViewRedirect', array( &$this ) ) ) {
1224 $redir = $sk->link(
1225 $this->mRedirectedFrom,
1226 null,
1227 array(),
1228 array( 'redirect' => 'no' ),
1229 array( 'known', 'noclasses' )
1232 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1233 $wgOut->setSubtitle( $s );
1235 // Set the fragment if one was specified in the redirect
1236 if ( strval( $this->mTitle->getFragment() ) != '' ) {
1237 $fragment = Xml::escapeJsString( $this->mTitle->getFragmentForURL() );
1238 $wgOut->addInlineScript( "redirectToFragment(\"$fragment\");" );
1241 // Add a <link rel="canonical"> tag
1242 $wgOut->addLink( array( 'rel' => 'canonical',
1243 'href' => $this->mTitle->getLocalURL() )
1246 return true;
1248 } elseif ( $rdfrom ) {
1249 // This is an externally redirected view, from some other wiki.
1250 // If it was reported from a trusted site, supply a backlink.
1251 if ( $wgRedirectSources && preg_match( $wgRedirectSources, $rdfrom ) ) {
1252 $redir = $sk->makeExternalLink( $rdfrom, $rdfrom );
1253 $s = wfMsgExt( 'redirectedfrom', array( 'parseinline', 'replaceafter' ), $redir );
1254 $wgOut->setSubtitle( $s );
1256 return true;
1260 return false;
1264 * Show a header specific to the namespace currently being viewed, like
1265 * [[MediaWiki:Talkpagetext]]. For Article::view().
1267 public function showNamespaceHeader() {
1268 global $wgOut;
1270 if ( $this->mTitle->isTalkPage() ) {
1271 if ( !wfMessage( 'talkpageheader' )->isDisabled() ) {
1272 $wgOut->wrapWikiMsg( "<div class=\"mw-talkpageheader\">\n$1\n</div>", array( 'talkpageheader' ) );
1278 * Show the footer section of an ordinary page view
1280 public function showViewFooter() {
1281 global $wgOut, $wgUseTrackbacks;
1283 # check if we're displaying a [[User talk:x.x.x.x]] anonymous talk page
1284 if ( $this->mTitle->getNamespace() == NS_USER_TALK && IP::isValid( $this->mTitle->getText() ) ) {
1285 $wgOut->addWikiMsg( 'anontalkpagetext' );
1288 # If we have been passed an &rcid= parameter, we want to give the user a
1289 # chance to mark this new article as patrolled.
1290 $this->showPatrolFooter();
1292 # Trackbacks
1293 if ( $wgUseTrackbacks ) {
1294 $this->addTrackbacks();
1297 wfRunHooks( 'ArticleViewFooter', array( $this ) );
1302 * If patrol is possible, output a patrol UI box. This is called from the
1303 * footer section of ordinary page views. If patrol is not possible or not
1304 * desired, does nothing.
1306 public function showPatrolFooter() {
1307 global $wgOut, $wgRequest, $wgUser;
1309 $rcid = $wgRequest->getVal( 'rcid' );
1311 if ( !$rcid || !$this->mTitle->quickUserCan( 'patrol' ) ) {
1312 return;
1315 $sk = $wgUser->getSkin();
1316 $token = $wgUser->editToken( $rcid );
1317 $wgOut->preventClickjacking();
1319 $wgOut->addHTML(
1320 "<div class='patrollink'>" .
1321 wfMsgHtml(
1322 'markaspatrolledlink',
1323 $sk->link(
1324 $this->mTitle,
1325 wfMsgHtml( 'markaspatrolledtext' ),
1326 array(),
1327 array(
1328 'action' => 'markpatrolled',
1329 'rcid' => $rcid,
1330 'token' => $token,
1332 array( 'known', 'noclasses' )
1335 '</div>'
1340 * Show the error text for a missing article. For articles in the MediaWiki
1341 * namespace, show the default message text. To be called from Article::view().
1343 public function showMissingArticle() {
1344 global $wgOut, $wgRequest, $wgUser;
1346 # Show info in user (talk) namespace. Does the user exist? Is he blocked?
1347 if ( $this->mTitle->getNamespace() == NS_USER || $this->mTitle->getNamespace() == NS_USER_TALK ) {
1348 $parts = explode( '/', $this->mTitle->getText() );
1349 $rootPart = $parts[0];
1350 $user = User::newFromName( $rootPart, false /* allow IP users*/ );
1351 $ip = User::isIP( $rootPart );
1353 if ( !$user->isLoggedIn() && !$ip ) { # User does not exist
1354 $wgOut->wrapWikiMsg( "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
1355 array( 'userpage-userdoesnotexist-view', $rootPart ) );
1356 } else if ( $user->isBlocked() ) { # Show log extract if the user is currently blocked
1357 LogEventsList::showLogExtract(
1358 $wgOut,
1359 'block',
1360 $user->getUserPage()->getPrefixedText(),
1362 array(
1363 'lim' => 1,
1364 'showIfEmpty' => false,
1365 'msgKey' => array(
1366 'blocked-notice-logextract',
1367 $user->getName() # Support GENDER in notice
1374 wfRunHooks( 'ShowMissingArticle', array( $this ) );
1376 # Show delete and move logs
1377 LogEventsList::showLogExtract( $wgOut, array( 'delete', 'move' ), $this->mTitle->getPrefixedText(), '',
1378 array( 'lim' => 10,
1379 'conds' => array( "log_action != 'revision'" ),
1380 'showIfEmpty' => false,
1381 'msgKey' => array( 'moveddeleted-notice' ) )
1384 # Show error message
1385 $oldid = $this->getOldID();
1386 if ( $oldid ) {
1387 $text = wfMsgNoTrans( 'missing-article',
1388 $this->mTitle->getPrefixedText(),
1389 wfMsgNoTrans( 'missingarticle-rev', $oldid ) );
1390 } elseif ( $this->mTitle->getNamespace() === NS_MEDIAWIKI ) {
1391 // Use the default message text
1392 $text = $this->mTitle->getDefaultMessageText();
1393 } else {
1394 $createErrors = $this->mTitle->getUserPermissionsErrors( 'create', $wgUser );
1395 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $wgUser );
1396 $errors = array_merge( $createErrors, $editErrors );
1398 if ( !count( $errors ) ) {
1399 $text = wfMsgNoTrans( 'noarticletext' );
1400 } else {
1401 $text = wfMsgNoTrans( 'noarticletext-nopermission' );
1404 $text = "<div class='noarticletext'>\n$text\n</div>";
1406 if ( !$this->hasViewableContent() ) {
1407 // If there's no backing content, send a 404 Not Found
1408 // for better machine handling of broken links.
1409 $wgRequest->response()->header( "HTTP/1.x 404 Not Found" );
1412 $wgOut->addWikiText( $text );
1416 * If the revision requested for view is deleted, check permissions.
1417 * Send either an error message or a warning header to $wgOut.
1419 * @return boolean true if the view is allowed, false if not.
1421 public function showDeletedRevisionHeader() {
1422 global $wgOut, $wgRequest;
1424 if ( !$this->mRevision->isDeleted( Revision::DELETED_TEXT ) ) {
1425 // Not deleted
1426 return true;
1429 // If the user is not allowed to see it...
1430 if ( !$this->mRevision->userCan( Revision::DELETED_TEXT ) ) {
1431 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1432 'rev-deleted-text-permission' );
1434 return false;
1435 // If the user needs to confirm that they want to see it...
1436 } else if ( $wgRequest->getInt( 'unhide' ) != 1 ) {
1437 # Give explanation and add a link to view the revision...
1438 $oldid = intval( $this->getOldID() );
1439 $link = $this->mTitle->getFullUrl( "oldid={$oldid}&unhide=1" );
1440 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1441 'rev-suppressed-text-unhide' : 'rev-deleted-text-unhide';
1442 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n",
1443 array( $msg, $link ) );
1445 return false;
1446 // We are allowed to see...
1447 } else {
1448 $msg = $this->mRevision->isDeleted( Revision::DELETED_RESTRICTED ) ?
1449 'rev-suppressed-text-view' : 'rev-deleted-text-view';
1450 $wgOut->wrapWikiMsg( "<div class='mw-warning plainlinks'>\n$1\n</div>\n", $msg );
1452 return true;
1457 * Should the parser cache be used?
1459 * @return boolean
1461 public function useParserCache( $oldid ) {
1462 global $wgUser, $wgEnableParserCache;
1464 return $wgEnableParserCache
1465 && $wgUser->getStubThreshold() == 0
1466 && $this->exists()
1467 && empty( $oldid )
1468 && !$this->mTitle->isCssOrJsPage()
1469 && !$this->mTitle->isCssJsSubpage();
1473 * Execute the uncached parse for action=view
1475 public function doViewParse() {
1476 global $wgOut;
1478 $oldid = $this->getOldID();
1479 $parserOptions = $this->getParserOptions();
1481 # Render printable version, use printable version cache
1482 $parserOptions->setIsPrintable( $wgOut->isPrintable() );
1484 # Don't show section-edit links on old revisions... this way lies madness.
1485 if ( !$this->isCurrent() || $wgOut->isPrintable() || !$this->mTitle->quickUserCan( 'edit' ) ) {
1486 $parserOptions->setEditSection( false );
1489 $useParserCache = $this->useParserCache( $oldid );
1490 $this->outputWikiText( $this->getContent(), $useParserCache, $parserOptions );
1492 return true;
1496 * Try to fetch an expired entry from the parser cache. If it is present,
1497 * output it and return true. If it is not present, output nothing and
1498 * return false. This is used as a callback function for
1499 * PoolCounter::executeProtected().
1501 * @return boolean
1503 public function tryDirtyCache() {
1504 global $wgOut;
1505 $parserCache = ParserCache::singleton();
1506 $options = $this->getParserOptions();
1508 if ( $wgOut->isPrintable() ) {
1509 $options->setIsPrintable( true );
1510 $options->setEditSection( false );
1513 $output = $parserCache->getDirty( $this, $options );
1515 if ( $output ) {
1516 wfDebug( __METHOD__ . ": sending dirty output\n" );
1517 wfDebugLog( 'dirty', "dirty output " . $parserCache->getKey( $this, $options ) . "\n" );
1518 $wgOut->setSquidMaxage( 0 );
1519 $this->mParserOutput = $output;
1520 $wgOut->addParserOutput( $output );
1521 $wgOut->addHTML( "<!-- parser cache is expired, sending anyway due to pool overload-->\n" );
1523 return true;
1524 } else {
1525 wfDebugLog( 'dirty', "dirty missing\n" );
1526 wfDebug( __METHOD__ . ": no dirty cache\n" );
1528 return false;
1533 * View redirect
1535 * @param $target Title|Array of destination(s) to redirect
1536 * @param $appendSubtitle Boolean [optional]
1537 * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence?
1538 * @return string containing HMTL with redirect link
1540 public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) {
1541 global $wgOut, $wgContLang, $wgStylePath, $wgUser;
1543 if ( !is_array( $target ) ) {
1544 $target = array( $target );
1547 $imageDir = $wgContLang->getDir();
1549 if ( $appendSubtitle ) {
1550 $wgOut->appendSubtitle( wfMsgHtml( 'redirectpagesub' ) );
1553 $sk = $wgUser->getSkin();
1554 // the loop prepends the arrow image before the link, so the first case needs to be outside
1555 $title = array_shift( $target );
1557 if ( $forceKnown ) {
1558 $link = $sk->linkKnown( $title, htmlspecialchars( $title->getFullText() ) );
1559 } else {
1560 $link = $sk->link( $title, htmlspecialchars( $title->getFullText() ) );
1563 $nextRedirect = $wgStylePath . '/common/images/nextredirect' . $imageDir . '.png';
1564 $alt = $wgContLang->isRTL() ? '←' : '→';
1565 // Automatically append redirect=no to each link, since most of them are redirect pages themselves.
1566 // FIXME: where this happens?
1567 foreach ( $target as $rt ) {
1568 $link .= Html::element( 'img', array( 'src' => $nextRedirect, 'alt' => $alt ) );
1569 if ( $forceKnown ) {
1570 $link .= $sk->linkKnown( $rt, htmlspecialchars( $rt->getFullText() ) );
1571 } else {
1572 $link .= $sk->link( $rt, htmlspecialchars( $rt->getFullText() ) );
1576 $imageUrl = $wgStylePath . '/common/images/redirect' . $imageDir . '.png';
1577 return '<div class="redirectMsg">' .
1578 Html::element( 'img', array( 'src' => $imageUrl, 'alt' => '#REDIRECT' ) ) .
1579 '<span class="redirectText">' . $link . '</span></div>';
1583 * Builds trackback links for article display if $wgUseTrackbacks is set to true
1585 public function addTrackbacks() {
1586 global $wgOut, $wgUser;
1588 $dbr = wfGetDB( DB_SLAVE );
1589 $tbs = $dbr->select( 'trackbacks',
1590 array( 'tb_id', 'tb_title', 'tb_url', 'tb_ex', 'tb_name' ),
1591 array( 'tb_page' => $this->getID() )
1594 if ( !$dbr->numRows( $tbs ) ) {
1595 return;
1598 $wgOut->preventClickjacking();
1600 $tbtext = "";
1601 foreach ( $tbs as $o ) {
1602 $rmvtxt = "";
1604 if ( $wgUser->isAllowed( 'trackback' ) ) {
1605 $delurl = $this->mTitle->getFullURL( "action=deletetrackback&tbid=" .
1606 $o->tb_id . "&token=" . urlencode( $wgUser->editToken() ) );
1607 $rmvtxt = wfMsg( 'trackbackremove', htmlspecialchars( $delurl ) );
1610 $tbtext .= "\n";
1611 $tbtext .= wfMsgNoTrans( strlen( $o->tb_ex ) ? 'trackbackexcerpt' : 'trackback',
1612 $o->tb_title,
1613 $o->tb_url,
1614 $o->tb_ex,
1615 $o->tb_name,
1616 $rmvtxt );
1619 $wgOut->wrapWikiMsg( "<div id='mw_trackbacks'>\n$1\n</div>\n", array( 'trackbackbox', $tbtext ) );
1623 * Removes trackback record for current article from trackbacks table
1625 public function deletetrackback() {
1626 global $wgUser, $wgRequest, $wgOut;
1628 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ) ) ) {
1629 $wgOut->addWikiMsg( 'sessionfailure' );
1631 return;
1634 $permission_errors = $this->mTitle->getUserPermissionsErrors( 'delete', $wgUser );
1636 if ( count( $permission_errors ) ) {
1637 $wgOut->showPermissionsErrorPage( $permission_errors );
1639 return;
1642 $db = wfGetDB( DB_MASTER );
1643 $db->delete( 'trackbacks', array( 'tb_id' => $wgRequest->getInt( 'tbid' ) ) );
1645 $wgOut->addWikiMsg( 'trackbackdeleteok' );
1646 $this->mTitle->invalidateCache();
1650 * Handle action=render
1653 public function render() {
1654 global $wgOut;
1656 $wgOut->setArticleBodyOnly( true );
1657 $this->view();
1661 * Handle action=purge
1663 public function purge() {
1664 global $wgUser, $wgRequest, $wgOut;
1666 if ( $wgUser->isAllowed( 'purge' ) || $wgRequest->wasPosted() ) {
1667 //FIXME: shouldn't this be in doPurge()?
1668 if ( wfRunHooks( 'ArticlePurge', array( &$this ) ) ) {
1669 $this->doPurge();
1670 $this->view();
1672 } else {
1673 $formParams = array(
1674 'method' => 'post',
1675 'action' => $wgRequest->getRequestURL(),
1678 $wgOut->addWikiMsg( 'confirm-purge-top' );
1680 $form = Html::openElement( 'form', $formParams );
1681 $form .= Xml::submitButton( wfMsg( 'confirm_purge_button' ) );
1682 $form .= Html::closeElement( 'form' );
1684 $wgOut->addHTML( $form );
1685 $wgOut->addWikiMsg( 'confirm-purge-bottom' );
1687 $wgOut->setPageTitle( $this->mTitle->getPrefixedText() );
1688 $wgOut->setRobotPolicy( 'noindex,nofollow' );
1693 * Perform the actions of a page purging
1695 public function doPurge() {
1696 global $wgUseSquid;
1698 // Invalidate the cache
1699 $this->mTitle->invalidateCache();
1700 $this->clear();
1702 if ( $wgUseSquid ) {
1703 // Commit the transaction before the purge is sent
1704 $dbw = wfGetDB( DB_MASTER );
1705 $dbw->commit();
1707 // Send purge
1708 $update = SquidUpdate::newSimplePurge( $this->mTitle );
1709 $update->doUpdate();
1712 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1713 if ( $this->getID() == 0 ) {
1714 $text = false;
1715 } else {
1716 $text = $this->getRawText();
1719 MessageCache::singleton()->replace( $this->mTitle->getDBkey(), $text );
1724 * Insert a new empty page record for this article.
1725 * This *must* be followed up by creating a revision
1726 * and running $this->updateRevisionOn( ... );
1727 * or else the record will be left in a funky state.
1728 * Best if all done inside a transaction.
1730 * @param $dbw Database
1731 * @return int The newly created page_id key, or false if the title already existed
1732 * @private
1734 public function insertOn( $dbw ) {
1735 wfProfileIn( __METHOD__ );
1737 $page_id = $dbw->nextSequenceValue( 'page_page_id_seq' );
1738 $dbw->insert( 'page', array(
1739 'page_id' => $page_id,
1740 'page_namespace' => $this->mTitle->getNamespace(),
1741 'page_title' => $this->mTitle->getDBkey(),
1742 'page_counter' => 0,
1743 'page_restrictions' => '',
1744 'page_is_redirect' => 0, # Will set this shortly...
1745 'page_is_new' => 1,
1746 'page_random' => wfRandom(),
1747 'page_touched' => $dbw->timestamp(),
1748 'page_latest' => 0, # Fill this in shortly...
1749 'page_len' => 0, # Fill this in shortly...
1750 ), __METHOD__, 'IGNORE' );
1752 $affected = $dbw->affectedRows();
1754 if ( $affected ) {
1755 $newid = $dbw->insertId();
1756 $this->mTitle->resetArticleId( $newid );
1758 wfProfileOut( __METHOD__ );
1760 return $affected ? $newid : false;
1764 * Update the page record to point to a newly saved revision.
1766 * @param $dbw DatabaseBase: object
1767 * @param $revision Revision: For ID number, and text used to set
1768 length and redirect status fields
1769 * @param $lastRevision Integer: if given, will not overwrite the page field
1770 * when different from the currently set value.
1771 * Giving 0 indicates the new page flag should be set
1772 * on.
1773 * @param $lastRevIsRedirect Boolean: if given, will optimize adding and
1774 * removing rows in redirect table.
1775 * @param $setNewFlag Boolean: Set to true if a page flag should be set
1776 * Needed when $lastRevision has to be set to sth. !=0
1777 * @return bool true on success, false on failure
1778 * @private
1780 public function updateRevisionOn( &$dbw, $revision, $lastRevision = null, $lastRevIsRedirect = null, $setNewFlag = false ) {
1781 wfProfileIn( __METHOD__ );
1783 $text = $revision->getText();
1784 $rt = Title::newFromRedirectRecurse( $text );
1786 $conditions = array( 'page_id' => $this->getId() );
1788 if ( !is_null( $lastRevision ) ) {
1789 # An extra check against threads stepping on each other
1790 $conditions['page_latest'] = $lastRevision;
1793 if ( !$setNewFlag ) {
1794 $setNewFlag = ( $lastRevision === 0 );
1797 $dbw->update( 'page',
1798 array( /* SET */
1799 'page_latest' => $revision->getId(),
1800 'page_touched' => $dbw->timestamp(),
1801 'page_is_new' => $setNewFlag,
1802 'page_is_redirect' => $rt !== null ? 1 : 0,
1803 'page_len' => strlen( $text ),
1805 $conditions,
1806 __METHOD__ );
1808 $result = $dbw->affectedRows() != 0;
1809 if ( $result ) {
1810 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1813 wfProfileOut( __METHOD__ );
1814 return $result;
1818 * Add row to the redirect table if this is a redirect, remove otherwise.
1820 * @param $dbw Database
1821 * @param $redirectTitle Title object pointing to the redirect target,
1822 * or NULL if this is not a redirect
1823 * @param $lastRevIsRedirect If given, will optimize adding and
1824 * removing rows in redirect table.
1825 * @return bool true on success, false on failure
1826 * @private
1828 public function updateRedirectOn( &$dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1829 // Always update redirects (target link might have changed)
1830 // Update/Insert if we don't know if the last revision was a redirect or not
1831 // Delete if changing from redirect to non-redirect
1832 $isRedirect = !is_null( $redirectTitle );
1834 if ( $isRedirect || is_null( $lastRevIsRedirect ) || $lastRevIsRedirect !== $isRedirect ) {
1835 wfProfileIn( __METHOD__ );
1836 if ( $isRedirect ) {
1837 $this->insertRedirectEntry( $redirectTitle );
1838 } else {
1839 // This is not a redirect, remove row from redirect table
1840 $where = array( 'rd_from' => $this->getId() );
1841 $dbw->delete( 'redirect', $where, __METHOD__ );
1844 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1845 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1847 wfProfileOut( __METHOD__ );
1849 return ( $dbw->affectedRows() != 0 );
1852 return true;
1856 * If the given revision is newer than the currently set page_latest,
1857 * update the page record. Otherwise, do nothing.
1859 * @param $dbw Database object
1860 * @param $revision Revision object
1861 * @return mixed
1863 public function updateIfNewerOn( &$dbw, $revision ) {
1864 wfProfileIn( __METHOD__ );
1866 $row = $dbw->selectRow(
1867 array( 'revision', 'page' ),
1868 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1869 array(
1870 'page_id' => $this->getId(),
1871 'page_latest=rev_id' ),
1872 __METHOD__ );
1874 if ( $row ) {
1875 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1876 wfProfileOut( __METHOD__ );
1877 return false;
1879 $prev = $row->rev_id;
1880 $lastRevIsRedirect = (bool)$row->page_is_redirect;
1881 } else {
1882 # No or missing previous revision; mark the page as new
1883 $prev = 0;
1884 $lastRevIsRedirect = null;
1887 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1889 wfProfileOut( __METHOD__ );
1890 return $ret;
1894 * @param $section empty/null/false or a section number (0, 1, 2, T1, T2...)
1895 * @param $text String: new text of the section
1896 * @param $summary String: new section's subject, only if $section is 'new'
1897 * @param $edittime String: revision timestamp or null to use the current revision
1898 * @return string Complete article text, or null if error
1900 public function replaceSection( $section, $text, $summary = '', $edittime = null ) {
1901 wfProfileIn( __METHOD__ );
1903 if ( strval( $section ) == '' ) {
1904 // Whole-page edit; let the whole text through
1905 } else {
1906 if ( is_null( $edittime ) ) {
1907 $rev = Revision::newFromTitle( $this->mTitle );
1908 } else {
1909 $dbw = wfGetDB( DB_MASTER );
1910 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1913 if ( !$rev ) {
1914 wfDebug( "Article::replaceSection asked for bogus section (page: " .
1915 $this->getId() . "; section: $section; edittime: $edittime)\n" );
1916 return null;
1919 $oldtext = $rev->getText();
1921 if ( $section == 'new' ) {
1922 # Inserting a new section
1923 $subject = $summary ? wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" : '';
1924 $text = strlen( trim( $oldtext ) ) > 0
1925 ? "{$oldtext}\n\n{$subject}{$text}"
1926 : "{$subject}{$text}";
1927 } else {
1928 # Replacing an existing section; roll out the big guns
1929 global $wgParser;
1931 $text = $wgParser->replaceSection( $oldtext, $section, $text );
1935 wfProfileOut( __METHOD__ );
1936 return $text;
1940 * @deprecated @since 1.7 use Article::doEdit()
1942 function insertNewArticle( $text, $summary, $isminor, $watchthis, $suppressRC = false, $comment = false, $bot = false ) {
1943 wfDeprecated( __METHOD__ );
1945 $flags = EDIT_NEW | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1946 ( $isminor ? EDIT_MINOR : 0 ) |
1947 ( $suppressRC ? EDIT_SUPPRESS_RC : 0 ) |
1948 ( $bot ? EDIT_FORCE_BOT : 0 );
1950 # If this is a comment, add the summary as headline
1951 if ( $comment && $summary != "" ) {
1952 $text = wfMsgForContent( 'newsectionheaderdefaultlevel', $summary ) . "\n\n" . $text;
1954 $this->doEdit( $text, $summary, $flags );
1956 $dbw = wfGetDB( DB_MASTER );
1957 if ( $watchthis ) {
1958 if ( !$this->mTitle->userIsWatching() ) {
1959 $dbw->begin();
1960 $this->doWatch();
1961 $dbw->commit();
1963 } else {
1964 if ( $this->mTitle->userIsWatching() ) {
1965 $dbw->begin();
1966 $this->doUnwatch();
1967 $dbw->commit();
1970 $this->doRedirect( $this->isRedirect( $text ) );
1974 * @deprecated @since 1.7 use Article::doEdit()
1976 function updateArticle( $text, $summary, $minor, $watchthis, $forceBot = false, $sectionanchor = '' ) {
1977 wfDeprecated( __METHOD__ );
1979 $flags = EDIT_UPDATE | EDIT_DEFER_UPDATES | EDIT_AUTOSUMMARY |
1980 ( $minor ? EDIT_MINOR : 0 ) |
1981 ( $forceBot ? EDIT_FORCE_BOT : 0 );
1983 $status = $this->doEdit( $text, $summary, $flags );
1985 if ( !$status->isOK() ) {
1986 return false;
1989 $dbw = wfGetDB( DB_MASTER );
1990 if ( $watchthis ) {
1991 if ( !$this->mTitle->userIsWatching() ) {
1992 $dbw->begin();
1993 $this->doWatch();
1994 $dbw->commit();
1996 } else {
1997 if ( $this->mTitle->userIsWatching() ) {
1998 $dbw->begin();
1999 $this->doUnwatch();
2000 $dbw->commit();
2004 $extraQuery = ''; // Give extensions a chance to modify URL query on update
2005 wfRunHooks( 'ArticleUpdateBeforeRedirect', array( $this, &$sectionanchor, &$extraQuery ) );
2007 $this->doRedirect( $this->isRedirect( $text ), $sectionanchor, $extraQuery );
2008 return true;
2012 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
2013 * @param $flags Int
2014 * @return Int updated $flags
2016 function checkFlags( $flags ) {
2017 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
2018 if ( $this->mTitle->getArticleID() ) {
2019 $flags |= EDIT_UPDATE;
2020 } else {
2021 $flags |= EDIT_NEW;
2025 return $flags;
2029 * Article::doEdit()
2031 * Change an existing article or create a new article. Updates RC and all necessary caches,
2032 * optionally via the deferred update array.
2034 * $wgUser must be set before calling this function.
2036 * @param $text String: new text
2037 * @param $summary String: edit summary
2038 * @param $flags Integer bitfield:
2039 * EDIT_NEW
2040 * Article is known or assumed to be non-existent, create a new one
2041 * EDIT_UPDATE
2042 * Article is known or assumed to be pre-existing, update it
2043 * EDIT_MINOR
2044 * Mark this edit minor, if the user is allowed to do so
2045 * EDIT_SUPPRESS_RC
2046 * Do not log the change in recentchanges
2047 * EDIT_FORCE_BOT
2048 * Mark the edit a "bot" edit regardless of user rights
2049 * EDIT_DEFER_UPDATES
2050 * Defer some of the updates until the end of index.php
2051 * EDIT_AUTOSUMMARY
2052 * Fill in blank summaries with generated text where possible
2054 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected.
2055 * If EDIT_UPDATE is specified and the article doesn't exist, the function will an
2056 * edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an
2057 * edit-already-exists error will be returned. These two conditions are also possible with
2058 * auto-detection due to MediaWiki's performance-optimised locking strategy.
2060 * @param $baseRevId the revision ID this edit was based off, if any
2061 * @param $user User (optional), $wgUser will be used if not passed
2063 * @return Status object. Possible errors:
2064 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status
2065 * edit-gone-missing: In update mode, but the article didn't exist
2066 * edit-conflict: In update mode, the article changed unexpectedly
2067 * edit-no-change: Warning that the text was the same as before
2068 * edit-already-exists: In creation mode, but the article already exists
2070 * Extensions may define additional errors.
2072 * $return->value will contain an associative array with members as follows:
2073 * new: Boolean indicating if the function attempted to create a new article
2074 * revision: The revision object for the inserted revision, or null
2076 * Compatibility note: this function previously returned a boolean value indicating success/failure
2078 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
2079 global $wgUser, $wgDBtransactions, $wgUseAutomaticEditSummaries;
2081 # Low-level sanity check
2082 if ( $this->mTitle->getText() === '' ) {
2083 throw new MWException( 'Something is trying to edit an article with an empty title' );
2086 wfProfileIn( __METHOD__ );
2088 $user = is_null( $user ) ? $wgUser : $user;
2089 $status = Status::newGood( array() );
2091 # Load $this->mTitle->getArticleID() and $this->mLatest if it's not already
2092 $this->loadPageData();
2094 $flags = $this->checkFlags( $flags );
2096 if ( !wfRunHooks( 'ArticleSave', array( &$this, &$user, &$text, &$summary,
2097 $flags & EDIT_MINOR, null, null, &$flags, &$status ) ) )
2099 wfDebug( __METHOD__ . ": ArticleSave hook aborted save!\n" );
2100 wfProfileOut( __METHOD__ );
2102 if ( $status->isOK() ) {
2103 $status->fatal( 'edit-hook-aborted' );
2106 return $status;
2109 # Silently ignore EDIT_MINOR if not allowed
2110 $isminor = ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' );
2111 $bot = $flags & EDIT_FORCE_BOT;
2113 $oldtext = $this->getRawText(); // current revision
2114 $oldsize = strlen( $oldtext );
2116 # Provide autosummaries if one is not provided and autosummaries are enabled.
2117 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY && $summary == '' ) {
2118 $summary = $this->getAutosummary( $oldtext, $text, $flags );
2121 $editInfo = $this->prepareTextForEdit( $text, null, $user );
2122 $text = $editInfo->pst;
2123 $newsize = strlen( $text );
2125 $dbw = wfGetDB( DB_MASTER );
2126 $now = wfTimestampNow();
2127 $this->mTimestamp = $now;
2129 if ( $flags & EDIT_UPDATE ) {
2130 # Update article, but only if changed.
2131 $status->value['new'] = false;
2133 # Make sure the revision is either completely inserted or not inserted at all
2134 if ( !$wgDBtransactions ) {
2135 $userAbort = ignore_user_abort( true );
2138 $changed = ( strcmp( $text, $oldtext ) != 0 );
2140 if ( $changed ) {
2141 $this->mGoodAdjustment = (int)$this->isCountable( $text )
2142 - (int)$this->isCountable( $oldtext );
2143 $this->mTotalAdjustment = 0;
2145 if ( !$this->mLatest ) {
2146 # Article gone missing
2147 wfDebug( __METHOD__ . ": EDIT_UPDATE specified but article doesn't exist\n" );
2148 $status->fatal( 'edit-gone-missing' );
2150 wfProfileOut( __METHOD__ );
2151 return $status;
2154 $revision = new Revision( array(
2155 'page' => $this->getId(),
2156 'comment' => $summary,
2157 'minor_edit' => $isminor,
2158 'text' => $text,
2159 'parent_id' => $this->mLatest,
2160 'user' => $user->getId(),
2161 'user_text' => $user->getName(),
2162 'timestamp' => $now
2163 ) );
2165 $dbw->begin();
2166 $revisionId = $revision->insertOn( $dbw );
2168 # Update page
2170 # Note that we use $this->mLatest instead of fetching a value from the master DB
2171 # during the course of this function. This makes sure that EditPage can detect
2172 # edit conflicts reliably, either by $ok here, or by $article->getTimestamp()
2173 # before this function is called. A previous function used a separate query, this
2174 # creates a window where concurrent edits can cause an ignored edit conflict.
2175 $ok = $this->updateRevisionOn( $dbw, $revision, $this->mLatest );
2177 if ( !$ok ) {
2178 /* Belated edit conflict! Run away!! */
2179 $status->fatal( 'edit-conflict' );
2181 # Delete the invalid revision if the DB is not transactional
2182 if ( !$wgDBtransactions ) {
2183 $dbw->delete( 'revision', array( 'rev_id' => $revisionId ), __METHOD__ );
2186 $revisionId = 0;
2187 $dbw->rollback();
2188 } else {
2189 global $wgUseRCPatrol;
2190 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, $baseRevId, $user ) );
2191 # Update recentchanges
2192 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
2193 # Mark as patrolled if the user can do so
2194 $patrolled = $wgUseRCPatrol && !count(
2195 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
2196 # Add RC row to the DB
2197 $rc = RecentChange::notifyEdit( $now, $this->mTitle, $isminor, $user, $summary,
2198 $this->mLatest, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
2199 $revisionId, $patrolled
2202 # Log auto-patrolled edits
2203 if ( $patrolled ) {
2204 PatrolLog::record( $rc, true );
2207 $user->incEditCount();
2208 $dbw->commit();
2210 } else {
2211 $status->warning( 'edit-no-change' );
2212 $revision = null;
2213 // Keep the same revision ID, but do some updates on it
2214 $revisionId = $this->getLatest();
2215 // Update page_touched, this is usually implicit in the page update
2216 // Other cache updates are done in onArticleEdit()
2217 $this->mTitle->invalidateCache();
2220 if ( !$wgDBtransactions ) {
2221 ignore_user_abort( $userAbort );
2224 // Now that ignore_user_abort is restored, we can respond to fatal errors
2225 if ( !$status->isOK() ) {
2226 wfProfileOut( __METHOD__ );
2227 return $status;
2230 # Invalidate cache of this article and all pages using this article
2231 # as a template. Partly deferred.
2232 Article::onArticleEdit( $this->mTitle );
2233 # Update links tables, site stats, etc.
2234 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, $changed, $user );
2235 } else {
2236 # Create new article
2237 $status->value['new'] = true;
2239 # Set statistics members
2240 # We work out if it's countable after PST to avoid counter drift
2241 # when articles are created with {{subst:}}
2242 $this->mGoodAdjustment = (int)$this->isCountable( $text );
2243 $this->mTotalAdjustment = 1;
2245 $dbw->begin();
2247 # Add the page record; stake our claim on this title!
2248 # This will return false if the article already exists
2249 $newid = $this->insertOn( $dbw );
2251 if ( $newid === false ) {
2252 $dbw->rollback();
2253 $status->fatal( 'edit-already-exists' );
2255 wfProfileOut( __METHOD__ );
2256 return $status;
2259 # Save the revision text...
2260 $revision = new Revision( array(
2261 'page' => $newid,
2262 'comment' => $summary,
2263 'minor_edit' => $isminor,
2264 'text' => $text,
2265 'user' => $user->getId(),
2266 'user_text' => $user->getName(),
2267 'timestamp' => $now
2268 ) );
2269 $revisionId = $revision->insertOn( $dbw );
2271 $this->mTitle->resetArticleID( $newid );
2273 # Update the page record with revision data
2274 $this->updateRevisionOn( $dbw, $revision, 0 );
2276 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2278 # Update recentchanges
2279 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
2280 global $wgUseRCPatrol, $wgUseNPPatrol;
2282 # Mark as patrolled if the user can do so
2283 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) && !count(
2284 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
2285 # Add RC row to the DB
2286 $rc = RecentChange::notifyNew( $now, $this->mTitle, $isminor, $user, $summary, $bot,
2287 '', strlen( $text ), $revisionId, $patrolled );
2289 # Log auto-patrolled edits
2290 if ( $patrolled ) {
2291 PatrolLog::record( $rc, true );
2294 $user->incEditCount();
2295 $dbw->commit();
2297 # Update links, etc.
2298 $this->editUpdates( $text, $summary, $isminor, $now, $revisionId, true, $user );
2300 # Clear caches
2301 Article::onArticleCreate( $this->mTitle );
2303 wfRunHooks( 'ArticleInsertComplete', array( &$this, &$user, $text, $summary,
2304 $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
2307 # Do updates right now unless deferral was requested
2308 if ( !( $flags & EDIT_DEFER_UPDATES ) ) {
2309 wfDoUpdates();
2312 // Return the new revision (or null) to the caller
2313 $status->value['revision'] = $revision;
2315 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$user, $text, $summary,
2316 $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $baseRevId ) );
2318 wfProfileOut( __METHOD__ );
2319 return $status;
2323 * Output a redirect back to the article.
2324 * This is typically used after an edit.
2326 * @param $noRedir Boolean: add redirect=no
2327 * @param $sectionAnchor String: section to redirect to, including "#"
2328 * @param $extraQuery String: extra query params
2330 public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) {
2331 global $wgOut;
2333 if ( $noRedir ) {
2334 $query = 'redirect=no';
2335 if ( $extraQuery )
2336 $query .= "&$extraQuery";
2337 } else {
2338 $query = $extraQuery;
2341 $wgOut->redirect( $this->mTitle->getFullURL( $query ) . $sectionAnchor );
2345 * Mark this particular edit/page as patrolled
2347 public function markpatrolled() {
2348 global $wgOut, $wgUser, $wgRequest;
2350 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2352 # If we haven't been given an rc_id value, we can't do anything
2353 $rcid = (int) $wgRequest->getVal( 'rcid' );
2355 if ( !$wgUser->matchEditToken( $wgRequest->getVal( 'token' ), $rcid ) ) {
2356 $wgOut->showErrorPage( 'sessionfailure-title', 'sessionfailure' );
2357 return;
2360 $rc = RecentChange::newFromId( $rcid );
2362 if ( is_null( $rc ) ) {
2363 $wgOut->showErrorPage( 'markedaspatrollederror', 'markedaspatrollederrortext' );
2364 return;
2367 # It would be nice to see where the user had actually come from, but for now just guess
2368 $returnto = $rc->getAttribute( 'rc_type' ) == RC_NEW ? 'Newpages' : 'Recentchanges';
2369 $return = SpecialPage::getTitleFor( $returnto );
2371 $errors = $rc->doMarkPatrolled();
2373 if ( in_array( array( 'rcpatroldisabled' ), $errors ) ) {
2374 $wgOut->showErrorPage( 'rcpatroldisabled', 'rcpatroldisabledtext' );
2376 return;
2379 if ( in_array( array( 'hookaborted' ), $errors ) ) {
2380 // The hook itself has handled any output
2381 return;
2384 if ( in_array( array( 'markedaspatrollederror-noautopatrol' ), $errors ) ) {
2385 $wgOut->setPageTitle( wfMsg( 'markedaspatrollederror' ) );
2386 $wgOut->addWikiMsg( 'markedaspatrollederror-noautopatrol' );
2387 $wgOut->returnToMain( false, $return );
2389 return;
2392 if ( !empty( $errors ) ) {
2393 $wgOut->showPermissionsErrorPage( $errors );
2395 return;
2398 # Inform the user
2399 $wgOut->setPageTitle( wfMsg( 'markedaspatrolled' ) );
2400 $wgOut->addWikiMsg( 'markedaspatrolledtext', $rc->getTitle()->getPrefixedText() );
2401 $wgOut->returnToMain( false, $return );
2405 * User-interface handler for the "watch" action
2407 public function watch() {
2408 global $wgUser, $wgOut;
2410 if ( $wgUser->isAnon() ) {
2411 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2412 return;
2415 if ( wfReadOnly() ) {
2416 $wgOut->readOnlyPage();
2417 return;
2420 if ( $this->doWatch() ) {
2421 $wgOut->setPagetitle( wfMsg( 'addedwatch' ) );
2422 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2423 $wgOut->addWikiMsg( 'addedwatchtext', $this->mTitle->getPrefixedText() );
2426 $wgOut->returnToMain( true, $this->mTitle->getPrefixedText() );
2430 * Add this page to $wgUser's watchlist
2431 * @return bool true on successful watch operation
2433 public function doWatch() {
2434 global $wgUser;
2436 if ( $wgUser->isAnon() ) {
2437 return false;
2440 if ( wfRunHooks( 'WatchArticle', array( &$wgUser, &$this ) ) ) {
2441 $wgUser->addWatch( $this->mTitle );
2442 return wfRunHooks( 'WatchArticleComplete', array( &$wgUser, &$this ) );
2445 return false;
2449 * User interface handler for the "unwatch" action.
2451 public function unwatch() {
2452 global $wgUser, $wgOut;
2454 if ( $wgUser->isAnon() ) {
2455 $wgOut->showErrorPage( 'watchnologin', 'watchnologintext' );
2456 return;
2459 if ( wfReadOnly() ) {
2460 $wgOut->readOnlyPage();
2461 return;
2464 if ( $this->doUnwatch() ) {
2465 $wgOut->setPagetitle( wfMsg( 'removedwatch' ) );
2466 $wgOut->setRobotPolicy( 'noindex,nofollow' );
2467 $wgOut->addWikiMsg( 'removedwatchtext', $this->mTitle->getPrefixedText() );
2470 $wgOut->returnToMain( true, $this->mTitle->getPrefixedText() );
2474 * Stop watching a page
2475 * @return bool true on successful unwatch
2477 public function doUnwatch() {
2478 global $wgUser;
2480 if ( $wgUser->isAnon() ) {
2481 return false;
2484 if ( wfRunHooks( 'UnwatchArticle', array( &$wgUser, &$this ) ) ) {
2485 $wgUser->removeWatch( $this->mTitle );
2486 return wfRunHooks( 'UnwatchArticleComplete', array( &$wgUser, &$this ) );
2489 return false;
2493 * action=protect handler
2495 public function protect() {
2496 $form = new ProtectionForm( $this );
2497 $form->execute();
2501 * action=unprotect handler (alias)
2503 public function unprotect() {
2504 $this->protect();
2508 * Update the article's restriction field, and leave a log entry.
2510 * @param $limit Array: set of restriction keys
2511 * @param $reason String
2512 * @param &$cascade Integer. Set to false if cascading protection isn't allowed.
2513 * @param $expiry Array: per restriction type expiration
2514 * @return bool true on success
2516 public function updateRestrictions( $limit = array(), $reason = '', &$cascade = 0, $expiry = array() ) {
2517 global $wgUser, $wgContLang;
2519 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2521 $id = $this->mTitle->getArticleID();
2523 if ( $id <= 0 ) {
2524 wfDebug( "updateRestrictions failed: article id $id <= 0\n" );
2525 return false;
2528 if ( wfReadOnly() ) {
2529 wfDebug( "updateRestrictions failed: read-only\n" );
2530 return false;
2533 if ( !$this->mTitle->userCan( 'protect' ) ) {
2534 wfDebug( "updateRestrictions failed: insufficient permissions\n" );
2535 return false;
2538 if ( !$cascade ) {
2539 $cascade = false;
2542 // Take this opportunity to purge out expired restrictions
2543 Title::purgeExpiredRestrictions();
2545 # FIXME: Same limitations as described in ProtectionForm.php (line 37);
2546 # we expect a single selection, but the schema allows otherwise.
2547 $current = array();
2548 $updated = Article::flattenRestrictions( $limit );
2549 $changed = false;
2551 foreach ( $restrictionTypes as $action ) {
2552 if ( isset( $expiry[$action] ) ) {
2553 # Get current restrictions on $action
2554 $aLimits = $this->mTitle->getRestrictions( $action );
2555 $current[$action] = implode( '', $aLimits );
2556 # Are any actual restrictions being dealt with here?
2557 $aRChanged = count( $aLimits ) || !empty( $limit[$action] );
2559 # If something changed, we need to log it. Checking $aRChanged
2560 # assures that "unprotecting" a page that is not protected does
2561 # not log just because the expiry was "changed".
2562 if ( $aRChanged && $this->mTitle->mRestrictionsExpiry[$action] != $expiry[$action] ) {
2563 $changed = true;
2568 $current = Article::flattenRestrictions( $current );
2570 $changed = ( $changed || $current != $updated );
2571 $changed = $changed || ( $updated && $this->mTitle->areRestrictionsCascading() != $cascade );
2572 $protect = ( $updated != '' );
2574 # If nothing's changed, do nothing
2575 if ( $changed ) {
2576 if ( wfRunHooks( 'ArticleProtect', array( &$this, &$wgUser, $limit, $reason ) ) ) {
2577 $dbw = wfGetDB( DB_MASTER );
2579 # Prepare a null revision to be added to the history
2580 $modified = $current != '' && $protect;
2582 if ( $protect ) {
2583 $comment_type = $modified ? 'modifiedarticleprotection' : 'protectedarticle';
2584 } else {
2585 $comment_type = 'unprotectedarticle';
2588 $comment = $wgContLang->ucfirst( wfMsgForContent( $comment_type, $this->mTitle->getPrefixedText() ) );
2590 # Only restrictions with the 'protect' right can cascade...
2591 # Otherwise, people who cannot normally protect can "protect" pages via transclusion
2592 $editrestriction = isset( $limit['edit'] ) ? array( $limit['edit'] ) : $this->mTitle->getRestrictions( 'edit' );
2594 # The schema allows multiple restrictions
2595 if ( !in_array( 'protect', $editrestriction ) && !in_array( 'sysop', $editrestriction ) ) {
2596 $cascade = false;
2599 $cascade_description = '';
2601 if ( $cascade ) {
2602 $cascade_description = ' [' . wfMsgForContent( 'protect-summary-cascade' ) . ']';
2605 if ( $reason ) {
2606 $comment .= ": $reason";
2609 $editComment = $comment;
2610 $encodedExpiry = array();
2611 $protect_description = '';
2612 foreach ( $limit as $action => $restrictions ) {
2613 if ( !isset( $expiry[$action] ) )
2614 $expiry[$action] = Block::infinity();
2616 $encodedExpiry[$action] = Block::encodeExpiry( $expiry[$action], $dbw );
2617 if ( $restrictions != '' ) {
2618 $protect_description .= "[$action=$restrictions] (";
2619 if ( $encodedExpiry[$action] != 'infinity' ) {
2620 $protect_description .= wfMsgForContent( 'protect-expiring',
2621 $wgContLang->timeanddate( $expiry[$action], false, false ) ,
2622 $wgContLang->date( $expiry[$action], false, false ) ,
2623 $wgContLang->time( $expiry[$action], false, false ) );
2624 } else {
2625 $protect_description .= wfMsgForContent( 'protect-expiry-indefinite' );
2628 $protect_description .= ') ';
2631 $protect_description = trim( $protect_description );
2633 if ( $protect_description && $protect ) {
2634 $editComment .= " ($protect_description)";
2637 if ( $cascade ) {
2638 $editComment .= "$cascade_description";
2641 # Update restrictions table
2642 foreach ( $limit as $action => $restrictions ) {
2643 if ( $restrictions != '' ) {
2644 $dbw->replace( 'page_restrictions', array( array( 'pr_page', 'pr_type' ) ),
2645 array( 'pr_page' => $id,
2646 'pr_type' => $action,
2647 'pr_level' => $restrictions,
2648 'pr_cascade' => ( $cascade && $action == 'edit' ) ? 1 : 0,
2649 'pr_expiry' => $encodedExpiry[$action]
2651 __METHOD__
2653 } else {
2654 $dbw->delete( 'page_restrictions', array( 'pr_page' => $id,
2655 'pr_type' => $action ), __METHOD__ );
2659 # Insert a null revision
2660 $nullRevision = Revision::newNullRevision( $dbw, $id, $editComment, true );
2661 $nullRevId = $nullRevision->insertOn( $dbw );
2663 $latest = $this->getLatest();
2664 # Update page record
2665 $dbw->update( 'page',
2666 array( /* SET */
2667 'page_touched' => $dbw->timestamp(),
2668 'page_restrictions' => '',
2669 'page_latest' => $nullRevId
2670 ), array( /* WHERE */
2671 'page_id' => $id
2672 ), 'Article::protect'
2675 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $nullRevision, $latest, $wgUser ) );
2676 wfRunHooks( 'ArticleProtectComplete', array( &$this, &$wgUser, $limit, $reason ) );
2678 # Update the protection log
2679 $log = new LogPage( 'protect' );
2680 if ( $protect ) {
2681 $params = array( $protect_description, $cascade ? 'cascade' : '' );
2682 $log->addEntry( $modified ? 'modify' : 'protect', $this->mTitle, trim( $reason ), $params );
2683 } else {
2684 $log->addEntry( 'unprotect', $this->mTitle, $reason );
2686 } # End hook
2687 } # End "changed" check
2689 return true;
2693 * Take an array of page restrictions and flatten it to a string
2694 * suitable for insertion into the page_restrictions field.
2695 * @param $limit Array
2696 * @return String
2698 protected static function flattenRestrictions( $limit ) {
2699 if ( !is_array( $limit ) ) {
2700 throw new MWException( 'Article::flattenRestrictions given non-array restriction set' );
2703 $bits = array();
2704 ksort( $limit );
2706 foreach ( $limit as $action => $restrictions ) {
2707 if ( $restrictions != '' ) {
2708 $bits[] = "$action=$restrictions";
2712 return implode( ':', $bits );
2716 * Auto-generates a deletion reason
2718 * @param &$hasHistory Boolean: whether the page has a history
2719 * @return mixed String containing deletion reason or empty string, or boolean false
2720 * if no revision occurred
2722 public function generateReason( &$hasHistory ) {
2723 global $wgContLang;
2725 $dbw = wfGetDB( DB_MASTER );
2726 // Get the last revision
2727 $rev = Revision::newFromTitle( $this->mTitle );
2729 if ( is_null( $rev ) ) {
2730 return false;
2733 // Get the article's contents
2734 $contents = $rev->getText();
2735 $blank = false;
2737 // If the page is blank, use the text from the previous revision,
2738 // which can only be blank if there's a move/import/protect dummy revision involved
2739 if ( $contents == '' ) {
2740 $prev = $rev->getPrevious();
2742 if ( $prev ) {
2743 $contents = $prev->getText();
2744 $blank = true;
2748 // Find out if there was only one contributor
2749 // Only scan the last 20 revisions
2750 $res = $dbw->select( 'revision', 'rev_user_text',
2751 array( 'rev_page' => $this->getID(), $dbw->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0' ),
2752 __METHOD__,
2753 array( 'LIMIT' => 20 )
2756 if ( $res === false ) {
2757 // This page has no revisions, which is very weird
2758 return false;
2761 $hasHistory = ( $res->numRows() > 1 );
2762 $row = $dbw->fetchObject( $res );
2764 if ( $row ) { // $row is false if the only contributor is hidden
2765 $onlyAuthor = $row->rev_user_text;
2766 // Try to find a second contributor
2767 foreach ( $res as $row ) {
2768 if ( $row->rev_user_text != $onlyAuthor ) { // Bug 22999
2769 $onlyAuthor = false;
2770 break;
2773 } else {
2774 $onlyAuthor = false;
2777 // Generate the summary with a '$1' placeholder
2778 if ( $blank ) {
2779 // The current revision is blank and the one before is also
2780 // blank. It's just not our lucky day
2781 $reason = wfMsgForContent( 'exbeforeblank', '$1' );
2782 } else {
2783 if ( $onlyAuthor ) {
2784 $reason = wfMsgForContent( 'excontentauthor', '$1', $onlyAuthor );
2785 } else {
2786 $reason = wfMsgForContent( 'excontent', '$1' );
2790 if ( $reason == '-' ) {
2791 // Allow these UI messages to be blanked out cleanly
2792 return '';
2795 // Replace newlines with spaces to prevent uglyness
2796 $contents = preg_replace( "/[\n\r]/", ' ', $contents );
2797 // Calculate the maximum amount of chars to get
2798 // Max content length = max comment length - length of the comment (excl. $1) - '...'
2799 $maxLength = 255 - ( strlen( $reason ) - 2 ) - 3;
2800 $contents = $wgContLang->truncate( $contents, $maxLength );
2801 // Remove possible unfinished links
2802 $contents = preg_replace( '/\[\[([^\]]*)\]?$/', '$1', $contents );
2803 // Now replace the '$1' placeholder
2804 $reason = str_replace( '$1', $contents, $reason );
2806 return $reason;
2811 * UI entry point for page deletion
2813 public function delete() {
2814 global $wgUser, $wgOut, $wgRequest;
2816 $confirm = $wgRequest->wasPosted() &&
2817 $wgUser->matchEditToken( $wgRequest->getVal( 'wpEditToken' ) );
2819 $this->DeleteReasonList = $wgRequest->getText( 'wpDeleteReasonList', 'other' );
2820 $this->DeleteReason = $wgRequest->getText( 'wpReason' );
2822 $reason = $this->DeleteReasonList;
2824 if ( $reason != 'other' && $this->DeleteReason != '' ) {
2825 // Entry from drop down menu + additional comment
2826 $reason .= wfMsgForContent( 'colon-separator' ) . $this->DeleteReason;
2827 } elseif ( $reason == 'other' ) {
2828 $reason = $this->DeleteReason;
2831 # Flag to hide all contents of the archived revisions
2832 $suppress = $wgRequest->getVal( 'wpSuppress' ) && $wgUser->isAllowed( 'suppressrevision' );
2834 # This code desperately needs to be totally rewritten
2836 # Read-only check...
2837 if ( wfReadOnly() ) {
2838 $wgOut->readOnlyPage();
2840 return;
2843 # Check permissions
2844 $permission_errors = $this->mTitle->getUserPermissionsErrors( 'delete', $wgUser );
2846 if ( count( $permission_errors ) > 0 ) {
2847 $wgOut->showPermissionsErrorPage( $permission_errors );
2849 return;
2852 $wgOut->setPagetitle( wfMsg( 'delete-confirm', $this->mTitle->getPrefixedText() ) );
2854 # Better double-check that it hasn't been deleted yet!
2855 $dbw = wfGetDB( DB_MASTER );
2856 $conds = $this->mTitle->pageCond();
2857 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__ );
2858 if ( $latest === false ) {
2859 $wgOut->showFatalError(
2860 Html::rawElement(
2861 'div',
2862 array( 'class' => 'error mw-error-cannotdelete' ),
2863 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle->getPrefixedText() )
2866 $wgOut->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
2867 LogEventsList::showLogExtract(
2868 $wgOut,
2869 'delete',
2870 $this->mTitle->getPrefixedText()
2873 return;
2876 # Hack for big sites
2877 $bigHistory = $this->isBigDeletion();
2878 if ( $bigHistory && !$this->mTitle->userCan( 'bigdelete' ) ) {
2879 global $wgLang, $wgDeleteRevisionsLimit;
2881 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2882 array( 'delete-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2884 return;
2887 if ( $confirm ) {
2888 $this->doDelete( $reason, $suppress );
2890 if ( $wgRequest->getCheck( 'wpWatch' ) && $wgUser->isLoggedIn() ) {
2891 $this->doWatch();
2892 } elseif ( $this->mTitle->userIsWatching() ) {
2893 $this->doUnwatch();
2896 return;
2899 // Generate deletion reason
2900 $hasHistory = false;
2901 if ( !$reason ) {
2902 $reason = $this->generateReason( $hasHistory );
2905 // If the page has a history, insert a warning
2906 if ( $hasHistory && !$confirm ) {
2907 global $wgLang;
2909 $skin = $wgUser->getSkin();
2910 $revisions = $this->estimateRevisionCount();
2911 //FIXME: lego
2912 $wgOut->addHTML( '<strong class="mw-delete-warning-revisions">' .
2913 wfMsgExt( 'historywarning', array( 'parseinline' ), $wgLang->formatNum( $revisions ) ) .
2914 wfMsgHtml( 'word-separator' ) . $skin->historyLink() .
2915 '</strong>'
2918 if ( $bigHistory ) {
2919 global $wgDeleteRevisionsLimit;
2920 $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>\n",
2921 array( 'delete-warning-toobig', $wgLang->formatNum( $wgDeleteRevisionsLimit ) ) );
2925 return $this->confirmDelete( $reason );
2929 * @return bool whether or not the page surpasses $wgDeleteRevisionsLimit revisions
2931 public function isBigDeletion() {
2932 global $wgDeleteRevisionsLimit;
2934 if ( $wgDeleteRevisionsLimit ) {
2935 $revCount = $this->estimateRevisionCount();
2937 return $revCount > $wgDeleteRevisionsLimit;
2940 return false;
2944 * @return int approximate revision count
2946 public function estimateRevisionCount() {
2947 $dbr = wfGetDB( DB_SLAVE );
2949 // For an exact count...
2950 // return $dbr->selectField( 'revision', 'COUNT(*)',
2951 // array( 'rev_page' => $this->getId() ), __METHOD__ );
2952 return $dbr->estimateRowCount( 'revision', '*',
2953 array( 'rev_page' => $this->getId() ), __METHOD__ );
2957 * Get the last N authors
2958 * @param $num Integer: number of revisions to get
2959 * @param $revLatest String: the latest rev_id, selected from the master (optional)
2960 * @return array Array of authors, duplicates not removed
2962 public function getLastNAuthors( $num, $revLatest = 0 ) {
2963 wfProfileIn( __METHOD__ );
2964 // First try the slave
2965 // If that doesn't have the latest revision, try the master
2966 $continue = 2;
2967 $db = wfGetDB( DB_SLAVE );
2969 do {
2970 $res = $db->select( array( 'page', 'revision' ),
2971 array( 'rev_id', 'rev_user_text' ),
2972 array(
2973 'page_namespace' => $this->mTitle->getNamespace(),
2974 'page_title' => $this->mTitle->getDBkey(),
2975 'rev_page = page_id'
2976 ), __METHOD__, $this->getSelectOptions( array(
2977 'ORDER BY' => 'rev_timestamp DESC',
2978 'LIMIT' => $num
2982 if ( !$res ) {
2983 wfProfileOut( __METHOD__ );
2984 return array();
2987 $row = $db->fetchObject( $res );
2989 if ( $continue == 2 && $revLatest && $row->rev_id != $revLatest ) {
2990 $db = wfGetDB( DB_MASTER );
2991 $continue--;
2992 } else {
2993 $continue = 0;
2995 } while ( $continue );
2997 $authors = array( $row->rev_user_text );
2999 foreach ( $res as $row ) {
3000 $authors[] = $row->rev_user_text;
3003 wfProfileOut( __METHOD__ );
3004 return $authors;
3008 * Output deletion confirmation dialog
3009 * FIXME: Move to another file?
3010 * @param $reason String: prefilled reason
3012 public function confirmDelete( $reason ) {
3013 global $wgOut, $wgUser;
3015 wfDebug( "Article::confirmDelete\n" );
3017 $deleteBackLink = $wgUser->getSkin()->linkKnown( $this->mTitle );
3018 $wgOut->setSubtitle( wfMsgHtml( 'delete-backlink', $deleteBackLink ) );
3019 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3020 $wgOut->addWikiMsg( 'confirmdeletetext' );
3022 wfRunHooks( 'ArticleConfirmDelete', array( $this, $wgOut, &$reason ) );
3024 if ( $wgUser->isAllowed( 'suppressrevision' ) ) {
3025 $suppress = "<tr id=\"wpDeleteSuppressRow\">
3026 <td></td>
3027 <td class='mw-input'><strong>" .
3028 Xml::checkLabel( wfMsg( 'revdelete-suppress' ),
3029 'wpSuppress', 'wpSuppress', false, array( 'tabindex' => '4' ) ) .
3030 "</strong></td>
3031 </tr>";
3032 } else {
3033 $suppress = '';
3035 $checkWatch = $wgUser->getBoolOption( 'watchdeletion' ) || $this->mTitle->userIsWatching();
3037 $form = Xml::openElement( 'form', array( 'method' => 'post',
3038 'action' => $this->mTitle->getLocalURL( 'action=delete' ), 'id' => 'deleteconfirm' ) ) .
3039 Xml::openElement( 'fieldset', array( 'id' => 'mw-delete-table' ) ) .
3040 Xml::tags( 'legend', null, wfMsgExt( 'delete-legend', array( 'parsemag', 'escapenoentities' ) ) ) .
3041 Xml::openElement( 'table', array( 'id' => 'mw-deleteconfirm-table' ) ) .
3042 "<tr id=\"wpDeleteReasonListRow\">
3043 <td class='mw-label'>" .
3044 Xml::label( wfMsg( 'deletecomment' ), 'wpDeleteReasonList' ) .
3045 "</td>
3046 <td class='mw-input'>" .
3047 Xml::listDropDown( 'wpDeleteReasonList',
3048 wfMsgForContent( 'deletereason-dropdown' ),
3049 wfMsgForContent( 'deletereasonotherlist' ), '', 'wpReasonDropDown', 1 ) .
3050 "</td>
3051 </tr>
3052 <tr id=\"wpDeleteReasonRow\">
3053 <td class='mw-label'>" .
3054 Xml::label( wfMsg( 'deleteotherreason' ), 'wpReason' ) .
3055 "</td>
3056 <td class='mw-input'>" .
3057 Html::input( 'wpReason', $reason, 'text', array(
3058 'size' => '60',
3059 'maxlength' => '255',
3060 'tabindex' => '2',
3061 'id' => 'wpReason',
3062 'autofocus'
3063 ) ) .
3064 "</td>
3065 </tr>";
3067 # Disallow watching if user is not logged in
3068 if ( $wgUser->isLoggedIn() ) {
3069 $form .= "
3070 <tr>
3071 <td></td>
3072 <td class='mw-input'>" .
3073 Xml::checkLabel( wfMsg( 'watchthis' ),
3074 'wpWatch', 'wpWatch', $checkWatch, array( 'tabindex' => '3' ) ) .
3075 "</td>
3076 </tr>";
3079 $form .= "
3080 $suppress
3081 <tr>
3082 <td></td>
3083 <td class='mw-submit'>" .
3084 Xml::submitButton( wfMsg( 'deletepage' ),
3085 array( 'name' => 'wpConfirmB', 'id' => 'wpConfirmB', 'tabindex' => '5' ) ) .
3086 "</td>
3087 </tr>" .
3088 Xml::closeElement( 'table' ) .
3089 Xml::closeElement( 'fieldset' ) .
3090 Html::hidden( 'wpEditToken', $wgUser->editToken() ) .
3091 Xml::closeElement( 'form' );
3093 if ( $wgUser->isAllowed( 'editinterface' ) ) {
3094 $skin = $wgUser->getSkin();
3095 $title = Title::makeTitle( NS_MEDIAWIKI, 'Deletereason-dropdown' );
3096 $link = $skin->link(
3097 $title,
3098 wfMsgHtml( 'delete-edit-reasonlist' ),
3099 array(),
3100 array( 'action' => 'edit' )
3102 $form .= '<p class="mw-delete-editreasons">' . $link . '</p>';
3105 $wgOut->addHTML( $form );
3106 $wgOut->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
3107 LogEventsList::showLogExtract( $wgOut, 'delete',
3108 $this->mTitle->getPrefixedText()
3113 * Perform a deletion and output success or failure messages
3115 public function doDelete( $reason, $suppress = false ) {
3116 global $wgOut, $wgUser;
3118 $id = $this->mTitle->getArticleID( Title::GAID_FOR_UPDATE );
3120 $error = '';
3121 if ( wfRunHooks( 'ArticleDelete', array( &$this, &$wgUser, &$reason, &$error ) ) ) {
3122 if ( $this->doDeleteArticle( $reason, $suppress, $id ) ) {
3123 $deleted = $this->mTitle->getPrefixedText();
3125 $wgOut->setPagetitle( wfMsg( 'actioncomplete' ) );
3126 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3128 $loglink = '[[Special:Log/delete|' . wfMsgNoTrans( 'deletionlog' ) . ']]';
3130 $wgOut->addWikiMsg( 'deletedtext', $deleted, $loglink );
3131 $wgOut->returnToMain( false );
3132 wfRunHooks( 'ArticleDeleteComplete', array( &$this, &$wgUser, $reason, $id ) );
3134 } else {
3135 if ( $error == '' ) {
3136 $wgOut->showFatalError(
3137 Html::rawElement(
3138 'div',
3139 array( 'class' => 'error mw-error-cannotdelete' ),
3140 wfMsgExt( 'cannotdelete', array( 'parse' ), $this->mTitle->getPrefixedText() )
3144 $wgOut->addHTML( Xml::element( 'h2', null, LogPage::logName( 'delete' ) ) );
3146 LogEventsList::showLogExtract(
3147 $wgOut,
3148 'delete',
3149 $this->mTitle->getPrefixedText()
3151 } else {
3152 $wgOut->showFatalError( $error );
3158 * Back-end article deletion
3159 * Deletes the article with database consistency, writes logs, purges caches
3161 * @param $reason string delete reason for deletion log
3162 * @param suppress bitfield
3163 * Revision::DELETED_TEXT
3164 * Revision::DELETED_COMMENT
3165 * Revision::DELETED_USER
3166 * Revision::DELETED_RESTRICTED
3167 * @param $id int article ID
3168 * @param $commit boolean defaults to true, triggers transaction end
3169 * @return boolean true if successful
3171 public function doDeleteArticle( $reason, $suppress = false, $id = 0, $commit = true ) {
3172 global $wgDeferredUpdateList, $wgUseTrackbacks;
3174 wfDebug( __METHOD__ . "\n" );
3176 $dbw = wfGetDB( DB_MASTER );
3177 $t = $this->mTitle->getDBkey();
3178 $id = $id ? $id : $this->mTitle->getArticleID( Title::GAID_FOR_UPDATE );
3180 if ( $t === '' || $id == 0 ) {
3181 return false;
3184 $u = new SiteStatsUpdate( 0, 1, - (int)$this->isCountable( $this->getRawText() ), -1 );
3185 array_push( $wgDeferredUpdateList, $u );
3187 // Bitfields to further suppress the content
3188 if ( $suppress ) {
3189 $bitfield = 0;
3190 // This should be 15...
3191 $bitfield |= Revision::DELETED_TEXT;
3192 $bitfield |= Revision::DELETED_COMMENT;
3193 $bitfield |= Revision::DELETED_USER;
3194 $bitfield |= Revision::DELETED_RESTRICTED;
3195 } else {
3196 $bitfield = 'rev_deleted';
3199 $dbw->begin();
3200 // For now, shunt the revision data into the archive table.
3201 // Text is *not* removed from the text table; bulk storage
3202 // is left intact to avoid breaking block-compression or
3203 // immutable storage schemes.
3205 // For backwards compatibility, note that some older archive
3206 // table entries will have ar_text and ar_flags fields still.
3208 // In the future, we may keep revisions and mark them with
3209 // the rev_deleted field, which is reserved for this purpose.
3210 $dbw->insertSelect( 'archive', array( 'page', 'revision' ),
3211 array(
3212 'ar_namespace' => 'page_namespace',
3213 'ar_title' => 'page_title',
3214 'ar_comment' => 'rev_comment',
3215 'ar_user' => 'rev_user',
3216 'ar_user_text' => 'rev_user_text',
3217 'ar_timestamp' => 'rev_timestamp',
3218 'ar_minor_edit' => 'rev_minor_edit',
3219 'ar_rev_id' => 'rev_id',
3220 'ar_text_id' => 'rev_text_id',
3221 'ar_text' => '\'\'', // Be explicit to appease
3222 'ar_flags' => '\'\'', // MySQL's "strict mode"...
3223 'ar_len' => 'rev_len',
3224 'ar_page_id' => 'page_id',
3225 'ar_deleted' => $bitfield
3226 ), array(
3227 'page_id' => $id,
3228 'page_id = rev_page'
3229 ), __METHOD__
3232 # Delete restrictions for it
3233 $dbw->delete( 'page_restrictions', array ( 'pr_page' => $id ), __METHOD__ );
3235 # Now that it's safely backed up, delete it
3236 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
3237 $ok = ( $dbw->affectedRows() > 0 ); // getArticleId() uses slave, could be laggy
3239 if ( !$ok ) {
3240 $dbw->rollback();
3241 return false;
3244 # Fix category table counts
3245 $cats = array();
3246 $res = $dbw->select( 'categorylinks', 'cl_to', array( 'cl_from' => $id ), __METHOD__ );
3248 foreach ( $res as $row ) {
3249 $cats [] = $row->cl_to;
3252 $this->updateCategoryCounts( array(), $cats );
3254 # If using cascading deletes, we can skip some explicit deletes
3255 if ( !$dbw->cascadingDeletes() ) {
3256 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__ );
3258 if ( $wgUseTrackbacks )
3259 $dbw->delete( 'trackbacks', array( 'tb_page' => $id ), __METHOD__ );
3261 # Delete outgoing links
3262 $dbw->delete( 'pagelinks', array( 'pl_from' => $id ) );
3263 $dbw->delete( 'imagelinks', array( 'il_from' => $id ) );
3264 $dbw->delete( 'categorylinks', array( 'cl_from' => $id ) );
3265 $dbw->delete( 'templatelinks', array( 'tl_from' => $id ) );
3266 $dbw->delete( 'externallinks', array( 'el_from' => $id ) );
3267 $dbw->delete( 'langlinks', array( 'll_from' => $id ) );
3268 $dbw->delete( 'redirect', array( 'rd_from' => $id ) );
3271 # If using cleanup triggers, we can skip some manual deletes
3272 if ( !$dbw->cleanupTriggers() ) {
3273 # Clean up recentchanges entries...
3274 $dbw->delete( 'recentchanges',
3275 array( 'rc_type != ' . RC_LOG,
3276 'rc_namespace' => $this->mTitle->getNamespace(),
3277 'rc_title' => $this->mTitle->getDBkey() ),
3278 __METHOD__ );
3279 $dbw->delete( 'recentchanges',
3280 array( 'rc_type != ' . RC_LOG, 'rc_cur_id' => $id ),
3281 __METHOD__ );
3284 # Clear caches
3285 Article::onArticleDelete( $this->mTitle );
3287 # Clear the cached article id so the interface doesn't act like we exist
3288 $this->mTitle->resetArticleID( 0 );
3290 # Log the deletion, if the page was suppressed, log it at Oversight instead
3291 $logtype = $suppress ? 'suppress' : 'delete';
3292 $log = new LogPage( $logtype );
3294 # Make sure logging got through
3295 $log->addEntry( 'delete', $this->mTitle, $reason, array() );
3297 if ( $commit ) {
3298 $dbw->commit();
3301 return true;
3305 * Roll back the most recent consecutive set of edits to a page
3306 * from the same user; fails if there are no eligible edits to
3307 * roll back to, e.g. user is the sole contributor. This function
3308 * performs permissions checks on $wgUser, then calls commitRollback()
3309 * to do the dirty work
3311 * @param $fromP String: Name of the user whose edits to rollback.
3312 * @param $summary String: Custom summary. Set to default summary if empty.
3313 * @param $token String: Rollback token.
3314 * @param $bot Boolean: If true, mark all reverted edits as bot.
3316 * @param $resultDetails Array: contains result-specific array of additional values
3317 * 'alreadyrolled' : 'current' (rev)
3318 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3320 * @return array of errors, each error formatted as
3321 * array(messagekey, param1, param2, ...).
3322 * On success, the array is empty. This array can also be passed to
3323 * OutputPage::showPermissionsErrorPage().
3325 public function doRollback( $fromP, $summary, $token, $bot, &$resultDetails ) {
3326 global $wgUser;
3328 $resultDetails = null;
3330 # Check permissions
3331 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $wgUser );
3332 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $wgUser );
3333 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3335 if ( !$wgUser->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
3336 $errors[] = array( 'sessionfailure' );
3339 if ( $wgUser->pingLimiter( 'rollback' ) || $wgUser->pingLimiter() ) {
3340 $errors[] = array( 'actionthrottledtext' );
3343 # If there were errors, bail out now
3344 if ( !empty( $errors ) ) {
3345 return $errors;
3348 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails );
3352 * Backend implementation of doRollback(), please refer there for parameter
3353 * and return value documentation
3355 * NOTE: This function does NOT check ANY permissions, it just commits the
3356 * rollback to the DB Therefore, you should only call this function direct-
3357 * ly if you want to use custom permissions checks. If you don't, use
3358 * doRollback() instead.
3360 public function commitRollback( $fromP, $summary, $bot, &$resultDetails ) {
3361 global $wgUseRCPatrol, $wgUser, $wgLang;
3363 $dbw = wfGetDB( DB_MASTER );
3365 if ( wfReadOnly() ) {
3366 return array( array( 'readonlytext' ) );
3369 # Get the last editor
3370 $current = Revision::newFromTitle( $this->mTitle );
3371 if ( is_null( $current ) ) {
3372 # Something wrong... no page?
3373 return array( array( 'notanarticle' ) );
3376 $from = str_replace( '_', ' ', $fromP );
3377 # User name given should match up with the top revision.
3378 # If the user was deleted then $from should be empty.
3379 if ( $from != $current->getUserText() ) {
3380 $resultDetails = array( 'current' => $current );
3381 return array( array( 'alreadyrolled',
3382 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3383 htmlspecialchars( $fromP ),
3384 htmlspecialchars( $current->getUserText() )
3385 ) );
3388 # Get the last edit not by this guy...
3389 # Note: these may not be public values
3390 $user = intval( $current->getRawUser() );
3391 $user_text = $dbw->addQuotes( $current->getRawUserText() );
3392 $s = $dbw->selectRow( 'revision',
3393 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3394 array( 'rev_page' => $current->getPage(),
3395 "rev_user != {$user} OR rev_user_text != {$user_text}"
3396 ), __METHOD__,
3397 array( 'USE INDEX' => 'page_timestamp',
3398 'ORDER BY' => 'rev_timestamp DESC' )
3400 if ( $s === false ) {
3401 # No one else ever edited this page
3402 return array( array( 'cantrollback' ) );
3403 } else if ( $s->rev_deleted & Revision::DELETED_TEXT || $s->rev_deleted & Revision::DELETED_USER ) {
3404 # Only admins can see this text
3405 return array( array( 'notvisiblerev' ) );
3408 $set = array();
3409 if ( $bot && $wgUser->isAllowed( 'markbotedits' ) ) {
3410 # Mark all reverted edits as bot
3411 $set['rc_bot'] = 1;
3414 if ( $wgUseRCPatrol ) {
3415 # Mark all reverted edits as patrolled
3416 $set['rc_patrolled'] = 1;
3419 if ( count( $set ) ) {
3420 $dbw->update( 'recentchanges', $set,
3421 array( /* WHERE */
3422 'rc_cur_id' => $current->getPage(),
3423 'rc_user_text' => $current->getUserText(),
3424 "rc_timestamp > '{$s->rev_timestamp}'",
3425 ), __METHOD__
3429 # Generate the edit summary if necessary
3430 $target = Revision::newFromId( $s->rev_id );
3431 if ( empty( $summary ) ) {
3432 if ( $from == '' ) { // no public user name
3433 $summary = wfMsgForContent( 'revertpage-nouser' );
3434 } else {
3435 $summary = wfMsgForContent( 'revertpage' );
3439 # Allow the custom summary to use the same args as the default message
3440 $args = array(
3441 $target->getUserText(), $from, $s->rev_id,
3442 $wgLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ), true ),
3443 $current->getId(), $wgLang->timeanddate( $current->getTimestamp() )
3445 $summary = wfMsgReplaceArgs( $summary, $args );
3447 # Save
3448 $flags = EDIT_UPDATE;
3450 if ( $wgUser->isAllowed( 'minoredit' ) ) {
3451 $flags |= EDIT_MINOR;
3454 if ( $bot && ( $wgUser->isAllowed( 'markbotedits' ) || $wgUser->isAllowed( 'bot' ) ) ) {
3455 $flags |= EDIT_FORCE_BOT;
3458 # Actually store the edit
3459 $status = $this->doEdit( $target->getText(), $summary, $flags, $target->getId() );
3460 if ( !empty( $status->value['revision'] ) ) {
3461 $revId = $status->value['revision']->getId();
3462 } else {
3463 $revId = false;
3466 wfRunHooks( 'ArticleRollbackComplete', array( $this, $wgUser, $target, $current ) );
3468 $resultDetails = array(
3469 'summary' => $summary,
3470 'current' => $current,
3471 'target' => $target,
3472 'newid' => $revId
3475 return array();
3479 * User interface for rollback operations
3481 public function rollback() {
3482 global $wgUser, $wgOut, $wgRequest;
3484 $details = null;
3486 $result = $this->doRollback(
3487 $wgRequest->getVal( 'from' ),
3488 $wgRequest->getText( 'summary' ),
3489 $wgRequest->getVal( 'token' ),
3490 $wgRequest->getBool( 'bot' ),
3491 $details
3494 if ( in_array( array( 'actionthrottledtext' ), $result ) ) {
3495 $wgOut->rateLimited();
3496 return;
3499 if ( isset( $result[0][0] ) && ( $result[0][0] == 'alreadyrolled' || $result[0][0] == 'cantrollback' ) ) {
3500 $wgOut->setPageTitle( wfMsg( 'rollbackfailed' ) );
3501 $errArray = $result[0];
3502 $errMsg = array_shift( $errArray );
3503 $wgOut->addWikiMsgArray( $errMsg, $errArray );
3505 if ( isset( $details['current'] ) ) {
3506 $current = $details['current'];
3508 if ( $current->getComment() != '' ) {
3509 $wgOut->addWikiMsgArray( 'editcomment', array(
3510 $wgUser->getSkin()->formatComment( $current->getComment() ) ), array( 'replaceafter' ) );
3514 return;
3517 # Display permissions errors before read-only message -- there's no
3518 # point in misleading the user into thinking the inability to rollback
3519 # is only temporary.
3520 if ( !empty( $result ) && $result !== array( array( 'readonlytext' ) ) ) {
3521 # array_diff is completely broken for arrays of arrays, sigh.
3522 # Remove any 'readonlytext' error manually.
3523 $out = array();
3524 foreach ( $result as $error ) {
3525 if ( $error != array( 'readonlytext' ) ) {
3526 $out [] = $error;
3529 $wgOut->showPermissionsErrorPage( $out );
3531 return;
3534 if ( $result == array( array( 'readonlytext' ) ) ) {
3535 $wgOut->readOnlyPage();
3537 return;
3540 $current = $details['current'];
3541 $target = $details['target'];
3542 $newId = $details['newid'];
3543 $wgOut->setPageTitle( wfMsg( 'actioncomplete' ) );
3544 $wgOut->setRobotPolicy( 'noindex,nofollow' );
3546 if ( $current->getUserText() === '' ) {
3547 $old = wfMsg( 'rev-deleted-user' );
3548 } else {
3549 $old = $wgUser->getSkin()->userLink( $current->getUser(), $current->getUserText() )
3550 . $wgUser->getSkin()->userToolLinks( $current->getUser(), $current->getUserText() );
3553 $new = $wgUser->getSkin()->userLink( $target->getUser(), $target->getUserText() )
3554 . $wgUser->getSkin()->userToolLinks( $target->getUser(), $target->getUserText() );
3555 $wgOut->addHTML( wfMsgExt( 'rollback-success', array( 'parse', 'replaceafter' ), $old, $new ) );
3556 $wgOut->returnToMain( false, $this->mTitle );
3558 if ( !$wgRequest->getBool( 'hidediff', false ) && !$wgUser->getBoolOption( 'norollbackdiff', false ) ) {
3559 $de = new DifferenceEngine( $this->mTitle, $current->getId(), $newId, false, true );
3560 $de->showDiff( '', '' );
3565 * Do standard deferred updates after page view
3567 public function viewUpdates() {
3568 global $wgDeferredUpdateList, $wgDisableCounters, $wgUser;
3569 if ( wfReadOnly() ) {
3570 return;
3573 # Don't update page view counters on views from bot users (bug 14044)
3574 if ( !$wgDisableCounters && !$wgUser->isAllowed( 'bot' ) && $this->getID() ) {
3575 $wgDeferredUpdateList[] = new ViewCountUpdate( $this->getID() );
3576 $wgDeferredUpdateList[] = new SiteStatsUpdate( 1, 0, 0 );
3579 # Update newtalk / watchlist notification status
3580 $wgUser->clearNotification( $this->mTitle );
3584 * Prepare text which is about to be saved.
3585 * Returns a stdclass with source, pst and output members
3587 public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
3588 if ( $this->mPreparedEdit && $this->mPreparedEdit->newText == $text && $this->mPreparedEdit->revid == $revid ) {
3589 // Already prepared
3590 return $this->mPreparedEdit;
3593 global $wgParser;
3595 if( $user === null ) {
3596 global $wgUser;
3597 $user = $wgUser;
3599 $popts = ParserOptions::newFromUser( $user );
3600 wfRunHooks( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
3602 $edit = (object)array();
3603 $edit->revid = $revid;
3604 $edit->newText = $text;
3605 $edit->pst = $this->preSaveTransform( $text, $user, $popts );
3606 $edit->popts = $this->getParserOptions( true );
3607 $edit->output = $wgParser->parse( $edit->pst, $this->mTitle, $edit->popts, true, true, $revid );
3608 $edit->oldText = $this->getRawText();
3610 $this->mPreparedEdit = $edit;
3612 return $edit;
3616 * Do standard deferred updates after page edit.
3617 * Update links tables, site stats, search index and message cache.
3618 * Purges pages that include this page if the text was changed here.
3619 * Every 100th edit, prune the recent changes table.
3621 * @private
3622 * @param $text String: New text of the article
3623 * @param $summary String: Edit summary
3624 * @param $minoredit Boolean: Minor edit
3625 * @param $timestamp_of_pagechange String timestamp associated with the page change
3626 * @param $newid Integer: rev_id value of the new revision
3627 * @param $changed Boolean: Whether or not the content actually changed
3628 * @param $user User object: User doing the edit
3630 public function editUpdates( $text, $summary, $minoredit, $timestamp_of_pagechange, $newid, $changed = true, User $user = null ) {
3631 global $wgDeferredUpdateList, $wgUser, $wgEnableParserCache;
3633 wfProfileIn( __METHOD__ );
3635 # Parse the text
3636 # Be careful not to double-PST: $text is usually already PST-ed once
3637 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
3638 wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
3639 $editInfo = $this->prepareTextForEdit( $text, $newid, $user );
3640 } else {
3641 wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
3642 $editInfo = $this->mPreparedEdit;
3645 # Save it to the parser cache
3646 if ( $wgEnableParserCache ) {
3647 $parserCache = ParserCache::singleton();
3648 $parserCache->save( $editInfo->output, $this, $editInfo->popts );
3651 # Update the links tables
3652 $u = new LinksUpdate( $this->mTitle, $editInfo->output );
3653 $u->doUpdate();
3655 wfRunHooks( 'ArticleEditUpdates', array( &$this, &$editInfo, $changed ) );
3657 if ( wfRunHooks( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
3658 if ( 0 == mt_rand( 0, 99 ) ) {
3659 // Flush old entries from the `recentchanges` table; we do this on
3660 // random requests so as to avoid an increase in writes for no good reason
3661 global $wgRCMaxAge;
3663 $dbw = wfGetDB( DB_MASTER );
3664 $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
3665 $recentchanges = $dbw->tableName( 'recentchanges' );
3666 $sql = "DELETE FROM $recentchanges WHERE rc_timestamp < '{$cutoff}'";
3668 $dbw->query( $sql );
3672 $id = $this->getID();
3673 $title = $this->mTitle->getPrefixedDBkey();
3674 $shortTitle = $this->mTitle->getDBkey();
3676 if ( 0 == $id ) {
3677 wfProfileOut( __METHOD__ );
3678 return;
3681 $u = new SiteStatsUpdate( 0, 1, $this->mGoodAdjustment, $this->mTotalAdjustment );
3682 array_push( $wgDeferredUpdateList, $u );
3683 $u = new SearchUpdate( $id, $title, $text );
3684 array_push( $wgDeferredUpdateList, $u );
3686 # If this is another user's talk page, update newtalk
3687 # Don't do this if $changed = false otherwise some idiot can null-edit a
3688 # load of user talk pages and piss people off, nor if it's a minor edit
3689 # by a properly-flagged bot.
3690 if ( $this->mTitle->getNamespace() == NS_USER_TALK && $shortTitle != $wgUser->getTitleKey() && $changed
3691 && !( $minoredit && $wgUser->isAllowed( 'nominornewtalk' ) )
3693 if ( wfRunHooks( 'ArticleEditUpdateNewTalk', array( &$this ) ) ) {
3694 $other = User::newFromName( $shortTitle, false );
3695 if ( !$other ) {
3696 wfDebug( __METHOD__ . ": invalid username\n" );
3697 } elseif ( User::isIP( $shortTitle ) ) {
3698 // An anonymous user
3699 $other->setNewtalk( true );
3700 } elseif ( $other->isLoggedIn() ) {
3701 $other->setNewtalk( true );
3702 } else {
3703 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
3708 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
3709 MessageCache::singleton()->replace( $shortTitle, $text );
3712 wfProfileOut( __METHOD__ );
3716 * Perform article updates on a special page creation.
3718 * @param $rev Revision object
3720 * @todo This is a shitty interface function. Kill it and replace the
3721 * other shitty functions like editUpdates and such so it's not needed
3722 * anymore.
3724 public function createUpdates( $rev ) {
3725 $this->mGoodAdjustment = $this->isCountable( $rev->getText() );
3726 $this->mTotalAdjustment = 1;
3727 $this->editUpdates( $rev->getText(), $rev->getComment(),
3728 $rev->isMinor(), wfTimestamp(), $rev->getId(), true );
3732 * Generate the navigation links when browsing through an article revisions
3733 * It shows the information as:
3734 * Revision as of \<date\>; view current revision
3735 * \<- Previous version | Next Version -\>
3737 * @param $oldid String: revision ID of this article revision
3739 public function setOldSubtitle( $oldid = 0 ) {
3740 global $wgLang, $wgOut, $wgUser, $wgRequest;
3742 if ( !wfRunHooks( 'DisplayOldSubtitle', array( &$this, &$oldid ) ) ) {
3743 return;
3746 $unhide = $wgRequest->getInt( 'unhide' ) == 1;
3748 # Cascade unhide param in links for easy deletion browsing
3749 $extraParams = array();
3750 if ( $wgRequest->getVal( 'unhide' ) ) {
3751 $extraParams['unhide'] = 1;
3754 $revision = Revision::newFromId( $oldid );
3756 $current = ( $oldid == $this->mLatest );
3757 $td = $wgLang->timeanddate( $this->mTimestamp, true );
3758 $tddate = $wgLang->date( $this->mTimestamp, true );
3759 $tdtime = $wgLang->time( $this->mTimestamp, true );
3760 $sk = $wgUser->getSkin();
3761 $lnk = $current
3762 ? wfMsgHtml( 'currentrevisionlink' )
3763 : $sk->link(
3764 $this->mTitle,
3765 wfMsgHtml( 'currentrevisionlink' ),
3766 array(),
3767 $extraParams,
3768 array( 'known', 'noclasses' )
3770 $curdiff = $current
3771 ? wfMsgHtml( 'diff' )
3772 : $sk->link(
3773 $this->mTitle,
3774 wfMsgHtml( 'diff' ),
3775 array(),
3776 array(
3777 'diff' => 'cur',
3778 'oldid' => $oldid
3779 ) + $extraParams,
3780 array( 'known', 'noclasses' )
3782 $prev = $this->mTitle->getPreviousRevisionID( $oldid ) ;
3783 $prevlink = $prev
3784 ? $sk->link(
3785 $this->mTitle,
3786 wfMsgHtml( 'previousrevision' ),
3787 array(),
3788 array(
3789 'direction' => 'prev',
3790 'oldid' => $oldid
3791 ) + $extraParams,
3792 array( 'known', 'noclasses' )
3794 : wfMsgHtml( 'previousrevision' );
3795 $prevdiff = $prev
3796 ? $sk->link(
3797 $this->mTitle,
3798 wfMsgHtml( 'diff' ),
3799 array(),
3800 array(
3801 'diff' => 'prev',
3802 'oldid' => $oldid
3803 ) + $extraParams,
3804 array( 'known', 'noclasses' )
3806 : wfMsgHtml( 'diff' );
3807 $nextlink = $current
3808 ? wfMsgHtml( 'nextrevision' )
3809 : $sk->link(
3810 $this->mTitle,
3811 wfMsgHtml( 'nextrevision' ),
3812 array(),
3813 array(
3814 'direction' => 'next',
3815 'oldid' => $oldid
3816 ) + $extraParams,
3817 array( 'known', 'noclasses' )
3819 $nextdiff = $current
3820 ? wfMsgHtml( 'diff' )
3821 : $sk->link(
3822 $this->mTitle,
3823 wfMsgHtml( 'diff' ),
3824 array(),
3825 array(
3826 'diff' => 'next',
3827 'oldid' => $oldid
3828 ) + $extraParams,
3829 array( 'known', 'noclasses' )
3832 $cdel = '';
3834 // User can delete revisions or view deleted revisions...
3835 $canHide = $wgUser->isAllowed( 'deleterevision' );
3836 if ( $canHide || ( $revision->getVisibility() && $wgUser->isAllowed( 'deletedhistory' ) ) ) {
3837 if ( !$revision->userCan( Revision::DELETED_RESTRICTED ) ) {
3838 $cdel = $sk->revDeleteLinkDisabled( $canHide ); // rev was hidden from Sysops
3839 } else {
3840 $query = array(
3841 'type' => 'revision',
3842 'target' => $this->mTitle->getPrefixedDbkey(),
3843 'ids' => $oldid
3845 $cdel = $sk->revDeleteLink( $query, $revision->isDeleted( File::DELETED_RESTRICTED ), $canHide );
3847 $cdel .= ' ';
3850 # Show user links if allowed to see them. If hidden, then show them only if requested...
3851 $userlinks = $sk->revUserTools( $revision, !$unhide );
3853 $infomsg = $current && !wfMessage( 'revision-info-current' )->isDisabled()
3854 ? 'revision-info-current'
3855 : 'revision-info';
3857 $r = "\n\t\t\t\t<div id=\"mw-{$infomsg}\">" .
3858 wfMsgExt(
3859 $infomsg,
3860 array( 'parseinline', 'replaceafter' ),
3861 $td,
3862 $userlinks,
3863 $revision->getID(),
3864 $tddate,
3865 $tdtime,
3866 $revision->getUser()
3868 "</div>\n" .
3869 "\n\t\t\t\t<div id=\"mw-revision-nav\">" . $cdel . wfMsgExt( 'revision-nav', array( 'escapenoentities', 'parsemag', 'replaceafter' ),
3870 $prevdiff, $prevlink, $lnk, $curdiff, $nextlink, $nextdiff ) . "</div>\n\t\t\t";
3872 $wgOut->setSubtitle( $r );
3876 * This function is called right before saving the wikitext,
3877 * so we can do things like signatures and links-in-context.
3879 * @param $text String article contents
3880 * @param $user User object: user doing the edit, $wgUser will be used if
3881 * null is given
3882 * @param $popts ParserOptions object: parser options, default options for
3883 * the user loaded if null given
3884 * @return string article contents with altered wikitext markup (signatures
3885 * converted, {{subst:}}, templates, etc.)
3887 public function preSaveTransform( $text, User $user = null, ParserOptions $popts = null ) {
3888 global $wgParser;
3890 if ( $user === null ) {
3891 global $wgUser;
3892 $user = $wgUser;
3895 if ( $popts === null ) {
3896 $popts = ParserOptions::newFromUser( $user );
3899 return $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
3902 /* Caching functions */
3905 * checkLastModified returns true if it has taken care of all
3906 * output to the client that is necessary for this request.
3907 * (that is, it has sent a cached version of the page)
3909 * @return boolean true if cached version send, false otherwise
3911 protected function tryFileCache() {
3912 static $called = false;
3914 if ( $called ) {
3915 wfDebug( "Article::tryFileCache(): called twice!?\n" );
3916 return false;
3919 $called = true;
3920 if ( $this->isFileCacheable() ) {
3921 $cache = new HTMLFileCache( $this->mTitle );
3922 if ( $cache->isFileCacheGood( $this->mTouched ) ) {
3923 wfDebug( "Article::tryFileCache(): about to load file\n" );
3924 $cache->loadFromFileCache();
3925 return true;
3926 } else {
3927 wfDebug( "Article::tryFileCache(): starting buffer\n" );
3928 ob_start( array( &$cache, 'saveToFileCache' ) );
3930 } else {
3931 wfDebug( "Article::tryFileCache(): not cacheable\n" );
3934 return false;
3938 * Check if the page can be cached
3939 * @return bool
3941 public function isFileCacheable() {
3942 $cacheable = false;
3944 if ( HTMLFileCache::useFileCache() ) {
3945 $cacheable = $this->getID() && !$this->mRedirectedFrom && !$this->mTitle->isRedirect();
3946 // Extension may have reason to disable file caching on some pages.
3947 if ( $cacheable ) {
3948 $cacheable = wfRunHooks( 'IsFileCacheable', array( &$this ) );
3952 return $cacheable;
3956 * Loads page_touched and returns a value indicating if it should be used
3957 * @return boolean true if not a redirect
3959 public function checkTouched() {
3960 if ( !$this->mDataLoaded ) {
3961 $this->loadPageData();
3964 return !$this->mIsRedirect;
3968 * Get the page_touched field
3969 * @return string containing GMT timestamp
3971 public function getTouched() {
3972 if ( !$this->mDataLoaded ) {
3973 $this->loadPageData();
3976 return $this->mTouched;
3980 * Get the page_latest field
3981 * @return integer rev_id of current revision
3983 public function getLatest() {
3984 if ( !$this->mDataLoaded ) {
3985 $this->loadPageData();
3988 return (int)$this->mLatest;
3992 * Edit an article without doing all that other stuff
3993 * The article must already exist; link tables etc
3994 * are not updated, caches are not flushed.
3996 * @param $text String: text submitted
3997 * @param $comment String: comment submitted
3998 * @param $minor Boolean: whereas it's a minor modification
4000 public function quickEdit( $text, $comment = '', $minor = 0 ) {
4001 wfProfileIn( __METHOD__ );
4003 $dbw = wfGetDB( DB_MASTER );
4004 $revision = new Revision( array(
4005 'page' => $this->getId(),
4006 'text' => $text,
4007 'comment' => $comment,
4008 'minor_edit' => $minor ? 1 : 0,
4009 ) );
4010 $revision->insertOn( $dbw );
4011 $this->updateRevisionOn( $dbw, $revision );
4013 global $wgUser;
4014 wfRunHooks( 'NewRevisionFromEditComplete', array( $this, $revision, false, $wgUser ) );
4016 wfProfileOut( __METHOD__ );
4020 * The onArticle*() functions are supposed to be a kind of hooks
4021 * which should be called whenever any of the specified actions
4022 * are done.
4024 * This is a good place to put code to clear caches, for instance.
4026 * This is called on page move and undelete, as well as edit
4028 * @param $title Title object
4030 public static function onArticleCreate( $title ) {
4031 # Update existence markers on article/talk tabs...
4032 if ( $title->isTalkPage() ) {
4033 $other = $title->getSubjectPage();
4034 } else {
4035 $other = $title->getTalkPage();
4038 $other->invalidateCache();
4039 $other->purgeSquid();
4041 $title->touchLinks();
4042 $title->purgeSquid();
4043 $title->deleteTitleProtection();
4047 * Clears caches when article is deleted
4049 public static function onArticleDelete( $title ) {
4050 # Update existence markers on article/talk tabs...
4051 if ( $title->isTalkPage() ) {
4052 $other = $title->getSubjectPage();
4053 } else {
4054 $other = $title->getTalkPage();
4057 $other->invalidateCache();
4058 $other->purgeSquid();
4060 $title->touchLinks();
4061 $title->purgeSquid();
4063 # File cache
4064 HTMLFileCache::clearFileCache( $title );
4066 # Messages
4067 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
4068 MessageCache::singleton()->replace( $title->getDBkey(), false );
4071 # Images
4072 if ( $title->getNamespace() == NS_FILE ) {
4073 $update = new HTMLCacheUpdate( $title, 'imagelinks' );
4074 $update->doUpdate();
4077 # User talk pages
4078 if ( $title->getNamespace() == NS_USER_TALK ) {
4079 $user = User::newFromName( $title->getText(), false );
4080 $user->setNewtalk( false );
4083 # Image redirects
4084 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
4088 * Purge caches on page update etc
4090 * @param $title Title object
4091 * @todo: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title
4093 public static function onArticleEdit( $title ) {
4094 global $wgDeferredUpdateList;
4096 // Invalidate caches of articles which include this page
4097 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'templatelinks' );
4099 // Invalidate the caches of all pages which redirect here
4100 $wgDeferredUpdateList[] = new HTMLCacheUpdate( $title, 'redirect' );
4102 # Purge squid for this page only
4103 $title->purgeSquid();
4105 # Clear file cache for this page only
4106 HTMLFileCache::clearFileCache( $title );
4109 /**#@-*/
4112 * Overriden by ImagePage class, only present here to avoid a fatal error
4113 * Called for ?action=revert
4115 public function revert() {
4116 global $wgOut;
4117 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4121 * Info about this page
4122 * Called for ?action=info when $wgAllowPageInfo is on.
4124 public function info() {
4125 global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser;
4127 if ( !$wgAllowPageInfo ) {
4128 $wgOut->showErrorPage( 'nosuchaction', 'nosuchactiontext' );
4129 return;
4132 $page = $this->mTitle->getSubjectPage();
4134 $wgOut->setPagetitle( $page->getPrefixedText() );
4135 $wgOut->setPageTitleActionText( wfMsg( 'info_short' ) );
4136 $wgOut->setSubtitle( wfMsgHtml( 'infosubtitle' ) );
4138 if ( !$this->mTitle->exists() ) {
4139 $wgOut->addHTML( '<div class="noarticletext">' );
4140 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
4141 // This doesn't quite make sense; the user is asking for
4142 // information about the _page_, not the message... -- RC
4143 $wgOut->addHTML( htmlspecialchars( $this->mTitle->getDefaultMessageText() ) );
4144 } else {
4145 $msg = $wgUser->isLoggedIn()
4146 ? 'noarticletext'
4147 : 'noarticletextanon';
4148 $wgOut->addHTML( wfMsgExt( $msg, 'parse' ) );
4151 $wgOut->addHTML( '</div>' );
4152 } else {
4153 $dbr = wfGetDB( DB_SLAVE );
4154 $wl_clause = array(
4155 'wl_title' => $page->getDBkey(),
4156 'wl_namespace' => $page->getNamespace() );
4157 $numwatchers = $dbr->selectField(
4158 'watchlist',
4159 'COUNT(*)',
4160 $wl_clause,
4161 __METHOD__,
4162 $this->getSelectOptions() );
4164 $pageInfo = $this->pageCountInfo( $page );
4165 $talkInfo = $this->pageCountInfo( $page->getTalkPage() );
4168 //FIXME: unescaped messages
4169 $wgOut->addHTML( "<ul><li>" . wfMsg( "numwatchers", $wgLang->formatNum( $numwatchers ) ) . '</li>' );
4170 $wgOut->addHTML( "<li>" . wfMsg( 'numedits', $wgLang->formatNum( $pageInfo['edits'] ) ) . '</li>' );
4172 if ( $talkInfo ) {
4173 $wgOut->addHTML( '<li>' . wfMsg( "numtalkedits", $wgLang->formatNum( $talkInfo['edits'] ) ) . '</li>' );
4176 $wgOut->addHTML( '<li>' . wfMsg( "numauthors", $wgLang->formatNum( $pageInfo['authors'] ) ) . '</li>' );
4178 if ( $talkInfo ) {
4179 $wgOut->addHTML( '<li>' . wfMsg( 'numtalkauthors', $wgLang->formatNum( $talkInfo['authors'] ) ) . '</li>' );
4182 $wgOut->addHTML( '</ul>' );
4187 * Return the total number of edits and number of unique editors
4188 * on a given page. If page does not exist, returns false.
4190 * @param $title Title object
4191 * @return mixed array or boolean false
4193 public function pageCountInfo( $title ) {
4194 $id = $title->getArticleId();
4196 if ( $id == 0 ) {
4197 return false;
4200 $dbr = wfGetDB( DB_SLAVE );
4201 $rev_clause = array( 'rev_page' => $id );
4202 $edits = $dbr->selectField(
4203 'revision',
4204 'COUNT(rev_page)',
4205 $rev_clause,
4206 __METHOD__,
4207 $this->getSelectOptions()
4209 $authors = $dbr->selectField(
4210 'revision',
4211 'COUNT(DISTINCT rev_user_text)',
4212 $rev_clause,
4213 __METHOD__,
4214 $this->getSelectOptions()
4217 return array( 'edits' => $edits, 'authors' => $authors );
4221 * Return a list of templates used by this article.
4222 * Uses the templatelinks table
4224 * @return Array of Title objects
4226 public function getUsedTemplates() {
4227 $result = array();
4228 $id = $this->mTitle->getArticleID();
4230 if ( $id == 0 ) {
4231 return array();
4234 $dbr = wfGetDB( DB_SLAVE );
4235 $res = $dbr->select( array( 'templatelinks' ),
4236 array( 'tl_namespace', 'tl_title' ),
4237 array( 'tl_from' => $id ),
4238 __METHOD__ );
4240 if ( $res !== false ) {
4241 foreach ( $res as $row ) {
4242 $result[] = Title::makeTitle( $row->tl_namespace, $row->tl_title );
4246 return $result;
4250 * Returns a list of hidden categories this page is a member of.
4251 * Uses the page_props and categorylinks tables.
4253 * @return Array of Title objects
4255 public function getHiddenCategories() {
4256 $result = array();
4257 $id = $this->mTitle->getArticleID();
4259 if ( $id == 0 ) {
4260 return array();
4263 $dbr = wfGetDB( DB_SLAVE );
4264 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
4265 array( 'cl_to' ),
4266 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
4267 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
4268 __METHOD__ );
4270 if ( $res !== false ) {
4271 foreach ( $res as $row ) {
4272 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
4276 return $result;
4280 * Return an applicable autosummary if one exists for the given edit.
4281 * @param $oldtext String: the previous text of the page.
4282 * @param $newtext String: The submitted text of the page.
4283 * @param $flags Int bitmask: a bitmask of flags submitted for the edit.
4284 * @return string An appropriate autosummary, or an empty string.
4286 public static function getAutosummary( $oldtext, $newtext, $flags ) {
4287 global $wgContLang;
4289 # Decide what kind of autosummary is needed.
4291 # Redirect autosummaries
4292 $ot = Title::newFromRedirect( $oldtext );
4293 $rt = Title::newFromRedirect( $newtext );
4295 if ( is_object( $rt ) && ( !is_object( $ot ) || !$rt->equals( $ot ) || $ot->getFragment() != $rt->getFragment() ) ) {
4296 return wfMsgForContent( 'autoredircomment', $rt->getFullText() );
4299 # New page autosummaries
4300 if ( $flags & EDIT_NEW && strlen( $newtext ) ) {
4301 # If they're making a new article, give its text, truncated, in the summary.
4303 $truncatedtext = $wgContLang->truncate(
4304 str_replace( "\n", ' ', $newtext ),
4305 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-new' ) ) ) );
4307 return wfMsgForContent( 'autosumm-new', $truncatedtext );
4310 # Blanking autosummaries
4311 if ( $oldtext != '' && $newtext == '' ) {
4312 return wfMsgForContent( 'autosumm-blank' );
4313 } elseif ( strlen( $oldtext ) > 10 * strlen( $newtext ) && strlen( $newtext ) < 500 ) {
4314 # Removing more than 90% of the article
4316 $truncatedtext = $wgContLang->truncate(
4317 $newtext,
4318 max( 0, 200 - strlen( wfMsgForContent( 'autosumm-replace' ) ) ) );
4320 return wfMsgForContent( 'autosumm-replace', $truncatedtext );
4323 # If we reach this point, there's no applicable autosummary for our case, so our
4324 # autosummary is empty.
4325 return '';
4329 * Add the primary page-view wikitext to the output buffer
4330 * Saves the text into the parser cache if possible.
4331 * Updates templatelinks if it is out of date.
4333 * @param $text String
4334 * @param $cache Boolean
4335 * @param $parserOptions mixed ParserOptions object, or boolean false
4337 public function outputWikiText( $text, $cache = true, $parserOptions = false ) {
4338 global $wgOut;
4340 $this->mParserOutput = $this->getOutputFromWikitext( $text, $cache, $parserOptions );
4341 $wgOut->addParserOutput( $this->mParserOutput );
4345 * This does all the heavy lifting for outputWikitext, except it returns the parser
4346 * output instead of sending it straight to $wgOut. Makes things nice and simple for,
4347 * say, embedding thread pages within a discussion system (LiquidThreads)
4349 * @param $text string
4350 * @param $cache boolean
4351 * @param $parserOptions parsing options, defaults to false
4352 * @return string containing parsed output
4354 public function getOutputFromWikitext( $text, $cache = true, $parserOptions = false ) {
4355 global $wgParser, $wgEnableParserCache, $wgUseFileCache;
4357 if ( !$parserOptions ) {
4358 $parserOptions = $this->getParserOptions();
4361 $time = - wfTime();
4362 $this->mParserOutput = $wgParser->parse( $text, $this->mTitle,
4363 $parserOptions, true, true, $this->getRevIdFetched() );
4364 $time += wfTime();
4366 # Timing hack
4367 if ( $time > 3 ) {
4368 wfDebugLog( 'slow-parse', sprintf( "%-5.2f %s", $time,
4369 $this->mTitle->getPrefixedDBkey() ) );
4372 if ( $wgEnableParserCache && $cache && $this->mParserOutput->isCacheable() ) {
4373 $parserCache = ParserCache::singleton();
4374 $parserCache->save( $this->mParserOutput, $this, $parserOptions );
4377 // Make sure file cache is not used on uncacheable content.
4378 // Output that has magic words in it can still use the parser cache
4379 // (if enabled), though it will generally expire sooner.
4380 if ( !$this->mParserOutput->isCacheable() || $this->mParserOutput->containsOldMagic() ) {
4381 $wgUseFileCache = false;
4384 $this->doCascadeProtectionUpdates( $this->mParserOutput );
4386 return $this->mParserOutput;
4390 * Get parser options suitable for rendering the primary article wikitext
4391 * @param $canonical boolean Determines that the generated must not depend on user preferences (see bug 14404)
4392 * @return mixed ParserOptions object or boolean false
4394 public function getParserOptions( $canonical = false ) {
4395 global $wgUser, $wgLanguageCode;
4397 if ( !$this->mParserOptions || $canonical ) {
4398 $user = !$canonical ? $wgUser : new User;
4399 $parserOptions = new ParserOptions( $user );
4400 $parserOptions->setTidy( true );
4401 $parserOptions->enableLimitReport();
4403 if ( $canonical ) {
4404 $parserOptions->setUserLang( $wgLanguageCode ); # Must be set explicitely
4405 return $parserOptions;
4407 $this->mParserOptions = $parserOptions;
4410 // Clone to allow modifications of the return value without affecting
4411 // the cache
4412 return clone $this->mParserOptions;
4416 * Updates cascading protections
4418 * @param $parserOutput mixed ParserOptions object, or boolean false
4420 protected function doCascadeProtectionUpdates( $parserOutput ) {
4421 if ( !$this->isCurrent() || wfReadOnly() || !$this->mTitle->areRestrictionsCascading() ) {
4422 return;
4425 // templatelinks table may have become out of sync,
4426 // especially if using variable-based transclusions.
4427 // For paranoia, check if things have changed and if
4428 // so apply updates to the database. This will ensure
4429 // that cascaded protections apply as soon as the changes
4430 // are visible.
4432 # Get templates from templatelinks
4433 $id = $this->mTitle->getArticleID();
4435 $tlTemplates = array();
4437 $dbr = wfGetDB( DB_SLAVE );
4438 $res = $dbr->select( array( 'templatelinks' ),
4439 array( 'tl_namespace', 'tl_title' ),
4440 array( 'tl_from' => $id ),
4441 __METHOD__
4444 foreach ( $res as $row ) {
4445 $tlTemplates["{$row->tl_namespace}:{$row->tl_title}"] = true;
4448 # Get templates from parser output.
4449 $poTemplates = array();
4450 foreach ( $parserOutput->getTemplates() as $ns => $templates ) {
4451 foreach ( $templates as $dbk => $id ) {
4452 $poTemplates["$ns:$dbk"] = true;
4456 # Get the diff
4457 $templates_diff = array_diff_key( $poTemplates, $tlTemplates );
4459 if ( count( $templates_diff ) > 0 ) {
4460 # Whee, link updates time.
4461 $u = new LinksUpdate( $this->mTitle, $parserOutput, false );
4462 $u->doUpdate();
4467 * Update all the appropriate counts in the category table, given that
4468 * we've added the categories $added and deleted the categories $deleted.
4470 * @param $added array The names of categories that were added
4471 * @param $deleted array The names of categories that were deleted
4473 public function updateCategoryCounts( $added, $deleted ) {
4474 $ns = $this->mTitle->getNamespace();
4475 $dbw = wfGetDB( DB_MASTER );
4477 # First make sure the rows exist. If one of the "deleted" ones didn't
4478 # exist, we might legitimately not create it, but it's simpler to just
4479 # create it and then give it a negative value, since the value is bogus
4480 # anyway.
4482 # Sometimes I wish we had INSERT ... ON DUPLICATE KEY UPDATE.
4483 $insertCats = array_merge( $added, $deleted );
4484 if ( !$insertCats ) {
4485 # Okay, nothing to do
4486 return;
4489 $insertRows = array();
4491 foreach ( $insertCats as $cat ) {
4492 $insertRows[] = array(
4493 'cat_id' => $dbw->nextSequenceValue( 'category_cat_id_seq' ),
4494 'cat_title' => $cat
4497 $dbw->insert( 'category', $insertRows, __METHOD__, 'IGNORE' );
4499 $addFields = array( 'cat_pages = cat_pages + 1' );
4500 $removeFields = array( 'cat_pages = cat_pages - 1' );
4502 if ( $ns == NS_CATEGORY ) {
4503 $addFields[] = 'cat_subcats = cat_subcats + 1';
4504 $removeFields[] = 'cat_subcats = cat_subcats - 1';
4505 } elseif ( $ns == NS_FILE ) {
4506 $addFields[] = 'cat_files = cat_files + 1';
4507 $removeFields[] = 'cat_files = cat_files - 1';
4510 if ( $added ) {
4511 $dbw->update(
4512 'category',
4513 $addFields,
4514 array( 'cat_title' => $added ),
4515 __METHOD__
4519 if ( $deleted ) {
4520 $dbw->update(
4521 'category',
4522 $removeFields,
4523 array( 'cat_title' => $deleted ),
4524 __METHOD__
4530 * Lightweight method to get the parser output for a page, checking the parser cache
4531 * and so on. Doesn't consider most of the stuff that Article::view is forced to
4532 * consider, so it's not appropriate to use there.
4534 * @since 1.16 (r52326) for LiquidThreads
4536 * @param $oldid mixed integer Revision ID or null
4537 * @return ParserOutput
4539 public function getParserOutput( $oldid = null ) {
4540 global $wgEnableParserCache, $wgUser;
4542 // Should the parser cache be used?
4543 $useParserCache = $wgEnableParserCache &&
4544 $wgUser->getStubThreshold() == 0 &&
4545 $this->exists() &&
4546 $oldid === null;
4548 wfDebug( __METHOD__ . ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
4550 if ( $wgUser->getStubThreshold() ) {
4551 wfIncrStats( 'pcache_miss_stub' );
4554 $parserOutput = false;
4555 if ( $useParserCache ) {
4556 $parserOutput = ParserCache::singleton()->get( $this, $this->getParserOptions() );
4559 if ( $parserOutput === false ) {
4560 // Cache miss; parse and output it.
4561 $rev = Revision::newFromTitle( $this->getTitle(), $oldid );
4563 return $this->getOutputFromWikitext( $rev->getText(), $useParserCache );
4564 } else {
4565 return $parserOutput;
4571 class PoolWorkArticleView extends PoolCounterWork {
4572 private $mArticle;
4574 function __construct( $article, $key, $useParserCache, $parserOptions ) {
4575 parent::__construct( 'ArticleView', $key );
4576 $this->mArticle = $article;
4577 $this->cacheable = $useParserCache;
4578 $this->parserOptions = $parserOptions;
4581 function doWork() {
4582 return $this->mArticle->doViewParse();
4585 function getCachedWork() {
4586 global $wgOut;
4588 $parserCache = ParserCache::singleton();
4589 $this->mArticle->mParserOutput = $parserCache->get( $this->mArticle, $this->parserOptions );
4591 if ( $this->mArticle->mParserOutput !== false ) {
4592 wfDebug( __METHOD__ . ": showing contents parsed by someone else\n" );
4593 $wgOut->addParserOutput( $this->mArticle->mParserOutput );
4594 # Ensure that UI elements requiring revision ID have
4595 # the correct version information.
4596 $wgOut->setRevisionId( $this->mArticle->getLatest() );
4597 return true;
4599 return false;
4602 function fallback() {
4603 return $this->mArticle->tryDirtyCache();
4606 function error( $status ) {
4607 global $wgOut;
4609 $wgOut->clearHTML(); // for release() errors
4610 $wgOut->enableClientCache( false );
4611 $wgOut->setRobotPolicy( 'noindex,nofollow' );
4613 $errortext = $status->getWikiText( false, 'view-pool-error' );
4614 $wgOut->addWikiText( '<div class="errorbox">' . $errortext . '</div>' );
4616 return false;