wiki.techinc.nl/includes/Rest/Handler/CreationHandler.php
Daniel Kinzler b73cc87dd1 Re-apply "REST: Emit swagger spec"
This reverts commit 890558f1fa.
This restores Id584208d9b67d877606a0add1d71c9b1784cdb1b with some fixes.

Bug: T323786
Bug: T352742
Change-Id: Ib31c451ddd75b06c95a544c8a3d2a64b32264126
2023-12-06 11:20:11 +01:00

117 lines
3.1 KiB
PHP

<?php
namespace MediaWiki\Rest\Handler;
use MediaWiki\Request\WebResponse;
use MediaWiki\Rest\HttpException;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\Response;
use MediaWiki\Rest\Validator\JsonBodyValidator;
use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\ParamValidator;
/**
* Core REST API endpoint that handles page creation (main slot only)
*/
class CreationHandler extends EditHandler {
/**
* @inheritDoc
*/
protected function getTitleParameter() {
return $this->getValidatedBody()['title'];
}
/**
* @inheritDoc
*/
public function getBodyValidator( $contentType ) {
if ( $contentType !== 'application/json' ) {
throw new HttpException( "Unsupported Content-Type",
415,
[ 'content_type' => $contentType ]
);
}
return new JsonBodyValidator( [
'source' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
self::PARAM_DESCRIPTION => 'The intended content of the page',
],
'title' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
self::PARAM_DESCRIPTION => 'The title of the page to create',
],
'comment' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
self::PARAM_DESCRIPTION => 'A comment descripting the reason for creating the page',
],
'content_model' => [
self::PARAM_SOURCE => 'body',
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => false,
self::PARAM_DESCRIPTION => 'The content model to use to interpret the source',
],
] + $this->getTokenParamDefinition() );
}
/**
* @inheritDoc
*/
protected function getActionModuleParameters() {
$body = $this->getValidatedBody();
$title = $this->getTitleParameter();
$contentmodel = $body['content_model'] ?: null;
if ( $contentmodel !== null && !$this->contentHandlerFactory->isDefinedModel( $contentmodel ) ) {
throw new LocalizedHttpException(
new MessageValue( 'rest-bad-content-model', [ $body['content_model'] ] ), 400
);
}
// Use a known good CSRF token if a token is not needed because we are
// using a method of authentication that protects against CSRF, like OAuth.
$token = $this->needsToken() ? $this->getToken() : $this->getUser()->getEditToken();
$params = [
'action' => 'edit',
'title' => $title,
'text' => $body['source'],
'summary' => $body['comment'],
'token' => $token,
'createonly' => true,
];
if ( $contentmodel !== null ) {
$params['contentmodel'] = $contentmodel;
}
return $params;
}
protected function mapActionModuleResponse(
WebResponse $actionModuleResponse,
array $actionModuleResult,
Response $response
) {
parent::mapActionModuleResponse(
$actionModuleResponse,
$actionModuleResult,
$response
);
$title = $this->urlEncodeTitle( $actionModuleResult['edit']['title'] );
$url = $this->getRouter()->getRouteUrl( '/v1/page/' . $title );
$response->setHeader( 'Location', $url );
}
}