Base class for Parsoid handlers. More...

Inherited by MediaWiki\Rest\Handler\TransformHandler.

Collaboration diagram for MediaWiki\Rest\Handler\ParsoidHandler:

[legend]

Public Member Functions
	__construct (RevisionLookup $revisionLookup, SiteConfig $siteConfig, PageConfigFactory $pageConfigFactory, DataAccess $dataAccess)

	execute ()
	Execute the handler.This is called after parameter validation. The return value can either be a Response or any type accepted by ResponseFactory::createFromReturnValue().To automatically construct an error response, execute() should throw a \MediaWiki\Rest\HttpException. Such exceptions will not be logged like a normal exception.If execute() throws any other kind of exception, the exception will be logged and a generic 500 error page will be shown. Stability: stable to override Returns mixed

	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.

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

	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.

	getParamSettings ()
	Fetch ParamValidator settings for parameters.

	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.

	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.

	needsWriteAccess ()
	Indicates whether this route requires write access to the wiki.

	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.

Static Public Member Functions
static	factory ()

Protected Member Functions
	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)

	getOpts (array $body, RequestInterface $request)

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

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

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

	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.

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

	getConditionalHeaderUtil ()
	Get a ConditionalHeaderUtil object.

	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.

	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.

Protected Attributes
DataAccess	$dataAccess

ExtensionRegistry	$extensionRegistry

StatsdDataFactoryInterface	$metrics
	A statistics aggregator.

PageConfigFactory	$pageConfigFactory

SiteConfig	$siteConfig

Additional Inherited Members
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

Detailed Description

Base class for Parsoid handlers.

Access: internal: For use by the Parsoid extension

Definition at line 78 of file ParsoidHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\ParsoidHandler::__construct	(	RevisionLookup	$revisionLookup,
		SiteConfig	$siteConfig,
		PageConfigFactory	$pageConfigFactory,
		DataAccess	$dataAccess )

Definition at line 108 of file ParsoidHandler.php.

References MediaWiki\Parser\Parsoid\Config\SiteConfig\metrics().

Member Function Documentation

◆ acceptable()

MediaWiki\Rest\Handler\ParsoidHandler::acceptable ( array & $attribs )

protected

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.

Parameters

array &$attribs Request attributes from getRequestAttributes()

Returns: bool

Definition at line 439 of file ParsoidHandler.php.

◆ assertDomainIsCorrect()

MediaWiki\Rest\Handler\ParsoidHandler::assertDomainIsCorrect ( $domain )

protected

Verify that the {domain} path parameter matches the actual domain.

Todo: Remove this when we no longer need to support the {domain} parameter with backwards compatibility with the parsoid extension.

Parameters

string $domain Domain name parameter to validate

Definition at line 136 of file ParsoidHandler.php.

◆ execute()

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

abstract

Execute the handler.This is called after parameter validation. The return value can either be a Response or any type accepted by ResponseFactory::createFromReturnValue().To automatically construct an error response, execute() should throw a \MediaWiki\Rest\HttpException. Such exceptions will not be logged like a normal exception.If execute() throws any other kind of exception, the exception will be logged and a generic 500 error page will be shown.

Stability: stable: to override

Returns: mixed

Reimplemented from MediaWiki\Rest\Handler.

Reimplemented in MediaWiki\Rest\Handler\TransformHandler.

◆ factory()

static MediaWiki\Rest\Handler\ParsoidHandler::factory ( )

static

Returns: static

Definition at line 97 of file ParsoidHandler.php.

◆ getHtmlInputTransformHelper()

MediaWiki\Rest\Handler\ParsoidHandler::getHtmlInputTransformHelper	(	array	$attribs,
		string	$html,
		PageIdentity	$page )

protected

Parameters

array	$attribs
string	$html
PageIdentity	$page

Returns: HtmlInputTransformHelper

Definition at line 399 of file ParsoidHandler.php.

◆ getOpts()

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

protected

Reimplemented in MediaWiki\Rest\Handler\TransformHandler.

Definition at line 202 of file ParsoidHandler.php.

◆ getPageContentEndpoint()

