NetworkController::saveNatSettings() - Code Metrics - mikopbx/Core - Measure and Improve Code Quality continuously with Scrutinizer

NetworkController::saveNatSettings() B
last analyzed 2025-05-20 09:51 UTC

↳ Parent: NetworkController

Complexity

Conditions	8
Paths	7

Size

Total Lines	25
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
eloc	19
c	2
b	0
f	0
dl	0
loc	25
rs	8.4444
cc	8
nc	7
nop	1

<?php

/*
 * MikoPBX - free phone system for small business
 * Copyright © 2017-2023 Alexey Portnov and Nikolay Beketov
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <https://www.gnu.org/licenses/>.
 */

namespace MikoPBX\AdminCabinet\Controllers;

use MikoPBX\AdminCabinet\Forms\NetworkEditForm;
use MikoPBX\Common\Models\LanInterfaces;
use MikoPBX\Common\Models\PbxSettings;
use MikoPBX\Core\System\Util;

class NetworkController extends BaseController
{
    /**
     * Lan cards settings form
     */
    public function modifyAction(): void
    {
        $networkInterfaces = LanInterfaces::find();
        foreach ($networkInterfaces as $record) {
            if ($record->disabled !== '1') {
                $arrEth[] = $record;
            }
        }

        $template = new LanInterfaces();
        $template->id = 0;
        $template->dhcp = '1';
        $template->vlanid = '4095';

        $arrEth[] = $template;

        $internetInterface = LanInterfaces::findFirstByInternet('1');
        if ($internetInterface === null) {
            $internetInterface = new LanInterfaces();
            $internetInterface->id = 1;
        }

        // We will find additional interfaces which we can delete
        $deletableInterfaces = [];
        $countInterfaces = LanInterfaces::count(['group' => 'interface']);
        foreach ($countInterfaces as $record) {
            if ($record->rowcount > 1) {
                $deletableInterfaces[] = $record->interface;
            }
        }
        $form = new NetworkEditForm($internetInterface, ['eths' => $arrEth]);

        $this->view->setVars(
            [
                'SIP_PORT' => PbxSettings::getValueByKey(PbxSettings::SIP_PORT),
                'EXTERNAL_SIP_PORT' => PbxSettings::getValueByKey(PbxSettings::EXTERNAL_SIP_PORT),
                'TLS_PORT' => PbxSettings::getValueByKey(PbxSettings::TLS_PORT),
                'EXTERNAL_TLS_PORT' => PbxSettings::getValueByKey(PbxSettings::EXTERNAL_TLS_PORT),
                'RTP_PORT_FROM' => PbxSettings::getValueByKey(PbxSettings::RTP_PORT_FROM),
                'RTP_PORT_TO' => PbxSettings::getValueByKey(PbxSettings::RTP_PORT_TO),
                'form' => $form,
                'eths' => $arrEth,
                'deletableEths' => $deletableInterfaces,
                'isDocker' => Util::isDocker(),
                'submitMode' => null,
            ]
        );
    }

    /**
     * Saves the lan cards settings
     */
    public function saveAction(): void
    {
        if (!$this->request->isPost()) {
            return;
        }

        $data = $this->request->getPost();
        $this->db->begin();


        list($result, $messages) = $this->saveLanInterfaces($data);
        if (!$result) {
            $this->flash->warning(implode('<br>', $messages));
            $this->view->success = false;
            $this->db->rollback();
            return;
        }

        list($result, $messages) = $this->saveNatSettings($data);
        if (!$result) {
            $this->flash->warning(implode('<br>', $messages));
            $this->view->success = false;
            $this->db->rollback();
            return;
        }

        $this->view->reload = 'network/modify';
        $this->flash->success($this->translation->_('ms_SuccessfulSaved'));
        $this->view->success = true;
        $this->db->commit();
    }

