PEAR2_Net_RouterOS-1.0.0b1PEAR2_Net_RouterOS-1.0.0b1/src/PEAR2/Net/Transmitter/StreamTransmitter.php

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
<?php

/**
 * ~~summary~~
 * 
 * ~~description~~
 * 
 * PHP version 5
 * 
 * @category  Net
 * @package   PEAR2_Net_Transmitter
 * @author    Vasil Rangelov <boen.robot@gmail.com>
 * @copyright 2011 Vasil Rangelov
 * @license   http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
 * @version   SVN: $WCREV$
 * @link      http://netrouteros.sourceforge.net/
 */
/**
 * The namespace declaration.
 */
namespace PEAR2\Net\Transmitter;

/**
 * A stream transmitter.
 * 
 * This is a convinience wrapper for stream functionality. Used to ensure data
 * integrity. Designed for sockets, but it has intentionally been made to accept
 * any stream.
 * 
 * @category Net
 * @package  PEAR2_Net_Transmitter
 * @author   Vasil Rangelov <boen.robot@gmail.com>
 * @license  http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
 * @link     http://netrouteros.sourceforge.net/
 * @see      Client
 */
class StreamTransmitter
{
    const DIRECTION_BOTH = '|||';
    const DIRECTION_SEND = '<<<';
    const DIRECTION_RECEIVE = '>>>';

    /**
     * @var resource The stream to wrap around.
     */
    protected $stream;

    /**
     * @var bool A flag that tells whether or not the stream is persistent.
     */
    protected $persist;

    /**
     * Wraps around the specified stream.
     * 
     * @param resource $stream The stream to wrap around.
     * 
     * @see isFresh()
     */
    public function __construct($stream)
    {
        if (!self::isStream($stream)) {
            throw $this->createException('Invalid stream supplied.', 1);
        }
        $this->stream = $stream;
        $this->persist = (bool) preg_match(
            '#\s?persistent\s?#sm', get_resource_type($stream)
        );
    }

    /**
     * Checks if a given variable is a stream resource.
     * 
     * @param mixed $var The variable to check.
     * 
     * @return bool TRUE on success, FALSE on failure.
     */
    public static function isStream($var)
    {
        return is_resource($var)
            && (bool) preg_match('#\s?stream$#sm', get_resource_type($var));
    }

    /**
     * Checks whether the wrapped stream is fresh.
     * 
     * Checks whether the wrapped stream is fresh. A stream is considered fresh
     * if there hasn't been any activity on it. Particularly useful for
     * detecting reused persistent connections.
     * 
     * @return bool TRUE if the socket is fresh, FALSE otherwise.
     */
    public function isFresh()
    {
        return ftell($this->stream) === 0;
    }
    
    /**
     * Sets the timeout for the stream.
     * 
     * @param int $seconds      Timeout in seconds.
     * @param int $microseconds Timeout in microseconds to be added to the
     * seconds.
     * 
     * @return bool TRUE on success, FALSE on failure.
     */
    public function setTimeout($seconds, $microseconds = 0)
    {
        return stream_set_timeout($this->stream, $seconds, $microseconds);
    }
    
    /**
     * Sets the size of a stream's buffer.
     * 
     * @param int $size         The desired size of the buffer, in bytes.
     * @param string $direction The buffer of which direction to set. Valid
     * values are the DIRECTION_* constants.
     * 
     * @return bool TRUE on success, FALSE on failure.
     */
    public function setBuffer($size, $direction = self::DIRECTION_BOTH)
    {
        switch($direction) {
        case self::DIRECTION_SEND:
            return stream_set_write_buffer($this->stream, $size) === 0;
        case self::DIRECTION_RECEIVE:
            return stream_set_read_buffer($this->stream, $size) === 0;
        default:
            return stream_set_write_buffer($this->stream, $size) === 0
                && stream_set_read_buffer($this->stream, $size) === 0;
        }
    }

    /**
     * Sends a string over the wrapped stream.
     * 
     * @param string $string The string to send.
     * 
     * @return int The number of bytes sent.
     */
    public function send($string)
    {
        $bytes = 0;
        $bytesToSend = (double) sprintf('%u', strlen($string));
        while ($bytes < $bytesToSend) {
            if ($this->isAcceptingData()) {
                $bytesNow = @fwrite(
                    $this->stream, substr($string, $bytes, 0xFFFFF)
                );
                if (0 != $bytesNow) {
                    $bytes += $bytesNow;
                } else {
                    throw $this->createException(
                        'Failed while sending string.', 2
                    );
                }
            }
        }
        return $bytes;
    }

