Handler for transforming content given in the request. More...

Inherits MediaWiki\Rest\Handler\ParsoidHandler.

Collaboration diagram for MediaWiki\Rest\Handler\TransformHandler:

[legend]

Public Member Functions
	checkPreconditions ()
	Check the conditional request headers and generate a response if appropriate.

	execute ()
	Transform content given in the request from or to wikitext.

	getHeaderParamSettings ()
	Fetch ParamValidator settings for request headers.Every setting must include self::PARAM_SOURCE as 'header' to specify it's a request header for the endpoint.Subclasses that must use the headers from a request should consider having PARAM_REQUIRED setting of "true", Otherwise if the header's existence or non-existence doesn't break the code the PARAM_REQUIRED should be set to "false". Stability: stable to override Returns array[] Associative array mapping header names to ParamValidator settings arrays

	getParamSettings ()
	Fetch ParamValidator settings for parameters.Every setting must include self::PARAM_SOURCE to specify which part of the request is to contain the parameter.Can be used for the request body as well, by setting self::PARAM_SOURCE to "post". Note that the values of "post" parameters will be accessible through getValidatedParams(). "post" parameters are used with form data (application/x-www-form-urlencoded or multipart/form-data).For "query" parameters, a PARAM_REQUIRED setting of "false" means the caller does not have to supply the parameter. For "path" parameters, the path matcher will always require the caller to supply all path parameters for a route, regardless of the PARAM_REQUIRED setting. However, "path" parameters may be specified in getParamSettings() as non-required to indicate that the handler services multiple routes, some of which may not supply the parameter. Stability: stable to override Returns array[] Associative array mapping parameter names to ParamValidator settings arrays

	needsWriteAccess ()
	Indicates whether this route requires write access to the wiki.Handlers may override this method to return false if and only if the operation they implement is "safe" per RFC 7231 section 4.2.1. A handler's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.Handlers for GET, HEAD, OPTIONS, and TRACE requests should each implement a "safe" operation. Handlers of PUT and DELETE requests should each implement a non-"safe" operation. Note that handlers of POST requests can implement a "safe" operation, particularly in the case where large input parameters are required.The information provided by this method is used to perform basic authorization checks and to determine whether cross-origin requests are safe. Stability: stable to override Returns bool

Public Member Functions inherited from MediaWiki\Rest\Handler\ParsoidHandler
	__construct (RevisionLookup $revisionLookup, SiteConfig $siteConfig, PageConfigFactory $pageConfigFactory, DataAccess $dataAccess)

	getSupportedRequestTypes ()
	Returns the content types that should be accepted by parseBodyData().

Public Member Functions inherited from MediaWiki\Rest\Handler
	applyCacheControl (ResponseInterface $response)
	Apply cache control to enforce privacy.

	applyConditionalResponseHeaders (ResponseInterface $response)
	Apply verifier headers to the response, per RFC 7231 §7.2.

	applyDeprecationHeader (ResponseInterface $response)
	Apply Deprecation header per RFC 9745.

	checkSession ()
	Check the session (and session provider)

	getAuthority ()
	Get the current acting authority.

	getBodyParamSettings ()
	Fetch ParamValidator settings for body fields.

	getBodyValidator ( $contentType)
	Fetch the BodyValidator.

	getConfig ()
	Get the configuration array for the current route.

	getOpenApiSpec (string $method)
	Returns an OpenAPI Operation Object specification structure as an associative array.

	getPath ()
	Returns the path this handler is bound to relative to the module prefix.

	getRequest ()
	Get the current request.

	getResponseFactory ()
	Get the ResponseFactory which can be used to generate Response objects.

	getResponseHeaderSettings ()
	Fetch the settings array mapping response headers to their descriptions and schemas.

	getSession ()
	Get the Session.

	getSupportedPathParams ()
	Get a list of parameter placeholders present in the route's path as returned by getPath().

	getValidatedBody ()
	Fetch the validated body.

	getValidatedParams ()
	Fetch the validated parameters.

	initContext (Module $module, string $path, array $routeConfig, array $openApiSpec=[])
	Injects information about the handler's context in the Module.

	initForExecute (RequestInterface $request)
	Initialise for execution based on the given request.

	initServices (Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer)
	Inject service objects.

	initSession (Session $session)
	Inject session information.

	needsReadAccess ()
	Indicates whether this route requires read rights.

	parseBodyData (RequestInterface $request)
	Returns the parsed body of the request.

	requireSafeAgainstCsrf ()
	Indicates whether this route can be accessed only by session providers safe vs csrf.

	validate (Validator $restValidator)
	Validate the request parameters/attributes and body.

Protected Member Functions
	generateResponseSpec (string $method)
	Returns an OpenAPI Responses Object specification structure as an associative array.

	getOpts (array $body, RequestInterface $request)

&	getRequestAttributes ()
	Rough equivalent of req.local from Parsoid-JS.

