Backend logic for performing a page delete action. More...

Collaboration diagram for Page\DeletePage:

[legend]

Public Member Functions
	__construct (HookContainer $hookContainer, RevisionStore $revisionStore, LBFactory $lbFactory, JobQueueGroup $jobQueueGroup, CommentStore $commentStore, ServiceOptions $serviceOptions, BagOStuff $recentDeletesCache, string $localWikiID, string $webRequestID, WikiPageFactory $wikiPageFactory, UserFactory $userFactory, BacklinkCacheFactory $backlinkCacheFactory, NamespaceInfo $namespaceInfo, ITextFormatter $contLangMsgTextFormatter, ProperPageIdentity $page, Authority $deleter)

	canProbablyDeleteAssociatedTalk ()
	Tests whether it's probably possible to delete the associated talk page. More...

	deleteIfAllowed (string $reason)
	Same as deleteUnsafe, but checks permissions. More...

	deleteInternal (WikiPage $page, string $pageRole, string $reason, ?string $webRequestId=null)

	deleteUnsafe (string $reason)
	Back-end article deletion: deletes the article with database consistency, writes logs, purges caches. More...

	deletionsWereScheduled ()

	deletionWasScheduled ()

	doDeleteUpdates (WikiPage $page, RevisionRecord $revRecord)

	forceImmediate (bool $forceImmediate)
	If false, allows deleting over time via the job queue. More...

	getDeletionUpdates (WikiPage $page, RevisionRecord $rev)

	getLegacyHookErrors ()

	getSuccessfulDeletionsIDs ()

	isBatchedDelete (int $safetyMargin=0)
	Determines if this deletion would be batched (executed over time by the job queue) or not (completed in the same request as the delete call). More...

	keepLegacyHookErrorsSeparate ()

	setDeleteAssociatedTalk (bool $delete)
	If set to true and the page has a talk page, delete that one too. More...

	setDeletionAttempted ()
	Called before attempting a deletion, allows the result getters to be used. More...

	setIsDeletePageUnitTest (bool $test)

	setLogSubtype (string $logSubtype)
	Set a specific log subtype for the deletion log entry. More...

	setSuppress (bool $suppress)
	If true, suppress all revisions and log the deletion in the suppression log instead of the deletion log. More...

	setTags (array $tags)
	Change tags to apply to the deletion action. More...

Public Attributes
const	CONSTRUCTOR_OPTIONS

const	PAGE_BASE = 'base'
	Constants used for the return value of getSuccessfulDeletionsIDs() and deletionsWereScheduled() More...

const	PAGE_TALK = 'talk'

Private Member Functions
	archiveRevisions (WikiPage $page, int $id)
	Archives revisions as part of page deletion. More...

	assertDeletionAttempted ()
	Asserts that a deletion operation was attempted. More...

	authorizeDeletion ()

	isBigDeletion ()

	runPreDeleteHooks (WikiPage $page, string &$reason)

Private Attributes
WikiPage null	$associatedTalk
	If not null, it means that we have to delete it. More...

bool	$attemptedDeletion = false
	Whether a deletion was attempted. More...

BacklinkCacheFactory	$backlinkCacheFactory

CommentStore	$commentStore

ITextFormatter	$contLangMsgTextFormatter

Authority	$deleter

bool	$forceImmediate = false

HookRunner	$hookRunner

bool	$isDeletePageUnitTest = false

JobQueueGroup	$jobQueueGroup

LBFactory	$lbFactory

string array	$legacyHookErrors = ''

ILoadBalancer	$loadBalancer

string	$localWikiID

string	$logSubtype = 'delete'

bool	$mergeLegacyHookErrors = true

NamespaceInfo	$namespaceInfo

ServiceOptions	$options

WikiPage	$page

BagOStuff	$recentDeletesCache

RevisionStore	$revisionStore

array< int\|null > null	$successfulDeletionsIDs
	Keys are the self::PAGE_* constants. More...

bool	$suppress = false

string[]	$tags = []

UserFactory	$userFactory

array< bool\|null > null	$wasScheduled
	Keys are the self::PAGE_* constants. More...

string	$webRequestID

WikiPageFactory	$wikiPageFactory

Detailed Description

Backend logic for performing a page delete action.

