BufferStreamHandler.php
5.1 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
<?php
/**
* Joomla! Content Management System
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Utility;
defined('JPATH_PLATFORM') or die;
// Workaround for B/C. Will be removed with 4.0
BufferStreamHandler::stream_register();
/**
* Generic Buffer stream handler
*
* This class provides a generic buffer stream. It can be used to store/retrieve/manipulate
* string buffers with the standard PHP filesystem I/O methods.
*
* @since 1.7.0
*/
class BufferStreamHandler
{
/**
* Stream position
*
* @var integer
* @since 1.7.0
*/
public $position = 0;
/**
* Buffer name
*
* @var string
* @since 1.7.0
*/
public $name = null;
/**
* Buffer hash
*
* @var array
* @since 3.0.0
*/
public $buffers = array();
/**
* Status of registering the wrapper
*
* @var boolean
* @since 3.8.2
*/
static private $registered = false;
/**
* Function to register the stream wrapper
*
* @return void
*
* @since 3.8.2
*/
public static function stream_register()
{
if (!self::$registered)
{
stream_wrapper_register('buffer', '\\Joomla\\CMS\\Utility\\BufferStreamHandler');
self::$registered = true;
}
return;
}
/**
* Function to open file or url
*
* @param string $path The URL that was passed
* @param string $mode Mode used to open the file @see fopen
* @param integer $options Flags used by the API, may be STREAM_USE_PATH and
* STREAM_REPORT_ERRORS
* @param string &$opened_path Full path of the resource. Used with STREAN_USE_PATH option
*
* @return boolean
*
* @since 1.7.0
* @see streamWrapper::stream_open
*/
public function stream_open($path, $mode, $options, &$opened_path)
{
$url = parse_url($path);
$this->name = $url['host'];
$this->buffers[$this->name] = null;
$this->position = 0;
return true;
}
/**
* Read stream
*
* @param integer $count How many bytes of data from the current position should be returned.
*
* @return mixed The data from the stream up to the specified number of bytes (all data if
* the total number of bytes in the stream is less than $count. Null if
* the stream is empty.
*
* @see streamWrapper::stream_read
* @since 1.7.0
*/
public function stream_read($count)
{
$ret = substr($this->buffers[$this->name], $this->position, $count);
$this->position += strlen($ret);
return $ret;
}
/**
* Write stream
*
* @param string $data The data to write to the stream.
*
* @return integer
*
* @see streamWrapper::stream_write
* @since 1.7.0
*/
public function stream_write($data)
{
$left = substr($this->buffers[$this->name], 0, $this->position);
$right = substr($this->buffers[$this->name], $this->position + strlen($data));
$this->buffers[$this->name] = $left . $data . $right;
$this->position += strlen($data);
return strlen($data);
}
/**
* Function to get the current position of the stream
*
* @return integer
*
* @see streamWrapper::stream_tell
* @since 1.7.0
*/
public function stream_tell()
{
return $this->position;
}
/**
* Function to test for end of file pointer
*
* @return boolean True if the pointer is at the end of the stream
*
* @see streamWrapper::stream_eof
* @since 1.7.0
*/
public function stream_eof()
{
return $this->position >= strlen($this->buffers[$this->name]);
}
/**
* The read write position updates in response to $offset and $whence
*
* @param integer $offset The offset in bytes
* @param integer $whence Position the offset is added to
* Options are SEEK_SET, SEEK_CUR, and SEEK_END
*
* @return boolean True if updated
*
* @see streamWrapper::stream_seek
* @since 1.7.0
*/
public function stream_seek($offset, $whence)
{
switch ($whence)
{
case SEEK_SET :
return $this->seek_set($offset);
case SEEK_CUR :
return $this->seek_cur($offset);
case SEEK_END :
return $this->seek_end($offset);
}
return false;
}
/**
* Set the position to the offset
*
* @param integer $offset The offset in bytes
*
* @return boolean
*/
protected function seek_set($offset)
{
if ($offset < 0 || $offset > strlen($this->buffers[$this->name]))
{
return false;
}
$this->position = $offset;
return true;
}
/**
* Adds the offset to current position
*
* @param integer $offset The offset in bytes
*
* @return boolean
*/
protected function seek_cur($offset)
{
if ($offset < 0)
{
return false;
}
$this->position += $offset;
return true;
}
/**
* Sets the position to the end of the current buffer + offset
*
* @param integer $offset The offset in bytes
*
* @return boolean
*/
protected function seek_end($offset)
{
$offset += strlen($this->buffers[$this->name]);
if ($offset < 0)
{
return false;
}
$this->position = $offset;
return true;
}
}