Handler for editing activity, providing a unified interface for saving modified entities while performing permission checks and handling edit conflicts. More...

Inheritance diagram for Wikibase\Repo\EditEntity\MediaWikiEditEntity:

Collaboration diagram for Wikibase\Repo\EditEntity\MediaWikiEditEntity:

Public Member Functions
	__construct (EntityTitleStoreLookup $titleLookup, EntityRevisionLookup $entityLookup, EntityStore $entityStore, EntityPermissionChecker $permissionChecker, EntityDiffer $entityDiffer, EntityPatcher $entityPatcher, ?EntityId $entityId, IContextSource $context, EditFilterHookRunner $editFilterHookRunner, UserOptionsLookup $userOptionsLookup, $maxSerializedEntitySize, array $localEntityTypes, int $baseRevId=0, $allowMasterConnection=true)

	getEntityId ()
	Returns the ID of the entity being edited.

	getLatestRevision ()
	Returns the latest revision of the entity.

	getBaseRevision ()
	Return the base revision for the edit.

	getStatus ()
	Get the status object.

	isSuccess ()
	Determines whether the last call to attemptSave was successful.

	hasError ( $errorType=EditEntity::ANY_ERROR)
	Checks whether this EditEntity encountered any of the given error types while executing attemptSave().

	hasEditConflict ()
	Determines whether an edit conflict exists, that is, whether another user has edited the same item after the base revision was created.

	isTokenOK ( $token)
	Make sure the given WebRequest contains a valid edit token.

	attemptSave (EntityDocument $newEntity, string $summary, $flags, $token, $watch=null, array $tags=[])
	Attempts to save the given Entity object.

