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\Assert\Assert
;
27 use Wikimedia\Rdbms\FakeResultWrapper
;
28 use Wikimedia\Rdbms\IDatabase
;
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 $loadBalancer = MediaWikiServices
::getInstance()->getDBLoadBalancer();
437 $db = $loadBalancer->getConnection( $index );
438 $data = $this->pageDataFromTitle( $db, $this->mTitle
, $opts );
441 && $index == DB_REPLICA
442 && $loadBalancer->getServerCount() > 1
443 && $loadBalancer->hasOrMadeRecentMasterChanges()
445 $from = self
::READ_LATEST
;
446 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
447 $db = $loadBalancer->getConnection( $index );
448 $data = $this->pageDataFromTitle( $db, $this->mTitle
, $opts );
451 // No idea from where the caller got this data, assume replica DB.
453 $from = self
::READ_NORMAL
;
456 $this->loadFromRow( $data, $from );
460 * Load the object from a database row
463 * @param object|bool $data DB row containing fields returned by selectFields() or false
464 * @param string|int $from One of the following:
465 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB
466 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
467 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
468 * the master DB using SELECT FOR UPDATE
470 public function loadFromRow( $data, $from ) {
471 $lc = MediaWikiServices
::getInstance()->getLinkCache();
472 $lc->clearLink( $this->mTitle
);
475 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
477 $this->mTitle
->loadFromRow( $data );
479 // Old-fashioned restrictions
480 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
482 $this->mId
= intval( $data->page_id
);
483 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
484 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
485 $this->mIsRedirect
= intval( $data->page_is_redirect
);
486 $this->mLatest
= intval( $data->page_latest
);
487 // T39225: $latest may no longer match the cached latest Revision object.
488 // Double-check the ID of any cached latest Revision object for consistency.
489 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
490 $this->mLastRevision
= null;
491 $this->mTimestamp
= '';
494 $lc->addBadLinkObj( $this->mTitle
);
496 $this->mTitle
->loadFromRow( false );
498 $this->clearCacheFields();
503 $this->mDataLoaded
= true;
504 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
508 * @return int Page ID
510 public function getId() {
511 if ( !$this->mDataLoaded
) {
512 $this->loadPageData();
518 * @return bool Whether or not the page exists in the database
520 public function exists() {
521 if ( !$this->mDataLoaded
) {
522 $this->loadPageData();
524 return $this->mId
> 0;
528 * Check if this page is something we're going to be showing
529 * some sort of sensible content for. If we return false, page
530 * views (plain action=view) will return an HTTP 404 response,
531 * so spiders and robots can know they're following a bad link.
535 public function hasViewableContent() {
536 return $this->mTitle
->isKnown();
540 * Tests if the article content represents a redirect
544 public function isRedirect() {
545 if ( !$this->mDataLoaded
) {
546 $this->loadPageData();
549 return (bool)$this->mIsRedirect
;
553 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
555 * Will use the revisions actual content model if the page exists,
556 * and the page's default if the page doesn't exist yet.
562 public function getContentModel() {
563 if ( $this->exists() ) {
564 $cache = ObjectCache
::getMainWANInstance();
566 return $cache->getWithSetCallback(
567 $cache->makeKey( 'page-content-model', $this->getLatest() ),
570 $rev = $this->getRevision();
572 // Look at the revision's actual content model
573 return $rev->getContentModel();
575 $title = $this->mTitle
->getPrefixedDBkey();
576 wfWarn( "Page $title exists but has no (visible) revisions!" );
577 return $this->mTitle
->getContentModel();
583 // use the default model for this page
584 return $this->mTitle
->getContentModel();
588 * Loads page_touched and returns a value indicating if it should be used
589 * @return bool True if this page exists and is not a redirect
591 public function checkTouched() {
592 if ( !$this->mDataLoaded
) {
593 $this->loadPageData();
595 return ( $this->mId
&& !$this->mIsRedirect
);
599 * Get the page_touched field
600 * @return string Containing GMT timestamp
602 public function getTouched() {
603 if ( !$this->mDataLoaded
) {
604 $this->loadPageData();
606 return $this->mTouched
;
610 * Get the page_links_updated field
611 * @return string|null Containing GMT timestamp
613 public function getLinksTimestamp() {
614 if ( !$this->mDataLoaded
) {
615 $this->loadPageData();
617 return $this->mLinksUpdated
;
621 * Get the page_latest field
622 * @return int The rev_id of current revision
624 public function getLatest() {
625 if ( !$this->mDataLoaded
) {
626 $this->loadPageData();
628 return (int)$this->mLatest
;
632 * Get the Revision object of the oldest revision
633 * @return Revision|null
635 public function getOldestRevision() {
636 // Try using the replica DB first, then try the master
637 $rev = $this->mTitle
->getFirstRevision();
639 $rev = $this->mTitle
->getFirstRevision( Title
::GAID_FOR_UPDATE
);
645 * Loads everything except the text
646 * This isn't necessary for all uses, so it's only done if needed.
648 protected function loadLastEdit() {
649 if ( $this->mLastRevision
!== null ) {
650 return; // already loaded
653 $latest = $this->getLatest();
655 return; // page doesn't exist or is missing page_latest info
658 if ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) {
659 // T39225: if session S1 loads the page row FOR UPDATE, the result always
660 // includes the latest changes committed. This is true even within REPEATABLE-READ
661 // transactions, where S1 normally only sees changes committed before the first S1
662 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
663 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
664 // happened after the first S1 SELECT.
665 // https://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read
666 $flags = Revision
::READ_LOCKING
;
667 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
668 } elseif ( $this->mDataLoadedFrom
== self
::READ_LATEST
) {
669 // Bug T93976: if page_latest was loaded from the master, fetch the
670 // revision from there as well, as it may not exist yet on a replica DB.
671 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
672 $flags = Revision
::READ_LATEST
;
673 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
675 $dbr = wfGetDB( DB_REPLICA
);
676 $revision = Revision
::newKnownCurrent( $dbr, $this->getTitle(), $latest );
679 if ( $revision ) { // sanity
680 $this->setLastEdit( $revision );
685 * Set the latest revision
686 * @param Revision $revision
688 protected function setLastEdit( Revision
$revision ) {
689 $this->mLastRevision
= $revision;
690 $this->mTimestamp
= $revision->getTimestamp();
694 * Get the latest revision
695 * @return Revision|null
697 public function getRevision() {
698 $this->loadLastEdit();
699 if ( $this->mLastRevision
) {
700 return $this->mLastRevision
;
706 * Get the content of the current revision. No side-effects...
708 * @param int $audience One of:
709 * Revision::FOR_PUBLIC to be displayed to all users
710 * Revision::FOR_THIS_USER to be displayed to $wgUser
711 * Revision::RAW get the text regardless of permissions
712 * @param User $user User object to check for, only if FOR_THIS_USER is passed
713 * to the $audience parameter
714 * @return Content|null The content of the current revision
718 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
719 $this->loadLastEdit();
720 if ( $this->mLastRevision
) {
721 return $this->mLastRevision
->getContent( $audience, $user );
727 * @return string MW timestamp of last article revision
729 public function getTimestamp() {
730 // Check if the field has been filled by WikiPage::setTimestamp()
731 if ( !$this->mTimestamp
) {
732 $this->loadLastEdit();
735 return wfTimestamp( TS_MW
, $this->mTimestamp
);
739 * Set the page timestamp (use only to avoid DB queries)
740 * @param string $ts MW timestamp of last article revision
743 public function setTimestamp( $ts ) {
744 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
748 * @param int $audience One of:
749 * Revision::FOR_PUBLIC to be displayed to all users
750 * Revision::FOR_THIS_USER to be displayed to the given user
751 * Revision::RAW get the text regardless of permissions
752 * @param User $user User object to check for, only if FOR_THIS_USER is passed
753 * to the $audience parameter
754 * @return int User ID for the user that made the last article revision
756 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
757 $this->loadLastEdit();
758 if ( $this->mLastRevision
) {
759 return $this->mLastRevision
->getUser( $audience, $user );
766 * Get the User object of the user who created the page
767 * @param int $audience One of:
768 * Revision::FOR_PUBLIC to be displayed to all users
769 * Revision::FOR_THIS_USER to be displayed to the given user
770 * Revision::RAW get the text regardless of permissions
771 * @param User $user User object to check for, only if FOR_THIS_USER is passed
772 * to the $audience parameter
775 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
776 $revision = $this->getOldestRevision();
778 $userName = $revision->getUserText( $audience, $user );
779 return User
::newFromName( $userName, false );
786 * @param int $audience One of:
787 * Revision::FOR_PUBLIC to be displayed to all users
788 * Revision::FOR_THIS_USER to be displayed to the given user
789 * Revision::RAW get the text regardless of permissions
790 * @param User $user User object to check for, only if FOR_THIS_USER is passed
791 * to the $audience parameter
792 * @return string Username of the user that made the last article revision
794 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
795 $this->loadLastEdit();
796 if ( $this->mLastRevision
) {
797 return $this->mLastRevision
->getUserText( $audience, $user );
804 * @param int $audience One of:
805 * Revision::FOR_PUBLIC to be displayed to all users
806 * Revision::FOR_THIS_USER to be displayed to the given user
807 * Revision::RAW get the text regardless of permissions
808 * @param User $user User object to check for, only if FOR_THIS_USER is passed
809 * to the $audience parameter
810 * @return string Comment stored for the last article revision
812 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
813 $this->loadLastEdit();
814 if ( $this->mLastRevision
) {
815 return $this->mLastRevision
->getComment( $audience, $user );
822 * Returns true if last revision was marked as "minor edit"
824 * @return bool Minor edit indicator for the last article revision.
826 public function getMinorEdit() {
827 $this->loadLastEdit();
828 if ( $this->mLastRevision
) {
829 return $this->mLastRevision
->isMinor();
836 * Determine whether a page would be suitable for being counted as an
837 * article in the site_stats table based on the title & its content
839 * @param PreparedEdit|bool $editInfo (false): object returned by prepareTextForEdit(),
840 * if false, the current database state will be used
843 public function isCountable( $editInfo = false ) {
844 global $wgArticleCountMethod;
846 if ( !$this->mTitle
->isContentPage() ) {
851 $content = $editInfo->pstContent
;
853 $content = $this->getContent();
856 if ( !$content ||
$content->isRedirect() ) {
862 if ( $wgArticleCountMethod === 'link' ) {
863 // nasty special case to avoid re-parsing to detect links
866 // ParserOutput::getLinks() is a 2D array of page links, so
867 // to be really correct we would need to recurse in the array
868 // but the main array should only have items in it if there are
870 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
872 $hasLinks = (bool)wfGetDB( DB_REPLICA
)->selectField( 'pagelinks', 1,
873 [ 'pl_from' => $this->getId() ], __METHOD__
);
877 return $content->isCountable( $hasLinks );
881 * If this page is a redirect, get its target
883 * The target will be fetched from the redirect table if possible.
884 * If this page doesn't have an entry there, call insertRedirect()
885 * @return Title|null Title object, or null if this page is not a redirect
887 public function getRedirectTarget() {
888 if ( !$this->mTitle
->isRedirect() ) {
892 if ( $this->mRedirectTarget
!== null ) {
893 return $this->mRedirectTarget
;
896 // Query the redirect table
897 $dbr = wfGetDB( DB_REPLICA
);
898 $row = $dbr->selectRow( 'redirect',
899 [ 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ],
900 [ 'rd_from' => $this->getId() ],
904 // rd_fragment and rd_interwiki were added later, populate them if empty
905 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
906 $this->mRedirectTarget
= Title
::makeTitle(
907 $row->rd_namespace
, $row->rd_title
,
908 $row->rd_fragment
, $row->rd_interwiki
910 return $this->mRedirectTarget
;
913 // This page doesn't have an entry in the redirect table
914 $this->mRedirectTarget
= $this->insertRedirect();
915 return $this->mRedirectTarget
;
919 * Insert an entry for this page into the redirect table if the content is a redirect
921 * The database update will be deferred via DeferredUpdates
923 * Don't call this function directly unless you know what you're doing.
924 * @return Title|null Title object or null if not a redirect
926 public function insertRedirect() {
927 $content = $this->getContent();
928 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
933 // Update the DB post-send if the page has not cached since now
934 $latest = $this->getLatest();
935 DeferredUpdates
::addCallableUpdate(
936 function () use ( $retval, $latest ) {
937 $this->insertRedirectEntry( $retval, $latest );
939 DeferredUpdates
::POSTSEND
,
947 * Insert or update the redirect table entry for this page to indicate it redirects to $rt
948 * @param Title $rt Redirect target
949 * @param int|null $oldLatest Prior page_latest for check and set
951 public function insertRedirectEntry( Title
$rt, $oldLatest = null ) {
952 $dbw = wfGetDB( DB_MASTER
);
953 $dbw->startAtomic( __METHOD__
);
955 if ( !$oldLatest ||
$oldLatest == $this->lockAndGetLatest() ) {
959 'rd_from' => $this->getId(),
960 'rd_namespace' => $rt->getNamespace(),
961 'rd_title' => $rt->getDBkey(),
962 'rd_fragment' => $rt->getFragment(),
963 'rd_interwiki' => $rt->getInterwiki(),
967 'rd_namespace' => $rt->getNamespace(),
968 'rd_title' => $rt->getDBkey(),
969 'rd_fragment' => $rt->getFragment(),
970 'rd_interwiki' => $rt->getInterwiki(),
976 $dbw->endAtomic( __METHOD__
);
980 * Get the Title object or URL this page redirects to
982 * @return bool|Title|string False, Title of in-wiki target, or string with URL
984 public function followRedirect() {
985 return $this->getRedirectURL( $this->getRedirectTarget() );
989 * Get the Title object or URL to use for a redirect. We use Title
990 * objects for same-wiki, non-special redirects and URLs for everything
992 * @param Title $rt Redirect target
993 * @return bool|Title|string False, Title object of local target, or string with URL
995 public function getRedirectURL( $rt ) {
1000 if ( $rt->isExternal() ) {
1001 if ( $rt->isLocal() ) {
1002 // Offsite wikis need an HTTP redirect.
1003 // This can be hard to reverse and may produce loops,
1004 // so they may be disabled in the site configuration.
1005 $source = $this->mTitle
->getFullURL( 'redirect=no' );
1006 return $rt->getFullURL( [ 'rdfrom' => $source ] );
1008 // External pages without "local" bit set are not valid
1014 if ( $rt->isSpecialPage() ) {
1015 // Gotta handle redirects to special pages differently:
1016 // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
1017 // Some pages are not valid targets.
1018 if ( $rt->isValidRedirectTarget() ) {
1019 return $rt->getFullURL();
1029 * Get a list of users who have edited this article, not including the user who made
1030 * the most recent revision, which you can get from $article->getUser() if you want it
1031 * @return UserArrayFromResult
1033 public function getContributors() {
1034 // @todo FIXME: This is expensive; cache this info somewhere.
1036 $dbr = wfGetDB( DB_REPLICA
);
1038 $actorMigration = ActorMigration
::newMigration();
1039 $actorQuery = $actorMigration->getJoin( 'rev_user' );
1041 $tables = array_merge( [ 'revision' ], $actorQuery['tables'], [ 'user' ] );
1044 'user_id' => $actorQuery['fields']['rev_user'],
1045 'user_name' => $actorQuery['fields']['rev_user_text'],
1046 'actor_id' => $actorQuery['fields']['rev_actor'],
1047 'user_real_name' => 'MIN(user_real_name)',
1048 'timestamp' => 'MAX(rev_timestamp)',
1051 $conds = [ 'rev_page' => $this->getId() ];
1053 // The user who made the top revision gets credited as "this page was last edited by
1054 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1055 $user = $this->getUser()
1056 ? User
::newFromId( $this->getUser() )
1057 : User
::newFromName( $this->getUserText(), false );
1058 $conds[] = 'NOT(' . $actorMigration->getWhere( $dbr, 'rev_user', $user )['conds'] . ')';
1061 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1064 'user' => [ 'LEFT JOIN', $actorQuery['fields']['rev_user'] . ' = user_id' ],
1065 ] +
$actorQuery['joins'];
1068 'GROUP BY' => [ $fields['user_id'], $fields['user_name'] ],
1069 'ORDER BY' => 'timestamp DESC',
1072 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1073 return new UserArrayFromResult( $res );
1077 * Should the parser cache be used?
1079 * @param ParserOptions $parserOptions ParserOptions to check
1083 public function shouldCheckParserCache( ParserOptions
$parserOptions, $oldId ) {
1084 return $parserOptions->getStubThreshold() == 0
1086 && ( $oldId === null ||
$oldId === 0 ||
$oldId === $this->getLatest() )
1087 && $this->getContentHandler()->isParserCacheSupported();
1091 * Get a ParserOutput for the given ParserOptions and revision ID.
1093 * The parser cache will be used if possible. Cache misses that result
1094 * in parser runs are debounced with PoolCounter.
1097 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1098 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1099 * get the current revision (default value)
1100 * @param bool $forceParse Force reindexing, regardless of cache settings
1101 * @return bool|ParserOutput ParserOutput or false if the revision was not found
1103 public function getParserOutput(
1104 ParserOptions
$parserOptions, $oldid = null, $forceParse = false
1107 ( !$forceParse ) && $this->shouldCheckParserCache( $parserOptions, $oldid );
1109 if ( $useParserCache && !$parserOptions->isSafeToCache() ) {
1110 throw new InvalidArgumentException(
1111 'The supplied ParserOptions are not safe to cache. Fix the options or set $forceParse = true.'
1115 wfDebug( __METHOD__
.
1116 ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1117 if ( $parserOptions->getStubThreshold() ) {
1118 wfIncrStats( 'pcache.miss.stub' );
1121 if ( $useParserCache ) {
1122 $parserOutput = MediaWikiServices
::getInstance()->getParserCache()
1123 ->get( $this, $parserOptions );
1124 if ( $parserOutput !== false ) {
1125 return $parserOutput;
1129 if ( $oldid === null ||
$oldid === 0 ) {
1130 $oldid = $this->getLatest();
1133 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1136 return $pool->getParserOutput();
1140 * Do standard deferred updates after page view (existing or missing page)
1141 * @param User $user The relevant user
1142 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1144 public function doViewUpdates( User
$user, $oldid = 0 ) {
1145 if ( wfReadOnly() ) {
1149 // Update newtalk / watchlist notification status;
1150 // Avoid outage if the master is not reachable by using a deferred updated
1151 DeferredUpdates
::addCallableUpdate(
1152 function () use ( $user, $oldid ) {
1153 Hooks
::run( 'PageViewUpdates', [ $this, $user ] );
1155 $user->clearNotification( $this->mTitle
, $oldid );
1157 DeferredUpdates
::PRESEND
1162 * Perform the actions of a page purging
1164 * @note In 1.28 (and only 1.28), this took a $flags parameter that
1165 * controlled how much purging was done.
1167 public function doPurge() {
1168 // Avoid PHP 7.1 warning of passing $this by reference
1171 if ( !Hooks
::run( 'ArticlePurge', [ &$wikiPage ] ) ) {
1175 $this->mTitle
->invalidateCache();
1178 HTMLFileCache
::clearFileCache( $this->getTitle() );
1179 // Send purge after above page_touched update was committed
1180 DeferredUpdates
::addUpdate(
1181 new CdnCacheUpdate( $this->mTitle
->getCdnUrls() ),
1182 DeferredUpdates
::PRESEND
1185 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1186 $messageCache = MessageCache
::singleton();
1187 $messageCache->updateMessageOverride( $this->mTitle
, $this->getContent() );
1194 * Insert a new empty page record for this article.
1195 * This *must* be followed up by creating a revision
1196 * and running $this->updateRevisionOn( ... );
1197 * or else the record will be left in a funky state.
1198 * Best if all done inside a transaction.
1200 * @param IDatabase $dbw
1201 * @param int|null $pageId Custom page ID that will be used for the insert statement
1203 * @return bool|int The newly created page_id key; false if the row was not
1204 * inserted, e.g. because the title already existed or because the specified
1205 * page ID is already in use.
1207 public function insertOn( $dbw, $pageId = null ) {
1208 $pageIdForInsert = $pageId ?
[ 'page_id' => $pageId ] : [];
1212 'page_namespace' => $this->mTitle
->getNamespace(),
1213 'page_title' => $this->mTitle
->getDBkey(),
1214 'page_restrictions' => '',
1215 'page_is_redirect' => 0, // Will set this shortly...
1217 'page_random' => wfRandom(),
1218 'page_touched' => $dbw->timestamp(),
1219 'page_latest' => 0, // Fill this in shortly...
1220 'page_len' => 0, // Fill this in shortly...
1221 ] +
$pageIdForInsert,
1226 if ( $dbw->affectedRows() > 0 ) {
1227 $newid = $pageId ?
(int)$pageId : $dbw->insertId();
1228 $this->mId
= $newid;
1229 $this->mTitle
->resetArticleID( $newid );
1233 return false; // nothing changed
1238 * Update the page record to point to a newly saved revision.
1240 * @param IDatabase $dbw
1241 * @param Revision $revision For ID number, and text used to set
1242 * length and redirect status fields
1243 * @param int $lastRevision If given, will not overwrite the page field
1244 * when different from the currently set value.
1245 * Giving 0 indicates the new page flag should be set on.
1246 * @param bool $lastRevIsRedirect If given, will optimize adding and
1247 * removing rows in redirect table.
1248 * @return bool Success; false if the page row was missing or page_latest changed
1250 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1251 $lastRevIsRedirect = null
1253 global $wgContentHandlerUseDB;
1255 // Assertion to try to catch T92046
1256 if ( (int)$revision->getId() === 0 ) {
1257 throw new InvalidArgumentException(
1258 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1262 $content = $revision->getContent();
1263 $len = $content ?
$content->getSize() : 0;
1264 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1266 $conditions = [ 'page_id' => $this->getId() ];
1268 if ( !is_null( $lastRevision ) ) {
1269 // An extra check against threads stepping on each other
1270 $conditions['page_latest'] = $lastRevision;
1273 $revId = $revision->getId();
1274 Assert
::parameter( $revId > 0, '$revision->getId()', 'must be > 0' );
1277 'page_latest' => $revId,
1278 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1279 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1280 'page_is_redirect' => $rt !== null ?
1 : 0,
1284 if ( $wgContentHandlerUseDB ) {
1285 $row['page_content_model'] = $revision->getContentModel();
1288 $dbw->update( 'page',
1293 $result = $dbw->affectedRows() > 0;
1295 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1296 $this->setLastEdit( $revision );
1297 $this->mLatest
= $revision->getId();
1298 $this->mIsRedirect
= (bool)$rt;
1299 // Update the LinkCache.
1300 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
1301 $linkCache->addGoodLinkObj(
1307 $revision->getContentModel()
1315 * Add row to the redirect table if this is a redirect, remove otherwise.
1317 * @param IDatabase $dbw
1318 * @param Title|null $redirectTitle Title object pointing to the redirect target,
1319 * or NULL if this is not a redirect
1320 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1321 * removing rows in redirect table.
1322 * @return bool True on success, false on failure
1325 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1326 // Always update redirects (target link might have changed)
1327 // Update/Insert if we don't know if the last revision was a redirect or not
1328 // Delete if changing from redirect to non-redirect
1329 $isRedirect = !is_null( $redirectTitle );
1331 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1335 if ( $isRedirect ) {
1336 $this->insertRedirectEntry( $redirectTitle );
1338 // This is not a redirect, remove row from redirect table
1339 $where = [ 'rd_from' => $this->getId() ];
1340 $dbw->delete( 'redirect', $where, __METHOD__
);
1343 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1344 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1347 return ( $dbw->affectedRows() != 0 );
1351 * If the given revision is newer than the currently set page_latest,
1352 * update the page record. Otherwise, do nothing.
1354 * @deprecated since 1.24, use updateRevisionOn instead
1356 * @param IDatabase $dbw
1357 * @param Revision $revision
1360 public function updateIfNewerOn( $dbw, $revision ) {
1361 $row = $dbw->selectRow(
1362 [ 'revision', 'page' ],
1363 [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1365 'page_id' => $this->getId(),
1366 'page_latest=rev_id' ],
1370 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1373 $prev = $row->rev_id
;
1374 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1376 // No or missing previous revision; mark the page as new
1378 $lastRevIsRedirect = null;
1381 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1387 * Get the content that needs to be saved in order to undo all revisions
1388 * between $undo and $undoafter. Revisions must belong to the same page,
1389 * must exist and must not be deleted
1390 * @param Revision $undo
1391 * @param Revision $undoafter Must be an earlier revision than $undo
1392 * @return Content|bool Content on success, false on failure
1394 * Before we had the Content object, this was done in getUndoText
1396 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1397 $handler = $undo->getContentHandler();
1398 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1402 * Returns true if this page's content model supports sections.
1406 * @todo The skin should check this and not offer section functionality if
1407 * sections are not supported.
1408 * @todo The EditPage should check this and not offer section functionality
1409 * if sections are not supported.
1411 public function supportsSections() {
1412 return $this->getContentHandler()->supportsSections();
1416 * @param string|int|null|bool $sectionId Section identifier as a number or string
1417 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1418 * or 'new' for a new section.
1419 * @param Content $sectionContent New content of the section.
1420 * @param string $sectionTitle New section's subject, only if $section is "new".
1421 * @param string $edittime Revision timestamp or null to use the current revision.
1423 * @throws MWException
1424 * @return Content|null New complete article content, or null if error.
1427 * @deprecated since 1.24, use replaceSectionAtRev instead
1429 public function replaceSectionContent(
1430 $sectionId, Content
$sectionContent, $sectionTitle = '', $edittime = null
1433 if ( $edittime && $sectionId !== 'new' ) {
1434 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
1435 $dbr = $lb->getConnection( DB_REPLICA
);
1436 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1437 // Try the master if this thread may have just added it.
1438 // This could be abstracted into a Revision method, but we don't want
1439 // to encourage loading of revisions by timestamp.
1441 && $lb->getServerCount() > 1
1442 && $lb->hasOrMadeRecentMasterChanges()
1444 $dbw = $lb->getConnection( DB_MASTER
);
1445 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1448 $baseRevId = $rev->getId();
1452 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1456 * @param string|int|null|bool $sectionId Section identifier as a number or string
1457 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1458 * or 'new' for a new section.
1459 * @param Content $sectionContent New content of the section.
1460 * @param string $sectionTitle New section's subject, only if $section is "new".
1461 * @param int|null $baseRevId
1463 * @throws MWException
1464 * @return Content|null New complete article content, or null if error.
1468 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1469 $sectionTitle = '', $baseRevId = null
1471 if ( strval( $sectionId ) === '' ) {
1472 // Whole-page edit; let the whole text through
1473 $newContent = $sectionContent;
1475 if ( !$this->supportsSections() ) {
1476 throw new MWException( "sections not supported for content model " .
1477 $this->getContentHandler()->getModelID() );
1480 // T32711: always use current version when adding a new section
1481 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1482 $oldContent = $this->getContent();
1484 $rev = Revision
::newFromId( $baseRevId );
1486 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1487 $this->getId() . "; section: $sectionId)\n" );
1491 $oldContent = $rev->getContent();
1494 if ( !$oldContent ) {
1495 wfDebug( __METHOD__
. ": no page text\n" );
1499 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1506 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1508 * @return int Updated $flags
1510 public function checkFlags( $flags ) {
1511 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1512 if ( $this->exists() ) {
1513 $flags |
= EDIT_UPDATE
;
1523 * Change an existing article or create a new article. Updates RC and all necessary caches,
1524 * optionally via the deferred update array.
1526 * @param Content $content New content
1527 * @param string $summary Edit summary
1528 * @param int $flags Bitfield:
1530 * Article is known or assumed to be non-existent, create a new one
1532 * Article is known or assumed to be pre-existing, update it
1534 * Mark this edit minor, if the user is allowed to do so
1536 * Do not log the change in recentchanges
1538 * Mark the edit a "bot" edit regardless of user rights
1540 * Fill in blank summaries with generated text where possible
1542 * Signal that the page retrieve/save cycle happened entirely in this request.
1544 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1545 * article will be detected. If EDIT_UPDATE is specified and the article
1546 * doesn't exist, the function will return an edit-gone-missing error. If
1547 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1548 * error will be returned. These two conditions are also possible with
1549 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1551 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1552 * This is not the parent revision ID, rather the revision ID for older
1553 * content used as the source for a rollback, for example.
1554 * @param User $user The user doing the edit
1555 * @param string $serialFormat Format for storing the content in the
1557 * @param array|null $tags Change tags to apply to this edit
1558 * Callers are responsible for permission checks
1559 * (with ChangeTags::canAddTagsAccompanyingChange)
1560 * @param Int $undidRevId Id of revision that was undone or 0
1562 * @throws MWException
1563 * @return Status Possible errors:
1564 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1565 * set the fatal flag of $status.
1566 * edit-gone-missing: In update mode, but the article didn't exist.
1567 * edit-conflict: In update mode, the article changed unexpectedly.
1568 * edit-no-change: Warning that the text was the same as before.
1569 * edit-already-exists: In creation mode, but the article already exists.
1571 * Extensions may define additional errors.
1573 * $return->value will contain an associative array with members as follows:
1574 * new: Boolean indicating if the function attempted to create a new article.
1575 * revision: The revision object for the inserted revision, or null.
1578 * @throws MWException
1580 public function doEditContent(
1581 Content
$content, $summary, $flags = 0, $baseRevId = false,
1582 User
$user = null, $serialFormat = null, $tags = [], $undidRevId = 0
1584 global $wgUser, $wgUseAutomaticEditSummaries;
1586 // Old default parameter for $tags was null
1587 if ( $tags === null ) {
1591 // Low-level sanity check
1592 if ( $this->mTitle
->getText() === '' ) {
1593 throw new MWException( 'Something is trying to edit an article with an empty title' );
1595 // Make sure the given content type is allowed for this page
1596 if ( !$content->getContentHandler()->canBeUsedOn( $this->mTitle
) ) {
1597 return Status
::newFatal( 'content-not-allowed-here',
1598 ContentHandler
::getLocalizedName( $content->getModel() ),
1599 $this->mTitle
->getPrefixedText()
1603 // Load the data from the master database if needed.
1604 // The caller may already loaded it from the master or even loaded it using
1605 // SELECT FOR UPDATE, so do not override that using clear().
1606 $this->loadPageData( 'fromdbmaster' );
1608 $user = $user ?
: $wgUser;
1609 $flags = $this->checkFlags( $flags );
1611 // Avoid PHP 7.1 warning of passing $this by reference
1614 // Trigger pre-save hook (using provided edit summary)
1615 $hookStatus = Status
::newGood( [] );
1616 $hook_args = [ &$wikiPage, &$user, &$content, &$summary,
1617 $flags & EDIT_MINOR
, null, null, &$flags, &$hookStatus ];
1618 // Check if the hook rejected the attempted save
1619 if ( !Hooks
::run( 'PageContentSave', $hook_args ) ) {
1620 if ( $hookStatus->isOK() ) {
1621 // Hook returned false but didn't call fatal(); use generic message
1622 $hookStatus->fatal( 'edit-hook-aborted' );
1628 $old_revision = $this->getRevision(); // current revision
1629 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1631 $handler = $content->getContentHandler();
1632 $tag = $handler->getChangeTag( $old_content, $content, $flags );
1633 // If there is no applicable tag, null is returned, so we need to check
1638 // Check for undo tag
1639 if ( $undidRevId !== 0 && in_array( 'mw-undo', ChangeTags
::getSoftwareTags() ) ) {
1640 $tags[] = 'mw-undo';
1643 // Provide autosummaries if summary is not provided and autosummaries are enabled
1644 if ( $wgUseAutomaticEditSummaries && ( $flags & EDIT_AUTOSUMMARY
) && $summary == '' ) {
1645 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1648 // Avoid statsd noise and wasted cycles check the edit stash (T136678)
1649 if ( ( $flags & EDIT_INTERNAL
) ||
( $flags & EDIT_FORCE_BOT
) ) {
1655 // Get the pre-save transform content and final parser output
1656 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat, $useCache );
1657 $pstContent = $editInfo->pstContent
; // Content object
1659 'bot' => ( $flags & EDIT_FORCE_BOT
),
1660 'minor' => ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' ),
1661 'serialized' => $pstContent->serialize( $serialFormat ),
1662 'serialFormat' => $serialFormat,
1663 'baseRevId' => $baseRevId,
1664 'oldRevision' => $old_revision,
1665 'oldContent' => $old_content,
1666 'oldId' => $this->getLatest(),
1667 'oldIsRedirect' => $this->isRedirect(),
1668 'oldCountable' => $this->isCountable(),
1669 'tags' => ( $tags !== null ) ?
(array)$tags : [],
1670 'undidRevId' => $undidRevId
1673 // Actually create the revision and create/update the page
1674 if ( $flags & EDIT_UPDATE
) {
1675 $status = $this->doModify( $pstContent, $flags, $user, $summary, $meta );
1677 $status = $this->doCreate( $pstContent, $flags, $user, $summary, $meta );
1680 // Promote user to any groups they meet the criteria for
1681 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
1682 $user->addAutopromoteOnceGroups( 'onEdit' );
1683 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1690 * @param Content $content Pre-save transform content
1693 * @param string $summary
1694 * @param array $meta
1696 * @throws DBUnexpectedError
1698 * @throws FatalError
1699 * @throws MWException
1701 private function doModify(
1702 Content
$content, $flags, User
$user, $summary, array $meta
1704 global $wgUseRCPatrol;
1706 // Update article, but only if changed.
1707 $status = Status
::newGood( [ 'new' => false, 'revision' => null ] );
1709 // Convenience variables
1710 $now = wfTimestampNow();
1711 $oldid = $meta['oldId'];
1712 /** @var Content|null $oldContent */
1713 $oldContent = $meta['oldContent'];
1714 $newsize = $content->getSize();
1717 // Article gone missing
1718 $status->fatal( 'edit-gone-missing' );
1721 } elseif ( !$oldContent ) {
1722 // Sanity check for T39225
1723 throw new MWException( "Could not find text for current revision {$oldid}." );
1726 $changed = !$content->equals( $oldContent );
1728 $dbw = wfGetDB( DB_MASTER
);
1731 // @TODO: pass content object?!
1732 $revision = new Revision( [
1733 'page' => $this->getId(),
1734 'title' => $this->mTitle
, // for determining the default content model
1735 'comment' => $summary,
1736 'minor_edit' => $meta['minor'],
1737 'text' => $meta['serialized'],
1739 'parent_id' => $oldid,
1740 'user' => $user->getId(),
1741 'user_text' => $user->getName(),
1742 'timestamp' => $now,
1743 'content_model' => $content->getModel(),
1744 'content_format' => $meta['serialFormat'],
1747 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1748 $status->merge( $prepStatus );
1749 if ( !$status->isOK() ) {
1753 $dbw->startAtomic( __METHOD__
);
1754 // Get the latest page_latest value while locking it.
1755 // Do a CAS style check to see if it's the same as when this method
1756 // started. If it changed then bail out before touching the DB.
1757 $latestNow = $this->lockAndGetLatest();
1758 if ( $latestNow != $oldid ) {
1759 $dbw->endAtomic( __METHOD__
);
1760 // Page updated or deleted in the mean time
1761 $status->fatal( 'edit-conflict' );
1766 // At this point we are now comitted to returning an OK
1767 // status unless some DB query error or other exception comes up.
1768 // This way callers don't have to call rollback() if $status is bad
1769 // unless they actually try to catch exceptions (which is rare).
1771 // Save the revision text
1772 $revisionId = $revision->insertOn( $dbw );
1773 // Update page_latest and friends to reflect the new revision
1774 if ( !$this->updateRevisionOn( $dbw, $revision, null, $meta['oldIsRedirect'] ) ) {
1775 throw new MWException( "Failed to update page row to use new revision." );
1778 $tags = $meta['tags'];
1779 Hooks
::run( 'NewRevisionFromEditComplete',
1780 [ $this, $revision, $meta['baseRevId'], $user, &$tags ] );
1782 // Update recentchanges
1783 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1784 // Mark as patrolled if the user can do so
1785 $autopatrolled = $wgUseRCPatrol && !count(
1786 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1787 // Add RC row to the DB
1788 RecentChange
::notifyEdit(
1791 $revision->isMinor(),
1795 $this->getTimestamp(),
1798 $oldContent ?
$oldContent->getSize() : 0,
1801 $autopatrolled ? RecentChange
::PRC_AUTOPATROLLED
:
1802 RecentChange
::PRC_UNPATROLLED
,
1807 $user->incEditCount();
1809 $dbw->endAtomic( __METHOD__
);
1810 $this->mTimestamp
= $now;
1812 // T34948: revision ID must be set to page {{REVISIONID}} and
1813 // related variables correctly. Likewise for {{REVISIONUSER}} (T135261).
1814 // Since we don't insert a new revision into the database, the least
1815 // error-prone way is to reuse given old revision.
1816 $revision = $meta['oldRevision'];
1820 // Return the new revision to the caller
1821 $status->value
['revision'] = $revision;
1823 $status->warning( 'edit-no-change' );
1824 // Update page_touched as updateRevisionOn() was not called.
1825 // Other cache updates are managed in onArticleEdit() via doEditUpdates().
1826 $this->mTitle
->invalidateCache( $now );
1829 // Do secondary updates once the main changes have been committed...
1830 DeferredUpdates
::addUpdate(
1831 new AtomicSectionUpdate(
1835 $revision, &$user, $content, $summary, &$flags,
1836 $changed, $meta, &$status
1838 // Update links tables, site stats, etc.
1839 $this->doEditUpdates(
1843 'changed' => $changed,
1844 'oldcountable' => $meta['oldCountable'],
1845 'oldrevision' => $meta['oldRevision']
1848 // Avoid PHP 7.1 warning of passing $this by reference
1850 // Trigger post-save hook
1851 $params = [ &$wikiPage, &$user, $content, $summary, $flags & EDIT_MINOR
,
1852 null, null, &$flags, $revision, &$status, $meta['baseRevId'],
1853 $meta['undidRevId'] ];
1854 Hooks
::run( 'PageContentSaveComplete', $params );
1857 DeferredUpdates
::PRESEND
1864 * @param Content $content Pre-save transform content
1867 * @param string $summary
1868 * @param array $meta
1870 * @throws DBUnexpectedError
1872 * @throws FatalError
1873 * @throws MWException
1875 private function doCreate(
1876 Content
$content, $flags, User
$user, $summary, array $meta
1878 global $wgUseRCPatrol, $wgUseNPPatrol, $wgPageCreationLog;
1880 $status = Status
::newGood( [ 'new' => true, 'revision' => null ] );
1882 $now = wfTimestampNow();
1883 $newsize = $content->getSize();
1884 $prepStatus = $content->prepareSave( $this, $flags, $meta['oldId'], $user );
1885 $status->merge( $prepStatus );
1886 if ( !$status->isOK() ) {
1890 $dbw = wfGetDB( DB_MASTER
);
1891 $dbw->startAtomic( __METHOD__
);
1893 // Add the page record unless one already exists for the title
1894 $newid = $this->insertOn( $dbw );
1895 if ( $newid === false ) {
1896 $dbw->endAtomic( __METHOD__
); // nothing inserted
1897 $status->fatal( 'edit-already-exists' );
1899 return $status; // nothing done
1902 // At this point we are now comitted to returning an OK
1903 // status unless some DB query error or other exception comes up.
1904 // This way callers don't have to call rollback() if $status is bad
1905 // unless they actually try to catch exceptions (which is rare).
1907 // @TODO: pass content object?!
1908 $revision = new Revision( [
1910 'title' => $this->mTitle
, // for determining the default content model
1911 'comment' => $summary,
1912 'minor_edit' => $meta['minor'],
1913 'text' => $meta['serialized'],
1915 'user' => $user->getId(),
1916 'user_text' => $user->getName(),
1917 'timestamp' => $now,
1918 'content_model' => $content->getModel(),
1919 'content_format' => $meta['serialFormat'],
1922 // Save the revision text...
1923 $revisionId = $revision->insertOn( $dbw );
1924 // Update the page record with revision data
1925 if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1926 throw new MWException( "Failed to update page row to use new revision." );
1929 Hooks
::run( 'NewRevisionFromEditComplete', [ $this, $revision, false, $user ] );
1931 // Update recentchanges
1932 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1933 // Mark as patrolled if the user can do so
1934 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) &&
1935 !count( $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1936 // Add RC row to the DB
1937 RecentChange
::notifyNew(
1940 $revision->isMinor(),
1952 $user->incEditCount();
1954 if ( $wgPageCreationLog ) {
1955 // Log the page creation
1956 // @TODO: Do we want a 'recreate' action?
1957 $logEntry = new ManualLogEntry( 'create', 'create' );
1958 $logEntry->setPerformer( $user );
1959 $logEntry->setTarget( $this->mTitle
);
1960 $logEntry->setComment( $summary );
1961 $logEntry->setTimestamp( $now );
1962 $logEntry->setAssociatedRevId( $revisionId );
1963 $logid = $logEntry->insert();
1964 // Note that we don't publish page creation events to recentchanges
1965 // (i.e. $logEntry->publish()) since this would create duplicate entries,
1966 // one for the edit and one for the page creation.
1969 $dbw->endAtomic( __METHOD__
);
1970 $this->mTimestamp
= $now;
1972 // Return the new revision to the caller
1973 $status->value
['revision'] = $revision;
1975 // Do secondary updates once the main changes have been committed...
1976 DeferredUpdates
::addUpdate(
1977 new AtomicSectionUpdate(
1981 $revision, &$user, $content, $summary, &$flags, $meta, &$status
1983 // Update links, etc.
1984 $this->doEditUpdates( $revision, $user, [ 'created' => true ] );
1985 // Avoid PHP 7.1 warning of passing $this by reference
1987 // Trigger post-create hook
1988 $params = [ &$wikiPage, &$user, $content, $summary,
1989 $flags & EDIT_MINOR
, null, null, &$flags, $revision ];
1990 Hooks
::run( 'PageContentInsertComplete', $params );
1991 // Trigger post-save hook
1992 $params = array_merge( $params, [ &$status, $meta['baseRevId'], 0 ] );
1993 Hooks
::run( 'PageContentSaveComplete', $params );
1996 DeferredUpdates
::PRESEND
2003 * Get parser options suitable for rendering the primary article wikitext
2005 * @see ContentHandler::makeParserOptions
2007 * @param IContextSource|User|string $context One of the following:
2008 * - IContextSource: Use the User and the Language of the provided
2010 * - User: Use the provided User object and $wgLang for the language,
2011 * so use an IContextSource object if possible.
2012 * - 'canonical': Canonical options (anonymous user with default
2013 * preferences and content language).
2014 * @return ParserOptions
2016 public function makeParserOptions( $context ) {
2017 $options = $this->getContentHandler()->makeParserOptions( $context );
2019 if ( $this->getTitle()->isConversionTable() ) {
2020 // @todo ConversionTable should become a separate content model, so
2021 // we don't need special cases like this one.
2022 $options->disableContentConversion();
2029 * Prepare content which is about to be saved.
2031 * Prior to 1.30, this returned a stdClass object with the same class
2034 * @param Content $content
2035 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2036 * revision ID is also accepted, but this is deprecated.
2037 * @param User|null $user
2038 * @param string|null $serialFormat
2039 * @param bool $useCache Check shared prepared edit cache
2041 * @return PreparedEdit
2045 public function prepareContentForEdit(
2046 Content
$content, $revision = null, User
$user = null,
2047 $serialFormat = null, $useCache = true
2049 global $wgContLang, $wgUser, $wgAjaxEditStash;
2051 if ( is_object( $revision ) ) {
2052 $revid = $revision->getId();
2055 // This code path is deprecated, and nothing is known to
2056 // use it, so performance here shouldn't be a worry.
2057 if ( $revid !== null ) {
2058 wfDeprecated( __METHOD__
. ' with $revision = revision ID', '1.25' );
2059 $revision = Revision
::newFromId( $revid, Revision
::READ_LATEST
);
2065 $user = is_null( $user ) ?
$wgUser : $user;
2066 // XXX: check $user->getId() here???
2068 // Use a sane default for $serialFormat, see T59026
2069 if ( $serialFormat === null ) {
2070 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2073 if ( $this->mPreparedEdit
2074 && isset( $this->mPreparedEdit
->newContent
)
2075 && $this->mPreparedEdit
->newContent
->equals( $content )
2076 && $this->mPreparedEdit
->revid
== $revid
2077 && $this->mPreparedEdit
->format
== $serialFormat
2078 // XXX: also check $user here?
2081 return $this->mPreparedEdit
;
2084 // The edit may have already been prepared via api.php?action=stashedit
2085 $cachedEdit = $useCache && $wgAjaxEditStash
2086 ? ApiStashEdit
::checkCache( $this->getTitle(), $content, $user )
2089 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2090 Hooks
::run( 'ArticlePrepareTextForEdit', [ $this, $popts ] );
2092 $edit = new PreparedEdit();
2093 if ( $cachedEdit ) {
2094 $edit->timestamp
= $cachedEdit->timestamp
;
2096 $edit->timestamp
= wfTimestampNow();
2098 // @note: $cachedEdit is safely not used if the rev ID was referenced in the text
2099 $edit->revid
= $revid;
2101 if ( $cachedEdit ) {
2102 $edit->pstContent
= $cachedEdit->pstContent
;
2104 $edit->pstContent
= $content
2105 ?
$content->preSaveTransform( $this->mTitle
, $user, $popts )
2109 $edit->format
= $serialFormat;
2110 $edit->popts
= $this->makeParserOptions( 'canonical' );
2111 if ( $cachedEdit ) {
2112 $edit->output
= $cachedEdit->output
;
2115 // We get here if vary-revision is set. This means that this page references
2116 // itself (such as via self-transclusion). In this case, we need to make sure
2117 // that any such self-references refer to the newly-saved revision, and not
2118 // to the previous one, which could otherwise happen due to replica DB lag.
2119 $oldCallback = $edit->popts
->getCurrentRevisionCallback();
2120 $edit->popts
->setCurrentRevisionCallback(
2121 function ( Title
$title, $parser = false ) use ( $revision, &$oldCallback ) {
2122 if ( $title->equals( $revision->getTitle() ) ) {
2125 return call_user_func( $oldCallback, $title, $parser );
2130 // Try to avoid a second parse if {{REVISIONID}} is used
2131 $dbIndex = ( $this->mDataLoadedFrom
& self
::READ_LATEST
) === self
::READ_LATEST
2132 ? DB_MASTER
// use the best possible guess
2133 : DB_REPLICA
; // T154554
2135 $edit->popts
->setSpeculativeRevIdCallback( function () use ( $dbIndex ) {
2136 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
2137 // Use a fresh connection in order to see the latest data, by avoiding
2138 // stale data from REPEATABLE-READ snapshots.
2139 $db = $lb->getConnectionRef( $dbIndex, [], false, $lb::CONN_TRX_AUTO
);
2141 return 1 +
(int)$db->selectField(
2149 $edit->output
= $edit->pstContent
2150 ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
)
2154 $edit->newContent
= $content;
2155 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2157 if ( $edit->output
) {
2158 $edit->output
->setCacheTime( wfTimestampNow() );
2161 // Process cache the result
2162 $this->mPreparedEdit
= $edit;
2168 * Do standard deferred updates after page edit.
2169 * Update links tables, site stats, search index and message cache.
2170 * Purges pages that include this page if the text was changed here.
2171 * Every 100th edit, prune the recent changes table.
2173 * @param Revision $revision
2174 * @param User $user User object that did the revision
2175 * @param array $options Array of options, following indexes are used:
2176 * - changed: bool, whether the revision changed the content (default true)
2177 * - created: bool, whether the revision created the page (default false)
2178 * - moved: bool, whether the page was moved (default false)
2179 * - restored: bool, whether the page was undeleted (default false)
2180 * - oldrevision: Revision object for the pre-update revision (default null)
2181 * - oldcountable: bool, null, or string 'no-change' (default null):
2182 * - bool: whether the page was counted as an article before that
2183 * revision, only used in changed is true and created is false
2184 * - null: if created is false, don't update the article count; if created
2185 * is true, do update the article count
2186 * - 'no-change': don't update the article count, ever
2188 public function doEditUpdates( Revision
$revision, User
$user, array $options = [] ) {
2189 global $wgRCWatchCategoryMembership;
2195 'restored' => false,
2196 'oldrevision' => null,
2197 'oldcountable' => null
2199 $content = $revision->getContent();
2201 $logger = LoggerFactory
::getInstance( 'SaveParse' );
2203 // See if the parser output before $revision was inserted is still valid
2205 if ( !$this->mPreparedEdit
) {
2206 $logger->debug( __METHOD__
. ": No prepared edit...\n" );
2207 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2208 $logger->info( __METHOD__
. ": Prepared edit has vary-revision...\n" );
2209 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision-id' )
2210 && $this->mPreparedEdit
->output
->getSpeculativeRevIdUsed() !== $revision->getId()
2212 $logger->info( __METHOD__
. ": Prepared edit has vary-revision-id with wrong ID...\n" );
2213 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-user' ) && !$options['changed'] ) {
2214 $logger->info( __METHOD__
. ": Prepared edit has vary-user and is null...\n" );
2216 wfDebug( __METHOD__
. ": Using prepared edit...\n" );
2217 $editInfo = $this->mPreparedEdit
;
2221 // Parse the text again if needed. Be careful not to do pre-save transform twice:
2222 // $text is usually already pre-save transformed once. Avoid using the edit stash
2223 // as any prepared content from there or in doEditContent() was already rejected.
2224 $editInfo = $this->prepareContentForEdit( $content, $revision, $user, null, false );
2227 // Save it to the parser cache.
2228 // Make sure the cache time matches page_touched to avoid double parsing.
2229 MediaWikiServices
::getInstance()->getParserCache()->save(
2230 $editInfo->output
, $this, $editInfo->popts
,
2231 $revision->getTimestamp(), $editInfo->revid
2234 // Update the links tables and other secondary data
2236 $recursive = $options['changed']; // T52785
2237 $updates = $content->getSecondaryDataUpdates(
2238 $this->getTitle(), null, $recursive, $editInfo->output
2240 foreach ( $updates as $update ) {
2241 $update->setCause( 'edit-page', $user->getName() );
2242 if ( $update instanceof LinksUpdate
) {
2243 $update->setRevision( $revision );
2244 $update->setTriggeringUser( $user );
2246 DeferredUpdates
::addUpdate( $update );
2248 if ( $wgRCWatchCategoryMembership
2249 && $this->getContentHandler()->supportsCategories() === true
2250 && ( $options['changed'] ||
$options['created'] )
2251 && !$options['restored']
2253 // Note: jobs are pushed after deferred updates, so the job should be able to see
2254 // the recent change entry (also done via deferred updates) and carry over any
2255 // bot/deletion/IP flags, ect.
2256 JobQueueGroup
::singleton()->lazyPush( new CategoryMembershipChangeJob(
2259 'pageId' => $this->getId(),
2260 'revTimestamp' => $revision->getTimestamp()
2266 // Avoid PHP 7.1 warning of passing $this by reference
2269 Hooks
::run( 'ArticleEditUpdates', [ &$wikiPage, &$editInfo, $options['changed'] ] );
2271 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', [ &$wikiPage ] ) ) {
2272 // Flush old entries from the `recentchanges` table
2273 if ( mt_rand( 0, 9 ) == 0 ) {
2274 JobQueueGroup
::singleton()->lazyPush( RecentChangesUpdateJob
::newPurgeJob() );
2278 if ( !$this->exists() ) {
2282 $id = $this->getId();
2283 $title = $this->mTitle
->getPrefixedDBkey();
2284 $shortTitle = $this->mTitle
->getDBkey();
2286 if ( $options['oldcountable'] === 'no-change' ||
2287 ( !$options['changed'] && !$options['moved'] )
2290 } elseif ( $options['created'] ) {
2291 $good = (int)$this->isCountable( $editInfo );
2292 } elseif ( $options['oldcountable'] !== null ) {
2293 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2297 $edits = $options['changed'] ?
1 : 0;
2298 $pages = $options['created'] ?
1 : 0;
2300 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory(
2301 [ 'edits' => $edits, 'articles' => $good, 'pages' => $pages ]
2303 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2305 // If this is another user's talk page, update newtalk.
2306 // Don't do this if $options['changed'] = false (null-edits) nor if
2307 // it's a minor edit and the user doesn't want notifications for those.
2308 if ( $options['changed']
2309 && $this->mTitle
->getNamespace() == NS_USER_TALK
2310 && $shortTitle != $user->getTitleKey()
2311 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2313 $recipient = User
::newFromName( $shortTitle, false );
2314 if ( !$recipient ) {
2315 wfDebug( __METHOD__
. ": invalid username\n" );
2317 // Avoid PHP 7.1 warning of passing $this by reference
2320 // Allow extensions to prevent user notification
2321 // when a new message is added to their talk page
2322 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', [ &$wikiPage, $recipient ] ) ) {
2323 if ( User
::isIP( $shortTitle ) ) {
2324 // An anonymous user
2325 $recipient->setNewtalk( true, $revision );
2326 } elseif ( $recipient->isLoggedIn() ) {
2327 $recipient->setNewtalk( true, $revision );
2329 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2335 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2336 MessageCache
::singleton()->updateMessageOverride( $this->mTitle
, $content );
2339 if ( $options['created'] ) {
2340 self
::onArticleCreate( $this->mTitle
);
2341 } elseif ( $options['changed'] ) { // T52785
2342 self
::onArticleEdit( $this->mTitle
, $revision );
2345 ResourceLoaderWikiModule
::invalidateModuleCache(
2346 $this->mTitle
, $options['oldrevision'], $revision, wfWikiID()
2351 * Update the article's restriction field, and leave a log entry.
2352 * This works for protection both existing and non-existing pages.
2354 * @param array $limit Set of restriction keys
2355 * @param array $expiry Per restriction type expiration
2356 * @param int &$cascade Set to false if cascading protection isn't allowed.
2357 * @param string $reason
2358 * @param User $user The user updating the restrictions
2359 * @param string|string[] $tags Change tags to add to the pages and protection log entries
2360 * ($user should be able to add the specified tags before this is called)
2361 * @return Status Status object; if action is taken, $status->value is the log_id of the
2362 * protection log entry.
2364 public function doUpdateRestrictions( array $limit, array $expiry,
2365 &$cascade, $reason, User
$user, $tags = null
2367 global $wgCascadingRestrictionLevels;
2369 if ( wfReadOnly() ) {
2370 return Status
::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
2373 $this->loadPageData( 'fromdbmaster' );
2374 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2375 $id = $this->getId();
2381 // Take this opportunity to purge out expired restrictions
2382 Title
::purgeExpiredRestrictions();
2384 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2385 // we expect a single selection, but the schema allows otherwise.
2386 $isProtected = false;
2390 $dbw = wfGetDB( DB_MASTER
);
2392 foreach ( $restrictionTypes as $action ) {
2393 if ( !isset( $expiry[$action] ) ||
$expiry[$action] === $dbw->getInfinity() ) {
2394 $expiry[$action] = 'infinity';
2396 if ( !isset( $limit[$action] ) ) {
2397 $limit[$action] = '';
2398 } elseif ( $limit[$action] != '' ) {
2402 // Get current restrictions on $action
2403 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2404 if ( $current != '' ) {
2405 $isProtected = true;
2408 if ( $limit[$action] != $current ) {
2410 } elseif ( $limit[$action] != '' ) {
2411 // Only check expiry change if the action is actually being
2412 // protected, since expiry does nothing on an not-protected
2414 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2420 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2424 // If nothing has changed, do nothing
2426 return Status
::newGood();
2429 if ( !$protect ) { // No protection at all means unprotection
2430 $revCommentMsg = 'unprotectedarticle-comment';
2431 $logAction = 'unprotect';
2432 } elseif ( $isProtected ) {
2433 $revCommentMsg = 'modifiedarticleprotection-comment';
2434 $logAction = 'modify';
2436 $revCommentMsg = 'protectedarticle-comment';
2437 $logAction = 'protect';
2440 $logRelationsValues = [];
2441 $logRelationsField = null;
2442 $logParamsDetails = [];
2444 // Null revision (used for change tag insertion)
2445 $nullRevision = null;
2447 if ( $id ) { // Protection of existing page
2448 // Avoid PHP 7.1 warning of passing $this by reference
2451 if ( !Hooks
::run( 'ArticleProtect', [ &$wikiPage, &$user, $limit, $reason ] ) ) {
2452 return Status
::newGood();
2455 // Only certain restrictions can cascade...
2456 $editrestriction = isset( $limit['edit'] )
2457 ?
[ $limit['edit'] ]
2458 : $this->mTitle
->getRestrictions( 'edit' );
2459 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2460 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2462 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2463 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2466 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2467 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2468 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2470 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2471 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2474 // The schema allows multiple restrictions
2475 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2479 // insert null revision to identify the page protection change as edit summary
2480 $latest = $this->getLatest();
2481 $nullRevision = $this->insertProtectNullRevision(
2490 if ( $nullRevision === null ) {
2491 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2494 $logRelationsField = 'pr_id';
2496 // Update restrictions table
2497 foreach ( $limit as $action => $restrictions ) {
2499 'page_restrictions',
2502 'pr_type' => $action
2506 if ( $restrictions != '' ) {
2507 $cascadeValue = ( $cascade && $action == 'edit' ) ?
1 : 0;
2509 'page_restrictions',
2512 'pr_type' => $action,
2513 'pr_level' => $restrictions,
2514 'pr_cascade' => $cascadeValue,
2515 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2519 $logRelationsValues[] = $dbw->insertId();
2520 $logParamsDetails[] = [
2522 'level' => $restrictions,
2523 'expiry' => $expiry[$action],
2524 'cascade' => (bool)$cascadeValue,
2529 // Clear out legacy restriction fields
2532 [ 'page_restrictions' => '' ],
2533 [ 'page_id' => $id ],
2537 // Avoid PHP 7.1 warning of passing $this by reference
2540 Hooks
::run( 'NewRevisionFromEditComplete',
2541 [ $this, $nullRevision, $latest, $user ] );
2542 Hooks
::run( 'ArticleProtectComplete', [ &$wikiPage, &$user, $limit, $reason ] );
2543 } else { // Protection of non-existing page (also known as "title protection")
2544 // Cascade protection is meaningless in this case
2547 if ( $limit['create'] != '' ) {
2548 $commentFields = CommentStore
::getStore()->insert( $dbw, 'pt_reason', $reason );
2549 $dbw->replace( 'protected_titles',
2550 [ [ 'pt_namespace', 'pt_title' ] ],
2552 'pt_namespace' => $this->mTitle
->getNamespace(),
2553 'pt_title' => $this->mTitle
->getDBkey(),
2554 'pt_create_perm' => $limit['create'],
2555 'pt_timestamp' => $dbw->timestamp(),
2556 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2557 'pt_user' => $user->getId(),
2558 ] +
$commentFields, __METHOD__
2560 $logParamsDetails[] = [
2562 'level' => $limit['create'],
2563 'expiry' => $expiry['create'],
2566 $dbw->delete( 'protected_titles',
2568 'pt_namespace' => $this->mTitle
->getNamespace(),
2569 'pt_title' => $this->mTitle
->getDBkey()
2575 $this->mTitle
->flushRestrictions();
2576 InfoAction
::invalidateCache( $this->mTitle
);
2578 if ( $logAction == 'unprotect' ) {
2581 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2583 '4::description' => $protectDescriptionLog, // parameter for IRC
2584 '5:bool:cascade' => $cascade,
2585 'details' => $logParamsDetails, // parameter for localize and api
2589 // Update the protection log
2590 $logEntry = new ManualLogEntry( 'protect', $logAction );
2591 $logEntry->setTarget( $this->mTitle
);
2592 $logEntry->setComment( $reason );
2593 $logEntry->setPerformer( $user );
2594 $logEntry->setParameters( $params );
2595 if ( !is_null( $nullRevision ) ) {
2596 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2598 $logEntry->setTags( $tags );
2599 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2600 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2602 $logId = $logEntry->insert();
2603 $logEntry->publish( $logId );
2605 return Status
::newGood( $logId );
2609 * Insert a new null revision for this page.
2611 * @param string $revCommentMsg Comment message key for the revision
2612 * @param array $limit Set of restriction keys
2613 * @param array $expiry Per restriction type expiration
2614 * @param int $cascade Set to false if cascading protection isn't allowed.
2615 * @param string $reason
2616 * @param User|null $user
2617 * @return Revision|null Null on error
2619 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2620 array $expiry, $cascade, $reason, $user = null
2622 $dbw = wfGetDB( DB_MASTER
);
2624 // Prepare a null revision to be added to the history
2625 $editComment = wfMessage(
2627 $this->mTitle
->getPrefixedText(),
2628 $user ?
$user->getName() : ''
2629 )->inContentLanguage()->text();
2631 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2633 $protectDescription = $this->protectDescription( $limit, $expiry );
2634 if ( $protectDescription ) {
2635 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2636 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2637 ->inContentLanguage()->text();
2640 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2641 $editComment .= wfMessage( 'brackets' )->params(
2642 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2643 )->inContentLanguage()->text();
2646 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2648 $nullRev->insertOn( $dbw );
2650 // Update page record and touch page
2651 $oldLatest = $nullRev->getParentId();
2652 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2659 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2662 protected function formatExpiry( $expiry ) {
2665 if ( $expiry != 'infinity' ) {
2668 $wgContLang->timeanddate( $expiry, false, false ),
2669 $wgContLang->date( $expiry, false, false ),
2670 $wgContLang->time( $expiry, false, false )
2671 )->inContentLanguage()->text();
2673 return wfMessage( 'protect-expiry-indefinite' )
2674 ->inContentLanguage()->text();
2679 * Builds the description to serve as comment for the edit.
2681 * @param array $limit Set of restriction keys
2682 * @param array $expiry Per restriction type expiration
2685 public function protectDescription( array $limit, array $expiry ) {
2686 $protectDescription = '';
2688 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2689 # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2690 # All possible message keys are listed here for easier grepping:
2691 # * restriction-create
2692 # * restriction-edit
2693 # * restriction-move
2694 # * restriction-upload
2695 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2696 # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2697 # with '' filtered out. All possible message keys are listed below:
2698 # * protect-level-autoconfirmed
2699 # * protect-level-sysop
2700 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2701 ->inContentLanguage()->text();
2703 $expiryText = $this->formatExpiry( $expiry[$action] );
2705 if ( $protectDescription !== '' ) {
2706 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2708 $protectDescription .= wfMessage( 'protect-summary-desc' )
2709 ->params( $actionText, $restrictionsText, $expiryText )
2710 ->inContentLanguage()->text();
2713 return $protectDescription;
2717 * Builds the description to serve as comment for the log entry.
2719 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2720 * protect description text. Keep them in old format to avoid breaking compatibility.
2721 * TODO: Fix protection log to store structured description and format it on-the-fly.
2723 * @param array $limit Set of restriction keys
2724 * @param array $expiry Per restriction type expiration
2727 public function protectDescriptionLog( array $limit, array $expiry ) {
2730 $protectDescriptionLog = '';
2732 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2733 $expiryText = $this->formatExpiry( $expiry[$action] );
2734 $protectDescriptionLog .= $wgContLang->getDirMark() .
2735 "[$action=$restrictions] ($expiryText)";
2738 return trim( $protectDescriptionLog );
2742 * Take an array of page restrictions and flatten it to a string
2743 * suitable for insertion into the page_restrictions field.
2745 * @param string[] $limit
2747 * @throws MWException
2750 protected static function flattenRestrictions( $limit ) {
2751 if ( !is_array( $limit ) ) {
2752 throw new MWException( __METHOD__
. ' given non-array restriction set' );
2758 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2759 $bits[] = "$action=$restrictions";
2762 return implode( ':', $bits );
2766 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2767 * backwards compatibility, if you care about error reporting you should use
2768 * doDeleteArticleReal() instead.
2770 * Deletes the article with database consistency, writes logs, purges caches
2772 * @param string $reason Delete reason for deletion log
2773 * @param bool $suppress Suppress all revisions and log the deletion in
2774 * the suppression log instead of the deletion log
2775 * @param int $u1 Unused
2776 * @param bool $u2 Unused
2777 * @param array|string &$error Array of errors to append to
2778 * @param User $user The deleting user
2779 * @return bool True if successful
2781 public function doDeleteArticle(
2782 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null
2784 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2785 return $status->isGood();
2789 * Back-end article deletion
2790 * Deletes the article with database consistency, writes logs, purges caches
2794 * @param string $reason Delete reason for deletion log
2795 * @param bool $suppress Suppress all revisions and log the deletion in
2796 * the suppression log instead of the deletion log
2797 * @param int $u1 Unused
2798 * @param bool $u2 Unused
2799 * @param array|string &$error Array of errors to append to
2800 * @param User $deleter The deleting user
2801 * @param array $tags Tags to apply to the deletion action
2802 * @param string $logsubtype
2803 * @return Status Status object; if successful, $status->value is the log_id of the
2804 * deletion log entry. If the page couldn't be deleted because it wasn't
2805 * found, $status is a non-fatal 'cannotdelete' error
2807 public function doDeleteArticleReal(
2808 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$deleter = null,
2809 $tags = [], $logsubtype = 'delete'
2811 global $wgUser, $wgContentHandlerUseDB, $wgCommentTableSchemaMigrationStage,
2812 $wgActorTableSchemaMigrationStage;
2814 wfDebug( __METHOD__
. "\n" );
2816 $status = Status
::newGood();
2818 if ( $this->mTitle
->getDBkey() === '' ) {
2819 $status->error( 'cannotdelete',
2820 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2824 // Avoid PHP 7.1 warning of passing $this by reference
2827 $deleter = is_null( $deleter ) ?
$wgUser : $deleter;
2828 if ( !Hooks
::run( 'ArticleDelete',
2829 [ &$wikiPage, &$deleter, &$reason, &$error, &$status, $suppress ]
2831 if ( $status->isOK() ) {
2832 // Hook aborted but didn't set a fatal status
2833 $status->fatal( 'delete-hook-aborted' );
2838 $dbw = wfGetDB( DB_MASTER
);
2839 $dbw->startAtomic( __METHOD__
);
2841 $this->loadPageData( self
::READ_LATEST
);
2842 $id = $this->getId();
2843 // T98706: lock the page from various other updates but avoid using
2844 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2845 // the revisions queries (which also JOIN on user). Only lock the page
2846 // row and CAS check on page_latest to see if the trx snapshot matches.
2847 $lockedLatest = $this->lockAndGetLatest();
2848 if ( $id == 0 ||
$this->getLatest() != $lockedLatest ) {
2849 $dbw->endAtomic( __METHOD__
);
2850 // Page not there or trx snapshot is stale
2851 $status->error( 'cannotdelete',
2852 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2856 // Given the lock above, we can be confident in the title and page ID values
2857 $namespace = $this->getTitle()->getNamespace();
2858 $dbKey = $this->getTitle()->getDBkey();
2860 // At this point we are now comitted to returning an OK
2861 // status unless some DB query error or other exception comes up.
2862 // This way callers don't have to call rollback() if $status is bad
2863 // unless they actually try to catch exceptions (which is rare).
2865 // we need to remember the old content so we can use it to generate all deletion updates.
2866 $revision = $this->getRevision();
2868 $content = $this->getContent( Revision
::RAW
);
2869 } catch ( Exception
$ex ) {
2870 wfLogWarning( __METHOD__
. ': failed to load content during deletion! '
2871 . $ex->getMessage() );
2876 $commentStore = CommentStore
::getStore();
2877 $actorMigration = ActorMigration
::newMigration();
2879 $revQuery = Revision
::getQueryInfo();
2882 // Bitfields to further suppress the content
2884 $bitfield = Revision
::SUPPRESSED_ALL
;
2885 $revQuery['fields'] = array_diff( $revQuery['fields'], [ 'rev_deleted' ] );
2888 // For now, shunt the revision data into the archive table.
2889 // Text is *not* removed from the text table; bulk storage
2890 // is left intact to avoid breaking block-compression or
2891 // immutable storage schemes.
2892 // In the future, we may keep revisions and mark them with
2893 // the rev_deleted field, which is reserved for this purpose.
2895 // Lock rows in `revision` and its temp tables, but not any others.
2896 // Note array_intersect() preserves keys from the first arg, and we're
2897 // assuming $revQuery has `revision` primary and isn't using subtables
2898 // for anything we care about.
2899 $res = $dbw->select(
2901 $revQuery['tables'],
2902 [ 'revision', 'revision_comment_temp', 'revision_actor_temp' ]
2905 [ 'rev_page' => $id ],
2910 foreach ( $res as $row ) {
2911 // Fetch all rows in case the DB needs that to properly lock them.
2914 // Get all of the page revisions
2915 $res = $dbw->select(
2916 $revQuery['tables'],
2917 $revQuery['fields'],
2918 [ 'rev_page' => $id ],
2924 // Build their equivalent archive rows
2928 /** @var int[] Revision IDs of edits that were made by IPs */
2931 foreach ( $res as $row ) {
2932 $comment = $commentStore->getComment( 'rev_comment', $row );
2933 $user = User
::newFromAnyId( $row->rev_user
, $row->rev_user_text
, $row->rev_actor
);
2935 'ar_namespace' => $namespace,
2936 'ar_title' => $dbKey,
2937 'ar_timestamp' => $row->rev_timestamp
,
2938 'ar_minor_edit' => $row->rev_minor_edit
,
2939 'ar_rev_id' => $row->rev_id
,
2940 'ar_parent_id' => $row->rev_parent_id
,
2941 'ar_text_id' => $row->rev_text_id
,
2942 'ar_len' => $row->rev_len
,
2943 'ar_page_id' => $id,
2944 'ar_deleted' => $suppress ?
$bitfield : $row->rev_deleted
,
2945 'ar_sha1' => $row->rev_sha1
,
2946 ] +
$commentStore->insert( $dbw, 'ar_comment', $comment )
2947 +
$actorMigration->getInsertValues( $dbw, 'ar_user', $user );
2948 if ( $wgContentHandlerUseDB ) {
2949 $rowInsert['ar_content_model'] = $row->rev_content_model
;
2950 $rowInsert['ar_content_format'] = $row->rev_content_format
;
2952 $rowsInsert[] = $rowInsert;
2953 $revids[] = $row->rev_id
;
2955 // Keep track of IP edits, so that the corresponding rows can
2956 // be deleted in the ip_changes table.
2957 if ( (int)$row->rev_user
=== 0 && IP
::isValid( $row->rev_user_text
) ) {
2958 $ipRevIds[] = $row->rev_id
;
2961 // Copy them into the archive table
2962 $dbw->insert( 'archive', $rowsInsert, __METHOD__
);
2963 // Save this so we can pass it to the ArticleDeleteComplete hook.
2964 $archivedRevisionCount = $dbw->affectedRows();
2966 // Clone the title and wikiPage, so we have the information we need when
2967 // we log and run the ArticleDeleteComplete hook.
2968 $logTitle = clone $this->mTitle
;
2969 $wikiPageBeforeDelete = clone $this;
2971 // Now that it's safely backed up, delete it
2972 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__
);
2973 $dbw->delete( 'revision', [ 'rev_page' => $id ], __METHOD__
);
2974 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
2975 $dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__
);
2977 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD
) {
2978 $dbw->delete( 'revision_actor_temp', [ 'revactor_rev' => $revids ], __METHOD__
);
2981 // Also delete records from ip_changes as applicable.
2982 if ( count( $ipRevIds ) > 0 ) {
2983 $dbw->delete( 'ip_changes', [ 'ipc_rev_id' => $ipRevIds ], __METHOD__
);
2986 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2987 $logtype = $suppress ?
'suppress' : 'delete';
2989 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2990 $logEntry->setPerformer( $deleter );
2991 $logEntry->setTarget( $logTitle );
2992 $logEntry->setComment( $reason );
2993 $logEntry->setTags( $tags );
2994 $logid = $logEntry->insert();
2996 $dbw->onTransactionPreCommitOrIdle(
2997 function () use ( $logEntry, $logid ) {
2998 // T58776: avoid deadlocks (especially from FileDeleteForm)
2999 $logEntry->publish( $logid );
3004 $dbw->endAtomic( __METHOD__
);
3006 $this->doDeleteUpdates( $id, $content, $revision, $deleter );
3008 Hooks
::run( 'ArticleDeleteComplete', [
3009 &$wikiPageBeforeDelete,
3015 $archivedRevisionCount
3017 $status->value
= $logid;
3019 // Show log excerpt on 404 pages rather than just a link
3020 $cache = MediaWikiServices
::getInstance()->getMainObjectStash();
3021 $key = $cache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
3022 $cache->set( $key, 1, $cache::TTL_DAY
);
3028 * Lock the page row for this title+id and return page_latest (or 0)
3030 * @return int Returns 0 if no row was found with this title+id
3033 public function lockAndGetLatest() {
3034 return (int)wfGetDB( DB_MASTER
)->selectField(
3038 'page_id' => $this->getId(),
3039 // Typically page_id is enough, but some code might try to do
3040 // updates assuming the title is the same, so verify that
3041 'page_namespace' => $this->getTitle()->getNamespace(),
3042 'page_title' => $this->getTitle()->getDBkey()
3050 * Do some database updates after deletion
3052 * @param int $id The page_id value of the page being deleted
3053 * @param Content|null $content Optional page content to be used when determining
3054 * the required updates. This may be needed because $this->getContent()
3055 * may already return null when the page proper was deleted.
3056 * @param Revision|null $revision The latest page revision
3057 * @param User|null $user The user that caused the deletion
3059 public function doDeleteUpdates(
3060 $id, Content
$content = null, Revision
$revision = null, User
$user = null
3063 $countable = $this->isCountable();
3064 } catch ( Exception
$ex ) {
3065 // fallback for deleting broken pages for which we cannot load the content for
3066 // some reason. Note that doDeleteArticleReal() already logged this problem.
3070 // Update site status
3071 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory(
3072 [ 'edits' => 1, 'articles' => -$countable, 'pages' => -1 ]
3075 // Delete pagelinks, update secondary indexes, etc
3076 $updates = $this->getDeletionUpdates( $content );
3077 foreach ( $updates as $update ) {
3078 DeferredUpdates
::addUpdate( $update );
3081 $causeAgent = $user ?
$user->getName() : 'unknown';
3082 // Reparse any pages transcluding this page
3083 LinksUpdate
::queueRecursiveJobsForTable(
3084 $this->mTitle
, 'templatelinks', 'delete-page', $causeAgent );
3085 // Reparse any pages including this image
3086 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
3087 LinksUpdate
::queueRecursiveJobsForTable(
3088 $this->mTitle
, 'imagelinks', 'delete-page', $causeAgent );
3092 self
::onArticleDelete( $this->mTitle
);
3093 ResourceLoaderWikiModule
::invalidateModuleCache(
3094 $this->mTitle
, $revision, null, wfWikiID()
3097 // Reset this object and the Title object
3098 $this->loadFromRow( false, self
::READ_LATEST
);
3101 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
3105 * Roll back the most recent consecutive set of edits to a page
3106 * from the same user; fails if there are no eligible edits to
3107 * roll back to, e.g. user is the sole contributor. This function
3108 * performs permissions checks on $user, then calls commitRollback()
3109 * to do the dirty work
3111 * @todo Separate the business/permission stuff out from backend code
3112 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3114 * @param string $fromP Name of the user whose edits to rollback.
3115 * @param string $summary Custom summary. Set to default summary if empty.
3116 * @param string $token Rollback token.
3117 * @param bool $bot If true, mark all reverted edits as bot.
3119 * @param array &$resultDetails Array contains result-specific array of additional values
3120 * 'alreadyrolled' : 'current' (rev)
3121 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3123 * @param User $user 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)
3128 * @return array Array of errors, each error formatted as
3129 * array(messagekey, param1, param2, ...).
3130 * On success, the array is empty. This array can also be passed to
3131 * OutputPage::showPermissionsErrorPage().
3133 public function doRollback(
3134 $fromP, $summary, $token, $bot, &$resultDetails, User
$user, $tags = null
3136 $resultDetails = null;
3138 // Check permissions
3139 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
3140 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
3141 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3143 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3144 $errors[] = [ 'sessionfailure' ];
3147 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
3148 $errors[] = [ 'actionthrottledtext' ];
3151 // If there were errors, bail out now
3152 if ( !empty( $errors ) ) {
3156 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3160 * Backend implementation of doRollback(), please refer there for parameter
3161 * and return value documentation
3163 * NOTE: This function does NOT check ANY permissions, it just commits the
3164 * rollback to the DB. Therefore, you should only call this function direct-
3165 * ly if you want to use custom permissions checks. If you don't, use
3166 * doRollback() instead.
3167 * @param string $fromP Name of the user whose edits to rollback.
3168 * @param string $summary Custom summary. Set to default summary if empty.
3169 * @param bool $bot If true, mark all reverted edits as bot.
3171 * @param array &$resultDetails Contains result-specific array of additional values
3172 * @param User $guser The user performing the rollback
3173 * @param array|null $tags Change tags to apply to the rollback
3174 * Callers are responsible for permission checks
3175 * (with ChangeTags::canAddTagsAccompanyingChange)
3179 public function commitRollback( $fromP, $summary, $bot,
3180 &$resultDetails, User
$guser, $tags = null
3182 global $wgUseRCPatrol, $wgContLang;
3184 $dbw = wfGetDB( DB_MASTER
);
3186 if ( wfReadOnly() ) {
3187 return [ [ 'readonlytext' ] ];
3190 // Get the last editor
3191 $current = $this->getRevision();
3192 if ( is_null( $current ) ) {
3193 // Something wrong... no page?
3194 return [ [ 'notanarticle' ] ];
3197 $from = str_replace( '_', ' ', $fromP );
3198 // User name given should match up with the top revision.
3199 // If the user was deleted then $from should be empty.
3200 if ( $from != $current->getUserText() ) {
3201 $resultDetails = [ 'current' => $current ];
3202 return [ [ 'alreadyrolled',
3203 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3204 htmlspecialchars( $fromP ),
3205 htmlspecialchars( $current->getUserText() )
3209 // Get the last edit not by this person...
3210 // Note: these may not be public values
3211 $userId = intval( $current->getUser( Revision
::RAW
) );
3212 $userName = $current->getUserText( Revision
::RAW
);
3214 $user = User
::newFromId( $userId );
3215 $user->setName( $userName );
3217 $user = User
::newFromName( $current->getUserText( Revision
::RAW
), false );
3220 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbw, 'rev_user', $user );
3222 $s = $dbw->selectRow(
3223 [ 'revision' ] +
$actorWhere['tables'],
3224 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3226 'rev_page' => $current->getPage(),
3227 'NOT(' . $actorWhere['conds'] . ')',
3231 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
3232 'ORDER BY' => 'rev_timestamp DESC'
3234 $actorWhere['joins']
3236 if ( $s === false ) {
3237 // No one else ever edited this page
3238 return [ [ 'cantrollback' ] ];
3239 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT
3240 ||
$s->rev_deleted
& Revision
::DELETED_USER
3242 // Only admins can see this text
3243 return [ [ 'notvisiblerev' ] ];
3246 // Generate the edit summary if necessary
3247 $target = Revision
::newFromId( $s->rev_id
, Revision
::READ_LATEST
);
3248 if ( empty( $summary ) ) {
3249 if ( $from == '' ) { // no public user name
3250 $summary = wfMessage( 'revertpage-nouser' );
3252 $summary = wfMessage( 'revertpage' );
3256 // Allow the custom summary to use the same args as the default message
3258 $target->getUserText(), $from, $s->rev_id
,
3259 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3260 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3262 if ( $summary instanceof Message
) {
3263 $summary = $summary->params( $args )->inContentLanguage()->text();
3265 $summary = wfMsgReplaceArgs( $summary, $args );
3268 // Trim spaces on user supplied text
3269 $summary = trim( $summary );
3272 $flags = EDIT_UPDATE | EDIT_INTERNAL
;
3274 if ( $guser->isAllowed( 'minoredit' ) ) {
3275 $flags |
= EDIT_MINOR
;
3278 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3279 $flags |
= EDIT_FORCE_BOT
;
3282 $targetContent = $target->getContent();
3283 $changingContentModel = $targetContent->getModel() !== $current->getContentModel();
3285 if ( in_array( 'mw-rollback', ChangeTags
::getSoftwareTags() ) ) {
3286 $tags[] = 'mw-rollback';
3289 // Actually store the edit
3290 $status = $this->doEditContent(
3300 // Set patrolling and bot flag on the edits, which gets rollbacked.
3301 // This is done even on edit failure to have patrolling in that case (T64157).
3303 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3304 // Mark all reverted edits as bot
3308 if ( $wgUseRCPatrol ) {
3309 // Mark all reverted edits as patrolled
3310 $set['rc_patrolled'] = RecentChange
::PRC_PATROLLED
;
3313 if ( count( $set ) ) {
3314 $actorWhere = ActorMigration
::newMigration()->getWhere( $dbw, 'rc_user', $user, false );
3315 $dbw->update( 'recentchanges', $set,
3317 'rc_cur_id' => $current->getPage(),
3318 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3319 $actorWhere['conds'], // No tables/joins are needed for rc_user
3325 if ( !$status->isOK() ) {
3326 return $status->getErrorsArray();
3329 // raise error, when the edit is an edit without a new version
3330 $statusRev = $status->value
['revision'] ??
null;
3331 if ( !( $statusRev instanceof Revision
) ) {
3332 $resultDetails = [ 'current' => $current ];
3333 return [ [ 'alreadyrolled',
3334 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3335 htmlspecialchars( $fromP ),
3336 htmlspecialchars( $current->getUserText() )
3340 if ( $changingContentModel ) {
3341 // If the content model changed during the rollback,
3342 // make sure it gets logged to Special:Log/contentmodel
3343 $log = new ManualLogEntry( 'contentmodel', 'change' );
3344 $log->setPerformer( $guser );
3345 $log->setTarget( $this->mTitle
);
3346 $log->setComment( $summary );
3347 $log->setParameters( [
3348 '4::oldmodel' => $current->getContentModel(),
3349 '5::newmodel' => $targetContent->getModel(),
3352 $logId = $log->insert( $dbw );
3353 $log->publish( $logId );
3356 $revId = $statusRev->getId();
3358 Hooks
::run( 'ArticleRollbackComplete', [ $this, $guser, $target, $current ] );
3361 'summary' => $summary,
3362 'current' => $current,
3363 'target' => $target,
3372 * The onArticle*() functions are supposed to be a kind of hooks
3373 * which should be called whenever any of the specified actions
3376 * This is a good place to put code to clear caches, for instance.
3378 * This is called on page move and undelete, as well as edit
3380 * @param Title $title
3382 public static function onArticleCreate( Title
$title ) {
3383 // Update existence markers on article/talk tabs...
3384 $other = $title->getOtherPage();
3386 $other->purgeSquid();
3388 $title->touchLinks();
3389 $title->purgeSquid();
3390 $title->deleteTitleProtection();
3392 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3394 // Invalidate caches of articles which include this page
3395 DeferredUpdates
::addUpdate(
3396 new HTMLCacheUpdate( $title, 'templatelinks', 'page-create' )
3399 if ( $title->getNamespace() == NS_CATEGORY
) {
3400 // Load the Category object, which will schedule a job to create
3401 // the category table row if necessary. Checking a replica DB is ok
3402 // here, in the worst case it'll run an unnecessary recount job on
3403 // a category that probably doesn't have many members.
3404 Category
::newFromTitle( $title )->getID();
3409 * Clears caches when article is deleted
3411 * @param Title $title
3413 public static function onArticleDelete( Title
$title ) {
3414 // Update existence markers on article/talk tabs...
3415 // Clear Backlink cache first so that purge jobs use more up-to-date backlink information
3416 BacklinkCache
::get( $title )->clear();
3417 $other = $title->getOtherPage();
3419 $other->purgeSquid();
3421 $title->touchLinks();
3422 $title->purgeSquid();
3424 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3427 HTMLFileCache
::clearFileCache( $title );
3428 InfoAction
::invalidateCache( $title );
3431 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3432 MessageCache
::singleton()->updateMessageOverride( $title, null );
3436 if ( $title->getNamespace() == NS_FILE
) {
3437 DeferredUpdates
::addUpdate(
3438 new HTMLCacheUpdate( $title, 'imagelinks', 'page-delete' )
3443 if ( $title->getNamespace() == NS_USER_TALK
) {
3444 $user = User
::newFromName( $title->getText(), false );
3446 $user->setNewtalk( false );
3451 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3455 * Purge caches on page update etc
3457 * @param Title $title
3458 * @param Revision|null $revision Revision that was just saved, may be null
3460 public static function onArticleEdit( Title
$title, Revision
$revision = null ) {
3461 // Invalidate caches of articles which include this page
3462 DeferredUpdates
::addUpdate(
3463 new HTMLCacheUpdate( $title, 'templatelinks', 'page-edit' )
3466 // Invalidate the caches of all pages which redirect here
3467 DeferredUpdates
::addUpdate(
3468 new HTMLCacheUpdate( $title, 'redirect', 'page-edit' )
3471 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3473 // Purge CDN for this page only
3474 $title->purgeSquid();
3475 // Clear file cache for this page only
3476 HTMLFileCache
::clearFileCache( $title );
3478 $revid = $revision ?
$revision->getId() : null;
3479 DeferredUpdates
::addCallableUpdate( function () use ( $title, $revid ) {
3480 InfoAction
::invalidateCache( $title, $revid );
3487 * Returns a list of categories this page is a member of.
3488 * Results will include hidden categories
3490 * @return TitleArray
3492 public function getCategories() {
3493 $id = $this->getId();
3495 return TitleArray
::newFromResult( new FakeResultWrapper( [] ) );
3498 $dbr = wfGetDB( DB_REPLICA
);
3499 $res = $dbr->select( 'categorylinks',
3500 [ 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ],
3501 // Have to do that since Database::fieldNamesWithAlias treats numeric indexes
3502 // as not being aliases, and NS_CATEGORY is numeric
3503 [ 'cl_from' => $id ],
3506 return TitleArray
::newFromResult( $res );
3510 * Returns a list of hidden categories this page is a member of.
3511 * Uses the page_props and categorylinks tables.
3513 * @return array Array of Title objects
3515 public function getHiddenCategories() {
3517 $id = $this->getId();
3523 $dbr = wfGetDB( DB_REPLICA
);
3524 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3526 [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3527 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ],
3530 if ( $res !== false ) {
3531 foreach ( $res as $row ) {
3532 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3540 * Auto-generates a deletion reason
3542 * @param bool &$hasHistory Whether the page has a history
3543 * @return string|bool String containing deletion reason or empty string, or boolean false
3544 * if no revision occurred
3546 public function getAutoDeleteReason( &$hasHistory ) {
3547 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3551 * Update all the appropriate counts in the category table, given that
3552 * we've added the categories $added and deleted the categories $deleted.
3554 * This should only be called from deferred updates or jobs to avoid contention.
3556 * @param array $added The names of categories that were added
3557 * @param array $deleted The names of categories that were deleted
3558 * @param int $id Page ID (this should be the original deleted page ID)
3560 public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3561 $id = $id ?
: $this->getId();
3562 $ns = $this->getTitle()->getNamespace();
3564 $addFields = [ 'cat_pages = cat_pages + 1' ];
3565 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3566 if ( $ns == NS_CATEGORY
) {
3567 $addFields[] = 'cat_subcats = cat_subcats + 1';
3568 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3569 } elseif ( $ns == NS_FILE
) {
3570 $addFields[] = 'cat_files = cat_files + 1';
3571 $removeFields[] = 'cat_files = cat_files - 1';
3574 $dbw = wfGetDB( DB_MASTER
);
3576 if ( count( $added ) ) {
3577 $existingAdded = $dbw->selectFieldValues(
3580 [ 'cat_title' => $added ],
3584 // For category rows that already exist, do a plain
3585 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3586 // to avoid creating gaps in the cat_id sequence.
3587 if ( count( $existingAdded ) ) {
3591 [ 'cat_title' => $existingAdded ],
3596 $missingAdded = array_diff( $added, $existingAdded );
3597 if ( count( $missingAdded ) ) {
3599 foreach ( $missingAdded as $cat ) {
3601 'cat_title' => $cat,
3603 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3604 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3617 if ( count( $deleted ) ) {
3621 [ 'cat_title' => $deleted ],
3626 foreach ( $added as $catName ) {
3627 $cat = Category
::newFromName( $catName );
3628 Hooks
::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3631 foreach ( $deleted as $catName ) {
3632 $cat = Category
::newFromName( $catName );
3633 Hooks
::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3636 // Refresh counts on categories that should be empty now
3637 if ( count( $deleted ) ) {
3638 $rows = $dbw->select(
3640 [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
3641 [ 'cat_title' => $deleted, 'cat_pages <= 100' ],
3644 foreach ( $rows as $row ) {
3645 $cat = Category
::newFromRow( $row );
3646 // T166757: do the update after this DB commit
3647 DeferredUpdates
::addCallableUpdate( function () use ( $cat ) {
3648 $cat->refreshCounts();
3655 * Opportunistically enqueue link update jobs given fresh parser output if useful
3657 * @param ParserOutput $parserOutput Current version page output
3660 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3661 if ( wfReadOnly() ) {
3665 if ( !Hooks
::run( 'OpportunisticLinksUpdate',
3666 [ $this, $this->mTitle
, $parserOutput ]
3671 $config = RequestContext
::getMain()->getConfig();
3674 'isOpportunistic' => true,
3675 'rootJobTimestamp' => $parserOutput->getCacheTime()
3678 if ( $this->mTitle
->areRestrictionsCascading() ) {
3679 // If the page is cascade protecting, the links should really be up-to-date
3680 JobQueueGroup
::singleton()->lazyPush(
3681 RefreshLinksJob
::newPrioritized( $this->mTitle
, $params )
3683 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3684 // Assume the output contains "dynamic" time/random based magic words.
3685 // Only update pages that expired due to dynamic content and NOT due to edits
3686 // to referenced templates/files. When the cache expires due to dynamic content,
3687 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3688 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3689 // template/file edit already triggered recursive RefreshLinksJob jobs.
3690 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3691 // If a page is uncacheable, do not keep spamming a job for it.
3692 // Although it would be de-duplicated, it would still waste I/O.
3693 $cache = ObjectCache
::getLocalClusterInstance();
3694 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3695 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3696 if ( $cache->add( $key, time(), $ttl ) ) {
3697 JobQueueGroup
::singleton()->lazyPush(
3698 RefreshLinksJob
::newDynamic( $this->mTitle
, $params )
3706 * Returns a list of updates to be performed when this page is deleted. The
3707 * updates should remove any information about this page from secondary data
3708 * stores such as links tables.
3710 * @param Content|null $content Optional Content object for determining the
3711 * necessary updates.
3712 * @return DeferrableUpdate[]
3714 public function getDeletionUpdates( Content
$content = null ) {
3716 // load content object, which may be used to determine the necessary updates.
3717 // XXX: the content may not be needed to determine the updates.
3719 $content = $this->getContent( Revision
::RAW
);
3720 } catch ( Exception
$ex ) {
3721 // If we can't load the content, something is wrong. Perhaps that's why
3722 // the user is trying to delete the page, so let's not fail in that case.
3723 // Note that doDeleteArticleReal() will already have logged an issue with
3724 // loading the content.
3731 $updates = $content->getDeletionUpdates( $this );
3734 Hooks
::run( 'WikiPageDeletionUpdates', [ $this, $content, &$updates ] );
3739 * Whether this content displayed on this page
3740 * comes from the local database
3745 public function isLocal() {
3750 * The display name for the site this content
3751 * come from. If a subclass overrides isLocal(),
3752 * this could return something other than the
3758 public function getWikiDisplayName() {
3764 * Get the source URL for the content on this page,
3765 * typically the canonical URL, but may be a remote
3766 * link if the content comes from another site
3771 public function getSourceURL() {
3772 return $this->getTitle()->getCanonicalURL();
3776 * @param WANObjectCache $cache
3780 public function getMutableCacheKeys( WANObjectCache
$cache ) {
3781 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3783 return $linkCache->getMutableCacheKeys( $cache, $this->getTitle()->getTitleValue() );