3 * Base representation for a MediaWiki page.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use \MediaWiki\Logger\LoggerFactory
;
26 * Class representing a MediaWiki article and history.
28 * Some fields are public only for backwards-compatibility. Use accessors.
29 * In the past, this class was part of Article.php and everything was public.
31 class WikiPage
implements Page
, IDBAccessObject
{
32 // Constants for $mDataLoadedFrom and related
37 public $mTitle = null;
42 public $mDataLoaded = false; // !< Boolean
43 public $mIsRedirect = false; // !< Boolean
44 public $mLatest = false; // !< Integer (false means "not loaded")
47 /** @var stdClass Map of cache fields (text, parser output, ect) for a proposed/new edit */
48 public $mPreparedEdit = false;
53 protected $mId = null;
56 * @var int One of the READ_* constants
58 protected $mDataLoadedFrom = self
::READ_NONE
;
63 protected $mRedirectTarget = null;
68 protected $mLastRevision = null;
71 * @var string Timestamp of the current revision or empty string if not loaded
73 protected $mTimestamp = '';
78 protected $mTouched = '19700101000000';
83 protected $mLinksUpdated = '19700101000000';
86 * Constructor and clear the article
87 * @param Title $title Reference to a Title object.
89 public function __construct( Title
$title ) {
90 $this->mTitle
= $title;
94 * Create a WikiPage object of the appropriate class for the given title.
99 * @return WikiPage|WikiCategoryPage|WikiFilePage
101 public static function factory( Title
$title ) {
102 $ns = $title->getNamespace();
104 if ( $ns == NS_MEDIA
) {
105 throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
106 } elseif ( $ns < 0 ) {
107 throw new MWException( "Invalid or virtual namespace $ns given." );
112 $page = new WikiFilePage( $title );
115 $page = new WikiCategoryPage( $title );
118 $page = new WikiPage( $title );
125 * Constructor from a page id
127 * @param int $id Article ID to load
128 * @param string|int $from One of the following values:
129 * - "fromdb" or WikiPage::READ_NORMAL to select from a slave database
130 * - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
132 * @return WikiPage|null
134 public static function newFromID( $id, $from = 'fromdb' ) {
135 // page id's are never 0 or negative, see bug 61166
140 $from = self
::convertSelectType( $from );
141 $db = wfGetDB( $from === self
::READ_LATEST ? DB_MASTER
: DB_SLAVE
);
142 $row = $db->selectRow(
143 'page', self
::selectFields(), [ 'page_id' => $id ], __METHOD__
);
147 return self
::newFromRow( $row, $from );
151 * Constructor from a database row
154 * @param object $row Database row containing at least fields returned by selectFields().
155 * @param string|int $from Source of $data:
156 * - "fromdb" or WikiPage::READ_NORMAL: from a slave DB
157 * - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
158 * - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
161 public static function newFromRow( $row, $from = 'fromdb' ) {
162 $page = self
::factory( Title
::newFromRow( $row ) );
163 $page->loadFromRow( $row, $from );
168 * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
170 * @param object|string|int $type
173 private static function convertSelectType( $type ) {
176 return self
::READ_NORMAL
;
178 return self
::READ_LATEST
;
180 return self
::READ_LOCKING
;
182 // It may already be an integer or whatever else
188 * @todo Move this UI stuff somewhere else
190 * @see ContentHandler::getActionOverrides
192 public function getActionOverrides() {
193 return $this->getContentHandler()->getActionOverrides();
197 * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
199 * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
201 * @return ContentHandler
205 public function getContentHandler() {
206 return ContentHandler
::getForModelID( $this->getContentModel() );
210 * Get the title object of the article
211 * @return Title Title object of this page
213 public function getTitle() {
214 return $this->mTitle
;
221 public function clear() {
222 $this->mDataLoaded
= false;
223 $this->mDataLoadedFrom
= self
::READ_NONE
;
225 $this->clearCacheFields();
229 * Clear the object cache fields
232 protected function clearCacheFields() {
234 $this->mRedirectTarget
= null; // Title object if set
235 $this->mLastRevision
= null; // Latest revision
236 $this->mTouched
= '19700101000000';
237 $this->mLinksUpdated
= '19700101000000';
238 $this->mTimestamp
= '';
239 $this->mIsRedirect
= false;
240 $this->mLatest
= false;
241 // Bug 57026: do not clear mPreparedEdit since prepareTextForEdit() already checks
242 // the requested rev ID and content against the cached one for equality. For most
243 // content types, the output should not change during the lifetime of this cache.
244 // Clearing it can cause extra parses on edit for no reason.
248 * Clear the mPreparedEdit cache field, as may be needed by mutable content types
252 public function clearPreparedEdit() {
253 $this->mPreparedEdit
= false;
257 * Return the list of revision fields that should be selected to create
262 public static function selectFields() {
263 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
274 'page_links_updated',
279 if ( $wgContentHandlerUseDB ) {
280 $fields[] = 'page_content_model';
283 if ( $wgPageLanguageUseDB ) {
284 $fields[] = 'page_lang';
291 * Fetch a page record with the given conditions
292 * @param IDatabase $dbr
293 * @param array $conditions
294 * @param array $options
295 * @return object|bool Database result resource, or false on failure
297 protected function pageData( $dbr, $conditions, $options = [] ) {
298 $fields = self
::selectFields();
300 Hooks
::run( 'ArticlePageDataBefore', [ &$this, &$fields ] );
302 $row = $dbr->selectRow( 'page', $fields, $conditions, __METHOD__
, $options );
304 Hooks
::run( 'ArticlePageDataAfter', [ &$this, &$row ] );
310 * Fetch a page record matching the Title object's namespace and title
311 * using a sanitized title string
313 * @param IDatabase $dbr
314 * @param Title $title
315 * @param array $options
316 * @return object|bool Database result resource, or false on failure
318 public function pageDataFromTitle( $dbr, $title, $options = [] ) {
319 return $this->pageData( $dbr, [
320 'page_namespace' => $title->getNamespace(),
321 'page_title' => $title->getDBkey() ], $options );
325 * Fetch a page record matching the requested ID
327 * @param IDatabase $dbr
329 * @param array $options
330 * @return object|bool Database result resource, or false on failure
332 public function pageDataFromId( $dbr, $id, $options = [] ) {
333 return $this->pageData( $dbr, [ 'page_id' => $id ], $options );
337 * Load the object from a given source by title
339 * @param object|string|int $from One of the following:
340 * - A DB query result object.
341 * - "fromdb" or WikiPage::READ_NORMAL to get from a slave DB.
342 * - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
343 * - "forupdate" or WikiPage::READ_LOCKING to get from the master DB
344 * using SELECT FOR UPDATE.
348 public function loadPageData( $from = 'fromdb' ) {
349 $from = self
::convertSelectType( $from );
350 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom
) {
351 // We already have the data from the correct location, no need to load it twice.
355 if ( is_int( $from ) ) {
356 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
357 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
360 && $index == DB_SLAVE
361 && wfGetLB()->getServerCount() > 1
362 && wfGetLB()->hasOrMadeRecentMasterChanges()
364 $from = self
::READ_LATEST
;
365 list( $index, $opts ) = DBAccessObjectUtils
::getDBOptions( $from );
366 $data = $this->pageDataFromTitle( wfGetDB( $index ), $this->mTitle
, $opts );
369 // No idea from where the caller got this data, assume slave database.
371 $from = self
::READ_NORMAL
;
374 $this->loadFromRow( $data, $from );
378 * Load the object from a database row
381 * @param object|bool $data DB row containing fields returned by selectFields() or false
382 * @param string|int $from One of the following:
383 * - "fromdb" or WikiPage::READ_NORMAL if the data comes from a slave DB
384 * - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
385 * - "forupdate" or WikiPage::READ_LOCKING if the data comes from
386 * the master DB using SELECT FOR UPDATE
388 public function loadFromRow( $data, $from ) {
389 $lc = LinkCache
::singleton();
390 $lc->clearLink( $this->mTitle
);
393 $lc->addGoodLinkObjFromRow( $this->mTitle
, $data );
395 $this->mTitle
->loadFromRow( $data );
397 // Old-fashioned restrictions
398 $this->mTitle
->loadRestrictions( $data->page_restrictions
);
400 $this->mId
= intval( $data->page_id
);
401 $this->mTouched
= wfTimestamp( TS_MW
, $data->page_touched
);
402 $this->mLinksUpdated
= wfTimestampOrNull( TS_MW
, $data->page_links_updated
);
403 $this->mIsRedirect
= intval( $data->page_is_redirect
);
404 $this->mLatest
= intval( $data->page_latest
);
405 // Bug 37225: $latest may no longer match the cached latest Revision object.
406 // Double-check the ID of any cached latest Revision object for consistency.
407 if ( $this->mLastRevision
&& $this->mLastRevision
->getId() != $this->mLatest
) {
408 $this->mLastRevision
= null;
409 $this->mTimestamp
= '';
412 $lc->addBadLinkObj( $this->mTitle
);
414 $this->mTitle
->loadFromRow( false );
416 $this->clearCacheFields();
421 $this->mDataLoaded
= true;
422 $this->mDataLoadedFrom
= self
::convertSelectType( $from );
426 * @return int Page ID
428 public function getId() {
429 if ( !$this->mDataLoaded
) {
430 $this->loadPageData();
436 * @return bool Whether or not the page exists in the database
438 public function exists() {
439 if ( !$this->mDataLoaded
) {
440 $this->loadPageData();
442 return $this->mId
> 0;
446 * Check if this page is something we're going to be showing
447 * some sort of sensible content for. If we return false, page
448 * views (plain action=view) will return an HTTP 404 response,
449 * so spiders and robots can know they're following a bad link.
453 public function hasViewableContent() {
454 return $this->exists() ||
$this->mTitle
->isAlwaysKnown();
458 * Tests if the article content represents a redirect
462 public function isRedirect() {
463 if ( !$this->mDataLoaded
) {
464 $this->loadPageData();
467 return (bool)$this->mIsRedirect
;
471 * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
473 * Will use the revisions actual content model if the page exists,
474 * and the page's default if the page doesn't exist yet.
480 public function getContentModel() {
481 if ( $this->exists() ) {
482 // look at the revision's actual content model
483 $rev = $this->getRevision();
485 if ( $rev !== null ) {
486 return $rev->getContentModel();
488 $title = $this->mTitle
->getPrefixedDBkey();
489 wfWarn( "Page $title exists but has no (visible) revisions!" );
493 // use the default model for this page
494 return $this->mTitle
->getContentModel();
498 * Loads page_touched and returns a value indicating if it should be used
499 * @return bool True if not a redirect
501 public function checkTouched() {
502 if ( !$this->mDataLoaded
) {
503 $this->loadPageData();
505 return !$this->mIsRedirect
;
509 * Get the page_touched field
510 * @return string Containing GMT timestamp
512 public function getTouched() {
513 if ( !$this->mDataLoaded
) {
514 $this->loadPageData();
516 return $this->mTouched
;
520 * Get the page_links_updated field
521 * @return string|null Containing GMT timestamp
523 public function getLinksTimestamp() {
524 if ( !$this->mDataLoaded
) {
525 $this->loadPageData();
527 return $this->mLinksUpdated
;
531 * Get the page_latest field
532 * @return int The rev_id of current revision
534 public function getLatest() {
535 if ( !$this->mDataLoaded
) {
536 $this->loadPageData();
538 return (int)$this->mLatest
;
542 * Get the Revision object of the oldest revision
543 * @return Revision|null
545 public function getOldestRevision() {
547 // Try using the slave database first, then try the master
549 $db = wfGetDB( DB_SLAVE
);
550 $revSelectFields = Revision
::selectFields();
553 while ( $continue ) {
554 $row = $db->selectRow(
555 [ 'page', 'revision' ],
558 'page_namespace' => $this->mTitle
->getNamespace(),
559 'page_title' => $this->mTitle
->getDBkey(),
564 'ORDER BY' => 'rev_timestamp ASC'
571 $db = wfGetDB( DB_MASTER
);
576 return $row ? Revision
::newFromRow( $row ) : null;
580 * Loads everything except the text
581 * This isn't necessary for all uses, so it's only done if needed.
583 protected function loadLastEdit() {
584 if ( $this->mLastRevision
!== null ) {
585 return; // already loaded
588 $latest = $this->getLatest();
590 return; // page doesn't exist or is missing page_latest info
593 if ( $this->mDataLoadedFrom
== self
::READ_LOCKING
) {
594 // Bug 37225: if session S1 loads the page row FOR UPDATE, the result always
595 // includes the latest changes committed. This is true even within REPEATABLE-READ
596 // transactions, where S1 normally only sees changes committed before the first S1
597 // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
598 // may not find it since a page row UPDATE and revision row INSERT by S2 may have
599 // happened after the first S1 SELECT.
600 // http://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read
601 $flags = Revision
::READ_LOCKING
;
602 } elseif ( $this->mDataLoadedFrom
== self
::READ_LATEST
) {
603 // Bug T93976: if page_latest was loaded from the master, fetch the
604 // revision from there as well, as it may not exist yet on a slave DB.
605 // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
606 $flags = Revision
::READ_LATEST
;
610 $revision = Revision
::newFromPageId( $this->getId(), $latest, $flags );
611 if ( $revision ) { // sanity
612 $this->setLastEdit( $revision );
617 * Set the latest revision
618 * @param Revision $revision
620 protected function setLastEdit( Revision
$revision ) {
621 $this->mLastRevision
= $revision;
622 $this->mTimestamp
= $revision->getTimestamp();
626 * Get the latest revision
627 * @return Revision|null
629 public function getRevision() {
630 $this->loadLastEdit();
631 if ( $this->mLastRevision
) {
632 return $this->mLastRevision
;
638 * Get the content of the current revision. No side-effects...
640 * @param int $audience One of:
641 * Revision::FOR_PUBLIC to be displayed to all users
642 * Revision::FOR_THIS_USER to be displayed to $wgUser
643 * Revision::RAW get the text regardless of permissions
644 * @param User $user User object to check for, only if FOR_THIS_USER is passed
645 * to the $audience parameter
646 * @return Content|null The content of the current revision
650 public function getContent( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
651 $this->loadLastEdit();
652 if ( $this->mLastRevision
) {
653 return $this->mLastRevision
->getContent( $audience, $user );
659 * Get the text of the current revision. No side-effects...
661 * @param int $audience One of:
662 * Revision::FOR_PUBLIC to be displayed to all users
663 * Revision::FOR_THIS_USER to be displayed to the given user
664 * Revision::RAW get the text regardless of permissions
665 * @param User $user User object to check for, only if FOR_THIS_USER is passed
666 * to the $audience parameter
667 * @return string|bool The text of the current revision
668 * @deprecated since 1.21, getContent() should be used instead.
670 public function getText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
671 ContentHandler
::deprecated( __METHOD__
, '1.21' );
673 $this->loadLastEdit();
674 if ( $this->mLastRevision
) {
675 return $this->mLastRevision
->getText( $audience, $user );
681 * @return string MW timestamp of last article revision
683 public function getTimestamp() {
684 // Check if the field has been filled by WikiPage::setTimestamp()
685 if ( !$this->mTimestamp
) {
686 $this->loadLastEdit();
689 return wfTimestamp( TS_MW
, $this->mTimestamp
);
693 * Set the page timestamp (use only to avoid DB queries)
694 * @param string $ts MW timestamp of last article revision
697 public function setTimestamp( $ts ) {
698 $this->mTimestamp
= wfTimestamp( TS_MW
, $ts );
702 * @param int $audience One of:
703 * Revision::FOR_PUBLIC to be displayed to all users
704 * Revision::FOR_THIS_USER to be displayed to the given user
705 * Revision::RAW get the text regardless of permissions
706 * @param User $user User object to check for, only if FOR_THIS_USER is passed
707 * to the $audience parameter
708 * @return int User ID for the user that made the last article revision
710 public function getUser( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
711 $this->loadLastEdit();
712 if ( $this->mLastRevision
) {
713 return $this->mLastRevision
->getUser( $audience, $user );
720 * Get the User object of the user who created the page
721 * @param int $audience One of:
722 * Revision::FOR_PUBLIC to be displayed to all users
723 * Revision::FOR_THIS_USER to be displayed to the given user
724 * Revision::RAW get the text regardless of permissions
725 * @param User $user User object to check for, only if FOR_THIS_USER is passed
726 * to the $audience parameter
729 public function getCreator( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
730 $revision = $this->getOldestRevision();
732 $userName = $revision->getUserText( $audience, $user );
733 return User
::newFromName( $userName, false );
740 * @param int $audience One of:
741 * Revision::FOR_PUBLIC to be displayed to all users
742 * Revision::FOR_THIS_USER to be displayed to the given user
743 * Revision::RAW get the text regardless of permissions
744 * @param User $user User object to check for, only if FOR_THIS_USER is passed
745 * to the $audience parameter
746 * @return string Username of the user that made the last article revision
748 public function getUserText( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
749 $this->loadLastEdit();
750 if ( $this->mLastRevision
) {
751 return $this->mLastRevision
->getUserText( $audience, $user );
758 * @param int $audience One of:
759 * Revision::FOR_PUBLIC to be displayed to all users
760 * Revision::FOR_THIS_USER to be displayed to the given user
761 * Revision::RAW get the text regardless of permissions
762 * @param User $user User object to check for, only if FOR_THIS_USER is passed
763 * to the $audience parameter
764 * @return string Comment stored for the last article revision
766 public function getComment( $audience = Revision
::FOR_PUBLIC
, User
$user = null ) {
767 $this->loadLastEdit();
768 if ( $this->mLastRevision
) {
769 return $this->mLastRevision
->getComment( $audience, $user );
776 * Returns true if last revision was marked as "minor edit"
778 * @return bool Minor edit indicator for the last article revision.
780 public function getMinorEdit() {
781 $this->loadLastEdit();
782 if ( $this->mLastRevision
) {
783 return $this->mLastRevision
->isMinor();
790 * Determine whether a page would be suitable for being counted as an
791 * article in the site_stats table based on the title & its content
793 * @param object|bool $editInfo (false): object returned by prepareTextForEdit(),
794 * if false, the current database state will be used
797 public function isCountable( $editInfo = false ) {
798 global $wgArticleCountMethod;
800 if ( !$this->mTitle
->isContentPage() ) {
805 $content = $editInfo->pstContent
;
807 $content = $this->getContent();
810 if ( !$content ||
$content->isRedirect() ) {
816 if ( $wgArticleCountMethod === 'link' ) {
817 // nasty special case to avoid re-parsing to detect links
820 // ParserOutput::getLinks() is a 2D array of page links, so
821 // to be really correct we would need to recurse in the array
822 // but the main array should only have items in it if there are
824 $hasLinks = (bool)count( $editInfo->output
->getLinks() );
826 $hasLinks = (bool)wfGetDB( DB_SLAVE
)->selectField( 'pagelinks', 1,
827 [ 'pl_from' => $this->getId() ], __METHOD__
);
831 return $content->isCountable( $hasLinks );
835 * If this page is a redirect, get its target
837 * The target will be fetched from the redirect table if possible.
838 * If this page doesn't have an entry there, call insertRedirect()
839 * @return Title|null Title object, or null if this page is not a redirect
841 public function getRedirectTarget() {
842 if ( !$this->mTitle
->isRedirect() ) {
846 if ( $this->mRedirectTarget
!== null ) {
847 return $this->mRedirectTarget
;
850 // Query the redirect table
851 $dbr = wfGetDB( DB_SLAVE
);
852 $row = $dbr->selectRow( 'redirect',
853 [ 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ],
854 [ 'rd_from' => $this->getId() ],
858 // rd_fragment and rd_interwiki were added later, populate them if empty
859 if ( $row && !is_null( $row->rd_fragment
) && !is_null( $row->rd_interwiki
) ) {
860 $this->mRedirectTarget
= Title
::makeTitle(
861 $row->rd_namespace
, $row->rd_title
,
862 $row->rd_fragment
, $row->rd_interwiki
864 return $this->mRedirectTarget
;
867 // This page doesn't have an entry in the redirect table
868 $this->mRedirectTarget
= $this->insertRedirect();
869 return $this->mRedirectTarget
;
873 * Insert an entry for this page into the redirect table if the content is a redirect
875 * The database update will be deferred via DeferredUpdates
877 * Don't call this function directly unless you know what you're doing.
878 * @return Title|null Title object or null if not a redirect
880 public function insertRedirect() {
881 $content = $this->getContent();
882 $retval = $content ?
$content->getUltimateRedirectTarget() : null;
887 // Update the DB post-send if the page has not cached since now
889 $latest = $this->getLatest();
890 DeferredUpdates
::addCallableUpdate( function() use ( $that, $retval, $latest ) {
891 $that->insertRedirectEntry( $retval, $latest );
898 * Insert or update the redirect table entry for this page to indicate it redirects to $rt
899 * @param Title $rt Redirect target
900 * @param int|null $oldLatest Prior page_latest for check and set
902 public function insertRedirectEntry( Title
$rt, $oldLatest = null ) {
903 $dbw = wfGetDB( DB_MASTER
);
904 $dbw->startAtomic( __METHOD__
);
906 if ( !$oldLatest ||
$oldLatest == $this->lockAndGetLatest() ) {
907 $dbw->replace( 'redirect',
910 'rd_from' => $this->getId(),
911 'rd_namespace' => $rt->getNamespace(),
912 'rd_title' => $rt->getDBkey(),
913 'rd_fragment' => $rt->getFragment(),
914 'rd_interwiki' => $rt->getInterwiki(),
920 $dbw->endAtomic( __METHOD__
);
924 * Get the Title object or URL this page redirects to
926 * @return bool|Title|string False, Title of in-wiki target, or string with URL
928 public function followRedirect() {
929 return $this->getRedirectURL( $this->getRedirectTarget() );
933 * Get the Title object or URL to use for a redirect. We use Title
934 * objects for same-wiki, non-special redirects and URLs for everything
936 * @param Title $rt Redirect target
937 * @return bool|Title|string False, Title object of local target, or string with URL
939 public function getRedirectURL( $rt ) {
944 if ( $rt->isExternal() ) {
945 if ( $rt->isLocal() ) {
946 // Offsite wikis need an HTTP redirect.
947 // This can be hard to reverse and may produce loops,
948 // so they may be disabled in the site configuration.
949 $source = $this->mTitle
->getFullURL( 'redirect=no' );
950 return $rt->getFullURL( [ 'rdfrom' => $source ] );
952 // External pages without "local" bit set are not valid
958 if ( $rt->isSpecialPage() ) {
959 // Gotta handle redirects to special pages differently:
960 // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
961 // Some pages are not valid targets.
962 if ( $rt->isValidRedirectTarget() ) {
963 return $rt->getFullURL();
973 * Get a list of users who have edited this article, not including the user who made
974 * the most recent revision, which you can get from $article->getUser() if you want it
975 * @return UserArrayFromResult
977 public function getContributors() {
978 // @todo FIXME: This is expensive; cache this info somewhere.
980 $dbr = wfGetDB( DB_SLAVE
);
982 if ( $dbr->implicitGroupby() ) {
983 $realNameField = 'user_real_name';
985 $realNameField = 'MIN(user_real_name) AS user_real_name';
988 $tables = [ 'revision', 'user' ];
991 'user_id' => 'rev_user',
992 'user_name' => 'rev_user_text',
994 'timestamp' => 'MAX(rev_timestamp)',
997 $conds = [ 'rev_page' => $this->getId() ];
999 // The user who made the top revision gets credited as "this page was last edited by
1000 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1001 $user = $this->getUser();
1003 $conds[] = "rev_user != $user";
1005 $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1009 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1012 'user' => [ 'LEFT JOIN', 'rev_user = user_id' ],
1016 'GROUP BY' => [ 'rev_user', 'rev_user_text' ],
1017 'ORDER BY' => 'timestamp DESC',
1020 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $jconds );
1021 return new UserArrayFromResult( $res );
1025 * Should the parser cache be used?
1027 * @param ParserOptions $parserOptions ParserOptions to check
1031 public function shouldCheckParserCache( ParserOptions
$parserOptions, $oldId ) {
1032 return $parserOptions->getStubThreshold() == 0
1034 && ( $oldId === null ||
$oldId === 0 ||
$oldId === $this->getLatest() )
1035 && $this->getContentHandler()->isParserCacheSupported();
1039 * Get a ParserOutput for the given ParserOptions and revision ID.
1041 * The parser cache will be used if possible. Cache misses that result
1042 * in parser runs are debounced with PoolCounter.
1045 * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1046 * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1047 * get the current revision (default value)
1049 * @return ParserOutput|bool ParserOutput or false if the revision was not found
1051 public function getParserOutput( ParserOptions
$parserOptions, $oldid = null ) {
1053 $useParserCache = $this->shouldCheckParserCache( $parserOptions, $oldid );
1054 wfDebug( __METHOD__
.
1055 ': using parser cache: ' . ( $useParserCache ?
'yes' : 'no' ) . "\n" );
1056 if ( $parserOptions->getStubThreshold() ) {
1057 wfIncrStats( 'pcache.miss.stub' );
1060 if ( $useParserCache ) {
1061 $parserOutput = ParserCache
::singleton()->get( $this, $parserOptions );
1062 if ( $parserOutput !== false ) {
1063 return $parserOutput;
1067 if ( $oldid === null ||
$oldid === 0 ) {
1068 $oldid = $this->getLatest();
1071 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1074 return $pool->getParserOutput();
1078 * Do standard deferred updates after page view (existing or missing page)
1079 * @param User $user The relevant user
1080 * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1082 public function doViewUpdates( User
$user, $oldid = 0 ) {
1083 if ( wfReadOnly() ) {
1087 Hooks
::run( 'PageViewUpdates', [ $this, $user ] );
1088 // Update newtalk / watchlist notification status
1090 $user->clearNotification( $this->mTitle
, $oldid );
1091 } catch ( DBError
$e ) {
1092 // Avoid outage if the master is not reachable
1093 MWExceptionHandler
::logException( $e );
1098 * Perform the actions of a page purging
1101 public function doPurge() {
1102 if ( !Hooks
::run( 'ArticlePurge', [ &$this ] ) ) {
1106 $this->mTitle
->invalidateCache();
1107 // Send purge after above page_touched update was committed
1108 DeferredUpdates
::addUpdate(
1109 new CdnCacheUpdate( $this->mTitle
->getCdnUrls() ),
1110 DeferredUpdates
::PRESEND
1113 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
1114 // @todo move this logic to MessageCache
1115 if ( $this->exists() ) {
1116 // NOTE: use transclusion text for messages.
1117 // This is consistent with MessageCache::getMsgFromNamespace()
1119 $content = $this->getContent();
1120 $text = $content === null ?
null : $content->getWikitextForTransclusion();
1122 if ( $text === null ) {
1129 MessageCache
::singleton()->replace( $this->mTitle
->getDBkey(), $text );
1136 * Insert a new empty page record for this article.
1137 * This *must* be followed up by creating a revision
1138 * and running $this->updateRevisionOn( ... );
1139 * or else the record will be left in a funky state.
1140 * Best if all done inside a transaction.
1142 * @param IDatabase $dbw
1143 * @param int|null $pageId Custom page ID that will be used for the insert statement
1145 * @return bool|int The newly created page_id key; false if the title already existed
1147 public function insertOn( $dbw, $pageId = null ) {
1148 $pageIdForInsert = $pageId ?
: $dbw->nextSequenceValue( 'page_page_id_seq' );
1152 'page_id' => $pageIdForInsert,
1153 'page_namespace' => $this->mTitle
->getNamespace(),
1154 'page_title' => $this->mTitle
->getDBkey(),
1155 'page_restrictions' => '',
1156 'page_is_redirect' => 0, // Will set this shortly...
1158 'page_random' => wfRandom(),
1159 'page_touched' => $dbw->timestamp(),
1160 'page_latest' => 0, // Fill this in shortly...
1161 'page_len' => 0, // Fill this in shortly...
1167 if ( $dbw->affectedRows() > 0 ) {
1168 $newid = $pageId ?
: $dbw->insertId();
1169 $this->mId
= $newid;
1170 $this->mTitle
->resetArticleID( $newid );
1174 return false; // nothing changed
1179 * Update the page record to point to a newly saved revision.
1181 * @param IDatabase $dbw
1182 * @param Revision $revision For ID number, and text used to set
1183 * length and redirect status fields
1184 * @param int $lastRevision If given, will not overwrite the page field
1185 * when different from the currently set value.
1186 * Giving 0 indicates the new page flag should be set on.
1187 * @param bool $lastRevIsRedirect If given, will optimize adding and
1188 * removing rows in redirect table.
1189 * @return bool Success; false if the page row was missing or page_latest changed
1191 public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1192 $lastRevIsRedirect = null
1194 global $wgContentHandlerUseDB;
1196 // Assertion to try to catch T92046
1197 if ( (int)$revision->getId() === 0 ) {
1198 throw new InvalidArgumentException(
1199 __METHOD__
. ': Revision has ID ' . var_export( $revision->getId(), 1 )
1203 $content = $revision->getContent();
1204 $len = $content ?
$content->getSize() : 0;
1205 $rt = $content ?
$content->getUltimateRedirectTarget() : null;
1207 $conditions = [ 'page_id' => $this->getId() ];
1209 if ( !is_null( $lastRevision ) ) {
1210 // An extra check against threads stepping on each other
1211 $conditions['page_latest'] = $lastRevision;
1215 'page_latest' => $revision->getId(),
1216 'page_touched' => $dbw->timestamp( $revision->getTimestamp() ),
1217 'page_is_new' => ( $lastRevision === 0 ) ?
1 : 0,
1218 'page_is_redirect' => $rt !== null ?
1 : 0,
1222 if ( $wgContentHandlerUseDB ) {
1223 $row['page_content_model'] = $revision->getContentModel();
1226 $dbw->update( 'page',
1231 $result = $dbw->affectedRows() > 0;
1233 $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1234 $this->setLastEdit( $revision );
1235 $this->mLatest
= $revision->getId();
1236 $this->mIsRedirect
= (bool)$rt;
1237 // Update the LinkCache.
1238 LinkCache
::singleton()->addGoodLinkObj(
1244 $revision->getContentModel()
1252 * Add row to the redirect table if this is a redirect, remove otherwise.
1254 * @param IDatabase $dbw
1255 * @param Title $redirectTitle Title object pointing to the redirect target,
1256 * or NULL if this is not a redirect
1257 * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1258 * removing rows in redirect table.
1259 * @return bool True on success, false on failure
1262 public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1263 // Always update redirects (target link might have changed)
1264 // Update/Insert if we don't know if the last revision was a redirect or not
1265 // Delete if changing from redirect to non-redirect
1266 $isRedirect = !is_null( $redirectTitle );
1268 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1272 if ( $isRedirect ) {
1273 $this->insertRedirectEntry( $redirectTitle );
1275 // This is not a redirect, remove row from redirect table
1276 $where = [ 'rd_from' => $this->getId() ];
1277 $dbw->delete( 'redirect', $where, __METHOD__
);
1280 if ( $this->getTitle()->getNamespace() == NS_FILE
) {
1281 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1284 return ( $dbw->affectedRows() != 0 );
1288 * If the given revision is newer than the currently set page_latest,
1289 * update the page record. Otherwise, do nothing.
1291 * @deprecated since 1.24, use updateRevisionOn instead
1293 * @param IDatabase $dbw
1294 * @param Revision $revision
1297 public function updateIfNewerOn( $dbw, $revision ) {
1299 $row = $dbw->selectRow(
1300 [ 'revision', 'page' ],
1301 [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1303 'page_id' => $this->getId(),
1304 'page_latest=rev_id' ],
1308 if ( wfTimestamp( TS_MW
, $row->rev_timestamp
) >= $revision->getTimestamp() ) {
1311 $prev = $row->rev_id
;
1312 $lastRevIsRedirect = (bool)$row->page_is_redirect
;
1314 // No or missing previous revision; mark the page as new
1316 $lastRevIsRedirect = null;
1319 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1325 * Get the content that needs to be saved in order to undo all revisions
1326 * between $undo and $undoafter. Revisions must belong to the same page,
1327 * must exist and must not be deleted
1328 * @param Revision $undo
1329 * @param Revision $undoafter Must be an earlier revision than $undo
1330 * @return Content|bool Content on success, false on failure
1332 * Before we had the Content object, this was done in getUndoText
1334 public function getUndoContent( Revision
$undo, Revision
$undoafter = null ) {
1335 $handler = $undo->getContentHandler();
1336 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1340 * Returns true if this page's content model supports sections.
1344 * @todo The skin should check this and not offer section functionality if
1345 * sections are not supported.
1346 * @todo The EditPage should check this and not offer section functionality
1347 * if sections are not supported.
1349 public function supportsSections() {
1350 return $this->getContentHandler()->supportsSections();
1354 * @param string|number|null|bool $sectionId Section identifier as a number or string
1355 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1356 * or 'new' for a new section.
1357 * @param Content $sectionContent New content of the section.
1358 * @param string $sectionTitle New section's subject, only if $section is "new".
1359 * @param string $edittime Revision timestamp or null to use the current revision.
1361 * @throws MWException
1362 * @return Content|null New complete article content, or null if error.
1365 * @deprecated since 1.24, use replaceSectionAtRev instead
1367 public function replaceSectionContent(
1368 $sectionId, Content
$sectionContent, $sectionTitle = '', $edittime = null
1372 if ( $edittime && $sectionId !== 'new' ) {
1373 $dbr = wfGetDB( DB_SLAVE
);
1374 $rev = Revision
::loadFromTimestamp( $dbr, $this->mTitle
, $edittime );
1375 // Try the master if this thread may have just added it.
1376 // This could be abstracted into a Revision method, but we don't want
1377 // to encourage loading of revisions by timestamp.
1379 && wfGetLB()->getServerCount() > 1
1380 && wfGetLB()->hasOrMadeRecentMasterChanges()
1382 $dbw = wfGetDB( DB_MASTER
);
1383 $rev = Revision
::loadFromTimestamp( $dbw, $this->mTitle
, $edittime );
1386 $baseRevId = $rev->getId();
1390 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1394 * @param string|number|null|bool $sectionId Section identifier as a number or string
1395 * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1396 * or 'new' for a new section.
1397 * @param Content $sectionContent New content of the section.
1398 * @param string $sectionTitle New section's subject, only if $section is "new".
1399 * @param int|null $baseRevId
1401 * @throws MWException
1402 * @return Content|null New complete article content, or null if error.
1406 public function replaceSectionAtRev( $sectionId, Content
$sectionContent,
1407 $sectionTitle = '', $baseRevId = null
1410 if ( strval( $sectionId ) === '' ) {
1411 // Whole-page edit; let the whole text through
1412 $newContent = $sectionContent;
1414 if ( !$this->supportsSections() ) {
1415 throw new MWException( "sections not supported for content model " .
1416 $this->getContentHandler()->getModelID() );
1419 // Bug 30711: always use current version when adding a new section
1420 if ( is_null( $baseRevId ) ||
$sectionId === 'new' ) {
1421 $oldContent = $this->getContent();
1423 $rev = Revision
::newFromId( $baseRevId );
1425 wfDebug( __METHOD__
. " asked for bogus section (page: " .
1426 $this->getId() . "; section: $sectionId)\n" );
1430 $oldContent = $rev->getContent();
1433 if ( !$oldContent ) {
1434 wfDebug( __METHOD__
. ": no page text\n" );
1438 $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1445 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1447 * @return int Updated $flags
1449 public function checkFlags( $flags ) {
1450 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
1451 if ( $this->exists() ) {
1452 $flags |
= EDIT_UPDATE
;
1462 * Change an existing article or create a new article. Updates RC and all necessary caches,
1463 * optionally via the deferred update array.
1465 * @param string $text New text
1466 * @param string $summary Edit summary
1467 * @param int $flags Bitfield:
1469 * Article is known or assumed to be non-existent, create a new one
1471 * Article is known or assumed to be pre-existing, update it
1473 * Mark this edit minor, if the user is allowed to do so
1475 * Do not log the change in recentchanges
1477 * Mark the edit a "bot" edit regardless of user rights
1479 * Fill in blank summaries with generated text where possible
1481 * Signal that the page retrieve/save cycle happened entirely in this request.
1483 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1484 * article will be detected. If EDIT_UPDATE is specified and the article
1485 * doesn't exist, the function will return an edit-gone-missing error. If
1486 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1487 * error will be returned. These two conditions are also possible with
1488 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1490 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1491 * This is not the parent revision ID, rather the revision ID for older
1492 * content used as the source for a rollback, for example.
1493 * @param User $user The user doing the edit
1495 * @throws MWException
1496 * @return Status Possible errors:
1497 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1498 * set the fatal flag of $status
1499 * edit-gone-missing: In update mode, but the article didn't exist.
1500 * edit-conflict: In update mode, the article changed unexpectedly.
1501 * edit-no-change: Warning that the text was the same as before.
1502 * edit-already-exists: In creation mode, but the article already exists.
1504 * Extensions may define additional errors.
1506 * $return->value will contain an associative array with members as follows:
1507 * new: Boolean indicating if the function attempted to create a new article.
1508 * revision: The revision object for the inserted revision, or null.
1510 * Compatibility note: this function previously returned a boolean value
1511 * indicating success/failure
1513 * @deprecated since 1.21: use doEditContent() instead.
1515 public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1516 ContentHandler
::deprecated( __METHOD__
, '1.21' );
1518 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
1520 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1524 * Change an existing article or create a new article. Updates RC and all necessary caches,
1525 * optionally via the deferred update array.
1527 * @param Content $content New content
1528 * @param string $summary Edit summary
1529 * @param int $flags Bitfield:
1531 * Article is known or assumed to be non-existent, create a new one
1533 * Article is known or assumed to be pre-existing, update it
1535 * Mark this edit minor, if the user is allowed to do so
1537 * Do not log the change in recentchanges
1539 * Mark the edit a "bot" edit regardless of user rights
1541 * Fill in blank summaries with generated text where possible
1543 * Signal that the page retrieve/save cycle happened entirely in this request.
1545 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1546 * article will be detected. If EDIT_UPDATE is specified and the article
1547 * doesn't exist, the function will return an edit-gone-missing error. If
1548 * EDIT_NEW is specified and the article does exist, an edit-already-exists
1549 * error will be returned. These two conditions are also possible with
1550 * auto-detection due to MediaWiki's performance-optimised locking strategy.
1552 * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1553 * This is not the parent revision ID, rather the revision ID for older
1554 * content used as the source for a rollback, for example.
1555 * @param User $user The user doing the edit
1556 * @param string $serialFormat Format for storing the content in the
1558 * @param array|null $tags Change tags to apply to this edit
1559 * Callers are responsible for permission checks
1560 * (with ChangeTags::canAddTagsAccompanyingChange)
1562 * @throws MWException
1563 * @return Status Possible errors:
1564 * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1565 * set the fatal flag of $status.
1566 * edit-gone-missing: In update mode, but the article didn't exist.
1567 * edit-conflict: In update mode, the article changed unexpectedly.
1568 * edit-no-change: Warning that the text was the same as before.
1569 * edit-already-exists: In creation mode, but the article already exists.
1571 * Extensions may define additional errors.
1573 * $return->value will contain an associative array with members as follows:
1574 * new: Boolean indicating if the function attempted to create a new article.
1575 * revision: The revision object for the inserted revision, or null.
1578 * @throws MWException
1580 public function doEditContent(
1581 Content
$content, $summary, $flags = 0, $baseRevId = false,
1582 User
$user = null, $serialFormat = null, $tags = null
1584 global $wgUser, $wgUseAutomaticEditSummaries;
1586 // Low-level sanity check
1587 if ( $this->mTitle
->getText() === '' ) {
1588 throw new MWException( 'Something is trying to edit an article with an empty title' );
1590 // Make sure the given content type is allowed for this page
1591 if ( !$content->getContentHandler()->canBeUsedOn( $this->mTitle
) ) {
1592 return Status
::newFatal( 'content-not-allowed-here',
1593 ContentHandler
::getLocalizedName( $content->getModel() ),
1594 $this->mTitle
->getPrefixedText()
1598 // Load the data from the master database if needed.
1599 // The caller may already loaded it from the master or even loaded it using
1600 // SELECT FOR UPDATE, so do not override that using clear().
1601 $this->loadPageData( 'fromdbmaster' );
1603 $user = $user ?
: $wgUser;
1604 $flags = $this->checkFlags( $flags );
1606 // Trigger pre-save hook (using provided edit summary)
1607 $hookStatus = Status
::newGood( [] );
1608 $hook_args = [ &$this, &$user, &$content, &$summary,
1609 $flags & EDIT_MINOR
, null, null, &$flags, &$hookStatus ];
1610 // Check if the hook rejected the attempted save
1611 if ( !Hooks
::run( 'PageContentSave', $hook_args )
1612 ||
!ContentHandler
::runLegacyHooks( 'ArticleSave', $hook_args )
1614 if ( $hookStatus->isOK() ) {
1615 // Hook returned false but didn't call fatal(); use generic message
1616 $hookStatus->fatal( 'edit-hook-aborted' );
1622 $old_revision = $this->getRevision(); // current revision
1623 $old_content = $this->getContent( Revision
::RAW
); // current revision's content
1625 // Provide autosummaries if one is not provided and autosummaries are enabled
1626 if ( $wgUseAutomaticEditSummaries && ( $flags & EDIT_AUTOSUMMARY
) && $summary == '' ) {
1627 $handler = $content->getContentHandler();
1628 $summary = $handler->getAutosummary( $old_content, $content, $flags );
1631 // Avoid statsd noise and wasted cycles check the edit stash (T136678)
1632 if ( ( $flags & EDIT_INTERNAL
) ||
( $flags & EDIT_FORCE_BOT
) ) {
1638 // Get the pre-save transform content and final parser output
1639 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat, $useCache );
1640 $pstContent = $editInfo->pstContent
; // Content object
1642 'bot' => ( $flags & EDIT_FORCE_BOT
),
1643 'minor' => ( $flags & EDIT_MINOR
) && $user->isAllowed( 'minoredit' ),
1644 'serialized' => $editInfo->pst
,
1645 'serialFormat' => $serialFormat,
1646 'baseRevId' => $baseRevId,
1647 'oldRevision' => $old_revision,
1648 'oldContent' => $old_content,
1649 'oldId' => $this->getLatest(),
1650 'oldIsRedirect' => $this->isRedirect(),
1651 'oldCountable' => $this->isCountable(),
1652 'tags' => ( $tags !== null ) ?
(array)$tags : []
1655 // Actually create the revision and create/update the page
1656 if ( $flags & EDIT_UPDATE
) {
1657 $status = $this->doModify( $pstContent, $flags, $user, $summary, $meta );
1659 $status = $this->doCreate( $pstContent, $flags, $user, $summary, $meta );
1662 // Promote user to any groups they meet the criteria for
1663 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
1664 $user->addAutopromoteOnceGroups( 'onEdit' );
1665 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1672 * @param Content $content Pre-save transform content
1673 * @param integer $flags
1675 * @param string $summary
1676 * @param array $meta
1678 * @throws DBUnexpectedError
1680 * @throws FatalError
1681 * @throws MWException
1683 private function doModify(
1684 Content
$content, $flags, User
$user, $summary, array $meta
1686 global $wgUseRCPatrol;
1688 // Update article, but only if changed.
1689 $status = Status
::newGood( [ 'new' => false, 'revision' => null ] );
1691 // Convenience variables
1692 $now = wfTimestampNow();
1693 $oldid = $meta['oldId'];
1694 /** @var $oldContent Content|null */
1695 $oldContent = $meta['oldContent'];
1696 $newsize = $content->getSize();
1699 // Article gone missing
1700 $status->fatal( 'edit-gone-missing' );
1703 } elseif ( !$oldContent ) {
1704 // Sanity check for bug 37225
1705 throw new MWException( "Could not find text for current revision {$oldid}." );
1708 // @TODO: pass content object?!
1709 $revision = new Revision( [
1710 'page' => $this->getId(),
1711 'title' => $this->mTitle
, // for determining the default content model
1712 'comment' => $summary,
1713 'minor_edit' => $meta['minor'],
1714 'text' => $meta['serialized'],
1716 'parent_id' => $oldid,
1717 'user' => $user->getId(),
1718 'user_text' => $user->getName(),
1719 'timestamp' => $now,
1720 'content_model' => $content->getModel(),
1721 'content_format' => $meta['serialFormat'],
1724 $changed = !$content->equals( $oldContent );
1726 $dbw = wfGetDB( DB_MASTER
);
1729 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1730 $status->merge( $prepStatus );
1731 if ( !$status->isOK() ) {
1735 $dbw->startAtomic( __METHOD__
);
1736 // Get the latest page_latest value while locking it.
1737 // Do a CAS style check to see if it's the same as when this method
1738 // started. If it changed then bail out before touching the DB.
1739 $latestNow = $this->lockAndGetLatest();
1740 if ( $latestNow != $oldid ) {
1741 $dbw->endAtomic( __METHOD__
);
1742 // Page updated or deleted in the mean time
1743 $status->fatal( 'edit-conflict' );
1748 // At this point we are now comitted to returning an OK
1749 // status unless some DB query error or other exception comes up.
1750 // This way callers don't have to call rollback() if $status is bad
1751 // unless they actually try to catch exceptions (which is rare).
1753 // Save the revision text
1754 $revisionId = $revision->insertOn( $dbw );
1755 // Update page_latest and friends to reflect the new revision
1756 if ( !$this->updateRevisionOn( $dbw, $revision, null, $meta['oldIsRedirect'] ) ) {
1757 $dbw->rollback( __METHOD__
); // sanity; this should never happen
1758 throw new MWException( "Failed to update page row to use new revision." );
1761 Hooks
::run( 'NewRevisionFromEditComplete',
1762 [ $this, $revision, $meta['baseRevId'], $user ] );
1764 // Update recentchanges
1765 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1766 // Mark as patrolled if the user can do so
1767 $patrolled = $wgUseRCPatrol && !count(
1768 $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1769 // Add RC row to the DB
1770 RecentChange
::notifyEdit(
1773 $revision->isMinor(),
1777 $this->getTimestamp(),
1780 $oldContent ?
$oldContent->getSize() : 0,
1788 $user->incEditCount();
1790 $dbw->endAtomic( __METHOD__
);
1791 $this->mTimestamp
= $now;
1793 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1794 // related variables correctly. Likewise for {{REVISIONUSER}} (T135261).
1795 $revision->setId( $this->getLatest() );
1796 $revision->setUserIdAndName(
1797 $this->getUser( Revision
::RAW
),
1798 $this->getUserText( Revision
::RAW
)
1803 // Return the new revision to the caller
1804 $status->value
['revision'] = $revision;
1806 $status->warning( 'edit-no-change' );
1807 // Update page_touched as updateRevisionOn() was not called.
1808 // Other cache updates are managed in onArticleEdit() via doEditUpdates().
1809 $this->mTitle
->invalidateCache( $now );
1812 // Do secondary updates once the main changes have been committed...
1813 DeferredUpdates
::addUpdate(
1814 new AtomicSectionUpdate(
1818 $revision, &$user, $content, $summary, &$flags,
1819 $changed, $meta, &$status
1821 // Update links tables, site stats, etc.
1822 $this->doEditUpdates(
1826 'changed' => $changed,
1827 'oldcountable' => $meta['oldCountable'],
1828 'oldrevision' => $meta['oldRevision']
1831 // Trigger post-save hook
1832 $params = [ &$this, &$user, $content, $summary, $flags & EDIT_MINOR
,
1833 null, null, &$flags, $revision, &$status, $meta['baseRevId'] ];
1834 ContentHandler
::runLegacyHooks( 'ArticleSaveComplete', $params );
1835 Hooks
::run( 'PageContentSaveComplete', $params );
1838 DeferredUpdates
::PRESEND
1845 * @param Content $content Pre-save transform content
1846 * @param integer $flags
1848 * @param string $summary
1849 * @param array $meta
1851 * @throws DBUnexpectedError
1853 * @throws FatalError
1854 * @throws MWException
1856 private function doCreate(
1857 Content
$content, $flags, User
$user, $summary, array $meta
1859 global $wgUseRCPatrol, $wgUseNPPatrol;
1861 $status = Status
::newGood( [ 'new' => true, 'revision' => null ] );
1863 $now = wfTimestampNow();
1864 $newsize = $content->getSize();
1865 $prepStatus = $content->prepareSave( $this, $flags, $meta['oldId'], $user );
1866 $status->merge( $prepStatus );
1867 if ( !$status->isOK() ) {
1871 $dbw = wfGetDB( DB_MASTER
);
1872 $dbw->startAtomic( __METHOD__
);
1874 // Add the page record unless one already exists for the title
1875 $newid = $this->insertOn( $dbw );
1876 if ( $newid === false ) {
1877 $dbw->endAtomic( __METHOD__
); // nothing inserted
1878 $status->fatal( 'edit-already-exists' );
1880 return $status; // nothing done
1883 // At this point we are now comitted to returning an OK
1884 // status unless some DB query error or other exception comes up.
1885 // This way callers don't have to call rollback() if $status is bad
1886 // unless they actually try to catch exceptions (which is rare).
1888 // @TODO: pass content object?!
1889 $revision = new Revision( [
1891 'title' => $this->mTitle
, // for determining the default content model
1892 'comment' => $summary,
1893 'minor_edit' => $meta['minor'],
1894 'text' => $meta['serialized'],
1896 'user' => $user->getId(),
1897 'user_text' => $user->getName(),
1898 'timestamp' => $now,
1899 'content_model' => $content->getModel(),
1900 'content_format' => $meta['serialFormat'],
1903 // Save the revision text...
1904 $revisionId = $revision->insertOn( $dbw );
1905 // Update the page record with revision data
1906 if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1907 $dbw->rollback( __METHOD__
); // sanity; this should never happen
1908 throw new MWException( "Failed to update page row to use new revision." );
1911 Hooks
::run( 'NewRevisionFromEditComplete', [ $this, $revision, false, $user ] );
1913 // Update recentchanges
1914 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1915 // Mark as patrolled if the user can do so
1916 $patrolled = ( $wgUseRCPatrol ||
$wgUseNPPatrol ) &&
1917 !count( $this->mTitle
->getUserPermissionsErrors( 'autopatrol', $user ) );
1918 // Add RC row to the DB
1919 RecentChange
::notifyNew(
1922 $revision->isMinor(),
1934 $user->incEditCount();
1936 $dbw->endAtomic( __METHOD__
);
1937 $this->mTimestamp
= $now;
1939 // Return the new revision to the caller
1940 $status->value
['revision'] = $revision;
1942 // Do secondary updates once the main changes have been committed...
1943 DeferredUpdates
::addUpdate(
1944 new AtomicSectionUpdate(
1948 $revision, &$user, $content, $summary, &$flags, $meta, &$status
1950 // Update links, etc.
1951 $this->doEditUpdates( $revision, $user, [ 'created' => true ] );
1952 // Trigger post-create hook
1953 $params = [ &$this, &$user, $content, $summary,
1954 $flags & EDIT_MINOR
, null, null, &$flags, $revision ];
1955 ContentHandler
::runLegacyHooks( 'ArticleInsertComplete', $params );
1956 Hooks
::run( 'PageContentInsertComplete', $params );
1957 // Trigger post-save hook
1958 $params = array_merge( $params, [ &$status, $meta['baseRevId'] ] );
1959 ContentHandler
::runLegacyHooks( 'ArticleSaveComplete', $params );
1960 Hooks
::run( 'PageContentSaveComplete', $params );
1964 DeferredUpdates
::PRESEND
1971 * Get parser options suitable for rendering the primary article wikitext
1973 * @see ContentHandler::makeParserOptions
1975 * @param IContextSource|User|string $context One of the following:
1976 * - IContextSource: Use the User and the Language of the provided
1978 * - User: Use the provided User object and $wgLang for the language,
1979 * so use an IContextSource object if possible.
1980 * - 'canonical': Canonical options (anonymous user with default
1981 * preferences and content language).
1982 * @return ParserOptions
1984 public function makeParserOptions( $context ) {
1985 $options = $this->getContentHandler()->makeParserOptions( $context );
1987 if ( $this->getTitle()->isConversionTable() ) {
1988 // @todo ConversionTable should become a separate content model, so
1989 // we don't need special cases like this one.
1990 $options->disableContentConversion();
1997 * Prepare text which is about to be saved.
1998 * Returns a stdClass with source, pst and output members
2000 * @param string $text
2001 * @param int|null $revid
2002 * @param User|null $user
2003 * @deprecated since 1.21: use prepareContentForEdit instead.
2006 public function prepareTextForEdit( $text, $revid = null, User
$user = null ) {
2007 ContentHandler
::deprecated( __METHOD__
, '1.21' );
2008 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
2009 return $this->prepareContentForEdit( $content, $revid, $user );
2013 * Prepare content which is about to be saved.
2014 * Returns a stdClass with source, pst and output members
2016 * @param Content $content
2017 * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2018 * revision ID is also accepted, but this is deprecated.
2019 * @param User|null $user
2020 * @param string|null $serialFormat
2021 * @param bool $useCache Check shared prepared edit cache
2027 public function prepareContentForEdit(
2028 Content
$content, $revision = null, User
$user = null,
2029 $serialFormat = null, $useCache = true
2031 global $wgContLang, $wgUser, $wgAjaxEditStash;
2033 if ( is_object( $revision ) ) {
2034 $revid = $revision->getId();
2037 // This code path is deprecated, and nothing is known to
2038 // use it, so performance here shouldn't be a worry.
2039 if ( $revid !== null ) {
2040 $revision = Revision
::newFromId( $revid, Revision
::READ_LATEST
);
2046 $user = is_null( $user ) ?
$wgUser : $user;
2047 // XXX: check $user->getId() here???
2049 // Use a sane default for $serialFormat, see bug 57026
2050 if ( $serialFormat === null ) {
2051 $serialFormat = $content->getContentHandler()->getDefaultFormat();
2054 if ( $this->mPreparedEdit
2055 && isset( $this->mPreparedEdit
->newContent
)
2056 && $this->mPreparedEdit
->newContent
->equals( $content )
2057 && $this->mPreparedEdit
->revid
== $revid
2058 && $this->mPreparedEdit
->format
== $serialFormat
2059 // XXX: also check $user here?
2062 return $this->mPreparedEdit
;
2065 // The edit may have already been prepared via api.php?action=stashedit
2066 $cachedEdit = $useCache && $wgAjaxEditStash
2067 ? ApiStashEdit
::checkCache( $this->getTitle(), $content, $user )
2070 $popts = ParserOptions
::newFromUserAndLang( $user, $wgContLang );
2071 Hooks
::run( 'ArticlePrepareTextForEdit', [ $this, $popts ] );
2074 if ( $cachedEdit ) {
2075 $edit->timestamp
= $cachedEdit->timestamp
;
2077 $edit->timestamp
= wfTimestampNow();
2079 // @note: $cachedEdit is safely not used if the rev ID was referenced in the text
2080 $edit->revid
= $revid;
2082 if ( $cachedEdit ) {
2083 $edit->pstContent
= $cachedEdit->pstContent
;
2085 $edit->pstContent
= $content
2086 ?
$content->preSaveTransform( $this->mTitle
, $user, $popts )
2090 $edit->format
= $serialFormat;
2091 $edit->popts
= $this->makeParserOptions( 'canonical' );
2092 if ( $cachedEdit ) {
2093 $edit->output
= $cachedEdit->output
;
2096 // We get here if vary-revision is set. This means that this page references
2097 // itself (such as via self-transclusion). In this case, we need to make sure
2098 // that any such self-references refer to the newly-saved revision, and not
2099 // to the previous one, which could otherwise happen due to slave lag.
2100 $oldCallback = $edit->popts
->getCurrentRevisionCallback();
2101 $edit->popts
->setCurrentRevisionCallback(
2102 function ( Title
$title, $parser = false ) use ( $revision, &$oldCallback ) {
2103 if ( $title->equals( $revision->getTitle() ) ) {
2106 return call_user_func( $oldCallback, $title, $parser );
2111 // Try to avoid a second parse if {{REVISIONID}} is used
2112 $edit->popts
->setSpeculativeRevIdCallback( function () {
2113 return 1 +
(int)wfGetDB( DB_MASTER
)->selectField(
2121 $edit->output
= $edit->pstContent
2122 ?
$edit->pstContent
->getParserOutput( $this->mTitle
, $revid, $edit->popts
)
2126 $edit->newContent
= $content;
2127 $edit->oldContent
= $this->getContent( Revision
::RAW
);
2129 // NOTE: B/C for hooks! don't use these fields!
2130 $edit->newText
= $edit->newContent
2131 ? ContentHandler
::getContentText( $edit->newContent
)
2133 $edit->oldText
= $edit->oldContent
2134 ? ContentHandler
::getContentText( $edit->oldContent
)
2136 $edit->pst
= $edit->pstContent ?
$edit->pstContent
->serialize( $serialFormat ) : '';
2138 if ( $edit->output
) {
2139 $edit->output
->setCacheTime( wfTimestampNow() );
2142 // Process cache the result
2143 $this->mPreparedEdit
= $edit;
2149 * Do standard deferred updates after page edit.
2150 * Update links tables, site stats, search index and message cache.
2151 * Purges pages that include this page if the text was changed here.
2152 * Every 100th edit, prune the recent changes table.
2154 * @param Revision $revision
2155 * @param User $user User object that did the revision
2156 * @param array $options Array of options, following indexes are used:
2157 * - changed: boolean, whether the revision changed the content (default true)
2158 * - created: boolean, whether the revision created the page (default false)
2159 * - moved: boolean, whether the page was moved (default false)
2160 * - restored: boolean, whether the page was undeleted (default false)
2161 * - oldrevision: Revision object for the pre-update revision (default null)
2162 * - oldcountable: boolean, null, or string 'no-change' (default null):
2163 * - boolean: whether the page was counted as an article before that
2164 * revision, only used in changed is true and created is false
2165 * - null: if created is false, don't update the article count; if created
2166 * is true, do update the article count
2167 * - 'no-change': don't update the article count, ever
2169 public function doEditUpdates( Revision
$revision, User
$user, array $options = [] ) {
2170 global $wgRCWatchCategoryMembership, $wgContLang;
2176 'restored' => false,
2177 'oldrevision' => null,
2178 'oldcountable' => null
2180 $content = $revision->getContent();
2182 $logger = LoggerFactory
::getInstance( 'SaveParse' );
2184 // See if the parser output before $revision was inserted is still valid
2186 if ( !$this->mPreparedEdit
) {
2187 $logger->debug( __METHOD__
. ": No prepared edit...\n" );
2188 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision' ) ) {
2189 $logger->info( __METHOD__
. ": Prepared edit has vary-revision...\n" );
2190 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-revision-id' )
2191 && $this->mPreparedEdit
->output
->getSpeculativeRevIdUsed() !== $revision->getId()
2193 $logger->info( __METHOD__
. ": Prepared edit has vary-revision-id with wrong ID...\n" );
2194 } elseif ( $this->mPreparedEdit
->output
->getFlag( 'vary-user' ) && !$options['changed'] ) {
2195 $logger->info( __METHOD__
. ": Prepared edit has vary-user and is null...\n" );
2197 wfDebug( __METHOD__
. ": Using prepared edit...\n" );
2198 $editInfo = $this->mPreparedEdit
;
2202 // Parse the text again if needed. Be careful not to do pre-save transform twice:
2203 // $text is usually already pre-save transformed once. Avoid using the edit stash
2204 // as any prepared content from there or in doEditContent() was already rejected.
2205 $editInfo = $this->prepareContentForEdit( $content, $revision, $user, null, false );
2208 // Save it to the parser cache.
2209 // Make sure the cache time matches page_touched to avoid double parsing.
2210 ParserCache
::singleton()->save(
2211 $editInfo->output
, $this, $editInfo->popts
,
2212 $revision->getTimestamp(), $editInfo->revid
2215 // Update the links tables and other secondary data
2217 $recursive = $options['changed']; // bug 50785
2218 $updates = $content->getSecondaryDataUpdates(
2219 $this->getTitle(), null, $recursive, $editInfo->output
2221 foreach ( $updates as $update ) {
2222 if ( $update instanceof LinksUpdate
) {
2223 $update->setRevision( $revision );
2224 $update->setTriggeringUser( $user );
2226 DeferredUpdates
::addUpdate( $update );
2228 if ( $wgRCWatchCategoryMembership
2229 && $this->getContentHandler()->supportsCategories() === true
2230 && ( $options['changed'] ||
$options['created'] )
2231 && !$options['restored']
2233 // Note: jobs are pushed after deferred updates, so the job should be able to see
2234 // the recent change entry (also done via deferred updates) and carry over any
2235 // bot/deletion/IP flags, ect.
2236 JobQueueGroup
::singleton()->lazyPush( new CategoryMembershipChangeJob(
2239 'pageId' => $this->getId(),
2240 'revTimestamp' => $revision->getTimestamp()
2246 Hooks
::run( 'ArticleEditUpdates', [ &$this, &$editInfo, $options['changed'] ] );
2248 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', [ &$this ] ) ) {
2249 // Flush old entries from the `recentchanges` table
2250 if ( mt_rand( 0, 9 ) == 0 ) {
2251 JobQueueGroup
::singleton()->lazyPush( RecentChangesUpdateJob
::newPurgeJob() );
2255 if ( !$this->exists() ) {
2259 $id = $this->getId();
2260 $title = $this->mTitle
->getPrefixedDBkey();
2261 $shortTitle = $this->mTitle
->getDBkey();
2263 if ( $options['oldcountable'] === 'no-change' ||
2264 ( !$options['changed'] && !$options['moved'] )
2267 } elseif ( $options['created'] ) {
2268 $good = (int)$this->isCountable( $editInfo );
2269 } elseif ( $options['oldcountable'] !== null ) {
2270 $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2274 $edits = $options['changed'] ?
1 : 0;
2275 $total = $options['created'] ?
1 : 0;
2277 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2278 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $content ) );
2280 // If this is another user's talk page, update newtalk.
2281 // Don't do this if $options['changed'] = false (null-edits) nor if
2282 // it's a minor edit and the user doesn't want notifications for those.
2283 if ( $options['changed']
2284 && $this->mTitle
->getNamespace() == NS_USER_TALK
2285 && $shortTitle != $user->getTitleKey()
2286 && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2288 $recipient = User
::newFromName( $shortTitle, false );
2289 if ( !$recipient ) {
2290 wfDebug( __METHOD__
. ": invalid username\n" );
2292 // Allow extensions to prevent user notification
2293 // when a new message is added to their talk page
2294 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', [ &$this, $recipient ] ) ) {
2295 if ( User
::isIP( $shortTitle ) ) {
2296 // An anonymous user
2297 $recipient->setNewtalk( true, $revision );
2298 } elseif ( $recipient->isLoggedIn() ) {
2299 $recipient->setNewtalk( true, $revision );
2301 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
2307 if ( $this->mTitle
->getNamespace() == NS_MEDIAWIKI
) {
2308 // XXX: could skip pseudo-messages like js/css here, based on content model.
2309 $msgtext = $content ?
$content->getWikitextForTransclusion() : null;
2310 if ( $msgtext === false ||
$msgtext === null ) {
2314 MessageCache
::singleton()->replace( $shortTitle, $msgtext );
2316 if ( $wgContLang->hasVariants() ) {
2317 $wgContLang->updateConversionTable( $this->mTitle
);
2321 if ( $options['created'] ) {
2322 self
::onArticleCreate( $this->mTitle
);
2323 } elseif ( $options['changed'] ) { // bug 50785
2324 self
::onArticleEdit( $this->mTitle
, $revision );
2329 * Edit an article without doing all that other stuff
2330 * The article must already exist; link tables etc
2331 * are not updated, caches are not flushed.
2333 * @param Content $content Content submitted
2334 * @param User $user The relevant user
2335 * @param string $comment Comment submitted
2336 * @param bool $minor Whereas it's a minor modification
2337 * @param string $serialFormat Format for storing the content in the database
2339 public function doQuickEditContent(
2340 Content
$content, User
$user, $comment = '', $minor = false, $serialFormat = null
2343 $serialized = $content->serialize( $serialFormat );
2345 $dbw = wfGetDB( DB_MASTER
);
2346 $revision = new Revision( [
2347 'title' => $this->getTitle(), // for determining the default content model
2348 'page' => $this->getId(),
2349 'user_text' => $user->getName(),
2350 'user' => $user->getId(),
2351 'text' => $serialized,
2352 'length' => $content->getSize(),
2353 'comment' => $comment,
2354 'minor_edit' => $minor ?
1 : 0,
2355 ] ); // XXX: set the content object?
2356 $revision->insertOn( $dbw );
2357 $this->updateRevisionOn( $dbw, $revision );
2359 Hooks
::run( 'NewRevisionFromEditComplete', [ $this, $revision, false, $user ] );
2364 * Update the article's restriction field, and leave a log entry.
2365 * This works for protection both existing and non-existing pages.
2367 * @param array $limit Set of restriction keys
2368 * @param array $expiry Per restriction type expiration
2369 * @param int &$cascade Set to false if cascading protection isn't allowed.
2370 * @param string $reason
2371 * @param User $user The user updating the restrictions
2372 * @param string|string[] $tags Change tags to add to the pages and protection log entries
2373 * ($user should be able to add the specified tags before this is called)
2374 * @return Status Status object; if action is taken, $status->value is the log_id of the
2375 * protection log entry.
2377 public function doUpdateRestrictions( array $limit, array $expiry,
2378 &$cascade, $reason, User
$user, $tags = null
2380 global $wgCascadingRestrictionLevels, $wgContLang;
2382 if ( wfReadOnly() ) {
2383 return Status
::newFatal( 'readonlytext', wfReadOnlyReason() );
2386 $this->loadPageData( 'fromdbmaster' );
2387 $restrictionTypes = $this->mTitle
->getRestrictionTypes();
2388 $id = $this->getId();
2394 // Take this opportunity to purge out expired restrictions
2395 Title
::purgeExpiredRestrictions();
2397 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2398 // we expect a single selection, but the schema allows otherwise.
2399 $isProtected = false;
2403 $dbw = wfGetDB( DB_MASTER
);
2405 foreach ( $restrictionTypes as $action ) {
2406 if ( !isset( $expiry[$action] ) ||
$expiry[$action] === $dbw->getInfinity() ) {
2407 $expiry[$action] = 'infinity';
2409 if ( !isset( $limit[$action] ) ) {
2410 $limit[$action] = '';
2411 } elseif ( $limit[$action] != '' ) {
2415 // Get current restrictions on $action
2416 $current = implode( '', $this->mTitle
->getRestrictions( $action ) );
2417 if ( $current != '' ) {
2418 $isProtected = true;
2421 if ( $limit[$action] != $current ) {
2423 } elseif ( $limit[$action] != '' ) {
2424 // Only check expiry change if the action is actually being
2425 // protected, since expiry does nothing on an not-protected
2427 if ( $this->mTitle
->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2433 if ( !$changed && $protect && $this->mTitle
->areRestrictionsCascading() != $cascade ) {
2437 // If nothing has changed, do nothing
2439 return Status
::newGood();
2442 if ( !$protect ) { // No protection at all means unprotection
2443 $revCommentMsg = 'unprotectedarticle';
2444 $logAction = 'unprotect';
2445 } elseif ( $isProtected ) {
2446 $revCommentMsg = 'modifiedarticleprotection';
2447 $logAction = 'modify';
2449 $revCommentMsg = 'protectedarticle';
2450 $logAction = 'protect';
2453 // Truncate for whole multibyte characters
2454 $reason = $wgContLang->truncate( $reason, 255 );
2456 $logRelationsValues = [];
2457 $logRelationsField = null;
2458 $logParamsDetails = [];
2460 // Null revision (used for change tag insertion)
2461 $nullRevision = null;
2463 if ( $id ) { // Protection of existing page
2464 if ( !Hooks
::run( 'ArticleProtect', [ &$this, &$user, $limit, $reason ] ) ) {
2465 return Status
::newGood();
2468 // Only certain restrictions can cascade...
2469 $editrestriction = isset( $limit['edit'] )
2470 ?
[ $limit['edit'] ]
2471 : $this->mTitle
->getRestrictions( 'edit' );
2472 foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2473 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2475 foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2476 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2479 $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2480 foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2481 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2483 foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2484 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2487 // The schema allows multiple restrictions
2488 if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2492 // insert null revision to identify the page protection change as edit summary
2493 $latest = $this->getLatest();
2494 $nullRevision = $this->insertProtectNullRevision(
2503 if ( $nullRevision === null ) {
2504 return Status
::newFatal( 'no-null-revision', $this->mTitle
->getPrefixedText() );
2507 $logRelationsField = 'pr_id';
2509 // Update restrictions table
2510 foreach ( $limit as $action => $restrictions ) {
2512 'page_restrictions',
2515 'pr_type' => $action
2519 if ( $restrictions != '' ) {
2520 $cascadeValue = ( $cascade && $action == 'edit' ) ?
1 : 0;
2522 'page_restrictions',
2524 'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2526 'pr_type' => $action,
2527 'pr_level' => $restrictions,
2528 'pr_cascade' => $cascadeValue,
2529 'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2533 $logRelationsValues[] = $dbw->insertId();
2534 $logParamsDetails[] = [
2536 'level' => $restrictions,
2537 'expiry' => $expiry[$action],
2538 'cascade' => (bool)$cascadeValue,
2543 // Clear out legacy restriction fields
2546 [ 'page_restrictions' => '' ],
2547 [ 'page_id' => $id ],
2551 Hooks
::run( 'NewRevisionFromEditComplete',
2552 [ $this, $nullRevision, $latest, $user ] );
2553 Hooks
::run( 'ArticleProtectComplete', [ &$this, &$user, $limit, $reason ] );
2554 } else { // Protection of non-existing page (also known as "title protection")
2555 // Cascade protection is meaningless in this case
2558 if ( $limit['create'] != '' ) {
2559 $dbw->replace( 'protected_titles',
2560 [ [ 'pt_namespace', 'pt_title' ] ],
2562 'pt_namespace' => $this->mTitle
->getNamespace(),
2563 'pt_title' => $this->mTitle
->getDBkey(),
2564 'pt_create_perm' => $limit['create'],
2565 'pt_timestamp' => $dbw->timestamp(),
2566 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2567 'pt_user' => $user->getId(),
2568 'pt_reason' => $reason,
2571 $logParamsDetails[] = [
2573 'level' => $limit['create'],
2574 'expiry' => $expiry['create'],
2577 $dbw->delete( 'protected_titles',
2579 'pt_namespace' => $this->mTitle
->getNamespace(),
2580 'pt_title' => $this->mTitle
->getDBkey()
2586 $this->mTitle
->flushRestrictions();
2587 InfoAction
::invalidateCache( $this->mTitle
);
2589 if ( $logAction == 'unprotect' ) {
2592 $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2594 '4::description' => $protectDescriptionLog, // parameter for IRC
2595 '5:bool:cascade' => $cascade,
2596 'details' => $logParamsDetails, // parameter for localize and api
2600 // Update the protection log
2601 $logEntry = new ManualLogEntry( 'protect', $logAction );
2602 $logEntry->setTarget( $this->mTitle
);
2603 $logEntry->setComment( $reason );
2604 $logEntry->setPerformer( $user );
2605 $logEntry->setParameters( $params );
2606 if ( !is_null( $nullRevision ) ) {
2607 $logEntry->setAssociatedRevId( $nullRevision->getId() );
2609 $logEntry->setTags( $tags );
2610 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2611 $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2613 $logId = $logEntry->insert();
2614 $logEntry->publish( $logId );
2616 return Status
::newGood( $logId );
2620 * Insert a new null revision for this page.
2622 * @param string $revCommentMsg Comment message key for the revision
2623 * @param array $limit Set of restriction keys
2624 * @param array $expiry Per restriction type expiration
2625 * @param int $cascade Set to false if cascading protection isn't allowed.
2626 * @param string $reason
2627 * @param User|null $user
2628 * @return Revision|null Null on error
2630 public function insertProtectNullRevision( $revCommentMsg, array $limit,
2631 array $expiry, $cascade, $reason, $user = null
2634 $dbw = wfGetDB( DB_MASTER
);
2636 // Prepare a null revision to be added to the history
2637 $editComment = $wgContLang->ucfirst(
2640 $this->mTitle
->getPrefixedText()
2641 )->inContentLanguage()->text()
2644 $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2646 $protectDescription = $this->protectDescription( $limit, $expiry );
2647 if ( $protectDescription ) {
2648 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2649 $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2650 ->inContentLanguage()->text();
2653 $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2654 $editComment .= wfMessage( 'brackets' )->params(
2655 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2656 )->inContentLanguage()->text();
2659 $nullRev = Revision
::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2661 $nullRev->insertOn( $dbw );
2663 // Update page record and touch page
2664 $oldLatest = $nullRev->getParentId();
2665 $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2672 * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2675 protected function formatExpiry( $expiry ) {
2678 if ( $expiry != 'infinity' ) {
2681 $wgContLang->timeanddate( $expiry, false, false ),
2682 $wgContLang->date( $expiry, false, false ),
2683 $wgContLang->time( $expiry, false, false )
2684 )->inContentLanguage()->text();
2686 return wfMessage( 'protect-expiry-indefinite' )
2687 ->inContentLanguage()->text();
2692 * Builds the description to serve as comment for the edit.
2694 * @param array $limit Set of restriction keys
2695 * @param array $expiry Per restriction type expiration
2698 public function protectDescription( array $limit, array $expiry ) {
2699 $protectDescription = '';
2701 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2702 # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2703 # All possible message keys are listed here for easier grepping:
2704 # * restriction-create
2705 # * restriction-edit
2706 # * restriction-move
2707 # * restriction-upload
2708 $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2709 # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2710 # with '' filtered out. All possible message keys are listed below:
2711 # * protect-level-autoconfirmed
2712 # * protect-level-sysop
2713 $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2714 ->inContentLanguage()->text();
2716 $expiryText = $this->formatExpiry( $expiry[$action] );
2718 if ( $protectDescription !== '' ) {
2719 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2721 $protectDescription .= wfMessage( 'protect-summary-desc' )
2722 ->params( $actionText, $restrictionsText, $expiryText )
2723 ->inContentLanguage()->text();
2726 return $protectDescription;
2730 * Builds the description to serve as comment for the log entry.
2732 * Some bots may parse IRC lines, which are generated from log entries which contain plain
2733 * protect description text. Keep them in old format to avoid breaking compatibility.
2734 * TODO: Fix protection log to store structured description and format it on-the-fly.
2736 * @param array $limit Set of restriction keys
2737 * @param array $expiry Per restriction type expiration
2740 public function protectDescriptionLog( array $limit, array $expiry ) {
2743 $protectDescriptionLog = '';
2745 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2746 $expiryText = $this->formatExpiry( $expiry[$action] );
2747 $protectDescriptionLog .= $wgContLang->getDirMark() .
2748 "[$action=$restrictions] ($expiryText)";
2751 return trim( $protectDescriptionLog );
2755 * Take an array of page restrictions and flatten it to a string
2756 * suitable for insertion into the page_restrictions field.
2758 * @param string[] $limit
2760 * @throws MWException
2763 protected static function flattenRestrictions( $limit ) {
2764 if ( !is_array( $limit ) ) {
2765 throw new MWException( __METHOD__
. ' given non-array restriction set' );
2771 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2772 $bits[] = "$action=$restrictions";
2775 return implode( ':', $bits );
2779 * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2780 * backwards compatibility, if you care about error reporting you should use
2781 * doDeleteArticleReal() instead.
2783 * Deletes the article with database consistency, writes logs, purges caches
2785 * @param string $reason Delete reason for deletion log
2786 * @param bool $suppress Suppress all revisions and log the deletion in
2787 * the suppression log instead of the deletion log
2788 * @param int $u1 Unused
2789 * @param bool $u2 Unused
2790 * @param array|string &$error Array of errors to append to
2791 * @param User $user The deleting user
2792 * @return bool True if successful
2794 public function doDeleteArticle(
2795 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null
2797 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2798 return $status->isGood();
2802 * Back-end article deletion
2803 * Deletes the article with database consistency, writes logs, purges caches
2807 * @param string $reason Delete reason for deletion log
2808 * @param bool $suppress Suppress all revisions and log the deletion in
2809 * the suppression log instead of the deletion log
2810 * @param int $u1 Unused
2811 * @param bool $u2 Unused
2812 * @param array|string &$error Array of errors to append to
2813 * @param User $user The deleting user
2814 * @return Status Status object; if successful, $status->value is the log_id of the
2815 * deletion log entry. If the page couldn't be deleted because it wasn't
2816 * found, $status is a non-fatal 'cannotdelete' error
2818 public function doDeleteArticleReal(
2819 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User
$user = null
2821 global $wgUser, $wgContentHandlerUseDB;
2823 wfDebug( __METHOD__
. "\n" );
2825 $status = Status
::newGood();
2827 if ( $this->mTitle
->getDBkey() === '' ) {
2828 $status->error( 'cannotdelete',
2829 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2833 $user = is_null( $user ) ?
$wgUser : $user;
2834 if ( !Hooks
::run( 'ArticleDelete',
2835 [ &$this, &$user, &$reason, &$error, &$status, $suppress ]
2837 if ( $status->isOK() ) {
2838 // Hook aborted but didn't set a fatal status
2839 $status->fatal( 'delete-hook-aborted' );
2844 $dbw = wfGetDB( DB_MASTER
);
2845 $dbw->startAtomic( __METHOD__
);
2847 $this->loadPageData( self
::READ_LATEST
);
2848 $id = $this->getId();
2849 // T98706: lock the page from various other updates but avoid using
2850 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2851 // the revisions queries (which also JOIN on user). Only lock the page
2852 // row and CAS check on page_latest to see if the trx snapshot matches.
2853 $lockedLatest = $this->lockAndGetLatest();
2854 if ( $id == 0 ||
$this->getLatest() != $lockedLatest ) {
2855 $dbw->endAtomic( __METHOD__
);
2856 // Page not there or trx snapshot is stale
2857 $status->error( 'cannotdelete',
2858 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2862 // At this point we are now comitted to returning an OK
2863 // status unless some DB query error or other exception comes up.
2864 // This way callers don't have to call rollback() if $status is bad
2865 // unless they actually try to catch exceptions (which is rare).
2867 // we need to remember the old content so we can use it to generate all deletion updates.
2868 $content = $this->getContent( Revision
::RAW
);
2870 // Bitfields to further suppress the content
2873 // This should be 15...
2874 $bitfield |
= Revision
::DELETED_TEXT
;
2875 $bitfield |
= Revision
::DELETED_COMMENT
;
2876 $bitfield |
= Revision
::DELETED_USER
;
2877 $bitfield |
= Revision
::DELETED_RESTRICTED
;
2879 $bitfield = 'rev_deleted';
2883 * For now, shunt the revision data into the archive table.
2884 * Text is *not* removed from the text table; bulk storage
2885 * is left intact to avoid breaking block-compression or
2886 * immutable storage schemes.
2888 * For backwards compatibility, note that some older archive
2889 * table entries will have ar_text and ar_flags fields still.
2891 * In the future, we may keep revisions and mark them with
2892 * the rev_deleted field, which is reserved for this purpose.
2896 'ar_namespace' => 'page_namespace',
2897 'ar_title' => 'page_title',
2898 'ar_comment' => 'rev_comment',
2899 'ar_user' => 'rev_user',
2900 'ar_user_text' => 'rev_user_text',
2901 'ar_timestamp' => 'rev_timestamp',
2902 'ar_minor_edit' => 'rev_minor_edit',
2903 'ar_rev_id' => 'rev_id',
2904 'ar_parent_id' => 'rev_parent_id',
2905 'ar_text_id' => 'rev_text_id',
2906 'ar_text' => '\'\'', // Be explicit to appease
2907 'ar_flags' => '\'\'', // MySQL's "strict mode"...
2908 'ar_len' => 'rev_len',
2909 'ar_page_id' => 'page_id',
2910 'ar_deleted' => $bitfield,
2911 'ar_sha1' => 'rev_sha1',
2914 if ( $wgContentHandlerUseDB ) {
2915 $row['ar_content_model'] = 'rev_content_model';
2916 $row['ar_content_format'] = 'rev_content_format';
2919 // Copy all the page revisions into the archive table
2922 [ 'page', 'revision' ],
2926 'page_id = rev_page'
2930 // Save this so we can pass it to the ArticleDeleteComplete hook.
2931 $archivedRevisionCount = $dbw->affectedRows();
2933 // Now that it's safely backed up, delete it
2934 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__
);
2936 if ( !$dbw->cascadingDeletes() ) {
2937 $dbw->delete( 'revision', [ 'rev_page' => $id ], __METHOD__
);
2940 // Clone the title, so we have the information we need when we log
2941 $logTitle = clone $this->mTitle
;
2943 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2944 $logtype = $suppress ?
'suppress' : 'delete';
2946 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2947 $logEntry->setPerformer( $user );
2948 $logEntry->setTarget( $logTitle );
2949 $logEntry->setComment( $reason );
2950 $logid = $logEntry->insert();
2952 $dbw->onTransactionPreCommitOrIdle( function () use ( $dbw, $logEntry, $logid ) {
2953 // Bug 56776: avoid deadlocks (especially from FileDeleteForm)
2954 $logEntry->publish( $logid );
2957 $dbw->endAtomic( __METHOD__
);
2959 $this->doDeleteUpdates( $id, $content );
2961 Hooks
::run( 'ArticleDeleteComplete',
2962 [ &$this, &$user, $reason, $id, $content, $logEntry, $archivedRevisionCount ] );
2963 $status->value
= $logid;
2965 // Show log excerpt on 404 pages rather than just a link
2966 $cache = ObjectCache
::getMainStashInstance();
2967 $key = wfMemcKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2968 $cache->set( $key, 1, $cache::TTL_DAY
);
2974 * Lock the page row for this title+id and return page_latest (or 0)
2976 * @return integer Returns 0 if no row was found with this title+id
2979 public function lockAndGetLatest() {
2980 return (int)wfGetDB( DB_MASTER
)->selectField(
2984 'page_id' => $this->getId(),
2985 // Typically page_id is enough, but some code might try to do
2986 // updates assuming the title is the same, so verify that
2987 'page_namespace' => $this->getTitle()->getNamespace(),
2988 'page_title' => $this->getTitle()->getDBkey()
2996 * Do some database updates after deletion
2998 * @param int $id The page_id value of the page being deleted
2999 * @param Content $content Optional page content to be used when determining
3000 * the required updates. This may be needed because $this->getContent()
3001 * may already return null when the page proper was deleted.
3003 public function doDeleteUpdates( $id, Content
$content = null ) {
3004 // Update site status
3005 DeferredUpdates
::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
3007 // Delete pagelinks, update secondary indexes, etc
3008 $updates = $this->getDeletionUpdates( $content );
3009 foreach ( $updates as $update ) {
3010 DeferredUpdates
::addUpdate( $update );
3013 // Reparse any pages transcluding this page
3014 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'templatelinks' );
3016 // Reparse any pages including this image
3017 if ( $this->mTitle
->getNamespace() == NS_FILE
) {
3018 LinksUpdate
::queueRecursiveJobsForTable( $this->mTitle
, 'imagelinks' );
3022 WikiPage
::onArticleDelete( $this->mTitle
);
3024 // Reset this object and the Title object
3025 $this->loadFromRow( false, self
::READ_LATEST
);
3028 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $this->mTitle
) );
3032 * Roll back the most recent consecutive set of edits to a page
3033 * from the same user; fails if there are no eligible edits to
3034 * roll back to, e.g. user is the sole contributor. This function
3035 * performs permissions checks on $user, then calls commitRollback()
3036 * to do the dirty work
3038 * @todo Separate the business/permission stuff out from backend code
3039 * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3041 * @param string $fromP Name of the user whose edits to rollback.
3042 * @param string $summary Custom summary. Set to default summary if empty.
3043 * @param string $token Rollback token.
3044 * @param bool $bot If true, mark all reverted edits as bot.
3046 * @param array $resultDetails Array contains result-specific array of additional values
3047 * 'alreadyrolled' : 'current' (rev)
3048 * success : 'summary' (str), 'current' (rev), 'target' (rev)
3050 * @param User $user The user performing the rollback
3051 * @param array|null $tags Change tags to apply to the rollback
3052 * Callers are responsible for permission checks
3053 * (with ChangeTags::canAddTagsAccompanyingChange)
3055 * @return array Array of errors, each error formatted as
3056 * array(messagekey, param1, param2, ...).
3057 * On success, the array is empty. This array can also be passed to
3058 * OutputPage::showPermissionsErrorPage().
3060 public function doRollback(
3061 $fromP, $summary, $token, $bot, &$resultDetails, User
$user, $tags = null
3063 $resultDetails = null;
3065 // Check permissions
3066 $editErrors = $this->mTitle
->getUserPermissionsErrors( 'edit', $user );
3067 $rollbackErrors = $this->mTitle
->getUserPermissionsErrors( 'rollback', $user );
3068 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3070 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3071 $errors[] = [ 'sessionfailure' ];
3074 if ( $user->pingLimiter( 'rollback' ) ||
$user->pingLimiter() ) {
3075 $errors[] = [ 'actionthrottledtext' ];
3078 // If there were errors, bail out now
3079 if ( !empty( $errors ) ) {
3083 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3087 * Backend implementation of doRollback(), please refer there for parameter
3088 * and return value documentation
3090 * NOTE: This function does NOT check ANY permissions, it just commits the
3091 * rollback to the DB. Therefore, you should only call this function direct-
3092 * ly if you want to use custom permissions checks. If you don't, use
3093 * doRollback() instead.
3094 * @param string $fromP Name of the user whose edits to rollback.
3095 * @param string $summary Custom summary. Set to default summary if empty.
3096 * @param bool $bot If true, mark all reverted edits as bot.
3098 * @param array $resultDetails Contains result-specific array of additional values
3099 * @param User $guser The user performing the rollback
3100 * @param array|null $tags Change tags to apply to the rollback
3101 * Callers are responsible for permission checks
3102 * (with ChangeTags::canAddTagsAccompanyingChange)
3106 public function commitRollback( $fromP, $summary, $bot,
3107 &$resultDetails, User
$guser, $tags = null
3109 global $wgUseRCPatrol, $wgContLang;
3111 $dbw = wfGetDB( DB_MASTER
);
3113 if ( wfReadOnly() ) {
3114 return [ [ 'readonlytext' ] ];
3117 // Get the last editor
3118 $current = $this->getRevision();
3119 if ( is_null( $current ) ) {
3120 // Something wrong... no page?
3121 return [ [ 'notanarticle' ] ];
3124 $from = str_replace( '_', ' ', $fromP );
3125 // User name given should match up with the top revision.
3126 // If the user was deleted then $from should be empty.
3127 if ( $from != $current->getUserText() ) {
3128 $resultDetails = [ 'current' => $current ];
3129 return [ [ 'alreadyrolled',
3130 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3131 htmlspecialchars( $fromP ),
3132 htmlspecialchars( $current->getUserText() )
3136 // Get the last edit not by this person...
3137 // Note: these may not be public values
3138 $user = intval( $current->getUser( Revision
::RAW
) );
3139 $user_text = $dbw->addQuotes( $current->getUserText( Revision
::RAW
) );
3140 $s = $dbw->selectRow( 'revision',
3141 [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3142 [ 'rev_page' => $current->getPage(),
3143 "rev_user != {$user} OR rev_user_text != {$user_text}"
3145 [ 'USE INDEX' => 'page_timestamp',
3146 'ORDER BY' => 'rev_timestamp DESC' ]
3148 if ( $s === false ) {
3149 // No one else ever edited this page
3150 return [ [ 'cantrollback' ] ];
3151 } elseif ( $s->rev_deleted
& Revision
::DELETED_TEXT
3152 ||
$s->rev_deleted
& Revision
::DELETED_USER
3154 // Only admins can see this text
3155 return [ [ 'notvisiblerev' ] ];
3158 // Generate the edit summary if necessary
3159 $target = Revision
::newFromId( $s->rev_id
, Revision
::READ_LATEST
);
3160 if ( empty( $summary ) ) {
3161 if ( $from == '' ) { // no public user name
3162 $summary = wfMessage( 'revertpage-nouser' );
3164 $summary = wfMessage( 'revertpage' );
3168 // Allow the custom summary to use the same args as the default message
3170 $target->getUserText(), $from, $s->rev_id
,
3171 $wgContLang->timeanddate( wfTimestamp( TS_MW
, $s->rev_timestamp
) ),
3172 $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3174 if ( $summary instanceof Message
) {
3175 $summary = $summary->params( $args )->inContentLanguage()->text();
3177 $summary = wfMsgReplaceArgs( $summary, $args );
3180 // Trim spaces on user supplied text
3181 $summary = trim( $summary );
3183 // Truncate for whole multibyte characters.
3184 $summary = $wgContLang->truncate( $summary, 255 );
3187 $flags = EDIT_UPDATE | EDIT_INTERNAL
;
3189 if ( $guser->isAllowed( 'minoredit' ) ) {
3190 $flags |
= EDIT_MINOR
;
3193 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3194 $flags |
= EDIT_FORCE_BOT
;
3197 // Actually store the edit
3198 $status = $this->doEditContent(
3199 $target->getContent(),
3208 // Set patrolling and bot flag on the edits, which gets rollbacked.
3209 // This is done even on edit failure to have patrolling in that case (bug 62157).
3211 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3212 // Mark all reverted edits as bot
3216 if ( $wgUseRCPatrol ) {
3217 // Mark all reverted edits as patrolled
3218 $set['rc_patrolled'] = 1;
3221 if ( count( $set ) ) {
3222 $dbw->update( 'recentchanges', $set,
3224 'rc_cur_id' => $current->getPage(),
3225 'rc_user_text' => $current->getUserText(),
3226 'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp
),
3232 if ( !$status->isOK() ) {
3233 return $status->getErrorsArray();
3236 // raise error, when the edit is an edit without a new version
3237 $statusRev = isset( $status->value
['revision'] )
3238 ?
$status->value
['revision']
3240 if ( !( $statusRev instanceof Revision
) ) {
3241 $resultDetails = [ 'current' => $current ];
3242 return [ [ 'alreadyrolled',
3243 htmlspecialchars( $this->mTitle
->getPrefixedText() ),
3244 htmlspecialchars( $fromP ),
3245 htmlspecialchars( $current->getUserText() )
3249 $revId = $statusRev->getId();
3251 Hooks
::run( 'ArticleRollbackComplete', [ $this, $guser, $target, $current ] );
3254 'summary' => $summary,
3255 'current' => $current,
3256 'target' => $target,
3264 * The onArticle*() functions are supposed to be a kind of hooks
3265 * which should be called whenever any of the specified actions
3268 * This is a good place to put code to clear caches, for instance.
3270 * This is called on page move and undelete, as well as edit
3272 * @param Title $title
3274 public static function onArticleCreate( Title
$title ) {
3275 // Update existence markers on article/talk tabs...
3276 $other = $title->getOtherPage();
3278 $other->purgeSquid();
3280 $title->touchLinks();
3281 $title->purgeSquid();
3282 $title->deleteTitleProtection();
3284 if ( $title->getNamespace() == NS_CATEGORY
) {
3285 // Load the Category object, which will schedule a job to create
3286 // the category table row if necessary. Checking a slave is ok
3287 // here, in the worst case it'll run an unnecessary recount job on
3288 // a category that probably doesn't have many members.
3289 Category
::newFromTitle( $title )->getID();
3294 * Clears caches when article is deleted
3296 * @param Title $title
3298 public static function onArticleDelete( Title
$title ) {
3301 // Update existence markers on article/talk tabs...
3302 $other = $title->getOtherPage();
3304 $other->purgeSquid();
3306 $title->touchLinks();
3307 $title->purgeSquid();
3310 HTMLFileCache
::clearFileCache( $title );
3311 InfoAction
::invalidateCache( $title );
3314 if ( $title->getNamespace() == NS_MEDIAWIKI
) {
3315 MessageCache
::singleton()->replace( $title->getDBkey(), false );
3317 if ( $wgContLang->hasVariants() ) {
3318 $wgContLang->updateConversionTable( $title );
3323 if ( $title->getNamespace() == NS_FILE
) {
3324 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'imagelinks' ) );
3328 if ( $title->getNamespace() == NS_USER_TALK
) {
3329 $user = User
::newFromName( $title->getText(), false );
3331 $user->setNewtalk( false );
3336 RepoGroup
::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3340 * Purge caches on page update etc
3342 * @param Title $title
3343 * @param Revision|null $revision Revision that was just saved, may be null
3345 public static function onArticleEdit( Title
$title, Revision
$revision = null ) {
3346 // Invalidate caches of articles which include this page
3347 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3349 // Invalidate the caches of all pages which redirect here
3350 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $title, 'redirect' ) );
3352 // Purge CDN for this page only
3353 $title->purgeSquid();
3354 // Clear file cache for this page only
3355 HTMLFileCache
::clearFileCache( $title );
3357 $revid = $revision ?
$revision->getId() : null;
3358 DeferredUpdates
::addCallableUpdate( function() use ( $title, $revid ) {
3359 InfoAction
::invalidateCache( $title, $revid );
3366 * Returns a list of categories this page is a member of.
3367 * Results will include hidden categories
3369 * @return TitleArray
3371 public function getCategories() {
3372 $id = $this->getId();
3374 return TitleArray
::newFromResult( new FakeResultWrapper( [] ) );
3377 $dbr = wfGetDB( DB_SLAVE
);
3378 $res = $dbr->select( 'categorylinks',
3379 [ 'cl_to AS page_title, ' . NS_CATEGORY
. ' AS page_namespace' ],
3380 // Have to do that since DatabaseBase::fieldNamesWithAlias treats numeric indexes
3381 // as not being aliases, and NS_CATEGORY is numeric
3382 [ 'cl_from' => $id ],
3385 return TitleArray
::newFromResult( $res );
3389 * Returns a list of hidden categories this page is a member of.
3390 * Uses the page_props and categorylinks tables.
3392 * @return array Array of Title objects
3394 public function getHiddenCategories() {
3396 $id = $this->getId();
3402 $dbr = wfGetDB( DB_SLAVE
);
3403 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3405 [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3406 'page_namespace' => NS_CATEGORY
, 'page_title=cl_to' ],
3409 if ( $res !== false ) {
3410 foreach ( $res as $row ) {
3411 $result[] = Title
::makeTitle( NS_CATEGORY
, $row->cl_to
);
3419 * Return an applicable autosummary if one exists for the given edit.
3420 * @param string|null $oldtext The previous text of the page.
3421 * @param string|null $newtext The submitted text of the page.
3422 * @param int $flags Bitmask: a bitmask of flags submitted for the edit.
3423 * @return string An appropriate autosummary, or an empty string.
3425 * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3427 public static function getAutosummary( $oldtext, $newtext, $flags ) {
3428 // NOTE: stub for backwards-compatibility. assumes the given text is
3429 // wikitext. will break horribly if it isn't.
3431 ContentHandler
::deprecated( __METHOD__
, '1.21' );
3433 $handler = ContentHandler
::getForModelID( CONTENT_MODEL_WIKITEXT
);
3434 $oldContent = is_null( $oldtext ) ?
null : $handler->unserializeContent( $oldtext );
3435 $newContent = is_null( $newtext ) ?
null : $handler->unserializeContent( $newtext );
3437 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3441 * Auto-generates a deletion reason
3443 * @param bool &$hasHistory Whether the page has a history
3444 * @return string|bool String containing deletion reason or empty string, or boolean false
3445 * if no revision occurred
3447 public function getAutoDeleteReason( &$hasHistory ) {
3448 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3452 * Update all the appropriate counts in the category table, given that
3453 * we've added the categories $added and deleted the categories $deleted.
3455 * @param array $added The names of categories that were added
3456 * @param array $deleted The names of categories that were deleted
3457 * @param integer $id Page ID (this should be the original deleted page ID)
3459 public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3460 $id = $id ?
: $this->getId();
3461 $dbw = wfGetDB( DB_MASTER
);
3462 $method = __METHOD__
;
3463 // Do this at the end of the commit to reduce lock wait timeouts
3464 $dbw->onTransactionPreCommitOrIdle(
3465 function () use ( $dbw, $added, $deleted, $id, $method ) {
3466 $ns = $this->getTitle()->getNamespace();
3468 $addFields = [ 'cat_pages = cat_pages + 1' ];
3469 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3470 if ( $ns == NS_CATEGORY
) {
3471 $addFields[] = 'cat_subcats = cat_subcats + 1';
3472 $removeFields[] = 'cat_subcats = cat_subcats - 1';
3473 } elseif ( $ns == NS_FILE
) {
3474 $addFields[] = 'cat_files = cat_files + 1';
3475 $removeFields[] = 'cat_files = cat_files - 1';
3478 if ( count( $added ) ) {
3479 $existingAdded = $dbw->selectFieldValues(
3482 [ 'cat_title' => $added ],
3486 // For category rows that already exist, do a plain
3487 // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3488 // to avoid creating gaps in the cat_id sequence.
3489 if ( count( $existingAdded ) ) {
3493 [ 'cat_title' => $existingAdded ],
3498 $missingAdded = array_diff( $added, $existingAdded );
3499 if ( count( $missingAdded ) ) {
3501 foreach ( $missingAdded as $cat ) {
3503 'cat_title' => $cat,
3505 'cat_subcats' => ( $ns == NS_CATEGORY
) ?
1 : 0,
3506 'cat_files' => ( $ns == NS_FILE
) ?
1 : 0,
3519 if ( count( $deleted ) ) {
3523 [ 'cat_title' => $deleted ],
3528 foreach ( $added as $catName ) {
3529 $cat = Category
::newFromName( $catName );
3530 Hooks
::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3533 foreach ( $deleted as $catName ) {
3534 $cat = Category
::newFromName( $catName );
3535 Hooks
::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3538 // Refresh counts on categories that should be empty now, to
3539 // trigger possible deletion. Check master for the most
3540 // up-to-date cat_pages.
3541 if ( count( $deleted ) ) {
3542 $rows = $dbw->select(
3544 [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
3545 [ 'cat_title' => $deleted, 'cat_pages <= 0' ],
3548 foreach ( $rows as $row ) {
3549 $cat = Category
::newFromRow( $row );
3550 $cat->refreshCounts();
3558 * Opportunistically enqueue link update jobs given fresh parser output if useful
3560 * @param ParserOutput $parserOutput Current version page output
3563 public function triggerOpportunisticLinksUpdate( ParserOutput
$parserOutput ) {
3564 if ( wfReadOnly() ) {
3568 if ( !Hooks
::run( 'OpportunisticLinksUpdate',
3569 [ $this, $this->mTitle
, $parserOutput ]
3574 $config = RequestContext
::getMain()->getConfig();
3577 'isOpportunistic' => true,
3578 'rootJobTimestamp' => $parserOutput->getCacheTime()
3581 if ( $this->mTitle
->areRestrictionsCascading() ) {
3582 // If the page is cascade protecting, the links should really be up-to-date
3583 JobQueueGroup
::singleton()->lazyPush(
3584 RefreshLinksJob
::newPrioritized( $this->mTitle
, $params )
3586 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3587 // Assume the output contains "dynamic" time/random based magic words.
3588 // Only update pages that expired due to dynamic content and NOT due to edits
3589 // to referenced templates/files. When the cache expires due to dynamic content,
3590 // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3591 // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3592 // template/file edit already triggered recursive RefreshLinksJob jobs.
3593 if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3594 // If a page is uncacheable, do not keep spamming a job for it.
3595 // Although it would be de-duplicated, it would still waste I/O.
3596 $cache = ObjectCache
::getLocalClusterInstance();
3597 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3598 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3599 if ( $cache->add( $key, time(), $ttl ) ) {
3600 JobQueueGroup
::singleton()->lazyPush(
3601 RefreshLinksJob
::newDynamic( $this->mTitle
, $params )
3609 * Returns a list of updates to be performed when this page is deleted. The
3610 * updates should remove any information about this page from secondary data
3611 * stores such as links tables.
3613 * @param Content|null $content Optional Content object for determining the
3614 * necessary updates.
3615 * @return DataUpdate[]
3617 public function getDeletionUpdates( Content
$content = null ) {
3619 // load content object, which may be used to determine the necessary updates.
3620 // XXX: the content may not be needed to determine the updates.
3621 $content = $this->getContent( Revision
::RAW
);
3627 $updates = $content->getDeletionUpdates( $this );
3630 Hooks
::run( 'WikiPageDeletionUpdates', [ $this, $content, &$updates ] );