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 MediaWiki\Revision\RevisionRecord
;
27 use MediaWiki\Revision\RevisionRenderer
;
28 use MediaWiki\Revision\RevisionStore
;
29 use MediaWiki\Revision\SlotRoleRegistry
;
30 use MediaWiki\Revision\SlotRecord
;
31 use MediaWiki\Storage\DerivedPageDataUpdater
;
32 use MediaWiki\Storage\PageUpdater
;
33 use MediaWiki\Storage\RevisionSlotsUpdate
;
34 use Wikimedia\Assert\Assert
;
35 use Wikimedia\Rdbms\FakeResultWrapper
;
36 use Wikimedia\Rdbms\IDatabase
;
37 use Wikimedia\Rdbms\LoadBalancer
;
40 * Class representing a MediaWiki article and history.
42 * Some fields are public only for backwards-compatibility. Use accessors.
43 * In the past, this class was part of Article.php and everything was public.
45 class WikiPage
implements Page
, IDBAccessObject
{
46 // Constants for $mDataLoadedFrom and related
51 public $mTitle = null;
57 public $mDataLoaded = false;
63 public $mIsRedirect = false;
66 * @var int|false False means "not loaded"
69 public $mLatest = false;
71 /** @var PreparedEdit Map of cache fields (text, parser output, ect) for a proposed/new edit */
72 public $mPreparedEdit = false;
77 protected $mId = null;
80 * @var int One of the READ_* constants
82 protected $mDataLoadedFrom = self
::READ_NONE
;
87 protected $mRedirectTarget = null;
92 protected $mLastRevision = null;
95 * @var string Timestamp of the current revision or empty string if not loaded
97 protected $mTimestamp = '';
102 protected $mTouched = '19700101000000';
107 protected $mLinksUpdated = '19700101000000';
110 * @var DerivedPageDataUpdater|null
112 private $derivedDataUpdater = null;
115 * Constructor and clear the article
116 * @param Title $title Reference to a Title object.
118 public function __construct( Title
$title ) {
119 $this->mTitle
= $title;
123 * Makes sure that the mTitle object is cloned
124 * to the newly cloned WikiPage.
126 public function __clone() {
127 $this->mTitle
= clone $this->mTitle
;
131 * Create a WikiPage object of the appropriate class for the given title.
133 * @param Title $title
135 * @throws MWException
136 * @return WikiPage|WikiCategoryPage|WikiFilePage
138 public static function factory( Title
$title ) {
139 $ns = $title->getNamespace();
141 if ( $ns == NS_MEDIA
) {
142 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
143 } elseif ( $ns < 0 ) {
144 throw new MWException( "Invalid or virtual namespace $ns given." );
148 if ( !Hooks
::run( 'WikiPageFactory', [ $title, &$page ] ) ) {
154 $page = new WikiFilePage( $title );
157 $page = new WikiCategoryPage( $title );
160 $page = new WikiPage( $title );
167 * Constructor from a page id
169 * @param int $id Article ID to load
170 * @param string|int $from One of the following values:
171 * - "fromdb" or WikiPage::READ_NORMAL to select from a replica DB
172 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
174 * @return WikiPage|null
176 public static function newFromID( $id, $from = 'fromdb' ) {
177 // page ids are never 0 or negative, see T63166
182 $from = self
::convertSelectType( $from );
183 $db = wfGetDB( $from === self
::READ_LATEST ? DB_MASTER
: DB_REPLICA
);
184 $pageQuery = self
::getQueryInfo();
185 $row = $db->selectRow(
186 $pageQuery['tables'], $pageQuery['fields'], [ 'page_id' => $id ], __METHOD__
,
187 [], $pageQuery['joins']
192 return self
::newFromRow( $row, $from );
196 * Constructor from a database row
199 * @param object $row Database row containing at least fields returned by selectFields().
200 * @param string|int $from Source of $data:
201 * - "fromdb" or WikiPage::READ_NORMAL: from a replica DB
202 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
203 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
206 public static function newFromRow( $row, $from = 'fromdb' ) {
207 $page = self
::factory( Title
::newFromRow( $row ) );
208 $page->loadFromRow( $row, $from );
213 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
215 * @param object|string|int $type
218 protected static function convertSelectType( $type ) {
221 return self
::READ_NORMAL
;
223 return self
::READ_LATEST
;
225 return self
::READ_LOCKING
;
227 // It may already be an integer or whatever else
233 * @return RevisionStore
235 private function getRevisionStore() {
236 return MediaWikiServices
::getInstance()->getRevisionStore();
240 * @return RevisionRenderer
242 private function getRevisionRenderer() {
243 return MediaWikiServices
::getInstance()->getRevisionRenderer();
247 * @return SlotRoleRegistry
249 private function getSlotRoleRegistry() {
250 return MediaWikiServices
::getInstance()->getSlotRoleRegistry();
254 * @return ParserCache
256 private function getParserCache() {
257 return MediaWikiServices
::getInstance()->getParserCache();
261 * @return LoadBalancer
263 private function getDBLoadBalancer() {
264 return MediaWikiServices
::getInstance()->getDBLoadBalancer();
268 * @todo Move this UI stuff somewhere else
270 * @see ContentHandler::getActionOverrides
273 public function getActionOverrides() {
274 return $this->getContentHandler()->getActionOverrides();
278 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
280 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
282 * @return ContentHandler
286 public function getContentHandler() {
287 return ContentHandler
::getForModelID( $this->getContentModel() );
291 * Get the title object of the article
292 * @return Title Title object of this page
294 public function getTitle() {
295 return $this->mTitle
;
302 public function clear() {
303 $this->mDataLoaded
= false;
304 $this->mDataLoadedFrom
= self
::READ_NONE
;
306 $this->clearCacheFields();
310 * Clear the object cache fields
313 protected function clearCacheFields() {
315 $this->mRedirectTarget
= null; // Title object if set
316 $this->mLastRevision
= null; // Latest revision
317 $this->mTouched
= '19700101000000';
318 $this->mLinksUpdated
= '19700101000000';
319 $this->mTimestamp
= '';
320 $this->mIsRedirect
= false;
321 $this->mLatest
= false;
322 // T59026: do not clear $this->derivedDataUpdater since getDerivedDataUpdater() already
323 // checks the requested rev ID and content against the cached one. For most
324 // content types, the output should not change during the lifetime of this cache.
325 // Clearing it can cause extra parses on edit for no reason.
329 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
333 public function clearPreparedEdit() {
334 $this->mPreparedEdit
= false;
338 * Return the list of revision fields that should be selected to create
341 * @deprecated since 1.31, use self::getQueryInfo() instead.
344 public static function selectFields() {
345 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
347 wfDeprecated( __METHOD__
, '1.31' );
358 'page_links_updated',
363 if ( $wgContentHandlerUseDB ) {
364 $fields[] = 'page_content_model';
367 if ( $wgPageLanguageUseDB ) {
368 $fields[] = 'page_lang';
375 * Return the tables, fields, and join conditions to be selected to create
378 * @return array With three keys:
379 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
380 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
381 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
383 public static function getQueryInfo() {
384 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
387 'tables' => [ 'page' ],
397 'page_links_updated',
404 if ( $wgContentHandlerUseDB ) {
405 $ret['fields'][] = 'page_content_model';
408 if ( $wgPageLanguageUseDB ) {
409 $ret['fields'][] = 'page_lang';
416 * Fetch a page record with the given conditions
417 * @param IDatabase $dbr
418 * @param array $conditions
419 * @param array $options
420 * @return object|bool Database result resource, or false on failure
422 protected function pageData( $dbr, $conditions, $options = [] ) {
423 $pageQuery = self
::getQueryInfo();
425 // Avoid PHP 7.1 warning of passing $this by reference
428 Hooks
::run( 'ArticlePageDataBefore', [
429 &$wikiPage, &$pageQuery['fields'], &$pageQuery['tables'], &$pageQuery['joins']
432 $row = $dbr->selectRow(
433 $pageQuery['tables'],
434 $pageQuery['fields'],
441 Hooks
::run( 'ArticlePageDataAfter', [ &$wikiPage, &$row ] );
447 * Fetch a page record matching the Title object's namespace and title
448 * using a sanitized title string
450 * @param IDatabase $dbr
451 * @param Title $title
452 * @param array $options
453 * @return object|bool Database result resource, or false on failure
455 public function pageDataFromTitle( $dbr, $title, $options = [] ) {
456 return $this->pageData( $dbr, [
457 'page_namespace' => $title->getNamespace(),
458 'page_title' => $title->getDBkey() ], $options );
462 * Fetch a page record matching the requested ID
464 * @param IDatabase $dbr
466 * @param array $options
467 * @return object|bool Database result resource, or false on failure
469 public function pageDataFromId( $dbr, $id, $options = [] ) {
470 return $this->pageData( $dbr, [ 'page_id' => $id ], $options );
474 * Load the object from a given source by title
476 * @param object|string|int $from One of the following:
477 * - A DB query result object.
478 * - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
479 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
480 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
481 * using SELECT FOR UPDATE.
485 public function loadPageData( $from = 'fromdb' ) {
486 $from = self
::convertSelectType( $from );
487 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
488 // We already have the data from the correct location, no need to load it twice.
492 if ( is_int( $from ) ) {
493 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
494 $loadBalancer = $this->getDBLoadBalancer();
495 $db = $loadBalancer->getConnection( $index );
496 $data = $this->pageDataFromTitle( $db, $this->mTitle
, $opts );
499 && $index == DB_REPLICA
500 && $loadBalancer->getServerCount() > 1
501 && $loadBalancer->hasOrMadeRecentMasterChanges()
503 $from = self
::READ_LATEST
;
504 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
505 $db = $loadBalancer->getConnection( $index );
506 $data = $this->pageDataFromTitle( $db, $this->mTitle
, $opts );
509 // No idea from where the caller got this data, assume replica DB.
511 $from = self
::READ_NORMAL
;
514 $this->loadFromRow( $data, $from );
518 * Checks whether the page data was loaded using the given database access mode (or better).
522 * @param string|int $from One of the following:
523 * - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
524 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
525 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
526 * using SELECT FOR UPDATE.
530 public function wasLoadedFrom( $from ) {
531 $from = self
::convertSelectType( $from );
533 if ( !is_int( $from ) ) {
534 // No idea from where the caller got this data, assume replica DB.
535 $from = self
::READ_NORMAL
;
538 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
546 * Load the object from a database row
549 * @param object|bool $data DB row containing fields returned by selectFields() or false
550 * @param string|int $from One of the following:
551 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB
552 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
553 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
554 * the master DB using SELECT FOR UPDATE
556 public function loadFromRow( $data, $from ) {
557 $lc = MediaWikiServices
::getInstance()->getLinkCache();
558 $lc->clearLink( $this->mTitle
);
561 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
563 $this->mTitle
->loadFromRow( $data );
565 // Old-fashioned restrictions
566 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
568 $this->mId
= intval( $data->page_id
);
569 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
570 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
571 $this->mIsRedirect
= intval( $data->page_is_redirect
);
572 $this->mLatest
= intval( $data->page_latest
);
573 // T39225: $latest may no longer match the cached latest Revision object.
574 // Double-check the ID of any cached latest Revision object for consistency.
575 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
576 $this->mLastRevision
= null;
577 $this->mTimestamp
= '';
580 $lc->addBadLinkObj( $this->mTitle
);
582 $this->mTitle
->loadFromRow( false );
584 $this->clearCacheFields();
589 $this->mDataLoaded
= true;
590 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
594 * @return int Page ID
596 public function getId() {
597 if ( !$this->mDataLoaded
) {
598 $this->loadPageData();
604 * @return bool Whether or not the page exists in the database
606 public function exists() {
607 if ( !$this->mDataLoaded
) {
608 $this->loadPageData();
610 return $this->mId
> 0;
614 * Check if this page is something we're going to be showing
615 * some sort of sensible content for. If we return false, page
616 * views (plain action=view) will return an HTTP 404 response,
617 * so spiders and robots can know they're following a bad link.
621 public function hasViewableContent() {
622 return $this->mTitle
->isKnown();
626 * Tests if the article content represents a redirect
630 public function isRedirect() {
631 if ( !$this->mDataLoaded
) {
632 $this->loadPageData();
635 return (bool)$this->mIsRedirect
;
639 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
641 * Will use the revisions actual content model if the page exists,
642 * and the page's default if the page doesn't exist yet.
648 public function getContentModel() {
649 if ( $this->exists() ) {
650 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
652 return $cache->getWithSetCallback(
653 $cache->makeKey( 'page-content-model', $this->getLatest() ),
656 $rev = $this->getRevision();
658 // Look at the revision's actual content model
659 return $rev->getContentModel();
661 $title = $this->mTitle
->getPrefixedDBkey();
662 wfWarn( "Page $title exists but has no (visible) revisions!" );
663 return $this->mTitle
->getContentModel();
669 // use the default model for this page
670 return $this->mTitle
->getContentModel();
674 * Loads page_touched and returns a value indicating if it should be used
675 * @return bool True if this page exists and is not a redirect
677 public function checkTouched() {
678 if ( !$this->mDataLoaded
) {
679 $this->loadPageData();
681 return ( $this->mId
&& !$this->mIsRedirect
);
685 * Get the page_touched field
686 * @return string Containing GMT timestamp
688 public function getTouched() {
689 if ( !$this->mDataLoaded
) {
690 $this->loadPageData();
692 return $this->mTouched
;
696 * Get the page_links_updated field
697 * @return string|null Containing GMT timestamp
699 public function getLinksTimestamp() {
700 if ( !$this->mDataLoaded
) {
701 $this->loadPageData();
703 return $this->mLinksUpdated
;
707 * Get the page_latest field
708 * @return int The rev_id of current revision
710 public function getLatest() {
711 if ( !$this->mDataLoaded
) {
712 $this->loadPageData();
714 return (int)$this->mLatest
;
718 * Get the Revision object of the oldest revision
719 * @return Revision|null
721 public function getOldestRevision() {
722 // Try using the replica DB first, then try the master
723 $rev = $this->mTitle
->getFirstRevision();
725 $rev = $this->mTitle
->getFirstRevision( Title
::GAID_FOR_UPDATE
);
731 * Loads everything except the text
732 * This isn't necessary for all uses, so it's only done if needed.
734 protected function loadLastEdit() {
735 if ( $this->mLastRevision
!== null ) {
736 return; // already loaded
739 $latest = $this->getLatest();
741 return; // page doesn't exist or is missing page_latest info
744 if ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) {
745 // T39225: if session S1 loads the page row FOR UPDATE, the result always
746 // includes the latest changes committed. This is true even within REPEATABLE-READ
747 // transactions, where S1 normally only sees changes committed before the first S1
748 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
749 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
750 // happened after the first S1 SELECT.
751 // https://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read
752 $flags = Revision
::READ_LOCKING
;
753 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
754 } elseif ( $this->mDataLoadedFrom
== self
::READ_LATEST
) {
755 // Bug T93976: if page_latest was loaded from the master, fetch the
756 // revision from there as well, as it may not exist yet on a replica DB.
757 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
758 $flags = Revision
::READ_LATEST
;
759 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
761 $dbr = wfGetDB( DB_REPLICA
);
762 $revision = Revision
::newKnownCurrent( $dbr, $this->getTitle(), $latest );
765 if ( $revision ) { // sanity
766 $this->setLastEdit( $revision );
771 * Set the latest revision
772 * @param Revision $revision
774 protected function setLastEdit( Revision
$revision ) {
775 $this->mLastRevision
= $revision;
776 $this->mTimestamp
= $revision->getTimestamp();
780 * Get the latest revision
781 * @return Revision|null
783 public function getRevision() {
784 $this->loadLastEdit();
785 if ( $this->mLastRevision
) {
786 return $this->mLastRevision
;
792 * Get the latest revision
793 * @return RevisionRecord|null
795 public function getRevisionRecord() {
796 $this->loadLastEdit();
797 if ( $this->mLastRevision
) {
798 return $this->mLastRevision
->getRevisionRecord();
804 * Get the content of the current revision. No side-effects...
806 * @param int $audience One of:
807 * Revision::FOR_PUBLIC to be displayed to all users
808 * Revision::FOR_THIS_USER to be displayed to $wgUser
809 * Revision::RAW get the text regardless of permissions
810 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
811 * to the $audience parameter
812 * @return Content|null The content of the current revision
816 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
817 $this->loadLastEdit();
818 if ( $this->mLastRevision
) {
819 return $this->mLastRevision
->getContent( $audience, $user );
825 * @return string MW timestamp of last article revision
827 public function getTimestamp() {
828 // Check if the field has been filled by WikiPage::setTimestamp()
829 if ( !$this->mTimestamp
) {
830 $this->loadLastEdit();
833 return wfTimestamp( TS_MW
, $this->mTimestamp
);
837 * Set the page timestamp (use only to avoid DB queries)
838 * @param string $ts MW timestamp of last article revision
841 public function setTimestamp( $ts ) {
842 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
846 * @param int $audience One of:
847 * Revision::FOR_PUBLIC to be displayed to all users
848 * Revision::FOR_THIS_USER to be displayed to the given user
849 * Revision::RAW get the text regardless of permissions
850 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
851 * to the $audience parameter
852 * @return int User ID for the user that made the last article revision
854 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
855 $this->loadLastEdit();
856 if ( $this->mLastRevision
) {
857 return $this->mLastRevision
->getUser( $audience, $user );
864 * Get the User object of the user who created the page
865 * @param int $audience One of:
866 * Revision::FOR_PUBLIC to be displayed to all users
867 * Revision::FOR_THIS_USER to be displayed to the given user
868 * Revision::RAW get the text regardless of permissions
869 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
870 * to the $audience parameter
873 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
874 $revision = $this->getOldestRevision();
876 $userName = $revision->getUserText( $audience, $user );
877 return User
::newFromName( $userName, false );
884 * @param int $audience One of:
885 * Revision::FOR_PUBLIC to be displayed to all users
886 * Revision::FOR_THIS_USER to be displayed to the given user
887 * Revision::RAW get the text regardless of permissions
888 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
889 * to the $audience parameter
890 * @return string Username of the user that made the last article revision
892 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
893 $this->loadLastEdit();
894 if ( $this->mLastRevision
) {
895 return $this->mLastRevision
->getUserText( $audience, $user );
902 * @param int $audience One of:
903 * Revision::FOR_PUBLIC to be displayed to all users
904 * Revision::FOR_THIS_USER to be displayed to the given user
905 * Revision::RAW get the text regardless of permissions
906 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
907 * to the $audience parameter
908 * @return string|null Comment stored for the last article revision, or null if the specified
909 * audience does not have access to the comment.
911 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
912 $this->loadLastEdit();
913 if ( $this->mLastRevision
) {
914 return $this->mLastRevision
->getComment( $audience, $user );
921 * Returns true if last revision was marked as "minor edit"
923 * @return bool Minor edit indicator for the last article revision.
925 public function getMinorEdit() {
926 $this->loadLastEdit();
927 if ( $this->mLastRevision
) {
928 return $this->mLastRevision
->isMinor();
935 * Determine whether a page would be suitable for being counted as an
936 * article in the site_stats table based on the title & its content
938 * @param PreparedEdit|bool $editInfo (false): object returned by prepareTextForEdit(),
939 * if false, the current database state will be used
942 public function isCountable( $editInfo = false ) {
943 global $wgArticleCountMethod;
945 // NOTE: Keep in sync with DerivedPageDataUpdater::isCountable.
947 if ( !$this->mTitle
->isContentPage() ) {
952 // NOTE: only the main slot can make a page a redirect
953 $content = $editInfo->pstContent
;
955 $content = $this->getContent();
958 if ( !$content ||
$content->isRedirect() ) {
964 if ( $wgArticleCountMethod === 'link' ) {
965 // nasty special case to avoid re-parsing to detect links
968 // ParserOutput::getLinks() is a 2D array of page links, so
969 // to be really correct we would need to recurse in the array
970 // but the main array should only have items in it if there are
972 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
974 // NOTE: keep in sync with RevisionRenderer::getLinkCount
975 // NOTE: keep in sync with DerivedPageDataUpdater::isCountable
976 $hasLinks = (bool)wfGetDB( DB_REPLICA
)->selectField( 'pagelinks', 1,
977 [ 'pl_from' => $this->getId() ], __METHOD__
);
981 // TODO: MCR: determine $hasLinks for each slot, and use that info
982 // with that slot's Content's isCountable method. That requires per-
983 // slot ParserOutput in the ParserCache, or per-slot info in the
985 return $content->isCountable( $hasLinks );
989 * If this page is a redirect, get its target
991 * The target will be fetched from the redirect table if possible.
992 * If this page doesn't have an entry there, call insertRedirect()
993 * @return Title|null Title object, or null if this page is not a redirect
995 public function getRedirectTarget() {
996 if ( !$this->mTitle
->isRedirect() ) {
1000 if ( $this->mRedirectTarget
!== null ) {
1001 return $this->mRedirectTarget
;
1004 // Query the redirect table
1005 $dbr = wfGetDB( DB_REPLICA
);
1006 $row = $dbr->selectRow( 'redirect',
1007 [ 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ],
1008 [ 'rd_from' => $this->getId() ],
1012 // rd_fragment and rd_interwiki were added later, populate them if empty
1013 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
1014 // (T203942) We can't redirect to Media namespace because it's virtual.
1015 // We don't want to modify Title objects farther down the
1016 // line. So, let's fix this here by changing to File namespace.
1017 if ( $row->rd_namespace
== NS_MEDIA
) {
1018 $namespace = NS_FILE
;
1020 $namespace = $row->rd_namespace
;
1022 $this->mRedirectTarget
= Title
::makeTitle(
1023 $namespace, $row->rd_title
,
1024 $row->rd_fragment
, $row->rd_interwiki
1026 return $this->mRedirectTarget
;
1029 // This page doesn't have an entry in the redirect table
1030 $this->mRedirectTarget
= $this->insertRedirect();
1031 return $this->mRedirectTarget
;
1035 * Insert an entry for this page into the redirect table if the content is a redirect
1037 * The database update will be deferred via DeferredUpdates
1039 * Don't call this function directly unless you know what you're doing.
1040 * @return Title|null Title object or null if not a redirect
1042 public function insertRedirect() {
1043 $content = $this->getContent();
1044 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
1049 // Update the DB post-send if the page has not cached since now
1050 $latest = $this->getLatest();
1051 DeferredUpdates
::addCallableUpdate(
1052 function () use ( $retval, $latest ) {
1053 $this->insertRedirectEntry( $retval, $latest );
1055 DeferredUpdates
::POSTSEND
,
1056 wfGetDB( DB_MASTER
)
1063 * Insert or update the redirect table entry for this page to indicate it redirects to $rt
1064 * @param Title $rt Redirect target
1065 * @param int|null $oldLatest Prior page_latest for check and set
1067 public function insertRedirectEntry( Title
$rt, $oldLatest = null ) {
1068 $dbw = wfGetDB( DB_MASTER
);
1069 $dbw->startAtomic( __METHOD__
);
1071 if ( !$oldLatest ||
$oldLatest == $this->lockAndGetLatest() ) {
1072 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1073 $truncatedFragment = $contLang->truncateForDatabase( $rt->getFragment(), 255 );
1077 'rd_from' => $this->getId(),
1078 'rd_namespace' => $rt->getNamespace(),
1079 'rd_title' => $rt->getDBkey(),
1080 'rd_fragment' => $truncatedFragment,
1081 'rd_interwiki' => $rt->getInterwiki(),
1085 'rd_namespace' => $rt->getNamespace(),
1086 'rd_title' => $rt->getDBkey(),
1087 'rd_fragment' => $truncatedFragment,
1088 'rd_interwiki' => $rt->getInterwiki(),
1094 $dbw->endAtomic( __METHOD__
);
1098 * Get the Title object or URL this page redirects to
1100 * @return bool|Title|string False, Title of in-wiki target, or string with URL
1102 public function followRedirect() {
1103 return $this->getRedirectURL( $this->getRedirectTarget() );
1107 * Get the Title object or URL to use for a redirect. We use Title
1108 * objects for same-wiki, non-special redirects and URLs for everything
1110 * @param Title $rt Redirect target
1111 * @return bool|Title|string False, Title object of local target, or string with URL
1113 public function getRedirectURL( $rt ) {
1118 if ( $rt->isExternal() ) {
1119 if ( $rt->isLocal() ) {
1120 // Offsite wikis need an HTTP redirect.
1121 // This can be hard to reverse and may produce loops,
1122 // so they may be disabled in the site configuration.
1123 $source = $this->mTitle
->getFullURL( 'redirect=no' );
1124 return $rt->getFullURL( [ 'rdfrom' => $source ] );
1126 // External pages without "local" bit set are not valid
1132 if ( $rt->isSpecialPage() ) {
1133 // Gotta handle redirects to special pages differently:
1134 // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
1135 // Some pages are not valid targets.
1136 if ( $rt->isValidRedirectTarget() ) {
1137 return $rt->getFullURL();
1147 * Get a list of users who have edited this article, not including the user who made
1148 * the most recent revision, which you can get from $article->getUser() if you want it
1149 * @return UserArrayFromResult
1151 public function getContributors() {
1152 // @todo: This is expensive; cache this info somewhere.
1154 $dbr = wfGetDB( DB_REPLICA
);
1156 $actorMigration = ActorMigration
::newMigration();
1157 $actorQuery = $actorMigration->getJoin( 'rev_user' );
1159 $tables = array_merge( [ 'revision' ], $actorQuery['tables'], [ 'user' ] );
1162 'user_id' => $actorQuery['fields']['rev_user'],
1163 'user_name' => $actorQuery['fields']['rev_user_text'],
1164 'actor_id' => $actorQuery['fields']['rev_actor'],
1165 'user_real_name' => 'MIN(user_real_name)',
1166 'timestamp' => 'MAX(rev_timestamp)',
1169 $conds = [ 'rev_page' => $this->getId() ];
1171 // The user who made the top revision gets credited as "this page was last edited by
1172 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1173 $user = $this->getUser()
1174 ? User
::newFromId( $this->getUser() )
1175 : User
::newFromName( $this->getUserText(), false );
1176 $conds[] = 'NOT(' . $actorMigration->getWhere( $dbr, 'rev_user', $user )['conds'] . ')';
1179 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1182 'user' => [ 'LEFT JOIN', $actorQuery['fields']['rev_user'] . ' = user_id' ],
1183 ] +
$actorQuery['joins'];
1186 'GROUP BY' => [ $fields['user_id'], $fields['user_name'] ],
1187 'ORDER BY' => 'timestamp DESC',
1190 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1191 return new UserArrayFromResult( $res );
1195 * Should the parser cache be used?
1197 * @param ParserOptions $parserOptions ParserOptions to check
1201 public function shouldCheckParserCache( ParserOptions
$parserOptions, $oldId ) {
1202 return $parserOptions->getStubThreshold() == 0
1204 && ( $oldId === null ||
$oldId === 0 ||
$oldId === $this->getLatest() )
1205 && $this->getContentHandler()->isParserCacheSupported();
1209 * Get a ParserOutput for the given ParserOptions and revision ID.
1211 * The parser cache will be used if possible. Cache misses that result
1212 * in parser runs are debounced with PoolCounter.
1214 * XXX merge this with updateParserCache()?
1217 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1218 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1219 * get the current revision (default value)
1220 * @param bool $forceParse Force reindexing, regardless of cache settings
1221 * @return bool|ParserOutput ParserOutput or false if the revision was not found
1223 public function getParserOutput(
1224 ParserOptions
$parserOptions, $oldid = null, $forceParse = false
1227 ( !$forceParse ) && $this->shouldCheckParserCache( $parserOptions, $oldid );
1229 if ( $useParserCache && !$parserOptions->isSafeToCache() ) {
1230 throw new InvalidArgumentException(
1231 'The supplied ParserOptions are not safe to cache. Fix the options or set $forceParse = true.'
1235 wfDebug( __METHOD__
.
1236 ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1237 if ( $parserOptions->getStubThreshold() ) {
1238 wfIncrStats( 'pcache.miss.stub' );
1241 if ( $useParserCache ) {
1242 $parserOutput = $this->getParserCache()
1243 ->get( $this, $parserOptions );
1244 if ( $parserOutput !== false ) {
1245 return $parserOutput;
1249 if ( $oldid === null ||
$oldid === 0 ) {
1250 $oldid = $this->getLatest();
1253 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1256 return $pool->getParserOutput();
1260 * Do standard deferred updates after page view (existing or missing page)
1261 * @param User $user The relevant user
1262 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1264 public function doViewUpdates( User
$user, $oldid = 0 ) {
1265 if ( wfReadOnly() ) {
1269 // Update newtalk / watchlist notification status;
1270 // Avoid outage if the master is not reachable by using a deferred updated
1271 DeferredUpdates
::addCallableUpdate(
1272 function () use ( $user, $oldid ) {
1273 Hooks
::run( 'PageViewUpdates', [ $this, $user ] );
1275 $user->clearNotification( $this->mTitle
, $oldid );
1277 DeferredUpdates
::PRESEND
1282 * Perform the actions of a page purging
1284 * @note In 1.28 (and only 1.28), this took a $flags parameter that
1285 * controlled how much purging was done.
1287 public function doPurge() {
1288 // Avoid PHP 7.1 warning of passing $this by reference
1291 if ( !Hooks
::run( 'ArticlePurge', [ &$wikiPage ] ) ) {
1295 $this->mTitle
->invalidateCache();
1298 HTMLFileCache
::clearFileCache( $this->getTitle() );
1299 // Send purge after above page_touched update was committed
1300 DeferredUpdates
::addUpdate(
1301 new CdnCacheUpdate( $this->mTitle
->getCdnUrls() ),
1302 DeferredUpdates
::PRESEND
1305 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1306 $messageCache = MessageCache
::singleton();
1307 $messageCache->updateMessageOverride( $this->mTitle
, $this->getContent() );
1314 * Insert a new empty page record for this article.
1315 * This *must* be followed up by creating a revision
1316 * and running $this->updateRevisionOn( ... );
1317 * or else the record will be left in a funky state.
1318 * Best if all done inside a transaction.
1320 * @todo Factor out into a PageStore service, to be used by PageUpdater.
1322 * @param IDatabase $dbw
1323 * @param int|null $pageId Custom page ID that will be used for the insert statement
1325 * @return bool|int The newly created page_id key; false if the row was not
1326 * inserted, e.g. because the title already existed or because the specified
1327 * page ID is already in use.
1329 public function insertOn( $dbw, $pageId = null ) {
1330 $pageIdForInsert = $pageId ?
[ 'page_id' => $pageId ] : [];
1334 'page_namespace' => $this->mTitle
->getNamespace(),
1335 'page_title' => $this->mTitle
->getDBkey(),
1336 'page_restrictions' => '',
1337 'page_is_redirect' => 0, // Will set this shortly...
1339 'page_random' => wfRandom(),
1340 'page_touched' => $dbw->timestamp(),
1341 'page_latest' => 0, // Fill this in shortly...
1342 'page_len' => 0, // Fill this in shortly...
1343 ] +
$pageIdForInsert,
1348 if ( $dbw->affectedRows() > 0 ) {
1349 $newid = $pageId ?
(int)$pageId : $dbw->insertId();
1350 $this->mId
= $newid;
1351 $this->mTitle
->resetArticleID( $newid );
1355 return false; // nothing changed
1360 * Update the page record to point to a newly saved revision.
1362 * @todo Factor out into a PageStore service, or move into PageUpdater.
1364 * @param IDatabase $dbw
1365 * @param Revision $revision For ID number, and text used to set
1366 * length and redirect status fields
1367 * @param int|null $lastRevision If given, will not overwrite the page field
1368 * when different from the currently set value.
1369 * Giving 0 indicates the new page flag should be set on.
1370 * @param bool|null $lastRevIsRedirect If given, will optimize adding and
1371 * removing rows in redirect table.
1372 * @return bool Success; false if the page row was missing or page_latest changed
1374 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1375 $lastRevIsRedirect = null
1377 global $wgContentHandlerUseDB;
1379 // TODO: move into PageUpdater or PageStore
1380 // NOTE: when doing that, make sure cached fields get reset in doEditContent,
1381 // and in the compat stub!
1383 // Assertion to try to catch T92046
1384 if ( (int)$revision->getId() === 0 ) {
1385 throw new InvalidArgumentException(
1386 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1390 $content = $revision->getContent();
1391 $len = $content ?
$content->getSize() : 0;
1392 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1394 $conditions = [ 'page_id' => $this->getId() ];
1396 if ( !is_null( $lastRevision ) ) {
1397 // An extra check against threads stepping on each other
1398 $conditions['page_latest'] = $lastRevision;
1401 $revId = $revision->getId();
1402 Assert
::parameter( $revId > 0, '$revision->getId()', 'must be > 0' );
1405 'page_latest' => $revId,
1406 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1407 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1408 'page_is_redirect' => $rt !== null ?
1 : 0,
1412 if ( $wgContentHandlerUseDB ) {
1413 $row['page_content_model'] = $revision->getContentModel();
1416 $dbw->update( 'page',
1421 $result = $dbw->affectedRows() > 0;
1423 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1424 $this->setLastEdit( $revision );
1425 $this->mLatest
= $revision->getId();
1426 $this->mIsRedirect
= (bool)$rt;
1427 // Update the LinkCache.
1428 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
1429 $linkCache->addGoodLinkObj(
1435 $revision->getContentModel()
1443 * Add row to the redirect table if this is a redirect, remove otherwise.
1445 * @param IDatabase $dbw
1446 * @param Title|null $redirectTitle Title object pointing to the redirect target,
1447 * or NULL if this is not a redirect
1448 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1449 * removing rows in redirect table.
1450 * @return bool True on success, false on failure
1453 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1454 // Always update redirects (target link might have changed)
1455 // Update/Insert if we don't know if the last revision was a redirect or not
1456 // Delete if changing from redirect to non-redirect
1457 $isRedirect = !is_null( $redirectTitle );
1459 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1463 if ( $isRedirect ) {
1464 $this->insertRedirectEntry( $redirectTitle );
1466 // This is not a redirect, remove row from redirect table
1467 $where = [ 'rd_from' => $this->getId() ];
1468 $dbw->delete( 'redirect', $where, __METHOD__
);
1471 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1472 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1475 return ( $dbw->affectedRows() != 0 );
1479 * If the given revision is newer than the currently set page_latest,
1480 * update the page record. Otherwise, do nothing.
1482 * @deprecated since 1.24, use updateRevisionOn instead
1484 * @param IDatabase $dbw
1485 * @param Revision $revision
1488 public function updateIfNewerOn( $dbw, $revision ) {
1489 $row = $dbw->selectRow(
1490 [ 'revision', 'page' ],
1491 [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1493 'page_id' => $this->getId(),
1494 'page_latest=rev_id' ],
1498 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1501 $prev = $row->rev_id
;
1502 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1504 // No or missing previous revision; mark the page as new
1506 $lastRevIsRedirect = null;
1509 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1515 * Helper method for checking whether two revisions have differences that go
1516 * beyond the main slot.
1518 * MCR migration note: this method should go away!
1520 * @deprecated Use only as a stop-gap before refactoring to support MCR.
1522 * @param Revision $a
1523 * @param Revision $b
1526 public static function hasDifferencesOutsideMainSlot( Revision
$a, Revision
$b ) {
1527 $aSlots = $a->getRevisionRecord()->getSlots();
1528 $bSlots = $b->getRevisionRecord()->getSlots();
1529 $changedRoles = $aSlots->getRolesWithDifferentContent( $bSlots );
1531 return ( $changedRoles !== [ SlotRecord
::MAIN
] && $changedRoles !== [] );
1535 * Get the content that needs to be saved in order to undo all revisions
1536 * between $undo and $undoafter. Revisions must belong to the same page,
1537 * must exist and must not be deleted
1539 * @param Revision $undo
1540 * @param Revision $undoafter Must be an earlier revision than $undo
1541 * @return Content|bool Content on success, false on failure
1543 * Before we had the Content object, this was done in getUndoText
1545 public function getUndoContent( Revision
$undo, Revision
$undoafter ) {
1546 // TODO: MCR: replace this with a method that returns a RevisionSlotsUpdate
1548 if ( self
::hasDifferencesOutsideMainSlot( $undo, $undoafter ) ) {
1549 // Cannot yet undo edits that involve anything other the main slot.
1553 $handler = $undo->getContentHandler();
1554 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1558 * Returns true if this page's content model supports sections.
1562 * @todo The skin should check this and not offer section functionality if
1563 * sections are not supported.
1564 * @todo The EditPage should check this and not offer section functionality
1565 * if sections are not supported.
1567 public function supportsSections() {
1568 return $this->getContentHandler()->supportsSections();
1572 * @param string|int|null|bool $sectionId Section identifier as a number or string
1573 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1574 * or 'new' for a new section.
1575 * @param Content $sectionContent New content of the section.
1576 * @param string $sectionTitle New section's subject, only if $section is "new".
1577 * @param string $edittime Revision timestamp or null to use the current revision.
1579 * @throws MWException
1580 * @return Content|null New complete article content, or null if error.
1583 * @deprecated since 1.24, use replaceSectionAtRev instead
1585 public function replaceSectionContent(
1586 $sectionId, Content
$sectionContent, $sectionTitle = '', $edittime = null
1589 if ( $edittime && $sectionId !== 'new' ) {
1590 $lb = $this->getDBLoadBalancer();
1591 $dbr = $lb->getConnection( DB_REPLICA
);
1592 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1593 // Try the master if this thread may have just added it.
1594 // This could be abstracted into a Revision method, but we don't want
1595 // to encourage loading of revisions by timestamp.
1597 && $lb->getServerCount() > 1
1598 && $lb->hasOrMadeRecentMasterChanges()
1600 $dbw = $lb->getConnection( DB_MASTER
);
1601 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1604 $baseRevId = $rev->getId();
1608 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1612 * @param string|int|null|bool $sectionId Section identifier as a number or string
1613 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1614 * or 'new' for a new section.
1615 * @param Content $sectionContent New content of the section.
1616 * @param string $sectionTitle New section's subject, only if $section is "new".
1617 * @param int|null $baseRevId
1619 * @throws MWException
1620 * @return Content|null New complete article content, or null if error.
1624 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1625 $sectionTitle = '', $baseRevId = null
1627 if ( strval( $sectionId ) === '' ) {
1628 // Whole-page edit; let the whole text through
1629 $newContent = $sectionContent;
1631 if ( !$this->supportsSections() ) {
1632 throw new MWException( "sections not supported for content model " .
1633 $this->getContentHandler()->getModelID() );
1636 // T32711: always use current version when adding a new section
1637 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1638 $oldContent = $this->getContent();
1640 $rev = Revision
::newFromId( $baseRevId );
1642 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1643 $this->getId() . "; section: $sectionId)\n" );
1647 $oldContent = $rev->getContent();
1650 if ( !$oldContent ) {
1651 wfDebug( __METHOD__
. ": no page text\n" );
1655 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1662 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1664 * @deprecated since 1.32, use exists() instead, or simply omit the EDIT_UPDATE
1665 * and EDIT_NEW flags. To protect against race conditions, use PageUpdater::grabParentRevision.
1668 * @return int Updated $flags
1670 public function checkFlags( $flags ) {
1671 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1672 if ( $this->exists() ) {
1673 $flags |
= EDIT_UPDATE
;
1683 * @return DerivedPageDataUpdater
1685 private function newDerivedDataUpdater() {
1686 global $wgRCWatchCategoryMembership, $wgArticleCountMethod;
1688 $derivedDataUpdater = new DerivedPageDataUpdater(
1689 $this, // NOTE: eventually, PageUpdater should not know about WikiPage
1690 $this->getRevisionStore(),
1691 $this->getRevisionRenderer(),
1692 $this->getSlotRoleRegistry(),
1693 $this->getParserCache(),
1694 JobQueueGroup
::singleton(),
1695 MessageCache
::singleton(),
1696 MediaWikiServices
::getInstance()->getContentLanguage(),
1697 MediaWikiServices
::getInstance()->getDBLoadBalancerFactory()
1700 $derivedDataUpdater->setRcWatchCategoryMembership( $wgRCWatchCategoryMembership );
1701 $derivedDataUpdater->setArticleCountMethod( $wgArticleCountMethod );
1703 return $derivedDataUpdater;
1707 * Returns a DerivedPageDataUpdater for use with the given target revision or new content.
1708 * This method attempts to re-use the same DerivedPageDataUpdater instance for subsequent calls.
1709 * The parameters passed to this method are used to ensure that the DerivedPageDataUpdater
1710 * returned matches that caller's expectations, allowing an existing instance to be re-used
1711 * if the given parameters match that instance's internal state according to
1712 * DerivedPageDataUpdater::isReusableFor(), and creating a new instance of the parameters do not
1713 * match the existign one.
1715 * If neither $forRevision nor $forUpdate is given, a new DerivedPageDataUpdater is always
1716 * created, replacing any DerivedPageDataUpdater currently cached.
1718 * MCR migration note: this replaces WikiPage::prepareContentForEdit.
1722 * @param User|null $forUser The user that will be used for, or was used for, PST.
1723 * @param RevisionRecord|null $forRevision The revision created by the edit for which
1724 * to perform updates, if the edit was already saved.
1725 * @param RevisionSlotsUpdate|null $forUpdate The new content to be saved by the edit (pre PST),
1726 * if the edit was not yet saved.
1727 * @param bool $forEdit Only re-use if the cached DerivedPageDataUpdater has the current
1728 * revision as the edit's parent revision. This ensures that the same
1729 * DerivedPageDataUpdater cannot be re-used for two consecutive edits.
1731 * @return DerivedPageDataUpdater
1733 private function getDerivedDataUpdater(
1734 User
$forUser = null,
1735 RevisionRecord
$forRevision = null,
1736 RevisionSlotsUpdate
$forUpdate = null,
1739 if ( !$forRevision && !$forUpdate ) {
1740 // NOTE: can't re-use an existing derivedDataUpdater if we don't know what the caller is
1741 // going to use it with.
1742 $this->derivedDataUpdater
= null;
1745 if ( $this->derivedDataUpdater
&& !$this->derivedDataUpdater
->isContentPrepared() ) {
1746 // NOTE: can't re-use an existing derivedDataUpdater if other code that has a reference
1747 // to it did not yet initialize it, because we don't know what data it will be
1748 // initialized with.
1749 $this->derivedDataUpdater
= null;
1752 // XXX: It would be nice to have an LRU cache instead of trying to re-use a single instance.
1753 // However, there is no good way to construct a cache key. We'd need to check against all
1754 // cached instances.
1756 if ( $this->derivedDataUpdater
1757 && !$this->derivedDataUpdater
->isReusableFor(
1761 $forEdit ?
$this->getLatest() : null
1764 $this->derivedDataUpdater
= null;
1767 if ( !$this->derivedDataUpdater
) {
1768 $this->derivedDataUpdater
= $this->newDerivedDataUpdater();
1771 return $this->derivedDataUpdater
;
1775 * Returns a PageUpdater for creating new revisions on this page (or creating the page).
1777 * The PageUpdater can also be used to detect the need for edit conflict resolution,
1778 * and to protected such conflict resolution from concurrent edits using a check-and-set
1784 * @param RevisionSlotsUpdate|null $forUpdate If given, allows any cached ParserOutput
1785 * that may already have been returned via getDerivedDataUpdater to be re-used.
1787 * @return PageUpdater
1789 public function newPageUpdater( User
$user, RevisionSlotsUpdate
$forUpdate = null ) {
1790 global $wgAjaxEditStash, $wgUseAutomaticEditSummaries, $wgPageCreationLog;
1792 $pageUpdater = new PageUpdater(
1794 $this, // NOTE: eventually, PageUpdater should not know about WikiPage
1795 $this->getDerivedDataUpdater( $user, null, $forUpdate, true ),
1796 $this->getDBLoadBalancer(),
1797 $this->getRevisionStore(),
1798 $this->getSlotRoleRegistry()
1801 $pageUpdater->setUsePageCreationLog( $wgPageCreationLog );
1802 $pageUpdater->setAjaxEditStash( $wgAjaxEditStash );
1803 $pageUpdater->setUseAutomaticEditSummaries( $wgUseAutomaticEditSummaries );
1805 return $pageUpdater;
1809 * Change an existing article or create a new article. Updates RC and all necessary caches,
1810 * optionally via the deferred update array.
1812 * @deprecated since 1.32, use PageUpdater::saveRevision instead. Note that the new method
1813 * expects callers to take care of checking EDIT_MINOR against the minoredit right, and to
1814 * apply the autopatrol right as appropriate.
1816 * @param Content $content New content
1817 * @param string|CommentStoreComment $summary Edit summary
1818 * @param int $flags Bitfield:
1820 * Article is known or assumed to be non-existent, create a new one
1822 * Article is known or assumed to be pre-existing, update it
1824 * Mark this edit minor, if the user is allowed to do so
1826 * Do not log the change in recentchanges
1828 * Mark the edit a "bot" edit regardless of user rights
1830 * Fill in blank summaries with generated text where possible
1832 * Signal that the page retrieve/save cycle happened entirely in this request.
1834 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1835 * article will be detected. If EDIT_UPDATE is specified and the article
1836 * doesn't exist, the function will return an edit-gone-missing error. If
1837 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1838 * error will be returned. These two conditions are also possible with
1839 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1841 * @param bool|int $originalRevId: The ID of an original revision that the edit
1842 * restores or repeats. The new revision is expected to have the exact same content as
1843 * the given original revision. This is used with rollbacks and with dummy "null" revisions
1844 * which are created to record things like page moves.
1845 * @param User|null $user The user doing the edit
1846 * @param string|null $serialFormat IGNORED.
1847 * @param array|null $tags Change tags to apply to this edit
1848 * Callers are responsible for permission checks
1849 * (with ChangeTags::canAddTagsAccompanyingChange)
1850 * @param Int $undidRevId Id of revision that was undone or 0
1852 * @throws MWException
1853 * @return Status Possible errors:
1854 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1855 * set the fatal flag of $status.
1856 * edit-gone-missing: In update mode, but the article didn't exist.
1857 * edit-conflict: In update mode, the article changed unexpectedly.
1858 * edit-no-change: Warning that the text was the same as before.
1859 * edit-already-exists: In creation mode, but the article already exists.
1861 * Extensions may define additional errors.
1863 * $return->value will contain an associative array with members as follows:
1864 * new: Boolean indicating if the function attempted to create a new article.
1865 * revision: The revision object for the inserted revision, or null.
1868 * @throws MWException
1870 public function doEditContent(
1871 Content
$content, $summary, $flags = 0, $originalRevId = false,
1872 User
$user = null, $serialFormat = null, $tags = [], $undidRevId = 0
1874 global $wgUser, $wgUseNPPatrol, $wgUseRCPatrol;
1876 if ( !( $summary instanceof CommentStoreComment
) ) {
1877 $summary = CommentStoreComment
::newUnsavedComment( trim( $summary ) );
1884 // TODO: this check is here for backwards-compatibility with 1.31 behavior.
1885 // Checking the minoredit right should be done in the same place the 'bot' right is
1886 // checked for the EDIT_FORCE_BOT flag, which is currently in EditPage::attemptSave.
1887 if ( ( $flags & EDIT_MINOR
) && !$user->isAllowed( 'minoredit' ) ) {
1888 $flags = ( $flags & ~EDIT_MINOR
);
1891 $slotsUpdate = new RevisionSlotsUpdate();
1892 $slotsUpdate->modifyContent( SlotRecord
::MAIN
, $content );
1894 // NOTE: while doEditContent() executes, callbacks to getDerivedDataUpdater and
1895 // prepareContentForEdit will generally use the DerivedPageDataUpdater that is also
1896 // used by this PageUpdater. However, there is no guarantee for this.
1897 $updater = $this->newPageUpdater( $user, $slotsUpdate );
1898 $updater->setContent( SlotRecord
::MAIN
, $content );
1899 $updater->setOriginalRevisionId( $originalRevId );
1900 $updater->setUndidRevisionId( $undidRevId );
1902 $needsPatrol = $wgUseRCPatrol ||
( $wgUseNPPatrol && !$this->exists() );
1904 // TODO: this logic should not be in the storage layer, it's here for compatibility
1905 // with 1.31 behavior. Applying the 'autopatrol' right should be done in the same
1906 // place the 'bot' right is handled, which is currently in EditPage::attemptSave.
1907 if ( $needsPatrol && $this->getTitle()->userCan( 'autopatrol', $user ) ) {
1908 $updater->setRcPatrolStatus( RecentChange
::PRC_AUTOPATROLLED
);
1911 $updater->addTags( $tags );
1913 $revRec = $updater->saveRevision(
1918 // $revRec will be null if the edit failed, or if no new revision was created because
1919 // the content did not change.
1921 // update cached fields
1922 // TODO: this is currently redundant to what is done in updateRevisionOn.
1923 // But updateRevisionOn() should move into PageStore, and then this will be needed.
1924 $this->setLastEdit( new Revision( $revRec ) ); // TODO: use RevisionRecord
1925 $this->mLatest
= $revRec->getId();
1928 return $updater->getStatus();
1932 * Get parser options suitable for rendering the primary article wikitext
1934 * @see ParserOptions::newCanonical
1936 * @param IContextSource|User|string $context One of the following:
1937 * - IContextSource: Use the User and the Language of the provided
1939 * - User: Use the provided User object and $wgLang for the language,
1940 * so use an IContextSource object if possible.
1941 * - 'canonical': Canonical options (anonymous user with default
1942 * preferences and content language).
1943 * @return ParserOptions
1945 public function makeParserOptions( $context ) {
1946 $options = ParserOptions
::newCanonical( $context );
1948 if ( $this->getTitle()->isConversionTable() ) {
1949 // @todo ConversionTable should become a separate content model, so
1950 // we don't need special cases like this one.
1951 $options->disableContentConversion();
1958 * Prepare content which is about to be saved.
1960 * Prior to 1.30, this returned a stdClass.
1962 * @deprecated since 1.32, use getDerivedDataUpdater instead.
1964 * @param Content $content
1965 * @param Revision|RevisionRecord|null $revision Revision object.
1966 * Used with vary-revision or vary-revision-id.
1967 * @param User|null $user
1968 * @param string|null $serialFormat IGNORED
1969 * @param bool $useCache Check shared prepared edit cache
1971 * @return PreparedEdit
1975 public function prepareContentForEdit(
1979 $serialFormat = null,
1988 if ( $revision !== null ) {
1989 if ( $revision instanceof Revision
) {
1990 $revision = $revision->getRevisionRecord();
1991 } elseif ( !( $revision instanceof RevisionRecord
) ) {
1992 throw new InvalidArgumentException(
1993 __METHOD__
. ': invalid $revision argument type ' . gettype( $revision ) );
1997 $slots = RevisionSlotsUpdate
::newFromContent( [ SlotRecord
::MAIN
=> $content ] );
1998 $updater = $this->getDerivedDataUpdater( $user, $revision, $slots );
2000 if ( !$updater->isUpdatePrepared() ) {
2001 $updater->prepareContent( $user, $slots, $useCache );
2004 $updater->prepareUpdate(
2007 'causeAction' => 'prepare-edit',
2008 'causeAgent' => $user->getName(),
2014 return $updater->getPreparedEdit();
2018 * Do standard deferred updates after page edit.
2019 * Update links tables, site stats, search index and message cache.
2020 * Purges pages that include this page if the text was changed here.
2021 * Every 100th edit, prune the recent changes table.
2023 * @deprecated since 1.32, use PageUpdater::doUpdates instead.
2025 * @param Revision $revision
2026 * @param User $user User object that did the revision
2027 * @param array $options Array of options, following indexes are used:
2028 * - changed: bool, whether the revision changed the content (default true)
2029 * - created: bool, whether the revision created the page (default false)
2030 * - moved: bool, whether the page was moved (default false)
2031 * - restored: bool, whether the page was undeleted (default false)
2032 * - oldrevision: Revision object for the pre-update revision (default null)
2033 * - oldcountable: bool, null, or string 'no-change' (default null):
2034 * - bool: whether the page was counted as an article before that
2035 * revision, only used in changed is true and created is false
2036 * - null: if created is false, don't update the article count; if created
2037 * is true, do update the article count
2038 * - 'no-change': don't update the article count, ever
2039 * - causeAction: an arbitrary string identifying the reason for the update.
2040 * See DataUpdate::getCauseAction(). (default 'edit-page')
2041 * - causeAgent: name of the user who caused the update. See DataUpdate::getCauseAgent().
2042 * (string, defaults to the passed user)
2044 public function doEditUpdates( Revision
$revision, User
$user, array $options = [] ) {
2046 'causeAction' => 'edit-page',
2047 'causeAgent' => $user->getName(),
2050 $revision = $revision->getRevisionRecord();
2052 $updater = $this->getDerivedDataUpdater( $user, $revision );
2054 $updater->prepareUpdate( $revision, $options );
2056 $updater->doUpdates();
2060 * Update the parser cache.
2062 * @note This is a temporary workaround until there is a proper data updater class.
2063 * It will become deprecated soon.
2065 * @param array $options
2066 * - causeAction: an arbitrary string identifying the reason for the update.
2067 * See DataUpdate::getCauseAction(). (default 'edit-page')
2068 * - causeAgent: name of the user who caused the update (string, defaults to the
2069 * user who created the revision)
2072 public function updateParserCache( array $options = [] ) {
2073 $revision = $this->getRevisionRecord();
2074 if ( !$revision ||
!$revision->getId() ) {
2075 LoggerFactory
::getInstance( 'wikipage' )->info(
2076 __METHOD__
. 'called with ' . ( $revision ?
'unsaved' : 'no' ) . ' revision'
2080 $user = User
::newFromIdentity( $revision->getUser( RevisionRecord
::RAW
) );
2082 $updater = $this->getDerivedDataUpdater( $user, $revision );
2083 $updater->prepareUpdate( $revision, $options );
2084 $updater->doParserCacheUpdate();
2088 * Do secondary data updates (such as updating link tables).
2089 * Secondary data updates are only a small part of the updates needed after saving
2090 * a new revision; normally PageUpdater::doUpdates should be used instead (which includes
2091 * secondary data updates). This method is provided for partial purges.
2093 * @note This is a temporary workaround until there is a proper data updater class.
2094 * It will become deprecated soon.
2096 * @param array $options
2097 * - recursive (bool, default true): whether to do a recursive update (update pages that
2098 * depend on this page, e.g. transclude it). This will set the $recursive parameter of
2099 * Content::getSecondaryDataUpdates. Typically this should be true unless the update
2100 * was something that did not really change the page, such as a null edit.
2101 * - triggeringUser: The user triggering the update (UserIdentity, defaults to the
2102 * user who created the revision)
2103 * - causeAction: an arbitrary string identifying the reason for the update.
2104 * See DataUpdate::getCauseAction(). (default 'unknown')
2105 * - causeAgent: name of the user who caused the update (string, default 'unknown')
2106 * - defer: one of the DeferredUpdates constants, or false to run immediately (default: false).
2107 * Note that even when this is set to false, some updates might still get deferred (as
2108 * some update might directly add child updates to DeferredUpdates).
2109 * - transactionTicket: a transaction ticket from LBFactory::getEmptyTransactionTicket(),
2110 * only when defer is false (default: null)
2113 public function doSecondaryDataUpdates( array $options = [] ) {
2114 $options['recursive'] = $options['recursive'] ??
true;
2115 $revision = $this->getRevisionRecord();
2116 if ( !$revision ||
!$revision->getId() ) {
2117 LoggerFactory
::getInstance( 'wikipage' )->info(
2118 __METHOD__
. 'called with ' . ( $revision ?
'unsaved' : 'no' ) . ' revision'
2122 $user = User
::newFromIdentity( $revision->getUser( RevisionRecord
::RAW
) );
2124 $updater = $this->getDerivedDataUpdater( $user, $revision );
2125 $updater->prepareUpdate( $revision, $options );
2126 $updater->doSecondaryDataUpdates( $options );
2130 * Update the article's restriction field, and leave a log entry.
2131 * This works for protection both existing and non-existing pages.
2133 * @param array $limit Set of restriction keys
2134 * @param array $expiry Per restriction type expiration
2135 * @param int &$cascade Set to false if cascading protection isn't allowed.
2136 * @param string $reason
2137 * @param User $user The user updating the restrictions
2138 * @param string|string[]|null $tags Change tags to add to the pages and protection log entries
2139 * ($user should be able to add the specified tags before this is called)
2140 * @return Status Status object; if action is taken, $status->value is the log_id of the
2141 * protection log entry.
2143 public function doUpdateRestrictions( array $limit, array $expiry,
2144 &$cascade, $reason, User
$user, $tags = null
2146 global $wgCascadingRestrictionLevels;
2148 if ( wfReadOnly() ) {
2149 return Status
::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
2152 $this->loadPageData( 'fromdbmaster' );
2153 $this->mTitle
->loadRestrictions( null, Title
::READ_LATEST
);
2154 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2155 $id = $this->getId();
2161 // Take this opportunity to purge out expired restrictions
2162 Title
::purgeExpiredRestrictions();
2164 // @todo: Same limitations as described in ProtectionForm.php (line 37);
2165 // we expect a single selection, but the schema allows otherwise.
2166 $isProtected = false;
2170 $dbw = wfGetDB( DB_MASTER
);
2172 foreach ( $restrictionTypes as $action ) {
2173 if ( !isset( $expiry[$action] ) ||
$expiry[$action] === $dbw->getInfinity() ) {
2174 $expiry[$action] = 'infinity';
2176 if ( !isset( $limit[$action] ) ) {
2177 $limit[$action] = '';
2178 } elseif ( $limit[$action] != '' ) {
2182 // Get current restrictions on $action
2183 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2184 if ( $current != '' ) {
2185 $isProtected = true;
2188 if ( $limit[$action] != $current ) {
2190 } elseif ( $limit[$action] != '' ) {
2191 // Only check expiry change if the action is actually being
2192 // protected, since expiry does nothing on an not-protected
2194 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2200 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2204 // If nothing has changed, do nothing
2206 return Status
::newGood();
2209 if ( !$protect ) { // No protection at all means unprotection
2210 $revCommentMsg = 'unprotectedarticle-comment';
2211 $logAction = 'unprotect';
2212 } elseif ( $isProtected ) {
2213 $revCommentMsg = 'modifiedarticleprotection-comment';
2214 $logAction = 'modify';
2216 $revCommentMsg = 'protectedarticle-comment';
2217 $logAction = 'protect';
2220 $logRelationsValues = [];
2221 $logRelationsField = null;
2222 $logParamsDetails = [];
2224 // Null revision (used for change tag insertion)
2225 $nullRevision = null;
2227 if ( $id ) { // Protection of existing page
2228 // Avoid PHP 7.1 warning of passing $this by reference
2231 if ( !Hooks
::run( 'ArticleProtect', [ &$wikiPage, &$user, $limit, $reason ] ) ) {
2232 return Status
::newGood();
2235 // Only certain restrictions can cascade...
2236 $editrestriction = isset( $limit['edit'] )
2237 ?
[ $limit['edit'] ]
2238 : $this->mTitle
->getRestrictions( 'edit' );
2239 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2240 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2242 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2243 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2246 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2247 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2248 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2250 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2251 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2254 // The schema allows multiple restrictions
2255 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2259 // insert null revision to identify the page protection change as edit summary
2260 $latest = $this->getLatest();
2261 $nullRevision = $this->insertProtectNullRevision(
2270 if ( $nullRevision === null ) {
2271 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2274 $logRelationsField = 'pr_id';
2276 // Update restrictions table
2277 foreach ( $limit as $action => $restrictions ) {
2279 'page_restrictions',
2282 'pr_type' => $action
2286 if ( $restrictions != '' ) {
2287 $cascadeValue = ( $cascade && $action == 'edit' ) ?
1 : 0;
2289 'page_restrictions',
2292 'pr_type' => $action,
2293 'pr_level' => $restrictions,
2294 'pr_cascade' => $cascadeValue,
2295 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2299 $logRelationsValues[] = $dbw->insertId();
2300 $logParamsDetails[] = [
2302 'level' => $restrictions,
2303 'expiry' => $expiry[$action],
2304 'cascade' => (bool)$cascadeValue,
2309 // Clear out legacy restriction fields
2312 [ 'page_restrictions' => '' ],
2313 [ 'page_id' => $id ],
2317 // Avoid PHP 7.1 warning of passing $this by reference
2320 Hooks
::run( 'NewRevisionFromEditComplete',
2321 [ $this, $nullRevision, $latest, $user ] );
2322 Hooks
::run( 'ArticleProtectComplete', [ &$wikiPage, &$user, $limit, $reason ] );
2323 } else { // Protection of non-existing page (also known as "title protection")
2324 // Cascade protection is meaningless in this case
2327 if ( $limit['create'] != '' ) {
2328 $commentFields = CommentStore
::getStore()->insert( $dbw, 'pt_reason', $reason );
2329 $dbw->replace( 'protected_titles',
2330 [ [ 'pt_namespace', 'pt_title' ] ],
2332 'pt_namespace' => $this->mTitle
->getNamespace(),
2333 'pt_title' => $this->mTitle
->getDBkey(),
2334 'pt_create_perm' => $limit['create'],
2335 'pt_timestamp' => $dbw->timestamp(),
2336 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2337 'pt_user' => $user->getId(),
2338 ] +
$commentFields, __METHOD__
2340 $logParamsDetails[] = [
2342 'level' => $limit['create'],
2343 'expiry' => $expiry['create'],
2346 $dbw->delete( 'protected_titles',
2348 'pt_namespace' => $this->mTitle
->getNamespace(),
2349 'pt_title' => $this->mTitle
->getDBkey()
2355 $this->mTitle
->flushRestrictions();
2356 InfoAction
::invalidateCache( $this->mTitle
);
2358 if ( $logAction == 'unprotect' ) {
2361 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2363 '4::description' => $protectDescriptionLog, // parameter for IRC
2364 '5:bool:cascade' => $cascade,
2365 'details' => $logParamsDetails, // parameter for localize and api
2369 // Update the protection log
2370 $logEntry = new ManualLogEntry( 'protect', $logAction );
2371 $logEntry->setTarget( $this->mTitle
);
2372 $logEntry->setComment( $reason );
2373 $logEntry->setPerformer( $user );
2374 $logEntry->setParameters( $params );
2375 if ( !is_null( $nullRevision ) ) {
2376 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2378 $logEntry->setTags( $tags );
2379 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2380 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2382 $logId = $logEntry->insert();
2383 $logEntry->publish( $logId );
2385 return Status
::newGood( $logId );
2389 * Insert a new null revision for this page.
2391 * @param string $revCommentMsg Comment message key for the revision
2392 * @param array $limit Set of restriction keys
2393 * @param array $expiry Per restriction type expiration
2394 * @param int $cascade Set to false if cascading protection isn't allowed.
2395 * @param string $reason
2396 * @param User|null $user
2397 * @return Revision|null Null on error
2399 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2400 array $expiry, $cascade, $reason, $user = null
2402 $dbw = wfGetDB( DB_MASTER
);
2404 // Prepare a null revision to be added to the history
2405 $editComment = wfMessage(
2407 $this->mTitle
->getPrefixedText(),
2408 $user ?
$user->getName() : ''
2409 )->inContentLanguage()->text();
2411 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2413 $protectDescription = $this->protectDescription( $limit, $expiry );
2414 if ( $protectDescription ) {
2415 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2416 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2417 ->inContentLanguage()->text();
2420 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2421 $editComment .= wfMessage( 'brackets' )->params(
2422 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2423 )->inContentLanguage()->text();
2426 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2428 $nullRev->insertOn( $dbw );
2430 // Update page record and touch page
2431 $oldLatest = $nullRev->getParentId();
2432 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2439 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2442 protected function formatExpiry( $expiry ) {
2443 if ( $expiry != 'infinity' ) {
2444 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
2447 $contLang->timeanddate( $expiry, false, false ),
2448 $contLang->date( $expiry, false, false ),
2449 $contLang->time( $expiry, false, false )
2450 )->inContentLanguage()->text();
2452 return wfMessage( 'protect-expiry-indefinite' )
2453 ->inContentLanguage()->text();
2458 * Builds the description to serve as comment for the edit.
2460 * @param array $limit Set of restriction keys
2461 * @param array $expiry Per restriction type expiration
2464 public function protectDescription( array $limit, array $expiry ) {
2465 $protectDescription = '';
2467 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2468 # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2469 # All possible message keys are listed here for easier grepping:
2470 # * restriction-create
2471 # * restriction-edit
2472 # * restriction-move
2473 # * restriction-upload
2474 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2475 # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2476 # with '' filtered out. All possible message keys are listed below:
2477 # * protect-level-autoconfirmed
2478 # * protect-level-sysop
2479 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2480 ->inContentLanguage()->text();
2482 $expiryText = $this->formatExpiry( $expiry[$action] );
2484 if ( $protectDescription !== '' ) {
2485 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2487 $protectDescription .= wfMessage( 'protect-summary-desc' )
2488 ->params( $actionText, $restrictionsText, $expiryText )
2489 ->inContentLanguage()->text();
2492 return $protectDescription;
2496 * Builds the description to serve as comment for the log entry.
2498 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2499 * protect description text. Keep them in old format to avoid breaking compatibility.
2500 * TODO: Fix protection log to store structured description and format it on-the-fly.
2502 * @param array $limit Set of restriction keys
2503 * @param array $expiry Per restriction type expiration
2506 public function protectDescriptionLog( array $limit, array $expiry ) {
2507 $protectDescriptionLog = '';
2509 $dirMark = MediaWikiServices
::getInstance()->getContentLanguage()->getDirMark();
2510 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2511 $expiryText = $this->formatExpiry( $expiry[$action] );
2512 $protectDescriptionLog .=
2514 "[$action=$restrictions] ($expiryText)";
2517 return trim( $protectDescriptionLog );
2521 * Take an array of page restrictions and flatten it to a string
2522 * suitable for insertion into the page_restrictions field.
2524 * @param string[] $limit
2526 * @throws MWException
2529 protected static function flattenRestrictions( $limit ) {
2530 if ( !is_array( $limit ) ) {
2531 throw new MWException( __METHOD__
. ' given non-array restriction set' );
2537 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2538 $bits[] = "$action=$restrictions";
2541 return implode( ':', $bits );
2545 * Determines if deletion of this page would be batched (executed over time by the job queue)
2546 * or not (completed in the same request as the delete call).
2548 * It is unlikely but possible that an edit from another request could push the page over the
2549 * batching threshold after this function is called, but before the caller acts upon the
2550 * return value. Callers must decide for themselves how to deal with this. $safetyMargin
2551 * is provided as an unreliable but situationally useful help for some common cases.
2553 * @param int $safetyMargin Added to the revision count when checking for batching
2554 * @return bool True if deletion would be batched, false otherwise
2556 public function isBatchedDelete( $safetyMargin = 0 ) {
2557 global $wgDeleteRevisionsBatchSize;
2559 $dbr = wfGetDB( DB_REPLICA
);
2560 $revCount = $this->getRevisionStore()->countRevisionsByPageId( $dbr, $this->getId() );
2561 $revCount +
= $safetyMargin;
2563 return $revCount >= $wgDeleteRevisionsBatchSize;
2567 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2568 * backwards compatibility, if you care about error reporting you should use
2569 * doDeleteArticleReal() instead.
2571 * Deletes the article with database consistency, writes logs, purges caches
2573 * @param string $reason Delete reason for deletion log
2574 * @param bool $suppress Suppress all revisions and log the deletion in
2575 * the suppression log instead of the deletion log
2576 * @param int|null $u1 Unused
2577 * @param bool|null $u2 Unused
2578 * @param array|string &$error Array of errors to append to
2579 * @param User|null $user The deleting user
2580 * @param bool $immediate false allows deleting over time via the job queue
2581 * @return bool True if successful
2582 * @throws FatalError
2583 * @throws MWException
2585 public function doDeleteArticle(
2586 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null,
2589 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user,
2590 [], 'delete', $immediate );
2592 // Returns true if the page was actually deleted, or is scheduled for deletion
2593 return $status->isOK();
2597 * Back-end article deletion
2598 * Deletes the article with database consistency, writes logs, purges caches
2602 * @param string $reason Delete reason for deletion log
2603 * @param bool $suppress Suppress all revisions and log the deletion in
2604 * the suppression log instead of the deletion log
2605 * @param int|null $u1 Unused
2606 * @param bool|null $u2 Unused
2607 * @param array|string &$error Array of errors to append to
2608 * @param User|null $deleter The deleting user
2609 * @param array $tags Tags to apply to the deletion action
2610 * @param string $logsubtype
2611 * @param bool $immediate false allows deleting over time via the job queue
2612 * @return Status Status object; if successful, $status->value is the log_id of the
2613 * deletion log entry. If the page couldn't be deleted because it wasn't
2614 * found, $status is a non-fatal 'cannotdelete' error
2615 * @throws FatalError
2616 * @throws MWException
2618 public function doDeleteArticleReal(
2619 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$deleter = null,
2620 $tags = [], $logsubtype = 'delete', $immediate = false
2624 wfDebug( __METHOD__
. "\n" );
2626 $status = Status
::newGood();
2628 // Avoid PHP 7.1 warning of passing $this by reference
2634 if ( !Hooks
::run( 'ArticleDelete',
2635 [ &$wikiPage, &$deleter, &$reason, &$error, &$status, $suppress ]
2637 if ( $status->isOK() ) {
2638 // Hook aborted but didn't set a fatal status
2639 $status->fatal( 'delete-hook-aborted' );
2644 return $this->doDeleteArticleBatched( $reason, $suppress, $deleter, $tags,
2645 $logsubtype, $immediate );
2649 * Back-end article deletion
2651 * Only invokes batching via the job queue if necessary per $wgDeleteRevisionsBatchSize.
2652 * Deletions can often be completed inline without involving the job queue.
2654 * Potentially called many times per deletion operation for pages with many revisions.
2656 public function doDeleteArticleBatched(
2657 $reason, $suppress, User
$deleter, $tags,
2658 $logsubtype, $immediate = false, $webRequestId = null
2660 wfDebug( __METHOD__
. "\n" );
2662 $status = Status
::newGood();
2664 $dbw = wfGetDB( DB_MASTER
);
2665 $dbw->startAtomic( __METHOD__
);
2667 $this->loadPageData( self
::READ_LATEST
);
2668 $id = $this->getId();
2669 // T98706: lock the page from various other updates but avoid using
2670 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2671 // the revisions queries (which also JOIN on user). Only lock the page
2672 // row and CAS check on page_latest to see if the trx snapshot matches.
2673 $lockedLatest = $this->lockAndGetLatest();
2674 if ( $id == 0 ||
$this->getLatest() != $lockedLatest ) {
2675 $dbw->endAtomic( __METHOD__
);
2676 // Page not there or trx snapshot is stale
2677 $status->error( 'cannotdelete',
2678 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2682 // At this point we are now committed to returning an OK
2683 // status unless some DB query error or other exception comes up.
2684 // This way callers don't have to call rollback() if $status is bad
2685 // unless they actually try to catch exceptions (which is rare).
2687 // we need to remember the old content so we can use it to generate all deletion updates.
2688 $revision = $this->getRevision();
2690 $content = $this->getContent( Revision
::RAW
);
2691 } catch ( Exception
$ex ) {
2692 wfLogWarning( __METHOD__
. ': failed to load content during deletion! '
2693 . $ex->getMessage() );
2698 // Archive revisions. In immediate mode, archive all revisions. Otherwise, archive
2699 // one batch of revisions and defer archival of any others to the job queue.
2700 $explictTrxLogged = false;
2702 $done = $this->archiveRevisions( $dbw, $id, $suppress );
2703 if ( $done ||
!$immediate ) {
2706 $dbw->endAtomic( __METHOD__
);
2707 if ( $dbw->explicitTrxActive() ) {
2708 // Explict transactions may never happen here in practice. Log to be sure.
2709 if ( !$explictTrxLogged ) {
2710 $explictTrxLogged = true;
2711 LoggerFactory
::getInstance( 'wfDebug' )->debug(
2712 'explicit transaction active in ' . __METHOD__
. ' while deleting {title}', [
2713 'title' => $this->getTitle()->getText(),
2718 if ( $dbw->trxLevel() ) {
2721 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2722 $lbFactory->waitForReplication();
2723 $dbw->startAtomic( __METHOD__
);
2726 // If done archiving, also delete the article.
2728 $dbw->endAtomic( __METHOD__
);
2731 'namespace' => $this->getTitle()->getNamespace(),
2732 'title' => $this->getTitle()->getDBkey(),
2733 'wikiPageId' => $id,
2734 'requestId' => $webRequestId ?? WebRequest
::getRequestId(),
2735 'reason' => $reason,
2736 'suppress' => $suppress,
2737 'userId' => $deleter->getId(),
2738 'tags' => json_encode( $tags ),
2739 'logsubtype' => $logsubtype,
2742 $job = new DeletePageJob( $jobParams );
2743 JobQueueGroup
::singleton()->push( $job );
2745 $status->warning( 'delete-scheduled',
2746 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2748 // Get archivedRevisionCount by db query, because there's no better alternative.
2749 // Jobs cannot pass a count of archived revisions to the next job, because additional
2750 // deletion operations can be started while the first is running. Jobs from each
2751 // gracefully interleave, but would not know about each other's count. Deduplication
2752 // in the job queue to avoid simultaneous deletion operations would add overhead.
2753 // Number of archived revisions cannot be known beforehand, because edits can be made
2754 // while deletion operations are being processed, changing the number of archivals.
2755 $archivedRevisionCount = (int)$dbw->selectField(
2756 'archive', 'COUNT(*)',
2758 'ar_namespace' => $this->getTitle()->getNamespace(),
2759 'ar_title' => $this->getTitle()->getDBkey(),
2764 // Clone the title and wikiPage, so we have the information we need when
2765 // we log and run the ArticleDeleteComplete hook.
2766 $logTitle = clone $this->mTitle
;
2767 $wikiPageBeforeDelete = clone $this;
2769 // Now that it's safely backed up, delete it
2770 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__
);
2772 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2773 $logtype = $suppress ?
'suppress' : 'delete';
2775 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2776 $logEntry->setPerformer( $deleter );
2777 $logEntry->setTarget( $logTitle );
2778 $logEntry->setComment( $reason );
2779 $logEntry->setTags( $tags );
2780 $logid = $logEntry->insert();
2782 $dbw->onTransactionPreCommitOrIdle(
2783 function () use ( $logEntry, $logid ) {
2784 // T58776: avoid deadlocks (especially from FileDeleteForm)
2785 $logEntry->publish( $logid );
2790 $dbw->endAtomic( __METHOD__
);
2792 $this->doDeleteUpdates( $id, $content, $revision, $deleter );
2794 Hooks
::run( 'ArticleDeleteComplete', [
2795 &$wikiPageBeforeDelete,
2801 $archivedRevisionCount
2803 $status->value
= $logid;
2805 // Show log excerpt on 404 pages rather than just a link
2806 $cache = MediaWikiServices
::getInstance()->getMainObjectStash();
2807 $key = $cache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2808 $cache->set( $key, 1, $cache::TTL_DAY
);
2815 * Archives revisions as part of page deletion.
2817 * @param IDatabase $dbw
2819 * @param bool $suppress Suppress all revisions and log the deletion in
2820 * the suppression log instead of the deletion log
2823 protected function archiveRevisions( $dbw, $id, $suppress ) {
2824 global $wgContentHandlerUseDB, $wgMultiContentRevisionSchemaMigrationStage,
2825 $wgActorTableSchemaMigrationStage, $wgDeleteRevisionsBatchSize;
2827 // Given the lock above, we can be confident in the title and page ID values
2828 $namespace = $this->getTitle()->getNamespace();
2829 $dbKey = $this->getTitle()->getDBkey();
2831 $commentStore = CommentStore
::getStore();
2832 $actorMigration = ActorMigration
::newMigration();
2834 $revQuery = Revision
::getQueryInfo();
2837 // Bitfields to further suppress the content
2839 $bitfield = Revision
::SUPPRESSED_ALL
;
2840 $revQuery['fields'] = array_diff( $revQuery['fields'], [ 'rev_deleted' ] );
2843 // For now, shunt the revision data into the archive table.
2844 // Text is *not* removed from the text table; bulk storage
2845 // is left intact to avoid breaking block-compression or
2846 // immutable storage schemes.
2847 // In the future, we may keep revisions and mark them with
2848 // the rev_deleted field, which is reserved for this purpose.
2850 // Lock rows in `revision` and its temp tables, but not any others.
2851 // Note array_intersect() preserves keys from the first arg, and we're
2852 // assuming $revQuery has `revision` primary and isn't using subtables
2853 // for anything we care about.
2854 $dbw->lockForUpdate(
2856 $revQuery['tables'],
2857 [ 'revision', 'revision_comment_temp', 'revision_actor_temp' ]
2859 [ 'rev_page' => $id ],
2865 // If SCHEMA_COMPAT_WRITE_OLD is set, also select all extra fields we still write,
2866 // so we can copy it to the archive table.
2867 // We know the fields exist, otherwise SCHEMA_COMPAT_WRITE_OLD could not function.
2868 if ( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) {
2869 $revQuery['fields'][] = 'rev_text_id';
2871 if ( $wgContentHandlerUseDB ) {
2872 $revQuery['fields'][] = 'rev_content_model';
2873 $revQuery['fields'][] = 'rev_content_format';
2877 // Get as many of the page revisions as we are allowed to. The +1 lets us recognize the
2878 // unusual case where there were exactly $wgDeleteRevisionBatchSize revisions remaining.
2879 $res = $dbw->select(
2880 $revQuery['tables'],
2881 $revQuery['fields'],
2882 [ 'rev_page' => $id ],
2884 [ 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => $wgDeleteRevisionsBatchSize +
1 ],
2888 // Build their equivalent archive rows
2892 /** @var int[] Revision IDs of edits that were made by IPs */
2896 foreach ( $res as $row ) {
2897 if ( count( $revids ) >= $wgDeleteRevisionsBatchSize ) {
2902 $comment = $commentStore->getComment( 'rev_comment', $row );
2903 $user = User
::newFromAnyId( $row->rev_user
, $row->rev_user_text
, $row->rev_actor
);
2905 'ar_namespace' => $namespace,
2906 'ar_title' => $dbKey,
2907 'ar_timestamp' => $row->rev_timestamp
,
2908 'ar_minor_edit' => $row->rev_minor_edit
,
2909 'ar_rev_id' => $row->rev_id
,
2910 'ar_parent_id' => $row->rev_parent_id
,
2912 * ar_text_id should probably not be written to when the multi content schema has
2913 * been migrated to (wgMultiContentRevisionSchemaMigrationStage) however there is no
2914 * default for the field in WMF production currently so we must keep writing
2915 * writing until a default of 0 is set.
2916 * Task: https://phabricator.wikimedia.org/T190148
2917 * Copying the value from the revision table should not lead to any issues for now.
2919 'ar_len' => $row->rev_len
,
2920 'ar_page_id' => $id,
2921 'ar_deleted' => $suppress ?
$bitfield : $row->rev_deleted
,
2922 'ar_sha1' => $row->rev_sha1
,
2923 ] +
$commentStore->insert( $dbw, 'ar_comment', $comment )
2924 +
$actorMigration->getInsertValues( $dbw, 'ar_user', $user );
2926 if ( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) {
2927 $rowInsert['ar_text_id'] = $row->rev_text_id
;
2929 if ( $wgContentHandlerUseDB ) {
2930 $rowInsert['ar_content_model'] = $row->rev_content_model
;
2931 $rowInsert['ar_content_format'] = $row->rev_content_format
;
2935 $rowsInsert[] = $rowInsert;
2936 $revids[] = $row->rev_id
;
2938 // Keep track of IP edits, so that the corresponding rows can
2939 // be deleted in the ip_changes table.
2940 if ( (int)$row->rev_user
=== 0 && IP
::isValid( $row->rev_user_text
) ) {
2941 $ipRevIds[] = $row->rev_id
;
2945 // This conditional is just a sanity check
2946 if ( count( $revids ) > 0 ) {
2947 // Copy them into the archive table
2948 $dbw->insert( 'archive', $rowsInsert, __METHOD__
);
2950 $dbw->delete( 'revision', [ 'rev_id' => $revids ], __METHOD__
);
2951 $dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__
);
2952 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
2953 $dbw->delete( 'revision_actor_temp', [ 'revactor_rev' => $revids ], __METHOD__
);
2956 // Also delete records from ip_changes as applicable.
2957 if ( count( $ipRevIds ) > 0 ) {
2958 $dbw->delete( 'ip_changes', [ 'ipc_rev_id' => $ipRevIds ], __METHOD__
);
2966 * Lock the page row for this title+id and return page_latest (or 0)
2968 * @return int Returns 0 if no row was found with this title+id
2971 public function lockAndGetLatest() {
2972 return (int)wfGetDB( DB_MASTER
)->selectField(
2976 'page_id' => $this->getId(),
2977 // Typically page_id is enough, but some code might try to do
2978 // updates assuming the title is the same, so verify that
2979 'page_namespace' => $this->getTitle()->getNamespace(),
2980 'page_title' => $this->getTitle()->getDBkey()
2988 * Do some database updates after deletion
2990 * @param int $id The page_id value of the page being deleted
2991 * @param Content|null $content Page content to be used when determining
2992 * the required updates. This may be needed because $this->getContent()
2993 * may already return null when the page proper was deleted.
2994 * @param Revision|null $revision The current page revision at the time of
2995 * deletion, used when determining the required updates. This may be needed because
2996 * $this->getRevision() may already return null when the page proper was deleted.
2997 * @param User|null $user The user that caused the deletion
2999 public function doDeleteUpdates(
3000 $id, Content
$content = null, Revision
$revision = null, User
$user = null
3002 if ( $id !== $this->getId() ) {
3003 throw new InvalidArgumentException( 'Mismatching page ID' );
3007 $countable = $this->isCountable();
3008 } catch ( Exception
$ex ) {
3009 // fallback for deleting broken pages for which we cannot load the content for
3010 // some reason. Note that doDeleteArticleReal() already logged this problem.
3014 // Update site status
3015 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory(
3016 [ 'edits' => 1, 'articles' => -$countable, 'pages' => -1 ]
3019 // Delete pagelinks, update secondary indexes, etc
3020 $updates = $this->getDeletionUpdates(
3021 $revision ?
$revision->getRevisionRecord() : $content
3023 foreach ( $updates as $update ) {
3024 DeferredUpdates
::addUpdate( $update );
3027 $causeAgent = $user ?
$user->getName() : 'unknown';
3028 // Reparse any pages transcluding this page
3029 LinksUpdate
::queueRecursiveJobsForTable(
3030 $this->mTitle
, 'templatelinks', 'delete-page', $causeAgent );
3031 // Reparse any pages including this image
3032 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
3033 LinksUpdate
::queueRecursiveJobsForTable(
3034 $this->mTitle
, 'imagelinks', 'delete-page', $causeAgent );
3038 self
::onArticleDelete( $this->mTitle
);
3039 ResourceLoaderWikiModule
::invalidateModuleCache(
3043 WikiMap
::getCurrentWikiDbDomain()->getId()
3046 // Reset this object and the Title object
3047 $this->loadFromRow( false, self
::READ_LATEST
);
3050 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
3054 * Roll back the most recent consecutive set of edits to a page
3055 * from the same user; fails if there are no eligible edits to
3056 * roll back to, e.g. user is the sole contributor. This function
3057 * performs permissions checks on $user, then calls commitRollback()
3058 * to do the dirty work
3060 * @todo Separate the business/permission stuff out from backend code
3061 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3063 * @param string $fromP Name of the user whose edits to rollback.
3064 * @param string $summary Custom summary. Set to default summary if empty.
3065 * @param string $token Rollback token.
3066 * @param bool $bot If true, mark all reverted edits as bot.
3068 * @param array &$resultDetails Array contains result-specific array of additional values
3069 * 'alreadyrolled' : 'current' (rev)
3070 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3072 * @param User $user The user performing the rollback
3073 * @param array|null $tags Change tags to apply to the rollback
3074 * Callers are responsible for permission checks
3075 * (with ChangeTags::canAddTagsAccompanyingChange)
3077 * @return array Array of errors, each error formatted as
3078 * array(messagekey, param1, param2, ...).
3079 * On success, the array is empty. This array can also be passed to
3080 * OutputPage::showPermissionsErrorPage().
3082 public function doRollback(
3083 $fromP, $summary, $token, $bot, &$resultDetails, User
$user, $tags = null
3085 $resultDetails = null;
3087 // Check permissions
3088 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
3089 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
3090 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3092 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3093 $errors[] = [ 'sessionfailure' ];
3096 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
3097 $errors[] = [ 'actionthrottledtext' ];
3100 // If there were errors, bail out now
3101 if ( !empty( $errors ) ) {
3105 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3109 * Backend implementation of doRollback(), please refer there for parameter
3110 * and return value documentation
3112 * NOTE: This function does NOT check ANY permissions, it just commits the
3113 * rollback to the DB. Therefore, you should only call this function direct-
3114 * ly if you want to use custom permissions checks. If you don't, use
3115 * doRollback() instead.
3116 * @param string $fromP Name of the user whose edits to rollback.
3117 * @param string $summary Custom summary. Set to default summary if empty.
3118 * @param bool $bot If true, mark all reverted edits as bot.
3120 * @param array &$resultDetails Contains result-specific array of additional values
3121 * @param User $guser The user performing the rollback
3122 * @param array|null $tags Change tags to apply to the rollback
3123 * Callers are responsible for permission checks
3124 * (with ChangeTags::canAddTagsAccompanyingChange)
3126 * @return array An array of error messages, as returned by Status::getErrorsArray()
3128 public function commitRollback( $fromP, $summary, $bot,
3129 &$resultDetails, User
$guser, $tags = null
3131 global $wgUseRCPatrol;
3133 $dbw = wfGetDB( DB_MASTER
);
3135 if ( wfReadOnly() ) {
3136 return [ [ 'readonlytext' ] ];
3139 // Begin revision creation cycle by creating a PageUpdater.
3140 // If the page is changed concurrently after grabParentRevision(), the rollback will fail.
3141 $updater = $this->newPageUpdater( $guser );
3142 $current = $updater->grabParentRevision();
3144 if ( is_null( $current ) ) {
3145 // Something wrong... no page?
3146 return [ [ 'notanarticle' ] ];
3149 $currentEditorForPublic = $current->getUser( RevisionRecord
::FOR_PUBLIC
);
3150 $legacyCurrent = new Revision( $current );
3151 $from = str_replace( '_', ' ', $fromP );
3153 // User name given should match up with the top revision.
3154 // If the revision's user is not visible, then $from should be empty.
3155 if ( $from !== ( $currentEditorForPublic ?
$currentEditorForPublic->getName() : '' ) ) {
3156 $resultDetails = [ 'current' => $legacyCurrent ];
3157 return [ [ 'alreadyrolled',
3158 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3159 htmlspecialchars( $fromP ),
3160 htmlspecialchars( $currentEditorForPublic ?
$currentEditorForPublic->getName() : '' )
3164 // Get the last edit not by this person...
3165 // Note: these may not be public values
3166 $actorWhere = ActorMigration
::newMigration()->getWhere(
3169 $current->getUser( RevisionRecord
::RAW
)
3172 $s = $dbw->selectRow(
3173 [ 'revision' ] +
$actorWhere['tables'],
3174 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3176 'rev_page' => $current->getPageId(),
3177 'NOT(' . $actorWhere['conds'] . ')',
3181 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
3182 'ORDER BY' => 'rev_timestamp DESC'
3184 $actorWhere['joins']
3186 if ( $s === false ) {
3187 // No one else ever edited this page
3188 return [ [ 'cantrollback' ] ];
3189 } elseif ( $s->rev_deleted
& RevisionRecord
::DELETED_TEXT
3190 ||
$s->rev_deleted
& RevisionRecord
::DELETED_USER
3192 // Only admins can see this text
3193 return [ [ 'notvisiblerev' ] ];
3196 // Generate the edit summary if necessary
3197 $target = $this->getRevisionStore()->getRevisionById(
3199 RevisionStore
::READ_LATEST
3201 if ( empty( $summary ) ) {
3202 if ( !$currentEditorForPublic ) { // no public user name
3203 $summary = wfMessage( 'revertpage-nouser' );
3205 $summary = wfMessage( 'revertpage' );
3208 $legacyTarget = new Revision( $target );
3209 $targetEditorForPublic = $target->getUser( RevisionRecord
::FOR_PUBLIC
);
3211 // Allow the custom summary to use the same args as the default message
3212 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
3214 $targetEditorForPublic ?
$targetEditorForPublic->getName() : null,
3215 $currentEditorForPublic ?
$currentEditorForPublic->getName() : null,
3217 $contLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3219 $contLang->timeanddate( $current->getTimestamp() )
3221 if ( $summary instanceof Message
) {
3222 $summary = $summary->params( $args )->inContentLanguage()->text();
3224 $summary = wfMsgReplaceArgs( $summary, $args );
3227 // Trim spaces on user supplied text
3228 $summary = trim( $summary );
3231 $flags = EDIT_UPDATE | EDIT_INTERNAL
;
3233 if ( $guser->isAllowed( 'minoredit' ) ) {
3234 $flags |
= EDIT_MINOR
;
3237 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3238 $flags |
= EDIT_FORCE_BOT
;
3241 // TODO: MCR: also log model changes in other slots, in case that becomes possible!
3242 $currentContent = $current->getContent( SlotRecord
::MAIN
);
3243 $targetContent = $target->getContent( SlotRecord
::MAIN
);
3244 $changingContentModel = $targetContent->getModel() !== $currentContent->getModel();
3246 if ( in_array( 'mw-rollback', ChangeTags
::getSoftwareTags() ) ) {
3247 $tags[] = 'mw-rollback';
3250 // Build rollback revision:
3251 // Restore old content
3252 // TODO: MCR: test this once we can store multiple slots
3253 foreach ( $target->getSlots()->getSlots() as $slot ) {
3254 $updater->inheritSlot( $slot );
3257 // Remove extra slots
3258 // TODO: MCR: test this once we can store multiple slots
3259 foreach ( $current->getSlotRoles() as $role ) {
3260 if ( !$target->hasSlot( $role ) ) {
3261 $updater->removeSlot( $role );
3265 $updater->setOriginalRevisionId( $target->getId() );
3266 // Do not call setUndidRevisionId(), that causes an extra "mw-undo" tag to be added (T190374)
3267 $updater->addTags( $tags );
3269 // TODO: this logic should not be in the storage layer, it's here for compatibility
3270 // with 1.31 behavior. Applying the 'autopatrol' right should be done in the same
3271 // place the 'bot' right is handled, which is currently in EditPage::attemptSave.
3272 if ( $wgUseRCPatrol && $this->getTitle()->userCan( 'autopatrol', $guser ) ) {
3273 $updater->setRcPatrolStatus( RecentChange
::PRC_AUTOPATROLLED
);
3276 // Actually store the rollback
3277 $rev = $updater->saveRevision(
3278 CommentStoreComment
::newUnsavedComment( $summary ),
3282 // Set patrolling and bot flag on the edits, which gets rollbacked.
3283 // This is done even on edit failure to have patrolling in that case (T64157).
3285 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3286 // Mark all reverted edits as bot
3290 if ( $wgUseRCPatrol ) {
3291 // Mark all reverted edits as patrolled
3292 $set['rc_patrolled'] = RecentChange
::PRC_AUTOPATROLLED
;
3295 if ( count( $set ) ) {
3296 $actorWhere = ActorMigration
::newMigration()->getWhere(
3299 $current->getUser( RevisionRecord
::RAW
),
3302 $dbw->update( 'recentchanges', $set,
3304 'rc_cur_id' => $current->getPageId(),
3305 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3306 $actorWhere['conds'], // No tables/joins are needed for rc_user
3312 if ( !$updater->wasSuccessful() ) {
3313 return $updater->getStatus()->getErrorsArray();
3316 // Report if the edit was not created because it did not change the content.
3317 if ( $updater->isUnchanged() ) {
3318 $resultDetails = [ 'current' => $legacyCurrent ];
3319 return [ [ 'alreadyrolled',
3320 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3321 htmlspecialchars( $fromP ),
3322 htmlspecialchars( $currentEditorForPublic ?
$currentEditorForPublic->getName() : '' )
3326 if ( $changingContentModel ) {
3327 // If the content model changed during the rollback,
3328 // make sure it gets logged to Special:Log/contentmodel
3329 $log = new ManualLogEntry( 'contentmodel', 'change' );
3330 $log->setPerformer( $guser );
3331 $log->setTarget( $this->mTitle
);
3332 $log->setComment( $summary );
3333 $log->setParameters( [
3334 '4::oldmodel' => $currentContent->getModel(),
3335 '5::newmodel' => $targetContent->getModel(),
3338 $logId = $log->insert( $dbw );
3339 $log->publish( $logId );
3342 $revId = $rev->getId();
3344 Hooks
::run( 'ArticleRollbackComplete', [ $this, $guser, $legacyTarget, $legacyCurrent ] );
3347 'summary' => $summary,
3348 'current' => $legacyCurrent,
3349 'target' => $legacyTarget,
3354 // TODO: make this return a Status object and wrap $resultDetails in that.
3359 * The onArticle*() functions are supposed to be a kind of hooks
3360 * which should be called whenever any of the specified actions
3363 * This is a good place to put code to clear caches, for instance.
3365 * This is called on page move and undelete, as well as edit
3367 * @param Title $title
3369 public static function onArticleCreate( Title
$title ) {
3370 // TODO: move this into a PageEventEmitter service
3372 // Update existence markers on article/talk tabs...
3373 $other = $title->getOtherPage();
3375 $other->purgeSquid();
3377 $title->touchLinks();
3378 $title->purgeSquid();
3379 $title->deleteTitleProtection();
3381 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3383 // Invalidate caches of articles which include this page
3384 DeferredUpdates
::addUpdate(
3385 new HTMLCacheUpdate( $title, 'templatelinks', 'page-create' )
3388 if ( $title->getNamespace() == NS_CATEGORY
) {
3389 // Load the Category object, which will schedule a job to create
3390 // the category table row if necessary. Checking a replica DB is ok
3391 // here, in the worst case it'll run an unnecessary recount job on
3392 // a category that probably doesn't have many members.
3393 Category
::newFromTitle( $title )->getID();
3398 * Clears caches when article is deleted
3400 * @param Title $title
3402 public static function onArticleDelete( Title
$title ) {
3403 // TODO: move this into a PageEventEmitter service
3405 // Update existence markers on article/talk tabs...
3406 // Clear Backlink cache first so that purge jobs use more up-to-date backlink information
3407 BacklinkCache
::get( $title )->clear();
3408 $other = $title->getOtherPage();
3410 $other->purgeSquid();
3412 $title->touchLinks();
3413 $title->purgeSquid();
3415 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3418 HTMLFileCache
::clearFileCache( $title );
3419 InfoAction
::invalidateCache( $title );
3422 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3423 MessageCache
::singleton()->updateMessageOverride( $title, null );
3427 if ( $title->getNamespace() == NS_FILE
) {
3428 DeferredUpdates
::addUpdate(
3429 new HTMLCacheUpdate( $title, 'imagelinks', 'page-delete' )
3434 if ( $title->getNamespace() == NS_USER_TALK
) {
3435 $user = User
::newFromName( $title->getText(), false );
3437 $user->setNewtalk( false );
3442 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3444 // Purge cross-wiki cache entities referencing this page
3445 self
::purgeInterwikiCheckKey( $title );
3449 * Purge caches on page update etc
3451 * @param Title $title
3452 * @param Revision|null $revision Revision that was just saved, may be null
3453 * @param string[]|null $slotsChanged The role names of the slots that were changed.
3454 * If not given, all slots are assumed to have changed.
3456 public static function onArticleEdit(
3458 Revision
$revision = null,
3459 $slotsChanged = null
3461 // TODO: move this into a PageEventEmitter service
3463 if ( $slotsChanged === null ||
in_array( SlotRecord
::MAIN
, $slotsChanged ) ) {
3464 // Invalidate caches of articles which include this page.
3465 // Only for the main slot, because only the main slot is transcluded.
3466 // TODO: MCR: not true for TemplateStyles! [SlotHandler]
3467 DeferredUpdates
::addUpdate(
3468 new HTMLCacheUpdate( $title, 'templatelinks', 'page-edit' )
3472 // Invalidate the caches of all pages which redirect here
3473 DeferredUpdates
::addUpdate(
3474 new HTMLCacheUpdate( $title, 'redirect', 'page-edit' )
3477 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3479 // Purge CDN for this page only
3480 $title->purgeSquid();
3481 // Clear file cache for this page only
3482 HTMLFileCache
::clearFileCache( $title );
3484 // Purge ?action=info cache
3485 $revid = $revision ?
$revision->getId() : null;
3486 DeferredUpdates
::addCallableUpdate( function () use ( $title, $revid ) {
3487 InfoAction
::invalidateCache( $title, $revid );
3490 // Purge cross-wiki cache entities referencing this page
3491 self
::purgeInterwikiCheckKey( $title );
3497 * Purge the check key for cross-wiki cache entries referencing this page
3499 * @param Title $title
3501 private static function purgeInterwikiCheckKey( Title
$title ) {
3502 global $wgEnableScaryTranscluding;
3504 if ( !$wgEnableScaryTranscluding ) {
3505 return; // @todo: perhaps this wiki is only used as a *source* for content?
3508 DeferredUpdates
::addCallableUpdate( function () use ( $title ) {
3509 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
3510 $cache->resetCheckKey(
3511 // Do not include the namespace since there can be multiple aliases to it
3512 // due to different namespace text definitions on different wikis. This only
3513 // means that some cache invalidations happen that are not strictly needed.
3514 $cache->makeGlobalKey(
3516 WikiMap
::getCurrentWikiDbDomain()->getId(),
3524 * Returns a list of categories this page is a member of.
3525 * Results will include hidden categories
3527 * @return TitleArray
3529 public function getCategories() {
3530 $id = $this->getId();
3532 return TitleArray
::newFromResult( new FakeResultWrapper( [] ) );
3535 $dbr = wfGetDB( DB_REPLICA
);
3536 $res = $dbr->select( 'categorylinks',
3537 [ 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ],
3538 // Have to do that since Database::fieldNamesWithAlias treats numeric indexes
3539 // as not being aliases, and NS_CATEGORY is numeric
3540 [ 'cl_from' => $id ],
3543 return TitleArray
::newFromResult( $res );
3547 * Returns a list of hidden categories this page is a member of.
3548 * Uses the page_props and categorylinks tables.
3550 * @return array Array of Title objects
3552 public function getHiddenCategories() {
3554 $id = $this->getId();
3560 $dbr = wfGetDB( DB_REPLICA
);
3561 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3563 [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3564 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ],
3567 if ( $res !== false ) {
3568 foreach ( $res as $row ) {
3569 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3577 * Auto-generates a deletion reason
3579 * @param bool &$hasHistory Whether the page has a history
3580 * @return string|bool String containing deletion reason or empty string, or boolean false
3581 * if no revision occurred
3583 public function getAutoDeleteReason( &$hasHistory ) {
3584 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3588 * Update all the appropriate counts in the category table, given that
3589 * we've added the categories $added and deleted the categories $deleted.
3591 * This should only be called from deferred updates or jobs to avoid contention.
3593 * @param array $added The names of categories that were added
3594 * @param array $deleted The names of categories that were deleted
3595 * @param int $id Page ID (this should be the original deleted page ID)
3597 public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3598 $id = $id ?
: $this->getId();
3599 $type = MediaWikiServices
::getInstance()->getNamespaceInfo()->
3600 getCategoryLinkType( $this->getTitle()->getNamespace() );
3602 $addFields = [ 'cat_pages = cat_pages + 1' ];
3603 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3604 if ( $type !== 'page' ) {
3605 $addFields[] = "cat_{$type}s = cat_{$type}s + 1";
3606 $removeFields[] = "cat_{$type}s = cat_{$type}s - 1";
3609 $dbw = wfGetDB( DB_MASTER
);
3611 if ( count( $added ) ) {
3612 $existingAdded = $dbw->selectFieldValues(
3615 [ 'cat_title' => $added ],
3619 // For category rows that already exist, do a plain
3620 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3621 // to avoid creating gaps in the cat_id sequence.
3622 if ( count( $existingAdded ) ) {
3626 [ 'cat_title' => $existingAdded ],
3631 $missingAdded = array_diff( $added, $existingAdded );
3632 if ( count( $missingAdded ) ) {
3634 foreach ( $missingAdded as $cat ) {
3636 'cat_title' => $cat,
3638 'cat_subcats' => ( $type === 'subcat' ) ?
1 : 0,
3639 'cat_files' => ( $type === 'file' ) ?
1 : 0,
3652 if ( count( $deleted ) ) {
3656 [ 'cat_title' => $deleted ],
3661 foreach ( $added as $catName ) {
3662 $cat = Category
::newFromName( $catName );
3663 Hooks
::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3666 foreach ( $deleted as $catName ) {
3667 $cat = Category
::newFromName( $catName );
3668 Hooks
::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3669 // Refresh counts on categories that should be empty now (after commit, T166757)
3670 DeferredUpdates
::addCallableUpdate( function () use ( $cat ) {
3671 $cat->refreshCountsIfEmpty();
3677 * Opportunistically enqueue link update jobs given fresh parser output if useful
3679 * @param ParserOutput $parserOutput Current version page output
3682 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3683 if ( wfReadOnly() ) {
3687 if ( !Hooks
::run( 'OpportunisticLinksUpdate',
3688 [ $this, $this->mTitle
, $parserOutput ]
3693 $config = RequestContext
::getMain()->getConfig();
3696 'isOpportunistic' => true,
3697 'rootJobTimestamp' => $parserOutput->getCacheTime()
3700 if ( $this->mTitle
->areRestrictionsCascading() ) {
3701 // If the page is cascade protecting, the links should really be up-to-date
3702 JobQueueGroup
::singleton()->lazyPush(
3703 RefreshLinksJob
::newPrioritized( $this->mTitle
, $params )
3705 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3706 // Assume the output contains "dynamic" time/random based magic words.
3707 // Only update pages that expired due to dynamic content and NOT due to edits
3708 // to referenced templates/files. When the cache expires due to dynamic content,
3709 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3710 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3711 // template/file edit already triggered recursive RefreshLinksJob jobs.
3712 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3713 // If a page is uncacheable, do not keep spamming a job for it.
3714 // Although it would be de-duplicated, it would still waste I/O.
3715 $cache = ObjectCache
::getLocalClusterInstance();
3716 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3717 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3718 if ( $cache->add( $key, time(), $ttl ) ) {
3719 JobQueueGroup
::singleton()->lazyPush(
3720 RefreshLinksJob
::newDynamic( $this->mTitle
, $params )
3728 * Returns a list of updates to be performed when this page is deleted. The
3729 * updates should remove any information about this page from secondary data
3730 * stores such as links tables.
3732 * @param RevisionRecord|Content|null $rev The revision being deleted. Also accepts a Content
3733 * object for backwards compatibility.
3734 * @return DeferrableUpdate[]
3736 public function getDeletionUpdates( $rev = null ) {
3738 wfDeprecated( __METHOD__
. ' without a RevisionRecord', '1.32' );
3741 $rev = $this->getRevisionRecord();
3742 } catch ( Exception
$ex ) {
3743 // If we can't load the content, something is wrong. Perhaps that's why
3744 // the user is trying to delete the page, so let's not fail in that case.
3745 // Note that doDeleteArticleReal() will already have logged an issue with
3746 // loading the content.
3747 wfDebug( __METHOD__
. ' failed to load current revision of page ' . $this->getId() );
3753 } elseif ( $rev instanceof Content
) {
3754 wfDeprecated( __METHOD__
. ' with a Content object instead of a RevisionRecord', '1.32' );
3756 $slotContent = [ SlotRecord
::MAIN
=> $rev ];
3758 $slotContent = array_map( function ( SlotRecord
$slot ) {
3759 return $slot->getContent( Revision
::RAW
);
3760 }, $rev->getSlots()->getSlots() );
3763 $allUpdates = [ new LinksDeletionUpdate( $this ) ];
3765 // NOTE: once Content::getDeletionUpdates() is removed, we only need to content
3766 // model here, not the content object!
3767 // TODO: consolidate with similar logic in DerivedPageDataUpdater::getSecondaryDataUpdates()
3768 /** @var Content $content */
3769 foreach ( $slotContent as $role => $content ) {
3770 $handler = $content->getContentHandler();
3772 $updates = $handler->getDeletionUpdates(
3776 $allUpdates = array_merge( $allUpdates, $updates );
3778 // TODO: remove B/C hack in 1.32!
3779 $legacyUpdates = $content->getDeletionUpdates( $this );
3781 // HACK: filter out redundant and incomplete LinksDeletionUpdate
3782 $legacyUpdates = array_filter( $legacyUpdates, function ( $update ) {
3783 return !( $update instanceof LinksDeletionUpdate
);
3786 $allUpdates = array_merge( $allUpdates, $legacyUpdates );
3789 Hooks
::run( 'PageDeletionDataUpdates', [ $this->getTitle(), $rev, &$allUpdates ] );
3791 // TODO: hard deprecate old hook in 1.33
3792 Hooks
::run( 'WikiPageDeletionUpdates', [ $this, $content, &$allUpdates ] );
3797 * Whether this content displayed on this page
3798 * comes from the local database
3803 public function isLocal() {
3808 * The display name for the site this content
3809 * come from. If a subclass overrides isLocal(),
3810 * this could return something other than the
3816 public function getWikiDisplayName() {
3822 * Get the source URL for the content on this page,
3823 * typically the canonical URL, but may be a remote
3824 * link if the content comes from another site
3829 public function getSourceURL() {
3830 return $this->getTitle()->getCanonicalURL();
3834 * @param WANObjectCache $cache
3838 public function getMutableCacheKeys( WANObjectCache
$cache ) {
3839 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3841 return $linkCache->getMutableCacheKeys( $cache, $this->getTitle() );