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 ?
: $dbw->nextSequenceValue( 'page_page_id_seq' );
1173 'page_id' => $pageIdForInsert,
1174 'page_namespace' => $this->mTitle
->getNamespace(),
1175 'page_title' => $this->mTitle
->getDBkey(),
1176 'page_restrictions' => '',
1177 'page_is_redirect' => 0, // Will set this shortly...
1179 'page_random' => wfRandom(),
1180 'page_touched' => $dbw->timestamp(),
1181 'page_latest' => 0, // Fill this in shortly...
1182 'page_len' => 0, // Fill this in shortly...
1188 if ( $dbw->affectedRows() > 0 ) {
1189 $newid = $pageId ?
(int)$pageId : $dbw->insertId();
1190 $this->mId
= $newid;
1191 $this->mTitle
->resetArticleID( $newid );
1195 return false; // nothing changed
1200 * Update the page record to point to a newly saved revision.
1202 * @param IDatabase $dbw
1203 * @param Revision $revision For ID number, and text used to set
1204 * length and redirect status fields
1205 * @param int $lastRevision If given, will not overwrite the page field
1206 * when different from the currently set value.
1207 * Giving 0 indicates the new page flag should be set on.
1208 * @param bool $lastRevIsRedirect If given, will optimize adding and
1209 * removing rows in redirect table.
1210 * @return bool Success; false if the page row was missing or page_latest changed
1212 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1213 $lastRevIsRedirect = null
1215 global $wgContentHandlerUseDB;
1217 // Assertion to try to catch T92046
1218 if ( (int)$revision->getId() === 0 ) {
1219 throw new InvalidArgumentException(
1220 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1224 $content = $revision->getContent();
1225 $len = $content ?
$content->getSize() : 0;
1226 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1228 $conditions = [ 'page_id' => $this->getId() ];
1230 if ( !is_null( $lastRevision ) ) {
1231 // An extra check against threads stepping on each other
1232 $conditions['page_latest'] = $lastRevision;
1236 'page_latest' => $revision->getId(),
1237 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1238 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1239 'page_is_redirect' => $rt !== null ?
1 : 0,
1243 if ( $wgContentHandlerUseDB ) {
1244 $row['page_content_model'] = $revision->getContentModel();
1247 $dbw->update( 'page',
1252 $result = $dbw->affectedRows() > 0;
1254 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1255 $this->setLastEdit( $revision );
1256 $this->mLatest
= $revision->getId();
1257 $this->mIsRedirect
= (bool)$rt;
1258 // Update the LinkCache.
1259 LinkCache
::singleton()->addGoodLinkObj(
1265 $revision->getContentModel()
1273 * Add row to the redirect table if this is a redirect, remove otherwise.
1275 * @param IDatabase $dbw
1276 * @param Title $redirectTitle Title object pointing to the redirect target,
1277 * or NULL if this is not a redirect
1278 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1279 * removing rows in redirect table.
1280 * @return bool True on success, false on failure
1283 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1284 // Always update redirects (target link might have changed)
1285 // Update/Insert if we don't know if the last revision was a redirect or not
1286 // Delete if changing from redirect to non-redirect
1287 $isRedirect = !is_null( $redirectTitle );
1289 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1293 if ( $isRedirect ) {
1294 $this->insertRedirectEntry( $redirectTitle );
1296 // This is not a redirect, remove row from redirect table
1297 $where = [ 'rd_from' => $this->getId() ];
1298 $dbw->delete( 'redirect', $where, __METHOD__
);
1301 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1302 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1305 return ( $dbw->affectedRows() != 0 );
1309 * If the given revision is newer than the currently set page_latest,
1310 * update the page record. Otherwise, do nothing.
1312 * @deprecated since 1.24, use updateRevisionOn instead
1314 * @param IDatabase $dbw
1315 * @param Revision $revision
1318 public function updateIfNewerOn( $dbw, $revision ) {
1319 $row = $dbw->selectRow(
1320 [ 'revision', 'page' ],
1321 [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1323 'page_id' => $this->getId(),
1324 'page_latest=rev_id' ],
1328 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1331 $prev = $row->rev_id
;
1332 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1334 // No or missing previous revision; mark the page as new
1336 $lastRevIsRedirect = null;
1339 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1345 * Get the content that needs to be saved in order to undo all revisions
1346 * between $undo and $undoafter. Revisions must belong to the same page,
1347 * must exist and must not be deleted
1348 * @param Revision $undo
1349 * @param Revision $undoafter Must be an earlier revision than $undo
1350 * @return Content|bool Content on success, false on failure
1352 * Before we had the Content object, this was done in getUndoText
1354 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1355 $handler = $undo->getContentHandler();
1356 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1360 * Returns true if this page's content model supports sections.
1364 * @todo The skin should check this and not offer section functionality if
1365 * sections are not supported.
1366 * @todo The EditPage should check this and not offer section functionality
1367 * if sections are not supported.
1369 public function supportsSections() {
1370 return $this->getContentHandler()->supportsSections();
1374 * @param string|int|null|bool $sectionId Section identifier as a number or string
1375 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1376 * or 'new' for a new section.
1377 * @param Content $sectionContent New content of the section.
1378 * @param string $sectionTitle New section's subject, only if $section is "new".
1379 * @param string $edittime Revision timestamp or null to use the current revision.
1381 * @throws MWException
1382 * @return Content|null New complete article content, or null if error.
1385 * @deprecated since 1.24, use replaceSectionAtRev instead
1387 public function replaceSectionContent(
1388 $sectionId, Content
$sectionContent, $sectionTitle = '', $edittime = null
1391 if ( $edittime && $sectionId !== 'new' ) {
1392 $dbr = wfGetDB( DB_REPLICA
);
1393 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1394 // Try the master if this thread may have just added it.
1395 // This could be abstracted into a Revision method, but we don't want
1396 // to encourage loading of revisions by timestamp.
1398 && wfGetLB()->getServerCount() > 1
1399 && wfGetLB()->hasOrMadeRecentMasterChanges()
1401 $dbw = wfGetDB( DB_MASTER
);
1402 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1405 $baseRevId = $rev->getId();
1409 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1413 * @param string|int|null|bool $sectionId Section identifier as a number or string
1414 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1415 * or 'new' for a new section.
1416 * @param Content $sectionContent New content of the section.
1417 * @param string $sectionTitle New section's subject, only if $section is "new".
1418 * @param int|null $baseRevId
1420 * @throws MWException
1421 * @return Content|null New complete article content, or null if error.
1425 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1426 $sectionTitle = '', $baseRevId = null
1428 if ( strval( $sectionId ) === '' ) {
1429 // Whole-page edit; let the whole text through
1430 $newContent = $sectionContent;
1432 if ( !$this->supportsSections() ) {
1433 throw new MWException( "sections not supported for content model " .
1434 $this->getContentHandler()->getModelID() );
1437 // T32711: always use current version when adding a new section
1438 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1439 $oldContent = $this->getContent();
1441 $rev = Revision
::newFromId( $baseRevId );
1443 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1444 $this->getId() . "; section: $sectionId)\n" );
1448 $oldContent = $rev->getContent();
1451 if ( !$oldContent ) {
1452 wfDebug( __METHOD__
. ": no page text\n" );
1456 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1463 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1465 * @return int Updated $flags
1467 public function checkFlags( $flags ) {
1468 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1469 if ( $this->exists() ) {
1470 $flags |
= EDIT_UPDATE
;
1480 * Change an existing article or create a new article. Updates RC and all necessary caches,
1481 * optionally via the deferred update array.
1483 * @param Content $content New content
1484 * @param string $summary Edit summary
1485 * @param int $flags Bitfield:
1487 * Article is known or assumed to be non-existent, create a new one
1489 * Article is known or assumed to be pre-existing, update it
1491 * Mark this edit minor, if the user is allowed to do so
1493 * Do not log the change in recentchanges
1495 * Mark the edit a "bot" edit regardless of user rights
1497 * Fill in blank summaries with generated text where possible
1499 * Signal that the page retrieve/save cycle happened entirely in this request.
1501 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1502 * article will be detected. If EDIT_UPDATE is specified and the article
1503 * doesn't exist, the function will return an edit-gone-missing error. If
1504 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1505 * error will be returned. These two conditions are also possible with
1506 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1508 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1509 * This is not the parent revision ID, rather the revision ID for older
1510 * content used as the source for a rollback, for example.
1511 * @param User $user The user doing the edit
1512 * @param string $serialFormat Format for storing the content in the
1514 * @param array|null $tags Change tags to apply to this edit
1515 * Callers are responsible for permission checks
1516 * (with ChangeTags::canAddTagsAccompanyingChange)
1517 * @param Int $undidRevId Id of revision that was undone or 0
1519 * @throws MWException
1520 * @return Status Possible errors:
1521 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1522 * set the fatal flag of $status.
1523 * edit-gone-missing: In update mode, but the article didn't exist.
1524 * edit-conflict: In update mode, the article changed unexpectedly.
1525 * edit-no-change: Warning that the text was the same as before.
1526 * edit-already-exists: In creation mode, but the article already exists.
1528 * Extensions may define additional errors.
1530 * $return->value will contain an associative array with members as follows:
1531 * new: Boolean indicating if the function attempted to create a new article.
1532 * revision: The revision object for the inserted revision, or null.
1535 * @throws MWException
1537 public function doEditContent(
1538 Content
$content, $summary, $flags = 0, $baseRevId = false,
1539 User
$user = null, $serialFormat = null, $tags = [], $undidRevId = 0
1541 global $wgUser, $wgUseAutomaticEditSummaries;
1543 // Old default parameter for $tags was null
1544 if ( $tags === null ) {
1548 // Low-level sanity check
1549 if ( $this->mTitle
->getText() === '' ) {
1550 throw new MWException( 'Something is trying to edit an article with an empty title' );
1552 // Make sure the given content type is allowed for this page
1553 if ( !$content->getContentHandler()->canBeUsedOn( $this->mTitle
) ) {
1554 return Status
::newFatal( 'content-not-allowed-here',
1555 ContentHandler
::getLocalizedName( $content->getModel() ),
1556 $this->mTitle
->getPrefixedText()
1560 // Load the data from the master database if needed.
1561 // The caller may already loaded it from the master or even loaded it using
1562 // SELECT FOR UPDATE, so do not override that using clear().
1563 $this->loadPageData( 'fromdbmaster' );
1565 $user = $user ?
: $wgUser;
1566 $flags = $this->checkFlags( $flags );
1568 // Avoid PHP 7.1 warning of passing $this by reference
1571 // Trigger pre-save hook (using provided edit summary)
1572 $hookStatus = Status
::newGood( [] );
1573 $hook_args = [ &$wikiPage, &$user, &$content, &$summary,
1574 $flags & EDIT_MINOR
, null, null, &$flags, &$hookStatus ];
1575 // Check if the hook rejected the attempted save
1576 if ( !Hooks
::run( 'PageContentSave', $hook_args ) ) {
1577 if ( $hookStatus->isOK() ) {
1578 // Hook returned false but didn't call fatal(); use generic message
1579 $hookStatus->fatal( 'edit-hook-aborted' );
1585 $old_revision = $this->getRevision(); // current revision
1586 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1588 if ( $old_content && $old_content->getModel() !== $content->getModel() ) {
1589 $tags[] = 'mw-contentmodelchange';
1592 // Provide autosummaries if one is not provided and autosummaries are enabled
1593 if ( $wgUseAutomaticEditSummaries && ( $flags & EDIT_AUTOSUMMARY
) && $summary == '' ) {
1594 $handler = $content->getContentHandler();
1595 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1598 // Avoid statsd noise and wasted cycles check the edit stash (T136678)
1599 if ( ( $flags & EDIT_INTERNAL
) ||
( $flags & EDIT_FORCE_BOT
) ) {
1605 // Get the pre-save transform content and final parser output
1606 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat, $useCache );
1607 $pstContent = $editInfo->pstContent
; // Content object
1609 'bot' => ( $flags & EDIT_FORCE_BOT
),
1610 'minor' => ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' ),
1611 'serialized' => $pstContent->serialize( $serialFormat ),
1612 'serialFormat' => $serialFormat,
1613 'baseRevId' => $baseRevId,
1614 'oldRevision' => $old_revision,
1615 'oldContent' => $old_content,
1616 'oldId' => $this->getLatest(),
1617 'oldIsRedirect' => $this->isRedirect(),
1618 'oldCountable' => $this->isCountable(),
1619 'tags' => ( $tags !== null ) ?
(array)$tags : [],
1620 'undidRevId' => $undidRevId
1623 // Actually create the revision and create/update the page
1624 if ( $flags & EDIT_UPDATE
) {
1625 $status = $this->doModify( $pstContent, $flags, $user, $summary, $meta );
1627 $status = $this->doCreate( $pstContent, $flags, $user, $summary, $meta );
1630 // Promote user to any groups they meet the criteria for
1631 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
1632 $user->addAutopromoteOnceGroups( 'onEdit' );
1633 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1640 * @param Content $content Pre-save transform content
1643 * @param string $summary
1644 * @param array $meta
1646 * @throws DBUnexpectedError
1648 * @throws FatalError
1649 * @throws MWException
1651 private function doModify(
1652 Content
$content, $flags, User
$user, $summary, array $meta
1654 global $wgUseRCPatrol;
1656 // Update article, but only if changed.
1657 $status = Status
::newGood( [ 'new' => false, 'revision' => null ] );
1659 // Convenience variables
1660 $now = wfTimestampNow();
1661 $oldid = $meta['oldId'];
1662 /** @var $oldContent Content|null */
1663 $oldContent = $meta['oldContent'];
1664 $newsize = $content->getSize();
1667 // Article gone missing
1668 $status->fatal( 'edit-gone-missing' );
1671 } elseif ( !$oldContent ) {
1672 // Sanity check for T39225
1673 throw new MWException( "Could not find text for current revision {$oldid}." );
1676 // @TODO: pass content object?!
1677 $revision = new Revision( [
1678 'page' => $this->getId(),
1679 'title' => $this->mTitle
, // for determining the default content model
1680 'comment' => $summary,
1681 'minor_edit' => $meta['minor'],
1682 'text' => $meta['serialized'],
1684 'parent_id' => $oldid,
1685 'user' => $user->getId(),
1686 'user_text' => $user->getName(),
1687 'timestamp' => $now,
1688 'content_model' => $content->getModel(),
1689 'content_format' => $meta['serialFormat'],
1692 $changed = !$content->equals( $oldContent );
1694 $dbw = wfGetDB( DB_MASTER
);
1697 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1698 $status->merge( $prepStatus );
1699 if ( !$status->isOK() ) {
1703 $dbw->startAtomic( __METHOD__
);
1704 // Get the latest page_latest value while locking it.
1705 // Do a CAS style check to see if it's the same as when this method
1706 // started. If it changed then bail out before touching the DB.
1707 $latestNow = $this->lockAndGetLatest();
1708 if ( $latestNow != $oldid ) {
1709 $dbw->endAtomic( __METHOD__
);
1710 // Page updated or deleted in the mean time
1711 $status->fatal( 'edit-conflict' );
1716 // At this point we are now comitted to returning an OK
1717 // status unless some DB query error or other exception comes up.
1718 // This way callers don't have to call rollback() if $status is bad
1719 // unless they actually try to catch exceptions (which is rare).
1721 // Save the revision text
1722 $revisionId = $revision->insertOn( $dbw );
1723 // Update page_latest and friends to reflect the new revision
1724 if ( !$this->updateRevisionOn( $dbw, $revision, null, $meta['oldIsRedirect'] ) ) {
1725 throw new MWException( "Failed to update page row to use new revision." );
1728 Hooks
::run( 'NewRevisionFromEditComplete',
1729 [ $this, $revision, $meta['baseRevId'], $user ] );
1731 // Update recentchanges
1732 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1733 // Mark as patrolled if the user can do so
1734 $patrolled = $wgUseRCPatrol && !count(
1735 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1736 // Add RC row to the DB
1737 RecentChange
::notifyEdit(
1740 $revision->isMinor(),
1744 $this->getTimestamp(),
1747 $oldContent ?
$oldContent->getSize() : 0,
1755 $user->incEditCount();
1757 $dbw->endAtomic( __METHOD__
);
1758 $this->mTimestamp
= $now;
1760 // T34948: revision ID must be set to page {{REVISIONID}} and
1761 // related variables correctly. Likewise for {{REVISIONUSER}} (T135261).
1762 $revision->setId( $this->getLatest() );
1763 $revision->setUserIdAndName(
1764 $this->getUser( Revision
::RAW
),
1765 $this->getUserText( Revision
::RAW
)
1770 // Return the new revision to the caller
1771 $status->value
['revision'] = $revision;
1773 $status->warning( 'edit-no-change' );
1774 // Update page_touched as updateRevisionOn() was not called.
1775 // Other cache updates are managed in onArticleEdit() via doEditUpdates().
1776 $this->mTitle
->invalidateCache( $now );
1779 // Do secondary updates once the main changes have been committed...
1780 DeferredUpdates
::addUpdate(
1781 new AtomicSectionUpdate(
1785 $revision, &$user, $content, $summary, &$flags,
1786 $changed, $meta, &$status
1788 // Update links tables, site stats, etc.
1789 $this->doEditUpdates(
1793 'changed' => $changed,
1794 'oldcountable' => $meta['oldCountable'],
1795 'oldrevision' => $meta['oldRevision']
1798 // Avoid PHP 7.1 warning of passing $this by reference
1800 // Trigger post-save hook
1801 $params = [ &$wikiPage, &$user, $content, $summary, $flags & EDIT_MINOR
,
1802 null, null, &$flags, $revision, &$status, $meta['baseRevId'],
1803 $meta['undidRevId'] ];
1804 Hooks
::run( 'PageContentSaveComplete', $params );
1807 DeferredUpdates
::PRESEND
1814 * @param Content $content Pre-save transform content
1817 * @param string $summary
1818 * @param array $meta
1820 * @throws DBUnexpectedError
1822 * @throws FatalError
1823 * @throws MWException
1825 private function doCreate(
1826 Content
$content, $flags, User
$user, $summary, array $meta
1828 global $wgUseRCPatrol, $wgUseNPPatrol;
1830 $status = Status
::newGood( [ 'new' => true, 'revision' => null ] );
1832 $now = wfTimestampNow();
1833 $newsize = $content->getSize();
1834 $prepStatus = $content->prepareSave( $this, $flags, $meta['oldId'], $user );
1835 $status->merge( $prepStatus );
1836 if ( !$status->isOK() ) {
1840 $dbw = wfGetDB( DB_MASTER
);
1841 $dbw->startAtomic( __METHOD__
);
1843 // Add the page record unless one already exists for the title
1844 $newid = $this->insertOn( $dbw );
1845 if ( $newid === false ) {
1846 $dbw->endAtomic( __METHOD__
); // nothing inserted
1847 $status->fatal( 'edit-already-exists' );
1849 return $status; // nothing done
1852 // At this point we are now comitted to returning an OK
1853 // status unless some DB query error or other exception comes up.
1854 // This way callers don't have to call rollback() if $status is bad
1855 // unless they actually try to catch exceptions (which is rare).
1857 // @TODO: pass content object?!
1858 $revision = new Revision( [
1860 'title' => $this->mTitle
, // for determining the default content model
1861 'comment' => $summary,
1862 'minor_edit' => $meta['minor'],
1863 'text' => $meta['serialized'],
1865 'user' => $user->getId(),
1866 'user_text' => $user->getName(),
1867 'timestamp' => $now,
1868 'content_model' => $content->getModel(),
1869 'content_format' => $meta['serialFormat'],
1872 // Save the revision text...
1873 $revisionId = $revision->insertOn( $dbw );
1874 // Update the page record with revision data
1875 if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1876 throw new MWException( "Failed to update page row to use new revision." );
1879 Hooks
::run( 'NewRevisionFromEditComplete', [ $this, $revision, false, $user ] );
1881 // Update recentchanges
1882 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1883 // Mark as patrolled if the user can do so
1884 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) &&
1885 !count( $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1886 // Add RC row to the DB
1887 RecentChange
::notifyNew(
1890 $revision->isMinor(),
1902 $user->incEditCount();
1904 $dbw->endAtomic( __METHOD__
);
1905 $this->mTimestamp
= $now;
1907 // Return the new revision to the caller
1908 $status->value
['revision'] = $revision;
1910 // Do secondary updates once the main changes have been committed...
1911 DeferredUpdates
::addUpdate(
1912 new AtomicSectionUpdate(
1916 $revision, &$user, $content, $summary, &$flags, $meta, &$status
1918 // Update links, etc.
1919 $this->doEditUpdates( $revision, $user, [ 'created' => true ] );
1920 // Avoid PHP 7.1 warning of passing $this by reference
1922 // Trigger post-create hook
1923 $params = [ &$wikiPage, &$user, $content, $summary,
1924 $flags & EDIT_MINOR
, null, null, &$flags, $revision ];
1925 Hooks
::run( 'PageContentInsertComplete', $params );
1926 // Trigger post-save hook
1927 $params = array_merge( $params, [ &$status, $meta['baseRevId'] ] );
1928 Hooks
::run( 'PageContentSaveComplete', $params );
1931 DeferredUpdates
::PRESEND
1938 * Get parser options suitable for rendering the primary article wikitext
1940 * @see ContentHandler::makeParserOptions
1942 * @param IContextSource|User|string $context One of the following:
1943 * - IContextSource: Use the User and the Language of the provided
1945 * - User: Use the provided User object and $wgLang for the language,
1946 * so use an IContextSource object if possible.
1947 * - 'canonical': Canonical options (anonymous user with default
1948 * preferences and content language).
1949 * @return ParserOptions
1951 public function makeParserOptions( $context ) {
1952 $options = $this->getContentHandler()->makeParserOptions( $context );
1954 if ( $this->getTitle()->isConversionTable() ) {
1955 // @todo ConversionTable should become a separate content model, so
1956 // we don't need special cases like this one.
1957 $options->disableContentConversion();
1964 * Prepare content which is about to be saved.
1966 * Prior to 1.30, this returned a stdClass object with the same class
1969 * @param Content $content
1970 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
1971 * revision ID is also accepted, but this is deprecated.
1972 * @param User|null $user
1973 * @param string|null $serialFormat
1974 * @param bool $useCache Check shared prepared edit cache
1976 * @return PreparedEdit
1980 public function prepareContentForEdit(
1981 Content
$content, $revision = null, User
$user = null,
1982 $serialFormat = null, $useCache = true
1984 global $wgContLang, $wgUser, $wgAjaxEditStash;
1986 if ( is_object( $revision ) ) {
1987 $revid = $revision->getId();
1990 // This code path is deprecated, and nothing is known to
1991 // use it, so performance here shouldn't be a worry.
1992 if ( $revid !== null ) {
1993 $revision = Revision
::newFromId( $revid, Revision
::READ_LATEST
);
1999 $user = is_null( $user ) ?
$wgUser : $user;
2000 // XXX: check $user->getId() here???
2002 // Use a sane default for $serialFormat, see T59026
2003 if ( $serialFormat === null ) {
2004 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2007 if ( $this->mPreparedEdit
2008 && isset( $this->mPreparedEdit
->newContent
)
2009 && $this->mPreparedEdit
->newContent
->equals( $content )
2010 && $this->mPreparedEdit
->revid
== $revid
2011 && $this->mPreparedEdit
->format
== $serialFormat
2012 // XXX: also check $user here?
2015 return $this->mPreparedEdit
;
2018 // The edit may have already been prepared via api.php?action=stashedit
2019 $cachedEdit = $useCache && $wgAjaxEditStash
2020 ? ApiStashEdit
::checkCache( $this->getTitle(), $content, $user )
2023 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2024 Hooks
::run( 'ArticlePrepareTextForEdit', [ $this, $popts ] );
2026 $edit = new PreparedEdit();
2027 if ( $cachedEdit ) {
2028 $edit->timestamp
= $cachedEdit->timestamp
;
2030 $edit->timestamp
= wfTimestampNow();
2032 // @note: $cachedEdit is safely not used if the rev ID was referenced in the text
2033 $edit->revid
= $revid;
2035 if ( $cachedEdit ) {
2036 $edit->pstContent
= $cachedEdit->pstContent
;
2038 $edit->pstContent
= $content
2039 ?
$content->preSaveTransform( $this->mTitle
, $user, $popts )
2043 $edit->format
= $serialFormat;
2044 $edit->popts
= $this->makeParserOptions( 'canonical' );
2045 if ( $cachedEdit ) {
2046 $edit->output
= $cachedEdit->output
;
2049 // We get here if vary-revision is set. This means that this page references
2050 // itself (such as via self-transclusion). In this case, we need to make sure
2051 // that any such self-references refer to the newly-saved revision, and not
2052 // to the previous one, which could otherwise happen due to replica DB lag.
2053 $oldCallback = $edit->popts
->getCurrentRevisionCallback();
2054 $edit->popts
->setCurrentRevisionCallback(
2055 function ( Title
$title, $parser = false ) use ( $revision, &$oldCallback ) {
2056 if ( $title->equals( $revision->getTitle() ) ) {
2059 return call_user_func( $oldCallback, $title, $parser );
2064 // Try to avoid a second parse if {{REVISIONID}} is used
2065 $dbIndex = ( $this->mDataLoadedFrom
& self
::READ_LATEST
) === self
::READ_LATEST
2066 ? DB_MASTER
// use the best possible guess
2067 : DB_REPLICA
; // T154554
2069 $edit->popts
->setSpeculativeRevIdCallback( function () use ( $dbIndex ) {
2070 return 1 +
(int)wfGetDB( $dbIndex )->selectField(
2078 $edit->output
= $edit->pstContent
2079 ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
)
2083 $edit->newContent
= $content;
2084 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2086 // NOTE: B/C for hooks! don't use these fields!
2087 $edit->newText
= $edit->newContent
2088 ? ContentHandler
::getContentText( $edit->newContent
)
2090 $edit->oldText
= $edit->oldContent
2091 ? ContentHandler
::getContentText( $edit->oldContent
)
2093 $edit->pst
= $edit->pstContent ?
$edit->pstContent
->serialize( $serialFormat ) : '';
2095 if ( $edit->output
) {
2096 $edit->output
->setCacheTime( wfTimestampNow() );
2099 // Process cache the result
2100 $this->mPreparedEdit
= $edit;
2106 * Do standard deferred updates after page edit.
2107 * Update links tables, site stats, search index and message cache.
2108 * Purges pages that include this page if the text was changed here.
2109 * Every 100th edit, prune the recent changes table.
2111 * @param Revision $revision
2112 * @param User $user User object that did the revision
2113 * @param array $options Array of options, following indexes are used:
2114 * - changed: bool, whether the revision changed the content (default true)
2115 * - created: bool, whether the revision created the page (default false)
2116 * - moved: bool, whether the page was moved (default false)
2117 * - restored: bool, whether the page was undeleted (default false)
2118 * - oldrevision: Revision object for the pre-update revision (default null)
2119 * - oldcountable: bool, null, or string 'no-change' (default null):
2120 * - bool: whether the page was counted as an article before that
2121 * revision, only used in changed is true and created is false
2122 * - null: if created is false, don't update the article count; if created
2123 * is true, do update the article count
2124 * - 'no-change': don't update the article count, ever
2126 public function doEditUpdates( Revision
$revision, User
$user, array $options = [] ) {
2127 global $wgRCWatchCategoryMembership;
2133 'restored' => false,
2134 'oldrevision' => null,
2135 'oldcountable' => null
2137 $content = $revision->getContent();
2139 $logger = LoggerFactory
::getInstance( 'SaveParse' );
2141 // See if the parser output before $revision was inserted is still valid
2143 if ( !$this->mPreparedEdit
) {
2144 $logger->debug( __METHOD__
. ": No prepared edit...\n" );
2145 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2146 $logger->info( __METHOD__
. ": Prepared edit has vary-revision...\n" );
2147 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision-id' )
2148 && $this->mPreparedEdit
->output
->getSpeculativeRevIdUsed() !== $revision->getId()
2150 $logger->info( __METHOD__
. ": Prepared edit has vary-revision-id with wrong ID...\n" );
2151 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-user' ) && !$options['changed'] ) {
2152 $logger->info( __METHOD__
. ": Prepared edit has vary-user and is null...\n" );
2154 wfDebug( __METHOD__
. ": Using prepared edit...\n" );
2155 $editInfo = $this->mPreparedEdit
;
2159 // Parse the text again if needed. Be careful not to do pre-save transform twice:
2160 // $text is usually already pre-save transformed once. Avoid using the edit stash
2161 // as any prepared content from there or in doEditContent() was already rejected.
2162 $editInfo = $this->prepareContentForEdit( $content, $revision, $user, null, false );
2165 // Save it to the parser cache.
2166 // Make sure the cache time matches page_touched to avoid double parsing.
2167 ParserCache
::singleton()->save(
2168 $editInfo->output
, $this, $editInfo->popts
,
2169 $revision->getTimestamp(), $editInfo->revid
2172 // Update the links tables and other secondary data
2174 $recursive = $options['changed']; // T52785
2175 $updates = $content->getSecondaryDataUpdates(
2176 $this->getTitle(), null, $recursive, $editInfo->output
2178 foreach ( $updates as $update ) {
2179 if ( $update instanceof LinksUpdate
) {
2180 $update->setRevision( $revision );
2181 $update->setTriggeringUser( $user );
2183 DeferredUpdates
::addUpdate( $update );
2185 if ( $wgRCWatchCategoryMembership
2186 && $this->getContentHandler()->supportsCategories() === true
2187 && ( $options['changed'] ||
$options['created'] )
2188 && !$options['restored']
2190 // Note: jobs are pushed after deferred updates, so the job should be able to see
2191 // the recent change entry (also done via deferred updates) and carry over any
2192 // bot/deletion/IP flags, ect.
2193 JobQueueGroup
::singleton()->lazyPush( new CategoryMembershipChangeJob(
2196 'pageId' => $this->getId(),
2197 'revTimestamp' => $revision->getTimestamp()
2203 // Avoid PHP 7.1 warning of passing $this by reference
2206 Hooks
::run( 'ArticleEditUpdates', [ &$wikiPage, &$editInfo, $options['changed'] ] );
2208 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', [ &$wikiPage ] ) ) {
2209 // Flush old entries from the `recentchanges` table
2210 if ( mt_rand( 0, 9 ) == 0 ) {
2211 JobQueueGroup
::singleton()->lazyPush( RecentChangesUpdateJob
::newPurgeJob() );
2215 if ( !$this->exists() ) {
2219 $id = $this->getId();
2220 $title = $this->mTitle
->getPrefixedDBkey();
2221 $shortTitle = $this->mTitle
->getDBkey();
2223 if ( $options['oldcountable'] === 'no-change' ||
2224 ( !$options['changed'] && !$options['moved'] )
2227 } elseif ( $options['created'] ) {
2228 $good = (int)$this->isCountable( $editInfo );
2229 } elseif ( $options['oldcountable'] !== null ) {
2230 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2234 $edits = $options['changed'] ?
1 : 0;
2235 $total = $options['created'] ?
1 : 0;
2237 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2238 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2240 // If this is another user's talk page, update newtalk.
2241 // Don't do this if $options['changed'] = false (null-edits) nor if
2242 // it's a minor edit and the user doesn't want notifications for those.
2243 if ( $options['changed']
2244 && $this->mTitle
->getNamespace() == NS_USER_TALK
2245 && $shortTitle != $user->getTitleKey()
2246 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2248 $recipient = User
::newFromName( $shortTitle, false );
2249 if ( !$recipient ) {
2250 wfDebug( __METHOD__
. ": invalid username\n" );
2252 // Avoid PHP 7.1 warning of passing $this by reference
2255 // Allow extensions to prevent user notification
2256 // when a new message is added to their talk page
2257 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', [ &$wikiPage, $recipient ] ) ) {
2258 if ( User
::isIP( $shortTitle ) ) {
2259 // An anonymous user
2260 $recipient->setNewtalk( true, $revision );
2261 } elseif ( $recipient->isLoggedIn() ) {
2262 $recipient->setNewtalk( true, $revision );
2264 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2270 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2271 MessageCache
::singleton()->updateMessageOverride( $this->mTitle
, $content );
2274 if ( $options['created'] ) {
2275 self
::onArticleCreate( $this->mTitle
);
2276 } elseif ( $options['changed'] ) { // T52785
2277 self
::onArticleEdit( $this->mTitle
, $revision );
2280 ResourceLoaderWikiModule
::invalidateModuleCache(
2281 $this->mTitle
, $options['oldrevision'], $revision, wfWikiID()
2286 * Update the article's restriction field, and leave a log entry.
2287 * This works for protection both existing and non-existing pages.
2289 * @param array $limit Set of restriction keys
2290 * @param array $expiry Per restriction type expiration
2291 * @param int &$cascade Set to false if cascading protection isn't allowed.
2292 * @param string $reason
2293 * @param User $user The user updating the restrictions
2294 * @param string|string[] $tags Change tags to add to the pages and protection log entries
2295 * ($user should be able to add the specified tags before this is called)
2296 * @return Status Status object; if action is taken, $status->value is the log_id of the
2297 * protection log entry.
2299 public function doUpdateRestrictions( array $limit, array $expiry,
2300 &$cascade, $reason, User
$user, $tags = null
2302 global $wgCascadingRestrictionLevels;
2304 if ( wfReadOnly() ) {
2305 return Status
::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
2308 $this->loadPageData( 'fromdbmaster' );
2309 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2310 $id = $this->getId();
2316 // Take this opportunity to purge out expired restrictions
2317 Title
::purgeExpiredRestrictions();
2319 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2320 // we expect a single selection, but the schema allows otherwise.
2321 $isProtected = false;
2325 $dbw = wfGetDB( DB_MASTER
);
2327 foreach ( $restrictionTypes as $action ) {
2328 if ( !isset( $expiry[$action] ) ||
$expiry[$action] === $dbw->getInfinity() ) {
2329 $expiry[$action] = 'infinity';
2331 if ( !isset( $limit[$action] ) ) {
2332 $limit[$action] = '';
2333 } elseif ( $limit[$action] != '' ) {
2337 // Get current restrictions on $action
2338 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2339 if ( $current != '' ) {
2340 $isProtected = true;
2343 if ( $limit[$action] != $current ) {
2345 } elseif ( $limit[$action] != '' ) {
2346 // Only check expiry change if the action is actually being
2347 // protected, since expiry does nothing on an not-protected
2349 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2355 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2359 // If nothing has changed, do nothing
2361 return Status
::newGood();
2364 if ( !$protect ) { // No protection at all means unprotection
2365 $revCommentMsg = 'unprotectedarticle-comment';
2366 $logAction = 'unprotect';
2367 } elseif ( $isProtected ) {
2368 $revCommentMsg = 'modifiedarticleprotection-comment';
2369 $logAction = 'modify';
2371 $revCommentMsg = 'protectedarticle-comment';
2372 $logAction = 'protect';
2375 $logRelationsValues = [];
2376 $logRelationsField = null;
2377 $logParamsDetails = [];
2379 // Null revision (used for change tag insertion)
2380 $nullRevision = null;
2382 if ( $id ) { // Protection of existing page
2383 // Avoid PHP 7.1 warning of passing $this by reference
2386 if ( !Hooks
::run( 'ArticleProtect', [ &$wikiPage, &$user, $limit, $reason ] ) ) {
2387 return Status
::newGood();
2390 // Only certain restrictions can cascade...
2391 $editrestriction = isset( $limit['edit'] )
2392 ?
[ $limit['edit'] ]
2393 : $this->mTitle
->getRestrictions( 'edit' );
2394 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2395 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2397 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2398 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2401 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2402 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2403 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2405 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2406 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2409 // The schema allows multiple restrictions
2410 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2414 // insert null revision to identify the page protection change as edit summary
2415 $latest = $this->getLatest();
2416 $nullRevision = $this->insertProtectNullRevision(
2425 if ( $nullRevision === null ) {
2426 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2429 $logRelationsField = 'pr_id';
2431 // Update restrictions table
2432 foreach ( $limit as $action => $restrictions ) {
2434 'page_restrictions',
2437 'pr_type' => $action
2441 if ( $restrictions != '' ) {
2442 $cascadeValue = ( $cascade && $action == 'edit' ) ?
1 : 0;
2444 'page_restrictions',
2446 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2448 'pr_type' => $action,
2449 'pr_level' => $restrictions,
2450 'pr_cascade' => $cascadeValue,
2451 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2455 $logRelationsValues[] = $dbw->insertId();
2456 $logParamsDetails[] = [
2458 'level' => $restrictions,
2459 'expiry' => $expiry[$action],
2460 'cascade' => (bool)$cascadeValue,
2465 // Clear out legacy restriction fields
2468 [ 'page_restrictions' => '' ],
2469 [ 'page_id' => $id ],
2473 // Avoid PHP 7.1 warning of passing $this by reference
2476 Hooks
::run( 'NewRevisionFromEditComplete',
2477 [ $this, $nullRevision, $latest, $user ] );
2478 Hooks
::run( 'ArticleProtectComplete', [ &$wikiPage, &$user, $limit, $reason ] );
2479 } else { // Protection of non-existing page (also known as "title protection")
2480 // Cascade protection is meaningless in this case
2483 if ( $limit['create'] != '' ) {
2484 $commentFields = CommentStore
::newKey( 'pt_reason' )->insert( $dbw, $reason );
2485 $dbw->replace( 'protected_titles',
2486 [ [ 'pt_namespace', 'pt_title' ] ],
2488 'pt_namespace' => $this->mTitle
->getNamespace(),
2489 'pt_title' => $this->mTitle
->getDBkey(),
2490 'pt_create_perm' => $limit['create'],
2491 'pt_timestamp' => $dbw->timestamp(),
2492 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2493 'pt_user' => $user->getId(),
2494 ] +
$commentFields, __METHOD__
2496 $logParamsDetails[] = [
2498 'level' => $limit['create'],
2499 'expiry' => $expiry['create'],
2502 $dbw->delete( 'protected_titles',
2504 'pt_namespace' => $this->mTitle
->getNamespace(),
2505 'pt_title' => $this->mTitle
->getDBkey()
2511 $this->mTitle
->flushRestrictions();
2512 InfoAction
::invalidateCache( $this->mTitle
);
2514 if ( $logAction == 'unprotect' ) {
2517 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2519 '4::description' => $protectDescriptionLog, // parameter for IRC
2520 '5:bool:cascade' => $cascade,
2521 'details' => $logParamsDetails, // parameter for localize and api
2525 // Update the protection log
2526 $logEntry = new ManualLogEntry( 'protect', $logAction );
2527 $logEntry->setTarget( $this->mTitle
);
2528 $logEntry->setComment( $reason );
2529 $logEntry->setPerformer( $user );
2530 $logEntry->setParameters( $params );
2531 if ( !is_null( $nullRevision ) ) {
2532 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2534 $logEntry->setTags( $tags );
2535 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2536 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2538 $logId = $logEntry->insert();
2539 $logEntry->publish( $logId );
2541 return Status
::newGood( $logId );
2545 * Insert a new null revision for this page.
2547 * @param string $revCommentMsg Comment message key for the revision
2548 * @param array $limit Set of restriction keys
2549 * @param array $expiry Per restriction type expiration
2550 * @param int $cascade Set to false if cascading protection isn't allowed.
2551 * @param string $reason
2552 * @param User|null $user
2553 * @return Revision|null Null on error
2555 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2556 array $expiry, $cascade, $reason, $user = null
2558 $dbw = wfGetDB( DB_MASTER
);
2560 // Prepare a null revision to be added to the history
2561 $editComment = wfMessage(
2563 $this->mTitle
->getPrefixedText(),
2564 $user ?
$user->getName() : ''
2565 )->inContentLanguage()->text();
2567 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2569 $protectDescription = $this->protectDescription( $limit, $expiry );
2570 if ( $protectDescription ) {
2571 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2572 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2573 ->inContentLanguage()->text();
2576 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2577 $editComment .= wfMessage( 'brackets' )->params(
2578 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2579 )->inContentLanguage()->text();
2582 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2584 $nullRev->insertOn( $dbw );
2586 // Update page record and touch page
2587 $oldLatest = $nullRev->getParentId();
2588 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2595 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2598 protected function formatExpiry( $expiry ) {
2601 if ( $expiry != 'infinity' ) {
2604 $wgContLang->timeanddate( $expiry, false, false ),
2605 $wgContLang->date( $expiry, false, false ),
2606 $wgContLang->time( $expiry, false, false )
2607 )->inContentLanguage()->text();
2609 return wfMessage( 'protect-expiry-indefinite' )
2610 ->inContentLanguage()->text();
2615 * Builds the description to serve as comment for the edit.
2617 * @param array $limit Set of restriction keys
2618 * @param array $expiry Per restriction type expiration
2621 public function protectDescription( array $limit, array $expiry ) {
2622 $protectDescription = '';
2624 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2625 # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2626 # All possible message keys are listed here for easier grepping:
2627 # * restriction-create
2628 # * restriction-edit
2629 # * restriction-move
2630 # * restriction-upload
2631 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2632 # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2633 # with '' filtered out. All possible message keys are listed below:
2634 # * protect-level-autoconfirmed
2635 # * protect-level-sysop
2636 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2637 ->inContentLanguage()->text();
2639 $expiryText = $this->formatExpiry( $expiry[$action] );
2641 if ( $protectDescription !== '' ) {
2642 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2644 $protectDescription .= wfMessage( 'protect-summary-desc' )
2645 ->params( $actionText, $restrictionsText, $expiryText )
2646 ->inContentLanguage()->text();
2649 return $protectDescription;
2653 * Builds the description to serve as comment for the log entry.
2655 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2656 * protect description text. Keep them in old format to avoid breaking compatibility.
2657 * TODO: Fix protection log to store structured description and format it on-the-fly.
2659 * @param array $limit Set of restriction keys
2660 * @param array $expiry Per restriction type expiration
2663 public function protectDescriptionLog( array $limit, array $expiry ) {
2666 $protectDescriptionLog = '';
2668 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2669 $expiryText = $this->formatExpiry( $expiry[$action] );
2670 $protectDescriptionLog .= $wgContLang->getDirMark() .
2671 "[$action=$restrictions] ($expiryText)";
2674 return trim( $protectDescriptionLog );
2678 * Take an array of page restrictions and flatten it to a string
2679 * suitable for insertion into the page_restrictions field.
2681 * @param string[] $limit
2683 * @throws MWException
2686 protected static function flattenRestrictions( $limit ) {
2687 if ( !is_array( $limit ) ) {
2688 throw new MWException( __METHOD__
. ' given non-array restriction set' );
2694 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2695 $bits[] = "$action=$restrictions";
2698 return implode( ':', $bits );
2702 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2703 * backwards compatibility, if you care about error reporting you should use
2704 * doDeleteArticleReal() instead.
2706 * Deletes the article with database consistency, writes logs, purges caches
2708 * @param string $reason Delete reason for deletion log
2709 * @param bool $suppress Suppress all revisions and log the deletion in
2710 * the suppression log instead of the deletion log
2711 * @param int $u1 Unused
2712 * @param bool $u2 Unused
2713 * @param array|string &$error Array of errors to append to
2714 * @param User $user The deleting user
2715 * @return bool True if successful
2717 public function doDeleteArticle(
2718 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null
2720 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2721 return $status->isGood();
2725 * Back-end article deletion
2726 * Deletes the article with database consistency, writes logs, purges caches
2730 * @param string $reason Delete reason for deletion log
2731 * @param bool $suppress Suppress all revisions and log the deletion in
2732 * the suppression log instead of the deletion log
2733 * @param int $u1 Unused
2734 * @param bool $u2 Unused
2735 * @param array|string &$error Array of errors to append to
2736 * @param User $user The deleting user
2737 * @param array $tags Tags to apply to the deletion action
2738 * @return Status Status object; if successful, $status->value is the log_id of the
2739 * deletion log entry. If the page couldn't be deleted because it wasn't
2740 * found, $status is a non-fatal 'cannotdelete' error
2742 public function doDeleteArticleReal(
2743 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null,
2744 $tags = [], $logsubtype = 'delete'
2746 global $wgUser, $wgContentHandlerUseDB, $wgCommentTableSchemaMigrationStage;
2748 wfDebug( __METHOD__
. "\n" );
2750 $status = Status
::newGood();
2752 if ( $this->mTitle
->getDBkey() === '' ) {
2753 $status->error( 'cannotdelete',
2754 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2758 // Avoid PHP 7.1 warning of passing $this by reference
2761 $user = is_null( $user ) ?
$wgUser : $user;
2762 if ( !Hooks
::run( 'ArticleDelete',
2763 [ &$wikiPage, &$user, &$reason, &$error, &$status, $suppress ]
2765 if ( $status->isOK() ) {
2766 // Hook aborted but didn't set a fatal status
2767 $status->fatal( 'delete-hook-aborted' );
2772 $dbw = wfGetDB( DB_MASTER
);
2773 $dbw->startAtomic( __METHOD__
);
2775 $this->loadPageData( self
::READ_LATEST
);
2776 $id = $this->getId();
2777 // T98706: lock the page from various other updates but avoid using
2778 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2779 // the revisions queries (which also JOIN on user). Only lock the page
2780 // row and CAS check on page_latest to see if the trx snapshot matches.
2781 $lockedLatest = $this->lockAndGetLatest();
2782 if ( $id == 0 ||
$this->getLatest() != $lockedLatest ) {
2783 $dbw->endAtomic( __METHOD__
);
2784 // Page not there or trx snapshot is stale
2785 $status->error( 'cannotdelete',
2786 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2790 // Given the lock above, we can be confident in the title and page ID values
2791 $namespace = $this->getTitle()->getNamespace();
2792 $dbKey = $this->getTitle()->getDBkey();
2794 // At this point we are now comitted to returning an OK
2795 // status unless some DB query error or other exception comes up.
2796 // This way callers don't have to call rollback() if $status is bad
2797 // unless they actually try to catch exceptions (which is rare).
2799 // we need to remember the old content so we can use it to generate all deletion updates.
2800 $revision = $this->getRevision();
2802 $content = $this->getContent( Revision
::RAW
);
2803 } catch ( Exception
$ex ) {
2804 wfLogWarning( __METHOD__
. ': failed to load content during deletion! '
2805 . $ex->getMessage() );
2810 $revCommentStore = new CommentStore( 'rev_comment' );
2811 $arCommentStore = new CommentStore( 'ar_comment' );
2813 $fields = Revision
::selectFields();
2816 // Bitfields to further suppress the content
2818 $bitfield = Revision
::SUPPRESSED_ALL
;
2819 $fields = array_diff( $fields, [ 'rev_deleted' ] );
2822 // For now, shunt the revision data into the archive table.
2823 // Text is *not* removed from the text table; bulk storage
2824 // is left intact to avoid breaking block-compression or
2825 // immutable storage schemes.
2826 // In the future, we may keep revisions and mark them with
2827 // the rev_deleted field, which is reserved for this purpose.
2829 // Get all of the page revisions
2830 $commentQuery = $revCommentStore->getJoin();
2831 $res = $dbw->select(
2832 [ 'revision' ] +
$commentQuery['tables'],
2833 $fields +
$commentQuery['fields'],
2834 [ 'rev_page' => $id ],
2837 $commentQuery['joins']
2839 // Build their equivalent archive rows
2842 foreach ( $res as $row ) {
2843 $comment = $revCommentStore->getComment( $row );
2845 'ar_namespace' => $namespace,
2846 'ar_title' => $dbKey,
2847 'ar_user' => $row->rev_user
,
2848 'ar_user_text' => $row->rev_user_text
,
2849 'ar_timestamp' => $row->rev_timestamp
,
2850 'ar_minor_edit' => $row->rev_minor_edit
,
2851 'ar_rev_id' => $row->rev_id
,
2852 'ar_parent_id' => $row->rev_parent_id
,
2853 'ar_text_id' => $row->rev_text_id
,
2856 'ar_len' => $row->rev_len
,
2857 'ar_page_id' => $id,
2858 'ar_deleted' => $suppress ?
$bitfield : $row->rev_deleted
,
2859 'ar_sha1' => $row->rev_sha1
,
2860 ] +
$arCommentStore->insert( $dbw, $comment );
2861 if ( $wgContentHandlerUseDB ) {
2862 $rowInsert['ar_content_model'] = $row->rev_content_model
;
2863 $rowInsert['ar_content_format'] = $row->rev_content_format
;
2865 $rowsInsert[] = $rowInsert;
2866 $revids[] = $row->rev_id
;
2868 // Copy them into the archive table
2869 $dbw->insert( 'archive', $rowsInsert, __METHOD__
);
2870 // Save this so we can pass it to the ArticleDeleteComplete hook.
2871 $archivedRevisionCount = $dbw->affectedRows();
2873 // Clone the title and wikiPage, so we have the information we need when
2874 // we log and run the ArticleDeleteComplete hook.
2875 $logTitle = clone $this->mTitle
;
2876 $wikiPageBeforeDelete = clone $this;
2878 // Now that it's safely backed up, delete it
2879 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__
);
2880 $dbw->delete( 'revision', [ 'rev_page' => $id ], __METHOD__
);
2881 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD
) {
2882 $dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__
);
2885 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2886 $logtype = $suppress ?
'suppress' : 'delete';
2888 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2889 $logEntry->setPerformer( $user );
2890 $logEntry->setTarget( $logTitle );
2891 $logEntry->setComment( $reason );
2892 $logEntry->setTags( $tags );
2893 $logid = $logEntry->insert();
2895 $dbw->onTransactionPreCommitOrIdle(
2896 function () use ( $dbw, $logEntry, $logid ) {
2897 // T58776: avoid deadlocks (especially from FileDeleteForm)
2898 $logEntry->publish( $logid );
2903 $dbw->endAtomic( __METHOD__
);
2905 $this->doDeleteUpdates( $id, $content, $revision );
2907 Hooks
::run( 'ArticleDeleteComplete', [
2908 &$wikiPageBeforeDelete,
2914 $archivedRevisionCount
2916 $status->value
= $logid;
2918 // Show log excerpt on 404 pages rather than just a link
2919 $cache = MediaWikiServices
::getInstance()->getMainObjectStash();
2920 $key = $cache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2921 $cache->set( $key, 1, $cache::TTL_DAY
);
2927 * Lock the page row for this title+id and return page_latest (or 0)
2929 * @return int Returns 0 if no row was found with this title+id
2932 public function lockAndGetLatest() {
2933 return (int)wfGetDB( DB_MASTER
)->selectField(
2937 'page_id' => $this->getId(),
2938 // Typically page_id is enough, but some code might try to do
2939 // updates assuming the title is the same, so verify that
2940 'page_namespace' => $this->getTitle()->getNamespace(),
2941 'page_title' => $this->getTitle()->getDBkey()
2949 * Do some database updates after deletion
2951 * @param int $id The page_id value of the page being deleted
2952 * @param Content|null $content Optional page content to be used when determining
2953 * the required updates. This may be needed because $this->getContent()
2954 * may already return null when the page proper was deleted.
2955 * @param Revision|null $revision The latest page revision
2957 public function doDeleteUpdates( $id, Content
$content = null, Revision
$revision = null ) {
2959 $countable = $this->isCountable();
2960 } catch ( Exception
$ex ) {
2961 // fallback for deleting broken pages for which we cannot load the content for
2962 // some reason. Note that doDeleteArticleReal() already logged this problem.
2966 // Update site status
2967 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$countable, -1 ) );
2969 // Delete pagelinks, update secondary indexes, etc
2970 $updates = $this->getDeletionUpdates( $content );
2971 foreach ( $updates as $update ) {
2972 DeferredUpdates
::addUpdate( $update );
2975 // Reparse any pages transcluding this page
2976 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'templatelinks' );
2978 // Reparse any pages including this image
2979 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
2980 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'imagelinks' );
2984 self
::onArticleDelete( $this->mTitle
);
2985 ResourceLoaderWikiModule
::invalidateModuleCache(
2986 $this->mTitle
, $revision, null, wfWikiID()
2989 // Reset this object and the Title object
2990 $this->loadFromRow( false, self
::READ_LATEST
);
2993 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
2997 * Roll back the most recent consecutive set of edits to a page
2998 * from the same user; fails if there are no eligible edits to
2999 * roll back to, e.g. user is the sole contributor. This function
3000 * performs permissions checks on $user, then calls commitRollback()
3001 * to do the dirty work
3003 * @todo Separate the business/permission stuff out from backend code
3004 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3006 * @param string $fromP Name of the user whose edits to rollback.
3007 * @param string $summary Custom summary. Set to default summary if empty.
3008 * @param string $token Rollback token.
3009 * @param bool $bot If true, mark all reverted edits as bot.
3011 * @param array &$resultDetails Array contains result-specific array of additional values
3012 * 'alreadyrolled' : 'current' (rev)
3013 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3015 * @param User $user The user performing the rollback
3016 * @param array|null $tags Change tags to apply to the rollback
3017 * Callers are responsible for permission checks
3018 * (with ChangeTags::canAddTagsAccompanyingChange)
3020 * @return array Array of errors, each error formatted as
3021 * array(messagekey, param1, param2, ...).
3022 * On success, the array is empty. This array can also be passed to
3023 * OutputPage::showPermissionsErrorPage().
3025 public function doRollback(
3026 $fromP, $summary, $token, $bot, &$resultDetails, User
$user, $tags = null
3028 $resultDetails = null;
3030 // Check permissions
3031 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
3032 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
3033 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3035 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3036 $errors[] = [ 'sessionfailure' ];
3039 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
3040 $errors[] = [ 'actionthrottledtext' ];
3043 // If there were errors, bail out now
3044 if ( !empty( $errors ) ) {
3048 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3052 * Backend implementation of doRollback(), please refer there for parameter
3053 * and return value documentation
3055 * NOTE: This function does NOT check ANY permissions, it just commits the
3056 * rollback to the DB. Therefore, you should only call this function direct-
3057 * ly if you want to use custom permissions checks. If you don't, use
3058 * doRollback() instead.
3059 * @param string $fromP Name of the user whose edits to rollback.
3060 * @param string $summary Custom summary. Set to default summary if empty.
3061 * @param bool $bot If true, mark all reverted edits as bot.
3063 * @param array &$resultDetails Contains result-specific array of additional values
3064 * @param User $guser The user performing the rollback
3065 * @param array|null $tags Change tags to apply to the rollback
3066 * Callers are responsible for permission checks
3067 * (with ChangeTags::canAddTagsAccompanyingChange)
3071 public function commitRollback( $fromP, $summary, $bot,
3072 &$resultDetails, User
$guser, $tags = null
3074 global $wgUseRCPatrol, $wgContLang;
3076 $dbw = wfGetDB( DB_MASTER
);
3078 if ( wfReadOnly() ) {
3079 return [ [ 'readonlytext' ] ];
3082 // Get the last editor
3083 $current = $this->getRevision();
3084 if ( is_null( $current ) ) {
3085 // Something wrong... no page?
3086 return [ [ 'notanarticle' ] ];
3089 $from = str_replace( '_', ' ', $fromP );
3090 // User name given should match up with the top revision.
3091 // If the user was deleted then $from should be empty.
3092 if ( $from != $current->getUserText() ) {
3093 $resultDetails = [ 'current' => $current ];
3094 return [ [ 'alreadyrolled',
3095 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3096 htmlspecialchars( $fromP ),
3097 htmlspecialchars( $current->getUserText() )
3101 // Get the last edit not by this person...
3102 // Note: these may not be public values
3103 $user = intval( $current->getUser( Revision
::RAW
) );
3104 $user_text = $dbw->addQuotes( $current->getUserText( Revision
::RAW
) );
3105 $s = $dbw->selectRow( 'revision',
3106 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3107 [ 'rev_page' => $current->getPage(),
3108 "rev_user != {$user} OR rev_user_text != {$user_text}"
3110 [ 'USE INDEX' => 'page_timestamp',
3111 'ORDER BY' => 'rev_timestamp DESC' ]
3113 if ( $s === false ) {
3114 // No one else ever edited this page
3115 return [ [ 'cantrollback' ] ];
3116 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT
3117 ||
$s->rev_deleted
& Revision
::DELETED_USER
3119 // Only admins can see this text
3120 return [ [ 'notvisiblerev' ] ];
3123 // Generate the edit summary if necessary
3124 $target = Revision
::newFromId( $s->rev_id
, Revision
::READ_LATEST
);
3125 if ( empty( $summary ) ) {
3126 if ( $from == '' ) { // no public user name
3127 $summary = wfMessage( 'revertpage-nouser' );
3129 $summary = wfMessage( 'revertpage' );
3133 // Allow the custom summary to use the same args as the default message
3135 $target->getUserText(), $from, $s->rev_id
,
3136 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3137 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3139 if ( $summary instanceof Message
) {
3140 $summary = $summary->params( $args )->inContentLanguage()->text();
3142 $summary = wfMsgReplaceArgs( $summary, $args );
3145 // Trim spaces on user supplied text
3146 $summary = trim( $summary );
3149 $flags = EDIT_UPDATE | EDIT_INTERNAL
;
3151 if ( $guser->isAllowed( 'minoredit' ) ) {
3152 $flags |
= EDIT_MINOR
;
3155 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3156 $flags |
= EDIT_FORCE_BOT
;
3159 $targetContent = $target->getContent();
3160 $changingContentModel = $targetContent->getModel() !== $current->getContentModel();
3162 // Actually store the edit
3163 $status = $this->doEditContent(
3173 // Set patrolling and bot flag on the edits, which gets rollbacked.
3174 // This is done even on edit failure to have patrolling in that case (T64157).
3176 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3177 // Mark all reverted edits as bot
3181 if ( $wgUseRCPatrol ) {
3182 // Mark all reverted edits as patrolled
3183 $set['rc_patrolled'] = 1;
3186 if ( count( $set ) ) {
3187 $dbw->update( 'recentchanges', $set,
3189 'rc_cur_id' => $current->getPage(),
3190 'rc_user_text' => $current->getUserText(),
3191 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3197 if ( !$status->isOK() ) {
3198 return $status->getErrorsArray();
3201 // raise error, when the edit is an edit without a new version
3202 $statusRev = isset( $status->value
['revision'] )
3203 ?
$status->value
['revision']
3205 if ( !( $statusRev instanceof Revision
) ) {
3206 $resultDetails = [ 'current' => $current ];
3207 return [ [ 'alreadyrolled',
3208 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3209 htmlspecialchars( $fromP ),
3210 htmlspecialchars( $current->getUserText() )
3214 if ( $changingContentModel ) {
3215 // If the content model changed during the rollback,
3216 // make sure it gets logged to Special:Log/contentmodel
3217 $log = new ManualLogEntry( 'contentmodel', 'change' );
3218 $log->setPerformer( $guser );
3219 $log->setTarget( $this->mTitle
);
3220 $log->setComment( $summary );
3221 $log->setParameters( [
3222 '4::oldmodel' => $current->getContentModel(),
3223 '5::newmodel' => $targetContent->getModel(),
3226 $logId = $log->insert( $dbw );
3227 $log->publish( $logId );
3230 $revId = $statusRev->getId();
3232 Hooks
::run( 'ArticleRollbackComplete', [ $this, $guser, $target, $current ] );
3235 'summary' => $summary,
3236 'current' => $current,
3237 'target' => $target,
3245 * The onArticle*() functions are supposed to be a kind of hooks
3246 * which should be called whenever any of the specified actions
3249 * This is a good place to put code to clear caches, for instance.
3251 * This is called on page move and undelete, as well as edit
3253 * @param Title $title
3255 public static function onArticleCreate( Title
$title ) {
3256 // Update existence markers on article/talk tabs...
3257 $other = $title->getOtherPage();
3259 $other->purgeSquid();
3261 $title->touchLinks();
3262 $title->purgeSquid();
3263 $title->deleteTitleProtection();
3265 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3267 // Invalidate caches of articles which include this page
3268 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3270 if ( $title->getNamespace() == NS_CATEGORY
) {
3271 // Load the Category object, which will schedule a job to create
3272 // the category table row if necessary. Checking a replica DB is ok
3273 // here, in the worst case it'll run an unnecessary recount job on
3274 // a category that probably doesn't have many members.
3275 Category
::newFromTitle( $title )->getID();
3280 * Clears caches when article is deleted
3282 * @param Title $title
3284 public static function onArticleDelete( Title
$title ) {
3285 // Update existence markers on article/talk tabs...
3286 $other = $title->getOtherPage();
3288 $other->purgeSquid();
3290 $title->touchLinks();
3291 $title->purgeSquid();
3293 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3296 HTMLFileCache
::clearFileCache( $title );
3297 InfoAction
::invalidateCache( $title );
3300 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3301 MessageCache
::singleton()->updateMessageOverride( $title, null );
3305 if ( $title->getNamespace() == NS_FILE
) {
3306 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'imagelinks' ) );
3310 if ( $title->getNamespace() == NS_USER_TALK
) {
3311 $user = User
::newFromName( $title->getText(), false );
3313 $user->setNewtalk( false );
3318 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3322 * Purge caches on page update etc
3324 * @param Title $title
3325 * @param Revision|null $revision Revision that was just saved, may be null
3327 public static function onArticleEdit( Title
$title, Revision
$revision = null ) {
3328 // Invalidate caches of articles which include this page
3329 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3331 // Invalidate the caches of all pages which redirect here
3332 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'redirect' ) );
3334 MediaWikiServices
::getInstance()->getLinkCache()->invalidateTitle( $title );
3336 // Purge CDN for this page only
3337 $title->purgeSquid();
3338 // Clear file cache for this page only
3339 HTMLFileCache
::clearFileCache( $title );
3341 $revid = $revision ?
$revision->getId() : null;
3342 DeferredUpdates
::addCallableUpdate( function () use ( $title, $revid ) {
3343 InfoAction
::invalidateCache( $title, $revid );
3350 * Returns a list of categories this page is a member of.
3351 * Results will include hidden categories
3353 * @return TitleArray
3355 public function getCategories() {
3356 $id = $this->getId();
3358 return TitleArray
::newFromResult( new FakeResultWrapper( [] ) );
3361 $dbr = wfGetDB( DB_REPLICA
);
3362 $res = $dbr->select( 'categorylinks',
3363 [ 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ],
3364 // Have to do that since Database::fieldNamesWithAlias treats numeric indexes
3365 // as not being aliases, and NS_CATEGORY is numeric
3366 [ 'cl_from' => $id ],
3369 return TitleArray
::newFromResult( $res );
3373 * Returns a list of hidden categories this page is a member of.
3374 * Uses the page_props and categorylinks tables.
3376 * @return array Array of Title objects
3378 public function getHiddenCategories() {
3380 $id = $this->getId();
3386 $dbr = wfGetDB( DB_REPLICA
);
3387 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3389 [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3390 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ],
3393 if ( $res !== false ) {
3394 foreach ( $res as $row ) {
3395 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3403 * Auto-generates a deletion reason
3405 * @param bool &$hasHistory Whether the page has a history
3406 * @return string|bool String containing deletion reason or empty string, or boolean false
3407 * if no revision occurred
3409 public function getAutoDeleteReason( &$hasHistory ) {
3410 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3414 * Update all the appropriate counts in the category table, given that
3415 * we've added the categories $added and deleted the categories $deleted.
3417 * This should only be called from deferred updates or jobs to avoid contention.
3419 * @param array $added The names of categories that were added
3420 * @param array $deleted The names of categories that were deleted
3421 * @param int $id Page ID (this should be the original deleted page ID)
3423 public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3424 $id = $id ?
: $this->getId();
3425 $ns = $this->getTitle()->getNamespace();
3427 $addFields = [ 'cat_pages = cat_pages + 1' ];
3428 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3429 if ( $ns == NS_CATEGORY
) {
3430 $addFields[] = 'cat_subcats = cat_subcats + 1';
3431 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3432 } elseif ( $ns == NS_FILE
) {
3433 $addFields[] = 'cat_files = cat_files + 1';
3434 $removeFields[] = 'cat_files = cat_files - 1';
3437 $dbw = wfGetDB( DB_MASTER
);
3439 if ( count( $added ) ) {
3440 $existingAdded = $dbw->selectFieldValues(
3443 [ 'cat_title' => $added ],
3447 // For category rows that already exist, do a plain
3448 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3449 // to avoid creating gaps in the cat_id sequence.
3450 if ( count( $existingAdded ) ) {
3454 [ 'cat_title' => $existingAdded ],
3459 $missingAdded = array_diff( $added, $existingAdded );
3460 if ( count( $missingAdded ) ) {
3462 foreach ( $missingAdded as $cat ) {
3464 'cat_title' => $cat,
3466 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3467 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3480 if ( count( $deleted ) ) {
3484 [ 'cat_title' => $deleted ],
3489 foreach ( $added as $catName ) {
3490 $cat = Category
::newFromName( $catName );
3491 Hooks
::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3494 foreach ( $deleted as $catName ) {
3495 $cat = Category
::newFromName( $catName );
3496 Hooks
::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3499 // Refresh counts on categories that should be empty now, to
3500 // trigger possible deletion. Check master for the most
3501 // up-to-date cat_pages.
3502 if ( count( $deleted ) ) {
3503 $rows = $dbw->select(
3505 [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
3506 [ 'cat_title' => $deleted, 'cat_pages <= 0' ],
3509 foreach ( $rows as $row ) {
3510 $cat = Category
::newFromRow( $row );
3511 // T166757: do the update after this DB commit
3512 DeferredUpdates
::addCallableUpdate( function () use ( $cat ) {
3513 $cat->refreshCounts();
3520 * Opportunistically enqueue link update jobs given fresh parser output if useful
3522 * @param ParserOutput $parserOutput Current version page output
3525 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3526 if ( wfReadOnly() ) {
3530 if ( !Hooks
::run( 'OpportunisticLinksUpdate',
3531 [ $this, $this->mTitle
, $parserOutput ]
3536 $config = RequestContext
::getMain()->getConfig();
3539 'isOpportunistic' => true,
3540 'rootJobTimestamp' => $parserOutput->getCacheTime()
3543 if ( $this->mTitle
->areRestrictionsCascading() ) {
3544 // If the page is cascade protecting, the links should really be up-to-date
3545 JobQueueGroup
::singleton()->lazyPush(
3546 RefreshLinksJob
::newPrioritized( $this->mTitle
, $params )
3548 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3549 // Assume the output contains "dynamic" time/random based magic words.
3550 // Only update pages that expired due to dynamic content and NOT due to edits
3551 // to referenced templates/files. When the cache expires due to dynamic content,
3552 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3553 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3554 // template/file edit already triggered recursive RefreshLinksJob jobs.
3555 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3556 // If a page is uncacheable, do not keep spamming a job for it.
3557 // Although it would be de-duplicated, it would still waste I/O.
3558 $cache = ObjectCache
::getLocalClusterInstance();
3559 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3560 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3561 if ( $cache->add( $key, time(), $ttl ) ) {
3562 JobQueueGroup
::singleton()->lazyPush(
3563 RefreshLinksJob
::newDynamic( $this->mTitle
, $params )
3571 * Returns a list of updates to be performed when this page is deleted. The
3572 * updates should remove any information about this page from secondary data
3573 * stores such as links tables.
3575 * @param Content|null $content Optional Content object for determining the
3576 * necessary updates.
3577 * @return DeferrableUpdate[]
3579 public function getDeletionUpdates( Content
$content = null ) {
3581 // load content object, which may be used to determine the necessary updates.
3582 // XXX: the content may not be needed to determine the updates.
3584 $content = $this->getContent( Revision
::RAW
);
3585 } catch ( Exception
$ex ) {
3586 // If we can't load the content, something is wrong. Perhaps that's why
3587 // the user is trying to delete the page, so let's not fail in that case.
3588 // Note that doDeleteArticleReal() will already have logged an issue with
3589 // loading the content.
3596 $updates = $content->getDeletionUpdates( $this );
3599 Hooks
::run( 'WikiPageDeletionUpdates', [ $this, $content, &$updates ] );
3604 * Whether this content displayed on this page
3605 * comes from the local database
3610 public function isLocal() {
3615 * The display name for the site this content
3616 * come from. If a subclass overrides isLocal(),
3617 * this could return something other than the
3623 public function getWikiDisplayName() {
3629 * Get the source URL for the content on this page,
3630 * typically the canonical URL, but may be a remote
3631 * link if the content comes from another site
3636 public function getSourceURL() {
3637 return $this->getTitle()->getCanonicalURL();
3641 * @param WANObjectCache $cache
3645 public function getMutableCacheKeys( WANObjectCache
$cache ) {
3646 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
3648 return $linkCache->getMutableCacheKeys( $cache, $this->getTitle()->getTitleValue() );