JsonBodyValidator.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Rest\Validator;
 
use MediaWiki\Json\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;
 
class JsonBodyValidator implements BodyValidator {
 
    private $bodyParamSettings;
 
    public function __construct( array $bodyParamSettings ) {
        wfDeprecatedMsg(
            __CLASS__ . ' is deprecated.',
            '1.43'
        );
        $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;
    }
 
    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;
    }
}