Prepare an edit in shared cache so that it can be reused on edit. More...

Inheritance diagram for ApiStashEdit:

[legend]

Collaboration diagram for ApiStashEdit:

[legend]

Public Member Functions
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.

	getAllowedParams ()
	Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.

	isInternal ()
	Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable.

	isWriteMode ()
	Indicates whether this module requires write mode.

	mustBePosted ()
	Indicates whether this module must be called with a POST request.

	needsToken ()
	Returns the token type this module requires in order to execute.

Public Member Functions inherited from ApiBase
	__construct (ApiMain $mainModule, $moduleName, $modulePrefix='')

	getModuleManager ()
	Get the module manager, or null if this module has no sub-modules.

	getCustomPrinter ()
	If the module may only be used with a certain format module, it should override this method to return an instance of that formatter.

	getHelpUrls ()
	Return links to more detailed help pages about the module.

	shouldCheckMaxlag ()
	Indicates if this module needs maxlag to be checked.

	isReadMode ()
	Indicates whether this module requires read rights.

	isDeprecated ()
	Indicates whether this module is deprecated.

	getConditionalRequestData ( $condition)
	Returns data for HTTP conditional request mechanisms.

	getModuleName ()
	Get the name of the module being executed by this instance.

	getModulePrefix ()
	Get parameter prefix (usually two letters or an empty string).

	getMain ()
	Get the main module.

	isMain ()
	Returns true if this module is the main module ($this === $this->mMainModule), false otherwise.

	getParent ()
	Get the parent of this module.

	lacksSameOriginSecurity ()
	Returns true if the current request breaks the same-origin policy.

	getModulePath ()
	Get the path to this module.

	getModuleFromPath ( $path)
	Get a module from its module path.

	getResult ()
	Get the result object.

	getErrorFormatter ()
	Get the error formatter.

	getContinuationManager ()
	Get the continuation manager.

	setContinuationManager (ApiContinuationManager $manager=null)
	Set the continuation manager.

	dynamicParameterDocumentation ()
	Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams().

	encodeParamName ( $paramName)
	This method mangles parameter name based on the prefix supplied to the constructor.

	extractRequestParams ( $options=[])
	Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default.

	requireOnlyOneParameter ( $params, $required)
	Die if none or more than one of a certain set of parameters is set and not false.

	requireMaxOneParameter ( $params, $required)
	Die if more than one of a certain set of parameters is set and not false.

	requireAtLeastOneParameter ( $params, $required)
	Die if none of a certain set of parameters is set and not false.

	requirePostedParameters ( $params, $prefix='prefix')
	Die if any of the specified parameters were found in the query part of the URL rather than the post body.

	getTitleOrPageId ( $params, $load=false)
	Get a WikiPage object from a title or pageid param, if possible.

	getTitleFromTitleOrPageId ( $params)
	Get a Title object from a title or pageid param, if possible.

	validateToken ( $token, array $params)
	Validate the supplied token.

	getWatchlistUser ( $params)
	Gets the user for whom to get the watchlist.

	errorArrayToStatus (array $errors, User $user=null)
	Turn an array of message keys or key+param arrays into a Status.

	addBlockInfoToStatus (StatusValue $status, User $user=null)
	Add block info to block messages in a Status.

	addWarning ( $msg, $code=null, $data=null)
	Add a warning for this module.

	addDeprecation ( $msg, $feature, $data=[])
	Add a deprecation warning for this module.

	addError ( $msg, $code=null, $data=null)
	Add an error for this module without aborting.

	addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
	Add warnings and/or errors from a Status.

	dieWithError ( $msg, $code=null, $data=null, $httpCode=null)
	Abort execution with an error.

	dieWithException ( $exception, array $options=[])
	Abort execution with an error derived from an exception.

	dieBlocked (Block $block)
	Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info.

	dieStatus (StatusValue $status)
	Throw an ApiUsageException based on the Status object.

	dieReadOnly ()
	Helper function for readonly errors.

	checkUserRightsAny ( $rights, $user=null)
	Helper function for permission-denied errors.

	checkTitleUserPermissions (Title $title, $actions, $options=[])
	Helper function for permission-denied errors.

	dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null)
	Will only set a warning instead of failing if the global $wgDebugAPI is set to true.

	logFeatureUsage ( $feature)
	Write logging information for API features to a debug log, for usage analysis.

	getFinalSummary ()
	Get final module summary.

	getFinalDescription ()
	Get final module description, after hooks have had a chance to tweak it as needed.

	getFinalParams ( $flags=0)
	Get final list of parameters, after hooks have had a chance to tweak it as needed.

	getFinalParamDescription ()
	Get final parameter descriptions, after hooks have had a chance to tweak it as needed.

	modifyHelp (array &$help, array $options, array &$tocData)
	Called from ApiHelp before the pieces are joined together and returned.

Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key)
	Get a Message object with context set Parameters are the same as wfMessage()

	setContext (IContextSource $context)

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

