1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
|
<?php
namespace MediaWiki\Rest\Handler;
use MediaWiki\Request\WebResponse;
use MediaWiki\Rest\LocalizedHttpException;
use MediaWiki\Rest\Response;
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() {
$body = $this->getValidatedBody();
'@phan-var array $body';
return $body['title'];
}
/**
* @inheritDoc
* @return array
*/
public function getBodyParamSettings(): array {
return [
'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();
'@phan-var array $body';
$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 );
}
}
|