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
23 use MediaWiki\Edit\PreparedEdit
;
24 use \MediaWiki\Logger\LoggerFactory
;
25 use \MediaWiki\MediaWikiServices
;
26 use Wikimedia\Rdbms\FakeResultWrapper
;
27 use Wikimedia\Rdbms\IDatabase
;
28 use Wikimedia\Rdbms\DBError
;
29 use Wikimedia\Rdbms\DBUnexpectedError
;
32 * Class representing a MediaWiki article and history.
34 * Some fields are public only for backwards-compatibility. Use accessors.
35 * In the past, this class was part of Article.php and everything was public.
37 class WikiPage
implements Page
, IDBAccessObject
{
38 // Constants for $mDataLoadedFrom and related
43 public $mTitle = null;
48 public $mDataLoaded = false; // !< Boolean
49 public $mIsRedirect = false; // !< Boolean
50 public $mLatest = false; // !< Integer (false means "not loaded")
53 /** @var PreparedEdit Map of cache fields (text, parser output, ect) for a proposed/new edit */
54 public $mPreparedEdit = false;
59 protected $mId = null;
62 * @var int One of the READ_* constants
64 protected $mDataLoadedFrom = self
::READ_NONE
;
69 protected $mRedirectTarget = null;
74 protected $mLastRevision = null;
77 * @var string Timestamp of the current revision or empty string if not loaded
79 protected $mTimestamp = '';
84 protected $mTouched = '19700101000000';
89 protected $mLinksUpdated = '19700101000000';
92 * Constructor and clear the article
93 * @param Title $title Reference to a Title object.
95 public function __construct( Title
$title ) {
96 $this->mTitle
= $title;
100 * Makes sure that the mTitle object is cloned
101 * to the newly cloned WikiPage.
103 public function __clone() {
104 $this->mTitle
= clone $this->mTitle
;
108 * Create a WikiPage object of the appropriate class for the given title.
110 * @param Title $title
112 * @throws MWException
113 * @return WikiPage|WikiCategoryPage|WikiFilePage
115 public static function factory( Title
$title ) {
116 $ns = $title->getNamespace();
118 if ( $ns == NS_MEDIA
) {
119 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
120 } elseif ( $ns < 0 ) {
121 throw new MWException( "Invalid or virtual namespace $ns given." );
125 if ( !Hooks
::run( 'WikiPageFactory', [ $title, &$page ] ) ) {
131 $page = new WikiFilePage( $title );
134 $page = new WikiCategoryPage( $title );
137 $page = new WikiPage( $title );
144 * Constructor from a page id
146 * @param int $id Article ID to load
147 * @param string|int $from One of the following values:
148 * - "fromdb" or WikiPage::READ_NORMAL to select from a replica DB
149 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
151 * @return WikiPage|null
153 public static function newFromID( $id, $from = 'fromdb' ) {
154 // page ids are never 0 or negative, see T63166
159 $from = self
::convertSelectType( $from );
160 $db = wfGetDB( $from === self
::READ_LATEST ? DB_MASTER
: DB_REPLICA
);
161 $pageQuery = self
::getQueryInfo();
162 $row = $db->selectRow(
163 $pageQuery['tables'], $pageQuery['fields'], [ 'page_id' => $id ], __METHOD__
,
164 [], $pageQuery['joins']
169 return self
::newFromRow( $row, $from );
173 * Constructor from a database row
176 * @param object $row Database row containing at least fields returned by selectFields().
177 * @param string|int $from Source of $data:
178 * - "fromdb" or WikiPage::READ_NORMAL: from a replica DB
179 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
180 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
183 public static function newFromRow( $row, $from = 'fromdb' ) {
184 $page = self
::factory( Title
::newFromRow( $row ) );
185 $page->loadFromRow( $row, $from );
190 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
192 * @param object|string|int $type
195 private static function convertSelectType( $type ) {
198 return self
::READ_NORMAL
;
200 return self
::READ_LATEST
;
202 return self
::READ_LOCKING
;
204 // It may already be an integer or whatever else
210 * @todo Move this UI stuff somewhere else
212 * @see ContentHandler::getActionOverrides
215 public function getActionOverrides() {
216 return $this->getContentHandler()->getActionOverrides();
220 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
222 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
224 * @return ContentHandler
228 public function getContentHandler() {
229 return ContentHandler
::getForModelID( $this->getContentModel() );
233 * Get the title object of the article
234 * @return Title Title object of this page
236 public function getTitle() {
237 return $this->mTitle
;
244 public function clear() {
245 $this->mDataLoaded
= false;
246 $this->mDataLoadedFrom
= self
::READ_NONE
;
248 $this->clearCacheFields();
252 * Clear the object cache fields
255 protected function clearCacheFields() {
257 $this->mRedirectTarget
= null; // Title object if set
258 $this->mLastRevision
= null; // Latest revision
259 $this->mTouched
= '19700101000000';
260 $this->mLinksUpdated
= '19700101000000';
261 $this->mTimestamp
= '';
262 $this->mIsRedirect
= false;
263 $this->mLatest
= false;
264 // T59026: do not clear mPreparedEdit since prepareTextForEdit() already checks
265 // the requested rev ID and content against the cached one for equality. For most
266 // content types, the output should not change during the lifetime of this cache.
267 // Clearing it can cause extra parses on edit for no reason.
271 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
275 public function clearPreparedEdit() {
276 $this->mPreparedEdit
= false;
280 * Return the list of revision fields that should be selected to create
283 * @deprecated since 1.31, use self::getQueryInfo() instead.
286 public static function selectFields() {
287 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
289 wfDeprecated( __METHOD__
, '1.31' );
300 'page_links_updated',
305 if ( $wgContentHandlerUseDB ) {
306 $fields[] = 'page_content_model';
309 if ( $wgPageLanguageUseDB ) {
310 $fields[] = 'page_lang';
317 * Return the tables, fields, and join conditions to be selected to create
320 * @return array With three keys:
321 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
322 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
323 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
325 public static function getQueryInfo() {
326 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
329 'tables' => [ 'page' ],
339 'page_links_updated',
346 if ( $wgContentHandlerUseDB ) {
347 $ret['fields'][] = 'page_content_model';
350 if ( $wgPageLanguageUseDB ) {
351 $ret['fields'][] = 'page_lang';
358 * Fetch a page record with the given conditions
359 * @param IDatabase $dbr
360 * @param array $conditions
361 * @param array $options
362 * @return object|bool Database result resource, or false on failure
364 protected function pageData( $dbr, $conditions, $options = [] ) {
365 $pageQuery = self
::getQueryInfo();
367 // Avoid PHP 7.1 warning of passing $this by reference
370 Hooks
::run( 'ArticlePageDataBefore', [
371 &$wikiPage, &$pageQuery['fields'], &$pageQuery['tables'], &$pageQuery['joins']
374 $row = $dbr->selectRow(
375 $pageQuery['tables'],
376 $pageQuery['fields'],
383 Hooks
::run( 'ArticlePageDataAfter', [ &$wikiPage, &$row ] );
389 * Fetch a page record matching the Title object's namespace and title
390 * using a sanitized title string
392 * @param IDatabase $dbr
393 * @param Title $title
394 * @param array $options
395 * @return object|bool Database result resource, or false on failure
397 public function pageDataFromTitle( $dbr, $title, $options = [] ) {
398 return $this->pageData( $dbr, [
399 'page_namespace' => $title->getNamespace(),
400 'page_title' => $title->getDBkey() ], $options );
404 * Fetch a page record matching the requested ID
406 * @param IDatabase $dbr
408 * @param array $options
409 * @return object|bool Database result resource, or false on failure
411 public function pageDataFromId( $dbr, $id, $options = [] ) {
412 return $this->pageData( $dbr, [ 'page_id' => $id ], $options );
416 * Load the object from a given source by title
418 * @param object|string|int $from One of the following:
419 * - A DB query result object.
420 * - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
421 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
422 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
423 * using SELECT FOR UPDATE.
427 public function loadPageData( $from = 'fromdb' ) {
428 $from = self
::convertSelectType( $from );
429 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
430 // We already have the data from the correct location, no need to load it twice.
434 if ( is_int( $from ) ) {
435 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
436 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
437 $loadBalancer = MediaWikiServices
::getInstance()->getDBLoadBalancer();
440 && $index == DB_REPLICA
441 && $loadBalancer->getServerCount() > 1
442 && $loadBalancer->hasOrMadeRecentMasterChanges()
444 $from = self
::READ_LATEST
;
445 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
446 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
449 // No idea from where the caller got this data, assume replica DB.
451 $from = self
::READ_NORMAL
;
454 $this->loadFromRow( $data, $from );
458 * Load the object from a database row
461 * @param object|bool $data DB row containing fields returned by selectFields() or false
462 * @param string|int $from One of the following:
463 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB
464 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
465 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
466 * the master DB using SELECT FOR UPDATE
468 public function loadFromRow( $data, $from ) {
469 $lc = LinkCache
::singleton();
470 $lc->clearLink( $this->mTitle
);
473 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
475 $this->mTitle
->loadFromRow( $data );
477 // Old-fashioned restrictions
478 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
480 $this->mId
= intval( $data->page_id
);
481 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
482 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
483 $this->mIsRedirect
= intval( $data->page_is_redirect
);
484 $this->mLatest
= intval( $data->page_latest
);
485 // T39225: $latest may no longer match the cached latest Revision object.
486 // Double-check the ID of any cached latest Revision object for consistency.
487 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
488 $this->mLastRevision
= null;
489 $this->mTimestamp
= '';
492 $lc->addBadLinkObj( $this->mTitle
);
494 $this->mTitle
->loadFromRow( false );
496 $this->clearCacheFields();
501 $this->mDataLoaded
= true;
502 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
506 * @return int Page ID
508 public function getId() {
509 if ( !$this->mDataLoaded
) {
510 $this->loadPageData();
516 * @return bool Whether or not the page exists in the database
518 public function exists() {
519 if ( !$this->mDataLoaded
) {
520 $this->loadPageData();
522 return $this->mId
> 0;
526 * Check if this page is something we're going to be showing
527 * some sort of sensible content for. If we return false, page
528 * views (plain action=view) will return an HTTP 404 response,
529 * so spiders and robots can know they're following a bad link.
533 public function hasViewableContent() {
534 return $this->mTitle
->isKnown();
538 * Tests if the article content represents a redirect
542 public function isRedirect() {
543 if ( !$this->mDataLoaded
) {
544 $this->loadPageData();
547 return (bool)$this->mIsRedirect
;
551 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
553 * Will use the revisions actual content model if the page exists,
554 * and the page's default if the page doesn't exist yet.
560 public function getContentModel() {
561 if ( $this->exists() ) {
562 $cache = ObjectCache
::getMainWANInstance();
564 return $cache->getWithSetCallback(
565 $cache->makeKey( 'page-content-model', $this->getLatest() ),
568 $rev = $this->getRevision();
570 // Look at the revision's actual content model
571 return $rev->getContentModel();
573 $title = $this->mTitle
->getPrefixedDBkey();
574 wfWarn( "Page $title exists but has no (visible) revisions!" );
575 return $this->mTitle
->getContentModel();
581 // use the default model for this page
582 return $this->mTitle
->getContentModel();
586 * Loads page_touched and returns a value indicating if it should be used
587 * @return bool True if this page exists and is not a redirect
589 public function checkTouched() {
590 if ( !$this->mDataLoaded
) {
591 $this->loadPageData();
593 return ( $this->mId
&& !$this->mIsRedirect
);
597 * Get the page_touched field
598 * @return string Containing GMT timestamp
600 public function getTouched() {
601 if ( !$this->mDataLoaded
) {
602 $this->loadPageData();
604 return $this->mTouched
;
608 * Get the page_links_updated field
609 * @return string|null Containing GMT timestamp
611 public function getLinksTimestamp() {
612 if ( !$this->mDataLoaded
) {
613 $this->loadPageData();
615 return $this->mLinksUpdated
;
619 * Get the page_latest field
620 * @return int The rev_id of current revision
622 public function getLatest() {
623 if ( !$this->mDataLoaded
) {
624 $this->loadPageData();
626 return (int)$this->mLatest
;
630 * Get the Revision object of the oldest revision
631 * @return Revision|null
633 public function getOldestRevision() {
634 // Try using the replica DB first, then try the master
635 $rev = $this->mTitle
->getFirstRevision();
637 $rev = $this->mTitle
->getFirstRevision( Title
::GAID_FOR_UPDATE
);
643 * Loads everything except the text
644 * This isn't necessary for all uses, so it's only done if needed.
646 protected function loadLastEdit() {
647 if ( $this->mLastRevision
!== null ) {
648 return; // already loaded
651 $latest = $this->getLatest();
653 return; // page doesn't exist or is missing page_latest info
656 if ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) {
657 // T39225: if session S1 loads the page row FOR UPDATE, the result always
658 // includes the latest changes committed. This is true even within REPEATABLE-READ
659 // transactions, where S1 normally only sees changes committed before the first S1
660 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
661 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
662 // happened after the first S1 SELECT.
663 // https://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read
664 $flags = Revision
::READ_LOCKING
;
665 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
666 } elseif ( $this->mDataLoadedFrom
== self
::READ_LATEST
) {
667 // Bug T93976: if page_latest was loaded from the master, fetch the
668 // revision from there as well, as it may not exist yet on a replica DB.
669 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
670 $flags = Revision
::READ_LATEST
;
671 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
673 $dbr = wfGetDB( DB_REPLICA
);
674 $revision = Revision
::newKnownCurrent( $dbr, $this->getId(), $latest );
677 if ( $revision ) { // sanity
678 $this->setLastEdit( $revision );
683 * Set the latest revision
684 * @param Revision $revision
686 protected function setLastEdit( Revision
$revision ) {
687 $this->mLastRevision
= $revision;
688 $this->mTimestamp
= $revision->getTimestamp();
692 * Get the latest revision
693 * @return Revision|null
695 public function getRevision() {
696 $this->loadLastEdit();
697 if ( $this->mLastRevision
) {
698 return $this->mLastRevision
;
704 * Get the content of the current revision. No side-effects...
706 * @param int $audience One of:
707 * Revision::FOR_PUBLIC to be displayed to all users
708 * Revision::FOR_THIS_USER to be displayed to $wgUser
709 * Revision::RAW get the text regardless of permissions
710 * @param User $user User object to check for, only if FOR_THIS_USER is passed
711 * to the $audience parameter
712 * @return Content|null The content of the current revision
716 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
717 $this->loadLastEdit();
718 if ( $this->mLastRevision
) {
719 return $this->mLastRevision
->getContent( $audience, $user );
725 * @return string MW timestamp of last article revision
727 public function getTimestamp() {
728 // Check if the field has been filled by WikiPage::setTimestamp()
729 if ( !$this->mTimestamp
) {
730 $this->loadLastEdit();
733 return wfTimestamp( TS_MW
, $this->mTimestamp
);
737 * Set the page timestamp (use only to avoid DB queries)
738 * @param string $ts MW timestamp of last article revision
741 public function setTimestamp( $ts ) {
742 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
746 * @param int $audience One of:
747 * Revision::FOR_PUBLIC to be displayed to all users
748 * Revision::FOR_THIS_USER to be displayed to the given user
749 * Revision::RAW get the text regardless of permissions
750 * @param User $user User object to check for, only if FOR_THIS_USER is passed
751 * to the $audience parameter
752 * @return int User ID for the user that made the last article revision
754 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
755 $this->loadLastEdit();
756 if ( $this->mLastRevision
) {
757 return $this->mLastRevision
->getUser( $audience, $user );
764 * Get the User object of the user who created the page
765 * @param int $audience One of:
766 * Revision::FOR_PUBLIC to be displayed to all users
767 * Revision::FOR_THIS_USER to be displayed to the given user
768 * Revision::RAW get the text regardless of permissions
769 * @param User $user User object to check for, only if FOR_THIS_USER is passed
770 * to the $audience parameter
773 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
774 $revision = $this->getOldestRevision();
776 $userName = $revision->getUserText( $audience, $user );
777 return User
::newFromName( $userName, false );
784 * @param int $audience One of:
785 * Revision::FOR_PUBLIC to be displayed to all users
786 * Revision::FOR_THIS_USER to be displayed to the given user
787 * Revision::RAW get the text regardless of permissions
788 * @param User $user User object to check for, only if FOR_THIS_USER is passed
789 * to the $audience parameter
790 * @return string Username of the user that made the last article revision
792 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
793 $this->loadLastEdit();
794 if ( $this->mLastRevision
) {
795 return $this->mLastRevision
->getUserText( $audience, $user );
802 * @param int $audience One of:
803 * Revision::FOR_PUBLIC to be displayed to all users
804 * Revision::FOR_THIS_USER to be displayed to the given user
805 * Revision::RAW get the text regardless of permissions
806 * @param User $user User object to check for, only if FOR_THIS_USER is passed
807 * to the $audience parameter
808 * @return string Comment stored for the last article revision
810 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
811 $this->loadLastEdit();
812 if ( $this->mLastRevision
) {
813 return $this->mLastRevision
->getComment( $audience, $user );
820 * Returns true if last revision was marked as "minor edit"
822 * @return bool Minor edit indicator for the last article revision.
824 public function getMinorEdit() {
825 $this->loadLastEdit();
826 if ( $this->mLastRevision
) {
827 return $this->mLastRevision
->isMinor();
834 * Determine whether a page would be suitable for being counted as an
835 * article in the site_stats table based on the title & its content
837 * @param PreparedEdit|bool $editInfo (false): object returned by prepareTextForEdit(),
838 * if false, the current database state will be used
841 public function isCountable( $editInfo = false ) {
842 global $wgArticleCountMethod;
844 if ( !$this->mTitle
->isContentPage() ) {
849 $content = $editInfo->pstContent
;
851 $content = $this->getContent();
854 if ( !$content ||
$content->isRedirect() ) {
860 if ( $wgArticleCountMethod === 'link' ) {
861 // nasty special case to avoid re-parsing to detect links
864 // ParserOutput::getLinks() is a 2D array of page links, so
865 // to be really correct we would need to recurse in the array
866 // but the main array should only have items in it if there are
868 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
870 $hasLinks = (bool)wfGetDB( DB_REPLICA
)->selectField( 'pagelinks', 1,
871 [ 'pl_from' => $this->getId() ], __METHOD__
);
875 return $content->isCountable( $hasLinks );
879 * If this page is a redirect, get its target
881 * The target will be fetched from the redirect table if possible.
882 * If this page doesn't have an entry there, call insertRedirect()
883 * @return Title|null Title object, or null if this page is not a redirect
885 public function getRedirectTarget() {
886 if ( !$this->mTitle
->isRedirect() ) {
890 if ( $this->mRedirectTarget
!== null ) {
891 return $this->mRedirectTarget
;
894 // Query the redirect table
895 $dbr = wfGetDB( DB_REPLICA
);
896 $row = $dbr->selectRow( 'redirect',
897 [ 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ],
898 [ 'rd_from' => $this->getId() ],
902 // rd_fragment and rd_interwiki were added later, populate them if empty
903 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
904 $this->mRedirectTarget
= Title
::makeTitle(
905 $row->rd_namespace
, $row->rd_title
,
906 $row->rd_fragment
, $row->rd_interwiki
908 return $this->mRedirectTarget
;
911 // This page doesn't have an entry in the redirect table
912 $this->mRedirectTarget
= $this->insertRedirect();
913 return $this->mRedirectTarget
;
917 * Insert an entry for this page into the redirect table if the content is a redirect
919 * The database update will be deferred via DeferredUpdates
921 * Don't call this function directly unless you know what you're doing.
922 * @return Title|null Title object or null if not a redirect
924 public function insertRedirect() {
925 $content = $this->getContent();
926 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
931 // Update the DB post-send if the page has not cached since now
932 $latest = $this->getLatest();
933 DeferredUpdates
::addCallableUpdate(
934 function () use ( $retval, $latest ) {
935 $this->insertRedirectEntry( $retval, $latest );
937 DeferredUpdates
::POSTSEND
,
945 * Insert or update the redirect table entry for this page to indicate it redirects to $rt
946 * @param Title $rt Redirect target
947 * @param int|null $oldLatest Prior page_latest for check and set
949 public function insertRedirectEntry( Title
$rt, $oldLatest = null ) {
950 $dbw = wfGetDB( DB_MASTER
);
951 $dbw->startAtomic( __METHOD__
);
953 if ( !$oldLatest ||
$oldLatest == $this->lockAndGetLatest() ) {
957 'rd_from' => $this->getId(),
958 'rd_namespace' => $rt->getNamespace(),
959 'rd_title' => $rt->getDBkey(),
960 'rd_fragment' => $rt->getFragment(),
961 'rd_interwiki' => $rt->getInterwiki(),
965 'rd_namespace' => $rt->getNamespace(),
966 'rd_title' => $rt->getDBkey(),
967 'rd_fragment' => $rt->getFragment(),
968 'rd_interwiki' => $rt->getInterwiki(),
974 $dbw->endAtomic( __METHOD__
);
978 * Get the Title object or URL this page redirects to
980 * @return bool|Title|string False, Title of in-wiki target, or string with URL
982 public function followRedirect() {
983 return $this->getRedirectURL( $this->getRedirectTarget() );
987 * Get the Title object or URL to use for a redirect. We use Title
988 * objects for same-wiki, non-special redirects and URLs for everything
990 * @param Title $rt Redirect target
991 * @return bool|Title|string False, Title object of local target, or string with URL
993 public function getRedirectURL( $rt ) {
998 if ( $rt->isExternal() ) {
999 if ( $rt->isLocal() ) {
1000 // Offsite wikis need an HTTP redirect.
1001 // This can be hard to reverse and may produce loops,
1002 // so they may be disabled in the site configuration.
1003 $source = $this->mTitle
->getFullURL( 'redirect=no' );
1004 return $rt->getFullURL( [ 'rdfrom' => $source ] );
1006 // External pages without "local" bit set are not valid
1012 if ( $rt->isSpecialPage() ) {
1013 // Gotta handle redirects to special pages differently:
1014 // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
1015 // Some pages are not valid targets.
1016 if ( $rt->isValidRedirectTarget() ) {
1017 return $rt->getFullURL();
1027 * Get a list of users who have edited this article, not including the user who made
1028 * the most recent revision, which you can get from $article->getUser() if you want it
1029 * @return UserArrayFromResult
1031 public function getContributors() {
1032 // @todo FIXME: This is expensive; cache this info somewhere.
1034 $dbr = wfGetDB( DB_REPLICA
);
1036 $tables = [ 'revision', 'user' ];
1039 'user_id' => 'rev_user',
1040 'user_name' => 'rev_user_text',
1041 'user_real_name' => 'MIN(user_real_name)',
1042 'timestamp' => 'MAX(rev_timestamp)',
1045 $conds = [ 'rev_page' => $this->getId() ];
1047 // The user who made the top revision gets credited as "this page was last edited by
1048 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1049 $user = $this->getUser();
1051 $conds[] = "rev_user != $user";
1053 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1057 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1060 'user' => [ 'LEFT JOIN', 'rev_user = user_id' ],
1064 'GROUP BY' => [ 'rev_user', 'rev_user_text' ],
1065 'ORDER BY' => 'timestamp DESC',
1068 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1069 return new UserArrayFromResult( $res );
1073 * Should the parser cache be used?
1075 * @param ParserOptions $parserOptions ParserOptions to check
1079 public function shouldCheckParserCache( ParserOptions
$parserOptions, $oldId ) {
1080 return $parserOptions->getStubThreshold() == 0
1082 && ( $oldId === null ||
$oldId === 0 ||
$oldId === $this->getLatest() )
1083 && $this->getContentHandler()->isParserCacheSupported();
1087 * Get a ParserOutput for the given ParserOptions and revision ID.
1089 * The parser cache will be used if possible. Cache misses that result
1090 * in parser runs are debounced with PoolCounter.
1093 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1094 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1095 * get the current revision (default value)
1096 * @param bool $forceParse Force reindexing, regardless of cache settings
1097 * @return bool|ParserOutput ParserOutput or false if the revision was not found
1099 public function getParserOutput(
1100 ParserOptions
$parserOptions, $oldid = null, $forceParse = false
1103 ( !$forceParse ) && $this->shouldCheckParserCache( $parserOptions, $oldid );
1105 if ( $useParserCache && !$parserOptions->isSafeToCache() ) {
1106 throw new InvalidArgumentException(
1107 'The supplied ParserOptions are not safe to cache. Fix the options or set $forceParse = true.'
1111 wfDebug( __METHOD__
.
1112 ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1113 if ( $parserOptions->getStubThreshold() ) {
1114 wfIncrStats( 'pcache.miss.stub' );
1117 if ( $useParserCache ) {
1118 $parserOutput = MediaWikiServices
::getInstance()->getParserCache()
1119 ->get( $this, $parserOptions );
1120 if ( $parserOutput !== false ) {
1121 return $parserOutput;
1125 if ( $oldid === null ||
$oldid === 0 ) {
1126 $oldid = $this->getLatest();
1129 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1132 return $pool->getParserOutput();
1136 * Do standard deferred updates after page view (existing or missing page)
1137 * @param User $user The relevant user
1138 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1140 public function doViewUpdates( User
$user, $oldid = 0 ) {
1141 if ( wfReadOnly() ) {
1145 Hooks
::run( 'PageViewUpdates', [ $this, $user ] );
1146 // Update newtalk / watchlist notification status
1148 $user->clearNotification( $this->mTitle
, $oldid );
1149 } catch ( DBError
$e ) {
1150 // Avoid outage if the master is not reachable
1151 MWExceptionHandler
::logException( $e );
1156 * Perform the actions of a page purging
1158 * @note In 1.28 (and only 1.28), this took a $flags parameter that
1159 * controlled how much purging was done.
1161 public function doPurge() {
1162 // Avoid PHP 7.1 warning of passing $this by reference
1165 if ( !Hooks
::run( 'ArticlePurge', [ &$wikiPage ] ) ) {
1169 $this->mTitle
->invalidateCache();
1172 HTMLFileCache
::clearFileCache( $this->getTitle() );
1173 // Send purge after above page_touched update was committed
1174 DeferredUpdates
::addUpdate(
1175 new CdnCacheUpdate( $this->mTitle
->getCdnUrls() ),
1176 DeferredUpdates
::PRESEND
1179 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1180 $messageCache = MessageCache
::singleton();
1181 $messageCache->updateMessageOverride( $this->mTitle
, $this->getContent() );
1188 * Insert a new empty page record for this article.
1189 * This *must* be followed up by creating a revision
1190 * and running $this->updateRevisionOn( ... );
1191 * or else the record will be left in a funky state.
1192 * Best if all done inside a transaction.
1194 * @param IDatabase $dbw
1195 * @param int|null $pageId Custom page ID that will be used for the insert statement
1197 * @return bool|int The newly created page_id key; false if the row was not
1198 * inserted, e.g. because the title already existed or because the specified
1199 * page ID is already in use.
1201 public function insertOn( $dbw, $pageId = null ) {
1202 $pageIdForInsert = $pageId ?
[ 'page_id' => $pageId ] : [];
1206 'page_namespace' => $this->mTitle
->getNamespace(),
1207 'page_title' => $this->mTitle
->getDBkey(),
1208 'page_restrictions' => '',
1209 'page_is_redirect' => 0, // Will set this shortly...
1211 'page_random' => wfRandom(),
1212 'page_touched' => $dbw->timestamp(),
1213 'page_latest' => 0, // Fill this in shortly...
1214 'page_len' => 0, // Fill this in shortly...
1215 ] +
$pageIdForInsert,
1220 if ( $dbw->affectedRows() > 0 ) {
1221 $newid = $pageId ?
(int)$pageId : $dbw->insertId();
1222 $this->mId
= $newid;
1223 $this->mTitle
->resetArticleID( $newid );
1227 return false; // nothing changed
1232 * Update the page record to point to a newly saved revision.
1234 * @param IDatabase $dbw
1235 * @param Revision $revision For ID number, and text used to set
1236 * length and redirect status fields
1237 * @param int $lastRevision If given, will not overwrite the page field
1238 * when different from the currently set value.
1239 * Giving 0 indicates the new page flag should be set on.
1240 * @param bool $lastRevIsRedirect If given, will optimize adding and
1241 * removing rows in redirect table.
1242 * @return bool Success; false if the page row was missing or page_latest changed
1244 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1245 $lastRevIsRedirect = null
1247 global $wgContentHandlerUseDB;
1249 // Assertion to try to catch T92046
1250 if ( (int)$revision->getId() === 0 ) {
1251 throw new InvalidArgumentException(
1252 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1256 $content = $revision->getContent();
1257 $len = $content ?
$content->getSize() : 0;
1258 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1260 $conditions = [ 'page_id' => $this->getId() ];
1262 if ( !is_null( $lastRevision ) ) {
1263 // An extra check against threads stepping on each other
1264 $conditions['page_latest'] = $lastRevision;
1268 'page_latest' => $revision->getId(),
1269 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1270 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1271 'page_is_redirect' => $rt !== null ?
1 : 0,
1275 if ( $wgContentHandlerUseDB ) {
1276 $row['page_content_model'] = $revision->getContentModel();
1279 $dbw->update( 'page',
1284 $result = $dbw->affectedRows() > 0;
1286 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1287 $this->setLastEdit( $revision );
1288 $this->mLatest
= $revision->getId();
1289 $this->mIsRedirect
= (bool)$rt;
1290 // Update the LinkCache.
1291 LinkCache
::singleton()->addGoodLinkObj(
1297 $revision->getContentModel()
1305 * Add row to the redirect table if this is a redirect, remove otherwise.
1307 * @param IDatabase $dbw
1308 * @param Title|null $redirectTitle Title object pointing to the redirect target,
1309 * or NULL if this is not a redirect
1310 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1311 * removing rows in redirect table.
1312 * @return bool True on success, false on failure
1315 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1316 // Always update redirects (target link might have changed)
1317 // Update/Insert if we don't know if the last revision was a redirect or not
1318 // Delete if changing from redirect to non-redirect
1319 $isRedirect = !is_null( $redirectTitle );
1321 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1325 if ( $isRedirect ) {
1326 $this->insertRedirectEntry( $redirectTitle );
1328 // This is not a redirect, remove row from redirect table
1329 $where = [ 'rd_from' => $this->getId() ];
1330 $dbw->delete( 'redirect', $where, __METHOD__
);
1333 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1334 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1337 return ( $dbw->affectedRows() != 0 );
1341 * If the given revision is newer than the currently set page_latest,
1342 * update the page record. Otherwise, do nothing.
1344 * @deprecated since 1.24, use updateRevisionOn instead
1346 * @param IDatabase $dbw
1347 * @param Revision $revision
1350 public function updateIfNewerOn( $dbw, $revision ) {
1351 $row = $dbw->selectRow(
1352 [ 'revision', 'page' ],
1353 [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1355 'page_id' => $this->getId(),
1356 'page_latest=rev_id' ],
1360 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1363 $prev = $row->rev_id
;
1364 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1366 // No or missing previous revision; mark the page as new
1368 $lastRevIsRedirect = null;
1371 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1377 * Get the content that needs to be saved in order to undo all revisions
1378 * between $undo and $undoafter. Revisions must belong to the same page,
1379 * must exist and must not be deleted
1380 * @param Revision $undo
1381 * @param Revision $undoafter Must be an earlier revision than $undo
1382 * @return Content|bool Content on success, false on failure
1384 * Before we had the Content object, this was done in getUndoText
1386 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1387 $handler = $undo->getContentHandler();
1388 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1392 * Returns true if this page's content model supports sections.
1396 * @todo The skin should check this and not offer section functionality if
1397 * sections are not supported.
1398 * @todo The EditPage should check this and not offer section functionality
1399 * if sections are not supported.
1401 public function supportsSections() {
1402 return $this->getContentHandler()->supportsSections();
1406 * @param string|int|null|bool $sectionId Section identifier as a number or string
1407 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1408 * or 'new' for a new section.
1409 * @param Content $sectionContent New content of the section.
1410 * @param string $sectionTitle New section's subject, only if $section is "new".
1411 * @param string $edittime Revision timestamp or null to use the current revision.
1413 * @throws MWException
1414 * @return Content|null New complete article content, or null if error.
1417 * @deprecated since 1.24, use replaceSectionAtRev instead
1419 public function replaceSectionContent(
1420 $sectionId, Content
$sectionContent, $sectionTitle = '', $edittime = null
1423 if ( $edittime && $sectionId !== 'new' ) {
1424 $dbr = wfGetDB( DB_REPLICA
);
1425 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1426 // Try the master if this thread may have just added it.
1427 // This could be abstracted into a Revision method, but we don't want
1428 // to encourage loading of revisions by timestamp.
1430 && wfGetLB()->getServerCount() > 1
1431 && wfGetLB()->hasOrMadeRecentMasterChanges()
1433 $dbw = wfGetDB( DB_MASTER
);
1434 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1437 $baseRevId = $rev->getId();
1441 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1445 * @param string|int|null|bool $sectionId Section identifier as a number or string
1446 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1447 * or 'new' for a new section.
1448 * @param Content $sectionContent New content of the section.
1449 * @param string $sectionTitle New section's subject, only if $section is "new".
1450 * @param int|null $baseRevId
1452 * @throws MWException
1453 * @return Content|null New complete article content, or null if error.
1457 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1458 $sectionTitle = '', $baseRevId = null
1460 if ( strval( $sectionId ) === '' ) {
1461 // Whole-page edit; let the whole text through
1462 $newContent = $sectionContent;
1464 if ( !$this->supportsSections() ) {
1465 throw new MWException( "sections not supported for content model " .
1466 $this->getContentHandler()->getModelID() );
1469 // T32711: always use current version when adding a new section
1470 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1471 $oldContent = $this->getContent();
1473 $rev = Revision
::newFromId( $baseRevId );
1475 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1476 $this->getId() . "; section: $sectionId)\n" );
1480 $oldContent = $rev->getContent();
1483 if ( !$oldContent ) {
1484 wfDebug( __METHOD__
. ": no page text\n" );
1488 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1495 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1497 * @return int Updated $flags
1499 public function checkFlags( $flags ) {
1500 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1501 if ( $this->exists() ) {
1502 $flags |
= EDIT_UPDATE
;
1512 * Change an existing article or create a new article. Updates RC and all necessary caches,
1513 * optionally via the deferred update array.
1515 * @param Content $content New content
1516 * @param string $summary Edit summary
1517 * @param int $flags Bitfield:
1519 * Article is known or assumed to be non-existent, create a new one
1521 * Article is known or assumed to be pre-existing, update it
1523 * Mark this edit minor, if the user is allowed to do so
1525 * Do not log the change in recentchanges
1527 * Mark the edit a "bot" edit regardless of user rights
1529 * Fill in blank summaries with generated text where possible
1531 * Signal that the page retrieve/save cycle happened entirely in this request.
1533 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1534 * article will be detected. If EDIT_UPDATE is specified and the article
1535 * doesn't exist, the function will return an edit-gone-missing error. If
1536 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1537 * error will be returned. These two conditions are also possible with
1538 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1540 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1541 * This is not the parent revision ID, rather the revision ID for older
1542 * content used as the source for a rollback, for example.
1543 * @param User $user The user doing the edit
1544 * @param string $serialFormat Format for storing the content in the
1546 * @param array|null $tags Change tags to apply to this edit
1547 * Callers are responsible for permission checks
1548 * (with ChangeTags::canAddTagsAccompanyingChange)
1549 * @param Int $undidRevId Id of revision that was undone or 0
1551 * @throws MWException
1552 * @return Status Possible errors:
1553 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1554 * set the fatal flag of $status.
1555 * edit-gone-missing: In update mode, but the article didn't exist.
1556 * edit-conflict: In update mode, the article changed unexpectedly.
1557 * edit-no-change: Warning that the text was the same as before.
1558 * edit-already-exists: In creation mode, but the article already exists.
1560 * Extensions may define additional errors.
1562 * $return->value will contain an associative array with members as follows:
1563 * new: Boolean indicating if the function attempted to create a new article.
1564 * revision: The revision object for the inserted revision, or null.
1567 * @throws MWException
1569 public function doEditContent(
1570 Content
$content, $summary, $flags = 0, $baseRevId = false,
1571 User
$user = null, $serialFormat = null, $tags = [], $undidRevId = 0
1573 global $wgUser, $wgUseAutomaticEditSummaries;
1575 // Old default parameter for $tags was null
1576 if ( $tags === null ) {
1580 // Low-level sanity check
1581 if ( $this->mTitle
->getText() === '' ) {
1582 throw new MWException( 'Something is trying to edit an article with an empty title' );
1584 // Make sure the given content type is allowed for this page
1585 if ( !$content->getContentHandler()->canBeUsedOn( $this->mTitle
) ) {
1586 return Status
::newFatal( 'content-not-allowed-here',
1587 ContentHandler
::getLocalizedName( $content->getModel() ),
1588 $this->mTitle
->getPrefixedText()
1592 // Load the data from the master database if needed.
1593 // The caller may already loaded it from the master or even loaded it using
1594 // SELECT FOR UPDATE, so do not override that using clear().
1595 $this->loadPageData( 'fromdbmaster' );
1597 $user = $user ?
: $wgUser;
1598 $flags = $this->checkFlags( $flags );
1600 // Avoid PHP 7.1 warning of passing $this by reference
1603 // Trigger pre-save hook (using provided edit summary)
1604 $hookStatus = Status
::newGood( [] );
1605 $hook_args = [ &$wikiPage, &$user, &$content, &$summary,
1606 $flags & EDIT_MINOR
, null, null, &$flags, &$hookStatus ];
1607 // Check if the hook rejected the attempted save
1608 if ( !Hooks
::run( 'PageContentSave', $hook_args ) ) {
1609 if ( $hookStatus->isOK() ) {
1610 // Hook returned false but didn't call fatal(); use generic message
1611 $hookStatus->fatal( 'edit-hook-aborted' );
1617 $old_revision = $this->getRevision(); // current revision
1618 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1620 $handler = $content->getContentHandler();
1621 $tag = $handler->getChangeTag( $old_content, $content, $flags );
1622 // If there is no applicable tag, null is returned, so we need to check
1627 // Check for undo tag
1628 if ( $undidRevId !== 0 && in_array( 'mw-undo', ChangeTags
::getSoftwareTags() ) ) {
1629 $tags[] = 'mw-undo';
1632 // Provide autosummaries if summary is not provided and autosummaries are enabled
1633 if ( $wgUseAutomaticEditSummaries && ( $flags & EDIT_AUTOSUMMARY
) && $summary == '' ) {
1634 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1637 // Avoid statsd noise and wasted cycles check the edit stash (T136678)
1638 if ( ( $flags & EDIT_INTERNAL
) ||
( $flags & EDIT_FORCE_BOT
) ) {
1644 // Get the pre-save transform content and final parser output
1645 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat, $useCache );
1646 $pstContent = $editInfo->pstContent
; // Content object
1648 'bot' => ( $flags & EDIT_FORCE_BOT
),
1649 'minor' => ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' ),
1650 'serialized' => $pstContent->serialize( $serialFormat ),
1651 'serialFormat' => $serialFormat,
1652 'baseRevId' => $baseRevId,
1653 'oldRevision' => $old_revision,
1654 'oldContent' => $old_content,
1655 'oldId' => $this->getLatest(),
1656 'oldIsRedirect' => $this->isRedirect(),
1657 'oldCountable' => $this->isCountable(),
1658 'tags' => ( $tags !== null ) ?
(array)$tags : [],
1659 'undidRevId' => $undidRevId
1662 // Actually create the revision and create/update the page
1663 if ( $flags & EDIT_UPDATE
) {
1664 $status = $this->doModify( $pstContent, $flags, $user, $summary, $meta );
1666 $status = $this->doCreate( $pstContent, $flags, $user, $summary, $meta );
1669 // Promote user to any groups they meet the criteria for
1670 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
1671 $user->addAutopromoteOnceGroups( 'onEdit' );
1672 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1679 * @param Content $content Pre-save transform content
1682 * @param string $summary
1683 * @param array $meta
1685 * @throws DBUnexpectedError
1687 * @throws FatalError
1688 * @throws MWException
1690 private function doModify(
1691 Content
$content, $flags, User
$user, $summary, array $meta
1693 global $wgUseRCPatrol;
1695 // Update article, but only if changed.
1696 $status = Status
::newGood( [ 'new' => false, 'revision' => null ] );
1698 // Convenience variables
1699 $now = wfTimestampNow();
1700 $oldid = $meta['oldId'];
1701 /** @var Content|null $oldContent */
1702 $oldContent = $meta['oldContent'];
1703 $newsize = $content->getSize();
1706 // Article gone missing
1707 $status->fatal( 'edit-gone-missing' );
1710 } elseif ( !$oldContent ) {
1711 // Sanity check for T39225
1712 throw new MWException( "Could not find text for current revision {$oldid}." );
1715 $changed = !$content->equals( $oldContent );
1717 $dbw = wfGetDB( DB_MASTER
);
1720 // @TODO: pass content object?!
1721 $revision = new Revision( [
1722 'page' => $this->getId(),
1723 'title' => $this->mTitle
, // for determining the default content model
1724 'comment' => $summary,
1725 'minor_edit' => $meta['minor'],
1726 'text' => $meta['serialized'],
1728 'parent_id' => $oldid,
1729 'user' => $user->getId(),
1730 'user_text' => $user->getName(),
1731 'timestamp' => $now,
1732 'content_model' => $content->getModel(),
1733 'content_format' => $meta['serialFormat'],
1736 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1737 $status->merge( $prepStatus );
1738 if ( !$status->isOK() ) {
1742 $dbw->startAtomic( __METHOD__
);
1743 // Get the latest page_latest value while locking it.
1744 // Do a CAS style check to see if it's the same as when this method
1745 // started. If it changed then bail out before touching the DB.
1746 $latestNow = $this->lockAndGetLatest();
1747 if ( $latestNow != $oldid ) {
1748 $dbw->endAtomic( __METHOD__
);
1749 // Page updated or deleted in the mean time
1750 $status->fatal( 'edit-conflict' );
1755 // At this point we are now comitted to returning an OK
1756 // status unless some DB query error or other exception comes up.
1757 // This way callers don't have to call rollback() if $status is bad
1758 // unless they actually try to catch exceptions (which is rare).
1760 // Save the revision text
1761 $revisionId = $revision->insertOn( $dbw );
1762 // Update page_latest and friends to reflect the new revision
1763 if ( !$this->updateRevisionOn( $dbw, $revision, null, $meta['oldIsRedirect'] ) ) {
1764 throw new MWException( "Failed to update page row to use new revision." );
1767 Hooks
::run( 'NewRevisionFromEditComplete',
1768 [ $this, $revision, $meta['baseRevId'], $user ] );
1770 // Update recentchanges
1771 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1772 // Mark as patrolled if the user can do so
1773 $patrolled = $wgUseRCPatrol && !count(
1774 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1775 // Add RC row to the DB
1776 RecentChange
::notifyEdit(
1779 $revision->isMinor(),
1783 $this->getTimestamp(),
1786 $oldContent ?
$oldContent->getSize() : 0,
1794 $user->incEditCount();
1796 $dbw->endAtomic( __METHOD__
);
1797 $this->mTimestamp
= $now;
1799 // T34948: revision ID must be set to page {{REVISIONID}} and
1800 // related variables correctly. Likewise for {{REVISIONUSER}} (T135261).
1801 // Since we don't insert a new revision into the database, the least
1802 // error-prone way is to reuse given old revision.
1803 $revision = $meta['oldRevision'];
1807 // Return the new revision to the caller
1808 $status->value
['revision'] = $revision;
1810 $status->warning( 'edit-no-change' );
1811 // Update page_touched as updateRevisionOn() was not called.
1812 // Other cache updates are managed in onArticleEdit() via doEditUpdates().
1813 $this->mTitle
->invalidateCache( $now );
1816 // Do secondary updates once the main changes have been committed...
1817 DeferredUpdates
::addUpdate(
1818 new AtomicSectionUpdate(
1822 $revision, &$user, $content, $summary, &$flags,
1823 $changed, $meta, &$status
1825 // Update links tables, site stats, etc.
1826 $this->doEditUpdates(
1830 'changed' => $changed,
1831 'oldcountable' => $meta['oldCountable'],
1832 'oldrevision' => $meta['oldRevision']
1835 // Avoid PHP 7.1 warning of passing $this by reference
1837 // Trigger post-save hook
1838 $params = [ &$wikiPage, &$user, $content, $summary, $flags & EDIT_MINOR
,
1839 null, null, &$flags, $revision, &$status, $meta['baseRevId'],
1840 $meta['undidRevId'] ];
1841 Hooks
::run( 'PageContentSaveComplete', $params );
1844 DeferredUpdates
::PRESEND
1851 * @param Content $content Pre-save transform content
1854 * @param string $summary
1855 * @param array $meta
1857 * @throws DBUnexpectedError
1859 * @throws FatalError
1860 * @throws MWException
1862 private function doCreate(
1863 Content
$content, $flags, User
$user, $summary, array $meta
1865 global $wgUseRCPatrol, $wgUseNPPatrol;
1867 $status = Status
::newGood( [ 'new' => true, 'revision' => null ] );
1869 $now = wfTimestampNow();
1870 $newsize = $content->getSize();
1871 $prepStatus = $content->prepareSave( $this, $flags, $meta['oldId'], $user );
1872 $status->merge( $prepStatus );
1873 if ( !$status->isOK() ) {
1877 $dbw = wfGetDB( DB_MASTER
);
1878 $dbw->startAtomic( __METHOD__
);
1880 // Add the page record unless one already exists for the title
1881 $newid = $this->insertOn( $dbw );
1882 if ( $newid === false ) {
1883 $dbw->endAtomic( __METHOD__
); // nothing inserted
1884 $status->fatal( 'edit-already-exists' );
1886 return $status; // nothing done
1889 // At this point we are now comitted to returning an OK
1890 // status unless some DB query error or other exception comes up.
1891 // This way callers don't have to call rollback() if $status is bad
1892 // unless they actually try to catch exceptions (which is rare).
1894 // @TODO: pass content object?!
1895 $revision = new Revision( [
1897 'title' => $this->mTitle
, // for determining the default content model
1898 'comment' => $summary,
1899 'minor_edit' => $meta['minor'],
1900 'text' => $meta['serialized'],
1902 'user' => $user->getId(),
1903 'user_text' => $user->getName(),
1904 'timestamp' => $now,
1905 'content_model' => $content->getModel(),
1906 'content_format' => $meta['serialFormat'],
1909 // Save the revision text...
1910 $revisionId = $revision->insertOn( $dbw );
1911 // Update the page record with revision data
1912 if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1913 throw new MWException( "Failed to update page row to use new revision." );
1916 Hooks
::run( 'NewRevisionFromEditComplete', [ $this, $revision, false, $user ] );
1918 // Update recentchanges
1919 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1920 // Mark as patrolled if the user can do so
1921 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) &&
1922 !count( $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1923 // Add RC row to the DB
1924 RecentChange
::notifyNew(
1927 $revision->isMinor(),
1939 $user->incEditCount();
1941 $dbw->endAtomic( __METHOD__
);
1942 $this->mTimestamp
= $now;
1944 // Return the new revision to the caller
1945 $status->value
['revision'] = $revision;
1947 // Do secondary updates once the main changes have been committed...
1948 DeferredUpdates
::addUpdate(
1949 new AtomicSectionUpdate(
1953 $revision, &$user, $content, $summary, &$flags, $meta, &$status
1955 // Update links, etc.
1956 $this->doEditUpdates( $revision, $user, [ 'created' => true ] );
1957 // Avoid PHP 7.1 warning of passing $this by reference
1959 // Trigger post-create hook
1960 $params = [ &$wikiPage, &$user, $content, $summary,
1961 $flags & EDIT_MINOR
, null, null, &$flags, $revision ];
1962 Hooks
::run( 'PageContentInsertComplete', $params );
1963 // Trigger post-save hook
1964 $params = array_merge( $params, [ &$status, $meta['baseRevId'], 0 ] );
1965 Hooks
::run( 'PageContentSaveComplete', $params );
1968 DeferredUpdates
::PRESEND
1975 * Get parser options suitable for rendering the primary article wikitext
1977 * @see ContentHandler::makeParserOptions
1979 * @param IContextSource|User|string $context One of the following:
1980 * - IContextSource: Use the User and the Language of the provided
1982 * - User: Use the provided User object and $wgLang for the language,
1983 * so use an IContextSource object if possible.
1984 * - 'canonical': Canonical options (anonymous user with default
1985 * preferences and content language).
1986 * @return ParserOptions
1988 public function makeParserOptions( $context ) {
1989 $options = $this->getContentHandler()->makeParserOptions( $context );
1991 if ( $this->getTitle()->isConversionTable() ) {
1992 // @todo ConversionTable should become a separate content model, so
1993 // we don't need special cases like this one.
1994 $options->disableContentConversion();
2001 * Prepare content which is about to be saved.
2003 * Prior to 1.30, this returned a stdClass object with the same class
2006 * @param Content $content
2007 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2008 * revision ID is also accepted, but this is deprecated.
2009 * @param User|null $user
2010 * @param string|null $serialFormat
2011 * @param bool $useCache Check shared prepared edit cache
2013 * @return PreparedEdit
2017 public function prepareContentForEdit(
2018 Content
$content, $revision = null, User
$user = null,
2019 $serialFormat = null, $useCache = true
2021 global $wgContLang, $wgUser, $wgAjaxEditStash;
2023 if ( is_object( $revision ) ) {
2024 $revid = $revision->getId();
2027 // This code path is deprecated, and nothing is known to
2028 // use it, so performance here shouldn't be a worry.
2029 if ( $revid !== null ) {
2030 wfDeprecated( __METHOD__
. ' with $revision = revision ID', '1.25' );
2031 $revision = Revision
::newFromId( $revid, Revision
::READ_LATEST
);
2037 $user = is_null( $user ) ?
$wgUser : $user;
2038 // XXX: check $user->getId() here???
2040 // Use a sane default for $serialFormat, see T59026
2041 if ( $serialFormat === null ) {
2042 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2045 if ( $this->mPreparedEdit
2046 && isset( $this->mPreparedEdit
->newContent
)
2047 && $this->mPreparedEdit
->newContent
->equals( $content )
2048 && $this->mPreparedEdit
->revid
== $revid
2049 && $this->mPreparedEdit
->format
== $serialFormat
2050 // XXX: also check $user here?
2053 return $this->mPreparedEdit
;
2056 // The edit may have already been prepared via api.php?action=stashedit
2057 $cachedEdit = $useCache && $wgAjaxEditStash
2058 ? ApiStashEdit
::checkCache( $this->getTitle(), $content, $user )
2061 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2062 Hooks
::run( 'ArticlePrepareTextForEdit', [ $this, $popts ] );
2064 $edit = new PreparedEdit();
2065 if ( $cachedEdit ) {
2066 $edit->timestamp
= $cachedEdit->timestamp
;
2068 $edit->timestamp
= wfTimestampNow();
2070 // @note: $cachedEdit is safely not used if the rev ID was referenced in the text
2071 $edit->revid
= $revid;
2073 if ( $cachedEdit ) {
2074 $edit->pstContent
= $cachedEdit->pstContent
;
2076 $edit->pstContent
= $content
2077 ?
$content->preSaveTransform( $this->mTitle
, $user, $popts )
2081 $edit->format
= $serialFormat;
2082 $edit->popts
= $this->makeParserOptions( 'canonical' );
2083 if ( $cachedEdit ) {
2084 $edit->output
= $cachedEdit->output
;
2087 // We get here if vary-revision is set. This means that this page references
2088 // itself (such as via self-transclusion). In this case, we need to make sure
2089 // that any such self-references refer to the newly-saved revision, and not
2090 // to the previous one, which could otherwise happen due to replica DB lag.
2091 $oldCallback = $edit->popts
->getCurrentRevisionCallback();
2092 $edit->popts
->setCurrentRevisionCallback(
2093 function ( Title
$title, $parser = false ) use ( $revision, &$oldCallback ) {
2094 if ( $title->equals( $revision->getTitle() ) ) {
2097 return call_user_func( $oldCallback, $title, $parser );
2102 // Try to avoid a second parse if {{REVISIONID}} is used
2103 $dbIndex = ( $this->mDataLoadedFrom
& self
::READ_LATEST
) === self
::READ_LATEST
2104 ? DB_MASTER
// use the best possible guess
2105 : DB_REPLICA
; // T154554
2107 $edit->popts
->setSpeculativeRevIdCallback( function () use ( $dbIndex ) {
2108 return 1 +
(int)wfGetDB( $dbIndex )->selectField(
2116 $edit->output
= $edit->pstContent
2117 ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
)
2121 $edit->newContent
= $content;
2122 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2124 // NOTE: B/C for hooks! don't use these fields!
2125 $edit->newText
= $edit->newContent
2126 ? ContentHandler
::getContentText( $edit->newContent
)
2128 $edit->oldText
= $edit->oldContent
2129 ? ContentHandler
::getContentText( $edit->oldContent
)
2131 $edit->pst
= $edit->pstContent ?
$edit->pstContent
->serialize( $serialFormat ) : '';
2133 if ( $edit->output
) {
2134 $edit->output
->setCacheTime( wfTimestampNow() );
2137 // Process cache the result
2138 $this->mPreparedEdit
= $edit;
2144 * Do standard deferred updates after page edit.
2145 * Update links tables, site stats, search index and message cache.
2146 * Purges pages that include this page if the text was changed here.
2147 * Every 100th edit, prune the recent changes table.
2149 * @param Revision $revision
2150 * @param User $user User object that did the revision
2151 * @param array $options Array of options, following indexes are used:
2152 * - changed: bool, whether the revision changed the content (default true)
2153 * - created: bool, whether the revision created the page (default false)
2154 * - moved: bool, whether the page was moved (default false)
2155 * - restored: bool, whether the page was undeleted (default false)
2156 * - oldrevision: Revision object for the pre-update revision (default null)
2157 * - oldcountable: bool, null, or string 'no-change' (default null):
2158 * - bool: whether the page was counted as an article before that
2159 * revision, only used in changed is true and created is false
2160 * - null: if created is false, don't update the article count; if created
2161 * is true, do update the article count
2162 * - 'no-change': don't update the article count, ever
2164 public function doEditUpdates( Revision
$revision, User
$user, array $options = [] ) {
2165 global $wgRCWatchCategoryMembership;
2171 'restored' => false,
2172 'oldrevision' => null,
2173 'oldcountable' => null
2175 $content = $revision->getContent();
2177 $logger = LoggerFactory
::getInstance( 'SaveParse' );
2179 // See if the parser output before $revision was inserted is still valid
2181 if ( !$this->mPreparedEdit
) {
2182 $logger->debug( __METHOD__
. ": No prepared edit...\n" );
2183 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2184 $logger->info( __METHOD__
. ": Prepared edit has vary-revision...\n" );
2185 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision-id' )
2186 && $this->mPreparedEdit
->output
->getSpeculativeRevIdUsed() !== $revision->getId()
2188 $logger->info( __METHOD__
. ": Prepared edit has vary-revision-id with wrong ID...\n" );
2189 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-user' ) && !$options['changed'] ) {
2190 $logger->info( __METHOD__
. ": Prepared edit has vary-user and is null...\n" );
2192 wfDebug( __METHOD__
. ": Using prepared edit...\n" );
2193 $editInfo = $this->mPreparedEdit
;
2197 // Parse the text again if needed. Be careful not to do pre-save transform twice:
2198 // $text is usually already pre-save transformed once. Avoid using the edit stash
2199 // as any prepared content from there or in doEditContent() was already rejected.
2200 $editInfo = $this->prepareContentForEdit( $content, $revision, $user, null, false );
2203 // Save it to the parser cache.
2204 // Make sure the cache time matches page_touched to avoid double parsing.
2205 MediaWikiServices
::getInstance()->getParserCache()->save(
2206 $editInfo->output
, $this, $editInfo->popts
,
2207 $revision->getTimestamp(), $editInfo->revid
2210 // Update the links tables and other secondary data
2212 $recursive = $options['changed']; // T52785
2213 $updates = $content->getSecondaryDataUpdates(
2214 $this->getTitle(), null, $recursive, $editInfo->output
2216 foreach ( $updates as $update ) {
2217 $update->setCause( 'edit-page', $user->getName() );
2218 if ( $update instanceof LinksUpdate
) {
2219 $update->setRevision( $revision );
2220 $update->setTriggeringUser( $user );
2222 DeferredUpdates
::addUpdate( $update );
2224 if ( $wgRCWatchCategoryMembership
2225 && $this->getContentHandler()->supportsCategories() === true
2226 && ( $options['changed'] ||
$options['created'] )
2227 && !$options['restored']
2229 // Note: jobs are pushed after deferred updates, so the job should be able to see
2230 // the recent change entry (also done via deferred updates) and carry over any
2231 // bot/deletion/IP flags, ect.
2232 JobQueueGroup
::singleton()->lazyPush( new CategoryMembershipChangeJob(
2235 'pageId' => $this->getId(),
2236 'revTimestamp' => $revision->getTimestamp()
2242 // Avoid PHP 7.1 warning of passing $this by reference
2245 Hooks
::run( 'ArticleEditUpdates', [ &$wikiPage, &$editInfo, $options['changed'] ] );
2247 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', [ &$wikiPage ] ) ) {
2248 // Flush old entries from the `recentchanges` table
2249 if ( mt_rand( 0, 9 ) == 0 ) {
2250 JobQueueGroup
::singleton()->lazyPush( RecentChangesUpdateJob
::newPurgeJob() );
2254 if ( !$this->exists() ) {
2258 $id = $this->getId();
2259 $title = $this->mTitle
->getPrefixedDBkey();
2260 $shortTitle = $this->mTitle
->getDBkey();
2262 if ( $options['oldcountable'] === 'no-change' ||
2263 ( !$options['changed'] && !$options['moved'] )
2266 } elseif ( $options['created'] ) {
2267 $good = (int)$this->isCountable( $editInfo );
2268 } elseif ( $options['oldcountable'] !== null ) {
2269 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2273 $edits = $options['changed'] ?
1 : 0;
2274 $total = $options['created'] ?
1 : 0;
2276 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2277 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2279 // If this is another user's talk page, update newtalk.
2280 // Don't do this if $options['changed'] = false (null-edits) nor if
2281 // it's a minor edit and the user doesn't want notifications for those.
2282 if ( $options['changed']
2283 && $this->mTitle
->getNamespace() == NS_USER_TALK
2284 && $shortTitle != $user->getTitleKey()
2285 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2287 $recipient = User
::newFromName( $shortTitle, false );
2288 if ( !$recipient ) {
2289 wfDebug( __METHOD__
. ": invalid username\n" );
2291 // Avoid PHP 7.1 warning of passing $this by reference
2294 // Allow extensions to prevent user notification
2295 // when a new message is added to their talk page
2296 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', [ &$wikiPage, $recipient ] ) ) {
2297 if ( User
::isIP( $shortTitle ) ) {
2298 // An anonymous user
2299 $recipient->setNewtalk( true, $revision );
2300 } elseif ( $recipient->isLoggedIn() ) {
2301 $recipient->setNewtalk( true, $revision );
2303 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2309 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2310 MessageCache
::singleton()->updateMessageOverride( $this->mTitle
, $content );
2313 if ( $options['created'] ) {
2314 self
::onArticleCreate( $this->mTitle
);
2315 } elseif ( $options['changed'] ) { // T52785
2316 self
::onArticleEdit( $this->mTitle
, $revision );
2319 ResourceLoaderWikiModule
::invalidateModuleCache(
2320 $this->mTitle
, $options['oldrevision'], $revision, wfWikiID()
2325 * Update the article's restriction field, and leave a log entry.
2326 * This works for protection both existing and non-existing pages.
2328 * @param array $limit Set of restriction keys
2329 * @param array $expiry Per restriction type expiration
2330 * @param int &$cascade Set to false if cascading protection isn't allowed.
2331 * @param string $reason
2332 * @param User $user The user updating the restrictions
2333 * @param string|string[] $tags Change tags to add to the pages and protection log entries
2334 * ($user should be able to add the specified tags before this is called)
2335 * @return Status Status object; if action is taken, $status->value is the log_id of the
2336 * protection log entry.
2338 public function doUpdateRestrictions( array $limit, array $expiry,
2339 &$cascade, $reason, User
$user, $tags = null
2341 global $wgCascadingRestrictionLevels;
2343 if ( wfReadOnly() ) {
2344 return Status
::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
2347 $this->loadPageData( 'fromdbmaster' );
2348 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2349 $id = $this->getId();
2355 // Take this opportunity to purge out expired restrictions
2356 Title
::purgeExpiredRestrictions();
2358 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2359 // we expect a single selection, but the schema allows otherwise.
2360 $isProtected = false;
2364 $dbw = wfGetDB( DB_MASTER
);
2366 foreach ( $restrictionTypes as $action ) {
2367 if ( !isset( $expiry[$action] ) ||
$expiry[$action] === $dbw->getInfinity() ) {
2368 $expiry[$action] = 'infinity';
2370 if ( !isset( $limit[$action] ) ) {
2371 $limit[$action] = '';
2372 } elseif ( $limit[$action] != '' ) {
2376 // Get current restrictions on $action
2377 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2378 if ( $current != '' ) {
2379 $isProtected = true;
2382 if ( $limit[$action] != $current ) {
2384 } elseif ( $limit[$action] != '' ) {
2385 // Only check expiry change if the action is actually being
2386 // protected, since expiry does nothing on an not-protected
2388 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2394 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2398 // If nothing has changed, do nothing
2400 return Status
::newGood();
2403 if ( !$protect ) { // No protection at all means unprotection
2404 $revCommentMsg = 'unprotectedarticle-comment';
2405 $logAction = 'unprotect';
2406 } elseif ( $isProtected ) {
2407 $revCommentMsg = 'modifiedarticleprotection-comment';
2408 $logAction = 'modify';
2410 $revCommentMsg = 'protectedarticle-comment';
2411 $logAction = 'protect';
2414 $logRelationsValues = [];
2415 $logRelationsField = null;
2416 $logParamsDetails = [];
2418 // Null revision (used for change tag insertion)
2419 $nullRevision = null;
2421 if ( $id ) { // Protection of existing page
2422 // Avoid PHP 7.1 warning of passing $this by reference
2425 if ( !Hooks
::run( 'ArticleProtect', [ &$wikiPage, &$user, $limit, $reason ] ) ) {
2426 return Status
::newGood();
2429 // Only certain restrictions can cascade...
2430 $editrestriction = isset( $limit['edit'] )
2431 ?
[ $limit['edit'] ]
2432 : $this->mTitle
->getRestrictions( 'edit' );
2433 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2434 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2436 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2437 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2440 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2441 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2442 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2444 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2445 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2448 // The schema allows multiple restrictions
2449 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2453 // insert null revision to identify the page protection change as edit summary
2454 $latest = $this->getLatest();
2455 $nullRevision = $this->insertProtectNullRevision(
2464 if ( $nullRevision === null ) {
2465 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2468 $logRelationsField = 'pr_id';
2470 // Update restrictions table
2471 foreach ( $limit as $action => $restrictions ) {
2473 'page_restrictions',
2476 'pr_type' => $action
2480 if ( $restrictions != '' ) {
2481 $cascadeValue = ( $cascade && $action == 'edit' ) ?
1 : 0;
2483 'page_restrictions',
2486 'pr_type' => $action,
2487 'pr_level' => $restrictions,
2488 'pr_cascade' => $cascadeValue,
2489 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2493 $logRelationsValues[] = $dbw->insertId();
2494 $logParamsDetails[] = [
2496 'level' => $restrictions,
2497 'expiry' => $expiry[$action],
2498 'cascade' => (bool)$cascadeValue,
2503 // Clear out legacy restriction fields
2506 [ 'page_restrictions' => '' ],
2507 [ 'page_id' => $id ],
2511 // Avoid PHP 7.1 warning of passing $this by reference
2514 Hooks
::run( 'NewRevisionFromEditComplete',
2515 [ $this, $nullRevision, $latest, $user ] );
2516 Hooks
::run( 'ArticleProtectComplete', [ &$wikiPage, &$user, $limit, $reason ] );
2517 } else { // Protection of non-existing page (also known as "title protection")
2518 // Cascade protection is meaningless in this case
2521 if ( $limit['create'] != '' ) {
2522 $commentFields = CommentStore
::newKey( 'pt_reason' )->insert( $dbw, $reason );
2523 $dbw->replace( 'protected_titles',
2524 [ [ 'pt_namespace', 'pt_title' ] ],
2526 'pt_namespace' => $this->mTitle
->getNamespace(),
2527 'pt_title' => $this->mTitle
->getDBkey(),
2528 'pt_create_perm' => $limit['create'],
2529 'pt_timestamp' => $dbw->timestamp(),
2530 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2531 'pt_user' => $user->getId(),
2532 ] +
$commentFields, __METHOD__
2534 $logParamsDetails[] = [
2536 'level' => $limit['create'],
2537 'expiry' => $expiry['create'],
2540 $dbw->delete( 'protected_titles',
2542 'pt_namespace' => $this->mTitle
->getNamespace(),
2543 'pt_title' => $this->mTitle
->getDBkey()
2549 $this->mTitle
->flushRestrictions();
2550 InfoAction
::invalidateCache( $this->mTitle
);
2552 if ( $logAction == 'unprotect' ) {
2555 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2557 '4::description' => $protectDescriptionLog, // parameter for IRC
2558 '5:bool:cascade' => $cascade,
2559 'details' => $logParamsDetails, // parameter for localize and api
2563 // Update the protection log
2564 $logEntry = new ManualLogEntry( 'protect', $logAction );
2565 $logEntry->setTarget( $this->mTitle
);
2566 $logEntry->setComment( $reason );
2567 $logEntry->setPerformer( $user );
2568 $logEntry->setParameters( $params );
2569 if ( !is_null( $nullRevision ) ) {
2570 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2572 $logEntry->setTags( $tags );
2573 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2574 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2576 $logId = $logEntry->insert();
2577 $logEntry->publish( $logId );
2579 return Status
::newGood( $logId );
2583 * Insert a new null revision for this page.
2585 * @param string $revCommentMsg Comment message key for the revision
2586 * @param array $limit Set of restriction keys
2587 * @param array $expiry Per restriction type expiration
2588 * @param int $cascade Set to false if cascading protection isn't allowed.
2589 * @param string $reason
2590 * @param User|null $user
2591 * @return Revision|null Null on error
2593 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2594 array $expiry, $cascade, $reason, $user = null
2596 $dbw = wfGetDB( DB_MASTER
);
2598 // Prepare a null revision to be added to the history
2599 $editComment = wfMessage(
2601 $this->mTitle
->getPrefixedText(),
2602 $user ?
$user->getName() : ''
2603 )->inContentLanguage()->text();
2605 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2607 $protectDescription = $this->protectDescription( $limit, $expiry );
2608 if ( $protectDescription ) {
2609 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2610 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2611 ->inContentLanguage()->text();
2614 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2615 $editComment .= wfMessage( 'brackets' )->params(
2616 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2617 )->inContentLanguage()->text();
2620 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2622 $nullRev->insertOn( $dbw );
2624 // Update page record and touch page
2625 $oldLatest = $nullRev->getParentId();
2626 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2633 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2636 protected function formatExpiry( $expiry ) {
2639 if ( $expiry != 'infinity' ) {
2642 $wgContLang->timeanddate( $expiry, false, false ),
2643 $wgContLang->date( $expiry, false, false ),
2644 $wgContLang->time( $expiry, false, false )
2645 )->inContentLanguage()->text();
2647 return wfMessage( 'protect-expiry-indefinite' )
2648 ->inContentLanguage()->text();
2653 * Builds the description to serve as comment for the edit.
2655 * @param array $limit Set of restriction keys
2656 * @param array $expiry Per restriction type expiration
2659 public function protectDescription( array $limit, array $expiry ) {
2660 $protectDescription = '';
2662 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2663 # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2664 # All possible message keys are listed here for easier grepping:
2665 # * restriction-create
2666 # * restriction-edit
2667 # * restriction-move
2668 # * restriction-upload
2669 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2670 # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2671 # with '' filtered out. All possible message keys are listed below:
2672 # * protect-level-autoconfirmed
2673 # * protect-level-sysop
2674 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2675 ->inContentLanguage()->text();
2677 $expiryText = $this->formatExpiry( $expiry[$action] );
2679 if ( $protectDescription !== '' ) {
2680 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2682 $protectDescription .= wfMessage( 'protect-summary-desc' )
2683 ->params( $actionText, $restrictionsText, $expiryText )
2684 ->inContentLanguage()->text();
2687 return $protectDescription;
2691 * Builds the description to serve as comment for the log entry.
2693 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2694 * protect description text. Keep them in old format to avoid breaking compatibility.
2695 * TODO: Fix protection log to store structured description and format it on-the-fly.
2697 * @param array $limit Set of restriction keys
2698 * @param array $expiry Per restriction type expiration
2701 public function protectDescriptionLog( array $limit, array $expiry ) {
2704 $protectDescriptionLog = '';
2706 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2707 $expiryText = $this->formatExpiry( $expiry[$action] );
2708 $protectDescriptionLog .= $wgContLang->getDirMark() .
2709 "[$action=$restrictions] ($expiryText)";
2712 return trim( $protectDescriptionLog );
2716 * Take an array of page restrictions and flatten it to a string
2717 * suitable for insertion into the page_restrictions field.
2719 * @param string[] $limit
2721 * @throws MWException
2724 protected static function flattenRestrictions( $limit ) {
2725 if ( !is_array( $limit ) ) {
2726 throw new MWException( __METHOD__
. ' given non-array restriction set' );
2732 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2733 $bits[] = "$action=$restrictions";
2736 return implode( ':', $bits );
2740 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2741 * backwards compatibility, if you care about error reporting you should use
2742 * doDeleteArticleReal() instead.
2744 * Deletes the article with database consistency, writes logs, purges caches
2746 * @param string $reason Delete reason for deletion log
2747 * @param bool $suppress Suppress all revisions and log the deletion in
2748 * the suppression log instead of the deletion log
2749 * @param int $u1 Unused
2750 * @param bool $u2 Unused
2751 * @param array|string &$error Array of errors to append to
2752 * @param User $user The deleting user
2753 * @return bool True if successful
2755 public function doDeleteArticle(
2756 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null
2758 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2759 return $status->isGood();
2763 * Back-end article deletion
2764 * Deletes the article with database consistency, writes logs, purges caches
2768 * @param string $reason Delete reason for deletion log
2769 * @param bool $suppress Suppress all revisions and log the deletion in
2770 * the suppression log instead of the deletion log
2771 * @param int $u1 Unused
2772 * @param bool $u2 Unused
2773 * @param array|string &$error Array of errors to append to
2774 * @param User $user The deleting user
2775 * @param array $tags Tags to apply to the deletion action
2776 * @param string $logsubtype
2777 * @return Status Status object; if successful, $status->value is the log_id of the
2778 * deletion log entry. If the page couldn't be deleted because it wasn't
2779 * found, $status is a non-fatal 'cannotdelete' error
2781 public function doDeleteArticleReal(
2782 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null,
2783 $tags = [], $logsubtype = 'delete'
2785 global $wgUser, $wgContentHandlerUseDB, $wgCommentTableSchemaMigrationStage;
2787 wfDebug( __METHOD__
. "\n" );
2789 $status = Status
::newGood();
2791 if ( $this->mTitle
->getDBkey() === '' ) {
2792 $status->error( 'cannotdelete',
2793 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2797 // Avoid PHP 7.1 warning of passing $this by reference
2800 $user = is_null( $user ) ?
$wgUser : $user;
2801 if ( !Hooks
::run( 'ArticleDelete',
2802 [ &$wikiPage, &$user, &$reason, &$error, &$status, $suppress ]
2804 if ( $status->isOK() ) {
2805 // Hook aborted but didn't set a fatal status
2806 $status->fatal( 'delete-hook-aborted' );
2811 $dbw = wfGetDB( DB_MASTER
);
2812 $dbw->startAtomic( __METHOD__
);
2814 $this->loadPageData( self
::READ_LATEST
);
2815 $id = $this->getId();
2816 // T98706: lock the page from various other updates but avoid using
2817 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2818 // the revisions queries (which also JOIN on user). Only lock the page
2819 // row and CAS check on page_latest to see if the trx snapshot matches.
2820 $lockedLatest = $this->lockAndGetLatest();
2821 if ( $id == 0 ||
$this->getLatest() != $lockedLatest ) {
2822 $dbw->endAtomic( __METHOD__
);
2823 // Page not there or trx snapshot is stale
2824 $status->error( 'cannotdelete',
2825 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2829 // Given the lock above, we can be confident in the title and page ID values
2830 $namespace = $this->getTitle()->getNamespace();
2831 $dbKey = $this->getTitle()->getDBkey();
2833 // At this point we are now comitted to returning an OK
2834 // status unless some DB query error or other exception comes up.
2835 // This way callers don't have to call rollback() if $status is bad
2836 // unless they actually try to catch exceptions (which is rare).
2838 // we need to remember the old content so we can use it to generate all deletion updates.
2839 $revision = $this->getRevision();
2841 $content = $this->getContent( Revision
::RAW
);
2842 } catch ( Exception
$ex ) {
2843 wfLogWarning( __METHOD__
. ': failed to load content during deletion! '
2844 . $ex->getMessage() );
2849 $revCommentStore = new CommentStore( 'rev_comment' );
2850 $arCommentStore = new CommentStore( 'ar_comment' );
2852 $revQuery = Revision
::getQueryInfo();
2855 // Bitfields to further suppress the content
2857 $bitfield = Revision
::SUPPRESSED_ALL
;
2858 $revQuery['fields'] = array_diff( $revQuery['fields'], [ 'rev_deleted' ] );
2861 // For now, shunt the revision data into the archive table.
2862 // Text is *not* removed from the text table; bulk storage
2863 // is left intact to avoid breaking block-compression or
2864 // immutable storage schemes.
2865 // In the future, we may keep revisions and mark them with
2866 // the rev_deleted field, which is reserved for this purpose.
2868 // Get all of the page revisions
2869 $res = $dbw->select(
2870 $revQuery['tables'],
2871 $revQuery['fields'],
2872 [ 'rev_page' => $id ],
2878 // Build their equivalent archive rows
2882 /** @var int[] Revision IDs of edits that were made by IPs */
2885 foreach ( $res as $row ) {
2886 $comment = $revCommentStore->getComment( $row );
2888 'ar_namespace' => $namespace,
2889 'ar_title' => $dbKey,
2890 'ar_user' => $row->rev_user
,
2891 'ar_user_text' => $row->rev_user_text
,
2892 'ar_timestamp' => $row->rev_timestamp
,
2893 'ar_minor_edit' => $row->rev_minor_edit
,
2894 'ar_rev_id' => $row->rev_id
,
2895 'ar_parent_id' => $row->rev_parent_id
,
2896 'ar_text_id' => $row->rev_text_id
,
2899 'ar_len' => $row->rev_len
,
2900 'ar_page_id' => $id,
2901 'ar_deleted' => $suppress ?
$bitfield : $row->rev_deleted
,
2902 'ar_sha1' => $row->rev_sha1
,
2903 ] +
$arCommentStore->insert( $dbw, $comment );
2904 if ( $wgContentHandlerUseDB ) {
2905 $rowInsert['ar_content_model'] = $row->rev_content_model
;
2906 $rowInsert['ar_content_format'] = $row->rev_content_format
;
2908 $rowsInsert[] = $rowInsert;
2909 $revids[] = $row->rev_id
;
2911 // Keep track of IP edits, so that the corresponding rows can
2912 // be deleted in the ip_changes table.
2913 if ( (int)$row->rev_user
=== 0 && IP
::isValid( $row->rev_user_text
) ) {
2914 $ipRevIds[] = $row->rev_id
;
2917 // Copy them into the archive table
2918 $dbw->insert( 'archive', $rowsInsert, __METHOD__
);
2919 // Save this so we can pass it to the ArticleDeleteComplete hook.
2920 $archivedRevisionCount = $dbw->affectedRows();
2922 // Clone the title and wikiPage, so we have the information we need when
2923 // we log and run the ArticleDeleteComplete hook.
2924 $logTitle = clone $this->mTitle
;
2925 $wikiPageBeforeDelete = clone $this;
2927 // Now that it's safely backed up, delete it
2928 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__
);
2929 $dbw->delete( 'revision', [ 'rev_page' => $id ], __METHOD__
);
2930 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
2931 $dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__
);
2934 // Also delete records from ip_changes as applicable.
2935 if ( count( $ipRevIds ) > 0 ) {
2936 $dbw->delete( 'ip_changes', [ 'ipc_rev_id' => $ipRevIds ], __METHOD__
);
2939 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2940 $logtype = $suppress ?
'suppress' : 'delete';
2942 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2943 $logEntry->setPerformer( $user );
2944 $logEntry->setTarget( $logTitle );
2945 $logEntry->setComment( $reason );
2946 $logEntry->setTags( $tags );
2947 $logid = $logEntry->insert();
2949 $dbw->onTransactionPreCommitOrIdle(
2950 function () use ( $dbw, $logEntry, $logid ) {
2951 // T58776: avoid deadlocks (especially from FileDeleteForm)
2952 $logEntry->publish( $logid );
2957 $dbw->endAtomic( __METHOD__
);
2959 $this->doDeleteUpdates( $id, $content, $revision, $user );
2961 Hooks
::run( 'ArticleDeleteComplete', [
2962 &$wikiPageBeforeDelete,
2968 $archivedRevisionCount
2970 $status->value
= $logid;
2972 // Show log excerpt on 404 pages rather than just a link
2973 $cache = MediaWikiServices
::getInstance()->getMainObjectStash();
2974 $key = $cache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2975 $cache->set( $key, 1, $cache::TTL_DAY
);
2981 * Lock the page row for this title+id and return page_latest (or 0)
2983 * @return int Returns 0 if no row was found with this title+id
2986 public function lockAndGetLatest() {
2987 return (int)wfGetDB( DB_MASTER
)->selectField(
2991 'page_id' => $this->getId(),
2992 // Typically page_id is enough, but some code might try to do
2993 // updates assuming the title is the same, so verify that
2994 'page_namespace' => $this->getTitle()->getNamespace(),
2995 'page_title' => $this->getTitle()->getDBkey()
3003 * Do some database updates after deletion
3005 * @param int $id The page_id value of the page being deleted
3006 * @param Content|null $content Optional page content to be used when determining
3007 * the required updates. This may be needed because $this->getContent()
3008 * may already return null when the page proper was deleted.
3009 * @param Revision|null $revision The latest page revision
3010 * @param User|null $user The user that caused the deletion
3012 public function doDeleteUpdates(
3013 $id, Content
$content = null, Revision
$revision = null, User
$user = null
3016 $countable = $this->isCountable();
3017 } catch ( Exception
$ex ) {
3018 // fallback for deleting broken pages for which we cannot load the content for
3019 // some reason. Note that doDeleteArticleReal() already logged this problem.
3023 // Update site status
3024 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$countable, -1 ) );
3026 // Delete pagelinks, update secondary indexes, etc
3027 $updates = $this->getDeletionUpdates( $content );
3028 foreach ( $updates as $update ) {
3029 DeferredUpdates
::addUpdate( $update );
3032 $causeAgent = $user ?
$user->getName() : 'unknown';
3033 // Reparse any pages transcluding this page
3034 LinksUpdate
::queueRecursiveJobsForTable(
3035 $this->mTitle
, 'templatelinks', 'delete-page', $causeAgent );
3036 // Reparse any pages including this image
3037 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
3038 LinksUpdate
::queueRecursiveJobsForTable(
3039 $this->mTitle
, 'imagelinks', 'delete-page', $causeAgent );
3043 self
::onArticleDelete( $this->mTitle
);
3044 ResourceLoaderWikiModule
::invalidateModuleCache(
3045 $this->mTitle
, $revision, null, wfWikiID()
3048 // Reset this object and the Title object
3049 $this->loadFromRow( false, self
::READ_LATEST
);
3052 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
3056 * Roll back the most recent consecutive set of edits to a page
3057 * from the same user; fails if there are no eligible edits to
3058 * roll back to, e.g. user is the sole contributor. This function
3059 * performs permissions checks on $user, then calls commitRollback()
3060 * to do the dirty work
3062 * @todo Separate the business/permission stuff out from backend code
3063 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3065 * @param string $fromP Name of the user whose edits to rollback.
3066 * @param string $summary Custom summary. Set to default summary if empty.
3067 * @param string $token Rollback token.
3068 * @param bool $bot If true, mark all reverted edits as bot.
3070 * @param array &$resultDetails Array contains result-specific array of additional values
3071 * 'alreadyrolled' : 'current' (rev)
3072 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3074 * @param User $user The user performing the rollback
3075 * @param array|null $tags Change tags to apply to the rollback
3076 * Callers are responsible for permission checks
3077 * (with ChangeTags::canAddTagsAccompanyingChange)
3079 * @return array Array of errors, each error formatted as
3080 * array(messagekey, param1, param2, ...).
3081 * On success, the array is empty. This array can also be passed to
3082 * OutputPage::showPermissionsErrorPage().
3084 public function doRollback(
3085 $fromP, $summary, $token, $bot, &$resultDetails, User
$user, $tags = null
3087 $resultDetails = null;
3089 // Check permissions
3090 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
3091 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
3092 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3094 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3095 $errors[] = [ 'sessionfailure' ];
3098 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
3099 $errors[] = [ 'actionthrottledtext' ];
3102 // If there were errors, bail out now
3103 if ( !empty( $errors ) ) {
3107 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3111 * Backend implementation of doRollback(), please refer there for parameter
3112 * and return value documentation
3114 * NOTE: This function does NOT check ANY permissions, it just commits the
3115 * rollback to the DB. Therefore, you should only call this function direct-
3116 * ly if you want to use custom permissions checks. If you don't, use
3117 * doRollback() instead.
3118 * @param string $fromP Name of the user whose edits to rollback.
3119 * @param string $summary Custom summary. Set to default summary if empty.
3120 * @param bool $bot If true, mark all reverted edits as bot.
3122 * @param array &$resultDetails Contains result-specific array of additional values
3123 * @param User $guser The user performing the rollback
3124 * @param array|null $tags Change tags to apply to the rollback
3125 * Callers are responsible for permission checks
3126 * (with ChangeTags::canAddTagsAccompanyingChange)
3130 public function commitRollback( $fromP, $summary, $bot,
3131 &$resultDetails, User
$guser, $tags = null
3133 global $wgUseRCPatrol, $wgContLang;
3135 $dbw = wfGetDB( DB_MASTER
);
3137 if ( wfReadOnly() ) {
3138 return [ [ 'readonlytext' ] ];
3141 // Get the last editor
3142 $current = $this->getRevision();
3143 if ( is_null( $current ) ) {
3144 // Something wrong... no page?
3145 return [ [ 'notanarticle' ] ];
3148 $from = str_replace( '_', ' ', $fromP );
3149 // User name given should match up with the top revision.
3150 // If the user was deleted then $from should be empty.
3151 if ( $from != $current->getUserText() ) {
3152 $resultDetails = [ 'current' => $current ];
3153 return [ [ 'alreadyrolled',
3154 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3155 htmlspecialchars( $fromP ),
3156 htmlspecialchars( $current->getUserText() )
3160 // Get the last edit not by this person...
3161 // Note: these may not be public values
3162 $user = intval( $current->getUser( Revision
::RAW
) );
3163 $user_text = $dbw->addQuotes( $current->getUserText( Revision
::RAW
) );
3164 $s = $dbw->selectRow( 'revision',
3165 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3166 [ 'rev_page' => $current->getPage(),
3167 "rev_user != {$user} OR rev_user_text != {$user_text}"
3169 [ 'USE INDEX' => 'page_timestamp',
3170 'ORDER BY' => 'rev_timestamp DESC' ]
3172 if ( $s === false ) {
3173 // No one else ever edited this page
3174 return [ [ 'cantrollback' ] ];
3175 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT
3176 ||
$s->rev_deleted
& Revision
::DELETED_USER
3178 // Only admins can see this text
3179 return [ [ 'notvisiblerev' ] ];
3182 // Generate the edit summary if necessary
3183 $target = Revision
::newFromId( $s->rev_id
, Revision
::READ_LATEST
);
3184 if ( empty( $summary ) ) {
3185 if ( $from == '' ) { // no public user name
3186 $summary = wfMessage( 'revertpage-nouser' );
3188 $summary = wfMessage( 'revertpage' );
3192 // Allow the custom summary to use the same args as the default message
3194 $target->getUserText(), $from, $s->rev_id
,
3195 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3196 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3198 if ( $summary instanceof Message
) {
3199 $summary = $summary->params( $args )->inContentLanguage()->text();
3201 $summary = wfMsgReplaceArgs( $summary, $args );
3204 // Trim spaces on user supplied text
3205 $summary = trim( $summary );
3208 $flags = EDIT_UPDATE | EDIT_INTERNAL
;
3210 if ( $guser->isAllowed( 'minoredit' ) ) {
3211 $flags |
= EDIT_MINOR
;
3214 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3215 $flags |
= EDIT_FORCE_BOT
;
3218 $targetContent = $target->getContent();
3219 $changingContentModel = $targetContent->getModel() !== $current->getContentModel();
3221 if ( in_array( 'mw-rollback', ChangeTags
::getSoftwareTags() ) ) {
3222 $tags[] = 'mw-rollback';
3225 // Actually store the edit
3226 $status = $this->doEditContent(
3236 // Set patrolling and bot flag on the edits, which gets rollbacked.
3237 // This is done even on edit failure to have patrolling in that case (T64157).
3239 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3240 // Mark all reverted edits as bot
3244 if ( $wgUseRCPatrol ) {
3245 // Mark all reverted edits as patrolled
3246 $set['rc_patrolled'] = 1;
3249 if ( count( $set ) ) {
3250 $dbw->update( 'recentchanges', $set,
3252 'rc_cur_id' => $current->getPage(),
3253 'rc_user_text' => $current->getUserText(),
3254 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3260 if ( !$status->isOK() ) {
3261 return $status->getErrorsArray();
3264 // raise error, when the edit is an edit without a new version
3265 $statusRev = isset( $status->value
['revision'] )
3266 ?
$status->value
['revision']
3268 if ( !( $statusRev instanceof Revision
) ) {
3269 $resultDetails = [ 'current' => $current ];
3270 return [ [ 'alreadyrolled',
3271 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3272 htmlspecialchars( $fromP ),
3273 htmlspecialchars( $current->getUserText() )
3277 if ( $changingContentModel ) {
3278 // If the content model changed during the rollback,
3279 // make sure it gets logged to Special:Log/contentmodel
3280 $log = new ManualLogEntry( 'contentmodel', 'change' );
3281 $log->setPerformer( $guser );
3282 $log->setTarget( $this->mTitle
);
3283 $log->setComment( $summary );
3284 $log->setParameters( [
3285 '4::oldmodel' => $current->getContentModel(),
3286 '5::newmodel' => $targetContent->getModel(),
3289 $logId = $log->insert( $dbw );
3290 $log->publish( $logId );
3293 $revId = $statusRev->getId();
3295 Hooks
::run( 'ArticleRollbackComplete', [ $this, $guser, $target, $current ] );
3298 'summary' => $summary,
3299 'current' => $current,
3300 'target' => $target,
3309 * The onArticle*() functions are supposed to be a kind of hooks
3310 * which should be called whenever any of the specified actions
3313 * This is a good place to put code to clear caches, for instance.
3315 * This is called on page move and undelete, as well as edit
3317 * @param Title $title
3319 public static function onArticleCreate( Title
$title ) {
3320 // Update existence markers on article/talk tabs...
3321 $other = $title->getOtherPage();
3323 $other->purgeSquid();
3325 $title->touchLinks();
3326 $title->purgeSquid();
3327 $title->deleteTitleProtection();
3329 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3331 // Invalidate caches of articles which include this page
3332 DeferredUpdates
::addUpdate(
3333 new HTMLCacheUpdate( $title, 'templatelinks', 'page-create' )
3336 if ( $title->getNamespace() == NS_CATEGORY
) {
3337 // Load the Category object, which will schedule a job to create
3338 // the category table row if necessary. Checking a replica DB is ok
3339 // here, in the worst case it'll run an unnecessary recount job on
3340 // a category that probably doesn't have many members.
3341 Category
::newFromTitle( $title )->getID();
3346 * Clears caches when article is deleted
3348 * @param Title $title
3350 public static function onArticleDelete( Title
$title ) {
3351 // Update existence markers on article/talk tabs...
3352 $other = $title->getOtherPage();
3354 $other->purgeSquid();
3356 $title->touchLinks();
3357 $title->purgeSquid();
3359 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3362 HTMLFileCache
::clearFileCache( $title );
3363 InfoAction
::invalidateCache( $title );
3366 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3367 MessageCache
::singleton()->updateMessageOverride( $title, null );
3371 if ( $title->getNamespace() == NS_FILE
) {
3372 DeferredUpdates
::addUpdate(
3373 new HTMLCacheUpdate( $title, 'imagelinks', 'page-delete' )
3378 if ( $title->getNamespace() == NS_USER_TALK
) {
3379 $user = User
::newFromName( $title->getText(), false );
3381 $user->setNewtalk( false );
3386 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3390 * Purge caches on page update etc
3392 * @param Title $title
3393 * @param Revision|null $revision Revision that was just saved, may be null
3395 public static function onArticleEdit( Title
$title, Revision
$revision = null ) {
3396 // Invalidate caches of articles which include this page
3397 DeferredUpdates
::addUpdate(
3398 new HTMLCacheUpdate( $title, 'templatelinks', 'page-edit' )
3401 // Invalidate the caches of all pages which redirect here
3402 DeferredUpdates
::addUpdate(
3403 new HTMLCacheUpdate( $title, 'redirect', 'page-edit' )
3406 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3408 // Purge CDN for this page only
3409 $title->purgeSquid();
3410 // Clear file cache for this page only
3411 HTMLFileCache
::clearFileCache( $title );
3413 $revid = $revision ?
$revision->getId() : null;
3414 DeferredUpdates
::addCallableUpdate( function () use ( $title, $revid ) {
3415 InfoAction
::invalidateCache( $title, $revid );
3422 * Returns a list of categories this page is a member of.
3423 * Results will include hidden categories
3425 * @return TitleArray
3427 public function getCategories() {
3428 $id = $this->getId();
3430 return TitleArray
::newFromResult( new FakeResultWrapper( [] ) );
3433 $dbr = wfGetDB( DB_REPLICA
);
3434 $res = $dbr->select( 'categorylinks',
3435 [ 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ],
3436 // Have to do that since Database::fieldNamesWithAlias treats numeric indexes
3437 // as not being aliases, and NS_CATEGORY is numeric
3438 [ 'cl_from' => $id ],
3441 return TitleArray
::newFromResult( $res );
3445 * Returns a list of hidden categories this page is a member of.
3446 * Uses the page_props and categorylinks tables.
3448 * @return array Array of Title objects
3450 public function getHiddenCategories() {
3452 $id = $this->getId();
3458 $dbr = wfGetDB( DB_REPLICA
);
3459 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3461 [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3462 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ],
3465 if ( $res !== false ) {
3466 foreach ( $res as $row ) {
3467 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3475 * Auto-generates a deletion reason
3477 * @param bool &$hasHistory Whether the page has a history
3478 * @return string|bool String containing deletion reason or empty string, or boolean false
3479 * if no revision occurred
3481 public function getAutoDeleteReason( &$hasHistory ) {
3482 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3486 * Update all the appropriate counts in the category table, given that
3487 * we've added the categories $added and deleted the categories $deleted.
3489 * This should only be called from deferred updates or jobs to avoid contention.
3491 * @param array $added The names of categories that were added
3492 * @param array $deleted The names of categories that were deleted
3493 * @param int $id Page ID (this should be the original deleted page ID)
3495 public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3496 $id = $id ?
: $this->getId();
3497 $ns = $this->getTitle()->getNamespace();
3499 $addFields = [ 'cat_pages = cat_pages + 1' ];
3500 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3501 if ( $ns == NS_CATEGORY
) {
3502 $addFields[] = 'cat_subcats = cat_subcats + 1';
3503 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3504 } elseif ( $ns == NS_FILE
) {
3505 $addFields[] = 'cat_files = cat_files + 1';
3506 $removeFields[] = 'cat_files = cat_files - 1';
3509 $dbw = wfGetDB( DB_MASTER
);
3511 if ( count( $added ) ) {
3512 $existingAdded = $dbw->selectFieldValues(
3515 [ 'cat_title' => $added ],
3519 // For category rows that already exist, do a plain
3520 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3521 // to avoid creating gaps in the cat_id sequence.
3522 if ( count( $existingAdded ) ) {
3526 [ 'cat_title' => $existingAdded ],
3531 $missingAdded = array_diff( $added, $existingAdded );
3532 if ( count( $missingAdded ) ) {
3534 foreach ( $missingAdded as $cat ) {
3536 'cat_title' => $cat,
3538 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3539 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3552 if ( count( $deleted ) ) {
3556 [ 'cat_title' => $deleted ],
3561 foreach ( $added as $catName ) {
3562 $cat = Category
::newFromName( $catName );
3563 Hooks
::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3566 foreach ( $deleted as $catName ) {
3567 $cat = Category
::newFromName( $catName );
3568 Hooks
::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3571 // Refresh counts on categories that should be empty now, to
3572 // trigger possible deletion. Check master for the most
3573 // up-to-date cat_pages.
3574 if ( count( $deleted ) ) {
3575 $rows = $dbw->select(
3577 [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
3578 [ 'cat_title' => $deleted, 'cat_pages <= 0' ],
3581 foreach ( $rows as $row ) {
3582 $cat = Category
::newFromRow( $row );
3583 // T166757: do the update after this DB commit
3584 DeferredUpdates
::addCallableUpdate( function () use ( $cat ) {
3585 $cat->refreshCounts();
3592 * Opportunistically enqueue link update jobs given fresh parser output if useful
3594 * @param ParserOutput $parserOutput Current version page output
3597 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3598 if ( wfReadOnly() ) {
3602 if ( !Hooks
::run( 'OpportunisticLinksUpdate',
3603 [ $this, $this->mTitle
, $parserOutput ]
3608 $config = RequestContext
::getMain()->getConfig();
3611 'isOpportunistic' => true,
3612 'rootJobTimestamp' => $parserOutput->getCacheTime()
3615 if ( $this->mTitle
->areRestrictionsCascading() ) {
3616 // If the page is cascade protecting, the links should really be up-to-date
3617 JobQueueGroup
::singleton()->lazyPush(
3618 RefreshLinksJob
::newPrioritized( $this->mTitle
, $params )
3620 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3621 // Assume the output contains "dynamic" time/random based magic words.
3622 // Only update pages that expired due to dynamic content and NOT due to edits
3623 // to referenced templates/files. When the cache expires due to dynamic content,
3624 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3625 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3626 // template/file edit already triggered recursive RefreshLinksJob jobs.
3627 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3628 // If a page is uncacheable, do not keep spamming a job for it.
3629 // Although it would be de-duplicated, it would still waste I/O.
3630 $cache = ObjectCache
::getLocalClusterInstance();
3631 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3632 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3633 if ( $cache->add( $key, time(), $ttl ) ) {
3634 JobQueueGroup
::singleton()->lazyPush(
3635 RefreshLinksJob
::newDynamic( $this->mTitle
, $params )
3643 * Returns a list of updates to be performed when this page is deleted. The
3644 * updates should remove any information about this page from secondary data
3645 * stores such as links tables.
3647 * @param Content|null $content Optional Content object for determining the
3648 * necessary updates.
3649 * @return DeferrableUpdate[]
3651 public function getDeletionUpdates( Content
$content = null ) {
3653 // load content object, which may be used to determine the necessary updates.
3654 // XXX: the content may not be needed to determine the updates.
3656 $content = $this->getContent( Revision
::RAW
);
3657 } catch ( Exception
$ex ) {
3658 // If we can't load the content, something is wrong. Perhaps that's why
3659 // the user is trying to delete the page, so let's not fail in that case.
3660 // Note that doDeleteArticleReal() will already have logged an issue with
3661 // loading the content.
3668 $updates = $content->getDeletionUpdates( $this );
3671 Hooks
::run( 'WikiPageDeletionUpdates', [ $this, $content, &$updates ] );
3676 * Whether this content displayed on this page
3677 * comes from the local database
3682 public function isLocal() {
3687 * The display name for the site this content
3688 * come from. If a subclass overrides isLocal(),
3689 * this could return something other than the
3695 public function getWikiDisplayName() {
3701 * Get the source URL for the content on this page,
3702 * typically the canonical URL, but may be a remote
3703 * link if the content comes from another site
3708 public function getSourceURL() {
3709 return $this->getTitle()->getCanonicalURL();
3713 * @param WANObjectCache $cache
3717 public function getMutableCacheKeys( WANObjectCache
$cache ) {
3718 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3720 return $linkCache->getMutableCacheKeys( $cache, $this->getTitle()->getTitleValue() );