Repository navigation
Expand file tree
/
Copy pathServerRequestFactory.php
More file actions
210 lines (189 loc) · 8 KB
/
Copy pathServerRequestFactory.php
File metadata and controls
210 lines (189 loc) · 8 KB
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.3.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Http;
use Cake\Core\Configure;
use Cake\Http\Exception\BadRequestException;
use Cake\Utility\Hash;
use Psr\Http\Message\ServerRequestFactoryInterface;
use Psr\Http\Message\ServerRequestInterface;
use function Laminas\Diactoros\normalizeServer;
use function Laminas\Diactoros\normalizeUploadedFiles;
/**
* Factory for making ServerRequest instances.
*
* This adds in CakePHP specific behavior to populate the basePath and webroot
* attributes. Furthermore the Uri's path is corrected to only contain the
* 'virtual' path for the request.
*/
class ServerRequestFactory implements ServerRequestFactoryInterface
{
/**
* Create a request from the supplied superglobal values.
*
* If any argument is not supplied, the corresponding superglobal value will
* be used.
*
* @param array|null $server $_SERVER superglobal
* @param array|null $query $_GET superglobal
* @param array|null $parsedBody $_POST superglobal
* @param array|null $cookies $_COOKIE superglobal
* @param array|null $files $_FILES superglobal
* @return \Cake\Http\ServerRequest
* @throws \InvalidArgumentException for invalid file values
*/
public static function fromGlobals(
?array $server = null,
?array $query = null,
?array $parsedBody = null,
?array $cookies = null,
?array $files = null,
): ServerRequest {
$server = normalizeServer($server ?? $_SERVER);
['uri' => $uri, 'base' => $base, 'webroot' => $webroot] = UriFactory::marshalUriAndBaseFromSapi($server);
$sessionConfig = (array)Configure::read('Session') + [
'defaults' => 'php',
'cookiePath' => $webroot,
];
$session = Session::create($sessionConfig);
$request = new ServerRequest([
'environment' => $server,
'uri' => $uri,
'cookies' => $cookies ?? $_COOKIE,
'query' => $query ?? $_GET,
'webroot' => $webroot,
'base' => $base,
'session' => $session,
'input' => $server['CAKEPHP_INPUT'] ?? null,
]);
$request = static::marshalBodyAndRequestMethod($parsedBody ?? $_POST, $request);
// This is required as `ServerRequest::scheme()` ignores the value of
// `HTTP_X_FORWARDED_PROTO` unless `trustProxy` is enabled, while the
// `Uri` instance initially created always takes values of `HTTP_X_FORWARDED_PROTO`
// into account.
$uri = $request->getUri()->withScheme($request->scheme());
$request = $request->withUri($uri, true);
return static::marshalFiles($files ?? $_FILES, $request);
}
/**
* Sets the REQUEST_METHOD environment variable based on the simulated _method
* HTTP override value. The 'ORIGINAL_REQUEST_METHOD' is also preserved, if you
* want the read the non-simulated HTTP method the client used.
*
* Override values are upper-cased and may only contain the letters A-Z, optionally
* separated by single hyphens or underscores (e.g. `VERSION-CONTROL`).
*
* Request body of content type "application/x-www-form-urlencoded" is parsed
* into array for PUT/PATCH/DELETE requests.
*
* @param array $parsedBody Parsed body.
* @param \Cake\Http\ServerRequest $request Request instance.
* @return \Cake\Http\ServerRequest
*/
protected static function marshalBodyAndRequestMethod(array $parsedBody, ServerRequest $request): ServerRequest
{
$method = $request->getMethod();
$override = false;
if (
in_array($method, ['PUT', 'DELETE', 'PATCH'], true) &&
str_starts_with((string)$request->contentType(), 'application/x-www-form-urlencoded')
) {
$data = (string)$request->getBody();
parse_str($data, $parsedBody);
}
if ($request->hasHeader('X-Http-Method-Override')) {
$parsedBody['_method'] = $request->getHeaderLine('X-Http-Method-Override');
$override = true;
}
$request = $request->withEnv('ORIGINAL_REQUEST_METHOD', $method);
if (isset($parsedBody['_method'])) {
$request = $request->withEnv('REQUEST_METHOD', static::normalizeOverrideMethod($parsedBody['_method']));
unset($parsedBody['_method']);
$override = true;
}
if (
$override &&
!in_array($request->getMethod(), ['PUT', 'POST', 'DELETE', 'PATCH'], true)
) {
$parsedBody = [];
}
return $request->withParsedBody($parsedBody);
}
/**
* Normalize and validate a method override value.
*
* Only letters, optionally separated by single hyphens or underscores, are accepted to prevent
* arbitrary client supplied strings from ending up in `REQUEST_METHOD`, while
* still allowing custom methods like the WebDAV `VERSION-CONTROL`.
*
* @param mixed $method The method from the `_method` field or `X-Http-Method-Override` header.
* @return string
* @throws \Cake\Http\Exception\BadRequestException When the method is not a valid override value.
*/
protected static function normalizeOverrideMethod(mixed $method): string
{
if (is_string($method)) {
$method = strtoupper($method);
if (preg_match('/^[A-Z]+(?:[-_][A-Z]+)*$/D', $method)) {
return $method;
}
}
throw new BadRequestException('Invalid HTTP method override.');
}
/**
* Process uploaded files and move things onto the parsed body.
*
* @param array $files Files array for normalization and merging in parsed body.
* @param \Cake\Http\ServerRequest $request Request instance.
* @return \Cake\Http\ServerRequest
*/
protected static function marshalFiles(array $files, ServerRequest $request): ServerRequest
{
$files = normalizeUploadedFiles($files);
$request = $request->withUploadedFiles($files);
$parsedBody = $request->getParsedBody();
if (!is_array($parsedBody)) {
return $request;
}
$parsedBody = Hash::merge($parsedBody, $files);
return $request->withParsedBody($parsedBody);
}
/**
* Create a new server request.
*
* Note that server-params are taken precisely as given - no parsing/processing
* of the given values is performed, and, in particular, no attempt is made to
* determine the HTTP method or URI, which must be provided explicitly.
*
* @param string $method The HTTP method associated with the request.
* @param \Psr\Http\Message\UriInterface|string $uri The URI associated with the request. If
* the value is a string, the factory MUST create a UriInterface
* instance based on it.
* @param array $serverParams Array of SAPI parameters with which to seed
* the generated request instance.
* @return \Psr\Http\Message\ServerRequestInterface
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
*/
public function createServerRequest(string $method, $uri, array $serverParams = []): ServerRequestInterface
{
$serverParams['REQUEST_METHOD'] = $method;
$options = ['environment' => $serverParams];
if (is_string($uri)) {
$uri = (new UriFactory())->createUri($uri);
}
$options['uri'] = $uri;
return new ServerRequest($options);
}
}