PEAR2_Net_RouterOSPEAR2_Net_RouterOS-1.0.0b5/scripts/roscon.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
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
<?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.3
 * 
 * @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.0b5
 * @link      http://pear2.php.net/PEAR2_Net_RouterOS
 */

/**
 * Used as a "catch all" for errors when connecting.
 */
use Exception as E;

/**
 * Used to register dependency paths, if needed.
 */
use PEAR2\Autoload;

/**
 * Used for coloring the output, if the "--colors" argument is specified.
 */
use PEAR2\Console\Color;

/**
 * Used for parsing the command line arguments.
 */
use PEAR2\Console\CommandLine;

/**
 * The whole application is around that.
 */
use PEAR2\Net\RouterOS;

/**
 * Used for error handling when connecting or receiving.
 */
use PEAR2\Net\Transmitter\SocketException as SE;

//Detect disallowed direct runs of either this file or "roscon".
if (PHP_SAPI !== 'cli') {
    $includedFiles = get_included_files();
    $rosconPos = array_search(
        dirname(__FILE__) . DIRECTORY_SEPARATOR . 'roscon',
        $includedFiles,
        true
    );
    if (false !== $rosconPos) {
        unset($includedFiles[$rosconPos]);
    }

    if (count($includedFiles) === 1) {
        header('Content-Type: text/plain;charset=UTF-8');
        echo <<<HEREDOC
For security reasons, this file can not be ran DIRECTLY, except from the
command line. It can be included however, even when not using the command line.
HEREDOC;
        return;
    }
}

//If there's no appropriate autoloader, add one
if (!class_exists('PEAR2\Net\RouterOS\Communicator', true)) {
    $cwd = getcwd();
    chdir(__DIR__);

    //The composer autoloader from this package.
    //Also matched if the bin-dir is changed to a folder that is directly
    //descended from the composer project root.
    $autoloader = stream_resolve_include_path('../vendor/autoload.php');
    if (false !== $autoloader) {
        include_once $autoloader;
    } else {
        //The composer autoloader, when this package is a dependency.
        $autoloader = stream_resolve_include_path(
            (false === ($vendorDir = getenv('COMPOSER_VENDOR_DIR'))
                ? '../../..'
                : $vendorDir) . '/autoload.php'
        );
        unset($vendorDir);
        if (false !== $autoloader) {
            include_once $autoloader;
        } else {
            //PEAR2_Autoload, most probably installed globally.
            $autoloader = stream_resolve_include_path('PEAR2/Autoload.php');
            if (false !== $autoloader) {
                include_once $autoloader;
                Autoload::initialize(
                    realpath('../src')
                );
                Autoload::initialize(
                    realpath('../../Net_Transmitter.git/src')
                );
                Autoload::initialize(
                    realpath('../../Console_Color.git/src')
                );
                Autoload::initialize(
                    realpath('../../Console_CommandLine.git/src')
                );
            } else {
                fwrite(
                    STDERR,
                    <<<HEREDOC
No recognized autoloader is available.
Please install this package with Pyrus, PEAR or Composer.
Alternatively, install PEAR2_Autoload, and/or add it to your include_path.
HEREDOC
                );
                chdir($cwd);
                exit(10);
            }
        }
    }

    chdir($cwd);
    unset($autoloader, $cwd);
}

// Locate the data dir, in preference as:
// 1. The PHP_PEAR_DATA_DIR environment variable, if available
// 2. The data folder at "mypear" (filled at install time by Pyrus/PEAR)
// 3. The source layout's data folder (also used when running in PHAR).
// NOTE: using dirname(__FILE__) instead of __DIR__ to elegantly support PHAR.
$dataDir = (false != ($pearDataDir = getenv('PHP_PEAR_DATA_DIR')))
    ? realpath($pearDataDir . '/pear2.php.net/PEAR2_Net_RouterOS')
    : false;
