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
217 public function getActionOverrides() {
218 return $this->getContentHandler()->getActionOverrides();
222 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
224 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
226 * @return ContentHandler
230 public function getContentHandler() {
231 return ContentHandler
::getForModelID( $this->getContentModel() );
235 * Get the title object of the article
236 * @return Title Title object of this page
238 public function getTitle() {
239 return $this->mTitle
;
246 public function clear() {
247 $this->mDataLoaded
= false;
248 $this->mDataLoadedFrom
= self
::READ_NONE
;
250 $this->clearCacheFields();
254 * Clear the object cache fields
257 protected function clearCacheFields() {
259 $this->mRedirectTarget
= null; // Title object if set
260 $this->mLastRevision
= null; // Latest revision
261 $this->mTouched
= '19700101000000';
262 $this->mLinksUpdated
= '19700101000000';
263 $this->mTimestamp
= '';
264 $this->mIsRedirect
= false;
265 $this->mLatest
= false;
266 // T59026: do not clear mPreparedEdit since prepareTextForEdit() already checks
267 // the requested rev ID and content against the cached one for equality. For most
268 // content types, the output should not change during the lifetime of this cache.
269 // Clearing it can cause extra parses on edit for no reason.
273 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
277 public function clearPreparedEdit() {
278 $this->mPreparedEdit
= false;
282 * Return the list of revision fields that should be selected to create
287 public static function selectFields() {
288 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
299 'page_links_updated',
304 if ( $wgContentHandlerUseDB ) {
305 $fields[] = 'page_content_model';
308 if ( $wgPageLanguageUseDB ) {
309 $fields[] = 'page_lang';
316 * Fetch a page record with the given conditions
317 * @param IDatabase $dbr
318 * @param array $conditions
319 * @param array $options
320 * @return object|bool Database result resource, or false on failure
322 protected function pageData( $dbr, $conditions, $options = [] ) {
323 $fields = self
::selectFields();
325 // Avoid PHP 7.1 warning of passing $this by reference
328 Hooks
::run( 'ArticlePageDataBefore', [ &$wikiPage, &$fields ] );
330 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
, $options );
332 Hooks
::run( 'ArticlePageDataAfter', [ &$wikiPage, &$row ] );
338 * Fetch a page record matching the Title object's namespace and title
339 * using a sanitized title string
341 * @param IDatabase $dbr
342 * @param Title $title
343 * @param array $options
344 * @return object|bool Database result resource, or false on failure
346 public function pageDataFromTitle( $dbr, $title, $options = [] ) {
347 return $this->pageData( $dbr, [
348 'page_namespace' => $title->getNamespace(),
349 'page_title' => $title->getDBkey() ], $options );
353 * Fetch a page record matching the requested ID
355 * @param IDatabase $dbr
357 * @param array $options
358 * @return object|bool Database result resource, or false on failure
360 public function pageDataFromId( $dbr, $id, $options = [] ) {
361 return $this->pageData( $dbr, [ 'page_id' => $id ], $options );
365 * Load the object from a given source by title
367 * @param object|string|int $from One of the following:
368 * - A DB query result object.
369 * - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
370 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
371 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
372 * using SELECT FOR UPDATE.
376 public function loadPageData( $from = 'fromdb' ) {
377 $from = self
::convertSelectType( $from );
378 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
379 // We already have the data from the correct location, no need to load it twice.
383 if ( is_int( $from ) ) {
384 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
385 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
386 $loadBalancer = MediaWikiServices
::getInstance()->getDBLoadBalancer();
389 && $index == DB_REPLICA
390 && $loadBalancer->getServerCount() > 1
391 && $loadBalancer->hasOrMadeRecentMasterChanges()
393 $from = self
::READ_LATEST
;
394 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
395 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
398 // No idea from where the caller got this data, assume replica DB.
400 $from = self
::READ_NORMAL
;
403 $this->loadFromRow( $data, $from );
407 * Load the object from a database row
410 * @param object|bool $data DB row containing fields returned by selectFields() or false
411 * @param string|int $from One of the following:
412 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB
413 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
414 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
415 * the master DB using SELECT FOR UPDATE
417 public function loadFromRow( $data, $from ) {
418 $lc = LinkCache
::singleton();
419 $lc->clearLink( $this->mTitle
);
422 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
424 $this->mTitle
->loadFromRow( $data );
426 // Old-fashioned restrictions
427 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
429 $this->mId
= intval( $data->page_id
);
430 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
431 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
432 $this->mIsRedirect
= intval( $data->page_is_redirect
);
433 $this->mLatest
= intval( $data->page_latest
);
434 // T39225: $latest may no longer match the cached latest Revision object.
435 // Double-check the ID of any cached latest Revision object for consistency.
436 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
437 $this->mLastRevision
= null;
438 $this->mTimestamp
= '';
441 $lc->addBadLinkObj( $this->mTitle
);
443 $this->mTitle
->loadFromRow( false );
445 $this->clearCacheFields();
450 $this->mDataLoaded
= true;
451 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
455 * @return int Page ID
457 public function getId() {
458 if ( !$this->mDataLoaded
) {
459 $this->loadPageData();
465 * @return bool Whether or not the page exists in the database
467 public function exists() {
468 if ( !$this->mDataLoaded
) {
469 $this->loadPageData();
471 return $this->mId
> 0;
475 * Check if this page is something we're going to be showing
476 * some sort of sensible content for. If we return false, page
477 * views (plain action=view) will return an HTTP 404 response,
478 * so spiders and robots can know they're following a bad link.
482 public function hasViewableContent() {
483 return $this->mTitle
->isKnown();
487 * Tests if the article content represents a redirect
491 public function isRedirect() {
492 if ( !$this->mDataLoaded
) {
493 $this->loadPageData();
496 return (bool)$this->mIsRedirect
;
500 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
502 * Will use the revisions actual content model if the page exists,
503 * and the page's default if the page doesn't exist yet.
509 public function getContentModel() {
510 if ( $this->exists() ) {
511 $cache = ObjectCache
::getMainWANInstance();
513 return $cache->getWithSetCallback(
514 $cache->makeKey( 'page', 'content-model', $this->getLatest() ),
517 $rev = $this->getRevision();
519 // Look at the revision's actual content model
520 return $rev->getContentModel();
522 $title = $this->mTitle
->getPrefixedDBkey();
523 wfWarn( "Page $title exists but has no (visible) revisions!" );
524 return $this->mTitle
->getContentModel();
530 // use the default model for this page
531 return $this->mTitle
->getContentModel();
535 * Loads page_touched and returns a value indicating if it should be used
536 * @return bool True if this page exists and is not a redirect
538 public function checkTouched() {
539 if ( !$this->mDataLoaded
) {
540 $this->loadPageData();
542 return ( $this->mId
&& !$this->mIsRedirect
);
546 * Get the page_touched field
547 * @return string Containing GMT timestamp
549 public function getTouched() {
550 if ( !$this->mDataLoaded
) {
551 $this->loadPageData();
553 return $this->mTouched
;
557 * Get the page_links_updated field
558 * @return string|null Containing GMT timestamp
560 public function getLinksTimestamp() {
561 if ( !$this->mDataLoaded
) {
562 $this->loadPageData();
564 return $this->mLinksUpdated
;
568 * Get the page_latest field
569 * @return int The rev_id of current revision
571 public function getLatest() {
572 if ( !$this->mDataLoaded
) {
573 $this->loadPageData();
575 return (int)$this->mLatest
;
579 * Get the Revision object of the oldest revision
580 * @return Revision|null
582 public function getOldestRevision() {
583 // Try using the replica DB first, then try the master
584 $rev = $this->mTitle
->getFirstRevision();
586 $rev = $this->mTitle
->getFirstRevision( Title
::GAID_FOR_UPDATE
);
592 * Loads everything except the text
593 * This isn't necessary for all uses, so it's only done if needed.
595 protected function loadLastEdit() {
596 if ( $this->mLastRevision
!== null ) {
597 return; // already loaded
600 $latest = $this->getLatest();
602 return; // page doesn't exist or is missing page_latest info
605 if ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) {
606 // T39225: if session S1 loads the page row FOR UPDATE, the result always
607 // includes the latest changes committed. This is true even within REPEATABLE-READ
608 // transactions, where S1 normally only sees changes committed before the first S1
609 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
610 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
611 // happened after the first S1 SELECT.
612 // https://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read
613 $flags = Revision
::READ_LOCKING
;
614 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
615 } elseif ( $this->mDataLoadedFrom
== self
::READ_LATEST
) {
616 // Bug T93976: if page_latest was loaded from the master, fetch the
617 // revision from there as well, as it may not exist yet on a replica DB.
618 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
619 $flags = Revision
::READ_LATEST
;
620 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
622 $dbr = wfGetDB( DB_REPLICA
);
623 $revision = Revision
::newKnownCurrent( $dbr, $this->getId(), $latest );
626 if ( $revision ) { // sanity
627 $this->setLastEdit( $revision );
632 * Set the latest revision
633 * @param Revision $revision
635 protected function setLastEdit( Revision
$revision ) {
636 $this->mLastRevision
= $revision;
637 $this->mTimestamp
= $revision->getTimestamp();
641 * Get the latest revision
642 * @return Revision|null
644 public function getRevision() {
645 $this->loadLastEdit();
646 if ( $this->mLastRevision
) {
647 return $this->mLastRevision
;
653 * Get the content of the current revision. No side-effects...
655 * @param int $audience One of:
656 * Revision::FOR_PUBLIC to be displayed to all users
657 * Revision::FOR_THIS_USER to be displayed to $wgUser
658 * Revision::RAW get the text regardless of permissions
659 * @param User $user User object to check for, only if FOR_THIS_USER is passed
660 * to the $audience parameter
661 * @return Content|null The content of the current revision
665 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
666 $this->loadLastEdit();
667 if ( $this->mLastRevision
) {
668 return $this->mLastRevision
->getContent( $audience, $user );
674 * @return string MW timestamp of last article revision
676 public function getTimestamp() {
677 // Check if the field has been filled by WikiPage::setTimestamp()
678 if ( !$this->mTimestamp
) {
679 $this->loadLastEdit();
682 return wfTimestamp( TS_MW
, $this->mTimestamp
);
686 * Set the page timestamp (use only to avoid DB queries)
687 * @param string $ts MW timestamp of last article revision
690 public function setTimestamp( $ts ) {
691 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
695 * @param int $audience One of:
696 * Revision::FOR_PUBLIC to be displayed to all users
697 * Revision::FOR_THIS_USER to be displayed to the given user
698 * Revision::RAW get the text regardless of permissions
699 * @param User $user User object to check for, only if FOR_THIS_USER is passed
700 * to the $audience parameter
701 * @return int User ID for the user that made the last article revision
703 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
704 $this->loadLastEdit();
705 if ( $this->mLastRevision
) {
706 return $this->mLastRevision
->getUser( $audience, $user );
713 * Get the User object of the user who created the page
714 * @param int $audience One of:
715 * Revision::FOR_PUBLIC to be displayed to all users
716 * Revision::FOR_THIS_USER to be displayed to the given user
717 * Revision::RAW get the text regardless of permissions
718 * @param User $user User object to check for, only if FOR_THIS_USER is passed
719 * to the $audience parameter
722 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
723 $revision = $this->getOldestRevision();
725 $userName = $revision->getUserText( $audience, $user );
726 return User
::newFromName( $userName, false );
733 * @param int $audience One of:
734 * Revision::FOR_PUBLIC to be displayed to all users
735 * Revision::FOR_THIS_USER to be displayed to the given user
736 * Revision::RAW get the text regardless of permissions
737 * @param User $user User object to check for, only if FOR_THIS_USER is passed
738 * to the $audience parameter
739 * @return string Username of the user that made the last article revision
741 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
742 $this->loadLastEdit();
743 if ( $this->mLastRevision
) {
744 return $this->mLastRevision
->getUserText( $audience, $user );
751 * @param int $audience One of:
752 * Revision::FOR_PUBLIC to be displayed to all users
753 * Revision::FOR_THIS_USER to be displayed to the given user
754 * Revision::RAW get the text regardless of permissions
755 * @param User $user User object to check for, only if FOR_THIS_USER is passed
756 * to the $audience parameter
757 * @return string Comment stored for the last article revision
759 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
760 $this->loadLastEdit();
761 if ( $this->mLastRevision
) {
762 return $this->mLastRevision
->getComment( $audience, $user );
769 * Returns true if last revision was marked as "minor edit"
771 * @return bool Minor edit indicator for the last article revision.
773 public function getMinorEdit() {
774 $this->loadLastEdit();
775 if ( $this->mLastRevision
) {
776 return $this->mLastRevision
->isMinor();
783 * Determine whether a page would be suitable for being counted as an
784 * article in the site_stats table based on the title & its content
786 * @param PreparedEdit|bool $editInfo (false): object returned by prepareTextForEdit(),
787 * if false, the current database state will be used
790 public function isCountable( $editInfo = false ) {
791 global $wgArticleCountMethod;
793 if ( !$this->mTitle
->isContentPage() ) {
798 $content = $editInfo->pstContent
;
800 $content = $this->getContent();
803 if ( !$content ||
$content->isRedirect() ) {
809 if ( $wgArticleCountMethod === 'link' ) {
810 // nasty special case to avoid re-parsing to detect links
813 // ParserOutput::getLinks() is a 2D array of page links, so
814 // to be really correct we would need to recurse in the array
815 // but the main array should only have items in it if there are
817 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
819 $hasLinks = (bool)wfGetDB( DB_REPLICA
)->selectField( 'pagelinks', 1,
820 [ 'pl_from' => $this->getId() ], __METHOD__
);
824 return $content->isCountable( $hasLinks );
828 * If this page is a redirect, get its target
830 * The target will be fetched from the redirect table if possible.
831 * If this page doesn't have an entry there, call insertRedirect()
832 * @return Title|null Title object, or null if this page is not a redirect
834 public function getRedirectTarget() {
835 if ( !$this->mTitle
->isRedirect() ) {
839 if ( $this->mRedirectTarget
!== null ) {
840 return $this->mRedirectTarget
;
843 // Query the redirect table
844 $dbr = wfGetDB( DB_REPLICA
);
845 $row = $dbr->selectRow( 'redirect',
846 [ 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ],
847 [ 'rd_from' => $this->getId() ],
851 // rd_fragment and rd_interwiki were added later, populate them if empty
852 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
853 $this->mRedirectTarget
= Title
::makeTitle(
854 $row->rd_namespace
, $row->rd_title
,
855 $row->rd_fragment
, $row->rd_interwiki
857 return $this->mRedirectTarget
;
860 // This page doesn't have an entry in the redirect table
861 $this->mRedirectTarget
= $this->insertRedirect();
862 return $this->mRedirectTarget
;
866 * Insert an entry for this page into the redirect table if the content is a redirect
868 * The database update will be deferred via DeferredUpdates
870 * Don't call this function directly unless you know what you're doing.
871 * @return Title|null Title object or null if not a redirect
873 public function insertRedirect() {
874 $content = $this->getContent();
875 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
880 // Update the DB post-send if the page has not cached since now
882 $latest = $this->getLatest();
883 DeferredUpdates
::addCallableUpdate(
884 function () use ( $that, $retval, $latest ) {
885 $that->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 if ( $dbr->implicitGroupby() ) {
987 $realNameField = 'user_real_name';
989 $realNameField = 'MIN(user_real_name) AS user_real_name';
992 $tables = [ 'revision', 'user' ];
995 'user_id' => 'rev_user',
996 'user_name' => 'rev_user_text',
998 'timestamp' => 'MAX(rev_timestamp)',
1001 $conds = [ 'rev_page' => $this->getId() ];
1003 // The user who made the top revision gets credited as "this page was last edited by
1004 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1005 $user = $this->getUser();
1007 $conds[] = "rev_user != $user";
1009 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1013 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1016 'user' => [ 'LEFT JOIN', 'rev_user = user_id' ],
1020 'GROUP BY' => [ 'rev_user', 'rev_user_text' ],
1021 'ORDER BY' => 'timestamp DESC',
1024 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1025 return new UserArrayFromResult( $res );
1029 * Should the parser cache be used?
1031 * @param ParserOptions $parserOptions ParserOptions to check
1035 public function shouldCheckParserCache( ParserOptions
$parserOptions, $oldId ) {
1036 return $parserOptions->getStubThreshold() == 0
1038 && ( $oldId === null ||
$oldId === 0 ||
$oldId === $this->getLatest() )
1039 && $this->getContentHandler()->isParserCacheSupported();
1043 * Get a ParserOutput for the given ParserOptions and revision ID.
1045 * The parser cache will be used if possible. Cache misses that result
1046 * in parser runs are debounced with PoolCounter.
1049 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1050 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1051 * get the current revision (default value)
1052 * @param bool $forceParse Force reindexing, regardless of cache settings
1053 * @return bool|ParserOutput ParserOutput or false if the revision was not found
1055 public function getParserOutput(
1056 ParserOptions
$parserOptions, $oldid = null, $forceParse = false
1059 ( !$forceParse ) && $this->shouldCheckParserCache( $parserOptions, $oldid );
1061 if ( $useParserCache && !$parserOptions->isSafeToCache() ) {
1062 throw new InvalidArgumentException(
1063 'The supplied ParserOptions are not safe to cache. Fix the options or set $forceParse = true.'
1067 wfDebug( __METHOD__
.
1068 ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1069 if ( $parserOptions->getStubThreshold() ) {
1070 wfIncrStats( 'pcache.miss.stub' );
1073 if ( $useParserCache ) {
1074 $parserOutput = ParserCache
::singleton()->get( $this, $parserOptions );
1075 if ( $parserOutput !== false ) {
1076 return $parserOutput;
1080 if ( $oldid === null ||
$oldid === 0 ) {
1081 $oldid = $this->getLatest();
1084 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1087 return $pool->getParserOutput();
1091 * Do standard deferred updates after page view (existing or missing page)
1092 * @param User $user The relevant user
1093 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1095 public function doViewUpdates( User
$user, $oldid = 0 ) {
1096 if ( wfReadOnly() ) {
1100 Hooks
::run( 'PageViewUpdates', [ $this, $user ] );
1101 // Update newtalk / watchlist notification status
1103 $user->clearNotification( $this->mTitle
, $oldid );
1104 } catch ( DBError
$e ) {
1105 // Avoid outage if the master is not reachable
1106 MWExceptionHandler
::logException( $e );
1111 * Perform the actions of a page purging
1113 * @note In 1.28 (and only 1.28), this took a $flags parameter that
1114 * controlled how much purging was done.
1116 public function doPurge() {
1117 // Avoid PHP 7.1 warning of passing $this by reference
1120 if ( !Hooks
::run( 'ArticlePurge', [ &$wikiPage ] ) ) {
1124 $this->mTitle
->invalidateCache();
1127 HTMLFileCache
::clearFileCache( $this->getTitle() );
1128 // Send purge after above page_touched update was committed
1129 DeferredUpdates
::addUpdate(
1130 new CdnCacheUpdate( $this->mTitle
->getCdnUrls() ),
1131 DeferredUpdates
::PRESEND
1134 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1135 $messageCache = MessageCache
::singleton();
1136 $messageCache->updateMessageOverride( $this->mTitle
, $this->getContent() );
1143 * Get the last time a user explicitly purged the page via action=purge
1145 * @return string|bool TS_MW timestamp or false
1147 * @deprecated since 1.29. It will always return false.
1149 public function getLastPurgeTimestamp() {
1150 wfDeprecated( __METHOD__
, '1.29' );
1155 * Insert a new empty page record for this article.
1156 * This *must* be followed up by creating a revision
1157 * and running $this->updateRevisionOn( ... );
1158 * or else the record will be left in a funky state.
1159 * Best if all done inside a transaction.
1161 * @param IDatabase $dbw
1162 * @param int|null $pageId Custom page ID that will be used for the insert statement
1164 * @return bool|int The newly created page_id key; false if the row was not
1165 * inserted, e.g. because the title already existed or because the specified
1166 * page ID is already in use.
1168 public function insertOn( $dbw, $pageId = null ) {
1169 $pageIdForInsert = $pageId ?
[ 'page_id' => $pageId ] : [];
1173 'page_namespace' => $this->mTitle
->getNamespace(),
1174 'page_title' => $this->mTitle
->getDBkey(),
1175 'page_restrictions' => '',
1176 'page_is_redirect' => 0, // Will set this shortly...
1178 'page_random' => wfRandom(),
1179 'page_touched' => $dbw->timestamp(),
1180 'page_latest' => 0, // Fill this in shortly...
1181 'page_len' => 0, // Fill this in shortly...
1182 ] +
$pageIdForInsert,
1187 if ( $dbw->affectedRows() > 0 ) {
1188 $newid = $pageId ?
(int)$pageId : $dbw->insertId();
1189 $this->mId
= $newid;
1190 $this->mTitle
->resetArticleID( $newid );
1194 return false; // nothing changed
1199 * Update the page record to point to a newly saved revision.
1201 * @param IDatabase $dbw
1202 * @param Revision $revision For ID number, and text used to set
1203 * length and redirect status fields
1204 * @param int $lastRevision If given, will not overwrite the page field
1205 * when different from the currently set value.
1206 * Giving 0 indicates the new page flag should be set on.
1207 * @param bool $lastRevIsRedirect If given, will optimize adding and
1208 * removing rows in redirect table.
1209 * @return bool Success; false if the page row was missing or page_latest changed
1211 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1212 $lastRevIsRedirect = null
1214 global $wgContentHandlerUseDB;
1216 // Assertion to try to catch T92046
1217 if ( (int)$revision->getId() === 0 ) {
1218 throw new InvalidArgumentException(
1219 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1223 $content = $revision->getContent();
1224 $len = $content ?
$content->getSize() : 0;
1225 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1227 $conditions = [ 'page_id' => $this->getId() ];
1229 if ( !is_null( $lastRevision ) ) {
1230 // An extra check against threads stepping on each other
1231 $conditions['page_latest'] = $lastRevision;
1235 'page_latest' => $revision->getId(),
1236 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1237 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1238 'page_is_redirect' => $rt !== null ?
1 : 0,
1242 if ( $wgContentHandlerUseDB ) {
1243 $row['page_content_model'] = $revision->getContentModel();
1246 $dbw->update( 'page',
1251 $result = $dbw->affectedRows() > 0;
1253 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1254 $this->setLastEdit( $revision );
1255 $this->mLatest
= $revision->getId();
1256 $this->mIsRedirect
= (bool)$rt;
1257 // Update the LinkCache.
1258 LinkCache
::singleton()->addGoodLinkObj(
1264 $revision->getContentModel()
1272 * Add row to the redirect table if this is a redirect, remove otherwise.
1274 * @param IDatabase $dbw
1275 * @param Title $redirectTitle Title object pointing to the redirect target,
1276 * or NULL if this is not a redirect
1277 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1278 * removing rows in redirect table.
1279 * @return bool True on success, false on failure
1282 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1283 // Always update redirects (target link might have changed)
1284 // Update/Insert if we don't know if the last revision was a redirect or not
1285 // Delete if changing from redirect to non-redirect
1286 $isRedirect = !is_null( $redirectTitle );
1288 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1292 if ( $isRedirect ) {
1293 $this->insertRedirectEntry( $redirectTitle );
1295 // This is not a redirect, remove row from redirect table
1296 $where = [ 'rd_from' => $this->getId() ];
1297 $dbw->delete( 'redirect', $where, __METHOD__
);
1300 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1301 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1304 return ( $dbw->affectedRows() != 0 );
1308 * If the given revision is newer than the currently set page_latest,
1309 * update the page record. Otherwise, do nothing.
1311 * @deprecated since 1.24, use updateRevisionOn instead
1313 * @param IDatabase $dbw
1314 * @param Revision $revision
1317 public function updateIfNewerOn( $dbw, $revision ) {
1318 $row = $dbw->selectRow(
1319 [ 'revision', 'page' ],
1320 [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1322 'page_id' => $this->getId(),
1323 'page_latest=rev_id' ],
1327 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1330 $prev = $row->rev_id
;
1331 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1333 // No or missing previous revision; mark the page as new
1335 $lastRevIsRedirect = null;
1338 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1344 * Get the content that needs to be saved in order to undo all revisions
1345 * between $undo and $undoafter. Revisions must belong to the same page,
1346 * must exist and must not be deleted
1347 * @param Revision $undo
1348 * @param Revision $undoafter Must be an earlier revision than $undo
1349 * @return Content|bool Content on success, false on failure
1351 * Before we had the Content object, this was done in getUndoText
1353 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1354 $handler = $undo->getContentHandler();
1355 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1359 * Returns true if this page's content model supports sections.
1363 * @todo The skin should check this and not offer section functionality if
1364 * sections are not supported.
1365 * @todo The EditPage should check this and not offer section functionality
1366 * if sections are not supported.
1368 public function supportsSections() {
1369 return $this->getContentHandler()->supportsSections();
1373 * @param string|int|null|bool $sectionId Section identifier as a number or string
1374 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1375 * or 'new' for a new section.
1376 * @param Content $sectionContent New content of the section.
1377 * @param string $sectionTitle New section's subject, only if $section is "new".
1378 * @param string $edittime Revision timestamp or null to use the current revision.
1380 * @throws MWException
1381 * @return Content|null New complete article content, or null if error.
1384 * @deprecated since 1.24, use replaceSectionAtRev instead
1386 public function replaceSectionContent(
1387 $sectionId, Content
$sectionContent, $sectionTitle = '', $edittime = null
1390 if ( $edittime && $sectionId !== 'new' ) {
1391 $dbr = wfGetDB( DB_REPLICA
);
1392 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1393 // Try the master if this thread may have just added it.
1394 // This could be abstracted into a Revision method, but we don't want
1395 // to encourage loading of revisions by timestamp.
1397 && wfGetLB()->getServerCount() > 1
1398 && wfGetLB()->hasOrMadeRecentMasterChanges()
1400 $dbw = wfGetDB( DB_MASTER
);
1401 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1404 $baseRevId = $rev->getId();
1408 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1412 * @param string|int|null|bool $sectionId Section identifier as a number or string
1413 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1414 * or 'new' for a new section.
1415 * @param Content $sectionContent New content of the section.
1416 * @param string $sectionTitle New section's subject, only if $section is "new".
1417 * @param int|null $baseRevId
1419 * @throws MWException
1420 * @return Content|null New complete article content, or null if error.
1424 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1425 $sectionTitle = '', $baseRevId = null
1427 if ( strval( $sectionId ) === '' ) {
1428 // Whole-page edit; let the whole text through
1429 $newContent = $sectionContent;
1431 if ( !$this->supportsSections() ) {
1432 throw new MWException( "sections not supported for content model " .
1433 $this->getContentHandler()->getModelID() );
1436 // T32711: always use current version when adding a new section
1437 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1438 $oldContent = $this->getContent();
1440 $rev = Revision
::newFromId( $baseRevId );
1442 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1443 $this->getId() . "; section: $sectionId)\n" );
1447 $oldContent = $rev->getContent();
1450 if ( !$oldContent ) {
1451 wfDebug( __METHOD__
. ": no page text\n" );
1455 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1462 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1464 * @return int Updated $flags
1466 public function checkFlags( $flags ) {
1467 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1468 if ( $this->exists() ) {
1469 $flags |
= EDIT_UPDATE
;
1479 * Change an existing article or create a new article. Updates RC and all necessary caches,
1480 * optionally via the deferred update array.
1482 * @param Content $content New content
1483 * @param string $summary Edit summary
1484 * @param int $flags Bitfield:
1486 * Article is known or assumed to be non-existent, create a new one
1488 * Article is known or assumed to be pre-existing, update it
1490 * Mark this edit minor, if the user is allowed to do so
1492 * Do not log the change in recentchanges
1494 * Mark the edit a "bot" edit regardless of user rights
1496 * Fill in blank summaries with generated text where possible
1498 * Signal that the page retrieve/save cycle happened entirely in this request.
1500 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1501 * article will be detected. If EDIT_UPDATE is specified and the article
1502 * doesn't exist, the function will return an edit-gone-missing error. If
1503 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1504 * error will be returned. These two conditions are also possible with
1505 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1507 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1508 * This is not the parent revision ID, rather the revision ID for older
1509 * content used as the source for a rollback, for example.
1510 * @param User $user The user doing the edit
1511 * @param string $serialFormat Format for storing the content in the
1513 * @param array|null $tags Change tags to apply to this edit
1514 * Callers are responsible for permission checks
1515 * (with ChangeTags::canAddTagsAccompanyingChange)
1516 * @param Int $undidRevId Id of revision that was undone or 0
1518 * @throws MWException
1519 * @return Status Possible errors:
1520 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1521 * set the fatal flag of $status.
1522 * edit-gone-missing: In update mode, but the article didn't exist.
1523 * edit-conflict: In update mode, the article changed unexpectedly.
1524 * edit-no-change: Warning that the text was the same as before.
1525 * edit-already-exists: In creation mode, but the article already exists.
1527 * Extensions may define additional errors.
1529 * $return->value will contain an associative array with members as follows:
1530 * new: Boolean indicating if the function attempted to create a new article.
1531 * revision: The revision object for the inserted revision, or null.
1534 * @throws MWException
1536 public function doEditContent(
1537 Content
$content, $summary, $flags = 0, $baseRevId = false,
1538 User
$user = null, $serialFormat = null, $tags = [], $undidRevId = 0
1540 global $wgUser, $wgUseAutomaticEditSummaries;
1542 // Old default parameter for $tags was null
1543 if ( $tags === null ) {
1547 // Low-level sanity check
1548 if ( $this->mTitle
->getText() === '' ) {
1549 throw new MWException( 'Something is trying to edit an article with an empty title' );
1551 // Make sure the given content type is allowed for this page
1552 if ( !$content->getContentHandler()->canBeUsedOn( $this->mTitle
) ) {
1553 return Status
::newFatal( 'content-not-allowed-here',
1554 ContentHandler
::getLocalizedName( $content->getModel() ),
1555 $this->mTitle
->getPrefixedText()
1559 // Load the data from the master database if needed.
1560 // The caller may already loaded it from the master or even loaded it using
1561 // SELECT FOR UPDATE, so do not override that using clear().
1562 $this->loadPageData( 'fromdbmaster' );
1564 $user = $user ?
: $wgUser;
1565 $flags = $this->checkFlags( $flags );
1567 // Avoid PHP 7.1 warning of passing $this by reference
1570 // Trigger pre-save hook (using provided edit summary)
1571 $hookStatus = Status
::newGood( [] );
1572 $hook_args = [ &$wikiPage, &$user, &$content, &$summary,
1573 $flags & EDIT_MINOR
, null, null, &$flags, &$hookStatus ];
1574 // Check if the hook rejected the attempted save
1575 if ( !Hooks
::run( 'PageContentSave', $hook_args ) ) {
1576 if ( $hookStatus->isOK() ) {
1577 // Hook returned false but didn't call fatal(); use generic message
1578 $hookStatus->fatal( 'edit-hook-aborted' );
1584 $old_revision = $this->getRevision(); // current revision
1585 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1587 if ( $old_content && $old_content->getModel() !== $content->getModel() ) {
1588 $tags[] = 'mw-contentmodelchange';
1591 // Provide autosummaries if one is not provided and autosummaries are enabled
1592 if ( $wgUseAutomaticEditSummaries && ( $flags & EDIT_AUTOSUMMARY
) && $summary == '' ) {
1593 $handler = $content->getContentHandler();
1594 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1597 // Avoid statsd noise and wasted cycles check the edit stash (T136678)
1598 if ( ( $flags & EDIT_INTERNAL
) ||
( $flags & EDIT_FORCE_BOT
) ) {
1604 // Get the pre-save transform content and final parser output
1605 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat, $useCache );
1606 $pstContent = $editInfo->pstContent
; // Content object
1608 'bot' => ( $flags & EDIT_FORCE_BOT
),
1609 'minor' => ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' ),
1610 'serialized' => $pstContent->serialize( $serialFormat ),
1611 'serialFormat' => $serialFormat,
1612 'baseRevId' => $baseRevId,
1613 'oldRevision' => $old_revision,
1614 'oldContent' => $old_content,
1615 'oldId' => $this->getLatest(),
1616 'oldIsRedirect' => $this->isRedirect(),
1617 'oldCountable' => $this->isCountable(),
1618 'tags' => ( $tags !== null ) ?
(array)$tags : [],
1619 'undidRevId' => $undidRevId
1622 // Actually create the revision and create/update the page
1623 if ( $flags & EDIT_UPDATE
) {
1624 $status = $this->doModify( $pstContent, $flags, $user, $summary, $meta );
1626 $status = $this->doCreate( $pstContent, $flags, $user, $summary, $meta );
1629 // Promote user to any groups they meet the criteria for
1630 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
1631 $user->addAutopromoteOnceGroups( 'onEdit' );
1632 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1639 * @param Content $content Pre-save transform content
1642 * @param string $summary
1643 * @param array $meta
1645 * @throws DBUnexpectedError
1647 * @throws FatalError
1648 * @throws MWException
1650 private function doModify(
1651 Content
$content, $flags, User
$user, $summary, array $meta
1653 global $wgUseRCPatrol;
1655 // Update article, but only if changed.
1656 $status = Status
::newGood( [ 'new' => false, 'revision' => null ] );
1658 // Convenience variables
1659 $now = wfTimestampNow();
1660 $oldid = $meta['oldId'];
1661 /** @var $oldContent Content|null */
1662 $oldContent = $meta['oldContent'];
1663 $newsize = $content->getSize();
1666 // Article gone missing
1667 $status->fatal( 'edit-gone-missing' );
1670 } elseif ( !$oldContent ) {
1671 // Sanity check for T39225
1672 throw new MWException( "Could not find text for current revision {$oldid}." );
1675 // @TODO: pass content object?!
1676 $revision = new Revision( [
1677 'page' => $this->getId(),
1678 'title' => $this->mTitle
, // for determining the default content model
1679 'comment' => $summary,
1680 'minor_edit' => $meta['minor'],
1681 'text' => $meta['serialized'],
1683 'parent_id' => $oldid,
1684 'user' => $user->getId(),
1685 'user_text' => $user->getName(),
1686 'timestamp' => $now,
1687 'content_model' => $content->getModel(),
1688 'content_format' => $meta['serialFormat'],
1691 $changed = !$content->equals( $oldContent );
1693 $dbw = wfGetDB( DB_MASTER
);
1696 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1697 $status->merge( $prepStatus );
1698 if ( !$status->isOK() ) {
1702 $dbw->startAtomic( __METHOD__
);
1703 // Get the latest page_latest value while locking it.
1704 // Do a CAS style check to see if it's the same as when this method
1705 // started. If it changed then bail out before touching the DB.
1706 $latestNow = $this->lockAndGetLatest();
1707 if ( $latestNow != $oldid ) {
1708 $dbw->endAtomic( __METHOD__
);
1709 // Page updated or deleted in the mean time
1710 $status->fatal( 'edit-conflict' );
1715 // At this point we are now comitted to returning an OK
1716 // status unless some DB query error or other exception comes up.
1717 // This way callers don't have to call rollback() if $status is bad
1718 // unless they actually try to catch exceptions (which is rare).
1720 // Save the revision text
1721 $revisionId = $revision->insertOn( $dbw );
1722 // Update page_latest and friends to reflect the new revision
1723 if ( !$this->updateRevisionOn( $dbw, $revision, null, $meta['oldIsRedirect'] ) ) {
1724 throw new MWException( "Failed to update page row to use new revision." );
1727 Hooks
::run( 'NewRevisionFromEditComplete',
1728 [ $this, $revision, $meta['baseRevId'], $user ] );
1730 // Update recentchanges
1731 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1732 // Mark as patrolled if the user can do so
1733 $patrolled = $wgUseRCPatrol && !count(
1734 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1735 // Add RC row to the DB
1736 RecentChange
::notifyEdit(
1739 $revision->isMinor(),
1743 $this->getTimestamp(),
1746 $oldContent ?
$oldContent->getSize() : 0,
1754 $user->incEditCount();
1756 $dbw->endAtomic( __METHOD__
);
1757 $this->mTimestamp
= $now;
1759 // T34948: revision ID must be set to page {{REVISIONID}} and
1760 // related variables correctly. Likewise for {{REVISIONUSER}} (T135261).
1761 $revision->setId( $this->getLatest() );
1762 $revision->setUserIdAndName(
1763 $this->getUser( Revision
::RAW
),
1764 $this->getUserText( Revision
::RAW
)
1769 // Return the new revision to the caller
1770 $status->value
['revision'] = $revision;
1772 $status->warning( 'edit-no-change' );
1773 // Update page_touched as updateRevisionOn() was not called.
1774 // Other cache updates are managed in onArticleEdit() via doEditUpdates().
1775 $this->mTitle
->invalidateCache( $now );
1778 // Do secondary updates once the main changes have been committed...
1779 DeferredUpdates
::addUpdate(
1780 new AtomicSectionUpdate(
1784 $revision, &$user, $content, $summary, &$flags,
1785 $changed, $meta, &$status
1787 // Update links tables, site stats, etc.
1788 $this->doEditUpdates(
1792 'changed' => $changed,
1793 'oldcountable' => $meta['oldCountable'],
1794 'oldrevision' => $meta['oldRevision']
1797 // Avoid PHP 7.1 warning of passing $this by reference
1799 // Trigger post-save hook
1800 $params = [ &$wikiPage, &$user, $content, $summary, $flags & EDIT_MINOR
,
1801 null, null, &$flags, $revision, &$status, $meta['baseRevId'],
1802 $meta['undidRevId'] ];
1803 Hooks
::run( 'PageContentSaveComplete', $params );
1806 DeferredUpdates
::PRESEND
1813 * @param Content $content Pre-save transform content
1816 * @param string $summary
1817 * @param array $meta
1819 * @throws DBUnexpectedError
1821 * @throws FatalError
1822 * @throws MWException
1824 private function doCreate(
1825 Content
$content, $flags, User
$user, $summary, array $meta
1827 global $wgUseRCPatrol, $wgUseNPPatrol;
1829 $status = Status
::newGood( [ 'new' => true, 'revision' => null ] );
1831 $now = wfTimestampNow();
1832 $newsize = $content->getSize();
1833 $prepStatus = $content->prepareSave( $this, $flags, $meta['oldId'], $user );
1834 $status->merge( $prepStatus );
1835 if ( !$status->isOK() ) {
1839 $dbw = wfGetDB( DB_MASTER
);
1840 $dbw->startAtomic( __METHOD__
);
1842 // Add the page record unless one already exists for the title
1843 $newid = $this->insertOn( $dbw );
1844 if ( $newid === false ) {
1845 $dbw->endAtomic( __METHOD__
); // nothing inserted
1846 $status->fatal( 'edit-already-exists' );
1848 return $status; // nothing done
1851 // At this point we are now comitted to returning an OK
1852 // status unless some DB query error or other exception comes up.
1853 // This way callers don't have to call rollback() if $status is bad
1854 // unless they actually try to catch exceptions (which is rare).
1856 // @TODO: pass content object?!
1857 $revision = new Revision( [
1859 'title' => $this->mTitle
, // for determining the default content model
1860 'comment' => $summary,
1861 'minor_edit' => $meta['minor'],
1862 'text' => $meta['serialized'],
1864 'user' => $user->getId(),
1865 'user_text' => $user->getName(),
1866 'timestamp' => $now,
1867 'content_model' => $content->getModel(),
1868 'content_format' => $meta['serialFormat'],
1871 // Save the revision text...
1872 $revisionId = $revision->insertOn( $dbw );
1873 // Update the page record with revision data
1874 if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1875 throw new MWException( "Failed to update page row to use new revision." );
1878 Hooks
::run( 'NewRevisionFromEditComplete', [ $this, $revision, false, $user ] );
1880 // Update recentchanges
1881 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1882 // Mark as patrolled if the user can do so
1883 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) &&
1884 !count( $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1885 // Add RC row to the DB
1886 RecentChange
::notifyNew(
1889 $revision->isMinor(),
1901 $user->incEditCount();
1903 $dbw->endAtomic( __METHOD__
);
1904 $this->mTimestamp
= $now;
1906 // Return the new revision to the caller
1907 $status->value
['revision'] = $revision;
1909 // Do secondary updates once the main changes have been committed...
1910 DeferredUpdates
::addUpdate(
1911 new AtomicSectionUpdate(
1915 $revision, &$user, $content, $summary, &$flags, $meta, &$status
1917 // Update links, etc.
1918 $this->doEditUpdates( $revision, $user, [ 'created' => true ] );
1919 // Avoid PHP 7.1 warning of passing $this by reference
1921 // Trigger post-create hook
1922 $params = [ &$wikiPage, &$user, $content, $summary,
1923 $flags & EDIT_MINOR
, null, null, &$flags, $revision ];
1924 Hooks
::run( 'PageContentInsertComplete', $params );
1925 // Trigger post-save hook
1926 $params = array_merge( $params, [ &$status, $meta['baseRevId'] ] );
1927 Hooks
::run( 'PageContentSaveComplete', $params );
1930 DeferredUpdates
::PRESEND
1937 * Get parser options suitable for rendering the primary article wikitext
1939 * @see ContentHandler::makeParserOptions
1941 * @param IContextSource|User|string $context One of the following:
1942 * - IContextSource: Use the User and the Language of the provided
1944 * - User: Use the provided User object and $wgLang for the language,
1945 * so use an IContextSource object if possible.
1946 * - 'canonical': Canonical options (anonymous user with default
1947 * preferences and content language).
1948 * @return ParserOptions
1950 public function makeParserOptions( $context ) {
1951 $options = $this->getContentHandler()->makeParserOptions( $context );
1953 if ( $this->getTitle()->isConversionTable() ) {
1954 // @todo ConversionTable should become a separate content model, so
1955 // we don't need special cases like this one.
1956 $options->disableContentConversion();
1963 * Prepare content which is about to be saved.
1965 * Prior to 1.30, this returned a stdClass object with the same class
1968 * @param Content $content
1969 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
1970 * revision ID is also accepted, but this is deprecated.
1971 * @param User|null $user
1972 * @param string|null $serialFormat
1973 * @param bool $useCache Check shared prepared edit cache
1975 * @return PreparedEdit
1979 public function prepareContentForEdit(
1980 Content
$content, $revision = null, User
$user = null,
1981 $serialFormat = null, $useCache = true
1983 global $wgContLang, $wgUser, $wgAjaxEditStash;
1985 if ( is_object( $revision ) ) {
1986 $revid = $revision->getId();
1989 // This code path is deprecated, and nothing is known to
1990 // use it, so performance here shouldn't be a worry.
1991 if ( $revid !== null ) {
1992 $revision = Revision
::newFromId( $revid, Revision
::READ_LATEST
);
1998 $user = is_null( $user ) ?
$wgUser : $user;
1999 // XXX: check $user->getId() here???
2001 // Use a sane default for $serialFormat, see T59026
2002 if ( $serialFormat === null ) {
2003 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2006 if ( $this->mPreparedEdit
2007 && isset( $this->mPreparedEdit
->newContent
)
2008 && $this->mPreparedEdit
->newContent
->equals( $content )
2009 && $this->mPreparedEdit
->revid
== $revid
2010 && $this->mPreparedEdit
->format
== $serialFormat
2011 // XXX: also check $user here?
2014 return $this->mPreparedEdit
;
2017 // The edit may have already been prepared via api.php?action=stashedit
2018 $cachedEdit = $useCache && $wgAjaxEditStash
2019 ? ApiStashEdit
::checkCache( $this->getTitle(), $content, $user )
2022 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2023 Hooks
::run( 'ArticlePrepareTextForEdit', [ $this, $popts ] );
2025 $edit = new PreparedEdit();
2026 if ( $cachedEdit ) {
2027 $edit->timestamp
= $cachedEdit->timestamp
;
2029 $edit->timestamp
= wfTimestampNow();
2031 // @note: $cachedEdit is safely not used if the rev ID was referenced in the text
2032 $edit->revid
= $revid;
2034 if ( $cachedEdit ) {
2035 $edit->pstContent
= $cachedEdit->pstContent
;
2037 $edit->pstContent
= $content
2038 ?
$content->preSaveTransform( $this->mTitle
, $user, $popts )
2042 $edit->format
= $serialFormat;
2043 $edit->popts
= $this->makeParserOptions( 'canonical' );
2044 if ( $cachedEdit ) {
2045 $edit->output
= $cachedEdit->output
;
2048 // We get here if vary-revision is set. This means that this page references
2049 // itself (such as via self-transclusion). In this case, we need to make sure
2050 // that any such self-references refer to the newly-saved revision, and not
2051 // to the previous one, which could otherwise happen due to replica DB lag.
2052 $oldCallback = $edit->popts
->getCurrentRevisionCallback();
2053 $edit->popts
->setCurrentRevisionCallback(
2054 function ( Title
$title, $parser = false ) use ( $revision, &$oldCallback ) {
2055 if ( $title->equals( $revision->getTitle() ) ) {
2058 return call_user_func( $oldCallback, $title, $parser );
2063 // Try to avoid a second parse if {{REVISIONID}} is used
2064 $dbIndex = ( $this->mDataLoadedFrom
& self
::READ_LATEST
) === self
::READ_LATEST
2065 ? DB_MASTER
// use the best possible guess
2066 : DB_REPLICA
; // T154554
2068 $edit->popts
->setSpeculativeRevIdCallback( function () use ( $dbIndex ) {
2069 return 1 +
(int)wfGetDB( $dbIndex )->selectField(
2077 $edit->output
= $edit->pstContent
2078 ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
)
2082 $edit->newContent
= $content;
2083 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2085 // NOTE: B/C for hooks! don't use these fields!
2086 $edit->newText
= $edit->newContent
2087 ? ContentHandler
::getContentText( $edit->newContent
)
2089 $edit->oldText
= $edit->oldContent
2090 ? ContentHandler
::getContentText( $edit->oldContent
)
2092 $edit->pst
= $edit->pstContent ?
$edit->pstContent
->serialize( $serialFormat ) : '';
2094 if ( $edit->output
) {
2095 $edit->output
->setCacheTime( wfTimestampNow() );
2098 // Process cache the result
2099 $this->mPreparedEdit
= $edit;
2105 * Do standard deferred updates after page edit.
2106 * Update links tables, site stats, search index and message cache.
2107 * Purges pages that include this page if the text was changed here.
2108 * Every 100th edit, prune the recent changes table.
2110 * @param Revision $revision
2111 * @param User $user User object that did the revision
2112 * @param array $options Array of options, following indexes are used:
2113 * - changed: bool, whether the revision changed the content (default true)
2114 * - created: bool, whether the revision created the page (default false)
2115 * - moved: bool, whether the page was moved (default false)
2116 * - restored: bool, whether the page was undeleted (default false)
2117 * - oldrevision: Revision object for the pre-update revision (default null)
2118 * - oldcountable: bool, null, or string 'no-change' (default null):
2119 * - bool: whether the page was counted as an article before that
2120 * revision, only used in changed is true and created is false
2121 * - null: if created is false, don't update the article count; if created
2122 * is true, do update the article count
2123 * - 'no-change': don't update the article count, ever
2125 public function doEditUpdates( Revision
$revision, User
$user, array $options = [] ) {
2126 global $wgRCWatchCategoryMembership;
2132 'restored' => false,
2133 'oldrevision' => null,
2134 'oldcountable' => null
2136 $content = $revision->getContent();
2138 $logger = LoggerFactory
::getInstance( 'SaveParse' );
2140 // See if the parser output before $revision was inserted is still valid
2142 if ( !$this->mPreparedEdit
) {
2143 $logger->debug( __METHOD__
. ": No prepared edit...\n" );
2144 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2145 $logger->info( __METHOD__
. ": Prepared edit has vary-revision...\n" );
2146 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision-id' )
2147 && $this->mPreparedEdit
->output
->getSpeculativeRevIdUsed() !== $revision->getId()
2149 $logger->info( __METHOD__
. ": Prepared edit has vary-revision-id with wrong ID...\n" );
2150 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-user' ) && !$options['changed'] ) {
2151 $logger->info( __METHOD__
. ": Prepared edit has vary-user and is null...\n" );
2153 wfDebug( __METHOD__
. ": Using prepared edit...\n" );
2154 $editInfo = $this->mPreparedEdit
;
2158 // Parse the text again if needed. Be careful not to do pre-save transform twice:
2159 // $text is usually already pre-save transformed once. Avoid using the edit stash
2160 // as any prepared content from there or in doEditContent() was already rejected.
2161 $editInfo = $this->prepareContentForEdit( $content, $revision, $user, null, false );
2164 // Save it to the parser cache.
2165 // Make sure the cache time matches page_touched to avoid double parsing.
2166 ParserCache
::singleton()->save(
2167 $editInfo->output
, $this, $editInfo->popts
,
2168 $revision->getTimestamp(), $editInfo->revid
2171 // Update the links tables and other secondary data
2173 $recursive = $options['changed']; // T52785
2174 $updates = $content->getSecondaryDataUpdates(
2175 $this->getTitle(), null, $recursive, $editInfo->output
2177 foreach ( $updates as $update ) {
2178 if ( $update instanceof LinksUpdate
) {
2179 $update->setRevision( $revision );
2180 $update->setTriggeringUser( $user );
2182 DeferredUpdates
::addUpdate( $update );
2184 if ( $wgRCWatchCategoryMembership
2185 && $this->getContentHandler()->supportsCategories() === true
2186 && ( $options['changed'] ||
$options['created'] )
2187 && !$options['restored']
2189 // Note: jobs are pushed after deferred updates, so the job should be able to see
2190 // the recent change entry (also done via deferred updates) and carry over any
2191 // bot/deletion/IP flags, ect.
2192 JobQueueGroup
::singleton()->lazyPush( new CategoryMembershipChangeJob(
2195 'pageId' => $this->getId(),
2196 'revTimestamp' => $revision->getTimestamp()
2202 // Avoid PHP 7.1 warning of passing $this by reference
2205 Hooks
::run( 'ArticleEditUpdates', [ &$wikiPage, &$editInfo, $options['changed'] ] );
2207 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', [ &$wikiPage ] ) ) {
2208 // Flush old entries from the `recentchanges` table
2209 if ( mt_rand( 0, 9 ) == 0 ) {
2210 JobQueueGroup
::singleton()->lazyPush( RecentChangesUpdateJob
::newPurgeJob() );
2214 if ( !$this->exists() ) {
2218 $id = $this->getId();
2219 $title = $this->mTitle
->getPrefixedDBkey();
2220 $shortTitle = $this->mTitle
->getDBkey();
2222 if ( $options['oldcountable'] === 'no-change' ||
2223 ( !$options['changed'] && !$options['moved'] )
2226 } elseif ( $options['created'] ) {
2227 $good = (int)$this->isCountable( $editInfo );
2228 } elseif ( $options['oldcountable'] !== null ) {
2229 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2233 $edits = $options['changed'] ?
1 : 0;
2234 $total = $options['created'] ?
1 : 0;
2236 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2237 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2239 // If this is another user's talk page, update newtalk.
2240 // Don't do this if $options['changed'] = false (null-edits) nor if
2241 // it's a minor edit and the user doesn't want notifications for those.
2242 if ( $options['changed']
2243 && $this->mTitle
->getNamespace() == NS_USER_TALK
2244 && $shortTitle != $user->getTitleKey()
2245 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2247 $recipient = User
::newFromName( $shortTitle, false );
2248 if ( !$recipient ) {
2249 wfDebug( __METHOD__
. ": invalid username\n" );
2251 // Avoid PHP 7.1 warning of passing $this by reference
2254 // Allow extensions to prevent user notification
2255 // when a new message is added to their talk page
2256 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', [ &$wikiPage, $recipient ] ) ) {
2257 if ( User
::isIP( $shortTitle ) ) {
2258 // An anonymous user
2259 $recipient->setNewtalk( true, $revision );
2260 } elseif ( $recipient->isLoggedIn() ) {
2261 $recipient->setNewtalk( true, $revision );
2263 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2269 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2270 MessageCache
::singleton()->updateMessageOverride( $this->mTitle
, $content );
2273 if ( $options['created'] ) {
2274 self
::onArticleCreate( $this->mTitle
);
2275 } elseif ( $options['changed'] ) { // T52785
2276 self
::onArticleEdit( $this->mTitle
, $revision );
2279 ResourceLoaderWikiModule
::invalidateModuleCache(
2280 $this->mTitle
, $options['oldrevision'], $revision, wfWikiID()
2285 * Update the article's restriction field, and leave a log entry.
2286 * This works for protection both existing and non-existing pages.
2288 * @param array $limit Set of restriction keys
2289 * @param array $expiry Per restriction type expiration
2290 * @param int &$cascade Set to false if cascading protection isn't allowed.
2291 * @param string $reason
2292 * @param User $user The user updating the restrictions
2293 * @param string|string[] $tags Change tags to add to the pages and protection log entries
2294 * ($user should be able to add the specified tags before this is called)
2295 * @return Status Status object; if action is taken, $status->value is the log_id of the
2296 * protection log entry.
2298 public function doUpdateRestrictions( array $limit, array $expiry,
2299 &$cascade, $reason, User
$user, $tags = null
2301 global $wgCascadingRestrictionLevels, $wgContLang;
2303 if ( wfReadOnly() ) {
2304 return Status
::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
2307 $this->loadPageData( 'fromdbmaster' );
2308 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2309 $id = $this->getId();
2315 // Take this opportunity to purge out expired restrictions
2316 Title
::purgeExpiredRestrictions();
2318 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2319 // we expect a single selection, but the schema allows otherwise.
2320 $isProtected = false;
2324 $dbw = wfGetDB( DB_MASTER
);
2326 foreach ( $restrictionTypes as $action ) {
2327 if ( !isset( $expiry[$action] ) ||
$expiry[$action] === $dbw->getInfinity() ) {
2328 $expiry[$action] = 'infinity';
2330 if ( !isset( $limit[$action] ) ) {
2331 $limit[$action] = '';
2332 } elseif ( $limit[$action] != '' ) {
2336 // Get current restrictions on $action
2337 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2338 if ( $current != '' ) {
2339 $isProtected = true;
2342 if ( $limit[$action] != $current ) {
2344 } elseif ( $limit[$action] != '' ) {
2345 // Only check expiry change if the action is actually being
2346 // protected, since expiry does nothing on an not-protected
2348 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2354 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2358 // If nothing has changed, do nothing
2360 return Status
::newGood();
2363 if ( !$protect ) { // No protection at all means unprotection
2364 $revCommentMsg = 'unprotectedarticle-comment';
2365 $logAction = 'unprotect';
2366 } elseif ( $isProtected ) {
2367 $revCommentMsg = 'modifiedarticleprotection-comment';
2368 $logAction = 'modify';
2370 $revCommentMsg = 'protectedarticle-comment';
2371 $logAction = 'protect';
2374 // Truncate for whole multibyte characters
2375 $reason = $wgContLang->truncate( $reason, 255 );
2377 $logRelationsValues = [];
2378 $logRelationsField = null;
2379 $logParamsDetails = [];
2381 // Null revision (used for change tag insertion)
2382 $nullRevision = null;
2384 if ( $id ) { // Protection of existing page
2385 // Avoid PHP 7.1 warning of passing $this by reference
2388 if ( !Hooks
::run( 'ArticleProtect', [ &$wikiPage, &$user, $limit, $reason ] ) ) {
2389 return Status
::newGood();
2392 // Only certain restrictions can cascade...
2393 $editrestriction = isset( $limit['edit'] )
2394 ?
[ $limit['edit'] ]
2395 : $this->mTitle
->getRestrictions( 'edit' );
2396 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2397 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2399 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2400 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2403 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2404 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2405 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2407 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2408 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2411 // The schema allows multiple restrictions
2412 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2416 // insert null revision to identify the page protection change as edit summary
2417 $latest = $this->getLatest();
2418 $nullRevision = $this->insertProtectNullRevision(
2427 if ( $nullRevision === null ) {
2428 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2431 $logRelationsField = 'pr_id';
2433 // Update restrictions table
2434 foreach ( $limit as $action => $restrictions ) {
2436 'page_restrictions',
2439 'pr_type' => $action
2443 if ( $restrictions != '' ) {
2444 $cascadeValue = ( $cascade && $action == 'edit' ) ?
1 : 0;
2446 'page_restrictions',
2449 'pr_type' => $action,
2450 'pr_level' => $restrictions,
2451 'pr_cascade' => $cascadeValue,
2452 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2456 $logRelationsValues[] = $dbw->insertId();
2457 $logParamsDetails[] = [
2459 'level' => $restrictions,
2460 'expiry' => $expiry[$action],
2461 'cascade' => (bool)$cascadeValue,
2466 // Clear out legacy restriction fields
2469 [ 'page_restrictions' => '' ],
2470 [ 'page_id' => $id ],
2474 // Avoid PHP 7.1 warning of passing $this by reference
2477 Hooks
::run( 'NewRevisionFromEditComplete',
2478 [ $this, $nullRevision, $latest, $user ] );
2479 Hooks
::run( 'ArticleProtectComplete', [ &$wikiPage, &$user, $limit, $reason ] );
2480 } else { // Protection of non-existing page (also known as "title protection")
2481 // Cascade protection is meaningless in this case
2484 if ( $limit['create'] != '' ) {
2485 $commentFields = CommentStore
::newKey( 'pt_reason' )->insert( $dbw, $reason );
2486 $dbw->replace( 'protected_titles',
2487 [ [ 'pt_namespace', 'pt_title' ] ],
2489 'pt_namespace' => $this->mTitle
->getNamespace(),
2490 'pt_title' => $this->mTitle
->getDBkey(),
2491 'pt_create_perm' => $limit['create'],
2492 'pt_timestamp' => $dbw->timestamp(),
2493 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2494 'pt_user' => $user->getId(),
2495 ] +
$commentFields, __METHOD__
2497 $logParamsDetails[] = [
2499 'level' => $limit['create'],
2500 'expiry' => $expiry['create'],
2503 $dbw->delete( 'protected_titles',
2505 'pt_namespace' => $this->mTitle
->getNamespace(),
2506 'pt_title' => $this->mTitle
->getDBkey()
2512 $this->mTitle
->flushRestrictions();
2513 InfoAction
::invalidateCache( $this->mTitle
);
2515 if ( $logAction == 'unprotect' ) {
2518 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2520 '4::description' => $protectDescriptionLog, // parameter for IRC
2521 '5:bool:cascade' => $cascade,
2522 'details' => $logParamsDetails, // parameter for localize and api
2526 // Update the protection log
2527 $logEntry = new ManualLogEntry( 'protect', $logAction );
2528 $logEntry->setTarget( $this->mTitle
);
2529 $logEntry->setComment( $reason );
2530 $logEntry->setPerformer( $user );
2531 $logEntry->setParameters( $params );
2532 if ( !is_null( $nullRevision ) ) {
2533 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2535 $logEntry->setTags( $tags );
2536 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2537 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2539 $logId = $logEntry->insert();
2540 $logEntry->publish( $logId );
2542 return Status
::newGood( $logId );
2546 * Insert a new null revision for this page.
2548 * @param string $revCommentMsg Comment message key for the revision
2549 * @param array $limit Set of restriction keys
2550 * @param array $expiry Per restriction type expiration
2551 * @param int $cascade Set to false if cascading protection isn't allowed.
2552 * @param string $reason
2553 * @param User|null $user
2554 * @return Revision|null Null on error
2556 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2557 array $expiry, $cascade, $reason, $user = null
2559 $dbw = wfGetDB( DB_MASTER
);
2561 // Prepare a null revision to be added to the history
2562 $editComment = wfMessage(
2564 $this->mTitle
->getPrefixedText(),
2565 $user ?
$user->getName() : ''
2566 )->inContentLanguage()->text();
2568 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2570 $protectDescription = $this->protectDescription( $limit, $expiry );
2571 if ( $protectDescription ) {
2572 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2573 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2574 ->inContentLanguage()->text();
2577 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2578 $editComment .= wfMessage( 'brackets' )->params(
2579 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2580 )->inContentLanguage()->text();
2583 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2585 $nullRev->insertOn( $dbw );
2587 // Update page record and touch page
2588 $oldLatest = $nullRev->getParentId();
2589 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2596 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2599 protected function formatExpiry( $expiry ) {
2602 if ( $expiry != 'infinity' ) {
2605 $wgContLang->timeanddate( $expiry, false, false ),
2606 $wgContLang->date( $expiry, false, false ),
2607 $wgContLang->time( $expiry, false, false )
2608 )->inContentLanguage()->text();
2610 return wfMessage( 'protect-expiry-indefinite' )
2611 ->inContentLanguage()->text();
2616 * Builds the description to serve as comment for the edit.
2618 * @param array $limit Set of restriction keys
2619 * @param array $expiry Per restriction type expiration
2622 public function protectDescription( array $limit, array $expiry ) {
2623 $protectDescription = '';
2625 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2626 # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2627 # All possible message keys are listed here for easier grepping:
2628 # * restriction-create
2629 # * restriction-edit
2630 # * restriction-move
2631 # * restriction-upload
2632 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2633 # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2634 # with '' filtered out. All possible message keys are listed below:
2635 # * protect-level-autoconfirmed
2636 # * protect-level-sysop
2637 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2638 ->inContentLanguage()->text();
2640 $expiryText = $this->formatExpiry( $expiry[$action] );
2642 if ( $protectDescription !== '' ) {
2643 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2645 $protectDescription .= wfMessage( 'protect-summary-desc' )
2646 ->params( $actionText, $restrictionsText, $expiryText )
2647 ->inContentLanguage()->text();
2650 return $protectDescription;
2654 * Builds the description to serve as comment for the log entry.
2656 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2657 * protect description text. Keep them in old format to avoid breaking compatibility.
2658 * TODO: Fix protection log to store structured description and format it on-the-fly.
2660 * @param array $limit Set of restriction keys
2661 * @param array $expiry Per restriction type expiration
2664 public function protectDescriptionLog( array $limit, array $expiry ) {
2667 $protectDescriptionLog = '';
2669 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2670 $expiryText = $this->formatExpiry( $expiry[$action] );
2671 $protectDescriptionLog .= $wgContLang->getDirMark() .
2672 "[$action=$restrictions] ($expiryText)";
2675 return trim( $protectDescriptionLog );
2679 * Take an array of page restrictions and flatten it to a string
2680 * suitable for insertion into the page_restrictions field.
2682 * @param string[] $limit
2684 * @throws MWException
2687 protected static function flattenRestrictions( $limit ) {
2688 if ( !is_array( $limit ) ) {
2689 throw new MWException( __METHOD__
. ' given non-array restriction set' );
2695 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2696 $bits[] = "$action=$restrictions";
2699 return implode( ':', $bits );
2703 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2704 * backwards compatibility, if you care about error reporting you should use
2705 * doDeleteArticleReal() instead.
2707 * Deletes the article with database consistency, writes logs, purges caches
2709 * @param string $reason Delete reason for deletion log
2710 * @param bool $suppress Suppress all revisions and log the deletion in
2711 * the suppression log instead of the deletion log
2712 * @param int $u1 Unused
2713 * @param bool $u2 Unused
2714 * @param array|string &$error Array of errors to append to
2715 * @param User $user The deleting user
2716 * @return bool True if successful
2718 public function doDeleteArticle(
2719 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null
2721 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2722 return $status->isGood();
2726 * Back-end article deletion
2727 * Deletes the article with database consistency, writes logs, purges caches
2731 * @param string $reason Delete reason for deletion log
2732 * @param bool $suppress Suppress all revisions and log the deletion in
2733 * the suppression log instead of the deletion log
2734 * @param int $u1 Unused
2735 * @param bool $u2 Unused
2736 * @param array|string &$error Array of errors to append to
2737 * @param User $user The deleting user
2738 * @param array $tags Tags to apply to the deletion action
2739 * @return Status Status object; if successful, $status->value is the log_id of the
2740 * deletion log entry. If the page couldn't be deleted because it wasn't
2741 * found, $status is a non-fatal 'cannotdelete' error
2743 public function doDeleteArticleReal(
2744 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null,
2745 $tags = [], $logsubtype = 'delete'
2747 global $wgUser, $wgContentHandlerUseDB, $wgCommentTableSchemaMigrationStage;
2749 wfDebug( __METHOD__
. "\n" );
2751 $status = Status
::newGood();
2753 if ( $this->mTitle
->getDBkey() === '' ) {
2754 $status->error( 'cannotdelete',
2755 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2759 // Avoid PHP 7.1 warning of passing $this by reference
2762 $user = is_null( $user ) ?
$wgUser : $user;
2763 if ( !Hooks
::run( 'ArticleDelete',
2764 [ &$wikiPage, &$user, &$reason, &$error, &$status, $suppress ]
2766 if ( $status->isOK() ) {
2767 // Hook aborted but didn't set a fatal status
2768 $status->fatal( 'delete-hook-aborted' );
2773 $dbw = wfGetDB( DB_MASTER
);
2774 $dbw->startAtomic( __METHOD__
);
2776 $this->loadPageData( self
::READ_LATEST
);
2777 $id = $this->getId();
2778 // T98706: lock the page from various other updates but avoid using
2779 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2780 // the revisions queries (which also JOIN on user). Only lock the page
2781 // row and CAS check on page_latest to see if the trx snapshot matches.
2782 $lockedLatest = $this->lockAndGetLatest();
2783 if ( $id == 0 ||
$this->getLatest() != $lockedLatest ) {
2784 $dbw->endAtomic( __METHOD__
);
2785 // Page not there or trx snapshot is stale
2786 $status->error( 'cannotdelete',
2787 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2791 // Given the lock above, we can be confident in the title and page ID values
2792 $namespace = $this->getTitle()->getNamespace();
2793 $dbKey = $this->getTitle()->getDBkey();
2795 // At this point we are now comitted to returning an OK
2796 // status unless some DB query error or other exception comes up.
2797 // This way callers don't have to call rollback() if $status is bad
2798 // unless they actually try to catch exceptions (which is rare).
2800 // we need to remember the old content so we can use it to generate all deletion updates.
2801 $revision = $this->getRevision();
2803 $content = $this->getContent( Revision
::RAW
);
2804 } catch ( Exception
$ex ) {
2805 wfLogWarning( __METHOD__
. ': failed to load content during deletion! '
2806 . $ex->getMessage() );
2811 $revCommentStore = new CommentStore( 'rev_comment' );
2812 $arCommentStore = new CommentStore( 'ar_comment' );
2814 $fields = Revision
::selectFields();
2817 // Bitfields to further suppress the content
2819 $bitfield = Revision
::SUPPRESSED_ALL
;
2820 $fields = array_diff( $fields, [ 'rev_deleted' ] );
2823 // For now, shunt the revision data into the archive table.
2824 // Text is *not* removed from the text table; bulk storage
2825 // is left intact to avoid breaking block-compression or
2826 // immutable storage schemes.
2827 // In the future, we may keep revisions and mark them with
2828 // the rev_deleted field, which is reserved for this purpose.
2830 // Get all of the page revisions
2831 $commentQuery = $revCommentStore->getJoin();
2832 $res = $dbw->select(
2833 [ 'revision' ] +
$commentQuery['tables'],
2834 $fields +
$commentQuery['fields'],
2835 [ 'rev_page' => $id ],
2838 $commentQuery['joins']
2840 // Build their equivalent archive rows
2843 foreach ( $res as $row ) {
2844 $comment = $revCommentStore->getComment( $row );
2846 'ar_namespace' => $namespace,
2847 'ar_title' => $dbKey,
2848 'ar_user' => $row->rev_user
,
2849 'ar_user_text' => $row->rev_user_text
,
2850 'ar_timestamp' => $row->rev_timestamp
,
2851 'ar_minor_edit' => $row->rev_minor_edit
,
2852 'ar_rev_id' => $row->rev_id
,
2853 'ar_parent_id' => $row->rev_parent_id
,
2854 'ar_text_id' => $row->rev_text_id
,
2857 'ar_len' => $row->rev_len
,
2858 'ar_page_id' => $id,
2859 'ar_deleted' => $suppress ?
$bitfield : $row->rev_deleted
,
2860 'ar_sha1' => $row->rev_sha1
,
2861 ] +
$arCommentStore->insert( $dbw, $comment );
2862 if ( $wgContentHandlerUseDB ) {
2863 $rowInsert['ar_content_model'] = $row->rev_content_model
;
2864 $rowInsert['ar_content_format'] = $row->rev_content_format
;
2866 $rowsInsert[] = $rowInsert;
2867 $revids[] = $row->rev_id
;
2869 // Copy them into the archive table
2870 $dbw->insert( 'archive', $rowsInsert, __METHOD__
);
2871 // Save this so we can pass it to the ArticleDeleteComplete hook.
2872 $archivedRevisionCount = $dbw->affectedRows();
2874 // Clone the title and wikiPage, so we have the information we need when
2875 // we log and run the ArticleDeleteComplete hook.
2876 $logTitle = clone $this->mTitle
;
2877 $wikiPageBeforeDelete = clone $this;
2879 // Now that it's safely backed up, delete it
2880 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__
);
2881 $dbw->delete( 'revision', [ 'rev_page' => $id ], __METHOD__
);
2882 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
2883 $dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__
);
2886 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2887 $logtype = $suppress ?
'suppress' : 'delete';
2889 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2890 $logEntry->setPerformer( $user );
2891 $logEntry->setTarget( $logTitle );
2892 $logEntry->setComment( $reason );
2893 $logEntry->setTags( $tags );
2894 $logid = $logEntry->insert();
2896 $dbw->onTransactionPreCommitOrIdle(
2897 function () use ( $dbw, $logEntry, $logid ) {
2898 // T58776: avoid deadlocks (especially from FileDeleteForm)
2899 $logEntry->publish( $logid );
2904 $dbw->endAtomic( __METHOD__
);
2906 $this->doDeleteUpdates( $id, $content, $revision );
2908 Hooks
::run( 'ArticleDeleteComplete', [
2909 &$wikiPageBeforeDelete,
2915 $archivedRevisionCount
2917 $status->value
= $logid;
2919 // Show log excerpt on 404 pages rather than just a link
2920 $cache = MediaWikiServices
::getInstance()->getMainObjectStash();
2921 $key = $cache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2922 $cache->set( $key, 1, $cache::TTL_DAY
);
2928 * Lock the page row for this title+id and return page_latest (or 0)
2930 * @return int Returns 0 if no row was found with this title+id
2933 public function lockAndGetLatest() {
2934 return (int)wfGetDB( DB_MASTER
)->selectField(
2938 'page_id' => $this->getId(),
2939 // Typically page_id is enough, but some code might try to do
2940 // updates assuming the title is the same, so verify that
2941 'page_namespace' => $this->getTitle()->getNamespace(),
2942 'page_title' => $this->getTitle()->getDBkey()
2950 * Do some database updates after deletion
2952 * @param int $id The page_id value of the page being deleted
2953 * @param Content|null $content Optional page content to be used when determining
2954 * the required updates. This may be needed because $this->getContent()
2955 * may already return null when the page proper was deleted.
2956 * @param Revision|null $revision The latest page revision
2958 public function doDeleteUpdates( $id, Content
$content = null, Revision
$revision = null ) {
2960 $countable = $this->isCountable();
2961 } catch ( Exception
$ex ) {
2962 // fallback for deleting broken pages for which we cannot load the content for
2963 // some reason. Note that doDeleteArticleReal() already logged this problem.
2967 // Update site status
2968 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$countable, -1 ) );
2970 // Delete pagelinks, update secondary indexes, etc
2971 $updates = $this->getDeletionUpdates( $content );
2972 foreach ( $updates as $update ) {
2973 DeferredUpdates
::addUpdate( $update );
2976 // Reparse any pages transcluding this page
2977 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'templatelinks' );
2979 // Reparse any pages including this image
2980 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
2981 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'imagelinks' );
2985 self
::onArticleDelete( $this->mTitle
);
2986 ResourceLoaderWikiModule
::invalidateModuleCache(
2987 $this->mTitle
, $revision, null, wfWikiID()
2990 // Reset this object and the Title object
2991 $this->loadFromRow( false, self
::READ_LATEST
);
2994 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
2998 * Roll back the most recent consecutive set of edits to a page
2999 * from the same user; fails if there are no eligible edits to
3000 * roll back to, e.g. user is the sole contributor. This function
3001 * performs permissions checks on $user, then calls commitRollback()
3002 * to do the dirty work
3004 * @todo Separate the business/permission stuff out from backend code
3005 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3007 * @param string $fromP Name of the user whose edits to rollback.
3008 * @param string $summary Custom summary. Set to default summary if empty.
3009 * @param string $token Rollback token.
3010 * @param bool $bot If true, mark all reverted edits as bot.
3012 * @param array &$resultDetails Array contains result-specific array of additional values
3013 * 'alreadyrolled' : 'current' (rev)
3014 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3016 * @param User $user The user performing the rollback
3017 * @param array|null $tags Change tags to apply to the rollback
3018 * Callers are responsible for permission checks
3019 * (with ChangeTags::canAddTagsAccompanyingChange)
3021 * @return array Array of errors, each error formatted as
3022 * array(messagekey, param1, param2, ...).
3023 * On success, the array is empty. This array can also be passed to
3024 * OutputPage::showPermissionsErrorPage().
3026 public function doRollback(
3027 $fromP, $summary, $token, $bot, &$resultDetails, User
$user, $tags = null
3029 $resultDetails = null;
3031 // Check permissions
3032 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
3033 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
3034 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3036 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3037 $errors[] = [ 'sessionfailure' ];
3040 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
3041 $errors[] = [ 'actionthrottledtext' ];
3044 // If there were errors, bail out now
3045 if ( !empty( $errors ) ) {
3049 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3053 * Backend implementation of doRollback(), please refer there for parameter
3054 * and return value documentation
3056 * NOTE: This function does NOT check ANY permissions, it just commits the
3057 * rollback to the DB. Therefore, you should only call this function direct-
3058 * ly if you want to use custom permissions checks. If you don't, use
3059 * doRollback() instead.
3060 * @param string $fromP Name of the user whose edits to rollback.
3061 * @param string $summary Custom summary. Set to default summary if empty.
3062 * @param bool $bot If true, mark all reverted edits as bot.
3064 * @param array &$resultDetails Contains result-specific array of additional values
3065 * @param User $guser The user performing the rollback
3066 * @param array|null $tags Change tags to apply to the rollback
3067 * Callers are responsible for permission checks
3068 * (with ChangeTags::canAddTagsAccompanyingChange)
3072 public function commitRollback( $fromP, $summary, $bot,
3073 &$resultDetails, User
$guser, $tags = null
3075 global $wgUseRCPatrol, $wgContLang;
3077 $dbw = wfGetDB( DB_MASTER
);
3079 if ( wfReadOnly() ) {
3080 return [ [ 'readonlytext' ] ];
3083 // Get the last editor
3084 $current = $this->getRevision();
3085 if ( is_null( $current ) ) {
3086 // Something wrong... no page?
3087 return [ [ 'notanarticle' ] ];
3090 $from = str_replace( '_', ' ', $fromP );
3091 // User name given should match up with the top revision.
3092 // If the user was deleted then $from should be empty.
3093 if ( $from != $current->getUserText() ) {
3094 $resultDetails = [ 'current' => $current ];
3095 return [ [ 'alreadyrolled',
3096 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3097 htmlspecialchars( $fromP ),
3098 htmlspecialchars( $current->getUserText() )
3102 // Get the last edit not by this person...
3103 // Note: these may not be public values
3104 $user = intval( $current->getUser( Revision
::RAW
) );
3105 $user_text = $dbw->addQuotes( $current->getUserText( Revision
::RAW
) );
3106 $s = $dbw->selectRow( 'revision',
3107 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3108 [ 'rev_page' => $current->getPage(),
3109 "rev_user != {$user} OR rev_user_text != {$user_text}"
3111 [ 'USE INDEX' => 'page_timestamp',
3112 'ORDER BY' => 'rev_timestamp DESC' ]
3114 if ( $s === false ) {
3115 // No one else ever edited this page
3116 return [ [ 'cantrollback' ] ];
3117 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT
3118 ||
$s->rev_deleted
& Revision
::DELETED_USER
3120 // Only admins can see this text
3121 return [ [ 'notvisiblerev' ] ];
3124 // Generate the edit summary if necessary
3125 $target = Revision
::newFromId( $s->rev_id
, Revision
::READ_LATEST
);
3126 if ( empty( $summary ) ) {
3127 if ( $from == '' ) { // no public user name
3128 $summary = wfMessage( 'revertpage-nouser' );
3130 $summary = wfMessage( 'revertpage' );
3134 // Allow the custom summary to use the same args as the default message
3136 $target->getUserText(), $from, $s->rev_id
,
3137 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3138 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3140 if ( $summary instanceof Message
) {
3141 $summary = $summary->params( $args )->inContentLanguage()->text();
3143 $summary = wfMsgReplaceArgs( $summary, $args );
3146 // Trim spaces on user supplied text
3147 $summary = trim( $summary );
3149 // Truncate for whole multibyte characters.
3150 $summary = $wgContLang->truncate( $summary, 255 );
3153 $flags = EDIT_UPDATE | EDIT_INTERNAL
;
3155 if ( $guser->isAllowed( 'minoredit' ) ) {
3156 $flags |
= EDIT_MINOR
;
3159 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3160 $flags |
= EDIT_FORCE_BOT
;
3163 $targetContent = $target->getContent();
3164 $changingContentModel = $targetContent->getModel() !== $current->getContentModel();
3166 // Actually store the edit
3167 $status = $this->doEditContent(
3177 // Set patrolling and bot flag on the edits, which gets rollbacked.
3178 // This is done even on edit failure to have patrolling in that case (T64157).
3180 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3181 // Mark all reverted edits as bot
3185 if ( $wgUseRCPatrol ) {
3186 // Mark all reverted edits as patrolled
3187 $set['rc_patrolled'] = 1;
3190 if ( count( $set ) ) {
3191 $dbw->update( 'recentchanges', $set,
3193 'rc_cur_id' => $current->getPage(),
3194 'rc_user_text' => $current->getUserText(),
3195 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3201 if ( !$status->isOK() ) {
3202 return $status->getErrorsArray();
3205 // raise error, when the edit is an edit without a new version
3206 $statusRev = isset( $status->value
['revision'] )
3207 ?
$status->value
['revision']
3209 if ( !( $statusRev instanceof Revision
) ) {
3210 $resultDetails = [ 'current' => $current ];
3211 return [ [ 'alreadyrolled',
3212 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3213 htmlspecialchars( $fromP ),
3214 htmlspecialchars( $current->getUserText() )
3218 if ( $changingContentModel ) {
3219 // If the content model changed during the rollback,
3220 // make sure it gets logged to Special:Log/contentmodel
3221 $log = new ManualLogEntry( 'contentmodel', 'change' );
3222 $log->setPerformer( $guser );
3223 $log->setTarget( $this->mTitle
);
3224 $log->setComment( $summary );
3225 $log->setParameters( [
3226 '4::oldmodel' => $current->getContentModel(),
3227 '5::newmodel' => $targetContent->getModel(),
3230 $logId = $log->insert( $dbw );
3231 $log->publish( $logId );
3234 $revId = $statusRev->getId();
3236 Hooks
::run( 'ArticleRollbackComplete', [ $this, $guser, $target, $current ] );
3239 'summary' => $summary,
3240 'current' => $current,
3241 'target' => $target,
3249 * The onArticle*() functions are supposed to be a kind of hooks
3250 * which should be called whenever any of the specified actions
3253 * This is a good place to put code to clear caches, for instance.
3255 * This is called on page move and undelete, as well as edit
3257 * @param Title $title
3259 public static function onArticleCreate( Title
$title ) {
3260 // Update existence markers on article/talk tabs...
3261 $other = $title->getOtherPage();
3263 $other->purgeSquid();
3265 $title->touchLinks();
3266 $title->purgeSquid();
3267 $title->deleteTitleProtection();
3269 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3271 // Invalidate caches of articles which include this page
3272 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3274 if ( $title->getNamespace() == NS_CATEGORY
) {
3275 // Load the Category object, which will schedule a job to create
3276 // the category table row if necessary. Checking a replica DB is ok
3277 // here, in the worst case it'll run an unnecessary recount job on
3278 // a category that probably doesn't have many members.
3279 Category
::newFromTitle( $title )->getID();
3284 * Clears caches when article is deleted
3286 * @param Title $title
3288 public static function onArticleDelete( Title
$title ) {
3289 // Update existence markers on article/talk tabs...
3290 $other = $title->getOtherPage();
3292 $other->purgeSquid();
3294 $title->touchLinks();
3295 $title->purgeSquid();
3297 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3300 HTMLFileCache
::clearFileCache( $title );
3301 InfoAction
::invalidateCache( $title );
3304 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3305 MessageCache
::singleton()->updateMessageOverride( $title, null );
3309 if ( $title->getNamespace() == NS_FILE
) {
3310 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'imagelinks' ) );
3314 if ( $title->getNamespace() == NS_USER_TALK
) {
3315 $user = User
::newFromName( $title->getText(), false );
3317 $user->setNewtalk( false );
3322 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3326 * Purge caches on page update etc
3328 * @param Title $title
3329 * @param Revision|null $revision Revision that was just saved, may be null
3331 public static function onArticleEdit( Title
$title, Revision
$revision = null ) {
3332 // Invalidate caches of articles which include this page
3333 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3335 // Invalidate the caches of all pages which redirect here
3336 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'redirect' ) );
3338 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3340 // Purge CDN for this page only
3341 $title->purgeSquid();
3342 // Clear file cache for this page only
3343 HTMLFileCache
::clearFileCache( $title );
3345 $revid = $revision ?
$revision->getId() : null;
3346 DeferredUpdates
::addCallableUpdate( function () use ( $title, $revid ) {
3347 InfoAction
::invalidateCache( $title, $revid );
3354 * Returns a list of categories this page is a member of.
3355 * Results will include hidden categories
3357 * @return TitleArray
3359 public function getCategories() {
3360 $id = $this->getId();
3362 return TitleArray
::newFromResult( new FakeResultWrapper( [] ) );
3365 $dbr = wfGetDB( DB_REPLICA
);
3366 $res = $dbr->select( 'categorylinks',
3367 [ 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ],
3368 // Have to do that since Database::fieldNamesWithAlias treats numeric indexes
3369 // as not being aliases, and NS_CATEGORY is numeric
3370 [ 'cl_from' => $id ],
3373 return TitleArray
::newFromResult( $res );
3377 * Returns a list of hidden categories this page is a member of.
3378 * Uses the page_props and categorylinks tables.
3380 * @return array Array of Title objects
3382 public function getHiddenCategories() {
3384 $id = $this->getId();
3390 $dbr = wfGetDB( DB_REPLICA
);
3391 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3393 [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3394 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ],
3397 if ( $res !== false ) {
3398 foreach ( $res as $row ) {
3399 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3407 * Auto-generates a deletion reason
3409 * @param bool &$hasHistory Whether the page has a history
3410 * @return string|bool String containing deletion reason or empty string, or boolean false
3411 * if no revision occurred
3413 public function getAutoDeleteReason( &$hasHistory ) {
3414 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3418 * Update all the appropriate counts in the category table, given that
3419 * we've added the categories $added and deleted the categories $deleted.
3421 * This should only be called from deferred updates or jobs to avoid contention.
3423 * @param array $added The names of categories that were added
3424 * @param array $deleted The names of categories that were deleted
3425 * @param int $id Page ID (this should be the original deleted page ID)
3427 public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3428 $id = $id ?
: $this->getId();
3429 $ns = $this->getTitle()->getNamespace();
3431 $addFields = [ 'cat_pages = cat_pages + 1' ];
3432 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3433 if ( $ns == NS_CATEGORY
) {
3434 $addFields[] = 'cat_subcats = cat_subcats + 1';
3435 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3436 } elseif ( $ns == NS_FILE
) {
3437 $addFields[] = 'cat_files = cat_files + 1';
3438 $removeFields[] = 'cat_files = cat_files - 1';
3441 $dbw = wfGetDB( DB_MASTER
);
3443 if ( count( $added ) ) {
3444 $existingAdded = $dbw->selectFieldValues(
3447 [ 'cat_title' => $added ],
3451 // For category rows that already exist, do a plain
3452 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3453 // to avoid creating gaps in the cat_id sequence.
3454 if ( count( $existingAdded ) ) {
3458 [ 'cat_title' => $existingAdded ],
3463 $missingAdded = array_diff( $added, $existingAdded );
3464 if ( count( $missingAdded ) ) {
3466 foreach ( $missingAdded as $cat ) {
3468 'cat_title' => $cat,
3470 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3471 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3484 if ( count( $deleted ) ) {
3488 [ 'cat_title' => $deleted ],
3493 foreach ( $added as $catName ) {
3494 $cat = Category
::newFromName( $catName );
3495 Hooks
::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3498 foreach ( $deleted as $catName ) {
3499 $cat = Category
::newFromName( $catName );
3500 Hooks
::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3503 // Refresh counts on categories that should be empty now, to
3504 // trigger possible deletion. Check master for the most
3505 // up-to-date cat_pages.
3506 if ( count( $deleted ) ) {
3507 $rows = $dbw->select(
3509 [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
3510 [ 'cat_title' => $deleted, 'cat_pages <= 0' ],
3513 foreach ( $rows as $row ) {
3514 $cat = Category
::newFromRow( $row );
3515 // T166757: do the update after this DB commit
3516 DeferredUpdates
::addCallableUpdate( function () use ( $cat ) {
3517 $cat->refreshCounts();
3524 * Opportunistically enqueue link update jobs given fresh parser output if useful
3526 * @param ParserOutput $parserOutput Current version page output
3529 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3530 if ( wfReadOnly() ) {
3534 if ( !Hooks
::run( 'OpportunisticLinksUpdate',
3535 [ $this, $this->mTitle
, $parserOutput ]
3540 $config = RequestContext
::getMain()->getConfig();
3543 'isOpportunistic' => true,
3544 'rootJobTimestamp' => $parserOutput->getCacheTime()
3547 if ( $this->mTitle
->areRestrictionsCascading() ) {
3548 // If the page is cascade protecting, the links should really be up-to-date
3549 JobQueueGroup
::singleton()->lazyPush(
3550 RefreshLinksJob
::newPrioritized( $this->mTitle
, $params )
3552 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3553 // Assume the output contains "dynamic" time/random based magic words.
3554 // Only update pages that expired due to dynamic content and NOT due to edits
3555 // to referenced templates/files. When the cache expires due to dynamic content,
3556 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3557 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3558 // template/file edit already triggered recursive RefreshLinksJob jobs.
3559 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3560 // If a page is uncacheable, do not keep spamming a job for it.
3561 // Although it would be de-duplicated, it would still waste I/O.
3562 $cache = ObjectCache
::getLocalClusterInstance();
3563 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3564 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3565 if ( $cache->add( $key, time(), $ttl ) ) {
3566 JobQueueGroup
::singleton()->lazyPush(
3567 RefreshLinksJob
::newDynamic( $this->mTitle
, $params )
3575 * Returns a list of updates to be performed when this page is deleted. The
3576 * updates should remove any information about this page from secondary data
3577 * stores such as links tables.
3579 * @param Content|null $content Optional Content object for determining the
3580 * necessary updates.
3581 * @return DeferrableUpdate[]
3583 public function getDeletionUpdates( Content
$content = null ) {
3585 // load content object, which may be used to determine the necessary updates.
3586 // XXX: the content may not be needed to determine the updates.
3588 $content = $this->getContent( Revision
::RAW
);
3589 } catch ( Exception
$ex ) {
3590 // If we can't load the content, something is wrong. Perhaps that's why
3591 // the user is trying to delete the page, so let's not fail in that case.
3592 // Note that doDeleteArticleReal() will already have logged an issue with
3593 // loading the content.
3600 $updates = $content->getDeletionUpdates( $this );
3603 Hooks
::run( 'WikiPageDeletionUpdates', [ $this, $content, &$updates ] );
3608 * Whether this content displayed on this page
3609 * comes from the local database
3614 public function isLocal() {
3619 * The display name for the site this content
3620 * come from. If a subclass overrides isLocal(),
3621 * this could return something other than the
3627 public function getWikiDisplayName() {
3633 * Get the source URL for the content on this page,
3634 * typically the canonical URL, but may be a remote
3635 * link if the content comes from another site
3640 public function getSourceURL() {
3641 return $this->getTitle()->getCanonicalURL();
3645 * @param WANObjectCache $cache
3649 public function getMutableCacheKeys( WANObjectCache
$cache ) {
3650 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3652 return $linkCache->getMutableCacheKeys( $cache, $this->getTitle()->getTitleValue() );