Base class for Parsoid handlers. More...

Inherited by MediaWiki\Rest\Handler\TransformHandler.

Collaboration diagram for MediaWiki\Rest\Handler\ParsoidHandler:

[legend]

Public Member Functions
	__construct (array $parsoidSettings, 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

	wtLint (PageConfig $pageConfig, array $attribs, ?string $wikitext=null)

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.

	getBodyValidator ( $contentType)
	Fetch the BodyValidator.

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

	getParamSettings ()
	Fetch ParamValidator settings for parameters.

	getPath ()
	Returns the path this handler is bound to, including path variables.

	getRequest ()
	Get the current request.

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

	getSession ()
	Get the Session.

	getValidatedBody ()
	Fetch the validated body.

	getValidatedParams ()
	Fetch the validated parameters.

	init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session)
	Initialise with dependencies from the Router.

	needsReadAccess ()
	Indicates whether this route requires read rights.

	needsWriteAccess ()
	Indicates whether this route requires write access.

	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.

	createPageConfig (string $title, ?int $revision, ?string $wikitextOverride=null, ?Bcp47Code $pagelanguageOverride=null)

	createRedirectResponse (string $path, array $pathParams=[], array $queryParams=[])
	Redirect to another Parsoid URL (e.g.

	createRedirectToOldidResponse (PageConfig $pageConfig, array $attribs)
	Expand the current URL with the latest revision number and redirect there.

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

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

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

	getRedirectRouteUrl (string $path, array $pathParams=[], array $queryParams=[])
	Returns the target URL for a redirect to the given path and parameters.

&	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 $wikitext=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
	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.

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

	getRouter ()
	Get the Router.

	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 init() is called to inject the 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
trait	PageRedirectHandlerTrait
	Important: this trait should be used for implementations of the Handler class.

const	PARAM_SOURCE = 'rest-param-source'
	(string) ParamValidator constant to specify the source of the parameter.

Detailed Description

Base class for Parsoid handlers.

Definition at line 71 of file ParsoidHandler.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

array	$parsoidSettings
SiteConfig	$siteConfig
PageConfigFactory	$pageConfigFactory
DataAccess	$dataAccess

Definition at line 118 of file ParsoidHandler.php.

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 445 of file ParsoidHandler.php.

References MediaWiki\Rest\Handler\getRequest().

◆ 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 139 of file ParsoidHandler.php.

References MediaWiki\Rest\Handler\getConfig().

◆ createPageConfig()

MediaWiki\Rest\Handler\ParsoidHandler::createPageConfig	(	string	$title,
		?int	$revision,
		?string	$wikitextOverride = null,
		?Bcp47Code	$pagelanguageOverride = null )

protected

Parameters

string	$title	The page to be transformed
?int	$revision	The revision to be transformed
?string	$wikitextOverride	Custom wikitext to use instead of the real content of the page.
?Bcp47Code	$pagelanguageOverride

Returns: PageConfig

Definition at line 508 of file ParsoidHandler.php.

◆ createRedirectResponse()

MediaWiki\Rest\Handler\ParsoidHandler::createRedirectResponse	(	string	$path,
		array	$pathParams = [],
		array	$queryParams = [] )

protected

Redirect to another Parsoid URL (e.g.

canonization)

Stability: stable: to override

Parameters

string	$path	Target URL
array	$pathParams	Path parameters to inject into path
array	$queryParams	Query parameters

Returns: Response

Definition at line 559 of file ParsoidHandler.php.

References MediaWiki\Rest\Handler\getRequest().

◆ createRedirectToOldidResponse()

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

protected

Expand the current URL with the latest revision number and redirect there.

Parameters

PageConfig	$pageConfig
array	$attribs	Request attributes from getRequestAttributes()

Returns: Response

Definition at line 768 of file ParsoidHandler.php.

References MediaWiki\Rest\Handler\getRequest().

◆ 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 101 of file ParsoidHandler.php.

◆ getHtmlInputTransformHelper()

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

protected

Parameters

array	$attribs
string	$html
PageConfig \| PageIdentity	$page

Returns: HtmlInputTransformHelper

Definition at line 398 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 698 of file ParsoidHandler.php.

◆ getParsedBody()

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

protected

Get the parsed body by content-type.

Returns: array

Definition at line 185 of file ParsoidHandler.php.

References MediaWiki\Rest\Handler\getRequest().

◆ getRedirectRouteUrl()

MediaWiki\Rest\Handler\ParsoidHandler::getRedirectRouteUrl	(	string	$path,
		array	$pathParams = [],
		array	$queryParams = [] )

protected

Returns the target URL for a redirect to the given path and parameters.

This exists so subclasses can override it to control whether the redirect should go to a private or to a public URL.

See also: Router::getRouteUrl()

Stability: stable: to override

Parameters

string	$path
array	$pathParams
array	$queryParams

Returns: string

Definition at line 593 of file ParsoidHandler.php.

References $path.

◆ 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 208 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 717 of file ParsoidHandler.php.

◆ 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 682 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 1017 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 1190 of file ParsoidHandler.php.

References $source.

◆ newParsoid()

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

protected

Definition at line 1001 of file ParsoidHandler.php.

◆ parseHTML()

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

protected

Definition at line 1005 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 1046 of file ParsoidHandler.php.

◆ tryToCreatePageConfig()

MediaWiki\Rest\Handler\ParsoidHandler::tryToCreatePageConfig	(	array	$attribs,
		?string	$wikitext = 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	$wikitext
bool	$html2WtMode

Returns: PageConfig

Exceptions

HttpException

Definition at line 610 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 652 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 1154 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 835 of file ParsoidHandler.php.

References MediaWiki\Rest\Handler\getRequest().

◆ wtLint()

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

Definition at line 798 of file ParsoidHandler.php.

Member Data Documentation

◆ $dataAccess

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

protected

Definition at line 87 of file ParsoidHandler.php.

◆ $extensionRegistry

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

protected

Definition at line 90 of file ParsoidHandler.php.

◆ $metrics

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

protected

A statistics aggregator.

Definition at line 93 of file ParsoidHandler.php.

◆ $pageConfigFactory

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

protected

Definition at line 84 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()

◆ createPageConfig()

◆ createRedirectResponse()

◆ createRedirectToOldidResponse()

◆ execute()

◆ factory()

◆ getHtmlInputTransformHelper()

◆ getPageContentEndpoint()

◆ getParsedBody()

◆ getRedirectRouteUrl()

◆ getRequestAttributes()

◆ getRevisionContentEndpoint()

◆ getTransformEndpoint()

◆ html2wt()

◆ languageConversion()

◆ newParsoid()

◆ parseHTML()

◆ pb2pb()

◆ tryToCreatePageConfig()

◆ tryToCreatePageIdentity()

◆ updateRedLinks()

◆ wt2html()

◆ wtLint()

Member Data Documentation

◆ $dataAccess

◆ $extensionRegistry

◆ $metrics

◆ $pageConfigFactory

◆ $siteConfig