3 * Base representation for a MediaWiki page.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Edit\PreparedEdit
;
24 use \MediaWiki\Logger\LoggerFactory
;
25 use \MediaWiki\MediaWikiServices
;
26 use Wikimedia\Rdbms\FakeResultWrapper
;
27 use Wikimedia\Rdbms\IDatabase
;
28 use Wikimedia\Rdbms\DBError
;
29 use Wikimedia\Rdbms\DBUnexpectedError
;
32 * Class representing a MediaWiki article and history.
34 * Some fields are public only for backwards-compatibility. Use accessors.
35 * In the past, this class was part of Article.php and everything was public.
37 class WikiPage
implements Page
, IDBAccessObject
{
38 // Constants for $mDataLoadedFrom and related
43 public $mTitle = null;
48 public $mDataLoaded = false; // !< Boolean
49 public $mIsRedirect = false; // !< Boolean
50 public $mLatest = false; // !< Integer (false means "not loaded")
53 /** @var PreparedEdit Map of cache fields (text, parser output, ect) for a proposed/new edit */
54 public $mPreparedEdit = false;
59 protected $mId = null;
62 * @var int One of the READ_* constants
64 protected $mDataLoadedFrom = self
::READ_NONE
;
69 protected $mRedirectTarget = null;
74 protected $mLastRevision = null;
77 * @var string Timestamp of the current revision or empty string if not loaded
79 protected $mTimestamp = '';
84 protected $mTouched = '19700101000000';
89 protected $mLinksUpdated = '19700101000000';
91 /** @deprecated since 1.29. Added in 1.28 for partial purging, no longer used. */
92 const PURGE_CDN_CACHE
= 1;
93 const PURGE_CLUSTER_PCACHE
= 2;
94 const PURGE_GLOBAL_PCACHE
= 4;
98 * Constructor and clear the article
99 * @param Title $title Reference to a Title object.
101 public function __construct( Title
$title ) {
102 $this->mTitle
= $title;
106 * Makes sure that the mTitle object is cloned
107 * to the newly cloned WikiPage.
109 public function __clone() {
110 $this->mTitle
= clone $this->mTitle
;
114 * Create a WikiPage object of the appropriate class for the given title.
116 * @param Title $title
118 * @throws MWException
119 * @return WikiPage|WikiCategoryPage|WikiFilePage
121 public static function factory( Title
$title ) {
122 $ns = $title->getNamespace();
124 if ( $ns == NS_MEDIA
) {
125 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
126 } elseif ( $ns < 0 ) {
127 throw new MWException( "Invalid or virtual namespace $ns given." );
131 if ( !Hooks
::run( 'WikiPageFactory', [ $title, &$page ] ) ) {
137 $page = new WikiFilePage( $title );
140 $page = new WikiCategoryPage( $title );
143 $page = new WikiPage( $title );
150 * Constructor from a page id
152 * @param int $id Article ID to load
153 * @param string|int $from One of the following values:
154 * - "fromdb" or WikiPage::READ_NORMAL to select from a replica DB
155 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
157 * @return WikiPage|null
159 public static function newFromID( $id, $from = 'fromdb' ) {
160 // page ids are never 0 or negative, see T63166
165 $from = self
::convertSelectType( $from );
166 $db = wfGetDB( $from === self
::READ_LATEST ? DB_MASTER
: DB_REPLICA
);
167 $row = $db->selectRow(
168 'page', self
::selectFields(), [ 'page_id' => $id ], __METHOD__
);
172 return self
::newFromRow( $row, $from );
176 * Constructor from a database row
179 * @param object $row Database row containing at least fields returned by selectFields().
180 * @param string|int $from Source of $data:
181 * - "fromdb" or WikiPage::READ_NORMAL: from a replica DB
182 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
183 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
186 public static function newFromRow( $row, $from = 'fromdb' ) {
187 $page = self
::factory( Title
::newFromRow( $row ) );
188 $page->loadFromRow( $row, $from );
193 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
195 * @param object|string|int $type
198 private static function convertSelectType( $type ) {
201 return self
::READ_NORMAL
;
203 return self
::READ_LATEST
;
205 return self
::READ_LOCKING
;
207 // It may already be an integer or whatever else
213 * @todo Move this UI stuff somewhere else
215 * @see ContentHandler::getActionOverrides
218 public function getActionOverrides() {
219 return $this->getContentHandler()->getActionOverrides();
223 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
225 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
227 * @return ContentHandler
231 public function getContentHandler() {
232 return ContentHandler
::getForModelID( $this->getContentModel() );
236 * Get the title object of the article
237 * @return Title Title object of this page
239 public function getTitle() {
240 return $this->mTitle
;
247 public function clear() {
248 $this->mDataLoaded
= false;
249 $this->mDataLoadedFrom
= self
::READ_NONE
;
251 $this->clearCacheFields();
255 * Clear the object cache fields
258 protected function clearCacheFields() {
260 $this->mRedirectTarget
= null; // Title object if set
261 $this->mLastRevision
= null; // Latest revision
262 $this->mTouched
= '19700101000000';
263 $this->mLinksUpdated
= '19700101000000';
264 $this->mTimestamp
= '';
265 $this->mIsRedirect
= false;
266 $this->mLatest
= false;
267 // T59026: do not clear mPreparedEdit since prepareTextForEdit() already checks
268 // the requested rev ID and content against the cached one for equality. For most
269 // content types, the output should not change during the lifetime of this cache.
270 // Clearing it can cause extra parses on edit for no reason.
274 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
278 public function clearPreparedEdit() {
279 $this->mPreparedEdit
= false;
283 * Return the list of revision fields that should be selected to create
288 public static function selectFields() {
289 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
300 'page_links_updated',
305 if ( $wgContentHandlerUseDB ) {
306 $fields[] = 'page_content_model';
309 if ( $wgPageLanguageUseDB ) {
310 $fields[] = 'page_lang';
317 * Fetch a page record with the given conditions
318 * @param IDatabase $dbr
319 * @param array $conditions
320 * @param array $options
321 * @return object|bool Database result resource, or false on failure
323 protected function pageData( $dbr, $conditions, $options = [] ) {
324 $fields = self
::selectFields();
326 // Avoid PHP 7.1 warning of passing $this by reference
329 Hooks
::run( 'ArticlePageDataBefore', [ &$wikiPage, &$fields ] );
331 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
, $options );
333 Hooks
::run( 'ArticlePageDataAfter', [ &$wikiPage, &$row ] );
339 * Fetch a page record matching the Title object's namespace and title
340 * using a sanitized title string
342 * @param IDatabase $dbr
343 * @param Title $title
344 * @param array $options
345 * @return object|bool Database result resource, or false on failure
347 public function pageDataFromTitle( $dbr, $title, $options = [] ) {
348 return $this->pageData( $dbr, [
349 'page_namespace' => $title->getNamespace(),
350 'page_title' => $title->getDBkey() ], $options );
354 * Fetch a page record matching the requested ID
356 * @param IDatabase $dbr
358 * @param array $options
359 * @return object|bool Database result resource, or false on failure
361 public function pageDataFromId( $dbr, $id, $options = [] ) {
362 return $this->pageData( $dbr, [ 'page_id' => $id ], $options );
366 * Load the object from a given source by title
368 * @param object|string|int $from One of the following:
369 * - A DB query result object.
370 * - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
371 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
372 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
373 * using SELECT FOR UPDATE.
377 public function loadPageData( $from = 'fromdb' ) {
378 $from = self
::convertSelectType( $from );
379 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
380 // We already have the data from the correct location, no need to load it twice.
384 if ( is_int( $from ) ) {
385 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
386 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
387 $loadBalancer = MediaWikiServices
::getInstance()->getDBLoadBalancer();
390 && $index == DB_REPLICA
391 && $loadBalancer->getServerCount() > 1
392 && $loadBalancer->hasOrMadeRecentMasterChanges()
394 $from = self
::READ_LATEST
;
395 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
396 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
399 // No idea from where the caller got this data, assume replica DB.
401 $from = self
::READ_NORMAL
;
404 $this->loadFromRow( $data, $from );
408 * Load the object from a database row
411 * @param object|bool $data DB row containing fields returned by selectFields() or false
412 * @param string|int $from One of the following:
413 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB
414 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
415 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
416 * the master DB using SELECT FOR UPDATE
418 public function loadFromRow( $data, $from ) {
419 $lc = LinkCache
::singleton();
420 $lc->clearLink( $this->mTitle
);
423 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
425 $this->mTitle
->loadFromRow( $data );
427 // Old-fashioned restrictions
428 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
430 $this->mId
= intval( $data->page_id
);
431 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
432 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
433 $this->mIsRedirect
= intval( $data->page_is_redirect
);
434 $this->mLatest
= intval( $data->page_latest
);
435 // T39225: $latest may no longer match the cached latest Revision object.
436 // Double-check the ID of any cached latest Revision object for consistency.
437 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
438 $this->mLastRevision
= null;
439 $this->mTimestamp
= '';
442 $lc->addBadLinkObj( $this->mTitle
);
444 $this->mTitle
->loadFromRow( false );
446 $this->clearCacheFields();
451 $this->mDataLoaded
= true;
452 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
456 * @return int Page ID
458 public function getId() {
459 if ( !$this->mDataLoaded
) {
460 $this->loadPageData();
466 * @return bool Whether or not the page exists in the database
468 public function exists() {
469 if ( !$this->mDataLoaded
) {
470 $this->loadPageData();
472 return $this->mId
> 0;
476 * Check if this page is something we're going to be showing
477 * some sort of sensible content for. If we return false, page
478 * views (plain action=view) will return an HTTP 404 response,
479 * so spiders and robots can know they're following a bad link.
483 public function hasViewableContent() {
484 return $this->mTitle
->isKnown();
488 * Tests if the article content represents a redirect
492 public function isRedirect() {
493 if ( !$this->mDataLoaded
) {
494 $this->loadPageData();
497 return (bool)$this->mIsRedirect
;
501 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
503 * Will use the revisions actual content model if the page exists,
504 * and the page's default if the page doesn't exist yet.
510 public function getContentModel() {
511 if ( $this->exists() ) {
512 $cache = ObjectCache
::getMainWANInstance();
514 return $cache->getWithSetCallback(
515 $cache->makeKey( 'page', 'content-model', $this->getLatest() ),
518 $rev = $this->getRevision();
520 // Look at the revision's actual content model
521 return $rev->getContentModel();
523 $title = $this->mTitle
->getPrefixedDBkey();
524 wfWarn( "Page $title exists but has no (visible) revisions!" );
525 return $this->mTitle
->getContentModel();
531 // use the default model for this page
532 return $this->mTitle
->getContentModel();
536 * Loads page_touched and returns a value indicating if it should be used
537 * @return bool True if this page exists and is not a redirect
539 public function checkTouched() {
540 if ( !$this->mDataLoaded
) {
541 $this->loadPageData();
543 return ( $this->mId
&& !$this->mIsRedirect
);
547 * Get the page_touched field
548 * @return string Containing GMT timestamp
550 public function getTouched() {
551 if ( !$this->mDataLoaded
) {
552 $this->loadPageData();
554 return $this->mTouched
;
558 * Get the page_links_updated field
559 * @return string|null Containing GMT timestamp
561 public function getLinksTimestamp() {
562 if ( !$this->mDataLoaded
) {
563 $this->loadPageData();
565 return $this->mLinksUpdated
;
569 * Get the page_latest field
570 * @return int The rev_id of current revision
572 public function getLatest() {
573 if ( !$this->mDataLoaded
) {
574 $this->loadPageData();
576 return (int)$this->mLatest
;
580 * Get the Revision object of the oldest revision
581 * @return Revision|null
583 public function getOldestRevision() {
584 // Try using the replica DB first, then try the master
585 $rev = $this->mTitle
->getFirstRevision();
587 $rev = $this->mTitle
->getFirstRevision( Title
::GAID_FOR_UPDATE
);
593 * Loads everything except the text
594 * This isn't necessary for all uses, so it's only done if needed.
596 protected function loadLastEdit() {
597 if ( $this->mLastRevision
!== null ) {
598 return; // already loaded
601 $latest = $this->getLatest();
603 return; // page doesn't exist or is missing page_latest info
606 if ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) {
607 // T39225: if session S1 loads the page row FOR UPDATE, the result always
608 // includes the latest changes committed. This is true even within REPEATABLE-READ
609 // transactions, where S1 normally only sees changes committed before the first S1
610 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
611 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
612 // happened after the first S1 SELECT.
613 // https://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read
614 $flags = Revision
::READ_LOCKING
;
615 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
616 } elseif ( $this->mDataLoadedFrom
== self
::READ_LATEST
) {
617 // Bug T93976: if page_latest was loaded from the master, fetch the
618 // revision from there as well, as it may not exist yet on a replica DB.
619 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
620 $flags = Revision
::READ_LATEST
;
621 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
623 $dbr = wfGetDB( DB_REPLICA
);
624 $revision = Revision
::newKnownCurrent( $dbr, $this->getId(), $latest );
627 if ( $revision ) { // sanity
628 $this->setLastEdit( $revision );
633 * Set the latest revision
634 * @param Revision $revision
636 protected function setLastEdit( Revision
$revision ) {
637 $this->mLastRevision
= $revision;
638 $this->mTimestamp
= $revision->getTimestamp();
642 * Get the latest revision
643 * @return Revision|null
645 public function getRevision() {
646 $this->loadLastEdit();
647 if ( $this->mLastRevision
) {
648 return $this->mLastRevision
;
654 * Get the content of the current revision. No side-effects...
656 * @param int $audience One of:
657 * Revision::FOR_PUBLIC to be displayed to all users
658 * Revision::FOR_THIS_USER to be displayed to $wgUser
659 * Revision::RAW get the text regardless of permissions
660 * @param User $user User object to check for, only if FOR_THIS_USER is passed
661 * to the $audience parameter
662 * @return Content|null The content of the current revision
666 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
667 $this->loadLastEdit();
668 if ( $this->mLastRevision
) {
669 return $this->mLastRevision
->getContent( $audience, $user );
675 * @return string MW timestamp of last article revision
677 public function getTimestamp() {
678 // Check if the field has been filled by WikiPage::setTimestamp()
679 if ( !$this->mTimestamp
) {
680 $this->loadLastEdit();
683 return wfTimestamp( TS_MW
, $this->mTimestamp
);
687 * Set the page timestamp (use only to avoid DB queries)
688 * @param string $ts MW timestamp of last article revision
691 public function setTimestamp( $ts ) {
692 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
696 * @param int $audience One of:
697 * Revision::FOR_PUBLIC to be displayed to all users
698 * Revision::FOR_THIS_USER to be displayed to the given user
699 * Revision::RAW get the text regardless of permissions
700 * @param User $user User object to check for, only if FOR_THIS_USER is passed
701 * to the $audience parameter
702 * @return int User ID for the user that made the last article revision
704 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
705 $this->loadLastEdit();
706 if ( $this->mLastRevision
) {
707 return $this->mLastRevision
->getUser( $audience, $user );
714 * Get the User object of the user who created the page
715 * @param int $audience One of:
716 * Revision::FOR_PUBLIC to be displayed to all users
717 * Revision::FOR_THIS_USER to be displayed to the given user
718 * Revision::RAW get the text regardless of permissions
719 * @param User $user User object to check for, only if FOR_THIS_USER is passed
720 * to the $audience parameter
723 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
724 $revision = $this->getOldestRevision();
726 $userName = $revision->getUserText( $audience, $user );
727 return User
::newFromName( $userName, false );
734 * @param int $audience One of:
735 * Revision::FOR_PUBLIC to be displayed to all users
736 * Revision::FOR_THIS_USER to be displayed to the given user
737 * Revision::RAW get the text regardless of permissions
738 * @param User $user User object to check for, only if FOR_THIS_USER is passed
739 * to the $audience parameter
740 * @return string Username of the user that made the last article revision
742 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
743 $this->loadLastEdit();
744 if ( $this->mLastRevision
) {
745 return $this->mLastRevision
->getUserText( $audience, $user );
752 * @param int $audience One of:
753 * Revision::FOR_PUBLIC to be displayed to all users
754 * Revision::FOR_THIS_USER to be displayed to the given user
755 * Revision::RAW get the text regardless of permissions
756 * @param User $user User object to check for, only if FOR_THIS_USER is passed
757 * to the $audience parameter
758 * @return string Comment stored for the last article revision
760 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
761 $this->loadLastEdit();
762 if ( $this->mLastRevision
) {
763 return $this->mLastRevision
->getComment( $audience, $user );
770 * Returns true if last revision was marked as "minor edit"
772 * @return bool Minor edit indicator for the last article revision.
774 public function getMinorEdit() {
775 $this->loadLastEdit();
776 if ( $this->mLastRevision
) {
777 return $this->mLastRevision
->isMinor();
784 * Determine whether a page would be suitable for being counted as an
785 * article in the site_stats table based on the title & its content
787 * @param PreparedEdit|bool $editInfo (false): object returned by prepareTextForEdit(),
788 * if false, the current database state will be used
791 public function isCountable( $editInfo = false ) {
792 global $wgArticleCountMethod;
794 if ( !$this->mTitle
->isContentPage() ) {
799 $content = $editInfo->pstContent
;
801 $content = $this->getContent();
804 if ( !$content ||
$content->isRedirect() ) {
810 if ( $wgArticleCountMethod === 'link' ) {
811 // nasty special case to avoid re-parsing to detect links
814 // ParserOutput::getLinks() is a 2D array of page links, so
815 // to be really correct we would need to recurse in the array
816 // but the main array should only have items in it if there are
818 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
820 $hasLinks = (bool)wfGetDB( DB_REPLICA
)->selectField( 'pagelinks', 1,
821 [ 'pl_from' => $this->getId() ], __METHOD__
);
825 return $content->isCountable( $hasLinks );
829 * If this page is a redirect, get its target
831 * The target will be fetched from the redirect table if possible.
832 * If this page doesn't have an entry there, call insertRedirect()
833 * @return Title|null Title object, or null if this page is not a redirect
835 public function getRedirectTarget() {
836 if ( !$this->mTitle
->isRedirect() ) {
840 if ( $this->mRedirectTarget
!== null ) {
841 return $this->mRedirectTarget
;
844 // Query the redirect table
845 $dbr = wfGetDB( DB_REPLICA
);
846 $row = $dbr->selectRow( 'redirect',
847 [ 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ],
848 [ 'rd_from' => $this->getId() ],
852 // rd_fragment and rd_interwiki were added later, populate them if empty
853 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
854 $this->mRedirectTarget
= Title
::makeTitle(
855 $row->rd_namespace
, $row->rd_title
,
856 $row->rd_fragment
, $row->rd_interwiki
858 return $this->mRedirectTarget
;
861 // This page doesn't have an entry in the redirect table
862 $this->mRedirectTarget
= $this->insertRedirect();
863 return $this->mRedirectTarget
;
867 * Insert an entry for this page into the redirect table if the content is a redirect
869 * The database update will be deferred via DeferredUpdates
871 * Don't call this function directly unless you know what you're doing.
872 * @return Title|null Title object or null if not a redirect
874 public function insertRedirect() {
875 $content = $this->getContent();
876 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
881 // Update the DB post-send if the page has not cached since now
882 $latest = $this->getLatest();
883 DeferredUpdates
::addCallableUpdate(
884 function () use ( $retval, $latest ) {
885 $this->insertRedirectEntry( $retval, $latest );
887 DeferredUpdates
::POSTSEND
,
895 * Insert or update the redirect table entry for this page to indicate it redirects to $rt
896 * @param Title $rt Redirect target
897 * @param int|null $oldLatest Prior page_latest for check and set
899 public function insertRedirectEntry( Title
$rt, $oldLatest = null ) {
900 $dbw = wfGetDB( DB_MASTER
);
901 $dbw->startAtomic( __METHOD__
);
903 if ( !$oldLatest ||
$oldLatest == $this->lockAndGetLatest() ) {
907 'rd_from' => $this->getId(),
908 'rd_namespace' => $rt->getNamespace(),
909 'rd_title' => $rt->getDBkey(),
910 'rd_fragment' => $rt->getFragment(),
911 'rd_interwiki' => $rt->getInterwiki(),
915 'rd_namespace' => $rt->getNamespace(),
916 'rd_title' => $rt->getDBkey(),
917 'rd_fragment' => $rt->getFragment(),
918 'rd_interwiki' => $rt->getInterwiki(),
924 $dbw->endAtomic( __METHOD__
);
928 * Get the Title object or URL this page redirects to
930 * @return bool|Title|string False, Title of in-wiki target, or string with URL
932 public function followRedirect() {
933 return $this->getRedirectURL( $this->getRedirectTarget() );
937 * Get the Title object or URL to use for a redirect. We use Title
938 * objects for same-wiki, non-special redirects and URLs for everything
940 * @param Title $rt Redirect target
941 * @return bool|Title|string False, Title object of local target, or string with URL
943 public function getRedirectURL( $rt ) {
948 if ( $rt->isExternal() ) {
949 if ( $rt->isLocal() ) {
950 // Offsite wikis need an HTTP redirect.
951 // This can be hard to reverse and may produce loops,
952 // so they may be disabled in the site configuration.
953 $source = $this->mTitle
->getFullURL( 'redirect=no' );
954 return $rt->getFullURL( [ 'rdfrom' => $source ] );
956 // External pages without "local" bit set are not valid
962 if ( $rt->isSpecialPage() ) {
963 // Gotta handle redirects to special pages differently:
964 // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
965 // Some pages are not valid targets.
966 if ( $rt->isValidRedirectTarget() ) {
967 return $rt->getFullURL();
977 * Get a list of users who have edited this article, not including the user who made
978 * the most recent revision, which you can get from $article->getUser() if you want it
979 * @return UserArrayFromResult
981 public function getContributors() {
982 // @todo FIXME: This is expensive; cache this info somewhere.
984 $dbr = wfGetDB( DB_REPLICA
);
986 $tables = [ 'revision', 'user' ];
989 'user_id' => 'rev_user',
990 'user_name' => 'rev_user_text',
991 'user_real_name' => 'MIN(user_real_name)',
992 'timestamp' => 'MAX(rev_timestamp)',
995 $conds = [ 'rev_page' => $this->getId() ];
997 // The user who made the top revision gets credited as "this page was last edited by
998 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
999 $user = $this->getUser();
1001 $conds[] = "rev_user != $user";
1003 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1007 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1010 'user' => [ 'LEFT JOIN', 'rev_user = user_id' ],
1014 'GROUP BY' => [ 'rev_user', 'rev_user_text' ],
1015 'ORDER BY' => 'timestamp DESC',
1018 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1019 return new UserArrayFromResult( $res );
1023 * Should the parser cache be used?
1025 * @param ParserOptions $parserOptions ParserOptions to check
1029 public function shouldCheckParserCache( ParserOptions
$parserOptions, $oldId ) {
1030 return $parserOptions->getStubThreshold() == 0
1032 && ( $oldId === null ||
$oldId === 0 ||
$oldId === $this->getLatest() )
1033 && $this->getContentHandler()->isParserCacheSupported();
1037 * Get a ParserOutput for the given ParserOptions and revision ID.
1039 * The parser cache will be used if possible. Cache misses that result
1040 * in parser runs are debounced with PoolCounter.
1043 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1044 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1045 * get the current revision (default value)
1046 * @param bool $forceParse Force reindexing, regardless of cache settings
1047 * @return bool|ParserOutput ParserOutput or false if the revision was not found
1049 public function getParserOutput(
1050 ParserOptions
$parserOptions, $oldid = null, $forceParse = false
1053 ( !$forceParse ) && $this->shouldCheckParserCache( $parserOptions, $oldid );
1055 if ( $useParserCache && !$parserOptions->isSafeToCache() ) {
1056 throw new InvalidArgumentException(
1057 'The supplied ParserOptions are not safe to cache. Fix the options or set $forceParse = true.'
1061 wfDebug( __METHOD__
.
1062 ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1063 if ( $parserOptions->getStubThreshold() ) {
1064 wfIncrStats( 'pcache.miss.stub' );
1067 if ( $useParserCache ) {
1068 $parserOutput = MediaWikiServices
::getInstance()->getParserCache()
1069 ->get( $this, $parserOptions );
1070 if ( $parserOutput !== false ) {
1071 return $parserOutput;
1075 if ( $oldid === null ||
$oldid === 0 ) {
1076 $oldid = $this->getLatest();
1079 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1082 return $pool->getParserOutput();
1086 * Do standard deferred updates after page view (existing or missing page)
1087 * @param User $user The relevant user
1088 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1090 public function doViewUpdates( User
$user, $oldid = 0 ) {
1091 if ( wfReadOnly() ) {
1095 Hooks
::run( 'PageViewUpdates', [ $this, $user ] );
1096 // Update newtalk / watchlist notification status
1098 $user->clearNotification( $this->mTitle
, $oldid );
1099 } catch ( DBError
$e ) {
1100 // Avoid outage if the master is not reachable
1101 MWExceptionHandler
::logException( $e );
1106 * Perform the actions of a page purging
1108 * @note In 1.28 (and only 1.28), this took a $flags parameter that
1109 * controlled how much purging was done.
1111 public function doPurge() {
1112 // Avoid PHP 7.1 warning of passing $this by reference
1115 if ( !Hooks
::run( 'ArticlePurge', [ &$wikiPage ] ) ) {
1119 $this->mTitle
->invalidateCache();
1122 HTMLFileCache
::clearFileCache( $this->getTitle() );
1123 // Send purge after above page_touched update was committed
1124 DeferredUpdates
::addUpdate(
1125 new CdnCacheUpdate( $this->mTitle
->getCdnUrls() ),
1126 DeferredUpdates
::PRESEND
1129 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1130 $messageCache = MessageCache
::singleton();
1131 $messageCache->updateMessageOverride( $this->mTitle
, $this->getContent() );
1138 * Get the last time a user explicitly purged the page via action=purge
1140 * @return string|bool TS_MW timestamp or false
1142 * @deprecated since 1.29. It will always return false.
1144 public function getLastPurgeTimestamp() {
1145 wfDeprecated( __METHOD__
, '1.29' );
1150 * Insert a new empty page record for this article.
1151 * This *must* be followed up by creating a revision
1152 * and running $this->updateRevisionOn( ... );
1153 * or else the record will be left in a funky state.
1154 * Best if all done inside a transaction.
1156 * @param IDatabase $dbw
1157 * @param int|null $pageId Custom page ID that will be used for the insert statement
1159 * @return bool|int The newly created page_id key; false if the row was not
1160 * inserted, e.g. because the title already existed or because the specified
1161 * page ID is already in use.
1163 public function insertOn( $dbw, $pageId = null ) {
1164 $pageIdForInsert = $pageId ?
[ 'page_id' => $pageId ] : [];
1168 'page_namespace' => $this->mTitle
->getNamespace(),
1169 'page_title' => $this->mTitle
->getDBkey(),
1170 'page_restrictions' => '',
1171 'page_is_redirect' => 0, // Will set this shortly...
1173 'page_random' => wfRandom(),
1174 'page_touched' => $dbw->timestamp(),
1175 'page_latest' => 0, // Fill this in shortly...
1176 'page_len' => 0, // Fill this in shortly...
1177 ] +
$pageIdForInsert,
1182 if ( $dbw->affectedRows() > 0 ) {
1183 $newid = $pageId ?
(int)$pageId : $dbw->insertId();
1184 $this->mId
= $newid;
1185 $this->mTitle
->resetArticleID( $newid );
1189 return false; // nothing changed
1194 * Update the page record to point to a newly saved revision.
1196 * @param IDatabase $dbw
1197 * @param Revision $revision For ID number, and text used to set
1198 * length and redirect status fields
1199 * @param int $lastRevision If given, will not overwrite the page field
1200 * when different from the currently set value.
1201 * Giving 0 indicates the new page flag should be set on.
1202 * @param bool $lastRevIsRedirect If given, will optimize adding and
1203 * removing rows in redirect table.
1204 * @return bool Success; false if the page row was missing or page_latest changed
1206 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1207 $lastRevIsRedirect = null
1209 global $wgContentHandlerUseDB;
1211 // Assertion to try to catch T92046
1212 if ( (int)$revision->getId() === 0 ) {
1213 throw new InvalidArgumentException(
1214 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1218 $content = $revision->getContent();
1219 $len = $content ?
$content->getSize() : 0;
1220 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1222 $conditions = [ 'page_id' => $this->getId() ];
1224 if ( !is_null( $lastRevision ) ) {
1225 // An extra check against threads stepping on each other
1226 $conditions['page_latest'] = $lastRevision;
1230 'page_latest' => $revision->getId(),
1231 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1232 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1233 'page_is_redirect' => $rt !== null ?
1 : 0,
1237 if ( $wgContentHandlerUseDB ) {
1238 $row['page_content_model'] = $revision->getContentModel();
1241 $dbw->update( 'page',
1246 $result = $dbw->affectedRows() > 0;
1248 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1249 $this->setLastEdit( $revision );
1250 $this->mLatest
= $revision->getId();
1251 $this->mIsRedirect
= (bool)$rt;
1252 // Update the LinkCache.
1253 LinkCache
::singleton()->addGoodLinkObj(
1259 $revision->getContentModel()
1267 * Add row to the redirect table if this is a redirect, remove otherwise.
1269 * @param IDatabase $dbw
1270 * @param Title $redirectTitle Title object pointing to the redirect target,
1271 * or NULL if this is not a redirect
1272 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1273 * removing rows in redirect table.
1274 * @return bool True on success, false on failure
1277 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1278 // Always update redirects (target link might have changed)
1279 // Update/Insert if we don't know if the last revision was a redirect or not
1280 // Delete if changing from redirect to non-redirect
1281 $isRedirect = !is_null( $redirectTitle );
1283 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1287 if ( $isRedirect ) {
1288 $this->insertRedirectEntry( $redirectTitle );
1290 // This is not a redirect, remove row from redirect table
1291 $where = [ 'rd_from' => $this->getId() ];
1292 $dbw->delete( 'redirect', $where, __METHOD__
);
1295 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1296 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1299 return ( $dbw->affectedRows() != 0 );
1303 * If the given revision is newer than the currently set page_latest,
1304 * update the page record. Otherwise, do nothing.
1306 * @deprecated since 1.24, use updateRevisionOn instead
1308 * @param IDatabase $dbw
1309 * @param Revision $revision
1312 public function updateIfNewerOn( $dbw, $revision ) {
1313 $row = $dbw->selectRow(
1314 [ 'revision', 'page' ],
1315 [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1317 'page_id' => $this->getId(),
1318 'page_latest=rev_id' ],
1322 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1325 $prev = $row->rev_id
;
1326 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1328 // No or missing previous revision; mark the page as new
1330 $lastRevIsRedirect = null;
1333 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1339 * Get the content that needs to be saved in order to undo all revisions
1340 * between $undo and $undoafter. Revisions must belong to the same page,
1341 * must exist and must not be deleted
1342 * @param Revision $undo
1343 * @param Revision $undoafter Must be an earlier revision than $undo
1344 * @return Content|bool Content on success, false on failure
1346 * Before we had the Content object, this was done in getUndoText
1348 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1349 $handler = $undo->getContentHandler();
1350 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1354 * Returns true if this page's content model supports sections.
1358 * @todo The skin should check this and not offer section functionality if
1359 * sections are not supported.
1360 * @todo The EditPage should check this and not offer section functionality
1361 * if sections are not supported.
1363 public function supportsSections() {
1364 return $this->getContentHandler()->supportsSections();
1368 * @param string|int|null|bool $sectionId Section identifier as a number or string
1369 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1370 * or 'new' for a new section.
1371 * @param Content $sectionContent New content of the section.
1372 * @param string $sectionTitle New section's subject, only if $section is "new".
1373 * @param string $edittime Revision timestamp or null to use the current revision.
1375 * @throws MWException
1376 * @return Content|null New complete article content, or null if error.
1379 * @deprecated since 1.24, use replaceSectionAtRev instead
1381 public function replaceSectionContent(
1382 $sectionId, Content
$sectionContent, $sectionTitle = '', $edittime = null
1385 if ( $edittime && $sectionId !== 'new' ) {
1386 $dbr = wfGetDB( DB_REPLICA
);
1387 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1388 // Try the master if this thread may have just added it.
1389 // This could be abstracted into a Revision method, but we don't want
1390 // to encourage loading of revisions by timestamp.
1392 && wfGetLB()->getServerCount() > 1
1393 && wfGetLB()->hasOrMadeRecentMasterChanges()
1395 $dbw = wfGetDB( DB_MASTER
);
1396 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1399 $baseRevId = $rev->getId();
1403 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1407 * @param string|int|null|bool $sectionId Section identifier as a number or string
1408 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1409 * or 'new' for a new section.
1410 * @param Content $sectionContent New content of the section.
1411 * @param string $sectionTitle New section's subject, only if $section is "new".
1412 * @param int|null $baseRevId
1414 * @throws MWException
1415 * @return Content|null New complete article content, or null if error.
1419 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1420 $sectionTitle = '', $baseRevId = null
1422 if ( strval( $sectionId ) === '' ) {
1423 // Whole-page edit; let the whole text through
1424 $newContent = $sectionContent;
1426 if ( !$this->supportsSections() ) {
1427 throw new MWException( "sections not supported for content model " .
1428 $this->getContentHandler()->getModelID() );
1431 // T32711: always use current version when adding a new section
1432 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1433 $oldContent = $this->getContent();
1435 $rev = Revision
::newFromId( $baseRevId );
1437 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1438 $this->getId() . "; section: $sectionId)\n" );
1442 $oldContent = $rev->getContent();
1445 if ( !$oldContent ) {
1446 wfDebug( __METHOD__
. ": no page text\n" );
1450 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1457 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1459 * @return int Updated $flags
1461 public function checkFlags( $flags ) {
1462 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1463 if ( $this->exists() ) {
1464 $flags |
= EDIT_UPDATE
;
1474 * Change an existing article or create a new article. Updates RC and all necessary caches,
1475 * optionally via the deferred update array.
1477 * @param Content $content New content
1478 * @param string $summary Edit summary
1479 * @param int $flags Bitfield:
1481 * Article is known or assumed to be non-existent, create a new one
1483 * Article is known or assumed to be pre-existing, update it
1485 * Mark this edit minor, if the user is allowed to do so
1487 * Do not log the change in recentchanges
1489 * Mark the edit a "bot" edit regardless of user rights
1491 * Fill in blank summaries with generated text where possible
1493 * Signal that the page retrieve/save cycle happened entirely in this request.
1495 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1496 * article will be detected. If EDIT_UPDATE is specified and the article
1497 * doesn't exist, the function will return an edit-gone-missing error. If
1498 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1499 * error will be returned. These two conditions are also possible with
1500 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1502 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1503 * This is not the parent revision ID, rather the revision ID for older
1504 * content used as the source for a rollback, for example.
1505 * @param User $user The user doing the edit
1506 * @param string $serialFormat Format for storing the content in the
1508 * @param array|null $tags Change tags to apply to this edit
1509 * Callers are responsible for permission checks
1510 * (with ChangeTags::canAddTagsAccompanyingChange)
1511 * @param Int $undidRevId Id of revision that was undone or 0
1513 * @throws MWException
1514 * @return Status Possible errors:
1515 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1516 * set the fatal flag of $status.
1517 * edit-gone-missing: In update mode, but the article didn't exist.
1518 * edit-conflict: In update mode, the article changed unexpectedly.
1519 * edit-no-change: Warning that the text was the same as before.
1520 * edit-already-exists: In creation mode, but the article already exists.
1522 * Extensions may define additional errors.
1524 * $return->value will contain an associative array with members as follows:
1525 * new: Boolean indicating if the function attempted to create a new article.
1526 * revision: The revision object for the inserted revision, or null.
1529 * @throws MWException
1531 public function doEditContent(
1532 Content
$content, $summary, $flags = 0, $baseRevId = false,
1533 User
$user = null, $serialFormat = null, $tags = [], $undidRevId = 0
1535 global $wgUser, $wgUseAutomaticEditSummaries;
1537 // Old default parameter for $tags was null
1538 if ( $tags === null ) {
1542 // Low-level sanity check
1543 if ( $this->mTitle
->getText() === '' ) {
1544 throw new MWException( 'Something is trying to edit an article with an empty title' );
1546 // Make sure the given content type is allowed for this page
1547 if ( !$content->getContentHandler()->canBeUsedOn( $this->mTitle
) ) {
1548 return Status
::newFatal( 'content-not-allowed-here',
1549 ContentHandler
::getLocalizedName( $content->getModel() ),
1550 $this->mTitle
->getPrefixedText()
1554 // Load the data from the master database if needed.
1555 // The caller may already loaded it from the master or even loaded it using
1556 // SELECT FOR UPDATE, so do not override that using clear().
1557 $this->loadPageData( 'fromdbmaster' );
1559 $user = $user ?
: $wgUser;
1560 $flags = $this->checkFlags( $flags );
1562 // Avoid PHP 7.1 warning of passing $this by reference
1565 // Trigger pre-save hook (using provided edit summary)
1566 $hookStatus = Status
::newGood( [] );
1567 $hook_args = [ &$wikiPage, &$user, &$content, &$summary,
1568 $flags & EDIT_MINOR
, null, null, &$flags, &$hookStatus ];
1569 // Check if the hook rejected the attempted save
1570 if ( !Hooks
::run( 'PageContentSave', $hook_args ) ) {
1571 if ( $hookStatus->isOK() ) {
1572 // Hook returned false but didn't call fatal(); use generic message
1573 $hookStatus->fatal( 'edit-hook-aborted' );
1579 $old_revision = $this->getRevision(); // current revision
1580 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1582 if ( $old_content && $old_content->getModel() !== $content->getModel() ) {
1583 $tags[] = 'mw-contentmodelchange';
1586 // Provide autosummaries if one is not provided and autosummaries are enabled
1587 if ( $wgUseAutomaticEditSummaries && ( $flags & EDIT_AUTOSUMMARY
) && $summary == '' ) {
1588 $handler = $content->getContentHandler();
1589 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1592 // Avoid statsd noise and wasted cycles check the edit stash (T136678)
1593 if ( ( $flags & EDIT_INTERNAL
) ||
( $flags & EDIT_FORCE_BOT
) ) {
1599 // Get the pre-save transform content and final parser output
1600 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat, $useCache );
1601 $pstContent = $editInfo->pstContent
; // Content object
1603 'bot' => ( $flags & EDIT_FORCE_BOT
),
1604 'minor' => ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' ),
1605 'serialized' => $pstContent->serialize( $serialFormat ),
1606 'serialFormat' => $serialFormat,
1607 'baseRevId' => $baseRevId,
1608 'oldRevision' => $old_revision,
1609 'oldContent' => $old_content,
1610 'oldId' => $this->getLatest(),
1611 'oldIsRedirect' => $this->isRedirect(),
1612 'oldCountable' => $this->isCountable(),
1613 'tags' => ( $tags !== null ) ?
(array)$tags : [],
1614 'undidRevId' => $undidRevId
1617 // Actually create the revision and create/update the page
1618 if ( $flags & EDIT_UPDATE
) {
1619 $status = $this->doModify( $pstContent, $flags, $user, $summary, $meta );
1621 $status = $this->doCreate( $pstContent, $flags, $user, $summary, $meta );
1624 // Promote user to any groups they meet the criteria for
1625 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
1626 $user->addAutopromoteOnceGroups( 'onEdit' );
1627 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1634 * @param Content $content Pre-save transform content
1637 * @param string $summary
1638 * @param array $meta
1640 * @throws DBUnexpectedError
1642 * @throws FatalError
1643 * @throws MWException
1645 private function doModify(
1646 Content
$content, $flags, User
$user, $summary, array $meta
1648 global $wgUseRCPatrol;
1650 // Update article, but only if changed.
1651 $status = Status
::newGood( [ 'new' => false, 'revision' => null ] );
1653 // Convenience variables
1654 $now = wfTimestampNow();
1655 $oldid = $meta['oldId'];
1656 /** @var Content|null $oldContent */
1657 $oldContent = $meta['oldContent'];
1658 $newsize = $content->getSize();
1661 // Article gone missing
1662 $status->fatal( 'edit-gone-missing' );
1665 } elseif ( !$oldContent ) {
1666 // Sanity check for T39225
1667 throw new MWException( "Could not find text for current revision {$oldid}." );
1670 // @TODO: pass content object?!
1671 $revision = new Revision( [
1672 'page' => $this->getId(),
1673 'title' => $this->mTitle
, // for determining the default content model
1674 'comment' => $summary,
1675 'minor_edit' => $meta['minor'],
1676 'text' => $meta['serialized'],
1678 'parent_id' => $oldid,
1679 'user' => $user->getId(),
1680 'user_text' => $user->getName(),
1681 'timestamp' => $now,
1682 'content_model' => $content->getModel(),
1683 'content_format' => $meta['serialFormat'],
1686 $changed = !$content->equals( $oldContent );
1688 $dbw = wfGetDB( DB_MASTER
);
1691 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1692 $status->merge( $prepStatus );
1693 if ( !$status->isOK() ) {
1697 $dbw->startAtomic( __METHOD__
);
1698 // Get the latest page_latest value while locking it.
1699 // Do a CAS style check to see if it's the same as when this method
1700 // started. If it changed then bail out before touching the DB.
1701 $latestNow = $this->lockAndGetLatest();
1702 if ( $latestNow != $oldid ) {
1703 $dbw->endAtomic( __METHOD__
);
1704 // Page updated or deleted in the mean time
1705 $status->fatal( 'edit-conflict' );
1710 // At this point we are now comitted to returning an OK
1711 // status unless some DB query error or other exception comes up.
1712 // This way callers don't have to call rollback() if $status is bad
1713 // unless they actually try to catch exceptions (which is rare).
1715 // Save the revision text
1716 $revisionId = $revision->insertOn( $dbw );
1717 // Update page_latest and friends to reflect the new revision
1718 if ( !$this->updateRevisionOn( $dbw, $revision, null, $meta['oldIsRedirect'] ) ) {
1719 throw new MWException( "Failed to update page row to use new revision." );
1722 Hooks
::run( 'NewRevisionFromEditComplete',
1723 [ $this, $revision, $meta['baseRevId'], $user ] );
1725 // Update recentchanges
1726 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1727 // Mark as patrolled if the user can do so
1728 $patrolled = $wgUseRCPatrol && !count(
1729 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1730 // Add RC row to the DB
1731 RecentChange
::notifyEdit(
1734 $revision->isMinor(),
1738 $this->getTimestamp(),
1741 $oldContent ?
$oldContent->getSize() : 0,
1749 $user->incEditCount();
1751 $dbw->endAtomic( __METHOD__
);
1752 $this->mTimestamp
= $now;
1754 // T34948: revision ID must be set to page {{REVISIONID}} and
1755 // related variables correctly. Likewise for {{REVISIONUSER}} (T135261).
1756 $revision->setId( $this->getLatest() );
1757 $revision->setUserIdAndName(
1758 $this->getUser( Revision
::RAW
),
1759 $this->getUserText( Revision
::RAW
)
1764 // Return the new revision to the caller
1765 $status->value
['revision'] = $revision;
1767 $status->warning( 'edit-no-change' );
1768 // Update page_touched as updateRevisionOn() was not called.
1769 // Other cache updates are managed in onArticleEdit() via doEditUpdates().
1770 $this->mTitle
->invalidateCache( $now );
1773 // Do secondary updates once the main changes have been committed...
1774 DeferredUpdates
::addUpdate(
1775 new AtomicSectionUpdate(
1779 $revision, &$user, $content, $summary, &$flags,
1780 $changed, $meta, &$status
1782 // Update links tables, site stats, etc.
1783 $this->doEditUpdates(
1787 'changed' => $changed,
1788 'oldcountable' => $meta['oldCountable'],
1789 'oldrevision' => $meta['oldRevision']
1792 // Avoid PHP 7.1 warning of passing $this by reference
1794 // Trigger post-save hook
1795 $params = [ &$wikiPage, &$user, $content, $summary, $flags & EDIT_MINOR
,
1796 null, null, &$flags, $revision, &$status, $meta['baseRevId'],
1797 $meta['undidRevId'] ];
1798 Hooks
::run( 'PageContentSaveComplete', $params );
1801 DeferredUpdates
::PRESEND
1808 * @param Content $content Pre-save transform content
1811 * @param string $summary
1812 * @param array $meta
1814 * @throws DBUnexpectedError
1816 * @throws FatalError
1817 * @throws MWException
1819 private function doCreate(
1820 Content
$content, $flags, User
$user, $summary, array $meta
1822 global $wgUseRCPatrol, $wgUseNPPatrol;
1824 $status = Status
::newGood( [ 'new' => true, 'revision' => null ] );
1826 $now = wfTimestampNow();
1827 $newsize = $content->getSize();
1828 $prepStatus = $content->prepareSave( $this, $flags, $meta['oldId'], $user );
1829 $status->merge( $prepStatus );
1830 if ( !$status->isOK() ) {
1834 $dbw = wfGetDB( DB_MASTER
);
1835 $dbw->startAtomic( __METHOD__
);
1837 // Add the page record unless one already exists for the title
1838 $newid = $this->insertOn( $dbw );
1839 if ( $newid === false ) {
1840 $dbw->endAtomic( __METHOD__
); // nothing inserted
1841 $status->fatal( 'edit-already-exists' );
1843 return $status; // nothing done
1846 // At this point we are now comitted to returning an OK
1847 // status unless some DB query error or other exception comes up.
1848 // This way callers don't have to call rollback() if $status is bad
1849 // unless they actually try to catch exceptions (which is rare).
1851 // @TODO: pass content object?!
1852 $revision = new Revision( [
1854 'title' => $this->mTitle
, // for determining the default content model
1855 'comment' => $summary,
1856 'minor_edit' => $meta['minor'],
1857 'text' => $meta['serialized'],
1859 'user' => $user->getId(),
1860 'user_text' => $user->getName(),
1861 'timestamp' => $now,
1862 'content_model' => $content->getModel(),
1863 'content_format' => $meta['serialFormat'],
1866 // Save the revision text...
1867 $revisionId = $revision->insertOn( $dbw );
1868 // Update the page record with revision data
1869 if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1870 throw new MWException( "Failed to update page row to use new revision." );
1873 Hooks
::run( 'NewRevisionFromEditComplete', [ $this, $revision, false, $user ] );
1875 // Update recentchanges
1876 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1877 // Mark as patrolled if the user can do so
1878 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) &&
1879 !count( $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1880 // Add RC row to the DB
1881 RecentChange
::notifyNew(
1884 $revision->isMinor(),
1896 $user->incEditCount();
1898 $dbw->endAtomic( __METHOD__
);
1899 $this->mTimestamp
= $now;
1901 // Return the new revision to the caller
1902 $status->value
['revision'] = $revision;
1904 // Do secondary updates once the main changes have been committed...
1905 DeferredUpdates
::addUpdate(
1906 new AtomicSectionUpdate(
1910 $revision, &$user, $content, $summary, &$flags, $meta, &$status
1912 // Update links, etc.
1913 $this->doEditUpdates( $revision, $user, [ 'created' => true ] );
1914 // Avoid PHP 7.1 warning of passing $this by reference
1916 // Trigger post-create hook
1917 $params = [ &$wikiPage, &$user, $content, $summary,
1918 $flags & EDIT_MINOR
, null, null, &$flags, $revision ];
1919 Hooks
::run( 'PageContentInsertComplete', $params );
1920 // Trigger post-save hook
1921 $params = array_merge( $params, [ &$status, $meta['baseRevId'], 0 ] );
1922 Hooks
::run( 'PageContentSaveComplete', $params );
1925 DeferredUpdates
::PRESEND
1932 * Get parser options suitable for rendering the primary article wikitext
1934 * @see ContentHandler::makeParserOptions
1936 * @param IContextSource|User|string $context One of the following:
1937 * - IContextSource: Use the User and the Language of the provided
1939 * - User: Use the provided User object and $wgLang for the language,
1940 * so use an IContextSource object if possible.
1941 * - 'canonical': Canonical options (anonymous user with default
1942 * preferences and content language).
1943 * @return ParserOptions
1945 public function makeParserOptions( $context ) {
1946 $options = $this->getContentHandler()->makeParserOptions( $context );
1948 if ( $this->getTitle()->isConversionTable() ) {
1949 // @todo ConversionTable should become a separate content model, so
1950 // we don't need special cases like this one.
1951 $options->disableContentConversion();
1958 * Prepare content which is about to be saved.
1960 * Prior to 1.30, this returned a stdClass object with the same class
1963 * @param Content $content
1964 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
1965 * revision ID is also accepted, but this is deprecated.
1966 * @param User|null $user
1967 * @param string|null $serialFormat
1968 * @param bool $useCache Check shared prepared edit cache
1970 * @return PreparedEdit
1974 public function prepareContentForEdit(
1975 Content
$content, $revision = null, User
$user = null,
1976 $serialFormat = null, $useCache = true
1978 global $wgContLang, $wgUser, $wgAjaxEditStash;
1980 if ( is_object( $revision ) ) {
1981 $revid = $revision->getId();
1984 // This code path is deprecated, and nothing is known to
1985 // use it, so performance here shouldn't be a worry.
1986 if ( $revid !== null ) {
1987 wfDeprecated( __METHOD__
. ' with $revision = revision ID', '1.25' );
1988 $revision = Revision
::newFromId( $revid, Revision
::READ_LATEST
);
1994 $user = is_null( $user ) ?
$wgUser : $user;
1995 // XXX: check $user->getId() here???
1997 // Use a sane default for $serialFormat, see T59026
1998 if ( $serialFormat === null ) {
1999 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2002 if ( $this->mPreparedEdit
2003 && isset( $this->mPreparedEdit
->newContent
)
2004 && $this->mPreparedEdit
->newContent
->equals( $content )
2005 && $this->mPreparedEdit
->revid
== $revid
2006 && $this->mPreparedEdit
->format
== $serialFormat
2007 // XXX: also check $user here?
2010 return $this->mPreparedEdit
;
2013 // The edit may have already been prepared via api.php?action=stashedit
2014 $cachedEdit = $useCache && $wgAjaxEditStash
2015 ? ApiStashEdit
::checkCache( $this->getTitle(), $content, $user )
2018 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2019 Hooks
::run( 'ArticlePrepareTextForEdit', [ $this, $popts ] );
2021 $edit = new PreparedEdit();
2022 if ( $cachedEdit ) {
2023 $edit->timestamp
= $cachedEdit->timestamp
;
2025 $edit->timestamp
= wfTimestampNow();
2027 // @note: $cachedEdit is safely not used if the rev ID was referenced in the text
2028 $edit->revid
= $revid;
2030 if ( $cachedEdit ) {
2031 $edit->pstContent
= $cachedEdit->pstContent
;
2033 $edit->pstContent
= $content
2034 ?
$content->preSaveTransform( $this->mTitle
, $user, $popts )
2038 $edit->format
= $serialFormat;
2039 $edit->popts
= $this->makeParserOptions( 'canonical' );
2040 if ( $cachedEdit ) {
2041 $edit->output
= $cachedEdit->output
;
2044 // We get here if vary-revision is set. This means that this page references
2045 // itself (such as via self-transclusion). In this case, we need to make sure
2046 // that any such self-references refer to the newly-saved revision, and not
2047 // to the previous one, which could otherwise happen due to replica DB lag.
2048 $oldCallback = $edit->popts
->getCurrentRevisionCallback();
2049 $edit->popts
->setCurrentRevisionCallback(
2050 function ( Title
$title, $parser = false ) use ( $revision, &$oldCallback ) {
2051 if ( $title->equals( $revision->getTitle() ) ) {
2054 return call_user_func( $oldCallback, $title, $parser );
2059 // Try to avoid a second parse if {{REVISIONID}} is used
2060 $dbIndex = ( $this->mDataLoadedFrom
& self
::READ_LATEST
) === self
::READ_LATEST
2061 ? DB_MASTER
// use the best possible guess
2062 : DB_REPLICA
; // T154554
2064 $edit->popts
->setSpeculativeRevIdCallback( function () use ( $dbIndex ) {
2065 return 1 +
(int)wfGetDB( $dbIndex )->selectField(
2073 $edit->output
= $edit->pstContent
2074 ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
)
2078 $edit->newContent
= $content;
2079 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2081 // NOTE: B/C for hooks! don't use these fields!
2082 $edit->newText
= $edit->newContent
2083 ? ContentHandler
::getContentText( $edit->newContent
)
2085 $edit->oldText
= $edit->oldContent
2086 ? ContentHandler
::getContentText( $edit->oldContent
)
2088 $edit->pst
= $edit->pstContent ?
$edit->pstContent
->serialize( $serialFormat ) : '';
2090 if ( $edit->output
) {
2091 $edit->output
->setCacheTime( wfTimestampNow() );
2094 // Process cache the result
2095 $this->mPreparedEdit
= $edit;
2101 * Do standard deferred updates after page edit.
2102 * Update links tables, site stats, search index and message cache.
2103 * Purges pages that include this page if the text was changed here.
2104 * Every 100th edit, prune the recent changes table.
2106 * @param Revision $revision
2107 * @param User $user User object that did the revision
2108 * @param array $options Array of options, following indexes are used:
2109 * - changed: bool, whether the revision changed the content (default true)
2110 * - created: bool, whether the revision created the page (default false)
2111 * - moved: bool, whether the page was moved (default false)
2112 * - restored: bool, whether the page was undeleted (default false)
2113 * - oldrevision: Revision object for the pre-update revision (default null)
2114 * - oldcountable: bool, null, or string 'no-change' (default null):
2115 * - bool: whether the page was counted as an article before that
2116 * revision, only used in changed is true and created is false
2117 * - null: if created is false, don't update the article count; if created
2118 * is true, do update the article count
2119 * - 'no-change': don't update the article count, ever
2121 public function doEditUpdates( Revision
$revision, User
$user, array $options = [] ) {
2122 global $wgRCWatchCategoryMembership;
2128 'restored' => false,
2129 'oldrevision' => null,
2130 'oldcountable' => null
2132 $content = $revision->getContent();
2134 $logger = LoggerFactory
::getInstance( 'SaveParse' );
2136 // See if the parser output before $revision was inserted is still valid
2138 if ( !$this->mPreparedEdit
) {
2139 $logger->debug( __METHOD__
. ": No prepared edit...\n" );
2140 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2141 $logger->info( __METHOD__
. ": Prepared edit has vary-revision...\n" );
2142 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision-id' )
2143 && $this->mPreparedEdit
->output
->getSpeculativeRevIdUsed() !== $revision->getId()
2145 $logger->info( __METHOD__
. ": Prepared edit has vary-revision-id with wrong ID...\n" );
2146 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-user' ) && !$options['changed'] ) {
2147 $logger->info( __METHOD__
. ": Prepared edit has vary-user and is null...\n" );
2149 wfDebug( __METHOD__
. ": Using prepared edit...\n" );
2150 $editInfo = $this->mPreparedEdit
;
2154 // Parse the text again if needed. Be careful not to do pre-save transform twice:
2155 // $text is usually already pre-save transformed once. Avoid using the edit stash
2156 // as any prepared content from there or in doEditContent() was already rejected.
2157 $editInfo = $this->prepareContentForEdit( $content, $revision, $user, null, false );
2160 // Save it to the parser cache.
2161 // Make sure the cache time matches page_touched to avoid double parsing.
2162 MediaWikiServices
::getInstance()->getParserCache()->save(
2163 $editInfo->output
, $this, $editInfo->popts
,
2164 $revision->getTimestamp(), $editInfo->revid
2167 // Update the links tables and other secondary data
2169 $recursive = $options['changed']; // T52785
2170 $updates = $content->getSecondaryDataUpdates(
2171 $this->getTitle(), null, $recursive, $editInfo->output
2173 foreach ( $updates as $update ) {
2174 if ( $update instanceof LinksUpdate
) {
2175 $update->setRevision( $revision );
2176 $update->setTriggeringUser( $user );
2178 DeferredUpdates
::addUpdate( $update );
2180 if ( $wgRCWatchCategoryMembership
2181 && $this->getContentHandler()->supportsCategories() === true
2182 && ( $options['changed'] ||
$options['created'] )
2183 && !$options['restored']
2185 // Note: jobs are pushed after deferred updates, so the job should be able to see
2186 // the recent change entry (also done via deferred updates) and carry over any
2187 // bot/deletion/IP flags, ect.
2188 JobQueueGroup
::singleton()->lazyPush( new CategoryMembershipChangeJob(
2191 'pageId' => $this->getId(),
2192 'revTimestamp' => $revision->getTimestamp()
2198 // Avoid PHP 7.1 warning of passing $this by reference
2201 Hooks
::run( 'ArticleEditUpdates', [ &$wikiPage, &$editInfo, $options['changed'] ] );
2203 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', [ &$wikiPage ] ) ) {
2204 // Flush old entries from the `recentchanges` table
2205 if ( mt_rand( 0, 9 ) == 0 ) {
2206 JobQueueGroup
::singleton()->lazyPush( RecentChangesUpdateJob
::newPurgeJob() );
2210 if ( !$this->exists() ) {
2214 $id = $this->getId();
2215 $title = $this->mTitle
->getPrefixedDBkey();
2216 $shortTitle = $this->mTitle
->getDBkey();
2218 if ( $options['oldcountable'] === 'no-change' ||
2219 ( !$options['changed'] && !$options['moved'] )
2222 } elseif ( $options['created'] ) {
2223 $good = (int)$this->isCountable( $editInfo );
2224 } elseif ( $options['oldcountable'] !== null ) {
2225 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2229 $edits = $options['changed'] ?
1 : 0;
2230 $total = $options['created'] ?
1 : 0;
2232 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2233 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2235 // If this is another user's talk page, update newtalk.
2236 // Don't do this if $options['changed'] = false (null-edits) nor if
2237 // it's a minor edit and the user doesn't want notifications for those.
2238 if ( $options['changed']
2239 && $this->mTitle
->getNamespace() == NS_USER_TALK
2240 && $shortTitle != $user->getTitleKey()
2241 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2243 $recipient = User
::newFromName( $shortTitle, false );
2244 if ( !$recipient ) {
2245 wfDebug( __METHOD__
. ": invalid username\n" );
2247 // Avoid PHP 7.1 warning of passing $this by reference
2250 // Allow extensions to prevent user notification
2251 // when a new message is added to their talk page
2252 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', [ &$wikiPage, $recipient ] ) ) {
2253 if ( User
::isIP( $shortTitle ) ) {
2254 // An anonymous user
2255 $recipient->setNewtalk( true, $revision );
2256 } elseif ( $recipient->isLoggedIn() ) {
2257 $recipient->setNewtalk( true, $revision );
2259 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2265 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2266 MessageCache
::singleton()->updateMessageOverride( $this->mTitle
, $content );
2269 if ( $options['created'] ) {
2270 self
::onArticleCreate( $this->mTitle
);
2271 } elseif ( $options['changed'] ) { // T52785
2272 self
::onArticleEdit( $this->mTitle
, $revision );
2275 ResourceLoaderWikiModule
::invalidateModuleCache(
2276 $this->mTitle
, $options['oldrevision'], $revision, wfWikiID()
2281 * Update the article's restriction field, and leave a log entry.
2282 * This works for protection both existing and non-existing pages.
2284 * @param array $limit Set of restriction keys
2285 * @param array $expiry Per restriction type expiration
2286 * @param int &$cascade Set to false if cascading protection isn't allowed.
2287 * @param string $reason
2288 * @param User $user The user updating the restrictions
2289 * @param string|string[] $tags Change tags to add to the pages and protection log entries
2290 * ($user should be able to add the specified tags before this is called)
2291 * @return Status Status object; if action is taken, $status->value is the log_id of the
2292 * protection log entry.
2294 public function doUpdateRestrictions( array $limit, array $expiry,
2295 &$cascade, $reason, User
$user, $tags = null
2297 global $wgCascadingRestrictionLevels;
2299 if ( wfReadOnly() ) {
2300 return Status
::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
2303 $this->loadPageData( 'fromdbmaster' );
2304 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2305 $id = $this->getId();
2311 // Take this opportunity to purge out expired restrictions
2312 Title
::purgeExpiredRestrictions();
2314 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2315 // we expect a single selection, but the schema allows otherwise.
2316 $isProtected = false;
2320 $dbw = wfGetDB( DB_MASTER
);
2322 foreach ( $restrictionTypes as $action ) {
2323 if ( !isset( $expiry[$action] ) ||
$expiry[$action] === $dbw->getInfinity() ) {
2324 $expiry[$action] = 'infinity';
2326 if ( !isset( $limit[$action] ) ) {
2327 $limit[$action] = '';
2328 } elseif ( $limit[$action] != '' ) {
2332 // Get current restrictions on $action
2333 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2334 if ( $current != '' ) {
2335 $isProtected = true;
2338 if ( $limit[$action] != $current ) {
2340 } elseif ( $limit[$action] != '' ) {
2341 // Only check expiry change if the action is actually being
2342 // protected, since expiry does nothing on an not-protected
2344 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2350 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2354 // If nothing has changed, do nothing
2356 return Status
::newGood();
2359 if ( !$protect ) { // No protection at all means unprotection
2360 $revCommentMsg = 'unprotectedarticle-comment';
2361 $logAction = 'unprotect';
2362 } elseif ( $isProtected ) {
2363 $revCommentMsg = 'modifiedarticleprotection-comment';
2364 $logAction = 'modify';
2366 $revCommentMsg = 'protectedarticle-comment';
2367 $logAction = 'protect';
2370 $logRelationsValues = [];
2371 $logRelationsField = null;
2372 $logParamsDetails = [];
2374 // Null revision (used for change tag insertion)
2375 $nullRevision = null;
2377 if ( $id ) { // Protection of existing page
2378 // Avoid PHP 7.1 warning of passing $this by reference
2381 if ( !Hooks
::run( 'ArticleProtect', [ &$wikiPage, &$user, $limit, $reason ] ) ) {
2382 return Status
::newGood();
2385 // Only certain restrictions can cascade...
2386 $editrestriction = isset( $limit['edit'] )
2387 ?
[ $limit['edit'] ]
2388 : $this->mTitle
->getRestrictions( 'edit' );
2389 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2390 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2392 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2393 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2396 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2397 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2398 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2400 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2401 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2404 // The schema allows multiple restrictions
2405 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2409 // insert null revision to identify the page protection change as edit summary
2410 $latest = $this->getLatest();
2411 $nullRevision = $this->insertProtectNullRevision(
2420 if ( $nullRevision === null ) {
2421 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2424 $logRelationsField = 'pr_id';
2426 // Update restrictions table
2427 foreach ( $limit as $action => $restrictions ) {
2429 'page_restrictions',
2432 'pr_type' => $action
2436 if ( $restrictions != '' ) {
2437 $cascadeValue = ( $cascade && $action == 'edit' ) ?
1 : 0;
2439 'page_restrictions',
2442 'pr_type' => $action,
2443 'pr_level' => $restrictions,
2444 'pr_cascade' => $cascadeValue,
2445 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2449 $logRelationsValues[] = $dbw->insertId();
2450 $logParamsDetails[] = [
2452 'level' => $restrictions,
2453 'expiry' => $expiry[$action],
2454 'cascade' => (bool)$cascadeValue,
2459 // Clear out legacy restriction fields
2462 [ 'page_restrictions' => '' ],
2463 [ 'page_id' => $id ],
2467 // Avoid PHP 7.1 warning of passing $this by reference
2470 Hooks
::run( 'NewRevisionFromEditComplete',
2471 [ $this, $nullRevision, $latest, $user ] );
2472 Hooks
::run( 'ArticleProtectComplete', [ &$wikiPage, &$user, $limit, $reason ] );
2473 } else { // Protection of non-existing page (also known as "title protection")
2474 // Cascade protection is meaningless in this case
2477 if ( $limit['create'] != '' ) {
2478 $commentFields = CommentStore
::newKey( 'pt_reason' )->insert( $dbw, $reason );
2479 $dbw->replace( 'protected_titles',
2480 [ [ 'pt_namespace', 'pt_title' ] ],
2482 'pt_namespace' => $this->mTitle
->getNamespace(),
2483 'pt_title' => $this->mTitle
->getDBkey(),
2484 'pt_create_perm' => $limit['create'],
2485 'pt_timestamp' => $dbw->timestamp(),
2486 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2487 'pt_user' => $user->getId(),
2488 ] +
$commentFields, __METHOD__
2490 $logParamsDetails[] = [
2492 'level' => $limit['create'],
2493 'expiry' => $expiry['create'],
2496 $dbw->delete( 'protected_titles',
2498 'pt_namespace' => $this->mTitle
->getNamespace(),
2499 'pt_title' => $this->mTitle
->getDBkey()
2505 $this->mTitle
->flushRestrictions();
2506 InfoAction
::invalidateCache( $this->mTitle
);
2508 if ( $logAction == 'unprotect' ) {
2511 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2513 '4::description' => $protectDescriptionLog, // parameter for IRC
2514 '5:bool:cascade' => $cascade,
2515 'details' => $logParamsDetails, // parameter for localize and api
2519 // Update the protection log
2520 $logEntry = new ManualLogEntry( 'protect', $logAction );
2521 $logEntry->setTarget( $this->mTitle
);
2522 $logEntry->setComment( $reason );
2523 $logEntry->setPerformer( $user );
2524 $logEntry->setParameters( $params );
2525 if ( !is_null( $nullRevision ) ) {
2526 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2528 $logEntry->setTags( $tags );
2529 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2530 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2532 $logId = $logEntry->insert();
2533 $logEntry->publish( $logId );
2535 return Status
::newGood( $logId );
2539 * Insert a new null revision for this page.
2541 * @param string $revCommentMsg Comment message key for the revision
2542 * @param array $limit Set of restriction keys
2543 * @param array $expiry Per restriction type expiration
2544 * @param int $cascade Set to false if cascading protection isn't allowed.
2545 * @param string $reason
2546 * @param User|null $user
2547 * @return Revision|null Null on error
2549 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2550 array $expiry, $cascade, $reason, $user = null
2552 $dbw = wfGetDB( DB_MASTER
);
2554 // Prepare a null revision to be added to the history
2555 $editComment = wfMessage(
2557 $this->mTitle
->getPrefixedText(),
2558 $user ?
$user->getName() : ''
2559 )->inContentLanguage()->text();
2561 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2563 $protectDescription = $this->protectDescription( $limit, $expiry );
2564 if ( $protectDescription ) {
2565 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2566 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2567 ->inContentLanguage()->text();
2570 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2571 $editComment .= wfMessage( 'brackets' )->params(
2572 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2573 )->inContentLanguage()->text();
2576 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2578 $nullRev->insertOn( $dbw );
2580 // Update page record and touch page
2581 $oldLatest = $nullRev->getParentId();
2582 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2589 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2592 protected function formatExpiry( $expiry ) {
2595 if ( $expiry != 'infinity' ) {
2598 $wgContLang->timeanddate( $expiry, false, false ),
2599 $wgContLang->date( $expiry, false, false ),
2600 $wgContLang->time( $expiry, false, false )
2601 )->inContentLanguage()->text();
2603 return wfMessage( 'protect-expiry-indefinite' )
2604 ->inContentLanguage()->text();
2609 * Builds the description to serve as comment for the edit.
2611 * @param array $limit Set of restriction keys
2612 * @param array $expiry Per restriction type expiration
2615 public function protectDescription( array $limit, array $expiry ) {
2616 $protectDescription = '';
2618 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2619 # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2620 # All possible message keys are listed here for easier grepping:
2621 # * restriction-create
2622 # * restriction-edit
2623 # * restriction-move
2624 # * restriction-upload
2625 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2626 # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2627 # with '' filtered out. All possible message keys are listed below:
2628 # * protect-level-autoconfirmed
2629 # * protect-level-sysop
2630 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2631 ->inContentLanguage()->text();
2633 $expiryText = $this->formatExpiry( $expiry[$action] );
2635 if ( $protectDescription !== '' ) {
2636 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2638 $protectDescription .= wfMessage( 'protect-summary-desc' )
2639 ->params( $actionText, $restrictionsText, $expiryText )
2640 ->inContentLanguage()->text();
2643 return $protectDescription;
2647 * Builds the description to serve as comment for the log entry.
2649 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2650 * protect description text. Keep them in old format to avoid breaking compatibility.
2651 * TODO: Fix protection log to store structured description and format it on-the-fly.
2653 * @param array $limit Set of restriction keys
2654 * @param array $expiry Per restriction type expiration
2657 public function protectDescriptionLog( array $limit, array $expiry ) {
2660 $protectDescriptionLog = '';
2662 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2663 $expiryText = $this->formatExpiry( $expiry[$action] );
2664 $protectDescriptionLog .= $wgContLang->getDirMark() .
2665 "[$action=$restrictions] ($expiryText)";
2668 return trim( $protectDescriptionLog );
2672 * Take an array of page restrictions and flatten it to a string
2673 * suitable for insertion into the page_restrictions field.
2675 * @param string[] $limit
2677 * @throws MWException
2680 protected static function flattenRestrictions( $limit ) {
2681 if ( !is_array( $limit ) ) {
2682 throw new MWException( __METHOD__
. ' given non-array restriction set' );
2688 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2689 $bits[] = "$action=$restrictions";
2692 return implode( ':', $bits );
2696 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2697 * backwards compatibility, if you care about error reporting you should use
2698 * doDeleteArticleReal() instead.
2700 * Deletes the article with database consistency, writes logs, purges caches
2702 * @param string $reason Delete reason for deletion log
2703 * @param bool $suppress Suppress all revisions and log the deletion in
2704 * the suppression log instead of the deletion log
2705 * @param int $u1 Unused
2706 * @param bool $u2 Unused
2707 * @param array|string &$error Array of errors to append to
2708 * @param User $user The deleting user
2709 * @return bool True if successful
2711 public function doDeleteArticle(
2712 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null
2714 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2715 return $status->isGood();
2719 * Back-end article deletion
2720 * Deletes the article with database consistency, writes logs, purges caches
2724 * @param string $reason Delete reason for deletion log
2725 * @param bool $suppress Suppress all revisions and log the deletion in
2726 * the suppression log instead of the deletion log
2727 * @param int $u1 Unused
2728 * @param bool $u2 Unused
2729 * @param array|string &$error Array of errors to append to
2730 * @param User $user The deleting user
2731 * @param array $tags Tags to apply to the deletion action
2732 * @param string $logsubtype
2733 * @return Status Status object; if successful, $status->value is the log_id of the
2734 * deletion log entry. If the page couldn't be deleted because it wasn't
2735 * found, $status is a non-fatal 'cannotdelete' error
2737 public function doDeleteArticleReal(
2738 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null,
2739 $tags = [], $logsubtype = 'delete'
2741 global $wgUser, $wgContentHandlerUseDB, $wgCommentTableSchemaMigrationStage;
2743 wfDebug( __METHOD__
. "\n" );
2745 $status = Status
::newGood();
2747 if ( $this->mTitle
->getDBkey() === '' ) {
2748 $status->error( 'cannotdelete',
2749 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2753 // Avoid PHP 7.1 warning of passing $this by reference
2756 $user = is_null( $user ) ?
$wgUser : $user;
2757 if ( !Hooks
::run( 'ArticleDelete',
2758 [ &$wikiPage, &$user, &$reason, &$error, &$status, $suppress ]
2760 if ( $status->isOK() ) {
2761 // Hook aborted but didn't set a fatal status
2762 $status->fatal( 'delete-hook-aborted' );
2767 $dbw = wfGetDB( DB_MASTER
);
2768 $dbw->startAtomic( __METHOD__
);
2770 $this->loadPageData( self
::READ_LATEST
);
2771 $id = $this->getId();
2772 // T98706: lock the page from various other updates but avoid using
2773 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2774 // the revisions queries (which also JOIN on user). Only lock the page
2775 // row and CAS check on page_latest to see if the trx snapshot matches.
2776 $lockedLatest = $this->lockAndGetLatest();
2777 if ( $id == 0 ||
$this->getLatest() != $lockedLatest ) {
2778 $dbw->endAtomic( __METHOD__
);
2779 // Page not there or trx snapshot is stale
2780 $status->error( 'cannotdelete',
2781 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2785 // Given the lock above, we can be confident in the title and page ID values
2786 $namespace = $this->getTitle()->getNamespace();
2787 $dbKey = $this->getTitle()->getDBkey();
2789 // At this point we are now comitted to returning an OK
2790 // status unless some DB query error or other exception comes up.
2791 // This way callers don't have to call rollback() if $status is bad
2792 // unless they actually try to catch exceptions (which is rare).
2794 // we need to remember the old content so we can use it to generate all deletion updates.
2795 $revision = $this->getRevision();
2797 $content = $this->getContent( Revision
::RAW
);
2798 } catch ( Exception
$ex ) {
2799 wfLogWarning( __METHOD__
. ': failed to load content during deletion! '
2800 . $ex->getMessage() );
2805 $revCommentStore = new CommentStore( 'rev_comment' );
2806 $arCommentStore = new CommentStore( 'ar_comment' );
2808 $fields = Revision
::selectFields();
2811 // Bitfields to further suppress the content
2813 $bitfield = Revision
::SUPPRESSED_ALL
;
2814 $fields = array_diff( $fields, [ 'rev_deleted' ] );
2817 // For now, shunt the revision data into the archive table.
2818 // Text is *not* removed from the text table; bulk storage
2819 // is left intact to avoid breaking block-compression or
2820 // immutable storage schemes.
2821 // In the future, we may keep revisions and mark them with
2822 // the rev_deleted field, which is reserved for this purpose.
2824 // Get all of the page revisions
2825 $commentQuery = $revCommentStore->getJoin();
2826 $res = $dbw->select(
2827 [ 'revision' ] +
$commentQuery['tables'],
2828 $fields +
$commentQuery['fields'],
2829 [ 'rev_page' => $id ],
2832 $commentQuery['joins']
2835 // Build their equivalent archive rows
2839 /** @var int[] Revision IDs of edits that were made by IPs */
2842 foreach ( $res as $row ) {
2843 $comment = $revCommentStore->getComment( $row );
2845 'ar_namespace' => $namespace,
2846 'ar_title' => $dbKey,
2847 'ar_user' => $row->rev_user
,
2848 'ar_user_text' => $row->rev_user_text
,
2849 'ar_timestamp' => $row->rev_timestamp
,
2850 'ar_minor_edit' => $row->rev_minor_edit
,
2851 'ar_rev_id' => $row->rev_id
,
2852 'ar_parent_id' => $row->rev_parent_id
,
2853 'ar_text_id' => $row->rev_text_id
,
2856 'ar_len' => $row->rev_len
,
2857 'ar_page_id' => $id,
2858 'ar_deleted' => $suppress ?
$bitfield : $row->rev_deleted
,
2859 'ar_sha1' => $row->rev_sha1
,
2860 ] +
$arCommentStore->insert( $dbw, $comment );
2861 if ( $wgContentHandlerUseDB ) {
2862 $rowInsert['ar_content_model'] = $row->rev_content_model
;
2863 $rowInsert['ar_content_format'] = $row->rev_content_format
;
2865 $rowsInsert[] = $rowInsert;
2866 $revids[] = $row->rev_id
;
2868 // Keep track of IP edits, so that the corresponding rows can
2869 // be deleted in the ip_changes table.
2870 if ( (int)$row->rev_user
=== 0 && IP
::isValid( $row->rev_user_text
) ) {
2871 $ipRevIds[] = $row->rev_id
;
2874 // Copy them into the archive table
2875 $dbw->insert( 'archive', $rowsInsert, __METHOD__
);
2876 // Save this so we can pass it to the ArticleDeleteComplete hook.
2877 $archivedRevisionCount = $dbw->affectedRows();
2879 // Clone the title and wikiPage, so we have the information we need when
2880 // we log and run the ArticleDeleteComplete hook.
2881 $logTitle = clone $this->mTitle
;
2882 $wikiPageBeforeDelete = clone $this;
2884 // Now that it's safely backed up, delete it
2885 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__
);
2886 $dbw->delete( 'revision', [ 'rev_page' => $id ], __METHOD__
);
2887 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
2888 $dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__
);
2891 // Also delete records from ip_changes as applicable.
2892 if ( count( $ipRevIds ) > 0 ) {
2893 $dbw->delete( 'ip_changes', [ 'ipc_rev_id' => $ipRevIds ], __METHOD__
);
2896 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2897 $logtype = $suppress ?
'suppress' : 'delete';
2899 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2900 $logEntry->setPerformer( $user );
2901 $logEntry->setTarget( $logTitle );
2902 $logEntry->setComment( $reason );
2903 $logEntry->setTags( $tags );
2904 $logid = $logEntry->insert();
2906 $dbw->onTransactionPreCommitOrIdle(
2907 function () use ( $dbw, $logEntry, $logid ) {
2908 // T58776: avoid deadlocks (especially from FileDeleteForm)
2909 $logEntry->publish( $logid );
2914 $dbw->endAtomic( __METHOD__
);
2916 $this->doDeleteUpdates( $id, $content, $revision );
2918 Hooks
::run( 'ArticleDeleteComplete', [
2919 &$wikiPageBeforeDelete,
2925 $archivedRevisionCount
2927 $status->value
= $logid;
2929 // Show log excerpt on 404 pages rather than just a link
2930 $cache = MediaWikiServices
::getInstance()->getMainObjectStash();
2931 $key = $cache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2932 $cache->set( $key, 1, $cache::TTL_DAY
);
2938 * Lock the page row for this title+id and return page_latest (or 0)
2940 * @return int Returns 0 if no row was found with this title+id
2943 public function lockAndGetLatest() {
2944 return (int)wfGetDB( DB_MASTER
)->selectField(
2948 'page_id' => $this->getId(),
2949 // Typically page_id is enough, but some code might try to do
2950 // updates assuming the title is the same, so verify that
2951 'page_namespace' => $this->getTitle()->getNamespace(),
2952 'page_title' => $this->getTitle()->getDBkey()
2960 * Do some database updates after deletion
2962 * @param int $id The page_id value of the page being deleted
2963 * @param Content|null $content Optional page content to be used when determining
2964 * the required updates. This may be needed because $this->getContent()
2965 * may already return null when the page proper was deleted.
2966 * @param Revision|null $revision The latest page revision
2968 public function doDeleteUpdates( $id, Content
$content = null, Revision
$revision = null ) {
2970 $countable = $this->isCountable();
2971 } catch ( Exception
$ex ) {
2972 // fallback for deleting broken pages for which we cannot load the content for
2973 // some reason. Note that doDeleteArticleReal() already logged this problem.
2977 // Update site status
2978 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$countable, -1 ) );
2980 // Delete pagelinks, update secondary indexes, etc
2981 $updates = $this->getDeletionUpdates( $content );
2982 foreach ( $updates as $update ) {
2983 DeferredUpdates
::addUpdate( $update );
2986 // Reparse any pages transcluding this page
2987 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'templatelinks' );
2989 // Reparse any pages including this image
2990 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
2991 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'imagelinks' );
2995 self
::onArticleDelete( $this->mTitle
);
2996 ResourceLoaderWikiModule
::invalidateModuleCache(
2997 $this->mTitle
, $revision, null, wfWikiID()
3000 // Reset this object and the Title object
3001 $this->loadFromRow( false, self
::READ_LATEST
);
3004 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
3008 * Roll back the most recent consecutive set of edits to a page
3009 * from the same user; fails if there are no eligible edits to
3010 * roll back to, e.g. user is the sole contributor. This function
3011 * performs permissions checks on $user, then calls commitRollback()
3012 * to do the dirty work
3014 * @todo Separate the business/permission stuff out from backend code
3015 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3017 * @param string $fromP Name of the user whose edits to rollback.
3018 * @param string $summary Custom summary. Set to default summary if empty.
3019 * @param string $token Rollback token.
3020 * @param bool $bot If true, mark all reverted edits as bot.
3022 * @param array &$resultDetails Array contains result-specific array of additional values
3023 * 'alreadyrolled' : 'current' (rev)
3024 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3026 * @param User $user The user performing the rollback
3027 * @param array|null $tags Change tags to apply to the rollback
3028 * Callers are responsible for permission checks
3029 * (with ChangeTags::canAddTagsAccompanyingChange)
3031 * @return array Array of errors, each error formatted as
3032 * array(messagekey, param1, param2, ...).
3033 * On success, the array is empty. This array can also be passed to
3034 * OutputPage::showPermissionsErrorPage().
3036 public function doRollback(
3037 $fromP, $summary, $token, $bot, &$resultDetails, User
$user, $tags = null
3039 $resultDetails = null;
3041 // Check permissions
3042 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
3043 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
3044 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3046 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3047 $errors[] = [ 'sessionfailure' ];
3050 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
3051 $errors[] = [ 'actionthrottledtext' ];
3054 // If there were errors, bail out now
3055 if ( !empty( $errors ) ) {
3059 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3063 * Backend implementation of doRollback(), please refer there for parameter
3064 * and return value documentation
3066 * NOTE: This function does NOT check ANY permissions, it just commits the
3067 * rollback to the DB. Therefore, you should only call this function direct-
3068 * ly if you want to use custom permissions checks. If you don't, use
3069 * doRollback() instead.
3070 * @param string $fromP Name of the user whose edits to rollback.
3071 * @param string $summary Custom summary. Set to default summary if empty.
3072 * @param bool $bot If true, mark all reverted edits as bot.
3074 * @param array &$resultDetails Contains result-specific array of additional values
3075 * @param User $guser The user performing the rollback
3076 * @param array|null $tags Change tags to apply to the rollback
3077 * Callers are responsible for permission checks
3078 * (with ChangeTags::canAddTagsAccompanyingChange)
3082 public function commitRollback( $fromP, $summary, $bot,
3083 &$resultDetails, User
$guser, $tags = null
3085 global $wgUseRCPatrol, $wgContLang;
3087 $dbw = wfGetDB( DB_MASTER
);
3089 if ( wfReadOnly() ) {
3090 return [ [ 'readonlytext' ] ];
3093 // Get the last editor
3094 $current = $this->getRevision();
3095 if ( is_null( $current ) ) {
3096 // Something wrong... no page?
3097 return [ [ 'notanarticle' ] ];
3100 $from = str_replace( '_', ' ', $fromP );
3101 // User name given should match up with the top revision.
3102 // If the user was deleted then $from should be empty.
3103 if ( $from != $current->getUserText() ) {
3104 $resultDetails = [ 'current' => $current ];
3105 return [ [ 'alreadyrolled',
3106 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3107 htmlspecialchars( $fromP ),
3108 htmlspecialchars( $current->getUserText() )
3112 // Get the last edit not by this person...
3113 // Note: these may not be public values
3114 $user = intval( $current->getUser( Revision
::RAW
) );
3115 $user_text = $dbw->addQuotes( $current->getUserText( Revision
::RAW
) );
3116 $s = $dbw->selectRow( 'revision',
3117 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3118 [ 'rev_page' => $current->getPage(),
3119 "rev_user != {$user} OR rev_user_text != {$user_text}"
3121 [ 'USE INDEX' => 'page_timestamp',
3122 'ORDER BY' => 'rev_timestamp DESC' ]
3124 if ( $s === false ) {
3125 // No one else ever edited this page
3126 return [ [ 'cantrollback' ] ];
3127 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT
3128 ||
$s->rev_deleted
& Revision
::DELETED_USER
3130 // Only admins can see this text
3131 return [ [ 'notvisiblerev' ] ];
3134 // Generate the edit summary if necessary
3135 $target = Revision
::newFromId( $s->rev_id
, Revision
::READ_LATEST
);
3136 if ( empty( $summary ) ) {
3137 if ( $from == '' ) { // no public user name
3138 $summary = wfMessage( 'revertpage-nouser' );
3140 $summary = wfMessage( 'revertpage' );
3144 // Allow the custom summary to use the same args as the default message
3146 $target->getUserText(), $from, $s->rev_id
,
3147 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3148 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3150 if ( $summary instanceof Message
) {
3151 $summary = $summary->params( $args )->inContentLanguage()->text();
3153 $summary = wfMsgReplaceArgs( $summary, $args );
3156 // Trim spaces on user supplied text
3157 $summary = trim( $summary );
3160 $flags = EDIT_UPDATE | EDIT_INTERNAL
;
3162 if ( $guser->isAllowed( 'minoredit' ) ) {
3163 $flags |
= EDIT_MINOR
;
3166 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3167 $flags |
= EDIT_FORCE_BOT
;
3170 $targetContent = $target->getContent();
3171 $changingContentModel = $targetContent->getModel() !== $current->getContentModel();
3173 // Actually store the edit
3174 $status = $this->doEditContent(
3184 // Set patrolling and bot flag on the edits, which gets rollbacked.
3185 // This is done even on edit failure to have patrolling in that case (T64157).
3187 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3188 // Mark all reverted edits as bot
3192 if ( $wgUseRCPatrol ) {
3193 // Mark all reverted edits as patrolled
3194 $set['rc_patrolled'] = 1;
3197 if ( count( $set ) ) {
3198 $dbw->update( 'recentchanges', $set,
3200 'rc_cur_id' => $current->getPage(),
3201 'rc_user_text' => $current->getUserText(),
3202 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3208 if ( !$status->isOK() ) {
3209 return $status->getErrorsArray();
3212 // raise error, when the edit is an edit without a new version
3213 $statusRev = isset( $status->value
['revision'] )
3214 ?
$status->value
['revision']
3216 if ( !( $statusRev instanceof Revision
) ) {
3217 $resultDetails = [ 'current' => $current ];
3218 return [ [ 'alreadyrolled',
3219 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3220 htmlspecialchars( $fromP ),
3221 htmlspecialchars( $current->getUserText() )
3225 if ( $changingContentModel ) {
3226 // If the content model changed during the rollback,
3227 // make sure it gets logged to Special:Log/contentmodel
3228 $log = new ManualLogEntry( 'contentmodel', 'change' );
3229 $log->setPerformer( $guser );
3230 $log->setTarget( $this->mTitle
);
3231 $log->setComment( $summary );
3232 $log->setParameters( [
3233 '4::oldmodel' => $current->getContentModel(),
3234 '5::newmodel' => $targetContent->getModel(),
3237 $logId = $log->insert( $dbw );
3238 $log->publish( $logId );
3241 $revId = $statusRev->getId();
3243 Hooks
::run( 'ArticleRollbackComplete', [ $this, $guser, $target, $current ] );
3246 'summary' => $summary,
3247 'current' => $current,
3248 'target' => $target,
3256 * The onArticle*() functions are supposed to be a kind of hooks
3257 * which should be called whenever any of the specified actions
3260 * This is a good place to put code to clear caches, for instance.
3262 * This is called on page move and undelete, as well as edit
3264 * @param Title $title
3266 public static function onArticleCreate( Title
$title ) {
3267 // Update existence markers on article/talk tabs...
3268 $other = $title->getOtherPage();
3270 $other->purgeSquid();
3272 $title->touchLinks();
3273 $title->purgeSquid();
3274 $title->deleteTitleProtection();
3276 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3278 // Invalidate caches of articles which include this page
3279 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3281 if ( $title->getNamespace() == NS_CATEGORY
) {
3282 // Load the Category object, which will schedule a job to create
3283 // the category table row if necessary. Checking a replica DB is ok
3284 // here, in the worst case it'll run an unnecessary recount job on
3285 // a category that probably doesn't have many members.
3286 Category
::newFromTitle( $title )->getID();
3291 * Clears caches when article is deleted
3293 * @param Title $title
3295 public static function onArticleDelete( Title
$title ) {
3296 // Update existence markers on article/talk tabs...
3297 $other = $title->getOtherPage();
3299 $other->purgeSquid();
3301 $title->touchLinks();
3302 $title->purgeSquid();
3304 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3307 HTMLFileCache
::clearFileCache( $title );
3308 InfoAction
::invalidateCache( $title );
3311 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3312 MessageCache
::singleton()->updateMessageOverride( $title, null );
3316 if ( $title->getNamespace() == NS_FILE
) {
3317 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'imagelinks' ) );
3321 if ( $title->getNamespace() == NS_USER_TALK
) {
3322 $user = User
::newFromName( $title->getText(), false );
3324 $user->setNewtalk( false );
3329 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3333 * Purge caches on page update etc
3335 * @param Title $title
3336 * @param Revision|null $revision Revision that was just saved, may be null
3338 public static function onArticleEdit( Title
$title, Revision
$revision = null ) {
3339 // Invalidate caches of articles which include this page
3340 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3342 // Invalidate the caches of all pages which redirect here
3343 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'redirect' ) );
3345 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3347 // Purge CDN for this page only
3348 $title->purgeSquid();
3349 // Clear file cache for this page only
3350 HTMLFileCache
::clearFileCache( $title );
3352 $revid = $revision ?
$revision->getId() : null;
3353 DeferredUpdates
::addCallableUpdate( function () use ( $title, $revid ) {
3354 InfoAction
::invalidateCache( $title, $revid );
3361 * Returns a list of categories this page is a member of.
3362 * Results will include hidden categories
3364 * @return TitleArray
3366 public function getCategories() {
3367 $id = $this->getId();
3369 return TitleArray
::newFromResult( new FakeResultWrapper( [] ) );
3372 $dbr = wfGetDB( DB_REPLICA
);
3373 $res = $dbr->select( 'categorylinks',
3374 [ 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ],
3375 // Have to do that since Database::fieldNamesWithAlias treats numeric indexes
3376 // as not being aliases, and NS_CATEGORY is numeric
3377 [ 'cl_from' => $id ],
3380 return TitleArray
::newFromResult( $res );
3384 * Returns a list of hidden categories this page is a member of.
3385 * Uses the page_props and categorylinks tables.
3387 * @return array Array of Title objects
3389 public function getHiddenCategories() {
3391 $id = $this->getId();
3397 $dbr = wfGetDB( DB_REPLICA
);
3398 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3400 [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3401 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ],
3404 if ( $res !== false ) {
3405 foreach ( $res as $row ) {
3406 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3414 * Auto-generates a deletion reason
3416 * @param bool &$hasHistory Whether the page has a history
3417 * @return string|bool String containing deletion reason or empty string, or boolean false
3418 * if no revision occurred
3420 public function getAutoDeleteReason( &$hasHistory ) {
3421 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3425 * Update all the appropriate counts in the category table, given that
3426 * we've added the categories $added and deleted the categories $deleted.
3428 * This should only be called from deferred updates or jobs to avoid contention.
3430 * @param array $added The names of categories that were added
3431 * @param array $deleted The names of categories that were deleted
3432 * @param int $id Page ID (this should be the original deleted page ID)
3434 public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3435 $id = $id ?
: $this->getId();
3436 $ns = $this->getTitle()->getNamespace();
3438 $addFields = [ 'cat_pages = cat_pages + 1' ];
3439 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3440 if ( $ns == NS_CATEGORY
) {
3441 $addFields[] = 'cat_subcats = cat_subcats + 1';
3442 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3443 } elseif ( $ns == NS_FILE
) {
3444 $addFields[] = 'cat_files = cat_files + 1';
3445 $removeFields[] = 'cat_files = cat_files - 1';
3448 $dbw = wfGetDB( DB_MASTER
);
3450 if ( count( $added ) ) {
3451 $existingAdded = $dbw->selectFieldValues(
3454 [ 'cat_title' => $added ],
3458 // For category rows that already exist, do a plain
3459 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3460 // to avoid creating gaps in the cat_id sequence.
3461 if ( count( $existingAdded ) ) {
3465 [ 'cat_title' => $existingAdded ],
3470 $missingAdded = array_diff( $added, $existingAdded );
3471 if ( count( $missingAdded ) ) {
3473 foreach ( $missingAdded as $cat ) {
3475 'cat_title' => $cat,
3477 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3478 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3491 if ( count( $deleted ) ) {
3495 [ 'cat_title' => $deleted ],
3500 foreach ( $added as $catName ) {
3501 $cat = Category
::newFromName( $catName );
3502 Hooks
::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3505 foreach ( $deleted as $catName ) {
3506 $cat = Category
::newFromName( $catName );
3507 Hooks
::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3510 // Refresh counts on categories that should be empty now, to
3511 // trigger possible deletion. Check master for the most
3512 // up-to-date cat_pages.
3513 if ( count( $deleted ) ) {
3514 $rows = $dbw->select(
3516 [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
3517 [ 'cat_title' => $deleted, 'cat_pages <= 0' ],
3520 foreach ( $rows as $row ) {
3521 $cat = Category
::newFromRow( $row );
3522 // T166757: do the update after this DB commit
3523 DeferredUpdates
::addCallableUpdate( function () use ( $cat ) {
3524 $cat->refreshCounts();
3531 * Opportunistically enqueue link update jobs given fresh parser output if useful
3533 * @param ParserOutput $parserOutput Current version page output
3536 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3537 if ( wfReadOnly() ) {
3541 if ( !Hooks
::run( 'OpportunisticLinksUpdate',
3542 [ $this, $this->mTitle
, $parserOutput ]
3547 $config = RequestContext
::getMain()->getConfig();
3550 'isOpportunistic' => true,
3551 'rootJobTimestamp' => $parserOutput->getCacheTime()
3554 if ( $this->mTitle
->areRestrictionsCascading() ) {
3555 // If the page is cascade protecting, the links should really be up-to-date
3556 JobQueueGroup
::singleton()->lazyPush(
3557 RefreshLinksJob
::newPrioritized( $this->mTitle
, $params )
3559 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3560 // Assume the output contains "dynamic" time/random based magic words.
3561 // Only update pages that expired due to dynamic content and NOT due to edits
3562 // to referenced templates/files. When the cache expires due to dynamic content,
3563 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3564 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3565 // template/file edit already triggered recursive RefreshLinksJob jobs.
3566 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3567 // If a page is uncacheable, do not keep spamming a job for it.
3568 // Although it would be de-duplicated, it would still waste I/O.
3569 $cache = ObjectCache
::getLocalClusterInstance();
3570 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3571 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3572 if ( $cache->add( $key, time(), $ttl ) ) {
3573 JobQueueGroup
::singleton()->lazyPush(
3574 RefreshLinksJob
::newDynamic( $this->mTitle
, $params )
3582 * Returns a list of updates to be performed when this page is deleted. The
3583 * updates should remove any information about this page from secondary data
3584 * stores such as links tables.
3586 * @param Content|null $content Optional Content object for determining the
3587 * necessary updates.
3588 * @return DeferrableUpdate[]
3590 public function getDeletionUpdates( Content
$content = null ) {
3592 // load content object, which may be used to determine the necessary updates.
3593 // XXX: the content may not be needed to determine the updates.
3595 $content = $this->getContent( Revision
::RAW
);
3596 } catch ( Exception
$ex ) {
3597 // If we can't load the content, something is wrong. Perhaps that's why
3598 // the user is trying to delete the page, so let's not fail in that case.
3599 // Note that doDeleteArticleReal() will already have logged an issue with
3600 // loading the content.
3607 $updates = $content->getDeletionUpdates( $this );
3610 Hooks
::run( 'WikiPageDeletionUpdates', [ $this, $content, &$updates ] );
3615 * Whether this content displayed on this page
3616 * comes from the local database
3621 public function isLocal() {
3626 * The display name for the site this content
3627 * come from. If a subclass overrides isLocal(),
3628 * this could return something other than the
3634 public function getWikiDisplayName() {
3640 * Get the source URL for the content on this page,
3641 * typically the canonical URL, but may be a remote
3642 * link if the content comes from another site
3647 public function getSourceURL() {
3648 return $this->getTitle()->getCanonicalURL();
3652 * @param WANObjectCache $cache
3656 public function getMutableCacheKeys( WANObjectCache
$cache ) {
3657 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3659 return $linkCache->getMutableCacheKeys( $cache, $this->getTitle()->getTitleValue() );