SIPConf::generateProvidersPj() - Code Metrics - Inspection of "Merge pull request #20 from mikopbx/develop" - mikopbx/Core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 384de0...a2c24b )

by Nikolay
created 2020-11-05 18:23 UTC
SIPConf::generateProvidersPj() F

↳ Parent: SIPConf
Complexity

Conditions	16
Paths	8194
Size

Total Lines	123
Code Lines	95
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
eloc	95
c	2
b	0
f	0
dl	0
loc	123
rs	1.229
cc	16
nc	8194
nop	0
How to fix Long Method Complexity

<?php
/*
 * Copyright © MIKO LLC - All Rights Reserved
 * Unauthorized copying of this file, via any medium is strictly prohibited
 * Proprietary and confidential
 * Written by Alexey Portnov, 10 2020
 */

namespace MikoPBX\Core\Asterisk\Configs;

use MikoPBX\Common\Models\{Codecs,
    ExtensionForwardingRights,
    Extensions as ExtensionsModel,
    NetworkFilters,
    OutgoingRoutingTable,
    PbxSettings,
    Sip,
    Users};
use MikoPBX\Core\Asterisk\AstDB;
use MikoPBX\Modules\Config\ConfigClass;
use MikoPBX\Core\System\{MikoPBXConfig, Network, Util};
use MikoPBX\Core\Utilities\SubnetCalculator;
use Phalcon\Di;

class SIPConf extends ConfigClass
{
    public const TYPE_PJSIP = 'PJSIP';

    protected $data_peers;
    protected $data_providers;
    protected $data_rout;
    protected string $technology;
    protected array  $contexts_data;

    protected string $description = 'pjsip.conf';

    /**
     *
     * @return array
     */
    public function dependenceModels(): array
    {
        return [Sip::class, Users::class];
    }

    /**
     * Генератор sip.conf
     *
     * @return bool|void
     */
    protected function generateConfigProtected(): void
    {
        $conf = '';
        $conf .= $this->generateGeneralPj();
        $conf .= $this->generateProvidersPj();
        $conf .= $this->generatePeersPj();

        Util::fileWriteContent($this->config->path('asterisk.astetcdir') . '/pjsip.conf', $conf);
        $pjConf = '[log_mappings]'."\n".
            'type=log_mappings'."\n".
            'asterisk_error = 0'."\n".
            'asterisk_warning = 2'."\n".
            'asterisk_debug = 1,3,4,5,6'."\n\n";

        file_put_contents($this->config->path('asterisk.astetcdir') . '/pjproject.conf', $pjConf);
        file_put_contents($this->config->path('asterisk.astetcdir') . '/sorcery.conf', '');

        $db = new AstDB();
        foreach ($this->data_peers as $peer) {
            // Помещаем в AstDB сведения по маршуртизации.
            $ringlength = ($peer['ringlength'] == 0) ? '' : trim($peer['ringlength']);
            $db->databasePut('FW_TIME', "{$peer['extension']}", $ringlength);
            $db->databasePut('FW', "{$peer['extension']}", trim($peer['forwarding']));
            $db->databasePut('FW_BUSY', "{$peer['extension']}", trim($peer['forwardingonbusy']));
            $db->databasePut('FW_UNAV', "{$peer['extension']}", trim($peer['forwardingonunavailable']));
        }
    }