    /**
     * Saves the LAN interface configurations.
     *
     * This method iterates through each existing LAN interface, updates its configuration based on the provided data,
     * and saves the changes. If a new interface needs to be added (specified by 'interface_0'), it creates and saves this
     * new interface as well. If any save operation fails, the method returns an array containing `false` and the error messages.
     *
     * @param array $data Array containing the interface configurations.
     *                    Expected to contain interface settings such as IP, mask, etc., and a special key 'interface_0' for new interfaces.
     * @return array Returns an array with a boolean success flag and an array of error messages if applicable.
     */
    private function saveLanInterfaces(array $data): array
    {
        $networkInterfaces = LanInterfaces::find();

        // Update interface settings
        foreach ($networkInterfaces as $eth) {
            $this->fillEthStructure($eth, $data);
            if ($eth->save() === false) {
                $errors = $eth->getMessages();
                return [false, $errors];
            }
        }

        // Save additional interface settings if it exists
        if ($data['interface_0'] !== '') {
            $eth = new LanInterfaces();
            $eth->id = 0;
            $this->fillEthStructure($eth, $data);
            $eth->id = null;
            $eth->disabled = '0';
            if ($eth->create() === false) {
                $errors = $eth->getMessages();
                return [false, $errors];
            }
        }

        return [true, []];
    }

    /**
     * Fills network interface settings
     *
     * @param LanInterfaces $eth
     * @param array $data post data
     */
    private function fillEthStructure(LanInterfaces $eth, array $data): void
    {
        $isDocker = Util::isDocker();
        foreach ($eth as $name => $value) {
            $itIsInternetInterfce = intval($eth->id) === intval($data['internet_interface']);
            switch ($name) {
                case 'topology':
                    if ($itIsInternetInterfce) {
                        $eth->$name = ($data['usenat'] === 'on') ? LanInterfaces::TOPOLOGY_PRIVATE : LanInterfaces::TOPOLOGY_PUBLIC;
                    } else {
                        $eth->$name = '';
                    }
                    break;
                case 'extipaddr':
                    if ($itIsInternetInterfce) {
                        if (array_key_exists($name, $data)) {
                            $eth->$name = ($data['usenat'] === 'on') ? $data[$name] : $data['ipaddr_' . $eth->id];
                        } else {
                            $eth->$name = $data['ipaddr_' . $eth->id];
                        }
                    } else {
                        $eth->$name = '';
                    }

                    break;
                case 'exthostname':
                    if ($itIsInternetInterfce) {
                        if (array_key_exists($name, $data)) {
                            $eth->$name = ($data['usenat'] === 'on') ? $data[$name] : $data['hostname'];
                        } else {
                            $eth->$name = $data['hostname'];
                        }
                    } else {
                        $eth->$name = '';
                    }
                    break;
                case 'dhcp':
                    if (array_key_exists($name . '_' . $eth->id, $data)) {
                        $eth->$name = ($data['dhcp_' . $eth->id]) === 'on' ? '1' : '0';
                    }
                    if ($isDocker) {
                        $eth->dhcp = '1';
                    }
                    break;
                case 'internet':
                    $eth->$name = $itIsInternetInterfce ? '1' : '0';
                    break;
                case 'ipaddr':
                case 'subnet':
                    $eth->$name = '';
                    if (array_key_exists($name . '_' . $eth->id, $data)) {
                        $eth->$name = ($data['dhcp_' . $eth->id]) === 'on' ? '' : $data[$name . '_' . $eth->id];
                    }
                    break;
                case 'interface':
                    if ($eth->id === 0) {
                        $eth->$name = LanInterfaces::findFirstById($data[$name . '_' . $eth->id])->interface;
                    }
                    break;
                case 'domain':
                case 'hostname':
                case 'gateway':
                case 'primarydns':
                case 'secondarydns':
                    if (array_key_exists($name, $data) && $itIsInternetInterfce) {
                        $eth->$name = $data[$name];
                    } else {
                        $eth->$name = '';
                    }
                    break;
                default:
                    if (array_key_exists($name . '_' . $eth->id, $data)) {
                        $eth->$name = $data[$name . '_' . $eth->id];
                    }
            }
        }
    }

