forked from docker-php/docker-php
-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathStream.php
More file actions
217 lines (184 loc) · 4.45 KB
/
Copy pathStream.php
File metadata and controls
217 lines (184 loc) · 4.45 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
<?php
namespace Docker\SocketClient;
use Docker\SocketClient\Exception\StreamException;
use Docker\SocketClient\Exception\TimeoutException;
use Psr\Http\Message\StreamInterface;
/**
* Stream implementation for Socket Client.
*
* This implementation is used to have a Stream which react better to the Socket Client behavior.
*
* The main advantage is you can get the response of a request even if it's not finish, the response is available
* as soon as all headers are received, this stream will have the remaining socket used for the request / response
* call.
*
* It is only readable once, if you want to read the content multiple times, you can store contents of this
* stream into a variable or encapsulate it in a buffered stream.
*
* Writing and seeking is disable to avoid weird behaviors.
*
* @author Joel Wurtz <joel.wurtz@gmail.com>
*/
class Stream implements StreamInterface
{
/** @var resource Underlying socket */
private $socket;
/**
* @var bool Is stream detached
*/
private bool $isDetached = false;
/**
* @var int|null Size of the stream, so we know what we must read, null if not available (i.e. a chunked stream)
*/
private $size;
/**
* @var int Size of the stream readed, to avoid reading more than available and have the user blocked
*/
private $readed = 0;
/**
* Create the stream.
*
* @param resource $socket
* @param int $size
*/
public function __construct($socket, ?int $size = null)
{
$this->socket = $socket;
$this->size = $size;
}
/**
* {@inheritdoc}
*/
public function __toString(): string
{
try {
return $this->getContents();
} catch (\Exception $e) {
return '';
}
}
/**
* {@inheritdoc}
*/
public function close(): void
{
fclose($this->socket);
}
/**
* {@inheritdoc}
*/
public function detach()
{
$this->isDetached = true;
$socket = $this->socket;
$this->socket = null;
return $socket;
}
/**
* {@inheritdoc}
*/
public function getSize(): ?int
{
return $this->size;
}
/**
* {@inheritdoc}
*/
public function tell(): int
{
return ftell($this->socket);
}
/**
* {@inheritdoc}
*/
public function eof(): bool
{
return feof($this->socket);
}
/**
* {@inheritdoc}
*/
public function isSeekable(): bool
{
return false;
}
/**
* {@inheritdoc}
*/
public function seek($offset, $whence = SEEK_SET): void
{
throw new StreamException('This stream is not seekable');
}
/**
* {@inheritdoc}
*/
public function rewind(): void
{
throw new StreamException('This stream is not seekable');
}
/**
* {@inheritdoc}
*/
public function isWritable(): bool
{
return false;
}
/**
* {@inheritdoc}
*/
public function write($string): int
{
throw new StreamException('This stream is not writable');
}
/**
* {@inheritdoc}
*/
public function isReadable(): bool
{
return true;
}
/**
* {@inheritdoc}
*/
public function read($length): string
{
if (null === $this->getSize()) {
return fread($this->socket, $length);
}
if ($this->getSize() === $this->readed) {
return '';
}
// Even if we request a length a non blocking stream can return less data than asked
$read = fread($this->socket, $length);
if ($this->getMetadata('timed_out')) {
throw new TimeoutException('Stream timed out while reading data');
}
$this->readed += strlen($read);
return $read;
}
/**
* {@inheritdoc}
*/
public function getContents(): string
{
if (null === $this->getSize()) {
return stream_get_contents($this->socket);
}
$contents = '';
do {
$contents .= $this->read($this->getSize() - $this->readed);
} while ($this->readed < $this->getSize());
return $contents;
}
/**
* {@inheritdoc}
*/
public function getMetadata($key = null)
{
$meta = stream_get_meta_data($this->socket);
if (null === $key) {
return $meta;
}
return $meta[$key];
}
}