Iptables::iptablesFormPost() - Code Metrics - Inspection of "Improve code quality." - terrylinooo/shieldon - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 2.x ( 335e99...b197ca )

by Terry

created 2020-07-18 04:59 UTC

Iptables::iptablesFormPost() F

↳ Parent: Iptables

Complexity

Conditions	21
Paths	2400

Size

Total Lines	102
Code Lines	53

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	21
eloc	53
nc	2400
nop	3
dl	0
loc	102
rs	0
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/*
 * This file is part of the Shieldon package.
 *
 * (c) Terry L. <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Shieldon\Firewall\Panel;

use Psr\Http\Message\ResponseInterface;
use Shieldon\Firewall\Panel\BaseController;
use function Shieldon\Firewall\__;
use function Shieldon\Firewall\get_request;

use SplFileObject;
use ReflectionObject;

use function filter_var;
use function is_numeric;
use function in_array;
use function file;
use function file_put_contents;
use function sleep;
use function file_exists;
use function explode;
use function trim;

/**
 * The bridge between the Shieldon firewall and the Iptables firewall.
 */
class Iptables extends BaseController
{
    /**
     * Constructor
     */
    public function __construct() 
    {
        parent::__construct();
    }

    /**
     * The IPv4 table.
     *
     * @return ResponseInterface
     */
    public function ip4(): ResponseInterface
    {
        return $this->iptables('IPv4');
    }

    /**
     * The IPv6 table.
     *
     * @return ResponseInterface
     */
    public function ip6(): ResponseInterface
    {
        return $this->iptables('IPv6');
    }

    /**
     * The IPv4 table.
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function ip4status(): ResponseInterface
    {
        return $this->iptablesStatus('IPv4');
    }

    /**
     * The IPv6 table.
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function ip6status(): ResponseInterface
    {
        return $this->iptablesStatus('IPv6');
    }

    /**
     * Detect and handle form post action.
     *
     * @param string $type              IPv4 or IPv6
     * @param string $commandLogFile    The log file contains executed commands.
     * @param string $iptablesQueueFile The file contains the commands that wil 
     *                                  be executed by Iptables
     *
     * @return void
     */
    private function iptablesFormPost(string $type, string $commandLogFile, string $iptablesQueueFile)
    {
        $postParams = get_request()->getParsedBody();

        $con1 = (
            isset($postParams['ip']) &&
            filter_var(explode('/', $postParams['ip'])[0], FILTER_VALIDATE_IP)
        );

        $con2 = (
            isset($postParams['port']) &&
            (
                is_numeric($postParams['port']) ||
                $postParams['port'] === 'all' ||
                $postParams['port'] === 'custom'
            )
        );

        $con3 = (
            isset($postParams['subnet']) && 
            (
                is_numeric($postParams['subnet']) || 
                $postParams['subnet'] === 'null'
            )
        );

        $con4 = (
            isset($postParams['protocol']) && 
            in_array($postParams['protocol'], ['tcp', 'udp', 'all'])
        );

        $con5 = (
            isset($postParams['action']) && 
            in_array($postParams['action'], ['allow', 'deny'])
        );

        if ($con1 && $con2 && $con3 && $con4 && $con5) {
            $ip       = $postParams['ip'];
            $port     = $postParams['port'];
            $subnet   = $postParams['subnet'];
            $protocol = $postParams['protocol'];
            $action   = $postParams['action'];
            $cPort    = $postParams['port_custom'] ?? 'all';

            $isRemoval = false;

            if (isset($postParams['remove']) && $postParams['remove'] === 'yes') {
                $isRemoval = true;
            }

            if ('custom' === $port) {
                $port = $cPort;
            }

            $ipv = '4';

            if ('IPv6' === $type) {
                $ipv = '6';
            }

            /**
             * The process of add or remove command string from two files:
             * 
             * (1) The command file -
             *     This file is used on display the commands on the page 
             *     Iptables Manager.
             * (2) The queue file -
             *     This file is a bridge between Shieldon Firewall and Iptalbes.
             *     ipbales_bridge.sh will monitor this file, once commands come, 
             *     transforming the commands into Iptables syntax commands and 
             *     then execute the Iptables commands.
             */
            if (!$isRemoval) {
                $originCommandString = "add,$ipv,$ip,$subnet,$port,$protocol,$action";

                // Delete line from the log file.
                $fileArr = file($commandLogFile);

                if (is_array($fileArr)) {
                    $keyFound = array_search(trim($originCommandString), $fileArr);
                    unset($fileArr[$keyFound]);

                    $t = [];
                    $i = 0;
                    foreach ($fileArr as $f) {
                        $t[$i] = trim($f);
                        $i++;
                    }
                    file_put_contents($commandLogFile, implode(PHP_EOL, $t));
                }

                $applyCommand = "delete,$ipv,$ip,$subnet,$port,$protocol,$action";

                file_put_contents($iptablesQueueFile, $applyCommand . "\n", FILE_APPEND | LOCK_EX);

                // Becase we need system cronjob done, and then the web page will show the actual results.
                sleep(10);
            } else {
                $applyCommand = "add,$ipv,$ip,$subnet,$port,$protocol,$action";

                file_put_contents($iptablesQueueFile, $applyCommand . "\n", FILE_APPEND | LOCK_EX);
                sleep(1);
            }
        }
    }

