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                         );
 886                         return $this->mRedirectTarget;
 887                 }
 888
 889                 // This page doesn't have an entry in the redirect table
 890                 $this->mRedirectTarget = $this->insertRedirect();
 891                 return $this->mRedirectTarget;
 892         }
 893
 894         /**
 895          * Insert an entry for this page into the redirect table if the content is a redirect
 896          *
 897          * The database update will be deferred via DeferredUpdates
 898          *
 899          * Don't call this function directly unless you know what you're doing.
 900          * @return Title|null Title object or null if not a redirect
 901          */
 902         public function insertRedirect() {
 903                 $content = $this->getContent();
 904                 $retval = $content ? $content->getUltimateRedirectTarget() : null;
 905                 if ( !$retval ) {
 906                         return null;
 907                 }
 908
 909                 // Update the DB post-send if the page has not cached since now
 910                 $that = $this;
 911                 $latest = $this->getLatest();
 912                 DeferredUpdates::addCallableUpdate( function() use ( $that, $retval, $latest ) {
 913                         $that->insertRedirectEntry( $retval, $latest );
 914                 } );
 915
 916                 return $retval;
 917         }
 918
 919         /**
 920          * Insert or update the redirect table entry for this page to indicate it redirects to $rt
 921          * @param Title $rt Redirect target
 922          * @param int|null $oldLatest Prior page_latest for check and set
 923          */
 924         public function insertRedirectEntry( Title $rt, $oldLatest = null ) {
 925                 $dbw = wfGetDB( DB_MASTER );
 926                 $dbw->startAtomic( __METHOD__ );
 927
 928                 if ( !$oldLatest || $oldLatest == $this->lockAndGetLatest() ) {
 929                         $dbw->replace( 'redirect',
 930                                 array( 'rd_from' ),
 931                                 array(
 932                                         'rd_from' => $this->getId(),
 933                                         'rd_namespace' => $rt->getNamespace(),
 934                                         'rd_title' => $rt->getDBkey(),
 935                                         'rd_fragment' => $rt->getFragment(),
 936                                         'rd_interwiki' => $rt->getInterwiki(),
 937                                 ),
 938                                 __METHOD__
 939                         );
 940                 }
 941
 942                 $dbw->endAtomic( __METHOD__ );
 943         }
 944
 945         /**
 946          * Get the Title object or URL this page redirects to
 947          *
 948          * @return bool|Title|string False, Title of in-wiki target, or string with URL
 949          */
 950         public function followRedirect() {
 951                 return $this->getRedirectURL( $this->getRedirectTarget() );
 952         }
 953
 954         /**
 955          * Get the Title object or URL to use for a redirect. We use Title
 956          * objects for same-wiki, non-special redirects and URLs for everything
 957          * else.
 958          * @param Title $rt Redirect target
 959          * @return bool|Title|string False, Title object of local target, or string with URL
 960          */
 961         public function getRedirectURL( $rt ) {
 962                 if ( !$rt ) {
 963                         return false;
 964                 }
 965
 966                 if ( $rt->isExternal() ) {
 967                         if ( $rt->isLocal() ) {
 968                                 // Offsite wikis need an HTTP redirect.
 969                                 // This can be hard to reverse and may produce loops,
 970                                 // so they may be disabled in the site configuration.
 971                                 $source = $this->mTitle->getFullURL( 'redirect=no' );
 972                                 return $rt->getFullURL( array( 'rdfrom' => $source ) );
 973                         } else {
 974                                 // External pages without "local" bit set are not valid
 975                                 // redirect targets
 976                                 return false;
 977                         }
 978                 }
 979
 980                 if ( $rt->isSpecialPage() ) {
 981                         // Gotta handle redirects to special pages differently:
 982                         // Fill the HTTP response "Location" header and ignore the rest of the page we're on.
 983                         // Some pages are not valid targets.
 984                         if ( $rt->isValidRedirectTarget() ) {
 985                                 return $rt->getFullURL();
 986                         } else {
 987                                 return false;
 988                         }
 989                 }
 990
 991                 return $rt;
 992         }
 993
 994         /**
 995          * Get a list of users who have edited this article, not including the user who made
 996          * the most recent revision, which you can get from $article->getUser() if you want it
 997          * @return UserArrayFromResult
 998          */
 999         public function getContributors() {
1000                 // @todo FIXME: This is expensive; cache this info somewhere.
1001
1002                 $dbr = wfGetDB( DB_SLAVE );
1003
1004                 if ( $dbr->implicitGroupby() ) {
1005                         $realNameField = 'user_real_name';
1006                 } else {
1007                         $realNameField = 'MIN(user_real_name) AS user_real_name';
1008                 }
1009
1010                 $tables = array( 'revision', 'user' );
1011
1012                 $fields = array(
1013                         'user_id' => 'rev_user',
1014                         'user_name' => 'rev_user_text',
1015                         $realNameField,
1016                         'timestamp' => 'MAX(rev_timestamp)',
1017                 );
1018
1019                 $conds = array( 'rev_page' => $this->getId() );
1020
1021                 // The user who made the top revision gets credited as "this page was last edited by
1022                 // John, based on contributions by Tom, Dick and Harry", so don't include them twice.
1023                 $user = $this->getUser();
1024                 if ( $user ) {
1025                         $conds[] = "rev_user != $user";
1026                 } else {
1027                         $conds[] = "rev_user_text != {$dbr->addQuotes( $this->getUserText() )}";
1028                 }
1029
1030                 // Username hidden?
1031                 $conds[] = "{$dbr->bitAnd( 'rev_deleted', Revision::DELETED_USER )} = 0";
1032
1033                 $jconds = array(
1034                         'user' => array( 'LEFT JOIN', 'rev_user = user_id' ),
1035                 );
1036
1037                 $options = array(
1038                         'GROUP BY' => array( 'rev_user', 'rev_user_text' ),
1039                         'ORDER BY' => 'timestamp DESC',
1040                 );
1041
1042                 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $jconds );
1043                 return new UserArrayFromResult( $res );
1044         }
1045
1046         /**
1047          * Should the parser cache be used?
1048          *
1049          * @param ParserOptions $parserOptions ParserOptions to check
1050          * @param int $oldId
1051          * @return bool
1052          */
1053         public function shouldCheckParserCache( ParserOptions $parserOptions, $oldId ) {
1054                 return $parserOptions->getStubThreshold() == 0
1055                         && $this->exists()
1056                         && ( $oldId === null || $oldId === 0 || $oldId === $this->getLatest() )
1057                         && $this->getContentHandler()->isParserCacheSupported();
1058         }
1059
1060         /**
1061          * Get a ParserOutput for the given ParserOptions and revision ID.
1062          *
1063          * The parser cache will be used if possible. Cache misses that result
1064          * in parser runs are debounced with PoolCounter.
1065          *
1066          * @since 1.19
1067          * @param ParserOptions $parserOptions ParserOptions to use for the parse operation
1068          * @param null|int $oldid Revision ID to get the text from, passing null or 0 will
1069          *   get the current revision (default value)
1070          *
1071          * @return ParserOutput|bool ParserOutput or false if the revision was not found
1072          */
1073         public function getParserOutput( ParserOptions $parserOptions, $oldid = null ) {
1074
1075                 $useParserCache = $this->shouldCheckParserCache( $parserOptions, $oldid );
1076                 wfDebug( __METHOD__ .
1077                         ': using parser cache: ' . ( $useParserCache ? 'yes' : 'no' ) . "\n" );
1078                 if ( $parserOptions->getStubThreshold() ) {
1079                         wfIncrStats( 'pcache.miss.stub' );
1080                 }
1081
1082                 if ( $useParserCache ) {
1083                         $parserOutput = ParserCache::singleton()->get( $this, $parserOptions );
1084                         if ( $parserOutput !== false ) {
1085                                 return $parserOutput;
1086                         }
1087                 }
1088
1089                 if ( $oldid === null || $oldid === 0 ) {
1090                         $oldid = $this->getLatest();
1091                 }
1092
1093                 $pool = new PoolWorkArticleView( $this, $parserOptions, $oldid, $useParserCache );
1094                 $pool->execute();
1095
1096                 return $pool->getParserOutput();
1097         }
1098
1099         /**
1100          * Do standard deferred updates after page view (existing or missing page)
1101          * @param User $user The relevant user
1102          * @param int $oldid Revision id being viewed; if not given or 0, latest revision is assumed
1103          */
1104         public function doViewUpdates( User $user, $oldid = 0 ) {
1105                 if ( wfReadOnly() ) {
1106                         return;
1107                 }
1108
1109                 Hooks::run( 'PageViewUpdates', array( $this, $user ) );
1110                 // Update newtalk / watchlist notification status
1111                 try {
1112                         $user->clearNotification( $this->mTitle, $oldid );
1113                 } catch ( DBError $e ) {
1114                         // Avoid outage if the master is not reachable
1115                         MWExceptionHandler::logException( $e );
1116                 }
1117         }
1118
1119         /**
1120          * Perform the actions of a page purging
1121          * @return bool
1122          */
1123         public function doPurge() {
1124                 if ( !Hooks::run( 'ArticlePurge', array( &$this ) ) ) {
1125                         return false;
1126                 }
1127
1128                 $title = $this->mTitle;
1129                 wfGetDB( DB_MASTER )->onTransactionIdle( function() use ( $title ) {
1130                         // Invalidate the cache in auto-commit mode
1131                         $title->invalidateCache();
1132                 } );
1133
1134                 // Send purge after above page_touched update was committed
1135                 DeferredUpdates::addUpdate(
1136                         new SquidUpdate( $title->getSquidURLs() ),
1137                         DeferredUpdates::PRESEND
1138                 );
1139
1140                 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
1141                         // @todo move this logic to MessageCache
1142                         if ( $this->exists() ) {
1143                                 // NOTE: use transclusion text for messages.
1144                                 //       This is consistent with  MessageCache::getMsgFromNamespace()
1145
1146                                 $content = $this->getContent();
1147                                 $text = $content === null ? null : $content->getWikitextForTransclusion();
1148
1149                                 if ( $text === null ) {
1150                                         $text = false;
1151                                 }
1152                         } else {
1153                                 $text = false;
1154                         }
1155
1156                         MessageCache::singleton()->replace( $this->mTitle->getDBkey(), $text );
1157                 }
1158
1159                 return true;
1160         }
1161         /**
1162          * Insert a new empty page record for this article.
1163          * This *must* be followed up by creating a revision
1164          * and running $this->updateRevisionOn( ... );
1165          * or else the record will be left in a funky state.
1166          * Best if all done inside a transaction.
1167          *
1168          * @param IDatabase $dbw
1169          * @return int|bool The newly created page_id key; false if the title already existed
1170          */
1171         public function insertOn( $dbw ) {
1172                 $dbw->insert(
1173                         'page',
1174                         array(
1175                                 'page_id'           => $dbw->nextSequenceValue( 'page_page_id_seq' ),
1176                                 'page_namespace'    => $this->mTitle->getNamespace(),
1177                                 'page_title'        => $this->mTitle->getDBkey(),
1178                                 'page_restrictions' => '',
1179                                 'page_is_redirect'  => 0, // Will set this shortly...
1180                                 'page_is_new'       => 1,
1181                                 'page_random'       => wfRandom(),
1182                                 'page_touched'      => $dbw->timestamp(),
1183                                 'page_latest'       => 0, // Fill this in shortly...
1184                                 'page_len'          => 0, // Fill this in shortly...
1185                         ),
1186                         __METHOD__,
1187                         'IGNORE'
1188                 );
1189
1190                 if ( $dbw->affectedRows() > 0 ) {
1191                         $newid = $dbw->insertId();
1192                         $this->mId = $newid;
1193                         $this->mTitle->resetArticleID( $newid );
1194
1195                         return $newid;
1196                 } else {
1197                         return false; // nothing changed
1198                 }
1199         }
1200
1201         /**
1202          * Update the page record to point to a newly saved revision.
1203          *
1204          * @param IDatabase $dbw
1205          * @param Revision $revision For ID number, and text used to set
1206          *   length and redirect status fields
1207          * @param int $lastRevision If given, will not overwrite the page field
1208          *   when different from the currently set value.
1209          *   Giving 0 indicates the new page flag should be set on.
1210          * @param bool $lastRevIsRedirect If given, will optimize adding and
1211          *   removing rows in redirect table.
1212          * @return bool Success; false if the page row was missing or page_latest changed
1213          */
1214         public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
1215                 $lastRevIsRedirect = null
1216         ) {
1217                 global $wgContentHandlerUseDB;
1218
1219                 // Assertion to try to catch T92046
1220                 if ( (int)$revision->getId() === 0 ) {
1221                         throw new InvalidArgumentException(
1222                                 __METHOD__ . ': Revision has ID ' . var_export( $revision->getId(), 1 )
1223                         );
1224                 }
1225
1226                 $content = $revision->getContent();
1227                 $len = $content ? $content->getSize() : 0;
1228                 $rt = $content ? $content->getUltimateRedirectTarget() : null;
1229
1230                 $conditions = array( 'page_id' => $this->getId() );
1231
1232                 if ( !is_null( $lastRevision ) ) {
1233                         // An extra check against threads stepping on each other
1234                         $conditions['page_latest'] = $lastRevision;
1235                 }
1236
1237                 $row = array( /* SET */
1238                         'page_latest'      => $revision->getId(),
1239                         'page_touched'     => $dbw->timestamp( $revision->getTimestamp() ),
1240                         'page_is_new'      => ( $lastRevision === 0 ) ? 1 : 0,
1241                         'page_is_redirect' => $rt !== null ? 1 : 0,
1242                         'page_len'         => $len,
1243                 );
1244
1245                 if ( $wgContentHandlerUseDB ) {
1246                         $row['page_content_model'] = $revision->getContentModel();
1247                 }
1248
1249                 $dbw->update( 'page',
1250                         $row,
1251                         $conditions,
1252                         __METHOD__ );
1253
1254                 $result = $dbw->affectedRows() > 0;
1255                 if ( $result ) {
1256                         $this->updateRedirectOn( $dbw, $rt, $lastRevIsRedirect );
1257                         $this->setLastEdit( $revision );
1258                         $this->mLatest = $revision->getId();
1259                         $this->mIsRedirect = (bool)$rt;
1260                         // Update the LinkCache.
1261                         LinkCache::singleton()->addGoodLinkObj(
1262                                 $this->getId(),
1263                                 $this->mTitle,
1264                                 $len,
1265                                 $this->mIsRedirect,
1266                                 $this->mLatest,
1267                                 $revision->getContentModel()
1268                         );
1269                 }
1270
1271                 return $result;
1272         }
1273
1274         /**
1275          * Add row to the redirect table if this is a redirect, remove otherwise.
1276          *
1277          * @param IDatabase $dbw
1278          * @param Title $redirectTitle Title object pointing to the redirect target,
1279          *   or NULL if this is not a redirect
1280          * @param null|bool $lastRevIsRedirect If given, will optimize adding and
1281          *   removing rows in redirect table.
1282          * @return bool True on success, false on failure
1283          * @private
1284          */
1285         public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
1286                 // Always update redirects (target link might have changed)
1287                 // Update/Insert if we don't know if the last revision was a redirect or not
1288                 // Delete if changing from redirect to non-redirect
1289                 $isRedirect = !is_null( $redirectTitle );
1290
1291                 if ( !$isRedirect && $lastRevIsRedirect === false ) {
1292                         return true;
1293                 }
1294
1295                 if ( $isRedirect ) {
1296                         $this->insertRedirectEntry( $redirectTitle );
1297                 } else {
1298                         // This is not a redirect, remove row from redirect table
1299                         $where = array( 'rd_from' => $this->getId() );
1300                         $dbw->delete( 'redirect', $where, __METHOD__ );
1301                 }
1302
1303                 if ( $this->getTitle()->getNamespace() == NS_FILE ) {
1304                         RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $this->getTitle() );
1305                 }
1306
1307                 return ( $dbw->affectedRows() != 0 );
1308         }
1309
1310         /**
1311          * If the given revision is newer than the currently set page_latest,
1312          * update the page record. Otherwise, do nothing.
1313          *
1314          * @deprecated since 1.24, use updateRevisionOn instead
1315          *
1316          * @param IDatabase $dbw
1317          * @param Revision $revision
1318          * @return bool
1319          */
1320         public function updateIfNewerOn( $dbw, $revision ) {
1321
1322                 $row = $dbw->selectRow(
1323                         array( 'revision', 'page' ),
1324                         array( 'rev_id', 'rev_timestamp', 'page_is_redirect' ),
1325                         array(
1326                                 'page_id' => $this->getId(),
1327                                 'page_latest=rev_id' ),
1328                         __METHOD__ );
1329
1330                 if ( $row ) {
1331                         if ( wfTimestamp( TS_MW, $row->rev_timestamp ) >= $revision->getTimestamp() ) {
1332                                 return false;
1333                         }
1334                         $prev = $row->rev_id;
1335                         $lastRevIsRedirect = (bool)$row->page_is_redirect;
1336                 } else {
1337                         // No or missing previous revision; mark the page as new
1338                         $prev = 0;
1339                         $lastRevIsRedirect = null;
1340                 }
1341
1342                 $ret = $this->updateRevisionOn( $dbw, $revision, $prev, $lastRevIsRedirect );
1343
1344                 return $ret;
1345         }
1346
1347         /**
1348          * Get the content that needs to be saved in order to undo all revisions
1349          * between $undo and $undoafter. Revisions must belong to the same page,
1350          * must exist and must not be deleted
1351          * @param Revision $undo
1352          * @param Revision $undoafter Must be an earlier revision than $undo
1353          * @return Content|bool Content on success, false on failure
1354          * @since 1.21
1355          * Before we had the Content object, this was done in getUndoText
1356          */
1357         public function getUndoContent( Revision $undo, Revision $undoafter = null ) {
1358                 $handler = $undo->getContentHandler();
1359                 return $handler->getUndoContent( $this->getRevision(), $undo, $undoafter );
1360         }
1361
1362         /**
1363          * Get the text that needs to be saved in order to undo all revisions
1364          * between $undo and $undoafter. Revisions must belong to the same page,
1365          * must exist and must not be deleted
1366          * @param Revision $undo
1367          * @param Revision $undoafter Must be an earlier revision than $undo
1368          * @return string|bool String on success, false on failure
1369          * @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
1370          */
1371         public function getUndoText( Revision $undo, Revision $undoafter = null ) {
1372                 ContentHandler::deprecated( __METHOD__, '1.21' );
1373
1374                 $this->loadLastEdit();
1375
1376                 if ( $this->mLastRevision ) {
1377                         if ( is_null( $undoafter ) ) {
1378                                 $undoafter = $undo->getPrevious();
1379                         }
1380
1381                         $handler = $this->getContentHandler();
1382                         $undone = $handler->getUndoContent( $this->mLastRevision, $undo, $undoafter );
1383
1384                         if ( !$undone ) {
1385                                 return false;
1386                         } else {
1387                                 return ContentHandler::getContentText( $undone );
1388                         }
1389                 }
1390
1391                 return false;
1392         }
1393
1394         /**
1395          * @param string|number|null|bool $sectionId Section identifier as a number or string
1396          * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1397          * or 'new' for a new section.
1398          * @param string $text New text of the section.
1399          * @param string $sectionTitle New section's subject, only if $section is "new".
1400          * @param string $edittime Revision timestamp or null to use the current revision.
1401          *
1402          * @throws MWException
1403          * @return string|null New complete article text, or null if error.
1404          *
1405          * @deprecated since 1.21, use replaceSectionAtRev() instead
1406          */
1407         public function replaceSection( $sectionId, $text, $sectionTitle = '',
1408                 $edittime = null
1409         ) {
1410                 ContentHandler::deprecated( __METHOD__, '1.21' );
1411
1412                 // NOTE: keep condition in sync with condition in replaceSectionContent!
1413                 if ( strval( $sectionId ) === '' ) {
1414                         // Whole-page edit; let the whole text through
1415                         return $text;
1416                 }
1417
1418                 if ( !$this->supportsSections() ) {
1419                         throw new MWException( "sections not supported for content model " .
1420                                 $this->getContentHandler()->getModelID() );
1421                 }
1422
1423                 // could even make section title, but that's not required.
1424                 $sectionContent = ContentHandler::makeContent( $text, $this->getTitle() );
1425
1426                 $newContent = $this->replaceSectionContent( $sectionId, $sectionContent, $sectionTitle,
1427                         $edittime );
1428
1429                 return ContentHandler::getContentText( $newContent );
1430         }
1431
1432         /**
1433          * Returns true if this page's content model supports sections.
1434          *
1435          * @return bool
1436          *
1437          * @todo The skin should check this and not offer section functionality if
1438          *   sections are not supported.
1439          * @todo The EditPage should check this and not offer section functionality
1440          *   if sections are not supported.
1441          */
1442         public function supportsSections() {
1443                 return $this->getContentHandler()->supportsSections();
1444         }
1445
1446         /**
1447          * @param string|number|null|bool $sectionId Section identifier as a number or string
1448          * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1449          * or 'new' for a new section.
1450          * @param Content $sectionContent New content of the section.
1451          * @param string $sectionTitle New section's subject, only if $section is "new".
1452          * @param string $edittime Revision timestamp or null to use the current revision.
1453          *
1454          * @throws MWException
1455          * @return Content|null New complete article content, or null if error.
1456          *
1457          * @since 1.21
1458          * @deprecated since 1.24, use replaceSectionAtRev instead
1459          */
1460         public function replaceSectionContent(
1461                 $sectionId, Content $sectionContent, $sectionTitle = '', $edittime = null
1462         ) {
1463
1464                 $baseRevId = null;
1465                 if ( $edittime && $sectionId !== 'new' ) {
1466                         $dbr = wfGetDB( DB_SLAVE );
1467                         $rev = Revision::loadFromTimestamp( $dbr, $this->mTitle, $edittime );
1468                         // Try the master if this thread may have just added it.
1469                         // This could be abstracted into a Revision method, but we don't want
1470                         // to encourage loading of revisions by timestamp.
1471                         if ( !$rev
1472                                 && wfGetLB()->getServerCount() > 1
1473                                 && wfGetLB()->hasOrMadeRecentMasterChanges()
1474                         ) {
1475                                 $dbw = wfGetDB( DB_MASTER );
1476                                 $rev = Revision::loadFromTimestamp( $dbw, $this->mTitle, $edittime );
1477                         }
1478                         if ( $rev ) {
1479                                 $baseRevId = $rev->getId();
1480                         }
1481                 }
1482
1483                 return $this->replaceSectionAtRev( $sectionId, $sectionContent, $sectionTitle, $baseRevId );
1484         }
1485
1486         /**
1487          * @param string|number|null|bool $sectionId Section identifier as a number or string
1488          * (e.g. 0, 1 or 'T-1'), null/false or an empty string for the whole page
1489          * or 'new' for a new section.
1490          * @param Content $sectionContent New content of the section.
1491          * @param string $sectionTitle New section's subject, only if $section is "new".
1492          * @param int|null $baseRevId
1493          *
1494          * @throws MWException
1495          * @return Content|null New complete article content, or null if error.
1496          *
1497          * @since 1.24
1498          */
1499         public function replaceSectionAtRev( $sectionId, Content $sectionContent,
1500                 $sectionTitle = '', $baseRevId = null
1501         ) {
1502
1503                 if ( strval( $sectionId ) === '' ) {
1504                         // Whole-page edit; let the whole text through
1505                         $newContent = $sectionContent;
1506                 } else {
1507                         if ( !$this->supportsSections() ) {
1508                                 throw new MWException( "sections not supported for content model " .
1509                                         $this->getContentHandler()->getModelID() );
1510                         }
1511
1512                         // Bug 30711: always use current version when adding a new section
1513                         if ( is_null( $baseRevId ) || $sectionId === 'new' ) {
1514                                 $oldContent = $this->getContent();
1515                         } else {
1516                                 $rev = Revision::newFromId( $baseRevId );
1517                                 if ( !$rev ) {
1518                                         wfDebug( __METHOD__ . " asked for bogus section (page: " .
1519                                                 $this->getId() . "; section: $sectionId)\n" );
1520                                         return null;
1521                                 }
1522
1523                                 $oldContent = $rev->getContent();
1524                         }
1525
1526                         if ( !$oldContent ) {
1527                                 wfDebug( __METHOD__ . ": no page text\n" );
1528                                 return null;
1529                         }
1530
1531                         $newContent = $oldContent->replaceSection( $sectionId, $sectionContent, $sectionTitle );
1532                 }
1533
1534                 return $newContent;
1535         }
1536
1537         /**
1538          * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
1539          * @param int $flags
1540          * @return int Updated $flags
1541          */
1542         public function checkFlags( $flags ) {
1543                 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
1544                         if ( $this->exists() ) {
1545                                 $flags |= EDIT_UPDATE;
1546                         } else {
1547                                 $flags |= EDIT_NEW;
1548                         }
1549                 }
1550
1551                 return $flags;
1552         }
1553
1554         /**
1555          * Change an existing article or create a new article. Updates RC and all necessary caches,
1556          * optionally via the deferred update array.
1557          *
1558          * @param string $text New text
1559          * @param string $summary Edit summary
1560          * @param int $flags Bitfield:
1561          *      EDIT_NEW
1562          *          Article is known or assumed to be non-existent, create a new one
1563          *      EDIT_UPDATE
1564          *          Article is known or assumed to be pre-existing, update it
1565          *      EDIT_MINOR
1566          *          Mark this edit minor, if the user is allowed to do so
1567          *      EDIT_SUPPRESS_RC
1568          *          Do not log the change in recentchanges
1569          *      EDIT_FORCE_BOT
1570          *          Mark the edit a "bot" edit regardless of user rights
1571          *      EDIT_AUTOSUMMARY
1572          *          Fill in blank summaries with generated text where possible
1573          *
1574          * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1575          * article will be detected. If EDIT_UPDATE is specified and the article
1576          * doesn't exist, the function will return an edit-gone-missing error. If
1577          * EDIT_NEW is specified and the article does exist, an edit-already-exists
1578          * error will be returned. These two conditions are also possible with
1579          * auto-detection due to MediaWiki's performance-optimised locking strategy.
1580          *
1581          * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1582          *   This is not the parent revision ID, rather the revision ID for older
1583          *   content used as the source for a rollback, for example.
1584          * @param User $user The user doing the edit
1585          *
1586          * @throws MWException
1587          * @return Status Possible errors:
1588          *   edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1589          *     set the fatal flag of $status
1590          *   edit-gone-missing: In update mode, but the article didn't exist.
1591          *   edit-conflict: In update mode, the article changed unexpectedly.
1592          *   edit-no-change: Warning that the text was the same as before.
1593          *   edit-already-exists: In creation mode, but the article already exists.
1594          *
1595          * Extensions may define additional errors.
1596          *
1597          * $return->value will contain an associative array with members as follows:
1598          *     new: Boolean indicating if the function attempted to create a new article.
1599          *     revision: The revision object for the inserted revision, or null.
1600          *
1601          * Compatibility note: this function previously returned a boolean value
1602          * indicating success/failure
1603          *
1604          * @deprecated since 1.21: use doEditContent() instead.
1605          */
1606         public function doEdit( $text, $summary, $flags = 0, $baseRevId = false, $user = null ) {
1607                 ContentHandler::deprecated( __METHOD__, '1.21' );
1608
1609                 $content = ContentHandler::makeContent( $text, $this->getTitle() );
1610
1611                 return $this->doEditContent( $content, $summary, $flags, $baseRevId, $user );
1612         }
1613
1614         /**
1615          * Change an existing article or create a new article. Updates RC and all necessary caches,
1616          * optionally via the deferred update array.
1617          *
1618          * @param Content $content New content
1619          * @param string $summary Edit summary
1620          * @param int $flags Bitfield:
1621          *      EDIT_NEW
1622          *          Article is known or assumed to be non-existent, create a new one
1623          *      EDIT_UPDATE
1624          *          Article is known or assumed to be pre-existing, update it
1625          *      EDIT_MINOR
1626          *          Mark this edit minor, if the user is allowed to do so
1627          *      EDIT_SUPPRESS_RC
1628          *          Do not log the change in recentchanges
1629          *      EDIT_FORCE_BOT
1630          *          Mark the edit a "bot" edit regardless of user rights
1631          *      EDIT_AUTOSUMMARY
1632          *          Fill in blank summaries with generated text where possible
1633          *
1634          * If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the
1635          * article will be detected. If EDIT_UPDATE is specified and the article
1636          * doesn't exist, the function will return an edit-gone-missing error. If
1637          * EDIT_NEW is specified and the article does exist, an edit-already-exists
1638          * error will be returned. These two conditions are also possible with
1639          * auto-detection due to MediaWiki's performance-optimised locking strategy.
1640          *
1641          * @param bool|int $baseRevId The revision ID this edit was based off, if any.
1642          *   This is not the parent revision ID, rather the revision ID for older
1643          *   content used as the source for a rollback, for example.
1644          * @param User $user The user doing the edit
1645          * @param string $serialFormat Format for storing the content in the
1646          *   database.
1647          *
1648          * @throws MWException
1649          * @return Status Possible errors:
1650          *     edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
1651          *       set the fatal flag of $status.
1652          *     edit-gone-missing: In update mode, but the article didn't exist.
1653          *     edit-conflict: In update mode, the article changed unexpectedly.
1654          *     edit-no-change: Warning that the text was the same as before.
1655          *     edit-already-exists: In creation mode, but the article already exists.
1656          *
1657          *  Extensions may define additional errors.
1658          *
1659          *  $return->value will contain an associative array with members as follows:
1660          *     new: Boolean indicating if the function attempted to create a new article.
1661          *     revision: The revision object for the inserted revision, or null.
1662          *
1663          * @since 1.21
1664          * @throws MWException
1665          */
1666         public function doEditContent( Content $content, $summary, $flags = 0, $baseRevId = false,
1667                 User $user = null, $serialFormat = null
1668         ) {
1669                 global $wgUser, $wgUseAutomaticEditSummaries, $wgUseRCPatrol, $wgUseNPPatrol;
1670
1671                 // Low-level sanity check
1672                 if ( $this->mTitle->getText() === '' ) {
1673                         throw new MWException( 'Something is trying to edit an article with an empty title' );
1674                 }
1675
1676                 if ( !$content->getContentHandler()->canBeUsedOn( $this->getTitle() ) ) {
1677                         return Status::newFatal( 'content-not-allowed-here',
1678                                 ContentHandler::getLocalizedName( $content->getModel() ),
1679                                 $this->getTitle()->getPrefixedText() );
1680                 }
1681
1682                 $user = is_null( $user ) ? $wgUser : $user;
1683                 $status = Status::newGood( array() );
1684
1685                 // Load the data from the master database if needed.
1686                 // The caller may already loaded it from the master or even loaded it using
1687                 // SELECT FOR UPDATE, so do not override that using clear().
1688                 $this->loadPageData( 'fromdbmaster' );
1689
1690                 $flags = $this->checkFlags( $flags );
1691
1692                 // handle hook
1693                 $hook_args = array( &$this, &$user, &$content, &$summary,
1694                                                         $flags & EDIT_MINOR, null, null, &$flags, &$status );
1695
1696                 if ( !Hooks::run( 'PageContentSave', $hook_args )
1697                         || !ContentHandler::runLegacyHooks( 'ArticleSave', $hook_args ) ) {
1698
1699                         wfDebug( __METHOD__ . ": ArticleSave or ArticleSaveContent hook aborted save!\n" );
1700
1701                         if ( $status->isOK() ) {
1702                                 $status->fatal( 'edit-hook-aborted' );
1703                         }
1704
1705                         return $status;
1706                 }
1707
1708                 // Silently ignore EDIT_MINOR if not allowed
1709                 $isminor = ( $flags & EDIT_MINOR ) && $user->isAllowed( 'minoredit' );
1710                 $bot = $flags & EDIT_FORCE_BOT;
1711
1712                 $old_revision = $this->getRevision(); // current revision
1713                 $old_content = $this->getContent( Revision::RAW ); // current revision's content
1714
1715                 $oldsize = $old_content ? $old_content->getSize() : 0;
1716                 $oldid = $this->getLatest();
1717                 $oldIsRedirect = $this->isRedirect();
1718                 $oldcountable = $this->isCountable();
1719
1720                 $handler = $content->getContentHandler();
1721
1722                 // Provide autosummaries if one is not provided and autosummaries are enabled.
1723                 if ( $wgUseAutomaticEditSummaries && $flags & EDIT_AUTOSUMMARY && $summary == '' ) {
1724                         if ( !$old_content ) {
1725                                 $old_content = null;
1726                         }
1727                         $summary = $handler->getAutosummary( $old_content, $content, $flags );
1728                 }
1729
1730                 $editInfo = $this->prepareContentForEdit( $content, null, $user, $serialFormat );
1731                 $serialized = $editInfo->pst;
1732
1733                 /**
1734                  * @var Content $content
1735                  */
1736                 $content = $editInfo->pstContent;
1737                 $newsize = $content->getSize();
1738
1739                 $dbw = wfGetDB( DB_MASTER );
1740                 $now = wfTimestampNow();
1741
1742                 if ( $flags & EDIT_UPDATE ) {
1743                         // Update article, but only if changed.
1744                         $status->value['new'] = false;
1745
1746                         if ( !$oldid ) {
1747                                 // Article gone missing
1748                                 wfDebug( __METHOD__ . ": EDIT_UPDATE specified but article doesn't exist\n" );
1749                                 $status->fatal( 'edit-gone-missing' );
1750
1751                                 return $status;
1752                         } elseif ( !$old_content ) {
1753                                 // Sanity check for bug 37225
1754                                 throw new MWException( "Could not find text for current revision {$oldid}." );
1755                         }
1756
1757                         $revision = new Revision( array(
1758                                 'page'       => $this->getId(),
1759                                 'title'      => $this->getTitle(), // for determining the default content model
1760                                 'comment'    => $summary,
1761                                 'minor_edit' => $isminor,
1762                                 'text'       => $serialized,
1763                                 'len'        => $newsize,
1764                                 'parent_id'  => $oldid,
1765                                 'user'       => $user->getId(),
1766                                 'user_text'  => $user->getName(),
1767                                 'timestamp'  => $now,
1768                                 'content_model' => $content->getModel(),
1769                                 'content_format' => $serialFormat,
1770                         ) ); // XXX: pass content object?!
1771
1772                         $changed = !$content->equals( $old_content );
1773
1774                         if ( $changed ) {
1775                                 $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1776                                 $status->merge( $prepStatus );
1777
1778                                 if ( !$status->isOK() ) {
1779                                         return $status;
1780                                 }
1781
1782                                 $dbw->begin( __METHOD__ );
1783                                 // Get the latest page_latest value while locking it.
1784                                 // Do a CAS style check to see if it's the same as when this method
1785                                 // started. If it changed then bail out before touching the DB.
1786                                 $latestNow = $this->lockAndGetLatest();
1787                                 if ( $latestNow != $oldid ) {
1788                                         $dbw->commit( __METHOD__ );
1789                                         // Page updated or deleted in the mean time
1790                                         $status->fatal( 'edit-conflict' );
1791
1792                                         return $status;
1793                                 }
1794
1795                                 // At this point we are now comitted to returning an OK
1796                                 // status unless some DB query error or other exception comes up.
1797                                 // This way callers don't have to call rollback() if $status is bad
1798                                 // unless they actually try to catch exceptions (which is rare).
1799
1800                                 $revisionId = $revision->insertOn( $dbw );
1801
1802                                 // Update page_latest and friends to reflect the new revision
1803                                 if ( !$this->updateRevisionOn( $dbw, $revision, null, $oldIsRedirect ) ) {
1804                                         $dbw->rollback( __METHOD__ );
1805                                         throw new MWException( "Failed to update page row to use new revision." );
1806                                 }
1807
1808                                 Hooks::run( 'NewRevisionFromEditComplete',
1809                                         array( $this, $revision, $baseRevId, $user ) );
1810
1811                                 // Update recentchanges
1812                                 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1813                                         // Mark as patrolled if the user can do so
1814                                         $patrolled = $wgUseRCPatrol && !count(
1815                                                 $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1816                                         // Add RC row to the DB
1817                                         RecentChange::notifyEdit(
1818                                                 $now, $this->mTitle, $isminor, $user, $summary,
1819                                                 $oldid, $this->getTimestamp(), $bot, '', $oldsize, $newsize,
1820                                                 $revisionId, $patrolled
1821                                         );
1822                                 }
1823
1824                                 $user->incEditCount();
1825
1826                                 $dbw->commit( __METHOD__ );
1827                                 $this->mTimestamp = $now;
1828                         } else {
1829                                 // Bug 32948: revision ID must be set to page {{REVISIONID}} and
1830                                 // related variables correctly
1831                                 $revision->setId( $this->getLatest() );
1832                         }
1833
1834                         // Update links tables, site stats, etc.
1835                         $this->doEditUpdates(
1836                                 $revision,
1837                                 $user,
1838                                 array(
1839                                         'changed' => $changed,
1840                                         'oldcountable' => $oldcountable,
1841                                         'oldrevision' => $old_revision
1842                                 )
1843                         );
1844
1845                         if ( !$changed ) {
1846                                 $status->warning( 'edit-no-change' );
1847                                 $revision = null;
1848                                 // Update page_touched, this is usually implicit in the page update
1849                                 // Other cache updates are done in onArticleEdit()
1850                                 $this->mTitle->invalidateCache( $now );
1851                         }
1852                 } else {
1853                         // Create new article
1854                         $status->value['new'] = true;
1855
1856                         $prepStatus = $content->prepareSave( $this, $flags, $oldid, $user );
1857                         $status->merge( $prepStatus );
1858                         if ( !$status->isOK() ) {
1859                                 return $status;
1860                         }
1861
1862                         $dbw->begin( __METHOD__ );
1863
1864                         // Add the page record unless one already exists for the title
1865                         $newid = $this->insertOn( $dbw );
1866                         if ( $newid === false ) {
1867                                 $dbw->commit( __METHOD__ ); // nothing inserted
1868                                 $status->fatal( 'edit-already-exists' );
1869
1870                                 return $status; // nothing done
1871                         }
1872
1873                         // At this point we are now comitted to returning an OK
1874                         // status unless some DB query error or other exception comes up.
1875                         // This way callers don't have to call rollback() if $status is bad
1876                         // unless they actually try to catch exceptions (which is rare).
1877
1878                         // Save the revision text...
1879                         $revision = new Revision( array(
1880                                 'page'       => $newid,
1881                                 'title'      => $this->getTitle(), // for determining the default content model
1882                                 'comment'    => $summary,
1883                                 'minor_edit' => $isminor,
1884                                 'text'       => $serialized,
1885                                 'len'        => $newsize,
1886                                 'user'       => $user->getId(),
1887                                 'user_text'  => $user->getName(),
1888                                 'timestamp'  => $now,
1889                                 'content_model' => $content->getModel(),
1890                                 'content_format' => $serialFormat,
1891                         ) );
1892                         $revisionId = $revision->insertOn( $dbw );
1893
1894                         // Bug 37225: use accessor to get the text as Revision may trim it
1895                         $content = $revision->getContent(); // sanity; get normalized version
1896
1897                         if ( $content ) {
1898                                 $newsize = $content->getSize();
1899                         }
1900
1901                         // Update the page record with revision data
1902                         if ( !$this->updateRevisionOn( $dbw, $revision, 0 ) ) {
1903                                 $dbw->rollback( __METHOD__ );
1904                                 throw new MWException( "Failed to update page row to use new revision." );
1905                         }
1906
1907                         Hooks::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
1908
1909                         // Update recentchanges
1910                         if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1911                                 // Mark as patrolled if the user can do so
1912                                 $patrolled = ( $wgUseRCPatrol || $wgUseNPPatrol ) && !count(
1913                                         $this->mTitle->getUserPermissionsErrors( 'autopatrol', $user ) );
1914                                 // Add RC row to the DB
1915                                 RecentChange::notifyNew(
1916                                         $now, $this->mTitle, $isminor, $user, $summary, $bot,
1917                                         '', $newsize, $revisionId, $patrolled
1918                                 );
1919                         }
1920
1921                         $user->incEditCount();
1922
1923                         $dbw->commit( __METHOD__ );
1924                         $this->mTimestamp = $now;
1925
1926                         // Update links, etc.
1927                         $this->doEditUpdates(
1928                                 $revision,
1929                                 $user,
1930                                 array( 'created' => true, 'oldrevision' => $old_revision )
1931                         );
1932
1933                         $hook_args = array( &$this, &$user, $content, $summary,
1934                                                                 $flags & EDIT_MINOR, null, null, &$flags, $revision );
1935
1936                         ContentHandler::runLegacyHooks( 'ArticleInsertComplete', $hook_args );
1937                         Hooks::run( 'PageContentInsertComplete', $hook_args );
1938                 }
1939
1940                 // Return the new revision (or null) to the caller
1941                 $status->value['revision'] = $revision;
1942
1943                 $hook_args = array( &$this, &$user, $content, $summary,
1944                         $flags & EDIT_MINOR, null, null, &$flags, $revision, &$status, $baseRevId );
1945
1946                 ContentHandler::runLegacyHooks( 'ArticleSaveComplete', $hook_args );
1947                 Hooks::run( 'PageContentSaveComplete', $hook_args );
1948
1949                 // Promote user to any groups they meet the criteria for
1950                 DeferredUpdates::addCallableUpdate( function () use ( $user ) {
1951                         $user->addAutopromoteOnceGroups( 'onEdit' );
1952                         $user->addAutopromoteOnceGroups( 'onView' ); // b/c
1953                 } );
1954
1955                 return $status;
1956         }
1957
1958         /**
1959          * Get parser options suitable for rendering the primary article wikitext
1960          *
1961          * @see ContentHandler::makeParserOptions
1962          *
1963          * @param IContextSource|User|string $context One of the following:
1964          *        - IContextSource: Use the User and the Language of the provided
1965          *          context
1966          *        - User: Use the provided User object and $wgLang for the language,
1967          *          so use an IContextSource object if possible.
1968          *        - 'canonical': Canonical options (anonymous user with default
1969          *          preferences and content language).
1970          * @return ParserOptions
1971          */
1972         public function makeParserOptions( $context ) {
1973                 $options = $this->getContentHandler()->makeParserOptions( $context );
1974
1975                 if ( $this->getTitle()->isConversionTable() ) {
1976                         // @todo ConversionTable should become a separate content model, so
1977                         // we don't need special cases like this one.
1978                         $options->disableContentConversion();
1979                 }
1980
1981                 return $options;
1982         }
1983
1984         /**
1985          * Prepare text which is about to be saved.
1986          * Returns a stdClass with source, pst and output members
1987          *
1988          * @param string $text
1989          * @param int|null $revid
1990          * @param User|null $user
1991          * @deprecated since 1.21: use prepareContentForEdit instead.
1992          * @return object
1993          */
1994         public function prepareTextForEdit( $text, $revid = null, User $user = null ) {
1995                 ContentHandler::deprecated( __METHOD__, '1.21' );
1996                 $content = ContentHandler::makeContent( $text, $this->getTitle() );
1997                 return $this->prepareContentForEdit( $content, $revid, $user );
1998         }
1999
2000         /**
2001          * Prepare content which is about to be saved.
2002          * Returns a stdClass with source, pst and output members
2003          *
2004          * @param Content $content
2005          * @param Revision|int|null $revision Revision object. For backwards compatibility, a
2006          *        revision ID is also accepted, but this is deprecated.
2007          * @param User|null $user
2008          * @param string|null $serialFormat
2009          * @param bool $useCache Check shared prepared edit cache
2010          *
2011          * @return object
2012          *
2013          * @since 1.21
2014          */
2015         public function prepareContentForEdit(
2016                 Content $content, $revision = null, User $user = null,
2017                 $serialFormat = null, $useCache = true
2018         ) {
2019                 global $wgContLang, $wgUser, $wgAjaxEditStash;
2020
2021                 if ( is_object( $revision ) ) {
2022                         $revid = $revision->getId();
2023                 } else {
2024                         $revid = $revision;
2025                         // This code path is deprecated, and nothing is known to
2026                         // use it, so performance here shouldn't be a worry.
2027                         if ( $revid !== null ) {
2028                                 $revision = Revision::newFromId( $revid, Revision::READ_LATEST );
2029                         } else {
2030                                 $revision = null;
2031                         }
2032                 }
2033
2034                 $user = is_null( $user ) ? $wgUser : $user;
2035                 // XXX: check $user->getId() here???
2036
2037                 // Use a sane default for $serialFormat, see bug 57026
2038                 if ( $serialFormat === null ) {
2039                         $serialFormat = $content->getContentHandler()->getDefaultFormat();
2040                 }
2041
2042                 if ( $this->mPreparedEdit
2043                         && $this->mPreparedEdit->newContent
2044                         && $this->mPreparedEdit->newContent->equals( $content )
2045                         && $this->mPreparedEdit->revid == $revid
2046                         && $this->mPreparedEdit->format == $serialFormat
2047                         // XXX: also check $user here?
2048                 ) {
2049                         // Already prepared
2050                         return $this->mPreparedEdit;
2051                 }
2052
2053                 // The edit may have already been prepared via api.php?action=stashedit
2054                 $cachedEdit = $useCache && $wgAjaxEditStash
2055                         ? ApiStashEdit::checkCache( $this->getTitle(), $content, $user )
2056                         : false;
2057
2058                 $popts = ParserOptions::newFromUserAndLang( $user, $wgContLang );
2059                 Hooks::run( 'ArticlePrepareTextForEdit', array( $this, $popts ) );
2060
2061                 $edit = (object)array();
2062                 if ( $cachedEdit ) {
2063                         $edit->timestamp = $cachedEdit->timestamp;
2064                 } else {
2065                         $edit->timestamp = wfTimestampNow();
2066                 }
2067                 // @note: $cachedEdit is not used if the rev ID was referenced in the text
2068                 $edit->revid = $revid;
2069
2070                 if ( $cachedEdit ) {
2071                         $edit->pstContent = $cachedEdit->pstContent;
2072                 } else {
2073                         $edit->pstContent = $content
2074                                 ? $content->preSaveTransform( $this->mTitle, $user, $popts )
2075                                 : null;
2076                 }
2077
2078                 $edit->format = $serialFormat;
2079                 $edit->popts = $this->makeParserOptions( 'canonical' );
2080                 if ( $cachedEdit ) {
2081                         $edit->output = $cachedEdit->output;
2082                 } else {
2083                         if ( $revision ) {
2084                                 // We get here if vary-revision is set. This means that this page references
2085                                 // itself (such as via self-transclusion). In this case, we need to make sure
2086                                 // that any such self-references refer to the newly-saved revision, and not
2087                                 // to the previous one, which could otherwise happen due to slave lag.
2088                                 $oldCallback = $edit->popts->getCurrentRevisionCallback();
2089                                 $edit->popts->setCurrentRevisionCallback(
2090                                         function ( Title $title, $parser = false ) use ( $revision, &$oldCallback ) {
2091                                                 if ( $title->equals( $revision->getTitle() ) ) {
2092                                                         return $revision;
2093                                                 } else {
2094                                                         return call_user_func( $oldCallback, $title, $parser );
2095                                                 }
2096                                         }
2097                                 );
2098                         }
2099                         $edit->output = $edit->pstContent
2100                                 ? $edit->pstContent->getParserOutput( $this->mTitle, $revid, $edit->popts )
2101                                 : null;
2102                 }
2103
2104                 $edit->newContent = $content;
2105                 $edit->oldContent = $this->getContent( Revision::RAW );
2106
2107                 // NOTE: B/C for hooks! don't use these fields!
2108                 $edit->newText = $edit->newContent
2109                         ? ContentHandler::getContentText( $edit->newContent )
2110                         : '';
2111                 $edit->oldText = $edit->oldContent
2112                         ? ContentHandler::getContentText( $edit->oldContent )
2113                         : '';
2114                 $edit->pst = $edit->pstContent ? $edit->pstContent->serialize( $serialFormat ) : '';
2115
2116                 $this->mPreparedEdit = $edit;
2117                 return $edit;
2118         }
2119
2120         /**
2121          * Do standard deferred updates after page edit.
2122          * Update links tables, site stats, search index and message cache.
2123          * Purges pages that include this page if the text was changed here.
2124          * Every 100th edit, prune the recent changes table.
2125          *
2126          * @param Revision $revision
2127          * @param User $user User object that did the revision
2128          * @param array $options Array of options, following indexes are used:
2129          * - changed: boolean, whether the revision changed the content (default true)
2130          * - created: boolean, whether the revision created the page (default false)
2131          * - moved: boolean, whether the page was moved (default false)
2132          * - restored: boolean, whether the page was undeleted (default false)
2133          * - oldrevision: Revision object for the pre-update revision (default null)
2134          * - oldcountable: boolean, null, or string 'no-change' (default null):
2135          *   - boolean: whether the page was counted as an article before that
2136          *     revision, only used in changed is true and created is false
2137          *   - null: if created is false, don't update the article count; if created
2138          *     is true, do update the article count
2139          *   - 'no-change': don't update the article count, ever
2140          */
2141         public function doEditUpdates( Revision $revision, User $user, array $options = array() ) {
2142                 global $wgRCWatchCategoryMembership;
2143
2144                 $options += array(
2145                         'changed' => true,
2146                         'created' => false,
2147                         'moved' => false,
2148                         'restored' => false,
2149                         'oldrevision' => null,
2150                         'oldcountable' => null
2151                 );
2152                 $content = $revision->getContent();
2153
2154                 // Parse the text
2155                 // Be careful not to do pre-save transform twice: $text is usually
2156                 // already pre-save transformed once.
2157                 if ( !$this->mPreparedEdit || $this->mPreparedEdit->output->getFlag( 'vary-revision' ) ) {
2158                         wfDebug( __METHOD__ . ": No prepared edit or vary-revision is set...\n" );
2159                         $editInfo = $this->prepareContentForEdit( $content, $revision, $user );
2160                 } else {
2161                         wfDebug( __METHOD__ . ": No vary-revision, using prepared edit...\n" );
2162                         $editInfo = $this->mPreparedEdit;
2163                 }
2164
2165                 // Save it to the parser cache.
2166                 // Make sure the cache time matches page_touched to avoid double parsing.
2167                 ParserCache::singleton()->save(
2168                         $editInfo->output, $this, $editInfo->popts,
2169                         $revision->getTimestamp(), $editInfo->revid
2170                 );
2171
2172                 // Update the links tables and other secondary data
2173                 if ( $content ) {
2174                         $recursive = $options['changed']; // bug 50785
2175                         $updates = $content->getSecondaryDataUpdates(
2176                                 $this->getTitle(), null, $recursive, $editInfo->output
2177                         );
2178                         foreach ( $updates as $update ) {
2179                                 if ( $update instanceof LinksUpdate ) {
2180                                         $update->setRevision( $revision );
2181                                         $update->setTriggeringUser( $user );
2182                                 }
2183                                 DeferredUpdates::addUpdate( $update );
2184                         }
2185                         if ( $wgRCWatchCategoryMembership
2186                                 && ( $options['changed'] || $options['created'] )
2187                                 && !$options['restored']
2188                         ) {
2189                                 // Note: jobs are pushed after deferred updates, so the job should be able to see
2190                                 // the recent change entry (also done via deferred updates) and carry over any
2191                                 // bot/deletion/IP flags, ect.
2192                                 JobQueueGroup::singleton()->lazyPush( new CategoryMembershipChangeJob(
2193                                         $this->getTitle(),
2194                                         array(
2195                                                 'pageId' => $this->getId(),
2196                                                 'revTimestamp' => $revision->getTimestamp()
2197                                         )
2198                                 ) );
2199                         }
2200                 }
2201
2202                 Hooks::run( 'ArticleEditUpdates', array( &$this, &$editInfo, $options['changed'] ) );
2203
2204                 if ( Hooks::run( 'ArticleEditUpdatesDeleteFromRecentchanges', array( &$this ) ) ) {
2205                         // Flush old entries from the `recentchanges` table
2206                         if ( mt_rand( 0, 9 ) == 0 ) {
2207                                 JobQueueGroup::singleton()->lazyPush( RecentChangesUpdateJob::newPurgeJob() );
2208                         }
2209                 }
2210
2211                 if ( !$this->exists() ) {
2212                         return;
2213                 }
2214
2215                 $id = $this->getId();
2216                 $title = $this->mTitle->getPrefixedDBkey();
2217                 $shortTitle = $this->mTitle->getDBkey();
2218
2219                 if ( $options['oldcountable'] === 'no-change' ||
2220                         ( !$options['changed'] && !$options['moved'] )
2221                 ) {
2222                         $good = 0;
2223                 } elseif ( $options['created'] ) {
2224                         $good = (int)$this->isCountable( $editInfo );
2225                 } elseif ( $options['oldcountable'] !== null ) {
2226                         $good = (int)$this->isCountable( $editInfo ) - (int)$options['oldcountable'];
2227                 } else {
2228                         $good = 0;
2229                 }
2230                 $edits = $options['changed'] ? 1 : 0;
2231                 $total = $options['created'] ? 1 : 0;
2232
2233                 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, $edits, $good, $total ) );
2234                 DeferredUpdates::addUpdate( new SearchUpdate( $id, $title, $content ) );
2235
2236                 // If this is another user's talk page, update newtalk.
2237                 // Don't do this if $options['changed'] = false (null-edits) nor if
2238                 // it's a minor edit and the user doesn't want notifications for those.
2239                 if ( $options['changed']
2240                         && $this->mTitle->getNamespace() == NS_USER_TALK
2241                         && $shortTitle != $user->getTitleKey()
2242                         && !( $revision->isMinor() && $user->isAllowed( 'nominornewtalk' ) )
2243                 ) {
2244                         $recipient = User::newFromName( $shortTitle, false );
2245                         if ( !$recipient ) {
2246                                 wfDebug( __METHOD__ . ": invalid username\n" );
2247                         } else {
2248                                 // Allow extensions to prevent user notification
2249                                 // when a new message is added to their talk page
2250                                 if ( Hooks::run( 'ArticleEditUpdateNewTalk', array( &$this, $recipient ) ) ) {
2251                                         if ( User::isIP( $shortTitle ) ) {
2252                                                 // An anonymous user
2253                                                 $recipient->setNewtalk( true, $revision );
2254                                         } elseif ( $recipient->isLoggedIn() ) {
2255                                                 $recipient->setNewtalk( true, $revision );
2256                                         } else {
2257                                                 wfDebug( __METHOD__ . ": don't need to notify a nonexistent user\n" );
2258                                         }
2259                                 }
2260                         }
2261                 }
2262
2263                 if ( $this->mTitle->getNamespace() == NS_MEDIAWIKI ) {
2264                         // XXX: could skip pseudo-messages like js/css here, based on content model.
2265                         $msgtext = $content ? $content->getWikitextForTransclusion() : null;
2266                         if ( $msgtext === false || $msgtext === null ) {
2267                                 $msgtext = '';
2268                         }
2269
2270                         MessageCache::singleton()->replace( $shortTitle, $msgtext );
2271                 }
2272
2273                 if ( $options['created'] ) {
2274                         self::onArticleCreate( $this->mTitle );
2275                 } elseif ( $options['changed'] ) { // bug 50785
2276                         self::onArticleEdit( $this->mTitle, $revision );
2277                 }
2278         }
2279
2280         /**
2281          * Edit an article without doing all that other stuff
2282          * The article must already exist; link tables etc
2283          * are not updated, caches are not flushed.
2284          *
2285          * @param Content $content Content submitted
2286          * @param User $user The relevant user
2287          * @param string $comment Comment submitted
2288          * @param bool $minor Whereas it's a minor modification
2289          * @param string $serialFormat Format for storing the content in the database
2290          */
2291         public function doQuickEditContent(
2292                 Content $content, User $user, $comment = '', $minor = false, $serialFormat = null
2293         ) {
2294
2295                 $serialized = $content->serialize( $serialFormat );
2296
2297                 $dbw = wfGetDB( DB_MASTER );
2298                 $revision = new Revision( array(
2299                         'title'      => $this->getTitle(), // for determining the default content model
2300                         'page'       => $this->getId(),
2301                         'user_text'  => $user->getName(),
2302                         'user'       => $user->getId(),
2303                         'text'       => $serialized,
2304                         'length'     => $content->getSize(),
2305                         'comment'    => $comment,
2306                         'minor_edit' => $minor ? 1 : 0,
2307                 ) ); // XXX: set the content object?
2308                 $revision->insertOn( $dbw );
2309                 $this->updateRevisionOn( $dbw, $revision );
2310
2311                 Hooks::run( 'NewRevisionFromEditComplete', array( $this, $revision, false, $user ) );
2312
2313         }
2314
2315         /**
2316          * Update the article's restriction field, and leave a log entry.
2317          * This works for protection both existing and non-existing pages.
2318          *
2319          * @param array $limit Set of restriction keys
2320          * @param array $expiry Per restriction type expiration
2321          * @param int &$cascade Set to false if cascading protection isn't allowed.
2322          * @param string $reason
2323          * @param User $user The user updating the restrictions
2324          * @return Status
2325          */
2326         public function doUpdateRestrictions( array $limit, array $expiry,
2327                 &$cascade, $reason, User $user
2328         ) {
2329                 global $wgCascadingRestrictionLevels, $wgContLang;
2330
2331                 if ( wfReadOnly() ) {
2332                         return Status::newFatal( 'readonlytext', wfReadOnlyReason() );
2333                 }
2334
2335                 $this->loadPageData( 'fromdbmaster' );
2336                 $restrictionTypes = $this->mTitle->getRestrictionTypes();
2337                 $id = $this->getId();
2338
2339                 if ( !$cascade ) {
2340                         $cascade = false;
2341                 }
2342
2343                 // Take this opportunity to purge out expired restrictions
2344                 Title::purgeExpiredRestrictions();
2345
2346                 // @todo FIXME: Same limitations as described in ProtectionForm.php (line 37);
2347                 // we expect a single selection, but the schema allows otherwise.
2348                 $isProtected = false;
2349                 $protect = false;
2350                 $changed = false;
2351
2352                 $dbw = wfGetDB( DB_MASTER );
2353
2354                 foreach ( $restrictionTypes as $action ) {
2355                         if ( !isset( $expiry[$action] ) || $expiry[$action] === $dbw->getInfinity() ) {
2356                                 $expiry[$action] = 'infinity';
2357                         }
2358                         if ( !isset( $limit[$action] ) ) {
2359                                 $limit[$action] = '';
2360                         } elseif ( $limit[$action] != '' ) {
2361                                 $protect = true;
2362                         }
2363
2364                         // Get current restrictions on $action
2365                         $current = implode( '', $this->mTitle->getRestrictions( $action ) );
2366                         if ( $current != '' ) {
2367                                 $isProtected = true;
2368                         }
2369
2370                         if ( $limit[$action] != $current ) {
2371                                 $changed = true;
2372                         } elseif ( $limit[$action] != '' ) {
2373                                 // Only check expiry change if the action is actually being
2374                                 // protected, since expiry does nothing on an not-protected
2375                                 // action.
2376                                 if ( $this->mTitle->getRestrictionExpiry( $action ) != $expiry[$action] ) {
2377                                         $changed = true;
2378                                 }
2379                         }
2380                 }
2381
2382                 if ( !$changed && $protect && $this->mTitle->areRestrictionsCascading() != $cascade ) {
2383                         $changed = true;
2384                 }
2385
2386                 // If nothing has changed, do nothing
2387                 if ( !$changed ) {
2388                         return Status::newGood();
2389                 }
2390
2391                 if ( !$protect ) { // No protection at all means unprotection
2392                         $revCommentMsg = 'unprotectedarticle';
2393                         $logAction = 'unprotect';
2394                 } elseif ( $isProtected ) {
2395                         $revCommentMsg = 'modifiedarticleprotection';
2396                         $logAction = 'modify';
2397                 } else {
2398                         $revCommentMsg = 'protectedarticle';
2399                         $logAction = 'protect';
2400                 }
2401
2402                 // Truncate for whole multibyte characters
2403                 $reason = $wgContLang->truncate( $reason, 255 );
2404
2405                 $logRelationsValues = array();
2406                 $logRelationsField = null;
2407                 $logParamsDetails = array();
2408
2409                 if ( $id ) { // Protection of existing page
2410                         if ( !Hooks::run( 'ArticleProtect', array( &$this, &$user, $limit, $reason ) ) ) {
2411                                 return Status::newGood();
2412                         }
2413
2414                         // Only certain restrictions can cascade...
2415                         $editrestriction = isset( $limit['edit'] )
2416                                 ? array( $limit['edit'] )
2417                                 : $this->mTitle->getRestrictions( 'edit' );
2418                         foreach ( array_keys( $editrestriction, 'sysop' ) as $key ) {
2419                                 $editrestriction[$key] = 'editprotected'; // backwards compatibility
2420                         }
2421                         foreach ( array_keys( $editrestriction, 'autoconfirmed' ) as $key ) {
2422                                 $editrestriction[$key] = 'editsemiprotected'; // backwards compatibility
2423                         }
2424
2425                         $cascadingRestrictionLevels = $wgCascadingRestrictionLevels;
2426                         foreach ( array_keys( $cascadingRestrictionLevels, 'sysop' ) as $key ) {
2427                                 $cascadingRestrictionLevels[$key] = 'editprotected'; // backwards compatibility
2428                         }
2429                         foreach ( array_keys( $cascadingRestrictionLevels, 'autoconfirmed' ) as $key ) {
2430                                 $cascadingRestrictionLevels[$key] = 'editsemiprotected'; // backwards compatibility
2431                         }
2432
2433                         // The schema allows multiple restrictions
2434                         if ( !array_intersect( $editrestriction, $cascadingRestrictionLevels ) ) {
2435                                 $cascade = false;
2436                         }
2437
2438                         // insert null revision to identify the page protection change as edit summary
2439                         $latest = $this->getLatest();
2440                         $nullRevision = $this->insertProtectNullRevision(
2441                                 $revCommentMsg,
2442                                 $limit,
2443                                 $expiry,
2444                                 $cascade,
2445                                 $reason,
2446                                 $user
2447                         );
2448
2449                         if ( $nullRevision === null ) {
2450                                 return Status::newFatal( 'no-null-revision', $this->mTitle->getPrefixedText() );
2451                         }
2452
2453                         $logRelationsField = 'pr_id';
2454
2455                         // Update restrictions table
2456                         foreach ( $limit as $action => $restrictions ) {
2457                                 $dbw->delete(
2458                                         'page_restrictions',
2459                                         array(
2460                                                 'pr_page' => $id,
2461                                                 'pr_type' => $action
2462                                         ),
2463                                         __METHOD__
2464                                 );
2465                                 if ( $restrictions != '' ) {
2466                                         $cascadeValue = ( $cascade && $action == 'edit' ) ? 1 : 0;
2467                                         $dbw->insert(
2468                                                 'page_restrictions',
2469                                                 array(
2470                                                         'pr_id' => $dbw->nextSequenceValue( 'page_restrictions_pr_id_seq' ),
2471                                                         'pr_page' => $id,
2472                                                         'pr_type' => $action,
2473                                                         'pr_level' => $restrictions,
2474                                                         'pr_cascade' => $cascadeValue,
2475                                                         'pr_expiry' => $dbw->encodeExpiry( $expiry[$action] )
2476                                                 ),
2477                                                 __METHOD__
2478                                         );
2479                                         $logRelationsValues[] = $dbw->insertId();
2480                                         $logParamsDetails[] = array(
2481                                                 'type' => $action,
2482                                                 'level' => $restrictions,
2483                                                 'expiry' => $expiry[$action],
2484                                                 'cascade' => (bool)$cascadeValue,
2485                                         );
2486                                 }
2487                         }
2488
2489                         // Clear out legacy restriction fields
2490                         $dbw->update(
2491                                 'page',
2492                                 array( 'page_restrictions' => '' ),
2493                                 array( 'page_id' => $id ),
2494                                 __METHOD__
2495                         );
2496
2497                         Hooks::run( 'NewRevisionFromEditComplete',
2498                                 array( $this, $nullRevision, $latest, $user ) );
2499                         Hooks::run( 'ArticleProtectComplete', array( &$this, &$user, $limit, $reason ) );
2500                 } else { // Protection of non-existing page (also known as "title protection")
2501                         // Cascade protection is meaningless in this case
2502                         $cascade = false;
2503
2504                         if ( $limit['create'] != '' ) {
2505                                 $dbw->replace( 'protected_titles',
2506                                         array( array( 'pt_namespace', 'pt_title' ) ),
2507                                         array(
2508                                                 'pt_namespace' => $this->mTitle->getNamespace(),
2509                                                 'pt_title' => $this->mTitle->getDBkey(),
2510                                                 'pt_create_perm' => $limit['create'],
2511                                                 'pt_timestamp' => $dbw->timestamp(),
2512                                                 'pt_expiry' => $dbw->encodeExpiry( $expiry['create'] ),
2513                                                 'pt_user' => $user->getId(),
2514                                                 'pt_reason' => $reason,
2515                                         ), __METHOD__
2516                                 );
2517                                 $logParamsDetails[] = array(
2518                                         'type' => 'create',
2519                                         'level' => $limit['create'],
2520                                         'expiry' => $expiry['create'],
2521                                 );
2522                         } else {
2523                                 $dbw->delete( 'protected_titles',
2524                                         array(
2525                                                 'pt_namespace' => $this->mTitle->getNamespace(),
2526                                                 'pt_title' => $this->mTitle->getDBkey()
2527                                         ), __METHOD__
2528                                 );
2529                         }
2530                 }
2531
2532                 $this->mTitle->flushRestrictions();
2533                 InfoAction::invalidateCache( $this->mTitle );
2534
2535                 if ( $logAction == 'unprotect' ) {
2536                         $params = array();
2537                 } else {
2538                         $protectDescriptionLog = $this->protectDescriptionLog( $limit, $expiry );
2539                         $params = array(
2540                                 '4::description' => $protectDescriptionLog, // parameter for IRC
2541                                 '5:bool:cascade' => $cascade,
2542                                 'details' => $logParamsDetails, // parameter for localize and api
2543                         );
2544                 }
2545
2546                 // Update the protection log
2547                 $logEntry = new ManualLogEntry( 'protect', $logAction );
2548                 $logEntry->setTarget( $this->mTitle );
2549                 $logEntry->setComment( $reason );
2550                 $logEntry->setPerformer( $user );
2551                 $logEntry->setParameters( $params );
2552                 if ( $logRelationsField !== null && count( $logRelationsValues ) ) {
2553                         $logEntry->setRelations( array( $logRelationsField => $logRelationsValues ) );
2554                 }
2555                 $logId = $logEntry->insert();
2556                 $logEntry->publish( $logId );
2557
2558                 return Status::newGood();
2559         }
2560
2561         /**
2562          * Insert a new null revision for this page.
2563          *
2564          * @param string $revCommentMsg Comment message key for the revision
2565          * @param array $limit Set of restriction keys
2566          * @param array $expiry Per restriction type expiration
2567          * @param int $cascade Set to false if cascading protection isn't allowed.
2568          * @param string $reason
2569          * @param User|null $user
2570          * @return Revision|null Null on error
2571          */
2572         public function insertProtectNullRevision( $revCommentMsg, array $limit,
2573                 array $expiry, $cascade, $reason, $user = null
2574         ) {
2575                 global $wgContLang;
2576                 $dbw = wfGetDB( DB_MASTER );
2577
2578                 // Prepare a null revision to be added to the history
2579                 $editComment = $wgContLang->ucfirst(
2580                         wfMessage(
2581                                 $revCommentMsg,
2582                                 $this->mTitle->getPrefixedText()
2583                         )->inContentLanguage()->text()
2584                 );
2585                 if ( $reason ) {
2586                         $editComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
2587                 }
2588                 $protectDescription = $this->protectDescription( $limit, $expiry );
2589                 if ( $protectDescription ) {
2590                         $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2591                         $editComment .= wfMessage( 'parentheses' )->params( $protectDescription )
2592                                 ->inContentLanguage()->text();
2593                 }
2594                 if ( $cascade ) {
2595                         $editComment .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2596                         $editComment .= wfMessage( 'brackets' )->params(
2597                                 wfMessage( 'protect-summary-cascade' )->inContentLanguage()->text()
2598                         )->inContentLanguage()->text();
2599                 }
2600
2601                 $nullRev = Revision::newNullRevision( $dbw, $this->getId(), $editComment, true, $user );
2602                 if ( $nullRev ) {
2603                         $nullRev->insertOn( $dbw );
2604
2605                         // Update page record and touch page
2606                         $oldLatest = $nullRev->getParentId();
2607                         $this->updateRevisionOn( $dbw, $nullRev, $oldLatest );
2608                 }
2609
2610                 return $nullRev;
2611         }
2612
2613         /**
2614          * @param string $expiry 14-char timestamp or "infinity", or false if the input was invalid
2615          * @return string
2616          */
2617         protected function formatExpiry( $expiry ) {
2618                 global $wgContLang;
2619
2620                 if ( $expiry != 'infinity' ) {
2621                         return wfMessage(
2622                                 'protect-expiring',
2623                                 $wgContLang->timeanddate( $expiry, false, false ),
2624                                 $wgContLang->date( $expiry, false, false ),
2625                                 $wgContLang->time( $expiry, false, false )
2626                         )->inContentLanguage()->text();
2627                 } else {
2628                         return wfMessage( 'protect-expiry-indefinite' )
2629                                 ->inContentLanguage()->text();
2630                 }
2631         }
2632
2633         /**
2634          * Builds the description to serve as comment for the edit.
2635          *
2636          * @param array $limit Set of restriction keys
2637          * @param array $expiry Per restriction type expiration
2638          * @return string
2639          */
2640         public function protectDescription( array $limit, array $expiry ) {
2641                 $protectDescription = '';
2642
2643                 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2644                         # $action is one of $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' ).
2645                         # All possible message keys are listed here for easier grepping:
2646                         # * restriction-create
2647                         # * restriction-edit
2648                         # * restriction-move
2649                         # * restriction-upload
2650                         $actionText = wfMessage( 'restriction-' . $action )->inContentLanguage()->text();
2651                         # $restrictions is one of $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' ),
2652                         # with '' filtered out. All possible message keys are listed below:
2653                         # * protect-level-autoconfirmed
2654                         # * protect-level-sysop
2655                         $restrictionsText = wfMessage( 'protect-level-' . $restrictions )
2656                                 ->inContentLanguage()->text();
2657
2658                         $expiryText = $this->formatExpiry( $expiry[$action] );
2659
2660                         if ( $protectDescription !== '' ) {
2661                                 $protectDescription .= wfMessage( 'word-separator' )->inContentLanguage()->text();
2662                         }
2663                         $protectDescription .= wfMessage( 'protect-summary-desc' )
2664                                 ->params( $actionText, $restrictionsText, $expiryText )
2665                                 ->inContentLanguage()->text();
2666                 }
2667
2668                 return $protectDescription;
2669         }
2670
2671         /**
2672          * Builds the description to serve as comment for the log entry.
2673          *
2674          * Some bots may parse IRC lines, which are generated from log entries which contain plain
2675          * protect description text. Keep them in old format to avoid breaking compatibility.
2676          * TODO: Fix protection log to store structured description and format it on-the-fly.
2677          *
2678          * @param array $limit Set of restriction keys
2679          * @param array $expiry Per restriction type expiration
2680          * @return string
2681          */
2682         public function protectDescriptionLog( array $limit, array $expiry ) {
2683                 global $wgContLang;
2684
2685                 $protectDescriptionLog = '';
2686
2687                 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2688                         $expiryText = $this->formatExpiry( $expiry[$action] );
2689                         $protectDescriptionLog .= $wgContLang->getDirMark() .
2690                                 "[$action=$restrictions] ($expiryText)";
2691                 }
2692
2693                 return trim( $protectDescriptionLog );
2694         }
2695
2696         /**
2697          * Take an array of page restrictions and flatten it to a string
2698          * suitable for insertion into the page_restrictions field.
2699          *
2700          * @param string[] $limit
2701          *
2702          * @throws MWException
2703          * @return string
2704          */
2705         protected static function flattenRestrictions( $limit ) {
2706                 if ( !is_array( $limit ) ) {
2707                         throw new MWException( __METHOD__ . ' given non-array restriction set' );
2708                 }
2709
2710                 $bits = array();
2711                 ksort( $limit );
2712
2713                 foreach ( array_filter( $limit ) as $action => $restrictions ) {
2714                         $bits[] = "$action=$restrictions";
2715                 }
2716
2717                 return implode( ':', $bits );
2718         }
2719
2720         /**
2721          * Same as doDeleteArticleReal(), but returns a simple boolean. This is kept around for
2722          * backwards compatibility, if you care about error reporting you should use
2723          * doDeleteArticleReal() instead.
2724          *
2725          * Deletes the article with database consistency, writes logs, purges caches
2726          *
2727          * @param string $reason Delete reason for deletion log
2728          * @param bool $suppress Suppress all revisions and log the deletion in
2729          *        the suppression log instead of the deletion log
2730          * @param int $u1 Unused
2731          * @param bool $u2 Unused
2732          * @param array|string &$error Array of errors to append to
2733          * @param User $user The deleting user
2734          * @return bool True if successful
2735          */
2736         public function doDeleteArticle(
2737                 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $user = null
2738         ) {
2739                 $status = $this->doDeleteArticleReal( $reason, $suppress, $u1, $u2, $error, $user );
2740                 return $status->isGood();
2741         }
2742
2743         /**
2744          * Back-end article deletion
2745          * Deletes the article with database consistency, writes logs, purges caches
2746          *
2747          * @since 1.19
2748          *
2749          * @param string $reason Delete reason for deletion log
2750          * @param bool $suppress Suppress all revisions and log the deletion in
2751          *   the suppression log instead of the deletion log
2752          * @param int $u1 Unused
2753          * @param bool $u2 Unused
2754          * @param array|string &$error Array of errors to append to
2755          * @param User $user The deleting user
2756          * @return Status Status object; if successful, $status->value is the log_id of the
2757          *   deletion log entry. If the page couldn't be deleted because it wasn't
2758          *   found, $status is a non-fatal 'cannotdelete' error
2759          */
2760         public function doDeleteArticleReal(
2761                 $reason, $suppress = false, $u1 = null, $u2 = null, &$error = '', User $user = null
2762         ) {
2763                 global $wgUser, $wgContentHandlerUseDB;
2764
2765                 wfDebug( __METHOD__ . "\n" );
2766
2767                 $status = Status::newGood();
2768
2769                 if ( $this->mTitle->getDBkey() === '' ) {
2770                         $status->error( 'cannotdelete',
2771                                 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2772                         return $status;
2773                 }
2774
2775                 $user = is_null( $user ) ? $wgUser : $user;
2776                 if ( !Hooks::run( 'ArticleDelete',
2777                         array( &$this, &$user, &$reason, &$error, &$status, $suppress )
2778                 ) ) {
2779                         if ( $status->isOK() ) {
2780                                 // Hook aborted but didn't set a fatal status
2781                                 $status->fatal( 'delete-hook-aborted' );
2782                         }
2783                         return $status;
2784                 }
2785
2786                 $dbw = wfGetDB( DB_MASTER );
2787                 $dbw->startAtomic( __METHOD__ );
2788
2789                 $this->loadPageData( self::READ_LATEST );
2790                 $id = $this->getID();
2791                 // T98706: lock the page from various other updates but avoid using
2792                 // WikiPage::READ_LOCKING as that will carry over the FOR UPDATE to
2793                 // the revisions queries (which also JOIN on user). Only lock the page
2794                 // row and CAS check on page_latest to see if the trx snapshot matches.
2795                 $lockedLatest = $this->lockAndGetLatest();
2796                 if ( $id == 0 || $this->getLatest() != $lockedLatest ) {
2797                         $dbw->endAtomic( __METHOD__ );
2798                         // Page not there or trx snapshot is stale
2799                         $status->error( 'cannotdelete',
2800                                 wfEscapeWikiText( $this->getTitle()->getPrefixedText() ) );
2801                         return $status;
2802                 }
2803
2804                 // At this point we are now comitted to returning an OK
2805                 // status unless some DB query error or other exception comes up.
2806                 // This way callers don't have to call rollback() if $status is bad
2807                 // unless they actually try to catch exceptions (which is rare).
2808
2809                 // we need to remember the old content so we can use it to generate all deletion updates.
2810                 $content = $this->getContent( Revision::RAW );
2811
2812                 // Bitfields to further suppress the content
2813                 if ( $suppress ) {
2814                         $bitfield = 0;
2815                         // This should be 15...
2816                         $bitfield |= Revision::DELETED_TEXT;
2817                         $bitfield |= Revision::DELETED_COMMENT;
2818                         $bitfield |= Revision::DELETED_USER;
2819                         $bitfield |= Revision::DELETED_RESTRICTED;
2820                 } else {
2821                         $bitfield = 'rev_deleted';
2822                 }
2823
2824                 /**
2825                  * For now, shunt the revision data into the archive table.
2826                  * Text is *not* removed from the text table; bulk storage
2827                  * is left intact to avoid breaking block-compression or
2828                  * immutable storage schemes.
2829                  *
2830                  * For backwards compatibility, note that some older archive
2831                  * table entries will have ar_text and ar_flags fields still.
2832                  *
2833                  * In the future, we may keep revisions and mark them with
2834                  * the rev_deleted field, which is reserved for this purpose.
2835                  */
2836
2837                 $row = array(
2838                         'ar_namespace'  => 'page_namespace',
2839                         'ar_title'      => 'page_title',
2840                         'ar_comment'    => 'rev_comment',
2841                         'ar_user'       => 'rev_user',
2842                         'ar_user_text'  => 'rev_user_text',
2843                         'ar_timestamp'  => 'rev_timestamp',
2844                         'ar_minor_edit' => 'rev_minor_edit',
2845                         'ar_rev_id'     => 'rev_id',
2846                         'ar_parent_id'  => 'rev_parent_id',
2847                         'ar_text_id'    => 'rev_text_id',
2848                         'ar_text'       => '\'\'', // Be explicit to appease
2849                         'ar_flags'      => '\'\'', // MySQL's "strict mode"...
2850                         'ar_len'        => 'rev_len',
2851                         'ar_page_id'    => 'page_id',
2852                         'ar_deleted'    => $bitfield,
2853                         'ar_sha1'       => 'rev_sha1',
2854                 );
2855
2856                 if ( $wgContentHandlerUseDB ) {
2857                         $row['ar_content_model'] = 'rev_content_model';
2858                         $row['ar_content_format'] = 'rev_content_format';
2859                 }
2860
2861                 // Copy all the page revisions into the archive table
2862                 $dbw->insertSelect(
2863                         'archive',
2864                         array( 'page', 'revision' ),
2865                         $row,
2866                         array(
2867                                 'page_id' => $id,
2868                                 'page_id = rev_page'
2869                         ),
2870                         __METHOD__
2871                 );
2872
2873                 // Now that it's safely backed up, delete it
2874                 $dbw->delete( 'page', array( 'page_id' => $id ), __METHOD__ );
2875
2876                 if ( !$dbw->cascadingDeletes() ) {
2877                         $dbw->delete( 'revision', array( 'rev_page' => $id ), __METHOD__ );
2878                 }
2879
2880                 // Clone the title, so we have the information we need when we log
2881                 $logTitle = clone $this->mTitle;
2882
2883                 // Log the deletion, if the page was suppressed, put it in the suppression log instead
2884                 $logtype = $suppress ? 'suppress' : 'delete';
2885
2886                 $logEntry = new ManualLogEntry( $logtype, 'delete' );
2887                 $logEntry->setPerformer( $user );
2888                 $logEntry->setTarget( $logTitle );
2889                 $logEntry->setComment( $reason );
2890                 $logid = $logEntry->insert();
2891
2892                 $dbw->onTransactionPreCommitOrIdle( function () use ( $dbw, $logEntry, $logid ) {
2893                         // Bug 56776: avoid deadlocks (especially from FileDeleteForm)
2894                         $logEntry->publish( $logid );
2895                 } );
2896
2897                 $dbw->endAtomic( __METHOD__ );
2898
2899                 $this->doDeleteUpdates( $id, $content );
2900
2901                 Hooks::run( 'ArticleDeleteComplete',
2902                         array( &$this, &$user, $reason, $id, $content, $logEntry ) );
2903                 $status->value = $logid;
2904
2905                 // Show log excerpt on 404 pages rather than just a link
2906                 $cache = ObjectCache::getMainStashInstance();
2907                 $key = wfMemcKey( 'page-recent-delete', md5( $logTitle->getPrefixedText() ) );
2908                 $cache->set( $key, 1, $cache::TTL_DAY );
2909
2910                 return $status;
2911         }
2912
2913         /**
2914          * Lock the page row for this title+id and return page_latest (or 0)
2915          *
2916          * @return integer Returns 0 if no row was found with this title+id
2917          * @since 1.27
2918          */
2919         public function lockAndGetLatest() {
2920                 return (int)wfGetDB( DB_MASTER )->selectField(
2921                         'page',
2922                         'page_latest',
2923                         array(
2924                                 'page_id' => $this->getId(),
2925                                 // Typically page_id is enough, but some code might try to do
2926                                 // updates assuming the title is the same, so verify that
2927                                 'page_namespace' => $this->getTitle()->getNamespace(),
2928                                 'page_title' => $this->getTitle()->getDBkey()
2929                         ),
2930                         __METHOD__,
2931                         array( 'FOR UPDATE' )
2932                 );
2933         }
2934
2935         /**
2936          * Do some database updates after deletion
2937          *
2938          * @param int $id The page_id value of the page being deleted
2939          * @param Content $content Optional page content to be used when determining
2940          *   the required updates. This may be needed because $this->getContent()
2941          *   may already return null when the page proper was deleted.
2942          */
2943         public function doDeleteUpdates( $id, Content $content = null ) {
2944                 // Update site status
2945                 DeferredUpdates::addUpdate( new SiteStatsUpdate( 0, 1, - (int)$this->isCountable(), -1 ) );
2946
2947                 // Delete pagelinks, update secondary indexes, etc
2948                 $updates = $this->getDeletionUpdates( $content );
2949                 foreach ( $updates as $update ) {
2950                         DeferredUpdates::addUpdate( $update );
2951                 }
2952
2953                 // Reparse any pages transcluding this page
2954                 LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'templatelinks' );
2955
2956                 // Reparse any pages including this image
2957                 if ( $this->mTitle->getNamespace() == NS_FILE ) {
2958                         LinksUpdate::queueRecursiveJobsForTable( $this->mTitle, 'imagelinks' );
2959                 }
2960
2961                 // Clear caches
2962                 WikiPage::onArticleDelete( $this->mTitle );
2963
2964                 // Reset this object and the Title object
2965                 $this->loadFromRow( false, self::READ_LATEST );
2966
2967                 // Search engine
2968                 DeferredUpdates::addUpdate( new SearchUpdate( $id, $this->mTitle ) );
2969         }
2970
2971         /**
2972          * Roll back the most recent consecutive set of edits to a page
2973          * from the same user; fails if there are no eligible edits to
2974          * roll back to, e.g. user is the sole contributor. This function
2975          * performs permissions checks on $user, then calls commitRollback()
2976          * to do the dirty work
2977          *
2978          * @todo Separate the business/permission stuff out from backend code
2979          *
2980          * @param string $fromP Name of the user whose edits to rollback.
2981          * @param string $summary Custom summary. Set to default summary if empty.
2982          * @param string $token Rollback token.
2983          * @param bool $bot If true, mark all reverted edits as bot.
2984          *
2985          * @param array $resultDetails Array contains result-specific array of additional values
2986          *    'alreadyrolled' : 'current' (rev)
2987          *    success        : 'summary' (str), 'current' (rev), 'target' (rev)
2988          *
2989          * @param User $user The user performing the rollback
2990          * @return array Array of errors, each error formatted as
2991          *   array(messagekey, param1, param2, ...).
2992          * On success, the array is empty.  This array can also be passed to
2993          * OutputPage::showPermissionsErrorPage().
2994          */
2995         public function doRollback(
2996                 $fromP, $summary, $token, $bot, &$resultDetails, User $user
2997         ) {
2998                 $resultDetails = null;
2999
3000                 // Check permissions
3001                 $editErrors = $this->mTitle->getUserPermissionsErrors( 'edit', $user );
3002                 $rollbackErrors = $this->mTitle->getUserPermissionsErrors( 'rollback', $user );
3003                 $errors = array_merge( $editErrors, wfArrayDiff2( $rollbackErrors, $editErrors ) );
3004
3005                 if ( !$user->matchEditToken( $token, array( $this->mTitle->getPrefixedText(), $fromP ) ) ) {
3006                         $errors[] = array( 'sessionfailure' );
3007                 }
3008
3009                 if ( $user->pingLimiter( 'rollback' ) || $user->pingLimiter() ) {
3010                         $errors[] = array( 'actionthrottledtext' );
3011                 }
3012
3013                 // If there were errors, bail out now
3014                 if ( !empty( $errors ) ) {
3015                         return $errors;
3016                 }
3017
3018                 return $this->commitRollback( $fromP, $summary, $bot, $resultDetails, $user );
3019         }
3020
3021         /**
3022          * Backend implementation of doRollback(), please refer there for parameter
3023          * and return value documentation
3024          *
3025          * NOTE: This function does NOT check ANY permissions, it just commits the
3026          * rollback to the DB. Therefore, you should only call this function direct-
3027          * ly if you want to use custom permissions checks. If you don't, use
3028          * doRollback() instead.
3029          * @param string $fromP Name of the user whose edits to rollback.
3030          * @param string $summary Custom summary. Set to default summary if empty.
3031          * @param bool $bot If true, mark all reverted edits as bot.
3032          *
3033          * @param array $resultDetails Contains result-specific array of additional values
3034          * @param User $guser The user performing the rollback
3035          * @return array
3036          */
3037         public function commitRollback( $fromP, $summary, $bot, &$resultDetails, User $guser ) {
3038                 global $wgUseRCPatrol, $wgContLang;
3039
3040                 $dbw = wfGetDB( DB_MASTER );
3041
3042                 if ( wfReadOnly() ) {
3043                         return array( array( 'readonlytext' ) );
3044                 }
3045
3046                 // Get the last editor
3047                 $current = $this->getRevision();
3048                 if ( is_null( $current ) ) {
3049                         // Something wrong... no page?
3050                         return array( array( 'notanarticle' ) );
3051                 }
3052
3053                 $from = str_replace( '_', ' ', $fromP );
3054                 // User name given should match up with the top revision.
3055                 // If the user was deleted then $from should be empty.
3056                 if ( $from != $current->getUserText() ) {
3057                         $resultDetails = array( 'current' => $current );
3058                         return array( array( 'alreadyrolled',
3059                                 htmlspecialchars( $this->mTitle->getPrefixedText() ),
3060                                 htmlspecialchars( $fromP ),
3061                                 htmlspecialchars( $current->getUserText() )
3062                         ) );
3063                 }
3064
3065                 // Get the last edit not by this person...
3066                 // Note: these may not be public values
3067                 $user = intval( $current->getUser( Revision::RAW ) );
3068                 $user_text = $dbw->addQuotes( $current->getUserText( Revision::RAW ) );
3069                 $s = $dbw->selectRow( 'revision',
3070                         array( 'rev_id', 'rev_timestamp', 'rev_deleted' ),
3071                         array( 'rev_page' => $current->getPage(),
3072                                 "rev_user != {$user} OR rev_user_text != {$user_text}"
3073                         ), __METHOD__,
3074                         array( 'USE INDEX' => 'page_timestamp',
3075                                 'ORDER BY' => 'rev_timestamp DESC' )
3076                         );
3077                 if ( $s === false ) {
3078                         // No one else ever edited this page
3079                         return array( array( 'cantrollback' ) );
3080                 } elseif ( $s->rev_deleted & Revision::DELETED_TEXT
3081                         || $s->rev_deleted & Revision::DELETED_USER
3082                 ) {
3083                         // Only admins can see this text
3084                         return array( array( 'notvisiblerev' ) );
3085                 }
3086
3087                 // Generate the edit summary if necessary
3088                 $target = Revision::newFromId( $s->rev_id, Revision::READ_LATEST );
3089                 if ( empty( $summary ) ) {
3090                         if ( $from == '' ) { // no public user name
3091                                 $summary = wfMessage( 'revertpage-nouser' );
3092                         } else {
3093                                 $summary = wfMessage( 'revertpage' );
3094                         }
3095                 }
3096
3097                 // Allow the custom summary to use the same args as the default message
3098                 $args = array(
3099                         $target->getUserText(), $from, $s->rev_id,
3100                         $wgContLang->timeanddate( wfTimestamp( TS_MW, $s->rev_timestamp ) ),
3101                         $current->getId(), $wgContLang->timeanddate( $current->getTimestamp() )
3102                 );
3103                 if ( $summary instanceof Message ) {
3104                         $summary = $summary->params( $args )->inContentLanguage()->text();
3105                 } else {
3106                         $summary = wfMsgReplaceArgs( $summary, $args );
3107                 }
3108
3109                 // Trim spaces on user supplied text
3110                 $summary = trim( $summary );
3111
3112                 // Truncate for whole multibyte characters.
3113                 $summary = $wgContLang->truncate( $summary, 255 );
3114
3115                 // Save
3116                 $flags = EDIT_UPDATE;
3117
3118                 if ( $guser->isAllowed( 'minoredit' ) ) {
3119                         $flags |= EDIT_MINOR;
3120                 }
3121
3122                 if ( $bot && ( $guser->isAllowedAny( 'markbotedits', 'bot' ) ) ) {
3123                         $flags |= EDIT_FORCE_BOT;
3124                 }
3125
3126                 // Actually store the edit
3127                 $status = $this->doEditContent(
3128                         $target->getContent(),
3129                         $summary,
3130                         $flags,
3131                         $target->getId(),
3132                         $guser
3133                 );
3134
3135                 // Set patrolling and bot flag on the edits, which gets rollbacked.
3136                 // This is done even on edit failure to have patrolling in that case (bug 62157).
3137                 $set = array();
3138                 if ( $bot && $guser->isAllowed( 'markbotedits' ) ) {
3139                         // Mark all reverted edits as bot
3140                         $set['rc_bot'] = 1;
3141                 }
3142
3143                 if ( $wgUseRCPatrol ) {
3144                         // Mark all reverted edits as patrolled
3145                         $set['rc_patrolled'] = 1;
3146                 }
3147
3148                 if ( count( $set ) ) {
3149                         $dbw->update( 'recentchanges', $set,
3150                                 array( /* WHERE */
3151                                         'rc_cur_id' => $current->getPage(),
3152                                         'rc_user_text' => $current->getUserText(),
3153                                         'rc_timestamp > ' . $dbw->addQuotes( $s->rev_timestamp ),
3154                                 ),
3155                                 __METHOD__
3156                         );
3157                 }
3158
3159                 if ( !$status->isOK() ) {
3160                         return $status->getErrorsArray();
3161                 }
3162
3163                 // raise error, when the edit is an edit without a new version
3164                 $statusRev = isset( $status->value['revision'] )
3165                         ? $status->value['revision']
3166                         : null;
3167                 if ( !( $statusRev instanceof Revision ) ) {
3168                         $resultDetails = array( 'current' => $current );
3169                         return array( array( 'alreadyrolled',
3170                                         htmlspecialchars( $this->mTitle->getPrefixedText() ),
3171                                         htmlspecialchars( $fromP ),
3172                                         htmlspecialchars( $current->getUserText() )
3173                         ) );
3174                 }
3175
3176                 $revId = $statusRev->getId();
3177
3178                 Hooks::run( 'ArticleRollbackComplete', array( $this, $guser, $target, $current ) );
3179
3180                 $resultDetails = array(
3181                         'summary' => $summary,
3182                         'current' => $current,
3183                         'target' => $target,
3184                         'newid' => $revId
3185                 );
3186
3187                 return array();
3188         }
3189
3190         /**
3191          * The onArticle*() functions are supposed to be a kind of hooks
3192          * which should be called whenever any of the specified actions
3193          * are done.
3194          *
3195          * This is a good place to put code to clear caches, for instance.
3196          *
3197          * This is called on page move and undelete, as well as edit
3198          *
3199          * @param Title $title
3200          */
3201         public static function onArticleCreate( Title $title ) {
3202                 // Update existence markers on article/talk tabs...
3203                 $other = $title->getOtherPage();
3204
3205                 $other->purgeSquid();
3206
3207                 $title->touchLinks();
3208                 $title->purgeSquid();
3209                 $title->deleteTitleProtection();
3210         }
3211
3212         /**
3213          * Clears caches when article is deleted
3214          *
3215          * @param Title $title
3216          */
3217         public static function onArticleDelete( Title $title ) {
3218                 // Update existence markers on article/talk tabs...
3219                 $other = $title->getOtherPage();
3220
3221                 $other->purgeSquid();
3222
3223                 $title->touchLinks();
3224                 $title->purgeSquid();
3225
3226                 // File cache
3227                 HTMLFileCache::clearFileCache( $title );
3228                 InfoAction::invalidateCache( $title );
3229
3230                 // Messages
3231                 if ( $title->getNamespace() == NS_MEDIAWIKI ) {
3232                         MessageCache::singleton()->replace( $title->getDBkey(), false );
3233                 }
3234
3235                 // Images
3236                 if ( $title->getNamespace() == NS_FILE ) {
3237                         DeferredUpdates::addUpdate( new HTMLCacheUpdate( $title, 'imagelinks' ) );
3238                 }
3239
3240                 // User talk pages
3241                 if ( $title->getNamespace() == NS_USER_TALK ) {
3242                         $user = User::newFromName( $title->getText(), false );
3243                         if ( $user ) {
3244                                 $user->setNewtalk( false );
3245                         }
3246                 }
3247
3248                 // Image redirects
3249                 RepoGroup::singleton()->getLocalRepo()->invalidateImageRedirect( $title );
3250         }
3251
3252         /**
3253          * Purge caches on page update etc
3254          *
3255          * @param Title $title
3256          * @param Revision|null $revision Revision that was just saved, may be null
3257          */
3258         public static function onArticleEdit( Title $title, Revision $revision = null ) {
3259                 // Invalidate caches of articles which include this page
3260                 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $title, 'templatelinks' ) );
3261
3262                 // Invalidate the caches of all pages which redirect here
3263                 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $title, 'redirect' ) );
3264
3265                 // Purge squid for this page only
3266                 $title->purgeSquid();
3267                 // Clear file cache for this page only
3268                 HTMLFileCache::clearFileCache( $title );
3269
3270                 $revid = $revision ? $revision->getId() : null;
3271                 DeferredUpdates::addCallableUpdate( function() use ( $title, $revid ) {
3272                         InfoAction::invalidateCache( $title, $revid );
3273                 } );
3274         }
3275
3276         /**#@-*/
3277
3278         /**
3279          * Returns a list of categories this page is a member of.
3280          * Results will include hidden categories
3281          *
3282          * @return TitleArray
3283          */
3284         public function getCategories() {
3285                 $id = $this->getId();
3286                 if ( $id == 0 ) {
3287                         return TitleArray::newFromResult( new FakeResultWrapper( array() ) );
3288                 }
3289
3290                 $dbr = wfGetDB( DB_SLAVE );
3291                 $res = $dbr->select( 'categorylinks',
3292                         array( 'cl_to AS page_title, ' . NS_CATEGORY . ' AS page_namespace' ),
3293                         // Have to do that since DatabaseBase::fieldNamesWithAlias treats numeric indexes
3294                         // as not being aliases, and NS_CATEGORY is numeric
3295                         array( 'cl_from' => $id ),
3296                         __METHOD__ );
3297
3298                 return TitleArray::newFromResult( $res );
3299         }
3300
3301         /**
3302          * Returns a list of hidden categories this page is a member of.
3303          * Uses the page_props and categorylinks tables.
3304          *
3305          * @return array Array of Title objects
3306          */
3307         public function getHiddenCategories() {
3308                 $result = array();
3309                 $id = $this->getId();
3310
3311                 if ( $id == 0 ) {
3312                         return array();
3313                 }
3314
3315                 $dbr = wfGetDB( DB_SLAVE );
3316                 $res = $dbr->select( array( 'categorylinks', 'page_props', 'page' ),
3317                         array( 'cl_to' ),
3318                         array( 'cl_from' => $id, 'pp_page=page_id', 'pp_propname' => 'hiddencat',
3319                                 'page_namespace' => NS_CATEGORY, 'page_title=cl_to' ),
3320                         __METHOD__ );
3321
3322                 if ( $res !== false ) {
3323                         foreach ( $res as $row ) {
3324                                 $result[] = Title::makeTitle( NS_CATEGORY, $row->cl_to );
3325                         }
3326                 }
3327
3328                 return $result;
3329         }
3330
3331         /**
3332          * Return an applicable autosummary if one exists for the given edit.
3333          * @param string|null $oldtext The previous text of the page.
3334          * @param string|null $newtext The submitted text of the page.
3335          * @param int $flags Bitmask: a bitmask of flags submitted for the edit.
3336          * @return string An appropriate autosummary, or an empty string.
3337          *
3338          * @deprecated since 1.21, use ContentHandler::getAutosummary() instead
3339          */
3340         public static function getAutosummary( $oldtext, $newtext, $flags ) {
3341                 // NOTE: stub for backwards-compatibility. assumes the given text is
3342                 // wikitext. will break horribly if it isn't.
3343
3344                 ContentHandler::deprecated( __METHOD__, '1.21' );
3345
3346                 $handler = ContentHandler::getForModelID( CONTENT_MODEL_WIKITEXT );
3347                 $oldContent = is_null( $oldtext ) ? null : $handler->unserializeContent( $oldtext );
3348                 $newContent = is_null( $newtext ) ? null : $handler->unserializeContent( $newtext );
3349
3350                 return $handler->getAutosummary( $oldContent, $newContent, $flags );
3351         }
3352
3353         /**
3354          * Auto-generates a deletion reason
3355          *
3356          * @param bool &$hasHistory Whether the page has a history
3357          * @return string|bool String containing deletion reason or empty string, or boolean false
3358          *    if no revision occurred
3359          */
3360         public function getAutoDeleteReason( &$hasHistory ) {
3361                 return $this->getContentHandler()->getAutoDeleteReason( $this->getTitle(), $hasHistory );
3362         }
3363
3364         /**
3365          * Update all the appropriate counts in the category table, given that
3366          * we've added the categories $added and deleted the categories $deleted.
3367          *
3368          * @param array $added The names of categories that were added
3369          * @param array $deleted The names of categories that were deleted
3370          */
3371         public function updateCategoryCounts( array $added, array $deleted ) {
3372                 $that = $this;
3373                 $method = __METHOD__;
3374                 $dbw = wfGetDB( DB_MASTER );
3375
3376                 // Do this at the end of the commit to reduce lock wait timeouts
3377                 $dbw->onTransactionPreCommitOrIdle(
3378                         function () use ( $dbw, $that, $method, $added, $deleted ) {
3379                                 $ns = $that->getTitle()->getNamespace();
3380
3381                                 $addFields = array( 'cat_pages = cat_pages + 1' );
3382                                 $removeFields = array( 'cat_pages = cat_pages - 1' );
3383                                 if ( $ns == NS_CATEGORY ) {
3384                                         $addFields[] = 'cat_subcats = cat_subcats + 1';
3385                                         $removeFields[] = 'cat_subcats = cat_subcats - 1';
3386                                 } elseif ( $ns == NS_FILE ) {
3387                                         $addFields[] = 'cat_files = cat_files + 1';
3388                                         $removeFields[] = 'cat_files = cat_files - 1';
3389                                 }
3390
3391                                 if ( count( $added ) ) {
3392                                         $existingAdded = $dbw->selectFieldValues(
3393                                                 'category',
3394                                                 'cat_title',
3395                                                 array( 'cat_title' => $added ),
3396                                                 __METHOD__
3397                                         );
3398
3399                                         // For category rows that already exist, do a plain
3400                                         // UPDATE instead of INSERT...ON DUPLICATE KEY UPDATE
3401                                         // to avoid creating gaps in the cat_id sequence.
3402                                         if ( count( $existingAdded ) ) {
3403                                                 $dbw->update(
3404                                                         'category',
3405                                                         $addFields,
3406                                                         array( 'cat_title' => $existingAdded ),
3407                                                         __METHOD__
3408                                                 );
3409                                         }
3410
3411                                         $missingAdded = array_diff( $added, $existingAdded );
3412                                         if ( count( $missingAdded ) ) {
3413                                                 $insertRows = array();
3414                                                 foreach ( $missingAdded as $cat ) {
3415                                                         $insertRows[] = array(
3416                                                                 'cat_title'   => $cat,
3417                                                                 'cat_pages'   => 1,
3418                                                                 'cat_subcats' => ( $ns == NS_CATEGORY ) ? 1 : 0,
3419                                                                 'cat_files'   => ( $ns == NS_FILE ) ? 1 : 0,
3420                                                         );
3421                                                 }
3422                                                 $dbw->upsert(
3423                                                         'category',
3424                                                         $insertRows,
3425                                                         array( 'cat_title' ),
3426                                                         $addFields,
3427                                                         $method
3428                                                 );
3429                                         }
3430                                 }
3431
3432                                 if ( count( $deleted ) ) {
3433                                         $dbw->update(
3434                                                 'category',
3435                                                 $removeFields,
3436                                                 array( 'cat_title' => $deleted ),
3437                                                 $method
3438                                         );
3439                                 }
3440
3441                                 foreach ( $added as $catName ) {
3442                                         $cat = Category::newFromName( $catName );
3443                                         Hooks::run( 'CategoryAfterPageAdded', array( $cat, $that ) );
3444                                 }
3445
3446                                 foreach ( $deleted as $catName ) {
3447                                         $cat = Category::newFromName( $catName );
3448                                         Hooks::run( 'CategoryAfterPageRemoved', array( $cat, $that ) );
3449                                 }
3450                         }
3451                 );
3452         }
3453
3454         /**
3455          * Opportunistically enqueue link update jobs given fresh parser output if useful
3456          *
3457          * @param ParserOutput $parserOutput Current version page output
3458          * @since 1.25
3459          */
3460         public function triggerOpportunisticLinksUpdate( ParserOutput $parserOutput ) {
3461                 if ( wfReadOnly() ) {
3462                         return;
3463                 }
3464
3465                 if ( !Hooks::run( 'OpportunisticLinksUpdate',
3466                         array( $this, $this->mTitle, $parserOutput )
3467                 ) ) {
3468                         return;
3469                 }
3470
3471                 $params = array(
3472                         'isOpportunistic' => true,
3473                         'rootJobTimestamp' => $parserOutput->getCacheTime()
3474                 );
3475
3476                 if ( $this->mTitle->areRestrictionsCascading() ) {
3477                         // If the page is cascade protecting, the links should really be up-to-date
3478                         JobQueueGroup::singleton()->lazyPush(
3479                                 RefreshLinksJob::newPrioritized( $this->mTitle, $params )
3480                         );
3481                 } elseif ( $parserOutput->hasDynamicContent() ) {
3482                         // Assume the output contains "dynamic" time/random based magic words.
3483                         // Only update pages that expired due to dynamic content and NOT due to edits
3484                         // to referenced templates/files. When the cache expires due to dynamic content,
3485                         // page_touched is unchanged. We want to avoid triggering redundant jobs due to
3486                         // views of pages that were just purged via HTMLCacheUpdateJob. In that case, the
3487                         // template/file edit already triggered recursive RefreshLinksJob jobs.
3488                         if ( $this->getLinksTimestamp() > $this->getTouched() ) {
3489                                 // If a page is uncacheable, do not keep spamming a job for it.
3490                                 // Although it would be de-duplicated, it would still waste I/O.
3491                                 $cache = ObjectCache::getLocalClusterInstance();
3492                                 $key = $cache->makeKey( 'dynamic-linksupdate', 'last', $this->getId() );
3493                                 if ( $cache->add( $key, time(), 60 ) ) {
3494                                         JobQueueGroup::singleton()->lazyPush(
3495                                                 RefreshLinksJob::newDynamic( $this->mTitle, $params )
3496                                         );
3497                                 }
3498                         }
3499                 }
3500         }
3501
3502         /**
3503          * Return a list of templates used by this article.
3504          * Uses the templatelinks table
3505          *
3506          * @deprecated since 1.19; use Title::getTemplateLinksFrom()
3507          * @return array Array of Title objects
3508          */
3509         public function getUsedTemplates() {
3510                 return $this->mTitle->getTemplateLinksFrom();
3511         }
3512
3513         /**
3514          * This function is called right before saving the wikitext,
3515          * so we can do things like signatures and links-in-context.
3516          *
3517          * @deprecated since 1.19; use Parser::preSaveTransform() instead
3518          * @param string $text Article contents
3519          * @param User $user User doing the edit
3520          * @param ParserOptions $popts Parser options, default options for
3521          *   the user loaded if null given
3522          * @return string Article contents with altered wikitext markup (signatures
3523          *      converted, {{subst:}}, templates, etc.)
3524          */
3525         public function preSaveTransform( $text, User $user = null, ParserOptions $popts = null ) {
3526                 global $wgParser, $wgUser;
3527
3528                 wfDeprecated( __METHOD__, '1.19' );
3529
3530                 $user = is_null( $user ) ? $wgUser : $user;
3531
3532                 if ( $popts === null ) {
3533                         $popts = ParserOptions::newFromUser( $user );
3534                 }
3535
3536                 return $wgParser->preSaveTransform( $text, $this->mTitle, $user, $popts );
3537         }
3538
3539         /**
3540          * Update the article's restriction field, and leave a log entry.
3541          *
3542          * @deprecated since 1.19
3543          * @param array $limit Set of restriction keys
3544          * @param string $reason
3545          * @param int &$cascade Set to false if cascading protection isn't allowed.
3546          * @param array $expiry Per restriction type expiration
3547          * @param User $user The user updating the restrictions
3548          * @return bool True on success
3549          */
3550         public function updateRestrictions(
3551                 $limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User $user = null
3552         ) {
3553                 global $wgUser;
3554
3555                 $user = is_null( $user ) ? $wgUser : $user;
3556
3557                 return $this->doUpdateRestrictions( $limit, $expiry, $cascade, $reason, $user )->isOK();
3558         }
3559
3560         /**
3561          * Returns a list of updates to be performed when this page is deleted. The
3562          * updates should remove any information about this page from secondary data
3563          * stores such as links tables.
3564          *
3565          * @param Content|null $content Optional Content object for determining the
3566          *   necessary updates.
3567          * @return DataUpdate[]
3568          */
3569         public function getDeletionUpdates( Content $content = null ) {
3570                 if ( !$content ) {
3571                         // load content object, which may be used to determine the necessary updates.
3572                         // XXX: the content may not be needed to determine the updates.
3573                         $content = $this->getContent( Revision::RAW );
3574                 }
3575
3576                 if ( !$content ) {
3577                         $updates = array();
3578                 } else {
3579                         $updates = $content->getDeletionUpdates( $this );
3580                 }
3581
3582                 Hooks::run( 'WikiPageDeletionUpdates', array( $this, $content, &$updates ) );
3583                 return $updates;
3584         }
3585 }