В предыдущей статье мы рассмотрели способы добавления и редактирования параметров на вкладку Advanced Settings . В этой статье рассмотрим, как правильно обращаться к параметрам Advanced Settings из кода модуля. Делать мы это будем на примере доработки, которая упростит перевод записей в режим стерео в FreePBX. Также добавим обработчик переключателя, между использованием приложения Monitor и MixMonitor для записи разговоров (добавление самого переключателя описывается в предыдущей статье).

Подготовительный этап

Перед тем, как приступим к написанию кода, необходимого для работы нашего функционала, проведём ряд подготовительных мероприятий.

1) Создадим переключатель между приложениями Monitor и MixMonitor. Если Вы это уже делали, в рамках предыдущей статьи, то данный шаг можно пропустить и перейти к пункту 2. Если же нет, то необходимо выполнить в MySQL запрос:

INSERT INTO insert into freepbx_settings(keyword,value,name,description,type,options,defaultval,readonly,hidden,category,module,sortorder) values ('MIXMONITOR_USE',0,'Use MixMonitor','KEYWORD:MIXMONITOR_USE Setting true will use the MixMonitor application instead of Monitor so the concept of \'joining/mixing\' the in/out files now goes away when this is enabled.','bool','',1,0,0,'Call Recording','callrecording',0);

2) Создаём переключатель, позволяющий управлять стереорежимом записи разговоров. Для этого в MySQL выполняем следующий запрос:

insert into freepbx_settings(keyword,value,name,description,type,options,defaultval,readonly,hidden,category,module,sortorder) values ('STEREOMODE_USE',0,'Enable Stereo Mode','KEYWORD:STEREOMODE_USE Setting true will use the record in stereo mode.','bool','',0,0,0,'Call Recording','callrecording',0);

По итогу, после выполнения этих запросов, категория Call Recording на странице Advanced Settings должна выглядеть следующим образом:

Теперь, когда подготовка завершена, перейдём к редактированию скриптов.

Правки скриптов

Открываем в режиме редактирования файл …/admin/modules/callrecording/functions.inc.php.  Находим в нём функцию callrecording_get_config($engine). Здесь находим строку:

$context = 'ext-callrecording';

До неё вставляем следующий код:

$stereo_mode = FreePBX::Config()->get_conf_setting('STEREOMODE_USE');
$use_mixmonitor = FreePBX::Config()->get_conf_setting('MIXMONITOR_USE');
$path_to_sox = FreePBX::Config()->get_conf_setting('WHICH_sox');

Тем самым мы обеспечили считывание текущих настроек, указанных на вкладке Advanced Settings. В переменную $path_to_sox считываем значения параметра Path for sox. Оно нам потребуется в дальнейшем, при реализации стереорежима записи.

Теперь, в этой же функции находим строку:

$exten = 'recordcheck';

Это означает, что правки, внесённые ниже, будут относиться к экстеншену recordcheck, контекста sub-record-check. Находим вызов приложения MixMonitor, относящийся к данному экстеншену (должен быть немного ниже), по следующей строке:

$ext->add($context, $exten, '', new ext_mixmonitor('${MIXMON_DIR}${YEAR}/${MONTH}/${DAY}/${CALLFILENAME}.${MON_FMT}','abi(LOCAL_MIXMON_ID)${MIXMON_BEEP}','${MIXMON_POST}'));

Вместо этой строки вставляем следующий код:

$monitor_flag = '';
if ($stereo_mode) {
	$ext->add($context, $exten, '', new ext_set('MONITOR_EXEC',"$path_to_sox -M"));
	$monitor_flag = 'm';
}
if ($use_mixmonitor) {	
	$ext->add($context, $exten, '', new ext_mixmonitor('${MIXMON_DIR}${YEAR}/${MONTH}/${DAY}/${CALLFILENAME}.${MON_FMT}','abi(LOCAL_MIXMON_ID)${MIXMON_BEEP}','${MIXMON_POST}'));
}
else {
	$ext->add($context, $exten, '', new ext_monitor('${MIXMON_FORMAT}','${MIXMON_DIR}${YEAR}/${MONTH}/${DAY}/${CALLFILENAME}', $monitor_flag));
}

Кодом выше мы добавили использования стереорежима и использования приложения Monitor вместо MixMonitor.

Теперь необходимо провести такую же процедуру с экстеншеном recq, также описанным в данной функции. Находим строку:

$exten = 'recq';

По аналогии с предыдущей правкой, находим здесь вызов приложения MixMonitor:

$ext->add($context, $exten, '', new ext_mixmonitor('${MONITOR_FILENAME}.${MON_FMT}','${MONITOR_OPTIONS}${MIXMON_BEEP}','${MIXMON_POST}'));

И заменим эту строку на следующий код:

$monitor_flag = '';
if ($stereo_mode) {
	$ext->add($context, $exten, '', new ext_set('MONITOR_EXEC',"$path_to_sox -M"));
	$monitor_flag = 'm';
}
if ($use_mixmonitor) {
	$ext->add($context, $exten, '', new ext_mixmonitor('${MONITOR_FILENAME}.${MON_FMT}','${MONITOR_OPTIONS}${MIXMON_BEEP}','${MIXMON_POST}'));
}
else {
	$ext->add($context, $exten, '', new ext_monitor('${MIXMON_FORMAT}','${MIXMON_DIR}${YEAR}/${MONTH}/${DAY}/${CALLFILENAME}',$monitor_flag));
}

На этом редактирование данного файла завершено.

По умолчанию, в FreePBX 13 версии отсутствует ext_monitor, который мы использовали в своём коде. Необходимо его добавить. Для этого открываем в режиме редактирования файл …/admin/libraries/ extensions.class.php. Находим здесь описание класса ext_mixmonitor (достаточно воспользоваться поиском по названию). Сразу после завершения его описания добавим свой класс ext_monitor:

class ext_monitor extends extension {
	var $file;
	var $format;
	var $flags;

	function ext_monitor($format, $file, $flags = "") {
		$this->file = $file;
		$this->format = $format;
		$this->flags = $flags;
	}
	function output() {
		return "Monitor(".$this->format.",".$this->file.",".$this->flags.")";
	}
}

Таким образом, вызов ext_monitor осуществляется с тремя параметрами: расширение файла ($format), имя файла с указанием пути ($file) и необязательный параметр – указание флагов ($flags).

На этом редактирование кода завершено. Перейдём к его проверке.

Проверка работы кода

Для проверки работы кода обратимся к файлу extensions_additional.conf. При значении параметров в Advanced Settings: Enable Stereo Mode = No,Use MixMonitor = Yes, диалплан в контексте sub-record-check останется стандартным.

Теперь изменим значения параметров следующим образом: Enable Stereo Mode = Yes, Use MixMonitor = No. Применяем параметры, возвращаемся к файлу. Диалплан модернизируется следующим образом:

Также меняется диалплан в экстеншене recq.

Описание работы

Здесь приведу описание работы, в зависимости от значения параметров:

• Enable Stereo Mode = [Yes|No],Use MixMonitor = Yes – записывается один файл, используя стандартное приложение MixMonitor;
• Enable Stereo Mode = No,Use MixMonitor = No – записываются отдельно левое и правое плечи канала в два разных файла, используя приложение Monitor;
• Enable Stereo Mode = Yes,Use MixMonitor = No – записываются отдельно левое и правое плечи канала в два разных файла, используя приложение Monitor, после чего «склеиваются» приложением sox в один стереофайл.

На этом доработка по упрощению перевода записей в режим стерео завершена.