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;
56 public $mDataLoaded = false; // !< Boolean
57 public $mIsRedirect = false; // !< Boolean
58 public $mLatest = false; // !< Integer (false means "not loaded")
61 /** @var PreparedEdit Map of cache fields (text, parser output, ect) for a proposed/new edit */
62 public $mPreparedEdit = false;
67 protected $mId = null;
70 * @var int One of the READ_* constants
72 protected $mDataLoadedFrom = self
::READ_NONE
;
77 protected $mRedirectTarget = null;
82 protected $mLastRevision = null;
85 * @var string Timestamp of the current revision or empty string if not loaded
87 protected $mTimestamp = '';
92 protected $mTouched = '19700101000000';
97 protected $mLinksUpdated = '19700101000000';
100 * @var DerivedPageDataUpdater|null
102 private $derivedDataUpdater = null;
105 * Constructor and clear the article
106 * @param Title $title Reference to a Title object.
108 public function __construct( Title
$title ) {
109 $this->mTitle
= $title;
113 * Makes sure that the mTitle object is cloned
114 * to the newly cloned WikiPage.
116 public function __clone() {
117 $this->mTitle
= clone $this->mTitle
;
121 * Create a WikiPage object of the appropriate class for the given title.
123 * @param Title $title
125 * @throws MWException
126 * @return WikiPage|WikiCategoryPage|WikiFilePage
128 public static function factory( Title
$title ) {
129 $ns = $title->getNamespace();
131 if ( $ns == NS_MEDIA
) {
132 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
133 } elseif ( $ns < 0 ) {
134 throw new MWException( "Invalid or virtual namespace $ns given." );
138 if ( !Hooks
::run( 'WikiPageFactory', [ $title, &$page ] ) ) {
144 $page = new WikiFilePage( $title );
147 $page = new WikiCategoryPage( $title );
150 $page = new WikiPage( $title );
157 * Constructor from a page id
159 * @param int $id Article ID to load
160 * @param string|int $from One of the following values:
161 * - "fromdb" or WikiPage::READ_NORMAL to select from a replica DB
162 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
164 * @return WikiPage|null
166 public static function newFromID( $id, $from = 'fromdb' ) {
167 // page ids are never 0 or negative, see T63166
172 $from = self
::convertSelectType( $from );
173 $db = wfGetDB( $from === self
::READ_LATEST ? DB_MASTER
: DB_REPLICA
);
174 $pageQuery = self
::getQueryInfo();
175 $row = $db->selectRow(
176 $pageQuery['tables'], $pageQuery['fields'], [ 'page_id' => $id ], __METHOD__
,
177 [], $pageQuery['joins']
182 return self
::newFromRow( $row, $from );
186 * Constructor from a database row
189 * @param object $row Database row containing at least fields returned by selectFields().
190 * @param string|int $from Source of $data:
191 * - "fromdb" or WikiPage::READ_NORMAL: from a replica DB
192 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
193 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
196 public static function newFromRow( $row, $from = 'fromdb' ) {
197 $page = self
::factory( Title
::newFromRow( $row ) );
198 $page->loadFromRow( $row, $from );
203 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
205 * @param object|string|int $type
208 protected static function convertSelectType( $type ) {
211 return self
::READ_NORMAL
;
213 return self
::READ_LATEST
;
215 return self
::READ_LOCKING
;
217 // It may already be an integer or whatever else
223 * @return RevisionStore
225 private function getRevisionStore() {
226 return MediaWikiServices
::getInstance()->getRevisionStore();
230 * @return RevisionRenderer
232 private function getRevisionRenderer() {
233 return MediaWikiServices
::getInstance()->getRevisionRenderer();
237 * @return SlotRoleRegistry
239 private function getSlotRoleRegistry() {
240 return MediaWikiServices
::getInstance()->getSlotRoleRegistry();
244 * @return ParserCache
246 private function getParserCache() {
247 return MediaWikiServices
::getInstance()->getParserCache();
251 * @return LoadBalancer
253 private function getDBLoadBalancer() {
254 return MediaWikiServices
::getInstance()->getDBLoadBalancer();
258 * @todo Move this UI stuff somewhere else
260 * @see ContentHandler::getActionOverrides
263 public function getActionOverrides() {
264 return $this->getContentHandler()->getActionOverrides();
268 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
270 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
272 * @return ContentHandler
276 public function getContentHandler() {
277 return ContentHandler
::getForModelID( $this->getContentModel() );
281 * Get the title object of the article
282 * @return Title Title object of this page
284 public function getTitle() {
285 return $this->mTitle
;
292 public function clear() {
293 $this->mDataLoaded
= false;
294 $this->mDataLoadedFrom
= self
::READ_NONE
;
296 $this->clearCacheFields();
300 * Clear the object cache fields
303 protected function clearCacheFields() {
305 $this->mRedirectTarget
= null; // Title object if set
306 $this->mLastRevision
= null; // Latest revision
307 $this->mTouched
= '19700101000000';
308 $this->mLinksUpdated
= '19700101000000';
309 $this->mTimestamp
= '';
310 $this->mIsRedirect
= false;
311 $this->mLatest
= false;
312 // T59026: do not clear $this->derivedDataUpdater since getDerivedDataUpdater() already
313 // checks the requested rev ID and content against the cached one. For most
314 // content types, the output should not change during the lifetime of this cache.
315 // Clearing it can cause extra parses on edit for no reason.
319 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
323 public function clearPreparedEdit() {
324 $this->mPreparedEdit
= false;
328 * Return the list of revision fields that should be selected to create
331 * @deprecated since 1.31, use self::getQueryInfo() instead.
334 public static function selectFields() {
335 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
337 wfDeprecated( __METHOD__
, '1.31' );
348 'page_links_updated',
353 if ( $wgContentHandlerUseDB ) {
354 $fields[] = 'page_content_model';
357 if ( $wgPageLanguageUseDB ) {
358 $fields[] = 'page_lang';
365 * Return the tables, fields, and join conditions to be selected to create
368 * @return array With three keys:
369 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
370 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
371 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
373 public static function getQueryInfo() {
374 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
377 'tables' => [ 'page' ],
387 'page_links_updated',
394 if ( $wgContentHandlerUseDB ) {
395 $ret['fields'][] = 'page_content_model';
398 if ( $wgPageLanguageUseDB ) {
399 $ret['fields'][] = 'page_lang';
406 * Fetch a page record with the given conditions
407 * @param IDatabase $dbr
408 * @param array $conditions
409 * @param array $options
410 * @return object|bool Database result resource, or false on failure
412 protected function pageData( $dbr, $conditions, $options = [] ) {
413 $pageQuery = self
::getQueryInfo();
415 // Avoid PHP 7.1 warning of passing $this by reference
418 Hooks
::run( 'ArticlePageDataBefore', [
419 &$wikiPage, &$pageQuery['fields'], &$pageQuery['tables'], &$pageQuery['joins']
422 $row = $dbr->selectRow(
423 $pageQuery['tables'],
424 $pageQuery['fields'],
431 Hooks
::run( 'ArticlePageDataAfter', [ &$wikiPage, &$row ] );
437 * Fetch a page record matching the Title object's namespace and title
438 * using a sanitized title string
440 * @param IDatabase $dbr
441 * @param Title $title
442 * @param array $options
443 * @return object|bool Database result resource, or false on failure
445 public function pageDataFromTitle( $dbr, $title, $options = [] ) {
446 return $this->pageData( $dbr, [
447 'page_namespace' => $title->getNamespace(),
448 'page_title' => $title->getDBkey() ], $options );
452 * Fetch a page record matching the requested ID
454 * @param IDatabase $dbr
456 * @param array $options
457 * @return object|bool Database result resource, or false on failure
459 public function pageDataFromId( $dbr, $id, $options = [] ) {
460 return $this->pageData( $dbr, [ 'page_id' => $id ], $options );
464 * Load the object from a given source by title
466 * @param object|string|int $from One of the following:
467 * - A DB query result object.
468 * - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
469 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
470 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
471 * using SELECT FOR UPDATE.
475 public function loadPageData( $from = 'fromdb' ) {
476 $from = self
::convertSelectType( $from );
477 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
478 // We already have the data from the correct location, no need to load it twice.
482 if ( is_int( $from ) ) {
483 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
484 $loadBalancer = $this->getDBLoadBalancer();
485 $db = $loadBalancer->getConnection( $index );
486 $data = $this->pageDataFromTitle( $db, $this->mTitle
, $opts );
489 && $index == DB_REPLICA
490 && $loadBalancer->getServerCount() > 1
491 && $loadBalancer->hasOrMadeRecentMasterChanges()
493 $from = self
::READ_LATEST
;
494 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
495 $db = $loadBalancer->getConnection( $index );
496 $data = $this->pageDataFromTitle( $db, $this->mTitle
, $opts );
499 // No idea from where the caller got this data, assume replica DB.
501 $from = self
::READ_NORMAL
;
504 $this->loadFromRow( $data, $from );
508 * Checks whether the page data was loaded using the given database access mode (or better).
512 * @param string|int $from One of the following:
513 * - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
514 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
515 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
516 * using SELECT FOR UPDATE.
520 public function wasLoadedFrom( $from ) {
521 $from = self
::convertSelectType( $from );
523 if ( !is_int( $from ) ) {
524 // No idea from where the caller got this data, assume replica DB.
525 $from = self
::READ_NORMAL
;
528 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
536 * Load the object from a database row
539 * @param object|bool $data DB row containing fields returned by selectFields() or false
540 * @param string|int $from One of the following:
541 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB
542 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
543 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
544 * the master DB using SELECT FOR UPDATE
546 public function loadFromRow( $data, $from ) {
547 $lc = MediaWikiServices
::getInstance()->getLinkCache();
548 $lc->clearLink( $this->mTitle
);
551 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
553 $this->mTitle
->loadFromRow( $data );
555 // Old-fashioned restrictions
556 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
558 $this->mId
= intval( $data->page_id
);
559 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
560 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
561 $this->mIsRedirect
= intval( $data->page_is_redirect
);
562 $this->mLatest
= intval( $data->page_latest
);
563 // T39225: $latest may no longer match the cached latest Revision object.
564 // Double-check the ID of any cached latest Revision object for consistency.
565 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
566 $this->mLastRevision
= null;
567 $this->mTimestamp
= '';
570 $lc->addBadLinkObj( $this->mTitle
);
572 $this->mTitle
->loadFromRow( false );
574 $this->clearCacheFields();
579 $this->mDataLoaded
= true;
580 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
584 * @return int Page ID
586 public function getId() {
587 if ( !$this->mDataLoaded
) {
588 $this->loadPageData();
594 * @return bool Whether or not the page exists in the database
596 public function exists() {
597 if ( !$this->mDataLoaded
) {
598 $this->loadPageData();
600 return $this->mId
> 0;
604 * Check if this page is something we're going to be showing
605 * some sort of sensible content for. If we return false, page
606 * views (plain action=view) will return an HTTP 404 response,
607 * so spiders and robots can know they're following a bad link.
611 public function hasViewableContent() {
612 return $this->mTitle
->isKnown();
616 * Tests if the article content represents a redirect
620 public function isRedirect() {
621 if ( !$this->mDataLoaded
) {
622 $this->loadPageData();
625 return (bool)$this->mIsRedirect
;
629 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
631 * Will use the revisions actual content model if the page exists,
632 * and the page's default if the page doesn't exist yet.
638 public function getContentModel() {
639 if ( $this->exists() ) {
640 $cache = ObjectCache
::getMainWANInstance();
642 return $cache->getWithSetCallback(
643 $cache->makeKey( 'page-content-model', $this->getLatest() ),
646 $rev = $this->getRevision();
648 // Look at the revision's actual content model
649 return $rev->getContentModel();
651 $title = $this->mTitle
->getPrefixedDBkey();
652 wfWarn( "Page $title exists but has no (visible) revisions!" );
653 return $this->mTitle
->getContentModel();
659 // use the default model for this page
660 return $this->mTitle
->getContentModel();
664 * Loads page_touched and returns a value indicating if it should be used
665 * @return bool True if this page exists and is not a redirect
667 public function checkTouched() {
668 if ( !$this->mDataLoaded
) {
669 $this->loadPageData();
671 return ( $this->mId
&& !$this->mIsRedirect
);
675 * Get the page_touched field
676 * @return string Containing GMT timestamp
678 public function getTouched() {
679 if ( !$this->mDataLoaded
) {
680 $this->loadPageData();
682 return $this->mTouched
;
686 * Get the page_links_updated field
687 * @return string|null Containing GMT timestamp
689 public function getLinksTimestamp() {
690 if ( !$this->mDataLoaded
) {
691 $this->loadPageData();
693 return $this->mLinksUpdated
;
697 * Get the page_latest field
698 * @return int The rev_id of current revision
700 public function getLatest() {
701 if ( !$this->mDataLoaded
) {
702 $this->loadPageData();
704 return (int)$this->mLatest
;
708 * Get the Revision object of the oldest revision
709 * @return Revision|null
711 public function getOldestRevision() {
712 // Try using the replica DB first, then try the master
713 $rev = $this->mTitle
->getFirstRevision();
715 $rev = $this->mTitle
->getFirstRevision( Title
::GAID_FOR_UPDATE
);
721 * Loads everything except the text
722 * This isn't necessary for all uses, so it's only done if needed.
724 protected function loadLastEdit() {
725 if ( $this->mLastRevision
!== null ) {
726 return; // already loaded
729 $latest = $this->getLatest();
731 return; // page doesn't exist or is missing page_latest info
734 if ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) {
735 // T39225: if session S1 loads the page row FOR UPDATE, the result always
736 // includes the latest changes committed. This is true even within REPEATABLE-READ
737 // transactions, where S1 normally only sees changes committed before the first S1
738 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
739 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
740 // happened after the first S1 SELECT.
741 // https://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read
742 $flags = Revision
::READ_LOCKING
;
743 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
744 } elseif ( $this->mDataLoadedFrom
== self
::READ_LATEST
) {
745 // Bug T93976: if page_latest was loaded from the master, fetch the
746 // revision from there as well, as it may not exist yet on a replica DB.
747 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
748 $flags = Revision
::READ_LATEST
;
749 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
751 $dbr = wfGetDB( DB_REPLICA
);
752 $revision = Revision
::newKnownCurrent( $dbr, $this->getTitle(), $latest );
755 if ( $revision ) { // sanity
756 $this->setLastEdit( $revision );
761 * Set the latest revision
762 * @param Revision $revision
764 protected function setLastEdit( Revision
$revision ) {
765 $this->mLastRevision
= $revision;
766 $this->mTimestamp
= $revision->getTimestamp();
770 * Get the latest revision
771 * @return Revision|null
773 public function getRevision() {
774 $this->loadLastEdit();
775 if ( $this->mLastRevision
) {
776 return $this->mLastRevision
;
782 * Get the latest revision
783 * @return RevisionRecord|null
785 public function getRevisionRecord() {
786 $this->loadLastEdit();
787 if ( $this->mLastRevision
) {
788 return $this->mLastRevision
->getRevisionRecord();
794 * Get the content of the current revision. No side-effects...
796 * @param int $audience One of:
797 * Revision::FOR_PUBLIC to be displayed to all users
798 * Revision::FOR_THIS_USER to be displayed to $wgUser
799 * Revision::RAW get the text regardless of permissions
800 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
801 * to the $audience parameter
802 * @return Content|null The content of the current revision
806 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
807 $this->loadLastEdit();
808 if ( $this->mLastRevision
) {
809 return $this->mLastRevision
->getContent( $audience, $user );
815 * @return string MW timestamp of last article revision
817 public function getTimestamp() {
818 // Check if the field has been filled by WikiPage::setTimestamp()
819 if ( !$this->mTimestamp
) {
820 $this->loadLastEdit();
823 return wfTimestamp( TS_MW
, $this->mTimestamp
);
827 * Set the page timestamp (use only to avoid DB queries)
828 * @param string $ts MW timestamp of last article revision
831 public function setTimestamp( $ts ) {
832 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
836 * @param int $audience One of:
837 * Revision::FOR_PUBLIC to be displayed to all users
838 * Revision::FOR_THIS_USER to be displayed to the given user
839 * Revision::RAW get the text regardless of permissions
840 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
841 * to the $audience parameter
842 * @return int User ID for the user that made the last article revision
844 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
845 $this->loadLastEdit();
846 if ( $this->mLastRevision
) {
847 return $this->mLastRevision
->getUser( $audience, $user );
854 * Get the User object of the user who created the page
855 * @param int $audience One of:
856 * Revision::FOR_PUBLIC to be displayed to all users
857 * Revision::FOR_THIS_USER to be displayed to the given user
858 * Revision::RAW get the text regardless of permissions
859 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
860 * to the $audience parameter
863 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
864 $revision = $this->getOldestRevision();
866 $userName = $revision->getUserText( $audience, $user );
867 return User
::newFromName( $userName, false );
874 * @param int $audience One of:
875 * Revision::FOR_PUBLIC to be displayed to all users
876 * Revision::FOR_THIS_USER to be displayed to the given user
877 * Revision::RAW get the text regardless of permissions
878 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
879 * to the $audience parameter
880 * @return string Username of the user that made the last article revision
882 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
883 $this->loadLastEdit();
884 if ( $this->mLastRevision
) {
885 return $this->mLastRevision
->getUserText( $audience, $user );
892 * @param int $audience One of:
893 * Revision::FOR_PUBLIC to be displayed to all users
894 * Revision::FOR_THIS_USER to be displayed to the given user
895 * Revision::RAW get the text regardless of permissions
896 * @param User|null $user User object to check for, only if FOR_THIS_USER is passed
897 * to the $audience parameter
898 * @return string Comment stored for the last article revision
900 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
901 $this->loadLastEdit();
902 if ( $this->mLastRevision
) {
903 return $this->mLastRevision
->getComment( $audience, $user );
910 * Returns true if last revision was marked as "minor edit"
912 * @return bool Minor edit indicator for the last article revision.
914 public function getMinorEdit() {
915 $this->loadLastEdit();
916 if ( $this->mLastRevision
) {
917 return $this->mLastRevision
->isMinor();
924 * Determine whether a page would be suitable for being counted as an
925 * article in the site_stats table based on the title & its content
927 * @param PreparedEdit|bool $editInfo (false): object returned by prepareTextForEdit(),
928 * if false, the current database state will be used
931 public function isCountable( $editInfo = false ) {
932 global $wgArticleCountMethod;
934 // NOTE: Keep in sync with DerivedPageDataUpdater::isCountable.
936 if ( !$this->mTitle
->isContentPage() ) {
941 // NOTE: only the main slot can make a page a redirect
942 $content = $editInfo->pstContent
;
944 $content = $this->getContent();
947 if ( !$content ||
$content->isRedirect() ) {
953 if ( $wgArticleCountMethod === 'link' ) {
954 // nasty special case to avoid re-parsing to detect links
957 // ParserOutput::getLinks() is a 2D array of page links, so
958 // to be really correct we would need to recurse in the array
959 // but the main array should only have items in it if there are
961 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
963 // NOTE: keep in sync with RevisionRenderer::getLinkCount
964 // NOTE: keep in sync with DerivedPageDataUpdater::isCountable
965 $hasLinks = (bool)wfGetDB( DB_REPLICA
)->selectField( 'pagelinks', 1,
966 [ 'pl_from' => $this->getId() ], __METHOD__
);
970 // TODO: MCR: determine $hasLinks for each slot, and use that info
971 // with that slot's Content's isCountable method. That requires per-
972 // slot ParserOutput in the ParserCache, or per-slot info in the
974 return $content->isCountable( $hasLinks );
978 * If this page is a redirect, get its target
980 * The target will be fetched from the redirect table if possible.
981 * If this page doesn't have an entry there, call insertRedirect()
982 * @return Title|null Title object, or null if this page is not a redirect
984 public function getRedirectTarget() {
985 if ( !$this->mTitle
->isRedirect() ) {
989 if ( $this->mRedirectTarget
!== null ) {
990 return $this->mRedirectTarget
;
993 // Query the redirect table
994 $dbr = wfGetDB( DB_REPLICA
);
995 $row = $dbr->selectRow( 'redirect',
996 [ 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ],
997 [ 'rd_from' => $this->getId() ],
1001 // rd_fragment and rd_interwiki were added later, populate them if empty
1002 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
1003 // (T203942) We can't redirect to Media namespace because it's virtual.
1004 // We don't want to modify Title objects farther down the
1005 // line. So, let's fix this here by changing to File namespace.
1006 if ( $row->rd_namespace
== NS_MEDIA
) {
1007 $namespace = NS_FILE
;
1009 $namespace = $row->rd_namespace
;
1011 $this->mRedirectTarget
= Title
::makeTitle(
1012 $namespace, $row->rd_title
,
1013 $row->rd_fragment
, $row->rd_interwiki
1015 return $this->mRedirectTarget
;
1018 // This page doesn't have an entry in the redirect table
1019 $this->mRedirectTarget
= $this->insertRedirect();
1020 return $this->mRedirectTarget
;
1024 * Insert an entry for this page into the redirect table if the content is a redirect
1026 * The database update will be deferred via DeferredUpdates
1028 * Don't call this function directly unless you know what you're doing.
1029 * @return Title|null Title object or null if not a redirect
1031 public function insertRedirect() {
1032 $content = $this->getContent();
1033 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
1038 // Update the DB post-send if the page has not cached since now
1039 $latest = $this->getLatest();
1040 DeferredUpdates
::addCallableUpdate(
1041 function () use ( $retval, $latest ) {
1042 $this->insertRedirectEntry( $retval, $latest );
1044 DeferredUpdates
::POSTSEND
,
1045 wfGetDB( DB_MASTER
)
1052 * Insert or update the redirect table entry for this page to indicate it redirects to $rt
1053 * @param Title $rt Redirect target
1054 * @param int|null $oldLatest Prior page_latest for check and set
1056 public function insertRedirectEntry( Title
$rt, $oldLatest = null ) {
1057 $dbw = wfGetDB( DB_MASTER
);
1058 $dbw->startAtomic( __METHOD__
);
1060 if ( !$oldLatest ||
$oldLatest == $this->lockAndGetLatest() ) {
1061 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
1062 $truncatedFragment = $contLang->truncateForDatabase( $rt->getFragment(), 255 );
1066 'rd_from' => $this->getId(),
1067 'rd_namespace' => $rt->getNamespace(),
1068 'rd_title' => $rt->getDBkey(),
1069 'rd_fragment' => $truncatedFragment,
1070 'rd_interwiki' => $rt->getInterwiki(),
1074 'rd_namespace' => $rt->getNamespace(),
1075 'rd_title' => $rt->getDBkey(),
1076 'rd_fragment' => $truncatedFragment,
1077 'rd_interwiki' => $rt->getInterwiki(),
1083 $dbw->endAtomic( __METHOD__
);
1087 * Get the Title object or URL this page redirects to
1089 * @return bool|Title|string False, Title of in-wiki target, or string with URL
1091 public function followRedirect() {
1092 return $this->getRedirectURL( $this->getRedirectTarget() );
1096 * Get the Title object or URL to use for a redirect. We use Title
1097 * objects for same-wiki, non-special redirects and URLs for everything
1099 * @param Title $rt Redirect target
1100 * @return bool|Title|string False, Title object of local target, or string with URL
1102 public function getRedirectURL( $rt ) {
1107 if ( $rt->isExternal() ) {
1108 if ( $rt->isLocal() ) {
1109 // Offsite wikis need an HTTP redirect.
1110 // This can be hard to reverse and may produce loops,
1111 // so they may be disabled in the site configuration.
1112 $source = $this->mTitle
->getFullURL( 'redirect=no' );
1113 return $rt->getFullURL( [ 'rdfrom' => $source ] );
1115 // External pages without "local" bit set are not valid
1121 if ( $rt->isSpecialPage() ) {
1122 // Gotta handle redirects to special pages differently:
1123 // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
1124 // Some pages are not valid targets.
1125 if ( $rt->isValidRedirectTarget() ) {
1126 return $rt->getFullURL();
1136 * Get a list of users who have edited this article, not including the user who made
1137 * the most recent revision, which you can get from $article->getUser() if you want it
1138 * @return UserArrayFromResult
1140 public function getContributors() {
1141 // @todo: This is expensive; cache this info somewhere.
1143 $dbr = wfGetDB( DB_REPLICA
);
1145 $actorMigration = ActorMigration
::newMigration();
1146 $actorQuery = $actorMigration->getJoin( 'rev_user' );
1148 $tables = array_merge( [ 'revision' ], $actorQuery['tables'], [ 'user' ] );
1151 'user_id' => $actorQuery['fields']['rev_user'],
1152 'user_name' => $actorQuery['fields']['rev_user_text'],
1153 'actor_id' => $actorQuery['fields']['rev_actor'],
1154 'user_real_name' => 'MIN(user_real_name)',
1155 'timestamp' => 'MAX(rev_timestamp)',
1158 $conds = [ 'rev_page' => $this->getId() ];
1160 // The user who made the top revision gets credited as "this page was last edited by
1161 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1162 $user = $this->getUser()
1163 ? User
::newFromId( $this->getUser() )
1164 : User
::newFromName( $this->getUserText(), false );
1165 $conds[] = 'NOT(' . $actorMigration->getWhere( $dbr, 'rev_user', $user )['conds'] . ')';
1168 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1171 'user' => [ 'LEFT JOIN', $actorQuery['fields']['rev_user'] . ' = user_id' ],
1172 ] +
$actorQuery['joins'];
1175 'GROUP BY' => [ $fields['user_id'], $fields['user_name'] ],
1176 'ORDER BY' => 'timestamp DESC',
1179 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1180 return new UserArrayFromResult( $res );
1184 * Should the parser cache be used?
1186 * @param ParserOptions $parserOptions ParserOptions to check
1190 public function shouldCheckParserCache( ParserOptions
$parserOptions, $oldId ) {
1191 return $parserOptions->getStubThreshold() == 0
1193 && ( $oldId === null ||
$oldId === 0 ||
$oldId === $this->getLatest() )
1194 && $this->getContentHandler()->isParserCacheSupported();
1198 * Get a ParserOutput for the given ParserOptions and revision ID.
1200 * The parser cache will be used if possible. Cache misses that result
1201 * in parser runs are debounced with PoolCounter.
1203 * XXX merge this with updateParserCache()?
1206 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1207 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1208 * get the current revision (default value)
1209 * @param bool $forceParse Force reindexing, regardless of cache settings
1210 * @return bool|ParserOutput ParserOutput or false if the revision was not found
1212 public function getParserOutput(
1213 ParserOptions
$parserOptions, $oldid = null, $forceParse = false
1216 ( !$forceParse ) && $this->shouldCheckParserCache( $parserOptions, $oldid );
1218 if ( $useParserCache && !$parserOptions->isSafeToCache() ) {
1219 throw new InvalidArgumentException(
1220 'The supplied ParserOptions are not safe to cache. Fix the options or set $forceParse = true.'
1224 wfDebug( __METHOD__
.
1225 ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1226 if ( $parserOptions->getStubThreshold() ) {
1227 wfIncrStats( 'pcache.miss.stub' );
1230 if ( $useParserCache ) {
1231 $parserOutput = $this->getParserCache()
1232 ->get( $this, $parserOptions );
1233 if ( $parserOutput !== false ) {
1234 return $parserOutput;
1238 if ( $oldid === null ||
$oldid === 0 ) {
1239 $oldid = $this->getLatest();
1242 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1245 return $pool->getParserOutput();
1249 * Do standard deferred updates after page view (existing or missing page)
1250 * @param User $user The relevant user
1251 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1253 public function doViewUpdates( User
$user, $oldid = 0 ) {
1254 if ( wfReadOnly() ) {
1258 // Update newtalk / watchlist notification status;
1259 // Avoid outage if the master is not reachable by using a deferred updated
1260 DeferredUpdates
::addCallableUpdate(
1261 function () use ( $user, $oldid ) {
1262 Hooks
::run( 'PageViewUpdates', [ $this, $user ] );
1264 $user->clearNotification( $this->mTitle
, $oldid );
1266 DeferredUpdates
::PRESEND
1271 * Perform the actions of a page purging
1273 * @note In 1.28 (and only 1.28), this took a $flags parameter that
1274 * controlled how much purging was done.
1276 public function doPurge() {
1277 // Avoid PHP 7.1 warning of passing $this by reference
1280 if ( !Hooks
::run( 'ArticlePurge', [ &$wikiPage ] ) ) {
1284 $this->mTitle
->invalidateCache();
1287 HTMLFileCache
::clearFileCache( $this->getTitle() );
1288 // Send purge after above page_touched update was committed
1289 DeferredUpdates
::addUpdate(
1290 new CdnCacheUpdate( $this->mTitle
->getCdnUrls() ),
1291 DeferredUpdates
::PRESEND
1294 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1295 $messageCache = MessageCache
::singleton();
1296 $messageCache->updateMessageOverride( $this->mTitle
, $this->getContent() );
1303 * Insert a new empty page record for this article.
1304 * This *must* be followed up by creating a revision
1305 * and running $this->updateRevisionOn( ... );
1306 * or else the record will be left in a funky state.
1307 * Best if all done inside a transaction.
1309 * @todo Factor out into a PageStore service, to be used by PageUpdater.
1311 * @param IDatabase $dbw
1312 * @param int|null $pageId Custom page ID that will be used for the insert statement
1314 * @return bool|int The newly created page_id key; false if the row was not
1315 * inserted, e.g. because the title already existed or because the specified
1316 * page ID is already in use.
1318 public function insertOn( $dbw, $pageId = null ) {
1319 $pageIdForInsert = $pageId ?
[ 'page_id' => $pageId ] : [];
1323 'page_namespace' => $this->mTitle
->getNamespace(),
1324 'page_title' => $this->mTitle
->getDBkey(),
1325 'page_restrictions' => '',
1326 'page_is_redirect' => 0, // Will set this shortly...
1328 'page_random' => wfRandom(),
1329 'page_touched' => $dbw->timestamp(),
1330 'page_latest' => 0, // Fill this in shortly...
1331 'page_len' => 0, // Fill this in shortly...
1332 ] +
$pageIdForInsert,
1337 if ( $dbw->affectedRows() > 0 ) {
1338 $newid = $pageId ?
(int)$pageId : $dbw->insertId();
1339 $this->mId
= $newid;
1340 $this->mTitle
->resetArticleID( $newid );
1344 return false; // nothing changed
1349 * Update the page record to point to a newly saved revision.
1351 * @todo Factor out into a PageStore service, or move into PageUpdater.
1353 * @param IDatabase $dbw
1354 * @param Revision $revision For ID number, and text used to set
1355 * length and redirect status fields
1356 * @param int|null $lastRevision If given, will not overwrite the page field
1357 * when different from the currently set value.
1358 * Giving 0 indicates the new page flag should be set on.
1359 * @param bool|null $lastRevIsRedirect If given, will optimize adding and
1360 * removing rows in redirect table.
1361 * @return bool Success; false if the page row was missing or page_latest changed
1363 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1364 $lastRevIsRedirect = null
1366 global $wgContentHandlerUseDB;
1368 // TODO: move into PageUpdater or PageStore
1369 // NOTE: when doing that, make sure cached fields get reset in doEditContent,
1370 // and in the compat stub!
1372 // Assertion to try to catch T92046
1373 if ( (int)$revision->getId() === 0 ) {
1374 throw new InvalidArgumentException(
1375 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1379 $content = $revision->getContent();
1380 $len = $content ?
$content->getSize() : 0;
1381 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1383 $conditions = [ 'page_id' => $this->getId() ];
1385 if ( !is_null( $lastRevision ) ) {
1386 // An extra check against threads stepping on each other
1387 $conditions['page_latest'] = $lastRevision;
1390 $revId = $revision->getId();
1391 Assert
::parameter( $revId > 0, '$revision->getId()', 'must be > 0' );
1394 'page_latest' => $revId,
1395 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1396 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1397 'page_is_redirect' => $rt !== null ?
1 : 0,
1401 if ( $wgContentHandlerUseDB ) {
1402 $row['page_content_model'] = $revision->getContentModel();
1405 $dbw->update( 'page',
1410 $result = $dbw->affectedRows() > 0;
1412 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1413 $this->setLastEdit( $revision );
1414 $this->mLatest
= $revision->getId();
1415 $this->mIsRedirect
= (bool)$rt;
1416 // Update the LinkCache.
1417 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
1418 $linkCache->addGoodLinkObj(
1424 $revision->getContentModel()
1432 * Add row to the redirect table if this is a redirect, remove otherwise.
1434 * @param IDatabase $dbw
1435 * @param Title|null $redirectTitle Title object pointing to the redirect target,
1436 * or NULL if this is not a redirect
1437 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1438 * removing rows in redirect table.
1439 * @return bool True on success, false on failure
1442 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1443 // Always update redirects (target link might have changed)
1444 // Update/Insert if we don't know if the last revision was a redirect or not
1445 // Delete if changing from redirect to non-redirect
1446 $isRedirect = !is_null( $redirectTitle );
1448 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1452 if ( $isRedirect ) {
1453 $this->insertRedirectEntry( $redirectTitle );
1455 // This is not a redirect, remove row from redirect table
1456 $where = [ 'rd_from' => $this->getId() ];
1457 $dbw->delete( 'redirect', $where, __METHOD__
);
1460 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1461 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1464 return ( $dbw->affectedRows() != 0 );
1468 * If the given revision is newer than the currently set page_latest,
1469 * update the page record. Otherwise, do nothing.
1471 * @deprecated since 1.24, use updateRevisionOn instead
1473 * @param IDatabase $dbw
1474 * @param Revision $revision
1477 public function updateIfNewerOn( $dbw, $revision ) {
1478 $row = $dbw->selectRow(
1479 [ 'revision', 'page' ],
1480 [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1482 'page_id' => $this->getId(),
1483 'page_latest=rev_id' ],
1487 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1490 $prev = $row->rev_id
;
1491 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1493 // No or missing previous revision; mark the page as new
1495 $lastRevIsRedirect = null;
1498 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1504 * Helper method for checking whether two revisions have differences that go
1505 * beyond the main slot.
1507 * MCR migration note: this method should go away!
1509 * @deprecated Use only as a stop-gap before refactoring to support MCR.
1511 * @param Revision $a
1512 * @param Revision $b
1515 public static function hasDifferencesOutsideMainSlot( Revision
$a, Revision
$b ) {
1516 $aSlots = $a->getRevisionRecord()->getSlots();
1517 $bSlots = $b->getRevisionRecord()->getSlots();
1518 $changedRoles = $aSlots->getRolesWithDifferentContent( $bSlots );
1520 return ( $changedRoles !== [ SlotRecord
::MAIN
] && $changedRoles !== [] );
1524 * Get the content that needs to be saved in order to undo all revisions
1525 * between $undo and $undoafter. Revisions must belong to the same page,
1526 * must exist and must not be deleted
1528 * @param Revision $undo
1529 * @param Revision $undoafter Must be an earlier revision than $undo
1530 * @return Content|bool Content on success, false on failure
1532 * Before we had the Content object, this was done in getUndoText
1534 public function getUndoContent( Revision
$undo, Revision
$undoafter ) {
1535 // TODO: MCR: replace this with a method that returns a RevisionSlotsUpdate
1537 if ( self
::hasDifferencesOutsideMainSlot( $undo, $undoafter ) ) {
1538 // Cannot yet undo edits that involve anything other the main slot.
1542 $handler = $undo->getContentHandler();
1543 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1547 * Returns true if this page's content model supports sections.
1551 * @todo The skin should check this and not offer section functionality if
1552 * sections are not supported.
1553 * @todo The EditPage should check this and not offer section functionality
1554 * if sections are not supported.
1556 public function supportsSections() {
1557 return $this->getContentHandler()->supportsSections();
1561 * @param string|int|null|bool $sectionId Section identifier as a number or string
1562 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1563 * or 'new' for a new section.
1564 * @param Content $sectionContent New content of the section.
1565 * @param string $sectionTitle New section's subject, only if $section is "new".
1566 * @param string $edittime Revision timestamp or null to use the current revision.
1568 * @throws MWException
1569 * @return Content|null New complete article content, or null if error.
1572 * @deprecated since 1.24, use replaceSectionAtRev instead
1574 public function replaceSectionContent(
1575 $sectionId, Content
$sectionContent, $sectionTitle = '', $edittime = null
1578 if ( $edittime && $sectionId !== 'new' ) {
1579 $lb = $this->getDBLoadBalancer();
1580 $dbr = $lb->getConnection( DB_REPLICA
);
1581 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1582 // Try the master if this thread may have just added it.
1583 // This could be abstracted into a Revision method, but we don't want
1584 // to encourage loading of revisions by timestamp.
1586 && $lb->getServerCount() > 1
1587 && $lb->hasOrMadeRecentMasterChanges()
1589 $dbw = $lb->getConnection( DB_MASTER
);
1590 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1593 $baseRevId = $rev->getId();
1597 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1601 * @param string|int|null|bool $sectionId Section identifier as a number or string
1602 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1603 * or 'new' for a new section.
1604 * @param Content $sectionContent New content of the section.
1605 * @param string $sectionTitle New section's subject, only if $section is "new".
1606 * @param int|null $baseRevId
1608 * @throws MWException
1609 * @return Content|null New complete article content, or null if error.
1613 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1614 $sectionTitle = '', $baseRevId = null
1616 if ( strval( $sectionId ) === '' ) {
1617 // Whole-page edit; let the whole text through
1618 $newContent = $sectionContent;
1620 if ( !$this->supportsSections() ) {
1621 throw new MWException( "sections not supported for content model " .
1622 $this->getContentHandler()->getModelID() );
1625 // T32711: always use current version when adding a new section
1626 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1627 $oldContent = $this->getContent();
1629 $rev = Revision
::newFromId( $baseRevId );
1631 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1632 $this->getId() . "; section: $sectionId)\n" );
1636 $oldContent = $rev->getContent();
1639 if ( !$oldContent ) {
1640 wfDebug( __METHOD__
. ": no page text\n" );
1644 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1651 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1653 * @deprecated since 1.32, use exists() instead, or simply omit the EDIT_UPDATE
1654 * and EDIT_NEW flags. To protect against race conditions, use PageUpdater::grabParentRevision.
1657 * @return int Updated $flags
1659 public function checkFlags( $flags ) {
1660 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1661 if ( $this->exists() ) {
1662 $flags |
= EDIT_UPDATE
;
1672 * @return DerivedPageDataUpdater
1674 private function newDerivedDataUpdater() {
1675 global $wgRCWatchCategoryMembership, $wgArticleCountMethod;
1677 $derivedDataUpdater = new DerivedPageDataUpdater(
1678 $this, // NOTE: eventually, PageUpdater should not know about WikiPage
1679 $this->getRevisionStore(),
1680 $this->getRevisionRenderer(),
1681 $this->getSlotRoleRegistry(),
1682 $this->getParserCache(),
1683 JobQueueGroup
::singleton(),
1684 MessageCache
::singleton(),
1685 MediaWikiServices
::getInstance()->getContentLanguage(),
1686 MediaWikiServices
::getInstance()->getDBLoadBalancerFactory()
1689 $derivedDataUpdater->setRcWatchCategoryMembership( $wgRCWatchCategoryMembership );
1690 $derivedDataUpdater->setArticleCountMethod( $wgArticleCountMethod );
1692 return $derivedDataUpdater;
1696 * Returns a DerivedPageDataUpdater for use with the given target revision or new content.
1697 * This method attempts to re-use the same DerivedPageDataUpdater instance for subsequent calls.
1698 * The parameters passed to this method are used to ensure that the DerivedPageDataUpdater
1699 * returned matches that caller's expectations, allowing an existing instance to be re-used
1700 * if the given parameters match that instance's internal state according to
1701 * DerivedPageDataUpdater::isReusableFor(), and creating a new instance of the parameters do not
1702 * match the existign one.
1704 * If neither $forRevision nor $forUpdate is given, a new DerivedPageDataUpdater is always
1705 * created, replacing any DerivedPageDataUpdater currently cached.
1707 * MCR migration note: this replaces WikiPage::prepareContentForEdit.
1711 * @param User|null $forUser The user that will be used for, or was used for, PST.
1712 * @param RevisionRecord|null $forRevision The revision created by the edit for which
1713 * to perform updates, if the edit was already saved.
1714 * @param RevisionSlotsUpdate|null $forUpdate The new content to be saved by the edit (pre PST),
1715 * if the edit was not yet saved.
1716 * @param bool $forEdit Only re-use if the cached DerivedPageDataUpdater has the current
1717 * revision as the edit's parent revision. This ensures that the same
1718 * DerivedPageDataUpdater cannot be re-used for two consecutive edits.
1720 * @return DerivedPageDataUpdater
1722 private function getDerivedDataUpdater(
1723 User
$forUser = null,
1724 RevisionRecord
$forRevision = null,
1725 RevisionSlotsUpdate
$forUpdate = null,
1728 if ( !$forRevision && !$forUpdate ) {
1729 // NOTE: can't re-use an existing derivedDataUpdater if we don't know what the caller is
1730 // going to use it with.
1731 $this->derivedDataUpdater
= null;
1734 if ( $this->derivedDataUpdater
&& !$this->derivedDataUpdater
->isContentPrepared() ) {
1735 // NOTE: can't re-use an existing derivedDataUpdater if other code that has a reference
1736 // to it did not yet initialize it, because we don't know what data it will be
1737 // initialized with.
1738 $this->derivedDataUpdater
= null;
1741 // XXX: It would be nice to have an LRU cache instead of trying to re-use a single instance.
1742 // However, there is no good way to construct a cache key. We'd need to check against all
1743 // cached instances.
1745 if ( $this->derivedDataUpdater
1746 && !$this->derivedDataUpdater
->isReusableFor(
1750 $forEdit ?
$this->getLatest() : null
1753 $this->derivedDataUpdater
= null;
1756 if ( !$this->derivedDataUpdater
) {
1757 $this->derivedDataUpdater
= $this->newDerivedDataUpdater();
1760 return $this->derivedDataUpdater
;
1764 * Returns a PageUpdater for creating new revisions on this page (or creating the page).
1766 * The PageUpdater can also be used to detect the need for edit conflict resolution,
1767 * and to protected such conflict resolution from concurrent edits using a check-and-set
1773 * @param RevisionSlotsUpdate|null $forUpdate If given, allows any cached ParserOutput
1774 * that may already have been returned via getDerivedDataUpdater to be re-used.
1776 * @return PageUpdater
1778 public function newPageUpdater( User
$user, RevisionSlotsUpdate
$forUpdate = null ) {
1779 global $wgAjaxEditStash, $wgUseAutomaticEditSummaries, $wgPageCreationLog;
1781 $pageUpdater = new PageUpdater(
1783 $this, // NOTE: eventually, PageUpdater should not know about WikiPage
1784 $this->getDerivedDataUpdater( $user, null, $forUpdate, true ),
1785 $this->getDBLoadBalancer(),
1786 $this->getRevisionStore(),
1787 $this->getSlotRoleRegistry()
1790 $pageUpdater->setUsePageCreationLog( $wgPageCreationLog );
1791 $pageUpdater->setAjaxEditStash( $wgAjaxEditStash );
1792 $pageUpdater->setUseAutomaticEditSummaries( $wgUseAutomaticEditSummaries );
1794 return $pageUpdater;
1798 * Change an existing article or create a new article. Updates RC and all necessary caches,
1799 * optionally via the deferred update array.
1801 * @deprecated since 1.32, use PageUpdater::saveRevision instead. Note that the new method
1802 * expects callers to take care of checking EDIT_MINOR against the minoredit right, and to
1803 * apply the autopatrol right as appropriate.
1805 * @param Content $content New content
1806 * @param string|CommentStoreComment $summary Edit summary
1807 * @param int $flags Bitfield:
1809 * Article is known or assumed to be non-existent, create a new one
1811 * Article is known or assumed to be pre-existing, update it
1813 * Mark this edit minor, if the user is allowed to do so
1815 * Do not log the change in recentchanges
1817 * Mark the edit a "bot" edit regardless of user rights
1819 * Fill in blank summaries with generated text where possible
1821 * Signal that the page retrieve/save cycle happened entirely in this request.
1823 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1824 * article will be detected. If EDIT_UPDATE is specified and the article
1825 * doesn't exist, the function will return an edit-gone-missing error. If
1826 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1827 * error will be returned. These two conditions are also possible with
1828 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1830 * @param bool|int $originalRevId: The ID of an original revision that the edit
1831 * restores or repeats. The new revision is expected to have the exact same content as
1832 * the given original revision. This is used with rollbacks and with dummy "null" revisions
1833 * which are created to record things like page moves.
1834 * @param User|null $user The user doing the edit
1835 * @param string|null $serialFormat IGNORED.
1836 * @param array|null $tags Change tags to apply to this edit
1837 * Callers are responsible for permission checks
1838 * (with ChangeTags::canAddTagsAccompanyingChange)
1839 * @param Int $undidRevId Id of revision that was undone or 0
1841 * @throws MWException
1842 * @return Status Possible errors:
1843 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1844 * set the fatal flag of $status.
1845 * edit-gone-missing: In update mode, but the article didn't exist.
1846 * edit-conflict: In update mode, the article changed unexpectedly.
1847 * edit-no-change: Warning that the text was the same as before.
1848 * edit-already-exists: In creation mode, but the article already exists.
1850 * Extensions may define additional errors.
1852 * $return->value will contain an associative array with members as follows:
1853 * new: Boolean indicating if the function attempted to create a new article.
1854 * revision: The revision object for the inserted revision, or null.
1857 * @throws MWException
1859 public function doEditContent(
1860 Content
$content, $summary, $flags = 0, $originalRevId = false,
1861 User
$user = null, $serialFormat = null, $tags = [], $undidRevId = 0
1863 global $wgUser, $wgUseNPPatrol, $wgUseRCPatrol;
1865 if ( !( $summary instanceof CommentStoreComment
) ) {
1866 $summary = CommentStoreComment
::newUnsavedComment( trim( $summary ) );
1873 // TODO: this check is here for backwards-compatibility with 1.31 behavior.
1874 // Checking the minoredit right should be done in the same place the 'bot' right is
1875 // checked for the EDIT_FORCE_BOT flag, which is currently in EditPage::attemptSave.
1876 if ( ( $flags & EDIT_MINOR
) && !$user->isAllowed( 'minoredit' ) ) {
1877 $flags = ( $flags & ~EDIT_MINOR
);
1880 $slotsUpdate = new RevisionSlotsUpdate();
1881 $slotsUpdate->modifyContent( SlotRecord
::MAIN
, $content );
1883 // NOTE: while doEditContent() executes, callbacks to getDerivedDataUpdater and
1884 // prepareContentForEdit will generally use the DerivedPageDataUpdater that is also
1885 // used by this PageUpdater. However, there is no guarantee for this.
1886 $updater = $this->newPageUpdater( $user, $slotsUpdate );
1887 $updater->setContent( SlotRecord
::MAIN
, $content );
1888 $updater->setOriginalRevisionId( $originalRevId );
1889 $updater->setUndidRevisionId( $undidRevId );
1891 $needsPatrol = $wgUseRCPatrol ||
( $wgUseNPPatrol && !$this->exists() );
1893 // TODO: this logic should not be in the storage layer, it's here for compatibility
1894 // with 1.31 behavior. Applying the 'autopatrol' right should be done in the same
1895 // place the 'bot' right is handled, which is currently in EditPage::attemptSave.
1896 if ( $needsPatrol && $this->getTitle()->userCan( 'autopatrol', $user ) ) {
1897 $updater->setRcPatrolStatus( RecentChange
::PRC_AUTOPATROLLED
);
1900 $updater->addTags( $tags );
1902 $revRec = $updater->saveRevision(
1907 // $revRec will be null if the edit failed, or if no new revision was created because
1908 // the content did not change.
1910 // update cached fields
1911 // TODO: this is currently redundant to what is done in updateRevisionOn.
1912 // But updateRevisionOn() should move into PageStore, and then this will be needed.
1913 $this->setLastEdit( new Revision( $revRec ) ); // TODO: use RevisionRecord
1914 $this->mLatest
= $revRec->getId();
1917 return $updater->getStatus();
1921 * Get parser options suitable for rendering the primary article wikitext
1923 * @see ParserOptions::newCanonical
1925 * @param IContextSource|User|string $context One of the following:
1926 * - IContextSource: Use the User and the Language of the provided
1928 * - User: Use the provided User object and $wgLang for the language,
1929 * so use an IContextSource object if possible.
1930 * - 'canonical': Canonical options (anonymous user with default
1931 * preferences and content language).
1932 * @return ParserOptions
1934 public function makeParserOptions( $context ) {
1935 $options = ParserOptions
::newCanonical( $context );
1937 if ( $this->getTitle()->isConversionTable() ) {
1938 // @todo ConversionTable should become a separate content model, so
1939 // we don't need special cases like this one.
1940 $options->disableContentConversion();
1947 * Prepare content which is about to be saved.
1949 * Prior to 1.30, this returned a stdClass.
1951 * @deprecated since 1.32, use getDerivedDataUpdater instead.
1953 * @param Content $content
1954 * @param Revision|RevisionRecord|int|null $revision Revision object.
1955 * For backwards compatibility, a revision ID is also accepted,
1956 * but this is deprecated.
1957 * Used with vary-revision or vary-revision-id.
1958 * @param User|null $user
1959 * @param string|null $serialFormat IGNORED
1960 * @param bool $useCache Check shared prepared edit cache
1962 * @return PreparedEdit
1966 public function prepareContentForEdit(
1970 $serialFormat = null,
1979 if ( !is_object( $revision ) ) {
1981 // This code path is deprecated, and nothing is known to
1982 // use it, so performance here shouldn't be a worry.
1983 if ( $revid !== null ) {
1984 wfDeprecated( __METHOD__
. ' with $revision = revision ID', '1.25' );
1985 $store = $this->getRevisionStore();
1986 $revision = $store->getRevisionById( $revid, Revision
::READ_LATEST
);
1990 } elseif ( $revision instanceof Revision
) {
1991 $revision = $revision->getRevisionRecord();
1994 $slots = RevisionSlotsUpdate
::newFromContent( [ SlotRecord
::MAIN
=> $content ] );
1995 $updater = $this->getDerivedDataUpdater( $user, $revision, $slots );
1997 if ( !$updater->isUpdatePrepared() ) {
1998 $updater->prepareContent( $user, $slots, $useCache );
2001 $updater->prepareUpdate(
2004 'causeAction' => 'prepare-edit',
2005 'causeAgent' => $user->getName(),
2011 return $updater->getPreparedEdit();
2015 * Do standard deferred updates after page edit.
2016 * Update links tables, site stats, search index and message cache.
2017 * Purges pages that include this page if the text was changed here.
2018 * Every 100th edit, prune the recent changes table.
2020 * @deprecated since 1.32, use PageUpdater::doUpdates instead.
2022 * @param Revision $revision
2023 * @param User $user User object that did the revision
2024 * @param array $options Array of options, following indexes are used:
2025 * - changed: bool, whether the revision changed the content (default true)
2026 * - created: bool, whether the revision created the page (default false)
2027 * - moved: bool, whether the page was moved (default false)
2028 * - restored: bool, whether the page was undeleted (default false)
2029 * - oldrevision: Revision object for the pre-update revision (default null)
2030 * - oldcountable: bool, null, or string 'no-change' (default null):
2031 * - bool: whether the page was counted as an article before that
2032 * revision, only used in changed is true and created is false
2033 * - null: if created is false, don't update the article count; if created
2034 * is true, do update the article count
2035 * - 'no-change': don't update the article count, ever
2036 * - causeAction: an arbitrary string identifying the reason for the update.
2037 * See DataUpdate::getCauseAction(). (default 'edit-page')
2038 * - causeAgent: name of the user who caused the update. See DataUpdate::getCauseAgent().
2039 * (string, defaults to the passed user)
2041 public function doEditUpdates( Revision
$revision, User
$user, array $options = [] ) {
2043 'causeAction' => 'edit-page',
2044 'causeAgent' => $user->getName(),
2047 $revision = $revision->getRevisionRecord();
2049 $updater = $this->getDerivedDataUpdater( $user, $revision );
2051 $updater->prepareUpdate( $revision, $options );
2053 $updater->doUpdates();
2057 * Update the parser cache.
2059 * @note This is a temporary workaround until there is a proper data updater class.
2060 * It will become deprecated soon.
2062 * @param array $options
2063 * - causeAction: an arbitrary string identifying the reason for the update.
2064 * See DataUpdate::getCauseAction(). (default 'edit-page')
2065 * - causeAgent: name of the user who caused the update (string, defaults to the
2066 * user who created the revision)
2069 public function updateParserCache( array $options = [] ) {
2070 $revision = $this->getRevisionRecord();
2071 if ( !$revision ||
!$revision->getId() ) {
2072 LoggerFactory
::getInstance( 'wikipage' )->info(
2073 __METHOD__
. 'called with ' . ( $revision ?
'unsaved' : 'no' ) . ' revision'
2077 $user = User
::newFromIdentity( $revision->getUser( RevisionRecord
::RAW
) );
2079 $updater = $this->getDerivedDataUpdater( $user, $revision );
2080 $updater->prepareUpdate( $revision, $options );
2081 $updater->doParserCacheUpdate();
2085 * Do secondary data updates (such as updating link tables).
2086 * Secondary data updates are only a small part of the updates needed after saving
2087 * a new revision; normally PageUpdater::doUpdates should be used instead (which includes
2088 * secondary data updates). This method is provided for partial purges.
2090 * @note This is a temporary workaround until there is a proper data updater class.
2091 * It will become deprecated soon.
2093 * @param array $options
2094 * - recursive (bool, default true): whether to do a recursive update (update pages that
2095 * depend on this page, e.g. transclude it). This will set the $recursive parameter of
2096 * Content::getSecondaryDataUpdates. Typically this should be true unless the update
2097 * was something that did not really change the page, such as a null edit.
2098 * - triggeringUser: The user triggering the update (UserIdentity, defaults to the
2099 * user who created the revision)
2100 * - causeAction: an arbitrary string identifying the reason for the update.
2101 * See DataUpdate::getCauseAction(). (default 'unknown')
2102 * - causeAgent: name of the user who caused the update (string, default 'unknown')
2103 * - defer: one of the DeferredUpdates constants, or false to run immediately (default: false).
2104 * Note that even when this is set to false, some updates might still get deferred (as
2105 * some update might directly add child updates to DeferredUpdates).
2106 * - transactionTicket: a transaction ticket from LBFactory::getEmptyTransactionTicket(),
2107 * only when defer is false (default: null)
2110 public function doSecondaryDataUpdates( array $options = [] ) {
2111 $options['recursive'] = $options['recursive'] ??
true;
2112 $revision = $this->getRevisionRecord();
2113 if ( !$revision ||
!$revision->getId() ) {
2114 LoggerFactory
::getInstance( 'wikipage' )->info(
2115 __METHOD__
. 'called with ' . ( $revision ?
'unsaved' : 'no' ) . ' revision'
2119 $user = User
::newFromIdentity( $revision->getUser( RevisionRecord
::RAW
) );
2121 $updater = $this->getDerivedDataUpdater( $user, $revision );
2122 $updater->prepareUpdate( $revision, $options );
2123 $updater->doSecondaryDataUpdates( $options );
2127 * Update the article's restriction field, and leave a log entry.
2128 * This works for protection both existing and non-existing pages.
2130 * @param array $limit Set of restriction keys
2131 * @param array $expiry Per restriction type expiration
2132 * @param int &$cascade Set to false if cascading protection isn't allowed.
2133 * @param string $reason
2134 * @param User $user The user updating the restrictions
2135 * @param string|string[]|null $tags Change tags to add to the pages and protection log entries
2136 * ($user should be able to add the specified tags before this is called)
2137 * @return Status Status object; if action is taken, $status->value is the log_id of the
2138 * protection log entry.
2140 public function doUpdateRestrictions( array $limit, array $expiry,
2141 &$cascade, $reason, User
$user, $tags = null
2143 global $wgCascadingRestrictionLevels;
2145 if ( wfReadOnly() ) {
2146 return Status
::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
2149 $this->loadPageData( 'fromdbmaster' );
2150 $this->mTitle
->loadRestrictions( null, Title
::READ_LATEST
);
2151 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2152 $id = $this->getId();
2158 // Take this opportunity to purge out expired restrictions
2159 Title
::purgeExpiredRestrictions();
2161 // @todo: Same limitations as described in ProtectionForm.php (line 37);
2162 // we expect a single selection, but the schema allows otherwise.
2163 $isProtected = false;
2167 $dbw = wfGetDB( DB_MASTER
);
2169 foreach ( $restrictionTypes as $action ) {
2170 if ( !isset( $expiry[$action] ) ||
$expiry[$action] === $dbw->getInfinity() ) {
2171 $expiry[$action] = 'infinity';
2173 if ( !isset( $limit[$action] ) ) {
2174 $limit[$action] = '';
2175 } elseif ( $limit[$action] != '' ) {
2179 // Get current restrictions on $action
2180 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2181 if ( $current != '' ) {
2182 $isProtected = true;
2185 if ( $limit[$action] != $current ) {
2187 } elseif ( $limit[$action] != '' ) {
2188 // Only check expiry change if the action is actually being
2189 // protected, since expiry does nothing on an not-protected
2191 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2197 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2201 // If nothing has changed, do nothing
2203 return Status
::newGood();
2206 if ( !$protect ) { // No protection at all means unprotection
2207 $revCommentMsg = 'unprotectedarticle-comment';
2208 $logAction = 'unprotect';
2209 } elseif ( $isProtected ) {
2210 $revCommentMsg = 'modifiedarticleprotection-comment';
2211 $logAction = 'modify';
2213 $revCommentMsg = 'protectedarticle-comment';
2214 $logAction = 'protect';
2217 $logRelationsValues = [];
2218 $logRelationsField = null;
2219 $logParamsDetails = [];
2221 // Null revision (used for change tag insertion)
2222 $nullRevision = null;
2224 if ( $id ) { // Protection of existing page
2225 // Avoid PHP 7.1 warning of passing $this by reference
2228 if ( !Hooks
::run( 'ArticleProtect', [ &$wikiPage, &$user, $limit, $reason ] ) ) {
2229 return Status
::newGood();
2232 // Only certain restrictions can cascade...
2233 $editrestriction = isset( $limit['edit'] )
2234 ?
[ $limit['edit'] ]
2235 : $this->mTitle
->getRestrictions( 'edit' );
2236 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2237 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2239 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2240 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2243 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2244 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2245 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2247 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2248 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2251 // The schema allows multiple restrictions
2252 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2256 // insert null revision to identify the page protection change as edit summary
2257 $latest = $this->getLatest();
2258 $nullRevision = $this->insertProtectNullRevision(
2267 if ( $nullRevision === null ) {
2268 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2271 $logRelationsField = 'pr_id';
2273 // Update restrictions table
2274 foreach ( $limit as $action => $restrictions ) {
2276 'page_restrictions',
2279 'pr_type' => $action
2283 if ( $restrictions != '' ) {
2284 $cascadeValue = ( $cascade && $action == 'edit' ) ?
1 : 0;
2286 'page_restrictions',
2289 'pr_type' => $action,
2290 'pr_level' => $restrictions,
2291 'pr_cascade' => $cascadeValue,
2292 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2296 $logRelationsValues[] = $dbw->insertId();
2297 $logParamsDetails[] = [
2299 'level' => $restrictions,
2300 'expiry' => $expiry[$action],
2301 'cascade' => (bool)$cascadeValue,
2306 // Clear out legacy restriction fields
2309 [ 'page_restrictions' => '' ],
2310 [ 'page_id' => $id ],
2314 // Avoid PHP 7.1 warning of passing $this by reference
2317 Hooks
::run( 'NewRevisionFromEditComplete',
2318 [ $this, $nullRevision, $latest, $user ] );
2319 Hooks
::run( 'ArticleProtectComplete', [ &$wikiPage, &$user, $limit, $reason ] );
2320 } else { // Protection of non-existing page (also known as "title protection")
2321 // Cascade protection is meaningless in this case
2324 if ( $limit['create'] != '' ) {
2325 $commentFields = CommentStore
::getStore()->insert( $dbw, 'pt_reason', $reason );
2326 $dbw->replace( 'protected_titles',
2327 [ [ 'pt_namespace', 'pt_title' ] ],
2329 'pt_namespace' => $this->mTitle
->getNamespace(),
2330 'pt_title' => $this->mTitle
->getDBkey(),
2331 'pt_create_perm' => $limit['create'],
2332 'pt_timestamp' => $dbw->timestamp(),
2333 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2334 'pt_user' => $user->getId(),
2335 ] +
$commentFields, __METHOD__
2337 $logParamsDetails[] = [
2339 'level' => $limit['create'],
2340 'expiry' => $expiry['create'],
2343 $dbw->delete( 'protected_titles',
2345 'pt_namespace' => $this->mTitle
->getNamespace(),
2346 'pt_title' => $this->mTitle
->getDBkey()
2352 $this->mTitle
->flushRestrictions();
2353 InfoAction
::invalidateCache( $this->mTitle
);
2355 if ( $logAction == 'unprotect' ) {
2358 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2360 '4::description' => $protectDescriptionLog, // parameter for IRC
2361 '5:bool:cascade' => $cascade,
2362 'details' => $logParamsDetails, // parameter for localize and api
2366 // Update the protection log
2367 $logEntry = new ManualLogEntry( 'protect', $logAction );
2368 $logEntry->setTarget( $this->mTitle
);
2369 $logEntry->setComment( $reason );
2370 $logEntry->setPerformer( $user );
2371 $logEntry->setParameters( $params );
2372 if ( !is_null( $nullRevision ) ) {
2373 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2375 $logEntry->setTags( $tags );
2376 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2377 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2379 $logId = $logEntry->insert();
2380 $logEntry->publish( $logId );
2382 return Status
::newGood( $logId );
2386 * Insert a new null revision for this page.
2388 * @param string $revCommentMsg Comment message key for the revision
2389 * @param array $limit Set of restriction keys
2390 * @param array $expiry Per restriction type expiration
2391 * @param int $cascade Set to false if cascading protection isn't allowed.
2392 * @param string $reason
2393 * @param User|null $user
2394 * @return Revision|null Null on error
2396 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2397 array $expiry, $cascade, $reason, $user = null
2399 $dbw = wfGetDB( DB_MASTER
);
2401 // Prepare a null revision to be added to the history
2402 $editComment = wfMessage(
2404 $this->mTitle
->getPrefixedText(),
2405 $user ?
$user->getName() : ''
2406 )->inContentLanguage()->text();
2408 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2410 $protectDescription = $this->protectDescription( $limit, $expiry );
2411 if ( $protectDescription ) {
2412 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2413 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2414 ->inContentLanguage()->text();
2417 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2418 $editComment .= wfMessage( 'brackets' )->params(
2419 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2420 )->inContentLanguage()->text();
2423 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2425 $nullRev->insertOn( $dbw );
2427 // Update page record and touch page
2428 $oldLatest = $nullRev->getParentId();
2429 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2436 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2439 protected function formatExpiry( $expiry ) {
2440 if ( $expiry != 'infinity' ) {
2441 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
2444 $contLang->timeanddate( $expiry, false, false ),
2445 $contLang->date( $expiry, false, false ),
2446 $contLang->time( $expiry, false, false )
2447 )->inContentLanguage()->text();
2449 return wfMessage( 'protect-expiry-indefinite' )
2450 ->inContentLanguage()->text();
2455 * Builds the description to serve as comment for the edit.
2457 * @param array $limit Set of restriction keys
2458 * @param array $expiry Per restriction type expiration
2461 public function protectDescription( array $limit, array $expiry ) {
2462 $protectDescription = '';
2464 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2465 # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2466 # All possible message keys are listed here for easier grepping:
2467 # * restriction-create
2468 # * restriction-edit
2469 # * restriction-move
2470 # * restriction-upload
2471 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2472 # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2473 # with '' filtered out. All possible message keys are listed below:
2474 # * protect-level-autoconfirmed
2475 # * protect-level-sysop
2476 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2477 ->inContentLanguage()->text();
2479 $expiryText = $this->formatExpiry( $expiry[$action] );
2481 if ( $protectDescription !== '' ) {
2482 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2484 $protectDescription .= wfMessage( 'protect-summary-desc' )
2485 ->params( $actionText, $restrictionsText, $expiryText )
2486 ->inContentLanguage()->text();
2489 return $protectDescription;
2493 * Builds the description to serve as comment for the log entry.
2495 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2496 * protect description text. Keep them in old format to avoid breaking compatibility.
2497 * TODO: Fix protection log to store structured description and format it on-the-fly.
2499 * @param array $limit Set of restriction keys
2500 * @param array $expiry Per restriction type expiration
2503 public function protectDescriptionLog( array $limit, array $expiry ) {
2504 $protectDescriptionLog = '';
2506 $dirMark = MediaWikiServices
::getInstance()->getContentLanguage()->getDirMark();
2507 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2508 $expiryText = $this->formatExpiry( $expiry[$action] );
2509 $protectDescriptionLog .=
2511 "[$action=$restrictions] ($expiryText)";
2514 return trim( $protectDescriptionLog );
2518 * Take an array of page restrictions and flatten it to a string
2519 * suitable for insertion into the page_restrictions field.
2521 * @param string[] $limit
2523 * @throws MWException
2526 protected static function flattenRestrictions( $limit ) {
2527 if ( !is_array( $limit ) ) {
2528 throw new MWException( __METHOD__
. ' given non-array restriction set' );
2534 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2535 $bits[] = "$action=$restrictions";
2538 return implode( ':', $bits );
2542 * Determines if deletion of this page would be batched (executed over time by the job queue)
2543 * or not (completed in the same request as the delete call).
2545 * It is unlikely but possible that an edit from another request could push the page over the
2546 * batching threshold after this function is called, but before the caller acts upon the
2547 * return value. Callers must decide for themselves how to deal with this. $safetyMargin
2548 * is provided as an unreliable but situationally useful help for some common cases.
2550 * @param int $safetyMargin Added to the revision count when checking for batching
2551 * @return bool True if deletion would be batched, false otherwise
2553 public function isBatchedDelete( $safetyMargin = 0 ) {
2554 global $wgDeleteRevisionsBatchSize;
2556 $dbr = wfGetDB( DB_REPLICA
);
2557 $revCount = $this->getRevisionStore()->countRevisionsByPageId( $dbr, $this->getId() );
2558 $revCount +
= $safetyMargin;
2560 return $revCount >= $wgDeleteRevisionsBatchSize;
2564 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2565 * backwards compatibility, if you care about error reporting you should use
2566 * doDeleteArticleReal() instead.
2568 * Deletes the article with database consistency, writes logs, purges caches
2570 * @param string $reason Delete reason for deletion log
2571 * @param bool $suppress Suppress all revisions and log the deletion in
2572 * the suppression log instead of the deletion log
2573 * @param int|null $u1 Unused
2574 * @param bool|null $u2 Unused
2575 * @param array|string &$error Array of errors to append to
2576 * @param User|null $user The deleting user
2577 * @param bool $immediate false allows deleting over time via the job queue
2578 * @return bool True if successful
2579 * @throws FatalError
2580 * @throws MWException
2582 public function doDeleteArticle(
2583 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null,
2586 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user,
2587 [], 'delete', $immediate );
2589 // Returns true if the page was actually deleted, or is scheduled for deletion
2590 return $status->isOK();
2594 * Back-end article deletion
2595 * Deletes the article with database consistency, writes logs, purges caches
2599 * @param string $reason Delete reason for deletion log
2600 * @param bool $suppress Suppress all revisions and log the deletion in
2601 * the suppression log instead of the deletion log
2602 * @param int|null $u1 Unused
2603 * @param bool|null $u2 Unused
2604 * @param array|string &$error Array of errors to append to
2605 * @param User|null $deleter The deleting user
2606 * @param array $tags Tags to apply to the deletion action
2607 * @param string $logsubtype
2608 * @param bool $immediate false allows deleting over time via the job queue
2609 * @return Status Status object; if successful, $status->value is the log_id of the
2610 * deletion log entry. If the page couldn't be deleted because it wasn't
2611 * found, $status is a non-fatal 'cannotdelete' error
2612 * @throws FatalError
2613 * @throws MWException
2615 public function doDeleteArticleReal(
2616 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$deleter = null,
2617 $tags = [], $logsubtype = 'delete', $immediate = false
2621 wfDebug( __METHOD__
. "\n" );
2623 $status = Status
::newGood();
2625 // Avoid PHP 7.1 warning of passing $this by reference
2628 $deleter = is_null( $deleter ) ?
$wgUser : $deleter;
2629 if ( !Hooks
::run( 'ArticleDelete',
2630 [ &$wikiPage, &$deleter, &$reason, &$error, &$status, $suppress ]
2632 if ( $status->isOK() ) {
2633 // Hook aborted but didn't set a fatal status
2634 $status->fatal( 'delete-hook-aborted' );
2639 return $this->doDeleteArticleBatched( $reason, $suppress, $deleter, $tags,
2640 $logsubtype, $immediate );
2644 * Back-end article deletion
2646 * Only invokes batching via the job queue if necessary per $wgDeleteRevisionsBatchSize.
2647 * Deletions can often be completed inline without involving the job queue.
2649 * Potentially called many times per deletion operation for pages with many revisions.
2651 public function doDeleteArticleBatched(
2652 $reason, $suppress, User
$deleter, $tags,
2653 $logsubtype, $immediate = false, $webRequestId = null
2655 wfDebug( __METHOD__
. "\n" );
2657 $status = Status
::newGood();
2659 $dbw = wfGetDB( DB_MASTER
);
2660 $dbw->startAtomic( __METHOD__
);
2662 $this->loadPageData( self
::READ_LATEST
);
2663 $id = $this->getId();
2664 // T98706: lock the page from various other updates but avoid using
2665 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2666 // the revisions queries (which also JOIN on user). Only lock the page
2667 // row and CAS check on page_latest to see if the trx snapshot matches.
2668 $lockedLatest = $this->lockAndGetLatest();
2669 if ( $id == 0 ||
$this->getLatest() != $lockedLatest ) {
2670 $dbw->endAtomic( __METHOD__
);
2671 // Page not there or trx snapshot is stale
2672 $status->error( 'cannotdelete',
2673 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2677 // At this point we are now committed to returning an OK
2678 // status unless some DB query error or other exception comes up.
2679 // This way callers don't have to call rollback() if $status is bad
2680 // unless they actually try to catch exceptions (which is rare).
2682 // we need to remember the old content so we can use it to generate all deletion updates.
2683 $revision = $this->getRevision();
2685 $content = $this->getContent( Revision
::RAW
);
2686 } catch ( Exception
$ex ) {
2687 wfLogWarning( __METHOD__
. ': failed to load content during deletion! '
2688 . $ex->getMessage() );
2693 // Archive revisions. In immediate mode, archive all revisions. Otherwise, archive
2694 // one batch of revisions and defer archival of any others to the job queue.
2695 $explictTrxLogged = false;
2697 $done = $this->archiveRevisions( $dbw, $id, $suppress );
2698 if ( $done ||
!$immediate ) {
2701 $dbw->endAtomic( __METHOD__
);
2702 if ( $dbw->explicitTrxActive() ) {
2703 // Explict transactions may never happen here in practice. Log to be sure.
2704 if ( !$explictTrxLogged ) {
2705 $explictTrxLogged = true;
2706 LoggerFactory
::getInstance( 'wfDebug' )->debug(
2707 'explicit transaction active in ' . __METHOD__
. ' while deleting {title}', [
2708 'title' => $this->getTitle()->getText(),
2713 if ( $dbw->trxLevel() ) {
2716 $lbFactory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2717 $lbFactory->waitForReplication();
2718 $dbw->startAtomic( __METHOD__
);
2721 // If done archiving, also delete the article.
2723 $dbw->endAtomic( __METHOD__
);
2726 'wikiPageId' => $id,
2727 'requestId' => $webRequestId ?? WebRequest
::getRequestId(),
2728 'reason' => $reason,
2729 'suppress' => $suppress,
2730 'userId' => $deleter->getId(),
2731 'tags' => json_encode( $tags ),
2732 'logsubtype' => $logsubtype,
2735 $job = new DeletePageJob( $this->getTitle(), $jobParams );
2736 JobQueueGroup
::singleton()->push( $job );
2738 $status->warning( 'delete-scheduled',
2739 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2741 // Get archivedRevisionCount by db query, because there's no better alternative.
2742 // Jobs cannot pass a count of archived revisions to the next job, because additional
2743 // deletion operations can be started while the first is running. Jobs from each
2744 // gracefully interleave, but would not know about each other's count. Deduplication
2745 // in the job queue to avoid simultaneous deletion operations would add overhead.
2746 // Number of archived revisions cannot be known beforehand, because edits can be made
2747 // while deletion operations are being processed, changing the number of archivals.
2748 $archivedRevisionCount = (int)$dbw->selectField(
2749 'archive', 'COUNT(*)',
2751 'ar_namespace' => $this->getTitle()->getNamespace(),
2752 'ar_title' => $this->getTitle()->getDBkey(),
2757 // Clone the title and wikiPage, so we have the information we need when
2758 // we log and run the ArticleDeleteComplete hook.
2759 $logTitle = clone $this->mTitle
;
2760 $wikiPageBeforeDelete = clone $this;
2762 // Now that it's safely backed up, delete it
2763 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__
);
2765 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2766 $logtype = $suppress ?
'suppress' : 'delete';
2768 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2769 $logEntry->setPerformer( $deleter );
2770 $logEntry->setTarget( $logTitle );
2771 $logEntry->setComment( $reason );
2772 $logEntry->setTags( $tags );
2773 $logid = $logEntry->insert();
2775 $dbw->onTransactionPreCommitOrIdle(
2776 function () use ( $logEntry, $logid ) {
2777 // T58776: avoid deadlocks (especially from FileDeleteForm)
2778 $logEntry->publish( $logid );
2783 $dbw->endAtomic( __METHOD__
);
2785 $this->doDeleteUpdates( $id, $content, $revision, $deleter );
2787 Hooks
::run( 'ArticleDeleteComplete', [
2788 &$wikiPageBeforeDelete,
2794 $archivedRevisionCount
2796 $status->value
= $logid;
2798 // Show log excerpt on 404 pages rather than just a link
2799 $cache = MediaWikiServices
::getInstance()->getMainObjectStash();
2800 $key = $cache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2801 $cache->set( $key, 1, $cache::TTL_DAY
);
2808 * Archives revisions as part of page deletion.
2810 * @param IDatabase $dbw
2812 * @param bool $suppress Suppress all revisions and log the deletion in
2813 * the suppression log instead of the deletion log
2816 protected function archiveRevisions( $dbw, $id, $suppress ) {
2817 global $wgContentHandlerUseDB, $wgMultiContentRevisionSchemaMigrationStage,
2818 $wgCommentTableSchemaMigrationStage, $wgActorTableSchemaMigrationStage,
2819 $wgDeleteRevisionsBatchSize;
2821 // Given the lock above, we can be confident in the title and page ID values
2822 $namespace = $this->getTitle()->getNamespace();
2823 $dbKey = $this->getTitle()->getDBkey();
2825 $commentStore = CommentStore
::getStore();
2826 $actorMigration = ActorMigration
::newMigration();
2828 $revQuery = Revision
::getQueryInfo();
2831 // Bitfields to further suppress the content
2833 $bitfield = Revision
::SUPPRESSED_ALL
;
2834 $revQuery['fields'] = array_diff( $revQuery['fields'], [ 'rev_deleted' ] );
2837 // For now, shunt the revision data into the archive table.
2838 // Text is *not* removed from the text table; bulk storage
2839 // is left intact to avoid breaking block-compression or
2840 // immutable storage schemes.
2841 // In the future, we may keep revisions and mark them with
2842 // the rev_deleted field, which is reserved for this purpose.
2844 // Lock rows in `revision` and its temp tables, but not any others.
2845 // Note array_intersect() preserves keys from the first arg, and we're
2846 // assuming $revQuery has `revision` primary and isn't using subtables
2847 // for anything we care about.
2848 $dbw->lockForUpdate(
2850 $revQuery['tables'],
2851 [ 'revision', 'revision_comment_temp', 'revision_actor_temp' ]
2853 [ 'rev_page' => $id ],
2859 // If SCHEMA_COMPAT_WRITE_OLD is set, also select all extra fields we still write,
2860 // so we can copy it to the archive table.
2861 // We know the fields exist, otherwise SCHEMA_COMPAT_WRITE_OLD could not function.
2862 if ( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) {
2863 $revQuery['fields'][] = 'rev_text_id';
2865 if ( $wgContentHandlerUseDB ) {
2866 $revQuery['fields'][] = 'rev_content_model';
2867 $revQuery['fields'][] = 'rev_content_format';
2871 // Get as many of the page revisions as we are allowed to. The +1 lets us recognize the
2872 // unusual case where there were exactly $wgDeleteRevisionBatchSize revisions remaining.
2873 $res = $dbw->select(
2874 $revQuery['tables'],
2875 $revQuery['fields'],
2876 [ 'rev_page' => $id ],
2878 [ 'ORDER BY' => 'rev_timestamp ASC', 'LIMIT' => $wgDeleteRevisionsBatchSize +
1 ],
2882 // Build their equivalent archive rows
2886 /** @var int[] Revision IDs of edits that were made by IPs */
2890 foreach ( $res as $row ) {
2891 if ( count( $revids ) >= $wgDeleteRevisionsBatchSize ) {
2896 $comment = $commentStore->getComment( 'rev_comment', $row );
2897 $user = User
::newFromAnyId( $row->rev_user
, $row->rev_user_text
, $row->rev_actor
);
2899 'ar_namespace' => $namespace,
2900 'ar_title' => $dbKey,
2901 'ar_timestamp' => $row->rev_timestamp
,
2902 'ar_minor_edit' => $row->rev_minor_edit
,
2903 'ar_rev_id' => $row->rev_id
,
2904 'ar_parent_id' => $row->rev_parent_id
,
2906 * ar_text_id should probably not be written to when the multi content schema has
2907 * been migrated to (wgMultiContentRevisionSchemaMigrationStage) however there is no
2908 * default for the field in WMF production currently so we must keep writing
2909 * writing until a default of 0 is set.
2910 * Task: https://phabricator.wikimedia.org/T190148
2911 * Copying the value from the revision table should not lead to any issues for now.
2913 'ar_len' => $row->rev_len
,
2914 'ar_page_id' => $id,
2915 'ar_deleted' => $suppress ?
$bitfield : $row->rev_deleted
,
2916 'ar_sha1' => $row->rev_sha1
,
2917 ] +
$commentStore->insert( $dbw, 'ar_comment', $comment )
2918 +
$actorMigration->getInsertValues( $dbw, 'ar_user', $user );
2920 if ( $wgMultiContentRevisionSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) {
2921 $rowInsert['ar_text_id'] = $row->rev_text_id
;
2923 if ( $wgContentHandlerUseDB ) {
2924 $rowInsert['ar_content_model'] = $row->rev_content_model
;
2925 $rowInsert['ar_content_format'] = $row->rev_content_format
;
2929 $rowsInsert[] = $rowInsert;
2930 $revids[] = $row->rev_id
;
2932 // Keep track of IP edits, so that the corresponding rows can
2933 // be deleted in the ip_changes table.
2934 if ( (int)$row->rev_user
=== 0 && IP
::isValid( $row->rev_user_text
) ) {
2935 $ipRevIds[] = $row->rev_id
;
2939 // This conditional is just a sanity check
2940 if ( count( $revids ) > 0 ) {
2941 // Copy them into the archive table
2942 $dbw->insert( 'archive', $rowsInsert, __METHOD__
);
2944 $dbw->delete( 'revision', [ 'rev_id' => $revids ], __METHOD__
);
2945 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
2946 $dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__
);
2948 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
2949 $dbw->delete( 'revision_actor_temp', [ 'revactor_rev' => $revids ], __METHOD__
);
2952 // Also delete records from ip_changes as applicable.
2953 if ( count( $ipRevIds ) > 0 ) {
2954 $dbw->delete( 'ip_changes', [ 'ipc_rev_id' => $ipRevIds ], __METHOD__
);
2962 * Lock the page row for this title+id and return page_latest (or 0)
2964 * @return int Returns 0 if no row was found with this title+id
2967 public function lockAndGetLatest() {
2968 return (int)wfGetDB( DB_MASTER
)->selectField(
2972 'page_id' => $this->getId(),
2973 // Typically page_id is enough, but some code might try to do
2974 // updates assuming the title is the same, so verify that
2975 'page_namespace' => $this->getTitle()->getNamespace(),
2976 'page_title' => $this->getTitle()->getDBkey()
2984 * Do some database updates after deletion
2986 * @param int $id The page_id value of the page being deleted
2987 * @param Content|null $content Page content to be used when determining
2988 * the required updates. This may be needed because $this->getContent()
2989 * may already return null when the page proper was deleted.
2990 * @param RevisionRecord|Revision|null $revision The current page revision at the time of
2991 * deletion, used when determining the required updates. This may be needed because
2992 * $this->getRevision() may already return null when the page proper was deleted.
2993 * @param User|null $user The user that caused the deletion
2995 public function doDeleteUpdates(
2996 $id, Content
$content = null, Revision
$revision = null, User
$user = null
2998 if ( $id !== $this->getId() ) {
2999 throw new InvalidArgumentException( 'Mismatching page ID' );
3003 $countable = $this->isCountable();
3004 } catch ( Exception
$ex ) {
3005 // fallback for deleting broken pages for which we cannot load the content for
3006 // some reason. Note that doDeleteArticleReal() already logged this problem.
3010 // Update site status
3011 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory(
3012 [ 'edits' => 1, 'articles' => -$countable, 'pages' => -1 ]
3015 // Delete pagelinks, update secondary indexes, etc
3016 $updates = $this->getDeletionUpdates(
3017 $revision ?
$revision->getRevisionRecord() : $content
3019 foreach ( $updates as $update ) {
3020 DeferredUpdates
::addUpdate( $update );
3023 $causeAgent = $user ?
$user->getName() : 'unknown';
3024 // Reparse any pages transcluding this page
3025 LinksUpdate
::queueRecursiveJobsForTable(
3026 $this->mTitle
, 'templatelinks', 'delete-page', $causeAgent );
3027 // Reparse any pages including this image
3028 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
3029 LinksUpdate
::queueRecursiveJobsForTable(
3030 $this->mTitle
, 'imagelinks', 'delete-page', $causeAgent );
3034 self
::onArticleDelete( $this->mTitle
);
3035 ResourceLoaderWikiModule
::invalidateModuleCache(
3036 $this->mTitle
, $revision, null, wfWikiID()
3039 // Reset this object and the Title object
3040 $this->loadFromRow( false, self
::READ_LATEST
);
3043 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
3047 * Roll back the most recent consecutive set of edits to a page
3048 * from the same user; fails if there are no eligible edits to
3049 * roll back to, e.g. user is the sole contributor. This function
3050 * performs permissions checks on $user, then calls commitRollback()
3051 * to do the dirty work
3053 * @todo Separate the business/permission stuff out from backend code
3054 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3056 * @param string $fromP Name of the user whose edits to rollback.
3057 * @param string $summary Custom summary. Set to default summary if empty.
3058 * @param string $token Rollback token.
3059 * @param bool $bot If true, mark all reverted edits as bot.
3061 * @param array &$resultDetails Array contains result-specific array of additional values
3062 * 'alreadyrolled' : 'current' (rev)
3063 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3065 * @param User $user The user performing the rollback
3066 * @param array|null $tags Change tags to apply to the rollback
3067 * Callers are responsible for permission checks
3068 * (with ChangeTags::canAddTagsAccompanyingChange)
3070 * @return array Array of errors, each error formatted as
3071 * array(messagekey, param1, param2, ...).
3072 * On success, the array is empty. This array can also be passed to
3073 * OutputPage::showPermissionsErrorPage().
3075 public function doRollback(
3076 $fromP, $summary, $token, $bot, &$resultDetails, User
$user, $tags = null
3078 $resultDetails = null;
3080 // Check permissions
3081 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
3082 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
3083 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3085 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3086 $errors[] = [ 'sessionfailure' ];
3089 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
3090 $errors[] = [ 'actionthrottledtext' ];
3093 // If there were errors, bail out now
3094 if ( !empty( $errors ) ) {
3098 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3102 * Backend implementation of doRollback(), please refer there for parameter
3103 * and return value documentation
3105 * NOTE: This function does NOT check ANY permissions, it just commits the
3106 * rollback to the DB. Therefore, you should only call this function direct-
3107 * ly if you want to use custom permissions checks. If you don't, use
3108 * doRollback() instead.
3109 * @param string $fromP Name of the user whose edits to rollback.
3110 * @param string $summary Custom summary. Set to default summary if empty.
3111 * @param bool $bot If true, mark all reverted edits as bot.
3113 * @param array &$resultDetails Contains result-specific array of additional values
3114 * @param User $guser The user performing the rollback
3115 * @param array|null $tags Change tags to apply to the rollback
3116 * Callers are responsible for permission checks
3117 * (with ChangeTags::canAddTagsAccompanyingChange)
3119 * @return array An array of error messages, as returned by Status::getErrorsArray()
3121 public function commitRollback( $fromP, $summary, $bot,
3122 &$resultDetails, User
$guser, $tags = null
3124 global $wgUseRCPatrol;
3126 $dbw = wfGetDB( DB_MASTER
);
3128 if ( wfReadOnly() ) {
3129 return [ [ 'readonlytext' ] ];
3132 // Begin revision creation cycle by creating a PageUpdater.
3133 // If the page is changed concurrently after grabParentRevision(), the rollback will fail.
3134 $updater = $this->newPageUpdater( $guser );
3135 $current = $updater->grabParentRevision();
3137 if ( is_null( $current ) ) {
3138 // Something wrong... no page?
3139 return [ [ 'notanarticle' ] ];
3142 $currentEditorForPublic = $current->getUser( RevisionRecord
::FOR_PUBLIC
);
3143 $legacyCurrent = new Revision( $current );
3144 $from = str_replace( '_', ' ', $fromP );
3146 // User name given should match up with the top revision.
3147 // If the revision's user is not visible, then $from should be empty.
3148 if ( $from !== ( $currentEditorForPublic ?
$currentEditorForPublic->getName() : '' ) ) {
3149 $resultDetails = [ 'current' => $legacyCurrent ];
3150 return [ [ 'alreadyrolled',
3151 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3152 htmlspecialchars( $fromP ),
3153 htmlspecialchars( $currentEditorForPublic ?
$currentEditorForPublic->getName() : '' )
3157 // Get the last edit not by this person...
3158 // Note: these may not be public values
3159 $actorWhere = ActorMigration
::newMigration()->getWhere(
3162 $current->getUser( RevisionRecord
::RAW
)
3165 $s = $dbw->selectRow(
3166 [ 'revision' ] +
$actorWhere['tables'],
3167 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3169 'rev_page' => $current->getPageId(),
3170 'NOT(' . $actorWhere['conds'] . ')',
3174 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
3175 'ORDER BY' => 'rev_timestamp DESC'
3177 $actorWhere['joins']
3179 if ( $s === false ) {
3180 // No one else ever edited this page
3181 return [ [ 'cantrollback' ] ];
3182 } elseif ( $s->rev_deleted
& RevisionRecord
::DELETED_TEXT
3183 ||
$s->rev_deleted
& RevisionRecord
::DELETED_USER
3185 // Only admins can see this text
3186 return [ [ 'notvisiblerev' ] ];
3189 // Generate the edit summary if necessary
3190 $target = $this->getRevisionStore()->getRevisionById(
3192 RevisionStore
::READ_LATEST
3194 if ( empty( $summary ) ) {
3195 if ( !$currentEditorForPublic ) { // no public user name
3196 $summary = wfMessage( 'revertpage-nouser' );
3198 $summary = wfMessage( 'revertpage' );
3201 $legacyTarget = new Revision( $target );
3202 $targetEditorForPublic = $target->getUser( RevisionRecord
::FOR_PUBLIC
);
3204 // Allow the custom summary to use the same args as the default message
3205 $contLang = MediaWikiServices
::getInstance()->getContentLanguage();
3207 $targetEditorForPublic ?
$targetEditorForPublic->getName() : null,
3208 $currentEditorForPublic ?
$currentEditorForPublic->getName() : null,
3210 $contLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3212 $contLang->timeanddate( $current->getTimestamp() )
3214 if ( $summary instanceof Message
) {
3215 $summary = $summary->params( $args )->inContentLanguage()->text();
3217 $summary = wfMsgReplaceArgs( $summary, $args );
3220 // Trim spaces on user supplied text
3221 $summary = trim( $summary );
3224 $flags = EDIT_UPDATE | EDIT_INTERNAL
;
3226 if ( $guser->isAllowed( 'minoredit' ) ) {
3227 $flags |
= EDIT_MINOR
;
3230 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3231 $flags |
= EDIT_FORCE_BOT
;
3234 // TODO: MCR: also log model changes in other slots, in case that becomes possible!
3235 $currentContent = $current->getContent( SlotRecord
::MAIN
);
3236 $targetContent = $target->getContent( SlotRecord
::MAIN
);
3237 $changingContentModel = $targetContent->getModel() !== $currentContent->getModel();
3239 if ( in_array( 'mw-rollback', ChangeTags
::getSoftwareTags() ) ) {
3240 $tags[] = 'mw-rollback';
3243 // Build rollback revision:
3244 // Restore old content
3245 // TODO: MCR: test this once we can store multiple slots
3246 foreach ( $target->getSlots()->getSlots() as $slot ) {
3247 $updater->inheritSlot( $slot );
3250 // Remove extra slots
3251 // TODO: MCR: test this once we can store multiple slots
3252 foreach ( $current->getSlotRoles() as $role ) {
3253 if ( !$target->hasSlot( $role ) ) {
3254 $updater->removeSlot( $role );
3258 $updater->setOriginalRevisionId( $target->getId() );
3259 // Do not call setUndidRevisionId(), that causes an extra "mw-undo" tag to be added (T190374)
3260 $updater->addTags( $tags );
3262 // TODO: this logic should not be in the storage layer, it's here for compatibility
3263 // with 1.31 behavior. Applying the 'autopatrol' right should be done in the same
3264 // place the 'bot' right is handled, which is currently in EditPage::attemptSave.
3265 if ( $wgUseRCPatrol && $this->getTitle()->userCan( 'autopatrol', $guser ) ) {
3266 $updater->setRcPatrolStatus( RecentChange
::PRC_AUTOPATROLLED
);
3269 // Actually store the rollback
3270 $rev = $updater->saveRevision(
3271 CommentStoreComment
::newUnsavedComment( $summary ),
3275 // Set patrolling and bot flag on the edits, which gets rollbacked.
3276 // This is done even on edit failure to have patrolling in that case (T64157).
3278 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3279 // Mark all reverted edits as bot
3283 if ( $wgUseRCPatrol ) {
3284 // Mark all reverted edits as patrolled
3285 $set['rc_patrolled'] = RecentChange
::PRC_PATROLLED
;
3288 if ( count( $set ) ) {
3289 $actorWhere = ActorMigration
::newMigration()->getWhere(
3292 $current->getUser( RevisionRecord
::RAW
),
3295 $dbw->update( 'recentchanges', $set,
3297 'rc_cur_id' => $current->getPageId(),
3298 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3299 $actorWhere['conds'], // No tables/joins are needed for rc_user
3305 if ( !$updater->wasSuccessful() ) {
3306 return $updater->getStatus()->getErrorsArray();
3309 // Report if the edit was not created because it did not change the content.
3310 if ( $updater->isUnchanged() ) {
3311 $resultDetails = [ 'current' => $legacyCurrent ];
3312 return [ [ 'alreadyrolled',
3313 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3314 htmlspecialchars( $fromP ),
3315 htmlspecialchars( $targetEditorForPublic ?
$targetEditorForPublic->getName() : '' )
3319 if ( $changingContentModel ) {
3320 // If the content model changed during the rollback,
3321 // make sure it gets logged to Special:Log/contentmodel
3322 $log = new ManualLogEntry( 'contentmodel', 'change' );
3323 $log->setPerformer( $guser );
3324 $log->setTarget( $this->mTitle
);
3325 $log->setComment( $summary );
3326 $log->setParameters( [
3327 '4::oldmodel' => $currentContent->getModel(),
3328 '5::newmodel' => $targetContent->getModel(),
3331 $logId = $log->insert( $dbw );
3332 $log->publish( $logId );
3335 $revId = $rev->getId();
3337 Hooks
::run( 'ArticleRollbackComplete', [ $this, $guser, $legacyTarget, $legacyCurrent ] );
3340 'summary' => $summary,
3341 'current' => $legacyCurrent,
3342 'target' => $legacyTarget,
3347 // TODO: make this return a Status object and wrap $resultDetails in that.
3352 * The onArticle*() functions are supposed to be a kind of hooks
3353 * which should be called whenever any of the specified actions
3356 * This is a good place to put code to clear caches, for instance.
3358 * This is called on page move and undelete, as well as edit
3360 * @param Title $title
3362 public static function onArticleCreate( Title
$title ) {
3363 // TODO: move this into a PageEventEmitter service
3365 // Update existence markers on article/talk tabs...
3366 $other = $title->getOtherPage();
3368 $other->purgeSquid();
3370 $title->touchLinks();
3371 $title->purgeSquid();
3372 $title->deleteTitleProtection();
3374 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3376 // Invalidate caches of articles which include this page
3377 DeferredUpdates
::addUpdate(
3378 new HTMLCacheUpdate( $title, 'templatelinks', 'page-create' )
3381 if ( $title->getNamespace() == NS_CATEGORY
) {
3382 // Load the Category object, which will schedule a job to create
3383 // the category table row if necessary. Checking a replica DB is ok
3384 // here, in the worst case it'll run an unnecessary recount job on
3385 // a category that probably doesn't have many members.
3386 Category
::newFromTitle( $title )->getID();
3391 * Clears caches when article is deleted
3393 * @param Title $title
3395 public static function onArticleDelete( Title
$title ) {
3396 // TODO: move this into a PageEventEmitter service
3398 // Update existence markers on article/talk tabs...
3399 // Clear Backlink cache first so that purge jobs use more up-to-date backlink information
3400 BacklinkCache
::get( $title )->clear();
3401 $other = $title->getOtherPage();
3403 $other->purgeSquid();
3405 $title->touchLinks();
3406 $title->purgeSquid();
3408 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3411 HTMLFileCache
::clearFileCache( $title );
3412 InfoAction
::invalidateCache( $title );
3415 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3416 MessageCache
::singleton()->updateMessageOverride( $title, null );
3420 if ( $title->getNamespace() == NS_FILE
) {
3421 DeferredUpdates
::addUpdate(
3422 new HTMLCacheUpdate( $title, 'imagelinks', 'page-delete' )
3427 if ( $title->getNamespace() == NS_USER_TALK
) {
3428 $user = User
::newFromName( $title->getText(), false );
3430 $user->setNewtalk( false );
3435 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3437 // Purge cross-wiki cache entities referencing this page
3438 self
::purgeInterwikiCheckKey( $title );
3442 * Purge caches on page update etc
3444 * @param Title $title
3445 * @param Revision|null $revision Revision that was just saved, may be null
3446 * @param string[]|null $slotsChanged The role names of the slots that were changed.
3447 * If not given, all slots are assumed to have changed.
3449 public static function onArticleEdit(
3451 Revision
$revision = null,
3452 $slotsChanged = null
3454 // TODO: move this into a PageEventEmitter service
3456 if ( $slotsChanged === null ||
in_array( SlotRecord
::MAIN
, $slotsChanged ) ) {
3457 // Invalidate caches of articles which include this page.
3458 // Only for the main slot, because only the main slot is transcluded.
3459 // TODO: MCR: not true for TemplateStyles! [SlotHandler]
3460 DeferredUpdates
::addUpdate(
3461 new HTMLCacheUpdate( $title, 'templatelinks', 'page-edit' )
3465 // Invalidate the caches of all pages which redirect here
3466 DeferredUpdates
::addUpdate(
3467 new HTMLCacheUpdate( $title, 'redirect', 'page-edit' )
3470 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3472 // Purge CDN for this page only
3473 $title->purgeSquid();
3474 // Clear file cache for this page only
3475 HTMLFileCache
::clearFileCache( $title );
3477 // Purge ?action=info cache
3478 $revid = $revision ?
$revision->getId() : null;
3479 DeferredUpdates
::addCallableUpdate( function () use ( $title, $revid ) {
3480 InfoAction
::invalidateCache( $title, $revid );
3483 // Purge cross-wiki cache entities referencing this page
3484 self
::purgeInterwikiCheckKey( $title );
3490 * Purge the check key for cross-wiki cache entries referencing this page
3492 * @param Title $title
3494 private static function purgeInterwikiCheckKey( Title
$title ) {
3495 global $wgEnableScaryTranscluding;
3497 if ( !$wgEnableScaryTranscluding ) {
3498 return; // @todo: perhaps this wiki is only used as a *source* for content?
3501 DeferredUpdates
::addCallableUpdate( function () use ( $title ) {
3502 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
3503 $cache->resetCheckKey(
3504 // Do not include the namespace since there can be multiple aliases to it
3505 // due to different namespace text definitions on different wikis. This only
3506 // means that some cache invalidations happen that are not strictly needed.
3507 $cache->makeGlobalKey(
3509 WikiMap
::getCurrentWikiDomain()->getId(),
3517 * Returns a list of categories this page is a member of.
3518 * Results will include hidden categories
3520 * @return TitleArray
3522 public function getCategories() {
3523 $id = $this->getId();
3525 return TitleArray
::newFromResult( new FakeResultWrapper( [] ) );
3528 $dbr = wfGetDB( DB_REPLICA
);
3529 $res = $dbr->select( 'categorylinks',
3530 [ 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ],
3531 // Have to do that since Database::fieldNamesWithAlias treats numeric indexes
3532 // as not being aliases, and NS_CATEGORY is numeric
3533 [ 'cl_from' => $id ],
3536 return TitleArray
::newFromResult( $res );
3540 * Returns a list of hidden categories this page is a member of.
3541 * Uses the page_props and categorylinks tables.
3543 * @return array Array of Title objects
3545 public function getHiddenCategories() {
3547 $id = $this->getId();
3553 $dbr = wfGetDB( DB_REPLICA
);
3554 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3556 [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3557 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ],
3560 if ( $res !== false ) {
3561 foreach ( $res as $row ) {
3562 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3570 * Auto-generates a deletion reason
3572 * @param bool &$hasHistory Whether the page has a history
3573 * @return string|bool String containing deletion reason or empty string, or boolean false
3574 * if no revision occurred
3576 public function getAutoDeleteReason( &$hasHistory ) {
3577 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3581 * Update all the appropriate counts in the category table, given that
3582 * we've added the categories $added and deleted the categories $deleted.
3584 * This should only be called from deferred updates or jobs to avoid contention.
3586 * @param array $added The names of categories that were added
3587 * @param array $deleted The names of categories that were deleted
3588 * @param int $id Page ID (this should be the original deleted page ID)
3590 public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3591 $id = $id ?
: $this->getId();
3592 $type = MWNamespace
::getCategoryLinkType( $this->getTitle()->getNamespace() );
3594 $addFields = [ 'cat_pages = cat_pages + 1' ];
3595 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3596 if ( $type !== 'page' ) {
3597 $addFields[] = "cat_{$type}s = cat_{$type}s + 1";
3598 $removeFields[] = "cat_{$type}s = cat_{$type}s - 1";
3601 $dbw = wfGetDB( DB_MASTER
);
3603 if ( count( $added ) ) {
3604 $existingAdded = $dbw->selectFieldValues(
3607 [ 'cat_title' => $added ],
3611 // For category rows that already exist, do a plain
3612 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3613 // to avoid creating gaps in the cat_id sequence.
3614 if ( count( $existingAdded ) ) {
3618 [ 'cat_title' => $existingAdded ],
3623 $missingAdded = array_diff( $added, $existingAdded );
3624 if ( count( $missingAdded ) ) {
3626 foreach ( $missingAdded as $cat ) {
3628 'cat_title' => $cat,
3630 'cat_subcats' => ( $type === 'subcat' ) ?
1 : 0,
3631 'cat_files' => ( $type === 'file' ) ?
1 : 0,
3644 if ( count( $deleted ) ) {
3648 [ 'cat_title' => $deleted ],
3653 foreach ( $added as $catName ) {
3654 $cat = Category
::newFromName( $catName );
3655 Hooks
::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3658 foreach ( $deleted as $catName ) {
3659 $cat = Category
::newFromName( $catName );
3660 Hooks
::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3661 // Refresh counts on categories that should be empty now (after commit, T166757)
3662 DeferredUpdates
::addCallableUpdate( function () use ( $cat ) {
3663 $cat->refreshCountsIfEmpty();
3669 * Opportunistically enqueue link update jobs given fresh parser output if useful
3671 * @param ParserOutput $parserOutput Current version page output
3674 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3675 if ( wfReadOnly() ) {
3679 if ( !Hooks
::run( 'OpportunisticLinksUpdate',
3680 [ $this, $this->mTitle
, $parserOutput ]
3685 $config = RequestContext
::getMain()->getConfig();
3688 'isOpportunistic' => true,
3689 'rootJobTimestamp' => $parserOutput->getCacheTime()
3692 if ( $this->mTitle
->areRestrictionsCascading() ) {
3693 // If the page is cascade protecting, the links should really be up-to-date
3694 JobQueueGroup
::singleton()->lazyPush(
3695 RefreshLinksJob
::newPrioritized( $this->mTitle
, $params )
3697 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3698 // Assume the output contains "dynamic" time/random based magic words.
3699 // Only update pages that expired due to dynamic content and NOT due to edits
3700 // to referenced templates/files. When the cache expires due to dynamic content,
3701 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3702 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3703 // template/file edit already triggered recursive RefreshLinksJob jobs.
3704 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3705 // If a page is uncacheable, do not keep spamming a job for it.
3706 // Although it would be de-duplicated, it would still waste I/O.
3707 $cache = ObjectCache
::getLocalClusterInstance();
3708 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3709 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3710 if ( $cache->add( $key, time(), $ttl ) ) {
3711 JobQueueGroup
::singleton()->lazyPush(
3712 RefreshLinksJob
::newDynamic( $this->mTitle
, $params )
3720 * Returns a list of updates to be performed when this page is deleted. The
3721 * updates should remove any information about this page from secondary data
3722 * stores such as links tables.
3724 * @param RevisionRecord|Content|null $rev The revision being deleted. Also accepts a Content
3725 * object for backwards compatibility.
3726 * @return DeferrableUpdate[]
3728 public function getDeletionUpdates( $rev = null ) {
3730 wfDeprecated( __METHOD__
. ' without a RevisionRecord', '1.32' );
3733 $rev = $this->getRevisionRecord();
3734 } catch ( Exception
$ex ) {
3735 // If we can't load the content, something is wrong. Perhaps that's why
3736 // the user is trying to delete the page, so let's not fail in that case.
3737 // Note that doDeleteArticleReal() will already have logged an issue with
3738 // loading the content.
3739 wfDebug( __METHOD__
. ' failed to load current revision of page ' . $this->getId() );
3745 } elseif ( $rev instanceof Content
) {
3746 wfDeprecated( __METHOD__
. ' with a Content object instead of a RevisionRecord', '1.32' );
3748 $slotContent = [ SlotRecord
::MAIN
=> $rev ];
3750 $slotContent = array_map( function ( SlotRecord
$slot ) {
3751 return $slot->getContent( Revision
::RAW
);
3752 }, $rev->getSlots()->getSlots() );
3755 $allUpdates = [ new LinksDeletionUpdate( $this ) ];
3757 // NOTE: once Content::getDeletionUpdates() is removed, we only need to content
3758 // model here, not the content object!
3759 // TODO: consolidate with similar logic in DerivedPageDataUpdater::getSecondaryDataUpdates()
3760 /** @var Content $content */
3761 foreach ( $slotContent as $role => $content ) {
3762 $handler = $content->getContentHandler();
3764 $updates = $handler->getDeletionUpdates(
3768 $allUpdates = array_merge( $allUpdates, $updates );
3770 // TODO: remove B/C hack in 1.32!
3771 $legacyUpdates = $content->getDeletionUpdates( $this );
3773 // HACK: filter out redundant and incomplete LinksDeletionUpdate
3774 $legacyUpdates = array_filter( $legacyUpdates, function ( $update ) {
3775 return !( $update instanceof LinksDeletionUpdate
);
3778 $allUpdates = array_merge( $allUpdates, $legacyUpdates );
3781 Hooks
::run( 'PageDeletionDataUpdates', [ $this->getTitle(), $rev, &$allUpdates ] );
3783 // TODO: hard deprecate old hook in 1.33
3784 Hooks
::run( 'WikiPageDeletionUpdates', [ $this, $content, &$allUpdates ] );
3789 * Whether this content displayed on this page
3790 * comes from the local database
3795 public function isLocal() {
3800 * The display name for the site this content
3801 * come from. If a subclass overrides isLocal(),
3802 * this could return something other than the
3808 public function getWikiDisplayName() {
3814 * Get the source URL for the content on this page,
3815 * typically the canonical URL, but may be a remote
3816 * link if the content comes from another site
3821 public function getSourceURL() {
3822 return $this->getTitle()->getCanonicalURL();
3826 * @param WANObjectCache $cache
3830 public function getMutableCacheKeys( WANObjectCache
$cache ) {
3831 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3833 return $linkCache->getMutableCacheKeys( $cache, $this->getTitle() );