MediaWiki master
MediaWiki\Rest\Handler\RevisionSourceHandler Class Reference

A handler that returns page source and metadata for the following routes: More...

Inherits MediaWiki\Rest\SimpleHandler.

Collaboration diagram for MediaWiki\Rest\Handler\RevisionSourceHandler:

Public Member Functions

 __construct (PageRestHelperFactory $helperFactory)
 
 getParamSettings ()
 Fetch ParamValidator settings for parameters.
 
 needsWriteAccess ()
 Indicates whether this route requires write access to the wiki.
 
 run ()
 
- Public Member Functions inherited from MediaWiki\Rest\SimpleHandler
 execute ()
 Execute the handler.
 
- 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.
 
 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().
 
 getSupportedRequestTypes ()
 Returns the content types that should be accepted by parseBodyData().
 
 getValidatedBody ()
 Fetch the validated body.
 
 getValidatedParams ()
 Fetch the validated parameters.
 
 initContext (Module $module, string $path, array $routeConfig)
 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

 getETag ()
 The subclass should override this to provide an ETag for the current state of the requested resource.
 
 getLastModified ()
 The subclass should override this to provide the maximum last modified timestamp of the requested resource.
 
 getResponseBodySchemaFileName (string $method)
 Returns the path and name of a JSON file containing an OpenAPI Schema Object specification structure.
 
 hasRepresentation ()
 
 postValidationSetup ()
 The handler can override this to do any necessary setup after validate() has been called.
 
- 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.
 
 getHookContainer ()
 Get a HookContainer, for running extension hooks or for hook metadata.
 
 getHookRunner ()
 Get a HookRunner for running core hooks.
 
 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.
 
 getRouter ()
 
 getRouteUrl ( $pathParams=[], $queryParams=[])
 Get the URL of this handler's endpoint.
 
 postInitSetup ()
 The handler can override this to do any necessary setup after the init functions are called to inject dependencies.
 
 urlEncodeTitle ( $title)
 URL-encode titles in a "pretty" way.
 

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
 
const RESPONSE_BODY_DESCRIPTION_KEY = 'x-i18n-description'
 

Detailed Description

A handler that returns page source and metadata for the following routes:

  • /revision/{revision}
  • /revision/{revision}/bare

Definition at line 19 of file RevisionSourceHandler.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Handler\RevisionSourceHandler::__construct ( PageRestHelperFactory $helperFactory)

Member Function Documentation

◆ getETag()

MediaWiki\Rest\Handler\RevisionSourceHandler::getETag ( )
protected

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

This is called before execute() in order to decide whether to send a 304. If the request is going to change the state of the resource, the ETag returned must represent the state before the change. In other words, it must identify the entity that the change is going to be applied to.

For GET and HEAD requests, this ETag will also be included in the response.

Handlers that modify the resource and want to return an ETag header representing the new state in the response should set the header in the execute() method. However, note that responses to PUT requests must not return an ETag unless the new content of the resource is exactly the data that was sent by the client in the request body.

This must be a complete ETag, including double quotes. See RFC 7231 §7.2 and RFC 7232 §2.3 for semantics.

Stability: stable
to override
Returns
string|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 98 of file RevisionSourceHandler.php.

◆ getLastModified()

MediaWiki\Rest\Handler\RevisionSourceHandler::getLastModified ( )
protected

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

This is called before execute() in order to decide whether to send a 304. If the request is going to change the state of the resource, the time returned must represent the last modification date before the change. In other words, it must provide the timestamp of the entity that the change is going to be applied to.

For GET and HEAD requests, this value will automatically be included in the response in the Last-Modified header.

Handlers that modify the resource and want to return a Last-Modified header representing the new state in the response should set the header in the execute() method.

See RFC 7231 §7.2 and RFC 7232 §2.3 for semantics.

Stability: stable
to override
Returns
string|int|float|DateTime|null

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 102 of file RevisionSourceHandler.php.

◆ getParamSettings()

MediaWiki\Rest\Handler\RevisionSourceHandler::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 117 of file RevisionSourceHandler.php.

◆ getResponseBodySchemaFileName()

MediaWiki\Rest\Handler\RevisionSourceHandler::getResponseBodySchemaFileName ( string $method)
protected

Returns the path and name of a JSON file containing an OpenAPI Schema Object specification structure.

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

Returns null by default. Subclasses with a suitable JSON file should implement this method.

Parameters
string$methodThe HTTP method to produce a spec for ("get", "post", etc).
Stability: stable
to override
Since
1.43
Returns
?string

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 83 of file RevisionSourceHandler.php.

◆ hasRepresentation()

MediaWiki\Rest\Handler\RevisionSourceHandler::hasRepresentation ( )
protected
Returns
bool

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 124 of file RevisionSourceHandler.php.

◆ needsWriteAccess()

MediaWiki\Rest\Handler\RevisionSourceHandler::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 113 of file RevisionSourceHandler.php.

◆ postValidationSetup()

MediaWiki\Rest\Handler\RevisionSourceHandler::postValidationSetup ( )
protected

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

This gives the handler an opportunity to do initialization based on parameters before pre-execution calls like getLastModified() or getETag().

Stability: stable
to override
Since
1.36

Reimplemented from MediaWiki\Rest\Handler.

Definition at line 27 of file RevisionSourceHandler.php.

References MediaWiki\Rest\Handler\getAuthority(), and MediaWiki\Rest\Handler\getValidatedParams().

◆ run()

MediaWiki\Rest\Handler\RevisionSourceHandler::run ( )
Returns
Response
Exceptions
LocalizedHttpException

Definition at line 48 of file RevisionSourceHandler.php.

References MediaWiki\Rest\Handler\getResponseFactory().


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