MediaWiki
master
|
Base class for Parsoid handlers. More...
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.
| |
wtLint (PageConfig $pageConfig, array $attribs, ?string $wikitext=null) | |
![]() | |
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... | |
getPath () | |
Returns the path this handler is bound to, including path variables. 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... | |
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, PageIdentity $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 $wikitextOverride=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... | |
![]() | |
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 | |
![]() | |
const | PARAM_SOURCE = 'rest-param-source' |
(string) ParamValidator constant to specify the source of the parameter. More... | |
Base class for Parsoid handlers.
Definition at line 72 of file ParsoidHandler.php.
MediaWiki\Rest\Handler\ParsoidHandler::__construct | ( | RevisionLookup | $revisionLookup, |
SiteConfig | $siteConfig, | ||
PageConfigFactory | $pageConfigFactory, | ||
DataAccess | $dataAccess | ||
) |
RevisionLookup | $revisionLookup | |
SiteConfig | $siteConfig | |
PageConfigFactory | $pageConfigFactory | |
DataAccess | $dataAccess |
Definition at line 118 of file ParsoidHandler.php.
References ExtensionRegistry\getInstance().
|
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.
array | &$attribs | Request attributes from getRequestAttributes() |
Definition at line 434 of file ParsoidHandler.php.
|
protected |
Verify that the {domain} path parameter matches the actual domain.
string | $domain | Domain name parameter to validate |
Definition at line 139 of file ParsoidHandler.php.
|
protected |
Redirect to another Parsoid URL (e.g.
canonization)
string | $path | Target URL |
array | $pathParams | Path parameters to inject into path |
array | $queryParams | Query parameters |
Definition at line 500 of file ParsoidHandler.php.
|
protected |
Expand the current URL with the latest revision number and redirect there.
PageConfig | $pageConfig | |
array | $attribs | Request attributes from getRequestAttributes() |
Definition at line 739 of file ParsoidHandler.php.
|
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.
Reimplemented from MediaWiki\Rest\Handler.
Reimplemented in MediaWiki\Rest\Handler\TransformHandler.
|
static |
Definition at line 101 of file ParsoidHandler.php.
|
protected |
array | $attribs | |
string | $html | |
PageIdentity | $page |
Definition at line 393 of file ParsoidHandler.php.
|
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.
string | $format | The format the endpoint is expected to return. |
Definition at line 669 of file ParsoidHandler.php.
|
protected |
Get the parsed body by content-type.
Definition at line 185 of file ParsoidHandler.php.
|
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.
string | $path | |
array | $pathParams | |
array | $queryParams |
Definition at line 534 of file ParsoidHandler.php.
References $path.
|
protected |
Rough equivalent of req.local from Parsoid-JS.
FIXME most of these should be replaced with more native ways of handling the request.
Reimplemented in MediaWiki\Rest\Handler\TransformHandler.
Definition at line 208 of file ParsoidHandler.php.
|
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.
string | $format | The format the endpoint is expected to return. |
Definition at line 688 of file ParsoidHandler.php.
|
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.
string | $format | The format the endpoint is expected to return. |
Definition at line 653 of file ParsoidHandler.php.
|
protected |
PageConfig | PageIdentity | $page | |
array | $attribs | Attributes gotten from requests |
string | $html | Original HTML |
HttpException |
Definition at line 991 of file ParsoidHandler.php.
|
protected |
Do variant conversion on a document.
PageConfig | $pageConfig | |
array | $attribs | |
array | $revision |
HttpException |
Definition at line 1164 of file ParsoidHandler.php.
References $source.
|
protected |
Definition at line 975 of file ParsoidHandler.php.
|
protected |
Definition at line 979 of file ParsoidHandler.php.
|
protected |
Pagebundle -> pagebundle helper.
array<string,array|string> | $attribs |
HttpException |
Definition at line 1020 of file ParsoidHandler.php.
|
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.
array | $attribs | |
?string | $wikitextOverride Custom wikitext to use instead of the real content of the page. | |
bool | $html2WtMode |
HttpException |
Definition at line 552 of file ParsoidHandler.php.
|
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.
array | $attribs |
HttpException |
Definition at line 623 of file ParsoidHandler.php.
|
protected |
Update red links on a document.
PageConfig | $pageConfig | |
array | $attribs | |
array | $revision |
Definition at line 1128 of file ParsoidHandler.php.
|
protected |
Wikitext -> HTML helper.
Spec'd in https://phabricator.wikimedia.org/T75955 and the API tests.
PageConfig | $pageConfig | |
array | $attribs | Request attributes from getRequestAttributes() |
?string | $wikitext Wikitext to transform (or null to use the page specified in the request attributes). |
Definition at line 806 of file ParsoidHandler.php.
MediaWiki\Rest\Handler\ParsoidHandler::wtLint | ( | PageConfig | $pageConfig, |
array | $attribs, | ||
?string | $wikitext = null |
||
) |
Definition at line 769 of file ParsoidHandler.php.
|
protected |
Definition at line 85 of file ParsoidHandler.php.
|
protected |
Definition at line 88 of file ParsoidHandler.php.
|
protected |
A statistics aggregator.
Definition at line 91 of file ParsoidHandler.php.
|
protected |
Definition at line 82 of file ParsoidHandler.php.
|
protected |
Definition at line 79 of file ParsoidHandler.php.