PEAR2_Net_RouterOS-1.0.0b2PEAR2_Net_RouterOS-1.0.0b2/src/PEAR2/Net/RouterOS/Client.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
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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
<?php

/**
 * RouterOS API client implementation.

 * 
 * RouterOS is the flag product of the company MikroTik and is a powerful router software. One of its many abilities is to allow control over it via an API. This package provides a client for that API, in turn allowing you to use PHP to control RouterOS hosts.
 * 
 * PHP version 5
 * 
 * @category  Net
 * @package   PEAR2_Net_RouterOS
 * @author    Vasil Rangelov <boen.robot@gmail.com>
 * @copyright 2011 Vasil Rangelov
 * @license   http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
 * @version   1.0.0b2
 * @link      http://pear2.php.net/PEAR2_Net_RouterOS
 */
/**
 * The namespace declaration.
 */
namespace PEAR2\Net\RouterOS;

/**
 * A RouterOS client.
 * 
 * Provides functionality for easily communicating with a RouterOS host.
 * 
 * @category Net
 * @package  PEAR2_Net_RouterOS
 * @author   Vasil Rangelov <boen.robot@gmail.com>
 * @license  http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
 * @link     http://pear2.php.net/PEAR2_Net_RouterOS
 */
class Client
{
    /**
     * Used in {@link isRequestActive()} to limit search only to requests
     * that have a callback.
     */
    const FILTER_CALLBACK = 1;
    /**
     * Used in {@link isRequestActive()} to limit search only to requests
     * that use the buffer.
     */
    const FILTER_BUFFER = 2;
    /**
     * Used in {@link isRequestActive()} to indicate no limit in search.
     */
    const FILTER_ALL = 3;

    /**
     * @var Communicator The communicator for this client.
     */
    protected $com;

    /**
     * @var int The number of currently pending requests.
     */
    protected $pendingRequestsCount = 0;

    /**
     * @var array An array of responses that have not yet been extracted or
     * passed to a callback. Key is the tag of the request, and the value
     * is an array of associated responses.
     */
    protected $responseBuffer = array();

    /**
     * @var array An array of callbacks to be executed as responses come.
     * Key is the tag of the request, and the value is the callback for it.
     */
    protected $callbacks = array();

    /**
     * @var bool Whether to stream future responses.
     */
    private $_streamResponses = false;

    /**
     * Opens a new instance of a RouterOS API client.
     * 
     * Opens a new instance of a RouterOS API client with the specified
     * settings.
     * 
     * @param string   $host     Hostname (IP or domain) of the RouterOS server.
     * @param string   $username The RouterOS username.
     * @param string   $password The RouterOS password.
     * 
     * @param int      $port     The port on which the RouterOS server provides
     * the API service.
     * @param bool     $persist  Whether or not the connection should be a
     * persistent one.
     * @param float    $timeout  The timeout for the connection.
     * @param resource $context  A context for the socket.
     * 
     * @see sendSync()
     * @see sendAsync()
     */
    public function __construct($host, $username, $password = '', $port = 8728,
        $persist = false, $timeout = null, $context = null
    ) {
        $this->com = new Communicator(
            $host, $port, $persist, $timeout, $username, $context
        );
        //Login the user if necessary
        if ($this->com->getTransmitter()->isFresh()) {
            if (!self::login($this->com, $username, $password)) {
                $this->com->close();
                throw new DataFlowException(
                    'Invalid username or password supplied.', 100
                );
            }
        }
    }
    
    /**
     * A shorthand gateway.
     * 
     * This is a magic PHP method that allows you to call the object as a
     * function. Depending on the argument given, one of the other functions in
     * the class is invoked and its returned value is returned by this function.
     * 
     * @param mixed $arg Value can be either a {@link Request} to send, which
     * would be sent asynchoniously if it has a tag, and synchroniously if not,
     * a number to loop with or null to complete all pending requests. Any other
     * value is converted to string and treated as the tag of a request to
     * complete.
     * 
     * @return mixed Whatever the long form function would have returned.
     */
    public function __invoke($arg = null)
    {
        if (is_int($arg) || is_double($arg)) {
            return $this->loop($arg);
        } elseif ($arg instanceof Request) {
            return $arg->getTag() === null ? $this->sendSync($arg)
                : $this->sendAsync($arg);
        } elseif (null === $arg) {
            return $this->completeRequest();
        }
        return $this->completeRequest((string) $arg);
    }

