Panel::setRouteBase() - Code Metrics - Inspection of "Fix constant." - terrylinooo/shieldon - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 2.x ( 9c7c64...09a803 )

by Terry
created 2020-07-24 10:02 UTC
Panel::setRouteBase() A

↳ Parent: Panel
Complexity

Conditions	2
Paths	2
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	2
eloc	2
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	4
rs	10
<?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.
 * 
 * php version 7.1.0
 * 
 * @category  Web-security
 * @package   Shieldon
 * @author    Terry Lin <[email protected]>
 * @copyright 2019 terrylinooo
 * @license   https://github.com/terrylinooo/shieldon/blob/2.x/LICENSE MIT
 * @link      https://github.com/terrylinooo/shieldon
 * @see       https://shieldon.io
 */

declare(strict_types=1);

namespace Shieldon\Firewall;

use Psr\Http\Message\ResponseInterface;
use Shieldon\Firewall\HttpResolver;
use Shieldon\Firewall\Panel\CsrfTrait;
use Shieldon\Firewall\Panel\DemoModeTrait;
use Shieldon\Firewall\Panel\User;
use function Shieldon\Firewall\get_request;
use function Shieldon\Firewall\get_response;

use function call_user_func;
use function explode;
use function in_array;
use function property_exists;
use function str_replace;
use function trim;
use function ucfirst;

/**
 * Firewall's Control Panel
 *
 * Display a Control Panel UI for developers or administrators.
 */
class Panel
{
    use DemoModeTrait;
    use CsrfTrait;

    /**
     * Route map.
     *
     * @var array
     */
    protected $registerRoutes;

    /**
     * The HTTP resolver.
     * 
     * We need to resolve the HTTP result by ourselves to prevent conficts
     * with other frameworks.
     *
     * @var \Shieldon\Firewall\HttpResolver
     */
    protected $resolver = null;

    /**
     * Firewall panel constructor.                         
     */
    public function __construct() 
    {
        $this->registerRoutes = [
            'ajax/changeLocale',
            'ajax/tryMessenger',
            'circle/filter',
            'circle/rule',
            'circle/session',
            'home/index',
            'home/overview',
            'iptables/ip4',
            'iptables/ip4status',
            'iptables/ip6',
            'iptables/ip6status',
            'report/actionLog',
            'report/operation',
            'security/authentication',
            'security/xssProtection',
            'setting/basic',
            'setting/exclusion',
            'setting/export',
            'setting/import',
            'setting/ipManager',
            'setting/messenger',
            'user/login',
            'user/logout',
        ];

        $this->resolver = new HttpResolver();
    }

    /**
     * Display pages.
     * 
     * @param string $basePath The base URL of the firewall panel.
     * 
     * @return void
     */
    public function entry($basePath): void
    {
        $request = get_request();
        $response = get_response();

        $path = trim($request->getUri()->getPath(), '/');
        $base = trim($basePath, '/');
        $urlSegment = trim(str_replace($base, '', $path), '/');

        if ($urlSegment === $basePath || $urlSegment === '') {
            $urlSegment = 'home/index';
        }

        $urlParts = explode('/', $urlSegment);

        $controller = $urlParts[0] ?? 'home';
        $method = $urlParts[1] ?? 'index';

        if (in_array("$controller/$method", $this->registerRoutes)) {
            $this->setRouteBase($base);
            $this->checkAuth();

            $controller = __CLASS__ . '\\' . ucfirst($controller);

            $controllerClass = new $controller();
            $controllerClass->csrf($this->csrfField);

            if ('demo' === $this->mode) {

                // For security reasons, the POST method is not allowed 
                // in the Demo mode.
                set_request(get_request()->withParsedBody([])->withMethod('GET'));
                unset_superglobal(null, 'post');

                $controllerClass->demo(
                    $this->demoUser['user'],
                    $this->demoUser['pass']
                );
            }

            $this->resolver(call_user_func([$controllerClass, $method]));
                   resolver(call_user_func([$controllerClass, $method]));
        }
       
        $this->resolver($response->withStatus(404));
    }

    /**
     * Set the base route for the panel.
     *
     * @param string $base The base path.
     *
     * @return void
     */
    protected function setRouteBase(string $base)
    {
        if (!defined('SHIELDON_PANEL_BASE')) {
            define('SHIELDON_PANEL_BASE', $base);
        }
    }

    /**
     * Prompt an authorization login.
     *
     * @return void
     */
    protected function checkAuth(): void
    {
        $check = get_session()->get('shieldon_user_login');

        if (empty($check)) {
            $this->resolver((new User)->login($this->mode));
        }
    }

    /**
     * Magic method.
     * 
     * Helps the property `$resolver` to work like a function.
     * 
     * @param string $method The method name.
     * @param array  $args   The arguments.
     *
     * @return mixed
     */
    public function __call($method, $args)
    {
        if (property_exists($this, $method)) {
            $callable = $this->{$method};

            if (isset($args[0]) && $args[0] instanceof ResponseInterface) {
                return $callable($args[0]);
            }
        }
        // @codeCoverageIgnoreStart
    }
    // @codeCoverageIgnoreEnd
}

terrylinooo / shieldon

Push — 2.x ( 9c7c64...09a803 )

Panel::setRouteBase() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
