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