    /**
     * Saves the NAT-related settings for external access.
     *
     * Iterates through a list of predefined setting keys related to NAT configuration (like external SIP and TLS ports),
     * and updates these settings with new values from the provided data. If a setting fails to save, the method returns
     * immediately with an error.
     *
     * @param array $data Associative array where keys are setting names and values are the new settings to be saved.
     * @return array Returns an array with a boolean success flag and, if unsuccessful, an array of error messages.
     */
    private function saveNatSettings(array $data): array
    {
        $messages = [];
        foreach ($data as $key => $value) {
            switch ($key) {
                case PbxSettings::AUTO_UPDATE_EXTERNAL_IP:
                    PbxSettings::setValueByKey($key, $value === 'on' ? '1' : '0', $messages);
                    break;
                case PbxSettings::EXTERNAL_SIP_PORT:
                    if (empty($value)) {
                        $value = PbxSettings::getValueByKey(PbxSettings::SIP_PORT);
                    }
                    PbxSettings::setValueByKey($key, trim($value), $messages);
                    break;
                case PbxSettings::EXTERNAL_TLS_PORT:
                    if (empty($value)) {
                        $value = PbxSettings::getValueByKey(PbxSettings::TLS_PORT);
                    }
                    PbxSettings::setValueByKey($key, trim($value), $messages);
                    break;
                default:
            }
        }
        $result = count($messages) === 0;
        return [$result, ['error' => $messages]];
    }

    /**
     * Delete a lan interface by ID
     *
     * @param string $ethId interface id
     */
    public function deleteAction(string $ethId = ''): void
    {
        $eth = LanInterfaces::findFirstById($ethId);
        if ($eth !== null && $eth->delete() === false) {
            $errors = $eth->getMessages();
            $this->flash->warning(implode('<br>', $errors));
            $this->view->success = false;
            return;
        }
        $this->view->success = true;
    }
}