    /**
     * Генератора секции general pjsip.conf
     *
     *
     * @return string
     */
    private function generateGeneralPj(): string
    {
        $lang    = $this->generalSettings['PBXLanguage'];
        [$topology, $extipaddr, $exthostname, $subnets] = $this->getTopologyData();

        $codecs = $this->getCodecs();
        $codecConf = '';
        foreach ($codecs as $codec){
            $codecConf.= "allow = {$codec}\n";
        }

        $pbxVersion = PbxSettings::getValueByKey('PBXVersion');
        $natConf = '';
        if ($topology === 'private') {
            foreach ($subnets as $net) {
                $natConf .= "local_net={$net}\n";
            }
            if ( ! empty($exthostname)) {
                $parts = explode(':', $exthostname);
                $natConf  .= 'external_media_address=' . $parts[0] . "\n";
                $natConf  .= 'external_signaling_address=' . $parts[0] . "\n";
                $natConf  .= 'external_signaling_port=' . ($parts[1] ?? '5060');
            } elseif ( ! empty($extipaddr)) {
                $parts = explode(':', $extipaddr);
                $natConf  .= 'external_media_address=' . $parts[0] . "\n";
                $natConf  .= 'external_signaling_address=' . $parts[0] . "\n";
                $natConf  .= 'external_signaling_port=' . ($parts[1] ?? '5060');
            }
        }

        $conf = "[general] \n" .
            "disable_multi_domain=on\n" .
            "transport = udp \n\n" .

            "[global] \n" .
            "type = global\n" .
            "endpoint_identifier_order=username,ip,anonymous\n" .
            "user_agent = mikopbx-{$pbxVersion}\n\n" .

            "[anonymous]\n" .
            "type = endpoint\n" .
            $codecConf.
            "language={$lang}\n".
            "timers = no\n" .
            "context = public-direct-dial\n\n".

            "[transport-udp]\n" .
            "type = transport\n" .
            "protocol = udp\n" .
            "bind=0.0.0.0:{$this->generalSettings['SIPPort']}\n".
            "{$natConf}\n\n".

            "[transport-tcp]\n" .
            "type = transport\n" .
            "protocol = tcp\n" .
            "bind=0.0.0.0:{$this->generalSettings['SIPPort']}\n".
            "{$natConf}\n\n".
            '';

        $varEtcDir = $this->config->path('core.varEtcDir');
        file_put_contents($varEtcDir . '/topology_hash', md5($topology . $exthostname . $extipaddr. $this->generalSettings['SIPPort']));
        $conf .= "\n";

        return $conf;
    }

    /**
     * Проверка ключевых параметров.
     * Если параметры изменены, то необходим рестарт Asterisk процесса.
     * @return bool
     */
    public function needAsteriskRestart():bool{
        $di     = Di::getDefault();
        if ($di === null) {
            return false;
        }
        $mikoPBXConfig  = new MikoPBXConfig();
        [$topology, $extipaddr, $exthostname] = $this->getTopologyData();

        $generalSettings = $mikoPBXConfig->getGeneralSettings();
        $now_hadh = md5($topology . $exthostname . $extipaddr. $generalSettings['SIPPort']);
        $old_hash   = '';
        $varEtcDir = $di->getShared('config')->path('core.varEtcDir');
        if (file_exists($varEtcDir . '/topology_hash')) {
            $old_hash = file_get_contents($varEtcDir . '/topology_hash');
        }

        return $old_hash !== $now_hadh;
    }

    /**
     * @return array
     */
    private function getTopologyData():array{
        $network = new Network();

        $topology    = 'public';
        $extipaddr   = '';
        $exthostname = '';
        $networks    = $network->getEnabledLanInterfaces();
        $subnets     = [];
        foreach ($networks as $if_data) {
            $lan_config = $network->getInterface($if_data['interface']);
            if (empty($lan_config['ipaddr']) || empty($lan_config['subnet'])) {
                continue;
            }
            $sub = new SubnetCalculator($lan_config['ipaddr'], $lan_config['subnet']);
            $net = $sub->getNetworkPortion() . '/' . $lan_config['subnet'];
            if ($if_data['topology'] === 'private' && in_array($net, $subnets, true) === false) {
                $subnets[] = $net;
            }
            if (trim($if_data['internet']) === '1') {
                $topology    = trim($if_data['topology']);
                $extipaddr   = trim($if_data['extipaddr']);
                $exthostname = trim($if_data['exthostname']);
            }
        }

        $networks = NetworkFilters::find('local_network=1');
        foreach ($networks as $net) {
            if (in_array($net->permit, $subnets, true) === false) {
                $subnets[] = $net->permit;
            }
        }

        return array(
            $topology,
            $extipaddr,
            $exthostname,
            $subnets,
        );

    }