    /**
     * System layer firwall - iptables
     * 
     * @param string $type The type of IP address.
     *
     * @return void
     */
    protected function iptables(string $type = 'IPv4'): ResponseInterface
    {
        $reflection = new ReflectionObject($this->kernel);
        $t = $reflection->getProperty('properties');
        $t->setAccessible(true);
        $properties = $t->getValue($this->kernel);

        $dir = $properties['iptables_watching_folder'];

        // The iptables log files.
        $commandLogFile = $dir . '/ipv4_command.log';

        if ('IPv6' === $type) {
            $commandLogFile = $dir . '/ipv6_command.log';
        }

        $iptablesQueueFile = $dir . '/iptables_queue.log';

        if ('POST' === get_request()->getMethod()) {
            $this->iptablesFormPost($type, $commandLogFile, $iptablesQueueFile);
        }

        $data[] = [];

        $ipCommand = '';

        if (file_exists($commandLogFile)) {
            $file = new SplFileObject($commandLogFile);

            $ipCommand = [];

            while (!$file->eof()) {
                $line = trim($file->fgets());
                $ipInfo = explode(',', $line);

                if (!empty($ipInfo[4])) {
                    $ipCommand[] = $ipInfo;
                }
            }
        }

        $data['ipCommand'] = $ipCommand;
        $data['type'] = $type;

        $data['title'] = __('panel', 'title_iptables_manager', 'Iptables Manager') . ' (' . $type . ')';

        return $this->renderPage('panel/iptables_manager', $data);

    }