if (false === $dataDir) {
    $dataDir = realpath('@PEAR2_DATA_DIR@/pear2.php.net/PEAR2_Net_RouterOS')
        ?: (realpath('@PEAR2_DATA_DIR@/PEAR2_Net_RouterOS')
        ?: (is_dir(__DIR__ . '/../data')
        ? __DIR__ . '/../data'
        : false));
}

if (false === $dataDir) {
    fwrite(
        STDERR,
        'Unable to find data dir.'
    );
    exit(11);
}
$consoleDefFile = is_file($dataDir . '/roscon.xml')
    ? $dataDir . '/roscon.xml'
    : false;
if (false === $consoleDefFile) {
    fwrite(
        STDERR,
        <<<HEREDOC
The console definition file (roscon.xml) was not found at the data dir, which
was found to be at
{$dataDir}
HEREDOC
    );
    exit(12);
}

$cmdParser = CommandLine::fromXmlFile($consoleDefFile);
try {
    $cmd = $cmdParser->parse();
} catch (CommandLine\Exception $e) {
    fwrite(
        STDERR,
        'Error when parsing command line: ' . $e->getMessage() . "\n"
    );
    $cmdParser->displayUsage(13);
}

$comTimeout = null === $cmd->options['conTime']
    ? (null === $cmd->options['time']
            ? (int)ini_get('default_socket_timeout')
            : $cmd->options['time'])
    : $cmd->options['conTime'];
$cmd->options['time'] = $cmd->options['time'] ?: 3;
$comContext = null === $cmd->options['caPath']
    ? null
    : stream_context_create(
        is_file($cmd->options['caPath'])
        ? array(
            'ssl' => array(
                'verify_peer' => true,
                'cafile' => $cmd->options['caPath'])
          )
        : array(
            'ssl' => array(
                'verify_peer' => true,
                'capath' => $cmd->options['caPath'])
          )
    );

$cColors = array(
    'SEND' => '',
    'SENT' => '',
    'RECV' => '',
    'ERR'  => '',
    'NOTE' => '',
    ''     => ''
);
if ('auto' === $cmd->options['isColored']) {
    $cmd->options['isColored'] = ((strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN'
    || getenv('ANSICON_VER') != false)
    && class_exists('PEAR2\Console\Color', true)) ? 'yes' : 'no';
}
if ('yes' === $cmd->options['isColored']) {
    if (class_exists('PEAR2\Console\Color', true)) {
        $cColors['SEND'] = new Color(
            Color\Fonts::PURPLE
        );
        $cColors['SENT'] = clone $cColors['SEND'];
        $cColors['SENT']->setStyles(Color\Styles::UNDERLINE, true);
        $cColors['RECV'] = new Color(
            Color\Fonts::GREEN
        );
        $cColors['ERR'] = new Color(
            Color\Fonts::WHITE,
            Color\Backgrounds::RED
        );
        $cColors['NOTE'] = new Color(
            Color\Fonts::BLUE,
            Color\Backgrounds::YELLOW
        );
        $cColors[''] = new Color();

        foreach ($cColors as $mode => $color) {
            $cColors[$mode] = ((string)$color) . "\033[K";
        }
    } else {
        fwrite(
            STDERR,
            <<<HEREDOC
Warning: Color was forced, but PEAR2_Console_Color is not available.
         Resuming with colors disabled.
HEREDOC
        );
    }
}