    /**
     * Генератор секции провайдеров в sip.conf
     *
     *
     * @return string
     */
    private function generateProvidersPj(): string
    {
        $conf        = '';
        $reg_strings = '';
        $prov_config = '';
        if ($this->data_providers===null){
            $this->getSettings();
        }
        foreach ($this->data_providers as $provider) {
            $manual_attributes = Util::parseIniSettings(base64_decode($provider['manualattributes'] ?? ''));
            $port              = (trim($provider['port']) === '') ? '5060' : $provider['port'];

            $need_register = $provider['noregister'] !== '1';
            if ($need_register) {
                $options     = [
                    'type'     => 'auth',
                    'username' => $provider['username'],
                    'password' => $provider['secret'],
                ];
                $reg_strings .= "[REG-AUTH-{$provider['uniqid']}]\n";
                $reg_strings .= Util::overrideConfigurationArray($options, $manual_attributes, 'registration-auth');

                $options     = [
                    'type'                        => 'registration',
                    // 'transport'                   => 'transport-udp',
                    'outbound_auth'               => "REG-AUTH-{$provider['uniqid']}",
                    'contact_user'                => $provider['username'],
                    'retry_interval'              => '30',
                    'max_retries'                 => '100',
                    'forbidden_retry_interval'    => '300',
                    'fatal_retry_interval'        => '300',
                    'expiration'                  => $this->generalSettings['SIPDefaultExpiry'],
                    'server_uri'                  => "sip:{$provider['host']}:{$port}",
                    'client_uri'                  => "sip:{$provider['username']}@{$provider['host']}:{$port}",
                ];
                $reg_strings .= "[REG-{$provider['uniqid']}] \n";
                $reg_strings .= Util::overrideConfigurationArray($options, $manual_attributes, 'registration');
            }

            if ('1' !== $provider['receive_calls_without_auth']) {
                $options     = [
                    'type'     => 'auth',
                    'username' => $provider['username'],
                    'password' => $provider['secret'],
                ];
                $prov_config .= "[{$provider['uniqid']}-OUT]\n";
                $prov_config .= Util::overrideConfigurationArray($options, $manual_attributes, 'endpoint-auth');
            }

            $defaultuser = (trim($provider['defaultuser']) === '') ? $provider['username'] : $provider['defaultuser'];
            if ( ! empty($defaultuser) && '1' !== $provider['receive_calls_without_auth']) {
                $contact = "sip:$defaultuser@{$provider['host']}:{$port}";
            } else {
                $contact = "sip:{$provider['host']}:{$port}";
            }

            $options     = [
                'type'               => 'aor',
                'max_contacts'       => '1',
                'contact'            => $contact,
                'maximum_expiration' => $this->generalSettings['SIPMaxExpiry'],
                'minimum_expiration' => $this->generalSettings['SIPMinExpiry'],
                'default_expiration' => $this->generalSettings['SIPDefaultExpiry'],
            ];
            if($provider['qualify'] === '1'){
                $options['qualify_frequency'] = $provider['qualifyfreq'];
                $options['qualify_timeout']   = '3.0';
            }

            $prov_config .= "[{$provider['uniqid']}]\n";
            $prov_config .= Util::overrideConfigurationArray($options, $manual_attributes, 'aor');

            $options     = [
                'type'     => 'identify',
                'endpoint' => $provider['uniqid'],
                'match'    => $provider['host'],
            ];
            $prov_config .= "[{$provider['uniqid']}]\n";
            $prov_config .= Util::overrideConfigurationArray($options, $manual_attributes, 'identify');

            $fromdomain = (trim($provider['fromdomain']) === '') ? $provider['host'] : $provider['fromdomain'];
            $from       = (trim(
                    $provider['fromuser']
                ) === '') ? "{$provider['username']}; username" : "{$provider['fromuser']}; fromuser";
            $from_user  = ($provider['disablefromuser'] === '1') ? null : $from;
            $lang       = $this->generalSettings['PBXLanguage'];

            if (count($this->contexts_data[$provider['context_id']]) === 1) {
                $context_id = $provider['uniqid'];
            } else {
                $context_id = $provider['context_id'];
            }
            $dtmfmode = ($provider['dtmfmode'] === 'rfc2833') ? 'rfc4733' : $provider['dtmfmode'];
            $options  = [
                'type'            => 'endpoint',
                '100rel'          => "no",
                'context'         => "{$context_id}-incoming",
                'dtmf_mode'       => $dtmfmode,
                'disallow'        => 'all',
                'allow'           => $provider['codecs'],
                'rtp_symmetric'   => 'yes',
                'force_rport'     => 'yes',
                'rewrite_contact' => 'yes',
                'ice_support'     => 'no',
                'direct_media'    => 'no',
                'from_user'       => $from_user,
                'from_domain'     => $fromdomain,
                'sdp_session'     => 'mikopbx',
                'language'        => $lang,
                'aors'            => $provider['uniqid'],
                'timers'          => ' no',
            ];
            if ('1' !== $provider['receive_calls_without_auth']) {
                $options['outbound_auth'] = "{$provider['uniqid']}-OUT";
            }
            $prov_config .= "[{$provider['uniqid']}]\n";
            $prov_config .= Util::overrideConfigurationArray($options, $manual_attributes, 'endpoint');
        }

        $conf .= $reg_strings;
        $conf .= $prov_config;

        return $conf;
    }