Since: 1.37

Definition at line 52 of file DeletePage.php.

Constructor & Destructor Documentation

◆ __construct()

Page\DeletePage::__construct	(	HookContainer	$hookContainer,
		RevisionStore	$revisionStore,
		LBFactory	$lbFactory,
		JobQueueGroup	$jobQueueGroup,
		CommentStore	$commentStore,
		ServiceOptions	$serviceOptions,
		BagOStuff	$recentDeletesCache,
		string	$localWikiID,
		string	$webRequestID,
		WikiPageFactory	$wikiPageFactory,
		UserFactory	$userFactory,
		BacklinkCacheFactory	$backlinkCacheFactory,
		NamespaceInfo	$namespaceInfo,
		ITextFormatter	$contLangMsgTextFormatter,
		ProperPageIdentity	$page,
		Authority	$deleter
	)

Access: internal: Create via the PageDeleteFactory service.

Parameters

HookContainer	$hookContainer
RevisionStore	$revisionStore
LBFactory	$lbFactory
JobQueueGroup	$jobQueueGroup
CommentStore	$commentStore
ServiceOptions	$serviceOptions
BagOStuff	$recentDeletesCache
string	$localWikiID
string	$webRequestID
WikiPageFactory	$wikiPageFactory
UserFactory	$userFactory
BacklinkCacheFactory	$backlinkCacheFactory
NamespaceInfo	$namespaceInfo
ITextFormatter	$contLangMsgTextFormatter
ProperPageIdentity	$page
Authority	$deleter

Definition at line 155 of file DeletePage.php.

References Page\DeletePage\$backlinkCacheFactory, Page\DeletePage\$commentStore, Page\DeletePage\$contLangMsgTextFormatter, Page\DeletePage\$deleter, Page\DeletePage\$jobQueueGroup, Page\DeletePage\$lbFactory, Page\DeletePage\$localWikiID, Page\DeletePage\$namespaceInfo, Page\DeletePage\$page, Page\DeletePage\$recentDeletesCache, Page\DeletePage\$revisionStore, Page\DeletePage\$userFactory, Page\DeletePage\$webRequestID, Page\DeletePage\$wikiPageFactory, and Page\WikiPageFactory\newFromTitle().

Member Function Documentation

◆ archiveRevisions()

Page\DeletePage::archiveRevisions	(	WikiPage	$page,
		int	$id
	)

private

Archives revisions as part of page deletion.

Parameters

WikiPage	$page
int	$id

Returns: bool

Definition at line 729 of file DeletePage.php.

References $revQuery.

◆ assertDeletionAttempted()

Page\DeletePage::assertDeletionAttempted ( )

private

Asserts that a deletion operation was attempted.

Exceptions

BadMethodCallException

Definition at line 335 of file DeletePage.php.

◆ authorizeDeletion()

Page\DeletePage::authorizeDeletion ( )

private

Returns: PermissionStatus

Definition at line 390 of file DeletePage.php.

◆ canProbablyDeleteAssociatedTalk()

Page\DeletePage::canProbablyDeleteAssociatedTalk ( )

Tests whether it's probably possible to delete the associated talk page.

This checks the replica, so it may not see the latest master change, and is useful e.g. for building the UI.

Returns: StatusValue

Definition at line 262 of file DeletePage.php.

References StatusValue\newFatal().

◆ deleteIfAllowed()

Page\DeletePage::deleteIfAllowed ( string $reason )

Same as deleteUnsafe, but checks permissions.

Parameters

string $reason

Returns: StatusValue

Definition at line 377 of file DeletePage.php.

◆ deleteInternal()

Page\DeletePage::deleteInternal	(	WikiPage	$page,
		string	$pageRole,
		string	$reason,
		?string	$webRequestId = `null`
	)

Access: internal: The only external caller allowed is DeletePageJob. Back-end article deletion

Only invokes batching via the job queue if necessary per DeleteRevisionsBatchSize. Deletions can often be completed inline without involving the job queue.

Potentially called many times per deletion operation for pages with many revisions.

Parameters

WikiPage	$page
string	$pageRole
string	$reason
string \| null	$webRequestId

Returns: Status

Definition at line 545 of file DeletePage.php.

◆ deleteUnsafe()

