View GitHub Repository silverstripe-framework

Schedule Inspection
Subscribe
Completed
Push — director-middleware ( 65944d...059969 )
by Sam
08:23
created

SessionMiddleware::process()   A

↳ Parent: SessionMiddleware

Complexity

Conditions 1
Paths 2

Size

Total Lines 17
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 7
nc 2
nop 2
dl 0
loc 17
rs 9.4285
c 0
b 0
f 0
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
namespace SilverStripe\Control;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
class SessionMiddleware implements HTTPMiddleware

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
{

            


            
                                                        
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
    public function process(HTTPRequest $request, callable $delegate)

            


            
                                                        
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
        try {

            


            
                                                        
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
            // Start session and execute

            


            
                                                        
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
            $request->getSession()->init();

            


            
                                                        
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
            // Generate output

            


            
                                                        
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
            $response = $delegate($request);

            


            
                                                        
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
        // Save session data, even if there was an exception.

            


            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
        // Note that save() will start/resume the session if required.

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
        } finally {

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
            $request->getSession()->save();

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
        return $response;

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The variable $response does not seem to be defined for all execution paths leading up to this point.
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
If you define a variable conditionally, it can happen that it is not defined
for all execution paths.


Let’s take a look at an example:


function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}





In the above example, the variable $x is defined if you pass “foo” or “bar”
as argument for $a. However, since the switch statement has no default
case statement, if you pass any other value, the variable $x would be undefined.




Available Fixes


  1. Check for existence of the variable explicitly:
    

    function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    if (isset($x)) { // Make sure it's always set.
        echo $x;
    }
}

    

    

    2. 

  2. Define a default value for the variable:
    

    function myFunction($a) {
    $x = ''; // Set a default which gets overridden for certain paths.
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    echo $x;
}

    

    

    3. 

  3. Add a value for the missing path:
    

    function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;

        // We add support for the missing case.
        default:
            $x = '';
            break;
    }

    echo $x;
}

    

    

    4. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    25