    /**
     * Генератор сеции пиров для sip.conf
     *
     *
     * @return string
     */
    public function generatePeersPj(): string
    {
        if ($this->data_peers===null){
            $this->getSettings();
        }
        $lang              = $this->generalSettings['PBXLanguage'];
        $additionalModules = $this->di->getShared('pbxConfModules');
        $conf              = '';

        foreach ($this->data_peers as $peer) {
            $manual_attributes = Util::parseIniSettings($peer['manualattributes'] ?? '');

            $language = str_replace('_', '-', strtolower($lang));
            $language = (trim($language) === '') ? 'en-en' : $language;

            $calleridname = (trim($peer['calleridname']) === '') ? $peer['extension'] : $peer['calleridname'];
            $busylevel    = (trim($peer['busylevel']) === '') ? '1' : '' . $peer['busylevel'];

            $options = [
                'type'     => 'auth',
                'username' => $peer['extension'],
                'password' => $peer['secret'],
            ];
            $conf    .= "[{$peer['extension']}] \n";
            $conf    .= Util::overrideConfigurationArray($options, $manual_attributes, 'auth');

            $options = [
                'type'              => 'aor',
                'qualify_frequency' => '60',
                'qualify_timeout'   => '5',
                'max_contacts'      => '5',
            ];
            $conf    .= "[{$peer['extension']}] \n";
            $conf    .= Util::overrideConfigurationArray($options, $manual_attributes, 'aor');

            $dtmfmode = ($peer['dtmfmode'] === 'rfc2833') ? 'rfc4733' : $peer['dtmfmode'];
            $options  = [
                'type'                 => 'endpoint',
                // 'transport'            => 'transport-udp',
                'context'              => 'all_peers',
                'dtmf_mode'            => $dtmfmode,
                'disallow'             => 'all',
                'allow'                => $peer['codecs'],
                'rtp_symmetric'        => 'yes',
                'force_rport'          => 'yes',
                'rewrite_contact'      => 'yes',
                'ice_support'          => 'no',
                'direct_media'         => 'no',
                'callerid'             => "{$calleridname} <{$peer['extension']}>",
                // 'webrtc'   => 'yes',
                'send_pai'             => 'yes',
                'call_group'           => '1',
                'pickup_group'         => '1',
                'sdp_session'          => 'mikopbx',
                'language'             => $language,
                'mailboxes'            => 'admin@voicemailcontext',
                'device_state_busy_at' => $busylevel,
                'aors'                 => $peer['extension'],
                'auth'                 => $peer['extension'],
                'outbound_auth'        => $peer['extension'],
                'acl'                  => "acl_{$peer['extension']}",
                'timers'               => ' no',
            ];
            // ---------------- //
            $conf .= "[{$peer['extension']}] \n";
            $conf .= Util::overrideConfigurationArray($options, $manual_attributes, 'endpoint');

            foreach ($additionalModules as $Object) {
                $conf .= $Object->generatePeerPjAdditionalOptions($peer);
            }
        }

        foreach ($additionalModules as $Object) {
            // Prevent cycling, skip current class
            if (is_a($Object, __CLASS__)) {
                continue;
            }
            $conf .= $Object->generatePeersPj();
        }

        return $conf;
    }