try {
    $com = new RouterOS\Communicator(
        $cmd->args['hostname'],
        $cmd->options['portNum'],
        false,
        $comTimeout,
        '',
        (string)$cmd->options['crypto'],
        $comContext
    );
} catch (E $e) {
    fwrite(STDERR, "Error upon connecting: {$e->getMessage()}\n");
    $previous = $e->getPrevious();
    if ($previous instanceof SE) {
        fwrite(
            STDERR,
            "Details: ({$previous->getSocketErrorNumber()}) "
            . $previous->getSocketErrorMessage() . "\n\n"
        );
    }
    if ($e instanceof RouterOS\SocketException
        && $e->getCode() === RouterOS\SocketException::CODE_CONNECTION_FAIL
    ) {
        fwrite(
            STDERR,
            <<<HEREDOC
Possible reasons:

1. You haven't enabled the API service at RouterOS or you've enabled it on a
   different TCP port.
   Make sure that the "api" service at "/ip service" is enabled, and with that
   same TCP port (8728 by default or 8729 for "api-ssl").

2. You've mistyped the IP and/or port.
   Check the IP and port you've specified are the ones you intended.

3. Your web server's IP is not in the list of subnets allowed to use the API.
   Check the "address" property at "/ip service".
   If it's empty, that's not the problem for sure. If it's non-empty however,
   make sure your IP is in that list, or is at least matched as part of an
   otherwise larger subnet.

4. The router is not reachable from your web server for some reason.
   Try to reach the router (!!!)from the web server(!!!) by other means
   (e.g. Winbox, ping) using the same IP, and if you're unable to reach it,
   check the network settings on your server, router and any intermediate nodes
   under your control that may affect the connection.

5. Your web server is configured to forbid that outgoing connection.
   If you're the web server administrator, check your web server's firewall's
   settings. If you're on a hosting plan... Typically, shared hosts block all
   outgoing connections, but it's also possible that only connections to that
   port are blocked. Try to connect to a host on a popular port (21, 80, 443,
   etc.), and if successful, change the API service port to that port. If the
   connection fails even then, ask your host to configure their firewall so as
   to allow you to make outgoing connections to the ip:port you've set the API
   service on.

6. The router has a filter/mangle/nat rule that overrides the settings at
   "/ip service".
   This is a very rare scenario, but if you want to be sure, try to disable all
   rules that may cause such a thing, or (if you can afford it) set up a fresh
   RouterOS in place of the existing one, and see if you can connect to it
   instead. If you still can't connect, such a rule is certainly not the (only)
   reason.

HEREDOC
        );
    }
    return;
}
if (null !== $cmd->args['username']) {
    try {
        if (!RouterOS\Client::login(
            $com,
            $cmd->args['username'],
            (string)$cmd->args['password'],
            $comTimeout
        )) {
            fwrite(
                STDERR,
                <<<HEREDOC
Login refused. Possible reasons:

1. No such username.
   Make sure you have spelled it correctly.

2. The user does not have the "api" privilege.
   Check the permissions of the user's group at "/user group".

3. The user is not allowed to access the router from your web server's IP.
   Make sure your web server's IP address is within the subnets the user is
   allowed to log in from. You can check them at the "address" property
   of the user in the "/user" menu.

4. Mistyped password.
   Make sure you have spelled it correctly.
   If it contains spaces, don't forget to quote the whole password.
   If it contains non-ASCII characters, be careful of your locale.
   It must match that of the terminal you set your password on, or you must
   type the equivalent code points in your current locale, which may display as
   different characters.

HEREDOC
            );
            return;
        }
    } catch (RouterOS\SocketException $e) {
        fwrite(STDERR, "Error upon login: " . $e->getMessage());
        return;
    }
}

