Workaround for sudden exceptions when the last command is /system/reboot;

Countable objects now implement the $mode argument;
Renamed changeMenu() to setMenu(), and added getMenu() for the purpose of chaneMenu() with an empty string;
Tweaked the VM settings, so that one arrives quicker at the copy&paste phase;
Moved the test callback into a separate file, thus making the tests no longer requiring allow_url_fopen;
CS and MD fixes (argument renames, mostly).

Author: boenrobot

.scrutinizer.yml

@@ -1,9 +1,14 @@
 imports:
     - php
 inherit: true
+before_commands:
+    - composer require pear2/net_transmitter:dev-develop
+    - composer require pear2/cache_shm:dev-develop
+    - composer require pear2/console_commandline
+    - composer require pear2/console_color
 tools:
     php_sim: false
     php_cpd: true
     php_code_sniffer:
         config:
-            standard: PEAR
+            standard: PEAR

RELEASE-1.0.0b5

@@ -4,17 +4,20 @@ Console and some overall improvements.
 * __BREAKING CHANGES:__
     - Removed Message::getAllArguments() in favor of IteratorAggregate implementation that returns an ArrayObject. For most intents and purposes, you should be able to just search&replace "->getAllArguments()" with an empty string (that will implicitly call getIterator()). If you require the arguments as a "real" array, you can replace "->getAllArguments()" with "->getIterator()->getArrayCopy()".
     - Message::\_\_invoke() without arguments is now a shortcut for getTag() instead of getting all arguments.
-    - Util::changeMenu() now returns the Util object itself, except when you supply an empty string, when the current menu is returned (as before).
+    - Util::changeMenu() is now renamed to Util::setMenu() and always returns the Util object itself.
 * New Util methods:
-    - getall()
-    - count()
+    - getMenu() (serves the same purpose as previously Util::changeMenu() with an emptry string)
+    - getAll()
+    - count() (implementation of Countable, reports the number of items at the current menu)
     - prepareScript()
-* Message now implements Countable, reporting the number of arguments.
+* Message now implements Countable, reporting the number of arguments (on COUNTER_NORMAL) or words (on COUNT_RECURSIVE).
 * Util::get() now uses RouterOS' "get" command, unless it returns an empty !done response (as it does for RouterOS versions prior to 6.0), in which case it automatically fallbacks to a print with a query.
 * Util::escapeValue() and Util::parseValue() now support associative arrays (introduced in RouterOS 6.2).
 * Util::escapeValue() now correctly converts DateTime objects to DateInterval objects relative to UNIX epoch time in UTC. Previously, the current time zone was used instead of UTC.
 * Util::add() and Util::set()/Util::edit() now support flags as values with a numeric key.
 * ResponseCollection can now be searched by argument values, if you first designate an argument name with the new ResponseCollection::setIndex() method.
 * ResponseCollection can now produce a sorted response collection based on user defined criteria using the new ResponseCollection::orderBy() method.
+* Util::find() now always returns a comma separated list when used without arguments (as opposed to ";" separated, in more recent RouterOS versions).
+* Response receiving now resets if an empty sentence is received, instead of throwing an exception.
 * Doc fixes (Notably: Clarified the acceptability of seekable streams as argument values, which has been present for a long time, but never documented).
 * CS fixes.

composer.json

