MediaWiki  master
MediaWiki\Rest\Handler\ParsoidHandler Class Reference

Base class for Parsoid handlers. More...

Inheritance diagram for MediaWiki\Rest\Handler\ParsoidHandler:
Collaboration diagram for MediaWiki\Rest\Handler\ParsoidHandler:

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
More...
 
- Public Member Functions inherited from MediaWiki\Rest\Handler
 applyCacheControl (ResponseInterface $response)
 Apply cache control to enforce privacy. More...
 
 applyConditionalResponseHeaders (ResponseInterface $response)
 Apply verifier headers to the response, per RFC 7231 ยง7.2. More...
 
 checkPreconditions ()
 Check the conditional request headers and generate a response if appropriate. More...
 
 checkSession ()
 Check the session (and session provider) More...
 
 getAuthority ()
 Get the current acting authority. More...
 
 getBodyValidator ( $contentType)
 Fetch the BodyValidator. More...
 
 getConfig ()
 Get the configuration array for the current route. More...
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters. More...
 
 getRequest ()
 Get the current request. More...
 
 getResponseFactory ()
 Get the ResponseFactory which can be used to generate Response objects. More...
 
 getSession ()
 Get the Session. More...
 
 getValidatedBody ()
 Fetch the validated body. More...
 
 getValidatedParams ()
 Fetch the validated parameters. More...
 
 init (Router $router, RequestInterface $request, array $config, Authority $authority, ResponseFactory $responseFactory, HookContainer $hookContainer, Session $session)
 Initialise with dependencies from the Router. More...
 
 needsReadAccess ()
 Indicates whether this route requires read rights. More...
 
 needsWriteAccess ()
 Indicates whether this route requires write access. More...
 
 requireSafeAgainstCsrf ()
 Indicates whether this route can be accessed only by session providers safe vs csrf. More...
 
 validate (Validator $restValidator)
 Validate the request parameters/attributes and body. More...
 

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. More...
 
 assertDomainIsCorrect ( $domain)
 Verify that the {domain} path parameter matches the actual domain. More...
 
 createPageConfig (string $title, ?int $revision, ?string $wikitextOverride=null, ?string $pagelanguageOverride=null)
 
 createRedirectResponse (string $path, array $pathParams=[], array $queryParams=[])
 Redirect to another Parsoid URL (e.g. More...
 
 createRedirectToOldidResponse (PageConfig $pageConfig, array $attribs)
 Expand the current URL with the latest revision number and redirect there. More...
 
 getHtmlInputTransformHelper (array $attribs, string $html, $page)
 
 getPageContentEndpoint (string $format=ParsoidFormatHelper::FORMAT_HTML)
 Get the path for the page content endpoint. More...
 
 getParsedBody ()
 Get the parsed body by content-type. More...
 
 getRedirectRouteUrl (string $path, array $pathParams=[], array $queryParams=[])
 Returns the target URL for a redirect to the given path and parameters. More...
 
getRequestAttributes ()
 Rough equivalent of req.local from Parsoid-JS. More...
 
 getRevisionContentEndpoint (string $format=ParsoidFormatHelper::FORMAT_HTML)
 Get the path for the page content endpoint. More...
 
 getTransformEndpoint (string $format=ParsoidFormatHelper::FORMAT_HTML)
 Get the path for the transform endpoint. More...
 
 html2wt ( $page, array $attribs, string $html)
 
 languageConversion (PageConfig $pageConfig, array $attribs, array $revision)
 Do variant conversion on a document. More...
 
 newParsoid ()
 
 parseHTML (string $html, bool $validateXMLNames=false)
 
 pb2pb (array $attribs)
 Pagebundle -> pagebundle helper. More...
 
 tryToCreatePageConfig (array $attribs, ?string $wikitext=null, bool $html2WtMode=false)
 Try to create a PageConfig object. More...
 
 tryToCreatePageIdentity (array $attribs)
 Try to create a PageIdentity object. More...
 
 updateRedLinks (PageConfig $pageConfig, array $attribs, array $revision)
 Update red links on a document. More...
 
 wt2html (PageConfig $pageConfig, array $attribs, ?string $wikitext=null)
 Wikitext -> HTML helper. More...
 
- Protected Member Functions inherited from MediaWiki\Rest\Handler
 getConditionalHeaderUtil ()
 Get a ConditionalHeaderUtil object. More...
 
 getETag ()
 The subclass should override this to provide an ETag for the current state of the requested resource. More...
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getLastModified ()
 The subclass should override this to provide the maximum last modified timestamp of the requested resource. More...
 
 getRouter ()
 Get the Router. More...
 
 getRouteUrl ( $pathParams=[], $queryParams=[])
 Get the URL of this handler's endpoint. More...
 
 hasRepresentation ()
 The subclass should override this to indicate whether the resource exists. More...
 
 postInitSetup ()
 The handler can override this to do any necessary setup after init() is called to inject the dependencies. More...
 
 postValidationSetup ()
 The handler can override this to do any necessary setup after validate() has been called. More...
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way. More...
 

Protected Attributes

DataAccess $dataAccess
 
ExtensionRegistry $extensionRegistry
 
StatsdDataFactoryInterface $metrics
 A statistics aggregator. More...
 
PageConfigFactory $pageConfigFactory
 
SiteConfig $siteConfig
 

Additional Inherited Members

- Public Attributes inherited from MediaWiki\Rest\Handler
const PARAM_SOURCE = 'rest-param-source'
 (string) ParamValidator constant to specify the source of the parameter. More...
 

Detailed Description

Base class for Parsoid handlers.

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

References ExtensionRegistry\getInstance().

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&$attribsRequest attributes from getRequestAttributes()
Returns
bool

Definition at line 341 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$domainDomain name parameter to validate

Definition at line 131 of file ParsoidHandler.php.

◆ createPageConfig()

MediaWiki\Rest\Handler\ParsoidHandler::createPageConfig ( string  $title,
?int  $revision,
?string  $wikitextOverride = null,
?string  $pagelanguageOverride = null 
)
protected
Parameters
string$titleThe 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.
?string$pagelanguageOverride
Returns
PageConfig

Definition at line 404 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$pathTarget URL
array$pathParamsPath parameters to inject into path
array$queryParamsQuery parameters
Returns
Response

Definition at line 455 of file ParsoidHandler.php.

◆ 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$attribsRequest attributes from getRequestAttributes()
Returns
Response

Definition at line 627 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 93 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 289 of file ParsoidHandler.php.

References $title.

◆ 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$formatThe format the endpoint is expected to return.
Returns
string

Definition at line 594 of file ParsoidHandler.php.

◆ getParsedBody()

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

Get the parsed body by content-type.

Returns
array

Definition at line 177 of file ParsoidHandler.php.

◆ 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 489 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

Definition at line 200 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$formatThe format the endpoint is expected to return.
Returns
string

Definition at line 613 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$formatThe format the endpoint is expected to return.
Returns
string

Definition at line 578 of file ParsoidHandler.php.

◆ html2wt()

MediaWiki\Rest\Handler\ParsoidHandler::html2wt (   $page,
array  $attribs,
string  $html 
)
protected
Parameters
PageConfig | PageIdentity$page
array$attribsAttributes gotten from requests
string$htmlOriginal HTML
Returns
Response
Exceptions
HttpException

Definition at line 872 of file ParsoidHandler.php.

References Title\newFromTextThrow().

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

References $source.

◆ newParsoid()

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

Definition at line 856 of file ParsoidHandler.php.

◆ parseHTML()

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

Definition at line 860 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 901 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 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 548 of file ParsoidHandler.php.

References Title\newMainPage().

◆ 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 1009 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$attribsRequest attributes from getRequestAttributes()
?string$wikitext Wikitext to transform (or null to use the page specified in the request attributes).
Returns
Response

Definition at line 667 of file ParsoidHandler.php.

References $content.

Member Data Documentation

◆ $dataAccess

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

Definition at line 79 of file ParsoidHandler.php.

◆ $extensionRegistry

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

Definition at line 82 of file ParsoidHandler.php.

◆ $metrics

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

A statistics aggregator.

Definition at line 85 of file ParsoidHandler.php.

◆ $pageConfigFactory

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

Definition at line 76 of file ParsoidHandler.php.

◆ $siteConfig

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

Definition at line 73 of file ParsoidHandler.php.


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