Session::startSession() - Code Metrics - Inspection of "fix secure sessions" - fkooman/php-remote-storage - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 81c3eb...cdf577 )

by François

created 2017-02-19 20:13 UTC

Session::startSession() A

↳ Parent: Session

Complexity

Conditions	4
Paths	8

Size

Total Lines	19
Code Lines	10

Duplication

Lines	8
Ratio	42.11 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	8
loc	19
rs	9.2
cc	4
eloc	10
nc	8
nop	0

<?php
/**
 *  Copyright (C) 2016 SURFnet.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace fkooman\RemoteStorage\Http;

class Session implements SessionInterface
{
    /** @var bool */
    private $secureOnly = true;

    public function setSecureOnly($secureOnly)
    {
        $this->secureOnly = (bool) $secureOnly;
    }

    public function startSession()
// 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 ('' === session_id()) {
            session_set_cookie_params(0, '/', '', $this->secureOnly, true);
            session_start();
        }

        // https://paragonie.com/blog/2015/04/fast-track-safe-and-secure-php-sessions
        // Make sure we have a canary set
        if (!isset($_SESSION['canary'])) {

            session_regenerate_id(true);
            $_SESSION['canary'] = time();
        }
        // Regenerate session ID every five minutes:
        if ($_SESSION['canary'] < time() - 300) {

            session_regenerate_id(true);
            $_SESSION['canary'] = time();
        }
    }

    public function set($key, $value)
// 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);
    }
}
    {
        $this->startSession();
        $_SESSION[$key] = $value;
    }

    public function delete($key)
// 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);
    }
}
    {
        $this->startSession();
        if ($this->has($key)) {
            unset($_SESSION[$key]);
        }
    }

    public function has($key)
// 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);
    }
}
    {
        $this->startSession();

        return array_key_exists($key, $_SESSION);
    }

    public function get($key)
// 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);
    }
}
    {
        $this->startSession();
        if ($this->has($key)) {
            return $_SESSION[$key];
        }

        return;
    }

    public function destroy()
    {
        $this->startSession();
        session_destroy();
    }
}


1		<?php
2		/**
3		* Copyright (C) 2016 SURFnet.
4		*
5		* This program is free software: you can redistribute it and/or modify
6		* it under the terms of the GNU Affero General Public License as
7		* published by the Free Software Foundation, either version 3 of the
8		* License, or (at your option) any later version.
9		*
10		* This program is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		* GNU Affero General Public License for more details.
14		*
15		* You should have received a copy of the GNU Affero General Public License
16		* along with this program. If not, see <http://www.gnu.org/licenses/>.
17		*/
18
19		namespace fkooman\RemoteStorage\Http;
20
21		class Session implements SessionInterface
22		{
23		/** @var bool */
24		private $secureOnly = true;
25
26		public function setSecureOnly($secureOnly)
27		{
28		$this->secureOnly = (bool) $secureOnly;
29		}
30
31		public function startSession()
		0 ignored issues – show Coding Style introduced 2017-02-19 18:44 UTC by Report Bug Copy Issue Report `startSession` uses the super-global variable `$_SESSION` 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...
32		{
33		if ('' === session_id()) {
34		session_set_cookie_params(0, '/', '', $this->secureOnly, true);
35		session_start();
36		}
37
38		// https://paragonie.com/blog/2015/04/fast-track-safe-and-secure-php-sessions
39		// Make sure we have a canary set
40	View Code Duplication	if (!isset($_SESSION['canary'])) {
		0 ignored issues – show Duplication introduced 2017-02-19 18:44 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
41		session_regenerate_id(true);
42		$_SESSION['canary'] = time();
43		}
44		// Regenerate session ID every five minutes:
45	View Code Duplication	if ($_SESSION['canary'] < time() - 300) {
		0 ignored issues – show Duplication introduced 2017-02-19 18:44 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
46		session_regenerate_id(true);
47		$_SESSION['canary'] = time();
48		}
49		}
50
51		public function set($key, $value)
		0 ignored issues – show Coding Style introduced 2017-01-13 10:38 UTC by Report Bug Copy Issue Report `set` uses the super-global variable `$_SESSION` 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...
52		{
53		$this->startSession();
54		$_SESSION[$key] = $value;
55		}
56
57		public function delete($key)
		0 ignored issues – show Coding Style introduced 2017-01-13 10:38 UTC by Report Bug Copy Issue Report `delete` uses the super-global variable `$_SESSION` 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...
58		{
59		$this->startSession();
60		if ($this->has($key)) {
61		unset($_SESSION[$key]);
62		}
63		}
64
65		public function has($key)
		0 ignored issues – show Coding Style introduced 2017-01-13 10:38 UTC by Report Bug Copy Issue Report `has` uses the super-global variable `$_SESSION` 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...
66		{
67		$this->startSession();
68
69		return array_key_exists($key, $_SESSION);
70		}
71
72		public function get($key)
		0 ignored issues – show Coding Style introduced 2017-01-13 10:38 UTC by Report Bug Copy Issue Report `get` uses the super-global variable `$_SESSION` 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...
73		{
74		$this->startSession();
75		if ($this->has($key)) {
76		return $_SESSION[$key];
77		}
78
79		return;
80		}
81
82		public function destroy()
83		{
84		$this->startSession();
85		session_destroy();
86		}
87		}
88

fkooman / php-remote-storage

GitHub Access Token became invalid

Push — master ( 81c3eb...cdf577 )

Session::startSession() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like