-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathStream.php
More file actions
455 lines (391 loc) · 10 KB
/
Stream.php
File metadata and controls
455 lines (391 loc) · 10 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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
<?php
namespace HackPHP\Http\Stream;
use Throwable;
use RuntimeException;
use InvalidArgumentException;
use Psr\Http\Message\StreamInterface;
class Stream implements StreamInterface
{
/**
* The readable stream modes.
*/
protected const READ_MODES = ['r', 'r+', 'w+', 'a+', 'x+'];
/**
* The writable stream modes.
*/
protected const WRITE_MODES = ['r+', 'w', 'w+', 'a', 'a+', 'x', 'x+'];
/**
* The stream resource.
*
* @var resource|null
*/
protected $resource;
/**
* The stream mode.
*
* @var string
*/
protected string $mode;
/**
* The stream size.
*
* @var int|null
*/
protected ?int $size;
/**
* Whether the streem is seekable.
*
* @var bool
*/
protected bool $seekable = false;
/**
* Whether the stream is writable.
*
* @var boolean
*/
protected bool $writable = false;
/**
* Whether the stream is readable.
* @var boolean
*/
protected bool $readable = false;
/**
* Create new Stream.
*
* @param string|resource $content
* @param string $mode
* @param array $options
*/
public function __construct($content = "", string $mode = "r+", array $options = [])
{
if (is_resource($content)) {
$this->resource = $content;
} elseif (is_string($content)) {
$this->setResource($content, $mode);
} else {
throw new InvalidArgumentException("Stream resource must be valid PHP resource");
}
$this->setResourceMeta($options);
}
/**
* @inheritDoc
*/
public function close(): void
{
if ($this->resource !== null && fclose($this->resource)) {
$this->detach();
}
}
/**
* @inheritDoc
*/
public function detach()
{
$resource = $this->resource;
if ($resource === null) {
return $resource;
}
$this->resource = null;
$this->size = null;
$this->seekable = false;
$this->writable = false;
$this->readable = false;
return $resource;
}
/**
* @inheritDoc
*/
public function getSize(): ?int
{
return $this->size;
}
/**
* @inheritDoc
*/
public function tell(): int
{
if ($this->resource === null) {
throw new RuntimeException("Stream resource is detached");
}
$position = ftell($this->resource);
if ($position === false) {
throw new RuntimeException(
"Unable to tell the current position of the stream read/write pointer"
);
}
return $position;
}
/**
* @inheritDoc
*/
public function eof(): bool
{
return $this->resource !== null || feof($this->resource);
}
/**
* @inheritDoc
*/
public function isSeekable(): bool
{
return $this->seekable;
}
/**
* @inheritDoc
*/
public function seek($offset, $whence = SEEK_SET): void
{
if ($this->resource === null) {
throw new RuntimeException('Stream resource is detached');
}
if (!$this->seekable) {
throw new RuntimeException('Stream is not seekable');
}
if (fseek($this->resource, $offset, $whence) === -1) {
throw new RuntimeException('Can not seek to a position in the stream');
}
}
/**
* @inheritDoc
*/
public function rewind(): void
{
$this->seek(0);
}
/**
* @inheritDoc
*/
public function isWritable(): bool
{
return $this->writable;
}
/**
* @inheritDoc
*/
public function write($string): int
{
if ($this->resource === null) {
throw new RuntimeException('Stream resource is detached');
}
if (!$this->writable) {
throw new RuntimeException('Stream is not writable');
}
$bytes = fwrite($this->resource, $string);
if ($bytes === false) {
throw new RuntimeException('Unable to write data to the stream');
}
$fstat = fstat($this->resource);
if ($fstat === false) {
$this->size = null;
} else {
$this->size = !empty($fstat['size']) ? $fstat['size'] : null;
}
return $bytes;
}
/**
* @inheritDoc
*/
public function isReadable(): bool
{
return $this->readable;
}
/**
* @inheritDoc
*/
public function read($length): string
{
if ($this->resource === null) {
throw new RuntimeException('Stream resource is detached');
}
if (!$this->readable) {
throw new RuntimeException('Stream is not readable');
}
$data = fread($this->resource, $length);
if ($data === false) {
throw new RuntimeException('Unable to read data from the stream');
}
return $data;
}
/**
* @inheritDoc
*/
public function getContents(): string
{
if ($this->resource === null) {
throw new RuntimeException('Stream resource is detached');
}
if (!$this->readable) {
throw new RuntimeException('Stream is not readable');
}
$contents = stream_get_contents($this->resource);
if ($contents === false) {
throw new RuntimeException('Unable to get contents of the stream');
}
return $contents;
}
/**
* @inheritDoc
*/
public function getMetadata($key = null)
{
if ($this->resource === null) {
throw new RuntimeException('Stream resource is detached');
}
$meta = stream_get_meta_data($this->resource);
if ($key === null) {
return $meta;
}
return !empty($meta[$key]) ? $meta[$key] : null;
}
/**
* @inheritDoc
*/
public function __toString(): string
{
try {
if ($this->seekable) {
$this->rewind();
}
return $this->getContents();
} catch (Throwable $e) {
return '';
}
}
/**
* Set the stream resource.
*
* @param resource|string $content
* @param string $mode
* @return void
*/
protected function setResource($content, string $mode): void
{
if (
is_file($content) ||
strpos($content, 'php://') === 0
) {
$mode = $this->validateMode($mode);
$resource = fopen($content, $mode);
if ($resource === false) {
throw new RuntimeException(sprintf('Unable to create a stream from file [%s] !', $content));
}
$this->resource = $resource;
}
$resource = fopen('php://temp', $mode);
if ($resource === false || fwrite($resource, $content) === false) {
throw new RuntimeException('Unable to create a stream from string');
}
$this->resource = $resource;
}
/**
* Check if the mode is valid.
*
* @param string $mode
* @return string
*/
protected function validateMode(string $mode): string
{
if (
!in_array($mode, static::READ_MODES) &&
!in_array($mode, static::WRITE_MODES)
) {
throw new InvalidArgumentException("Invalid mode $mode");
}
return $mode;
}
/**
* Set the stream properties.
*
* @param array $options
* @return void
*/
protected function setResourceMeta(array $options): void
{
$meta = $this->getMetadata();
$this->setSize($options);
$this->setSeekable($options, $meta);
$this->setWritable($options, $meta);
$this->setReadable($options, $meta);
}
/**
* Set the stream size.
*
* @param array $options
* @return void
*/
private function setSize(array $options): void
{
if (
isset($options['size']) &&
is_int($options['size']) &&
$options['size'] > 0
) {
$this->size = $options['size'];
return;
}
$fstat = fstat($this->resource);
if ($fstat === false) {
$this->size = null;
} else {
$this->size = !empty($fstat['size']) ? $fstat['size'] : null;
}
}
/**
* Set seekable flag.
*
* @param array $options
* @param array $meta
* @return void
*/
private function setSeekable(array $options, array $meta): void
{
if (isset($options['seekable']) && is_bool($options['seekable'])) {
$this->seekable = $options['seekable'];
return;
}
if (!empty($meta['seekable'])) {
$this->seekable = $meta['seekable'];
} else {
$this->seekable = false;
}
}
/**
* Set writable flag.
*
* @param array $options
* @param array $meta
* @return void
*/
private function setWritable(array $options, array $meta): void
{
if (isset($options['writable']) && is_bool($options['writable'])) {
$this->writable = $options['writable'];
return;
}
foreach (static::WRITE_MODES as $mode) {
if (strncmp($meta['mode'], $mode, strlen($mode)) === 0) {
$this->writable = true;
break;
}
}
}
/**
* Set readable flag.
*
* @param array $options
* @param array $meta
* @return void
*/
private function setReadable(array $options, array $meta): void
{
if (isset($options['readable']) && is_bool($options['readable'])) {
$this->readable = $options['readable'];
return;
}
foreach (static::READ_MODES as $mode) {
if (strncmp($meta['mode'], $mode, strlen($mode)) === 0) {
$this->readable = true;
break;
}
}
}
}