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
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2023 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Http\Middleware;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;
use RuntimeException;
use function connection_status;
use function fastcgi_finish_request;
use function function_exists;
use function header;
use function header_remove;
use function headers_sent;
use function http_response_code;
use function ob_get_length;
use function ob_get_level;
use function sprintf;
use const CONNECTION_NORMAL;
/**
* Middleware to emit the response - send it back to the webserver.
*/
class EmitResponse implements MiddlewareInterface
{
// Stream the output in chunks.
private const CHUNK_SIZE = 65536;
/**
* @param ServerRequestInterface $request
* @param RequestHandlerInterface $handler
*
* @return ResponseInterface
*/
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
$response = $handler->handle($request);
$this->assertHeadersNotEmitted();
$this->removeDefaultPhpHeaders();
// Unless webtrees set a cache-control header, assume the page cannot be cached
if (!$response->hasHeader('cache-control')) {
$response = $response->withHeader('cache-control', 'no-store');
}
$this->assertBodyNotEmitted();
$this->emitStatusLine($response);
$this->emitHeaders($response);
$this->emitBody($response);
$this->closeConnection();
return $response;
}
/**
* Remove the default PHP header.
*
* @return void
*/
private function removeDefaultPhpHeaders(): void
{
header_remove('X-Powered-By');
header_remove('cache-control');
header_remove('Expires');
header_remove('Pragma');
}
/**
* @return void
* @throws RuntimeException
*/
private function assertHeadersNotEmitted(): void
{
if (headers_sent($file, $line)) {
$message = sprintf('Headers already sent at %s:%d', $file, $line);
throw new RuntimeException($message);
}
}
/**
* @return void
* @throws RuntimeException
*/
private function assertBodyNotEmitted(): void
{
if (ob_get_level() > 0 && ob_get_length() > 0) {
// The output probably contains an error message.
$output = ob_get_clean();
throw new RuntimeException('Output already started: ' . $output);
}
}
/**
* @param ResponseInterface $response
*/
private function emitStatusLine(ResponseInterface $response): void
{
http_response_code($response->getStatusCode());
header(sprintf(
'HTTP/%s %d %s',
$response->getProtocolVersion(),
$response->getStatusCode(),
$response->getReasonPhrase()
));
}
/**
* @param ResponseInterface $response
*/
private function emitHeaders(ResponseInterface $response): void
{
foreach ($response->getHeaders() as $name => $values) {
foreach ($values as $value) {
header(
sprintf('%s: %s', $name, $value),
false,
$response->getStatusCode()
);
}
}
}
/**
* @param ResponseInterface $response
*
* @return void
*/
private function emitBody(ResponseInterface $response): void
{
$body = $response->getBody();
if ($body->isSeekable()) {
$body->rewind();
}
while (!$body->eof() && connection_status() === CONNECTION_NORMAL) {
echo $body->read(self::CHUNK_SIZE);
}
}
/**
* @return void
*/
private function closeConnection(): void
{
if (function_exists('fastcgi_finish_request')) {
fastcgi_finish_request();
}
}
}
|
