MaintenanceModeMiddleware::getIp() - Code Metrics - Inspection of "Add allowed ips" - rdehnhardt/lumen-maintenance-mode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 928b67...8d8dff )

by Renato

created 2016-06-22 14:38 UTC

MaintenanceModeMiddleware::getIp() A

↳ Parent: MaintenanceModeMiddleware

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	10
rs	9.4285
cc	3
eloc	7
nc	3
nop	0

<?php

namespace Rdehnhardt\MaintenanceMode\Http\Middleware;

use Closure;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Rdehnhardt\MaintenanceMode\MaintenanceModeService;

class MaintenanceModeMiddleware
{
    /**
     * Maintenance Mode Service.
     *
     * @var \Rdehnhardt\MaintenanceMode\MaintenanceModeService
     */
    protected $maintenance;

    /**
     * Lumen Application Instance.
     *
     * @var \Laravel\Lumen\Application
     */
    protected $app;

    /**
     * View Factory.
     *
     * @var \Illuminate\View\Factory
     */
    protected $view;

    public function __construct(MaintenanceModeService $maintenance, Application $app)
    {
        $this->maintenance = $maintenance;
        $this->app = $app;

        $this->view = $app['view'];
    }

    /**
     * Handle incoming requests.
     *
     * @param Request $request
     * @param \Closure $next
     *
     * @return \Symfony\Component\HttpFoundation\Response
     * @throws \Symfony\Component\HttpKernel\Exception\HttpException
     * @throws \InvalidArgumentException
     */
    public function handle($request, Closure $next)
    {
        if ($this->maintenance->isDownMode() && !$this->maintenance->checkAllowedIp($this->getIp())) {
            if ($this->view->exists('errors.503')) {
                return new Response($this->view->make('errors.503'), 503);
            }

            return $this->app->abort(503, 'The application is down for maintenance.');
        }

        return $next($request);
    }

    /**
     * Get client ip
     */
    private function getIp()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (!empty($_SERVER['HTTP_CLIENT_IP'])) {
            return $_SERVER['HTTP_CLIENT_IP'];
        } elseif (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
            return $_SERVER['HTTP_X_FORWARDED_FOR'];
        } else {
            return $_SERVER['REMOTE_ADDR'];
        }
    }
}


1			<?php
2
3			namespace Rdehnhardt\MaintenanceMode\Http\Middleware;
4
5			use Closure;
6			use Illuminate\Contracts\Foundation\Application;
7			use Illuminate\Http\Request;
8			use Illuminate\Http\Response;
9			use Rdehnhardt\MaintenanceMode\MaintenanceModeService;
10
11			class MaintenanceModeMiddleware
12			{
13			/**
14			* Maintenance Mode Service.
15			*
16			* @var \Rdehnhardt\MaintenanceMode\MaintenanceModeService
17			*/
18			protected $maintenance;
19
20			/**
21			* Lumen Application Instance.
22			*
23			* @var \Laravel\Lumen\Application
24			*/
25			protected $app;
26
27			/**
28			* View Factory.
29			*
30			* @var \Illuminate\View\Factory
31			*/
32			protected $view;
33
34			public function __construct(MaintenanceModeService $maintenance, Application $app)
35			{
36			$this->maintenance = $maintenance;
37			$this->app = $app;
			0 ignored issues – show Documentation Bug introduced 2016-05-10 15:59 UTC by Report Bug Copy Issue Report It seems like `$app` of type `object<Illuminate\Contra...Foundation\Application>` is incompatible with the declared type `object<Laravel\Lumen\Application>` of property `$app`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
38			$this->view = $app['view'];
39			}
40
41			/**
42			* Handle incoming requests.
43			*
44			* @param Request $request
45			* @param \Closure $next
46			*
47			* @return \Symfony\Component\HttpFoundation\Response
48			* @throws \Symfony\Component\HttpKernel\Exception\HttpException
49			* @throws \InvalidArgumentException
50			*/
51			public function handle($request, Closure $next)
52			{
53			if ($this->maintenance->isDownMode() && !$this->maintenance->checkAllowedIp($this->getIp())) {
54			if ($this->view->exists('errors.503')) {
55			return new Response($this->view->make('errors.503'), 503);
56			}
57
58			return $this->app->abort(503, 'The application is down for maintenance.');
59			}
60
61			return $next($request);
62			}
63
64			/**
65			* Get client ip
66			*/
67			private function getIp()
			0 ignored issues – show Coding Style introduced 2016-06-22 14:51 UTC by Report Bug Copy Issue Report `getIp` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
68			{
69			if (!empty($_SERVER['HTTP_CLIENT_IP'])) {
70			return $_SERVER['HTTP_CLIENT_IP'];
71			} elseif (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
72			return $_SERVER['HTTP_X_FORWARDED_FOR'];
73			} else {
74			return $_SERVER['REMOTE_ADDR'];
75			}
76			}
77			}
78

rdehnhardt / lumen-maintenance-mode

GitHub Access Token became invalid

Push — master ( 928b67...8d8dff )

MaintenanceModeMiddleware::getIp() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like