    /**
     * Login to a RouterOS connection.
     * 
     * @param Communicator $com      The communicator to attempt to login to.
     * @param string       $username The RouterOS username.
     * @param string       $password The RouterOS password.
     * 
     * @return bool TRUE on success, FALSE on failure.
     */
    public static function login(Communicator $com, $username, $password = '')
    {
        try {
            $request = new Request('/login');
            $request->send($com);
            $response = new Response($com);
            $request->setArgument('name', $username);
            $request->setArgument(
                'response', '00' . md5(
                    chr(0) . $password
                    . pack('H*', $response->getArgument('ret'))
                )
            );
            $request->send($com);
            $response = new Response($com);
            return $response->getType() === Response::TYPE_FINAL
                && null === $response->getArgument('ret');
        } catch (\Exception $e) {
            throw ($e instanceof NotSupportedException
            || $e instanceof UnexpectedValueException
            || !$com->getTransmitter()->isDataAwaiting()) ? new SocketException(
                'This is not a compatible RouterOS service', 101, $e
            ) : $e;
        }
    }
    
    /**
     * Sets the charset(s) for this connection.
     * 
     * Sets the charset(s) for this connection. The specified charset(s) will be
     * used for all future requests and responses. When sending,
     * {@link Communicator::CHARSET_LOCAL} is converted to
     * {@link Communicator::HARSET_REMOTE}, and when receiving,
     * {@link Communicator::CHARSET_REMOTE} is converted to
     * {@link Communicator::CHARSET_LOCAL}. Setting NULL to either charset will
     * disable charset convertion, and data will be both sent and received "as
     * is".
     * 
     * @param mixed $charset     The charset to set. If $charsetType is
     * {@link Communicator::CHARSET_ALL}, you can supply either a string to use
     * for all charsets, or an array with the charset types as keys, and the
     * charsets as values.
     * @param int   $charsetType Which charset to set. Valid values are the
     * Communicator::CHARSET_* constants. Any other value is treated as
     * {@link Communicator::CHARSET_ALL}.
     * 
     * @return string|array The old charset. If $charsetType is
     * {@link Communicator::CHARSET_ALL}, the old values will be returned as an
     * array with the types as keys, and charsets as values.
     * @see Communicator::setDefaultCharset()
     */
    public function setCharset(
        $charset, $charsetType = Communicator::CHARSET_ALL
    ) {
        return $this->com->setCharset($charset, $charsetType);
    }
    
    /**
     * Gets the charset(s) for this connection.
     * 
     * @param int $charsetType Which charset to get. Valid values are the
     * Communicator::CHARSET_* constants. Any other value is treated as
     * {@link Communicator::CHARSET_ALL}.
     * 
     * @return string|array The current charset. If $charsetType is
     * {@link Communicator::CHARSET_ALL}, the current values will be returned as
     * an array with the types as keys, and charsets as values.
     * @see setCharset()
     */
    public function getCharset($charsetType)
    {
        return $this->com->getCharset($charsetType);
    }

    /**
     * Sends a request and waits for responses.
     * 
     * @param Request  $request  The request to send.
     * @param callback $callback Optional. A function that is to be executed
     * when new responses for this request are available. The callback takes two
     * parameters. The {@link Response} object as the first, and the
     * {@link Client} object as the second one. If the function returns TRUE,
     * the request is canceled. Note that the callback may be executed one last
     * time after that with a response that notifies about the canceling.
     * 
     * @return Client The client object.
     * @see completeRequest()
     * @see loop()
     * @see cancelRequest()
     */
    public function sendAsync(Request $request, $callback = null)
    {
        //Error checking
        $tag = $request->getTag();
        if (null === $tag) {
            throw new DataFlowException(
                'Asynchonous commands must have a tag.', 102
            );
        }
        if ($this->isRequestActive($tag)) {
            throw new DataFlowException(
                'There must not be multiple active requests sharing a tag.', 103
            );
        }
        
        $this->send($request);

        if (null === $callback) {
            //Register the request at the buffer
            $this->responseBuffer[$tag] = array();
        } else {
            //Prepare the callback
            $this->callbacks[$tag] = $callback;
        }
        return $this;
    }

