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