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