Page\DeletePage::deleteUnsafe ( string $reason )

Back-end article deletion: deletes the article with database consistency, writes logs, purges caches.

Note: This method doesn't check user permissions. Use deleteIfAllowed for that.

Parameters

string $reason Delete reason for deletion log

Returns

Status Status object:

If successful (or scheduled), a good Status
If a page couldn't be deleted because it wasn't found, a Status with a non-fatal 'cannotdelete' error.
A fatal Status otherwise.

Definition at line 465 of file DeletePage.php.

◆ deletionsWereScheduled()

Page\DeletePage::deletionsWereScheduled ( )

Returns: bool[] Whether the deletions were scheduled

Exceptions

BadMethodCallException If no deletions were attempted

Definition at line 366 of file DeletePage.php.

◆ deletionWasScheduled()

Page\DeletePage::deletionWasScheduled ( )

Returns: bool Whether (part of) the deletion was scheduled

Exceptions

BadMethodCallException If no deletions were attempted

Deprecated:: since 1.38, use ::deletionsWereScheduled() instead.

Definition at line 355 of file DeletePage.php.

◆ doDeleteUpdates()

Page\DeletePage::doDeleteUpdates	(	WikiPage	$page,
		RevisionRecord	$revRecord
	)

Access: private: Public for BC only Do some database updates after deletion

Parameters

WikiPage	$page
RevisionRecord	$revRecord	The current page revision at the time of deletion, used when determining the required updates. This may be needed because $page->getRevisionRecord() may already return null when the page proper was deleted.

Definition at line 847 of file DeletePage.php.

◆ forceImmediate()

Page\DeletePage::forceImmediate ( bool $forceImmediate )

If false, allows deleting over time via the job queue.

Parameters

bool $forceImmediate

Returns: self For chaining

Definition at line 251 of file DeletePage.php.

◆ getDeletionUpdates()

Page\DeletePage::getDeletionUpdates	(	WikiPage	$page,
		RevisionRecord	$rev
	)

Access: private: Public for BC only Returns a list of updates to be performed when the page is deleted. The updates should remove any information about this page from secondary data stores such as links tables.

Parameters

WikiPage	$page
RevisionRecord	$rev	The revision being deleted.

Returns: DeferrableUpdate[]

Definition at line 924 of file DeletePage.php.

◆ getLegacyHookErrors()

Page\DeletePage::getLegacyHookErrors ( )

Access: internal: BC method for use by WikiPage::doDeleteArticleReal only.

Returns: array|string

Definition at line 198 of file DeletePage.php.

References Page\DeletePage\$legacyHookErrors.

◆ getSuccessfulDeletionsIDs()

Page\DeletePage::getSuccessfulDeletionsIDs ( )

Returns: int[] Array of log IDs of successful deletions

Exceptions

BadMethodCallException If no deletions were attempted

Definition at line 345 of file DeletePage.php.

◆ isBatchedDelete()

Page\DeletePage::isBatchedDelete ( int $safetyMargin = 0 )

Determines if this deletion would be batched (executed over time by the job queue) or not (completed in the same request as the delete call).

It is unlikely but possible that an edit from another request could push the page over the batching threshold after this function is called, but before the caller acts upon the return value. Callers must decide for themselves how to deal with this. $safetyMargin is provided as an unreliable but situationally useful help for some common cases.

Parameters

int $safetyMargin Added to the revision count when checking for batching

Returns: bool True if deletion would be batched, false otherwise

Definition at line 438 of file DeletePage.php.

◆ isBigDeletion()

Page\DeletePage::isBigDeletion ( )

private

Returns: bool

Definition at line 411 of file DeletePage.php.

◆ keepLegacyHookErrorsSeparate()

Page\DeletePage::keepLegacyHookErrorsSeparate ( )

Access: internal: BC method for use by WikiPage::doDeleteArticleReal only.

Returns: self

Definition at line 206 of file DeletePage.php.

◆ runPreDeleteHooks()

Page\DeletePage::runPreDeleteHooks	(	WikiPage	$page,
		string &	$reason
	)

private

Parameters

WikiPage	$page
string	&$reason

Returns: Status

Definition at line 499 of file DeletePage.php.

References StatusValue\fatal().

◆ setDeleteAssociatedTalk()