Protected Member Functions inherited from MediaWiki\Rest\Handler\ParsoidHandler
	acceptable (array &$attribs)
	This method checks if we support the requested content formats As a side-effect, it updates $attribs to set outputContentVersion that Parsoid should generate based on request headers.

	assertDomainIsCorrect ( $domain)
	Verify that the {domain} path parameter matches the actual domain.

	getHtmlInputTransformHelper (array $attribs, string $html, PageIdentity $page)

	getPageContentEndpoint (string $format=ParsoidFormatHelper::FORMAT_HTML)
	Get the path for the page content endpoint.

	getParsedBody ()
	Get the parsed body by content-type.

	getRevisionContentEndpoint (string $format=ParsoidFormatHelper::FORMAT_HTML)
	Get the path for the page content endpoint.

	getTransformEndpoint (string $format=ParsoidFormatHelper::FORMAT_HTML)
	Get the path for the transform endpoint.

	html2wt ( $page, array $attribs, string $html)

	languageConversion (PageConfig $pageConfig, array $attribs, array $revision)
	Do variant conversion on a document.

	newParsoid ()

	parseHTML (string $html, bool $validateXMLNames=false)

	pb2pb (array $attribs)
	Pagebundle -> pagebundle helper.

	tryToCreatePageConfig (array $attribs, ?string $wikitextOverride=null, bool $html2WtMode=false)
	Try to create a PageConfig object.

	tryToCreatePageIdentity (array $attribs)
	Try to create a PageIdentity object.

	updateRedLinks (PageConfig $pageConfig, array $attribs, array $revision)
	Update red links on a document.

	wt2html (PageConfig $pageConfig, array $attribs, ?string $wikitext=null)
	Wikitext -> HTML helper.

Protected Member Functions inherited from MediaWiki\Rest\Handler
	detectExtraneousBodyFields (Validator $restValidator)
	Subclasses may override this to disable or modify checks for extraneous body fields.

	getConditionalHeaderUtil ()
	Get a ConditionalHeaderUtil object.

	getDeprecatedDate ()
	Returns the timestamp at which this was or will be deprecated, or null if none.

	getETag ()
	The subclass should override this to provide an ETag for the current state of the requested resource.

	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata.

	getHookRunner ()
	Get a HookRunner for running core hooks.

	getJsonLocalizer ()
	Get a JsonLocalizer object.

	getLastModified ()
	The subclass should override this to provide the maximum last modified timestamp of the requested resource.

	getModule ()
	Get the Module this handler belongs to.

	getRequestBodySchema (string $mediaType)
	Returns a content schema per the OpenAPI spec.

	getRequestSpec (string $method)
	Returns an OpenAPI Request Body Object specification structure as an associative array.

	getResponseBodySchema (string $method)
	Returns an OpenAPI Schema Object specification structure as an associative array.

	getResponseBodySchemaFileName (string $method)
	Returns the path and name of a JSON file containing an OpenAPI Schema Object specification structure.

	getRouter ()

	getRouteUrl ( $pathParams=[], $queryParams=[])
	Get the URL of this handler's endpoint.

	hasRepresentation ()
	The subclass should override this to indicate whether the resource exists.

	isDeprecated ()
	Indicates whether this is deprecated.

	postInitSetup ()
	The handler can override this to do any necessary setup after the init functions are called to inject dependencies.

	postValidationSetup ()
	The handler can override this to do any necessary setup after validate() has been called.

	urlEncodeTitle ( $title)
	URL-encode titles in a "pretty" way.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Rest\Handler\ParsoidHandler
static	factory ()

Public Attributes inherited from MediaWiki\Rest\Handler
const	KNOWN_PARAM_SOURCES = Validator::KNOWN_PARAM_SOURCES

const	OPENAPI_DESCRIPTION_KEY = 'description'

const	PARAM_DESCRIPTION = Validator::PARAM_DESCRIPTION

const	PARAM_SOURCE = Validator::PARAM_SOURCE

Protected Attributes inherited from MediaWiki\Rest\Handler\ParsoidHandler
DataAccess	$dataAccess

ExtensionRegistry	$extensionRegistry

StatsdDataFactoryInterface	$metrics
	A statistics aggregator.

PageConfigFactory	$pageConfigFactory

SiteConfig	$siteConfig

Detailed Description

Handler for transforming content given in the request.

This handler can provide the intended APIs of restbase V1 routes, such as:

POST /v1/transform/wikitext/to/html
POST /v1/transform/html/to/wikitext
POST /v1/transform/wikitext/to/lint
POST /v1/transform/wikitext/to/html/{title}
POST /v1/transform/html/to/wikitext/{title}
POST /v1/transform/wikitext/to/lint/{title}
POST /v1/transform/wikitext/to/html/{title}/{revision}
POST /v1/transform/html/to/wikitext/{title}/{revision}
POST /v1/transform/wikitext/to/lint/{title}/{revision}