@@ -21,11 +21,12 @@
     },
     "require-dev": {
         "phpunit/phpunit": "@stable",
-        "squizlabs/php_codesniffer": "@stable",
-        "scrutinizer/php-analyzer": "dev-master"
+        "squizlabs/php_codesniffer": "@stable"
     },
     "suggest": {
         "pear2/cache_shm": "Enables persistent connections.",
+        "pear2/console_commandline": "Enables the console",
+        "pear2/console_color": "Enables colors in the console",
         "ext-apc": "This or Wincache is required for persistent connections.",
         "ext-wincache": "This or APC is required for persistent connections. Reccomended instead of APC on Windows.",
         "ext-openssl": "Enables encrypted connections."

src/PEAR2/Net/RouterOS/Client.php

@@ -527,41 +527,41 @@ public function extractNewResponses($tag = null)
      * are no more pending requests or when a specified timeout has passed
      * (whichever comes first).
      * 
-     * @param int $timeout_s  Timeout for the loop. If NULL, there is no time
+     * @param int $timeoutS  Timeout for the loop. If NULL, there is no time
      *     limit.
-     * @param int $timeout_us Microseconds to add to the time limit.
+     * @param int $timeoutUs Microseconds to add to the time limit.
      * 
      * @return bool TRUE when there are any more pending requests, FALSE
      *     otherwise.
      * @see extractNewResponses()
      * @see getPendingRequestsCount()
      */
-    public function loop($timeout_s = null, $timeout_us = 0)
+    public function loop($timeoutS = null, $timeoutUs = 0)
     {
         try {
-            if (null === $timeout_s) {
+            if (null === $timeoutS) {
                 while ($this->getPendingRequestsCount() !== 0) {
                     $this->dispatchNextResponse(null);
                 }
             } else {
-                list($start_us, $start_s) = explode(' ', microtime());
+                list($startUs, $startS) = explode(' ', microtime());
                 while ($this->getPendingRequestsCount() !== 0
-                    && ($timeout_s >= 0 || $timeout_us >= 0)
+                    && ($timeoutS >= 0 || $timeoutUs >= 0)
                 ) {
-                    $this->dispatchNextResponse($timeout_s, $timeout_us);
-                    list($end_us, $end_s) = explode(' ', microtime());
-
-                    $timeout_s -= $end_s - $start_s;
-                    $timeout_us -= $end_us - $start_us;
-                    if ($timeout_us <= 0) {
-                        if ($timeout_s > 0) {
-                            $timeout_us = 1000000 + $timeout_us;
-                            $timeout_s--;
+                    $this->dispatchNextResponse($timeoutS, $timeoutUs);
+                    list($endUs, $endS) = explode(' ', microtime());
+
+                    $timeoutS -= $endS - $startS;
+                    $timeoutUs -= $endUs - $startUs;
+                    if ($timeoutUs <= 0) {
+                        if ($timeoutS > 0) {
+                            $timeoutUs = 1000000 + $timeoutUs;
+                            $timeoutS--;
                         }
                     }
 
-                    $start_s = $end_s;
-                    $start_us = $end_us;
+                    $startS = $endS;
+                    $startUs = $endUs;
                 }
             }
         } catch (SocketException $e) {
@@ -706,25 +706,34 @@ public function isStreamingResponses()
     public function close()
     {
         $result = true;
-        try {
-            if ($this->com->getTransmitter()->getCrypto() === N::CRYPTO_OFF) {
-                if (null !== $this->registry) {
-                    $this->registry->setTaglessMode(true);
-                }
+        /*
+         * The check below is done because for some unknown reason
+         * (either a PHP or a RouterOS bug) calling "/quit" on an encrypted
+         * connection makes one end hang.
+         * 
+         * Since encrypted connections only appeared in RouterOS 6.1, and
+         * the "/quit" call is needed for all <6.0 versions, problems due
+         * to its absence should be limited to some earlier 6.* versions
+         * on some RouterBOARD devices.
+         */
+        if ($this->com->getTransmitter()->getCrypto() === N::CRYPTO_OFF) {
+            if (null !== $this->registry) {
+                $this->registry->setTaglessMode(true);
+            }
+            try {
                 $response = $this->sendSync(new Request('/quit'));
-                if (null !== $this->registry) {
-                    $this->registry->setTaglessMode(false);
-                }
                 $result = $response[0]->getType() === Response::TYPE_FATAL;
+            } catch (SocketException $e) {
+                $result
+                    = $e->getCode() === SocketException::CODE_REQUEST_SEND_FAIL;
+            } catch (E $e) {
+                //Ignore unknown errors.
             }
-            $result = $result && $this->com->close();
-        } catch (SocketException $e) {
-            $result
-                = $e->getCode() === SocketException::CODE_UNACCEPTING_REQEUST;
             if (null !== $this->registry) {
                 $this->registry->setTaglessMode(false);
             }
         }
+        $result = $result && $this->com->close();
         $this->callbacks = array();
         $this->pendingRequestsCount = 0;
         return $result;
@@ -766,20 +775,20 @@ protected function send(Request $request)
      * 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.
      * 
-     * @param int $timeout_s  If a response is not immediatly available, wait
+     * @param int $timeoutS  If a response is not immediatly available, wait
      *     this many seconds. If NULL, wait indefinetly.
-     * @param int $timeout_us Microseconds to add to the waiting time.
+     * @param int $timeoutUs Microseconds to add to the waiting time.
      * 
      * @throws SocketException When there's no response within the time limit.
      * @return Response The dispatched response.
      */
-    protected function dispatchNextResponse($timeout_s = 0, $timeout_us = 0)
+    protected function dispatchNextResponse($timeoutS = 0, $timeoutUs = 0)
     {
         $response = new Response(
             $this->com,
             $this->_streamingResponses,
-            $timeout_s,
-            $timeout_us,
+            $timeoutS,
+            $timeoutUs,
             $this->registry
         );
         if ($response->getType() === Response::TYPE_FATAL) {

src/PEAR2/Net/RouterOS/Communicator.php

@@ -197,21 +197,21 @@ public static function isSeekableStream($var)
     /**
      * Uses iconv to convert a stream from one charset to another.
      * 
-     * @param string   $in_charset  The charset of the stream.
-     * @param string   $out_charset The desired resulting charset.
-     * @param resource $stream      The stream to convert.
+     * @param string   $inCharset  The charset of the stream.
+     * @param string   $outCharset The desired resulting charset.
+     * @param resource $stream     The stream to convert.
      * 
      * @return resource A new stream that uses the $out_charset. The stream is a
      *     subset from the original stream, from its current position to its
      *     end.
      */
-    public static function iconvStream($in_charset, $out_charset, $stream)
+    public static function iconvStream($inCharset, $outCharset, $stream)
     {
         $bytes = 0;
         $result = fopen('php://temp', 'r+b');
         $iconvFilter = stream_filter_append(
             $result,
-            'convert.iconv.' . $in_charset . '.' . $out_charset,
+            'convert.iconv.' . $inCharset . '.' . $outCharset,
             STREAM_FILTER_WRITE
         );
 

src/PEAR2/Net/RouterOS/Message.php

@@ -66,10 +66,10 @@ abstract class Message implements IteratorAggregate, Countable
      * the class is invoked and its returned value is returned by this function.
      * 
      * @param string $name The name of an argument to get the value of, or NULL
-     *     to get all arguments as an array.
+     *     to get the tag.
      * 
-     * @return string|array The value of the specified argument, or an array of
-     *     all arguments if NULL is provided.
+     * @return string|resource The value of the specified argument,
+     *     or the tag if NULL is provided.
      */
     public function __invoke($name = null)
     {
@@ -178,11 +178,20 @@ public function getIterator()
     /**
      * Counts the number of arguments.
      * 
-     * @return int The number of arguments.
+     * @param int $mode The counter mode.
+     *     Either COUNT_NORMAL or COUNT_RECURSIVE.
+     *     When in normal mode, counts the number of arguments.
+     *     When in recursive mode, counts the number of API words.
+     * 
+     * @return int The number of arguments/words.
      */
-    public function count()
+    public function count($mode = COUNT_NORMAL)
     {
-        return count($this->arguments);
+        $result = count($this->arguments);
+        if ($mode !== COUNT_NORMAL) {
+            $result += 2/*first+last word*/ + (int)(string)$this->getTag();
+        }
+        return $result;
     }
 
     /**

src/PEAR2/Net/RouterOS/Query.php

@@ -213,7 +213,7 @@ private function _send(Communicator $com)
         if (!$com->getTransmitter()->isAcceptingData()) {
             throw new SocketException(
                 'Transmitter is invalid. Sending aborted.',
-                SocketException::CODE_UNACCEPTING_QUERY
+                SocketException::CODE_QUERY_SEND_FAIL
             );
         }
         $bytes = 0;

src/PEAR2/Net/RouterOS/Request.php

@@ -62,7 +62,7 @@ class Request extends Message
      */
     public function __construct($command, Query $query = null, $tag = null)
     {
-        if (false !== ($firstEquals = strpos($command, '='))
+        if (false !== strpos($command, '=')
             && false !== ($spaceBeforeEquals = strrpos(
                 strstr($command, '=', true),
                 ' '
@@ -83,13 +83,14 @@ public function __construct($command, Query $query = null, $tag = null)
      * 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 A {@link Query} to associate the request
-     *     with, a {@link Communicator} to send the request over, an argument to
-     *     get the value of, or NULL to get all arguments as an array. If a
+     * @param Query|Communicator|string|null $arg A {@link Query} to associate
+     *     the request with, a {@link Communicator} to send the request over,
+     *     an argument to get the value of, or NULL to get the tag. If a
      *     second argument is provided, this becomes the name of the argument to
      *     set the value of, and the second argument is the value to set.
      * 
-     * @return mixed Whatever the long form function would have returned.
+     * @return string|resource|int|$this Whatever the long form
+     *     function returns.
      */
     public function __invoke($arg = null)
     {
@@ -291,7 +292,7 @@ private function _send(Communicator $com)
         if (!$com->getTransmitter()->isAcceptingData()) {
             throw new SocketException(
                 'Transmitter is invalid. Sending aborted.',
-                SocketException::CODE_UNACCEPTING_REQEUST
+                SocketException::CODE_REQUEST_SEND_FAIL
             );
         }
         $bytes = 0;