Class for managing stashed edits used by the page updater classes. More...

Collaboration diagram for MediaWiki\Storage\PageEditStash:

[legend]

Public Member Functions
	__construct (BagOStuff $cache, ILoadBalancer $lb, LoggerInterface $logger, StatsdDataFactoryInterface $stats, $initiator)

	checkCache (Title $title, Content $content, User $user)
	Check that a prepared edit is in cache and still up-to-date. More...

	fetchInputText ( $textHash)

	parseAndCache (WikiPage $page, Content $content, User $user, $summary)

	stashInputText ( $text, $textHash)

Public Attributes
const	ERROR_BUSY = 'busy'

const	ERROR_CACHE = 'error_cache'

const	ERROR_NONE = 'stashed'

const	ERROR_PARSE = 'error_parse'

const	ERROR_UNCACHEABLE = 'uncacheable'

const	INITIATOR_JOB_OR_CLI = 2

const	INITIATOR_USER = 1

const	MAX_CACHE_RECENT = 2

const	MAX_CACHE_TTL = 300

const	MAX_SIGNATURE_TTL = 60

const	PRESUME_FRESH_TTL_SEC = 30

Private Member Functions
	getAndWaitForStashValue ( $key)

	getContentHash (Content $content)
	Get hash of the content, factoring in model/format. More...

	getStashKey (Title $title, $contentHash, User $user)
	Get the temporary prepared edit stash key for a user. More...

	getStashValue ( $key)

	incrStatsByContent ( $subkey, Content $content)

	lastEditTime (User $user)

	pruneExcessStashedEntries (User $user, $newKey)

	recentStashEntryCount (User $user)

	storeStashValue ( $key, Content $pstContent, ParserOutput $parserOutput, $timestamp, User $user)
	Build a value to store in memcached based on the PST content and parser output. More...

Private Attributes
BagOStuff	$cache

int	$initiator

ILoadBalancer	$lb

LoggerInterface	$logger

StatsdDataFactoryInterface	$stats

Detailed Description

Class for managing stashed edits used by the page updater classes.

Since: 1.34

Definition at line 44 of file PageEditStash.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Storage\PageEditStash::__construct	(	BagOStuff	$cache,
		ILoadBalancer	$lb,
		LoggerInterface	$logger,
		StatsdDataFactoryInterface	$stats,
			$initiator
	)

Parameters

BagOStuff	$cache
ILoadBalancer	$lb
LoggerInterface	$logger
StatsdDataFactoryInterface	$stats
int	$initiator	Class INITIATOR__* constant

Definition at line 78 of file PageEditStash.php.

References MediaWiki\Storage\PageEditStash\$cache, MediaWiki\Storage\PageEditStash\$initiator, MediaWiki\Storage\PageEditStash\$lb, MediaWiki\Storage\PageEditStash\$logger, MediaWiki\Storage\PageEditStash\$stats, and cache.

Member Function Documentation

◆ checkCache()

MediaWiki\Storage\PageEditStash::checkCache	(	Title	$title,
		Content	$content,
		User	$user
	)

Check that a prepared edit is in cache and still up-to-date.

This method blocks if the prepared edit is already being rendered, waiting until rendering finishes before doing final validity checks.

The cache is rejected if template or file changes are detected. Note that foreign template or file transclusions are not checked.

This returns an object with the following fields:

pstContent: the Content after pre-save-transform
output: the ParserOutput instance
timestamp: the timestamp of the parse
edits: author edit count if they are logged in or NULL otherwise

Parameters

Title	$title
Content	$content
User	$user	User to get parser options from

Returns: stdClass|bool Returns edit stash object or false on cache miss

Definition at line 200 of file PageEditStash.php.

References MediaWiki\$context, MediaWiki\Storage\PageEditStash\$logger, MediaWiki\Storage\PageEditStash\getAndWaitForStashValue(), MediaWiki\Storage\PageEditStash\getContentHash(), User\getEditCount(), User\getName(), Title\getPrefixedText(), User\getRequest(), MediaWiki\Storage\PageEditStash\getStashKey(), MediaWiki\Storage\PageEditStash\incrStatsByContent(), User\isAnon(), User\isBot(), MediaWiki\Storage\PageEditStash\lastEditTime(), MediaWiki\Storage\PageEditStash\recentStashEntryCount(), and wfTimestamp().

◆ fetchInputText()

MediaWiki\Storage\PageEditStash::fetchInputText ( $textHash )

Parameters

string $textHash

Returns: string|bool Text or false if missing

Definition at line 333 of file PageEditStash.php.

References cache.

◆ getAndWaitForStashValue()

MediaWiki\Storage\PageEditStash::getAndWaitForStashValue ( $key )

private

Parameters

string $key

Returns: bool|stdClass

Definition at line 307 of file PageEditStash.php.

References MediaWiki\Storage\PageEditStash\getStashValue().