    /**
     * Получение настроек.
     */
    public function getSettings(): void
    {
        $this->contexts_data  = [];
        // Настройки для текущего класса.
        $this->data_peers     = $this->getPeers();
        $this->data_providers = $this->getProviders();
        $this->data_rout      = $this->getOutRoutes();
        $this->technology     = self::getTechnology();
    }

    /**
     * Получение данных по SIP пирам.
     *
     * @return array
     */
    private function getPeers(): array
    {
        /** @var \MikoPBX\Common\Models\NetworkFilters $network_filter */
        /** @var \MikoPBX\Common\Models\Sip $sip_peer */
        /** @var \MikoPBX\Common\Models\Extensions $extension */
        /** @var \MikoPBX\Common\Models\Users $user */
        /** @var \MikoPBX\Common\Models\ExtensionForwardingRights $extensionForwarding */

        $data    = [];
        $db_data = Sip::find("type = 'peer' AND ( disabled <> '1')");
        foreach ($db_data as $sip_peer) {
            $arr_data       = $sip_peer->toArray();
            $network_filter = null;
            if (null != $sip_peer->networkfilterid) {
                $network_filter = NetworkFilters::findFirst($sip_peer->networkfilterid);
            }
            $arr_data['permit'] = ($network_filter === null) ? '' : $network_filter->permit;
            $arr_data['deny']   = ($network_filter === null) ? '' : $network_filter->deny;

            // Получим используемые кодеки.
            $arr_data['codecs'] = $this->getCodecs();

            // Имя сотрудника.
            $extension = ExtensionsModel::findFirst("number = '{$sip_peer->extension}'");
            if (null === $extension) {
                $arr_data['publicaccess'] = false;
                $arr_data['language']     = '';
                $arr_data['calleridname'] = $sip_peer->extension;
            } else {
                $arr_data['publicaccess'] = $extension->public_access;
                $arr_data['calleridname'] = $extension->callerid;
                $user                     = Users::findFirst($extension->userid);
                if (null !== $user) {
                    $arr_data['language'] = $user->language;
                    $arr_data['user_id']  = $user->id;
                }
            }
            $extensionForwarding = ExtensionForwardingRights::findFirst("extension = '{$sip_peer->extension}'");
            if (null === $extensionForwarding) {
                $arr_data['ringlength']              = '';
                $arr_data['forwarding']              = '';
                $arr_data['forwardingonbusy']        = '';
                $arr_data['forwardingonunavailable'] = '';
            } else {
                $arr_data['ringlength']              = $extensionForwarding->ringlength;
                $arr_data['forwarding']              = $extensionForwarding->forwarding;
                $arr_data['forwardingonbusy']        = $extensionForwarding->forwardingonbusy;
                $arr_data['forwardingonunavailable'] = $extensionForwarding->forwardingonunavailable;
            }
            $data[] = $arr_data;
        }

        return $data;
    }

    /**
     * Возвращает доступные пиру кодеки.
     *
     * @return array
     */
    private function getCodecs(): array
    {
        $arr_codecs = [];
        $filter     = [
            'conditions'=>'disabled="0"',
            'order' => 'type, priority',
        ];
        $codecs     = Codecs::find($filter);
        foreach ($codecs as $codec_data) {
            $arr_codecs[] = $codec_data->name;
        }

        return $arr_codecs;
    }

    /**
     * Получение данных по SIP провайдерам.
     *
     * @return array
     */
    private function getProviders(): array
    {
        /** @var \MikoPBX\Common\Models\Sip $sip_peer */
        /** @var \MikoPBX\Common\Models\NetworkFilters $network_filter */
        // Получим настройки всех аккаунтов.
        $data    = [];
        $db_data = Sip::find("type = 'friend' AND ( disabled <> '1')");
        foreach ($db_data as $sip_peer) {
            $arr_data                               = $sip_peer->toArray();
            $arr_data['receive_calls_without_auth'] = $sip_peer->receive_calls_without_auth;
            $network_filter                         = NetworkFilters::findFirst($sip_peer->networkfilterid);
            $arr_data['permit']                     = ($network_filter === null) ? '' : $network_filter->permit;
            $arr_data['deny']                       = ($network_filter === null) ? '' : $network_filter->deny;

            // Получим используемые кодеки.
            $arr_data['codecs'] = $this->getCodecs();

            $context_id = preg_replace("/[^a-z\d]/iu", '', $sip_peer->host . $sip_peer->port);
            if ( ! isset($this->contexts_data[$context_id])) {
                $this->contexts_data[$context_id] = [];
            }
            $this->contexts_data[$context_id][$sip_peer->uniqid] = $sip_peer->username;

            $arr_data['context_id'] = $context_id;
            $data[]                 = $arr_data;
        }

        return $data;
    }

