f5a7e973c7
A previous change made it possible to include response schemas in generated OpenAPI specs. However, it did not provide the http method to the code that generates/includes these schemas. Because some handlers support multiple http methods, this is necessary. So add it. Bug: T375530 Change-Id: Ie681d576cdffc387d78a1686e058903761b749ac (cherry picked from commit 576b29092d5fd6a8480e02ddc2141b69cf698936)
122 lines
3.4 KiB
PHP
122 lines
3.4 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Rest\Handler;
|
|
|
|
use LogicException;
|
|
use MediaWiki\Rest\Handler\Helper\PageRestHelperFactory;
|
|
use MediaWiki\Rest\Handler\Helper\RevisionContentHelper;
|
|
use MediaWiki\Rest\LocalizedHttpException;
|
|
use MediaWiki\Rest\Response;
|
|
use MediaWiki\Rest\SimpleHandler;
|
|
use MediaWiki\Revision\RevisionRecord;
|
|
|
|
/**
|
|
* A handler that returns page source and metadata for the following routes:
|
|
* - /revision/{revision}
|
|
* - /revision/{revision}/bare
|
|
*/
|
|
class RevisionSourceHandler extends SimpleHandler {
|
|
|
|
private RevisionContentHelper $contentHelper;
|
|
|
|
public function __construct( PageRestHelperFactory $helperFactory ) {
|
|
$this->contentHelper = $helperFactory->newRevisionContentHelper();
|
|
}
|
|
|
|
protected function postValidationSetup() {
|
|
$this->contentHelper->init( $this->getAuthority(), $this->getValidatedParams() );
|
|
}
|
|
|
|
/**
|
|
* @param RevisionRecord $rev
|
|
* @return string
|
|
*/
|
|
private function constructHtmlUrl( RevisionRecord $rev ): string {
|
|
// TODO: once legacy "v1" routes are removed, just use the path prefix from the module.
|
|
$pathPrefix = $this->getModule()->getPathPrefix();
|
|
if ( strlen( $pathPrefix ) == 0 ) {
|
|
$pathPrefix = 'v1';
|
|
}
|
|
|
|
return $this->getRouter()->getRouteUrl(
|
|
'/' . $pathPrefix . '/revision/{id}/html',
|
|
[ 'id' => $rev->getId() ]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @return Response
|
|
* @throws LocalizedHttpException
|
|
*/
|
|
public function run() {
|
|
$this->contentHelper->checkAccess();
|
|
|
|
$outputMode = $this->getOutputMode();
|
|
switch ( $outputMode ) {
|
|
case 'restbase': // compatibility for restbase migration
|
|
$body = [ 'items' => [ $this->contentHelper->constructRestbaseCompatibleMetadata() ] ];
|
|
break;
|
|
case 'bare':
|
|
$revisionRecord = $this->contentHelper->getTargetRevision();
|
|
$body = $this->contentHelper->constructMetadata();
|
|
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable revisionRecord is set when used
|
|
$body['html_url'] = $this->constructHtmlUrl( $revisionRecord );
|
|
$response = $this->getResponseFactory()->createJson( $body );
|
|
$this->contentHelper->setCacheControl( $response );
|
|
break;
|
|
case 'source':
|
|
$content = $this->contentHelper->getContent();
|
|
$body = $this->contentHelper->constructMetadata();
|
|
$body['source'] = $content->getText();
|
|
break;
|
|
default:
|
|
throw new LogicException( "Unknown output mode $outputMode" );
|
|
}
|
|
|
|
$response = $this->getResponseFactory()->createJson( $body );
|
|
$this->contentHelper->setCacheControl( $response );
|
|
|
|
return $response;
|
|
}
|
|
|
|
protected function getResponseBodySchemaFileName( string $method ): ?string {
|
|
// TODO: add fields based on the output mode to the schema
|
|
return 'includes/Rest/Handler/Schema/RevisionMetaData.json';
|
|
}
|
|
|
|
/**
|
|
* @return string|null
|
|
*/
|
|
protected function getETag(): ?string {
|
|
return $this->contentHelper->getETag();
|
|
}
|
|
|
|
/**
|
|
* @return string|null
|
|
*/
|
|
protected function getLastModified(): ?string {
|
|
return $this->contentHelper->getLastModified();
|
|
}
|
|
|
|
private function getOutputMode(): string {
|
|
if ( $this->getRouter()->isRestbaseCompatEnabled( $this->getRequest() ) ) {
|
|
return 'restbase';
|
|
}
|
|
return $this->getConfig()['format'];
|
|
}
|
|
|
|
public function needsWriteAccess(): bool {
|
|
return false;
|
|
}
|
|
|
|
public function getParamSettings(): array {
|
|
return $this->contentHelper->getParamSettings();
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
protected function hasRepresentation() {
|
|
return $this->contentHelper->hasContent();
|
|
}
|
|
}
|