-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathStream.php
More file actions
416 lines (387 loc) · 12.2 KB
/
Copy pathStream.php
File metadata and controls
416 lines (387 loc) · 12.2 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
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
<?php
/**
* This file is part of HttpMessage
*
* @package bdk/http-message
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2014-2024 Brad Kent
* @version v1.0
*/
namespace bdk\HttpMessage;
use bdk\HttpMessage\AbstractStream;
use InvalidArgumentException;
use Psr\Http\Message\StreamInterface;
use RuntimeException;
/**
* Psr\Http\Message\Stream implementation
*
* @psalm-api
*/
class Stream extends AbstractStream implements StreamInterface
{
/**
* Resource modes.
*
* @var string
*
* @see http://php.net/manual/function.fopen.php
* @see http://php.net/manual/en/function.gzopen.php
*/
const READABLE_MODES = '/r|a\+|ab\+|w\+|wb\+|x\+|xb\+|c\+|cb\+/';
const WRITABLE_MODES = '/a|w|r\+|rb\+|rw|x|c/';
/** @var int|null */
private $size;
/** @var bool */
private $seekable;
/** @var bool */
private $readable;
/** @var bool */
private $writable;
/** @var string|null */
private $uri;
/** @var array */
private $customMetadata = array();
/**
* This constructor accepts an associative array of options.
*
* - metadata: (array) Any additional metadata to return when the metadata
* of the stream is accessed.
* - size: (int) If a read stream would otherwise have an indeterminate
* size, but the size is known due to foreknowledge, then you can
* provide that size, in bytes.
*
* @param mixed $resource Resource, file, or string content to wrap.
* @param array $options Associative array of options.
*
* @throws InvalidArgumentException if the stream is not a stream resource
*/
public function __construct($resource = null, array $options = array())
{
$this->setResource($resource);
/** @var array{metadata:array,size:int|null} */
$options = \array_merge(array(
'metadata' => array(),
'size' => null,
), $options);
$this->size = $options['size'];
$this->customMetadata = $options['metadata'];
/** @psalm-suppress PossiblyInvalidArgument */
$meta = \stream_get_meta_data($this->resource);
$this->seekable = $meta['seekable'];
$this->readable = (bool) \preg_match(self::READABLE_MODES, $meta['mode']);
$this->writable = (bool) \preg_match(self::WRITABLE_MODES, $meta['mode']);
/** @var string|null */
$this->uri = $this->getMetadata('uri');
}
/**
* Closes the stream when the destructed
*/
public function __destruct()
{
$this->close();
}
/**
* Reads all data from the stream into a string, from the beginning to end.
*
* Warning: This could attempt to load a large amount of data into memory.
*
* @return string
*
* @see http://php.net/manual/en/language.oop5.magic.php#object.tostring
*/
public function __toString(): string
{
if ($this->isResourceOpen() === false) {
return '';
}
try {
$this->seek(0);
/** @psalm-suppress PossiblyInvalidArgument we know resource is open */
return (string) \stream_get_contents($this->resource);
} catch (\Exception $e) {
return '';
}
}
/**
* Closes the stream and any underlying resources.
*
* @return void
*/
public function close(): void
{
if (isset($this->resource)) {
if ($this->isResourceOpen() === true) {
/** @psalm-suppress PossiblyInvalidArgument we know resource is open */
\fclose($this->resource);
}
$this->detach();
}
}
/**
* Separates any underlying resources from the stream.
*
* After the stream has been detached, the stream is in an unusable state.
*
* @return resource|null Underlying PHP stream, if any
*/
public function detach()
{
if (!isset($this->resource)) {
return null;
}
$resource = $this->isResourceOpen()
? $this->resource
: null;
unset($this->resource);
$this->size = null;
$this->uri = null;
$this->readable = false;
$this->seekable = false;
$this->writable = false;
return $resource;
}
/**
* Get the size of the stream if known.
*
* @return int|null Returns the size in bytes if known, or null if unknown.
*/
public function getSize(): ?int
{
if ($this->size !== null) {
return $this->size;
}
if ($this->isResourceOpen() === false) {
return null;
}
// Clear the stat cache if the stream has a URI
if ($this->uri) {
\clearstatcache(true, $this->uri);
}
/** @psalm-suppress PossiblyInvalidArgument we know resource is open */
$stats = \fstat($this->resource);
if (isset($stats['size'])) {
$this->size = $stats['size'];
}
return $this->size;
}
/**
* Returns the current position of the file read/write pointer
*
* @return int Position of the file pointer
* @throws RuntimeException on error.
*/
public function tell(): int
{
if ($this->isResourceOpen() === false) {
throw new RuntimeException($this->strings['detached']);
}
/** @psalm-suppress PossiblyInvalidArgument we know resource is open */
$result = \ftell($this->resource);
if ($result === false) {
throw new RuntimeException($this->strings['posUnknown']);
}
return $result;
}
/**
* Returns true if the stream is at the end of the stream.
*
* @return bool
* @throws RuntimeException
*/
public function eof(): bool
{
if ($this->isResourceOpen() === false) {
throw new RuntimeException($this->strings['detached']);
}
/** @psalm-suppress PossiblyInvalidArgument we know resource is open */
return \feof($this->resource);
}
/**
* Returns whether or not the stream is seekable.
*
* @return bool
*/
public function isSeekable(): bool
{
return $this->seekable;
}
/**
* Seek to a position in the stream.
*
* @param int $offset Stream offset
* @param int $whence Specifies how the cursor position will be calculated
* based on the seek offset. Valid values are identical to the built-in
* PHP $whence values for `fseek()`.
* SEEK_SET: Set position equal to offset bytes
* SEEK_CUR: Set position to current location plus offset
* SEEK_END: Set position to end-of-stream plus offset.
*
* @link http://www.php.net/manual/en/function.fseek.php
* @throws RuntimeException on failure.
*
* @return void
*/
public function seek(int $offset, int $whence = SEEK_SET): void
{
$whence = (int) $whence;
if ($this->isResourceOpen() === false) {
throw new RuntimeException($this->strings['detached']);
}
if (!$this->seekable) {
throw new RuntimeException($this->strings['seekNonSeekable']);
}
/** @psalm-suppress PossiblyInvalidArgument we know resource is open */
if (\fseek($this->resource, $offset, $whence) === -1) {
throw new RuntimeException(\sprintf(
$this->strings['seekFail'],
$offset,
\var_export($whence, true)
));
}
}
/**
* Seek to the beginning of the stream.
*
* If the stream is not seekable, this method will raise an exception;
* otherwise, it will perform a seek(0).
*
* @link http://www.php.net/manual/en/function.fseek.php
* @see seek()
* @throws RuntimeException on failure.
*
* @return void
*/
public function rewind(): void
{
$this->seek(0);
}
/**
* Returns whether or not the stream is writable.
*
* @return bool
*/
public function isWritable(): bool
{
return $this->writable;
}
/**
* Write data to the stream.
*
* @param string $string The string that is to be written.
*
* @return int Returns the number of bytes written to the stream.
* @throws RuntimeException on failure.
*/
public function write(string $string): int
{
if ($this->isResourceOpen() === false) {
throw new RuntimeException($this->strings['detached']);
}
if (!$this->writable) {
throw new RuntimeException($this->strings['writeFailNonWritable']);
}
// We can't know the size after writing anything
$this->size = null;
/** @psalm-suppress PossiblyInvalidArgument we know resource is open */
$result = \fwrite($this->resource, $string);
if ($result === false) {
throw new RuntimeException($this->strings['writeFail']);
}
return $result;
}
/**
* Returns whether or not the stream is readable.
*
* @return bool
*/
public function isReadable(): bool
{
return $this->readable;
}
/**
* Read data from the stream.
*
* @param int $length Read up to $length bytes from the object and return
* them. Fewer than $length bytes may be returned if underlying stream
* call returns fewer bytes.
*
* @return string Returns the data read from the stream, or an empty string
* if no bytes are available.
* @throws RuntimeException if an error occurs.
* @throws InvalidArgumentException if negative length specified
*/
public function read(int $length): string
{
if ($this->isResourceOpen() === false) {
throw new RuntimeException($this->strings['detached']);
}
if (!$this->readable) {
throw new RuntimeException($this->strings['readFailNonReadable']);
}
if ($length < 0) {
throw new InvalidArgumentException($this->strings['readLengthNegative']);
}
if ($length === 0) {
return '';
}
/** @psalm-suppress PossiblyInvalidArgument we know resource is open */
$string = \fread($this->resource, $length);
if ($string === false) {
throw new RuntimeException($this->strings['readFail']);
}
return $string;
}
/**
* Returns the remaining contents in a string
*
* @return string
* @throws RuntimeException if unable to read or an error occurs while
* reading.
*/
public function getContents(): string
{
if ($this->isResourceOpen() === false) {
throw new RuntimeException($this->strings['detached']);
}
$contents = false;
if ($this->readable) {
/** @psalm-suppress PossiblyInvalidArgument we know resource is open */
$contents = \stream_get_contents($this->resource);
}
if ($contents === false) {
throw new RuntimeException($this->strings['readFail']);
}
return $contents;
}
/**
* Get stream metadata as an associative array or retrieve a specific key.
*
* The keys returned are identical to the keys returned from PHP's
* stream_get_meta_data() function.
*
* @param string|null $key Specific metadata to retrieve.
*
* @return array|mixed|null Returns an associative array if no key is
* provided. Returns a specific key value if a key is provided and the
* value is found, or null if the key is not found.
* @link http://php.net/manual/en/function.stream-get-meta-data.php
*
* @psalm-suppress PossiblyInvalidArgument we know resource is open
*/
public function getMetadata(?string $key = null)
{
if ($this->isResourceOpen() === false) {
return $key !== null
? null
: array();
}
$meta = $this->customMetadata + \stream_get_meta_data($this->resource);
if ($key === null) {
return $meta;
}
return isset($meta[$key])
? $meta[$key]
: null;
}
}