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