if ($cmd->options['verbose']) {
    $cSep = ' | ';
    $cColumns = array(
        'mode' => 4,
        'length' => 11,
        'encodedLength' => 12
    );
    $cColumns['contents'] = $cmd->options['size'] - 1//row length
            - array_sum($cColumns)
            - (3/*strlen($c_sep)*/ * count($cColumns));
    fwrite(
        STDOUT,
        implode(
            "\n",
            array(
                implode(
                    $cSep,
                    array(
                        str_pad(
                            'MODE',
                            $cColumns['mode'],
                            ' ',
                            STR_PAD_RIGHT
                        ),
                        str_pad(
                            'LENGTH',
                            $cColumns['length'],
                            ' ',
                            STR_PAD_BOTH
                        ),
                        str_pad(
                            'LENGTH',
                            $cColumns['encodedLength'],
                            ' ',
                            STR_PAD_BOTH
                        ),
                        ' CONTENTS'
                    )
                ),
                implode(
                    $cSep,
                    array(
                        str_repeat(' ', $cColumns['mode']),
                        str_pad(
                            '(decoded)',
                            $cColumns['length'],
                            ' ',
                            STR_PAD_BOTH
                        ),
                        str_pad(
                            '(encoded)',
                            $cColumns['encodedLength'],
                            ' ',
                            STR_PAD_BOTH
                        ),
                        ''
                    )
                ),
                implode(
                    '-|-',
                    array(
                        str_repeat('-', $cColumns['mode']),
                        str_repeat('-', $cColumns['length']),
                        str_repeat('-', $cColumns['encodedLength']),
                        str_repeat('-', $cColumns['contents'])
                    )
                )
            )
        ) . "\n"
    );

    $cRegexWrap = '/([^\n]{1,' . ($cColumns['contents']) . '})/sS';
    
    $printWord = function (
        $mode,
        $word,
        $msg = ''
    ) use (
        $cSep,
        $cColumns,
        $cRegexWrap,
        $cColors
    ) {
        $wordFragments = preg_split(
            $cRegexWrap,
            $word,
            null,
            PREG_SPLIT_DELIM_CAPTURE
        );
        for ($i = 0, $l = count($wordFragments); $i < $l; $i += 2) {
            unset($wordFragments[$i]);
        }
        if ('' !== $cColors['']) {
            $wordFragments = str_replace("\033", "\033[27@", $wordFragments);
        }

        $isAbnormal = 'ERR' === $mode || 'NOTE' === $mode;
        if ($isAbnormal) {
            $details = str_pad(
                $msg,
                $cColumns['length'] + $cColumns['encodedLength'] + 3,
                ' ',
                STR_PAD_BOTH
            );
        } else {
            $length = strlen($word);
            $lengthBytes = RouterOS\Communicator::encodeLength($length);
            $encodedLength = '';
            for ($i = 0, $l = strlen($lengthBytes); $i < $l; ++$i) {
                $encodedLength .= str_pad(
                    dechex(ord($lengthBytes[$i])),
                    2,
                    '0',
                    STR_PAD_LEFT
                );
            }

            $details = str_pad(
                $length,
                $cColumns['length'],
                ' ',
                STR_PAD_LEFT
            ) .
            $cSep .
            str_pad(
                '0x' . strtoupper($encodedLength),
                $cColumns['encodedLength'],
                ' ',
                STR_PAD_LEFT
            );
        }
        fwrite(
            STDOUT,
            $cColors[$mode] .
            str_pad($mode, $cColumns['mode'], ' ', STR_PAD_RIGHT) .
            $cColors[''] .
            "{$cSep}{$details}{$cSep}{$cColors[$mode]}" .
            implode(
                "\n{$cColors['']}" .
                str_repeat(' ', $cColumns['mode']) .
                $cSep .
                implode(
                    ($isAbnormal ? '   ' : $cSep),
                    array(
                        str_repeat(' ', $cColumns['length']),
                        str_repeat(' ', $cColumns['encodedLength'])
                    )
                ) . $cSep . $cColors[$mode],
                $wordFragments
            ) . "\n{$cColors['']}"
        );
    };
} else {
    $printWord = function ($mode, $word, $msg = '') use ($cColors) {
        if ('' !== $cColors['']) {
            $word = str_replace("\033", "\033[27@", $word);
            $msg = str_replace("\033", "\033[27@", $msg);
        }

        if ('ERR' === $mode || 'NOTE' === $mode) {
            fwrite(STDERR, "{$cColors[$mode]}-- {$msg}");
            if ('' !== $word) {
                fwrite(STDERR, ": {$word}");
            }
            fwrite(STDERR, "{$cColors['']}\n");
        } elseif ('SENT' !== $mode) {
            fwrite(STDOUT, "{$cColors[$mode]}{$word}{$cColors['']}\n");
        }
    };
}

