Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@12
|
3 * @see https://github.com/zendframework/zend-diactoros for the canonical source repository
|
Chris@12
|
4 * @copyright Copyright (c) 2015-2017 Zend Technologies USA Inc. (http://www.zend.com)
|
Chris@0
|
5 * @license https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
|
Chris@0
|
6 */
|
Chris@0
|
7
|
Chris@0
|
8 namespace Zend\Diactoros;
|
Chris@0
|
9
|
Chris@0
|
10 use InvalidArgumentException;
|
Chris@16
|
11 use Psr\Http\Message\StreamInterface;
|
Chris@0
|
12 use RuntimeException;
|
Chris@16
|
13
|
Chris@16
|
14 use function array_key_exists;
|
Chris@16
|
15 use function fclose;
|
Chris@16
|
16 use function feof;
|
Chris@16
|
17 use function fopen;
|
Chris@16
|
18 use function fread;
|
Chris@16
|
19 use function fseek;
|
Chris@16
|
20 use function fstat;
|
Chris@16
|
21 use function ftell;
|
Chris@16
|
22 use function fwrite;
|
Chris@16
|
23 use function get_resource_type;
|
Chris@16
|
24 use function is_int;
|
Chris@16
|
25 use function is_resource;
|
Chris@16
|
26 use function is_string;
|
Chris@16
|
27 use function restore_error_handler;
|
Chris@16
|
28 use function set_error_handler;
|
Chris@16
|
29 use function stream_get_contents;
|
Chris@16
|
30 use function stream_get_meta_data;
|
Chris@16
|
31 use function strstr;
|
Chris@16
|
32
|
Chris@16
|
33 use const E_WARNING;
|
Chris@16
|
34 use const SEEK_SET;
|
Chris@0
|
35
|
Chris@0
|
36 /**
|
Chris@0
|
37 * Implementation of PSR HTTP streams
|
Chris@0
|
38 */
|
Chris@0
|
39 class Stream implements StreamInterface
|
Chris@0
|
40 {
|
Chris@0
|
41 /**
|
Chris@0
|
42 * @var resource|null
|
Chris@0
|
43 */
|
Chris@0
|
44 protected $resource;
|
Chris@0
|
45
|
Chris@0
|
46 /**
|
Chris@0
|
47 * @var string|resource
|
Chris@0
|
48 */
|
Chris@0
|
49 protected $stream;
|
Chris@0
|
50
|
Chris@0
|
51 /**
|
Chris@0
|
52 * @param string|resource $stream
|
Chris@0
|
53 * @param string $mode Mode with which to open stream
|
Chris@0
|
54 * @throws InvalidArgumentException
|
Chris@0
|
55 */
|
Chris@0
|
56 public function __construct($stream, $mode = 'r')
|
Chris@0
|
57 {
|
Chris@0
|
58 $this->setStream($stream, $mode);
|
Chris@0
|
59 }
|
Chris@0
|
60
|
Chris@0
|
61 /**
|
Chris@0
|
62 * {@inheritdoc}
|
Chris@0
|
63 */
|
Chris@0
|
64 public function __toString()
|
Chris@0
|
65 {
|
Chris@0
|
66 if (! $this->isReadable()) {
|
Chris@0
|
67 return '';
|
Chris@0
|
68 }
|
Chris@0
|
69
|
Chris@0
|
70 try {
|
Chris@0
|
71 if ($this->isSeekable()) {
|
Chris@0
|
72 $this->rewind();
|
Chris@0
|
73 }
|
Chris@0
|
74
|
Chris@0
|
75 return $this->getContents();
|
Chris@0
|
76 } catch (RuntimeException $e) {
|
Chris@0
|
77 return '';
|
Chris@0
|
78 }
|
Chris@0
|
79 }
|
Chris@0
|
80
|
Chris@0
|
81 /**
|
Chris@0
|
82 * {@inheritdoc}
|
Chris@0
|
83 */
|
Chris@0
|
84 public function close()
|
Chris@0
|
85 {
|
Chris@0
|
86 if (! $this->resource) {
|
Chris@0
|
87 return;
|
Chris@0
|
88 }
|
Chris@0
|
89
|
Chris@0
|
90 $resource = $this->detach();
|
Chris@0
|
91 fclose($resource);
|
Chris@0
|
92 }
|
Chris@0
|
93
|
Chris@0
|
94 /**
|
Chris@0
|
95 * {@inheritdoc}
|
Chris@0
|
96 */
|
Chris@0
|
97 public function detach()
|
Chris@0
|
98 {
|
Chris@0
|
99 $resource = $this->resource;
|
Chris@0
|
100 $this->resource = null;
|
Chris@0
|
101 return $resource;
|
Chris@0
|
102 }
|
Chris@0
|
103
|
Chris@0
|
104 /**
|
Chris@0
|
105 * Attach a new stream/resource to the instance.
|
Chris@0
|
106 *
|
Chris@0
|
107 * @param string|resource $resource
|
Chris@0
|
108 * @param string $mode
|
Chris@0
|
109 * @throws InvalidArgumentException for stream identifier that cannot be
|
Chris@0
|
110 * cast to a resource
|
Chris@0
|
111 * @throws InvalidArgumentException for non-resource stream
|
Chris@0
|
112 */
|
Chris@0
|
113 public function attach($resource, $mode = 'r')
|
Chris@0
|
114 {
|
Chris@0
|
115 $this->setStream($resource, $mode);
|
Chris@0
|
116 }
|
Chris@0
|
117
|
Chris@0
|
118 /**
|
Chris@0
|
119 * {@inheritdoc}
|
Chris@0
|
120 */
|
Chris@0
|
121 public function getSize()
|
Chris@0
|
122 {
|
Chris@0
|
123 if (null === $this->resource) {
|
Chris@0
|
124 return null;
|
Chris@0
|
125 }
|
Chris@0
|
126
|
Chris@0
|
127 $stats = fstat($this->resource);
|
Chris@13
|
128 if ($stats !== false) {
|
Chris@13
|
129 return $stats['size'];
|
Chris@13
|
130 }
|
Chris@13
|
131
|
Chris@13
|
132 return null;
|
Chris@0
|
133 }
|
Chris@0
|
134
|
Chris@0
|
135 /**
|
Chris@0
|
136 * {@inheritdoc}
|
Chris@0
|
137 */
|
Chris@0
|
138 public function tell()
|
Chris@0
|
139 {
|
Chris@0
|
140 if (! $this->resource) {
|
Chris@0
|
141 throw new RuntimeException('No resource available; cannot tell position');
|
Chris@0
|
142 }
|
Chris@0
|
143
|
Chris@0
|
144 $result = ftell($this->resource);
|
Chris@0
|
145 if (! is_int($result)) {
|
Chris@0
|
146 throw new RuntimeException('Error occurred during tell operation');
|
Chris@0
|
147 }
|
Chris@0
|
148
|
Chris@0
|
149 return $result;
|
Chris@0
|
150 }
|
Chris@0
|
151
|
Chris@0
|
152 /**
|
Chris@0
|
153 * {@inheritdoc}
|
Chris@0
|
154 */
|
Chris@0
|
155 public function eof()
|
Chris@0
|
156 {
|
Chris@0
|
157 if (! $this->resource) {
|
Chris@0
|
158 return true;
|
Chris@0
|
159 }
|
Chris@0
|
160
|
Chris@0
|
161 return feof($this->resource);
|
Chris@0
|
162 }
|
Chris@0
|
163
|
Chris@0
|
164 /**
|
Chris@0
|
165 * {@inheritdoc}
|
Chris@0
|
166 */
|
Chris@0
|
167 public function isSeekable()
|
Chris@0
|
168 {
|
Chris@0
|
169 if (! $this->resource) {
|
Chris@0
|
170 return false;
|
Chris@0
|
171 }
|
Chris@0
|
172
|
Chris@0
|
173 $meta = stream_get_meta_data($this->resource);
|
Chris@0
|
174 return $meta['seekable'];
|
Chris@0
|
175 }
|
Chris@0
|
176
|
Chris@0
|
177 /**
|
Chris@0
|
178 * {@inheritdoc}
|
Chris@0
|
179 */
|
Chris@0
|
180 public function seek($offset, $whence = SEEK_SET)
|
Chris@0
|
181 {
|
Chris@0
|
182 if (! $this->resource) {
|
Chris@0
|
183 throw new RuntimeException('No resource available; cannot seek position');
|
Chris@0
|
184 }
|
Chris@0
|
185
|
Chris@0
|
186 if (! $this->isSeekable()) {
|
Chris@0
|
187 throw new RuntimeException('Stream is not seekable');
|
Chris@0
|
188 }
|
Chris@0
|
189
|
Chris@0
|
190 $result = fseek($this->resource, $offset, $whence);
|
Chris@0
|
191
|
Chris@0
|
192 if (0 !== $result) {
|
Chris@0
|
193 throw new RuntimeException('Error seeking within stream');
|
Chris@0
|
194 }
|
Chris@0
|
195
|
Chris@0
|
196 return true;
|
Chris@0
|
197 }
|
Chris@0
|
198
|
Chris@0
|
199 /**
|
Chris@0
|
200 * {@inheritdoc}
|
Chris@0
|
201 */
|
Chris@0
|
202 public function rewind()
|
Chris@0
|
203 {
|
Chris@0
|
204 return $this->seek(0);
|
Chris@0
|
205 }
|
Chris@0
|
206
|
Chris@0
|
207 /**
|
Chris@0
|
208 * {@inheritdoc}
|
Chris@0
|
209 */
|
Chris@0
|
210 public function isWritable()
|
Chris@0
|
211 {
|
Chris@0
|
212 if (! $this->resource) {
|
Chris@0
|
213 return false;
|
Chris@0
|
214 }
|
Chris@0
|
215
|
Chris@0
|
216 $meta = stream_get_meta_data($this->resource);
|
Chris@0
|
217 $mode = $meta['mode'];
|
Chris@0
|
218
|
Chris@0
|
219 return (
|
Chris@0
|
220 strstr($mode, 'x')
|
Chris@0
|
221 || strstr($mode, 'w')
|
Chris@0
|
222 || strstr($mode, 'c')
|
Chris@0
|
223 || strstr($mode, 'a')
|
Chris@0
|
224 || strstr($mode, '+')
|
Chris@0
|
225 );
|
Chris@0
|
226 }
|
Chris@0
|
227
|
Chris@0
|
228 /**
|
Chris@0
|
229 * {@inheritdoc}
|
Chris@0
|
230 */
|
Chris@0
|
231 public function write($string)
|
Chris@0
|
232 {
|
Chris@0
|
233 if (! $this->resource) {
|
Chris@0
|
234 throw new RuntimeException('No resource available; cannot write');
|
Chris@0
|
235 }
|
Chris@0
|
236
|
Chris@0
|
237 if (! $this->isWritable()) {
|
Chris@0
|
238 throw new RuntimeException('Stream is not writable');
|
Chris@0
|
239 }
|
Chris@0
|
240
|
Chris@0
|
241 $result = fwrite($this->resource, $string);
|
Chris@0
|
242
|
Chris@0
|
243 if (false === $result) {
|
Chris@0
|
244 throw new RuntimeException('Error writing to stream');
|
Chris@0
|
245 }
|
Chris@0
|
246 return $result;
|
Chris@0
|
247 }
|
Chris@0
|
248
|
Chris@0
|
249 /**
|
Chris@0
|
250 * {@inheritdoc}
|
Chris@0
|
251 */
|
Chris@0
|
252 public function isReadable()
|
Chris@0
|
253 {
|
Chris@0
|
254 if (! $this->resource) {
|
Chris@0
|
255 return false;
|
Chris@0
|
256 }
|
Chris@0
|
257
|
Chris@0
|
258 $meta = stream_get_meta_data($this->resource);
|
Chris@0
|
259 $mode = $meta['mode'];
|
Chris@0
|
260
|
Chris@0
|
261 return (strstr($mode, 'r') || strstr($mode, '+'));
|
Chris@0
|
262 }
|
Chris@0
|
263
|
Chris@0
|
264 /**
|
Chris@0
|
265 * {@inheritdoc}
|
Chris@0
|
266 */
|
Chris@0
|
267 public function read($length)
|
Chris@0
|
268 {
|
Chris@0
|
269 if (! $this->resource) {
|
Chris@0
|
270 throw new RuntimeException('No resource available; cannot read');
|
Chris@0
|
271 }
|
Chris@0
|
272
|
Chris@0
|
273 if (! $this->isReadable()) {
|
Chris@0
|
274 throw new RuntimeException('Stream is not readable');
|
Chris@0
|
275 }
|
Chris@0
|
276
|
Chris@0
|
277 $result = fread($this->resource, $length);
|
Chris@0
|
278
|
Chris@0
|
279 if (false === $result) {
|
Chris@0
|
280 throw new RuntimeException('Error reading stream');
|
Chris@0
|
281 }
|
Chris@0
|
282
|
Chris@0
|
283 return $result;
|
Chris@0
|
284 }
|
Chris@0
|
285
|
Chris@0
|
286 /**
|
Chris@0
|
287 * {@inheritdoc}
|
Chris@0
|
288 */
|
Chris@0
|
289 public function getContents()
|
Chris@0
|
290 {
|
Chris@0
|
291 if (! $this->isReadable()) {
|
Chris@0
|
292 throw new RuntimeException('Stream is not readable');
|
Chris@0
|
293 }
|
Chris@0
|
294
|
Chris@0
|
295 $result = stream_get_contents($this->resource);
|
Chris@0
|
296 if (false === $result) {
|
Chris@0
|
297 throw new RuntimeException('Error reading from stream');
|
Chris@0
|
298 }
|
Chris@0
|
299 return $result;
|
Chris@0
|
300 }
|
Chris@0
|
301
|
Chris@0
|
302 /**
|
Chris@0
|
303 * {@inheritdoc}
|
Chris@0
|
304 */
|
Chris@0
|
305 public function getMetadata($key = null)
|
Chris@0
|
306 {
|
Chris@0
|
307 if (null === $key) {
|
Chris@0
|
308 return stream_get_meta_data($this->resource);
|
Chris@0
|
309 }
|
Chris@0
|
310
|
Chris@0
|
311 $metadata = stream_get_meta_data($this->resource);
|
Chris@0
|
312 if (! array_key_exists($key, $metadata)) {
|
Chris@0
|
313 return null;
|
Chris@0
|
314 }
|
Chris@0
|
315
|
Chris@0
|
316 return $metadata[$key];
|
Chris@0
|
317 }
|
Chris@0
|
318
|
Chris@0
|
319 /**
|
Chris@0
|
320 * Set the internal stream resource.
|
Chris@0
|
321 *
|
Chris@0
|
322 * @param string|resource $stream String stream target or stream resource.
|
Chris@0
|
323 * @param string $mode Resource mode for stream target.
|
Chris@0
|
324 * @throws InvalidArgumentException for invalid streams or resources.
|
Chris@0
|
325 */
|
Chris@0
|
326 private function setStream($stream, $mode = 'r')
|
Chris@0
|
327 {
|
Chris@0
|
328 $error = null;
|
Chris@0
|
329 $resource = $stream;
|
Chris@0
|
330
|
Chris@0
|
331 if (is_string($stream)) {
|
Chris@0
|
332 set_error_handler(function ($e) use (&$error) {
|
Chris@17
|
333 if ($e !== E_WARNING) {
|
Chris@17
|
334 return;
|
Chris@17
|
335 }
|
Chris@17
|
336
|
Chris@0
|
337 $error = $e;
|
Chris@17
|
338 });
|
Chris@0
|
339 $resource = fopen($stream, $mode);
|
Chris@0
|
340 restore_error_handler();
|
Chris@0
|
341 }
|
Chris@0
|
342
|
Chris@0
|
343 if ($error) {
|
Chris@0
|
344 throw new InvalidArgumentException('Invalid stream reference provided');
|
Chris@0
|
345 }
|
Chris@0
|
346
|
Chris@0
|
347 if (! is_resource($resource) || 'stream' !== get_resource_type($resource)) {
|
Chris@0
|
348 throw new InvalidArgumentException(
|
Chris@0
|
349 'Invalid stream provided; must be a string stream identifier or stream resource'
|
Chris@0
|
350 );
|
Chris@0
|
351 }
|
Chris@0
|
352
|
Chris@0
|
353 if ($stream !== $resource) {
|
Chris@0
|
354 $this->stream = $stream;
|
Chris@0
|
355 }
|
Chris@0
|
356
|
Chris@0
|
357 $this->resource = $resource;
|
Chris@0
|
358 }
|
Chris@0
|
359 }
|