    /**
     * Checks if a request is active.
     * 
     * Checks if a request is active. A request is considered active if it's a
     * pending request and/or has responses that are not yet extracted.
     * 
     * @param string $tag    The tag of the request to look for.
     * @param int    $filter One of the FILTER_* consntants. Limits the search
     * to the specified places.
     * 
     * @return bool TRUE if the request is active, FALSE otherwise.
     * @see getPendingRequestsCount()
     * @see completeRequest()
     */
    public function isRequestActive($tag, $filter = self::FILTER_ALL)
    {
        $result = 0;
        if (self::FILTER_CALLBACK === ($filter & self::FILTER_CALLBACK)) {
            $result |= (int) array_key_exists($tag, $this->callbacks);
        }
        if (self::FILTER_BUFFER === ($filter & self::FILTER_BUFFER)) {
            $result |= (int) array_key_exists($tag, $this->responseBuffer);
        }
        return 0 !== $result;
    }

    /**
     * Sends a request and gets the full response.
     * 
     * @param Request $request The request to send.
     * 
     * @return ResponseCollection The received responses as a collection.
     * @see sendAsync()
     * @see close()
     */
    public function sendSync(Request $request)
    {
        $this->send($request);
        return $this->completeRequest($request->getTag());
    }

    /**
     * Completes a specified request.
     * 
     * Starts an event loop for the RouterOS callbacks and finishes when a
     * specified request is completed.
     * 
     * @param string $tag The tag of the request to complete. Setting NULL
     * completes all requests.
     * 
     * @return ResponseCollection A collection of {@link Response} objects that
     * haven't been passed to a callback function or previously extracted with
     * {@link extractNewResponses()}. Returns an empty collection when $tag is
     * set to NULL (responses can still be extracted).
     */
    public function completeRequest($tag = null)
    {
        $isTagNull = null === $tag;
        $result = $isTagNull ? array()
            : $this->extractNewResponses($tag)->toArray();
        while ((!$isTagNull && $this->isRequestActive($tag))
        || ($isTagNull && 0 !== $this->getPendingRequestsCount())
        ) {
            $newReply = $this->dispatchNextResponse();
            if ($newReply->getTag() === $tag) {
                if ($isTagNull) {
                    $result[] = $newReply;
                }
                if ($newReply->getType() === Response::TYPE_FINAL) {
                    if (!$isTagNull) {
                        $result = array_merge(
                            $result,
                            $this->extractNewResponses($tag)->toArray()
                        );
                    }
                    break;
                }
            }
        }
        return new ResponseCollection($result);
    }

    /**
     * Extracts responses for a request.
     * 
     * Gets all new responses for a request that haven't been passed to a
     * callback and clears the buffer from them.
     * 
     * @param string $tag The tag of the request to extract new responses for.
     * Specifying NULL with extract new responses for all requests.
     * 
     * @return ResponseCollection A collection of {@link Response} objects for
     * the specified request.
     * @see loop()
     */
    public function extractNewResponses($tag = null)
    {
        if (null === $tag) {
            $result = array();
            foreach (array_keys($this->responseBuffer) as $tag) {
                $result = array_merge(
                    $result, $this->extractNewResponses($tag)->toArray()
                );
            }
            return new ResponseCollection($result);
        } elseif ($this->isRequestActive($tag, self::FILTER_CALLBACK)) {
            return new ResponseCollection(array());
        } elseif ($this->isRequestActive($tag, self::FILTER_BUFFER)) {
            $result = $this->responseBuffer[$tag];
            if (!empty($result)) {
                if ($result[count($result) - 1]->getType()
                    === Response::TYPE_FINAL
                ) {
                    unset($this->responseBuffer[$tag]);
                } else {
                    $this->responseBuffer[$tag] = array();
                }
            }
            return new ResponseCollection($result);
        } else {
            throw new DataFlowException(
                'No such request, or the request has already finished.', 104
            );
        }
    }

    /**
     * Starts an event loop for the RouterOS callbacks.
     * 
     * Starts an event loop for the RouterOS callbacks and finishes when there
     * are no more pending requests or when a specified timeout has passed
     * (whichever comes first).
     * 
     * @param float $timeout Timeout for the loop. If 0, there is no time limit.
     * 
     * @return bool TRUE when there are any more pending requests, FALSE
     * otherwise.
     * @see extractNewResponses()
     * @see getPendingRequestsCount()
     */
    public function loop($timeout = 0)
    {
        if ($this->getPendingRequestsCount() !== 0) {
            $start = microtime(true);
            do {
                $this->dispatchNextResponse();
            } while (
            ((microtime(true) - $start) <= $timeout)
            || (0 === $timeout && $this->getPendingRequestsCount() !== 0)
            );
        }
        return $this->getPendingRequestsCount() !== 0;
    }

    /**
     * Gets the number of pending requests.
     * 
     * @return int The number of pending requests.
     * @see isRequestActive()
     */
    public function getPendingRequestsCount()
    {
        return $this->pendingRequestsCount;
    }

