Handler::prepareResponse() - Code Metrics - Inspection of "Add custom errors page for 404, 500 & 503" - XetaIO/Xetaravel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#31)

by Fèvre

created 2017-06-05 13:17 UTC

Handler::prepareResponse() A

↳ Parent: Handler

Complexity

Conditions	4
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.2
c	0
b	0
f	0
cc	4
eloc	6
nc	3
nop	2

<?php
namespace Xetaravel\Exceptions;

use Exception;
use Illuminate\Auth\AuthenticationException;
use Illuminate\Support\Facades\Auth;
use Symfony\Component\HttpKernel\Exception\HttpException;
use Xetaio\Local\Exceptions\LocalHandler as ExceptionHandler;

class Handler extends ExceptionHandler
{
    /**
     * A list of the exception types that should not be reported.
     *
     * @var array
     */
    protected $dontReport = [
        \Illuminate\Auth\AuthenticationException::class,
        \Illuminate\Auth\Access\AuthorizationException::class,
        \Symfony\Component\HttpKernel\Exception\HttpException::class,
        \Illuminate\Database\Eloquent\ModelNotFoundException::class,
        \Illuminate\Session\TokenMismatchException::class,
        \Illuminate\Validation\ValidationException::class
    ];

    /**
     * Report or log an exception.
     *
     * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
     *
     * @param  \Exception  $exception
     * @return void
     */
    public function report(Exception $exception)
    {
        parent::report($exception);
    }

    /**
     * Render an exception into an HTTP response.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Exception  $exception
     * @return \Illuminate\Http\Response|\Symfony\Component\HttpFoundation\Response
     */
    public function render($request, Exception $exception)
    {
        if ($exception instanceof \Ultraware\Roles\Exceptions\RoleDeniedException ||
            $exception instanceof \Ultraware\Roles\Exceptions\PermissionDeniedException ||
            $exception instanceof \Ultraware\Roles\Exceptions\LevelDeniedException) {
            //If the user is banished, redirect him to the banished page.
            if (Auth::check() && Auth::user()->hasRole('banished')) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                return redirect()
                    ->route('page.banished');
            }

            return redirect()
                ->route('page.index')
                ->with('danger', 'You don\'t have the permission to view this page.');
        }

        return parent::render($request, $exception);
    }

    /**
     * Convert an authentication exception into an unauthenticated response.
     *
     * @param \Illuminate\Http\Request $request
     * @param \Illuminate\Auth\AuthenticationException $exception
     *
     * @return \Illuminate\Http\Response
     */
    protected function unauthenticated($request, AuthenticationException $exception)

    {
        if ($request->expectsJson()) {
            return response()->json(['error' => 'Unauthenticated.'], 401);
        }

        return redirect()
            ->guest(route('users.auth.login'))
            ->with('danger', 'You don\'t have the permission to view this page.');
    }

    /**
     * Prepare response containing exception render.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Exception $e
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function prepareResponse($request, Exception $e)
    {
        if (!$this->isHttpException($e) && config('app.debug')) {
            return $this->toIlluminateResponse($this->convertExceptionToResponse($e), $e);
        }

        if (!$this->isHttpException($e)) {
            $e = new HttpException(500, $e->getMessage());
        }

        return $this->toIlluminateResponse($this->renderHttpException($e), $e);

    }
}


1			<?php
2			namespace Xetaravel\Exceptions;
3
4			use Exception;
5			use Illuminate\Auth\AuthenticationException;
6			use Illuminate\Support\Facades\Auth;
7			use Symfony\Component\HttpKernel\Exception\HttpException;
8			use Xetaio\Local\Exceptions\LocalHandler as ExceptionHandler;
9
10			class Handler extends ExceptionHandler
11			{
12			/**
13			* A list of the exception types that should not be reported.
14			*
15			* @var array
16			*/
17			protected $dontReport = [
18			\Illuminate\Auth\AuthenticationException::class,
19			\Illuminate\Auth\Access\AuthorizationException::class,
20			\Symfony\Component\HttpKernel\Exception\HttpException::class,
21			\Illuminate\Database\Eloquent\ModelNotFoundException::class,
22			\Illuminate\Session\TokenMismatchException::class,
23			\Illuminate\Validation\ValidationException::class
24			];
25
26			/**
27			* Report or log an exception.
28			*
29			* This is a great spot to send exceptions to Sentry, Bugsnag, etc.
30			*
31			* @param \Exception $exception
32			* @return void
33			*/
34			public function report(Exception $exception)
35			{
36			parent::report($exception);
37			}
38
39			/**
40			* Render an exception into an HTTP response.
41			*
42			* @param \Illuminate\Http\Request $request
43			* @param \Exception $exception
44			* @return \Illuminate\Http\Response\|\Symfony\Component\HttpFoundation\Response
45			*/
46			public function render($request, Exception $exception)
47			{
48			if ($exception instanceof \Ultraware\Roles\Exceptions\RoleDeniedException \|\|
49			$exception instanceof \Ultraware\Roles\Exceptions\PermissionDeniedException \|\|
50			$exception instanceof \Ultraware\Roles\Exceptions\LevelDeniedException) {
51			//If the user is banished, redirect him to the banished page.
52			if (Auth::check() && Auth::user()->hasRole('banished')) {
			0 ignored issues – show Bug introduced 2017-05-03 18:29 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `hasRole()` does only exist in the following implementations of said interface: `Xetaravel\Models\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
53			return redirect()
54			->route('page.banished');
55			}
56
57			return redirect()
58			->route('page.index')
59			->with('danger', 'You don\'t have the permission to view this page.');
60			}
61
62			return parent::render($request, $exception);
63			}
64
65			/**
66			* Convert an authentication exception into an unauthenticated response.
67			*
68			* @param \Illuminate\Http\Request $request
69			* @param \Illuminate\Auth\AuthenticationException $exception
70			*
71			* @return \Illuminate\Http\Response
72			*/
73			protected function unauthenticated($request, AuthenticationException $exception)
			0 ignored issues – show Unused Code introduced 2017-05-03 18:29 UTC by Report Bug Copy Issue Report The parameter `$exception` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
74			{
75			if ($request->expectsJson()) {
76			return response()->json(['error' => 'Unauthenticated.'], 401);
77			}
78
79			return redirect()
80			->guest(route('users.auth.login'))
81			->with('danger', 'You don\'t have the permission to view this page.');
82			}
83
84			/**
85			* Prepare response containing exception render.
86			*
87			* @param \Illuminate\Http\Request $request
88			* @param \Exception $e
89			*
90			* @return \Symfony\Component\HttpFoundation\Response
91			*/
92			protected function prepareResponse($request, Exception $e)
93			{
94			if (!$this->isHttpException($e) && config('app.debug')) {
95			return $this->toIlluminateResponse($this->convertExceptionToResponse($e), $e);
96			}
97
98			if (!$this->isHttpException($e)) {
99			$e = new HttpException(500, $e->getMessage());
100			}
101
102			return $this->toIlluminateResponse($this->renderHttpException($e), $e);
			0 ignored issues – show Compatibility introduced 2017-06-05 14:37 UTC by Report Bug Copy Issue Report `$e` of type `object<Exception>` is not a sub-type of `object<Symfony\Component...xception\HttpException>`. It seems like you assume a child class of the class `Exception` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
103			}
104			}
105

XetaIO / Xetaravel

Pull Request — master (#31)

Handler::prepareResponse() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like