Добавление нового ключа в fwconsole, и создание fwconsole password.

В этой статье рассмотрим как добавляются новые ключи в утилиту fwconsole на примере простого вывода пароля от внутреннего номера (или группы внутренних номеров) в командной строке.

Утилита fwconsole позволяет из командной строки управлять некоторыми процессами FreePBX, к примеру перезагружать, применять конфигурационные файлы, включать/отключать транки. Более подробно о возможностях fwconsole можно прочесть в статье Использование fwconsole во FreePBX 13.

Но, к сожалению, список таких параметров ограничен. В этой статье рассмотрим, как можно расширить параметры своими функциями.

Правки кода

В этом разделе рассмотрим, какие правки в код FreePBX необходимо внести для добавления новых ключей в fwconsole.

Большинство основных ключей fwconsole описаны классами в каталоге …/admin/libraries/Console/.

Создадим здесь новый файл Pass.class.php и откроем его в режиме редактирования.

Перед объявлением класса необходимо прописать пространство имён и всё, что по-стандарту используется:

namespace FreePBX\Console\Command;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
Теперь переходим к описанию самого класса. В файл вставляем следующий код:
class Pass extends Command
{
…
}

Внутрь данного класса будем помещать методы и свойства.

Так как отображать пароли необходимо не только одного-двух внутренних номеров, но и целого диапазона, ограничим его ширину. Установим максимальную ширину одного диапазона — не более 1000 внутренних номеров. Для этого прописываем следующее свойство:

private $max_length_range = 1000;

Теперь объявим конфигурацию нашего ключа. Делается это следующим методом:

protected function configure()
{
    $this->FreePBXConf = \FreePBX::Config();
    $this->setName('pass')
    ->setAliases(array('password'))
    ->setDescription(_('Get secret of extensions'))
    ->setDefinition(array(
        new InputArgument('args', InputArgument::IS_ARRAY, null, null),));
}

Здесь, в параметре setName указываем имя ключа, по которому будем обращаться; в setAliases указываем возможные алиасы (удобные для запоминания) имена; в setDescription указываем описание работы fwconsole с этим ключом. Массивы аргументов оставляем по умолчанию.

Перейдём к описанию метода выполнения. Объявляется он стандартно для большинства классов ключей fwconsole:

protected function execute(InputInterface $input, OutputInterface $output)
{
…
}

В тело данного метода помещается код, описывающий работу ключа. В нашем случае, код следующий:

$args = $input->getArgument('args');
foreach ($args as $ext)
{
    if (strpos($ext, '-') !== false)
        $this->getPassByRange($ext, $output);
    else
    {
        $ext_info = \FreePBX::Core()->getDevice($ext);
        if (empty($ext_info['secret']))
            $ext_info['secret'] = 'Not found';
        $output->writeln($ext . ' : ' . $ext_info['secret']);
    }
}

Коротко рассмотрим код, описанный выше. Сперва, стандартным методом getArgument получаем список всех аргументов (внутренних номеров и диапазонов), пароль которых необходимо получить. Если данный аргумент является диапазоном, то вызываем метод getPassByRange (её описание рассмотрим ниже). Если данный аргумент является обычным внутренним номером, то вызываем метод getDevice модуля Core, с помощью которого получаем пароль.Его выводим в консоль с помощью метода writeln. Каждый такой вывод будет располагаться в отдельной строке.

Теперь рассмотрим функцию getPassByRange:

private function getPassByRange($range, $output)
{
    $range_list = explode('-', $range);
    if (empty($range_list[0]) || empty($range_list[1]))
    {
        $output->writeln($range . ' : Incorrect! Left or right part of range is empty');
        return true;
    }
    $begin = trim($range_list[0]);
    $end = trim($range_list[1]);
    if (!is_numeric($begin) || !is_numeric($end) || $begin > $end)
    {
        $output->writeln($range . ' : Incorrect range!');
        return true;
    }
    $length = $range_list[1] - $range_list[0];
    if ($length > $this->max_length_range)
    {
        $output->writeln($range . ' : exts counts more '. $this->max_length_range . '. If you really need this, please set another value for $max_length_range variable in file .../admin/libraries/Console/Pass.class.php');
        return true;
    }
    $i = $begin;
    while ($i <= $end)
    {
        $ext_info = \FreePBX::Core()->getDevice($i);
        if (empty($ext_info['secret']))
            $ext_info['secret'] = 'Not found';
        $output->writeln($i . ' : ' . $ext_info['secret']);
        $i = $this->customInc($i);
    }
}

Коротко рассмотрим описанный выше код. В массив $range_list помещаем левую и правую границы диапазона. Затем проверяем, что эти границы существуют и являются числовыми. Также проверяем, что размер диапазона не превышает максимально допустимого max_length_range, объявленного ранее.

Если все условия выполнены, то запускаем цикл от левой границы диапазона до правой с шагом 1, в котором получаем пароль с помощью метода getDevice и выводим его.

Для инкремента счётчика цикла используем кастомную функцию customInc:

private function customInc($i)
{
    $len = strlen($i);
    $i++;    
    while(strlen($i) < $len)
        $i = '0' . $i;
    return $i;
}

Она необходима для правильного инкремента внутренних номеров с ведущим нулём, к примеру: 0008, 0009. Ведь если увеличивать стандартной функцией inc, то получим: inc(0008) = 9, а номер 0009 и 9 вовсе не одно и то же для Asterisk.

На этом описание класса Pass.class.php завершено.

Теперь необходимо изменить владельца этого файла на пользователя asterisk. Делается это командой:

chown asterisk:asterisk Pass.class.php

из директории …/admin/libraries/Console/.

Можно переходить к тестированию функционала.

Выведем в консоль пароли внутренних номеров 101, 111, несуществующего номера 106 и диапазона номеров 0020-0022. Для этого воспользуемся командой:

fwconsole pass 101 111 116 0020-0022

Как видим из скриншота выше, получили запрашиваемые пароли. В случае с несуществующим номером 116 получаем сообщение “Not Found”.

На этом статья по добавлению нового ключа в fwconsole на примере создания нового ключа password завершена.