    /**
     * Cancels a request.
     * 
     * Cancels an active request. Using this function in favor of a plain call
     * to the "/cancel" command is highly reccomended, as it also updates the
     * counter of pending requests properly. Note that canceling a request also
     * removes any responses for it that were not previously extracted with
     * {@link extractNewResponses()}.
     * 
     * @param string $tag Tag of the request to cancel. Setting NULL will cancel
     * all requests.
     * 
     * @return Client The client object.
     * @see sendAsync()
     * @see close()
     */
    public function cancelRequest($tag = null)
    {
        $cancelRequest = new Request('/cancel');
        $tagIsNotNull = !(null === $tag);
        if ($tagIsNotNull) {
            if ($this->isRequestActive($tag)) {
                $cancelRequest->setArgument('tag', $tag);
            } else {
                throw new DataFlowException(
                    'No such request. Canceling aborted.', 105
                );
            }
        }
        $this->sendSync($cancelRequest);

        if ($tagIsNotNull) {
            if ($this->isRequestActive($tag, self::FILTER_BUFFER)) {
                unset($this->responseBuffer[$tag]);
            } elseif ($this->isRequestActive($tag, self::FILTER_CALLBACK)) {
                unset($this->callbacks[$tag]);
            }
            $this->pendingRequestsCount--;
        } else {
            $this->responseBuffer = array();
            $this->callbacks = array();
            $this->pendingRequestsCount = 0;
        }
        return $this;
    }

    /**
     * Sets response streaming setting.
     * 
     * Sets whether future responses are streamed. If responses are streamed,
     * the argument values are returned as streams instead of strings. This is
     * particularly useful if you expect a response that may contain one or more
     * very large words.
     * 
     * @param bool $streamResponses Whether to stream future responses.
     * 
     * @return bool The previous value of the setting.
     * @see getStreamResponses()
     */
    public function setStreamResponses($streamResponses)
    {
        $oldStreamResponses = $this->_streamResponses;
        $this->_streamResponses = (bool) $streamResponses;
        return $oldStreamResponses;
    }

    /**
     * Gets response streaming setting.
     * 
     * Gets whether future responses are streamed.
     * 
     * @return bool The value of the setting.
     * @see setStreamResponses()
     */
    public function getStreamResponses()
    {
        return $this->_streamResponses;
    }

    /**
     * Closes the opened connection, even if it is a persistent one.
     * 
     * Closes the opened connection, even if it is a persistent one. Note that
     * {@link extractNewResponses()} can still be used to extract responses
     * collected prior to the closing.
     * 
     * @return bool TRUE on success, FALSE on failure.
     */
    public function close()
    {
        $result = false;
        try {
            $response = $this->sendSync(new Request('/quit'));
            $result = $this->com->close()
                && $response->getType() === Response::TYPE_FATAL;
        } catch (SocketException $e) {
            $result = $e->getCode() === 205;
        }
        $this->callbacks = array();
        $this->pendingRequestsCount = 0;
        return $result;
    }

    /**
     * Sends a request to RouterOS.
     * 
     * @param Request $request The request to send.
     * 
     * @return Client The client object.
     * @see sendSync()
     * @see sendAsync()
     */
    protected function send(Request $request)
    {
        $request->send($this->com);
        $this->pendingRequestsCount++;
        return $this;
    }

    /**
     * Dispatches the next response in queue.
     * 
     * Dispatches the next response in queue, i.e. it executes the associated
     * callback if there is one, or places the response in the response buffer.
     * 
     * @return Response The dispatched response.
     */
    protected function dispatchNextResponse()
    {
        $response = new Response($this->com, $this->_streamResponses);
        if ($response->getType() === Response::TYPE_FATAL) {
            $this->pendingRequestsCount = 0;
            $this->com->close();
            return $response;
        }

        $tag = $response->getTag();
        $isLastForRequest = $response->getType() === Response::TYPE_FINAL;
        if ($isLastForRequest) {
            $this->pendingRequestsCount--;
        }

        if (null !== $tag) {
            if ($this->isRequestActive($tag, self::FILTER_CALLBACK)) {
                if ($this->callbacks[$tag]($response, $this)) {
                    $this->cancelRequest($tag);
                } elseif ($isLastForRequest) {
                    unset($this->callbacks[$tag]);
                }
            } else {
                $this->responseBuffer[$tag][] = $response;
            }
        }
        return $response;
    }

}
EOF