/
ResponseTransformer.php
291 lines (264 loc) · 9.02 KB
/
ResponseTransformer.php
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://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. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.3.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Http;
use Cake\Network\Response as CakeResponse;
use Psr\Http\Message\ResponseInterface as PsrResponse;
use Zend\Diactoros\CallbackStream;
use Zend\Diactoros\Response as DiactorosResponse;
use Zend\Diactoros\Stream;
/**
* This class converts PSR7 responses into CakePHP ones and back again.
*
* By bridging the CakePHP and PSR7 responses together, applications
* can be embedded as PSR7 middleware in a fully compatible way.
*
* @internal
*/
class ResponseTransformer
{
/**
* Convert a PSR7 Response into a CakePHP one.
*
* @param PsrResponse $response The response to convert.
* @return CakeResponse The equivalent CakePHP response
*/
public static function toCake(PsrResponse $response)
{
$body = static::getBody($response);
$data = [
'status' => $response->getStatusCode(),
'body' => $body['body'],
];
$cake = new CakeResponse($data);
if ($body['file']) {
$cake->file($body['file']);
}
$cookies = static::parseCookies($response->getHeader('Set-Cookie'));
foreach ($cookies as $cookie) {
$cake->cookie($cookie);
}
$headers = static::collapseHeaders($response);
$cake->header($headers);
if (!empty($headers['Content-Type'])) {
$cake->type($headers['Content-Type']);
}
return $cake;
}
/**
* Get the response body from a PSR7 Response.
*
* @param PsrResponse $response The response to convert.
* @return array A hash of 'body' and 'file'
*/
protected static function getBody(PsrResponse $response)
{
$stream = $response->getBody();
if ($stream->getMetadata('wrapper_type') === 'plainfile') {
return ['body' => '', 'file' => $stream->getMetadata('uri')];
}
if ($stream->getSize() === 0) {
return ['body' => '', 'file' => false];
}
$stream->rewind();
return ['body' => $stream->getContents(), 'file' => false];
}
/**
* Parse the Set-Cookie headers in a PSR7 response
* into the format CakePHP expects.
*
* @param array $cookieHeader A list of Set-Cookie headers.
* @return array Parsed cookie data.
*/
protected static function parseCookies(array $cookieHeader)
{
$cookies = [];
foreach ($cookieHeader as $cookie) {
if (strpos($cookie, '";"') !== false) {
$cookie = str_replace('";"', "{__cookie_replace__}", $cookie);
$parts = preg_split('/\;[ \t]*/', $cookie);
$parts = str_replace("{__cookie_replace__}", '";"', $parts);
} else {
$parts = preg_split('/\;[ \t]*/', $cookie);
}
list($name, $value) = explode('=', array_shift($parts), 2);
$parsed = ['name' => $name, 'value' => urldecode($value)];
foreach ($parts as $part) {
if (strpos($part, '=') !== false) {
list($key, $value) = explode('=', $part);
} else {
$key = $part;
$value = true;
}
$key = strtolower($key);
if ($key === 'httponly') {
$key = 'httpOnly';
}
if ($key === 'expires') {
$key = 'expire';
$value = strtotime($value);
}
if (!isset($parsed[$key])) {
$parsed[$key] = $value;
}
}
$cookies[] = $parsed;
}
return $cookies;
}
/**
* Convert a PSR7 Response headers into a flat array
*
* @param PsrResponse $response The response to convert.
* @return CakeResponse The equivalent CakePHP response
*/
protected static function collapseHeaders(PsrResponse $response)
{
$out = [];
foreach ($response->getHeaders() as $name => $value) {
if (count($value) === 1) {
$out[$name] = $value[0];
} else {
$out[$name] = $value;
}
}
return $out;
}
/**
* Convert a CakePHP response into a PSR7 one.
*
* @param CakeResponse $response The CakePHP response to convert
* @return PsrResponse $response The equivalent PSR7 response.
*/
public static function toPsr(CakeResponse $response)
{
$status = $response->statusCode();
$headers = $response->header();
if (!isset($headers['Content-Type'])) {
$headers = static::setContentType($headers, $response);
}
$cookies = $response->cookie();
if ($cookies && (
session_status() === \PHP_SESSION_ACTIVE ||
PHP_SAPI === 'cli' ||
PHP_SAPI === 'phpdbg'
)) {
$sessionCookie = session_get_cookie_params();
$sessionName = session_name();
$cookies[$sessionName] = [
'name' => $sessionName,
'path' => $sessionCookie['path'],
'value' => session_id(),
'expire' => $sessionCookie['lifetime'],
'secure' => $sessionCookie['secure'],
'domain' => $sessionCookie['domain'],
'httpOnly' => $sessionCookie['httponly'],
];
}
if ($cookies) {
$headers['Set-Cookie'] = static::buildCookieHeader($cookies);
}
$stream = static::getStream($response);
return new DiactorosResponse($stream, $status, $headers);
}
/**
* Add in the Content-Type header if necessary.
*
* @param array $headers The headers to update
* @param CakeResponse $response The CakePHP response to convert
* @return The updated headers.
*/
protected static function setContentType($headers, $response)
{
if (isset($headers['Content-Type'])) {
return $headers;
}
if (in_array($response->statusCode(), [204, 304])) {
return $headers;
}
$whitelist = [
'application/javascript', 'application/json', 'application/xml', 'application/rss+xml'
];
$type = $response->type();
$charset = $response->charset();
$hasCharset = false;
if ($charset && (strpos($type, 'text/') === 0 || in_array($type, $whitelist))) {
$hasCharset = true;
}
$value = $type;
if ($hasCharset) {
$value = "{$type}; charset={$charset}";
}
$headers['Content-Type'] = $value;
return $headers;
}
/**
* Convert an array of cookies into header lines.
*
* @param array $cookies The cookies to serialize.
* @return array A list of cookie header values.
*/
protected static function buildCookieHeader($cookies)
{
$headers = [];
foreach ($cookies as $cookie) {
$parts = [
sprintf('%s=%s', urlencode($cookie['name']), urlencode($cookie['value']))
];
if ($cookie['expire']) {
$cookie['expire'] = gmdate('D, d M Y H:i:s T', $cookie['expire']);
}
$attributes = [
'expire' => 'Expires=%s',
'path' => 'Path=%s',
'domain' => 'Domain=%s',
'httpOnly' => 'HttpOnly',
'secure' => 'Secure',
];
foreach ($attributes as $key => $attr) {
if ($cookie[$key]) {
$parts[] = sprintf($attr, $cookie[$key]);
}
}
$headers[] = implode('; ', $parts);
}
return $headers;
}
/**
* Get the stream for the new response.
*
* @param \Cake\Network\Response $response The cake response to extract the body from.
* @return Psr\Http\Message\StreamInterface The stream.
*/
protected static function getStream($response)
{
$stream = 'php://memory';
$body = $response->body();
if (is_string($body) && strlen($body)) {
$stream = new Stream('php://memory', 'wb');
$stream->write($body);
return $stream;
}
if (is_callable($body)) {
$stream = new CallbackStream($body);
return $stream;
}
$file = $response->getFile();
if ($file) {
$stream = new Stream($file->path, 'rb');
return $stream;
}
return $stream;
}
}