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\Logger\LoggerFactory
;
24 use \MediaWiki\MediaWikiServices
;
27 * Class representing a MediaWiki article and history.
29 * Some fields are public only for backwards-compatibility. Use accessors.
30 * In the past, this class was part of Article.php and everything was public.
32 class WikiPage
implements Page
, IDBAccessObject
{
33 // Constants for $mDataLoadedFrom and related
38 public $mTitle = null;
43 public $mDataLoaded = false; // !< Boolean
44 public $mIsRedirect = false; // !< Boolean
45 public $mLatest = false; // !< Integer (false means "not loaded")
48 /** @var stdClass Map of cache fields (text, parser output, ect) for a proposed/new edit */
49 public $mPreparedEdit = false;
54 protected $mId = null;
57 * @var int One of the READ_* constants
59 protected $mDataLoadedFrom = self
::READ_NONE
;
64 protected $mRedirectTarget = null;
69 protected $mLastRevision = null;
72 * @var string Timestamp of the current revision or empty string if not loaded
74 protected $mTimestamp = '';
79 protected $mTouched = '19700101000000';
84 protected $mLinksUpdated = '19700101000000';
86 const PURGE_CDN_CACHE
= 1; // purge CDN cache for page variant URLs
87 const PURGE_CLUSTER_PCACHE
= 2; // purge parser cache in the local datacenter
88 const PURGE_GLOBAL_PCACHE
= 4; // set page_touched to clear parser cache in all datacenters
92 * Constructor and clear the article
93 * @param Title $title Reference to a Title object.
95 public function __construct( Title
$title ) {
96 $this->mTitle
= $title;
100 * Makes sure that the mTitle object is cloned
101 * to the newly cloned WikiPage.
103 public function __clone() {
104 $this->mTitle
= clone $this->mTitle
;
108 * Create a WikiPage object of the appropriate class for the given title.
110 * @param Title $title
112 * @throws MWException
113 * @return WikiPage|WikiCategoryPage|WikiFilePage
115 public static function factory( Title
$title ) {
116 $ns = $title->getNamespace();
118 if ( $ns == NS_MEDIA
) {
119 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
120 } elseif ( $ns < 0 ) {
121 throw new MWException( "Invalid or virtual namespace $ns given." );
125 if ( !Hooks
::run( 'WikiPageFactory', [ $title, &$page ] ) ) {
131 $page = new WikiFilePage( $title );
134 $page = new WikiCategoryPage( $title );
137 $page = new WikiPage( $title );
144 * Constructor from a page id
146 * @param int $id Article ID to load
147 * @param string|int $from One of the following values:
148 * - "fromdb" or WikiPage::READ_NORMAL to select from a replica DB
149 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
151 * @return WikiPage|null
153 public static function newFromID( $id, $from = 'fromdb' ) {
154 // page id's are never 0 or negative, see bug 61166
159 $from = self
::convertSelectType( $from );
160 $db = wfGetDB( $from === self
::READ_LATEST ? DB_MASTER
: DB_REPLICA
);
161 $row = $db->selectRow(
162 'page', self
::selectFields(), [ 'page_id' => $id ], __METHOD__
);
166 return self
::newFromRow( $row, $from );
170 * Constructor from a database row
173 * @param object $row Database row containing at least fields returned by selectFields().
174 * @param string|int $from Source of $data:
175 * - "fromdb" or WikiPage::READ_NORMAL: from a replica DB
176 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
177 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
180 public static function newFromRow( $row, $from = 'fromdb' ) {
181 $page = self
::factory( Title
::newFromRow( $row ) );
182 $page->loadFromRow( $row, $from );
187 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
189 * @param object|string|int $type
192 private static function convertSelectType( $type ) {
195 return self
::READ_NORMAL
;
197 return self
::READ_LATEST
;
199 return self
::READ_LOCKING
;
201 // It may already be an integer or whatever else
207 * @todo Move this UI stuff somewhere else
209 * @see ContentHandler::getActionOverrides
211 public function getActionOverrides() {
212 return $this->getContentHandler()->getActionOverrides();
216 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
218 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
220 * @return ContentHandler
224 public function getContentHandler() {
225 return ContentHandler
::getForModelID( $this->getContentModel() );
229 * Get the title object of the article
230 * @return Title Title object of this page
232 public function getTitle() {
233 return $this->mTitle
;
240 public function clear() {
241 $this->mDataLoaded
= false;
242 $this->mDataLoadedFrom
= self
::READ_NONE
;
244 $this->clearCacheFields();
248 * Clear the object cache fields
251 protected function clearCacheFields() {
253 $this->mRedirectTarget
= null; // Title object if set
254 $this->mLastRevision
= null; // Latest revision
255 $this->mTouched
= '19700101000000';
256 $this->mLinksUpdated
= '19700101000000';
257 $this->mTimestamp
= '';
258 $this->mIsRedirect
= false;
259 $this->mLatest
= false;
260 // Bug 57026: do not clear mPreparedEdit since prepareTextForEdit() already checks
261 // the requested rev ID and content against the cached one for equality. For most
262 // content types, the output should not change during the lifetime of this cache.
263 // Clearing it can cause extra parses on edit for no reason.
267 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
271 public function clearPreparedEdit() {
272 $this->mPreparedEdit
= false;
276 * Return the list of revision fields that should be selected to create
281 public static function selectFields() {
282 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
293 'page_links_updated',
298 if ( $wgContentHandlerUseDB ) {
299 $fields[] = 'page_content_model';
302 if ( $wgPageLanguageUseDB ) {
303 $fields[] = 'page_lang';
310 * Fetch a page record with the given conditions
311 * @param IDatabase $dbr
312 * @param array $conditions
313 * @param array $options
314 * @return object|bool Database result resource, or false on failure
316 protected function pageData( $dbr, $conditions, $options = [] ) {
317 $fields = self
::selectFields();
319 Hooks
::run( 'ArticlePageDataBefore', [ &$this, &$fields ] );
321 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
, $options );
323 Hooks
::run( 'ArticlePageDataAfter', [ &$this, &$row ] );
329 * Fetch a page record matching the Title object's namespace and title
330 * using a sanitized title string
332 * @param IDatabase $dbr
333 * @param Title $title
334 * @param array $options
335 * @return object|bool Database result resource, or false on failure
337 public function pageDataFromTitle( $dbr, $title, $options = [] ) {
338 return $this->pageData( $dbr, [
339 'page_namespace' => $title->getNamespace(),
340 'page_title' => $title->getDBkey() ], $options );
344 * Fetch a page record matching the requested ID
346 * @param IDatabase $dbr
348 * @param array $options
349 * @return object|bool Database result resource, or false on failure
351 public function pageDataFromId( $dbr, $id, $options = [] ) {
352 return $this->pageData( $dbr, [ 'page_id' => $id ], $options );
356 * Load the object from a given source by title
358 * @param object|string|int $from One of the following:
359 * - A DB query result object.
360 * - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
361 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
362 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
363 * using SELECT FOR UPDATE.
367 public function loadPageData( $from = 'fromdb' ) {
368 $from = self
::convertSelectType( $from );
369 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
370 // We already have the data from the correct location, no need to load it twice.
374 if ( is_int( $from ) ) {
375 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
376 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
379 && $index == DB_REPLICA
380 && wfGetLB()->getServerCount() > 1
381 && wfGetLB()->hasOrMadeRecentMasterChanges()
383 $from = self
::READ_LATEST
;
384 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
385 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
388 // No idea from where the caller got this data, assume replica DB.
390 $from = self
::READ_NORMAL
;
393 $this->loadFromRow( $data, $from );
397 * Load the object from a database row
400 * @param object|bool $data DB row containing fields returned by selectFields() or false
401 * @param string|int $from One of the following:
402 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB
403 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
404 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
405 * the master DB using SELECT FOR UPDATE
407 public function loadFromRow( $data, $from ) {
408 $lc = LinkCache
::singleton();
409 $lc->clearLink( $this->mTitle
);
412 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
414 $this->mTitle
->loadFromRow( $data );
416 // Old-fashioned restrictions
417 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
419 $this->mId
= intval( $data->page_id
);
420 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
421 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
422 $this->mIsRedirect
= intval( $data->page_is_redirect
);
423 $this->mLatest
= intval( $data->page_latest
);
424 // Bug 37225: $latest may no longer match the cached latest Revision object.
425 // Double-check the ID of any cached latest Revision object for consistency.
426 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
427 $this->mLastRevision
= null;
428 $this->mTimestamp
= '';
431 $lc->addBadLinkObj( $this->mTitle
);
433 $this->mTitle
->loadFromRow( false );
435 $this->clearCacheFields();
440 $this->mDataLoaded
= true;
441 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
445 * @return int Page ID
447 public function getId() {
448 if ( !$this->mDataLoaded
) {
449 $this->loadPageData();
455 * @return bool Whether or not the page exists in the database
457 public function exists() {
458 if ( !$this->mDataLoaded
) {
459 $this->loadPageData();
461 return $this->mId
> 0;
465 * Check if this page is something we're going to be showing
466 * some sort of sensible content for. If we return false, page
467 * views (plain action=view) will return an HTTP 404 response,
468 * so spiders and robots can know they're following a bad link.
472 public function hasViewableContent() {
473 return $this->mTitle
->isKnown();
477 * Tests if the article content represents a redirect
481 public function isRedirect() {
482 if ( !$this->mDataLoaded
) {
483 $this->loadPageData();
486 return (bool)$this->mIsRedirect
;
490 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
492 * Will use the revisions actual content model if the page exists,
493 * and the page's default if the page doesn't exist yet.
499 public function getContentModel() {
500 if ( $this->exists() ) {
501 $cache = ObjectCache
::getMainWANInstance();
503 return $cache->getWithSetCallback(
504 $cache->makeKey( 'page', 'content-model', $this->getLatest() ),
507 $rev = $this->getRevision();
509 // Look at the revision's actual content model
510 return $rev->getContentModel();
512 $title = $this->mTitle
->getPrefixedDBkey();
513 wfWarn( "Page $title exists but has no (visible) revisions!" );
514 return $this->mTitle
->getContentModel();
520 // use the default model for this page
521 return $this->mTitle
->getContentModel();
525 * Loads page_touched and returns a value indicating if it should be used
526 * @return bool True if this page exists and is not a redirect
528 public function checkTouched() {
529 if ( !$this->mDataLoaded
) {
530 $this->loadPageData();
532 return ( $this->mId
&& !$this->mIsRedirect
);
536 * Get the page_touched field
537 * @return string Containing GMT timestamp
539 public function getTouched() {
540 if ( !$this->mDataLoaded
) {
541 $this->loadPageData();
543 return $this->mTouched
;
547 * Get the page_links_updated field
548 * @return string|null Containing GMT timestamp
550 public function getLinksTimestamp() {
551 if ( !$this->mDataLoaded
) {
552 $this->loadPageData();
554 return $this->mLinksUpdated
;
558 * Get the page_latest field
559 * @return int The rev_id of current revision
561 public function getLatest() {
562 if ( !$this->mDataLoaded
) {
563 $this->loadPageData();
565 return (int)$this->mLatest
;
569 * Get the Revision object of the oldest revision
570 * @return Revision|null
572 public function getOldestRevision() {
574 // Try using the replica DB first, then try the master
576 $db = wfGetDB( DB_REPLICA
);
577 $revSelectFields = Revision
::selectFields();
580 while ( $continue ) {
581 $row = $db->selectRow(
582 [ 'page', 'revision' ],
585 'page_namespace' => $this->mTitle
->getNamespace(),
586 'page_title' => $this->mTitle
->getDBkey(),
591 'ORDER BY' => 'rev_timestamp ASC'
598 $db = wfGetDB( DB_MASTER
);
603 return $row ? Revision
::newFromRow( $row ) : null;
607 * Loads everything except the text
608 * This isn't necessary for all uses, so it's only done if needed.
610 protected function loadLastEdit() {
611 if ( $this->mLastRevision
!== null ) {
612 return; // already loaded
615 $latest = $this->getLatest();
617 return; // page doesn't exist or is missing page_latest info
620 if ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) {
621 // Bug 37225: if session S1 loads the page row FOR UPDATE, the result always
622 // includes the latest changes committed. This is true even within REPEATABLE-READ
623 // transactions, where S1 normally only sees changes committed before the first S1
624 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
625 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
626 // happened after the first S1 SELECT.
627 // https://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read
628 $flags = Revision
::READ_LOCKING
;
629 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
630 } elseif ( $this->mDataLoadedFrom
== self
::READ_LATEST
) {
631 // Bug T93976: if page_latest was loaded from the master, fetch the
632 // revision from there as well, as it may not exist yet on a replica DB.
633 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
634 $flags = Revision
::READ_LATEST
;
635 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
637 $dbr = wfGetDB( DB_REPLICA
);
638 $revision = Revision
::newKnownCurrent( $dbr, $this->getId(), $latest );
641 if ( $revision ) { // sanity
642 $this->setLastEdit( $revision );
647 * Set the latest revision
648 * @param Revision $revision
650 protected function setLastEdit( Revision
$revision ) {
651 $this->mLastRevision
= $revision;
652 $this->mTimestamp
= $revision->getTimestamp();
656 * Get the latest revision
657 * @return Revision|null
659 public function getRevision() {
660 $this->loadLastEdit();
661 if ( $this->mLastRevision
) {
662 return $this->mLastRevision
;
668 * Get the content of the current revision. No side-effects...
670 * @param int $audience One of:
671 * Revision::FOR_PUBLIC to be displayed to all users
672 * Revision::FOR_THIS_USER to be displayed to $wgUser
673 * Revision::RAW get the text regardless of permissions
674 * @param User $user User object to check for, only if FOR_THIS_USER is passed
675 * to the $audience parameter
676 * @return Content|null The content of the current revision
680 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
681 $this->loadLastEdit();
682 if ( $this->mLastRevision
) {
683 return $this->mLastRevision
->getContent( $audience, $user );
689 * Get the text of the current revision. No side-effects...
691 * @param int $audience One of:
692 * Revision::FOR_PUBLIC to be displayed to all users
693 * Revision::FOR_THIS_USER to be displayed to the given user
694 * Revision::RAW get the text regardless of permissions
695 * @param User $user User object to check for, only if FOR_THIS_USER is passed
696 * to the $audience parameter
697 * @return string|bool The text of the current revision
698 * @deprecated since 1.21, getContent() should be used instead.
700 public function getText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
701 wfDeprecated( __METHOD__
, '1.21' );
703 $this->loadLastEdit();
704 if ( $this->mLastRevision
) {
705 return $this->mLastRevision
->getText( $audience, $user );
711 * @return string MW timestamp of last article revision
713 public function getTimestamp() {
714 // Check if the field has been filled by WikiPage::setTimestamp()
715 if ( !$this->mTimestamp
) {
716 $this->loadLastEdit();
719 return wfTimestamp( TS_MW
, $this->mTimestamp
);
723 * Set the page timestamp (use only to avoid DB queries)
724 * @param string $ts MW timestamp of last article revision
727 public function setTimestamp( $ts ) {
728 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
732 * @param int $audience One of:
733 * Revision::FOR_PUBLIC to be displayed to all users
734 * Revision::FOR_THIS_USER to be displayed to the given user
735 * Revision::RAW get the text regardless of permissions
736 * @param User $user User object to check for, only if FOR_THIS_USER is passed
737 * to the $audience parameter
738 * @return int User ID for the user that made the last article revision
740 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
741 $this->loadLastEdit();
742 if ( $this->mLastRevision
) {
743 return $this->mLastRevision
->getUser( $audience, $user );
750 * Get the User object of the user who created the page
751 * @param int $audience One of:
752 * Revision::FOR_PUBLIC to be displayed to all users
753 * Revision::FOR_THIS_USER to be displayed to the given user
754 * Revision::RAW get the text regardless of permissions
755 * @param User $user User object to check for, only if FOR_THIS_USER is passed
756 * to the $audience parameter
759 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
760 $revision = $this->getOldestRevision();
762 $userName = $revision->getUserText( $audience, $user );
763 return User
::newFromName( $userName, false );
770 * @param int $audience One of:
771 * Revision::FOR_PUBLIC to be displayed to all users
772 * Revision::FOR_THIS_USER to be displayed to the given user
773 * Revision::RAW get the text regardless of permissions
774 * @param User $user User object to check for, only if FOR_THIS_USER is passed
775 * to the $audience parameter
776 * @return string Username of the user that made the last article revision
778 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
779 $this->loadLastEdit();
780 if ( $this->mLastRevision
) {
781 return $this->mLastRevision
->getUserText( $audience, $user );
788 * @param int $audience One of:
789 * Revision::FOR_PUBLIC to be displayed to all users
790 * Revision::FOR_THIS_USER to be displayed to the given user
791 * Revision::RAW get the text regardless of permissions
792 * @param User $user User object to check for, only if FOR_THIS_USER is passed
793 * to the $audience parameter
794 * @return string Comment stored for the last article revision
796 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
797 $this->loadLastEdit();
798 if ( $this->mLastRevision
) {
799 return $this->mLastRevision
->getComment( $audience, $user );
806 * Returns true if last revision was marked as "minor edit"
808 * @return bool Minor edit indicator for the last article revision.
810 public function getMinorEdit() {
811 $this->loadLastEdit();
812 if ( $this->mLastRevision
) {
813 return $this->mLastRevision
->isMinor();
820 * Determine whether a page would be suitable for being counted as an
821 * article in the site_stats table based on the title & its content
823 * @param object|bool $editInfo (false): object returned by prepareTextForEdit(),
824 * if false, the current database state will be used
827 public function isCountable( $editInfo = false ) {
828 global $wgArticleCountMethod;
830 if ( !$this->mTitle
->isContentPage() ) {
835 $content = $editInfo->pstContent
;
837 $content = $this->getContent();
840 if ( !$content ||
$content->isRedirect() ) {
846 if ( $wgArticleCountMethod === 'link' ) {
847 // nasty special case to avoid re-parsing to detect links
850 // ParserOutput::getLinks() is a 2D array of page links, so
851 // to be really correct we would need to recurse in the array
852 // but the main array should only have items in it if there are
854 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
856 $hasLinks = (bool)wfGetDB( DB_REPLICA
)->selectField( 'pagelinks', 1,
857 [ 'pl_from' => $this->getId() ], __METHOD__
);
861 return $content->isCountable( $hasLinks );
865 * If this page is a redirect, get its target
867 * The target will be fetched from the redirect table if possible.
868 * If this page doesn't have an entry there, call insertRedirect()
869 * @return Title|null Title object, or null if this page is not a redirect
871 public function getRedirectTarget() {
872 if ( !$this->mTitle
->isRedirect() ) {
876 if ( $this->mRedirectTarget
!== null ) {
877 return $this->mRedirectTarget
;
880 // Query the redirect table
881 $dbr = wfGetDB( DB_REPLICA
);
882 $row = $dbr->selectRow( 'redirect',
883 [ 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ],
884 [ 'rd_from' => $this->getId() ],
888 // rd_fragment and rd_interwiki were added later, populate them if empty
889 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
890 $this->mRedirectTarget
= Title
::makeTitle(
891 $row->rd_namespace
, $row->rd_title
,
892 $row->rd_fragment
, $row->rd_interwiki
894 return $this->mRedirectTarget
;
897 // This page doesn't have an entry in the redirect table
898 $this->mRedirectTarget
= $this->insertRedirect();
899 return $this->mRedirectTarget
;
903 * Insert an entry for this page into the redirect table if the content is a redirect
905 * The database update will be deferred via DeferredUpdates
907 * Don't call this function directly unless you know what you're doing.
908 * @return Title|null Title object or null if not a redirect
910 public function insertRedirect() {
911 $content = $this->getContent();
912 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
917 // Update the DB post-send if the page has not cached since now
919 $latest = $this->getLatest();
920 DeferredUpdates
::addCallableUpdate(
921 function () use ( $that, $retval, $latest ) {
922 $that->insertRedirectEntry( $retval, $latest );
924 DeferredUpdates
::POSTSEND
,
932 * Insert or update the redirect table entry for this page to indicate it redirects to $rt
933 * @param Title $rt Redirect target
934 * @param int|null $oldLatest Prior page_latest for check and set
936 public function insertRedirectEntry( Title
$rt, $oldLatest = null ) {
937 $dbw = wfGetDB( DB_MASTER
);
938 $dbw->startAtomic( __METHOD__
);
940 if ( !$oldLatest ||
$oldLatest == $this->lockAndGetLatest() ) {
944 'rd_from' => $this->getId(),
945 'rd_namespace' => $rt->getNamespace(),
946 'rd_title' => $rt->getDBkey(),
947 'rd_fragment' => $rt->getFragment(),
948 'rd_interwiki' => $rt->getInterwiki(),
952 'rd_namespace' => $rt->getNamespace(),
953 'rd_title' => $rt->getDBkey(),
954 'rd_fragment' => $rt->getFragment(),
955 'rd_interwiki' => $rt->getInterwiki(),
961 $dbw->endAtomic( __METHOD__
);
965 * Get the Title object or URL this page redirects to
967 * @return bool|Title|string False, Title of in-wiki target, or string with URL
969 public function followRedirect() {
970 return $this->getRedirectURL( $this->getRedirectTarget() );
974 * Get the Title object or URL to use for a redirect. We use Title
975 * objects for same-wiki, non-special redirects and URLs for everything
977 * @param Title $rt Redirect target
978 * @return bool|Title|string False, Title object of local target, or string with URL
980 public function getRedirectURL( $rt ) {
985 if ( $rt->isExternal() ) {
986 if ( $rt->isLocal() ) {
987 // Offsite wikis need an HTTP redirect.
988 // This can be hard to reverse and may produce loops,
989 // so they may be disabled in the site configuration.
990 $source = $this->mTitle
->getFullURL( 'redirect=no' );
991 return $rt->getFullURL( [ 'rdfrom' => $source ] );
993 // External pages without "local" bit set are not valid
999 if ( $rt->isSpecialPage() ) {
1000 // Gotta handle redirects to special pages differently:
1001 // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
1002 // Some pages are not valid targets.
1003 if ( $rt->isValidRedirectTarget() ) {
1004 return $rt->getFullURL();
1014 * Get a list of users who have edited this article, not including the user who made
1015 * the most recent revision, which you can get from $article->getUser() if you want it
1016 * @return UserArrayFromResult
1018 public function getContributors() {
1019 // @todo FIXME: This is expensive; cache this info somewhere.
1021 $dbr = wfGetDB( DB_REPLICA
);
1023 if ( $dbr->implicitGroupby() ) {
1024 $realNameField = 'user_real_name';
1026 $realNameField = 'MIN(user_real_name) AS user_real_name';
1029 $tables = [ 'revision', 'user' ];
1032 'user_id' => 'rev_user',
1033 'user_name' => 'rev_user_text',
1035 'timestamp' => 'MAX(rev_timestamp)',
1038 $conds = [ 'rev_page' => $this->getId() ];
1040 // The user who made the top revision gets credited as "this page was last edited by
1041 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1042 $user = $this->getUser();
1044 $conds[] = "rev_user != $user";
1046 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1050 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1053 'user' => [ 'LEFT JOIN', 'rev_user = user_id' ],
1057 'GROUP BY' => [ 'rev_user', 'rev_user_text' ],
1058 'ORDER BY' => 'timestamp DESC',
1061 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1062 return new UserArrayFromResult( $res );
1066 * Should the parser cache be used?
1068 * @param ParserOptions $parserOptions ParserOptions to check
1072 public function shouldCheckParserCache( ParserOptions
$parserOptions, $oldId ) {
1073 return $parserOptions->getStubThreshold() == 0
1075 && ( $oldId === null ||
$oldId === 0 ||
$oldId === $this->getLatest() )
1076 && $this->getContentHandler()->isParserCacheSupported();
1080 * Get a ParserOutput for the given ParserOptions and revision ID.
1082 * The parser cache will be used if possible. Cache misses that result
1083 * in parser runs are debounced with PoolCounter.
1086 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1087 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1088 * get the current revision (default value)
1089 * @param bool $forceParse Force reindexing, regardless of cache settings
1090 * @return bool|ParserOutput ParserOutput or false if the revision was not found
1092 public function getParserOutput(
1093 ParserOptions
$parserOptions, $oldid = null, $forceParse = false
1096 ( !$forceParse ) && $this->shouldCheckParserCache( $parserOptions, $oldid );
1097 wfDebug( __METHOD__
.
1098 ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1099 if ( $parserOptions->getStubThreshold() ) {
1100 wfIncrStats( 'pcache.miss.stub' );
1103 if ( $useParserCache ) {
1104 $parserOutput = ParserCache
::singleton()->get( $this, $parserOptions );
1105 if ( $parserOutput !== false ) {
1106 return $parserOutput;
1110 if ( $oldid === null ||
$oldid === 0 ) {
1111 $oldid = $this->getLatest();
1114 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1117 return $pool->getParserOutput();
1121 * Do standard deferred updates after page view (existing or missing page)
1122 * @param User $user The relevant user
1123 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1125 public function doViewUpdates( User
$user, $oldid = 0 ) {
1126 if ( wfReadOnly() ) {
1130 Hooks
::run( 'PageViewUpdates', [ $this, $user ] );
1131 // Update newtalk / watchlist notification status
1133 $user->clearNotification( $this->mTitle
, $oldid );
1134 } catch ( DBError
$e ) {
1135 // Avoid outage if the master is not reachable
1136 MWExceptionHandler
::logException( $e );
1141 * Perform the actions of a page purging
1142 * @param integer $flags Bitfield of WikiPage::PURGE_* constants
1145 public function doPurge( $flags = self
::PURGE_ALL
) {
1146 if ( !Hooks
::run( 'ArticlePurge', [ &$this ] ) ) {
1150 if ( ( $flags & self
::PURGE_GLOBAL_PCACHE
) == self
::PURGE_GLOBAL_PCACHE
) {
1151 // Set page_touched in the database to invalidate all DC caches
1152 $this->mTitle
->invalidateCache();
1153 } elseif ( ( $flags & self
::PURGE_CLUSTER_PCACHE
) == self
::PURGE_CLUSTER_PCACHE
) {
1154 // Delete the parser options key in the local cluster to invalidate the DC cache
1155 ParserCache
::singleton()->deleteOptionsKey( $this );
1156 // Avoid sending HTTP 304s in ViewAction to the client who just issued the purge
1157 $cache = ObjectCache
::getLocalClusterInstance();
1159 $cache->makeKey( 'page', 'last-dc-purge', $this->getId() ),
1160 wfTimestamp( TS_MW
),
1165 if ( ( $flags & self
::PURGE_CDN_CACHE
) == self
::PURGE_CDN_CACHE
) {
1166 // Clear any HTML file cache
1167 HTMLFileCache
::clearFileCache( $this->getTitle() );
1168 // Send purge after any page_touched above update was committed
1169 DeferredUpdates
::addUpdate(
1170 new CdnCacheUpdate( $this->mTitle
->getCdnUrls() ),
1171 DeferredUpdates
::PRESEND
1175 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1176 // @todo move this logic to MessageCache
1177 if ( $this->exists() ) {
1178 // NOTE: use transclusion text for messages.
1179 // This is consistent with MessageCache::getMsgFromNamespace()
1181 $content = $this->getContent();
1182 $text = $content === null ?
null : $content->getWikitextForTransclusion();
1184 if ( $text === null ) {
1191 MessageCache
::singleton()->replace( $this->mTitle
->getDBkey(), $text );
1198 * Get the last time a user explicitly purged the page via action=purge
1200 * @return string|bool TS_MW timestamp or false
1203 public function getLastPurgeTimestamp() {
1204 $cache = ObjectCache
::getLocalClusterInstance();
1206 return $cache->get( $cache->makeKey( 'page', 'last-dc-purge', $this->getId() ) );
1210 * Insert a new empty page record for this article.
1211 * This *must* be followed up by creating a revision
1212 * and running $this->updateRevisionOn( ... );
1213 * or else the record will be left in a funky state.
1214 * Best if all done inside a transaction.
1216 * @param IDatabase $dbw
1217 * @param int|null $pageId Custom page ID that will be used for the insert statement
1219 * @return bool|int The newly created page_id key; false if the row was not
1220 * inserted, e.g. because the title already existed or because the specified
1221 * page ID is already in use.
1223 public function insertOn( $dbw, $pageId = null ) {
1224 $pageIdForInsert = $pageId ?
: $dbw->nextSequenceValue( 'page_page_id_seq' );
1228 'page_id' => $pageIdForInsert,
1229 'page_namespace' => $this->mTitle
->getNamespace(),
1230 'page_title' => $this->mTitle
->getDBkey(),
1231 'page_restrictions' => '',
1232 'page_is_redirect' => 0, // Will set this shortly...
1234 'page_random' => wfRandom(),
1235 'page_touched' => $dbw->timestamp(),
1236 'page_latest' => 0, // Fill this in shortly...
1237 'page_len' => 0, // Fill this in shortly...
1243 if ( $dbw->affectedRows() > 0 ) {
1244 $newid = $pageId ?
: $dbw->insertId();
1245 $this->mId
= $newid;
1246 $this->mTitle
->resetArticleID( $newid );
1250 return false; // nothing changed
1255 * Update the page record to point to a newly saved revision.
1257 * @param IDatabase $dbw
1258 * @param Revision $revision For ID number, and text used to set
1259 * length and redirect status fields
1260 * @param int $lastRevision If given, will not overwrite the page field
1261 * when different from the currently set value.
1262 * Giving 0 indicates the new page flag should be set on.
1263 * @param bool $lastRevIsRedirect If given, will optimize adding and
1264 * removing rows in redirect table.
1265 * @return bool Success; false if the page row was missing or page_latest changed
1267 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1268 $lastRevIsRedirect = null
1270 global $wgContentHandlerUseDB;
1272 // Assertion to try to catch T92046
1273 if ( (int)$revision->getId() === 0 ) {
1274 throw new InvalidArgumentException(
1275 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1279 $content = $revision->getContent();
1280 $len = $content ?
$content->getSize() : 0;
1281 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1283 $conditions = [ 'page_id' => $this->getId() ];
1285 if ( !is_null( $lastRevision ) ) {
1286 // An extra check against threads stepping on each other
1287 $conditions['page_latest'] = $lastRevision;
1291 'page_latest' => $revision->getId(),
1292 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1293 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1294 'page_is_redirect' => $rt !== null ?
1 : 0,
1298 if ( $wgContentHandlerUseDB ) {
1299 $row['page_content_model'] = $revision->getContentModel();
1302 $dbw->update( 'page',
1307 $result = $dbw->affectedRows() > 0;
1309 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1310 $this->setLastEdit( $revision );
1311 $this->mLatest
= $revision->getId();
1312 $this->mIsRedirect
= (bool)$rt;
1313 // Update the LinkCache.
1314 LinkCache
::singleton()->addGoodLinkObj(
1320 $revision->getContentModel()
1328 * Add row to the redirect table if this is a redirect, remove otherwise.
1330 * @param IDatabase $dbw
1331 * @param Title $redirectTitle Title object pointing to the redirect target,
1332 * or NULL if this is not a redirect
1333 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1334 * removing rows in redirect table.
1335 * @return bool True on success, false on failure
1338 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1339 // Always update redirects (target link might have changed)
1340 // Update/Insert if we don't know if the last revision was a redirect or not
1341 // Delete if changing from redirect to non-redirect
1342 $isRedirect = !is_null( $redirectTitle );
1344 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1348 if ( $isRedirect ) {
1349 $this->insertRedirectEntry( $redirectTitle );
1351 // This is not a redirect, remove row from redirect table
1352 $where = [ 'rd_from' => $this->getId() ];
1353 $dbw->delete( 'redirect', $where, __METHOD__
);
1356 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1357 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1360 return ( $dbw->affectedRows() != 0 );
1364 * If the given revision is newer than the currently set page_latest,
1365 * update the page record. Otherwise, do nothing.
1367 * @deprecated since 1.24, use updateRevisionOn instead
1369 * @param IDatabase $dbw
1370 * @param Revision $revision
1373 public function updateIfNewerOn( $dbw, $revision ) {
1375 $row = $dbw->selectRow(
1376 [ 'revision', 'page' ],
1377 [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1379 'page_id' => $this->getId(),
1380 'page_latest=rev_id' ],
1384 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1387 $prev = $row->rev_id
;
1388 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1390 // No or missing previous revision; mark the page as new
1392 $lastRevIsRedirect = null;
1395 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1401 * Get the content that needs to be saved in order to undo all revisions
1402 * between $undo and $undoafter. Revisions must belong to the same page,
1403 * must exist and must not be deleted
1404 * @param Revision $undo
1405 * @param Revision $undoafter Must be an earlier revision than $undo
1406 * @return Content|bool Content on success, false on failure
1408 * Before we had the Content object, this was done in getUndoText
1410 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1411 $handler = $undo->getContentHandler();
1412 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1416 * Returns true if this page's content model supports sections.
1420 * @todo The skin should check this and not offer section functionality if
1421 * sections are not supported.
1422 * @todo The EditPage should check this and not offer section functionality
1423 * if sections are not supported.
1425 public function supportsSections() {
1426 return $this->getContentHandler()->supportsSections();
1430 * @param string|number|null|bool $sectionId Section identifier as a number or string
1431 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1432 * or 'new' for a new section.
1433 * @param Content $sectionContent New content of the section.
1434 * @param string $sectionTitle New section's subject, only if $section is "new".
1435 * @param string $edittime Revision timestamp or null to use the current revision.
1437 * @throws MWException
1438 * @return Content|null New complete article content, or null if error.
1441 * @deprecated since 1.24, use replaceSectionAtRev instead
1443 public function replaceSectionContent(
1444 $sectionId, Content
$sectionContent, $sectionTitle = '', $edittime = null
1448 if ( $edittime && $sectionId !== 'new' ) {
1449 $dbr = wfGetDB( DB_REPLICA
);
1450 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1451 // Try the master if this thread may have just added it.
1452 // This could be abstracted into a Revision method, but we don't want
1453 // to encourage loading of revisions by timestamp.
1455 && wfGetLB()->getServerCount() > 1
1456 && wfGetLB()->hasOrMadeRecentMasterChanges()
1458 $dbw = wfGetDB( DB_MASTER
);
1459 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1462 $baseRevId = $rev->getId();
1466 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1470 * @param string|number|null|bool $sectionId Section identifier as a number or string
1471 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1472 * or 'new' for a new section.
1473 * @param Content $sectionContent New content of the section.
1474 * @param string $sectionTitle New section's subject, only if $section is "new".
1475 * @param int|null $baseRevId
1477 * @throws MWException
1478 * @return Content|null New complete article content, or null if error.
1482 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1483 $sectionTitle = '', $baseRevId = null
1486 if ( strval( $sectionId ) === '' ) {
1487 // Whole-page edit; let the whole text through
1488 $newContent = $sectionContent;
1490 if ( !$this->supportsSections() ) {
1491 throw new MWException( "sections not supported for content model " .
1492 $this->getContentHandler()->getModelID() );
1495 // Bug 30711: always use current version when adding a new section
1496 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1497 $oldContent = $this->getContent();
1499 $rev = Revision
::newFromId( $baseRevId );
1501 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1502 $this->getId() . "; section: $sectionId)\n" );
1506 $oldContent = $rev->getContent();
1509 if ( !$oldContent ) {
1510 wfDebug( __METHOD__
. ": no page text\n" );
1514 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1521 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1523 * @return int Updated $flags
1525 public function checkFlags( $flags ) {
1526 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1527 if ( $this->exists() ) {
1528 $flags |
= EDIT_UPDATE
;
1538 * Change an existing article or create a new article. Updates RC and all necessary caches,
1539 * optionally via the deferred update array.
1541 * @param string $text New text
1542 * @param string $summary Edit summary
1543 * @param int $flags Bitfield:
1545 * Article is known or assumed to be non-existent, create a new one
1547 * Article is known or assumed to be pre-existing, update it
1549 * Mark this edit minor, if the user is allowed to do so
1551 * Do not log the change in recentchanges
1553 * Mark the edit a "bot" edit regardless of user rights
1555 * Fill in blank summaries with generated text where possible
1557 * Signal that the page retrieve/save cycle happened entirely in this request.
1559 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1560 * article will be detected. If EDIT_UPDATE is specified and the article
1561 * doesn't exist, the function will return an edit-gone-missing error. If
1562 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1563 * error will be returned. These two conditions are also possible with
1564 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1566 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1567 * This is not the parent revision ID, rather the revision ID for older
1568 * content used as the source for a rollback, for example.
1569 * @param User $user The user doing the edit
1571 * @throws MWException
1572 * @return Status Possible errors:
1573 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1574 * set the fatal flag of $status
1575 * edit-gone-missing: In update mode, but the article didn't exist.
1576 * edit-conflict: In update mode, the article changed unexpectedly.
1577 * edit-no-change: Warning that the text was the same as before.
1578 * edit-already-exists: In creation mode, but the article already exists.
1580 * Extensions may define additional errors.
1582 * $return->value will contain an associative array with members as follows:
1583 * new: Boolean indicating if the function attempted to create a new article.
1584 * revision: The revision object for the inserted revision, or null.
1586 * Compatibility note: this function previously returned a boolean value
1587 * indicating success/failure
1589 * @deprecated since 1.21: use doEditContent() instead.
1591 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1592 wfDeprecated( __METHOD__
, '1.21' );
1594 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
1596 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1600 * Change an existing article or create a new article. Updates RC and all necessary caches,
1601 * optionally via the deferred update array.
1603 * @param Content $content New content
1604 * @param string $summary Edit summary
1605 * @param int $flags Bitfield:
1607 * Article is known or assumed to be non-existent, create a new one
1609 * Article is known or assumed to be pre-existing, update it
1611 * Mark this edit minor, if the user is allowed to do so
1613 * Do not log the change in recentchanges
1615 * Mark the edit a "bot" edit regardless of user rights
1617 * Fill in blank summaries with generated text where possible
1619 * Signal that the page retrieve/save cycle happened entirely in this request.
1621 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1622 * article will be detected. If EDIT_UPDATE is specified and the article
1623 * doesn't exist, the function will return an edit-gone-missing error. If
1624 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1625 * error will be returned. These two conditions are also possible with
1626 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1628 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1629 * This is not the parent revision ID, rather the revision ID for older
1630 * content used as the source for a rollback, for example.
1631 * @param User $user The user doing the edit
1632 * @param string $serialFormat Format for storing the content in the
1634 * @param array|null $tags Change tags to apply to this edit
1635 * Callers are responsible for permission checks
1636 * (with ChangeTags::canAddTagsAccompanyingChange)
1638 * @throws MWException
1639 * @return Status Possible errors:
1640 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1641 * set the fatal flag of $status.
1642 * edit-gone-missing: In update mode, but the article didn't exist.
1643 * edit-conflict: In update mode, the article changed unexpectedly.
1644 * edit-no-change: Warning that the text was the same as before.
1645 * edit-already-exists: In creation mode, but the article already exists.
1647 * Extensions may define additional errors.
1649 * $return->value will contain an associative array with members as follows:
1650 * new: Boolean indicating if the function attempted to create a new article.
1651 * revision: The revision object for the inserted revision, or null.
1654 * @throws MWException
1656 public function doEditContent(
1657 Content
$content, $summary, $flags = 0, $baseRevId = false,
1658 User
$user = null, $serialFormat = null, $tags = []
1660 global $wgUser, $wgUseAutomaticEditSummaries;
1662 // Old default parameter for $tags was null
1663 if ( $tags === null ) {
1667 // Low-level sanity check
1668 if ( $this->mTitle
->getText() === '' ) {
1669 throw new MWException( 'Something is trying to edit an article with an empty title' );
1671 // Make sure the given content type is allowed for this page
1672 if ( !$content->getContentHandler()->canBeUsedOn( $this->mTitle
) ) {
1673 return Status
::newFatal( 'content-not-allowed-here',
1674 ContentHandler
::getLocalizedName( $content->getModel() ),
1675 $this->mTitle
->getPrefixedText()
1679 // Load the data from the master database if needed.
1680 // The caller may already loaded it from the master or even loaded it using
1681 // SELECT FOR UPDATE, so do not override that using clear().
1682 $this->loadPageData( 'fromdbmaster' );
1684 $user = $user ?
: $wgUser;
1685 $flags = $this->checkFlags( $flags );
1687 // Trigger pre-save hook (using provided edit summary)
1688 $hookStatus = Status
::newGood( [] );
1689 $hook_args = [ &$this, &$user, &$content, &$summary,
1690 $flags & EDIT_MINOR
, null, null, &$flags, &$hookStatus ];
1691 // Check if the hook rejected the attempted save
1692 if ( !Hooks
::run( 'PageContentSave', $hook_args )
1693 ||
!ContentHandler
::runLegacyHooks( 'ArticleSave', $hook_args, '1.21' )
1695 if ( $hookStatus->isOK() ) {
1696 // Hook returned false but didn't call fatal(); use generic message
1697 $hookStatus->fatal( 'edit-hook-aborted' );
1703 $old_revision = $this->getRevision(); // current revision
1704 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1706 if ( $old_content && $old_content->getModel() !== $content->getModel() ) {
1707 $tags[] = 'mw-contentmodelchange';
1710 // Provide autosummaries if one is not provided and autosummaries are enabled
1711 if ( $wgUseAutomaticEditSummaries && ( $flags & EDIT_AUTOSUMMARY
) && $summary == '' ) {
1712 $handler = $content->getContentHandler();
1713 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1716 // Avoid statsd noise and wasted cycles check the edit stash (T136678)
1717 if ( ( $flags & EDIT_INTERNAL
) ||
( $flags & EDIT_FORCE_BOT
) ) {
1723 // Get the pre-save transform content and final parser output
1724 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat, $useCache );
1725 $pstContent = $editInfo->pstContent
; // Content object
1727 'bot' => ( $flags & EDIT_FORCE_BOT
),
1728 'minor' => ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' ),
1729 'serialized' => $editInfo->pst
,
1730 'serialFormat' => $serialFormat,
1731 'baseRevId' => $baseRevId,
1732 'oldRevision' => $old_revision,
1733 'oldContent' => $old_content,
1734 'oldId' => $this->getLatest(),
1735 'oldIsRedirect' => $this->isRedirect(),
1736 'oldCountable' => $this->isCountable(),
1737 'tags' => ( $tags !== null ) ?
(array)$tags : []
1740 // Actually create the revision and create/update the page
1741 if ( $flags & EDIT_UPDATE
) {
1742 $status = $this->doModify( $pstContent, $flags, $user, $summary, $meta );
1744 $status = $this->doCreate( $pstContent, $flags, $user, $summary, $meta );
1747 // Promote user to any groups they meet the criteria for
1748 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
1749 $user->addAutopromoteOnceGroups( 'onEdit' );
1750 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1757 * @param Content $content Pre-save transform content
1758 * @param integer $flags
1760 * @param string $summary
1761 * @param array $meta
1763 * @throws DBUnexpectedError
1765 * @throws FatalError
1766 * @throws MWException
1768 private function doModify(
1769 Content
$content, $flags, User
$user, $summary, array $meta
1771 global $wgUseRCPatrol;
1773 // Update article, but only if changed.
1774 $status = Status
::newGood( [ 'new' => false, 'revision' => null ] );
1776 // Convenience variables
1777 $now = wfTimestampNow();
1778 $oldid = $meta['oldId'];
1779 /** @var $oldContent Content|null */
1780 $oldContent = $meta['oldContent'];
1781 $newsize = $content->getSize();
1784 // Article gone missing
1785 $status->fatal( 'edit-gone-missing' );
1788 } elseif ( !$oldContent ) {
1789 // Sanity check for bug 37225
1790 throw new MWException( "Could not find text for current revision {$oldid}." );
1793 // @TODO: pass content object?!
1794 $revision = new Revision( [
1795 'page' => $this->getId(),
1796 'title' => $this->mTitle
, // for determining the default content model
1797 'comment' => $summary,
1798 'minor_edit' => $meta['minor'],
1799 'text' => $meta['serialized'],
1801 'parent_id' => $oldid,
1802 'user' => $user->getId(),
1803 'user_text' => $user->getName(),
1804 'timestamp' => $now,
1805 'content_model' => $content->getModel(),
1806 'content_format' => $meta['serialFormat'],
1809 $changed = !$content->equals( $oldContent );
1811 $dbw = wfGetDB( DB_MASTER
);
1814 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1815 $status->merge( $prepStatus );
1816 if ( !$status->isOK() ) {
1820 $dbw->startAtomic( __METHOD__
);
1821 // Get the latest page_latest value while locking it.
1822 // Do a CAS style check to see if it's the same as when this method
1823 // started. If it changed then bail out before touching the DB.
1824 $latestNow = $this->lockAndGetLatest();
1825 if ( $latestNow != $oldid ) {
1826 $dbw->endAtomic( __METHOD__
);
1827 // Page updated or deleted in the mean time
1828 $status->fatal( 'edit-conflict' );
1833 // At this point we are now comitted to returning an OK
1834 // status unless some DB query error or other exception comes up.
1835 // This way callers don't have to call rollback() if $status is bad
1836 // unless they actually try to catch exceptions (which is rare).
1838 // Save the revision text
1839 $revisionId = $revision->insertOn( $dbw );
1840 // Update page_latest and friends to reflect the new revision
1841 if ( !$this->updateRevisionOn( $dbw, $revision, null, $meta['oldIsRedirect'] ) ) {
1842 throw new MWException( "Failed to update page row to use new revision." );
1845 Hooks
::run( 'NewRevisionFromEditComplete',
1846 [ $this, $revision, $meta['baseRevId'], $user ] );
1848 // Update recentchanges
1849 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1850 // Mark as patrolled if the user can do so
1851 $patrolled = $wgUseRCPatrol && !count(
1852 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1853 // Add RC row to the DB
1854 RecentChange
::notifyEdit(
1857 $revision->isMinor(),
1861 $this->getTimestamp(),
1864 $oldContent ?
$oldContent->getSize() : 0,
1872 $user->incEditCount();
1874 $dbw->endAtomic( __METHOD__
);
1875 $this->mTimestamp
= $now;
1877 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1878 // related variables correctly. Likewise for {{REVISIONUSER}} (T135261).
1879 $revision->setId( $this->getLatest() );
1880 $revision->setUserIdAndName(
1881 $this->getUser( Revision
::RAW
),
1882 $this->getUserText( Revision
::RAW
)
1887 // Return the new revision to the caller
1888 $status->value
['revision'] = $revision;
1890 $status->warning( 'edit-no-change' );
1891 // Update page_touched as updateRevisionOn() was not called.
1892 // Other cache updates are managed in onArticleEdit() via doEditUpdates().
1893 $this->mTitle
->invalidateCache( $now );
1896 // Do secondary updates once the main changes have been committed...
1897 DeferredUpdates
::addUpdate(
1898 new AtomicSectionUpdate(
1902 $revision, &$user, $content, $summary, &$flags,
1903 $changed, $meta, &$status
1905 // Update links tables, site stats, etc.
1906 $this->doEditUpdates(
1910 'changed' => $changed,
1911 'oldcountable' => $meta['oldCountable'],
1912 'oldrevision' => $meta['oldRevision']
1915 // Trigger post-save hook
1916 $params = [ &$this, &$user, $content, $summary, $flags & EDIT_MINOR
,
1917 null, null, &$flags, $revision, &$status, $meta['baseRevId'] ];
1918 ContentHandler
::runLegacyHooks( 'ArticleSaveComplete', $params );
1919 Hooks
::run( 'PageContentSaveComplete', $params );
1922 DeferredUpdates
::PRESEND
1929 * @param Content $content Pre-save transform content
1930 * @param integer $flags
1932 * @param string $summary
1933 * @param array $meta
1935 * @throws DBUnexpectedError
1937 * @throws FatalError
1938 * @throws MWException
1940 private function doCreate(
1941 Content
$content, $flags, User
$user, $summary, array $meta
1943 global $wgUseRCPatrol, $wgUseNPPatrol;
1945 $status = Status
::newGood( [ 'new' => true, 'revision' => null ] );
1947 $now = wfTimestampNow();
1948 $newsize = $content->getSize();
1949 $prepStatus = $content->prepareSave( $this, $flags, $meta['oldId'], $user );
1950 $status->merge( $prepStatus );
1951 if ( !$status->isOK() ) {
1955 $dbw = wfGetDB( DB_MASTER
);
1956 $dbw->startAtomic( __METHOD__
);
1958 // Add the page record unless one already exists for the title
1959 $newid = $this->insertOn( $dbw );
1960 if ( $newid === false ) {
1961 $dbw->endAtomic( __METHOD__
); // nothing inserted
1962 $status->fatal( 'edit-already-exists' );
1964 return $status; // nothing done
1967 // At this point we are now comitted to returning an OK
1968 // status unless some DB query error or other exception comes up.
1969 // This way callers don't have to call rollback() if $status is bad
1970 // unless they actually try to catch exceptions (which is rare).
1972 // @TODO: pass content object?!
1973 $revision = new Revision( [
1975 'title' => $this->mTitle
, // for determining the default content model
1976 'comment' => $summary,
1977 'minor_edit' => $meta['minor'],
1978 'text' => $meta['serialized'],
1980 'user' => $user->getId(),
1981 'user_text' => $user->getName(),
1982 'timestamp' => $now,
1983 'content_model' => $content->getModel(),
1984 'content_format' => $meta['serialFormat'],
1987 // Save the revision text...
1988 $revisionId = $revision->insertOn( $dbw );
1989 // Update the page record with revision data
1990 if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1991 throw new MWException( "Failed to update page row to use new revision." );
1994 Hooks
::run( 'NewRevisionFromEditComplete', [ $this, $revision, false, $user ] );
1996 // Update recentchanges
1997 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1998 // Mark as patrolled if the user can do so
1999 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) &&
2000 !count( $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
2001 // Add RC row to the DB
2002 RecentChange
::notifyNew(
2005 $revision->isMinor(),
2017 $user->incEditCount();
2019 $dbw->endAtomic( __METHOD__
);
2020 $this->mTimestamp
= $now;
2022 // Return the new revision to the caller
2023 $status->value
['revision'] = $revision;
2025 // Do secondary updates once the main changes have been committed...
2026 DeferredUpdates
::addUpdate(
2027 new AtomicSectionUpdate(
2031 $revision, &$user, $content, $summary, &$flags, $meta, &$status
2033 // Update links, etc.
2034 $this->doEditUpdates( $revision, $user, [ 'created' => true ] );
2035 // Trigger post-create hook
2036 $params = [ &$this, &$user, $content, $summary,
2037 $flags & EDIT_MINOR
, null, null, &$flags, $revision ];
2038 ContentHandler
::runLegacyHooks( 'ArticleInsertComplete', $params, '1.21' );
2039 Hooks
::run( 'PageContentInsertComplete', $params );
2040 // Trigger post-save hook
2041 $params = array_merge( $params, [ &$status, $meta['baseRevId'] ] );
2042 ContentHandler
::runLegacyHooks( 'ArticleSaveComplete', $params, '1.21' );
2043 Hooks
::run( 'PageContentSaveComplete', $params );
2047 DeferredUpdates
::PRESEND
2054 * Get parser options suitable for rendering the primary article wikitext
2056 * @see ContentHandler::makeParserOptions
2058 * @param IContextSource|User|string $context One of the following:
2059 * - IContextSource: Use the User and the Language of the provided
2061 * - User: Use the provided User object and $wgLang for the language,
2062 * so use an IContextSource object if possible.
2063 * - 'canonical': Canonical options (anonymous user with default
2064 * preferences and content language).
2065 * @return ParserOptions
2067 public function makeParserOptions( $context ) {
2068 $options = $this->getContentHandler()->makeParserOptions( $context );
2070 if ( $this->getTitle()->isConversionTable() ) {
2071 // @todo ConversionTable should become a separate content model, so
2072 // we don't need special cases like this one.
2073 $options->disableContentConversion();
2080 * Prepare content which is about to be saved.
2081 * Returns a stdClass with source, pst and output members
2083 * @param Content $content
2084 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2085 * revision ID is also accepted, but this is deprecated.
2086 * @param User|null $user
2087 * @param string|null $serialFormat
2088 * @param bool $useCache Check shared prepared edit cache
2094 public function prepareContentForEdit(
2095 Content
$content, $revision = null, User
$user = null,
2096 $serialFormat = null, $useCache = true
2098 global $wgContLang, $wgUser, $wgAjaxEditStash;
2100 if ( is_object( $revision ) ) {
2101 $revid = $revision->getId();
2104 // This code path is deprecated, and nothing is known to
2105 // use it, so performance here shouldn't be a worry.
2106 if ( $revid !== null ) {
2107 $revision = Revision
::newFromId( $revid, Revision
::READ_LATEST
);
2113 $user = is_null( $user ) ?
$wgUser : $user;
2114 // XXX: check $user->getId() here???
2116 // Use a sane default for $serialFormat, see bug 57026
2117 if ( $serialFormat === null ) {
2118 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2121 if ( $this->mPreparedEdit
2122 && isset( $this->mPreparedEdit
->newContent
)
2123 && $this->mPreparedEdit
->newContent
->equals( $content )
2124 && $this->mPreparedEdit
->revid
== $revid
2125 && $this->mPreparedEdit
->format
== $serialFormat
2126 // XXX: also check $user here?
2129 return $this->mPreparedEdit
;
2132 // The edit may have already been prepared via api.php?action=stashedit
2133 $cachedEdit = $useCache && $wgAjaxEditStash
2134 ? ApiStashEdit
::checkCache( $this->getTitle(), $content, $user )
2137 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2138 Hooks
::run( 'ArticlePrepareTextForEdit', [ $this, $popts ] );
2141 if ( $cachedEdit ) {
2142 $edit->timestamp
= $cachedEdit->timestamp
;
2144 $edit->timestamp
= wfTimestampNow();
2146 // @note: $cachedEdit is safely not used if the rev ID was referenced in the text
2147 $edit->revid
= $revid;
2149 if ( $cachedEdit ) {
2150 $edit->pstContent
= $cachedEdit->pstContent
;
2152 $edit->pstContent
= $content
2153 ?
$content->preSaveTransform( $this->mTitle
, $user, $popts )
2157 $edit->format
= $serialFormat;
2158 $edit->popts
= $this->makeParserOptions( 'canonical' );
2159 if ( $cachedEdit ) {
2160 $edit->output
= $cachedEdit->output
;
2163 // We get here if vary-revision is set. This means that this page references
2164 // itself (such as via self-transclusion). In this case, we need to make sure
2165 // that any such self-references refer to the newly-saved revision, and not
2166 // to the previous one, which could otherwise happen due to replica DB lag.
2167 $oldCallback = $edit->popts
->getCurrentRevisionCallback();
2168 $edit->popts
->setCurrentRevisionCallback(
2169 function ( Title
$title, $parser = false ) use ( $revision, &$oldCallback ) {
2170 if ( $title->equals( $revision->getTitle() ) ) {
2173 return call_user_func( $oldCallback, $title, $parser );
2178 // Try to avoid a second parse if {{REVISIONID}} is used
2179 $edit->popts
->setSpeculativeRevIdCallback( function () {
2180 return 1 +
(int)wfGetDB( DB_MASTER
)->selectField(
2188 $edit->output
= $edit->pstContent
2189 ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
)
2193 $edit->newContent
= $content;
2194 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2196 // NOTE: B/C for hooks! don't use these fields!
2197 $edit->newText
= $edit->newContent
2198 ? ContentHandler
::getContentText( $edit->newContent
)
2200 $edit->oldText
= $edit->oldContent
2201 ? ContentHandler
::getContentText( $edit->oldContent
)
2203 $edit->pst
= $edit->pstContent ?
$edit->pstContent
->serialize( $serialFormat ) : '';
2205 if ( $edit->output
) {
2206 $edit->output
->setCacheTime( wfTimestampNow() );
2209 // Process cache the result
2210 $this->mPreparedEdit
= $edit;
2216 * Do standard deferred updates after page edit.
2217 * Update links tables, site stats, search index and message cache.
2218 * Purges pages that include this page if the text was changed here.
2219 * Every 100th edit, prune the recent changes table.
2221 * @param Revision $revision
2222 * @param User $user User object that did the revision
2223 * @param array $options Array of options, following indexes are used:
2224 * - changed: boolean, whether the revision changed the content (default true)
2225 * - created: boolean, whether the revision created the page (default false)
2226 * - moved: boolean, whether the page was moved (default false)
2227 * - restored: boolean, whether the page was undeleted (default false)
2228 * - oldrevision: Revision object for the pre-update revision (default null)
2229 * - oldcountable: boolean, null, or string 'no-change' (default null):
2230 * - boolean: whether the page was counted as an article before that
2231 * revision, only used in changed is true and created is false
2232 * - null: if created is false, don't update the article count; if created
2233 * is true, do update the article count
2234 * - 'no-change': don't update the article count, ever
2236 public function doEditUpdates( Revision
$revision, User
$user, array $options = [] ) {
2237 global $wgRCWatchCategoryMembership, $wgContLang;
2243 'restored' => false,
2244 'oldrevision' => null,
2245 'oldcountable' => null
2247 $content = $revision->getContent();
2249 $logger = LoggerFactory
::getInstance( 'SaveParse' );
2251 // See if the parser output before $revision was inserted is still valid
2253 if ( !$this->mPreparedEdit
) {
2254 $logger->debug( __METHOD__
. ": No prepared edit...\n" );
2255 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2256 $logger->info( __METHOD__
. ": Prepared edit has vary-revision...\n" );
2257 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision-id' )
2258 && $this->mPreparedEdit
->output
->getSpeculativeRevIdUsed() !== $revision->getId()
2260 $logger->info( __METHOD__
. ": Prepared edit has vary-revision-id with wrong ID...\n" );
2261 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-user' ) && !$options['changed'] ) {
2262 $logger->info( __METHOD__
. ": Prepared edit has vary-user and is null...\n" );
2264 wfDebug( __METHOD__
. ": Using prepared edit...\n" );
2265 $editInfo = $this->mPreparedEdit
;
2269 // Parse the text again if needed. Be careful not to do pre-save transform twice:
2270 // $text is usually already pre-save transformed once. Avoid using the edit stash
2271 // as any prepared content from there or in doEditContent() was already rejected.
2272 $editInfo = $this->prepareContentForEdit( $content, $revision, $user, null, false );
2275 // Save it to the parser cache.
2276 // Make sure the cache time matches page_touched to avoid double parsing.
2277 ParserCache
::singleton()->save(
2278 $editInfo->output
, $this, $editInfo->popts
,
2279 $revision->getTimestamp(), $editInfo->revid
2282 // Update the links tables and other secondary data
2284 $recursive = $options['changed']; // bug 50785
2285 $updates = $content->getSecondaryDataUpdates(
2286 $this->getTitle(), null, $recursive, $editInfo->output
2288 foreach ( $updates as $update ) {
2289 if ( $update instanceof LinksUpdate
) {
2290 $update->setRevision( $revision );
2291 $update->setTriggeringUser( $user );
2293 DeferredUpdates
::addUpdate( $update );
2295 if ( $wgRCWatchCategoryMembership
2296 && $this->getContentHandler()->supportsCategories() === true
2297 && ( $options['changed'] ||
$options['created'] )
2298 && !$options['restored']
2300 // Note: jobs are pushed after deferred updates, so the job should be able to see
2301 // the recent change entry (also done via deferred updates) and carry over any
2302 // bot/deletion/IP flags, ect.
2303 JobQueueGroup
::singleton()->lazyPush( new CategoryMembershipChangeJob(
2306 'pageId' => $this->getId(),
2307 'revTimestamp' => $revision->getTimestamp()
2313 Hooks
::run( 'ArticleEditUpdates', [ &$this, &$editInfo, $options['changed'] ] );
2315 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', [ &$this ] ) ) {
2316 // Flush old entries from the `recentchanges` table
2317 if ( mt_rand( 0, 9 ) == 0 ) {
2318 JobQueueGroup
::singleton()->lazyPush( RecentChangesUpdateJob
::newPurgeJob() );
2322 if ( !$this->exists() ) {
2326 $id = $this->getId();
2327 $title = $this->mTitle
->getPrefixedDBkey();
2328 $shortTitle = $this->mTitle
->getDBkey();
2330 if ( $options['oldcountable'] === 'no-change' ||
2331 ( !$options['changed'] && !$options['moved'] )
2334 } elseif ( $options['created'] ) {
2335 $good = (int)$this->isCountable( $editInfo );
2336 } elseif ( $options['oldcountable'] !== null ) {
2337 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2341 $edits = $options['changed'] ?
1 : 0;
2342 $total = $options['created'] ?
1 : 0;
2344 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2345 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2347 // If this is another user's talk page, update newtalk.
2348 // Don't do this if $options['changed'] = false (null-edits) nor if
2349 // it's a minor edit and the user doesn't want notifications for those.
2350 if ( $options['changed']
2351 && $this->mTitle
->getNamespace() == NS_USER_TALK
2352 && $shortTitle != $user->getTitleKey()
2353 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2355 $recipient = User
::newFromName( $shortTitle, false );
2356 if ( !$recipient ) {
2357 wfDebug( __METHOD__
. ": invalid username\n" );
2359 // Allow extensions to prevent user notification
2360 // when a new message is added to their talk page
2361 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', [ &$this, $recipient ] ) ) {
2362 if ( User
::isIP( $shortTitle ) ) {
2363 // An anonymous user
2364 $recipient->setNewtalk( true, $revision );
2365 } elseif ( $recipient->isLoggedIn() ) {
2366 $recipient->setNewtalk( true, $revision );
2368 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2374 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2375 // XXX: could skip pseudo-messages like js/css here, based on content model.
2376 $msgtext = $content ?
$content->getWikitextForTransclusion() : null;
2377 if ( $msgtext === false ||
$msgtext === null ) {
2381 MessageCache
::singleton()->replace( $shortTitle, $msgtext );
2383 if ( $wgContLang->hasVariants() ) {
2384 $wgContLang->updateConversionTable( $this->mTitle
);
2388 if ( $options['created'] ) {
2389 self
::onArticleCreate( $this->mTitle
);
2390 } elseif ( $options['changed'] ) { // bug 50785
2391 self
::onArticleEdit( $this->mTitle
, $revision );
2394 ResourceLoaderWikiModule
::invalidateModuleCache(
2395 $this->mTitle
, $options['oldrevision'], $revision, wfWikiID()
2400 * Update the article's restriction field, and leave a log entry.
2401 * This works for protection both existing and non-existing pages.
2403 * @param array $limit Set of restriction keys
2404 * @param array $expiry Per restriction type expiration
2405 * @param int &$cascade Set to false if cascading protection isn't allowed.
2406 * @param string $reason
2407 * @param User $user The user updating the restrictions
2408 * @param string|string[] $tags Change tags to add to the pages and protection log entries
2409 * ($user should be able to add the specified tags before this is called)
2410 * @return Status Status object; if action is taken, $status->value is the log_id of the
2411 * protection log entry.
2413 public function doUpdateRestrictions( array $limit, array $expiry,
2414 &$cascade, $reason, User
$user, $tags = null
2416 global $wgCascadingRestrictionLevels, $wgContLang;
2418 if ( wfReadOnly() ) {
2419 return Status
::newFatal( 'readonlytext', wfReadOnlyReason() );
2422 $this->loadPageData( 'fromdbmaster' );
2423 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2424 $id = $this->getId();
2430 // Take this opportunity to purge out expired restrictions
2431 Title
::purgeExpiredRestrictions();
2433 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2434 // we expect a single selection, but the schema allows otherwise.
2435 $isProtected = false;
2439 $dbw = wfGetDB( DB_MASTER
);
2441 foreach ( $restrictionTypes as $action ) {
2442 if ( !isset( $expiry[$action] ) ||
$expiry[$action] === $dbw->getInfinity() ) {
2443 $expiry[$action] = 'infinity';
2445 if ( !isset( $limit[$action] ) ) {
2446 $limit[$action] = '';
2447 } elseif ( $limit[$action] != '' ) {
2451 // Get current restrictions on $action
2452 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2453 if ( $current != '' ) {
2454 $isProtected = true;
2457 if ( $limit[$action] != $current ) {
2459 } elseif ( $limit[$action] != '' ) {
2460 // Only check expiry change if the action is actually being
2461 // protected, since expiry does nothing on an not-protected
2463 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2469 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2473 // If nothing has changed, do nothing
2475 return Status
::newGood();
2478 if ( !$protect ) { // No protection at all means unprotection
2479 $revCommentMsg = 'unprotectedarticle-comment';
2480 $logAction = 'unprotect';
2481 } elseif ( $isProtected ) {
2482 $revCommentMsg = 'modifiedarticleprotection-comment';
2483 $logAction = 'modify';
2485 $revCommentMsg = 'protectedarticle-comment';
2486 $logAction = 'protect';
2489 // Truncate for whole multibyte characters
2490 $reason = $wgContLang->truncate( $reason, 255 );
2492 $logRelationsValues = [];
2493 $logRelationsField = null;
2494 $logParamsDetails = [];
2496 // Null revision (used for change tag insertion)
2497 $nullRevision = null;
2499 if ( $id ) { // Protection of existing page
2500 if ( !Hooks
::run( 'ArticleProtect', [ &$this, &$user, $limit, $reason ] ) ) {
2501 return Status
::newGood();
2504 // Only certain restrictions can cascade...
2505 $editrestriction = isset( $limit['edit'] )
2506 ?
[ $limit['edit'] ]
2507 : $this->mTitle
->getRestrictions( 'edit' );
2508 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2509 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2511 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2512 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2515 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2516 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2517 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2519 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2520 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2523 // The schema allows multiple restrictions
2524 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2528 // insert null revision to identify the page protection change as edit summary
2529 $latest = $this->getLatest();
2530 $nullRevision = $this->insertProtectNullRevision(
2539 if ( $nullRevision === null ) {
2540 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2543 $logRelationsField = 'pr_id';
2545 // Update restrictions table
2546 foreach ( $limit as $action => $restrictions ) {
2548 'page_restrictions',
2551 'pr_type' => $action
2555 if ( $restrictions != '' ) {
2556 $cascadeValue = ( $cascade && $action == 'edit' ) ?
1 : 0;
2558 'page_restrictions',
2560 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2562 'pr_type' => $action,
2563 'pr_level' => $restrictions,
2564 'pr_cascade' => $cascadeValue,
2565 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2569 $logRelationsValues[] = $dbw->insertId();
2570 $logParamsDetails[] = [
2572 'level' => $restrictions,
2573 'expiry' => $expiry[$action],
2574 'cascade' => (bool)$cascadeValue,
2579 // Clear out legacy restriction fields
2582 [ 'page_restrictions' => '' ],
2583 [ 'page_id' => $id ],
2587 Hooks
::run( 'NewRevisionFromEditComplete',
2588 [ $this, $nullRevision, $latest, $user ] );
2589 Hooks
::run( 'ArticleProtectComplete', [ &$this, &$user, $limit, $reason ] );
2590 } else { // Protection of non-existing page (also known as "title protection")
2591 // Cascade protection is meaningless in this case
2594 if ( $limit['create'] != '' ) {
2595 $dbw->replace( 'protected_titles',
2596 [ [ 'pt_namespace', 'pt_title' ] ],
2598 'pt_namespace' => $this->mTitle
->getNamespace(),
2599 'pt_title' => $this->mTitle
->getDBkey(),
2600 'pt_create_perm' => $limit['create'],
2601 'pt_timestamp' => $dbw->timestamp(),
2602 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2603 'pt_user' => $user->getId(),
2604 'pt_reason' => $reason,
2607 $logParamsDetails[] = [
2609 'level' => $limit['create'],
2610 'expiry' => $expiry['create'],
2613 $dbw->delete( 'protected_titles',
2615 'pt_namespace' => $this->mTitle
->getNamespace(),
2616 'pt_title' => $this->mTitle
->getDBkey()
2622 $this->mTitle
->flushRestrictions();
2623 InfoAction
::invalidateCache( $this->mTitle
);
2625 if ( $logAction == 'unprotect' ) {
2628 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2630 '4::description' => $protectDescriptionLog, // parameter for IRC
2631 '5:bool:cascade' => $cascade,
2632 'details' => $logParamsDetails, // parameter for localize and api
2636 // Update the protection log
2637 $logEntry = new ManualLogEntry( 'protect', $logAction );
2638 $logEntry->setTarget( $this->mTitle
);
2639 $logEntry->setComment( $reason );
2640 $logEntry->setPerformer( $user );
2641 $logEntry->setParameters( $params );
2642 if ( !is_null( $nullRevision ) ) {
2643 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2645 $logEntry->setTags( $tags );
2646 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2647 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2649 $logId = $logEntry->insert();
2650 $logEntry->publish( $logId );
2652 return Status
::newGood( $logId );
2656 * Insert a new null revision for this page.
2658 * @param string $revCommentMsg Comment message key for the revision
2659 * @param array $limit Set of restriction keys
2660 * @param array $expiry Per restriction type expiration
2661 * @param int $cascade Set to false if cascading protection isn't allowed.
2662 * @param string $reason
2663 * @param User|null $user
2664 * @return Revision|null Null on error
2666 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2667 array $expiry, $cascade, $reason, $user = null
2669 $dbw = wfGetDB( DB_MASTER
);
2671 // Prepare a null revision to be added to the history
2672 $editComment = wfMessage(
2674 $this->mTitle
->getPrefixedText(),
2675 $user ?
$user->getName() : ''
2676 )->inContentLanguage()->text();
2678 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2680 $protectDescription = $this->protectDescription( $limit, $expiry );
2681 if ( $protectDescription ) {
2682 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2683 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2684 ->inContentLanguage()->text();
2687 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2688 $editComment .= wfMessage( 'brackets' )->params(
2689 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2690 )->inContentLanguage()->text();
2693 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2695 $nullRev->insertOn( $dbw );
2697 // Update page record and touch page
2698 $oldLatest = $nullRev->getParentId();
2699 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2706 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2709 protected function formatExpiry( $expiry ) {
2712 if ( $expiry != 'infinity' ) {
2715 $wgContLang->timeanddate( $expiry, false, false ),
2716 $wgContLang->date( $expiry, false, false ),
2717 $wgContLang->time( $expiry, false, false )
2718 )->inContentLanguage()->text();
2720 return wfMessage( 'protect-expiry-indefinite' )
2721 ->inContentLanguage()->text();
2726 * Builds the description to serve as comment for the edit.
2728 * @param array $limit Set of restriction keys
2729 * @param array $expiry Per restriction type expiration
2732 public function protectDescription( array $limit, array $expiry ) {
2733 $protectDescription = '';
2735 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2736 # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2737 # All possible message keys are listed here for easier grepping:
2738 # * restriction-create
2739 # * restriction-edit
2740 # * restriction-move
2741 # * restriction-upload
2742 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2743 # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2744 # with '' filtered out. All possible message keys are listed below:
2745 # * protect-level-autoconfirmed
2746 # * protect-level-sysop
2747 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2748 ->inContentLanguage()->text();
2750 $expiryText = $this->formatExpiry( $expiry[$action] );
2752 if ( $protectDescription !== '' ) {
2753 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2755 $protectDescription .= wfMessage( 'protect-summary-desc' )
2756 ->params( $actionText, $restrictionsText, $expiryText )
2757 ->inContentLanguage()->text();
2760 return $protectDescription;
2764 * Builds the description to serve as comment for the log entry.
2766 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2767 * protect description text. Keep them in old format to avoid breaking compatibility.
2768 * TODO: Fix protection log to store structured description and format it on-the-fly.
2770 * @param array $limit Set of restriction keys
2771 * @param array $expiry Per restriction type expiration
2774 public function protectDescriptionLog( array $limit, array $expiry ) {
2777 $protectDescriptionLog = '';
2779 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2780 $expiryText = $this->formatExpiry( $expiry[$action] );
2781 $protectDescriptionLog .= $wgContLang->getDirMark() .
2782 "[$action=$restrictions] ($expiryText)";
2785 return trim( $protectDescriptionLog );
2789 * Take an array of page restrictions and flatten it to a string
2790 * suitable for insertion into the page_restrictions field.
2792 * @param string[] $limit
2794 * @throws MWException
2797 protected static function flattenRestrictions( $limit ) {
2798 if ( !is_array( $limit ) ) {
2799 throw new MWException( __METHOD__
. ' given non-array restriction set' );
2805 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2806 $bits[] = "$action=$restrictions";
2809 return implode( ':', $bits );
2813 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2814 * backwards compatibility, if you care about error reporting you should use
2815 * doDeleteArticleReal() instead.
2817 * Deletes the article with database consistency, writes logs, purges caches
2819 * @param string $reason Delete reason for deletion log
2820 * @param bool $suppress Suppress all revisions and log the deletion in
2821 * the suppression log instead of the deletion log
2822 * @param int $u1 Unused
2823 * @param bool $u2 Unused
2824 * @param array|string &$error Array of errors to append to
2825 * @param User $user The deleting user
2826 * @return bool True if successful
2828 public function doDeleteArticle(
2829 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null
2831 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2832 return $status->isGood();
2836 * Back-end article deletion
2837 * Deletes the article with database consistency, writes logs, purges caches
2841 * @param string $reason Delete reason for deletion log
2842 * @param bool $suppress Suppress all revisions and log the deletion in
2843 * the suppression log instead of the deletion log
2844 * @param int $u1 Unused
2845 * @param bool $u2 Unused
2846 * @param array|string &$error Array of errors to append to
2847 * @param User $user The deleting user
2848 * @param array $tags Tags to apply to the deletion action
2849 * @return Status Status object; if successful, $status->value is the log_id of the
2850 * deletion log entry. If the page couldn't be deleted because it wasn't
2851 * found, $status is a non-fatal 'cannotdelete' error
2853 public function doDeleteArticleReal(
2854 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null,
2855 $tags = [], $logsubtype = 'delete'
2857 global $wgUser, $wgContentHandlerUseDB;
2859 wfDebug( __METHOD__
. "\n" );
2861 $status = Status
::newGood();
2863 if ( $this->mTitle
->getDBkey() === '' ) {
2864 $status->error( 'cannotdelete',
2865 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2869 $user = is_null( $user ) ?
$wgUser : $user;
2870 if ( !Hooks
::run( 'ArticleDelete',
2871 [ &$this, &$user, &$reason, &$error, &$status, $suppress ]
2873 if ( $status->isOK() ) {
2874 // Hook aborted but didn't set a fatal status
2875 $status->fatal( 'delete-hook-aborted' );
2880 $dbw = wfGetDB( DB_MASTER
);
2881 $dbw->startAtomic( __METHOD__
);
2883 $this->loadPageData( self
::READ_LATEST
);
2884 $id = $this->getId();
2885 // T98706: lock the page from various other updates but avoid using
2886 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2887 // the revisions queries (which also JOIN on user). Only lock the page
2888 // row and CAS check on page_latest to see if the trx snapshot matches.
2889 $lockedLatest = $this->lockAndGetLatest();
2890 if ( $id == 0 ||
$this->getLatest() != $lockedLatest ) {
2891 $dbw->endAtomic( __METHOD__
);
2892 // Page not there or trx snapshot is stale
2893 $status->error( 'cannotdelete',
2894 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2898 // Given the lock above, we can be confident in the title and page ID values
2899 $namespace = $this->getTitle()->getNamespace();
2900 $dbKey = $this->getTitle()->getDBkey();
2902 // At this point we are now comitted to returning an OK
2903 // status unless some DB query error or other exception comes up.
2904 // This way callers don't have to call rollback() if $status is bad
2905 // unless they actually try to catch exceptions (which is rare).
2907 // we need to remember the old content so we can use it to generate all deletion updates.
2908 $revision = $this->getRevision();
2910 $content = $this->getContent( Revision
::RAW
);
2911 } catch ( Exception
$ex ) {
2912 wfLogWarning( __METHOD__
. ': failed to load content during deletion! '
2913 . $ex->getMessage() );
2918 $fields = Revision
::selectFields();
2921 // Bitfields to further suppress the content
2923 $bitfield = Revision
::SUPPRESSED_ALL
;
2924 $fields = array_diff( $fields, [ 'rev_deleted' ] );
2927 // For now, shunt the revision data into the archive table.
2928 // Text is *not* removed from the text table; bulk storage
2929 // is left intact to avoid breaking block-compression or
2930 // immutable storage schemes.
2931 // In the future, we may keep revisions and mark them with
2932 // the rev_deleted field, which is reserved for this purpose.
2934 // Get all of the page revisions
2935 $res = $dbw->select(
2938 [ 'rev_page' => $id ],
2942 // Build their equivalent archive rows
2944 foreach ( $res as $row ) {
2946 'ar_namespace' => $namespace,
2947 'ar_title' => $dbKey,
2948 'ar_comment' => $row->rev_comment
,
2949 'ar_user' => $row->rev_user
,
2950 'ar_user_text' => $row->rev_user_text
,
2951 'ar_timestamp' => $row->rev_timestamp
,
2952 'ar_minor_edit' => $row->rev_minor_edit
,
2953 'ar_rev_id' => $row->rev_id
,
2954 'ar_parent_id' => $row->rev_parent_id
,
2955 'ar_text_id' => $row->rev_text_id
,
2958 'ar_len' => $row->rev_len
,
2959 'ar_page_id' => $id,
2960 'ar_deleted' => $suppress ?
$bitfield : $row->rev_deleted
,
2961 'ar_sha1' => $row->rev_sha1
,
2963 if ( $wgContentHandlerUseDB ) {
2964 $rowInsert['ar_content_model'] = $row->rev_content_model
;
2965 $rowInsert['ar_content_format'] = $row->rev_content_format
;
2967 $rowsInsert[] = $rowInsert;
2969 // Copy them into the archive table
2970 $dbw->insert( 'archive', $rowsInsert, __METHOD__
);
2971 // Save this so we can pass it to the ArticleDeleteComplete hook.
2972 $archivedRevisionCount = $dbw->affectedRows();
2974 // Clone the title and wikiPage, so we have the information we need when
2975 // we log and run the ArticleDeleteComplete hook.
2976 $logTitle = clone $this->mTitle
;
2977 $wikiPageBeforeDelete = clone $this;
2979 // Now that it's safely backed up, delete it
2980 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__
);
2981 $dbw->delete( 'revision', [ 'rev_page' => $id ], __METHOD__
);
2983 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2984 $logtype = $suppress ?
'suppress' : 'delete';
2986 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2987 $logEntry->setPerformer( $user );
2988 $logEntry->setTarget( $logTitle );
2989 $logEntry->setComment( $reason );
2990 $logEntry->setTags( $tags );
2991 $logid = $logEntry->insert();
2993 $dbw->onTransactionPreCommitOrIdle(
2994 function () use ( $dbw, $logEntry, $logid ) {
2995 // Bug 56776: avoid deadlocks (especially from FileDeleteForm)
2996 $logEntry->publish( $logid );
3001 $dbw->endAtomic( __METHOD__
);
3003 $this->doDeleteUpdates( $id, $content, $revision );
3005 Hooks
::run( 'ArticleDeleteComplete', [
3006 &$wikiPageBeforeDelete,
3012 $archivedRevisionCount
3014 $status->value
= $logid;
3016 // Show log excerpt on 404 pages rather than just a link
3017 $cache = ObjectCache
::getMainStashInstance();
3018 $key = wfMemcKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
3019 $cache->set( $key, 1, $cache::TTL_DAY
);
3025 * Lock the page row for this title+id and return page_latest (or 0)
3027 * @return integer Returns 0 if no row was found with this title+id
3030 public function lockAndGetLatest() {
3031 return (int)wfGetDB( DB_MASTER
)->selectField(
3035 'page_id' => $this->getId(),
3036 // Typically page_id is enough, but some code might try to do
3037 // updates assuming the title is the same, so verify that
3038 'page_namespace' => $this->getTitle()->getNamespace(),
3039 'page_title' => $this->getTitle()->getDBkey()
3047 * Do some database updates after deletion
3049 * @param int $id The page_id value of the page being deleted
3050 * @param Content|null $content Optional page content to be used when determining
3051 * the required updates. This may be needed because $this->getContent()
3052 * may already return null when the page proper was deleted.
3053 * @param Revision|null $revision The latest page revision
3055 public function doDeleteUpdates( $id, Content
$content = null, Revision
$revision = null ) {
3057 $countable = $this->isCountable();
3058 } catch ( Exception
$ex ) {
3059 // fallback for deleting broken pages for which we cannot load the content for
3060 // some reason. Note that doDeleteArticleReal() already logged this problem.
3064 // Update site status
3065 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$countable, -1 ) );
3067 // Delete pagelinks, update secondary indexes, etc
3068 $updates = $this->getDeletionUpdates( $content );
3069 foreach ( $updates as $update ) {
3070 DeferredUpdates
::addUpdate( $update );
3073 // Reparse any pages transcluding this page
3074 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'templatelinks' );
3076 // Reparse any pages including this image
3077 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
3078 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'imagelinks' );
3082 WikiPage
::onArticleDelete( $this->mTitle
);
3083 ResourceLoaderWikiModule
::invalidateModuleCache(
3084 $this->mTitle
, $revision, null, wfWikiID()
3087 // Reset this object and the Title object
3088 $this->loadFromRow( false, self
::READ_LATEST
);
3091 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
3095 * Roll back the most recent consecutive set of edits to a page
3096 * from the same user; fails if there are no eligible edits to
3097 * roll back to, e.g. user is the sole contributor. This function
3098 * performs permissions checks on $user, then calls commitRollback()
3099 * to do the dirty work
3101 * @todo Separate the business/permission stuff out from backend code
3102 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3104 * @param string $fromP Name of the user whose edits to rollback.
3105 * @param string $summary Custom summary. Set to default summary if empty.
3106 * @param string $token Rollback token.
3107 * @param bool $bot If true, mark all reverted edits as bot.
3109 * @param array $resultDetails Array contains result-specific array of additional values
3110 * 'alreadyrolled' : 'current' (rev)
3111 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3113 * @param User $user The user performing the rollback
3114 * @param array|null $tags Change tags to apply to the rollback
3115 * Callers are responsible for permission checks
3116 * (with ChangeTags::canAddTagsAccompanyingChange)
3118 * @return array Array of errors, each error formatted as
3119 * array(messagekey, param1, param2, ...).
3120 * On success, the array is empty. This array can also be passed to
3121 * OutputPage::showPermissionsErrorPage().
3123 public function doRollback(
3124 $fromP, $summary, $token, $bot, &$resultDetails, User
$user, $tags = null
3126 $resultDetails = null;
3128 // Check permissions
3129 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
3130 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
3131 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3133 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3134 $errors[] = [ 'sessionfailure' ];
3137 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
3138 $errors[] = [ 'actionthrottledtext' ];
3141 // If there were errors, bail out now
3142 if ( !empty( $errors ) ) {
3146 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3150 * Backend implementation of doRollback(), please refer there for parameter
3151 * and return value documentation
3153 * NOTE: This function does NOT check ANY permissions, it just commits the
3154 * rollback to the DB. Therefore, you should only call this function direct-
3155 * ly if you want to use custom permissions checks. If you don't, use
3156 * doRollback() instead.
3157 * @param string $fromP Name of the user whose edits to rollback.
3158 * @param string $summary Custom summary. Set to default summary if empty.
3159 * @param bool $bot If true, mark all reverted edits as bot.
3161 * @param array $resultDetails Contains result-specific array of additional values
3162 * @param User $guser The user performing the rollback
3163 * @param array|null $tags Change tags to apply to the rollback
3164 * Callers are responsible for permission checks
3165 * (with ChangeTags::canAddTagsAccompanyingChange)
3169 public function commitRollback( $fromP, $summary, $bot,
3170 &$resultDetails, User
$guser, $tags = null
3172 global $wgUseRCPatrol, $wgContLang;
3174 $dbw = wfGetDB( DB_MASTER
);
3176 if ( wfReadOnly() ) {
3177 return [ [ 'readonlytext' ] ];
3180 // Get the last editor
3181 $current = $this->getRevision();
3182 if ( is_null( $current ) ) {
3183 // Something wrong... no page?
3184 return [ [ 'notanarticle' ] ];
3187 $from = str_replace( '_', ' ', $fromP );
3188 // User name given should match up with the top revision.
3189 // If the user was deleted then $from should be empty.
3190 if ( $from != $current->getUserText() ) {
3191 $resultDetails = [ 'current' => $current ];
3192 return [ [ 'alreadyrolled',
3193 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3194 htmlspecialchars( $fromP ),
3195 htmlspecialchars( $current->getUserText() )
3199 // Get the last edit not by this person...
3200 // Note: these may not be public values
3201 $user = intval( $current->getUser( Revision
::RAW
) );
3202 $user_text = $dbw->addQuotes( $current->getUserText( Revision
::RAW
) );
3203 $s = $dbw->selectRow( 'revision',
3204 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3205 [ 'rev_page' => $current->getPage(),
3206 "rev_user != {$user} OR rev_user_text != {$user_text}"
3208 [ 'USE INDEX' => 'page_timestamp',
3209 'ORDER BY' => 'rev_timestamp DESC' ]
3211 if ( $s === false ) {
3212 // No one else ever edited this page
3213 return [ [ 'cantrollback' ] ];
3214 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT
3215 ||
$s->rev_deleted
& Revision
::DELETED_USER
3217 // Only admins can see this text
3218 return [ [ 'notvisiblerev' ] ];
3221 // Generate the edit summary if necessary
3222 $target = Revision
::newFromId( $s->rev_id
, Revision
::READ_LATEST
);
3223 if ( empty( $summary ) ) {
3224 if ( $from == '' ) { // no public user name
3225 $summary = wfMessage( 'revertpage-nouser' );
3227 $summary = wfMessage( 'revertpage' );
3231 // Allow the custom summary to use the same args as the default message
3233 $target->getUserText(), $from, $s->rev_id
,
3234 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3235 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3237 if ( $summary instanceof Message
) {
3238 $summary = $summary->params( $args )->inContentLanguage()->text();
3240 $summary = wfMsgReplaceArgs( $summary, $args );
3243 // Trim spaces on user supplied text
3244 $summary = trim( $summary );
3246 // Truncate for whole multibyte characters.
3247 $summary = $wgContLang->truncate( $summary, 255 );
3250 $flags = EDIT_UPDATE | EDIT_INTERNAL
;
3252 if ( $guser->isAllowed( 'minoredit' ) ) {
3253 $flags |
= EDIT_MINOR
;
3256 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3257 $flags |
= EDIT_FORCE_BOT
;
3260 $targetContent = $target->getContent();
3261 $changingContentModel = $targetContent->getModel() !== $current->getContentModel();
3263 // Actually store the edit
3264 $status = $this->doEditContent(
3274 // Set patrolling and bot flag on the edits, which gets rollbacked.
3275 // This is done even on edit failure to have patrolling in that case (bug 62157).
3277 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3278 // Mark all reverted edits as bot
3282 if ( $wgUseRCPatrol ) {
3283 // Mark all reverted edits as patrolled
3284 $set['rc_patrolled'] = 1;
3287 if ( count( $set ) ) {
3288 $dbw->update( 'recentchanges', $set,
3290 'rc_cur_id' => $current->getPage(),
3291 'rc_user_text' => $current->getUserText(),
3292 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3298 if ( !$status->isOK() ) {
3299 return $status->getErrorsArray();
3302 // raise error, when the edit is an edit without a new version
3303 $statusRev = isset( $status->value
['revision'] )
3304 ?
$status->value
['revision']
3306 if ( !( $statusRev instanceof Revision
) ) {
3307 $resultDetails = [ 'current' => $current ];
3308 return [ [ 'alreadyrolled',
3309 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3310 htmlspecialchars( $fromP ),
3311 htmlspecialchars( $current->getUserText() )
3315 if ( $changingContentModel ) {
3316 // If the content model changed during the rollback,
3317 // make sure it gets logged to Special:Log/contentmodel
3318 $log = new ManualLogEntry( 'contentmodel', 'change' );
3319 $log->setPerformer( $guser );
3320 $log->setTarget( $this->mTitle
);
3321 $log->setComment( $summary );
3322 $log->setParameters( [
3323 '4::oldmodel' => $current->getContentModel(),
3324 '5::newmodel' => $targetContent->getModel(),
3327 $logId = $log->insert( $dbw );
3328 $log->publish( $logId );
3331 $revId = $statusRev->getId();
3333 Hooks
::run( 'ArticleRollbackComplete', [ $this, $guser, $target, $current ] );
3336 'summary' => $summary,
3337 'current' => $current,
3338 'target' => $target,
3346 * The onArticle*() functions are supposed to be a kind of hooks
3347 * which should be called whenever any of the specified actions
3350 * This is a good place to put code to clear caches, for instance.
3352 * This is called on page move and undelete, as well as edit
3354 * @param Title $title
3356 public static function onArticleCreate( Title
$title ) {
3357 // Update existence markers on article/talk tabs...
3358 $other = $title->getOtherPage();
3360 $other->purgeSquid();
3362 $title->touchLinks();
3363 $title->purgeSquid();
3364 $title->deleteTitleProtection();
3366 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3368 if ( $title->getNamespace() == NS_CATEGORY
) {
3369 // Load the Category object, which will schedule a job to create
3370 // the category table row if necessary. Checking a replica DB is ok
3371 // here, in the worst case it'll run an unnecessary recount job on
3372 // a category that probably doesn't have many members.
3373 Category
::newFromTitle( $title )->getID();
3378 * Clears caches when article is deleted
3380 * @param Title $title
3382 public static function onArticleDelete( Title
$title ) {
3385 // Update existence markers on article/talk tabs...
3386 $other = $title->getOtherPage();
3388 $other->purgeSquid();
3390 $title->touchLinks();
3391 $title->purgeSquid();
3393 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3396 HTMLFileCache
::clearFileCache( $title );
3397 InfoAction
::invalidateCache( $title );
3400 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3401 MessageCache
::singleton()->replace( $title->getDBkey(), false );
3403 if ( $wgContLang->hasVariants() ) {
3404 $wgContLang->updateConversionTable( $title );
3409 if ( $title->getNamespace() == NS_FILE
) {
3410 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'imagelinks' ) );
3414 if ( $title->getNamespace() == NS_USER_TALK
) {
3415 $user = User
::newFromName( $title->getText(), false );
3417 $user->setNewtalk( false );
3422 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3426 * Purge caches on page update etc
3428 * @param Title $title
3429 * @param Revision|null $revision Revision that was just saved, may be null
3431 public static function onArticleEdit( Title
$title, Revision
$revision = null ) {
3432 // Invalidate caches of articles which include this page
3433 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3435 // Invalidate the caches of all pages which redirect here
3436 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'redirect' ) );
3438 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3440 // Purge CDN for this page only
3441 $title->purgeSquid();
3442 // Clear file cache for this page only
3443 HTMLFileCache
::clearFileCache( $title );
3445 $revid = $revision ?
$revision->getId() : null;
3446 DeferredUpdates
::addCallableUpdate( function() use ( $title, $revid ) {
3447 InfoAction
::invalidateCache( $title, $revid );
3454 * Returns a list of categories this page is a member of.
3455 * Results will include hidden categories
3457 * @return TitleArray
3459 public function getCategories() {
3460 $id = $this->getId();
3462 return TitleArray
::newFromResult( new FakeResultWrapper( [] ) );
3465 $dbr = wfGetDB( DB_REPLICA
);
3466 $res = $dbr->select( 'categorylinks',
3467 [ 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ],
3468 // Have to do that since Database::fieldNamesWithAlias treats numeric indexes
3469 // as not being aliases, and NS_CATEGORY is numeric
3470 [ 'cl_from' => $id ],
3473 return TitleArray
::newFromResult( $res );
3477 * Returns a list of hidden categories this page is a member of.
3478 * Uses the page_props and categorylinks tables.
3480 * @return array Array of Title objects
3482 public function getHiddenCategories() {
3484 $id = $this->getId();
3490 $dbr = wfGetDB( DB_REPLICA
);
3491 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3493 [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3494 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ],
3497 if ( $res !== false ) {
3498 foreach ( $res as $row ) {
3499 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3507 * Auto-generates a deletion reason
3509 * @param bool &$hasHistory Whether the page has a history
3510 * @return string|bool String containing deletion reason or empty string, or boolean false
3511 * if no revision occurred
3513 public function getAutoDeleteReason( &$hasHistory ) {
3514 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3518 * Update all the appropriate counts in the category table, given that
3519 * we've added the categories $added and deleted the categories $deleted.
3521 * This should only be called from deferred updates or jobs to avoid contention.
3523 * @param array $added The names of categories that were added
3524 * @param array $deleted The names of categories that were deleted
3525 * @param integer $id Page ID (this should be the original deleted page ID)
3527 public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3528 $id = $id ?
: $this->getId();
3529 $ns = $this->getTitle()->getNamespace();
3531 $addFields = [ 'cat_pages = cat_pages + 1' ];
3532 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3533 if ( $ns == NS_CATEGORY
) {
3534 $addFields[] = 'cat_subcats = cat_subcats + 1';
3535 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3536 } elseif ( $ns == NS_FILE
) {
3537 $addFields[] = 'cat_files = cat_files + 1';
3538 $removeFields[] = 'cat_files = cat_files - 1';
3541 $dbw = wfGetDB( DB_MASTER
);
3543 if ( count( $added ) ) {
3544 $existingAdded = $dbw->selectFieldValues(
3547 [ 'cat_title' => $added ],
3551 // For category rows that already exist, do a plain
3552 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3553 // to avoid creating gaps in the cat_id sequence.
3554 if ( count( $existingAdded ) ) {
3558 [ 'cat_title' => $existingAdded ],
3563 $missingAdded = array_diff( $added, $existingAdded );
3564 if ( count( $missingAdded ) ) {
3566 foreach ( $missingAdded as $cat ) {
3568 'cat_title' => $cat,
3570 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3571 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3584 if ( count( $deleted ) ) {
3588 [ 'cat_title' => $deleted ],
3593 foreach ( $added as $catName ) {
3594 $cat = Category
::newFromName( $catName );
3595 Hooks
::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3598 foreach ( $deleted as $catName ) {
3599 $cat = Category
::newFromName( $catName );
3600 Hooks
::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3603 // Refresh counts on categories that should be empty now, to
3604 // trigger possible deletion. Check master for the most
3605 // up-to-date cat_pages.
3606 if ( count( $deleted ) ) {
3607 $rows = $dbw->select(
3609 [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
3610 [ 'cat_title' => $deleted, 'cat_pages <= 0' ],
3613 foreach ( $rows as $row ) {
3614 $cat = Category
::newFromRow( $row );
3615 $cat->refreshCounts();
3621 * Opportunistically enqueue link update jobs given fresh parser output if useful
3623 * @param ParserOutput $parserOutput Current version page output
3626 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3627 if ( wfReadOnly() ) {
3631 if ( !Hooks
::run( 'OpportunisticLinksUpdate',
3632 [ $this, $this->mTitle
, $parserOutput ]
3637 $config = RequestContext
::getMain()->getConfig();
3640 'isOpportunistic' => true,
3641 'rootJobTimestamp' => $parserOutput->getCacheTime()
3644 if ( $this->mTitle
->areRestrictionsCascading() ) {
3645 // If the page is cascade protecting, the links should really be up-to-date
3646 JobQueueGroup
::singleton()->lazyPush(
3647 RefreshLinksJob
::newPrioritized( $this->mTitle
, $params )
3649 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3650 // Assume the output contains "dynamic" time/random based magic words.
3651 // Only update pages that expired due to dynamic content and NOT due to edits
3652 // to referenced templates/files. When the cache expires due to dynamic content,
3653 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3654 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3655 // template/file edit already triggered recursive RefreshLinksJob jobs.
3656 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3657 // If a page is uncacheable, do not keep spamming a job for it.
3658 // Although it would be de-duplicated, it would still waste I/O.
3659 $cache = ObjectCache
::getLocalClusterInstance();
3660 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3661 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3662 if ( $cache->add( $key, time(), $ttl ) ) {
3663 JobQueueGroup
::singleton()->lazyPush(
3664 RefreshLinksJob
::newDynamic( $this->mTitle
, $params )
3672 * Returns a list of updates to be performed when this page is deleted. The
3673 * updates should remove any information about this page from secondary data
3674 * stores such as links tables.
3676 * @param Content|null $content Optional Content object for determining the
3677 * necessary updates.
3678 * @return DeferrableUpdate[]
3680 public function getDeletionUpdates( Content
$content = null ) {
3682 // load content object, which may be used to determine the necessary updates.
3683 // XXX: the content may not be needed to determine the updates.
3685 $content = $this->getContent( Revision
::RAW
);
3686 } catch ( Exception
$ex ) {
3687 // If we can't load the content, something is wrong. Perhaps that's why
3688 // the user is trying to delete the page, so let's not fail in that case.
3689 // Note that doDeleteArticleReal() will already have logged an issue with
3690 // loading the content.
3697 $updates = $content->getDeletionUpdates( $this );
3700 Hooks
::run( 'WikiPageDeletionUpdates', [ $this, $content, &$updates ] );
3705 * Whether this content displayed on this page
3706 * comes from the local database
3711 public function isLocal() {
3716 * The display name for the site this content
3717 * come from. If a subclass overrides isLocal(),
3718 * this could return something other than the
3724 public function getWikiDisplayName() {
3730 * Get the source URL for the content on this page,
3731 * typically the canonical URL, but may be a remote
3732 * link if the content comes from another site
3737 public function getSourceURL() {
3738 return $this->getTitle()->getCanonicalURL();