A handle for managing updates for derived page data on edit, import, purge, etc. More...

Inherits LoggerAwareInterface, and MediaWiki\Storage\PreparedUpdate.

Collaboration diagram for MediaWiki\Storage\DerivedPageDataUpdater:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, PageIdentity $page, RevisionStore $revisionStore, RevisionRenderer $revisionRenderer, SlotRoleRegistry $slotRoleRegistry, ParserCache $parserCache, JobQueueGroup $jobQueueGroup, Language $contLang, ILBFactory $loadbalancerFactory, IContentHandlerFactory $contentHandlerFactory, HookContainer $hookContainer, DomainEventDispatcher $eventDispatcher, EditResultCache $editResultCache, ContentTransformer $contentTransformer, PageEditStash $pageEditStash, WANObjectCache $mainWANObjectCache, WikiPageFactory $wikiPageFactory, ChangeTagsStore $changeTagsStore)

	dispatchPageUpdatedEvent ()

	doParserCacheUpdate ()
	Causes parser cache entries to be updated.

	doSecondaryDataUpdates (array $options=[])
	Do secondary data updates (e.g.

	doUpdates ()
	Do standard updates after page edit, purge, or import.

	getCanonicalParserOptions ()

	getCanonicalParserOutput ()
	Returns the canonical parser output.Code that does not need access to the rendered HTML should use getParserOutputForMetaData() instead. Returns ParserOutput

	getModifiedSlotRoles ()
	Returns the role names of the slots modified by the new revision, not including removed roles.

	getPage ()
	Returns the page being updated.

	getParserOutputForMetaData ()

	getPreparedEdit ()

	getRawContent (string $role)
	Returns the content of the given slot, with no audience checks.

	getRawSlot ( $role)
	Returns the slot, modified or inherited, after PST, with no audience checks applied.

	getRemovedSlotRoles ()
	Returns the role names of the slots removed by the new revision.

	getRenderedRevision ()
	Returns a RenderedRevision instance acting as a lazy holder for the ParserOutput of the revision.

	getRevision ()
	Returns the update's target revision - that is, the revision that will be the current revision after the update.

	getSecondaryDataUpdates ( $recursive=false)

	getSlotParserOutput ( $role, $generateHtml=true)

	getSlots ()
	Returns the slots of the target revision, after PST.

	getTouchedSlotRoles ()
	Returns the role names of the slots touched by the new revision, including removed roles.

	grabCurrentRevision ()
	Returns the revision that was the page's current revision when grabCurrentRevision() was first called.

	isChange ()
	Whether the content of the current revision after the edit is different from the content of the current revision before the edit.

	isContentDeleted ()
	Whether the content is deleted and thus not visible to the public.

	isContentPrepared ()
	Whether prepareUpdate() or prepareContent() have been called on this instance.

	isCountable ()
	Whether the page will be countable after the edit.

	isCreation ()
	Whether the edit creates the page.

	isRedirect ()
	Whether the page will be a redirect after the edit.

	isReusableFor (?UserIdentity $user=null, ?RevisionRecord $revision=null, ?RevisionSlotsUpdate $slotsUpdate=null, $parentId=null)
	Checks whether this DerivedPageDataUpdater can be re-used for running updates targeting the given revision.

	isUpdatePrepared ()
	Whether prepareUpdate() has been called on this instance.

	pageExisted ()
	Determines whether the page being edited already existed.

	prepareContent (UserIdentity $user, RevisionSlotsUpdate $slotsUpdate, $useStash=true)
	Prepare updates based on an update which has not yet been saved.

	prepareUpdate (RevisionRecord $revision, array $options=[])
	Prepare derived data updates targeting the given RevisionRecord.

	setArticleCountMethod ( $articleCountMethod)

	setCause (string $cause)
	Set the cause of the update.

	setForceEmptyRevision (bool $forceEmptyRevision)
	Set whether null-edits should create a revision.

	setLogger (LoggerInterface $logger)

	setPerformer (UserIdentity $performer)
	Set the performer of the action.

	setRcWatchCategoryMembership ( $rcWatchCategoryMembership)

	wasRedirect ()
	Whether the page was a redirect before the edit.

Detailed Description

A handle for managing updates for derived page data on edit, import, purge, etc.

Note: Avoid direct usage of DerivedPageDataUpdater.

Todo: Define interfaces for the different use cases of DerivedPageDataUpdater, particularly providing access to post-PST content and ParserOutput to callbacks during revision creation, which currently use WikiPage::prepareContentForEdit, and allowing updates to be triggered on purge, import, and undeletion, which currently use WikiPage::doEditUpdates() and Content::getSecondaryDataUpdates().

DerivedPageDataUpdater instances are designed to be cached inside a WikiPage instance, and re-used by callback code over the course of an update operation. It's a stepping stone on the way to a more complete refactoring of WikiPage.

When using a DerivedPageDataUpdater, the following life cycle must be observed: grabCurrentRevision (optional), prepareContent (optional), prepareUpdate (required for doUpdates). getCanonicalParserOutput, getSlots, and getSecondaryDataUpdates require prepareContent or prepareUpdate to have been called first, to initialize the DerivedPageDataUpdater.

MCR migration note: this replaces the relevant methods in WikiPage, and covers the use cases of PreparedEdit.

See also: docs/pageupdater.md for more information.

Access: internal

Since: 1.32

Definition at line 105 of file DerivedPageDataUpdater.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Storage\DerivedPageDataUpdater::__construct	(	ServiceOptions	$options,
		PageIdentity	$page,
		RevisionStore	$revisionStore,
		RevisionRenderer	$revisionRenderer,
		SlotRoleRegistry	$slotRoleRegistry,
		ParserCache	$parserCache,
		JobQueueGroup	$jobQueueGroup,
		Language	$contLang,
		ILBFactory	$loadbalancerFactory,
		IContentHandlerFactory	$contentHandlerFactory,
		HookContainer	$hookContainer,
		DomainEventDispatcher	$eventDispatcher,
		EditResultCache	$editResultCache,
		ContentTransformer	$contentTransformer,
		PageEditStash	$pageEditStash,
		WANObjectCache	$mainWANObjectCache,
		WikiPageFactory	$wikiPageFactory,
		ChangeTagsStore	$changeTagsStore )

Definition at line 317 of file DerivedPageDataUpdater.php.

References MediaWiki\Config\ServiceOptions\get(), MediaWiki\Page\WikiPageFactory\newFromTitle(), MediaWiki\MainConfigNames\ParsoidCacheConfig, and MediaWiki\MainConfigNames\UseRCPatrol.

Member Function Documentation

◆ dispatchPageUpdatedEvent()

MediaWiki\Storage\DerivedPageDataUpdater::dispatchPageUpdatedEvent ( )

Access: internal

Definition at line 1700 of file DerivedPageDataUpdater.php.

◆ doParserCacheUpdate()

MediaWiki\Storage\DerivedPageDataUpdater::doParserCacheUpdate ( )

Causes parser cache entries to be updated.

Note: This does not update links tables. Use doSecondaryDataUpdates() for that.; Application logic should use Wikipage::updateParserCache instead.

Definition at line 1857 of file DerivedPageDataUpdater.php.

◆ doSecondaryDataUpdates()

MediaWiki\Storage\DerivedPageDataUpdater::doSecondaryDataUpdates ( array $options = [] )

Do secondary data updates (e.g.

updating link tables) or schedule them as deferred updates

Note: This does not update the parser cache. Use doParserCacheUpdate() for that.; Application logic should use Wikipage::doSecondaryDataUpdates instead.

Parameters

array

$options

recursive: make the update recursive, i.e. also update pages which transclude the current page or otherwise depend on it (default: false)
defer: one of the DeferredUpdates constants, or false to run immediately after waiting for replication of the changes from the SecondaryDataUpdates hooks (default: false)
freshness: used with 'defer'; forces an update if the last update was before the given timestamp, even if the page and its dependencies didn't change since then (TS_MW; default: false)

Since: 1.32

Definition at line 1815 of file DerivedPageDataUpdater.php.

◆ doUpdates()

MediaWiki\Storage\DerivedPageDataUpdater::doUpdates ( )

Do standard updates after page edit, purge, or import.

Update links tables and other derived data. Purges pages that depend on this page when appropriate. With a 10% chance, triggers pruning the recent changes table.

Further updates may be triggered by core components and extensions that listen to the PageRevisionUpdated event. Search for method names starting with "handlePageUpdatedEvent" to find listeners.

Note: prepareUpdate() must be called before calling this method!

MCR migration note: this replaces WikiPage::doEditUpdates.

Definition at line 1570 of file DerivedPageDataUpdater.php.

References MediaWiki\Page\WikiPage\getId(), getTitle(), and wfDebug().

◆ getCanonicalParserOptions()

MediaWiki\Storage\DerivedPageDataUpdater::getCanonicalParserOptions ( )

Definition at line 1447 of file DerivedPageDataUpdater.php.

◆ getCanonicalParserOutput()

MediaWiki\Storage\DerivedPageDataUpdater::getCanonicalParserOutput ( )

Returns the canonical parser output.Code that does not need access to the rendered HTML should use getParserOutputForMetaData() instead.

Returns: ParserOutput

Returns: ParserOutput

Implements MediaWiki\Storage\PreparedUpdate.

Definition at line 1443 of file DerivedPageDataUpdater.php.

◆ getModifiedSlotRoles()

MediaWiki\Storage\DerivedPageDataUpdater::getModifiedSlotRoles ( )

Returns the role names of the slots modified by the new revision, not including removed roles.

Returns: string[]

Implements MediaWiki\Storage\PreparedUpdate.

Definition at line 1152 of file DerivedPageDataUpdater.php.

◆ getPage()

MediaWiki\Storage\DerivedPageDataUpdater::getPage ( )

Returns the page being updated.

Since: 1.37

Returns: ProperPageIdentity (narrowed to ProperPageIdentity in 1.44)

Implements MediaWiki\Storage\PreparedUpdate.

Definition at line 564 of file DerivedPageDataUpdater.php.

◆ getParserOutputForMetaData()

MediaWiki\Storage\DerivedPageDataUpdater::getParserOutputForMetaData ( )

Since: 1.37

Returns: ParserOutput

Implements MediaWiki\Storage\PreparedUpdate.

Definition at line 1435 of file DerivedPageDataUpdater.php.

◆ getPreparedEdit()

MediaWiki\Storage\DerivedPageDataUpdater::getPreparedEdit ( )

Deprecated: since 1.43; This only exists for B/C, use the getters on DerivedPageDataUpdater directly!

Returns: PreparedEdit

Definition at line 1399 of file DerivedPageDataUpdater.php.

◆ getRawContent()

MediaWiki\Storage\DerivedPageDataUpdater::getRawContent ( string $role )

Returns the content of the given slot, with no audience checks.

Exceptions

PageUpdateException If the slot is neither set for update nor inherited from the parent revision.

Parameters

string $role slot role name

Returns: Content

Implements MediaWiki\Storage\PreparedUpdate.

Definition at line 734 of file DerivedPageDataUpdater.php.

◆ getRawSlot()

MediaWiki\Storage\DerivedPageDataUpdater::getRawSlot ( $role )

Returns the slot, modified or inherited, after PST, with no audience checks applied.

Parameters

string $role slot role name

Exceptions

PageUpdateException If the slot is neither set for update nor inherited from the parent revision.

Returns: SlotRecord

Definition at line 722 of file DerivedPageDataUpdater.php.

◆ getRemovedSlotRoles()

MediaWiki\Storage\DerivedPageDataUpdater::getRemovedSlotRoles ( )

Returns the role names of the slots removed by the new revision.

Returns: string[]

Implements MediaWiki\Storage\PreparedUpdate.

Definition at line 1161 of file DerivedPageDataUpdater.php.

◆ getRenderedRevision()

MediaWiki\Storage\DerivedPageDataUpdater::getRenderedRevision ( )

Returns a RenderedRevision instance acting as a lazy holder for the ParserOutput of the revision.

Returns: RenderedRevision

Implements MediaWiki\Storage\PreparedUpdate.

Definition at line 1026 of file DerivedPageDataUpdater.php.

◆ getRevision()

MediaWiki\Storage\DerivedPageDataUpdater::getRevision ( )

Returns the update's target revision - that is, the revision that will be the current revision after the update.

Note: Callers must treat the returned RevisionRecord's content as immutable, even if it is a MutableRevisionRecord instance. Other aspects of a MutableRevisionRecord returned from here, such as the user or the comment, may be changed, but may not be reflected in ParserOutput until after prepareUpdate() has been called.

Todo: This is currently used by PageUpdater::makeNewRevision() to construct an unsaved MutableRevisionRecord instance. Introduce something like an UnsavedRevisionFactory service for that purpose instead!

Returns: RevisionRecord

Implements MediaWiki\Storage\PreparedUpdate.

Definition at line 1021 of file DerivedPageDataUpdater.php.

◆ getSecondaryDataUpdates()

MediaWiki\Storage\DerivedPageDataUpdater::getSecondaryDataUpdates ( $recursive = false )

Parameters

bool $recursive

Returns: DeferrableUpdate[]

Definition at line 1456 of file DerivedPageDataUpdater.php.

References MediaWiki\Page\WikiPage\exists(), MediaWiki\Page\WikiPage\getTitle(), and MediaWiki\Page\WikiPage\loadPageData().

◆ getSlotParserOutput()

MediaWiki\Storage\DerivedPageDataUpdater::getSlotParserOutput	(		$role,
			$generateHtml = true )

Parameters

string	$role
bool	$generateHtml

Returns: ParserOutput

Definition at line 1424 of file DerivedPageDataUpdater.php.

◆ getSlots()

MediaWiki\Storage\DerivedPageDataUpdater::getSlots ( )

Returns the slots of the target revision, after PST.

Note: Callers must treat the returned RevisionSlots instance as immutable, even if it is a MutableRevisionSlots instance.

Returns: RevisionSlots

Definition at line 1113 of file DerivedPageDataUpdater.php.

◆ getTouchedSlotRoles()

MediaWiki\Storage\DerivedPageDataUpdater::getTouchedSlotRoles ( )

Returns the role names of the slots touched by the new revision, including removed roles.

Returns: string[]

Definition at line 1142 of file DerivedPageDataUpdater.php.

◆ grabCurrentRevision()

MediaWiki\Storage\DerivedPageDataUpdater::grabCurrentRevision ( )

Returns the revision that was the page's current revision when grabCurrentRevision() was first called.

During an edit, that revision will act as the logical parent of the new revision.

Some updates are performed based on the difference between the database state at the moment this method is first called, and the state after the edit.

See also: docs/pageupdater.md for more information on when thie method can and should be called.

Note: After prepareUpdate() was called, grabCurrentRevision() will throw an exception to avoid confusion, since the page's current revision is then the new revision after the edit, which was presumably passed to prepareUpdate() as the $revision parameter. Use getParentRevision() instead to access the revision that is the parent of the new revision.

Returns: RevisionRecord|null the page's current revision, or null if the page does not yet exist.

Definition at line 644 of file DerivedPageDataUpdater.php.

References MediaWiki\Page\WikiPage\getRevisionRecord(), MediaWiki\Page\WikiPage\isCountable(), MediaWiki\Page\WikiPage\isRedirect(), and MediaWiki\Page\WikiPage\loadPageData().

◆ isChange()

MediaWiki\Storage\DerivedPageDataUpdater::isChange ( )

Whether the content of the current revision after the edit is different from the content of the current revision before the edit.

This will return false for a null-edit (no revision created), as well as for a dummy revision (a "null-revision" that has the same content as its parent).

Warning: at present, dummy revision would return false after prepareContent(), but true after prepareUpdate()!

Todo: This should probably be fixed.

Returns: bool

Definition at line 1079 of file DerivedPageDataUpdater.php.

◆ isContentDeleted()

MediaWiki\Storage\DerivedPageDataUpdater::isContentDeleted ( )

Whether the content is deleted and thus not visible to the public.

Returns: bool

Definition at line 704 of file DerivedPageDataUpdater.php.

◆ isContentPrepared()

MediaWiki\Storage\DerivedPageDataUpdater::isContentPrepared ( )

Whether prepareUpdate() or prepareContent() have been called on this instance.

Returns: bool

Definition at line 676 of file DerivedPageDataUpdater.php.

◆ isCountable()

MediaWiki\Storage\DerivedPageDataUpdater::isCountable ( )

Whether the page will be countable after the edit.

Returns: bool

Implements MediaWiki\Storage\PreparedUpdate.

Definition at line 753 of file DerivedPageDataUpdater.php.

◆ isCreation()

MediaWiki\Storage\DerivedPageDataUpdater::isCreation ( )

Whether the edit creates the page.

Returns: bool

Definition at line 1062 of file DerivedPageDataUpdater.php.

◆ isRedirect()

MediaWiki\Storage\DerivedPageDataUpdater::isRedirect ( )

Whether the page will be a redirect after the edit.

Returns: bool

Implements MediaWiki\Storage\PreparedUpdate.

Definition at line 795 of file DerivedPageDataUpdater.php.

◆ isReusableFor()

MediaWiki\Storage\DerivedPageDataUpdater::isReusableFor	(	?UserIdentity	$user = null,
		?RevisionRecord	$revision = null,
		?RevisionSlotsUpdate	$slotsUpdate = null,
			$parentId = null )

Checks whether this DerivedPageDataUpdater can be re-used for running updates targeting the given revision.

Parameters

UserIdentity \| null	$user	The user creating the revision in question
RevisionRecord \| null	$revision	New revision (after save, if already saved)
RevisionSlotsUpdate \| null	$slotsUpdate	New content (before PST)
null \| int	$parentId	Parent revision of the edit (use 0 for page creation)

Returns: bool

Definition at line 449 of file DerivedPageDataUpdater.php.

◆ isUpdatePrepared()

MediaWiki\Storage\DerivedPageDataUpdater::isUpdatePrepared ( )

Whether prepareUpdate() has been called on this instance.

Note: will also return null in case of a null-edit!

Returns: bool

Definition at line 687 of file DerivedPageDataUpdater.php.

◆ pageExisted()

MediaWiki\Storage\DerivedPageDataUpdater::pageExisted ( )

Determines whether the page being edited already existed.

Only defined after calling grabCurrentRevision() or prepareContent() or prepareUpdate()!

Returns: bool

Exceptions

LogicException if called before grabCurrentRevision

Definition at line 575 of file DerivedPageDataUpdater.php.

◆ prepareContent()

MediaWiki\Storage\DerivedPageDataUpdater::prepareContent	(	UserIdentity	$user,
		RevisionSlotsUpdate	$slotsUpdate,
			$useStash = true )

Prepare updates based on an update which has not yet been saved.

This may be used to create derived data that is needed when creating a new revision; particularly, this makes available the slots of the new revision via the getSlots() method, after applying PST and slot inheritance.

The derived data prepared for revision creation may then later be re-used by doUpdates(), without the need to re-calculate.

See also: docs/pageupdater.md for more information on when thie method can and should be called.

Note: Calling this method more than once with the same $slotsUpdate has no effect. Calling this method multiple times with different content will cause an exception.; Calling this method after prepareUpdate() has been called will cause an exception.

Parameters

UserIdentity	$user	The user to act as context for pre-save transformation (PST).
RevisionSlotsUpdate	$slotsUpdate	The new content of the slots to be updated by this edit, before PST.
bool	$useStash	Whether to use stashed ParserOutput

Definition at line 838 of file DerivedPageDataUpdater.php.

References MediaWiki\Title\Title\equals(), MediaWiki\Storage\RevisionSlotsUpdate\getModifiedRoles(), MediaWiki\Storage\RevisionSlotsUpdate\getModifiedSlot(), MediaWiki\User\UserIdentity\getName(), MediaWiki\Storage\RevisionSlotsUpdate\getRemovedRoles(), getTitle(), and MediaWiki\Storage\RevisionSlotsUpdate\isModifiedSlot().

◆ prepareUpdate()

MediaWiki\Storage\DerivedPageDataUpdater::prepareUpdate	(	RevisionRecord	$revision,
		array	$options = [] )

Prepare derived data updates targeting the given RevisionRecord.

Calling this method requires the given revision to be present in the database. This may be right after a new revision has been created, or when re-generating derived data e.g. in ApiPurge, RefreshLinksJob, and the refreshLinks script.

See also: docs/pageupdater.md for more information on when thie method can and should be called.

Note: Calling this method more than once with the same revision has no effect. $options are only used for the first call. Calling this method multiple times with different revisions will cause an exception.; If grabCurrentRevision() (or prepareContent()) has been called before calling this method, $revision->getParentRevision() has to refer to the revision that was the current revision at the time grabCurrentRevision() was called.

Parameters

RevisionRecord	$revision
array	$options	Array of options. Supports the flags defined by PageRevisionUpdatedEvent. In addition, the following keys are supported used: oldtitle: PageIdentity, if the page was moved this is the source title (default null) oldrevision: RevisionRecord object for the pre-update revision (default null) triggeringUser: The user triggering the update (UserIdentity, defaults to the user who created the revision) oldredirect: bool, null, or string 'no-change' (default null): bool: whether the page was counted as a redirect before that revision, only used in changed is true and created is false null or 'no-change': don't update the redirect status. oldcountable: bool, null, or string 'no-change' (default null): bool: whether the page was counted as an article before that revision, only used in changed is true and created is false null: if created is false, don't update the article count; if created is true, do update the article count 'no-change': don't update the article count, ever When set to null, pageState['oldCountable'] will be used instead if available.

cause: the reason for the update, see PageRevisionUpdatedEvent::CAUSE_XXX.
known-revision-output: a combined canonical ParserOutput for the revision, perhaps from some cache. The caller is responsible for ensuring that the ParserOutput indeed matched the $rev and $options. This mechanism is intended as a temporary stop-gap, for the time until caches have been changed to store RenderedRevision states instead of ParserOutput objects. (default: null) (since 1.33)
editResult: EditResult object created during the update. Required to perform reverted tag update using RevertedTagUpdateJob. (default: null) (since 1.36)

Definition at line 1210 of file DerivedPageDataUpdater.php.

References MediaWiki\Revision\RevisionRecord\getId(), MediaWiki\Revision\RevisionRecord\getParentId(), MediaWiki\Revision\RevisionRecord\getSlots(), and MediaWiki\Revision\RevisionRecord\getUser().