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