//Input/Output cycle
while (true) {

    $prevWord = null;
    $word = '';
    $words = array();


    if (!$com->getTransmitter()->isAvailable()) {
        $printWord('NOTE', '', 'Connection terminated');
        break;
    }

    //Input cycle
    while (true) {
        if ($cmd->options['verbose']) {
            fwrite(
                STDOUT,
                implode(
                    $cSep,
                    array(
                        $cColors['SEND'] .
                        str_pad('SEND', $cColumns['mode'], ' ', STR_PAD_RIGHT)
                        . $cColors[''],
                        str_pad(
                            '<prompt>',
                            $cColumns['length'],
                            ' ',
                            STR_PAD_LEFT
                        ),
                        str_pad(
                            '<prompt>',
                            $cColumns['encodedLength'],
                            ' ',
                            STR_PAD_LEFT
                        ),
                        ''
                    )
                )
            );
        }

        fwrite(STDOUT, (string)$cColors['SEND']);

        if ($cmd->options['multiline']) {
            while (true) {
                $line = stream_get_line(STDIN, PHP_INT_MAX, PHP_EOL);
                if (chr(3) === $line) {
                    break;
                }
                if ((chr(3) . chr(3)) === $line) {
                    $word .= chr(3);
                } else {
                    $word .=  $line . PHP_EOL;
                }
                if ($cmd->options['verbose']) {
                    fwrite(
                        STDOUT,
                        "\n{$cColors['']}" .
                        implode(
                            $cSep,
                            array(
                                str_repeat(' ', $cColumns['mode']),
                                str_repeat(' ', $cColumns['length']),
                                str_repeat(' ', $cColumns['encodedLength']),
                                ''
                            )
                        )
                        . $cColors['SEND']
                    );
                }
            }
            if ('' !== $word) {
                $word = substr($word, 0, -strlen(PHP_EOL));
            }
        } else {
            $word = stream_get_line(STDIN, PHP_INT_MAX, PHP_EOL);
        }

        if ($cmd->options['verbose']) {
            fwrite(STDOUT, "\n");
        }
        fwrite(STDOUT, (string)$cColors['']);

        $words[] = $word;
        if ('w' === $cmd->options['commandMode']) {
            break;
        }
        if ('' === $word) {
            if ('s' === $cmd->options['commandMode']) {
                break;
            } elseif ('' === $prevWord) {//'e' === $cmd->options['commandMode']
                array_pop($words);
                break;
            }
        }
        $prevWord = $word;
        $word = '';
    }

    //Input flush
    foreach ($words as $word) {
        try {
            $com->sendWord($word);
            $printWord('SENT', $word);
        } catch (SE $e) {
            if (0 === $e->getFragment()) {
                $printWord('ERR', '', 'Failed to send word');
            } else {
                $printWord(
                    'ERR',
                    substr($word, 0, $e->getFragment()),
                    'Partial word sent'
                );
            }
        }
    }

    //Output cycle
    while (true) {
        if (!$com->getTransmitter()->isAvailable()) {
            break;
        }

        if (!$com->getTransmitter()->isDataAwaiting($cmd->options['time'])) {
            $printWord('NOTE', '', 'Receiving timed out');
            break;
        }

        try {
            $word = $com->getNextWord();
            $printWord('RECV', $word);

            if ('w' === $cmd->options['replyMode']
                || ('s' === $cmd->options['replyMode'] && '' === $word)
            ) {
                break;
            }
        } catch (SE $e) {
            if ('' === $e->getFragment()) {
                $printWord('ERR', '', 'Failed to receive word');
            } else {
                $printWord('ERR', $e->getFragment(), 'Partial word received');
            }
            break;
        } catch (RouterOS\NotSupportedException $e) {
            $printWord('ERR', $e->getValue(), 'Unsupported control byte');
            break;
        } catch (E $e) {
            $printWord('ERR', (string)$e, 'Unknown error');
            break;
        }
    }
}
EOF