MediaWiki\Rest\Handler\ParsoidHandler::getPageContentEndpoint ( string $format = ParsoidFormatHelper::FORMAT_HTML )

protected

Get the path for the page content endpoint.

May be overwritten to override the path.

This is done in the parsoid extension, for backwards compatibility with the old endpoint URLs.

Stability: stable: to override

Parameters

string $format The format the endpoint is expected to return.

Returns: string

Definition at line 624 of file ParsoidHandler.php.

◆ getParsedBody()

MediaWiki\Rest\Handler\ParsoidHandler::getParsedBody ( )

protected

Get the parsed body by content-type.

Definition at line 180 of file ParsoidHandler.php.

◆ getRequestAttributes()

& MediaWiki\Rest\Handler\ParsoidHandler::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 in MediaWiki\Rest\Handler\TransformHandler.

Definition at line 214 of file ParsoidHandler.php.

◆ getRevisionContentEndpoint()

MediaWiki\Rest\Handler\ParsoidHandler::getRevisionContentEndpoint ( string $format = ParsoidFormatHelper::FORMAT_HTML )

protected

Get the path for the page content endpoint.

May be overwritten to override the path.

This is done in the parsoid extension, for backwards compatibility with the old endpoint URLs.

Stability: stable: to override

Parameters

string $format The format the endpoint is expected to return.

Returns: string

Definition at line 643 of file ParsoidHandler.php.

◆ getSupportedRequestTypes()

MediaWiki\Rest\Handler\ParsoidHandler::getSupportedRequestTypes ( )

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

Subclasses that support request types other than application/json should override this method.

If "application/x-www-form-urlencoded" or "multipart/form-data" are returned, parseBodyData() will use $request->getPostParams() to determine the body data.

Note: The return value of this method is ignored for requests using a method listed in Validator::NO_BODY_METHODS, in particular for the GET method.; for backwards compatibility, the default implementation of this method will examine the parameter definitions returned by getParamSettings() to see if any of the parameters are declared as "post" parameters. If this is the case, support for "application/x-www-form-urlencoded" and "multipart/form-data" is added. This may change in future releases. It is preferred to use "body" parameters and override this method explicitly when support for form data is desired.

Stability: stable: to override

Returns: string[] A list of content-types

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 122 of file ParsoidHandler.php.

References MediaWiki\Rest\Handler\getSupportedRequestTypes().

◆ getTransformEndpoint()

MediaWiki\Rest\Handler\ParsoidHandler::getTransformEndpoint ( string $format = ParsoidFormatHelper::FORMAT_HTML )

protected

Get the path for the transform endpoint.

May be overwritten to override the path.

This is done in the parsoid extension, for backwards compatibility with the old endpoint URLs.

Stability: stable: to override

Parameters

string $format The format the endpoint is expected to return.

Returns: string

Definition at line 608 of file ParsoidHandler.php.

◆ html2wt()

MediaWiki\Rest\Handler\ParsoidHandler::html2wt	(		$page,
		array	$attribs,
		string	$html )

protected

Parameters

PageConfig \| PageIdentity	$page
array	$attribs	Attributes gotten from requests
string	$html	Original HTML

Returns: Response

Exceptions

HttpException

Definition at line 860 of file ParsoidHandler.php.

◆ languageConversion()

MediaWiki\Rest\Handler\ParsoidHandler::languageConversion	(	PageConfig	$pageConfig,
		array	$attribs,
		array	$revision )

protected

Do variant conversion on a document.

Parameters

PageConfig	$pageConfig
array	$attribs
array	$revision

Returns: Response

Exceptions

HttpException

Definition at line 1020 of file ParsoidHandler.php.

References $source.

◆ newParsoid()

MediaWiki\Rest\Handler\ParsoidHandler::newParsoid ( )

protected

Definition at line 844 of file ParsoidHandler.php.

◆ parseHTML()

MediaWiki\Rest\Handler\ParsoidHandler::parseHTML	(	string	$html,
		bool	$validateXMLNames = false )

protected

Definition at line 848 of file ParsoidHandler.php.

◆ pb2pb()

MediaWiki\Rest\Handler\ParsoidHandler::pb2pb ( array $attribs )