    /**
     * System layer firwall - iptables Status
     * iptables -L
     * 
     * @param string $type The type of IP address.
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    protected function iptablesStatus(string $type = 'IPv4'): ResponseInterface
    {
        $data[] = [];


        $reflection = new ReflectionObject($this->kernel);
        $t = $reflection->getProperty('properties');
        $t->setAccessible(true);
        $properties = $t->getValue($this->kernel);

        $dir = $properties['iptables_watching_folder'];

        // The iptables log files.
        $ipStatusFile = $dir . '/ipv4_status.log';

        if ('IPv6' === $type) {
            $ipStatusFile = $dir . '/ipv6_status.log';
        }
        
        $ipStatus = '';

        if (file_exists($ipStatusFile)) {
            $ipStatus = file_get_contents($ipStatusFile);
        }

        $data['ipStatus'] = $ipStatus;
        $data['type'] = $type;

        $data['title'] = __('panel', 'title_iptables_status', 'Iptables Status') . ' (' . $type . ')';

        return $this->renderPage('panel/iptables_status', $data);
    }
}



1			<?php
2			/*
3			* This file is part of the Shieldon package.
4			*
5			* (c) Terry L. <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			declare(strict_types=1);
12
13			namespace Shieldon\Firewall\Panel;
14
15			use Psr\Http\Message\ResponseInterface;
16			use Shieldon\Firewall\Panel\BaseController;
17			use function Shieldon\Firewall\__;
18			use function Shieldon\Firewall\get_request;
19
20			use SplFileObject;
21			use ReflectionObject;
22
23			use function filter_var;
24			use function is_numeric;
25			use function in_array;
26			use function file;
27			use function file_put_contents;
28			use function sleep;
29			use function file_exists;
30			use function explode;
31			use function trim;
32
33			/**
34			* The bridge between the Shieldon firewall and the Iptables firewall.
35			*/
36			class Iptables extends BaseController
37			{
38			/**
39			* Constructor
40			*/
41			public function __construct()
42			{
43			parent::__construct();
44			}
45
46			/**
47			* The IPv4 table.
48			*
49			* @return ResponseInterface
50			*/
51			public function ip4(): ResponseInterface
52			{
53			return $this->iptables('IPv4');
54			}
55
56			/**
57			* The IPv6 table.
58			*
59			* @return ResponseInterface
60			*/
61			public function ip6(): ResponseInterface
62			{
63			return $this->iptables('IPv6');
64			}
65
66			/**
67			* The IPv4 table.
68			*
69			* @return \Psr\Http\Message\ResponseInterface
70			*/
71			public function ip4status(): ResponseInterface
72			{
73			return $this->iptablesStatus('IPv4');
74			}
75
76			/**
77			* The IPv6 table.
78			*
79			* @return \Psr\Http\Message\ResponseInterface
80			*/
81			public function ip6status(): ResponseInterface
82			{
83			return $this->iptablesStatus('IPv6');
84			}
85
86			/**
87			* Detect and handle form post action.
88			*
89			* @param string $type IPv4 or IPv6
90			* @param string $commandLogFile The log file contains executed commands.
91			* @param string $iptablesQueueFile The file contains the commands that wil
92			* be executed by Iptables
93			*
94			* @return void
95			*/
96			private function iptablesFormPost(string $type, string $commandLogFile, string $iptablesQueueFile)
97			{
98			$postParams = get_request()->getParsedBody();
99
100			$con1 = (
101			isset($postParams['ip']) &&
102			filter_var(explode('/', $postParams['ip'])[0], FILTER_VALIDATE_IP)
103			);
104
105			$con2 = (
106			isset($postParams['port']) &&
107			(
108			is_numeric($postParams['port']) \|\|
109			$postParams['port'] === 'all' \|\|
110			$postParams['port'] === 'custom'
111			)
112			);
113
114			$con3 = (
115			isset($postParams['subnet']) &&
116			(
117			is_numeric($postParams['subnet']) \|\|
118			$postParams['subnet'] === 'null'
119			)
120			);
121
122			$con4 = (
123			isset($postParams['protocol']) &&
124			in_array($postParams['protocol'], ['tcp', 'udp', 'all'])
125			);
126
127			$con5 = (
128			isset($postParams['action']) &&
129			in_array($postParams['action'], ['allow', 'deny'])
130			);
131
132			if ($con1 && $con2 && $con3 && $con4 && $con5) {
133			$ip = $postParams['ip'];
134			$port = $postParams['port'];
135			$subnet = $postParams['subnet'];
136			$protocol = $postParams['protocol'];
137			$action = $postParams['action'];
138			$cPort = $postParams['port_custom'] ?? 'all';
139
140			$isRemoval = false;
141
142			if (isset($postParams['remove']) && $postParams['remove'] === 'yes') {
143			$isRemoval = true;
144			}
145
146			if ('custom' === $port) {
147			$port = $cPort;
148			}
149
150			$ipv = '4';
151
152			if ('IPv6' === $type) {
153			$ipv = '6';
154			}
155
156			/**
157			* The process of add or remove command string from two files:
158			*
159			* (1) The command file -
160			* This file is used on display the commands on the page
161			* Iptables Manager.
162			* (2) The queue file -
163			* This file is a bridge between Shieldon Firewall and Iptalbes.
164			* ipbales_bridge.sh will monitor this file, once commands come,
165			* transforming the commands into Iptables syntax commands and
166			* then execute the Iptables commands.
167			*/
168			if (!$isRemoval) {
169			$originCommandString = "add,$ipv,$ip,$subnet,$port,$protocol,$action";
170
171			// Delete line from the log file.
172			$fileArr = file($commandLogFile);
173
174			if (is_array($fileArr)) {
175			$keyFound = array_search(trim($originCommandString), $fileArr);
176			unset($fileArr[$keyFound]);
177
178			$t = [];
179			$i = 0;
180			foreach ($fileArr as $f) {
181			$t[$i] = trim($f);
182			$i++;
183			}
184			file_put_contents($commandLogFile, implode(PHP_EOL, $t));
185			}
186
187			$applyCommand = "delete,$ipv,$ip,$subnet,$port,$protocol,$action";
188
189			file_put_contents($iptablesQueueFile, $applyCommand . "\n", FILE_APPEND \| LOCK_EX);
190
191			// Becase we need system cronjob done, and then the web page will show the actual results.
192			sleep(10);
193			} else {
194			$applyCommand = "add,$ipv,$ip,$subnet,$port,$protocol,$action";
195
196			file_put_contents($iptablesQueueFile, $applyCommand . "\n", FILE_APPEND \| LOCK_EX);
197			sleep(1);
198			}
199			}
200			}
201
202			/**
203			* System layer firwall - iptables
204			*
205			* @param string $type The type of IP address.
206			*
207			* @return void
208			*/
209			protected function iptables(string $type = 'IPv4'): ResponseInterface
210			{
211			$reflection = new ReflectionObject($this->kernel);
212			$t = $reflection->getProperty('properties');
213			$t->setAccessible(true);
214			$properties = $t->getValue($this->kernel);
215
216			$dir = $properties['iptables_watching_folder'];
217
218			// The iptables log files.
219			$commandLogFile = $dir . '/ipv4_command.log';
220
221			if ('IPv6' === $type) {
222			$commandLogFile = $dir . '/ipv6_command.log';
223			}
224
225			$iptablesQueueFile = $dir . '/iptables_queue.log';
226
227			if ('POST' === get_request()->getMethod()) {
228			$this->iptablesFormPost($type, $commandLogFile, $iptablesQueueFile);
229			}
230
231			$data[] = [];
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-07-18 05:01 UTC by Report Bug Copy Issue Report `$data` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$data = array();` before regardless. Loading history...
232			$ipCommand = '';
233
234			if (file_exists($commandLogFile)) {
235			$file = new SplFileObject($commandLogFile);
236
237			$ipCommand = [];
238
239			while (!$file->eof()) {
240			$line = trim($file->fgets());
241			$ipInfo = explode(',', $line);
242
243			if (!empty($ipInfo[4])) {
244			$ipCommand[] = $ipInfo;
245			}
246			}
247			}
248
249			$data['ipCommand'] = $ipCommand;
250			$data['type'] = $type;
251
252			$data['title'] = __('panel', 'title_iptables_manager', 'Iptables Manager') . ' (' . $type . ')';
253
254			return $this->renderPage('panel/iptables_manager', $data);
			0 ignored issues – show Bug Best Practice introduced 2020-07-15 19:08 UTC by Report Bug Copy Issue Report The expression `return $this->renderPage...tables_manager', $data)` returns the type `Psr\Http\Message\ResponseInterface` which is incompatible with the documented return type `void`. Loading history...
255			}
256
257			/**
258			* System layer firwall - iptables Status
259			* iptables -L
260			*
261			* @param string $type The type of IP address.
262			*
263			* @return \Psr\Http\Message\ResponseInterface
264			*/
265			protected function iptablesStatus(string $type = 'IPv4'): ResponseInterface
266			{
267			$data[] = [];
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-07-15 19:05 UTC by Report Bug Copy Issue Report `$data` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$data = array();` before regardless. Loading history...
268
269			$reflection = new ReflectionObject($this->kernel);
270			$t = $reflection->getProperty('properties');
271			$t->setAccessible(true);
272			$properties = $t->getValue($this->kernel);
273
274			$dir = $properties['iptables_watching_folder'];
275
276			// The iptables log files.
277			$ipStatusFile = $dir . '/ipv4_status.log';
278
279			if ('IPv6' === $type) {
280			$ipStatusFile = $dir . '/ipv6_status.log';
281			}
282
283			$ipStatus = '';
284
285			if (file_exists($ipStatusFile)) {
286			$ipStatus = file_get_contents($ipStatusFile);
287			}
288
289			$data['ipStatus'] = $ipStatus;
290			$data['type'] = $type;
291
292			$data['title'] = __('panel', 'title_iptables_status', 'Iptables Status') . ' (' . $type . ')';
293
294			return $this->renderPage('panel/iptables_status', $data);
295			}
296			}
297
298

terrylinooo / shieldon

Push — 2.x ( 335e99...b197ca )

Iptables::iptablesFormPost() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like