static	parseAndStash (WikiPage $page, Content $content, User $user, $summary)

Static Public Member Functions inherited from ApiBase
static	makeMessage ( $msg, IContextSource $context, array $params=null)
	Create a Message from a string or array.

static	truncateArray (&$arr, $limit)
	Truncate an array to a certain length.

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	MAX_CACHE_RECENT = 2

const	MAX_CACHE_TTL = 300

const	MAX_SIGNATURE_TTL = 60

const	PRESUME_FRESH_TTL_SEC = 30

Public Attributes inherited from ApiBase
const	ALL_DEFAULT_STRING = '*'

const	GET_VALUES_FOR_HELP = 1
	getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough.

const	LIMIT_BIG1 = 500
	Fast query, standard limit.

const	LIMIT_BIG2 = 5000
	Fast query, apihighlimits limit.

const	LIMIT_SML1 = 50
	Slow query, standard limit.

const	LIMIT_SML2 = 500
	Slow query, apihighlimits limit.

const	PARAM_DFLT = 0
	(null\|boolean\|integer\|string) Default value of the parameter.

const	PARAM_ISMULTI = 1
	(boolean) Accept multiple pipe-separated values for this parameter (e.g.

const	PARAM_TYPE = 2
	(string\|string[]) Either an array of allowed value strings, or a string type as described below.

const	PARAM_MAX = 3
	(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.

const	PARAM_MAX2 = 4
	(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'.

const	PARAM_MIN = 5
	(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.

const	PARAM_ALLOW_DUPLICATES = 6
	(boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true?

const	PARAM_DEPRECATED = 7
	(boolean) Is the parameter deprecated (will show a warning)?

const	PARAM_REQUIRED = 8
	(boolean) Is the parameter required?

const	PARAM_RANGE_ENFORCE = 9
	(boolean) For PARAM_TYPE 'integer', enforce PARAM_MIN and PARAM_MAX?

const	PARAM_HELP_MSG = 10
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter.

const	PARAM_HELP_MSG_APPEND = 11
	((string\|array\|Message)[]) Specify additional i18n messages to append to the normal message for this parameter.

const	PARAM_HELP_MSG_INFO = 12
	(array) Specify additional information tags for the parameter.

const	PARAM_VALUE_LINKS = 13
	(string[]) When PARAM_TYPE is an array, this may be an array mapping those values to page titles which will be linked in the help.

const	PARAM_HELP_MSG_PER_VALUE = 14
	((string\|array\|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage().

const	PARAM_SUBMODULE_MAP = 15
	(string[]) When PARAM_TYPE is 'submodule', map parameter values to submodule paths.

const	PARAM_SUBMODULE_PARAM_PREFIX = 16
	(string) When PARAM_TYPE is 'submodule', used to indicate the 'g' prefix added by ApiQueryGeneratorBase (and similar if anything else ever does that).

const	PARAM_ALL = 17
	(boolean\|string) When PARAM_TYPE has a defined set of values and PARAM_ISMULTI is true, this allows for an asterisk ('*') to be passed in place of a pipe-separated list of every possible value.

const	PARAM_EXTRA_NAMESPACES = 18
	(int[]) When PARAM_TYPE is 'namespace', include these as additional possible values.

const	PARAM_SENSITIVE = 19
	(boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of the value of this field.

const	PARAM_DEPRECATED_VALUES = 20
	(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.

const	PARAM_ISMULTI_LIMIT1 = 21
	(integer) Maximum number of values, for normal users.

const	PARAM_ISMULTI_LIMIT2 = 22
	(integer) Maximum number of values, for users with the apihighimits right.

const	PARAM_MAX_BYTES = 23
	(integer) Maximum length of a string in bytes (in UTF-8 encoding).

const	PARAM_MAX_CHARS = 24
	(integer) Maximum length of a string in characters (unicode codepoints).

const	PARAM_TEMPLATE_VARS = 25
	(array) Indicate that this is a templated parameter, and specify replacements.

Static Private Member Functions
static	getContentHash (Content $content)
	Get hash of the content, factoring in model/format.

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

static	getStashParserOutputKey ( $uuid)

static	getStashValue ( $key)

static	lastEditTime (User $user)

static	pruneExcessStashedEntries (BagOStuff $cache, User $user, $newKey)

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

Additional Inherited Members
Protected Member Functions inherited from ApiBase
	getExamplesMessages ()
	Returns usage examples for this module.

	getWebUITokenSalt (array $params)
	Fetch the salt used in the Web UI corresponding to this module.

	getDB ()
	Gets a default replica DB connection object.

	getParameter ( $paramName, $parseLimit=true)
	Get a value for the given parameter.

	getWatchlistValue ( $watchlist, $titleObj, $userOption=null)
	Return true if we're to watch the page, false if not, null if no change.

	getParameterFromSettings ( $paramName, $paramSettings, $parseLimit)
	Using the settings determine the value for the given parameter.

	handleParamNormalization ( $paramName, $value, $rawValue)
	Handle when a parameter was Unicode-normalized.

	explodeMultiValue ( $value, $limit)
	Split a multi-valued parameter string, like explode()

	parseMultiValue ( $valueName, $value, $allowMultiple, $allowedValues, $allSpecifier=null, $limit1=null, $limit2=null)
	Return an array of values that were given in a 'a\|b\|c' notation, after it optionally validates them against the list allowed values.

	validateLimit ( $paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false)
	Validate the value against the minimum and user/bot maximum limits.

	validateTimestamp ( $value, $encParamName)
	Validate and normalize parameters of type 'timestamp'.

	setWatch ( $watch, $titleObj, $userOption=null)
	Set a watch (or unwatch) based the based on a watchlist parameter.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

	filterIDs ( $fields, array $ids)
	Filter out-of-range values from a list of positive integer IDs.

	dieContinueUsageIf ( $condition)
	Die with the 'badcontinue' error.

	getSummaryMessage ()
	Return the summary message.

	getExtendedDescription ()
	Return the extended help text message.

	getHelpFlags ()
	Generates the list of flags for the help screen and for action=paraminfo.

	getModuleSourceInfo ()
	Returns information about the source of this module, if known.

	getDescription ()
	Returns the description string for this module.

	getParamDescription ()
	Returns an array of parameter descriptions.

	getExamples ()
	Returns usage examples for this module.

	getDescriptionMessage ()
	Return the description message.

Static Protected Member Functions inherited from ApiBase
static	dieDebug ( $method, $message)
	Internal code errors should be reported with this method.

Detailed Description

Prepare an edit in shared cache so that it can be reused on edit.

This endpoint can be called via AJAX as the user focuses on the edit summary box. By the time of submission, the parse may have already finished, and can be immediately used on page save. Certain parser functions like {{REVISIONID}} or {{CURRENTTIME}} may cause the cache to not be used on edit. Template and files used are check for changes since the output was generated. The cache TTL is also kept low for sanity.

Since: 1.25

Definition at line 38 of file ApiStashEdit.php.

Member Function Documentation

◆ checkCache()

static ApiStashEdit::checkCache	(	Title	$title,
		Content	$content,
		User	$user
	)

static

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.

The result is a map (pstContent,output,timestamp) with fields extracted directly from WikiPage::prepareContentForEdit().

Parameters

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

Returns: stdClass|bool Returns false on cache miss

Definition at line 264 of file ApiStashEdit.php.

References $content, $title, $user, and wfTimestamp().

Referenced by MediaWiki\Storage\DerivedPageDataUpdater\prepareContent().

◆ execute()

ApiStashEdit::execute ( )

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 51 of file ApiStashEdit.php.

References $cache, $content, $handler, $params, $ret, $title, $user, ApiBase\dieWithError(), ApiBase\extractRequestParams(), ApiBase\getModuleName(), ApiBase\getResult(), ApiBase\getTitleOrPageId(), ContextSource\getUser(), Revision\newFromPageId(), and ApiBase\requireOnlyOneParameter().

◆ getAllowedParams()

ApiStashEdit::getAllowedParams ( )

Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Returns: array

Reimplemented from ApiBase.

Definition at line 492 of file ApiStashEdit.php.

References null, ApiBase\PARAM_DFLT, ApiBase\PARAM_REQUIRED, ApiBase\PARAM_TYPE, and true.

◆ getContentHash()

static ApiStashEdit::getContentHash ( Content $content )

staticprivate

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

Parameters

Content $content

Returns: string

Definition at line 357 of file ApiStashEdit.php.

References $content.

◆ getStashKey()

static ApiStashEdit::getStashKey	(	Title	$title,
			$contentHash,
		User	$user
	)

staticprivate

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 377 of file ApiStashEdit.php.

References $title, and $user.

◆ getStashParserOutputKey()

static ApiStashEdit::getStashParserOutputKey ( $uuid )

staticprivate

Parameters

string $uuid

Returns: string

Definition at line 392 of file ApiStashEdit.php.

◆ getStashValue()

static ApiStashEdit::getStashValue ( $key )

staticprivate

Parameters

string $key

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

Definition at line 400 of file ApiStashEdit.php.

References $cache.

◆ isInternal()

ApiStashEdit::isInternal ( )

Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable.

Since: 1.25

Returns: bool

Reimplemented from ApiBase.

Definition at line 542 of file ApiStashEdit.php.

◆ isWriteMode()

ApiStashEdit::isWriteMode ( )

Indicates whether this module requires write mode.

This should return true for modules that may require synchronous database writes. Modules that do not need such writes should also not rely on master database access, since only read queries are needed and each master DB is a single point of failure. Additionally, requests that only need replica DBs can be efficiently routed to any datacenter via the Promise-Non-Write-API-Action header.

Returns: bool

Reimplemented from ApiBase.

Definition at line 538 of file ApiStashEdit.php.

◆ lastEditTime()

static ApiStashEdit::lastEditTime ( User $user )

staticprivate

Parameters

User $user

Returns: string|null TS_MW timestamp or null

Definition at line 336 of file ApiStashEdit.php.

References $time, $user, DB_REPLICA, wfGetDB(), and wfTimestampOrNull().

◆ mustBePosted()

ApiStashEdit::mustBePosted ( )

Indicates whether this module must be called with a POST request.

Returns: bool

Reimplemented from ApiBase.

Definition at line 534 of file ApiStashEdit.php.

◆ needsToken()

ApiStashEdit::needsToken ( )

Returns the token type this module requires in order to execute.

Modules are strongly encouraged to use the core 'csrf' type unless they have specialized security needs. If the token type is not one of the core types, you must use the ApiQueryTokensRegisterTypes hook to register it.

Returning a non-falsey value here will force the addition of an appropriate 'token' parameter in self::getFinalParams(). Also, self::mustBePosted() must return true when tokens are used.

In previous versions of MediaWiki, true was a valid return value. Returning true will generate errors indicating that the API module needs updating.

Returns: string|false

Reimplemented from ApiBase.

Definition at line 530 of file ApiStashEdit.php.

◆ parseAndStash()

static ApiStashEdit::parseAndStash	(	WikiPage	$page,
		Content	$content,
		User	$user,
			$summary
	)

static

Parameters

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

Returns: string ApiStashEdit::ERROR_* constant

Since: 1.25

Definition at line 173 of file ApiStashEdit.php.

References $code, $content, $fname, $title, $user, DB_MASTER, WikiPage\getTitle(), WikiPage\prepareContentForEdit(), string, use, wfGetDB(), and wfTimestamp().

◆ pruneExcessStashedEntries()

static ApiStashEdit::pruneExcessStashedEntries	(	BagOStuff	$cache,
		User	$user,
			$newKey
	)

staticprivate

Parameters

BagOStuff	$cache
User	$user
string	$newKey

Definition at line 479 of file ApiStashEdit.php.

References $cache, and $user.

◆ storeStashValue()

static ApiStashEdit::storeStashValue	(		$key,
		Content	$pstContent,
		ParserOutput	$parserOutput,
			$timestamp,
		User	$user
	)

staticprivate

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 431 of file ApiStashEdit.php.

References $cache, $user, CacheTime\getCacheExpiry(), CacheTime\getCacheTime(), ParserOutput\getFlag(), object, true, and wfTimestamp().

Member Data Documentation

◆ ERROR_BUSY

const ApiStashEdit::ERROR_BUSY = 'busy'

Definition at line 43 of file ApiStashEdit.php.

◆ ERROR_CACHE

const ApiStashEdit::ERROR_CACHE = 'error_cache'

Definition at line 41 of file ApiStashEdit.php.

◆ ERROR_NONE

const ApiStashEdit::ERROR_NONE = 'stashed'

Definition at line 39 of file ApiStashEdit.php.

◆ ERROR_PARSE

const ApiStashEdit::ERROR_PARSE = 'error_parse'

Definition at line 40 of file ApiStashEdit.php.

◆ ERROR_UNCACHEABLE

const ApiStashEdit::ERROR_UNCACHEABLE = 'uncacheable'

Definition at line 42 of file ApiStashEdit.php.

◆ MAX_CACHE_RECENT

const ApiStashEdit::MAX_CACHE_RECENT = 2

Definition at line 49 of file ApiStashEdit.php.

◆ MAX_CACHE_TTL

const ApiStashEdit::MAX_CACHE_TTL = 300

Definition at line 46 of file ApiStashEdit.php.

◆ MAX_SIGNATURE_TTL

const ApiStashEdit::MAX_SIGNATURE_TTL = 60

Definition at line 47 of file ApiStashEdit.php.

◆ PRESUME_FRESH_TTL_SEC

const ApiStashEdit::PRESUME_FRESH_TTL_SEC = 30

Definition at line 45 of file ApiStashEdit.php.

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

includes/api/ApiStashEdit.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkCache()

◆ execute()

◆ getAllowedParams()

◆ getContentHash()

◆ getStashKey()

◆ getStashParserOutputKey()

◆ getStashValue()

◆ isInternal()

◆ isWriteMode()

◆ lastEditTime()

◆ mustBePosted()

◆ needsToken()

◆ parseAndStash()

◆ pruneExcessStashedEntries()

◆ storeStashValue()

Member Data Documentation

◆ ERROR_BUSY

◆ ERROR_CACHE

◆ ERROR_NONE

◆ ERROR_PARSE

◆ ERROR_UNCACHEABLE

◆ MAX_CACHE_RECENT

◆ MAX_CACHE_TTL

◆ MAX_SIGNATURE_TTL

◆ PRESUME_FRESH_TTL_SEC