includes/Storage/PageUpdater.php

   1 <?php
   2 /**
   3  * Controller-like object for creating and updating pages by creating new revisions.
   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  * @author Daniel Kinzler
  23  */
  24
  25 namespace MediaWiki\Storage;
  26
  27 use AtomicSectionUpdate;
  28 use ChangeTags;
  29 use CommentStoreComment;
  30 use Content;
  31 use ContentHandler;
  32 use DeferredUpdates;
  33 use Hooks;
  34 use InvalidArgumentException;
  35 use LogicException;
  36 use ManualLogEntry;
  37 use MediaWiki\Linker\LinkTarget;
  38 use MWException;
  39 use RecentChange;
  40 use Revision;
  41 use RuntimeException;
  42 use Status;
  43 use Title;
  44 use User;
  45 use Wikimedia\Assert\Assert;
  46 use Wikimedia\Rdbms\DBConnRef;
  47 use Wikimedia\Rdbms\DBUnexpectedError;
  48 use Wikimedia\Rdbms\IDatabase;
  49 use Wikimedia\Rdbms\LoadBalancer;
  50 use WikiPage;
  51
  52 /**
  53  * Controller-like object for creating and updating pages by creating new revisions.
  54  *
  55  * PageUpdater instances provide compare-and-swap (CAS) protection against concurrent updates
  56  * between the time grabParentRevision() is called and saveRevision() inserts a new revision.
  57  * This allows application logic to safely perform edit conflict resolution using the parent
  58  * revision's content.
  59  *
  60  * @see docs/pageupdater.txt for more information.
  61  *
  62  * MCR migration note: this replaces the relevant methods in WikiPage.
  63  *
  64  * @since 1.32
  65  * @ingroup Page
  66  */
  67 class PageUpdater {
  68
  69         /**
  70          * @var User
  71          */
  72         private $user;
  73
  74         /**
  75          * @var WikiPage
  76          */
  77         private $wikiPage;
  78
  79         /**
  80          * @var DerivedPageDataUpdater
  81          */
  82         private $derivedDataUpdater;
  83
  84         /**
  85          * @var LoadBalancer
  86          */
  87         private $loadBalancer;
  88
  89         /**
  90          * @var RevisionStore
  91          */
  92         private $revisionStore;
  93
  94         /**
  95          * @var boolean see $wgUseAutomaticEditSummaries
  96          * @see $wgUseAutomaticEditSummaries
  97          */
  98         private $useAutomaticEditSummaries = true;
  99
 100         /**
 101          * @var int the RC patrol status the new revision should be marked with.
 102          */
 103         private $rcPatrolStatus = RecentChange::PRC_UNPATROLLED;
 104
 105         /**
 106          * @var bool whether to create a log entry for new page creations.
 107          */
 108         private $usePageCreationLog = true;
 109
 110         /**
 111          * @var boolean see $wgAjaxEditStash
 112          */
 113         private $ajaxEditStash = true;
 114
 115         /**
 116          * @var bool|int
 117          */
 118         private $originalRevId = false;
 119
 120         /**
 121          * @var array
 122          */
 123         private $tags = [];
 124
 125         /**
 126          * @var int
 127          */
 128         private $undidRevId = 0;
 129
 130         /**
 131          * @var RevisionSlotsUpdate
 132          */
 133         private $slotsUpdate;
 134
 135         /**
 136          * @var Status|null
 137          */
 138         private $status = null;
 139
 140         /**
 141          * @param User $user
 142          * @param WikiPage $wikiPage
 143          * @param DerivedPageDataUpdater $derivedDataUpdater
 144          * @param LoadBalancer $loadBalancer
 145          * @param RevisionStore $revisionStore
 146          */
 147         public function __construct(
 148                 User $user,
 149                 WikiPage $wikiPage,
 150                 DerivedPageDataUpdater $derivedDataUpdater,
 151                 LoadBalancer $loadBalancer,
 152                 RevisionStore $revisionStore
 153         ) {
 154                 $this->user = $user;
 155                 $this->wikiPage = $wikiPage;
 156                 $this->derivedDataUpdater = $derivedDataUpdater;
 157
 158                 $this->loadBalancer = $loadBalancer;
 159                 $this->revisionStore = $revisionStore;
 160
 161                 $this->slotsUpdate = new RevisionSlotsUpdate();
 162         }
 163
 164         /**
 165          * Can be used to enable or disable automatic summaries that are applied to certain kinds of
 166          * changes, like completely blanking a page.
 167          *
 168          * @param bool $useAutomaticEditSummaries
 169          * @see $wgUseAutomaticEditSummaries
 170          */
 171         public function setUseAutomaticEditSummaries( $useAutomaticEditSummaries ) {
 172                 $this->useAutomaticEditSummaries = $useAutomaticEditSummaries;
 173         }
 174
 175         /**
 176          * Sets the "patrolled" status of the edit.
 177          * Callers should check the "patrol" and "autopatrol" permissions as appropriate.
 178          *
 179          * @see $wgUseRCPatrol
 180          * @see $wgUseNPPatrol
 181          *
 182          * @param int $status RC patrol status, e.g. RecentChange::PRC_AUTOPATROLLED.
 183          */
 184         public function setRcPatrolStatus( $status ) {
 185                 $this->rcPatrolStatus = $status;
 186         }
 187
 188         /**
 189          * Whether to create a log entry for new page creations.
 190          *
 191          * @see $wgPageCreationLog
 192          *
 193          * @param bool $use
 194          */
 195         public function setUsePageCreationLog( $use ) {
 196                 $this->usePageCreationLog = $use;
 197         }
 198
 199         /**
 200          * @param bool $ajaxEditStash
 201          * @see $wgAjaxEditStash
 202          */
 203         public function setAjaxEditStash( $ajaxEditStash ) {
 204                 $this->ajaxEditStash = $ajaxEditStash;
 205         }
 206
 207         private function getWikiId() {
 208                 return false; // TODO: get from RevisionStore!
 209         }
 210
 211         /**
 212          * @param int $mode DB_MASTER or DB_REPLICA
 213          *
 214          * @return DBConnRef
 215          */
 216         private function getDBConnectionRef( $mode ) {
 217                 return $this->loadBalancer->getConnectionRef( $mode, [], $this->getWikiId() );
 218         }
 219
 220         /**
 221          * @return LinkTarget
 222          */
 223         private function getLinkTarget() {
 224                 // NOTE: eventually, we won't get a WikiPage passed into the constructor any more
 225                 return $this->wikiPage->getTitle();
 226         }
 227
 228         /**
 229          * @return Title
 230          */
 231         private function getTitle() {
 232                 // NOTE: eventually, we won't get a WikiPage passed into the constructor any more
 233                 return $this->wikiPage->getTitle();
 234         }
 235
 236         /**
 237          * @return WikiPage
 238          */
 239         private function getWikiPage() {
 240                 // NOTE: eventually, we won't get a WikiPage passed into the constructor any more
 241                 return $this->wikiPage;
 242         }
 243
 244         /**
 245          * Checks whether this update conflicts with another update performed between the client
 246          * loading data to prepare an edit, and the client committing the edit. This is intended to
 247          * detect user level "edit conflict" when the latest revision known to the client
 248          * is no longer the current revision when processing the update.
 249          *
 250          * An update expected to create a new page can be checked by setting $expectedParentRevision = 0.
 251          * Such an update is considered to have a conflict if a current revision exists (that is,
 252          * the page was created since the edit was initiated on the client).
 253          *
 254          * This method returning true indicates to calling code that edit conflict resolution should
 255          * be applied before saving any data. It does not prevent the update from being performed, and
 256          * it should not be confused with a "late" conflict indicated by the "edit-conflict" status.
 257          * A "late" conflict is a CAS failure caused by an update being performed concurrently between
 258          * the time grabParentRevision() was called and the time saveRevision() trying to insert the
 259          * new revision.
 260          *
 261          * @note A user level edit conflict is not the same as the "edit-conflict" status triggered by
 262          * a CAS failure. Calling this method establishes the CAS token, it does not check against it:
 263          * This method calls grabParentRevision(), and thus causes the expected parent revision
 264          * for the update to be fixed to the page's current revision at this point in time.
 265          * It acts as a compare-and-swap (CAS) token in that it is guaranteed that saveRevision()
 266          * will fail with the "edit-conflict" status if the current revision of the page changes after
 267          * hasEditConflict() (or grabParentRevision()) was called and before saveRevision() could insert
 268          * a new revision.
 269          *
 270          * @see grabParentRevision()
 271          *
 272          * @param int $expectedParentRevision The ID of the revision the client expects to be the
 273          *        current one. Use 0 to indicate that the page is expected to not yet exist.
 274          *
 275          * @return bool
 276          */
 277         public function hasEditConflict( $expectedParentRevision ) {
 278                 $parent = $this->grabParentRevision();
 279                 $parentId = $parent ? $parent->getId() : 0;
 280
 281                 return $parentId !== $expectedParentRevision;
 282         }
 283
 284         /**
 285          * Returns the revision that was the page's current revision when grabParentRevision()
 286          * was first called. This revision is the expected parent revision of the update, and will be
 287          * recorded as the new revision's parent revision (unless no new revision is created because
 288          * the content was not changed).
 289          *
 290          * This method MUST not be called after saveRevision() was called!
 291          *
 292          * The current revision determined by the first call to this methods effectively acts a
 293          * compare-and-swap (CAS) token which is checked by saveRevision(), which fails if any
 294          * concurrent updates created a new revision.
 295          *
 296          * Application code should call this method before applying transformations to the new
 297          * content that depend on the parent revision, e.g. adding/replacing sections, or resolving
 298          * conflicts via a 3-way merge. This protects against race conditions triggered by concurrent
 299          * updates.
 300          *
 301          * @see DerivedPageDataUpdater::grabCurrentRevision()
 302          *
 303          * @note The expected parent revision is not to be confused with the logical base revision.
 304          * The base revision is specified by the client, the parent revision is determined from the
 305          * database. If base revision and parent revision are not the same, the updates is considered
 306          * to require edit conflict resolution.
 307          *
 308          * @throws LogicException if called after saveRevision().
 309          * @return RevisionRecord|null the parent revision, or null of the page does not yet exist.
 310          */
 311         public function grabParentRevision() {
 312                 return $this->derivedDataUpdater->grabCurrentRevision();
 313         }
 314
 315         /**
 316          * @return string
 317          */
 318         private function getTimestampNow() {
 319                 // TODO: allow an override to be injected for testing
 320                 return wfTimestampNow();
 321         }
 322
 323         /**
 324          * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
 325          *
 326          * @param int $flags
 327          * @return int Updated $flags
 328          */
 329         private function checkFlags( $flags ) {
 330                 if ( !( $flags & EDIT_NEW ) && !( $flags & EDIT_UPDATE ) ) {
 331                         $flags |= ( $this->derivedDataUpdater->pageExisted() ) ? EDIT_UPDATE : EDIT_NEW;
 332                 }
 333
 334                 return $flags;
 335         }
 336
 337         /**
 338          * Set the new content for the given slot role
 339          *
 340          * @param string $role A slot role name (such as "main")
 341          * @param Content $content
 342          */
 343         public function setContent( $role, Content $content ) {
 344                 // TODO: MCR: check the role and the content's model against the list of supported
 345                 // roles, see T194046.
 346
 347                 if ( $role !== 'main' ) {
 348                         throw new InvalidArgumentException( 'Only the main slot is presently supported' );
 349                 }
 350
 351                 $this->slotsUpdate->modifyContent( $role, $content );
 352         }
 353
 354         /**
 355          * Explicitly inherit a slot from some earlier revision.
 356          *
 357          * The primary use case for this is rollbacks, when slots are to be inherited from
 358          * the rollback target, overriding the content from the parent revision (which is the
 359          * revision being rolled back).
 360          *
 361          * This should typically not be used to inherit slots from the parent revision, which
 362          * happens implicitly. Using this method causes the given slot to be treated as "modified"
 363          * during revision creation, even if it has the same content as in the parent revision.
 364          *
 365          * @param SlotRecord $originalSlot A slot already existing in the database, to be inherited
 366          *        by the new revision.
 367          */
 368         public function inheritSlot( SlotRecord $originalSlot ) {
 369                 // NOTE: this slot is inherited from some other revision, but it's
 370                 // a "modified" slot for the RevisionSlotsUpdate and DerivedPageDataUpdater,
 371                 // since it's not implicitly inherited from the parent revision.
 372                 $inheritedSlot = SlotRecord::newInherited( $originalSlot );
 373                 $this->slotsUpdate->modifySlot( $inheritedSlot );
 374         }
 375
 376         /**
 377          * Removes the slot with the given role.
 378          *
 379          * This discontinues the "stream" of slots with this role on the page,
 380          * preventing the new revision, and any subsequent revisions, from
 381          * inheriting the slot with this role.
 382          *
 383          * @param string $role A slot role name (but not "main")
 384          */
 385         public function removeSlot( $role ) {
 386                 if ( $role === 'main' ) {
 387                         throw new InvalidArgumentException( 'Cannot remove the main slot!' );
 388                 }
 389
 390                 $this->slotsUpdate->removeSlot( $role );
 391         }
 392
 393         /**
 394          * Returns the ID of an earlier revision that is being repeated or restored by this update.
 395          *
 396          * @return bool|int The original revision id, or false if no earlier revision is known to be
 397          * repeated or restored by this update.
 398          */
 399         public function getOriginalRevisionId() {
 400                 return $this->originalRevId;
 401         }
 402
 403         /**
 404          * Sets the ID of an earlier revision that is being repeated or restored by this update.
 405          * The new revision is expected to have the exact same content as the given original revision.
 406          * This is used with rollbacks and with dummy "null" revisions which are created to record
 407          * things like page moves.
 408          *
 409          * This value is passed to the PageContentSaveComplete and NewRevisionFromEditComplete hooks.
 410          *
 411          * @param int|bool $originalRevId The original revision id, or false if no earlier revision
 412          * is known to be repeated or restored by this update.
 413          */
 414         public function setOriginalRevisionId( $originalRevId ) {
 415                 Assert::parameterType( 'integer|boolean', $originalRevId, '$originalRevId' );
 416                 $this->originalRevId = $originalRevId;
 417         }
 418
 419         /**
 420          * Returns the revision ID set by setUndidRevisionId(), indicating what revision is being
 421          * undone by this edit.
 422          *
 423          * @return int
 424          */
 425         public function getUndidRevisionId() {
 426                 return $this->undidRevId;
 427         }
 428
 429         /**
 430          * Sets the ID of revision that was undone by the present update.
 431          * This is used with the "undo" action, and is expected to hold the oldest revision ID
 432          * in case more then one revision is being undone.
 433          *
 434          * @param int $undidRevId
 435          */
 436         public function setUndidRevisionId( $undidRevId ) {
 437                 Assert::parameterType( 'integer', $undidRevId, '$undidRevId' );
 438                 $this->undidRevId = $undidRevId;
 439         }
 440
 441         /**
 442          * Sets a tag to apply to this update.
 443          * Callers are responsible for permission checks,
 444          * using ChangeTags::canAddTagsAccompanyingChange.
 445          * @param string $tag
 446          */
 447         public function addTag( $tag ) {
 448                 Assert::parameterType( 'string', $tag, '$tag' );
 449                 $this->tags[] = trim( $tag );
 450         }
 451
 452         /**
 453          * Sets tags to apply to this update.
 454          * Callers are responsible for permission checks,
 455          * using ChangeTags::canAddTagsAccompanyingChange.
 456          * @param string[] $tags
 457          */
 458         public function addTags( array $tags ) {
 459                 Assert::parameterElementType( 'string', $tags, '$tags' );
 460                 foreach ( $tags as $tag ) {
 461                         $this->addTag( $tag );
 462                 }
 463         }
 464
 465         /**
 466          * Returns the list of tags set using the addTag() method.
 467          *
 468          * @return string[]
 469          */
 470         public function getExplicitTags() {
 471                 return $this->tags;
 472         }
 473
 474         /**
 475          * @param int $flags Bit mask: a bit mask of EDIT_XXX flags.
 476          * @return string[]
 477          */
 478         private function computeEffectiveTags( $flags ) {
 479                 $tags = $this->tags;
 480
 481                 foreach ( $this->slotsUpdate->getModifiedRoles() as $role ) {
 482                         $old_content = $this->getParentContent( $role );
 483
 484                         $handler = $this->getContentHandler( $role );
 485                         $content = $this->slotsUpdate->getModifiedSlot( $role )->getContent();
 486
 487                         // TODO: MCR: Do this for all slots. Also add tags for removing roles!
 488                         $tag = $handler->getChangeTag( $old_content, $content, $flags );
 489                         // If there is no applicable tag, null is returned, so we need to check
 490                         if ( $tag ) {
 491                                 $tags[] = $tag;
 492                         }
 493                 }
 494
 495                 // Check for undo tag
 496                 if ( $this->undidRevId !== 0 && in_array( 'mw-undo', ChangeTags::getSoftwareTags() ) ) {
 497                         $tags[] = 'mw-undo';
 498                 }
 499
 500                 return array_unique( $tags );
 501         }
 502
 503         /**
 504          * Returns the content of the given slot of the parent revision, with no audience checks applied.
 505          * If there is no parent revision or the slot is not defined, this returns null.
 506          *
 507          * @param string $role slot role name
 508          * @return Content|null
 509          */
 510         private function getParentContent( $role ) {
 511                 $parent = $this->grabParentRevision();
 512
 513                 if ( $parent && $parent->hasSlot( $role ) ) {
 514                         return $parent->getContent( $role, RevisionRecord::RAW );
 515                 }
 516
 517                 return null;
 518         }
 519
 520         /**
 521          * @param string $role slot role name
 522          * @return ContentHandler
 523          */
 524         private function getContentHandler( $role ) {
 525                 // TODO: inject something like a ContentHandlerRegistry
 526                 if ( $this->slotsUpdate->isModifiedSlot( $role ) ) {
 527                         $slot = $this->slotsUpdate->getModifiedSlot( $role );
 528                 } else {
 529                         $parent = $this->grabParentRevision();
 530
 531                         if ( $parent ) {
 532                                 $slot = $parent->getSlot( $role, RevisionRecord::RAW );
 533                         } else {
 534                                 throw new RevisionAccessException( 'No such slot: ' . $role );
 535                         }
 536                 }
 537
 538                 return ContentHandler::getForModelID( $slot->getModel() );
 539         }
 540
 541         /**
 542          * @param int $flags Bit mask: a bit mask of EDIT_XXX flags.
 543          *
 544          * @return CommentStoreComment
 545          */
 546         private function makeAutoSummary( $flags ) {
 547                 if ( !$this->useAutomaticEditSummaries || ( $flags & EDIT_AUTOSUMMARY ) === 0 ) {
 548                         return CommentStoreComment::newUnsavedComment( '' );
 549                 }
 550
 551                 // NOTE: this generates an auto-summary for SOME RANDOM changed slot!
 552                 // TODO: combine auto-summaries for multiple slots!
 553                 // XXX: this logic should not be in the storage layer!
 554                 $roles = $this->slotsUpdate->getModifiedRoles();
 555                 $role = reset( $roles );
 556
 557                 if ( $role === false ) {
 558                         return CommentStoreComment::newUnsavedComment( '' );
 559                 }
 560
 561                 $handler = $this->getContentHandler( $role );
 562                 $content = $this->slotsUpdate->getModifiedSlot( $role )->getContent();
 563                 $old_content = $this->getParentContent( $role );
 564                 $summary = $handler->getAutosummary( $old_content, $content, $flags );
 565
 566                 return CommentStoreComment::newUnsavedComment( $summary );
 567         }
 568
 569         /**
 570          * Change an existing article or create a new article. Updates RC and all necessary caches,
 571          * optionally via the deferred update array. This does not check user permissions.
 572          *
 573          * It is guaranteed that saveRevision() will fail if the current revision of the page
 574          * changes after grabParentRevision() was called and before saveRevision() can insert
 575          * a new revision, as per the CAS mechanism described above.
 576          *
 577          * The caller is however responsible for calling hasEditConflict() to detect a
 578          * user-level edit conflict, and to adjust the content of the new revision accordingly,
 579          * e.g. by using a 3-way-merge.
 580          *
 581          * MCR migration note: this replaces WikiPage::doEditContent. Callers that change to using
 582          * saveRevision() now need to check the "minoredit" themselves before using EDIT_MINOR.
 583          *
 584          * @param CommentStoreComment $summary Edit summary
 585          * @param int $flags Bitfield:
 586          *      EDIT_NEW
 587          *          Create a new page, or fail with "edit-already-exists" if the page exists.
 588          *      EDIT_UPDATE
 589          *          Create a new revision, or fail with "edit-gone-missing" if the page does not exist.
 590          *      EDIT_MINOR
 591          *          Mark this revision as minor
 592          *      EDIT_SUPPRESS_RC
 593          *          Do not log the change in recentchanges
 594          *      EDIT_FORCE_BOT
 595          *          Mark the revision as automated ("bot edit")
 596          *      EDIT_AUTOSUMMARY
 597          *          Fill in blank summaries with generated text where possible
 598          *      EDIT_INTERNAL
 599          *          Signal that the page retrieve/save cycle happened entirely in this request.
 600          *
 601          * If neither EDIT_NEW nor EDIT_UPDATE is specified, the expected state is detected
 602          * automatically via grabParentRevision(). In this case, the "edit-already-exists" or
 603          * "edit-gone-missing" errors may still be triggered due to race conditions, if the page
 604          * was unexpectedly created or deleted while revision creation is in progress. This can be
 605          * viewed as part of the CAS mechanism described above.
 606          *
 607          * @return RevisionRecord|null The new revision, or null if no new revision was created due
 608          *         to a failure or a null-edit. Use isUnchanged(), wasSuccessful() and getStatus()
 609          *         to determine the outcome of the revision creation.
 610          *
 611          * @throws MWException
 612          * @throws RuntimeException
 613          */
 614         public function saveRevision( CommentStoreComment $summary, $flags = 0 ) {
 615                 // Defend against mistakes caused by differences with the
 616                 // signature of WikiPage::doEditContent.
 617                 Assert::parameterType( 'integer', $flags, '$flags' );
 618
 619                 if ( $this->wasCommitted() ) {
 620                         throw new RuntimeException( 'saveRevision() has already been called on this PageUpdater!' );
 621                 }
 622
 623                 // Low-level sanity check
 624                 if ( $this->getLinkTarget()->getText() === '' ) {
 625                         throw new RuntimeException( 'Something is trying to edit an article with an empty title' );
 626                 }
 627
 628                 // TODO: MCR: check the role and the content's model against the list of supported
 629                 // and required roles, see T194046.
 630
 631                 // Make sure the given content type is allowed for this page
 632                 // TODO: decide: Extend check to other slots? Consider the role in check? [PageType]
 633                 $mainContentHandler = $this->getContentHandler( 'main' );
 634                 if ( !$mainContentHandler->canBeUsedOn( $this->getTitle() ) ) {
 635                         $this->status = Status::newFatal( 'content-not-allowed-here',
 636                                 ContentHandler::getLocalizedName( $mainContentHandler->getModelID() ),
 637                                 $this->getTitle()->getPrefixedText()
 638                         );
 639                         return null;
 640                 }
 641
 642                 // Load the data from the master database if needed. Needed to check flags.
 643                 // NOTE: This grabs the parent revision as the CAS token, if grabParentRevision
 644                 // wasn't called yet. If the page is modified by another process before we are done with
 645                 // it, this method must fail (with status 'edit-conflict')!
 646                 // NOTE: The parent revision may be different from $this->originalRevisionId.
 647                 $this->grabParentRevision();
 648                 $flags = $this->checkFlags( $flags );
 649
 650                 // Avoid statsd noise and wasted cycles check the edit stash (T136678)
 651                 if ( ( $flags & EDIT_INTERNAL ) || ( $flags & EDIT_FORCE_BOT ) ) {
 652                         $useStashed = false;
 653                 } else {
 654                         $useStashed = $this->ajaxEditStash;
 655                 }
 656
 657                 // TODO: use this only for the legacy hook, and only if something uses the legacy hook
 658                 $wikiPage = $this->getWikiPage();
 659
 660                 $user = $this->user;
 661
 662                 // Prepare the update. This performs PST and generates the canonical ParserOutput.
 663                 $this->derivedDataUpdater->prepareContent(
 664                         $this->user,
 665                         $this->slotsUpdate,
 666                         $useStashed
 667                 );
 668
 669                 // TODO: don't force initialization here!
 670                 // This is a hack to work around the fact that late initialization of the ParserOutput
 671                 // causes ApiFlowEditHeaderTest::testCache to fail. Whether that failure indicates an
 672                 // actual problem, or is just an issue with the test setup, remains to be determined
 673                 // [dk, 2018-03].
 674                 // Anomie said in 2018-03:
 675                 /*
 676                         I suspect that what's breaking is this:
 677
 678                         The old version of WikiPage::doEditContent() called prepareContentForEdit() which
 679                         generated the ParserOutput right then, so when doEditUpdates() gets called from the
 680                         DeferredUpdate scheduled by WikiPage::doCreate() there's no need to parse. I note
 681                         there's a comment there that says "Get the pre-save transform content and final
 682                         parser output".
 683                         The new version of WikiPage::doEditContent() makes a PageUpdater and calls its
 684                         saveRevision(), which calls DerivedPageDataUpdater::prepareContent() and
 685                         PageUpdater::doCreate() without ever having to actually generate a ParserOutput.
 686                         Thus, when DerivedPageDataUpdater::doUpdates() is called from the DeferredUpdate
 687                         scheduled by PageUpdater::doCreate(), it does find that it needs to parse at that point.
 688
 689                         And the order of operations in that Flow test is presumably:
 690
 691                         - Create a page with a call to WikiPage::doEditContent(), in a way that somehow avoids
 692                         processing the DeferredUpdate.
 693                         - Set up the "no set!" mock cache in Flow\Tests\Api\ApiTestCase::expectCacheInvalidate()
 694                         - Then, during the course of doing that test, a $db->commit() results in the
 695                         DeferredUpdates being run.
 696                  */
 697                 $this->derivedDataUpdater->getCanonicalParserOutput();
 698
 699                 $mainContent = $this->derivedDataUpdater->getSlots()->getContent( 'main' );
 700
 701                 // Trigger pre-save hook (using provided edit summary)
 702                 $hookStatus = Status::newGood( [] );
 703                 // TODO: replace legacy hook!
 704                 // TODO: avoid pass-by-reference, see T193950
 705                 $hook_args = [ &$wikiPage, &$user, &$mainContent, &$summary,
 706                         $flags & EDIT_MINOR, null, null, &$flags, &$hookStatus ];
 707                 // Check if the hook rejected the attempted save
 708                 if ( !Hooks::run( 'PageContentSave', $hook_args ) ) {
 709                         if ( $hookStatus->isOK() ) {
 710                                 // Hook returned false but didn't call fatal(); use generic message
 711                                 $hookStatus->fatal( 'edit-hook-aborted' );
 712                         }
 713
 714                         $this->status = $hookStatus;
 715                         return null;
 716                 }
 717
 718                 // Provide autosummaries if one is not provided and autosummaries are enabled
 719                 // XXX: $summary == null seems logical, but the empty string may actually come from the user
 720                 // XXX: Move this logic out of the storage layer! It does not belong here! Use a callback?
 721                 if ( $summary->text === '' && $summary->data === null ) {
 722                         $summary = $this->makeAutoSummary( $flags );
 723                 }
 724
 725                 // Actually create the revision and create/update the page.
 726                 // Do NOT yet set $this->status!
 727                 if ( $flags & EDIT_UPDATE ) {
 728                         $status = $this->doModify( $summary, $this->user, $flags );
 729                 } else {
 730                         $status = $this->doCreate( $summary, $this->user, $flags );
 731                 }
 732
 733                 // Promote user to any groups they meet the criteria for
 734                 DeferredUpdates::addCallableUpdate( function () use ( $user ) {
 735                         $user->addAutopromoteOnceGroups( 'onEdit' );
 736                         $user->addAutopromoteOnceGroups( 'onView' ); // b/c
 737                 } );
 738
 739                 // NOTE: set $this->status only after all hooks have been called,
 740                 // so wasCommitted doesn't return true wehn called indirectly from a hook handler!
 741                 $this->status = $status;
 742
 743                 // TODO: replace bad status with Exceptions!
 744                 return ( $this->status && $this->status->isOK() )
 745                         ? $this->status->value['revision-record']
 746                         : null;
 747         }
 748
 749         /**
 750          * Whether saveRevision() has been called on this instance
 751          *
 752          * @return bool
 753          */
 754         public function wasCommitted() {
 755                 return $this->status !== null;
 756         }
 757
 758         /**
 759          * The Status object indicating whether saveRevision() was successful, or null if
 760          * saveRevision() was not yet called on this instance.
 761          *
 762          * @note This is here for compatibility with WikiPage::doEditContent. It may be deprecated
 763          * soon.
 764          *
 765          * Possible status errors:
 766          *     edit-hook-aborted: The ArticleSave hook aborted the update but didn't
 767          *       set the fatal flag of $status.
 768          *     edit-gone-missing: In update mode, but the article didn't exist.
 769          *     edit-conflict: In update mode, the article changed unexpectedly.
 770          *     edit-no-change: Warning that the text was the same as before.
 771          *     edit-already-exists: In creation mode, but the article already exists.
 772          *
 773          *  Extensions may define additional errors.
 774          *
 775          *  $return->value will contain an associative array with members as follows:
 776          *     new: Boolean indicating if the function attempted to create a new article.
 777          *     revision: The revision object for the inserted revision, or null.
 778          *
 779          * @return null|Status
 780          */
 781         public function getStatus() {
 782                 return $this->status;
 783         }
 784
 785         /**
 786          * Whether saveRevision() completed successfully
 787          *
 788          * @return bool
 789          */
 790         public function wasSuccessful() {
 791                 return $this->status && $this->status->isOK();
 792         }
 793
 794         /**
 795          * Whether saveRevision() was called and created a new page.
 796          *
 797          * @return bool
 798          */
 799         public function isNew() {
 800                 return $this->status && $this->status->isOK() && $this->status->value['new'];
 801         }
 802
 803         /**
 804          * Whether saveRevision() did not create a revision because the content didn't change
 805          * (null-edit). Whether the content changed or not is determined by
 806          * DerivedPageDataUpdater::isChange().
 807          *
 808          * @return bool
 809          */
 810         public function isUnchanged() {
 811                 return $this->status
 812                         && $this->status->isOK()
 813                         && $this->status->value['revision-record'] === null;
 814         }
 815
 816         /**
 817          * The new revision created by saveRevision(), or null if saveRevision() has not yet been
 818          * called, failed, or did not create a new revision because the content did not change.
 819          *
 820          * @return RevisionRecord|null
 821          */
 822         public function getNewRevision() {
 823                 return ( $this->status && $this->status->isOK() )
 824                         ? $this->status->value['revision-record']
 825                         : null;
 826         }
 827
 828         /**
 829          * Constructs a MutableRevisionRecord based on the Content prepared by the
 830          * DerivedPageDataUpdater. This takes care of inheriting slots, updating slots
 831          * with PST applied, and removing discontinued slots.
 832          *
 833          * This calls Content::prepareSave() to verify that the slot content can be saved.
 834          * The $status parameter is updated with any errors or warnings found by Content::prepareSave().
 835          *
 836          * @param CommentStoreComment $comment
 837          * @param User $user
 838          * @param string $timestamp
 839          * @param int $flags
 840          * @param Status $status
 841          *
 842          * @return MutableRevisionRecord
 843          */
 844         private function makeNewRevision(
 845                 CommentStoreComment $comment,
 846                 User $user,
 847                 $timestamp,
 848                 $flags,
 849                 Status $status
 850         ) {
 851                 $wikiPage = $this->getWikiPage();
 852                 $title = $this->getTitle();
 853                 $parent = $this->grabParentRevision();
 854
 855                 $rev = new MutableRevisionRecord( $title, $this->getWikiId() );
 856                 $rev->setPageId( $title->getArticleID() );
 857
 858                 if ( $parent ) {
 859                         $oldid = $parent->getId();
 860                         $rev->setParentId( $oldid );
 861                 } else {
 862                         $oldid = 0;
 863                 }
 864
 865                 $rev->setComment( $comment );
 866                 $rev->setUser( $user );
 867                 $rev->setTimestamp( $timestamp );
 868                 $rev->setMinorEdit( ( $flags & EDIT_MINOR ) > 0 );
 869
 870                 foreach ( $this->derivedDataUpdater->getSlots()->getSlots() as $slot ) {
 871                         $content = $slot->getContent();
 872
 873                         // XXX: We may push this up to the "edit controller" level, see T192777.
 874                         // TODO: change the signature of PrepareSave to not take a WikiPage!
 875                         $prepStatus = $content->prepareSave( $wikiPage, $flags, $oldid, $user );
 876
 877                         if ( $prepStatus->isOK() ) {
 878                                 $rev->setSlot( $slot );
 879                         }
 880
 881                         // TODO: MCR: record which problem arose in which slot.
 882                         $status->merge( $prepStatus );
 883                 }
 884
 885                 return $rev;
 886         }
 887
 888         /**
 889          * @param CommentStoreComment $summary The edit summary
 890          * @param User $user The revision's author
 891          * @param int $flags EXIT_XXX constants
 892          *
 893          * @throws MWException
 894          * @return Status
 895          */
 896         private function doModify( CommentStoreComment $summary, User $user, $flags ) {
 897                 $wikiPage = $this->getWikiPage(); // TODO: use for legacy hooks only!
 898
 899                 // Update article, but only if changed.
 900                 $status = Status::newGood( [ 'new' => false, 'revision' => null, 'revision-record' => null ] );
 901
 902                 // Convenience variables
 903                 $now = $this->getTimestampNow();
 904
 905                 $oldRev = $this->grabParentRevision();
 906                 $oldid = $oldRev ? $oldRev->getId() : 0;
 907
 908                 if ( !$oldRev ) {
 909                         // Article gone missing
 910                         $status->fatal( 'edit-gone-missing' );
 911
 912                         return $status;
 913                 }
 914
 915                 $newRevisionRecord = $this->makeNewRevision(
 916                         $summary,
 917                         $user,
 918                         $now,
 919                         $flags,
 920                         $status
 921                 );
 922
 923                 if ( !$status->isOK() ) {
 924                         return $status;
 925                 }
 926
 927                 // XXX: we may want a flag that allows a null revision to be forced!
 928                 $changed = $this->derivedDataUpdater->isChange();
 929
 930                 $dbw = $this->getDBConnectionRef( DB_MASTER );
 931
 932                 if ( $changed ) {
 933                         $dbw->startAtomic( __METHOD__ );
 934
 935                         // Get the latest page_latest value while locking it.
 936                         // Do a CAS style check to see if it's the same as when this method
 937                         // started. If it changed then bail out before touching the DB.
 938                         $latestNow = $wikiPage->lockAndGetLatest(); // TODO: move to storage service, pass DB
 939                         if ( $latestNow != $oldid ) {
 940                                 // We don't need to roll back, since we did not modify the database yet.
 941                                 // XXX: Or do we want to rollback, any transaction started by calling
 942                                 // code will fail? If we want that, we should probably throw an exception.
 943                                 $dbw->endAtomic( __METHOD__ );
 944                                 // Page updated or deleted in the mean time
 945                                 $status->fatal( 'edit-conflict' );
 946
 947                                 return $status;
 948                         }
 949
 950                         // At this point we are now comitted to returning an OK
 951                         // status unless some DB query error or other exception comes up.
 952                         // This way callers don't have to call rollback() if $status is bad
 953                         // unless they actually try to catch exceptions (which is rare).
 954
 955                         // Save revision content and meta-data
 956                         $newRevisionRecord = $this->revisionStore->insertRevisionOn( $newRevisionRecord, $dbw );
 957                         $newLegacyRevision = new Revision( $newRevisionRecord );
 958
 959                         // Update page_latest and friends to reflect the new revision
 960                         // TODO: move to storage service
 961                         $wasRedirect = $this->derivedDataUpdater->wasRedirect();
 962                         if ( !$wikiPage->updateRevisionOn( $dbw, $newLegacyRevision, null, $wasRedirect ) ) {
 963                                 throw new PageUpdateException( "Failed to update page row to use new revision." );
 964                         }
 965
 966                         // TODO: replace legacy hook!
 967                         $tags = $this->computeEffectiveTags( $flags );
 968                         Hooks::run(
 969                                 'NewRevisionFromEditComplete',
 970                                 [ $wikiPage, $newLegacyRevision, $this->getOriginalRevisionId(), $user, &$tags ]
 971                         );
 972
 973                         // Update recentchanges
 974                         if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
 975                                 // Add RC row to the DB
 976                                 RecentChange::notifyEdit(
 977                                         $now,
 978                                         $this->getTitle(),
 979                                         $newRevisionRecord->isMinor(),
 980                                         $user,
 981                                         $summary->text, // TODO: pass object when that becomes possible
 982                                         $oldid,
 983                                         $newRevisionRecord->getTimestamp(),
 984                                         ( $flags & EDIT_FORCE_BOT ) > 0,
 985                                         '',
 986                                         $oldRev->getSize(),
 987                                         $newRevisionRecord->getSize(),
 988                                         $newRevisionRecord->getId(),
 989                                         $this->rcPatrolStatus,
 990                                         $tags
 991                                 );
 992                         }
 993
 994                         $user->incEditCount();
 995
 996                         $dbw->endAtomic( __METHOD__ );
 997
 998                         // Return the new revision to the caller
 999                         $status->value['revision-record'] = $newRevisionRecord;
1000
1001                         // TODO: globally replace usages of 'revision' with getNewRevision()
1002                         $status->value['revision'] = $newLegacyRevision;
1003                 } else {
1004                         // T34948: revision ID must be set to page {{REVISIONID}} and
1005                         // related variables correctly. Likewise for {{REVISIONUSER}} (T135261).
1006                         // Since we don't insert a new revision into the database, the least
1007                         // error-prone way is to reuse given old revision.
1008                         $newRevisionRecord = $oldRev;
1009
1010                         $status->warning( 'edit-no-change' );
1011                         // Update page_touched as updateRevisionOn() was not called.
1012                         // Other cache updates are managed in WikiPage::onArticleEdit()
1013                         // via WikiPage::doEditUpdates().
1014                         $this->getTitle()->invalidateCache( $now );
1015                 }
1016
1017                 // Do secondary updates once the main changes have been committed...
1018                 // NOTE: the updates have to be processed before sending the response to the client
1019                 // (DeferredUpdates::PRESEND), otherwise the client may already be following the
1020                 // HTTP redirect to the standard view before dervide data has been created - most
1021                 // importantly, before the parser cache has been updated. This would cause the
1022                 // content to be parsed a second time, or may cause stale content to be shown.
1023                 DeferredUpdates::addUpdate(
1024                         $this->getAtomicSectionUpdate(
1025                                 $dbw,
1026                                 $wikiPage,
1027                                 $newRevisionRecord,
1028                                 $user,
1029                                 $summary,
1030                                 $flags,
1031                                 $status,
1032                                 [ 'changed' => $changed, ]
1033                         ),
1034                         DeferredUpdates::PRESEND
1035                 );
1036
1037                 return $status;
1038         }
1039
1040         /**
1041          * @param CommentStoreComment $summary The edit summary
1042          * @param User $user The revision's author
1043          * @param int $flags EXIT_XXX constants
1044          *
1045          * @throws DBUnexpectedError
1046          * @throws MWException
1047          * @return Status
1048          */
1049         private function doCreate( CommentStoreComment $summary, User $user, $flags ) {
1050                 $wikiPage = $this->getWikiPage(); // TODO: use for legacy hooks only!
1051
1052                 if ( !$this->derivedDataUpdater->getSlots()->hasSlot( 'main' ) ) {
1053                         throw new PageUpdateException( 'Must provide a main slot when creating a page!' );
1054                 }
1055
1056                 $status = Status::newGood( [ 'new' => true, 'revision' => null, 'revision-record' => null ] );
1057
1058                 $now = $this->getTimestampNow();
1059
1060                 $newRevisionRecord = $this->makeNewRevision(
1061                         $summary,
1062                         $user,
1063                         $now,
1064                         $flags,
1065                         $status
1066                 );
1067
1068                 if ( !$status->isOK() ) {
1069                         return $status;
1070                 }
1071
1072                 $dbw = $this->getDBConnectionRef( DB_MASTER );
1073                 $dbw->startAtomic( __METHOD__ );
1074
1075                 // Add the page record unless one already exists for the title
1076                 // TODO: move to storage service
1077                 $newid = $wikiPage->insertOn( $dbw );
1078                 if ( $newid === false ) {
1079                         $dbw->endAtomic( __METHOD__ ); // nothing inserted
1080                         $status->fatal( 'edit-already-exists' );
1081
1082                         return $status; // nothing done
1083                 }
1084
1085                 // At this point we are now comitted to returning an OK
1086                 // status unless some DB query error or other exception comes up.
1087                 // This way callers don't have to call rollback() if $status is bad
1088                 // unless they actually try to catch exceptions (which is rare).
1089                 $newRevisionRecord->setPageId( $newid );
1090
1091                 // Save the revision text...
1092                 $newRevisionRecord = $this->revisionStore->insertRevisionOn( $newRevisionRecord, $dbw );
1093                 $newLegacyRevision = new Revision( $newRevisionRecord );
1094
1095                 // Update the page record with revision data
1096                 // TODO: move to storage service
1097                 if ( !$wikiPage->updateRevisionOn( $dbw, $newLegacyRevision, 0 ) ) {
1098                         throw new PageUpdateException( "Failed to update page row to use new revision." );
1099                 }
1100
1101                 // TODO: replace legacy hook!
1102                 $tags = $this->computeEffectiveTags( $flags );
1103                 Hooks::run(
1104                         'NewRevisionFromEditComplete',
1105                         [ $wikiPage, $newLegacyRevision, false, $user, &$tags ]
1106                 );
1107
1108                 // Update recentchanges
1109                 if ( !( $flags & EDIT_SUPPRESS_RC ) ) {
1110                         // Add RC row to the DB
1111                         RecentChange::notifyNew(
1112                                 $now,
1113                                 $this->getTitle(),
1114                                 $newRevisionRecord->isMinor(),
1115                                 $user,
1116                                 $summary->text, // TODO: pass object when that becomes possible
1117                                 ( $flags & EDIT_FORCE_BOT ) > 0,
1118                                 '',
1119                                 $newRevisionRecord->getSize(),
1120                                 $newRevisionRecord->getId(),
1121                                 $this->rcPatrolStatus,
1122                                 $tags
1123                         );
1124                 }
1125
1126                 $user->incEditCount();
1127
1128                 if ( $this->usePageCreationLog ) {
1129                         // Log the page creation
1130                         // @TODO: Do we want a 'recreate' action?
1131                         $logEntry = new ManualLogEntry( 'create', 'create' );
1132                         $logEntry->setPerformer( $user );
1133                         $logEntry->setTarget( $this->getTitle() );
1134                         $logEntry->setComment( $summary->text );
1135                         $logEntry->setTimestamp( $now );
1136                         $logEntry->setAssociatedRevId( $newRevisionRecord->getId() );
1137                         $logEntry->insert();
1138                         // Note that we don't publish page creation events to recentchanges
1139                         // (i.e. $logEntry->publish()) since this would create duplicate entries,
1140                         // one for the edit and one for the page creation.
1141                 }
1142
1143                 $dbw->endAtomic( __METHOD__ );
1144
1145                 // Return the new revision to the caller
1146                 // TODO: globally replace usages of 'revision' with getNewRevision()
1147                 $status->value['revision'] = $newLegacyRevision;
1148                 $status->value['revision-record'] = $newRevisionRecord;
1149
1150                 // Do secondary updates once the main changes have been committed...
1151                 DeferredUpdates::addUpdate(
1152                         $this->getAtomicSectionUpdate(
1153                                 $dbw,
1154                                 $wikiPage,
1155                                 $newRevisionRecord,
1156                                 $user,
1157                                 $summary,
1158                                 $flags,
1159                                 $status,
1160                                 [ 'created' => true ]
1161                         ),
1162                         DeferredUpdates::PRESEND
1163                 );
1164
1165                 return $status;
1166         }
1167
1168         private function getAtomicSectionUpdate(
1169                 IDatabase $dbw,
1170                 WikiPage $wikiPage,
1171                 RevisionRecord $newRevisionRecord,
1172                 User $user,
1173                 CommentStoreComment $summary,
1174                 $flags,
1175                 Status $status,
1176                 $hints = []
1177         ) {
1178                 return new AtomicSectionUpdate(
1179                         $dbw,
1180                         __METHOD__,
1181                         function () use (
1182                                 $wikiPage, $newRevisionRecord, $user,
1183                                 $summary, $flags, $status, $hints
1184                         ) {
1185                                 $newLegacyRevision = new Revision( $newRevisionRecord );
1186                                 $mainContent = $newRevisionRecord->getContent( 'main', RevisionRecord::RAW );
1187
1188                                 // Update links tables, site stats, etc.
1189                                 $this->derivedDataUpdater->prepareUpdate( $newRevisionRecord, $hints );
1190                                 $this->derivedDataUpdater->doUpdates();
1191
1192                                 // TODO: replace legacy hook!
1193                                 // TODO: avoid pass-by-reference, see T193950
1194
1195                                 if ( $hints['created'] ?? false ) {
1196                                         // Trigger post-create hook
1197                                         $params = [ &$wikiPage, &$user, $mainContent, $summary->text,
1198                                                 $flags & EDIT_MINOR, null, null, &$flags, $newLegacyRevision ];
1199                                         Hooks::run( 'PageContentInsertComplete', $params );
1200                                 }
1201
1202                                 // Trigger post-save hook
1203                                 $params = [ &$wikiPage, &$user, $mainContent, $summary->text,
1204                                                 $flags & EDIT_MINOR, null, null, &$flags, $newLegacyRevision,
1205                                                 &$status, $this->getOriginalRevisionId(), $this->undidRevId ];
1206                                 Hooks::run( 'PageContentSaveComplete', $params );
1207                         }
1208                 );
1209         }
1210
1211 }