This class is extended by the Parsoid extension, as CoreTransformHandler. Be careful with changes, in order to not break Parsoid.

This handler can also provide the intended APIs of Parsoid V3 routes. These routes are mentioned in the relevant links below.

See also: https://www.mediawiki.org/wiki/Parsoid/API#POST

Definition at line 42 of file TransformHandler.php.

Member Function Documentation

◆ checkPreconditions()

MediaWiki\Rest\Handler\TransformHandler::checkPreconditions ( )

Check the conditional request headers and generate a response if appropriate.

This is called by the Router before execute() and may be overridden.

Stability: stable: to override

Returns: ResponseInterface|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 80 of file TransformHandler.php.

◆ execute()

MediaWiki\Rest\Handler\TransformHandler::execute ( )

Transform content given in the request from or to wikitext.

Returns: Response

Exceptions

HttpException

Reimplemented from MediaWiki\Rest\Handler\ParsoidHandler.

Definition at line 210 of file TransformHandler.php.

◆ generateResponseSpec()

MediaWiki\Rest\Handler\TransformHandler::generateResponseSpec ( string $method )

protected

Returns an OpenAPI Responses Object specification structure as an associative array.

See also: https://swagger.io/specification/#responses-object

By default, this will contain basic information response for status 200, 400, and 500. The getResponseBodySchema() method is used to determine the structure of the response for status 200.

Subclasses may override this to provide additional information about the structure of responses.

Parameters

string $method The HTTP method to produce a spec for ("get", "post", etc).

Stability: stable: to override

Returns: array

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 122 of file TransformHandler.php.

◆ getHeaderParamSettings()

MediaWiki\Rest\Handler\TransformHandler::getHeaderParamSettings ( )

Fetch ParamValidator settings for request headers.Every setting must include self::PARAM_SOURCE as 'header' to specify it's a request header for the endpoint.Subclasses that must use the headers from a request should consider having PARAM_REQUIRED setting of "true", Otherwise if the header's existence or non-existence doesn't break the code the PARAM_REQUIRED should be set to "false".

Stability: stable: to override

Returns: array[] Associative array mapping header names to ParamValidator settings arrays

Returns: array

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 155 of file TransformHandler.php.

◆ getOpts()

MediaWiki\Rest\Handler\TransformHandler::getOpts	(	array	$body,
		RequestInterface	$request )

protected

Reimplemented from MediaWiki\Rest\Handler\ParsoidHandler.

Definition at line 87 of file TransformHandler.php.

◆ getParamSettings()

MediaWiki\Rest\Handler\TransformHandler::getParamSettings ( )

Fetch ParamValidator settings for parameters.Every setting must include self::PARAM_SOURCE to specify which part of the request is to contain the parameter.Can be used for the request body as well, by setting self::PARAM_SOURCE to "post". Note that the values of "post" parameters will be accessible through getValidatedParams(). "post" parameters are used with form data (application/x-www-form-urlencoded or multipart/form-data).For "query" parameters, a PARAM_REQUIRED setting of "false" means the caller does not have to supply the parameter. For "path" parameters, the path matcher will always require the caller to supply all path parameters for a route, regardless of the PARAM_REQUIRED setting. However, "path" parameters may be specified in getParamSettings() as non-required to indicate that the handler services multiple routes, some of which may not supply the parameter.

Stability: stable: to override

Returns: array[] Associative array mapping parameter names to ParamValidator settings arrays

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 45 of file TransformHandler.php.

References MediaWiki\Rest\Handler\getConfig(), and MediaWiki\Rest\Handler\PARAM_DESCRIPTION.

◆ getRequestAttributes()

& MediaWiki\Rest\Handler\TransformHandler::getRequestAttributes ( )

protected

Rough equivalent of req.local from Parsoid-JS.

FIXME most of these should be replaced with more native ways of handling the request.

Returns: array

Reimplemented from MediaWiki\Rest\Handler\ParsoidHandler.

Definition at line 97 of file TransformHandler.php.

References MediaWiki\Rest\Handler\getRequest().

◆ needsWriteAccess()

MediaWiki\Rest\Handler\TransformHandler::needsWriteAccess ( )

Indicates whether this route requires write access to the wiki.Handlers may override this method to return false if and only if the operation they implement is "safe" per RFC 7231 section 4.2.1. A handler's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.Handlers for GET, HEAD, OPTIONS, and TRACE requests should each implement a "safe" operation. Handlers of PUT and DELETE requests should each implement a non-"safe" operation. Note that handlers of POST requests can implement a "safe" operation, particularly in the case where large input parameters are required.The information provided by this method is used to perform basic authorization checks and to determine whether cross-origin requests are safe.

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 76 of file TransformHandler.php.

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

includes/Rest/Handler/TransformHandler.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checkPreconditions()

◆ execute()

◆ generateResponseSpec()

◆ getHeaderParamSettings()

◆ getOpts()

◆ getParamSettings()

◆ getRequestAttributes()

◆ needsWriteAccess()