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