Referenced by MediaWiki\Storage\PageEditStash\checkCache().

◆ getContentHash()

MediaWiki\Storage\PageEditStash::getContentHash ( Content $content )

private

Get hash of the content, factoring in model/format.

Parameters

Content $content

Returns: string

Definition at line 381 of file PageEditStash.php.

References Content\getDefaultFormat(), Content\getModel(), and Content\serialize().

Referenced by MediaWiki\Storage\PageEditStash\checkCache(), and MediaWiki\Storage\PageEditStash\parseAndCache().

◆ getStashKey()

MediaWiki\Storage\PageEditStash::getStashKey	(	Title	$title,
			$contentHash,
		User	$user
	)

private

Get the temporary prepared edit stash key for a user.

This key can be used for caching prepared edits provided:

a) The $user was used for PST options
b) The parser output was made from the PST using cannonical matching options

Parameters

Title	$title
string	$contentHash	Result of getContentHash()
User	$user	User to get parser options from

Returns: string

Definition at line 401 of file PageEditStash.php.

References cache, User\getId(), User\getName(), and Title\getPrefixedDBkey().

Referenced by MediaWiki\Storage\PageEditStash\checkCache(), and MediaWiki\Storage\PageEditStash\parseAndCache().

◆ getStashValue()

MediaWiki\Storage\PageEditStash::getStashValue ( $key )

private

Parameters

string $key

Returns: stdClass|bool Object map (pstContent,output,outputID,timestamp,edits) or false

Definition at line 416 of file PageEditStash.php.

References cache.

Referenced by MediaWiki\Storage\PageEditStash\getAndWaitForStashValue(), and MediaWiki\Storage\PageEditStash\parseAndCache().

◆ incrStatsByContent()

MediaWiki\Storage\PageEditStash::incrStatsByContent	(		$subkey,
		Content	$content
	)

private

Parameters

string	$subkey
Content	$content

Definition at line 298 of file PageEditStash.php.

References Content\getModel().

Referenced by MediaWiki\Storage\PageEditStash\checkCache().

◆ lastEditTime()

MediaWiki\Storage\PageEditStash::lastEditTime ( User $user )

private

Parameters

User $user

Returns: string|null TS_MW timestamp or null

Definition at line 359 of file PageEditStash.php.

References $time, DB_REPLICA, ActorMigration\newMigration(), and wfTimestampOrNull().

Referenced by MediaWiki\Storage\PageEditStash\checkCache().

◆ parseAndCache()

MediaWiki\Storage\PageEditStash::parseAndCache	(	WikiPage	$page,
		Content	$content,
		User	$user,
			$summary
	)

Parameters

WikiPage	$page
Content	$content	Edit content
User	$user
string	$summary	Edit summary

Returns: string Class ERROR_* constant

Definition at line 99 of file PageEditStash.php.

References $code, MediaWiki\$context, $fname, MediaWiki\Storage\PageEditStash\$logger, $title, DB_MASTER, MediaWiki\Storage\PageEditStash\getContentHash(), Content\getDefaultFormat(), MediaWiki\Storage\PageEditStash\getStashKey(), MediaWiki\Storage\PageEditStash\getStashValue(), WikiPage\getTitle(), null, WikiPage\prepareContentForEdit(), Hooks\run(), MediaWiki\Storage\PageEditStash\storeStashValue(), use, and wfTimestamp().

◆ pruneExcessStashedEntries()

MediaWiki\Storage\PageEditStash::pruneExcessStashedEntries	(	User	$user,
			$newKey
	)

private

Parameters

User	$user
string	$newKey

Definition at line 478 of file PageEditStash.php.

References cache, User\getName(), and BagOStuff\WRITE_PRUNE_SEGMENTS.

Referenced by MediaWiki\Storage\PageEditStash\storeStashValue().

◆ recentStashEntryCount()

MediaWiki\Storage\PageEditStash::recentStashEntryCount ( User $user )

private

Parameters

User $user

Returns: int

Definition at line 495 of file PageEditStash.php.

References cache, and User\getName().

Referenced by MediaWiki\Storage\PageEditStash\checkCache().

◆ stashInputText()

MediaWiki\Storage\PageEditStash::stashInputText	(	$text,
		$textHash
	)

Parameters

string	$text
string	$textHash

Returns: bool Success

Definition at line 344 of file PageEditStash.php.

References cache, and BagOStuff\WRITE_ALLOW_SEGMENTS.

◆ storeStashValue()

MediaWiki\Storage\PageEditStash::storeStashValue	(		$key,
		Content	$pstContent,
		ParserOutput	$parserOutput,
			$timestamp,
		User	$user
	)

private

Build a value to store in memcached based on the PST content and parser output.

This makes a simple version of WikiPage::prepareContentForEdit() as stash info

Parameters

