includes/page/WikiPage.php

   1 <?php
   2 /**
   3  * Base representation for a MediaWiki page.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  */
  22
  23 use MediaWiki\Edit\PreparedEdit;
  24 use MediaWiki\Logger\LoggerFactory;
  25 use MediaWiki\MediaWikiServices;
  26 use Wikimedia\Assert\Assert;
  27 use Wikimedia\Rdbms\FakeResultWrapper;
  28 use Wikimedia\Rdbms\IDatabase;
  29 use Wikimedia\Rdbms\DBUnexpectedError;
  30
  31 /**
  32  * Class representing a MediaWiki article and history.
  33  *
  34  * Some fields are public only for backwards-compatibility. Use accessors.
  35  * In the past, this class was part of Article.php and everything was public.
  36  */
  37 class WikiPage implements Page, IDBAccessObject {
  38         // Constants for $mDataLoadedFrom and related
  39
  40         /**
  41          * @var Title
  42          */
  43         public $mTitle = null;
  44
  45         /**@{{
  46          * @protected
  47          */
  48         public $mDataLoaded = false;         // !< Boolean
  49         public $mIsRedirect = false;         // !< Boolean
  50         public $mLatest = false;             // !< Integer (false means "not loaded")
  51         /**@}}*/
  52
  53         /** @var PreparedEdit Map of cache fields (text, parser output, ect) for a proposed/new edit */
  54         public $mPreparedEdit = false;
  55
  56         /**
  57          * @var int
  58          */
  59         protected $mId = null;
  60
  61         /**
  62          * @var int One of the READ_* constants
  63          */
  64         protected $mDataLoadedFrom = self::READ_NONE;
  65
  66         /**
  67          * @var Title
  68          */
  69         protected $mRedirectTarget = null;
  70
  71         /**
  72          * @var Revision
  73          */
  74         protected $mLastRevision = null;
  75
  76         /**
  77          * @var string Timestamp of the current revision or empty string if not loaded
  78          */
  79         protected $mTimestamp = '';
  80
  81         /**
  82          * @var string
  83          */
  84         protected $mTouched = '19700101000000';
  85
  86         /**
  87          * @var string
  88          */
  89         protected $mLinksUpdated = '19700101000000';
  90
  91         /**
  92          * Constructor and clear the article
  93          * @param Title $title Reference to a Title object.
  94          */
  95         public function __construct( Title $title ) {
  96                 $this->mTitle = $title;
  97         }
  98
  99         /**
 100          * Makes sure that the mTitle object is cloned
 101          * to the newly cloned WikiPage.
 102          */
 103         public function __clone() {
 104                 $this->mTitle = clone $this->mTitle;
 105         }
 106
 107         /**
 108          * Create a WikiPage object of the appropriate class for the given title.
 109          *
 110          * @param Title $title
 111          *
 112          * @throws MWException
 113          * @return WikiPage|WikiCategoryPage|WikiFilePage
 114          */
 115         public static function factory( Title $title ) {
 116                 $ns = $title->getNamespace();
 117
 118                 if ( $ns == NS_MEDIA ) {
 119                         throw new MWException( "NS_MEDIA is a virtual namespace; use NS_FILE." );
 120                 } elseif ( $ns < 0 ) {
 121                         throw new MWException( "Invalid or virtual namespace $ns given." );
 122                 }
 123
 124                 $page = null;
 125                 if ( !Hooks::run( 'WikiPageFactory', [ $title, &$page ] ) ) {
 126                         return $page;
 127                 }
 128
 129                 switch ( $ns ) {
 130                         case NS_FILE:
 131                                 $page = new WikiFilePage( $title );
 132                                 break;
 133                         case NS_CATEGORY:
 134                                 $page = new WikiCategoryPage( $title );
 135                                 break;
 136                         default:
 137                                 $page = new WikiPage( $title );
 138                 }
 139
 140                 return $page;
 141         }
 142
 143         /**
 144          * Constructor from a page id
 145          *
 146          * @param int $id Article ID to load
 147          * @param string|int $from One of the following values:
 148          *        - "fromdb" or WikiPage::READ_NORMAL to select from a replica DB
 149          *        - "fromdbmaster" or WikiPage::READ_LATEST to select from the master database
 150          *
 151          * @return WikiPage|null
 152          */
 153         public static function newFromID( $id, $from = 'fromdb' ) {
 154                 // page ids are never 0 or negative, see T63166
 155                 if ( $id < 1 ) {
 156                         return null;
 157                 }
 158
 159                 $from = self::convertSelectType( $from );
 160                 $db = wfGetDB( $from === self::READ_LATEST ? DB_MASTER : DB_REPLICA );
 161                 $pageQuery = self::getQueryInfo();
 162                 $row = $db->selectRow(
 163                         $pageQuery['tables'], $pageQuery['fields'], [ 'page_id' => $id ], __METHOD__,
 164                         [], $pageQuery['joins']
 165                 );
 166                 if ( !$row ) {
 167                         return null;
 168                 }
 169                 return self::newFromRow( $row, $from );
 170         }
 171
 172         /**
 173          * Constructor from a database row
 174          *
 175          * @since 1.20
 176          * @param object $row Database row containing at least fields returned by selectFields().
 177          * @param string|int $from Source of $data:
 178          *        - "fromdb" or WikiPage::READ_NORMAL: from a replica DB
 179          *        - "fromdbmaster" or WikiPage::READ_LATEST: from the master DB
 180          *        - "forupdate" or WikiPage::READ_LOCKING: from the master DB using SELECT FOR UPDATE
 181          * @return WikiPage
 182          */
 183         public static function newFromRow( $row, $from = 'fromdb' ) {
 184                 $page = self::factory( Title::newFromRow( $row ) );
 185                 $page->loadFromRow( $row, $from );
 186                 return $page;
 187         }
 188
 189         /**
 190          * Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.
 191          *
 192          * @param object|string|int $type
 193          * @return mixed
 194          */
 195         private static function convertSelectType( $type ) {
 196                 switch ( $type ) {
 197                         case 'fromdb':
 198                                 return self::READ_NORMAL;
 199                         case 'fromdbmaster':
 200                                 return self::READ_LATEST;
 201                         case 'forupdate':
 202                                 return self::READ_LOCKING;
 203                         default:
 204                                 // It may already be an integer or whatever else
 205                                 return $type;
 206                 }
 207         }
 208
 209         /**
 210          * @todo Move this UI stuff somewhere else
 211          *
 212          * @see ContentHandler::getActionOverrides
 213          * @return array
 214          */
 215         public function getActionOverrides() {
 216                 return $this->getContentHandler()->getActionOverrides();
 217         }
 218
 219         /**
 220          * Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
 221          *
 222          * Shorthand for ContentHandler::getForModelID( $this->getContentModel() );
 223          *
 224          * @return ContentHandler
 225          *
 226          * @since 1.21
 227          */
 228         public function getContentHandler() {
 229                 return ContentHandler::getForModelID( $this->getContentModel() );
 230         }
 231
 232         /**
 233          * Get the title object of the article
 234          * @return Title Title object of this page
 235          */
 236         public function getTitle() {
 237                 return $this->mTitle;
 238         }
 239
 240         /**
 241          * Clear the object
 242          * @return void
 243          */
 244         public function clear() {
 245                 $this->mDataLoaded = false;
 246                 $this->mDataLoadedFrom = self::READ_NONE;
 247
 248                 $this->clearCacheFields();
 249         }
 250
 251         /**
 252          * Clear the object cache fields
 253          * @return void
 254          */
 255         protected function clearCacheFields() {
 256                 $this->mId = null;
 257                 $this->mRedirectTarget = null; // Title object if set
 258                 $this->mLastRevision = null; // Latest revision
 259                 $this->mTouched = '19700101000000';
 260                 $this->mLinksUpdated = '19700101000000';
 261                 $this->mTimestamp = '';
 262                 $this->mIsRedirect = false;
 263                 $this->mLatest = false;
 264                 // T59026: do not clear mPreparedEdit since prepareTextForEdit() already checks
 265                 // the requested rev ID and content against the cached one for equality. For most
 266                 // content types, the output should not change during the lifetime of this cache.
 267                 // Clearing it can cause extra parses on edit for no reason.
 268         }
 269
 270         /**
 271          * Clear the mPreparedEdit cache field, as may be needed by mutable content types
 272          * @return void
 273          * @since 1.23
 274          */
 275         public function clearPreparedEdit() {
 276                 $this->mPreparedEdit = false;
 277         }
 278
 279         /**
 280          * Return the list of revision fields that should be selected to create
 281          * a new page.
 282          *
 283          * @deprecated since 1.31, use self::getQueryInfo() instead.
 284          * @return array
 285          */
 286         public static function selectFields() {
 287                 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
 288
 289                 wfDeprecated( __METHOD__, '1.31' );
 290
 291                 $fields = [
 292                         'page_id',
 293                         'page_namespace',
 294                         'page_title',
 295                         'page_restrictions',
 296                         'page_is_redirect',
 297                         'page_is_new',
 298                         'page_random',
 299                         'page_touched',
 300                         'page_links_updated',
 301                         'page_latest',
 302                         'page_len',
 303                 ];
 304
 305                 if ( $wgContentHandlerUseDB ) {
 306                         $fields[] = 'page_content_model';
 307                 }
 308
 309                 if ( $wgPageLanguageUseDB ) {
 310                         $fields[] = 'page_lang';
 311                 }
 312
 313                 return $fields;
 314         }
 315
 316         /**
 317          * Return the tables, fields, and join conditions to be selected to create
 318          * a new page object.
 319          * @since 1.31
 320          * @return array With three keys:
 321          *   - tables: (string[]) to include in the `$table` to `IDatabase->select()`
 322          *   - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
 323          *   - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
 324          */
 325         public static function getQueryInfo() {
 326                 global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
 327
 328                 $ret = [
 329                         'tables' => [ 'page' ],
 330                         'fields' => [
 331                                 'page_id',
 332                                 'page_namespace',
 333                                 'page_title',
 334                                 'page_restrictions',
 335                                 'page_is_redirect',
 336                                 'page_is_new',
 337                                 'page_random',
 338                                 'page_touched',
 339                                 'page_links_updated',
 340                                 'page_latest',
 341                                 'page_len',
 342                         ],
 343                         'joins' => [],
 344                 ];
 345
 346                 if ( $wgContentHandlerUseDB ) {
 347                         $ret['fields'][] = 'page_content_model';
 348                 }
 349
 350                 if ( $wgPageLanguageUseDB ) {
 351                         $ret['fields'][] = 'page_lang';
 352                 }
 353
 354                 return $ret;
 355         }
 356
 357         /**
 358          * Fetch a page record with the given conditions
 359          * @param IDatabase $dbr
 360          * @param array $conditions
 361          * @param array $options
 362          * @return object|bool Database result resource, or false on failure
 363          */
 364         protected function pageData( $dbr, $conditions, $options = [] ) {
 365                 $pageQuery = self::getQueryInfo();
 366
 367                 // Avoid PHP 7.1 warning of passing $this by reference
 368                 $wikiPage = $this;
 369
 370                 Hooks::run( 'ArticlePageDataBefore', [
 371                         &$wikiPage, &$pageQuery['fields'], &$pageQuery['tables'], &$pageQuery['joins']
 372                 ] );
 373
 374                 $row = $dbr->selectRow(
 375                         $pageQuery['tables'],
 376                         $pageQuery['fields'],
 377                         $conditions,
 378                         __METHOD__,
 379                         $options,
 380                         $pageQuery['joins']
 381                 );
 382
 383                 Hooks::run( 'ArticlePageDataAfter', [ &$wikiPage, &$row ] );
 384
 385                 return $row;
 386         }
 387
 388         /**
 389          * Fetch a page record matching the Title object's namespace and title
 390          * using a sanitized title string
 391          *
 392          * @param IDatabase $dbr
 393          * @param Title $title
 394          * @param array $options
 395          * @return object|bool Database result resource, or false on failure
 396          */
 397         public function pageDataFromTitle( $dbr, $title, $options = [] ) {
 398                 return $this->pageData( $dbr, [
 399                         'page_namespace' => $title->getNamespace(),
 400                         'page_title' => $title->getDBkey() ], $options );
 401         }
 402
 403         /**
 404          * Fetch a page record matching the requested ID
 405          *
 406          * @param IDatabase $dbr
 407          * @param int $id
 408          * @param array $options
 409          * @return object|bool Database result resource, or false on failure
 410          */
 411         public function pageDataFromId( $dbr, $id, $options = [] ) {
 412                 return $this->pageData( $dbr, [ 'page_id' => $id ], $options );
 413         }
 414
 415         /**
 416          * Load the object from a given source by title
 417          *
 418          * @param object|string|int $from One of the following:
 419          *   - A DB query result object.
 420          *   - "fromdb" or WikiPage::READ_NORMAL to get from a replica DB.
 421          *   - "fromdbmaster" or WikiPage::READ_LATEST to get from the master DB.
 422          *   - "forupdate"  or WikiPage::READ_LOCKING to get from the master DB
 423          *     using SELECT FOR UPDATE.
 424          *
 425          * @return void
 426          */
 427         public function loadPageData( $from = 'fromdb' ) {
 428                 $from = self::convertSelectType( $from );
 429                 if ( is_int( $from ) && $from <= $this->mDataLoadedFrom ) {
 430                         // We already have the data from the correct location, no need to load it twice.
 431                         return;
 432                 }
 433
 434                 if ( is_int( $from ) ) {
 435                         list( $index, $opts ) = DBAccessObjectUtils::getDBOptions( $from );
 436                         $loadBalancer = MediaWikiServices::getInstance()->getDBLoadBalancer();
 437                         $db = $loadBalancer->getConnection( $index );
 438                         $data = $this->pageDataFromTitle( $db, $this->mTitle, $opts );
 439
 440                         if ( !$data
 441                                 && $index == DB_REPLICA
 442                                 && $loadBalancer->getServerCount() > 1
 443                                 && $loadBalancer->hasOrMadeRecentMasterChanges()
 444                         ) {
 445                                 $from = self::READ_LATEST;
 446                                 list( $index, $opts ) = DBAccessObjectUtils::getDBOptions( $from );
 447                                 $db = $loadBalancer->getConnection( $index );
 448                                 $data = $this->pageDataFromTitle( $db, $this->mTitle, $opts );
 449                         }
 450                 } else {
 451                         // No idea from where the caller got this data, assume replica DB.
 452                         $data = $from;
 453                         $from = self::READ_NORMAL;
 454                 }
 455
 456                 $this->loadFromRow( $data, $from );
 457         }
 458
 459         /**
 460          * Load the object from a database row
 461          *
 462          * @since 1.20
 463          * @param object|bool $data DB row containing fields returned by selectFields() or false
 464          * @param string|int $from One of the following:
 465          *        - "fromdb" or WikiPage::READ_NORMAL if the data comes from a replica DB
 466          *        - "fromdbmaster" or WikiPage::READ_LATEST if the data comes from the master DB
 467          *        - "forupdate"  or WikiPage::READ_LOCKING if the data comes from
 468          *          the master DB using SELECT FOR UPDATE
 469          */
 470         public function loadFromRow( $data, $from ) {
 471                 $lc = LinkCache::singleton();
 472                 $lc->clearLink( $this->mTitle );
 473
 474                 if ( $data ) {
 475                         $lc->addGoodLinkObjFromRow( $this->mTitle, $data );
 476
 477                         $this->mTitle->loadFromRow( $data );
 478
 479                         // Old-fashioned restrictions
 480                         $this->mTitle->loadRestrictions( $data->page_restrictions );
 481
 482                         $this->mId = intval( $data->page_id );
 483                         $this->mTouched = wfTimestamp( TS_MW, $data->page_touched );
 484                         $this->mLinksUpdated = wfTimestampOrNull( TS_MW, $data->page_links_updated );
 485                         $this->mIsRedirect = intval( $data->page_is_redirect );
 486                         $this->mLatest = intval( $data->page_latest );
 487                         // T39225: $latest may no longer match the cached latest Revision object.
 488                         // Double-check the ID of any cached latest Revision object for consistency.
 489                         if ( $this->mLastRevision && $this->mLastRevision->getId() != $this->mLatest ) {
 490                                 $this->mLastRevision = null;
 491                                 $this->mTimestamp = '';
 492                         }
 493                 } else {
 494                         $lc->addBadLinkObj( $this->mTitle );
 495
 496                         $this->mTitle->loadFromRow( false );
 497
 498                         $this->clearCacheFields();
 499
 500                         $this->mId = 0;
 501                 }
 502
 503                 $this->mDataLoaded = true;
 504                 $this->mDataLoadedFrom = self::convertSelectType( $from );
 505         }
 506
 507         /**
 508          * @return int Page ID
 509          */
 510         public function getId() {
 511                 if ( !$this->mDataLoaded ) {
 512                         $this->loadPageData();
 513                 }
 514                 return $this->mId;
 515         }
 516
 517         /**
 518          * @return bool Whether or not the page exists in the database
 519          */
 520         public function exists() {
 521                 if ( !$this->mDataLoaded ) {
 522                         $this->loadPageData();
 523                 }
 524                 return $this->mId > 0;
 525         }
 526
 527         /**
 528          * Check if this page is something we're going to be showing
 529          * some sort of sensible content for. If we return false, page
 530          * views (plain action=view) will return an HTTP 404 response,
 531          * so spiders and robots can know they're following a bad link.
 532          *
 533          * @return bool
 534          */
 535         public function hasViewableContent() {
 536                 return $this->mTitle->isKnown();
 537         }
 538
 539         /**
 540          * Tests if the article content represents a redirect
 541          *
 542          * @return bool
 543          */
 544         public function isRedirect() {
 545                 if ( !$this->mDataLoaded ) {
 546                         $this->loadPageData();
 547                 }
 548
 549                 return (bool)$this->mIsRedirect;
 550         }
 551
 552         /**
 553          * Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
 554          *
 555          * Will use the revisions actual content model if the page exists,
 556          * and the page's default if the page doesn't exist yet.
 557          *
 558          * @return string
 559          *
 560          * @since 1.21
 561          */
 562         public function getContentModel() {
 563                 if ( $this->exists() ) {
 564                         $cache = ObjectCache::getMainWANInstance();
 565
 566                         return $cache->getWithSetCallback(
 567                                 $cache->makeKey( 'page-content-model', $this->getLatest() ),
 568                                 $cache::TTL_MONTH,
 569                                 function () {
 570                                         $rev = $this->getRevision();
 571                                         if ( $rev ) {
 572                                                 // Look at the revision's actual content model
 573                                                 return $rev->getContentModel();
 574                                         } else {
 575                                                 $title = $this->mTitle->getPrefixedDBkey();
 576                                                 wfWarn( "Page $title exists but has no (visible) revisions!" );
 577                                                 return $this->mTitle->getContentModel();
 578                                         }
 579                                 }
 580                         );
 581                 }
 582
 583                 // use the default model for this page
 584                 return $this->mTitle->getContentModel();
 585         }
 586
 587         /**
 588          * Loads page_touched and returns a value indicating if it should be used
 589          * @return bool True if this page exists and is not a redirect
 590          */
 591         public function checkTouched() {
 592                 if ( !$this->mDataLoaded ) {
 593                         $this->loadPageData();
 594                 }
 595                 return ( $this->mId && !$this->mIsRedirect );
 596         }
 597
 598         /**
 599          * Get the page_touched field
 600          * @return string Containing GMT timestamp
 601          */
 602         public function getTouched() {
 603                 if ( !$this->mDataLoaded ) {
 604                         $this->loadPageData();
 605                 }
 606                 return $this->mTouched;
 607         }
 608
 609         /**
 610          * Get the page_links_updated field
 611          * @return string|null Containing GMT timestamp
 612          */
 613         public function getLinksTimestamp() {
 614                 if ( !$this->mDataLoaded ) {
 615                         $this->loadPageData();
 616                 }
 617                 return $this->mLinksUpdated;
 618         }
 619
 620         /**
 621          * Get the page_latest field
 622          * @return int The rev_id of current revision
 623          */
 624         public function getLatest() {
 625                 if ( !$this->mDataLoaded ) {
 626                         $this->loadPageData();
 627                 }
 628                 return (int)$this->mLatest;
 629         }
 630
 631         /**
 632          * Get the Revision object of the oldest revision
 633          * @return Revision|null
 634          */
 635         public function getOldestRevision() {
 636                 // Try using the replica DB first, then try the master
 637                 $rev = $this->mTitle->getFirstRevision();
 638                 if ( !$rev ) {
 639                         $rev = $this->mTitle->getFirstRevision( Title::GAID_FOR_UPDATE );
 640                 }
 641                 return $rev;
 642         }
 643
 644         /**
 645          * Loads everything except the text
 646          * This isn't necessary for all uses, so it's only done if needed.
 647          */
 648         protected function loadLastEdit() {
 649                 if ( $this->mLastRevision !== null ) {
 650                         return; // already loaded
 651                 }
 652
 653                 $latest = $this->getLatest();
 654                 if ( !$latest ) {
 655                         return; // page doesn't exist or is missing page_latest info
 656                 }
 657
 658                 if ( $this->mDataLoadedFrom == self::READ_LOCKING ) {
 659                         // T39225: if session S1 loads the page row FOR UPDATE, the result always
 660                         // includes the latest changes committed. This is true even within REPEATABLE-READ
 661                         // transactions, where S1 normally only sees changes committed before the first S1
 662                         // SELECT. Thus we need S1 to also gets the revision row FOR UPDATE; otherwise, it
 663                         // may not find it since a page row UPDATE and revision row INSERT by S2 may have
 664                         // happened after the first S1 SELECT.
 665                         // https://dev.mysql.com/doc/refman/5.0/en/set-transaction.html#isolevel_repeatable-read
 666                         $flags = Revision::READ_LOCKING;
 667                         $revision = Revision::newFromPageId( $this->getId(), $latest, $flags );
 668                 } elseif ( $this->mDataLoadedFrom == self::READ_LATEST ) {
 669                         // Bug T93976: if page_latest was loaded from the master, fetch the
 670                         // revision from there as well, as it may not exist yet on a replica DB.
 671                         // Also, this keeps the queries in the same REPEATABLE-READ snapshot.
 672                         $flags = Revision::READ_LATEST;
 673                         $revision = Revision::newFromPageId( $this->getId(), $latest, $flags );
 674                 } else {
 675                         $dbr = wfGetDB( DB_REPLICA );
 676                         $revision = Revision::newKnownCurrent( $dbr, $this->getTitle(), $latest );
 677                 }
 678
 679                 if ( $revision ) { // sanity
 680                         $this->setLastEdit( $revision );
 681                 }
 682         }
 683
 684         /**
 685          * Set the latest revision
 686          * @param Revision $revision
 687          */
 688         protected function setLastEdit( Revision $revision ) {
 689                 $this->mLastRevision = $revision;
 690                 $this->mTimestamp = $revision->getTimestamp();
 691         }
 692
 693         /**
 694          * Get the latest revision
 695          * @return Revision|null
 696          */
 697         public function getRevision() {
 698                 $this->loadLastEdit();
 699                 if ( $this->mLastRevision ) {
 700                         return $this->mLastRevision;
 701                 }
 702                 return null;
 703         }
 704
 705         /**
 706          * Get the content of the current revision. No side-effects...
 707          *
 708          * @param int $audience One of:
 709          *   Revision::FOR_PUBLIC       to be displayed to all users
 710          *   Revision::FOR_THIS_USER    to be displayed to $wgUser
 711          *   Revision::RAW              get the text regardless of permissions
 712          * @param User $user User object to check for, only if FOR_THIS_USER is passed
 713          *   to the $audience parameter
 714          * @return Content|null The content of the current revision
 715          *
 716          * @since 1.21
 717          */
 718         public function getContent( $audience = Revision::FOR_PUBLIC, User $user = null ) {
 719                 $this->loadLastEdit();
 720                 if ( $this->mLastRevision ) {
 721                         return $this->mLastRevision->getContent( $audience, $user );
 722                 }
 723                 return null;
 724         }
 725
 726         /**
 727          * @return string MW timestamp of last article revision
 728          */
 729         public function getTimestamp() {
 730                 // Check if the field has been filled by WikiPage::setTimestamp()
 731                 if ( !$this->mTimestamp ) {
 732                         $this->loadLastEdit();
 733                 }
 734
 735                 return wfTimestamp( TS_MW, $this->mTimestamp );
 736         }
 737
 738         /**
 739          * Set the page timestamp (use only to avoid DB queries)
 740          * @param string $ts MW timestamp of last article revision
 741          * @return void
 742          */
 743         public function setTimestamp( $ts ) {
 744                 $this->mTimestamp = wfTimestamp( TS_MW, $ts );
 745         }
 746
 747         /**
 748          * @param int $audience One of:
 749          *   Revision::FOR_PUBLIC       to be displayed to all users
 750          *   Revision::FOR_THIS_USER    to be displayed to the given user
 751          *   Revision::RAW              get the text regardless of permissions
 752          * @param User $user User object to check for, only if FOR_THIS_USER is passed
 753          *   to the $audience parameter
 754          * @return int User ID for the user that made the last article revision
 755          */
 756         public function getUser( $audience = Revision::FOR_PUBLIC, User $user = null ) {
 757                 $this->loadLastEdit();
 758                 if ( $this->mLastRevision ) {
 759                         return $this->mLastRevision->getUser( $audience, $user );
 760                 } else {
 761                         return -1;
 762                 }
 763         }
 764
 765         /**
 766          * Get the User object of the user who created the page
 767          * @param int $audience One of:
 768          *   Revision::FOR_PUBLIC       to be displayed to all users
 769          *   Revision::FOR_THIS_USER    to be displayed to the given user
 770          *   Revision::RAW              get the text regardless of permissions
 771          * @param User $user User object to check for, only if FOR_THIS_USER is passed
 772          *   to the $audience parameter
 773          * @return User|null
 774          */
 775         public function getCreator( $audience = Revision::FOR_PUBLIC, User $user = null ) {
 776                 $revision = $this->getOldestRevision();
 777                 if ( $revision ) {
 778                         $userName = $revision->getUserText( $audience, $user );
 779                         return User::newFromName( $userName, false );
 780                 } else {
 781                         return null;
 782                 }
 783         }
 784
 785         /**
 786          * @param int $audience One of:
 787          *   Revision::FOR_PUBLIC       to be displayed to all users
 788          *   Revision::FOR_THIS_USER    to be displayed to the given user
 789          *   Revision::RAW              get the text regardless of permissions
 790          * @param User $user User object to check for, only if FOR_THIS_USER is passed
 791          *   to the $audience parameter
 792          * @return string Username of the user that made the last article revision
 793          */
 794         public function getUserText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
 795                 $this->loadLastEdit();
 796                 if ( $this->mLastRevision ) {
 797                         return $this->mLastRevision->getUserText( $audience, $user );
 798                 } else {
 799                         return '';
 800                 }
 801         }
 802
 803         /**
 804          * @param int $audience One of:
 805          *   Revision::FOR_PUBLIC       to be displayed to all users
 806          *   Revision::FOR_THIS_USER    to be displayed to the given user
 807          *   Revision::RAW              get the text regardless of permissions
 808          * @param User $user User object to check for, only if FOR_THIS_USER is passed
 809          *   to the $audience parameter
 810          * @return string Comment stored for the last article revision
 811          */
 812         public function getComment( $audience = Revision::FOR_PUBLIC, User $user = null ) {
 813                 $this->loadLastEdit();
 814                 if ( $this->mLastRevision ) {
 815                         return $this->mLastRevision->getComment( $audience, $user );
 816                 } else {
 817                         return '';
 818                 }
 819         }
 820
 821         /**
 822          * Returns true if last revision was marked as "minor edit"
 823          *
 824          * @return bool Minor edit indicator for the last article revision.
 825          */
 826         public function getMinorEdit() {
 827                 $this->loadLastEdit();
 828                 if ( $this->mLastRevision ) {
 829                         return $this->mLastRevision->isMinor();
 830                 } else {
 831                         return false;
 832                 }
 833         }
 834
 835         /**
 836          * Determine whether a page would be suitable for being counted as an
 837          * article in the site_stats table based on the title & its content
 838          *
 839          * @param PreparedEdit|bool $editInfo (false): object returned by prepareTextForEdit(),
 840          *   if false, the current database state will be used
 841          * @return bool
 842          */
 843         public function isCountable( $editInfo = false ) {
 844                 global $wgArticleCountMethod;
 845
 846                 if ( !$this->mTitle->isContentPage() ) {
 847                         return false;
 848                 }
 849
 850                 if ( $editInfo ) {
 851                         $content = $editInfo->pstContent;
 852                 } else {
 853                         $content = $this->getContent();
 854                 }
 855
 856                 if ( !$content || $content->isRedirect() ) {
 857                         return false;
 858                 }
 859
 860                 $hasLinks = null;
 861
 862                 if ( $wgArticleCountMethod === 'link' ) {
 863                         // nasty special case to avoid re-parsing to detect links
 864
 865                         if ( $editInfo ) {
 866                                 // ParserOutput::getLinks() is a 2D array of page links, so
 867                                 // to be really correct we would need to recurse in the array
 868                                 // but the main array should only have items in it if there are
 869                                 // links.
 870                                 $hasLinks = (bool)count( $editInfo->output->getLinks() );
 871                         } else {
 872                                 $hasLinks = (bool)wfGetDB( DB_REPLICA )->selectField( 'pagelinks', 1,
 873                                         [ 'pl_from' => $this->getId() ], __METHOD__ );
 874                         }
 875                 }
 876
 877                 return $content->isCountable( $hasLinks );
 878         }
 879
 880         /**
 881          * If this page is a redirect, get its target
 882          *
 883          * The target will be fetched from the redirect table if possible.
 884          * If this page doesn't have an entry there, call insertRedirect()
 885          * @return Title|null Title object, or null if this page is not a redirect
 886          */
 887         public function getRedirectTarget() {
 888                 if ( !$this->mTitle->isRedirect() ) {
 889                         return null;
 890                 }
 891
 892                 if ( $this->mRedirectTarget !== null ) {
 893                         return $this->mRedirectTarget;
 894                 }
 895
 896                 // Query the redirect table
 897                 $dbr = wfGetDB( DB_REPLICA );
 898                 $row = $dbr->selectRow( 'redirect',
 899                         [ 'rd_namespace', 'rd_title', 'rd_fragment', 'rd_interwiki' ],
 900                         [ 'rd_from' => $this->getId() ],
 901                         __METHOD__
 902                 );
 903
 904                 // rd_fragment and rd_interwiki were added later, populate them if empty
 905                 if ( $row && !is_null( $row->rd_fragment ) && !is_null( $row->rd_interwiki ) ) {
 906                         $this->mRedirectTarget = Title::makeTitle(
 907                                 $row->rd_namespace, $row->rd_title,
 908                                 $row->rd_fragment, $row->rd_interwiki
 909                         );
 910                         return $this->mRedirectTarget;
 911                 }
 912
 913                 // This page doesn't have an entry in the redirect table
 914                 $this->mRedirectTarget = $this->insertRedirect();
 915                 return $this->mRedirectTarget;
 916         }
 917
 918         /**
 919          * Insert an entry for this page into the redirect table if the content is a redirect
 920          *
 921          * The database update will be deferred via DeferredUpdates
 922          *
 923          * Don't call this function directly unless you know what you're doing.
 924          * @return Title|null Title object or null if not a redirect
 925          */
 926         public function insertRedirect() {
 927                 $content = $this->getContent();
 928                 $retval = $content ? $content->getUltimateRedirectTarget() : null;
 929                 if ( !$retval ) {
 930                         return null;
 931                 }
 932
 933                 // Update the DB post-send if the page has not cached since now
 934                 $latest = $this->getLatest();
 935                 DeferredUpdates::addCallableUpdate(
 936                         function () use ( $retval, $latest ) {
 937                                 $this->insertRedirectEntry( $retval, $latest );
 938                         },
 939                         DeferredUpdates::POSTSEND,
 940                         wfGetDB( DB_MASTER )
 941                 );
 942
 943                 return $retval;
 944         }
 945
 946         /**
 947          * Insert or update the redirect table entry for this page to indicate it redirects to $rt
 948          * @param Title $rt Redirect target
 949          * @param int|null $oldLatest Prior page_latest for check and set
 950          */
 951         public function insertRedirectEntry( Title $rt, $oldLatest = null ) {
 952                 $dbw = wfGetDB( DB_MASTER );
 953                 $dbw->startAtomic( __METHOD__ );
 954
 955                 if ( !$oldLatest || $oldLatest == $this->lockAndGetLatest() ) {
 956                         $dbw->upsert(
 957                                 'redirect',
 958                                 [
 959                                         'rd_from' => $this->getId(),
 960                                         'rd_namespace' => $rt->getNamespace(),
 961                                         'rd_title' => $rt->getDBkey(),
 962                                         'rd_fragment' => $rt->getFragment(),
 963                                         'rd_interwiki' => $rt->getInterwiki(),
 964                                 ],
 965                                 [ 'rd_from' ],
 966                                 [
 967                                         'rd_namespace' => $rt->getNamespace(),
 968                                         'rd_title' => $rt->getDBkey(),
 969                                         'rd_fragment' => $rt->getFragment(),
 970                                         'rd_interwiki' => $rt->getInterwiki(),
 971                                 ],
 972                                 __METHOD__
 973                         );
 974                 }
 975
 976                 $dbw->endAtomic( __METHOD__ );
 977         }
 978
 979         /**
 980          * Get the Title object or URL this page redirects to
 981          *
 982          * @return bool|Title|string False, Title of in-wiki target, or string with URL
 983          */
 984         public function followRedirect() {
 985                 return $this->getRedirectURL( $this->getRedirectTarget() );
 986         }
 987
 988         /**
 989          * Get the Title object or URL to use for a redirect. We use Title
 990          * objects for same-wiki, non-special redirects and URLs for everything
 991          * else.
 992          * @param Title $rt Redirect target
 993          * @return bool|Title|string False, Title object of local target, or string with URL
 994          */
 995         public function getRedirectURL( $rt ) {
 996                 if ( !$rt ) {
 997                         return false;
 998                 }
 999
1000                 if ( $rt->isExternal() ) {
1001                         if ( $rt->isLocal() ) {
1002                                 // Offsite wikis need an HTTP redirect.
1003                                 // This can be hard to reverse and may produce loops,
1004                                 // so they may be disabled in the site configuration.
1005                                 $source = $this->mTitle->getFullURL( 'redirect=no' );
1006                                 return $rt->getFullURL( [ 'rdfrom' => $source ] );
1007                         } else {
1008                                 // External pages without "local" bit set are not valid
1009                                 // redirect targets
1010                                 return false;
1011                         }
1012                 }
1013
1014                 if ( $rt->isSpecialPage() ) {
1015                         // Gotta handle redirects to special pages differently:
1016                         // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
1017                         // Some pages are not valid targets.
1018                         if ( $rt->isValidRedirectTarget() ) {
1019                                 return $rt->getFullURL();
1020                         } else {
1021                                 return false;
1022                         }
1023                 }
1024
1025                 return $rt;
1026         }
1027
1028         /**
1029          * Get a list of users who have edited this article, not including the user who made
1030          * the most recent revision, which you can get from $article->getUser() if you want it
1031          * @return UserArrayFromResult
1032          */
1033         public function getContributors() {
1034                 // @todo FIXME: This is expensive; cache this info somewhere.
1035
1036                 $dbr = wfGetDB( DB_REPLICA );
1037
1038                 $actorMigration = ActorMigration::newMigration();
1039                 $actorQuery = $actorMigration->getJoin( 'rev_user' );
1040
1041                 $tables = array_merge( [ 'revision' ], $actorQuery['tables'], [ 'user' ] );
1042
1043                 $fields = [
1044                         'user_id' => $actorQuery['fields']['rev_user'],
1045                         'user_name' => $actorQuery['fields']['rev_user_text'],
1046                         'actor_id' => $actorQuery['fields']['rev_actor'],
1047                         'user_real_name' => 'MIN(user_real_name)',
1048                         'timestamp' => 'MAX(rev_timestamp)',
1049                 ];
1050
1051                 $conds = [ 'rev_page' => $this->getId() ];
1052
1053                 // The user who made the top revision gets credited as "this page was last edited by
1054                 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1055                 $user = $this->getUser()
1056                         ? User::newFromId( $this->getUser() )
1057                         : User::newFromName( $this->getUserText(), false );
1058                 $conds[] = 'NOT(' . $actorMigration->getWhere( $dbr, 'rev_user', $user )['conds'] . ')';
1059
1060                 // Username hidden?
1061                 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1062
1063                 $jconds = [
1064                         'user' => [ 'LEFT JOIN', $actorQuery['fields']['rev_user'] . ' = user_id' ],
1065                 ] + $actorQuery['joins'];
1066
1067                 $options = [
1068                         'GROUP BY' => [ $fields['user_id'], $fields['user_name'] ],
1069                         'ORDER BY' => 'timestamp DESC',
1070                 ];
1071
1072                 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $jconds );
1073                 return new UserArrayFromResult( $res );
1074         }
1075
1076         /**
1077          * Should the parser cache be used?
1078          *
1079          * @param ParserOptions $parserOptions ParserOptions to check
1080          * @param int $oldId
1081          * @return bool
1082          */
1083         public function shouldCheckParserCache( ParserOptions $parserOptions, $oldId ) {
1084                 return $parserOptions->getStubThreshold() == 0
1085                         && $this->exists()
1086                         && ( $oldId === null || $oldId === 0 || $oldId === $this->getLatest() )
1087                         && $this->getContentHandler()->isParserCacheSupported();
1088         }
1089
1090         /**
1091          * Get a ParserOutput for the given ParserOptions and revision ID.
1092          *
1093          * The parser cache will be used if possible. Cache misses that result
1094          * in parser runs are debounced with PoolCounter.
1095          *
1096          * @since 1.19
1097          * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1098          * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1099          *   get the current revision (default value)
1100          * @param bool $forceParse Force reindexing, regardless of cache settings
1101          * @return bool|ParserOutput ParserOutput or false if the revision was not found
1102          */
1103         public function getParserOutput(
1104                 ParserOptions $parserOptions, $oldid = null, $forceParse = false
1105         ) {
1106                 $useParserCache =
1107                         ( !$forceParse ) && $this->shouldCheckParserCache( $parserOptions, $oldid );
1108
1109                 if ( $useParserCache && !$parserOptions->isSafeToCache() ) {
1110                         throw new InvalidArgumentException(
1111                                 'The supplied ParserOptions are not safe to cache. Fix the options or set $forceParse = true.'
1112                         );
1113                 }
1114
1115                 wfDebug( __METHOD__ .
1116                         ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
1117                 if ( $parserOptions->getStubThreshold() ) {
1118                         wfIncrStats( 'pcache.miss.stub' );
1119                 }
1120
1121                 if ( $useParserCache ) {
1122                         $parserOutput = MediaWikiServices::getInstance()->getParserCache()
1123                                 ->get( $this, $parserOptions );
1124                         if ( $parserOutput !== false ) {
1125                                 return $parserOutput;
1126                         }
1127                 }
1128
1129                 if ( $oldid === null || $oldid === 0 ) {
1130                         $oldid = $this->getLatest();
1131                 }
1132
1133                 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1134                 $pool->execute();
1135
1136                 return $pool->getParserOutput();
1137         }
1138
1139         /**
1140          * Do standard deferred updates after page view (existing or missing page)
1141          * @param User $user The relevant user
1142          * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1143          */
1144         public function doViewUpdates( User $user, $oldid = 0 ) {
1145                 if ( wfReadOnly() ) {
1146                         return;
1147                 }
1148
1149                 // Update newtalk / watchlist notification status;
1150                 // Avoid outage if the master is not reachable by using a deferred updated
1151                 DeferredUpdates::addCallableUpdate(
1152                         function () use ( $user, $oldid ) {
1153                                 Hooks::run( 'PageViewUpdates', [ $this, $user ] );
1154
1155                                 $user->clearNotification( $this->mTitle, $oldid );
1156                         },
1157                         DeferredUpdates::PRESEND
1158                 );
1159         }
1160
1161         /**
1162          * Perform the actions of a page purging
1163          * @return bool
1164          * @note In 1.28 (and only 1.28), this took a $flags parameter that
1165          *  controlled how much purging was done.
1166          */
1167         public function doPurge() {
1168                 // Avoid PHP 7.1 warning of passing $this by reference
1169                 $wikiPage = $this;
1170
1171                 if ( !Hooks::run( 'ArticlePurge', [ &$wikiPage ] ) ) {
1172                         return false;
1173                 }
1174
1175                 $this->mTitle->invalidateCache();
1176
1177                 // Clear file cache
1178                 HTMLFileCache::clearFileCache( $this->getTitle() );
1179                 // Send purge after above page_touched update was committed
1180                 DeferredUpdates::addUpdate(
1181                         new CdnCacheUpdate( $this->mTitle->getCdnUrls() ),
1182                         DeferredUpdates::PRESEND
1183                 );
1184
1185                 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1186                         $messageCache = MessageCache::singleton();
1187                         $messageCache->updateMessageOverride( $this->mTitle, $this->getContent() );
1188                 }
1189
1190                 return true;
1191         }
1192
1193         /**
1194          * Insert a new empty page record for this article.
1195          * This *must* be followed up by creating a revision
1196          * and running $this->updateRevisionOn( ... );
1197          * or else the record will be left in a funky state.
1198          * Best if all done inside a transaction.
1199          *
1200          * @param IDatabase $dbw
1201          * @param int|null $pageId Custom page ID that will be used for the insert statement
1202          *
1203          * @return bool|int The newly created page_id key; false if the row was not
1204          *   inserted, e.g. because the title already existed or because the specified
1205          *   page ID is already in use.
1206          */
1207         public function insertOn( $dbw, $pageId = null ) {
1208                 $pageIdForInsert = $pageId ? [ 'page_id' => $pageId ] : [];
1209                 $dbw->insert(
1210                         'page',
1211                         [
1212                                 'page_namespace'    => $this->mTitle->getNamespace(),
1213                                 'page_title'        => $this->mTitle->getDBkey(),
1214                                 'page_restrictions' => '',
1215                                 'page_is_redirect'  => 0, // Will set this shortly...
1216                                 'page_is_new'       => 1,
1217                                 'page_random'       => wfRandom(),
1218                                 'page_touched'      => $dbw->timestamp(),
1219                                 'page_latest'       => 0, // Fill this in shortly...
1220                                 'page_len'          => 0, // Fill this in shortly...
1221                         ] + $pageIdForInsert,
1222                         __METHOD__,
1223                         'IGNORE'
1224                 );
1225
1226                 if ( $dbw->affectedRows() > 0 ) {
1227                         $newid = $pageId ? (int)$pageId : $dbw->insertId();
1228                         $this->mId = $newid;
1229                         $this->mTitle->resetArticleID( $newid );
1230
1231                         return $newid;
1232                 } else {
1233                         return false; // nothing changed
1234                 }
1235         }
1236
1237         /**
1238          * Update the page record to point to a newly saved revision.
1239          *
1240          * @param IDatabase $dbw
1241          * @param Revision $revision For ID number, and text used to set
1242          *   length and redirect status fields
1243          * @param int $lastRevision If given, will not overwrite the page field
1244          *   when different from the currently set value.
1245          *   Giving 0 indicates the new page flag should be set on.
1246          * @param bool $lastRevIsRedirect If given, will optimize adding and
1247          *   removing rows in redirect table.
1248          * @return bool Success; false if the page row was missing or page_latest changed
1249          */
1250         public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1251                 $lastRevIsRedirect = null
1252         ) {
1253                 global $wgContentHandlerUseDB;
1254
1255                 // Assertion to try to catch T92046
1256                 if ( (int)$revision->getId() === 0 ) {
1257                         throw new InvalidArgumentException(
1258                                 __METHOD__ . ': Revision has ID ' . var_export( $revision->getId(), 1 )
1259                         );
1260                 }
1261
1262                 $content = $revision->getContent();
1263                 $len = $content ? $content->getSize() : 0;
1264                 $rt = $content ? $content->getUltimateRedirectTarget() : null;
1265
1266                 $conditions = [ 'page_id' => $this->getId() ];
1267
1268                 if ( !is_null( $lastRevision ) ) {
1269                         // An extra check against threads stepping on each other
1270                         $conditions['page_latest'] = $lastRevision;
1271                 }
1272
1273                 $revId = $revision->getId();
1274                 Assert::parameter( $revId > 0, '$revision->getId()', 'must be > 0' );
1275
1276                 $row = [ /* SET */
1277                         'page_latest'      => $revId,
1278                         'page_touched'     => $dbw->timestamp( $revision->getTimestamp() ),
1279                         'page_is_new'      => ( $lastRevision === 0 ) ? 1 : 0,
1280                         'page_is_redirect' => $rt !== null ? 1 : 0,
1281                         'page_len'         => $len,
1282                 ];
1283
1284                 if ( $wgContentHandlerUseDB ) {
1285                         $row['page_content_model'] = $revision->getContentModel();
1286                 }
1287
1288                 $dbw->update( 'page',
1289                         $row,
1290                         $conditions,
1291                         __METHOD__ );
1292
1293                 $result = $dbw->affectedRows() > 0;
1294                 if ( $result ) {
1295                         $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1296                         $this->setLastEdit( $revision );
1297                         $this->mLatest = $revision->getId();
1298                         $this->mIsRedirect = (bool)$rt;
1299                         // Update the LinkCache.
1300                         LinkCache::singleton()->addGoodLinkObj(
1301                                 $this->getId(),
1302                                 $this->mTitle,
1303                                 $len,
1304                                 $this->mIsRedirect,
1305                                 $this->mLatest,
1306                                 $revision->getContentModel()
1307                         );
1308                 }
1309
1310                 return $result;
1311         }
1312
1313         /**
1314          * Add row to the redirect table if this is a redirect, remove otherwise.
1315          *
1316          * @param IDatabase $dbw
1317          * @param Title|null $redirectTitle Title object pointing to the redirect target,
1318          *   or NULL if this is not a redirect
1319          * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1320          *   removing rows in redirect table.
1321          * @return bool True on success, false on failure
1322          * @private
1323          */
1324         public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1325                 // Always update redirects (target link might have changed)
1326                 // Update/Insert if we don't know if the last revision was a redirect or not
1327                 // Delete if changing from redirect to non-redirect
1328                 $isRedirect = !is_null( $redirectTitle );
1329
1330                 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1331                         return true;
1332                 }
1333
1334                 if ( $isRedirect ) {
1335                         $this->insertRedirectEntry( $redirectTitle );
1336                 } else {
1337                         // This is not a redirect, remove row from redirect table
1338                         $where = [ 'rd_from' => $this->getId() ];
1339                         $dbw->delete( 'redirect', $where, __METHOD__ );
1340                 }
1341
1342                 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1343                         RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1344                 }
1345
1346                 return ( $dbw->affectedRows() != 0 );
1347         }
1348
1349         /**
1350          * If the given revision is newer than the currently set page_latest,
1351          * update the page record. Otherwise, do nothing.
1352          *
1353          * @deprecated since 1.24, use updateRevisionOn instead
1354          *
1355          * @param IDatabase $dbw
1356          * @param Revision $revision
1357          * @return bool
1358          */
1359         public function updateIfNewerOn( $dbw, $revision ) {
1360                 $row = $dbw->selectRow(
1361                         [ 'revision', 'page' ],
1362                         [ 'rev_id', 'rev_timestamp', 'page_is_redirect' ],
1363                         [
1364                                 'page_id' => $this->getId(),
1365                                 'page_latest=rev_id' ],
1366                         __METHOD__ );
1367
1368                 if ( $row ) {
1369                         if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1370                                 return false;
1371                         }
1372                         $prev = $row->rev_id;
1373                         $lastRevIsRedirect = (bool)$row->page_is_redirect;
1374                 } else {
1375                         // No or missing previous revision; mark the page as new
1376                         $prev = 0;
1377                         $lastRevIsRedirect = null;
1378                 }
1379
1380                 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1381
1382                 return $ret;
1383         }
1384
1385         /**
1386          * Get the content that needs to be saved in order to undo all revisions
1387          * between $undo and $undoafter. Revisions must belong to the same page,
1388          * must exist and must not be deleted
1389          * @param Revision $undo
1390          * @param Revision $undoafter Must be an earlier revision than $undo
1391          * @return Content|bool Content on success, false on failure
1392          * @since 1.21
1393          * Before we had the Content object, this was done in getUndoText
1394          */
1395         public function getUndoContent( Revision $undo, Revision $undoafter = null ) {
1396                 $handler = $undo->getContentHandler();
1397                 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1398         }
1399
1400         /**
1401          * Returns true if this page's content model supports sections.
1402          *
1403          * @return bool
1404          *
1405          * @todo The skin should check this and not offer section functionality if
1406          *   sections are not supported.
1407          * @todo The EditPage should check this and not offer section functionality
1408          *   if sections are not supported.
1409          */
1410         public function supportsSections() {
1411                 return $this->getContentHandler()->supportsSections();
1412         }
1413
1414         /**
1415          * @param string|int|null|bool $sectionId Section identifier as a number or string
1416          * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1417          * or 'new' for a new section.
1418          * @param Content $sectionContent New content of the section.
1419          * @param string $sectionTitle New section's subject, only if $section is "new".
1420          * @param string $edittime Revision timestamp or null to use the current revision.
1421          *
1422          * @throws MWException
1423          * @return Content|null New complete article content, or null if error.
1424          *
1425          * @since 1.21
1426          * @deprecated since 1.24, use replaceSectionAtRev instead
1427          */
1428         public function replaceSectionContent(
1429                 $sectionId, Content $sectionContent, $sectionTitle = '', $edittime = null
1430         ) {
1431                 $baseRevId = null;
1432                 if ( $edittime && $sectionId !== 'new' ) {
1433                         $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
1434                         $dbr = $lb->getConnection( DB_REPLICA );
1435                         $rev = Revision::loadFromTimestamp( $dbr, $this->mTitle, $edittime );
1436                         // Try the master if this thread may have just added it.
1437                         // This could be abstracted into a Revision method, but we don't want
1438                         // to encourage loading of revisions by timestamp.
1439                         if ( !$rev
1440                                 && $lb->getServerCount() > 1
1441                                 && $lb->hasOrMadeRecentMasterChanges()
1442                         ) {
1443                                 $dbw = $lb->getConnection( DB_MASTER );
1444                                 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1445                         }
1446                         if ( $rev ) {
1447                                 $baseRevId = $rev->getId();
1448                         }
1449                 }
1450
1451                 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1452         }
1453
1454         /**
1455          * @param string|int|null|bool $sectionId Section identifier as a number or string
1456          * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1457          * or 'new' for a new section.
1458          * @param Content $sectionContent New content of the section.
1459          * @param string $sectionTitle New section's subject, only if $section is "new".
1460          * @param int|null $baseRevId
1461          *
1462          * @throws MWException
1463          * @return Content|null New complete article content, or null if error.
1464          *
1465          * @since 1.24
1466          */
1467         public function replaceSectionAtRev( $sectionId, Content $sectionContent,
1468                 $sectionTitle = '', $baseRevId = null
1469         ) {
1470                 if ( strval( $sectionId ) === '' ) {
1471                         // Whole-page edit; let the whole text through
1472                         $newContent = $sectionContent;
1473                 } else {
1474                         if ( !$this->supportsSections() ) {
1475                                 throw new MWException( "sections not supported for content model " .
1476                                         $this->getContentHandler()->getModelID() );
1477                         }
1478
1479                         // T32711: always use current version when adding a new section
1480                         if ( is_null( $baseRevId ) || $sectionId === 'new' ) {
1481                                 $oldContent = $this->getContent();
1482                         } else {
1483                                 $rev = Revision::newFromId( $baseRevId );
1484                                 if ( !$rev ) {
1485                                         wfDebug( __METHOD__ . " asked for bogus section (page: " .
1486                                                 $this->getId() . "; section: $sectionId)\n" );
1487                                         return null;
1488                                 }
1489
1490                                 $oldContent = $rev->getContent();
1491                         }
1492
1493                         if ( !$oldContent ) {
1494                                 wfDebug( __METHOD__ . ": no page text\n" );
1495                                 return null;
1496                         }
1497
1498                         $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1499                 }
1500
1501                 return $newContent;
1502         }
1503
1504         /**
1505          * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1506          * @param int $flags
1507          * @return int Updated $flags
1508          */
1509         public function checkFlags( $flags ) {
1510                 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
1511                         if ( $this->exists() ) {
1512                                 $flags |= EDIT_UPDATE;
1513                         } else {
1514                                 $flags |= EDIT_NEW;
1515                         }
1516                 }
1517
1518                 return $flags;
1519         }
1520
1521         /**
1522          * Change an existing article or create a new article. Updates RC and all necessary caches,
1523          * optionally via the deferred update array.
1524          *
1525          * @param Content $content New content
1526          * @param string $summary Edit summary
1527          * @param int $flags Bitfield:
1528          *      EDIT_NEW
1529          *          Article is known or assumed to be non-existent, create a new one
1530          *      EDIT_UPDATE
1531          *          Article is known or assumed to be pre-existing, update it
1532          *      EDIT_MINOR
1533          *          Mark this edit minor, if the user is allowed to do so
1534          *      EDIT_SUPPRESS_RC
1535          *          Do not log the change in recentchanges
1536          *      EDIT_FORCE_BOT
1537          *          Mark the edit a "bot" edit regardless of user rights
1538          *      EDIT_AUTOSUMMARY
1539          *          Fill in blank summaries with generated text where possible
1540          *      EDIT_INTERNAL
1541          *          Signal that the page retrieve/save cycle happened entirely in this request.
1542          *
1543          * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1544          * article will be detected. If EDIT_UPDATE is specified and the article
1545          * doesn't exist, the function will return an edit-gone-missing error. If
1546          * EDIT_NEW is specified and the article does exist, an edit-already-exists
1547          * error will be returned. These two conditions are also possible with
1548          * auto-detection due to MediaWiki's performance-optimised locking strategy.
1549          *
1550          * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1551          *   This is not the parent revision ID, rather the revision ID for older
1552          *   content used as the source for a rollback, for example.
1553          * @param User $user The user doing the edit
1554          * @param string $serialFormat Format for storing the content in the
1555          *   database.
1556          * @param array|null $tags Change tags to apply to this edit
1557          * Callers are responsible for permission checks
1558          * (with ChangeTags::canAddTagsAccompanyingChange)
1559          * @param Int $undidRevId Id of revision that was undone or 0
1560          *
1561          * @throws MWException
1562          * @return Status Possible errors:
1563          *     edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1564          *       set the fatal flag of $status.
1565          *     edit-gone-missing: In update mode, but the article didn't exist.
1566          *     edit-conflict: In update mode, the article changed unexpectedly.
1567          *     edit-no-change: Warning that the text was the same as before.
1568          *     edit-already-exists: In creation mode, but the article already exists.
1569          *
1570          *  Extensions may define additional errors.
1571          *
1572          *  $return->value will contain an associative array with members as follows:
1573          *     new: Boolean indicating if the function attempted to create a new article.
1574          *     revision: The revision object for the inserted revision, or null.
1575          *
1576          * @since 1.21
1577          * @throws MWException
1578          */
1579         public function doEditContent(
1580                 Content $content, $summary, $flags = 0, $baseRevId = false,
1581                 User $user = null, $serialFormat = null, $tags = [], $undidRevId = 0
1582         ) {
1583                 global $wgUser, $wgUseAutomaticEditSummaries;
1584
1585                 // Old default parameter for $tags was null
1586                 if ( $tags === null ) {
1587                         $tags = [];
1588                 }
1589
1590                 // Low-level sanity check
1591                 if ( $this->mTitle->getText() === '' ) {
1592                         throw new MWException( 'Something is trying to edit an article with an empty title' );
1593                 }
1594                 // Make sure the given content type is allowed for this page
1595                 if ( !$content->getContentHandler()->canBeUsedOn( $this->mTitle ) ) {
1596                         return Status::newFatal( 'content-not-allowed-here',
1597                                 ContentHandler::getLocalizedName( $content->getModel() ),
1598                                 $this->mTitle->getPrefixedText()
1599                         );
1600                 }
1601
1602                 // Load the data from the master database if needed.
1603                 // The caller may already loaded it from the master or even loaded it using
1604                 // SELECT FOR UPDATE, so do not override that using clear().
1605                 $this->loadPageData( 'fromdbmaster' );
1606
1607                 $user = $user ?: $wgUser;
1608                 $flags = $this->checkFlags( $flags );
1609
1610                 // Avoid PHP 7.1 warning of passing $this by reference
1611                 $wikiPage = $this;
1612
1613                 // Trigger pre-save hook (using provided edit summary)
1614                 $hookStatus = Status::newGood( [] );
1615                 $hook_args = [ &$wikiPage, &$user, &$content, &$summary,
1616                                                         $flags & EDIT_MINOR, null, null, &$flags, &$hookStatus ];
1617                 // Check if the hook rejected the attempted save
1618                 if ( !Hooks::run( 'PageContentSave', $hook_args ) ) {
1619                         if ( $hookStatus->isOK() ) {
1620                                 // Hook returned false but didn't call fatal(); use generic message
1621                                 $hookStatus->fatal( 'edit-hook-aborted' );
1622                         }
1623
1624                         return $hookStatus;
1625                 }
1626
1627                 $old_revision = $this->getRevision(); // current revision
1628                 $old_content = $this->getContent( Revision::RAW ); // current revision's content
1629
1630                 $handler = $content->getContentHandler();
1631                 $tag = $handler->getChangeTag( $old_content, $content, $flags );
1632                 // If there is no applicable tag, null is returned, so we need to check
1633                 if ( $tag ) {
1634                         $tags[] = $tag;
1635                 }
1636
1637                 // Check for undo tag
1638                 if ( $undidRevId !== 0 && in_array( 'mw-undo', ChangeTags::getSoftwareTags() ) ) {
1639                         $tags[] = 'mw-undo';
1640                 }
1641
1642                 // Provide autosummaries if summary is not provided and autosummaries are enabled
1643                 if ( $wgUseAutomaticEditSummaries && ( $flags & EDIT_AUTOSUMMARY ) && $summary == '' ) {
1644                         $summary = $handler->getAutosummary( $old_content, $content, $flags );
1645                 }
1646
1647                 // Avoid statsd noise and wasted cycles check the edit stash (T136678)
1648                 if ( ( $flags & EDIT_INTERNAL ) || ( $flags & EDIT_FORCE_BOT ) ) {
1649                         $useCache = false;
1650                 } else {
1651                         $useCache = true;
1652                 }
1653
1654                 // Get the pre-save transform content and final parser output
1655                 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat, $useCache );
1656                 $pstContent = $editInfo->pstContent; // Content object
1657                 $meta = [
1658                         'bot' => ( $flags & EDIT_FORCE_BOT ),
1659                         'minor' => ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' ),
1660                         'serialized' => $pstContent->serialize( $serialFormat ),
1661                         'serialFormat' => $serialFormat,
1662                         'baseRevId' => $baseRevId,
1663                         'oldRevision' => $old_revision,
1664                         'oldContent' => $old_content,
1665                         'oldId' => $this->getLatest(),
1666                         'oldIsRedirect' => $this->isRedirect(),
1667                         'oldCountable' => $this->isCountable(),
1668                         'tags' => ( $tags !== null ) ? (array)$tags : [],
1669                         'undidRevId' => $undidRevId
1670                 ];
1671
1672                 // Actually create the revision and create/update the page
1673                 if ( $flags & EDIT_UPDATE ) {
1674                         $status = $this->doModify( $pstContent, $flags, $user, $summary, $meta );
1675                 } else {
1676                         $status = $this->doCreate( $pstContent, $flags, $user, $summary, $meta );
1677                 }
1678
1679                 // Promote user to any groups they meet the criteria for
1680                 DeferredUpdates::addCallableUpdate( function () use ( $user ) {
1681                         $user->addAutopromoteOnceGroups( 'onEdit' );
1682                         $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1683                 } );
1684
1685                 return $status;
1686         }
1687
1688         /**
1689          * @param Content $content Pre-save transform content
1690          * @param int $flags
1691          * @param User $user
1692          * @param string $summary
1693          * @param array $meta
1694          * @return Status
1695          * @throws DBUnexpectedError
1696          * @throws Exception
1697          * @throws FatalError
1698          * @throws MWException
1699          */
1700         private function doModify(
1701                 Content $content, $flags, User $user, $summary, array $meta
1702         ) {
1703                 global $wgUseRCPatrol;
1704
1705                 // Update article, but only if changed.
1706                 $status = Status::newGood( [ 'new' => false, 'revision' => null ] );
1707
1708                 // Convenience variables
1709                 $now = wfTimestampNow();
1710                 $oldid = $meta['oldId'];
1711                 /** @var Content|null $oldContent */
1712                 $oldContent = $meta['oldContent'];
1713                 $newsize = $content->getSize();
1714
1715                 if ( !$oldid ) {
1716                         // Article gone missing
1717                         $status->fatal( 'edit-gone-missing' );
1718
1719                         return $status;
1720                 } elseif ( !$oldContent ) {
1721                         // Sanity check for T39225
1722                         throw new MWException( "Could not find text for current revision {$oldid}." );
1723                 }
1724
1725                 $changed = !$content->equals( $oldContent );
1726
1727                 $dbw = wfGetDB( DB_MASTER );
1728
1729                 if ( $changed ) {
1730                         // @TODO: pass content object?!
1731                         $revision = new Revision( [
1732                                 'page'       => $this->getId(),
1733                                 'title'      => $this->mTitle, // for determining the default content model
1734                                 'comment'    => $summary,
1735                                 'minor_edit' => $meta['minor'],
1736                                 'text'       => $meta['serialized'],
1737                                 'len'        => $newsize,
1738                                 'parent_id'  => $oldid,
1739                                 'user'       => $user->getId(),
1740                                 'user_text'  => $user->getName(),
1741                                 'timestamp'  => $now,
1742                                 'content_model' => $content->getModel(),
1743                                 'content_format' => $meta['serialFormat'],
1744                         ] );
1745
1746                         $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1747                         $status->merge( $prepStatus );
1748                         if ( !$status->isOK() ) {
1749                                 return $status;
1750                         }
1751
1752                         $dbw->startAtomic( __METHOD__ );
1753                         // Get the latest page_latest value while locking it.
1754                         // Do a CAS style check to see if it's the same as when this method
1755                         // started. If it changed then bail out before touching the DB.
1756                         $latestNow = $this->lockAndGetLatest();
1757                         if ( $latestNow != $oldid ) {
1758                                 $dbw->endAtomic( __METHOD__ );
1759                                 // Page updated or deleted in the mean time
1760                                 $status->fatal( 'edit-conflict' );
1761
1762                                 return $status;
1763                         }
1764
1765                         // At this point we are now comitted to returning an OK
1766                         // status unless some DB query error or other exception comes up.
1767                         // This way callers don't have to call rollback() if $status is bad
1768                         // unless they actually try to catch exceptions (which is rare).
1769
1770                         // Save the revision text
1771                         $revisionId = $revision->insertOn( $dbw );
1772                         // Update page_latest and friends to reflect the new revision
1773                         if ( !$this->updateRevisionOn( $dbw, $revision, null, $meta['oldIsRedirect'] ) ) {
1774                                 throw new MWException( "Failed to update page row to use new revision." );
1775                         }
1776
1777                         $tags = $meta['tags'];
1778                         Hooks::run( 'NewRevisionFromEditComplete',
1779                                 [ $this, $revision, $meta['baseRevId'], $user, &$tags ] );
1780
1781                         // Update recentchanges
1782                         if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1783                                 // Mark as patrolled if the user can do so
1784                                 $autopatrolled = $wgUseRCPatrol && !count(
1785                                                 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1786                                 // Add RC row to the DB
1787                                 RecentChange::notifyEdit(
1788                                         $now,
1789                                         $this->mTitle,
1790                                         $revision->isMinor(),
1791                                         $user,
1792                                         $summary,
1793                                         $oldid,
1794                                         $this->getTimestamp(),
1795                                         $meta['bot'],
1796                                         '',
1797                                         $oldContent ? $oldContent->getSize() : 0,
1798                                         $newsize,
1799                                         $revisionId,
1800                                         $autopatrolled ? RecentChange::PRC_AUTOPATROLLED :
1801                                                 RecentChange::PRC_UNPATROLLED,
1802                                         $tags
1803                                 );
1804                         }
1805
1806                         $user->incEditCount();
1807
1808                         $dbw->endAtomic( __METHOD__ );
1809                         $this->mTimestamp = $now;
1810                 } else {
1811                         // T34948: revision ID must be set to page {{REVISIONID}} and
1812                         // related variables correctly. Likewise for {{REVISIONUSER}} (T135261).
1813                         // Since we don't insert a new revision into the database, the least
1814                         // error-prone way is to reuse given old revision.
1815                         $revision = $meta['oldRevision'];
1816                 }
1817
1818                 if ( $changed ) {
1819                         // Return the new revision to the caller
1820                         $status->value['revision'] = $revision;
1821                 } else {
1822                         $status->warning( 'edit-no-change' );
1823                         // Update page_touched as updateRevisionOn() was not called.
1824                         // Other cache updates are managed in onArticleEdit() via doEditUpdates().
1825                         $this->mTitle->invalidateCache( $now );
1826                 }
1827
1828                 // Do secondary updates once the main changes have been committed...
1829                 DeferredUpdates::addUpdate(
1830                         new AtomicSectionUpdate(
1831                                 $dbw,
1832                                 __METHOD__,
1833                                 function () use (
1834                                         $revision, &$user, $content, $summary, &$flags,
1835                                         $changed, $meta, &$status
1836                                 ) {
1837                                         // Update links tables, site stats, etc.
1838                                         $this->doEditUpdates(
1839                                                 $revision,
1840                                                 $user,
1841                                                 [
1842                                                         'changed' => $changed,
1843                                                         'oldcountable' => $meta['oldCountable'],
1844                                                         'oldrevision' => $meta['oldRevision']
1845                                                 ]
1846                                         );
1847                                         // Avoid PHP 7.1 warning of passing $this by reference
1848                                         $wikiPage = $this;
1849                                         // Trigger post-save hook
1850                                         $params = [ &$wikiPage, &$user, $content, $summary, $flags & EDIT_MINOR,
1851                                                 null, null, &$flags, $revision, &$status, $meta['baseRevId'],
1852                                                 $meta['undidRevId'] ];
1853                                         Hooks::run( 'PageContentSaveComplete', $params );
1854                                 }
1855                         ),
1856                         DeferredUpdates::PRESEND
1857                 );
1858
1859                 return $status;
1860         }
1861
1862         /**
1863          * @param Content $content Pre-save transform content
1864          * @param int $flags
1865          * @param User $user
1866          * @param string $summary
1867          * @param array $meta
1868          * @return Status
1869          * @throws DBUnexpectedError
1870          * @throws Exception
1871          * @throws FatalError
1872          * @throws MWException
1873          */
1874         private function doCreate(
1875                 Content $content, $flags, User $user, $summary, array $meta
1876         ) {
1877                 global $wgUseRCPatrol, $wgUseNPPatrol;
1878
1879                 $status = Status::newGood( [ 'new' => true, 'revision' => null ] );
1880
1881                 $now = wfTimestampNow();
1882                 $newsize = $content->getSize();
1883                 $prepStatus = $content->prepareSave( $this, $flags, $meta['oldId'], $user );
1884                 $status->merge( $prepStatus );
1885                 if ( !$status->isOK() ) {
1886                         return $status;
1887                 }
1888
1889                 $dbw = wfGetDB( DB_MASTER );
1890                 $dbw->startAtomic( __METHOD__ );
1891
1892                 // Add the page record unless one already exists for the title
1893                 $newid = $this->insertOn( $dbw );
1894                 if ( $newid === false ) {
1895                         $dbw->endAtomic( __METHOD__ ); // nothing inserted
1896                         $status->fatal( 'edit-already-exists' );
1897
1898                         return $status; // nothing done
1899                 }
1900
1901                 // At this point we are now comitted to returning an OK
1902                 // status unless some DB query error or other exception comes up.
1903                 // This way callers don't have to call rollback() if $status is bad
1904                 // unless they actually try to catch exceptions (which is rare).
1905
1906                 // @TODO: pass content object?!
1907                 $revision = new Revision( [
1908                         'page'       => $newid,
1909                         'title'      => $this->mTitle, // for determining the default content model
1910                         'comment'    => $summary,
1911                         'minor_edit' => $meta['minor'],
1912                         'text'       => $meta['serialized'],
1913                         'len'        => $newsize,
1914                         'user'       => $user->getId(),
1915                         'user_text'  => $user->getName(),
1916                         'timestamp'  => $now,
1917                         'content_model' => $content->getModel(),
1918                         'content_format' => $meta['serialFormat'],
1919                 ] );
1920
1921                 // Save the revision text...
1922                 $revisionId = $revision->insertOn( $dbw );
1923                 // Update the page record with revision data
1924                 if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1925                         throw new MWException( "Failed to update page row to use new revision." );
1926                 }
1927
1928                 Hooks::run( 'NewRevisionFromEditComplete', [ $this, $revision, false, $user ] );
1929
1930                 // Update recentchanges
1931                 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1932                         // Mark as patrolled if the user can do so
1933                         $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) &&
1934                                 !count( $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1935                         // Add RC row to the DB
1936                         RecentChange::notifyNew(
1937                                 $now,
1938                                 $this->mTitle,
1939                                 $revision->isMinor(),
1940                                 $user,
1941                                 $summary,
1942                                 $meta['bot'],
1943                                 '',
1944                                 $newsize,
1945                                 $revisionId,
1946                                 $patrolled,
1947                                 $meta['tags']
1948                         );
1949                 }
1950
1951                 $user->incEditCount();
1952
1953                 $dbw->endAtomic( __METHOD__ );
1954                 $this->mTimestamp = $now;
1955
1956                 // Return the new revision to the caller
1957                 $status->value['revision'] = $revision;
1958
1959                 // Do secondary updates once the main changes have been committed...
1960                 DeferredUpdates::addUpdate(
1961                         new AtomicSectionUpdate(
1962                                 $dbw,
1963                                 __METHOD__,
1964                                 function () use (
1965                                         $revision, &$user, $content, $summary, &$flags, $meta, &$status
1966                                 ) {
1967                                         // Update links, etc.
1968                                         $this->doEditUpdates( $revision, $user, [ 'created' => true ] );
1969                                         // Avoid PHP 7.1 warning of passing $this by reference
1970                                         $wikiPage = $this;
1971                                         // Trigger post-create hook
1972                                         $params = [ &$wikiPage, &$user, $content, $summary,
1973                                                                 $flags & EDIT_MINOR, null, null, &$flags, $revision ];
1974                                         Hooks::run( 'PageContentInsertComplete', $params );
1975                                         // Trigger post-save hook
1976                                         $params = array_merge( $params, [ &$status, $meta['baseRevId'], 0 ] );
1977                                         Hooks::run( 'PageContentSaveComplete', $params );
1978                                 }
1979                         ),
1980                         DeferredUpdates::PRESEND
1981                 );
1982
1983                 return $status;
1984         }
1985
1986         /**
1987          * Get parser options suitable for rendering the primary article wikitext
1988          *
1989          * @see ContentHandler::makeParserOptions
1990          *
1991          * @param IContextSource|User|string $context One of the following:
1992          *        - IContextSource: Use the User and the Language of the provided
1993          *          context
1994          *        - User: Use the provided User object and $wgLang for the language,
1995          *          so use an IContextSource object if possible.
1996          *        - 'canonical': Canonical options (anonymous user with default
1997          *          preferences and content language).
1998          * @return ParserOptions
1999          */
2000         public function makeParserOptions( $context ) {
2001                 $options = $this->getContentHandler()->makeParserOptions( $context );
2002
2003                 if ( $this->getTitle()->isConversionTable() ) {
2004                         // @todo ConversionTable should become a separate content model, so
2005                         // we don't need special cases like this one.
2006                         $options->disableContentConversion();
2007                 }
2008
2009                 return $options;
2010         }
2011
2012         /**
2013          * Prepare content which is about to be saved.
2014          *
2015          * Prior to 1.30, this returned a stdClass object with the same class
2016          * members.
2017          *
2018          * @param Content $content
2019          * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2020          *        revision ID is also accepted, but this is deprecated.
2021          * @param User|null $user
2022          * @param string|null $serialFormat
2023          * @param bool $useCache Check shared prepared edit cache
2024          *
2025          * @return PreparedEdit
2026          *
2027          * @since 1.21
2028          */
2029         public function prepareContentForEdit(
2030                 Content $content, $revision = null, User $user = null,
2031                 $serialFormat = null, $useCache = true
2032         ) {
2033                 global $wgContLang, $wgUser, $wgAjaxEditStash;
2034
2035                 if ( is_object( $revision ) ) {
2036                         $revid = $revision->getId();
2037                 } else {
2038                         $revid = $revision;
2039                         // This code path is deprecated, and nothing is known to
2040                         // use it, so performance here shouldn't be a worry.
2041                         if ( $revid !== null ) {
2042                                 wfDeprecated( __METHOD__ . ' with $revision = revision ID', '1.25' );
2043                                 $revision = Revision::newFromId( $revid, Revision::READ_LATEST );
2044                         } else {
2045                                 $revision = null;
2046                         }
2047                 }
2048
2049                 $user = is_null( $user ) ? $wgUser : $user;
2050                 // XXX: check $user->getId() here???
2051
2052                 // Use a sane default for $serialFormat, see T59026
2053                 if ( $serialFormat === null ) {
2054                         $serialFormat = $content->getContentHandler()->getDefaultFormat();
2055                 }
2056
2057                 if ( $this->mPreparedEdit
2058                         && isset( $this->mPreparedEdit->newContent )
2059                         && $this->mPreparedEdit->newContent->equals( $content )
2060                         && $this->mPreparedEdit->revid == $revid
2061                         && $this->mPreparedEdit->format == $serialFormat
2062                         // XXX: also check $user here?
2063                 ) {
2064                         // Already prepared
2065                         return $this->mPreparedEdit;
2066                 }
2067
2068                 // The edit may have already been prepared via api.php?action=stashedit
2069                 $cachedEdit = $useCache && $wgAjaxEditStash
2070                         ? ApiStashEdit::checkCache( $this->getTitle(), $content, $user )
2071                         : false;
2072
2073                 $popts = ParserOptions::newFromUserAndLang( $user, $wgContLang );
2074                 Hooks::run( 'ArticlePrepareTextForEdit', [ $this, $popts ] );
2075
2076                 $edit = new PreparedEdit();
2077                 if ( $cachedEdit ) {
2078                         $edit->timestamp = $cachedEdit->timestamp;
2079                 } else {
2080                         $edit->timestamp = wfTimestampNow();
2081                 }
2082                 // @note: $cachedEdit is safely not used if the rev ID was referenced in the text
2083                 $edit->revid = $revid;
2084
2085                 if ( $cachedEdit ) {
2086                         $edit->pstContent = $cachedEdit->pstContent;
2087                 } else {
2088                         $edit->pstContent = $content
2089                                 ? $content->preSaveTransform( $this->mTitle, $user, $popts )
2090                                 : null;
2091                 }
2092
2093                 $edit->format = $serialFormat;
2094                 $edit->popts = $this->makeParserOptions( 'canonical' );
2095                 if ( $cachedEdit ) {
2096                         $edit->output = $cachedEdit->output;
2097                 } else {
2098                         if ( $revision ) {
2099                                 // We get here if vary-revision is set. This means that this page references
2100                                 // itself (such as via self-transclusion). In this case, we need to make sure
2101                                 // that any such self-references refer to the newly-saved revision, and not
2102                                 // to the previous one, which could otherwise happen due to replica DB lag.
2103                                 $oldCallback = $edit->popts->getCurrentRevisionCallback();
2104                                 $edit->popts->setCurrentRevisionCallback(
2105                                         function ( Title $title, $parser = false ) use ( $revision, &$oldCallback ) {
2106                                                 if ( $title->equals( $revision->getTitle() ) ) {
2107                                                         return $revision;
2108                                                 } else {
2109                                                         return call_user_func( $oldCallback, $title, $parser );
2110                                                 }
2111                                         }
2112                                 );
2113                         } else {
2114                                 // Try to avoid a second parse if {{REVISIONID}} is used
2115                                 $dbIndex = ( $this->mDataLoadedFrom & self::READ_LATEST ) === self::READ_LATEST
2116                                         ? DB_MASTER // use the best possible guess
2117                                         : DB_REPLICA; // T154554
2118
2119                                 $edit->popts->setSpeculativeRevIdCallback( function () use ( $dbIndex ) {
2120                                         return 1 + (int)wfGetDB( $dbIndex )->selectField(
2121                                                 'revision',
2122                                                 'MAX(rev_id)',
2123                                                 [],
2124                                                 __METHOD__
2125                                         );
2126                                 } );
2127                         }
2128                         $edit->output = $edit->pstContent
2129                                 ? $edit->pstContent->getParserOutput( $this->mTitle, $revid, $edit->popts )
2130                                 : null;
2131                 }
2132
2133                 $edit->newContent = $content;
2134                 $edit->oldContent = $this->getContent( Revision::RAW );
2135
2136                 if ( $edit->output ) {
2137                         $edit->output->setCacheTime( wfTimestampNow() );
2138                 }
2139
2140                 // Process cache the result
2141                 $this->mPreparedEdit = $edit;
2142
2143                 return $edit;
2144         }
2145
2146         /**
2147          * Do standard deferred updates after page edit.
2148          * Update links tables, site stats, search index and message cache.
2149          * Purges pages that include this page if the text was changed here.
2150          * Every 100th edit, prune the recent changes table.
2151          *
2152          * @param Revision $revision
2153          * @param User $user User object that did the revision
2154          * @param array $options Array of options, following indexes are used:
2155          * - changed: bool, whether the revision changed the content (default true)
2156          * - created: bool, whether the revision created the page (default false)
2157          * - moved: bool, whether the page was moved (default false)
2158          * - restored: bool, whether the page was undeleted (default false)
2159          * - oldrevision: Revision object for the pre-update revision (default null)
2160          * - oldcountable: bool, null, or string 'no-change' (default null):
2161          *   - bool: whether the page was counted as an article before that
2162          *     revision, only used in changed is true and created is false
2163          *   - null: if created is false, don't update the article count; if created
2164          *     is true, do update the article count
2165          *   - 'no-change': don't update the article count, ever
2166          */
2167         public function doEditUpdates( Revision $revision, User $user, array $options = [] ) {
2168                 global $wgRCWatchCategoryMembership;
2169
2170                 $options += [
2171                         'changed' => true,
2172                         'created' => false,
2173                         'moved' => false,
2174                         'restored' => false,
2175                         'oldrevision' => null,
2176                         'oldcountable' => null
2177                 ];
2178                 $content = $revision->getContent();
2179
2180                 $logger = LoggerFactory::getInstance( 'SaveParse' );
2181
2182                 // See if the parser output before $revision was inserted is still valid
2183                 $editInfo = false;
2184                 if ( !$this->mPreparedEdit ) {
2185                         $logger->debug( __METHOD__ . ": No prepared edit...\n" );
2186                 } elseif ( $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
2187                         $logger->info( __METHOD__ . ": Prepared edit has vary-revision...\n" );
2188                 } elseif ( $this->mPreparedEdit->output->getFlag( 'vary-revision-id' )
2189                         && $this->mPreparedEdit->output->getSpeculativeRevIdUsed() !== $revision->getId()
2190                 ) {
2191                         $logger->info( __METHOD__ . ": Prepared edit has vary-revision-id with wrong ID...\n" );
2192                 } elseif ( $this->mPreparedEdit->output->getFlag( 'vary-user' ) && !$options['changed'] ) {
2193                         $logger->info( __METHOD__ . ": Prepared edit has vary-user and is null...\n" );
2194                 } else {
2195                         wfDebug( __METHOD__ . ": Using prepared edit...\n" );
2196                         $editInfo = $this->mPreparedEdit;
2197                 }
2198
2199                 if ( !$editInfo ) {
2200                         // Parse the text again if needed. Be careful not to do pre-save transform twice:
2201                         // $text is usually already pre-save transformed once. Avoid using the edit stash
2202                         // as any prepared content from there or in doEditContent() was already rejected.
2203                         $editInfo = $this->prepareContentForEdit( $content, $revision, $user, null, false );
2204                 }
2205
2206                 // Save it to the parser cache.
2207                 // Make sure the cache time matches page_touched to avoid double parsing.
2208                 MediaWikiServices::getInstance()->getParserCache()->save(
2209                         $editInfo->output, $this, $editInfo->popts,
2210                         $revision->getTimestamp(), $editInfo->revid
2211                 );
2212
2213                 // Update the links tables and other secondary data
2214                 if ( $content ) {
2215                         $recursive = $options['changed']; // T52785
2216                         $updates = $content->getSecondaryDataUpdates(
2217                                 $this->getTitle(), null, $recursive, $editInfo->output
2218                         );
2219                         foreach ( $updates as $update ) {
2220                                 $update->setCause( 'edit-page', $user->getName() );
2221                                 if ( $update instanceof LinksUpdate ) {
2222                                         $update->setRevision( $revision );
2223                                         $update->setTriggeringUser( $user );
2224                                 }
2225                                 DeferredUpdates::addUpdate( $update );
2226                         }
2227                         if ( $wgRCWatchCategoryMembership
2228                                 && $this->getContentHandler()->supportsCategories() === true
2229                                 && ( $options['changed'] || $options['created'] )
2230                                 && !$options['restored']
2231                         ) {
2232                                 // Note: jobs are pushed after deferred updates, so the job should be able to see
2233                                 // the recent change entry (also done via deferred updates) and carry over any
2234                                 // bot/deletion/IP flags, ect.
2235                                 JobQueueGroup::singleton()->lazyPush( new CategoryMembershipChangeJob(
2236                                         $this->getTitle(),
2237                                         [
2238                                                 'pageId' => $this->getId(),
2239                                                 'revTimestamp' => $revision->getTimestamp()
2240                                         ]
2241                                 ) );
2242                         }
2243                 }
2244
2245                 // Avoid PHP 7.1 warning of passing $this by reference
2246                 $wikiPage = $this;
2247
2248                 Hooks::run( 'ArticleEditUpdates', [ &$wikiPage, &$editInfo, $options['changed'] ] );
2249
2250                 if ( Hooks::run( 'ArticleEditUpdatesDeleteFromRecentchanges', [ &$wikiPage ] ) ) {
2251                         // Flush old entries from the `recentchanges` table
2252                         if ( mt_rand( 0, 9 ) == 0 ) {
2253                                 JobQueueGroup::singleton()->lazyPush( RecentChangesUpdateJob::newPurgeJob() );
2254                         }
2255                 }
2256
2257                 if ( !$this->exists() ) {
2258                         return;
2259                 }
2260
2261                 $id = $this->getId();
2262                 $title = $this->mTitle->getPrefixedDBkey();
2263                 $shortTitle = $this->mTitle->getDBkey();
2264
2265                 if ( $options['oldcountable'] === 'no-change' ||
2266                         ( !$options['changed'] && !$options['moved'] )
2267                 ) {
2268                         $good = 0;
2269                 } elseif ( $options['created'] ) {
2270                         $good = (int)$this->isCountable( $editInfo );
2271                 } elseif ( $options['oldcountable'] !== null ) {
2272                         $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2273                 } else {
2274                         $good = 0;
2275                 }
2276                 $edits = $options['changed'] ? 1 : 0;
2277                 $pages = $options['created'] ? 1 : 0;
2278
2279                 DeferredUpdates::addUpdate( SiteStatsUpdate::factory(
2280                         [ 'edits' => $edits, 'articles' => $good, 'pages' => $pages ]
2281                 ) );
2282                 DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $content ) );
2283
2284                 // If this is another user's talk page, update newtalk.
2285                 // Don't do this if $options['changed'] = false (null-edits) nor if
2286                 // it's a minor edit and the user doesn't want notifications for those.
2287                 if ( $options['changed']
2288                         && $this->mTitle->getNamespace() == NS_USER_TALK
2289                         && $shortTitle != $user->getTitleKey()
2290                         && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2291                 ) {
2292                         $recipient = User::newFromName( $shortTitle, false );
2293                         if ( !$recipient ) {
2294                                 wfDebug( __METHOD__ . ": invalid username\n" );
2295                         } else {
2296                                 // Avoid PHP 7.1 warning of passing $this by reference
2297                                 $wikiPage = $this;
2298
2299                                 // Allow extensions to prevent user notification
2300                                 // when a new message is added to their talk page
2301                                 if ( Hooks::run( 'ArticleEditUpdateNewTalk', [ &$wikiPage, $recipient ] ) ) {
2302                                         if ( User::isIP( $shortTitle ) ) {
2303                                                 // An anonymous user
2304                                                 $recipient->setNewtalk( true, $revision );
2305                                         } elseif ( $recipient->isLoggedIn() ) {
2306                                                 $recipient->setNewtalk( true, $revision );
2307                                         } else {
2308                                                 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
2309                                         }
2310                                 }
2311                         }
2312                 }
2313
2314                 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
2315                         MessageCache::singleton()->updateMessageOverride( $this->mTitle, $content );
2316                 }
2317
2318                 if ( $options['created'] ) {
2319                         self::onArticleCreate( $this->mTitle );
2320                 } elseif ( $options['changed'] ) { // T52785
2321                         self::onArticleEdit( $this->mTitle, $revision );
2322                 }
2323
2324                 ResourceLoaderWikiModule::invalidateModuleCache(
2325                         $this->mTitle, $options['oldrevision'], $revision, wfWikiID()
2326                 );
2327         }
2328
2329         /**
2330          * Update the article's restriction field, and leave a log entry.
2331          * This works for protection both existing and non-existing pages.
2332          *
2333          * @param array $limit Set of restriction keys
2334          * @param array $expiry Per restriction type expiration
2335          * @param int &$cascade Set to false if cascading protection isn't allowed.
2336          * @param string $reason
2337          * @param User $user The user updating the restrictions
2338          * @param string|string[] $tags Change tags to add to the pages and protection log entries
2339          *   ($user should be able to add the specified tags before this is called)
2340          * @return Status Status object; if action is taken, $status->value is the log_id of the
2341          *   protection log entry.
2342          */
2343         public function doUpdateRestrictions( array $limit, array $expiry,
2344                 &$cascade, $reason, User $user, $tags = null
2345         ) {
2346                 global $wgCascadingRestrictionLevels;
2347
2348                 if ( wfReadOnly() ) {
2349                         return Status::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
2350                 }
2351
2352                 $this->loadPageData( 'fromdbmaster' );
2353                 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2354                 $id = $this->getId();
2355
2356                 if ( !$cascade ) {
2357                         $cascade = false;
2358                 }
2359
2360                 // Take this opportunity to purge out expired restrictions
2361                 Title::purgeExpiredRestrictions();
2362
2363                 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2364                 // we expect a single selection, but the schema allows otherwise.
2365                 $isProtected = false;
2366                 $protect = false;
2367                 $changed = false;
2368
2369                 $dbw = wfGetDB( DB_MASTER );
2370
2371                 foreach ( $restrictionTypes as $action ) {
2372                         if ( !isset( $expiry[$action] ) || $expiry[$action] === $dbw->getInfinity() ) {
2373                                 $expiry[$action] = 'infinity';
2374                         }
2375                         if ( !isset( $limit[$action] ) ) {
2376                                 $limit[$action] = '';
2377                         } elseif ( $limit[$action] != '' ) {
2378                                 $protect = true;
2379                         }
2380
2381                         // Get current restrictions on $action
2382                         $current = implode( '', $this->mTitle->getRestrictions( $action ) );
2383                         if ( $current != '' ) {
2384                                 $isProtected = true;
2385                         }
2386
2387                         if ( $limit[$action] != $current ) {
2388                                 $changed = true;
2389                         } elseif ( $limit[$action] != '' ) {
2390                                 // Only check expiry change if the action is actually being
2391                                 // protected, since expiry does nothing on an not-protected
2392                                 // action.
2393                                 if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2394                                         $changed = true;
2395                                 }
2396                         }
2397                 }
2398
2399                 if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
2400                         $changed = true;
2401                 }
2402
2403                 // If nothing has changed, do nothing
2404                 if ( !$changed ) {
2405                         return Status::newGood();
2406                 }
2407
2408                 if ( !$protect ) { // No protection at all means unprotection
2409                         $revCommentMsg = 'unprotectedarticle-comment';
2410                         $logAction = 'unprotect';
2411                 } elseif ( $isProtected ) {
2412                         $revCommentMsg = 'modifiedarticleprotection-comment';
2413                         $logAction = 'modify';
2414                 } else {
2415                         $revCommentMsg = 'protectedarticle-comment';
2416                         $logAction = 'protect';
2417                 }
2418
2419                 $logRelationsValues = [];
2420                 $logRelationsField = null;
2421                 $logParamsDetails = [];
2422
2423                 // Null revision (used for change tag insertion)
2424                 $nullRevision = null;
2425
2426                 if ( $id ) { // Protection of existing page
2427                         // Avoid PHP 7.1 warning of passing $this by reference
2428                         $wikiPage = $this;
2429
2430                         if ( !Hooks::run( 'ArticleProtect', [ &$wikiPage, &$user, $limit, $reason ] ) ) {
2431                                 return Status::newGood();
2432                         }
2433
2434                         // Only certain restrictions can cascade...
2435                         $editrestriction = isset( $limit['edit'] )
2436                                 ? [ $limit['edit'] ]
2437                                 : $this->mTitle->getRestrictions( 'edit' );
2438                         foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2439                                 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2440                         }
2441                         foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2442                                 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2443                         }
2444
2445                         $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2446                         foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2447                                 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2448                         }
2449                         foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2450                                 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2451                         }
2452
2453                         // The schema allows multiple restrictions
2454                         if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2455                                 $cascade = false;
2456                         }
2457
2458                         // insert null revision to identify the page protection change as edit summary
2459                         $latest = $this->getLatest();
2460                         $nullRevision = $this->insertProtectNullRevision(
2461                                 $revCommentMsg,
2462                                 $limit,
2463                                 $expiry,
2464                                 $cascade,
2465                                 $reason,
2466                                 $user
2467                         );
2468
2469                         if ( $nullRevision === null ) {
2470                                 return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() );
2471                         }
2472
2473                         $logRelationsField = 'pr_id';
2474
2475                         // Update restrictions table
2476                         foreach ( $limit as $action => $restrictions ) {
2477                                 $dbw->delete(
2478                                         'page_restrictions',
2479                                         [
2480                                                 'pr_page' => $id,
2481                                                 'pr_type' => $action
2482                                         ],
2483                                         __METHOD__
2484                                 );
2485                                 if ( $restrictions != '' ) {
2486                                         $cascadeValue = ( $cascade && $action == 'edit' ) ? 1 : 0;
2487                                         $dbw->insert(
2488                                                 'page_restrictions',
2489                                                 [
2490                                                         'pr_page' => $id,
2491                                                         'pr_type' => $action,
2492                                                         'pr_level' => $restrictions,
2493                                                         'pr_cascade' => $cascadeValue,
2494                                                         'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2495                                                 ],
2496                                                 __METHOD__
2497                                         );
2498                                         $logRelationsValues[] = $dbw->insertId();
2499                                         $logParamsDetails[] = [
2500                                                 'type' => $action,
2501                                                 'level' => $restrictions,
2502                                                 'expiry' => $expiry[$action],
2503                                                 'cascade' => (bool)$cascadeValue,
2504                                         ];
2505                                 }
2506                         }
2507
2508                         // Clear out legacy restriction fields
2509                         $dbw->update(
2510                                 'page',
2511                                 [ 'page_restrictions' => '' ],
2512                                 [ 'page_id' => $id ],
2513                                 __METHOD__
2514                         );
2515
2516                         // Avoid PHP 7.1 warning of passing $this by reference
2517                         $wikiPage = $this;
2518
2519                         Hooks::run( 'NewRevisionFromEditComplete',
2520                                 [ $this, $nullRevision, $latest, $user ] );
2521                         Hooks::run( 'ArticleProtectComplete', [ &$wikiPage, &$user, $limit, $reason ] );
2522                 } else { // Protection of non-existing page (also known as "title protection")
2523                         // Cascade protection is meaningless in this case
2524                         $cascade = false;
2525
2526                         if ( $limit['create'] != '' ) {
2527                                 $commentFields = CommentStore::getStore()->insert( $dbw, 'pt_reason', $reason );
2528                                 $dbw->replace( 'protected_titles',
2529                                         [ [ 'pt_namespace', 'pt_title' ] ],
2530                                         [
2531                                                 'pt_namespace' => $this->mTitle->getNamespace(),
2532                                                 'pt_title' => $this->mTitle->getDBkey(),
2533                                                 'pt_create_perm' => $limit['create'],
2534                                                 'pt_timestamp' => $dbw->timestamp(),
2535                                                 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2536                                                 'pt_user' => $user->getId(),
2537                                         ] + $commentFields, __METHOD__
2538                                 );
2539                                 $logParamsDetails[] = [
2540                                         'type' => 'create',
2541                                         'level' => $limit['create'],
2542                                         'expiry' => $expiry['create'],
2543                                 ];
2544                         } else {
2545                                 $dbw->delete( 'protected_titles',
2546                                         [
2547                                                 'pt_namespace' => $this->mTitle->getNamespace(),
2548                                                 'pt_title' => $this->mTitle->getDBkey()
2549                                         ], __METHOD__
2550                                 );
2551                         }
2552                 }
2553
2554                 $this->mTitle->flushRestrictions();
2555                 InfoAction::invalidateCache( $this->mTitle );
2556
2557                 if ( $logAction == 'unprotect' ) {
2558                         $params = [];
2559                 } else {
2560                         $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2561                         $params = [
2562                                 '4::description' => $protectDescriptionLog, // parameter for IRC
2563                                 '5:bool:cascade' => $cascade,
2564                                 'details' => $logParamsDetails, // parameter for localize and api
2565                         ];
2566                 }
2567
2568                 // Update the protection log
2569                 $logEntry = new ManualLogEntry( 'protect', $logAction );
2570                 $logEntry->setTarget( $this->mTitle );
2571                 $logEntry->setComment( $reason );
2572                 $logEntry->setPerformer( $user );
2573                 $logEntry->setParameters( $params );
2574                 if ( !is_null( $nullRevision ) ) {
2575                         $logEntry->setAssociatedRevId( $nullRevision->getId() );
2576                 }
2577                 $logEntry->setTags( $tags );
2578                 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2579                         $logEntry->setRelations( [ $logRelationsField => $logRelationsValues ] );
2580                 }
2581                 $logId = $logEntry->insert();
2582                 $logEntry->publish( $logId );
2583
2584                 return Status::newGood( $logId );
2585         }
2586
2587         /**
2588          * Insert a new null revision for this page.
2589          *
2590          * @param string $revCommentMsg Comment message key for the revision
2591          * @param array $limit Set of restriction keys
2592          * @param array $expiry Per restriction type expiration
2593          * @param int $cascade Set to false if cascading protection isn't allowed.
2594          * @param string $reason
2595          * @param User|null $user
2596          * @return Revision|null Null on error
2597          */
2598         public function insertProtectNullRevision( $revCommentMsg, array $limit,
2599                 array $expiry, $cascade, $reason, $user = null
2600         ) {
2601                 $dbw = wfGetDB( DB_MASTER );
2602
2603                 // Prepare a null revision to be added to the history
2604                 $editComment = wfMessage(
2605                         $revCommentMsg,
2606                         $this->mTitle->getPrefixedText(),
2607                         $user ? $user->getName() : ''
2608                 )->inContentLanguage()->text();
2609                 if ( $reason ) {
2610                         $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2611                 }
2612                 $protectDescription = $this->protectDescription( $limit, $expiry );
2613                 if ( $protectDescription ) {
2614                         $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2615                         $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2616                                 ->inContentLanguage()->text();
2617                 }
2618                 if ( $cascade ) {
2619                         $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2620                         $editComment .= wfMessage( 'brackets' )->params(
2621                                 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2622                         )->inContentLanguage()->text();
2623                 }
2624
2625                 $nullRev = Revision::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2626                 if ( $nullRev ) {
2627                         $nullRev->insertOn( $dbw );
2628
2629                         // Update page record and touch page
2630                         $oldLatest = $nullRev->getParentId();
2631                         $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2632                 }
2633
2634                 return $nullRev;
2635         }
2636
2637         /**
2638          * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2639          * @return string
2640          */
2641         protected function formatExpiry( $expiry ) {
2642                 global $wgContLang;
2643
2644                 if ( $expiry != 'infinity' ) {
2645                         return wfMessage(
2646                                 'protect-expiring',
2647                                 $wgContLang->timeanddate( $expiry, false, false ),
2648                                 $wgContLang->date( $expiry, false, false ),
2649                                 $wgContLang->time( $expiry, false, false )
2650                         )->inContentLanguage()->text();
2651                 } else {
2652                         return wfMessage( 'protect-expiry-indefinite' )
2653                                 ->inContentLanguage()->text();
2654                 }
2655         }
2656
2657         /**
2658          * Builds the description to serve as comment for the edit.
2659          *
2660          * @param array $limit Set of restriction keys
2661          * @param array $expiry Per restriction type expiration
2662          * @return string
2663          */
2664         public function protectDescription( array $limit, array $expiry ) {
2665                 $protectDescription = '';
2666
2667                 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2668                         # $action is one of $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ].
2669                         # All possible message keys are listed here for easier grepping:
2670                         # * restriction-create
2671                         # * restriction-edit
2672                         # * restriction-move
2673                         # * restriction-upload
2674                         $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2675                         # $restrictions is one of $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ],
2676                         # with '' filtered out. All possible message keys are listed below:
2677                         # * protect-level-autoconfirmed
2678                         # * protect-level-sysop
2679                         $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2680                                 ->inContentLanguage()->text();
2681
2682                         $expiryText = $this->formatExpiry( $expiry[$action] );
2683
2684                         if ( $protectDescription !== '' ) {
2685                                 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2686                         }
2687                         $protectDescription .= wfMessage( 'protect-summary-desc' )
2688                                 ->params( $actionText, $restrictionsText, $expiryText )
2689                                 ->inContentLanguage()->text();
2690                 }
2691
2692                 return $protectDescription;
2693         }
2694
2695         /**
2696          * Builds the description to serve as comment for the log entry.
2697          *
2698          * Some bots may parse IRC lines, which are generated from log entries which contain plain
2699          * protect description text. Keep them in old format to avoid breaking compatibility.
2700          * TODO: Fix protection log to store structured description and format it on-the-fly.
2701          *
2702          * @param array $limit Set of restriction keys
2703          * @param array $expiry Per restriction type expiration
2704          * @return string
2705          */
2706         public function protectDescriptionLog( array $limit, array $expiry ) {
2707                 global $wgContLang;
2708
2709                 $protectDescriptionLog = '';
2710
2711                 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2712                         $expiryText = $this->formatExpiry( $expiry[$action] );
2713                         $protectDescriptionLog .= $wgContLang->getDirMark() .
2714                                 "[$action=$restrictions] ($expiryText)";
2715                 }
2716
2717                 return trim( $protectDescriptionLog );
2718         }
2719
2720         /**
2721          * Take an array of page restrictions and flatten it to a string
2722          * suitable for insertion into the page_restrictions field.
2723          *
2724          * @param string[] $limit
2725          *
2726          * @throws MWException
2727          * @return string
2728          */
2729         protected static function flattenRestrictions( $limit ) {
2730                 if ( !is_array( $limit ) ) {
2731                         throw new MWException( __METHOD__ . ' given non-array restriction set' );
2732                 }
2733
2734                 $bits = [];
2735                 ksort( $limit );
2736
2737                 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2738                         $bits[] = "$action=$restrictions";
2739                 }
2740
2741                 return implode( ':', $bits );
2742         }
2743
2744         /**
2745          * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2746          * backwards compatibility, if you care about error reporting you should use
2747          * doDeleteArticleReal() instead.
2748          *
2749          * Deletes the article with database consistency, writes logs, purges caches
2750          *
2751          * @param string $reason Delete reason for deletion log
2752          * @param bool $suppress Suppress all revisions and log the deletion in
2753          *        the suppression log instead of the deletion log
2754          * @param int $u1 Unused
2755          * @param bool $u2 Unused
2756          * @param array|string &$error Array of errors to append to
2757          * @param User $user The deleting user
2758          * @return bool True if successful
2759          */
2760         public function doDeleteArticle(
2761                 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $user = null
2762         ) {
2763                 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2764                 return $status->isGood();
2765         }
2766
2767         /**
2768          * Back-end article deletion
2769          * Deletes the article with database consistency, writes logs, purges caches
2770          *
2771          * @since 1.19
2772          *
2773          * @param string $reason Delete reason for deletion log
2774          * @param bool $suppress Suppress all revisions and log the deletion in
2775          *   the suppression log instead of the deletion log
2776          * @param int $u1 Unused
2777          * @param bool $u2 Unused
2778          * @param array|string &$error Array of errors to append to
2779          * @param User $deleter The deleting user
2780          * @param array $tags Tags to apply to the deletion action
2781          * @param string $logsubtype
2782          * @return Status Status object; if successful, $status->value is the log_id of the
2783          *   deletion log entry. If the page couldn't be deleted because it wasn't
2784          *   found, $status is a non-fatal 'cannotdelete' error
2785          */
2786         public function doDeleteArticleReal(
2787                 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $deleter = null,
2788                 $tags = [], $logsubtype = 'delete'
2789         ) {
2790                 global $wgUser, $wgContentHandlerUseDB, $wgCommentTableSchemaMigrationStage,
2791                         $wgActorTableSchemaMigrationStage;
2792
2793                 wfDebug( __METHOD__ . "\n" );
2794
2795                 $status = Status::newGood();
2796
2797                 if ( $this->mTitle->getDBkey() === '' ) {
2798                         $status->error( 'cannotdelete',
2799                                 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2800                         return $status;
2801                 }
2802
2803                 // Avoid PHP 7.1 warning of passing $this by reference
2804                 $wikiPage = $this;
2805
2806                 $deleter = is_null( $deleter ) ? $wgUser : $deleter;
2807                 if ( !Hooks::run( 'ArticleDelete',
2808                         [ &$wikiPage, &$deleter, &$reason, &$error, &$status, $suppress ]
2809                 ) ) {
2810                         if ( $status->isOK() ) {
2811                                 // Hook aborted but didn't set a fatal status
2812                                 $status->fatal( 'delete-hook-aborted' );
2813                         }
2814                         return $status;
2815                 }
2816
2817                 $dbw = wfGetDB( DB_MASTER );
2818                 $dbw->startAtomic( __METHOD__ );
2819
2820                 $this->loadPageData( self::READ_LATEST );
2821                 $id = $this->getId();
2822                 // T98706: lock the page from various other updates but avoid using
2823                 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2824                 // the revisions queries (which also JOIN on user). Only lock the page
2825                 // row and CAS check on page_latest to see if the trx snapshot matches.
2826                 $lockedLatest = $this->lockAndGetLatest();
2827                 if ( $id == 0 || $this->getLatest() != $lockedLatest ) {
2828                         $dbw->endAtomic( __METHOD__ );
2829                         // Page not there or trx snapshot is stale
2830                         $status->error( 'cannotdelete',
2831                                 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2832                         return $status;
2833                 }
2834
2835                 // Given the lock above, we can be confident in the title and page ID values
2836                 $namespace = $this->getTitle()->getNamespace();
2837                 $dbKey = $this->getTitle()->getDBkey();
2838
2839                 // At this point we are now comitted to returning an OK
2840                 // status unless some DB query error or other exception comes up.
2841                 // This way callers don't have to call rollback() if $status is bad
2842                 // unless they actually try to catch exceptions (which is rare).
2843
2844                 // we need to remember the old content so we can use it to generate all deletion updates.
2845                 $revision = $this->getRevision();
2846                 try {
2847                         $content = $this->getContent( Revision::RAW );
2848                 } catch ( Exception $ex ) {
2849                         wfLogWarning( __METHOD__ . ': failed to load content during deletion! '
2850                                 . $ex->getMessage() );
2851
2852                         $content = null;
2853                 }
2854
2855                 $commentStore = CommentStore::getStore();
2856                 $actorMigration = ActorMigration::newMigration();
2857
2858                 $revQuery = Revision::getQueryInfo();
2859                 $bitfield = false;
2860
2861                 // Bitfields to further suppress the content
2862                 if ( $suppress ) {
2863                         $bitfield = Revision::SUPPRESSED_ALL;
2864                         $revQuery['fields'] = array_diff( $revQuery['fields'], [ 'rev_deleted' ] );
2865                 }
2866
2867                 // For now, shunt the revision data into the archive table.
2868                 // Text is *not* removed from the text table; bulk storage
2869                 // is left intact to avoid breaking block-compression or
2870                 // immutable storage schemes.
2871                 // In the future, we may keep revisions and mark them with
2872                 // the rev_deleted field, which is reserved for this purpose.
2873
2874                 // Lock rows in `revision` and its temp tables, but not any others.
2875                 // Note array_intersect() preserves keys from the first arg, and we're
2876                 // assuming $revQuery has `revision` primary and isn't using subtables
2877                 // for anything we care about.
2878                 $res = $dbw->select(
2879                         array_intersect(
2880                                 $revQuery['tables'],
2881                                 [ 'revision', 'revision_comment_temp', 'revision_actor_temp' ]
2882                         ),
2883                         '1',
2884                         [ 'rev_page' => $id ],
2885                         __METHOD__,
2886                         'FOR UPDATE',
2887                         $revQuery['joins']
2888                 );
2889                 foreach ( $res as $row ) {
2890                         // Fetch all rows in case the DB needs that to properly lock them.
2891                 }
2892
2893                 // Get all of the page revisions
2894                 $res = $dbw->select(
2895                         $revQuery['tables'],
2896                         $revQuery['fields'],
2897                         [ 'rev_page' => $id ],
2898                         __METHOD__,
2899                         [],
2900                         $revQuery['joins']
2901                 );
2902
2903                 // Build their equivalent archive rows
2904                 $rowsInsert = [];
2905                 $revids = [];
2906
2907                 /** @var int[] Revision IDs of edits that were made by IPs */
2908                 $ipRevIds = [];
2909
2910                 foreach ( $res as $row ) {
2911                         $comment = $commentStore->getComment( 'rev_comment', $row );
2912                         $user = User::newFromAnyId( $row->rev_user, $row->rev_user_text, $row->rev_actor );
2913                         $rowInsert = [
2914                                 'ar_namespace'  => $namespace,
2915                                 'ar_title'      => $dbKey,
2916                                 'ar_timestamp'  => $row->rev_timestamp,
2917                                 'ar_minor_edit' => $row->rev_minor_edit,
2918                                 'ar_rev_id'     => $row->rev_id,
2919                                 'ar_parent_id'  => $row->rev_parent_id,
2920                                 'ar_text_id'    => $row->rev_text_id,
2921                                 'ar_text'       => '',
2922                                 'ar_flags'      => '',
2923                                 'ar_len'        => $row->rev_len,
2924                                 'ar_page_id'    => $id,
2925                                 'ar_deleted'    => $suppress ? $bitfield : $row->rev_deleted,
2926                                 'ar_sha1'       => $row->rev_sha1,
2927                         ] + $commentStore->insert( $dbw, 'ar_comment', $comment )
2928                                 + $actorMigration->getInsertValues( $dbw, 'ar_user', $user );
2929                         if ( $wgContentHandlerUseDB ) {
2930                                 $rowInsert['ar_content_model'] = $row->rev_content_model;
2931                                 $rowInsert['ar_content_format'] = $row->rev_content_format;
2932                         }
2933                         $rowsInsert[] = $rowInsert;
2934                         $revids[] = $row->rev_id;
2935
2936                         // Keep track of IP edits, so that the corresponding rows can
2937                         // be deleted in the ip_changes table.
2938                         if ( (int)$row->rev_user === 0 && IP::isValid( $row->rev_user_text ) ) {
2939                                 $ipRevIds[] = $row->rev_id;
2940                         }
2941                 }
2942                 // Copy them into the archive table
2943                 $dbw->insert( 'archive', $rowsInsert, __METHOD__ );
2944                 // Save this so we can pass it to the ArticleDeleteComplete hook.
2945                 $archivedRevisionCount = $dbw->affectedRows();
2946
2947                 // Clone the title and wikiPage, so we have the information we need when
2948                 // we log and run the ArticleDeleteComplete hook.
2949                 $logTitle = clone $this->mTitle;
2950                 $wikiPageBeforeDelete = clone $this;
2951
2952                 // Now that it's safely backed up, delete it
2953                 $dbw->delete( 'page', [ 'page_id' => $id ], __METHOD__ );
2954                 $dbw->delete( 'revision', [ 'rev_page' => $id ], __METHOD__ );
2955                 if ( $wgCommentTableSchemaMigrationStage > MIGRATION_OLD ) {
2956                         $dbw->delete( 'revision_comment_temp', [ 'revcomment_rev' => $revids ], __METHOD__ );
2957                 }
2958                 if ( $wgActorTableSchemaMigrationStage > MIGRATION_OLD ) {
2959                         $dbw->delete( 'revision_actor_temp', [ 'revactor_rev' => $revids ], __METHOD__ );
2960                 }
2961
2962                 // Also delete records from ip_changes as applicable.
2963                 if ( count( $ipRevIds ) > 0 ) {
2964                         $dbw->delete( 'ip_changes', [ 'ipc_rev_id' => $ipRevIds ], __METHOD__ );
2965                 }
2966
2967                 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2968                 $logtype = $suppress ? 'suppress' : 'delete';
2969
2970                 $logEntry = new ManualLogEntry( $logtype, $logsubtype );
2971                 $logEntry->setPerformer( $deleter );
2972                 $logEntry->setTarget( $logTitle );
2973                 $logEntry->setComment( $reason );
2974                 $logEntry->setTags( $tags );
2975                 $logid = $logEntry->insert();
2976
2977                 $dbw->onTransactionPreCommitOrIdle(
2978                         function () use ( $dbw, $logEntry, $logid ) {
2979                                 // T58776: avoid deadlocks (especially from FileDeleteForm)
2980                                 $logEntry->publish( $logid );
2981                         },
2982                         __METHOD__
2983                 );
2984
2985                 $dbw->endAtomic( __METHOD__ );
2986
2987                 $this->doDeleteUpdates( $id, $content, $revision, $deleter );
2988
2989                 Hooks::run( 'ArticleDeleteComplete', [
2990                         &$wikiPageBeforeDelete,
2991                         &$deleter,
2992                         $reason,
2993                         $id,
2994                         $content,
2995                         $logEntry,
2996                         $archivedRevisionCount
2997                 ] );
2998                 $status->value = $logid;
2999
3000                 // Show log excerpt on 404 pages rather than just a link
3001                 $cache = MediaWikiServices::getInstance()->getMainObjectStash();
3002                 $key = $cache->makeKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
3003                 $cache->set( $key, 1, $cache::TTL_DAY );
3004
3005                 return $status;
3006         }
3007
3008         /**
3009          * Lock the page row for this title+id and return page_latest (or 0)
3010          *
3011          * @return int Returns 0 if no row was found with this title+id
3012          * @since 1.27
3013          */
3014         public function lockAndGetLatest() {
3015                 return (int)wfGetDB( DB_MASTER )->selectField(
3016                         'page',
3017                         'page_latest',
3018                         [
3019                                 'page_id' => $this->getId(),
3020                                 // Typically page_id is enough, but some code might try to do
3021                                 // updates assuming the title is the same, so verify that
3022                                 'page_namespace' => $this->getTitle()->getNamespace(),
3023                                 'page_title' => $this->getTitle()->getDBkey()
3024                         ],
3025                         __METHOD__,
3026                         [ 'FOR UPDATE' ]
3027                 );
3028         }
3029
3030         /**
3031          * Do some database updates after deletion
3032          *
3033          * @param int $id The page_id value of the page being deleted
3034          * @param Content|null $content Optional page content to be used when determining
3035          *   the required updates. This may be needed because $this->getContent()
3036          *   may already return null when the page proper was deleted.
3037          * @param Revision|null $revision The latest page revision
3038          * @param User|null $user The user that caused the deletion
3039          */
3040         public function doDeleteUpdates(
3041                 $id, Content $content = null, Revision $revision = null, User $user = null
3042         ) {
3043                 try {
3044                         $countable = $this->isCountable();
3045                 } catch ( Exception $ex ) {
3046                         // fallback for deleting broken pages for which we cannot load the content for
3047                         // some reason. Note that doDeleteArticleReal() already logged this problem.
3048                         $countable = false;
3049                 }
3050
3051                 // Update site status
3052                 DeferredUpdates::addUpdate( SiteStatsUpdate::factory(
3053                         [ 'edits' => 1, 'articles' => -$countable, 'pages' => -1 ]
3054                 ) );
3055
3056                 // Delete pagelinks, update secondary indexes, etc
3057                 $updates = $this->getDeletionUpdates( $content );
3058                 foreach ( $updates as $update ) {
3059                         DeferredUpdates::addUpdate( $update );
3060                 }
3061
3062                 $causeAgent = $user ? $user->getName() : 'unknown';
3063                 // Reparse any pages transcluding this page
3064                 LinksUpdate::queueRecursiveJobsForTable(
3065                         $this->mTitle, 'templatelinks', 'delete-page', $causeAgent );
3066                 // Reparse any pages including this image
3067                 if ( $this->mTitle->getNamespace() == NS_FILE ) {
3068                         LinksUpdate::queueRecursiveJobsForTable(
3069                                 $this->mTitle, 'imagelinks', 'delete-page', $causeAgent );
3070                 }
3071
3072                 // Clear caches
3073                 self::onArticleDelete( $this->mTitle );
3074                 ResourceLoaderWikiModule::invalidateModuleCache(
3075                         $this->mTitle, $revision, null, wfWikiID()
3076                 );
3077
3078                 // Reset this object and the Title object
3079                 $this->loadFromRow( false, self::READ_LATEST );
3080
3081                 // Search engine
3082                 DeferredUpdates::addUpdate( new SearchUpdate( $id, $this->mTitle ) );
3083         }
3084
3085         /**
3086          * Roll back the most recent consecutive set of edits to a page
3087          * from the same user; fails if there are no eligible edits to
3088          * roll back to, e.g. user is the sole contributor. This function
3089          * performs permissions checks on $user, then calls commitRollback()
3090          * to do the dirty work
3091          *
3092          * @todo Separate the business/permission stuff out from backend code
3093          * @todo Remove $token parameter. Already verified by RollbackAction and ApiRollback.
3094          *
3095          * @param string $fromP Name of the user whose edits to rollback.
3096          * @param string $summary Custom summary. Set to default summary if empty.
3097          * @param string $token Rollback token.
3098          * @param bool $bot If true, mark all reverted edits as bot.
3099          *
3100          * @param array &$resultDetails Array contains result-specific array of additional values
3101          *    'alreadyrolled' : 'current' (rev)
3102          *    success        : 'summary' (str), 'current' (rev), 'target' (rev)
3103          *
3104          * @param User $user The user performing the rollback
3105          * @param array|null $tags Change tags to apply to the rollback
3106          * Callers are responsible for permission checks
3107          * (with ChangeTags::canAddTagsAccompanyingChange)
3108          *
3109          * @return array Array of errors, each error formatted as
3110          *   array(messagekey, param1, param2, ...).
3111          * On success, the array is empty.  This array can also be passed to
3112          * OutputPage::showPermissionsErrorPage().
3113          */
3114         public function doRollback(
3115                 $fromP, $summary, $token, $bot, &$resultDetails, User $user, $tags = null
3116         ) {
3117                 $resultDetails = null;
3118
3119                 // Check permissions
3120                 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
3121                 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
3122                 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3123
3124                 if ( !$user->matchEditToken( $token, 'rollback' ) ) {
3125                         $errors[] = [ 'sessionfailure' ];
3126                 }
3127
3128                 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
3129                         $errors[] = [ 'actionthrottledtext' ];
3130                 }
3131
3132                 // If there were errors, bail out now
3133                 if ( !empty( $errors ) ) {
3134                         return $errors;
3135                 }
3136
3137                 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user, $tags );
3138         }
3139
3140         /**
3141          * Backend implementation of doRollback(), please refer there for parameter
3142          * and return value documentation
3143          *
3144          * NOTE: This function does NOT check ANY permissions, it just commits the
3145          * rollback to the DB. Therefore, you should only call this function direct-
3146          * ly if you want to use custom permissions checks. If you don't, use
3147          * doRollback() instead.
3148          * @param string $fromP Name of the user whose edits to rollback.
3149          * @param string $summary Custom summary. Set to default summary if empty.
3150          * @param bool $bot If true, mark all reverted edits as bot.
3151          *
3152          * @param array &$resultDetails Contains result-specific array of additional values
3153          * @param User $guser The user performing the rollback
3154          * @param array|null $tags Change tags to apply to the rollback
3155          * Callers are responsible for permission checks
3156          * (with ChangeTags::canAddTagsAccompanyingChange)
3157          *
3158          * @return array
3159          */
3160         public function commitRollback( $fromP, $summary, $bot,
3161                 &$resultDetails, User $guser, $tags = null
3162         ) {
3163                 global $wgUseRCPatrol, $wgContLang;
3164
3165                 $dbw = wfGetDB( DB_MASTER );
3166
3167                 if ( wfReadOnly() ) {
3168                         return [ [ 'readonlytext' ] ];
3169                 }
3170
3171                 // Get the last editor
3172                 $current = $this->getRevision();
3173                 if ( is_null( $current ) ) {
3174                         // Something wrong... no page?
3175                         return [ [ 'notanarticle' ] ];
3176                 }
3177
3178                 $from = str_replace( '_', ' ', $fromP );
3179                 // User name given should match up with the top revision.
3180                 // If the user was deleted then $from should be empty.
3181                 if ( $from != $current->getUserText() ) {
3182                         $resultDetails = [ 'current' => $current ];
3183                         return [ [ 'alreadyrolled',
3184                                 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3185                                 htmlspecialchars( $fromP ),
3186                                 htmlspecialchars( $current->getUserText() )
3187                         ] ];
3188                 }
3189
3190                 // Get the last edit not by this person...
3191                 // Note: these may not be public values
3192                 $userId = intval( $current->getUser( Revision::RAW ) );
3193                 $userName = $current->getUserText( Revision::RAW );
3194                 if ( $userId ) {
3195                         $user = User::newFromId( $userId );
3196                         $user->setName( $userName );
3197                 } else {
3198                         $user = User::newFromName( $current->getUserText( Revision::RAW ), false );
3199                 }
3200
3201                 $actorWhere = ActorMigration::newMigration()->getWhere( $dbw, 'rev_user', $user );
3202
3203                 $s = $dbw->selectRow(
3204                         [ 'revision' ] + $actorWhere['tables'],
3205                         [ 'rev_id', 'rev_timestamp', 'rev_deleted' ],
3206                         [
3207                                 'rev_page' => $current->getPage(),
3208                                 'NOT(' . $actorWhere['conds'] . ')',
3209                         ],
3210                         __METHOD__,
3211                         [
3212                                 'USE INDEX' => [ 'revision' => 'page_timestamp' ],
3213                                 'ORDER BY' => 'rev_timestamp DESC'
3214                         ],
3215                         $actorWhere['joins']
3216                 );
3217                 if ( $s === false ) {
3218                         // No one else ever edited this page
3219                         return [ [ 'cantrollback' ] ];
3220                 } elseif ( $s->rev_deleted & Revision::DELETED_TEXT
3221                         || $s->rev_deleted & Revision::DELETED_USER
3222                 ) {
3223                         // Only admins can see this text
3224                         return [ [ 'notvisiblerev' ] ];
3225                 }
3226
3227                 // Generate the edit summary if necessary
3228                 $target = Revision::newFromId( $s->rev_id, Revision::READ_LATEST );
3229                 if ( empty( $summary ) ) {
3230                         if ( $from == '' ) { // no public user name
3231                                 $summary = wfMessage( 'revertpage-nouser' );
3232                         } else {
3233                                 $summary = wfMessage( 'revertpage' );
3234                         }
3235                 }
3236
3237                 // Allow the custom summary to use the same args as the default message
3238                 $args = [
3239                         $target->getUserText(), $from, $s->rev_id,
3240                         $wgContLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
3241                         $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3242                 ];
3243                 if ( $summary instanceof Message ) {
3244                         $summary = $summary->params( $args )->inContentLanguage()->text();
3245                 } else {
3246                         $summary = wfMsgReplaceArgs( $summary, $args );
3247                 }
3248
3249                 // Trim spaces on user supplied text
3250                 $summary = trim( $summary );
3251
3252                 // Save
3253                 $flags = EDIT_UPDATE | EDIT_INTERNAL;
3254
3255                 if ( $guser->isAllowed( 'minoredit' ) ) {
3256                         $flags |= EDIT_MINOR;
3257                 }
3258
3259                 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3260                         $flags |= EDIT_FORCE_BOT;
3261                 }
3262
3263                 $targetContent = $target->getContent();
3264                 $changingContentModel = $targetContent->getModel() !== $current->getContentModel();
3265
3266                 if ( in_array( 'mw-rollback', ChangeTags::getSoftwareTags() ) ) {
3267                         $tags[] = 'mw-rollback';
3268                 }
3269
3270                 // Actually store the edit
3271                 $status = $this->doEditContent(
3272                         $targetContent,
3273                         $summary,
3274                         $flags,
3275                         $target->getId(),
3276                         $guser,
3277                         null,
3278                         $tags
3279                 );
3280
3281                 // Set patrolling and bot flag on the edits, which gets rollbacked.
3282                 // This is done even on edit failure to have patrolling in that case (T64157).
3283                 $set = [];
3284                 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3285                         // Mark all reverted edits as bot
3286                         $set['rc_bot'] = 1;
3287                 }
3288
3289                 if ( $wgUseRCPatrol ) {
3290                         // Mark all reverted edits as patrolled
3291                         $set['rc_patrolled'] = 1;
3292                 }
3293
3294                 if ( count( $set ) ) {
3295                         $actorWhere = ActorMigration::newMigration()->getWhere( $dbw, 'rc_user', $user, false );
3296                         $dbw->update( 'recentchanges', $set,
3297                                 [ /* WHERE */
3298                                         'rc_cur_id' => $current->getPage(),
3299                                         'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp ),
3300                                         $actorWhere['conds'], // No tables/joins are needed for rc_user
3301                                 ],
3302                                 __METHOD__
3303                         );
3304                 }
3305
3306                 if ( !$status->isOK() ) {
3307                         return $status->getErrorsArray();
3308                 }
3309
3310                 // raise error, when the edit is an edit without a new version
3311                 $statusRev = isset( $status->value['revision'] )
3312                         ? $status->value['revision']
3313                         : null;
3314                 if ( !( $statusRev instanceof Revision ) ) {
3315                         $resultDetails = [ 'current' => $current ];
3316                         return [ [ 'alreadyrolled',
3317                                         htmlspecialchars( $this->mTitle->getPrefixedText() ),
3318                                         htmlspecialchars( $fromP ),
3319                                         htmlspecialchars( $current->getUserText() )
3320                         ] ];
3321                 }
3322
3323                 if ( $changingContentModel ) {
3324                         // If the content model changed during the rollback,
3325                         // make sure it gets logged to Special:Log/contentmodel
3326                         $log = new ManualLogEntry( 'contentmodel', 'change' );
3327                         $log->setPerformer( $guser );
3328                         $log->setTarget( $this->mTitle );
3329                         $log->setComment( $summary );
3330                         $log->setParameters( [
3331                                 '4::oldmodel' => $current->getContentModel(),
3332                                 '5::newmodel' => $targetContent->getModel(),
3333                         ] );
3334
3335                         $logId = $log->insert( $dbw );
3336                         $log->publish( $logId );
3337                 }
3338
3339                 $revId = $statusRev->getId();
3340
3341                 Hooks::run( 'ArticleRollbackComplete', [ $this, $guser, $target, $current ] );
3342
3343                 $resultDetails = [
3344                         'summary' => $summary,
3345                         'current' => $current,
3346                         'target' => $target,
3347                         'newid' => $revId,
3348                         'tags' => $tags
3349                 ];
3350
3351                 return [];
3352         }
3353
3354         /**
3355          * The onArticle*() functions are supposed to be a kind of hooks
3356          * which should be called whenever any of the specified actions
3357          * are done.
3358          *
3359          * This is a good place to put code to clear caches, for instance.
3360          *
3361          * This is called on page move and undelete, as well as edit
3362          *
3363          * @param Title $title
3364          */
3365         public static function onArticleCreate( Title $title ) {
3366                 // Update existence markers on article/talk tabs...
3367                 $other = $title->getOtherPage();
3368
3369                 $other->purgeSquid();
3370
3371                 $title->touchLinks();
3372                 $title->purgeSquid();
3373                 $title->deleteTitleProtection();
3374
3375                 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3376
3377                 // Invalidate caches of articles which include this page
3378                 DeferredUpdates::addUpdate(
3379                         new HTMLCacheUpdate( $title, 'templatelinks', 'page-create' )
3380                 );
3381
3382                 if ( $title->getNamespace() == NS_CATEGORY ) {
3383                         // Load the Category object, which will schedule a job to create
3384                         // the category table row if necessary. Checking a replica DB is ok
3385                         // here, in the worst case it'll run an unnecessary recount job on
3386                         // a category that probably doesn't have many members.
3387                         Category::newFromTitle( $title )->getID();
3388                 }
3389         }
3390
3391         /**
3392          * Clears caches when article is deleted
3393          *
3394          * @param Title $title
3395          */
3396         public static function onArticleDelete( Title $title ) {
3397                 // Update existence markers on article/talk tabs...
3398                 // Clear Backlink cache first so that purge jobs use more up-to-date backlink information
3399                 BacklinkCache::get( $title )->clear();
3400                 $other = $title->getOtherPage();
3401
3402                 $other->purgeSquid();
3403
3404                 $title->touchLinks();
3405                 $title->purgeSquid();
3406
3407                 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3408
3409                 // File cache
3410                 HTMLFileCache::clearFileCache( $title );
3411                 InfoAction::invalidateCache( $title );
3412
3413                 // Messages
3414                 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
3415                         MessageCache::singleton()->updateMessageOverride( $title, null );
3416                 }
3417
3418                 // Images
3419                 if ( $title->getNamespace() == NS_FILE ) {
3420                         DeferredUpdates::addUpdate(
3421                                 new HTMLCacheUpdate( $title, 'imagelinks', 'page-delete' )
3422                         );
3423                 }
3424
3425                 // User talk pages
3426                 if ( $title->getNamespace() == NS_USER_TALK ) {
3427                         $user = User::newFromName( $title->getText(), false );
3428                         if ( $user ) {
3429                                 $user->setNewtalk( false );
3430                         }
3431                 }
3432
3433                 // Image redirects
3434                 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3435         }
3436
3437         /**
3438          * Purge caches on page update etc
3439          *
3440          * @param Title $title
3441          * @param Revision|null $revision Revision that was just saved, may be null
3442          */
3443         public static function onArticleEdit( Title $title, Revision $revision = null ) {
3444                 // Invalidate caches of articles which include this page
3445                 DeferredUpdates::addUpdate(
3446                         new HTMLCacheUpdate( $title, 'templatelinks', 'page-edit' )
3447                 );
3448
3449                 // Invalidate the caches of all pages which redirect here
3450                 DeferredUpdates::addUpdate(
3451                         new HTMLCacheUpdate( $title, 'redirect', 'page-edit' )
3452                 );
3453
3454                 MediaWikiServices::getInstance()->getLinkCache()->invalidateTitle( $title );
3455
3456                 // Purge CDN for this page only
3457                 $title->purgeSquid();
3458                 // Clear file cache for this page only
3459                 HTMLFileCache::clearFileCache( $title );
3460
3461                 $revid = $revision ? $revision->getId() : null;
3462                 DeferredUpdates::addCallableUpdate( function () use ( $title, $revid ) {
3463                         InfoAction::invalidateCache( $title, $revid );
3464                 } );
3465         }
3466
3467         /**#@-*/
3468
3469         /**
3470          * Returns a list of categories this page is a member of.
3471          * Results will include hidden categories
3472          *
3473          * @return TitleArray
3474          */
3475         public function getCategories() {
3476                 $id = $this->getId();
3477                 if ( $id == 0 ) {
3478                         return TitleArray::newFromResult( new FakeResultWrapper( [] ) );
3479                 }
3480
3481                 $dbr = wfGetDB( DB_REPLICA );
3482                 $res = $dbr->select( 'categorylinks',
3483                         [ 'cl_to AS page_title, ' . NS_CATEGORY . ' AS page_namespace' ],
3484                         // Have to do that since Database::fieldNamesWithAlias treats numeric indexes
3485                         // as not being aliases, and NS_CATEGORY is numeric
3486                         [ 'cl_from' => $id ],
3487                         __METHOD__ );
3488
3489                 return TitleArray::newFromResult( $res );
3490         }
3491
3492         /**
3493          * Returns a list of hidden categories this page is a member of.
3494          * Uses the page_props and categorylinks tables.
3495          *
3496          * @return array Array of Title objects
3497          */
3498         public function getHiddenCategories() {
3499                 $result = [];
3500                 $id = $this->getId();
3501
3502                 if ( $id == 0 ) {
3503                         return [];
3504                 }
3505
3506                 $dbr = wfGetDB( DB_REPLICA );
3507                 $res = $dbr->select( [ 'categorylinks', 'page_props', 'page' ],
3508                         [ 'cl_to' ],
3509                         [ 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3510                                 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ],
3511                         __METHOD__ );
3512
3513                 if ( $res !== false ) {
3514                         foreach ( $res as $row ) {
3515                                 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
3516                         }
3517                 }
3518
3519                 return $result;
3520         }
3521
3522         /**
3523          * Auto-generates a deletion reason
3524          *
3525          * @param bool &$hasHistory Whether the page has a history
3526          * @return string|bool String containing deletion reason or empty string, or boolean false
3527          *    if no revision occurred
3528          */
3529         public function getAutoDeleteReason( &$hasHistory ) {
3530                 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3531         }
3532
3533         /**
3534          * Update all the appropriate counts in the category table, given that
3535          * we've added the categories $added and deleted the categories $deleted.
3536          *
3537          * This should only be called from deferred updates or jobs to avoid contention.
3538          *
3539          * @param array $added The names of categories that were added
3540          * @param array $deleted The names of categories that were deleted
3541          * @param int $id Page ID (this should be the original deleted page ID)
3542          */
3543         public function updateCategoryCounts( array $added, array $deleted, $id = 0 ) {
3544                 $id = $id ?: $this->getId();
3545                 $ns = $this->getTitle()->getNamespace();
3546
3547                 $addFields = [ 'cat_pages = cat_pages + 1' ];
3548                 $removeFields = [ 'cat_pages = cat_pages - 1' ];
3549                 if ( $ns == NS_CATEGORY ) {
3550                         $addFields[] = 'cat_subcats = cat_subcats + 1';
3551                         $removeFields[] = 'cat_subcats = cat_subcats - 1';
3552                 } elseif ( $ns == NS_FILE ) {
3553                         $addFields[] = 'cat_files = cat_files + 1';
3554                         $removeFields[] = 'cat_files = cat_files - 1';
3555                 }
3556
3557                 $dbw = wfGetDB( DB_MASTER );
3558
3559                 if ( count( $added ) ) {
3560                         $existingAdded = $dbw->selectFieldValues(
3561                                 'category',
3562                                 'cat_title',
3563                                 [ 'cat_title' => $added ],
3564                                 __METHOD__
3565                         );
3566
3567                         // For category rows that already exist, do a plain
3568                         // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3569                         // to avoid creating gaps in the cat_id sequence.
3570                         if ( count( $existingAdded ) ) {
3571                                 $dbw->update(
3572                                         'category',
3573                                         $addFields,
3574                                         [ 'cat_title' => $existingAdded ],
3575                                         __METHOD__
3576                                 );
3577                         }
3578
3579                         $missingAdded = array_diff( $added, $existingAdded );
3580                         if ( count( $missingAdded ) ) {
3581                                 $insertRows = [];
3582                                 foreach ( $missingAdded as $cat ) {
3583                                         $insertRows[] = [
3584                                                 'cat_title'   => $cat,
3585                                                 'cat_pages'   => 1,
3586                                                 'cat_subcats' => ( $ns == NS_CATEGORY ) ? 1 : 0,
3587                                                 'cat_files'   => ( $ns == NS_FILE ) ? 1 : 0,
3588                                         ];
3589                                 }
3590                                 $dbw->upsert(
3591                                         'category',
3592                                         $insertRows,
3593                                         [ 'cat_title' ],
3594                                         $addFields,
3595                                         __METHOD__
3596                                 );
3597                         }
3598                 }
3599
3600                 if ( count( $deleted ) ) {
3601                         $dbw->update(
3602                                 'category',
3603                                 $removeFields,
3604                                 [ 'cat_title' => $deleted ],
3605                                 __METHOD__
3606                         );
3607                 }
3608
3609                 foreach ( $added as $catName ) {
3610                         $cat = Category::newFromName( $catName );
3611                         Hooks::run( 'CategoryAfterPageAdded', [ $cat, $this ] );
3612                 }
3613
3614                 foreach ( $deleted as $catName ) {
3615                         $cat = Category::newFromName( $catName );
3616                         Hooks::run( 'CategoryAfterPageRemoved', [ $cat, $this, $id ] );
3617                 }
3618
3619                 // Refresh counts on categories that should be empty now, to
3620                 // trigger possible deletion. Check master for the most
3621                 // up-to-date cat_pages.
3622                 if ( count( $deleted ) ) {
3623                         $rows = $dbw->select(
3624                                 'category',
3625                                 [ 'cat_id', 'cat_title', 'cat_pages', 'cat_subcats', 'cat_files' ],
3626                                 [ 'cat_title' => $deleted, 'cat_pages <= 0' ],
3627                                 __METHOD__
3628                         );
3629                         foreach ( $rows as $row ) {
3630                                 $cat = Category::newFromRow( $row );
3631                                 // T166757: do the update after this DB commit
3632                                 DeferredUpdates::addCallableUpdate( function () use ( $cat ) {
3633                                         $cat->refreshCounts();
3634                                 } );
3635                         }
3636                 }
3637         }
3638
3639         /**
3640          * Opportunistically enqueue link update jobs given fresh parser output if useful
3641          *
3642          * @param ParserOutput $parserOutput Current version page output
3643          * @since 1.25
3644          */
3645         public function triggerOpportunisticLinksUpdate( ParserOutput $parserOutput ) {
3646                 if ( wfReadOnly() ) {
3647                         return;
3648                 }
3649
3650                 if ( !Hooks::run( 'OpportunisticLinksUpdate',
3651                         [ $this, $this->mTitle, $parserOutput ]
3652                 ) ) {
3653                         return;
3654                 }
3655
3656                 $config = RequestContext::getMain()->getConfig();
3657
3658                 $params = [
3659                         'isOpportunistic' => true,
3660                         'rootJobTimestamp' => $parserOutput->getCacheTime()
3661                 ];
3662
3663                 if ( $this->mTitle->areRestrictionsCascading() ) {
3664                         // If the page is cascade protecting, the links should really be up-to-date
3665                         JobQueueGroup::singleton()->lazyPush(
3666                                 RefreshLinksJob::newPrioritized( $this->mTitle, $params )
3667                         );
3668                 } elseif ( !$config->get( 'MiserMode' ) && $parserOutput->hasDynamicContent() ) {
3669                         // Assume the output contains "dynamic" time/random based magic words.
3670                         // Only update pages that expired due to dynamic content and NOT due to edits
3671                         // to referenced templates/files. When the cache expires due to dynamic content,
3672                         // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3673                         // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3674                         // template/file edit already triggered recursive RefreshLinksJob jobs.
3675                         if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3676                                 // If a page is uncacheable, do not keep spamming a job for it.
3677                                 // Although it would be de-duplicated, it would still waste I/O.
3678                                 $cache = ObjectCache::getLocalClusterInstance();
3679                                 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3680                                 $ttl = max( $parserOutput->getCacheExpiry(), 3600 );
3681                                 if ( $cache->add( $key, time(), $ttl ) ) {
3682                                         JobQueueGroup::singleton()->lazyPush(
3683                                                 RefreshLinksJob::newDynamic( $this->mTitle, $params )
3684                                         );
3685                                 }
3686                         }
3687                 }
3688         }
3689
3690         /**
3691          * Returns a list of updates to be performed when this page is deleted. The
3692          * updates should remove any information about this page from secondary data
3693          * stores such as links tables.
3694          *
3695          * @param Content|null $content Optional Content object for determining the
3696          *   necessary updates.
3697          * @return DeferrableUpdate[]
3698          */
3699         public function getDeletionUpdates( Content $content = null ) {
3700                 if ( !$content ) {
3701                         // load content object, which may be used to determine the necessary updates.
3702                         // XXX: the content may not be needed to determine the updates.
3703                         try {
3704                                 $content = $this->getContent( Revision::RAW );
3705                         } catch ( Exception $ex ) {
3706                                 // If we can't load the content, something is wrong. Perhaps that's why
3707                                 // the user is trying to delete the page, so let's not fail in that case.
3708                                 // Note that doDeleteArticleReal() will already have logged an issue with
3709                                 // loading the content.
3710                         }
3711                 }
3712
3713                 if ( !$content ) {
3714                         $updates = [];
3715                 } else {
3716                         $updates = $content->getDeletionUpdates( $this );
3717                 }
3718
3719                 Hooks::run( 'WikiPageDeletionUpdates', [ $this, $content, &$updates ] );
3720                 return $updates;
3721         }
3722
3723         /**
3724          * Whether this content displayed on this page
3725          * comes from the local database
3726          *
3727          * @since 1.28
3728          * @return bool
3729          */
3730         public function isLocal() {
3731                 return true;
3732         }
3733
3734         /**
3735          * The display name for the site this content
3736          * come from. If a subclass overrides isLocal(),
3737          * this could return something other than the
3738          * current site name
3739          *
3740          * @since 1.28
3741          * @return string
3742          */
3743         public function getWikiDisplayName() {
3744                 global $wgSitename;
3745                 return $wgSitename;
3746         }
3747
3748         /**
3749          * Get the source URL for the content on this page,
3750          * typically the canonical URL, but may be a remote
3751          * link if the content comes from another site
3752          *
3753          * @since 1.28
3754          * @return string
3755          */
3756         public function getSourceURL() {
3757                 return $this->getTitle()->getCanonicalURL();
3758         }
3759
3760         /**
3761          * @param WANObjectCache $cache
3762          * @return string[]
3763          * @since 1.28
3764          */
3765         public function getMutableCacheKeys( WANObjectCache $cache ) {
3766                 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3767
3768                 return $linkCache->getMutableCacheKeys( $cache, $this->getTitle()->getTitleValue() );
3769         }
3770 }