    /**
     * Sends a stream over the wrapped stream.
     * 
     * @param resource $stream The stream to send.
     * 
     * @return int The number of bytes sent.
     */
    public function sendStream($stream)
    {
        $bytes = 0;
        while (!feof($stream)) {
            if ($this->isAcceptingData()) {
                $bytesNow = @stream_copy_to_stream(
                    $stream, $this->stream, 0xFFFFF
                );
                if (0 != $bytesNow) {
                    $bytes += $bytesNow;
                } else {
                    throw $this->createException(
                        'Failed while sending stream.', 3
                    );
                }
            }
        }
        fseek($stream, -$bytes, SEEK_CUR);
        return $bytes;
    }

    /**
     * Reads from the wrapped stream to receive.
     * 
     * Reads from the wrapped stream to receive content as a string.
     * 
     * @param int    $length The number of bytes to read.
     * @param string $what   Descriptive string about what is being received
     * (used in exception messages).
     * 
     * @return string The received content.
     */
    public function receive($length, $what = 'data')
    {
        $result = '';
        while ($length > 0) {
            if ($this->isAvailable()) {
                while ($this->isDataAwaiting()) {
                    $fragment = fread($this->stream, min($length, 0xFFFFF));
                    if ('' !== $fragment) {
                        $length -= strlen($fragment);
                        $result .= $fragment;
                        continue 2;
                    }
                }
            }
            throw $this->createException(
                "Failed while receiving {$what}", 4
            );
        }
        return $result;
    }

    /**
     * Reads from the wrapped stream to receive.
     * 
     * Reads from the wrapped stream to receive content as a stream.
     * 
     * @param int    $length  The number of bytes to read.
     * @param array  $filters An array of filters to apply to the stream while
     * receiving. Key is the filter name, value is an array of parameters for
     * the filter.
     * @param string $what    Descriptive string about what is being received
     * (used in exception messages).
     * 
     * @return resource The received content.
     */
    public function receiveStream(
        $length, array $filters = array(), $what = 'stream data'
    ) {
        $result = fopen('php://temp', 'r+b');
        $appliedFilters = array();
        foreach ($filters as $filtername => $params) {
            $appliedFilters[] = stream_filter_append(
                $result, $filtername, STREAM_FILTER_WRITE, $params
            );
        }
        
        while ($length > 0) {
            if ($this->isAvailable()) {
                while ($this->isDataAwaiting()) {
                    $fragment = fread($this->stream, min($length, 0xFFFFF));
                    if ('' !== $fragment) {
                        $length -= strlen($fragment);
                        fwrite($result, $fragment);
                        continue 2;
                    }
                }
            }
            throw $this->createException(
                "Failed while receiving {$what}", 5
            );
        }
        
        foreach ($appliedFilters as $filter) {
            stream_filter_remove($filter);
        }
        rewind($result);
        return $result;
    }

    /**
     * Checks whether the stream is available for operations.
     * 
     * @return bool TRUE if the stream is available, FALSE otherwise.
     */
    public function isAvailable()
    {
        return self::isStream($this->stream) && !feof($this->stream);
    }

    /**
     * Checks whether there is data to be read from the wrapped stream.
     * 
     * @return bool TRUE if there is data to be read, FALSE otherwise.
     */
    public function isDataAwaiting()
    {
        return $this->isAvailable();
    }

    /**
     * Checks whether the wrapped stream can be written to without a block.
     * 
     * @return bool TRUE if the wrapped stream would not block on a write, FALSE
     * otherwise.
     */
    public function isAcceptingData()
    {
        $r = $e = null;
        $w = array($this->stream);
        return self::isStream($this->stream)
            && 1 === @/* due to PHP bug #54563 */stream_select($r, $w, $e, 0);
    }

    /**
     * Closes the opened connection, unless it's a persistent one.
     */
    public function __destruct()
    {
        if (!$this->persist) {
            $this->close();
        }
    }

    /**
     * Closes the opened stream, even if it is a persistent one.
     * 
     * @return bool TRUE on success, FALSE on failure.
     */
    public function close()
    {
        return self::isStream($this->stream) && fclose($this->stream);
    }

    /**
     * Creates a new exception.
     * 
     * Creates a new exception. Used by the rest of the functions in this class.
     * Override in derived classes for custom exception handling.
     * 
     * @param string $message The exception message.
     * @param int    $code    The exception code.
     * 
     * @return \Exception The exception to then be thrown.
     */
    protected function createException($message, $code = 0)
    {
        return new \Exception($message, $code);
    }

}
EOF