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