41daf4d0d5
Note that "post" parameters remain accessible through getValidatedParams(), while "body" parameters have to be accessed though getValidatedBody(). This adds a number of tests that ensure that this remains to be the case, while deprecation warnings are triggered when appropriate. Code search to check that this is unused in prod: https://codesearch.wmcloud.org/things/?q=SOURCE+*%3D%3E+*%27post%27&files=&excludeFiles=&repos= Previous reverted incarnation of this: Ia0eedb383e69b Bug: T362850 Bug: T358560 Depends-On: Id94335b3ec8f0549ff7350d31cb7cfee8feaa012 Change-Id: I88accc52c5faab70b453709b02ed88a8af4bc181
93 lines
2.4 KiB
PHP
93 lines
2.4 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Tests\Rest\Handler;
|
|
|
|
use LogicException;
|
|
use MediaWiki\Rest\Handler;
|
|
use MediaWiki\Rest\RequestInterface;
|
|
use Wikimedia\ParamValidator\ParamValidator;
|
|
|
|
/**
|
|
* Test mock for asserting parameter processing and validation in Handler and Router.
|
|
*/
|
|
class EchoHandler extends Handler {
|
|
private $postValidationSetupCalled = false;
|
|
|
|
public function execute() {
|
|
if ( !$this->postValidationSetupCalled ) {
|
|
throw new LogicException( 'postValidationSetup was not called' );
|
|
}
|
|
|
|
$request = $this->getRequest();
|
|
return [
|
|
'method' => $request->getMethod(),
|
|
'uri' => $request->getUri(),
|
|
'protocolVersion' => $request->getProtocolVersion(),
|
|
'body' => $request->getBody()->getContents(),
|
|
'serverParams' => $request->getServerParams(),
|
|
'cookieParams' => $request->getCookieParams(),
|
|
'queryParams' => $request->getQueryParams(),
|
|
'postParams' => $request->getPostParams(),
|
|
'pathParams' => $request->getPathParams(),
|
|
'headers' => $request->getHeaders(),
|
|
'parsedBody' => $request->getParsedBody(),
|
|
'validatedBody' => $this->getValidatedBody(),
|
|
'validatedParams' => $this->getValidatedParams(),
|
|
];
|
|
}
|
|
|
|
public function getBodyParamSettings(): array {
|
|
if ( $this->getConfig()['postParam'] ?? false ) {
|
|
// Don't mix "post" and "body" params, it confuses
|
|
// Validator::detectExtraneousBodyFields()
|
|
return [];
|
|
}
|
|
|
|
return [
|
|
'bodyParam' => [
|
|
self::PARAM_SOURCE => 'body',
|
|
ParamValidator::PARAM_TYPE => 'string',
|
|
ParamValidator::PARAM_REQUIRED => false
|
|
],
|
|
];
|
|
}
|
|
|
|
public function getParamSettings() {
|
|
$paramSettings = [
|
|
'q' => [
|
|
self::PARAM_SOURCE => 'query',
|
|
ParamValidator::PARAM_TYPE => 'string',
|
|
],
|
|
'pathParam' => [
|
|
self::PARAM_SOURCE => 'path',
|
|
ParamValidator::PARAM_TYPE => 'string',
|
|
],
|
|
];
|
|
|
|
if ( $this->getConfig()['postParam'] ?? false ) {
|
|
// Deprecated, will trigger a warning!
|
|
$paramSettings['postParam'] = [
|
|
self::PARAM_SOURCE => 'post',
|
|
ParamValidator::PARAM_TYPE => 'string',
|
|
];
|
|
}
|
|
|
|
return $paramSettings;
|
|
}
|
|
|
|
protected function postValidationSetup() {
|
|
$this->postValidationSetupCalled = true;
|
|
}
|
|
|
|
public function getSupportedRequestTypes(): array {
|
|
return [
|
|
RequestInterface::JSON_CONTENT_TYPE,
|
|
RequestInterface::FORM_URLENCODED_CONTENT_TYPE,
|
|
RequestInterface::MULTIPART_FORM_DATA_CONTENT_TYPE,
|
|
];
|
|
}
|
|
|
|
public function needsWriteAccess() {
|
|
return false;
|
|
}
|
|
}
|