Private Member Functions
	getTitle ()
	Returns the Title of the page holding the entity that is being edited.

	getLatestRevisionId ()

	isNew ()
	Is the entity new?

	isNewPage ()
	Does this entity belong to a new page? (An entity may `be new`, and yet not belong to a new page, e.g.

	getBaseRevisionId ()
	Return the ID of the base revision for the edit.

	getReplicaMode ()

	fixEditConflict (EntityDocument $newEntity)
	Attempts to fix an edit conflict by patching the intended change into the latest revision after checking for conflicts.

	userWasLastToEdit (User $user=null, EntityId $entityId=null, $lastRevId=false)
	Check if no edits were made by other users since the given revision.

	checkEditPermissions (EntityDocument $newEntity)
	Checks the necessary permissions to perform this edit.

	checkRateLimits ()
	Checks if rate limits have been exceeded.

	getDesiredWatchState ( $watch)
	Resolve user specific default default for watch state, if $watch is null.

	checkEntityId (EntityId $id=null)

	checkReadOnly (EntityDocument $entity)

	entityTypeIsReadOnly (EntityDocument $entity)

	checkLocal (EntityDocument $entity)
	Modifies $this->status and $this->errorType.

	entityTypeIsLocal (EntityDocument $entity)

	getWatchDefault ()
	Returns whether the present edit would, per default, lead to the user watching the page.

	updateWatchlist ( $watch)
	Watches or unwatches the entity.

Private Attributes
	$entityRevisionLookup

	$titleLookup

	$entityStore

	$permissionChecker

	$entityDiffer

	$entityPatcher

	$entityId

	$baseRev = null

	$baseRevId

	$latestRev = null

	$latestRevId = 0

	$status

	$context

	$user

	$title = null

	$editFilterHookRunner

	$userOptionsLookup

	$errorType = 0

	$maxSerializedEntitySize

	$localEntityTypes

	$allowMasterConnection

Additional Inherited Members
Public Attributes inherited from Wikibase\Repo\EditEntity\EditEntity
const	PERMISSION_ERROR = 1
	indicates a permission error

const	EDIT_CONFLICT_ERROR = 2
	indicates an unresolved edit conflict

const	TOKEN_ERROR = 4
	indicates a token or session error

const	SAVE_ERROR = 8
	indicates that an error occurred while saving

const	PRECONDITION_FAILED = 16
	Indicates that the content failed some precondition to saving, such as a global uniqueness constraint.

const	FILTERED = 32
	Indicates that the content triggered an edit filter that uses the EditFilterMergedContent hook to supervise edits.

const	RATE_LIMIT = 64
	Indicates that the edit exceeded a rate limit.

const	ANY_ERROR = 0xFFFFFFFF
	bit mask for asking for any error.

Detailed Description

Handler for editing activity, providing a unified interface for saving modified entities while performing permission checks and handling edit conflicts.

Copyright: GPL-2.0-or-later

Author: John Erling Blad < jebla.nosp@m.d@gm.nosp@m.ail.c.nosp@m.om >; Daniel Kinzler; Thiemo Kreuz

Constructor & Destructor Documentation

◆ __construct()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::__construct	(	EntityTitleStoreLookup	$titleLookup,
		EntityRevisionLookup	$entityLookup,
		EntityStore	$entityStore,
		EntityPermissionChecker	$permissionChecker,
		EntityDiffer	$entityDiffer,
		EntityPatcher	$entityPatcher,
		?EntityId	$entityId,
		IContextSource	$context,
		EditFilterHookRunner	$editFilterHookRunner,
		UserOptionsLookup	$userOptionsLookup,
			$maxSerializedEntitySize,
		array	$localEntityTypes,
		int	$baseRevId = 0,
			$allowMasterConnection = true )

Parameters

EntityTitleStoreLookup	$titleLookup
EntityRevisionLookup	$entityLookup
EntityStore	$entityStore
EntityPermissionChecker	$permissionChecker
EntityDiffer	$entityDiffer
EntityPatcher	$entityPatcher
EntityId \| null	$entityId	the ID of the entity being edited. May be null when creating a new entity.
IContextSource	$context	the request context for the edit
EditFilterHookRunner	$editFilterHookRunner
UserOptionsLookup	$userOptionsLookup
int	$maxSerializedEntitySize	the maximal allowed entity size in Kilobytes
string[]	$localEntityTypes
int	$baseRevId	the base revision ID for conflict checking. Use 0 to indicate that the current revision should be used as the base revision, effectively disabling conflict detections. Note that the behavior of this class changed so that "late" conflicts that arise between edit conflict detection and database update are always detected, and result in the update to fail.
bool	$allowMasterConnection

Member Function Documentation

◆ attemptSave()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::attemptSave	(	EntityDocument	$newEntity,
		string	$summary,
			$flags,
			$token,
			$watch = null,
		array	$tags = [] )

Attempts to save the given Entity object.

This method performs entity level permission checks, checks the edit toke, enforces rate limits, resolves edit conflicts, and updates user watchlists if appropriate.

Success or failure are reported via the Status object returned by this method.

Parameters

EntityDocument	$newEntity
string	$summary	The edit summary.
int	$flags	The EDIT_XXX flags as used by WikiPage::doUserEditContent(). Additionally, the EntityContent::EDIT_XXX constants can be used.
string \| bool	$token	Edit token to check, or false to disable the token check. Null will fail the token text, as will the empty string.
bool \| null	$watch	Whether the user wants to watch the entity. Set to null to apply default according to getWatchDefault().
string[]	$tags	Change tags to add to the edit. Callers are responsible for checking that the user is permitted to add these tags (typically using `ChangeTags::canAddTagsAccompanyingChange`).

Returns: Status

Exceptions

ReadOnlyError

See also: WikiPage::doUserEditContent; EntityStore::saveEntity

Implements Wikibase\Repo\EditEntity\EditEntity.

◆ checkEditPermissions()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::checkEditPermissions ( EntityDocument $newEntity )

private

Checks the necessary permissions to perform this edit.

Per default, the 'edit' permission is checked. Use addRequiredPermission() to check more permissions.

Parameters

EntityDocument $newEntity

◆ checkEntityId()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::checkEntityId ( EntityId $id = null )

private

Parameters

EntityId | null $id

Exceptions

InvalidArgumentException

◆ checkLocal()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::checkLocal ( EntityDocument $entity )

private

Modifies $this->status and $this->errorType.

Does not throw.

◆ checkRateLimits()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::checkRateLimits ( )

private

Checks if rate limits have been exceeded.

◆ checkReadOnly()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::checkReadOnly ( EntityDocument $entity )

private

Parameters

EntityDocument $entity

Exceptions

ReadOnlyError

◆ entityTypeIsLocal()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::entityTypeIsLocal ( EntityDocument $entity )

private

◆ entityTypeIsReadOnly()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::entityTypeIsReadOnly ( EntityDocument $entity )

private

Parameters

EntityDocument $entity

Returns: bool

◆ fixEditConflict()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::fixEditConflict ( EntityDocument $newEntity )

private

Attempts to fix an edit conflict by patching the intended change into the latest revision after checking for conflicts.

Parameters

EntityDocument $newEntity

Returns: null|EntityDocument The patched Entity, or null if patching failed.

◆ getBaseRevision()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::getBaseRevision ( )

Return the base revision for the edit.

If no base revision ID was supplied to the constructor, this returns the latest revision. If the entity does not exist yet, this returns null.

Returns: EntityRevision|null

Exceptions

RevisionedUnresolvedRedirectException
StorageException

Implements Wikibase\Repo\EditEntity\EditEntity.

◆ getBaseRevisionId()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::getBaseRevisionId ( )

private

Return the ID of the base revision for the edit.

If no base revision ID was supplied to the constructor, this returns the ID of the latest revision. If the entity does not exist yet, this returns 0.

Returns: int

◆ getDesiredWatchState()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::getDesiredWatchState ( $watch )

private

Resolve user specific default default for watch state, if $watch is null.

Parameters

bool | null $watch

Returns: bool

◆ getEntityId()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::getEntityId ( )

Returns the ID of the entity being edited.

May be null if a new entity is to be created.

Returns: null|EntityId

Implements Wikibase\Repo\EditEntity\EditEntity.

◆ getLatestRevision()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::getLatestRevision ( )

Returns the latest revision of the entity.

Returns: EntityRevision|null

Implements Wikibase\Repo\EditEntity\EditEntity.

◆ getLatestRevisionId()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::getLatestRevisionId ( )

private

Returns: int 0 if the entity doesn't exist

◆ getReplicaMode()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::getReplicaMode ( )

private

Returns: string

◆ getStatus()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::getStatus ( )

Get the status object.

Only defined after attemptSave() was called.

After a successful save, the Status object's value field will contain an array, just like the status returned by WikiPage::doUserEditContent(). Well known fields in the status value are:

new: bool whether the edit created a new page
revision: Revision the new revision object
errorFlags: bit field indicating errors, see the XXX_ERROR constants.

Returns: Status

Implements Wikibase\Repo\EditEntity\EditEntity.

◆ getTitle()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::getTitle ( )

private

Returns the Title of the page holding the entity that is being edited.

Returns: Title|null

◆ getWatchDefault()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::getWatchDefault ( )

private

Returns whether the present edit would, per default, lead to the user watching the page.

This uses the user's watchdefault and watchcreations settings and considers whether the entity is already watched by the user.

Note: Keep in sync with logic in \MediaWiki\EditPage\EditPage!

Returns: bool

◆ hasEditConflict()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::hasEditConflict ( )

Determines whether an edit conflict exists, that is, whether another user has edited the same item after the base revision was created.

In other words, this method checks whether the base revision (as provided to the constructor) is still current. If no base revision was provided to the constructor, this will always return false.

If the base revision is different from the current revision, this will return true even if the edit conflict is resolvable. Indeed, it is used to determine whether conflict resolution should be attempted.

Returns: bool

Implements Wikibase\Repo\EditEntity\EditEntity.

◆ hasError()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::hasError ( $errorType = EditEntity::ANY_ERROR )

Checks whether this EditEntity encountered any of the given error types while executing attemptSave().

Parameters

int $errorType bit field using the EditEntity::XXX_ERROR constants. Defaults to EditEntity::ANY_ERROR.

Returns: bool true if this EditEntity encountered any of the error types in $errorType, false otherwise.

Implements Wikibase\Repo\EditEntity\EditEntity.

◆ isNew()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::isNew ( )

private

Is the entity new?

Returns: bool

◆ isNewPage()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::isNewPage ( )

private

Does this entity belong to a new page? (An entity may be new, and yet not belong to a new page, e.g.

if it is stored in a non-main slot.)

Returns: bool

◆ isSuccess()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::isSuccess ( )

Determines whether the last call to attemptSave was successful.

Returns: bool false if attemptSave() failed, true otherwise

Implements Wikibase\Repo\EditEntity\EditEntity.

◆ isTokenOK()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::isTokenOK ( $token )

Make sure the given WebRequest contains a valid edit token.

Parameters

string $token The token to check.

Returns: bool true if the token is valid

Implements Wikibase\Repo\EditEntity\EditEntity.

◆ updateWatchlist()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::updateWatchlist ( $watch )

private

Watches or unwatches the entity.

Note: Keep in sync with logic in \MediaWiki\EditPage\EditPage!

Todo: move to separate service

Parameters

bool $watch whether to watch or unwatch the page.

◆ userWasLastToEdit()

Wikibase\Repo\EditEntity\MediaWikiEditEntity::userWasLastToEdit	(	User	$user = null,
		EntityId	$entityId = null,
			$lastRevId = false )

private

Check if no edits were made by other users since the given revision.

This makes the assumption that revision ids are monotonically increasing.

Parameters

User \| null	$user
EntityId \| null	$entityId
int \| bool	$lastRevId

Returns: bool

Member Data Documentation

◆ $allowMasterConnection

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$allowMasterConnection

private

◆ $baseRev

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$baseRev = null

private

◆ $baseRevId

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$baseRevId

private

◆ $context

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$context

private

◆ $editFilterHookRunner

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$editFilterHookRunner

private

◆ $entityDiffer

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$entityDiffer

private

◆ $entityId

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$entityId

private

◆ $entityPatcher

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$entityPatcher

private

◆ $entityRevisionLookup

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$entityRevisionLookup

private

◆ $entityStore

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$entityStore

private

◆ $errorType

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$errorType = 0

private

◆ $latestRev

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$latestRev = null

private

◆ $latestRevId

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$latestRevId = 0

private

◆ $localEntityTypes

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$localEntityTypes

private

◆ $maxSerializedEntitySize

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$maxSerializedEntitySize

private

◆ $permissionChecker

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$permissionChecker

private

◆ $status

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$status

private

◆ $title

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$title = null

private

◆ $titleLookup

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$titleLookup

private

◆ $user

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$user

private

◆ $userOptionsLookup

Wikibase\Repo\EditEntity\MediaWikiEditEntity::$userOptionsLookup

private

The documentation for this class was generated from the following file:

repo/includes/EditEntity/MediaWikiEditEntity.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ attemptSave()

◆ checkEditPermissions()

◆ checkEntityId()

◆ checkLocal()

◆ checkRateLimits()

◆ checkReadOnly()

◆ entityTypeIsLocal()

◆ entityTypeIsReadOnly()

◆ fixEditConflict()

◆ getBaseRevision()

◆ getBaseRevisionId()

◆ getDesiredWatchState()

◆ getEntityId()

◆ getLatestRevision()

◆ getLatestRevisionId()

◆ getReplicaMode()

◆ getStatus()

◆ getTitle()

◆ getWatchDefault()

◆ hasEditConflict()

◆ hasError()

◆ isNew()

◆ isNewPage()

◆ isSuccess()

◆ isTokenOK()

◆ updateWatchlist()

◆ userWasLastToEdit()

Member Data Documentation

◆ $allowMasterConnection

◆ $baseRev

◆ $baseRevId

◆ $context

◆ $editFilterHookRunner

◆ $entityDiffer

◆ $entityId

◆ $entityPatcher

◆ $entityRevisionLookup

◆ $entityStore

◆ $errorType

◆ $latestRev

◆ $latestRevId

◆ $localEntityTypes

◆ $maxSerializedEntitySize

◆ $permissionChecker

◆ $status

◆ $title

◆ $titleLookup

◆ $user

◆ $userOptionsLookup