1			<?php
2
3			/*
4			* MikoPBX - free phone system for small business
5			* Copyright © 2017-2023 Alexey Portnov and Nikolay Beketov
6			*
7			* This program is free software: you can redistribute it and/or modify
8			* it under the terms of the GNU General Public License as published by
9			* the Free Software Foundation; either version 3 of the License, or
10			* (at your option) any later version.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License along with this program.
18			* If not, see <https://www.gnu.org/licenses/>.
19			*/
20
21			namespace MikoPBX\AdminCabinet\Controllers;
22
23			use MikoPBX\AdminCabinet\Forms\NetworkEditForm;
24			use MikoPBX\Common\Models\LanInterfaces;
25			use MikoPBX\Common\Models\PbxSettings;
26			use MikoPBX\Core\System\Util;
27
28			class NetworkController extends BaseController
29			{
30			/**
31			* Lan cards settings form
32			*/
33			public function modifyAction(): void
34			{
35			$networkInterfaces = LanInterfaces::find();
36			foreach ($networkInterfaces as $record) {
37			if ($record->disabled !== '1') {
38			$arrEth[] = $record;
39			}
40			}
41
42			$template = new LanInterfaces();
43			$template->id = 0;
44			$template->dhcp = '1';
45			$template->vlanid = '4095';
46
47			$arrEth[] = $template;
48
49			$internetInterface = LanInterfaces::findFirstByInternet('1');
50			if ($internetInterface === null) {
51			$internetInterface = new LanInterfaces();
52			$internetInterface->id = 1;
53			}
54
55			// We will find additional interfaces which we can delete
56			$deletableInterfaces = [];
57			$countInterfaces = LanInterfaces::count(['group' => 'interface']);
58			foreach ($countInterfaces as $record) {
59			if ($record->rowcount > 1) {
60			$deletableInterfaces[] = $record->interface;
61			}
62			}
63			$form = new NetworkEditForm($internetInterface, ['eths' => $arrEth]);
64
65			$this->view->setVars(
66			[
67			'SIP_PORT' => PbxSettings::getValueByKey(PbxSettings::SIP_PORT),
68			'EXTERNAL_SIP_PORT' => PbxSettings::getValueByKey(PbxSettings::EXTERNAL_SIP_PORT),
69			'TLS_PORT' => PbxSettings::getValueByKey(PbxSettings::TLS_PORT),
70			'EXTERNAL_TLS_PORT' => PbxSettings::getValueByKey(PbxSettings::EXTERNAL_TLS_PORT),
71			'RTP_PORT_FROM' => PbxSettings::getValueByKey(PbxSettings::RTP_PORT_FROM),
72			'RTP_PORT_TO' => PbxSettings::getValueByKey(PbxSettings::RTP_PORT_TO),
73			'form' => $form,
74			'eths' => $arrEth,
75			'deletableEths' => $deletableInterfaces,
76			'isDocker' => Util::isDocker(),
77			'submitMode' => null,
78			]
79			);
80			}
81
82			/**
83			* Saves the lan cards settings
84			*/
85			public function saveAction(): void
86			{
87			if (!$this->request->isPost()) {
88			return;
89			}
90
91			$data = $this->request->getPost();
92			$this->db->begin();
93
94
95			list($result, $messages) = $this->saveLanInterfaces($data);
96			if (!$result) {
97			$this->flash->warning(implode('<br>', $messages));
98			$this->view->success = false;
99			$this->db->rollback();
100			return;
101			}
102
103			list($result, $messages) = $this->saveNatSettings($data);
104			if (!$result) {
105			$this->flash->warning(implode('<br>', $messages));
106			$this->view->success = false;
107			$this->db->rollback();
108			return;
109			}
110
111			$this->view->reload = 'network/modify';
112			$this->flash->success($this->translation->_('ms_SuccessfulSaved'));
113			$this->view->success = true;
114			$this->db->commit();
115			}
116
117			/**
118			* Saves the LAN interface configurations.
119			*
120			* This method iterates through each existing LAN interface, updates its configuration based on the provided data,
121			* and saves the changes. If a new interface needs to be added (specified by 'interface_0'), it creates and saves this
122			* new interface as well. If any save operation fails, the method returns an array containing `false` and the error messages.
123			*
124			* @param array $data Array containing the interface configurations.
125			* Expected to contain interface settings such as IP, mask, etc., and a special key 'interface_0' for new interfaces.
126			* @return array Returns an array with a boolean success flag and an array of error messages if applicable.
127			*/
128			private function saveLanInterfaces(array $data): array
129			{
130			$networkInterfaces = LanInterfaces::find();
131
132			// Update interface settings
133			foreach ($networkInterfaces as $eth) {
134			$this->fillEthStructure($eth, $data);
135			if ($eth->save() === false) {
136			$errors = $eth->getMessages();
137			return [false, $errors];
138			}
139			}
140
141			// Save additional interface settings if it exists
142			if ($data['interface_0'] !== '') {
143			$eth = new LanInterfaces();
144			$eth->id = 0;
145			$this->fillEthStructure($eth, $data);
146			$eth->id = null;
147			$eth->disabled = '0';
148			if ($eth->create() === false) {
149			$errors = $eth->getMessages();
150			return [false, $errors];
151			}
152			}
153
154			return [true, []];
155			}
156
157			/**
158			* Fills network interface settings
159			*
160			* @param LanInterfaces $eth
161			* @param array $data post data
162			*/
163			private function fillEthStructure(LanInterfaces $eth, array $data): void
164			{
165			$isDocker = Util::isDocker();
166			foreach ($eth as $name => $value) {
167			$itIsInternetInterfce = intval($eth->id) === intval($data['internet_interface']);
168			switch ($name) {
169			case 'topology':
170			if ($itIsInternetInterfce) {
171			$eth->$name = ($data['usenat'] === 'on') ? LanInterfaces::TOPOLOGY_PRIVATE : LanInterfaces::TOPOLOGY_PUBLIC;
172			} else {
173			$eth->$name = '';
174			}
175			break;
176			case 'extipaddr':
177			if ($itIsInternetInterfce) {
178			if (array_key_exists($name, $data)) {
179			$eth->$name = ($data['usenat'] === 'on') ? $data[$name] : $data['ipaddr_' . $eth->id];
180			} else {
181			$eth->$name = $data['ipaddr_' . $eth->id];
182			}
183			} else {
184			$eth->$name = '';
185			}
186
187			break;
188			case 'exthostname':
189			if ($itIsInternetInterfce) {
190			if (array_key_exists($name, $data)) {
191			$eth->$name = ($data['usenat'] === 'on') ? $data[$name] : $data['hostname'];
192			} else {
193			$eth->$name = $data['hostname'];
194			}
195			} else {
196			$eth->$name = '';
197			}
198			break;
199			case 'dhcp':
200			if (array_key_exists($name . '_' . $eth->id, $data)) {
201			$eth->$name = ($data['dhcp_' . $eth->id]) === 'on' ? '1' : '0';
202			}
203			if ($isDocker) {
204			$eth->dhcp = '1';
205			}
206			break;
207			case 'internet':
208			$eth->$name = $itIsInternetInterfce ? '1' : '0';
209			break;
210			case 'ipaddr':
211			case 'subnet':
212			$eth->$name = '';
213			if (array_key_exists($name . '_' . $eth->id, $data)) {
214			$eth->$name = ($data['dhcp_' . $eth->id]) === 'on' ? '' : $data[$name . '_' . $eth->id];
215			}
216			break;
217			case 'interface':
218			if ($eth->id === 0) {
219			$eth->$name = LanInterfaces::findFirstById($data[$name . '_' . $eth->id])->interface;
220			}
221			break;
222			case 'domain':
223			case 'hostname':
224			case 'gateway':
225			case 'primarydns':
226			case 'secondarydns':
227			if (array_key_exists($name, $data) && $itIsInternetInterfce) {
228			$eth->$name = $data[$name];
229			} else {
230			$eth->$name = '';
231			}
232			break;
233			default:
234			if (array_key_exists($name . '_' . $eth->id, $data)) {
235			$eth->$name = $data[$name . '_' . $eth->id];
236			}
237			}
238			}
239			}
240
241			/**
242			* Saves the NAT-related settings for external access.
243			*
244			* Iterates through a list of predefined setting keys related to NAT configuration (like external SIP and TLS ports),
245			* and updates these settings with new values from the provided data. If a setting fails to save, the method returns
246			* immediately with an error.
247			*
248			* @param array $data Associative array where keys are setting names and values are the new settings to be saved.
249			* @return array Returns an array with a boolean success flag and, if unsuccessful, an array of error messages.
250			*/
251			private function saveNatSettings(array $data): array
252			{
253			$messages = [];
254			foreach ($data as $key => $value) {
255			switch ($key) {
256			case PbxSettings::AUTO_UPDATE_EXTERNAL_IP:
257			PbxSettings::setValueByKey($key, $value === 'on' ? '1' : '0', $messages);
258			break;
259			case PbxSettings::EXTERNAL_SIP_PORT:
260			if (empty($value)) {
261			$value = PbxSettings::getValueByKey(PbxSettings::SIP_PORT);
262			}
263			PbxSettings::setValueByKey($key, trim($value), $messages);
264			break;
265			case PbxSettings::EXTERNAL_TLS_PORT:
266			if (empty($value)) {
267			$value = PbxSettings::getValueByKey(PbxSettings::TLS_PORT);
268			}
269			PbxSettings::setValueByKey($key, trim($value), $messages);
270			break;
271			default:
272			}
273			}
274			$result = count($messages) === 0;
275			return [$result, ['error' => $messages]];
276			}
277
278			/**
279			* Delete a lan interface by ID
280			*
281			* @param string $ethId interface id
282			*/
283			public function deleteAction(string $ethId = ''): void
284			{
285			$eth = LanInterfaces::findFirstById($ethId);
286			if ($eth !== null && $eth->delete() === false) {
287			$errors = $eth->getMessages();
288			$this->flash->warning(implode('<br>', $errors));
289			$this->view->success = false;
290			return;
291			}
292			$this->view->success = true;
293			}
294			}
295

mikopbx / Core

NetworkController::saveNatSettings() B last analyzed 2025-05-20 09:51 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

NetworkController::saveNatSettings() B
last analyzed 2025-05-20 09:51 UTC