Page\DeletePage::setDeleteAssociatedTalk ( bool $delete )

If set to true and the page has a talk page, delete that one too.

Callers should call canProbablyDeleteAssociatedTalk first to make sure this is a valid operation. Note that the checks here are laxer than those in canProbablyDeleteAssociatedTalk. In particular, this doesn't check whether the page exists as that may be subject to race condition, and it's checked later on (in deleteInternal, using latest data) anyway.

Parameters

bool $delete

Returns: self For chaining

Exceptions

BadMethodCallException If $delete is true and the given page is not a talk page.

Definition at line 287 of file DeletePage.php.

◆ setDeletionAttempted()

Page\DeletePage::setDeletionAttempted ( )

Called before attempting a deletion, allows the result getters to be used.

Access: internal: The only external caller allowed is DeletePageJob.

Returns: self

Definition at line 320 of file DeletePage.php.

◆ setIsDeletePageUnitTest()

Page\DeletePage::setIsDeletePageUnitTest ( bool $test )

Access: internal: FIXME: Hack used when running the DeletePage unit test to disable some legacy code.

Parameters

bool $test

Definition at line 308 of file DeletePage.php.

◆ setLogSubtype()

Page\DeletePage::setLogSubtype ( string $logSubtype )

Set a specific log subtype for the deletion log entry.

Parameters

string $logSubtype

Returns: self For chaining

Definition at line 240 of file DeletePage.php.

◆ setSuppress()

Page\DeletePage::setSuppress ( bool $suppress )

If true, suppress all revisions and log the deletion in the suppression log instead of the deletion log.

Parameters

bool $suppress

Returns: self For chaining

Definition at line 218 of file DeletePage.php.

◆ setTags()

Page\DeletePage::setTags ( array $tags )

Change tags to apply to the deletion action.

Parameters

string[] $tags

Returns: self For chaining

Definition at line 229 of file DeletePage.php.

Member Data Documentation

◆ $associatedTalk

WikiPage null Page\DeletePage::$associatedTalk

private

If not null, it means that we have to delete it.

Definition at line 116 of file DeletePage.php.

◆ $attemptedDeletion

bool Page\DeletePage::$attemptedDeletion = false

private

Whether a deletion was attempted.

Definition at line 134 of file DeletePage.php.

◆ $backlinkCacheFactory

BacklinkCacheFactory Page\DeletePage::$backlinkCacheFactory

private

Definition at line 91 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $commentStore

CommentStore Page\DeletePage::$commentStore

private

Definition at line 79 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $contLangMsgTextFormatter

ITextFormatter Page\DeletePage::$contLangMsgTextFormatter

private

Definition at line 97 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $deleter

Authority Page\DeletePage::$deleter

private

Definition at line 105 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $forceImmediate

bool Page\DeletePage::$forceImmediate = false

private

Definition at line 114 of file DeletePage.php.

◆ $hookRunner

HookRunner Page\DeletePage::$hookRunner

private

Definition at line 69 of file DeletePage.php.

◆ $isDeletePageUnitTest

bool Page\DeletePage::$isDeletePageUnitTest = false

private

Definition at line 100 of file DeletePage.php.

◆ $jobQueueGroup

JobQueueGroup Page\DeletePage::$jobQueueGroup

private

Definition at line 77 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $lbFactory

LBFactory Page\DeletePage::$lbFactory

private

Definition at line 73 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $legacyHookErrors

string array Page\DeletePage::$legacyHookErrors = ''

private

Definition at line 119 of file DeletePage.php.

Referenced by Page\DeletePage\getLegacyHookErrors().

◆ $loadBalancer

ILoadBalancer Page\DeletePage::$loadBalancer

private

Definition at line 75 of file DeletePage.php.

◆ $localWikiID

string Page\DeletePage::$localWikiID

private

Definition at line 85 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $logSubtype

string Page\DeletePage::$logSubtype = 'delete'

private

Definition at line 112 of file DeletePage.php.

◆ $mergeLegacyHookErrors

bool Page\DeletePage::$mergeLegacyHookErrors = true

private

Definition at line 121 of file DeletePage.php.

◆ $namespaceInfo

NamespaceInfo Page\DeletePage::$namespaceInfo

private

Definition at line 95 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $options

