Merge "Import: Handle uploads with sha1 starting with 0 properly"
[mediawiki.git] / includes / page / WikiPage.php
blob00ac127ea076ced69fc8e9f556949ab19a0f5d2b
1 <?php
2 /**
3 * Base representation for a MediaWiki page.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
20 * @file
23 /**
24 * Abstract class for type hinting (accepts WikiPage, Article, ImagePage, CategoryPage)
26 interface Page {
29 /**
30 * Class representing a MediaWiki article and history.
32 * Some fields are public only for backwards-compatibility. Use accessors.
33 * In the past, this class was part of Article.php and everything was public.
35 class WikiPage implements Page, IDBAccessObject {
36 // Constants for $mDataLoadedFrom and related
38 /**
39 * @var Title
41 public $mTitle = null;
43 /**@{{
44 * @protected
46 public $mDataLoaded = false; // !< Boolean
47 public $mIsRedirect = false; // !< Boolean
48 public $mLatest = false; // !< Integer (false means "not loaded")
49 /**@}}*/
51 /** @var stdClass Map of cache fields (text, parser output, ect) for a proposed/new edit */
52 public $mPreparedEdit = false;
54 /**
55 * @var int
57 protected $mId = null;
59 /**
60 * @var int One of the READ_* constants
62 protected $mDataLoadedFrom = self::READ_NONE;
64 /**
65 * @var Title
67 protected $mRedirectTarget = null;
69 /**
70 * @var Revision
72 protected $mLastRevision = null;
74 /**
75 * @var string Timestamp of the current revision or empty string if not loaded
77 protected $mTimestamp = '';
79 /**
80 * @var string
82 protected $mTouched = '19700101000000';
84 /**
85 * @var string
87 protected $mLinksUpdated = '19700101000000';
89 /**
90 * Constructor and clear the article
91 * @param Title $title Reference to a Title object.
93 public function __construct( Title $title ) {
94 $this->mTitle = $title;
97 /**
98 * Create a WikiPage object of the appropriate class for the given title.
100 * @param Title $title
102 * @throws MWException
103 * @return WikiPage Object of the appropriate type
105 public static function factory( Title $title ) {
106 $ns = $title->getNamespace();
108 if ( $ns == NS_MEDIA ) {
109 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
110 } elseif ( $ns < 0 ) {
111 throw new MWException( "Invalid or virtual namespace $ns given." );
114 switch ( $ns ) {
115 case NS_FILE:
116 $page = new WikiFilePage( $title );
117 break;
118 case NS_CATEGORY:
119 $page = new WikiCategoryPage( $title );
120 break;
121 default:
122 $page = new WikiPage( $title );
125 return $page;
129 * Constructor from a page id
131 * @param int $id Article ID to load
132 * @param string|int $from One of the following values:
133 * - "fromdb" or WikiPage::READ_NORMAL to select from a slave database
134 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
136 * @return WikiPage|null
138 public static function newFromID( $id, $from = 'fromdb' ) {
139 // page id's are never 0 or negative, see bug 61166
140 if ( $id < 1 ) {
141 return null;
144 $from = self::convertSelectType( $from );
145 $db = wfGetDB( $from === self::READ_LATEST ? DB_MASTER : DB_SLAVE );
146 $row = $db->selectRow(
147 'page', self::selectFields(), array( 'page_id' => $id ), __METHOD__ );
148 if ( !$row ) {
149 return null;
151 return self::newFromRow( $row, $from );
155 * Constructor from a database row
157 * @since 1.20
158 * @param object $row Database row containing at least fields returned by selectFields().
159 * @param string|int $from Source of $data:
160 * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB
161 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
162 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
163 * @return WikiPage
165 public static function newFromRow( $row, $from = 'fromdb' ) {
166 $page = self::factory( Title::newFromRow( $row ) );
167 $page->loadFromRow( $row, $from );
168 return $page;
172 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
174 * @param object|string|int $type
175 * @return mixed
177 private static function convertSelectType( $type ) {
178 switch ( $type ) {
179 case 'fromdb':
180 return self::READ_NORMAL;
181 case 'fromdbmaster':
182 return self::READ_LATEST;
183 case 'forupdate':
184 return self::READ_LOCKING;
185 default:
186 // It may already be an integer or whatever else
187 return $type;
192 * Returns overrides for action handlers.
193 * Classes listed here will be used instead of the default one when
194 * (and only when) $wgActions[$action] === true. This allows subclasses
195 * to override the default behavior.
197 * @todo Move this UI stuff somewhere else
199 * @return array
201 public function getActionOverrides() {
202 $content_handler = $this->getContentHandler();
203 return $content_handler->getActionOverrides();
207 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
209 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
211 * @return ContentHandler
213 * @since 1.21
215 public function getContentHandler() {
216 return ContentHandler::getForModelID( $this->getContentModel() );
220 * Get the title object of the article
221 * @return Title Title object of this page
223 public function getTitle() {
224 return $this->mTitle;
228 * Clear the object
229 * @return void
231 public function clear() {
232 $this->mDataLoaded = false;
233 $this->mDataLoadedFrom = self::READ_NONE;
235 $this->clearCacheFields();
239 * Clear the object cache fields
240 * @return void
242 protected function clearCacheFields() {
243 $this->mId = null;
244 $this->mRedirectTarget = null; // Title object if set
245 $this->mLastRevision = null; // Latest revision
246 $this->mTouched = '19700101000000';
247 $this->mLinksUpdated = '19700101000000';
248 $this->mTimestamp = '';
249 $this->mIsRedirect = false;
250 $this->mLatest = false;
251 // Bug 57026: do not clear mPreparedEdit since prepareTextForEdit() already checks
252 // the requested rev ID and content against the cached one for equality. For most
253 // content types, the output should not change during the lifetime of this cache.
254 // Clearing it can cause extra parses on edit for no reason.
258 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
259 * @return void
260 * @since 1.23
262 public function clearPreparedEdit() {
263 $this->mPreparedEdit = false;
267 * Return the list of revision fields that should be selected to create
268 * a new page.
270 * @return array
272 public static function selectFields() {
273 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
275 $fields = array(
276 'page_id',
277 'page_namespace',
278 'page_title',
279 'page_restrictions',
280 'page_is_redirect',
281 'page_is_new',
282 'page_random',
283 'page_touched',
284 'page_links_updated',
285 'page_latest',
286 'page_len',
289 if ( $wgContentHandlerUseDB ) {
290 $fields[] = 'page_content_model';
293 if ( $wgPageLanguageUseDB ) {
294 $fields[] = 'page_lang';
297 return $fields;
301 * Fetch a page record with the given conditions
302 * @param IDatabase $dbr
303 * @param array $conditions
304 * @param array $options
305 * @return object|bool Database result resource, or false on failure
307 protected function pageData( $dbr, $conditions, $options = array() ) {
308 $fields = self::selectFields();
310 Hooks::run( 'ArticlePageDataBefore', array( &$this, &$fields ) );
312 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__, $options );
314 Hooks::run( 'ArticlePageDataAfter', array( &$this, &$row ) );
316 return $row;
320 * Fetch a page record matching the Title object's namespace and title
321 * using a sanitized title string
323 * @param IDatabase $dbr
324 * @param Title $title
325 * @param array $options
326 * @return object|bool Database result resource, or false on failure
328 public function pageDataFromTitle( $dbr, $title, $options = array() ) {
329 return $this->pageData( $dbr, array(
330 'page_namespace' => $title->getNamespace(),
331 'page_title' => $title->getDBkey() ), $options );
335 * Fetch a page record matching the requested ID
337 * @param IDatabase $dbr
338 * @param int $id
339 * @param array $options
340 * @return object|bool Database result resource, or false on failure
342 public function pageDataFromId( $dbr, $id, $options = array() ) {
343 return $this->pageData( $dbr, array( 'page_id' => $id ), $options );
347 * Load the object from a given source by title
349 * @param object|string|int $from One of the following:
350 * - A DB query result object.
351 * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB.
352 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
353 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
354 * using SELECT FOR UPDATE.
356 * @return void
358 public function loadPageData( $from = 'fromdb' ) {
359 $from = self::convertSelectType( $from );
360 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom ) {
361 // We already have the data from the correct location, no need to load it twice.
362 return;
365 if ( is_int( $from ) ) {
366 list( $index, $opts ) = DBAccessObjectUtils::getDBOptions( $from );
367 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle, $opts );
369 if ( !$data
370 && $index == DB_SLAVE
371 && wfGetLB()->getServerCount() > 1
372 && wfGetLB()->hasOrMadeRecentMasterChanges()
374 $from = self::READ_LATEST;
375 list( $index, $opts ) = DBAccessObjectUtils::getDBOptions( $from );
376 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle, $opts );
378 } else {
379 // No idea from where the caller got this data, assume slave database.
380 $data = $from;
381 $from = self::READ_NORMAL;
384 $this->loadFromRow( $data, $from );
388 * Load the object from a database row
390 * @since 1.20
391 * @param object|bool $data DB row containing fields returned by selectFields() or false
392 * @param string|int $from One of the following:
393 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB
394 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
395 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
396 * the master DB using SELECT FOR UPDATE
398 public function loadFromRow( $data, $from ) {
399 $lc = LinkCache::singleton();
400 $lc->clearLink( $this->mTitle );
402 if ( $data ) {
403 $lc->addGoodLinkObjFromRow( $this->mTitle, $data );
405 $this->mTitle->loadFromRow( $data );
407 // Old-fashioned restrictions
408 $this->mTitle->loadRestrictions( $data->page_restrictions );
410 $this->mId = intval( $data->page_id );
411 $this->mTouched = wfTimestamp( TS_MW, $data->page_touched );
412 $this->mLinksUpdated = wfTimestampOrNull( TS_MW, $data->page_links_updated );
413 $this->mIsRedirect = intval( $data->page_is_redirect );
414 $this->mLatest = intval( $data->page_latest );
415 // Bug 37225: $latest may no longer match the cached latest Revision object.
416 // Double-check the ID of any cached latest Revision object for consistency.
417 if ( $this->mLastRevision && $this->mLastRevision->getId() != $this->mLatest ) {
418 $this->mLastRevision = null;
419 $this->mTimestamp = '';
421 } else {
422 $lc->addBadLinkObj( $this->mTitle );
424 $this->mTitle->loadFromRow( false );
426 $this->clearCacheFields();
428 $this->mId = 0;
431 $this->mDataLoaded = true;
432 $this->mDataLoadedFrom = self::convertSelectType( $from );
436 * @return int Page ID
438 public function getId() {
439 if ( !$this->mDataLoaded ) {
440 $this->loadPageData();
442 return $this->mId;
446 * @return bool Whether or not the page exists in the database
448 public function exists() {
449 if ( !$this->mDataLoaded ) {
450 $this->loadPageData();
452 return $this->mId > 0;
456 * Check if this page is something we're going to be showing
457 * some sort of sensible content for. If we return false, page
458 * views (plain action=view) will return an HTTP 404 response,
459 * so spiders and robots can know they're following a bad link.
461 * @return bool
463 public function hasViewableContent() {
464 return $this->exists() || $this->mTitle->isAlwaysKnown();
468 * Tests if the article content represents a redirect
470 * @return bool
472 public function isRedirect() {
473 if ( !$this->mDataLoaded ) {
474 $this->loadPageData();
477 return (bool)$this->mIsRedirect;
481 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
483 * Will use the revisions actual content model if the page exists,
484 * and the page's default if the page doesn't exist yet.
486 * @return string
488 * @since 1.21
490 public function getContentModel() {
491 if ( $this->exists() ) {
492 // look at the revision's actual content model
493 $rev = $this->getRevision();
495 if ( $rev !== null ) {
496 return $rev->getContentModel();
497 } else {
498 $title = $this->mTitle->getPrefixedDBkey();
499 wfWarn( "Page $title exists but has no (visible) revisions!" );
503 // use the default model for this page
504 return $this->mTitle->getContentModel();
508 * Loads page_touched and returns a value indicating if it should be used
509 * @return bool True if not a redirect
511 public function checkTouched() {
512 if ( !$this->mDataLoaded ) {
513 $this->loadPageData();
515 return !$this->mIsRedirect;
519 * Get the page_touched field
520 * @return string Containing GMT timestamp
522 public function getTouched() {
523 if ( !$this->mDataLoaded ) {
524 $this->loadPageData();
526 return $this->mTouched;
530 * Get the page_links_updated field
531 * @return string|null Containing GMT timestamp
533 public function getLinksTimestamp() {
534 if ( !$this->mDataLoaded ) {
535 $this->loadPageData();
537 return $this->mLinksUpdated;
541 * Get the page_latest field
542 * @return int The rev_id of current revision
544 public function getLatest() {
545 if ( !$this->mDataLoaded ) {
546 $this->loadPageData();
548 return (int)$this->mLatest;
552 * Get the Revision object of the oldest revision
553 * @return Revision|null
555 public function getOldestRevision() {
557 // Try using the slave database first, then try the master
558 $continue = 2;
559 $db = wfGetDB( DB_SLAVE );
560 $revSelectFields = Revision::selectFields();
562 $row = null;
563 while ( $continue ) {
564 $row = $db->selectRow(
565 array( 'page', 'revision' ),
566 $revSelectFields,
567 array(
568 'page_namespace' => $this->mTitle->getNamespace(),
569 'page_title' => $this->mTitle->getDBkey(),
570 'rev_page = page_id'
572 __METHOD__,
573 array(
574 'ORDER BY' => 'rev_timestamp ASC'
578 if ( $row ) {
579 $continue = 0;
580 } else {
581 $db = wfGetDB( DB_MASTER );
582 $continue--;
586 return $row ? Revision::newFromRow( $row ) : null;
590 * Loads everything except the text
591 * This isn't necessary for all uses, so it's only done if needed.
593 protected function loadLastEdit() {
594 if ( $this->mLastRevision !== null ) {
595 return; // already loaded
598 $latest = $this->getLatest();
599 if ( !$latest ) {
600 return; // page doesn't exist or is missing page_latest info
603 if ( $this->mDataLoadedFrom == self::READ_LOCKING ) {
604 // Bug 37225: if session S1 loads the page row FOR UPDATE, the result always
605 // includes the latest changes committed. This is true even within REPEATABLE-READ
606 // transactions, where S1 normally only sees changes committed before the first S1
607 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
608 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
609 // happened after the first S1 SELECT.
610 // http://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read
611 $flags = Revision::READ_LOCKING;
612 } elseif ( $this->mDataLoadedFrom == self::READ_LATEST ) {
613 // Bug T93976: if page_latest was loaded from the master, fetch the
614 // revision from there as well, as it may not exist yet on a slave DB.
615 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
616 $flags = Revision::READ_LATEST;
617 } else {
618 $flags = 0;
620 $revision = Revision::newFromPageId( $this->getId(), $latest, $flags );
621 if ( $revision ) { // sanity
622 $this->setLastEdit( $revision );
627 * Set the latest revision
628 * @param Revision $revision
630 protected function setLastEdit( Revision $revision ) {
631 $this->mLastRevision = $revision;
632 $this->mTimestamp = $revision->getTimestamp();
636 * Get the latest revision
637 * @return Revision|null
639 public function getRevision() {
640 $this->loadLastEdit();
641 if ( $this->mLastRevision ) {
642 return $this->mLastRevision;
644 return null;
648 * Get the content of the current revision. No side-effects...
650 * @param int $audience One of:
651 * Revision::FOR_PUBLIC to be displayed to all users
652 * Revision::FOR_THIS_USER to be displayed to $wgUser
653 * Revision::RAW get the text regardless of permissions
654 * @param User $user User object to check for, only if FOR_THIS_USER is passed
655 * to the $audience parameter
656 * @return Content|null The content of the current revision
658 * @since 1.21
660 public function getContent( $audience = Revision::FOR_PUBLIC, User $user = null ) {
661 $this->loadLastEdit();
662 if ( $this->mLastRevision ) {
663 return $this->mLastRevision->getContent( $audience, $user );
665 return null;
669 * Get the text of the current revision. No side-effects...
671 * @param int $audience One of:
672 * Revision::FOR_PUBLIC to be displayed to all users
673 * Revision::FOR_THIS_USER to be displayed to the given user
674 * Revision::RAW get the text regardless of permissions
675 * @param User $user User object to check for, only if FOR_THIS_USER is passed
676 * to the $audience parameter
677 * @return string|bool The text of the current revision
678 * @deprecated since 1.21, getContent() should be used instead.
680 public function getText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
681 ContentHandler::deprecated( __METHOD__, '1.21' );
683 $this->loadLastEdit();
684 if ( $this->mLastRevision ) {
685 return $this->mLastRevision->getText( $audience, $user );
687 return false;
691 * Get the text of the current revision. No side-effects...
693 * @return string|bool The text of the current revision. False on failure
694 * @deprecated since 1.21, getContent() should be used instead.
696 public function getRawText() {
697 ContentHandler::deprecated( __METHOD__, '1.21' );
699 return $this->getText( Revision::RAW );
703 * @return string MW timestamp of last article revision
705 public function getTimestamp() {
706 // Check if the field has been filled by WikiPage::setTimestamp()
707 if ( !$this->mTimestamp ) {
708 $this->loadLastEdit();
711 return wfTimestamp( TS_MW, $this->mTimestamp );
715 * Set the page timestamp (use only to avoid DB queries)
716 * @param string $ts MW timestamp of last article revision
717 * @return void
719 public function setTimestamp( $ts ) {
720 $this->mTimestamp = wfTimestamp( TS_MW, $ts );
724 * @param int $audience One of:
725 * Revision::FOR_PUBLIC to be displayed to all users
726 * Revision::FOR_THIS_USER to be displayed to the given user
727 * Revision::RAW get the text regardless of permissions
728 * @param User $user User object to check for, only if FOR_THIS_USER is passed
729 * to the $audience parameter
730 * @return int User ID for the user that made the last article revision
732 public function getUser( $audience = Revision::FOR_PUBLIC, User $user = null ) {
733 $this->loadLastEdit();
734 if ( $this->mLastRevision ) {
735 return $this->mLastRevision->getUser( $audience, $user );
736 } else {
737 return -1;
742 * Get the User object of the user who created the page
743 * @param int $audience One of:
744 * Revision::FOR_PUBLIC to be displayed to all users
745 * Revision::FOR_THIS_USER to be displayed to the given user
746 * Revision::RAW get the text regardless of permissions
747 * @param User $user User object to check for, only if FOR_THIS_USER is passed
748 * to the $audience parameter
749 * @return User|null
751 public function getCreator( $audience = Revision::FOR_PUBLIC, User $user = null ) {
752 $revision = $this->getOldestRevision();
753 if ( $revision ) {
754 $userName = $revision->getUserText( $audience, $user );
755 return User::newFromName( $userName, false );
756 } else {
757 return null;
762 * @param int $audience One of:
763 * Revision::FOR_PUBLIC to be displayed to all users
764 * Revision::FOR_THIS_USER to be displayed to the given user
765 * Revision::RAW get the text regardless of permissions
766 * @param User $user User object to check for, only if FOR_THIS_USER is passed
767 * to the $audience parameter
768 * @return string Username of the user that made the last article revision
770 public function getUserText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
771 $this->loadLastEdit();
772 if ( $this->mLastRevision ) {
773 return $this->mLastRevision->getUserText( $audience, $user );
774 } else {
775 return '';
780 * @param int $audience One of:
781 * Revision::FOR_PUBLIC to be displayed to all users
782 * Revision::FOR_THIS_USER to be displayed to the given user
783 * Revision::RAW get the text regardless of permissions
784 * @param User $user User object to check for, only if FOR_THIS_USER is passed
785 * to the $audience parameter
786 * @return string Comment stored for the last article revision
788 public function getComment( $audience = Revision::FOR_PUBLIC, User $user = null ) {
789 $this->loadLastEdit();
790 if ( $this->mLastRevision ) {
791 return $this->mLastRevision->getComment( $audience, $user );
792 } else {
793 return '';
798 * Returns true if last revision was marked as "minor edit"
800 * @return bool Minor edit indicator for the last article revision.
802 public function getMinorEdit() {
803 $this->loadLastEdit();
804 if ( $this->mLastRevision ) {
805 return $this->mLastRevision->isMinor();
806 } else {
807 return false;
812 * Determine whether a page would be suitable for being counted as an
813 * article in the site_stats table based on the title & its content
815 * @param object|bool $editInfo (false): object returned by prepareTextForEdit(),
816 * if false, the current database state will be used
817 * @return bool
819 public function isCountable( $editInfo = false ) {
820 global $wgArticleCountMethod;
822 if ( !$this->mTitle->isContentPage() ) {
823 return false;
826 if ( $editInfo ) {
827 $content = $editInfo->pstContent;
828 } else {
829 $content = $this->getContent();
832 if ( !$content || $content->isRedirect() ) {
833 return false;
836 $hasLinks = null;
838 if ( $wgArticleCountMethod === 'link' ) {
839 // nasty special case to avoid re-parsing to detect links
841 if ( $editInfo ) {
842 // ParserOutput::getLinks() is a 2D array of page links, so
843 // to be really correct we would need to recurse in the array
844 // but the main array should only have items in it if there are
845 // links.
846 $hasLinks = (bool)count( $editInfo->output->getLinks() );
847 } else {
848 $hasLinks = (bool)wfGetDB( DB_SLAVE )->selectField( 'pagelinks', 1,
849 array( 'pl_from' => $this->getId() ), __METHOD__ );
853 return $content->isCountable( $hasLinks );
857 * If this page is a redirect, get its target
859 * The target will be fetched from the redirect table if possible.
860 * If this page doesn't have an entry there, call insertRedirect()
861 * @return Title|null Title object, or null if this page is not a redirect
863 public function getRedirectTarget() {
864 if ( !$this->mTitle->isRedirect() ) {
865 return null;
868 if ( $this->mRedirectTarget !== null ) {
869 return $this->mRedirectTarget;
872 // Query the redirect table
873 $dbr = wfGetDB( DB_SLAVE );
874 $row = $dbr->selectRow( 'redirect',
875 array( 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ),
876 array( 'rd_from' => $this->getId() ),
877 __METHOD__
880 // rd_fragment and rd_interwiki were added later, populate them if empty
881 if ( $row && !is_null( $row->rd_fragment ) && !is_null( $row->rd_interwiki ) ) {
882 $this->mRedirectTarget = Title::makeTitle(
883 $row->rd_namespace, $row->rd_title,
884 $row->rd_fragment, $row->rd_interwiki
886 return $this->mRedirectTarget;
889 // This page doesn't have an entry in the redirect table
890 $this->mRedirectTarget = $this->insertRedirect();
891 return $this->mRedirectTarget;
895 * Insert an entry for this page into the redirect table if the content is a redirect
897 * The database update will be deferred via DeferredUpdates
899 * Don't call this function directly unless you know what you're doing.
900 * @return Title|null Title object or null if not a redirect
902 public function insertRedirect() {
903 $content = $this->getContent();
904 $retval = $content ? $content->getUltimateRedirectTarget() : null;
905 if ( !$retval ) {
906 return null;
909 // Update the DB post-send if the page has not cached since now
910 $that = $this;
911 $latest = $this->getLatest();
912 DeferredUpdates::addCallableUpdate( function() use ( $that, $retval, $latest ) {
913 $that->insertRedirectEntry( $retval, $latest );
914 } );
916 return $retval;
920 * Insert or update the redirect table entry for this page to indicate it redirects to $rt
921 * @param Title $rt Redirect target
922 * @param int|null $oldLatest Prior page_latest for check and set
924 public function insertRedirectEntry( Title $rt, $oldLatest = null ) {
925 $dbw = wfGetDB( DB_MASTER );
926 $dbw->startAtomic( __METHOD__ );
928 if ( !$oldLatest || $oldLatest == $this->lockAndGetLatest() ) {
929 $dbw->replace( 'redirect',
930 array( 'rd_from' ),
931 array(
932 'rd_from' => $this->getId(),
933 'rd_namespace' => $rt->getNamespace(),
934 'rd_title' => $rt->getDBkey(),
935 'rd_fragment' => $rt->getFragment(),
936 'rd_interwiki' => $rt->getInterwiki(),
938 __METHOD__
942 $dbw->endAtomic( __METHOD__ );
946 * Get the Title object or URL this page redirects to
948 * @return bool|Title|string False, Title of in-wiki target, or string with URL
950 public function followRedirect() {
951 return $this->getRedirectURL( $this->getRedirectTarget() );
955 * Get the Title object or URL to use for a redirect. We use Title
956 * objects for same-wiki, non-special redirects and URLs for everything
957 * else.
958 * @param Title $rt Redirect target
959 * @return bool|Title|string False, Title object of local target, or string with URL
961 public function getRedirectURL( $rt ) {
962 if ( !$rt ) {
963 return false;
966 if ( $rt->isExternal() ) {
967 if ( $rt->isLocal() ) {
968 // Offsite wikis need an HTTP redirect.
969 // This can be hard to reverse and may produce loops,
970 // so they may be disabled in the site configuration.
971 $source = $this->mTitle->getFullURL( 'redirect=no' );
972 return $rt->getFullURL( array( 'rdfrom' => $source ) );
973 } else {
974 // External pages without "local" bit set are not valid
975 // redirect targets
976 return false;
980 if ( $rt->isSpecialPage() ) {
981 // Gotta handle redirects to special pages differently:
982 // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
983 // Some pages are not valid targets.
984 if ( $rt->isValidRedirectTarget() ) {
985 return $rt->getFullURL();
986 } else {
987 return false;
991 return $rt;
995 * Get a list of users who have edited this article, not including the user who made
996 * the most recent revision, which you can get from $article->getUser() if you want it
997 * @return UserArrayFromResult
999 public function getContributors() {
1000 // @todo FIXME: This is expensive; cache this info somewhere.
1002 $dbr = wfGetDB( DB_SLAVE );
1004 if ( $dbr->implicitGroupby() ) {
1005 $realNameField = 'user_real_name';
1006 } else {
1007 $realNameField = 'MIN(user_real_name) AS user_real_name';
1010 $tables = array( 'revision', 'user' );
1012 $fields = array(
1013 'user_id' => 'rev_user',
1014 'user_name' => 'rev_user_text',
1015 $realNameField,
1016 'timestamp' => 'MAX(rev_timestamp)',
1019 $conds = array( 'rev_page' => $this->getId() );
1021 // The user who made the top revision gets credited as "this page was last edited by
1022 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1023 $user = $this->getUser();
1024 if ( $user ) {
1025 $conds[] = "rev_user != $user";
1026 } else {
1027 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1030 // Username hidden?
1031 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1033 $jconds = array(
1034 'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
1037 $options = array(
1038 'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
1039 'ORDER BY' => 'timestamp DESC',
1042 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $jconds );
1043 return new UserArrayFromResult( $res );
1047 * Should the parser cache be used?
1049 * @param ParserOptions $parserOptions ParserOptions to check
1050 * @param int $oldId
1051 * @return bool
1053 public function shouldCheckParserCache( ParserOptions $parserOptions, $oldId ) {
1054 return $parserOptions->getStubThreshold() == 0
1055 && $this->exists()
1056 && ( $oldId === null || $oldId === 0 || $oldId === $this->getLatest() )
1057 && $this->getContentHandler()->isParserCacheSupported();
1061 * Get a ParserOutput for the given ParserOptions and revision ID.
1063 * The parser cache will be used if possible. Cache misses that result
1064 * in parser runs are debounced with PoolCounter.
1066 * @since 1.19
1067 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1068 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1069 * get the current revision (default value)
1071 * @return ParserOutput|bool ParserOutput or false if the revision was not found
1073 public function getParserOutput( ParserOptions $parserOptions, $oldid = null ) {
1075 $useParserCache = $this->shouldCheckParserCache( $parserOptions, $oldid );
1076 wfDebug( __METHOD__ .
1077 ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
1078 if ( $parserOptions->getStubThreshold() ) {
1079 wfIncrStats( 'pcache.miss.stub' );
1082 if ( $useParserCache ) {
1083 $parserOutput = ParserCache::singleton()->get( $this, $parserOptions );
1084 if ( $parserOutput !== false ) {
1085 return $parserOutput;
1089 if ( $oldid === null || $oldid === 0 ) {
1090 $oldid = $this->getLatest();
1093 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1094 $pool->execute();
1096 return $pool->getParserOutput();
1100 * Do standard deferred updates after page view (existing or missing page)
1101 * @param User $user The relevant user
1102 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1104 public function doViewUpdates( User $user, $oldid = 0 ) {
1105 if ( wfReadOnly() ) {
1106 return;
1109 Hooks::run( 'PageViewUpdates', array( $this, $user ) );
1110 // Update newtalk / watchlist notification status
1111 try {
1112 $user->clearNotification( $this->mTitle, $oldid );
1113 } catch ( DBError $e ) {
1114 // Avoid outage if the master is not reachable
1115 MWExceptionHandler::logException( $e );
1120 * Perform the actions of a page purging
1121 * @return bool
1123 public function doPurge() {
1124 if ( !Hooks::run( 'ArticlePurge', array( &$this ) ) ) {
1125 return false;
1128 $title = $this->mTitle;
1129 wfGetDB( DB_MASTER )->onTransactionIdle( function() use ( $title ) {
1130 // Invalidate the cache in auto-commit mode
1131 $title->invalidateCache();
1132 } );
1134 // Send purge after above page_touched update was committed
1135 DeferredUpdates::addUpdate(
1136 new CdnCacheUpdate( $title->getCdnUrls() ),
1137 DeferredUpdates::PRESEND
1140 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1141 // @todo move this logic to MessageCache
1142 if ( $this->exists() ) {
1143 // NOTE: use transclusion text for messages.
1144 // This is consistent with MessageCache::getMsgFromNamespace()
1146 $content = $this->getContent();
1147 $text = $content === null ? null : $content->getWikitextForTransclusion();
1149 if ( $text === null ) {
1150 $text = false;
1152 } else {
1153 $text = false;
1156 MessageCache::singleton()->replace( $this->mTitle->getDBkey(), $text );
1159 return true;
1162 * Insert a new empty page record for this article.
1163 * This *must* be followed up by creating a revision
1164 * and running $this->updateRevisionOn( ... );
1165 * or else the record will be left in a funky state.
1166 * Best if all done inside a transaction.
1168 * @param IDatabase $dbw
1169 * @return int|bool The newly created page_id key; false if the title already existed
1171 public function insertOn( $dbw ) {
1172 $dbw->insert(
1173 'page',
1174 array(
1175 'page_id' => $dbw->nextSequenceValue( 'page_page_id_seq' ),
1176 'page_namespace' => $this->mTitle->getNamespace(),
1177 'page_title' => $this->mTitle->getDBkey(),
1178 'page_restrictions' => '',
1179 'page_is_redirect' => 0, // Will set this shortly...
1180 'page_is_new' => 1,
1181 'page_random' => wfRandom(),
1182 'page_touched' => $dbw->timestamp(),
1183 'page_latest' => 0, // Fill this in shortly...
1184 'page_len' => 0, // Fill this in shortly...
1186 __METHOD__,
1187 'IGNORE'
1190 if ( $dbw->affectedRows() > 0 ) {
1191 $newid = $dbw->insertId();
1192 $this->mId = $newid;
1193 $this->mTitle->resetArticleID( $newid );
1195 return $newid;
1196 } else {
1197 return false; // nothing changed
1202 * Update the page record to point to a newly saved revision.
1204 * @param IDatabase $dbw
1205 * @param Revision $revision For ID number, and text used to set
1206 * length and redirect status fields
1207 * @param int $lastRevision If given, will not overwrite the page field
1208 * when different from the currently set value.
1209 * Giving 0 indicates the new page flag should be set on.
1210 * @param bool $lastRevIsRedirect If given, will optimize adding and
1211 * removing rows in redirect table.
1212 * @return bool Success; false if the page row was missing or page_latest changed
1214 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1215 $lastRevIsRedirect = null
1217 global $wgContentHandlerUseDB;
1219 // Assertion to try to catch T92046
1220 if ( (int)$revision->getId() === 0 ) {
1221 throw new InvalidArgumentException(
1222 __METHOD__ . ': Revision has ID ' . var_export( $revision->getId(), 1 )
1226 $content = $revision->getContent();
1227 $len = $content ? $content->getSize() : 0;
1228 $rt = $content ? $content->getUltimateRedirectTarget() : null;
1230 $conditions = array( 'page_id' => $this->getId() );
1232 if ( !is_null( $lastRevision ) ) {
1233 // An extra check against threads stepping on each other
1234 $conditions['page_latest'] = $lastRevision;
1237 $row = array( /* SET */
1238 'page_latest' => $revision->getId(),
1239 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1240 'page_is_new' => ( $lastRevision === 0 ) ? 1 : 0,
1241 'page_is_redirect' => $rt !== null ? 1 : 0,
1242 'page_len' => $len,
1245 if ( $wgContentHandlerUseDB ) {
1246 $row['page_content_model'] = $revision->getContentModel();
1249 $dbw->update( 'page',
1250 $row,
1251 $conditions,
1252 __METHOD__ );
1254 $result = $dbw->affectedRows() > 0;
1255 if ( $result ) {
1256 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1257 $this->setLastEdit( $revision );
1258 $this->mLatest = $revision->getId();
1259 $this->mIsRedirect = (bool)$rt;
1260 // Update the LinkCache.
1261 LinkCache::singleton()->addGoodLinkObj(
1262 $this->getId(),
1263 $this->mTitle,
1264 $len,
1265 $this->mIsRedirect,
1266 $this->mLatest,
1267 $revision->getContentModel()
1271 return $result;
1275 * Add row to the redirect table if this is a redirect, remove otherwise.
1277 * @param IDatabase $dbw
1278 * @param Title $redirectTitle Title object pointing to the redirect target,
1279 * or NULL if this is not a redirect
1280 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1281 * removing rows in redirect table.
1282 * @return bool True on success, false on failure
1283 * @private
1285 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1286 // Always update redirects (target link might have changed)
1287 // Update/Insert if we don't know if the last revision was a redirect or not
1288 // Delete if changing from redirect to non-redirect
1289 $isRedirect = !is_null( $redirectTitle );
1291 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1292 return true;
1295 if ( $isRedirect ) {
1296 $this->insertRedirectEntry( $redirectTitle );
1297 } else {
1298 // This is not a redirect, remove row from redirect table
1299 $where = array( 'rd_from' => $this->getId() );
1300 $dbw->delete( 'redirect', $where, __METHOD__ );
1303 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1304 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1307 return ( $dbw->affectedRows() != 0 );
1311 * If the given revision is newer than the currently set page_latest,
1312 * update the page record. Otherwise, do nothing.
1314 * @deprecated since 1.24, use updateRevisionOn instead
1316 * @param IDatabase $dbw
1317 * @param Revision $revision
1318 * @return bool
1320 public function updateIfNewerOn( $dbw, $revision ) {
1322 $row = $dbw->selectRow(
1323 array( 'revision', 'page' ),
1324 array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1325 array(
1326 'page_id' => $this->getId(),
1327 'page_latest=rev_id' ),
1328 __METHOD__ );
1330 if ( $row ) {
1331 if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1332 return false;
1334 $prev = $row->rev_id;
1335 $lastRevIsRedirect = (bool)$row->page_is_redirect;
1336 } else {
1337 // No or missing previous revision; mark the page as new
1338 $prev = 0;
1339 $lastRevIsRedirect = null;
1342 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1344 return $ret;
1348 * Get the content that needs to be saved in order to undo all revisions
1349 * between $undo and $undoafter. Revisions must belong to the same page,
1350 * must exist and must not be deleted
1351 * @param Revision $undo
1352 * @param Revision $undoafter Must be an earlier revision than $undo
1353 * @return Content|bool Content on success, false on failure
1354 * @since 1.21
1355 * Before we had the Content object, this was done in getUndoText
1357 public function getUndoContent( Revision $undo, Revision $undoafter = null ) {
1358 $handler = $undo->getContentHandler();
1359 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1363 * Get the text that needs to be saved in order to undo all revisions
1364 * between $undo and $undoafter. Revisions must belong to the same page,
1365 * must exist and must not be deleted
1366 * @param Revision $undo
1367 * @param Revision $undoafter Must be an earlier revision than $undo
1368 * @return string|bool String on success, false on failure
1369 * @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
1371 public function getUndoText( Revision $undo, Revision $undoafter = null ) {
1372 ContentHandler::deprecated( __METHOD__, '1.21' );
1374 $this->loadLastEdit();
1376 if ( $this->mLastRevision ) {
1377 if ( is_null( $undoafter ) ) {
1378 $undoafter = $undo->getPrevious();
1381 $handler = $this->getContentHandler();
1382 $undone = $handler->getUndoContent( $this->mLastRevision, $undo, $undoafter );
1384 if ( !$undone ) {
1385 return false;
1386 } else {
1387 return ContentHandler::getContentText( $undone );
1391 return false;
1395 * @param string|number|null|bool $sectionId Section identifier as a number or string
1396 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1397 * or 'new' for a new section.
1398 * @param string $text New text of the section.
1399 * @param string $sectionTitle New section's subject, only if $section is "new".
1400 * @param string $edittime Revision timestamp or null to use the current revision.
1402 * @throws MWException
1403 * @return string|null New complete article text, or null if error.
1405 * @deprecated since 1.21, use replaceSectionAtRev() instead
1407 public function replaceSection( $sectionId, $text, $sectionTitle = '',
1408 $edittime = null
1410 ContentHandler::deprecated( __METHOD__, '1.21' );
1412 // NOTE: keep condition in sync with condition in replaceSectionContent!
1413 if ( strval( $sectionId ) === '' ) {
1414 // Whole-page edit; let the whole text through
1415 return $text;
1418 if ( !$this->supportsSections() ) {
1419 throw new MWException( "sections not supported for content model " .
1420 $this->getContentHandler()->getModelID() );
1423 // could even make section title, but that's not required.
1424 $sectionContent = ContentHandler::makeContent( $text, $this->getTitle() );
1426 $newContent = $this->replaceSectionContent( $sectionId, $sectionContent, $sectionTitle,
1427 $edittime );
1429 return ContentHandler::getContentText( $newContent );
1433 * Returns true if this page's content model supports sections.
1435 * @return bool
1437 * @todo The skin should check this and not offer section functionality if
1438 * sections are not supported.
1439 * @todo The EditPage should check this and not offer section functionality
1440 * if sections are not supported.
1442 public function supportsSections() {
1443 return $this->getContentHandler()->supportsSections();
1447 * @param string|number|null|bool $sectionId Section identifier as a number or string
1448 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1449 * or 'new' for a new section.
1450 * @param Content $sectionContent New content of the section.
1451 * @param string $sectionTitle New section's subject, only if $section is "new".
1452 * @param string $edittime Revision timestamp or null to use the current revision.
1454 * @throws MWException
1455 * @return Content|null New complete article content, or null if error.
1457 * @since 1.21
1458 * @deprecated since 1.24, use replaceSectionAtRev instead
1460 public function replaceSectionContent(
1461 $sectionId, Content $sectionContent, $sectionTitle = '', $edittime = null
1464 $baseRevId = null;
1465 if ( $edittime && $sectionId !== 'new' ) {
1466 $dbr = wfGetDB( DB_SLAVE );
1467 $rev = Revision::loadFromTimestamp( $dbr, $this->mTitle, $edittime );
1468 // Try the master if this thread may have just added it.
1469 // This could be abstracted into a Revision method, but we don't want
1470 // to encourage loading of revisions by timestamp.
1471 if ( !$rev
1472 && wfGetLB()->getServerCount() > 1
1473 && wfGetLB()->hasOrMadeRecentMasterChanges()
1475 $dbw = wfGetDB( DB_MASTER );
1476 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1478 if ( $rev ) {
1479 $baseRevId = $rev->getId();
1483 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1487 * @param string|number|null|bool $sectionId Section identifier as a number or string
1488 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1489 * or 'new' for a new section.
1490 * @param Content $sectionContent New content of the section.
1491 * @param string $sectionTitle New section's subject, only if $section is "new".
1492 * @param int|null $baseRevId
1494 * @throws MWException
1495 * @return Content|null New complete article content, or null if error.
1497 * @since 1.24
1499 public function replaceSectionAtRev( $sectionId, Content $sectionContent,
1500 $sectionTitle = '', $baseRevId = null
1503 if ( strval( $sectionId ) === '' ) {
1504 // Whole-page edit; let the whole text through
1505 $newContent = $sectionContent;
1506 } else {
1507 if ( !$this->supportsSections() ) {
1508 throw new MWException( "sections not supported for content model " .
1509 $this->getContentHandler()->getModelID() );
1512 // Bug 30711: always use current version when adding a new section
1513 if ( is_null( $baseRevId ) || $sectionId === 'new' ) {
1514 $oldContent = $this->getContent();
1515 } else {
1516 $rev = Revision::newFromId( $baseRevId );
1517 if ( !$rev ) {
1518 wfDebug( __METHOD__ . " asked for bogus section (page: " .
1519 $this->getId() . "; section: $sectionId)\n" );
1520 return null;
1523 $oldContent = $rev->getContent();
1526 if ( !$oldContent ) {
1527 wfDebug( __METHOD__ . ": no page text\n" );
1528 return null;
1531 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1534 return $newContent;
1538 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1539 * @param int $flags
1540 * @return int Updated $flags
1542 public function checkFlags( $flags ) {
1543 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
1544 if ( $this->exists() ) {
1545 $flags |= EDIT_UPDATE;
1546 } else {
1547 $flags |= EDIT_NEW;
1551 return $flags;
1555 * Change an existing article or create a new article. Updates RC and all necessary caches,
1556 * optionally via the deferred update array.
1558 * @param string $text New text
1559 * @param string $summary Edit summary
1560 * @param int $flags Bitfield:
1561 * EDIT_NEW
1562 * Article is known or assumed to be non-existent, create a new one
1563 * EDIT_UPDATE
1564 * Article is known or assumed to be pre-existing, update it
1565 * EDIT_MINOR
1566 * Mark this edit minor, if the user is allowed to do so
1567 * EDIT_SUPPRESS_RC
1568 * Do not log the change in recentchanges
1569 * EDIT_FORCE_BOT
1570 * Mark the edit a "bot" edit regardless of user rights
1571 * EDIT_AUTOSUMMARY
1572 * Fill in blank summaries with generated text where possible
1574 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1575 * article will be detected. If EDIT_UPDATE is specified and the article
1576 * doesn't exist, the function will return an edit-gone-missing error. If
1577 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1578 * error will be returned. These two conditions are also possible with
1579 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1581 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1582 * This is not the parent revision ID, rather the revision ID for older
1583 * content used as the source for a rollback, for example.
1584 * @param User $user The user doing the edit
1586 * @throws MWException
1587 * @return Status Possible errors:
1588 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1589 * set the fatal flag of $status
1590 * edit-gone-missing: In update mode, but the article didn't exist.
1591 * edit-conflict: In update mode, the article changed unexpectedly.
1592 * edit-no-change: Warning that the text was the same as before.
1593 * edit-already-exists: In creation mode, but the article already exists.
1595 * Extensions may define additional errors.
1597 * $return->value will contain an associative array with members as follows:
1598 * new: Boolean indicating if the function attempted to create a new article.
1599 * revision: The revision object for the inserted revision, or null.
1601 * Compatibility note: this function previously returned a boolean value
1602 * indicating success/failure
1604 * @deprecated since 1.21: use doEditContent() instead.
1606 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1607 ContentHandler::deprecated( __METHOD__, '1.21' );
1609 $content = ContentHandler::makeContent( $text, $this->getTitle() );
1611 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1615 * Change an existing article or create a new article. Updates RC and all necessary caches,
1616 * optionally via the deferred update array.
1618 * @param Content $content New content
1619 * @param string $summary Edit summary
1620 * @param int $flags Bitfield:
1621 * EDIT_NEW
1622 * Article is known or assumed to be non-existent, create a new one
1623 * EDIT_UPDATE
1624 * Article is known or assumed to be pre-existing, update it
1625 * EDIT_MINOR
1626 * Mark this edit minor, if the user is allowed to do so
1627 * EDIT_SUPPRESS_RC
1628 * Do not log the change in recentchanges
1629 * EDIT_FORCE_BOT
1630 * Mark the edit a "bot" edit regardless of user rights
1631 * EDIT_AUTOSUMMARY
1632 * Fill in blank summaries with generated text where possible
1634 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1635 * article will be detected. If EDIT_UPDATE is specified and the article
1636 * doesn't exist, the function will return an edit-gone-missing error. If
1637 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1638 * error will be returned. These two conditions are also possible with
1639 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1641 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1642 * This is not the parent revision ID, rather the revision ID for older
1643 * content used as the source for a rollback, for example.
1644 * @param User $user The user doing the edit
1645 * @param string $serialFormat Format for storing the content in the
1646 * database.
1648 * @throws MWException
1649 * @return Status Possible errors:
1650 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1651 * set the fatal flag of $status.
1652 * edit-gone-missing: In update mode, but the article didn't exist.
1653 * edit-conflict: In update mode, the article changed unexpectedly.
1654 * edit-no-change: Warning that the text was the same as before.
1655 * edit-already-exists: In creation mode, but the article already exists.
1657 * Extensions may define additional errors.
1659 * $return->value will contain an associative array with members as follows:
1660 * new: Boolean indicating if the function attempted to create a new article.
1661 * revision: The revision object for the inserted revision, or null.
1663 * @since 1.21
1664 * @throws MWException
1666 public function doEditContent(
1667 Content $content, $summary, $flags = 0, $baseRevId = false,
1668 User $user = null, $serialFormat = null
1670 global $wgUser, $wgUseAutomaticEditSummaries;
1672 // Low-level sanity check
1673 if ( $this->mTitle->getText() === '' ) {
1674 throw new MWException( 'Something is trying to edit an article with an empty title' );
1676 // Make sure the given content type is allowed for this page
1677 if ( !$content->getContentHandler()->canBeUsedOn( $this->mTitle ) ) {
1678 return Status::newFatal( 'content-not-allowed-here',
1679 ContentHandler::getLocalizedName( $content->getModel() ),
1680 $this->mTitle->getPrefixedText()
1684 // Load the data from the master database if needed.
1685 // The caller may already loaded it from the master or even loaded it using
1686 // SELECT FOR UPDATE, so do not override that using clear().
1687 $this->loadPageData( 'fromdbmaster' );
1689 $user = $user ?: $wgUser;
1690 $flags = $this->checkFlags( $flags );
1692 // Trigger pre-save hook (using provided edit summary)
1693 $hookStatus = Status::newGood( array() );
1694 $hook_args = array( &$this, &$user, &$content, &$summary,
1695 $flags & EDIT_MINOR, null, null, &$flags, &$hookStatus );
1696 // Check if the hook rejected the attempted save
1697 if ( !Hooks::run( 'PageContentSave', $hook_args )
1698 || !ContentHandler::runLegacyHooks( 'ArticleSave', $hook_args )
1700 if ( $hookStatus->isOK() ) {
1701 // Hook returned false but didn't call fatal(); use generic message
1702 $hookStatus->fatal( 'edit-hook-aborted' );
1705 return $hookStatus;
1708 $old_revision = $this->getRevision(); // current revision
1709 $old_content = $this->getContent( Revision::RAW ); // current revision's content
1711 // Provide autosummaries if one is not provided and autosummaries are enabled
1712 if ( $wgUseAutomaticEditSummaries && ( $flags & EDIT_AUTOSUMMARY ) && $summary == '' ) {
1713 $handler = $content->getContentHandler();
1714 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1717 // Get the pre-save transform content and final parser output
1718 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat );
1719 $pstContent = $editInfo->pstContent; // Content object
1720 $meta = array(
1721 'bot' => ( $flags & EDIT_FORCE_BOT ),
1722 'minor' => ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' ),
1723 'serialized' => $editInfo->pst,
1724 'serialFormat' => $serialFormat,
1725 'baseRevId' => $baseRevId,
1726 'oldRevision' => $old_revision,
1727 'oldContent' => $old_content,
1728 'oldId' => $this->getLatest(),
1729 'oldIsRedirect' => $this->isRedirect(),
1730 'oldCountable' => $this->isCountable()
1733 // Actually create the revision and create/update the page
1734 if ( $flags & EDIT_UPDATE ) {
1735 $status = $this->doModify( $pstContent, $flags, $user, $summary, $meta );
1736 } else {
1737 $status = $this->doCreate( $pstContent, $flags, $user, $summary, $meta );
1740 // Promote user to any groups they meet the criteria for
1741 DeferredUpdates::addCallableUpdate( function () use ( $user ) {
1742 $user->addAutopromoteOnceGroups( 'onEdit' );
1743 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1744 } );
1746 return $status;
1750 * @param Content $content Pre-save transform content
1751 * @param integer $flags
1752 * @param User $user
1753 * @param string $summary
1754 * @param array $meta
1755 * @return Status
1756 * @throws DBUnexpectedError
1757 * @throws Exception
1758 * @throws FatalError
1759 * @throws MWException
1761 private function doModify(
1762 Content $content, $flags, User $user, $summary, array $meta
1764 global $wgUseRCPatrol;
1766 // Update article, but only if changed.
1767 $status = Status::newGood( array( 'new' => false, 'revision' => null ) );
1769 // Convenience variables
1770 $now = wfTimestampNow();
1771 $oldid = $meta['oldId'];
1772 /** @var $oldContent Content|null */
1773 $oldContent = $meta['oldContent'];
1774 $newsize = $content->getSize();
1776 if ( !$oldid ) {
1777 // Article gone missing
1778 $status->fatal( 'edit-gone-missing' );
1780 return $status;
1781 } elseif ( !$oldContent ) {
1782 // Sanity check for bug 37225
1783 throw new MWException( "Could not find text for current revision {$oldid}." );
1786 // @TODO: pass content object?!
1787 $revision = new Revision( array(
1788 'page' => $this->getId(),
1789 'title' => $this->mTitle, // for determining the default content model
1790 'comment' => $summary,
1791 'minor_edit' => $meta['minor'],
1792 'text' => $meta['serialized'],
1793 'len' => $newsize,
1794 'parent_id' => $oldid,
1795 'user' => $user->getId(),
1796 'user_text' => $user->getName(),
1797 'timestamp' => $now,
1798 'content_model' => $content->getModel(),
1799 'content_format' => $meta['serialFormat'],
1800 ) );
1802 $changed = !$content->equals( $oldContent );
1804 if ( $changed ) {
1805 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1806 $status->merge( $prepStatus );
1807 if ( !$status->isOK() ) {
1808 return $status;
1811 $dbw = wfGetDB( DB_MASTER );
1812 $dbw->begin( __METHOD__ );
1813 // Get the latest page_latest value while locking it.
1814 // Do a CAS style check to see if it's the same as when this method
1815 // started. If it changed then bail out before touching the DB.
1816 $latestNow = $this->lockAndGetLatest();
1817 if ( $latestNow != $oldid ) {
1818 $dbw->commit( __METHOD__ );
1819 // Page updated or deleted in the mean time
1820 $status->fatal( 'edit-conflict' );
1822 return $status;
1825 // At this point we are now comitted to returning an OK
1826 // status unless some DB query error or other exception comes up.
1827 // This way callers don't have to call rollback() if $status is bad
1828 // unless they actually try to catch exceptions (which is rare).
1830 // Save the revision text
1831 $revisionId = $revision->insertOn( $dbw );
1832 // Update page_latest and friends to reflect the new revision
1833 if ( !$this->updateRevisionOn( $dbw, $revision, null, $meta['oldIsRedirect'] ) ) {
1834 $dbw->rollback( __METHOD__ );
1835 throw new MWException( "Failed to update page row to use new revision." );
1838 Hooks::run( 'NewRevisionFromEditComplete',
1839 array( $this, $revision, $meta['baseRevId'], $user ) );
1841 // Update recentchanges
1842 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1843 // Mark as patrolled if the user can do so
1844 $patrolled = $wgUseRCPatrol && !count(
1845 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1846 // Add RC row to the DB
1847 RecentChange::notifyEdit(
1848 $now,
1849 $this->mTitle,
1850 $revision->isMinor(),
1851 $user,
1852 $summary,
1853 $oldid,
1854 $this->getTimestamp(),
1855 $meta['bot'],
1857 $oldContent ? $oldContent->getSize() : 0,
1858 $newsize,
1859 $revisionId,
1860 $patrolled
1864 $user->incEditCount();
1866 $dbw->commit( __METHOD__ );
1867 $this->mTimestamp = $now;
1868 } else {
1869 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1870 // related variables correctly
1871 $revision->setId( $this->getLatest() );
1874 // Update links tables, site stats, etc.
1875 $this->doEditUpdates(
1876 $revision,
1877 $user,
1878 array(
1879 'changed' => $changed,
1880 'oldcountable' => $meta['oldCountable'],
1881 'oldrevision' => $meta['oldRevision']
1885 if ( $changed ) {
1886 // Return the new revision to the caller
1887 $status->value['revision'] = $revision;
1888 } else {
1889 $status->warning( 'edit-no-change' );
1890 // Update page_touched as updateRevisionOn() was not called.
1891 // Other cache updates are managed in onArticleEdit() via doEditUpdates().
1892 $this->mTitle->invalidateCache( $now );
1895 // Trigger post-save hook
1896 $hook_args = array( &$this, &$user, $content, $summary,
1897 $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $meta['baseRevId'] );
1898 ContentHandler::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
1899 Hooks::run( 'PageContentSaveComplete', $hook_args );
1901 return $status;
1905 * @param Content $content Pre-save transform content
1906 * @param integer $flags
1907 * @param User $user
1908 * @param string $summary
1909 * @param array $meta
1910 * @return Status
1911 * @throws DBUnexpectedError
1912 * @throws Exception
1913 * @throws FatalError
1914 * @throws MWException
1916 private function doCreate(
1917 Content $content, $flags, User $user, $summary, array $meta
1919 global $wgUseRCPatrol, $wgUseNPPatrol;
1921 $status = Status::newGood( array( 'new' => true, 'revision' => null ) );
1923 $now = wfTimestampNow();
1924 $newsize = $content->getSize();
1925 $prepStatus = $content->prepareSave( $this, $flags, $meta['oldId'], $user );
1926 $status->merge( $prepStatus );
1927 if ( !$status->isOK() ) {
1928 return $status;
1931 $dbw = wfGetDB( DB_MASTER );
1932 $dbw->begin( __METHOD__ );
1934 // Add the page record unless one already exists for the title
1935 $newid = $this->insertOn( $dbw );
1936 if ( $newid === false ) {
1937 $dbw->commit( __METHOD__ ); // nothing inserted
1938 $status->fatal( 'edit-already-exists' );
1940 return $status; // nothing done
1943 // At this point we are now comitted to returning an OK
1944 // status unless some DB query error or other exception comes up.
1945 // This way callers don't have to call rollback() if $status is bad
1946 // unless they actually try to catch exceptions (which is rare).
1948 // @TODO: pass content object?!
1949 $revision = new Revision( array(
1950 'page' => $newid,
1951 'title' => $this->mTitle, // for determining the default content model
1952 'comment' => $summary,
1953 'minor_edit' => $meta['minor'],
1954 'text' => $meta['serialized'],
1955 'len' => $newsize,
1956 'user' => $user->getId(),
1957 'user_text' => $user->getName(),
1958 'timestamp' => $now,
1959 'content_model' => $content->getModel(),
1960 'content_format' => $meta['serialFormat'],
1961 ) );
1963 // Save the revision text...
1964 $revisionId = $revision->insertOn( $dbw );
1965 // Update the page record with revision data
1966 if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1967 $dbw->rollback( __METHOD__ );
1968 throw new MWException( "Failed to update page row to use new revision." );
1971 Hooks::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1973 // Update recentchanges
1974 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1975 // Mark as patrolled if the user can do so
1976 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) &&
1977 !count( $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1978 // Add RC row to the DB
1979 RecentChange::notifyNew(
1980 $now,
1981 $this->mTitle,
1982 $revision->isMinor(),
1983 $user,
1984 $summary,
1985 $meta['bot'],
1987 $newsize,
1988 $revisionId,
1989 $patrolled
1993 $user->incEditCount();
1995 $dbw->commit( __METHOD__ );
1996 $this->mTimestamp = $now;
1998 // Update links, etc.
1999 $this->doEditUpdates( $revision, $user, array( 'created' => true ) );
2001 $hook_args = array( &$this, &$user, $content, $summary,
2002 $flags & EDIT_MINOR, null, null, &$flags, $revision );
2003 ContentHandler::runLegacyHooks( 'ArticleInsertComplete', $hook_args );
2004 Hooks::run( 'PageContentInsertComplete', $hook_args );
2006 // Return the new revision to the caller
2007 $status->value['revision'] = $revision;
2009 // Trigger post-save hook
2010 $hook_args = array( &$this, &$user, $content, $summary,
2011 $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $meta['baseRevId'] );
2012 ContentHandler::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
2013 Hooks::run( 'PageContentSaveComplete', $hook_args );
2015 return $status;
2019 * Get parser options suitable for rendering the primary article wikitext
2021 * @see ContentHandler::makeParserOptions
2023 * @param IContextSource|User|string $context One of the following:
2024 * - IContextSource: Use the User and the Language of the provided
2025 * context
2026 * - User: Use the provided User object and $wgLang for the language,
2027 * so use an IContextSource object if possible.
2028 * - 'canonical': Canonical options (anonymous user with default
2029 * preferences and content language).
2030 * @return ParserOptions
2032 public function makeParserOptions( $context ) {
2033 $options = $this->getContentHandler()->makeParserOptions( $context );
2035 if ( $this->getTitle()->isConversionTable() ) {
2036 // @todo ConversionTable should become a separate content model, so
2037 // we don't need special cases like this one.
2038 $options->disableContentConversion();
2041 return $options;
2045 * Prepare text which is about to be saved.
2046 * Returns a stdClass with source, pst and output members
2048 * @param string $text
2049 * @param int|null $revid
2050 * @param User|null $user
2051 * @deprecated since 1.21: use prepareContentForEdit instead.
2052 * @return object
2054 public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
2055 ContentHandler::deprecated( __METHOD__, '1.21' );
2056 $content = ContentHandler::makeContent( $text, $this->getTitle() );
2057 return $this->prepareContentForEdit( $content, $revid, $user );
2061 * Prepare content which is about to be saved.
2062 * Returns a stdClass with source, pst and output members
2064 * @param Content $content
2065 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2066 * revision ID is also accepted, but this is deprecated.
2067 * @param User|null $user
2068 * @param string|null $serialFormat
2069 * @param bool $useCache Check shared prepared edit cache
2071 * @return object
2073 * @since 1.21
2075 public function prepareContentForEdit(
2076 Content $content, $revision = null, User $user = null,
2077 $serialFormat = null, $useCache = true
2079 global $wgContLang, $wgUser, $wgAjaxEditStash;
2081 if ( is_object( $revision ) ) {
2082 $revid = $revision->getId();
2083 } else {
2084 $revid = $revision;
2085 // This code path is deprecated, and nothing is known to
2086 // use it, so performance here shouldn't be a worry.
2087 if ( $revid !== null ) {
2088 $revision = Revision::newFromId( $revid, Revision::READ_LATEST );
2089 } else {
2090 $revision = null;
2094 $user = is_null( $user ) ? $wgUser : $user;
2095 // XXX: check $user->getId() here???
2097 // Use a sane default for $serialFormat, see bug 57026
2098 if ( $serialFormat === null ) {
2099 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2102 if ( $this->mPreparedEdit
2103 && $this->mPreparedEdit->newContent
2104 && $this->mPreparedEdit->newContent->equals( $content )
2105 && $this->mPreparedEdit->revid == $revid
2106 && $this->mPreparedEdit->format == $serialFormat
2107 // XXX: also check $user here?
2109 // Already prepared
2110 return $this->mPreparedEdit;
2113 // The edit may have already been prepared via api.php?action=stashedit
2114 $cachedEdit = $useCache && $wgAjaxEditStash
2115 ? ApiStashEdit::checkCache( $this->getTitle(), $content, $user )
2116 : false;
2118 $popts = ParserOptions::newFromUserAndLang( $user, $wgContLang );
2119 Hooks::run( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2121 $edit = (object)array();
2122 if ( $cachedEdit ) {
2123 $edit->timestamp = $cachedEdit->timestamp;
2124 } else {
2125 $edit->timestamp = wfTimestampNow();
2127 // @note: $cachedEdit is not used if the rev ID was referenced in the text
2128 $edit->revid = $revid;
2130 if ( $cachedEdit ) {
2131 $edit->pstContent = $cachedEdit->pstContent;
2132 } else {
2133 $edit->pstContent = $content
2134 ? $content->preSaveTransform( $this->mTitle, $user, $popts )
2135 : null;
2138 $edit->format = $serialFormat;
2139 $edit->popts = $this->makeParserOptions( 'canonical' );
2140 if ( $cachedEdit ) {
2141 $edit->output = $cachedEdit->output;
2142 } else {
2143 if ( $revision ) {
2144 // We get here if vary-revision is set. This means that this page references
2145 // itself (such as via self-transclusion). In this case, we need to make sure
2146 // that any such self-references refer to the newly-saved revision, and not
2147 // to the previous one, which could otherwise happen due to slave lag.
2148 $oldCallback = $edit->popts->getCurrentRevisionCallback();
2149 $edit->popts->setCurrentRevisionCallback(
2150 function ( Title $title, $parser = false ) use ( $revision, &$oldCallback ) {
2151 if ( $title->equals( $revision->getTitle() ) ) {
2152 return $revision;
2153 } else {
2154 return call_user_func( $oldCallback, $title, $parser );
2159 $edit->output = $edit->pstContent
2160 ? $edit->pstContent->getParserOutput( $this->mTitle, $revid, $edit->popts )
2161 : null;
2164 $edit->newContent = $content;
2165 $edit->oldContent = $this->getContent( Revision::RAW );
2167 // NOTE: B/C for hooks! don't use these fields!
2168 $edit->newText = $edit->newContent
2169 ? ContentHandler::getContentText( $edit->newContent )
2170 : '';
2171 $edit->oldText = $edit->oldContent
2172 ? ContentHandler::getContentText( $edit->oldContent )
2173 : '';
2174 $edit->pst = $edit->pstContent ? $edit->pstContent->serialize( $serialFormat ) : '';
2176 $this->mPreparedEdit = $edit;
2177 return $edit;
2181 * Do standard deferred updates after page edit.
2182 * Update links tables, site stats, search index and message cache.
2183 * Purges pages that include this page if the text was changed here.
2184 * Every 100th edit, prune the recent changes table.
2186 * @param Revision $revision
2187 * @param User $user User object that did the revision
2188 * @param array $options Array of options, following indexes are used:
2189 * - changed: boolean, whether the revision changed the content (default true)
2190 * - created: boolean, whether the revision created the page (default false)
2191 * - moved: boolean, whether the page was moved (default false)
2192 * - restored: boolean, whether the page was undeleted (default false)
2193 * - oldrevision: Revision object for the pre-update revision (default null)
2194 * - oldcountable: boolean, null, or string 'no-change' (default null):
2195 * - boolean: whether the page was counted as an article before that
2196 * revision, only used in changed is true and created is false
2197 * - null: if created is false, don't update the article count; if created
2198 * is true, do update the article count
2199 * - 'no-change': don't update the article count, ever
2201 public function doEditUpdates( Revision $revision, User $user, array $options = array() ) {
2202 global $wgRCWatchCategoryMembership;
2204 $options += array(
2205 'changed' => true,
2206 'created' => false,
2207 'moved' => false,
2208 'restored' => false,
2209 'oldrevision' => null,
2210 'oldcountable' => null
2212 $content = $revision->getContent();
2214 // Parse the text
2215 // Be careful not to do pre-save transform twice: $text is usually
2216 // already pre-save transformed once.
2217 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
2218 wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
2219 $editInfo = $this->prepareContentForEdit( $content, $revision, $user );
2220 } else {
2221 wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
2222 $editInfo = $this->mPreparedEdit;
2225 // Save it to the parser cache.
2226 // Make sure the cache time matches page_touched to avoid double parsing.
2227 ParserCache::singleton()->save(
2228 $editInfo->output, $this, $editInfo->popts,
2229 $revision->getTimestamp(), $editInfo->revid
2232 // Update the links tables and other secondary data
2233 if ( $content ) {
2234 $recursive = $options['changed']; // bug 50785
2235 $updates = $content->getSecondaryDataUpdates(
2236 $this->getTitle(), null, $recursive, $editInfo->output
2238 foreach ( $updates as $update ) {
2239 if ( $update instanceof LinksUpdate ) {
2240 $update->setRevision( $revision );
2241 $update->setTriggeringUser( $user );
2243 DeferredUpdates::addUpdate( $update );
2245 if ( $wgRCWatchCategoryMembership
2246 && ( $options['changed'] || $options['created'] )
2247 && !$options['restored']
2249 // Note: jobs are pushed after deferred updates, so the job should be able to see
2250 // the recent change entry (also done via deferred updates) and carry over any
2251 // bot/deletion/IP flags, ect.
2252 JobQueueGroup::singleton()->lazyPush( new CategoryMembershipChangeJob(
2253 $this->getTitle(),
2254 array(
2255 'pageId' => $this->getId(),
2256 'revTimestamp' => $revision->getTimestamp()
2258 ) );
2262 Hooks::run( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2264 if ( Hooks::run( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2265 // Flush old entries from the `recentchanges` table
2266 if ( mt_rand( 0, 9 ) == 0 ) {
2267 JobQueueGroup::singleton()->lazyPush( RecentChangesUpdateJob::newPurgeJob() );
2271 if ( !$this->exists() ) {
2272 return;
2275 $id = $this->getId();
2276 $title = $this->mTitle->getPrefixedDBkey();
2277 $shortTitle = $this->mTitle->getDBkey();
2279 if ( $options['oldcountable'] === 'no-change' ||
2280 ( !$options['changed'] && !$options['moved'] )
2282 $good = 0;
2283 } elseif ( $options['created'] ) {
2284 $good = (int)$this->isCountable( $editInfo );
2285 } elseif ( $options['oldcountable'] !== null ) {
2286 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2287 } else {
2288 $good = 0;
2290 $edits = $options['changed'] ? 1 : 0;
2291 $total = $options['created'] ? 1 : 0;
2293 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2294 DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $content ) );
2296 // If this is another user's talk page, update newtalk.
2297 // Don't do this if $options['changed'] = false (null-edits) nor if
2298 // it's a minor edit and the user doesn't want notifications for those.
2299 if ( $options['changed']
2300 && $this->mTitle->getNamespace() == NS_USER_TALK
2301 && $shortTitle != $user->getTitleKey()
2302 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2304 $recipient = User::newFromName( $shortTitle, false );
2305 if ( !$recipient ) {
2306 wfDebug( __METHOD__ . ": invalid username\n" );
2307 } else {
2308 // Allow extensions to prevent user notification
2309 // when a new message is added to their talk page
2310 if ( Hooks::run( 'ArticleEditUpdateNewTalk', array( &$this, $recipient ) ) ) {
2311 if ( User::isIP( $shortTitle ) ) {
2312 // An anonymous user
2313 $recipient->setNewtalk( true, $revision );
2314 } elseif ( $recipient->isLoggedIn() ) {
2315 $recipient->setNewtalk( true, $revision );
2316 } else {
2317 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
2323 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
2324 // XXX: could skip pseudo-messages like js/css here, based on content model.
2325 $msgtext = $content ? $content->getWikitextForTransclusion() : null;
2326 if ( $msgtext === false || $msgtext === null ) {
2327 $msgtext = '';
2330 MessageCache::singleton()->replace( $shortTitle, $msgtext );
2333 if ( $options['created'] ) {
2334 self::onArticleCreate( $this->mTitle );
2335 } elseif ( $options['changed'] ) { // bug 50785
2336 self::onArticleEdit( $this->mTitle, $revision );
2341 * Edit an article without doing all that other stuff
2342 * The article must already exist; link tables etc
2343 * are not updated, caches are not flushed.
2345 * @param Content $content Content submitted
2346 * @param User $user The relevant user
2347 * @param string $comment Comment submitted
2348 * @param bool $minor Whereas it's a minor modification
2349 * @param string $serialFormat Format for storing the content in the database
2351 public function doQuickEditContent(
2352 Content $content, User $user, $comment = '', $minor = false, $serialFormat = null
2355 $serialized = $content->serialize( $serialFormat );
2357 $dbw = wfGetDB( DB_MASTER );
2358 $revision = new Revision( array(
2359 'title' => $this->getTitle(), // for determining the default content model
2360 'page' => $this->getId(),
2361 'user_text' => $user->getName(),
2362 'user' => $user->getId(),
2363 'text' => $serialized,
2364 'length' => $content->getSize(),
2365 'comment' => $comment,
2366 'minor_edit' => $minor ? 1 : 0,
2367 ) ); // XXX: set the content object?
2368 $revision->insertOn( $dbw );
2369 $this->updateRevisionOn( $dbw, $revision );
2371 Hooks::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2376 * Update the article's restriction field, and leave a log entry.
2377 * This works for protection both existing and non-existing pages.
2379 * @param array $limit Set of restriction keys
2380 * @param array $expiry Per restriction type expiration
2381 * @param int &$cascade Set to false if cascading protection isn't allowed.
2382 * @param string $reason
2383 * @param User $user The user updating the restrictions
2384 * @return Status
2386 public function doUpdateRestrictions( array $limit, array $expiry,
2387 &$cascade, $reason, User $user
2389 global $wgCascadingRestrictionLevels, $wgContLang;
2391 if ( wfReadOnly() ) {
2392 return Status::newFatal( 'readonlytext', wfReadOnlyReason() );
2395 $this->loadPageData( 'fromdbmaster' );
2396 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2397 $id = $this->getId();
2399 if ( !$cascade ) {
2400 $cascade = false;
2403 // Take this opportunity to purge out expired restrictions
2404 Title::purgeExpiredRestrictions();
2406 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2407 // we expect a single selection, but the schema allows otherwise.
2408 $isProtected = false;
2409 $protect = false;
2410 $changed = false;
2412 $dbw = wfGetDB( DB_MASTER );
2414 foreach ( $restrictionTypes as $action ) {
2415 if ( !isset( $expiry[$action] ) || $expiry[$action] === $dbw->getInfinity() ) {
2416 $expiry[$action] = 'infinity';
2418 if ( !isset( $limit[$action] ) ) {
2419 $limit[$action] = '';
2420 } elseif ( $limit[$action] != '' ) {
2421 $protect = true;
2424 // Get current restrictions on $action
2425 $current = implode( '', $this->mTitle->getRestrictions( $action ) );
2426 if ( $current != '' ) {
2427 $isProtected = true;
2430 if ( $limit[$action] != $current ) {
2431 $changed = true;
2432 } elseif ( $limit[$action] != '' ) {
2433 // Only check expiry change if the action is actually being
2434 // protected, since expiry does nothing on an not-protected
2435 // action.
2436 if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2437 $changed = true;
2442 if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
2443 $changed = true;
2446 // If nothing has changed, do nothing
2447 if ( !$changed ) {
2448 return Status::newGood();
2451 if ( !$protect ) { // No protection at all means unprotection
2452 $revCommentMsg = 'unprotectedarticle';
2453 $logAction = 'unprotect';
2454 } elseif ( $isProtected ) {
2455 $revCommentMsg = 'modifiedarticleprotection';
2456 $logAction = 'modify';
2457 } else {
2458 $revCommentMsg = 'protectedarticle';
2459 $logAction = 'protect';
2462 // Truncate for whole multibyte characters
2463 $reason = $wgContLang->truncate( $reason, 255 );
2465 $logRelationsValues = array();
2466 $logRelationsField = null;
2467 $logParamsDetails = array();
2469 if ( $id ) { // Protection of existing page
2470 if ( !Hooks::run( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
2471 return Status::newGood();
2474 // Only certain restrictions can cascade...
2475 $editrestriction = isset( $limit['edit'] )
2476 ? array( $limit['edit'] )
2477 : $this->mTitle->getRestrictions( 'edit' );
2478 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2479 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2481 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2482 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2485 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2486 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2487 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2489 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2490 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2493 // The schema allows multiple restrictions
2494 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2495 $cascade = false;
2498 // insert null revision to identify the page protection change as edit summary
2499 $latest = $this->getLatest();
2500 $nullRevision = $this->insertProtectNullRevision(
2501 $revCommentMsg,
2502 $limit,
2503 $expiry,
2504 $cascade,
2505 $reason,
2506 $user
2509 if ( $nullRevision === null ) {
2510 return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() );
2513 $logRelationsField = 'pr_id';
2515 // Update restrictions table
2516 foreach ( $limit as $action => $restrictions ) {
2517 $dbw->delete(
2518 'page_restrictions',
2519 array(
2520 'pr_page' => $id,
2521 'pr_type' => $action
2523 __METHOD__
2525 if ( $restrictions != '' ) {
2526 $cascadeValue = ( $cascade && $action == 'edit' ) ? 1 : 0;
2527 $dbw->insert(
2528 'page_restrictions',
2529 array(
2530 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2531 'pr_page' => $id,
2532 'pr_type' => $action,
2533 'pr_level' => $restrictions,
2534 'pr_cascade' => $cascadeValue,
2535 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2537 __METHOD__
2539 $logRelationsValues[] = $dbw->insertId();
2540 $logParamsDetails[] = array(
2541 'type' => $action,
2542 'level' => $restrictions,
2543 'expiry' => $expiry[$action],
2544 'cascade' => (bool)$cascadeValue,
2549 // Clear out legacy restriction fields
2550 $dbw->update(
2551 'page',
2552 array( 'page_restrictions' => '' ),
2553 array( 'page_id' => $id ),
2554 __METHOD__
2557 Hooks::run( 'NewRevisionFromEditComplete',
2558 array( $this, $nullRevision, $latest, $user ) );
2559 Hooks::run( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2560 } else { // Protection of non-existing page (also known as "title protection")
2561 // Cascade protection is meaningless in this case
2562 $cascade = false;
2564 if ( $limit['create'] != '' ) {
2565 $dbw->replace( 'protected_titles',
2566 array( array( 'pt_namespace', 'pt_title' ) ),
2567 array(
2568 'pt_namespace' => $this->mTitle->getNamespace(),
2569 'pt_title' => $this->mTitle->getDBkey(),
2570 'pt_create_perm' => $limit['create'],
2571 'pt_timestamp' => $dbw->timestamp(),
2572 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2573 'pt_user' => $user->getId(),
2574 'pt_reason' => $reason,
2575 ), __METHOD__
2577 $logParamsDetails[] = array(
2578 'type' => 'create',
2579 'level' => $limit['create'],
2580 'expiry' => $expiry['create'],
2582 } else {
2583 $dbw->delete( 'protected_titles',
2584 array(
2585 'pt_namespace' => $this->mTitle->getNamespace(),
2586 'pt_title' => $this->mTitle->getDBkey()
2587 ), __METHOD__
2592 $this->mTitle->flushRestrictions();
2593 InfoAction::invalidateCache( $this->mTitle );
2595 if ( $logAction == 'unprotect' ) {
2596 $params = array();
2597 } else {
2598 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2599 $params = array(
2600 '4::description' => $protectDescriptionLog, // parameter for IRC
2601 '5:bool:cascade' => $cascade,
2602 'details' => $logParamsDetails, // parameter for localize and api
2606 // Update the protection log
2607 $logEntry = new ManualLogEntry( 'protect', $logAction );
2608 $logEntry->setTarget( $this->mTitle );
2609 $logEntry->setComment( $reason );
2610 $logEntry->setPerformer( $user );
2611 $logEntry->setParameters( $params );
2612 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2613 $logEntry->setRelations( array( $logRelationsField => $logRelationsValues ) );
2615 $logId = $logEntry->insert();
2616 $logEntry->publish( $logId );
2618 return Status::newGood();
2622 * Insert a new null revision for this page.
2624 * @param string $revCommentMsg Comment message key for the revision
2625 * @param array $limit Set of restriction keys
2626 * @param array $expiry Per restriction type expiration
2627 * @param int $cascade Set to false if cascading protection isn't allowed.
2628 * @param string $reason
2629 * @param User|null $user
2630 * @return Revision|null Null on error
2632 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2633 array $expiry, $cascade, $reason, $user = null
2635 global $wgContLang;
2636 $dbw = wfGetDB( DB_MASTER );
2638 // Prepare a null revision to be added to the history
2639 $editComment = $wgContLang->ucfirst(
2640 wfMessage(
2641 $revCommentMsg,
2642 $this->mTitle->getPrefixedText()
2643 )->inContentLanguage()->text()
2645 if ( $reason ) {
2646 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2648 $protectDescription = $this->protectDescription( $limit, $expiry );
2649 if ( $protectDescription ) {
2650 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2651 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2652 ->inContentLanguage()->text();
2654 if ( $cascade ) {
2655 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2656 $editComment .= wfMessage( 'brackets' )->params(
2657 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2658 )->inContentLanguage()->text();
2661 $nullRev = Revision::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2662 if ( $nullRev ) {
2663 $nullRev->insertOn( $dbw );
2665 // Update page record and touch page
2666 $oldLatest = $nullRev->getParentId();
2667 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2670 return $nullRev;
2674 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2675 * @return string
2677 protected function formatExpiry( $expiry ) {
2678 global $wgContLang;
2680 if ( $expiry != 'infinity' ) {
2681 return wfMessage(
2682 'protect-expiring',
2683 $wgContLang->timeanddate( $expiry, false, false ),
2684 $wgContLang->date( $expiry, false, false ),
2685 $wgContLang->time( $expiry, false, false )
2686 )->inContentLanguage()->text();
2687 } else {
2688 return wfMessage( 'protect-expiry-indefinite' )
2689 ->inContentLanguage()->text();
2694 * Builds the description to serve as comment for the edit.
2696 * @param array $limit Set of restriction keys
2697 * @param array $expiry Per restriction type expiration
2698 * @return string
2700 public function protectDescription( array $limit, array $expiry ) {
2701 $protectDescription = '';
2703 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2704 # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2705 # All possible message keys are listed here for easier grepping:
2706 # * restriction-create
2707 # * restriction-edit
2708 # * restriction-move
2709 # * restriction-upload
2710 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2711 # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2712 # with '' filtered out. All possible message keys are listed below:
2713 # * protect-level-autoconfirmed
2714 # * protect-level-sysop
2715 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2716 ->inContentLanguage()->text();
2718 $expiryText = $this->formatExpiry( $expiry[$action] );
2720 if ( $protectDescription !== '' ) {
2721 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2723 $protectDescription .= wfMessage( 'protect-summary-desc' )
2724 ->params( $actionText, $restrictionsText, $expiryText )
2725 ->inContentLanguage()->text();
2728 return $protectDescription;
2732 * Builds the description to serve as comment for the log entry.
2734 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2735 * protect description text. Keep them in old format to avoid breaking compatibility.
2736 * TODO: Fix protection log to store structured description and format it on-the-fly.
2738 * @param array $limit Set of restriction keys
2739 * @param array $expiry Per restriction type expiration
2740 * @return string
2742 public function protectDescriptionLog( array $limit, array $expiry ) {
2743 global $wgContLang;
2745 $protectDescriptionLog = '';
2747 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2748 $expiryText = $this->formatExpiry( $expiry[$action] );
2749 $protectDescriptionLog .= $wgContLang->getDirMark() .
2750 "[$action=$restrictions] ($expiryText)";
2753 return trim( $protectDescriptionLog );
2757 * Take an array of page restrictions and flatten it to a string
2758 * suitable for insertion into the page_restrictions field.
2760 * @param string[] $limit
2762 * @throws MWException
2763 * @return string
2765 protected static function flattenRestrictions( $limit ) {
2766 if ( !is_array( $limit ) ) {
2767 throw new MWException( __METHOD__ . ' given non-array restriction set' );
2770 $bits = array();
2771 ksort( $limit );
2773 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2774 $bits[] = "$action=$restrictions";
2777 return implode( ':', $bits );
2781 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2782 * backwards compatibility, if you care about error reporting you should use
2783 * doDeleteArticleReal() instead.
2785 * Deletes the article with database consistency, writes logs, purges caches
2787 * @param string $reason Delete reason for deletion log
2788 * @param bool $suppress Suppress all revisions and log the deletion in
2789 * the suppression log instead of the deletion log
2790 * @param int $u1 Unused
2791 * @param bool $u2 Unused
2792 * @param array|string &$error Array of errors to append to
2793 * @param User $user The deleting user
2794 * @return bool True if successful
2796 public function doDeleteArticle(
2797 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $user = null
2799 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2800 return $status->isGood();
2804 * Back-end article deletion
2805 * Deletes the article with database consistency, writes logs, purges caches
2807 * @since 1.19
2809 * @param string $reason Delete reason for deletion log
2810 * @param bool $suppress Suppress all revisions and log the deletion in
2811 * the suppression log instead of the deletion log
2812 * @param int $u1 Unused
2813 * @param bool $u2 Unused
2814 * @param array|string &$error Array of errors to append to
2815 * @param User $user The deleting user
2816 * @return Status Status object; if successful, $status->value is the log_id of the
2817 * deletion log entry. If the page couldn't be deleted because it wasn't
2818 * found, $status is a non-fatal 'cannotdelete' error
2820 public function doDeleteArticleReal(
2821 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $user = null
2823 global $wgUser, $wgContentHandlerUseDB;
2825 wfDebug( __METHOD__ . "\n" );
2827 $status = Status::newGood();
2829 if ( $this->mTitle->getDBkey() === '' ) {
2830 $status->error( 'cannotdelete',
2831 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2832 return $status;
2835 $user = is_null( $user ) ? $wgUser : $user;
2836 if ( !Hooks::run( 'ArticleDelete',
2837 array( &$this, &$user, &$reason, &$error, &$status, $suppress )
2838 ) ) {
2839 if ( $status->isOK() ) {
2840 // Hook aborted but didn't set a fatal status
2841 $status->fatal( 'delete-hook-aborted' );
2843 return $status;
2846 $dbw = wfGetDB( DB_MASTER );
2847 $dbw->startAtomic( __METHOD__ );
2849 $this->loadPageData( self::READ_LATEST );
2850 $id = $this->getID();
2851 // T98706: lock the page from various other updates but avoid using
2852 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2853 // the revisions queries (which also JOIN on user). Only lock the page
2854 // row and CAS check on page_latest to see if the trx snapshot matches.
2855 $lockedLatest = $this->lockAndGetLatest();
2856 if ( $id == 0 || $this->getLatest() != $lockedLatest ) {
2857 $dbw->endAtomic( __METHOD__ );
2858 // Page not there or trx snapshot is stale
2859 $status->error( 'cannotdelete',
2860 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2861 return $status;
2864 // At this point we are now comitted to returning an OK
2865 // status unless some DB query error or other exception comes up.
2866 // This way callers don't have to call rollback() if $status is bad
2867 // unless they actually try to catch exceptions (which is rare).
2869 // we need to remember the old content so we can use it to generate all deletion updates.
2870 $content = $this->getContent( Revision::RAW );
2872 // Bitfields to further suppress the content
2873 if ( $suppress ) {
2874 $bitfield = 0;
2875 // This should be 15...
2876 $bitfield |= Revision::DELETED_TEXT;
2877 $bitfield |= Revision::DELETED_COMMENT;
2878 $bitfield |= Revision::DELETED_USER;
2879 $bitfield |= Revision::DELETED_RESTRICTED;
2880 } else {
2881 $bitfield = 'rev_deleted';
2885 * For now, shunt the revision data into the archive table.
2886 * Text is *not* removed from the text table; bulk storage
2887 * is left intact to avoid breaking block-compression or
2888 * immutable storage schemes.
2890 * For backwards compatibility, note that some older archive
2891 * table entries will have ar_text and ar_flags fields still.
2893 * In the future, we may keep revisions and mark them with
2894 * the rev_deleted field, which is reserved for this purpose.
2897 $row = array(
2898 'ar_namespace' => 'page_namespace',
2899 'ar_title' => 'page_title',
2900 'ar_comment' => 'rev_comment',
2901 'ar_user' => 'rev_user',
2902 'ar_user_text' => 'rev_user_text',
2903 'ar_timestamp' => 'rev_timestamp',
2904 'ar_minor_edit' => 'rev_minor_edit',
2905 'ar_rev_id' => 'rev_id',
2906 'ar_parent_id' => 'rev_parent_id',
2907 'ar_text_id' => 'rev_text_id',
2908 'ar_text' => '\'\'', // Be explicit to appease
2909 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2910 'ar_len' => 'rev_len',
2911 'ar_page_id' => 'page_id',
2912 'ar_deleted' => $bitfield,
2913 'ar_sha1' => 'rev_sha1',
2916 if ( $wgContentHandlerUseDB ) {
2917 $row['ar_content_model'] = 'rev_content_model';
2918 $row['ar_content_format'] = 'rev_content_format';
2921 // Copy all the page revisions into the archive table
2922 $dbw->insertSelect(
2923 'archive',
2924 array( 'page', 'revision' ),
2925 $row,
2926 array(
2927 'page_id' => $id,
2928 'page_id = rev_page'
2930 __METHOD__
2933 // Now that it's safely backed up, delete it
2934 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
2936 if ( !$dbw->cascadingDeletes() ) {
2937 $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__ );
2940 // Clone the title, so we have the information we need when we log
2941 $logTitle = clone $this->mTitle;
2943 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2944 $logtype = $suppress ? 'suppress' : 'delete';
2946 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2947 $logEntry->setPerformer( $user );
2948 $logEntry->setTarget( $logTitle );
2949 $logEntry->setComment( $reason );
2950 $logid = $logEntry->insert();
2952 $dbw->onTransactionPreCommitOrIdle( function () use ( $dbw, $logEntry, $logid ) {
2953 // Bug 56776: avoid deadlocks (especially from FileDeleteForm)
2954 $logEntry->publish( $logid );
2955 } );
2957 $dbw->endAtomic( __METHOD__ );
2959 $this->doDeleteUpdates( $id, $content );
2961 Hooks::run( 'ArticleDeleteComplete',
2962 array( &$this, &$user, $reason, $id, $content, $logEntry ) );
2963 $status->value = $logid;
2965 // Show log excerpt on 404 pages rather than just a link
2966 $cache = ObjectCache::getMainStashInstance();
2967 $key = wfMemcKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2968 $cache->set( $key, 1, $cache::TTL_DAY );
2970 return $status;
2974 * Lock the page row for this title+id and return page_latest (or 0)
2976 * @return integer Returns 0 if no row was found with this title+id
2977 * @since 1.27
2979 public function lockAndGetLatest() {
2980 return (int)wfGetDB( DB_MASTER )->selectField(
2981 'page',
2982 'page_latest',
2983 array(
2984 'page_id' => $this->getId(),
2985 // Typically page_id is enough, but some code might try to do
2986 // updates assuming the title is the same, so verify that
2987 'page_namespace' => $this->getTitle()->getNamespace(),
2988 'page_title' => $this->getTitle()->getDBkey()
2990 __METHOD__,
2991 array( 'FOR UPDATE' )
2996 * Do some database updates after deletion
2998 * @param int $id The page_id value of the page being deleted
2999 * @param Content $content Optional page content to be used when determining
3000 * the required updates. This may be needed because $this->getContent()
3001 * may already return null when the page proper was deleted.
3003 public function doDeleteUpdates( $id, Content $content = null ) {
3004 // Update site status
3005 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
3007 // Delete pagelinks, update secondary indexes, etc
3008 $updates = $this->getDeletionUpdates( $content );
3009 foreach ( $updates as $update ) {
3010 DeferredUpdates::addUpdate( $update );
3013 // Reparse any pages transcluding this page
3014 LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'templatelinks' );
3016 // Reparse any pages including this image
3017 if ( $this->mTitle->getNamespace() == NS_FILE ) {
3018 LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'imagelinks' );
3021 // Clear caches
3022 WikiPage::onArticleDelete( $this->mTitle );
3024 // Reset this object and the Title object
3025 $this->loadFromRow( false, self::READ_LATEST );
3027 // Search engine
3028 DeferredUpdates::addUpdate( new SearchUpdate( $id, $this->mTitle ) );
3032 * Roll back the most recent consecutive set of edits to a page
3033 * from the same user; fails if there are no eligible edits to
3034 * roll back to, e.g. user is the sole contributor. This function
3035 * performs permissions checks on $user, then calls commitRollback()
3036 * to do the dirty work
3038 * @todo Separate the business/permission stuff out from backend code
3040 * @param string $fromP Name of the user whose edits to rollback.
3041 * @param string $summary Custom summary. Set to default summary if empty.
3042 * @param string $token Rollback token.
3043 * @param bool $bot If true, mark all reverted edits as bot.
3045 * @param array $resultDetails Array contains result-specific array of additional values
3046 * 'alreadyrolled' : 'current' (rev)
3047 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3049 * @param User $user The user performing the rollback
3050 * @return array Array of errors, each error formatted as
3051 * array(messagekey, param1, param2, ...).
3052 * On success, the array is empty. This array can also be passed to
3053 * OutputPage::showPermissionsErrorPage().
3055 public function doRollback(
3056 $fromP, $summary, $token, $bot, &$resultDetails, User $user
3058 $resultDetails = null;
3060 // Check permissions
3061 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
3062 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
3063 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3065 if ( !$user->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
3066 $errors[] = array( 'sessionfailure' );
3069 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
3070 $errors[] = array( 'actionthrottledtext' );
3073 // If there were errors, bail out now
3074 if ( !empty( $errors ) ) {
3075 return $errors;
3078 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
3082 * Backend implementation of doRollback(), please refer there for parameter
3083 * and return value documentation
3085 * NOTE: This function does NOT check ANY permissions, it just commits the
3086 * rollback to the DB. Therefore, you should only call this function direct-
3087 * ly if you want to use custom permissions checks. If you don't, use
3088 * doRollback() instead.
3089 * @param string $fromP Name of the user whose edits to rollback.
3090 * @param string $summary Custom summary. Set to default summary if empty.
3091 * @param bool $bot If true, mark all reverted edits as bot.
3093 * @param array $resultDetails Contains result-specific array of additional values
3094 * @param User $guser The user performing the rollback
3095 * @return array
3097 public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser ) {
3098 global $wgUseRCPatrol, $wgContLang;
3100 $dbw = wfGetDB( DB_MASTER );
3102 if ( wfReadOnly() ) {
3103 return array( array( 'readonlytext' ) );
3106 // Get the last editor
3107 $current = $this->getRevision();
3108 if ( is_null( $current ) ) {
3109 // Something wrong... no page?
3110 return array( array( 'notanarticle' ) );
3113 $from = str_replace( '_', ' ', $fromP );
3114 // User name given should match up with the top revision.
3115 // If the user was deleted then $from should be empty.
3116 if ( $from != $current->getUserText() ) {
3117 $resultDetails = array( 'current' => $current );
3118 return array( array( 'alreadyrolled',
3119 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3120 htmlspecialchars( $fromP ),
3121 htmlspecialchars( $current->getUserText() )
3122 ) );
3125 // Get the last edit not by this person...
3126 // Note: these may not be public values
3127 $user = intval( $current->getUser( Revision::RAW ) );
3128 $user_text = $dbw->addQuotes( $current->getUserText( Revision::RAW ) );
3129 $s = $dbw->selectRow( 'revision',
3130 array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3131 array( 'rev_page' => $current->getPage(),
3132 "rev_user != {$user} OR rev_user_text != {$user_text}"
3133 ), __METHOD__,
3134 array( 'USE INDEX' => 'page_timestamp',
3135 'ORDER BY' => 'rev_timestamp DESC' )
3137 if ( $s === false ) {
3138 // No one else ever edited this page
3139 return array( array( 'cantrollback' ) );
3140 } elseif ( $s->rev_deleted & Revision::DELETED_TEXT
3141 || $s->rev_deleted & Revision::DELETED_USER
3143 // Only admins can see this text
3144 return array( array( 'notvisiblerev' ) );
3147 // Generate the edit summary if necessary
3148 $target = Revision::newFromId( $s->rev_id, Revision::READ_LATEST );
3149 if ( empty( $summary ) ) {
3150 if ( $from == '' ) { // no public user name
3151 $summary = wfMessage( 'revertpage-nouser' );
3152 } else {
3153 $summary = wfMessage( 'revertpage' );
3157 // Allow the custom summary to use the same args as the default message
3158 $args = array(
3159 $target->getUserText(), $from, $s->rev_id,
3160 $wgContLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
3161 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3163 if ( $summary instanceof Message ) {
3164 $summary = $summary->params( $args )->inContentLanguage()->text();
3165 } else {
3166 $summary = wfMsgReplaceArgs( $summary, $args );
3169 // Trim spaces on user supplied text
3170 $summary = trim( $summary );
3172 // Truncate for whole multibyte characters.
3173 $summary = $wgContLang->truncate( $summary, 255 );
3175 // Save
3176 $flags = EDIT_UPDATE;
3178 if ( $guser->isAllowed( 'minoredit' ) ) {
3179 $flags |= EDIT_MINOR;
3182 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3183 $flags |= EDIT_FORCE_BOT;
3186 // Actually store the edit
3187 $status = $this->doEditContent(
3188 $target->getContent(),
3189 $summary,
3190 $flags,
3191 $target->getId(),
3192 $guser
3195 // Set patrolling and bot flag on the edits, which gets rollbacked.
3196 // This is done even on edit failure to have patrolling in that case (bug 62157).
3197 $set = array();
3198 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3199 // Mark all reverted edits as bot
3200 $set['rc_bot'] = 1;
3203 if ( $wgUseRCPatrol ) {
3204 // Mark all reverted edits as patrolled
3205 $set['rc_patrolled'] = 1;
3208 if ( count( $set ) ) {
3209 $dbw->update( 'recentchanges', $set,
3210 array( /* WHERE */
3211 'rc_cur_id' => $current->getPage(),
3212 'rc_user_text' => $current->getUserText(),
3213 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp ),
3215 __METHOD__
3219 if ( !$status->isOK() ) {
3220 return $status->getErrorsArray();
3223 // raise error, when the edit is an edit without a new version
3224 $statusRev = isset( $status->value['revision'] )
3225 ? $status->value['revision']
3226 : null;
3227 if ( !( $statusRev instanceof Revision ) ) {
3228 $resultDetails = array( 'current' => $current );
3229 return array( array( 'alreadyrolled',
3230 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3231 htmlspecialchars( $fromP ),
3232 htmlspecialchars( $current->getUserText() )
3233 ) );
3236 $revId = $statusRev->getId();
3238 Hooks::run( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
3240 $resultDetails = array(
3241 'summary' => $summary,
3242 'current' => $current,
3243 'target' => $target,
3244 'newid' => $revId
3247 return array();
3251 * The onArticle*() functions are supposed to be a kind of hooks
3252 * which should be called whenever any of the specified actions
3253 * are done.
3255 * This is a good place to put code to clear caches, for instance.
3257 * This is called on page move and undelete, as well as edit
3259 * @param Title $title
3261 public static function onArticleCreate( Title $title ) {
3262 // Update existence markers on article/talk tabs...
3263 $other = $title->getOtherPage();
3265 $other->purgeSquid();
3267 $title->touchLinks();
3268 $title->purgeSquid();
3269 $title->deleteTitleProtection();
3273 * Clears caches when article is deleted
3275 * @param Title $title
3277 public static function onArticleDelete( Title $title ) {
3278 // Update existence markers on article/talk tabs...
3279 $other = $title->getOtherPage();
3281 $other->purgeSquid();
3283 $title->touchLinks();
3284 $title->purgeSquid();
3286 // File cache
3287 HTMLFileCache::clearFileCache( $title );
3288 InfoAction::invalidateCache( $title );
3290 // Messages
3291 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
3292 MessageCache::singleton()->replace( $title->getDBkey(), false );
3295 // Images
3296 if ( $title->getNamespace() == NS_FILE ) {
3297 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $title, 'imagelinks' ) );
3300 // User talk pages
3301 if ( $title->getNamespace() == NS_USER_TALK ) {
3302 $user = User::newFromName( $title->getText(), false );
3303 if ( $user ) {
3304 $user->setNewtalk( false );
3308 // Image redirects
3309 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3313 * Purge caches on page update etc
3315 * @param Title $title
3316 * @param Revision|null $revision Revision that was just saved, may be null
3318 public static function onArticleEdit( Title $title, Revision $revision = null ) {
3319 // Invalidate caches of articles which include this page
3320 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3322 // Invalidate the caches of all pages which redirect here
3323 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $title, 'redirect' ) );
3325 // Purge CDN for this page only
3326 $title->purgeSquid();
3327 // Clear file cache for this page only
3328 HTMLFileCache::clearFileCache( $title );
3330 $revid = $revision ? $revision->getId() : null;
3331 DeferredUpdates::addCallableUpdate( function() use ( $title, $revid ) {
3332 InfoAction::invalidateCache( $title, $revid );
3333 } );
3336 /**#@-*/
3339 * Returns a list of categories this page is a member of.
3340 * Results will include hidden categories
3342 * @return TitleArray
3344 public function getCategories() {
3345 $id = $this->getId();
3346 if ( $id == 0 ) {
3347 return TitleArray::newFromResult( new FakeResultWrapper( array() ) );
3350 $dbr = wfGetDB( DB_SLAVE );
3351 $res = $dbr->select( 'categorylinks',
3352 array( 'cl_to AS page_title, ' . NS_CATEGORY . ' AS page_namespace' ),
3353 // Have to do that since DatabaseBase::fieldNamesWithAlias treats numeric indexes
3354 // as not being aliases, and NS_CATEGORY is numeric
3355 array( 'cl_from' => $id ),
3356 __METHOD__ );
3358 return TitleArray::newFromResult( $res );
3362 * Returns a list of hidden categories this page is a member of.
3363 * Uses the page_props and categorylinks tables.
3365 * @return array Array of Title objects
3367 public function getHiddenCategories() {
3368 $result = array();
3369 $id = $this->getId();
3371 if ( $id == 0 ) {
3372 return array();
3375 $dbr = wfGetDB( DB_SLAVE );
3376 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3377 array( 'cl_to' ),
3378 array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3379 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
3380 __METHOD__ );
3382 if ( $res !== false ) {
3383 foreach ( $res as $row ) {
3384 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
3388 return $result;
3392 * Return an applicable autosummary if one exists for the given edit.
3393 * @param string|null $oldtext The previous text of the page.
3394 * @param string|null $newtext The submitted text of the page.
3395 * @param int $flags Bitmask: a bitmask of flags submitted for the edit.
3396 * @return string An appropriate autosummary, or an empty string.
3398 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3400 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3401 // NOTE: stub for backwards-compatibility. assumes the given text is
3402 // wikitext. will break horribly if it isn't.
3404 ContentHandler::deprecated( __METHOD__, '1.21' );
3406 $handler = ContentHandler::getForModelID( CONTENT_MODEL_WIKITEXT );
3407 $oldContent = is_null( $oldtext ) ? null : $handler->unserializeContent( $oldtext );
3408 $newContent = is_null( $newtext ) ? null : $handler->unserializeContent( $newtext );
3410 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3414 * Auto-generates a deletion reason
3416 * @param bool &$hasHistory Whether the page has a history
3417 * @return string|bool String containing deletion reason or empty string, or boolean false
3418 * if no revision occurred
3420 public function getAutoDeleteReason( &$hasHistory ) {
3421 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3425 * Update all the appropriate counts in the category table, given that
3426 * we've added the categories $added and deleted the categories $deleted.
3428 * @param array $added The names of categories that were added
3429 * @param array $deleted The names of categories that were deleted
3431 public function updateCategoryCounts( array $added, array $deleted ) {
3432 $that = $this;
3433 $method = __METHOD__;
3434 $dbw = wfGetDB( DB_MASTER );
3436 // Do this at the end of the commit to reduce lock wait timeouts
3437 $dbw->onTransactionPreCommitOrIdle(
3438 function () use ( $dbw, $that, $method, $added, $deleted ) {
3439 $ns = $that->getTitle()->getNamespace();
3441 $addFields = array( 'cat_pages = cat_pages + 1' );
3442 $removeFields = array( 'cat_pages = cat_pages - 1' );
3443 if ( $ns == NS_CATEGORY ) {
3444 $addFields[] = 'cat_subcats = cat_subcats + 1';
3445 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3446 } elseif ( $ns == NS_FILE ) {
3447 $addFields[] = 'cat_files = cat_files + 1';
3448 $removeFields[] = 'cat_files = cat_files - 1';
3451 if ( count( $added ) ) {
3452 $existingAdded = $dbw->selectFieldValues(
3453 'category',
3454 'cat_title',
3455 array( 'cat_title' => $added ),
3456 __METHOD__
3459 // For category rows that already exist, do a plain
3460 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3461 // to avoid creating gaps in the cat_id sequence.
3462 if ( count( $existingAdded ) ) {
3463 $dbw->update(
3464 'category',
3465 $addFields,
3466 array( 'cat_title' => $existingAdded ),
3467 __METHOD__
3471 $missingAdded = array_diff( $added, $existingAdded );
3472 if ( count( $missingAdded ) ) {
3473 $insertRows = array();
3474 foreach ( $missingAdded as $cat ) {
3475 $insertRows[] = array(
3476 'cat_title' => $cat,
3477 'cat_pages' => 1,
3478 'cat_subcats' => ( $ns == NS_CATEGORY ) ? 1 : 0,
3479 'cat_files' => ( $ns == NS_FILE ) ? 1 : 0,
3482 $dbw->upsert(
3483 'category',
3484 $insertRows,
3485 array( 'cat_title' ),
3486 $addFields,
3487 $method
3492 if ( count( $deleted ) ) {
3493 $dbw->update(
3494 'category',
3495 $removeFields,
3496 array( 'cat_title' => $deleted ),
3497 $method
3501 foreach ( $added as $catName ) {
3502 $cat = Category::newFromName( $catName );
3503 Hooks::run( 'CategoryAfterPageAdded', array( $cat, $that ) );
3506 foreach ( $deleted as $catName ) {
3507 $cat = Category::newFromName( $catName );
3508 Hooks::run( 'CategoryAfterPageRemoved', array( $cat, $that ) );
3515 * Opportunistically enqueue link update jobs given fresh parser output if useful
3517 * @param ParserOutput $parserOutput Current version page output
3518 * @since 1.25
3520 public function triggerOpportunisticLinksUpdate( ParserOutput $parserOutput ) {
3521 if ( wfReadOnly() ) {
3522 return;
3525 if ( !Hooks::run( 'OpportunisticLinksUpdate',
3526 array( $this, $this->mTitle, $parserOutput )
3527 ) ) {
3528 return;
3531 $params = array(
3532 'isOpportunistic' => true,
3533 'rootJobTimestamp' => $parserOutput->getCacheTime()
3536 if ( $this->mTitle->areRestrictionsCascading() ) {
3537 // If the page is cascade protecting, the links should really be up-to-date
3538 JobQueueGroup::singleton()->lazyPush(
3539 RefreshLinksJob::newPrioritized( $this->mTitle, $params )
3541 } elseif ( $parserOutput->hasDynamicContent() ) {
3542 // Assume the output contains "dynamic" time/random based magic words.
3543 // Only update pages that expired due to dynamic content and NOT due to edits
3544 // to referenced templates/files. When the cache expires due to dynamic content,
3545 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3546 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3547 // template/file edit already triggered recursive RefreshLinksJob jobs.
3548 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3549 // If a page is uncacheable, do not keep spamming a job for it.
3550 // Although it would be de-duplicated, it would still waste I/O.
3551 $cache = ObjectCache::getLocalClusterInstance();
3552 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3553 if ( $cache->add( $key, time(), 60 ) ) {
3554 JobQueueGroup::singleton()->lazyPush(
3555 RefreshLinksJob::newDynamic( $this->mTitle, $params )
3563 * Returns a list of updates to be performed when this page is deleted. The
3564 * updates should remove any information about this page from secondary data
3565 * stores such as links tables.
3567 * @param Content|null $content Optional Content object for determining the
3568 * necessary updates.
3569 * @return DataUpdate[]
3571 public function getDeletionUpdates( Content $content = null ) {
3572 if ( !$content ) {
3573 // load content object, which may be used to determine the necessary updates.
3574 // XXX: the content may not be needed to determine the updates.
3575 $content = $this->getContent( Revision::RAW );
3578 if ( !$content ) {
3579 $updates = array();
3580 } else {
3581 $updates = $content->getDeletionUpdates( $this );
3584 Hooks::run( 'WikiPageDeletionUpdates', array( $this, $content, &$updates ) );
3585 return $updates;