Completed
Push — master ( aec809...fc310e )
by Fèvre
11s
created

Handler::prepareResponse()   A

Complexity

Conditions 4
Paths 3

Size

Total Lines 12
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 12
rs 9.2
c 0
b 0
f 0
cc 4
eloc 6
nc 3
nop 2
1
<?php
2
namespace Xetaravel\Exceptions;
3
4
use Exception;
5
use Illuminate\Auth\AuthenticationException;
6
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
7
use Illuminate\Support\Facades\Auth;
8
use Symfony\Component\HttpKernel\Exception\HttpException;
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 by
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. 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)
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