ServiceOptions Page\DeletePage::$options

private

Definition at line 81 of file DeletePage.php.

◆ $page

WikiPage Page\DeletePage::$page

private

Definition at line 103 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $recentDeletesCache

BagOStuff Page\DeletePage::$recentDeletesCache

private

Definition at line 83 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $revisionStore

RevisionStore Page\DeletePage::$revisionStore

private

Definition at line 71 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $successfulDeletionsIDs

array<int|null> null Page\DeletePage::$successfulDeletionsIDs

private

Keys are the self::PAGE_* constants.

Values are null if the deletion couldn't happen (e.g. due to lacking perms) or was scheduled. PAGE_TALK is only set when deleting the associated talk.

Definition at line 127 of file DeletePage.php.

◆ $suppress

bool Page\DeletePage::$suppress = false

private

Definition at line 108 of file DeletePage.php.

◆ $tags

string [] Page\DeletePage::$tags = []

private

Definition at line 110 of file DeletePage.php.

◆ $userFactory

UserFactory Page\DeletePage::$userFactory

private

Definition at line 89 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $wasScheduled

array<bool|null> null Page\DeletePage::$wasScheduled

private

Keys are the self::PAGE_* constants.

Values are null if the deletion couldn't happen (e.g. due to lacking perms). PAGE_TALK is only set when deleting the associated talk.

Definition at line 132 of file DeletePage.php.

◆ $webRequestID

string Page\DeletePage::$webRequestID

private

Definition at line 87 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ $wikiPageFactory

WikiPageFactory Page\DeletePage::$wikiPageFactory

private

Definition at line 93 of file DeletePage.php.

Referenced by Page\DeletePage\__construct().

◆ CONSTRUCTOR_OPTIONS

const Page\DeletePage::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::DeleteRevisionsBatchSize,
        MainConfigNames::ActorTableSchemaMigrationStage,
        MainConfigNames::DeleteRevisionsLimit,
    ]

Access: internal: For use by PageCommandFactory

Definition at line 56 of file DeletePage.php.

◆ PAGE_BASE

const Page\DeletePage::PAGE_BASE = 'base'

Constants used for the return value of getSuccessfulDeletionsIDs() and deletionsWereScheduled()

Definition at line 65 of file DeletePage.php.

◆ PAGE_TALK

const Page\DeletePage::PAGE_TALK = 'talk'

Definition at line 66 of file DeletePage.php.

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

includes/page/DeletePage.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ archiveRevisions()

◆ assertDeletionAttempted()

◆ authorizeDeletion()

◆ canProbablyDeleteAssociatedTalk()

◆ deleteIfAllowed()

◆ deleteInternal()

◆ deleteUnsafe()

◆ deletionsWereScheduled()

◆ deletionWasScheduled()

◆ doDeleteUpdates()

◆ forceImmediate()

◆ getDeletionUpdates()

◆ getLegacyHookErrors()

◆ getSuccessfulDeletionsIDs()

◆ isBatchedDelete()

◆ isBigDeletion()

◆ keepLegacyHookErrorsSeparate()

◆ runPreDeleteHooks()

◆ setDeleteAssociatedTalk()

◆ setDeletionAttempted()

◆ setIsDeletePageUnitTest()

◆ setLogSubtype()

◆ setSuppress()

◆ setTags()

Member Data Documentation

◆ $associatedTalk

◆ $attemptedDeletion

◆ $backlinkCacheFactory

◆ $commentStore

◆ $contLangMsgTextFormatter

◆ $deleter

◆ $forceImmediate

◆ $hookRunner

◆ $isDeletePageUnitTest

◆ $jobQueueGroup

◆ $lbFactory

◆ $legacyHookErrors

◆ $loadBalancer

◆ $localWikiID

◆ $logSubtype

◆ $mergeLegacyHookErrors

◆ $namespaceInfo

◆ $options

◆ $page

◆ $recentDeletesCache

◆ $revisionStore

◆ $successfulDeletionsIDs

◆ $suppress

◆ $tags

◆ $userFactory

◆ $wasScheduled

◆ $webRequestID

◆ $wikiPageFactory

◆ CONSTRUCTOR_OPTIONS

◆ PAGE_BASE

◆ PAGE_TALK