View GitHub Repository laravel-permission

Schedule Inspection
Subscribe
Completed
Push — master ( f81348...376794 )
by Freek
01:24
created

PermissionMiddleware::handle()   B

↳ Parent: PermissionMiddleware

Complexity

Conditions 5
Paths 12

Size

Total Lines 18
Code Lines 10

Duplication

Lines 18
Ratio 100 %

Importance

Changes 1
Bugs 1 Features 0
Metric Value
cc 5
eloc 10
c 1
b 1
f 0
nc 12
nop 3
dl 18
loc 18
rs 8.8571
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
namespace Spatie\Permission\Middlewares;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
use Closure;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
use Illuminate\Support\Facades\Auth;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
class PermissionMiddleware

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
{

            


            
                                                        
            
                                                                    
                                                                                                        
            
            

                
                    10
                

                                    
                                                    
                
                View Code Duplication
                
    public function handle($request, Closure $next, $permission)

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Duplication
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
This method seems to be duplicated in your project.
                                            

                                            
                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Duplicated code is one of the most pungent code smells. If you need to duplicate
the same code in three or more different places, we strongly encourage you to
look into extracting the code into a single class or operation.


You can also find more detailed suggestions in the “Code” section of your repository.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
        if (Auth::guest()) {

            


            
                                                        
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
            abort(403);

            


            
                                                        
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
        $permissions = is_array($permission)

            


            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
            ? $permission

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
            : explode('|', $permission);

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
        foreach ($permissions as $permission) {

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
            if (Auth::user()->can($permission)) {

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
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 can() does only exist in the following implementations of said interface: Illuminate\Foundation\Auth\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. 

  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.'
            );
        }

    }
}

    

    

    3. 




 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();
}

    

    

    2. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
                return $next($request);

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
            }

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
        abort(403);

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    29