3 * A handle for managing updates for derived page data on edit, import, purge, etc.
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
23 namespace MediaWiki\Storage
;
25 use CategoryMembershipChangeJob
;
33 use InvalidArgumentException
;
36 use LinksDeletionUpdate
;
39 use MediaWiki\Edit\PreparedEdit
;
40 use MediaWiki\MediaWikiServices
;
41 use MediaWiki\Revision\MutableRevisionRecord
;
42 use MediaWiki\Revision\RenderedRevision
;
43 use MediaWiki\Revision\RevisionRecord
;
44 use MediaWiki\Revision\RevisionRenderer
;
45 use MediaWiki\Revision\RevisionSlots
;
46 use MediaWiki\Revision\RevisionStore
;
47 use MediaWiki\Revision\SlotRoleRegistry
;
48 use MediaWiki\Revision\SlotRecord
;
49 use MediaWiki\User\UserIdentity
;
55 use Psr\Log\LoggerAwareInterface
;
56 use Psr\Log\LoggerInterface
;
57 use Psr\Log\NullLogger
;
58 use RecentChangesUpdateJob
;
59 use ResourceLoaderWikiModule
;
65 use Wikimedia\Assert\Assert
;
66 use Wikimedia\Rdbms\ILBFactory
;
70 * A handle for managing updates for derived page data on edit, import, purge, etc.
72 * @note Avoid direct usage of DerivedPageDataUpdater.
74 * @todo Define interfaces for the different use cases of DerivedPageDataUpdater, particularly
75 * providing access to post-PST content and ParserOutput to callbacks during revision creation,
76 * which currently use WikiPage::prepareContentForEdit, and allowing updates to be triggered on
77 * purge, import, and undeletion, which currently use WikiPage::doEditUpdates() and
78 * Content::getSecondaryDataUpdates().
80 * DerivedPageDataUpdater instances are designed to be cached inside a WikiPage instance,
81 * and re-used by callback code over the course of an update operation. It's a stepping stone
82 * on the way to a more complete refactoring of WikiPage.
84 * When using a DerivedPageDataUpdater, the following life cycle must be observed:
85 * grabCurrentRevision (optional), prepareContent (optional), prepareUpdate (required
86 * for doUpdates). getCanonicalParserOutput, getSlots, and getSecondaryDataUpdates
87 * require prepareContent or prepareUpdate to have been called first, to initialize the
88 * DerivedPageDataUpdater.
90 * @see docs/pageupdater.txt for more information.
92 * MCR migration note: this replaces the relevant methods in WikiPage, and covers the use cases
100 class DerivedPageDataUpdater
implements IDBAccessObject
, LoggerAwareInterface
{
103 * @var UserIdentity|null
105 private $user = null;
115 private $parserCache;
120 private $revisionStore;
130 private $jobQueueGroup;
135 private $messageCache;
140 private $loadbalancerFactory;
143 * @var LoggerInterface
148 * @var string see $wgArticleCountMethod
150 private $articleCountMethod;
153 * @var boolean see $wgRCWatchCategoryMembership
155 private $rcWatchCategoryMembership = false;
158 * Stores (most of) the $options parameter of prepareUpdate().
159 * @see prepareUpdate()
163 // newrev is true if prepareUpdate is handling the creation of a new revision,
164 // as opposed to a null edit or a forced update.
169 'oldrevision' => null,
170 'oldcountable' => null,
171 'oldredirect' => null,
172 'triggeringUser' => null,
173 // causeAction/causeAgent default to 'unknown' but that's handled where it's read,
174 // to make the life of prepareUpdate() callers easier.
175 'causeAction' => null,
176 'causeAgent' => null,
180 * The state of the relevant row in page table before the edit.
181 * This is determined by the first call to grabCurrentRevision, prepareContent,
182 * or prepareUpdate (so it is only accessible in 'knows-current' or a later stage).
183 * If pageState was not initialized when prepareUpdate() is called, prepareUpdate() will
184 * attempt to emulate the state of the page table before the edit.
186 * Contains the following fields:
187 * - oldRevision (RevisionRecord|null): the revision that was current before the change
188 * associated with this update. Might not be set, use getParentRevision().
189 * - oldId (int|null): the id of the above revision. 0 if there is no such revision (the change
190 * was about creating a new page); null if not known (that should not happen).
191 * - oldIsRedirect (bool|null): whether the page was a redirect before the change. Lazy-loaded,
192 * can be null; use wasRedirect() instead of direct access.
193 * - oldCountable (bool|null): whether the page was countable before the change (or null
194 * if we don't have that information)
198 private $pageState = null;
201 * @var RevisionSlotsUpdate|null
203 private $slotsUpdate = null;
206 * @var RevisionRecord|null
208 private $parentRevision = null;
211 * @var RevisionRecord|null
213 private $revision = null;
216 * @var RenderedRevision
218 private $renderedRevision = null;
221 * @var RevisionRenderer
223 private $revisionRenderer;
225 /** @var SlotRoleRegistry */
226 private $slotRoleRegistry;
229 * A stage identifier for managing the life cycle of this instance.
230 * Possible stages are 'new', 'knows-current', 'has-content', 'has-revision', and 'done'.
232 * @see docs/pageupdater.txt for documentation of the life cycle.
236 private $stage = 'new';
239 * Transition table for managing the life cycle of DerivedPageDateUpdater instances.
241 * XXX: Overkill. This is a linear order, we could just count. Names are nice though,
242 * and constants are also overkill...
244 * @see docs/pageupdater.txt for documentation of the life cycle.
248 private static $transitions = [
251 'knows-current' => true,
252 'has-content' => true,
253 'has-revision' => true,
256 'knows-current' => true,
257 'has-content' => true,
258 'has-revision' => true,
261 'has-content' => true,
262 'has-revision' => true,
265 'has-revision' => true,
271 * @param WikiPage $wikiPage ,
272 * @param RevisionStore $revisionStore
273 * @param RevisionRenderer $revisionRenderer
274 * @param SlotRoleRegistry $slotRoleRegistry
275 * @param ParserCache $parserCache
276 * @param JobQueueGroup $jobQueueGroup
277 * @param MessageCache $messageCache
278 * @param Language $contLang
279 * @param ILBFactory $loadbalancerFactory
281 public function __construct(
283 RevisionStore
$revisionStore,
284 RevisionRenderer
$revisionRenderer,
285 SlotRoleRegistry
$slotRoleRegistry,
286 ParserCache
$parserCache,
287 JobQueueGroup
$jobQueueGroup,
288 MessageCache
$messageCache,
290 ILBFactory
$loadbalancerFactory
292 $this->wikiPage
= $wikiPage;
294 $this->parserCache
= $parserCache;
295 $this->revisionStore
= $revisionStore;
296 $this->revisionRenderer
= $revisionRenderer;
297 $this->slotRoleRegistry
= $slotRoleRegistry;
298 $this->jobQueueGroup
= $jobQueueGroup;
299 $this->messageCache
= $messageCache;
300 $this->contLang
= $contLang;
301 // XXX only needed for waiting for replicas to catch up; there should be a narrower
302 // interface for that.
303 $this->loadbalancerFactory
= $loadbalancerFactory;
304 $this->logger
= new NullLogger();
307 public function setLogger( LoggerInterface
$logger ) {
308 $this->logger
= $logger;
312 * Transition function for managing the life cycle of this instances.
314 * @see docs/pageupdater.txt for documentation of the life cycle.
316 * @param string $newStage the new stage
317 * @return string the previous stage
319 * @throws LogicException If a transition to the given stage is not possible in the current
322 private function doTransition( $newStage ) {
323 $this->assertTransition( $newStage );
325 $oldStage = $this->stage
;
326 $this->stage
= $newStage;
332 * Asserts that a transition to the given stage is possible, without performing it.
334 * @see docs/pageupdater.txt for documentation of the life cycle.
336 * @param string $newStage the new stage
338 * @throws LogicException If this instance is not in the expected stage
340 private function assertTransition( $newStage ) {
341 if ( empty( self
::$transitions[$this->stage
][$newStage] ) ) {
342 throw new LogicException( "Cannot transition from {$this->stage} to $newStage" );
347 * Checks whether this DerivedPageDataUpdater can be re-used for running updates targeting
348 * the given revision.
350 * @param UserIdentity|null $user The user creating the revision in question
351 * @param RevisionRecord|null $revision New revision (after save, if already saved)
352 * @param RevisionSlotsUpdate|null $slotsUpdate New content (before PST)
353 * @param null|int $parentId Parent revision of the edit (use 0 for page creation)
357 public function isReusableFor(
358 UserIdentity
$user = null,
359 RevisionRecord
$revision = null,
360 RevisionSlotsUpdate
$slotsUpdate = null,
365 && $revision->getParentId() !== $parentId
367 throw new InvalidArgumentException( '$parentId should match the parent of $revision' );
370 // NOTE: For null revisions, $user may be different from $this->revision->getUser
371 // and also from $revision->getUser.
372 // But $user should always match $this->user.
373 if ( $user && $this->user
&& $user->getName() !== $this->user
->getName() ) {
377 if ( $revision && $this->revision
&& $this->revision
->getId()
378 && $this->revision
->getId() !== $revision->getId()
383 if ( $this->pageState
385 && $revision->getParentId() !== null
386 && $this->pageState
['oldId'] !== $revision->getParentId()
391 if ( $this->pageState
392 && $parentId !== null
393 && $this->pageState
['oldId'] !== $parentId
398 // NOTE: this check is the primary reason for having the $this->slotsUpdate field!
399 if ( $this->slotsUpdate
401 && !$this->slotsUpdate
->hasSameUpdates( $slotsUpdate )
408 && !$this->revision
->getSlots()->hasSameContent( $revision->getSlots() )
417 * @param string $articleCountMethod "any" or "link".
418 * @see $wgArticleCountMethod
420 public function setArticleCountMethod( $articleCountMethod ) {
421 $this->articleCountMethod
= $articleCountMethod;
425 * @param bool $rcWatchCategoryMembership
426 * @see $wgRCWatchCategoryMembership
428 public function setRcWatchCategoryMembership( $rcWatchCategoryMembership ) {
429 $this->rcWatchCategoryMembership
= $rcWatchCategoryMembership;
435 private function getTitle() {
436 // NOTE: eventually, we won't get a WikiPage passed into the constructor any more
437 return $this->wikiPage
->getTitle();
443 private function getWikiPage() {
444 // NOTE: eventually, we won't get a WikiPage passed into the constructor any more
445 return $this->wikiPage
;
449 * Determines whether the page being edited already existed.
450 * Only defined after calling grabCurrentRevision() or prepareContent() or prepareUpdate()!
453 * @throws LogicException if called before grabCurrentRevision
455 public function pageExisted() {
456 $this->assertHasPageState( __METHOD__
);
458 return $this->pageState
['oldId'] > 0;
462 * Returns the parent revision of the new revision wrapped by this update.
463 * If the update is a null-edit, this will return the parent of the current (and new) revision.
464 * This will return null if the revision wrapped by this update created the page.
465 * Only defined after calling prepareContent() or prepareUpdate()!
467 * @return RevisionRecord|null the parent revision of the new revision, or null if
468 * the update created the page.
470 private function getParentRevision() {
471 $this->assertPrepared( __METHOD__
);
473 if ( $this->parentRevision
) {
474 return $this->parentRevision
;
477 if ( !$this->pageState
['oldId'] ) {
478 // If there was no current revision, there is no parent revision,
479 // since the page didn't exist.
483 $oldId = $this->revision
->getParentId();
484 $flags = $this->useMaster() ? RevisionStore
::READ_LATEST
: 0;
485 $this->parentRevision
= $oldId
486 ?
$this->revisionStore
->getRevisionById( $oldId, $flags )
489 return $this->parentRevision
;
493 * Returns the revision that was the page's current revision when grabCurrentRevision()
496 * During an edit, that revision will act as the logical parent of the new revision.
498 * Some updates are performed based on the difference between the database state at the
499 * moment this method is first called, and the state after the edit.
501 * @see docs/pageupdater.txt for more information on when thie method can and should be called.
503 * @note After prepareUpdate() was called, grabCurrentRevision() will throw an exception
504 * to avoid confusion, since the page's current revision is then the new revision after
505 * the edit, which was presumably passed to prepareUpdate() as the $revision parameter.
506 * Use getParentRevision() instead to access the revision that is the parent of the
509 * @return RevisionRecord|null the page's current revision, or null if the page does not
512 public function grabCurrentRevision() {
513 if ( $this->pageState
) {
514 return $this->pageState
['oldRevision'];
517 $this->assertTransition( 'knows-current' );
519 // NOTE: eventually, we won't get a WikiPage passed into the constructor any more
520 $wikiPage = $this->getWikiPage();
522 // Do not call WikiPage::clear(), since the caller may already have caused page data
523 // to be loaded with SELECT FOR UPDATE. Just assert it's loaded now.
524 $wikiPage->loadPageData( self
::READ_LATEST
);
525 $rev = $wikiPage->getRevision();
526 $current = $rev ?
$rev->getRevisionRecord() : null;
529 'oldRevision' => $current,
530 'oldId' => $rev ?
$rev->getId() : 0,
531 'oldIsRedirect' => $wikiPage->isRedirect(), // NOTE: uses page table
532 'oldCountable' => $wikiPage->isCountable(), // NOTE: uses pagelinks table
535 $this->doTransition( 'knows-current' );
537 return $this->pageState
['oldRevision'];
541 * Whether prepareUpdate() or prepareContent() have been called on this instance.
545 public function isContentPrepared() {
546 return $this->revision
!== null;
550 * Whether prepareUpdate() has been called on this instance.
552 * @note will also return null in case of a null-edit!
556 public function isUpdatePrepared() {
557 return $this->revision
!== null && $this->revision
->getId() !== null;
563 private function getPageId() {
564 // NOTE: eventually, we won't get a WikiPage passed into the constructor any more
565 return $this->wikiPage
->getId();
569 * Whether the content is deleted and thus not visible to the public.
573 public function isContentDeleted() {
574 if ( $this->revision
) {
575 return $this->revision
->isDeleted( RevisionRecord
::DELETED_TEXT
);
577 // If the content has not been saved yet, it cannot have been deleted yet.
583 * Returns the slot, modified or inherited, after PST, with no audience checks applied.
585 * @param string $role slot role name
587 * @throws PageUpdateException If the slot is neither set for update nor inherited from the
591 public function getRawSlot( $role ) {
592 return $this->getSlots()->getSlot( $role );
596 * Returns the content of the given slot, with no audience checks.
598 * @throws PageUpdateException If the slot is neither set for update nor inherited from the
600 * @param string $role slot role name
603 public function getRawContent( $role ) {
604 return $this->getRawSlot( $role )->getContent();
608 * Returns the content model of the given slot
610 * @param string $role slot role name
613 private function getContentModel( $role ) {
614 return $this->getRawSlot( $role )->getModel();
618 * @param string $role slot role name
619 * @return ContentHandler
621 private function getContentHandler( $role ) {
622 // TODO: inject something like a ContentHandlerRegistry
623 return ContentHandler
::getForModelID( $this->getContentModel( $role ) );
626 private function useMaster() {
627 // TODO: can we just set a flag to true in prepareContent()?
628 return $this->wikiPage
->wasLoadedFrom( self
::READ_LATEST
);
634 public function isCountable() {
635 // NOTE: Keep in sync with WikiPage::isCountable.
637 if ( !$this->getTitle()->isContentPage() ) {
641 if ( $this->isContentDeleted() ) {
642 // This should be irrelevant: countability only applies to the current revision,
643 // and the current revision is never suppressed.
647 if ( $this->isRedirect() ) {
653 if ( $this->articleCountMethod
=== 'link' ) {
654 // NOTE: it would be more appropriate to determine for each slot separately
655 // whether it has links, and use that information with that slot's
656 // isCountable() method. However, that would break parity with
657 // WikiPage::isCountable, which uses the pagelinks table to determine
658 // whether the current revision has links.
659 $hasLinks = (bool)count( $this->getCanonicalParserOutput()->getLinks() );
662 foreach ( $this->getSlots()->getSlotRoles() as $role ) {
663 $roleHandler = $this->slotRoleRegistry
->getRoleHandler( $role );
664 if ( $roleHandler->supportsArticleCount() ) {
665 $content = $this->getRawContent( $role );
667 if ( $content->isCountable( $hasLinks ) ) {
679 public function isRedirect() {
680 // NOTE: main slot determines redirect status
681 // TODO: MCR: this should be controlled by a PageTypeHandler
682 $mainContent = $this->getRawContent( SlotRecord
::MAIN
);
684 return $mainContent->isRedirect();
688 * @param RevisionRecord $rev
692 private function revisionIsRedirect( RevisionRecord
$rev ) {
693 // NOTE: main slot determines redirect status
694 $mainContent = $rev->getContent( SlotRecord
::MAIN
, RevisionRecord
::RAW
);
696 return $mainContent->isRedirect();
700 * Prepare updates based on an update which has not yet been saved.
702 * This may be used to create derived data that is needed when creating a new revision;
703 * particularly, this makes available the slots of the new revision via the getSlots()
704 * method, after applying PST and slot inheritance.
706 * The derived data prepared for revision creation may then later be re-used by doUpdates(),
707 * without the need to re-calculate.
709 * @see docs/pageupdater.txt for more information on when thie method can and should be called.
711 * @note Calling this method more than once with the same $slotsUpdate
712 * has no effect. Calling this method multiple times with different content will cause
715 * @note Calling this method after prepareUpdate() has been called will cause an exception.
717 * @param User $user The user to act as context for pre-save transformation (PST).
718 * Type hint should be reduced to UserIdentity at some point.
719 * @param RevisionSlotsUpdate $slotsUpdate The new content of the slots to be updated
720 * by this edit, before PST.
721 * @param bool $useStash Whether to use stashed ParserOutput
723 public function prepareContent(
725 RevisionSlotsUpdate
$slotsUpdate,
728 if ( $this->slotsUpdate
) {
729 if ( !$this->user
) {
730 throw new LogicException(
731 'Unexpected state: $this->slotsUpdate was initialized, '
732 . 'but $this->user was not.'
736 if ( $this->user
->getName() !== $user->getName() ) {
737 throw new LogicException( 'Can\'t call prepareContent() again for different user! '
738 . 'Expected ' . $this->user
->getName() . ', got ' . $user->getName()
742 if ( !$this->slotsUpdate
->hasSameUpdates( $slotsUpdate ) ) {
743 throw new LogicException(
744 'Can\'t call prepareContent() again with different slot content!'
748 return; // prepareContent() already done, nothing to do
751 $this->assertTransition( 'has-content' );
753 $wikiPage = $this->getWikiPage(); // TODO: use only for legacy hooks!
754 $title = $this->getTitle();
756 $parentRevision = $this->grabCurrentRevision();
758 // The edit may have already been prepared via api.php?action=stashedit
759 $stashedEdit = false;
761 // TODO: MCR: allow output for all slots to be stashed.
762 if ( $useStash && $slotsUpdate->isModifiedSlot( SlotRecord
::MAIN
) ) {
763 $editStash = MediaWikiServices
::getInstance()->getPageEditStash();
764 $stashedEdit = $editStash->checkCache(
766 $slotsUpdate->getModifiedSlot( SlotRecord
::MAIN
)->getContent(),
767 User
::newFromIdentity( $user )
771 $userPopts = ParserOptions
::newFromUserAndLang( $user, $this->contLang
);
772 Hooks
::run( 'ArticlePrepareTextForEdit', [ $wikiPage, $userPopts ] );
775 $this->slotsUpdate
= $slotsUpdate;
777 if ( $parentRevision ) {
778 $this->revision
= MutableRevisionRecord
::newFromParentRevision( $parentRevision );
780 $this->revision
= new MutableRevisionRecord( $title );
783 // NOTE: user and timestamp must be set, so they can be used for
784 // {{subst:REVISIONUSER}} and {{subst:REVISIONTIMESTAMP}} in PST!
785 $this->revision
->setTimestamp( wfTimestampNow() );
786 $this->revision
->setUser( $user );
788 // Set up ParserOptions to operate on the new revision
789 $oldCallback = $userPopts->getCurrentRevisionCallback();
790 $userPopts->setCurrentRevisionCallback(
791 function ( Title
$parserTitle, $parser = false ) use ( $title, $oldCallback ) {
792 if ( $parserTitle->equals( $title ) ) {
793 $legacyRevision = new Revision( $this->revision
);
794 return $legacyRevision;
796 return call_user_func( $oldCallback, $parserTitle, $parser );
801 $pstContentSlots = $this->revision
->getSlots();
803 foreach ( $slotsUpdate->getModifiedRoles() as $role ) {
804 $slot = $slotsUpdate->getModifiedSlot( $role );
806 if ( $slot->isInherited() ) {
807 // No PST for inherited slots! Note that "modified" slots may still be inherited
808 // from an earlier version, e.g. for rollbacks.
810 } elseif ( $role === SlotRecord
::MAIN
&& $stashedEdit ) {
811 // TODO: MCR: allow PST content for all slots to be stashed.
812 $pstSlot = SlotRecord
::newUnsaved( $role, $stashedEdit->pstContent
);
814 $content = $slot->getContent();
815 $pstContent = $content->preSaveTransform( $title, $this->user
, $userPopts );
816 $pstSlot = SlotRecord
::newUnsaved( $role, $pstContent );
819 $pstContentSlots->setSlot( $pstSlot );
822 foreach ( $slotsUpdate->getRemovedRoles() as $role ) {
823 $pstContentSlots->removeSlot( $role );
826 $this->options
['created'] = ( $parentRevision === null );
827 $this->options
['changed'] = ( $parentRevision === null
828 ||
!$pstContentSlots->hasSameContent( $parentRevision->getSlots() ) );
830 $this->doTransition( 'has-content' );
832 if ( !$this->options
['changed'] ) {
835 // TODO: move this into MutableRevisionRecord
836 // TODO: This needs to behave differently for a forced dummy edit!
837 $this->revision
->setId( $parentRevision->getId() );
838 $this->revision
->setTimestamp( $parentRevision->getTimestamp() );
839 $this->revision
->setPageId( $parentRevision->getPageId() );
840 $this->revision
->setParentId( $parentRevision->getParentId() );
841 $this->revision
->setUser( $parentRevision->getUser( RevisionRecord
::RAW
) );
842 $this->revision
->setComment( $parentRevision->getComment( RevisionRecord
::RAW
) );
843 $this->revision
->setMinorEdit( $parentRevision->isMinor() );
844 $this->revision
->setVisibility( $parentRevision->getVisibility() );
846 // prepareUpdate() is redundant for null-edits
847 $this->doTransition( 'has-revision' );
849 $this->parentRevision
= $parentRevision;
852 $renderHints = [ 'use-master' => $this->useMaster(), 'audience' => RevisionRecord
::RAW
];
854 if ( $stashedEdit ) {
855 /** @var ParserOutput $output */
856 $output = $stashedEdit->output
;
857 // TODO: this should happen when stashing the ParserOutput, not now!
858 $output->setCacheTime( $stashedEdit->timestamp
);
860 $renderHints['known-revision-output'] = $output;
862 $this->logger
->debug( __METHOD__
. ': using stashed edit output...' );
865 // NOTE: we want a canonical rendering, so don't pass $this->user or ParserOptions
866 // NOTE: the revision is either new or current, so we can bypass audience checks.
867 $this->renderedRevision
= $this->revisionRenderer
->getRenderedRevision(
876 * Returns the update's target revision - that is, the revision that will be the current
877 * revision after the update.
879 * @note Callers must treat the returned RevisionRecord's content as immutable, even
880 * if it is a MutableRevisionRecord instance. Other aspects of a MutableRevisionRecord
881 * returned from here, such as the user or the comment, may be changed, but may not
882 * be reflected in ParserOutput until after prepareUpdate() has been called.
884 * @todo This is currently used by PageUpdater::makeNewRevision() to construct an unsaved
885 * MutableRevisionRecord instance. Introduce something like an UnsavedRevisionFactory service
886 * for that purpose instead!
888 * @return RevisionRecord
890 public function getRevision() {
891 $this->assertPrepared( __METHOD__
);
892 return $this->revision
;
896 * @return RenderedRevision
898 public function getRenderedRevision() {
899 $this->assertPrepared( __METHOD__
);
901 return $this->renderedRevision
;
904 private function assertHasPageState( $method ) {
905 if ( !$this->pageState
) {
906 throw new LogicException(
907 'Must call grabCurrentRevision() or prepareContent() '
908 . 'or prepareUpdate() before calling ' . $method
913 private function assertPrepared( $method ) {
914 if ( !$this->revision
) {
915 throw new LogicException(
916 'Must call prepareContent() or prepareUpdate() before calling ' . $method
921 private function assertHasRevision( $method ) {
922 if ( !$this->revision
->getId() ) {
923 throw new LogicException(
924 'Must call prepareUpdate() before calling ' . $method
930 * Whether the edit creates the page.
934 public function isCreation() {
935 $this->assertPrepared( __METHOD__
);
936 return $this->options
['created'];
940 * Whether the edit created, or should create, a new revision (that is, it's not a null-edit).
942 * @warning at present, "null-revisions" that do not change content but do have a revision
943 * record would return false after prepareContent(), but true after prepareUpdate()!
944 * This should probably be fixed.
948 public function isChange() {
949 $this->assertPrepared( __METHOD__
);
950 return $this->options
['changed'];
954 * Whether the page was a redirect before the edit.
958 public function wasRedirect() {
959 $this->assertHasPageState( __METHOD__
);
961 if ( $this->pageState
['oldIsRedirect'] === null ) {
962 /** @var RevisionRecord $rev */
963 $rev = $this->pageState
['oldRevision'];
965 $this->pageState
['oldIsRedirect'] = $this->revisionIsRedirect( $rev );
967 $this->pageState
['oldIsRedirect'] = false;
971 return $this->pageState
['oldIsRedirect'];
975 * Returns the slots of the target revision, after PST.
977 * @note Callers must treat the returned RevisionSlots instance as immutable, even
978 * if it is a MutableRevisionSlots instance.
980 * @return RevisionSlots
982 public function getSlots() {
983 $this->assertPrepared( __METHOD__
);
984 return $this->revision
->getSlots();
988 * Returns the RevisionSlotsUpdate for this updater.
990 * @return RevisionSlotsUpdate
992 private function getRevisionSlotsUpdate() {
993 $this->assertPrepared( __METHOD__
);
995 if ( !$this->slotsUpdate
) {
996 $old = $this->getParentRevision();
997 $this->slotsUpdate
= RevisionSlotsUpdate
::newFromRevisionSlots(
998 $this->revision
->getSlots(),
999 $old ?
$old->getSlots() : null
1002 return $this->slotsUpdate
;
1006 * Returns the role names of the slots touched by the new revision,
1007 * including removed roles.
1011 public function getTouchedSlotRoles() {
1012 return $this->getRevisionSlotsUpdate()->getTouchedRoles();
1016 * Returns the role names of the slots modified by the new revision,
1017 * not including removed roles.
1021 public function getModifiedSlotRoles() {
1022 return $this->getRevisionSlotsUpdate()->getModifiedRoles();
1026 * Returns the role names of the slots removed by the new revision.
1030 public function getRemovedSlotRoles() {
1031 return $this->getRevisionSlotsUpdate()->getRemovedRoles();
1035 * Prepare derived data updates targeting the given Revision.
1037 * Calling this method requires the given revision to be present in the database.
1038 * This may be right after a new revision has been created, or when re-generating
1039 * derived data e.g. in ApiPurge, RefreshLinksJob, and the refreshLinks
1042 * @see docs/pageupdater.txt for more information on when thie method can and should be called.
1044 * @note Calling this method more than once with the same revision has no effect.
1045 * $options are only used for the first call. Calling this method multiple times with
1046 * different revisions will cause an exception.
1048 * @note If grabCurrentRevision() (or prepareContent()) has been called before
1049 * calling this method, $revision->getParentRevision() has to refer to the revision that
1050 * was the current revision at the time grabCurrentRevision() was called.
1052 * @param RevisionRecord $revision
1053 * @param array $options Array of options, following indexes are used:
1054 * - changed: bool, whether the revision changed the content (default true)
1055 * - created: bool, whether the revision created the page (default false)
1056 * - moved: bool, whether the page was moved (default false)
1057 * - restored: bool, whether the page was undeleted (default false)
1058 * - oldrevision: Revision object for the pre-update revision (default null)
1059 * - triggeringUser: The user triggering the update (UserIdentity, defaults to the
1060 * user who created the revision)
1061 * - oldredirect: bool, null, or string 'no-change' (default null):
1062 * - bool: whether the page was counted as a redirect before that
1063 * revision, only used in changed is true and created is false
1064 * - null or 'no-change': don't update the redirect status.
1065 * - oldcountable: bool, null, or string 'no-change' (default null):
1066 * - bool: whether the page was counted as an article before that
1067 * revision, only used in changed is true and created is false
1068 * - null: if created is false, don't update the article count; if created
1069 * is true, do update the article count
1070 * - 'no-change': don't update the article count, ever
1071 * When set to null, pageState['oldCountable'] will be used instead if available.
1072 * - causeAction: an arbitrary string identifying the reason for the update.
1073 * See DataUpdate::getCauseAction(). (default 'unknown')
1074 * - causeAgent: name of the user who caused the update. See DataUpdate::getCauseAgent().
1075 * (string, default 'unknown')
1076 * - known-revision-output: a combined canonical ParserOutput for the revision, perhaps
1077 * from some cache. The caller is responsible for ensuring that the ParserOutput indeed
1078 * matched the $rev and $options. This mechanism is intended as a temporary stop-gap,
1079 * for the time until caches have been changed to store RenderedRevision states instead
1080 * of ParserOutput objects. (default: null) (since 1.33)
1082 public function prepareUpdate( RevisionRecord
$revision, array $options = [] ) {
1084 !isset( $options['oldrevision'] )
1085 ||
$options['oldrevision'] instanceof Revision
1086 ||
$options['oldrevision'] instanceof RevisionRecord
,
1087 '$options["oldrevision"]',
1088 'must be a RevisionRecord (or Revision)'
1091 !isset( $options['triggeringUser'] )
1092 ||
$options['triggeringUser'] instanceof UserIdentity
,
1093 '$options["triggeringUser"]',
1094 'must be a UserIdentity'
1097 if ( !$revision->getId() ) {
1098 throw new InvalidArgumentException(
1099 'Revision must have an ID set for it to be used with prepareUpdate()!'
1103 if ( $this->revision
&& $this->revision
->getId() ) {
1104 if ( $this->revision
->getId() === $revision->getId() ) {
1105 return; // nothing to do!
1107 throw new LogicException(
1108 'Trying to re-use DerivedPageDataUpdater with revision '
1109 . $revision->getId()
1110 . ', but it\'s already bound to revision '
1111 . $this->revision
->getId()
1116 if ( $this->revision
1117 && !$this->revision
->getSlots()->hasSameContent( $revision->getSlots() )
1119 throw new LogicException(
1120 'The Revision provided has mismatching content!'
1124 // Override fields defined in $this->options with values from $options.
1125 $this->options
= array_intersect_key( $options, $this->options
) +
$this->options
;
1127 if ( $this->revision
) {
1128 $oldId = $this->pageState
['oldId'] ??
0;
1129 $this->options
['newrev'] = ( $revision->getId() !== $oldId );
1130 } elseif ( isset( $this->options
['oldrevision'] ) ) {
1131 /** @var Revision|RevisionRecord $oldRev */
1132 $oldRev = $this->options
['oldrevision'];
1133 $oldId = $oldRev->getId();
1134 $this->options
['newrev'] = ( $revision->getId() !== $oldId );
1136 $oldId = $revision->getParentId();
1139 if ( $oldId !== null ) {
1140 // XXX: what if $options['changed'] disagrees?
1141 // MovePage creates a dummy revision with changed = false!
1142 // We may want to explicitly distinguish between "no new revision" (null-edit)
1143 // and "new revision without new content" (dummy revision).
1145 if ( $oldId === $revision->getParentId() ) {
1146 // NOTE: this may still be a NullRevision!
1148 $this->options
['changed'] = true;
1149 } elseif ( $oldId === $revision->getId() ) {
1151 $this->options
['changed'] = false;
1153 // This indicates that calling code has given us the wrong Revision object
1154 throw new LogicException(
1155 'The Revision mismatches old revision ID: '
1156 . 'Old ID is ' . $oldId
1157 . ', parent ID is ' . $revision->getParentId()
1158 . ', revision ID is ' . $revision->getId()
1163 // If prepareContent() was used to generate the PST content (which is indicated by
1164 // $this->slotsUpdate being set), and this is not a null-edit, then the given
1165 // revision must have the acting user as the revision author. Otherwise, user
1166 // signatures generated by PST would mismatch the user in the revision record.
1167 if ( $this->user
!== null && $this->options
['changed'] && $this->slotsUpdate
) {
1168 $user = $revision->getUser();
1169 if ( !$this->user
->equals( $user ) ) {
1170 throw new LogicException(
1171 'The Revision provided has a mismatching actor: expected '
1172 . $this->user
->getName()
1179 // If $this->pageState was not yet initialized by grabCurrentRevision or prepareContent,
1180 // emulate the state of the page table before the edit, as good as we can.
1181 if ( !$this->pageState
) {
1182 $this->pageState
= [
1183 'oldIsRedirect' => isset( $this->options
['oldredirect'] )
1184 && is_bool( $this->options
['oldredirect'] )
1185 ?
$this->options
['oldredirect']
1187 'oldCountable' => isset( $this->options
['oldcountable'] )
1188 && is_bool( $this->options
['oldcountable'] )
1189 ?
$this->options
['oldcountable']
1193 if ( $this->options
['changed'] ) {
1194 // The edit created a new revision
1195 $this->pageState
['oldId'] = $revision->getParentId();
1197 if ( isset( $this->options
['oldrevision'] ) ) {
1198 $rev = $this->options
['oldrevision'];
1199 $this->pageState
['oldRevision'] = $rev instanceof Revision
1200 ?
$rev->getRevisionRecord()
1204 // This is a null-edit, so the old revision IS the new revision!
1205 $this->pageState
['oldId'] = $revision->getId();
1206 $this->pageState
['oldRevision'] = $revision;
1210 // "created" is forced here
1211 $this->options
['created'] = ( $this->options
['created'] ||
1212 ( $this->pageState
['oldId'] === 0 ) );
1214 $this->revision
= $revision;
1216 $this->doTransition( 'has-revision' );
1218 // NOTE: in case we have a User object, don't override with a UserIdentity.
1219 // We already checked that $revision->getUser() mathces $this->user;
1220 if ( !$this->user
) {
1221 $this->user
= $revision->getUser( RevisionRecord
::RAW
);
1224 // Prune any output that depends on the revision ID.
1225 if ( $this->renderedRevision
) {
1226 $this->renderedRevision
->updateRevision( $revision );
1228 // NOTE: we want a canonical rendering, so don't pass $this->user or ParserOptions
1229 // NOTE: the revision is either new or current, so we can bypass audience checks.
1230 $this->renderedRevision
= $this->revisionRenderer
->getRenderedRevision(
1235 'use-master' => $this->useMaster(),
1236 'audience' => RevisionRecord
::RAW
,
1237 'known-revision-output' => $options['known-revision-output'] ??
null
1241 // XXX: Since we presumably are dealing with the current revision,
1242 // we could try to get the ParserOutput from the parser cache.
1245 // TODO: optionally get ParserOutput from the ParserCache here.
1246 // Move the logic used by RefreshLinksJob here!
1250 * @deprecated This only exists for B/C, use the getters on DerivedPageDataUpdater directly!
1251 * @return PreparedEdit
1253 public function getPreparedEdit() {
1254 $this->assertPrepared( __METHOD__
);
1256 $slotsUpdate = $this->getRevisionSlotsUpdate();
1257 $preparedEdit = new PreparedEdit();
1259 $preparedEdit->popts
= $this->getCanonicalParserOptions();
1260 $preparedEdit->parserOutputCallback
= [ $this, 'getCanonicalParserOutput' ];
1261 $preparedEdit->pstContent
= $this->revision
->getContent( SlotRecord
::MAIN
);
1262 $preparedEdit->newContent
=
1263 $slotsUpdate->isModifiedSlot( SlotRecord
::MAIN
)
1264 ?
$slotsUpdate->getModifiedSlot( SlotRecord
::MAIN
)->getContent()
1265 : $this->revision
->getContent( SlotRecord
::MAIN
); // XXX: can we just remove this?
1266 $preparedEdit->oldContent
= null; // unused. // XXX: could get this from the parent revision
1267 $preparedEdit->revid
= $this->revision ?
$this->revision
->getId() : null;
1268 $preparedEdit->timestamp
= $preparedEdit->output
->getCacheTime();
1269 $preparedEdit->format
= $preparedEdit->pstContent
->getDefaultFormat();
1271 return $preparedEdit;
1275 * @param string $role
1276 * @param bool $generateHtml
1277 * @return ParserOutput
1279 public function getSlotParserOutput( $role, $generateHtml = true ) {
1280 return $this->getRenderedRevision()->getSlotParserOutput(
1282 [ 'generate-html' => $generateHtml ]
1287 * @return ParserOutput
1289 public function getCanonicalParserOutput() {
1290 return $this->getRenderedRevision()->getRevisionParserOutput();
1294 * @return ParserOptions
1296 public function getCanonicalParserOptions() {
1297 return $this->getRenderedRevision()->getOptions();
1301 * @param bool $recursive
1303 * @return DeferrableUpdate[]
1305 public function getSecondaryDataUpdates( $recursive = false ) {
1306 if ( $this->isContentDeleted() ) {
1307 // This shouldn't happen, since the current content is always public,
1308 // and DataUpates are only needed for current content.
1312 $output = $this->getCanonicalParserOutput();
1314 // Construct a LinksUpdate for the combined canonical output.
1315 $linksUpdate = new LinksUpdate(
1321 $allUpdates = [ $linksUpdate ];
1323 // NOTE: Run updates for all slots, not just the modified slots! Otherwise,
1324 // info for an inherited slot may end up being removed. This is also needed
1325 // to ensure that purges are effective.
1326 $renderedRevision = $this->getRenderedRevision();
1327 foreach ( $this->getSlots()->getSlotRoles() as $role ) {
1328 $slot = $this->getRawSlot( $role );
1329 $content = $slot->getContent();
1330 $handler = $content->getContentHandler();
1332 $updates = $handler->getSecondaryDataUpdates(
1338 $allUpdates = array_merge( $allUpdates, $updates );
1340 // TODO: remove B/C hack in 1.32!
1341 // NOTE: we assume that the combined output contains all relevant meta-data for
1343 $legacyUpdates = $content->getSecondaryDataUpdates(
1350 // HACK: filter out redundant and incomplete LinksUpdates
1351 $legacyUpdates = array_filter( $legacyUpdates, function ( $update ) {
1352 return !( $update instanceof LinksUpdate
);
1355 $allUpdates = array_merge( $allUpdates, $legacyUpdates );
1358 // XXX: if a slot was removed by an earlier edit, but deletion updates failed to run at
1359 // that time, we don't know for which slots to run deletion updates when purging a page.
1360 // We'd have to examine the entire history of the page to determine that. Perhaps there
1361 // could be a "try extra hard" mode for that case that would run a DB query to find all
1362 // roles/models ever used on the page. On the other hand, removing slots should be quite
1363 // rare, so perhaps this isn't worth the trouble.
1365 // TODO: consolidate with similar logic in WikiPage::getDeletionUpdates()
1366 $wikiPage = $this->getWikiPage();
1367 $parentRevision = $this->getParentRevision();
1368 foreach ( $this->getRemovedSlotRoles() as $role ) {
1369 // HACK: we should get the content model of the removed slot from a SlotRoleHandler!
1370 // For now, find the slot in the parent revision - if the slot was removed, it should
1371 // always exist in the parent revision.
1372 $parentSlot = $parentRevision->getSlot( $role, RevisionRecord
::RAW
);
1373 $content = $parentSlot->getContent();
1374 $handler = $content->getContentHandler();
1376 $updates = $handler->getDeletionUpdates(
1380 $allUpdates = array_merge( $allUpdates, $updates );
1382 // TODO: remove B/C hack in 1.32!
1383 $legacyUpdates = $content->getDeletionUpdates( $wikiPage );
1385 // HACK: filter out redundant and incomplete LinksDeletionUpdate
1386 $legacyUpdates = array_filter( $legacyUpdates, function ( $update ) {
1387 return !( $update instanceof LinksDeletionUpdate
);
1390 $allUpdates = array_merge( $allUpdates, $legacyUpdates );
1393 // TODO: hard deprecate SecondaryDataUpdates in favor of RevisionDataUpdates in 1.33!
1395 'RevisionDataUpdates',
1396 [ $this->getTitle(), $renderedRevision, &$allUpdates ]
1403 * Do standard updates after page edit, purge, or import.
1404 * Update links tables, site stats, search index, title cache, message cache, etc.
1405 * Purges pages that depend on this page when appropriate.
1406 * With a 10% chance, triggers pruning the recent changes table.
1408 * @note prepareUpdate() must be called before calling this method!
1410 * MCR migration note: this replaces WikiPage::doEditUpdates.
1412 public function doUpdates() {
1413 $this->assertTransition( 'done' );
1415 // TODO: move logic into a PageEventEmitter service
1417 $wikiPage = $this->getWikiPage(); // TODO: use only for legacy hooks!
1419 $legacyUser = User
::newFromIdentity( $this->user
);
1420 $legacyRevision = new Revision( $this->revision
);
1422 $userParserOptions = ParserOptions
::newFromUser( $legacyUser );
1423 // Decide whether to save the final canonical parser ouput based on the fact that
1424 // users are typically redirected to viewing pages right after they edit those pages.
1425 // Due to vary-revision-id, getting/saving that output here might require a reparse.
1426 if ( $userParserOptions->matchesForCacheKey( $this->getCanonicalParserOptions() ) ) {
1427 // Whether getting the final output requires a reparse or not, the user will
1428 // need canonical output anyway, since that is what their parser options use.
1429 // A reparse now at least has the benefit of various warm process caches.
1430 $this->doParserCacheUpdate();
1432 // If the user does not have canonical parse options, then don't risk another parse
1433 // to make output they cannot use on the page refresh that typically occurs after
1434 // editing. Doing the parser output save post-send will still benefit *other* users.
1435 DeferredUpdates
::addCallableUpdate( function () {
1436 $this->doParserCacheUpdate();
1440 // Defer the getCannonicalParserOutput() call triggered by getSecondaryDataUpdates()
1441 // by wrapping the code that schedules the secondary updates in a callback itself
1442 $wrapperUpdate = new MWCallableUpdate(
1444 $this->doSecondaryDataUpdates( [
1445 // T52785 do not update any other pages on a null edit
1446 'recursive' => $this->options
['changed']
1451 $wrapperUpdate->setTransactionRoundRequirement( $wrapperUpdate::TRX_ROUND_ABSENT
);
1452 DeferredUpdates
::addUpdate( $wrapperUpdate );
1454 // TODO: MCR: check if *any* changed slot supports categories!
1455 if ( $this->rcWatchCategoryMembership
1456 && $this->getContentHandler( SlotRecord
::MAIN
)->supportsCategories() === true
1457 && ( $this->options
['changed'] ||
$this->options
['created'] )
1458 && !$this->options
['restored']
1460 // Note: jobs are pushed after deferred updates, so the job should be able to see
1461 // the recent change entry (also done via deferred updates) and carry over any
1462 // bot/deletion/IP flags, ect.
1463 $this->jobQueueGroup
->lazyPush(
1464 CategoryMembershipChangeJob
::newSpec(
1466 $this->revision
->getTimestamp()
1471 // TODO: replace legacy hook! Use a listener on PageEventEmitter instead!
1472 // @note: Extensions should *avoid* calling getCannonicalParserOutput() when using
1473 // this hook whenever possible in order to avoid unnecessary additional parses.
1474 $editInfo = $this->getPreparedEdit();
1475 Hooks
::run( 'ArticleEditUpdates',
1476 [ &$wikiPage, &$editInfo, $this->options
['changed'] ] );
1478 // TODO: replace legacy hook! Use a listener on PageEventEmitter instead!
1479 if ( Hooks
::run( 'ArticleEditUpdatesDeleteFromRecentchanges', [ &$wikiPage ] ) ) {
1480 // Flush old entries from the `recentchanges` table
1481 if ( mt_rand( 0, 9 ) == 0 ) {
1482 $this->jobQueueGroup
->lazyPush( RecentChangesUpdateJob
::newPurgeJob() );
1486 $id = $this->getPageId();
1487 $title = $this->getTitle();
1488 $shortTitle = $title->getDBkey();
1490 if ( !$title->exists() ) {
1491 wfDebug( __METHOD__
. ": Page doesn't exist any more, bailing out\n" );
1493 $this->doTransition( 'done' );
1497 DeferredUpdates
::addCallableUpdate( function () {
1499 $this->options
['oldcountable'] === 'no-change' ||
1500 ( !$this->options
['changed'] && !$this->options
['moved'] )
1503 } elseif ( $this->options
['created'] ) {
1504 $good = (int)$this->isCountable();
1505 } elseif ( $this->options
['oldcountable'] !== null ) {
1506 $good = (int)$this->isCountable()
1507 - (int)$this->options
['oldcountable'];
1508 } elseif ( isset( $this->pageState
['oldCountable'] ) ) {
1509 $good = (int)$this->isCountable()
1510 - (int)$this->pageState
['oldCountable'];
1514 $edits = $this->options
['changed'] ?
1 : 0;
1515 $pages = $this->options
['created'] ?
1 : 0;
1517 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory(
1518 [ 'edits' => $edits, 'articles' => $good, 'pages' => $pages ]
1522 // TODO: make search infrastructure aware of slots!
1523 $mainSlot = $this->revision
->getSlot( SlotRecord
::MAIN
);
1524 if ( !$mainSlot->isInherited() && !$this->isContentDeleted() ) {
1525 DeferredUpdates
::addUpdate( new SearchUpdate( $id, $title, $mainSlot->getContent() ) );
1528 // If this is another user's talk page, update newtalk.
1529 // Don't do this if $options['changed'] = false (null-edits) nor if
1530 // it's a minor edit and the user making the edit doesn't generate notifications for those.
1531 if ( $this->options
['changed']
1532 && $title->getNamespace() == NS_USER_TALK
1533 && $shortTitle != $legacyUser->getTitleKey()
1534 && !( $this->revision
->isMinor() && MediaWikiServices
::getInstance()
1535 ->getPermissionManager()
1536 ->userHasRight( $legacyUser, 'nominornewtalk' ) )
1538 $recipient = User
::newFromName( $shortTitle, false );
1539 if ( !$recipient ) {
1540 wfDebug( __METHOD__
. ": invalid username\n" );
1542 // Allow extensions to prevent user notification
1543 // when a new message is added to their talk page
1544 // TODO: replace legacy hook! Use a listener on PageEventEmitter instead!
1545 if ( Hooks
::run( 'ArticleEditUpdateNewTalk', [ &$wikiPage, $recipient ] ) ) {
1546 if ( User
::isIP( $shortTitle ) ) {
1547 // An anonymous user
1548 $recipient->setNewtalk( true, $legacyRevision );
1549 } elseif ( $recipient->isLoggedIn() ) {
1550 $recipient->setNewtalk( true, $legacyRevision );
1552 wfDebug( __METHOD__
. ": don't need to notify a nonexistent user\n" );
1558 if ( $title->getNamespace() == NS_MEDIAWIKI
1559 && $this->getRevisionSlotsUpdate()->isModifiedSlot( SlotRecord
::MAIN
)
1561 $mainContent = $this->isContentDeleted() ?
null : $this->getRawContent( SlotRecord
::MAIN
);
1563 $this->messageCache
->updateMessageOverride( $title, $mainContent );
1566 // TODO: move onArticleCreate and onArticle into a PageEventEmitter service
1567 if ( $this->options
['created'] ) {
1568 WikiPage
::onArticleCreate( $title );
1569 } elseif ( $this->options
['changed'] ) { // T52785
1570 WikiPage
::onArticleEdit( $title, $legacyRevision, $this->getTouchedSlotRoles() );
1573 $oldRevision = $this->getParentRevision();
1574 $oldLegacyRevision = $oldRevision ?
new Revision( $oldRevision ) : null;
1576 // TODO: In the wiring, register a listener for this on the new PageEventEmitter
1577 ResourceLoaderWikiModule
::invalidateModuleCache(
1581 $this->loadbalancerFactory
->getLocalDomainID()
1584 $this->doTransition( 'done' );
1588 * Do secondary data updates (such as updating link tables).
1590 * MCR note: this method is temporarily exposed via WikiPage::doSecondaryDataUpdates.
1592 * @param array $options
1593 * - recursive: make the update recursive, i.e. also update pages which transclude the
1594 * current page or otherwise depend on it (default: false)
1595 * - defer: one of the DeferredUpdates constants, or false to run immediately after waiting
1596 * for replication of the changes from the SecondaryDataUpdates hooks (default: false)
1599 public function doSecondaryDataUpdates( array $options = [] ) {
1600 $this->assertHasRevision( __METHOD__
);
1601 $options +
= [ 'recursive' => false, 'defer' => false ];
1602 $deferValues = [ false, DeferredUpdates
::PRESEND
, DeferredUpdates
::POSTSEND
];
1603 if ( !in_array( $options['defer'], $deferValues, true ) ) {
1604 throw new InvalidArgumentException( 'Invalid value for defer: ' . $options['defer'] );
1606 $updates = $this->getSecondaryDataUpdates( $options['recursive'] );
1608 $triggeringUser = $this->options
['triggeringUser'] ??
$this->user
;
1609 if ( !$triggeringUser instanceof User
) {
1610 $triggeringUser = User
::newFromIdentity( $triggeringUser );
1612 $causeAction = $this->options
['causeAction'] ??
'unknown';
1613 $causeAgent = $this->options
['causeAgent'] ??
'unknown';
1614 $legacyRevision = new Revision( $this->revision
);
1616 foreach ( $updates as $update ) {
1617 if ( $update instanceof DataUpdate
) {
1618 $update->setCause( $causeAction, $causeAgent );
1620 if ( $update instanceof LinksUpdate
) {
1621 $update->setRevision( $legacyRevision );
1622 $update->setTriggeringUser( $triggeringUser );
1626 if ( $options['defer'] === false ) {
1627 // T221577: flush any transaction; each update needs outer transaction scope
1628 $this->loadbalancerFactory
->commitMasterChanges( __METHOD__
);
1629 foreach ( $updates as $update ) {
1630 DeferredUpdates
::attemptUpdate( $update, $this->loadbalancerFactory
);
1633 foreach ( $updates as $update ) {
1634 DeferredUpdates
::addUpdate( $update, $options['defer'] );
1639 public function doParserCacheUpdate() {
1640 $this->assertHasRevision( __METHOD__
);
1642 $wikiPage = $this->getWikiPage(); // TODO: ParserCache should accept a RevisionRecord instead
1644 // NOTE: this may trigger the first parsing of the new content after an edit (when not
1645 // using pre-generated stashed output).
1646 // XXX: we may want to use the PoolCounter here. This would perhaps allow the initial parse
1647 // to be performed post-send. The client could already follow a HTTP redirect to the
1648 // page view, but would then have to wait for a response until rendering is complete.
1649 $output = $this->getCanonicalParserOutput();
1651 // Save it to the parser cache. Use the revision timestamp in the case of a
1652 // freshly saved edit, as that matches page_touched and a mismatch would trigger an
1653 // unnecessary reparse.
1654 $timestamp = $this->options
['newrev'] ?
$this->revision
->getTimestamp()
1655 : $output->getCacheTime();
1656 $this->parserCache
->save(
1657 $output, $wikiPage, $this->getCanonicalParserOptions(),
1658 $timestamp, $this->revision
->getId()