3 * Controller-like object for creating and updating pages by creating new revisions.
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.
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.
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
22 * @author Daniel Kinzler
25 namespace MediaWiki\Storage
;
27 use AtomicSectionUpdate
;
29 use CommentStoreComment
;
34 use InvalidArgumentException
;
37 use MediaWiki\Linker\LinkTarget
;
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
;
53 * Controller-like object for creating and updating pages by creating new revisions.
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
60 * @see docs/pageupdater.txt for more information.
62 * MCR migration note: this replaces the relevant methods in WikiPage.
80 * @var DerivedPageDataUpdater
82 private $derivedDataUpdater;
87 private $loadBalancer;
92 private $revisionStore;
95 * @var boolean see $wgUseAutomaticEditSummaries
96 * @see $wgUseAutomaticEditSummaries
98 private $useAutomaticEditSummaries = true;
101 * @var int the RC patrol status the new revision should be marked with.
103 private $rcPatrolStatus = RecentChange
::PRC_UNPATROLLED
;
106 * @var bool whether to create a log entry for new page creations.
108 private $usePageCreationLog = true;
111 * @var boolean see $wgAjaxEditStash
113 private $ajaxEditStash = true;
118 private $originalRevId = false;
128 private $undidRevId = 0;
131 * @var RevisionSlotsUpdate
133 private $slotsUpdate;
138 private $status = null;
142 * @param WikiPage $wikiPage
143 * @param DerivedPageDataUpdater $derivedDataUpdater
144 * @param LoadBalancer $loadBalancer
145 * @param RevisionStore $revisionStore
147 public function __construct(
150 DerivedPageDataUpdater
$derivedDataUpdater,
151 LoadBalancer
$loadBalancer,
152 RevisionStore
$revisionStore
155 $this->wikiPage
= $wikiPage;
156 $this->derivedDataUpdater
= $derivedDataUpdater;
158 $this->loadBalancer
= $loadBalancer;
159 $this->revisionStore
= $revisionStore;
161 $this->slotsUpdate
= new RevisionSlotsUpdate();
165 * Can be used to enable or disable automatic summaries that are applied to certain kinds of
166 * changes, like completely blanking a page.
168 * @param bool $useAutomaticEditSummaries
169 * @see $wgUseAutomaticEditSummaries
171 public function setUseAutomaticEditSummaries( $useAutomaticEditSummaries ) {
172 $this->useAutomaticEditSummaries
= $useAutomaticEditSummaries;
176 * Sets the "patrolled" status of the edit.
177 * Callers should check the "patrol" and "autopatrol" permissions as appropriate.
179 * @see $wgUseRCPatrol
180 * @see $wgUseNPPatrol
182 * @param int $status RC patrol status, e.g. RecentChange::PRC_AUTOPATROLLED.
184 public function setRcPatrolStatus( $status ) {
185 $this->rcPatrolStatus
= $status;
189 * Whether to create a log entry for new page creations.
191 * @see $wgPageCreationLog
195 public function setUsePageCreationLog( $use ) {
196 $this->usePageCreationLog
= $use;
200 * @param bool $ajaxEditStash
201 * @see $wgAjaxEditStash
203 public function setAjaxEditStash( $ajaxEditStash ) {
204 $this->ajaxEditStash
= $ajaxEditStash;
207 private function getWikiId() {
208 return false; // TODO: get from RevisionStore!
212 * @param int $mode DB_MASTER or DB_REPLICA
216 private function getDBConnectionRef( $mode ) {
217 return $this->loadBalancer
->getConnectionRef( $mode, [], $this->getWikiId() );
223 private function getLinkTarget() {
224 // NOTE: eventually, we won't get a WikiPage passed into the constructor any more
225 return $this->wikiPage
->getTitle();
231 private function getTitle() {
232 // NOTE: eventually, we won't get a WikiPage passed into the constructor any more
233 return $this->wikiPage
->getTitle();
239 private function getWikiPage() {
240 // NOTE: eventually, we won't get a WikiPage passed into the constructor any more
241 return $this->wikiPage
;
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.
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).
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
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
270 * @see grabParentRevision()
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.
277 public function hasEditConflict( $expectedParentRevision ) {
278 $parent = $this->grabParentRevision();
279 $parentId = $parent ?
$parent->getId() : 0;
281 return $parentId !== $expectedParentRevision;
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).
290 * This method MUST not be called after saveRevision() was called!
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.
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
301 * @see DerivedPageDataUpdater::grabCurrentRevision()
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.
308 * @throws LogicException if called after saveRevision().
309 * @return RevisionRecord|null the parent revision, or null of the page does not yet exist.
311 public function grabParentRevision() {
312 return $this->derivedDataUpdater
->grabCurrentRevision();
318 private function getTimestampNow() {
319 // TODO: allow an override to be injected for testing
320 return wfTimestampNow();
324 * Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
327 * @return int Updated $flags
329 private function checkFlags( $flags ) {
330 if ( !( $flags & EDIT_NEW
) && !( $flags & EDIT_UPDATE
) ) {
331 $flags |
= ( $this->derivedDataUpdater
->pageExisted() ) ? EDIT_UPDATE
: EDIT_NEW
;
338 * Set the new content for the given slot role
340 * @param string $role A slot role name (such as "main")
341 * @param Content $content
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.
347 $this->slotsUpdate
->modifyContent( $role, $content );
351 * Set the new slot for the given slot role
353 * @param SlotRecord $slot
355 public function setSlot( SlotRecord
$slot ) {
356 $this->slotsUpdate
->modifySlot( $slot );
360 * Explicitly inherit a slot from some earlier revision.
362 * The primary use case for this is rollbacks, when slots are to be inherited from
363 * the rollback target, overriding the content from the parent revision (which is the
364 * revision being rolled back).
366 * This should typically not be used to inherit slots from the parent revision, which
367 * happens implicitly. Using this method causes the given slot to be treated as "modified"
368 * during revision creation, even if it has the same content as in the parent revision.
370 * @param SlotRecord $originalSlot A slot already existing in the database, to be inherited
371 * by the new revision.
373 public function inheritSlot( SlotRecord
$originalSlot ) {
374 // NOTE: this slot is inherited from some other revision, but it's
375 // a "modified" slot for the RevisionSlotsUpdate and DerivedPageDataUpdater,
376 // since it's not implicitly inherited from the parent revision.
377 $inheritedSlot = SlotRecord
::newInherited( $originalSlot );
378 $this->slotsUpdate
->modifySlot( $inheritedSlot );
382 * Removes the slot with the given role.
384 * This discontinues the "stream" of slots with this role on the page,
385 * preventing the new revision, and any subsequent revisions, from
386 * inheriting the slot with this role.
388 * @param string $role A slot role name (but not "main")
390 public function removeSlot( $role ) {
391 if ( $role === 'main' ) {
392 throw new InvalidArgumentException( 'Cannot remove the main slot!' );
395 $this->slotsUpdate
->removeSlot( $role );
399 * Returns the ID of an earlier revision that is being repeated or restored by this update.
401 * @return bool|int The original revision id, or false if no earlier revision is known to be
402 * repeated or restored by this update.
404 public function getOriginalRevisionId() {
405 return $this->originalRevId
;
409 * Sets the ID of an earlier revision that is being repeated or restored by this update.
410 * The new revision is expected to have the exact same content as the given original revision.
411 * This is used with rollbacks and with dummy "null" revisions which are created to record
412 * things like page moves.
414 * This value is passed to the PageContentSaveComplete and NewRevisionFromEditComplete hooks.
416 * @param int|bool $originalRevId The original revision id, or false if no earlier revision
417 * is known to be repeated or restored by this update.
419 public function setOriginalRevisionId( $originalRevId ) {
420 Assert
::parameterType( 'integer|boolean', $originalRevId, '$originalRevId' );
421 $this->originalRevId
= $originalRevId;
425 * Returns the revision ID set by setUndidRevisionId(), indicating what revision is being
426 * undone by this edit.
430 public function getUndidRevisionId() {
431 return $this->undidRevId
;
435 * Sets the ID of revision that was undone by the present update.
436 * This is used with the "undo" action, and is expected to hold the oldest revision ID
437 * in case more then one revision is being undone.
439 * @param int $undidRevId
441 public function setUndidRevisionId( $undidRevId ) {
442 Assert
::parameterType( 'integer', $undidRevId, '$undidRevId' );
443 $this->undidRevId
= $undidRevId;
447 * Sets a tag to apply to this update.
448 * Callers are responsible for permission checks,
449 * using ChangeTags::canAddTagsAccompanyingChange.
452 public function addTag( $tag ) {
453 Assert
::parameterType( 'string', $tag, '$tag' );
454 $this->tags
[] = trim( $tag );
458 * Sets tags to apply to this update.
459 * Callers are responsible for permission checks,
460 * using ChangeTags::canAddTagsAccompanyingChange.
461 * @param string[] $tags
463 public function addTags( array $tags ) {
464 Assert
::parameterElementType( 'string', $tags, '$tags' );
465 foreach ( $tags as $tag ) {
466 $this->addTag( $tag );
471 * Returns the list of tags set using the addTag() method.
475 public function getExplicitTags() {
480 * @param int $flags Bit mask: a bit mask of EDIT_XXX flags.
483 private function computeEffectiveTags( $flags ) {
486 foreach ( $this->slotsUpdate
->getModifiedRoles() as $role ) {
487 $old_content = $this->getParentContent( $role );
489 $handler = $this->getContentHandler( $role );
490 $content = $this->slotsUpdate
->getModifiedSlot( $role )->getContent();
492 // TODO: MCR: Do this for all slots. Also add tags for removing roles!
493 $tag = $handler->getChangeTag( $old_content, $content, $flags );
494 // If there is no applicable tag, null is returned, so we need to check
500 // Check for undo tag
501 if ( $this->undidRevId
!== 0 && in_array( 'mw-undo', ChangeTags
::getSoftwareTags() ) ) {
505 return array_unique( $tags );
509 * Returns the content of the given slot of the parent revision, with no audience checks applied.
510 * If there is no parent revision or the slot is not defined, this returns null.
512 * @param string $role slot role name
513 * @return Content|null
515 private function getParentContent( $role ) {
516 $parent = $this->grabParentRevision();
518 if ( $parent && $parent->hasSlot( $role ) ) {
519 return $parent->getContent( $role, RevisionRecord
::RAW
);
526 * @param string $role slot role name
527 * @return ContentHandler
529 private function getContentHandler( $role ) {
530 // TODO: inject something like a ContentHandlerRegistry
531 if ( $this->slotsUpdate
->isModifiedSlot( $role ) ) {
532 $slot = $this->slotsUpdate
->getModifiedSlot( $role );
534 $parent = $this->grabParentRevision();
537 $slot = $parent->getSlot( $role, RevisionRecord
::RAW
);
539 throw new RevisionAccessException( 'No such slot: ' . $role );
543 return ContentHandler
::getForModelID( $slot->getModel() );
547 * @param int $flags Bit mask: a bit mask of EDIT_XXX flags.
549 * @return CommentStoreComment
551 private function makeAutoSummary( $flags ) {
552 if ( !$this->useAutomaticEditSummaries ||
( $flags & EDIT_AUTOSUMMARY
) === 0 ) {
553 return CommentStoreComment
::newUnsavedComment( '' );
556 // NOTE: this generates an auto-summary for SOME RANDOM changed slot!
557 // TODO: combine auto-summaries for multiple slots!
558 // XXX: this logic should not be in the storage layer!
559 $roles = $this->slotsUpdate
->getModifiedRoles();
560 $role = reset( $roles );
562 if ( $role === false ) {
563 return CommentStoreComment
::newUnsavedComment( '' );
566 $handler = $this->getContentHandler( $role );
567 $content = $this->slotsUpdate
->getModifiedSlot( $role )->getContent();
568 $old_content = $this->getParentContent( $role );
569 $summary = $handler->getAutosummary( $old_content, $content, $flags );
571 return CommentStoreComment
::newUnsavedComment( $summary );
575 * Change an existing article or create a new article. Updates RC and all necessary caches,
576 * optionally via the deferred update array. This does not check user permissions.
578 * It is guaranteed that saveRevision() will fail if the current revision of the page
579 * changes after grabParentRevision() was called and before saveRevision() can insert
580 * a new revision, as per the CAS mechanism described above.
582 * The caller is however responsible for calling hasEditConflict() to detect a
583 * user-level edit conflict, and to adjust the content of the new revision accordingly,
584 * e.g. by using a 3-way-merge.
586 * MCR migration note: this replaces WikiPage::doEditContent. Callers that change to using
587 * saveRevision() now need to check the "minoredit" themselves before using EDIT_MINOR.
589 * @param CommentStoreComment $summary Edit summary
590 * @param int $flags Bitfield:
592 * Create a new page, or fail with "edit-already-exists" if the page exists.
594 * Create a new revision, or fail with "edit-gone-missing" if the page does not exist.
596 * Mark this revision as minor
598 * Do not log the change in recentchanges
600 * Mark the revision as automated ("bot edit")
602 * Fill in blank summaries with generated text where possible
604 * Signal that the page retrieve/save cycle happened entirely in this request.
606 * If neither EDIT_NEW nor EDIT_UPDATE is specified, the expected state is detected
607 * automatically via grabParentRevision(). In this case, the "edit-already-exists" or
608 * "edit-gone-missing" errors may still be triggered due to race conditions, if the page
609 * was unexpectedly created or deleted while revision creation is in progress. This can be
610 * viewed as part of the CAS mechanism described above.
612 * @return RevisionRecord|null The new revision, or null if no new revision was created due
613 * to a failure or a null-edit. Use isUnchanged(), wasSuccessful() and getStatus()
614 * to determine the outcome of the revision creation.
616 * @throws MWException
617 * @throws RuntimeException
619 public function saveRevision( CommentStoreComment
$summary, $flags = 0 ) {
620 // Defend against mistakes caused by differences with the
621 // signature of WikiPage::doEditContent.
622 Assert
::parameterType( 'integer', $flags, '$flags' );
624 if ( $this->wasCommitted() ) {
625 throw new RuntimeException( 'saveRevision() has already been called on this PageUpdater!' );
628 // Low-level sanity check
629 if ( $this->getLinkTarget()->getText() === '' ) {
630 throw new RuntimeException( 'Something is trying to edit an article with an empty title' );
633 // TODO: MCR: check the role and the content's model against the list of supported
634 // and required roles, see T194046.
636 // Make sure the given content type is allowed for this page
637 // TODO: decide: Extend check to other slots? Consider the role in check? [PageType]
638 $mainContentHandler = $this->getContentHandler( 'main' );
639 if ( !$mainContentHandler->canBeUsedOn( $this->getTitle() ) ) {
640 $this->status
= Status
::newFatal( 'content-not-allowed-here',
641 ContentHandler
::getLocalizedName( $mainContentHandler->getModelID() ),
642 $this->getTitle()->getPrefixedText()
647 // Load the data from the master database if needed. Needed to check flags.
648 // NOTE: This grabs the parent revision as the CAS token, if grabParentRevision
649 // wasn't called yet. If the page is modified by another process before we are done with
650 // it, this method must fail (with status 'edit-conflict')!
651 // NOTE: The parent revision may be different from $this->originalRevisionId.
652 $this->grabParentRevision();
653 $flags = $this->checkFlags( $flags );
655 // Avoid statsd noise and wasted cycles check the edit stash (T136678)
656 if ( ( $flags & EDIT_INTERNAL
) ||
( $flags & EDIT_FORCE_BOT
) ) {
659 $useStashed = $this->ajaxEditStash
;
662 // TODO: use this only for the legacy hook, and only if something uses the legacy hook
663 $wikiPage = $this->getWikiPage();
667 // Prepare the update. This performs PST and generates the canonical ParserOutput.
668 $this->derivedDataUpdater
->prepareContent(
674 // TODO: don't force initialization here!
675 // This is a hack to work around the fact that late initialization of the ParserOutput
676 // causes ApiFlowEditHeaderTest::testCache to fail. Whether that failure indicates an
677 // actual problem, or is just an issue with the test setup, remains to be determined
679 // Anomie said in 2018-03:
681 I suspect that what's breaking is this:
683 The old version of WikiPage::doEditContent() called prepareContentForEdit() which
684 generated the ParserOutput right then, so when doEditUpdates() gets called from the
685 DeferredUpdate scheduled by WikiPage::doCreate() there's no need to parse. I note
686 there's a comment there that says "Get the pre-save transform content and final
688 The new version of WikiPage::doEditContent() makes a PageUpdater and calls its
689 saveRevision(), which calls DerivedPageDataUpdater::prepareContent() and
690 PageUpdater::doCreate() without ever having to actually generate a ParserOutput.
691 Thus, when DerivedPageDataUpdater::doUpdates() is called from the DeferredUpdate
692 scheduled by PageUpdater::doCreate(), it does find that it needs to parse at that point.
694 And the order of operations in that Flow test is presumably:
696 - Create a page with a call to WikiPage::doEditContent(), in a way that somehow avoids
697 processing the DeferredUpdate.
698 - Set up the "no set!" mock cache in Flow\Tests\Api\ApiTestCase::expectCacheInvalidate()
699 - Then, during the course of doing that test, a $db->commit() results in the
700 DeferredUpdates being run.
702 $this->derivedDataUpdater
->getCanonicalParserOutput();
704 $mainContent = $this->derivedDataUpdater
->getSlots()->getContent( 'main' );
706 // Trigger pre-save hook (using provided edit summary)
707 $hookStatus = Status
::newGood( [] );
708 // TODO: replace legacy hook!
709 // TODO: avoid pass-by-reference, see T193950
710 $hook_args = [ &$wikiPage, &$user, &$mainContent, &$summary,
711 $flags & EDIT_MINOR
, null, null, &$flags, &$hookStatus ];
712 // Check if the hook rejected the attempted save
713 if ( !Hooks
::run( 'PageContentSave', $hook_args ) ) {
714 if ( $hookStatus->isOK() ) {
715 // Hook returned false but didn't call fatal(); use generic message
716 $hookStatus->fatal( 'edit-hook-aborted' );
719 $this->status
= $hookStatus;
723 // Provide autosummaries if one is not provided and autosummaries are enabled
724 // XXX: $summary == null seems logical, but the empty string may actually come from the user
725 // XXX: Move this logic out of the storage layer! It does not belong here! Use a callback?
726 if ( $summary->text
=== '' && $summary->data
=== null ) {
727 $summary = $this->makeAutoSummary( $flags );
730 // Actually create the revision and create/update the page.
731 // Do NOT yet set $this->status!
732 if ( $flags & EDIT_UPDATE
) {
733 $status = $this->doModify( $summary, $this->user
, $flags );
735 $status = $this->doCreate( $summary, $this->user
, $flags );
738 // Promote user to any groups they meet the criteria for
739 DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
740 $user->addAutopromoteOnceGroups( 'onEdit' );
741 $user->addAutopromoteOnceGroups( 'onView' ); // b/c
744 // NOTE: set $this->status only after all hooks have been called,
745 // so wasCommitted doesn't return true wehn called indirectly from a hook handler!
746 $this->status
= $status;
748 // TODO: replace bad status with Exceptions!
749 return ( $this->status
&& $this->status
->isOK() )
750 ?
$this->status
->value
['revision-record']
755 * Whether saveRevision() has been called on this instance
759 public function wasCommitted() {
760 return $this->status
!== null;
764 * The Status object indicating whether saveRevision() was successful, or null if
765 * saveRevision() was not yet called on this instance.
767 * @note This is here for compatibility with WikiPage::doEditContent. It may be deprecated
770 * Possible status errors:
771 * edit-hook-aborted: The ArticleSave hook aborted the update but didn't
772 * set the fatal flag of $status.
773 * edit-gone-missing: In update mode, but the article didn't exist.
774 * edit-conflict: In update mode, the article changed unexpectedly.
775 * edit-no-change: Warning that the text was the same as before.
776 * edit-already-exists: In creation mode, but the article already exists.
778 * Extensions may define additional errors.
780 * $return->value will contain an associative array with members as follows:
781 * new: Boolean indicating if the function attempted to create a new article.
782 * revision: The revision object for the inserted revision, or null.
784 * @return null|Status
786 public function getStatus() {
787 return $this->status
;
791 * Whether saveRevision() completed successfully
795 public function wasSuccessful() {
796 return $this->status
&& $this->status
->isOK();
800 * Whether saveRevision() was called and created a new page.
804 public function isNew() {
805 return $this->status
&& $this->status
->isOK() && $this->status
->value
['new'];
809 * Whether saveRevision() did not create a revision because the content didn't change
810 * (null-edit). Whether the content changed or not is determined by
811 * DerivedPageDataUpdater::isChange().
815 public function isUnchanged() {
817 && $this->status
->isOK()
818 && $this->status
->value
['revision-record'] === null;
822 * The new revision created by saveRevision(), or null if saveRevision() has not yet been
823 * called, failed, or did not create a new revision because the content did not change.
825 * @return RevisionRecord|null
827 public function getNewRevision() {
828 return ( $this->status
&& $this->status
->isOK() )
829 ?
$this->status
->value
['revision-record']
834 * Constructs a MutableRevisionRecord based on the Content prepared by the
835 * DerivedPageDataUpdater. This takes care of inheriting slots, updating slots
836 * with PST applied, and removing discontinued slots.
838 * This calls Content::prepareSave() to verify that the slot content can be saved.
839 * The $status parameter is updated with any errors or warnings found by Content::prepareSave().
841 * @param CommentStoreComment $comment
843 * @param string $timestamp
845 * @param Status $status
847 * @return MutableRevisionRecord
849 private function makeNewRevision(
850 CommentStoreComment
$comment,
856 $wikiPage = $this->getWikiPage();
857 $title = $this->getTitle();
858 $parent = $this->grabParentRevision();
860 // XXX: we expect to get a MutableRevisionRecord here, but that's a bit brittle!
861 // TODO: introduce something like an UnsavedRevisionFactory service instead!
862 /** @var MutableRevisionRecord $rev */
863 $rev = $this->derivedDataUpdater
->getRevision();
865 $rev->setPageId( $title->getArticleID() );
868 $oldid = $parent->getId();
869 $rev->setParentId( $oldid );
874 $rev->setComment( $comment );
875 $rev->setUser( $user );
876 $rev->setTimestamp( $timestamp );
877 $rev->setMinorEdit( ( $flags & EDIT_MINOR
) > 0 );
879 foreach ( $rev->getSlots()->getSlots() as $slot ) {
880 $content = $slot->getContent();
882 // XXX: We may push this up to the "edit controller" level, see T192777.
883 // TODO: change the signature of PrepareSave to not take a WikiPage!
884 $prepStatus = $content->prepareSave( $wikiPage, $flags, $oldid, $user );
886 // TODO: MCR: record which problem arose in which slot.
887 $status->merge( $prepStatus );
894 * @param CommentStoreComment $summary The edit summary
895 * @param User $user The revision's author
896 * @param int $flags EXIT_XXX constants
898 * @throws MWException
901 private function doModify( CommentStoreComment
$summary, User
$user, $flags ) {
902 $wikiPage = $this->getWikiPage(); // TODO: use for legacy hooks only!
904 // Update article, but only if changed.
905 $status = Status
::newGood( [ 'new' => false, 'revision' => null, 'revision-record' => null ] );
907 // Convenience variables
908 $now = $this->getTimestampNow();
910 $oldRev = $this->grabParentRevision();
911 $oldid = $oldRev ?
$oldRev->getId() : 0;
914 // Article gone missing
915 $status->fatal( 'edit-gone-missing' );
920 $newRevisionRecord = $this->makeNewRevision(
928 if ( !$status->isOK() ) {
932 // XXX: we may want a flag that allows a null revision to be forced!
933 $changed = $this->derivedDataUpdater
->isChange();
935 $dbw = $this->getDBConnectionRef( DB_MASTER
);
938 $dbw->startAtomic( __METHOD__
);
940 // Get the latest page_latest value while locking it.
941 // Do a CAS style check to see if it's the same as when this method
942 // started. If it changed then bail out before touching the DB.
943 $latestNow = $wikiPage->lockAndGetLatest(); // TODO: move to storage service, pass DB
944 if ( $latestNow != $oldid ) {
945 // We don't need to roll back, since we did not modify the database yet.
946 // XXX: Or do we want to rollback, any transaction started by calling
947 // code will fail? If we want that, we should probably throw an exception.
948 $dbw->endAtomic( __METHOD__
);
949 // Page updated or deleted in the mean time
950 $status->fatal( 'edit-conflict' );
955 // At this point we are now comitted to returning an OK
956 // status unless some DB query error or other exception comes up.
957 // This way callers don't have to call rollback() if $status is bad
958 // unless they actually try to catch exceptions (which is rare).
960 // Save revision content and meta-data
961 $newRevisionRecord = $this->revisionStore
->insertRevisionOn( $newRevisionRecord, $dbw );
962 $newLegacyRevision = new Revision( $newRevisionRecord );
964 // Update page_latest and friends to reflect the new revision
965 // TODO: move to storage service
966 $wasRedirect = $this->derivedDataUpdater
->wasRedirect();
967 if ( !$wikiPage->updateRevisionOn( $dbw, $newLegacyRevision, null, $wasRedirect ) ) {
968 throw new PageUpdateException( "Failed to update page row to use new revision." );
971 // TODO: replace legacy hook!
972 $tags = $this->computeEffectiveTags( $flags );
974 'NewRevisionFromEditComplete',
975 [ $wikiPage, $newLegacyRevision, $this->getOriginalRevisionId(), $user, &$tags ]
978 // Update recentchanges
979 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
980 // Add RC row to the DB
981 RecentChange
::notifyEdit(
984 $newRevisionRecord->isMinor(),
986 $summary->text
, // TODO: pass object when that becomes possible
988 $newRevisionRecord->getTimestamp(),
989 ( $flags & EDIT_FORCE_BOT
) > 0,
992 $newRevisionRecord->getSize(),
993 $newRevisionRecord->getId(),
994 $this->rcPatrolStatus
,
999 $user->incEditCount();
1001 $dbw->endAtomic( __METHOD__
);
1003 // Return the new revision to the caller
1004 $status->value
['revision-record'] = $newRevisionRecord;
1006 // TODO: globally replace usages of 'revision' with getNewRevision()
1007 $status->value
['revision'] = $newLegacyRevision;
1009 // T34948: revision ID must be set to page {{REVISIONID}} and
1010 // related variables correctly. Likewise for {{REVISIONUSER}} (T135261).
1011 // Since we don't insert a new revision into the database, the least
1012 // error-prone way is to reuse given old revision.
1013 $newRevisionRecord = $oldRev;
1015 $status->warning( 'edit-no-change' );
1016 // Update page_touched as updateRevisionOn() was not called.
1017 // Other cache updates are managed in WikiPage::onArticleEdit()
1018 // via WikiPage::doEditUpdates().
1019 $this->getTitle()->invalidateCache( $now );
1022 // Do secondary updates once the main changes have been committed...
1023 // NOTE: the updates have to be processed before sending the response to the client
1024 // (DeferredUpdates::PRESEND), otherwise the client may already be following the
1025 // HTTP redirect to the standard view before dervide data has been created - most
1026 // importantly, before the parser cache has been updated. This would cause the
1027 // content to be parsed a second time, or may cause stale content to be shown.
1028 DeferredUpdates
::addUpdate(
1029 $this->getAtomicSectionUpdate(
1037 [ 'changed' => $changed, ]
1039 DeferredUpdates
::PRESEND
1046 * @param CommentStoreComment $summary The edit summary
1047 * @param User $user The revision's author
1048 * @param int $flags EXIT_XXX constants
1050 * @throws DBUnexpectedError
1051 * @throws MWException
1054 private function doCreate( CommentStoreComment
$summary, User
$user, $flags ) {
1055 $wikiPage = $this->getWikiPage(); // TODO: use for legacy hooks only!
1057 if ( !$this->derivedDataUpdater
->getSlots()->hasSlot( 'main' ) ) {
1058 throw new PageUpdateException( 'Must provide a main slot when creating a page!' );
1061 $status = Status
::newGood( [ 'new' => true, 'revision' => null, 'revision-record' => null ] );
1063 $now = $this->getTimestampNow();
1065 $newRevisionRecord = $this->makeNewRevision(
1073 if ( !$status->isOK() ) {
1077 $dbw = $this->getDBConnectionRef( DB_MASTER
);
1078 $dbw->startAtomic( __METHOD__
);
1080 // Add the page record unless one already exists for the title
1081 // TODO: move to storage service
1082 $newid = $wikiPage->insertOn( $dbw );
1083 if ( $newid === false ) {
1084 $dbw->endAtomic( __METHOD__
); // nothing inserted
1085 $status->fatal( 'edit-already-exists' );
1087 return $status; // nothing done
1090 // At this point we are now comitted to returning an OK
1091 // status unless some DB query error or other exception comes up.
1092 // This way callers don't have to call rollback() if $status is bad
1093 // unless they actually try to catch exceptions (which is rare).
1094 $newRevisionRecord->setPageId( $newid );
1096 // Save the revision text...
1097 $newRevisionRecord = $this->revisionStore
->insertRevisionOn( $newRevisionRecord, $dbw );
1098 $newLegacyRevision = new Revision( $newRevisionRecord );
1100 // Update the page record with revision data
1101 // TODO: move to storage service
1102 if ( !$wikiPage->updateRevisionOn( $dbw, $newLegacyRevision, 0 ) ) {
1103 throw new PageUpdateException( "Failed to update page row to use new revision." );
1106 // TODO: replace legacy hook!
1107 $tags = $this->computeEffectiveTags( $flags );
1109 'NewRevisionFromEditComplete',
1110 [ $wikiPage, $newLegacyRevision, false, $user, &$tags ]
1113 // Update recentchanges
1114 if ( !( $flags & EDIT_SUPPRESS_RC
) ) {
1115 // Add RC row to the DB
1116 RecentChange
::notifyNew(
1119 $newRevisionRecord->isMinor(),
1121 $summary->text
, // TODO: pass object when that becomes possible
1122 ( $flags & EDIT_FORCE_BOT
) > 0,
1124 $newRevisionRecord->getSize(),
1125 $newRevisionRecord->getId(),
1126 $this->rcPatrolStatus
,
1131 $user->incEditCount();
1133 if ( $this->usePageCreationLog
) {
1134 // Log the page creation
1135 // @TODO: Do we want a 'recreate' action?
1136 $logEntry = new ManualLogEntry( 'create', 'create' );
1137 $logEntry->setPerformer( $user );
1138 $logEntry->setTarget( $this->getTitle() );
1139 $logEntry->setComment( $summary->text
);
1140 $logEntry->setTimestamp( $now );
1141 $logEntry->setAssociatedRevId( $newRevisionRecord->getId() );
1142 $logEntry->insert();
1143 // Note that we don't publish page creation events to recentchanges
1144 // (i.e. $logEntry->publish()) since this would create duplicate entries,
1145 // one for the edit and one for the page creation.
1148 $dbw->endAtomic( __METHOD__
);
1150 // Return the new revision to the caller
1151 // TODO: globally replace usages of 'revision' with getNewRevision()
1152 $status->value
['revision'] = $newLegacyRevision;
1153 $status->value
['revision-record'] = $newRevisionRecord;
1155 // Do secondary updates once the main changes have been committed...
1156 DeferredUpdates
::addUpdate(
1157 $this->getAtomicSectionUpdate(
1165 [ 'created' => true ]
1167 DeferredUpdates
::PRESEND
1173 private function getAtomicSectionUpdate(
1176 RevisionRecord
$newRevisionRecord,
1178 CommentStoreComment
$summary,
1183 return new AtomicSectionUpdate(
1187 $wikiPage, $newRevisionRecord, $user,
1188 $summary, $flags, $status, $hints
1190 $newLegacyRevision = new Revision( $newRevisionRecord );
1191 $mainContent = $newRevisionRecord->getContent( 'main', RevisionRecord
::RAW
);
1193 // Update links tables, site stats, etc.
1194 $this->derivedDataUpdater
->prepareUpdate( $newRevisionRecord, $hints );
1195 $this->derivedDataUpdater
->doUpdates();
1197 // TODO: replace legacy hook!
1198 // TODO: avoid pass-by-reference, see T193950
1200 if ( $hints['created'] ??
false ) {
1201 // Trigger post-create hook
1202 $params = [ &$wikiPage, &$user, $mainContent, $summary->text
,
1203 $flags & EDIT_MINOR
, null, null, &$flags, $newLegacyRevision ];
1204 Hooks
::run( 'PageContentInsertComplete', $params );
1207 // Trigger post-save hook
1208 $params = [ &$wikiPage, &$user, $mainContent, $summary->text
,
1209 $flags & EDIT_MINOR
, null, null, &$flags, $newLegacyRevision,
1210 &$status, $this->getOriginalRevisionId(), $this->undidRevId
];
1211 Hooks
::run( 'PageContentSaveComplete', $params );