    /**
     * Генератор исходящих контекстов для пиров.
     *
     * @return array
     */
    private function getOutRoutes(): array
    {
        if ($this->data_peers===null){
            $this->getSettings();
        }
        /** @var \MikoPBX\Common\Models\OutgoingRoutingTable $rout */
        /** @var \MikoPBX\Common\Models\OutgoingRoutingTable $routs */
        /** @var \MikoPBX\Common\Models\Sip $db_data */
        /** @var \MikoPBX\Common\Models\Sip $sip_peer */

        $data    = [];
        $routs   = OutgoingRoutingTable::find(['order' => 'priority']);
        $db_data = Sip::find("type = 'friend' AND ( disabled <> '1')");
        foreach ($routs as $rout) {
            foreach ($db_data as $sip_peer) {
                if ($sip_peer->uniqid !== $rout->providerid) {
                    continue;
                }
                $arr_data                = $rout->toArray();
                $arr_data['description'] = $sip_peer->description;
                $arr_data['uniqid']      = $sip_peer->uniqid;
                $data[]                  = $arr_data;
            }
        }

        return $data;
    }



    /**
     * Генератор extension для контекста peers.
     *
     * @return string
     */
    public function extensionGenContexts(): string
    {
        if ($this->data_peers===null){
            $this->getSettings();
        }
        // Генерация внутреннего номерного плана.
        $conf = '';

        foreach ($this->data_peers as $peer) {
            $conf .= "[peer_{$peer['extension']}] \n";
            $conf .= "include => internal \n";
            $conf .= "include => outgoing \n";
        }

        $contexts = [];
        // Входящие контексты.
        foreach ($this->data_providers as $provider) {
            $contexts_data = $this->contexts_data[$provider['context_id']];
            if (count($contexts_data) === 1) {
                $conf .= ExtensionsConf::generateIncomingContextPeers($provider['uniqid'], $provider['username'], '');
            } elseif ( ! in_array($provider['context_id'], $contexts, true)) {
                $conf       .= ExtensionsConf::generateIncomingContextPeers(
                    $contexts_data,
                    null,
                    $provider['context_id']
                );
                $contexts[] = $provider['context_id'];
            }
        }

        return $conf;
    }

    /**
     * Генерация хинтов.
     *
     * @return string
     */
    public function extensionGenHints(): string
    {
        if ($this->data_peers===null){
            $this->getSettings();
        }
        $conf = '';
        foreach ($this->data_peers as $peer) {
            $conf .= "exten => {$peer['extension']},hint,{$this->technology}/{$peer['extension']} \n";
        }

        return $conf;
    }

    public function extensionGenInternal(): string
    {
        if ($this->data_peers===null){
            $this->getSettings();
        }
        // Генерация внутреннего номерного плана.
        $conf = '';
        foreach ($this->data_peers as $peer) {
            $conf .= "exten => {$peer['extension']},1,Goto(internal-users,{$peer['extension']},1) \n";
        }
        $conf .= "\n";

        return $conf;
    }

    public function extensionGenInternalTransfer(): string
    {
        if ($this->data_peers===null){
            $this->getSettings();
        }
        // Генерация внутреннего номерного плана.
        $conf = '';
        foreach ($this->data_peers as $peer) {
            $conf .= "exten => {$peer['extension']},1,Set(__ISTRANSFER=transfer_) \n";
            $conf .= "	same => n,Goto(internal-users,{$peer['extension']},1) \n";
        }
        $conf .= "\n";

        return $conf;
    }

    /**
     * Returns PJSIP ot SIP uses at PBX
     *
     * @return string
     */
    public static function getTechnology(): string
    {
        return self::TYPE_PJSIP;
    }
}
mikopbx / Core

Push — master ( 384de0...a2c24b )

SIPConf::generateProvidersPj() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