string	$key
Content	$pstContent	Pre-Save transformed content
ParserOutput	$parserOutput
string	$timestamp	TS_MW
User	$user

Returns: string|bool True or an error code

Definition at line 437 of file PageEditStash.php.

References cache, CacheTime\getCacheExpiry(), CacheTime\getCacheTime(), User\getEditCount(), ParserOutput\getFlag(), object, MediaWiki\Storage\PageEditStash\pruneExcessStashedEntries(), true, wfTimestamp(), and BagOStuff\WRITE_ALLOW_SEGMENTS.

Referenced by MediaWiki\Storage\PageEditStash\parseAndCache().

Member Data Documentation

◆ $cache

BagOStuff MediaWiki\Storage\PageEditStash::$cache

private

Definition at line 46 of file PageEditStash.php.

Referenced by MediaWiki\Storage\PageEditStash\__construct().

◆ $initiator

int MediaWiki\Storage\PageEditStash::$initiator

private

Definition at line 54 of file PageEditStash.php.

Referenced by MediaWiki\Storage\PageEditStash\__construct().

◆ $lb

ILoadBalancer MediaWiki\Storage\PageEditStash::$lb

private

Definition at line 48 of file PageEditStash.php.

Referenced by MediaWiki\Storage\PageEditStash\__construct().

◆ $logger

LoggerInterface MediaWiki\Storage\PageEditStash::$logger

private

Definition at line 50 of file PageEditStash.php.

Referenced by MediaWiki\Storage\PageEditStash\__construct(), MediaWiki\Storage\PageEditStash\checkCache(), and MediaWiki\Storage\PageEditStash\parseAndCache().

◆ $stats

StatsdDataFactoryInterface MediaWiki\Storage\PageEditStash::$stats

private

Definition at line 52 of file PageEditStash.php.

Referenced by MediaWiki\Storage\PageEditStash\__construct().

◆ ERROR_BUSY

const MediaWiki\Storage\PageEditStash::ERROR_BUSY = 'busy'

Definition at line 60 of file PageEditStash.php.

◆ ERROR_CACHE

const MediaWiki\Storage\PageEditStash::ERROR_CACHE = 'error_cache'

Definition at line 58 of file PageEditStash.php.

◆ ERROR_NONE

const MediaWiki\Storage\PageEditStash::ERROR_NONE = 'stashed'

Definition at line 56 of file PageEditStash.php.

◆ ERROR_PARSE

const MediaWiki\Storage\PageEditStash::ERROR_PARSE = 'error_parse'

Definition at line 57 of file PageEditStash.php.

◆ ERROR_UNCACHEABLE

const MediaWiki\Storage\PageEditStash::ERROR_UNCACHEABLE = 'uncacheable'

Definition at line 59 of file PageEditStash.php.

◆ INITIATOR_JOB_OR_CLI

const MediaWiki\Storage\PageEditStash::INITIATOR_JOB_OR_CLI = 2

Definition at line 69 of file PageEditStash.php.

◆ INITIATOR_USER

const MediaWiki\Storage\PageEditStash::INITIATOR_USER = 1

Definition at line 68 of file PageEditStash.php.

◆ MAX_CACHE_RECENT

const MediaWiki\Storage\PageEditStash::MAX_CACHE_RECENT = 2

Definition at line 66 of file PageEditStash.php.

◆ MAX_CACHE_TTL

const MediaWiki\Storage\PageEditStash::MAX_CACHE_TTL = 300

Definition at line 63 of file PageEditStash.php.

◆ MAX_SIGNATURE_TTL

const MediaWiki\Storage\PageEditStash::MAX_SIGNATURE_TTL = 60

Definition at line 64 of file PageEditStash.php.

◆ PRESUME_FRESH_TTL_SEC

const MediaWiki\Storage\PageEditStash::PRESUME_FRESH_TTL_SEC = 30

Definition at line 62 of file PageEditStash.php.

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

includes/Storage/PageEditStash.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkCache()

◆ fetchInputText()

◆ getAndWaitForStashValue()

◆ getContentHash()

◆ getStashKey()

◆ getStashValue()

◆ incrStatsByContent()

◆ lastEditTime()

◆ parseAndCache()

◆ pruneExcessStashedEntries()

◆ recentStashEntryCount()

◆ stashInputText()

◆ storeStashValue()

Member Data Documentation

◆ $cache

◆ $initiator

◆ $lb

◆ $logger

◆ $stats

◆ ERROR_BUSY

◆ ERROR_CACHE

◆ ERROR_NONE

◆ ERROR_PARSE

◆ ERROR_UNCACHEABLE

◆ INITIATOR_JOB_OR_CLI

◆ INITIATOR_USER

◆ MAX_CACHE_RECENT

◆ MAX_CACHE_TTL

◆ MAX_SIGNATURE_TTL

◆ PRESUME_FRESH_TTL_SEC