b73cc87dd1
This reverts commit 890558f1fa.
This restores Id584208d9b67d877606a0add1d71c9b1784cdb1b with some fixes.
Bug: T323786
Bug: T352742
Change-Id: Ib31c451ddd75b06c95a544c8a3d2a64b32264126
114 lines
2.8 KiB
PHP
114 lines
2.8 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Rest\Validator;
|
|
|
|
use FormatJson;
|
|
use MediaWiki\Rest\LocalizedHttpException;
|
|
use MediaWiki\Rest\RequestInterface;
|
|
use Wikimedia\Message\ListParam;
|
|
use Wikimedia\Message\ListType;
|
|
use Wikimedia\Message\MessageValue;
|
|
use Wikimedia\ParamValidator\ParamValidator;
|
|
|
|
/**
|
|
* Do-nothing body validator
|
|
*/
|
|
class JsonBodyValidator implements BodyValidator {
|
|
|
|
/**
|
|
* @var array[]
|
|
*/
|
|
private $bodyParamSettings;
|
|
|
|
/**
|
|
* @param array[] $bodyParamSettings
|
|
*/
|
|
public function __construct( array $bodyParamSettings ) {
|
|
$this->bodyParamSettings = $bodyParamSettings;
|
|
}
|
|
|
|
public function validateBody( RequestInterface $request ) {
|
|
$jsonStream = $request->getBody();
|
|
$status = FormatJson::parse( "$jsonStream", FormatJson::FORCE_ASSOC );
|
|
|
|
if ( !$status->isOK() ) {
|
|
throw new LocalizedHttpException(
|
|
new MessageValue( 'rest-json-body-parse-error', [ "$status" ] ),
|
|
400
|
|
);
|
|
}
|
|
|
|
$data = $status->value;
|
|
|
|
if ( !is_array( $data ) ) {
|
|
throw new LocalizedHttpException( new MessageValue( 'rest-bad-json-body' ), 400 );
|
|
}
|
|
|
|
$uncheckedBodyKeys = array_fill_keys( array_keys( $data ), true );
|
|
foreach ( $this->bodyParamSettings as $name => $settings ) {
|
|
if ( !empty( $settings[ParamValidator::PARAM_REQUIRED] ) && !isset( $data[$name] ) ) {
|
|
throw new LocalizedHttpException(
|
|
new MessageValue( 'rest-missing-body-field', [ $name ] ), 400
|
|
);
|
|
}
|
|
|
|
if ( !isset( $data[$name] ) ) {
|
|
$data[$name] = $settings[ParamValidator::PARAM_DEFAULT] ?? null;
|
|
}
|
|
|
|
unset( $uncheckedBodyKeys[$name] );
|
|
// TODO: use a ParamValidator to check field value, etc!
|
|
}
|
|
if ( $uncheckedBodyKeys ) {
|
|
throw new LocalizedHttpException(
|
|
new MessageValue(
|
|
'rest-extraneous-body-fields',
|
|
[ new ListParam( ListType::COMMA, array_keys( $uncheckedBodyKeys ) ) ]
|
|
),
|
|
400
|
|
);
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Returns an OpenAPI Schema Object specification structure as an associative array.
|
|
* @see https://swagger.io/specification/#schema-object
|
|
*
|
|
*
|
|
* This will contain information about the supported parameters.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getOpenAPISpec(): array {
|
|
$body = [];
|
|
$required = [];
|
|
|
|
// XXX: Maybe we want to be able to define a spec file in the route definition?
|
|
// NOTE: the route definition may not be loaded when this is called before init()!
|
|
|
|
foreach ( $this->bodyParamSettings as $name => $paramSetting ) {
|
|
$param = Validator::getParameterSpec(
|
|
$name,
|
|
$paramSetting
|
|
);
|
|
|
|
$body['properties'][$name] = $param['schema'];
|
|
|
|
if ( isset( $param['description'] ) ) {
|
|
$body['properties'][$name]['description'] = $param['description'];
|
|
}
|
|
|
|
if ( $param['required'] ?? false ) {
|
|
$required[] = $param['name'];
|
|
}
|
|
}
|
|
|
|
if ( $required ) {
|
|
$body['required'] = $required;
|
|
}
|
|
|
|
return $body;
|
|
}
|
|
}
|