protected

Pagebundle -> pagebundle helper.

Parameters

array<string,array|string> $attribs

Returns: Response

Exceptions

HttpException

Definition at line 888 of file ParsoidHandler.php.

◆ tryToCreatePageConfig()

MediaWiki\Rest\Handler\ParsoidHandler::tryToCreatePageConfig	(	array	$attribs,
		?string	$wikitextOverride = null,
		bool	$html2WtMode = false )

protected

Try to create a PageConfig object.

If we get an exception (because content may be missing or inaccessible), throw an appropriate HTTP response object for callers to handle.

Parameters

array	$attribs
?string	$wikitextOverride	Custom wikitext to use instead of the real content of the page.
bool	$html2WtMode

Returns: PageConfig

Exceptions

HttpException

Definition at line 506 of file ParsoidHandler.php.

◆ tryToCreatePageIdentity()

MediaWiki\Rest\Handler\ParsoidHandler::tryToCreatePageIdentity ( array $attribs )

protected

Try to create a PageIdentity object.

If no page is specified in the request, this will return the wiki's main page. If an invalid page is requested, this throws an appropriate HTTPException.

Parameters

array $attribs

Returns: PageIdentity

Exceptions

HttpException

Definition at line 576 of file ParsoidHandler.php.

◆ updateRedLinks()

MediaWiki\Rest\Handler\ParsoidHandler::updateRedLinks	(	PageConfig	$pageConfig,
		array	$attribs,
		array	$revision )

protected

Update red links on a document.

Parameters

PageConfig	$pageConfig
array	$attribs
array	$revision

Returns: Response

Definition at line 986 of file ParsoidHandler.php.

◆ wt2html()

MediaWiki\Rest\Handler\ParsoidHandler::wt2html	(	PageConfig	$pageConfig,
		array	$attribs,
		?string	$wikitext = null )

protected

Wikitext -> HTML helper.

Spec'd in https://phabricator.wikimedia.org/T75955 and the API tests.

Parameters

PageConfig	$pageConfig
array	$attribs	Request attributes from getRequestAttributes()
?string	$wikitext	Wikitext to transform (or null to use the page specified in the request attributes).

Returns: Response

Definition at line 681 of file ParsoidHandler.php.

Member Data Documentation

◆ $dataAccess

DataAccess MediaWiki\Rest\Handler\ParsoidHandler::$dataAccess

protected

Definition at line 83 of file ParsoidHandler.php.

◆ $extensionRegistry

ExtensionRegistry MediaWiki\Rest\Handler\ParsoidHandler::$extensionRegistry

protected

Definition at line 86 of file ParsoidHandler.php.

◆ $metrics

StatsdDataFactoryInterface MediaWiki\Rest\Handler\ParsoidHandler::$metrics

protected

A statistics aggregator.

Definition at line 89 of file ParsoidHandler.php.

◆ $pageConfigFactory

PageConfigFactory MediaWiki\Rest\Handler\ParsoidHandler::$pageConfigFactory

protected

Definition at line 82 of file ParsoidHandler.php.

◆ $siteConfig

SiteConfig MediaWiki\Rest\Handler\ParsoidHandler::$siteConfig

protected

Definition at line 81 of file ParsoidHandler.php.

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

includes/Rest/Handler/ParsoidHandler.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ acceptable()

◆ assertDomainIsCorrect()

◆ execute()

◆ factory()

◆ getHtmlInputTransformHelper()

◆ getOpts()

◆ getPageContentEndpoint()

◆ getParsedBody()

◆ getRequestAttributes()

◆ getRevisionContentEndpoint()

◆ getSupportedRequestTypes()

◆ getTransformEndpoint()

◆ html2wt()

◆ languageConversion()

◆ newParsoid()

◆ parseHTML()

◆ pb2pb()

◆ tryToCreatePageConfig()

◆ tryToCreatePageIdentity()

◆ updateRedLinks()

◆ wt2html()

Member Data Documentation

◆ $dataAccess

◆ $extensionRegistry

◆ $metrics

◆ $pageConfigFactory

◆ $siteConfig