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