Authenticate::isNotLogged() - Code Metrics - Inspection of "tests updated" - linna/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( fb1bf3...90f035 )

by Sebastian

created 2017-09-10 18:22 UTC

Authenticate::isNotLogged() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

/**
 * Linna Framework.
 *
 * @author Sebastian Rapetti <[email protected]>
 * @copyright (c) 2017, Sebastian Rapetti
 * @license http://opensource.org/licenses/MIT MIT License
 */
declare(strict_types=1);

namespace Linna\Auth;

use Linna\Session\Session;

/**
 * This class provide methods for manage user authentication.
 */
class Authenticate
{
    /**
     * @var array Login status
     */
    private $data = ['user_name'=>''];

    /**
     * @var bool Indicate login status, true or false
     */
    private $logged = false;

    /**
     * @var Session Session class
     */
    private $sessionInstance;

    /**
     * @var Password Password class
     */
    private $password;

    /**
     * Class constructor.
     * <pre><code class="php">$auth = new Authenticate($session, $password);</code></pre>
     *
     * @param Session  $session  Session class instance.
     * @param Password $password Password class instance.
     */
    public function __construct(Session $session, Password $password)
    {
        $this->password = $password;
        $this->sessionInstance = $session;
        $this->logged = $this->refresh();
    }

    /**
     * Utilize this method for check if an user in the current session,
     * is currently logged in.
     * <pre><code class="php">$auth = new Authenticate($session, $password);
     *
     * if ($auth->isLogged()) {
     *     //do actions
     * }
     * </code></pre>
     *
     * @return bool
     */
    public function isLogged() : bool
    {
        return $this->logged;
    }

    /**
     * Opposite to isLogged() method.
     *
     * Utilize this method for check if an user in the current session,
     * is currently not logged in.
     * <pre><code class="php">$auth = new Authenticate($session, $password);
     *
     * if ($auth->isNotLogged()) {
     *     //redirect or other action
     * }
     *
     * //do actions
     * </code></pre>
     *
     * @return bool
     */
    public function isNotLogged() : bool
    {
        return !$this->logged;
    }

    /**
     * Get Login Data.
     *
     * Return array containing login data. 
     * <pre><code class="php">//after session start and login, session data appear like below array:
     * [
     *     'time' => 1479641396
     *     'expire' => 1800
     *     'loginTime' => 1479641395
     *     'login' => [
     *         'login' => true
     *         'user_id' => 1
     *         'user_name' => 'root'
     *     ]
     * ]
     * </code></pre>
     *
     * @return array
     */
    public function getLoginData() : array
    {
        return $this->data;
    }

    /**
     * Try to attemp login for the informations passed by param.
     *
     * <pre><code class="php">$user = ''; //user from login page form
     * $password = ''; //password from login page form
     *
     * $storedUser = ''; //user from stored informations
     * $storedPassword = ''; //password hash from stored informations
     * $storedId = ''; //user id from stored informations
     *
     * $auth = new Authenticate($session, $password);
     * $auth->login($user, $password, $storedUser, $storedPassword, $storedId);
     *
     * //other operation after login
     * </code></pre>
     *
     * @param string $userName
     * @param string $password
     * @param string $storedUserName
     * @param string $storedPassword
     * @param int    $storedId
     *
     * @return bool
     */
    public function login(string $userName, string $password, string $storedUserName = '', string $storedPassword = '', int $storedId = 0): bool
    {
        if ($this->theLoginChecksFail($userName, $password, $storedUserName, $storedPassword)) {
            return false;
        }

        //write valid login on session
        $this->sessionInstance->loginTime = time();
        $this->sessionInstance->login = [
            'login'     => true,
            'user_id'   => $storedId,
            'user_name' => $storedUserName,
        ];

        //regenerate session id
        $this->sessionInstance->regenerate();
        $this->logged = true;

        return true;
    }

    /**
     * Check if the login fail.
     *
     * @param string $userName
     * @param string $password
     * @param string $storedUserName
     * @param string $storedPassword
     *
     * @return bool
     */
    private function theLoginChecksFail(string $userName, string $password, string $storedUserName, string $storedPassword) : bool
    {
        //check user presence
        if ($userName !== $storedUserName) {
            return true;
        }

        //if password doesn't match return false
        if (!$this->password->verify($password, $storedPassword)) {
            return true;
        }

        return false;
    }

    /**
     * Do logout and delete login information from session.
     * <pre><code class="php">$auth = new Authenticate();
     * $auth->logout();
     * </code></pre>
     *
     * @return bool
     */
    public function logout(): bool
    {
        //remove login data from session
        unset($this->sessionInstance->login, $this->sessionInstance->loginTime);

        //regenerate session id
        $this->sessionInstance->regenerate();
        $this->logged = false;

        return true;
    }

    /**
     * Check if user is logged, get login data from session and update it.
     *
     * @return bool
     */
    private function refresh(): bool
    {
        //check for login data on in current session
        if (!isset($this->sessionInstance->login)) {
            return false;
        }

        //take time
        $time = time();

        //check if login expired
        if (($this->sessionInstance->loginTime + $this->sessionInstance->expire) < $time) {
            return false;
        }

        //update login data
        $this->sessionInstance->loginTime = $time;
        $this->data = $this->sessionInstance->login;

        return true;
    }
}


1		<?php
2
3		/**
4		* Linna Framework.
5		*
6		* @author Sebastian Rapetti <[email protected]>
7		* @copyright (c) 2017, Sebastian Rapetti
8		* @license http://opensource.org/licenses/MIT MIT License
9		*/
10		declare(strict_types=1);
11
12		namespace Linna\Auth;
13
14		use Linna\Session\Session;
15
16		/**
17		* This class provide methods for manage user authentication.
18		*/
19		class Authenticate
20		{
21		/**
22		* @var array Login status
23		*/
24		private $data = ['user_name'=>''];
25
26		/**
27		* @var bool Indicate login status, true or false
28		*/
29		private $logged = false;
30
31		/**
32		* @var Session Session class
33		*/
34		private $sessionInstance;
35
36		/**
37		* @var Password Password class
38		*/
39		private $password;
40
41		/**
42		* Class constructor.
43		* <pre><code class="php">$auth = new Authenticate($session, $password);</code></pre>
44		*
45		* @param Session $session Session class instance.
46		* @param Password $password Password class instance.
47		*/
48	10	public function __construct(Session $session, Password $password)
49		{
50	10	$this->password = $password;
51	10	$this->sessionInstance = $session;
52	10	$this->logged = $this->refresh();
53	10	}
54
55		/**
56		* Utilize this method for check if an user in the current session,
57		* is currently logged in.
58		* <pre><code class="php">$auth = new Authenticate($session, $password);
59		*
60		* if ($auth->isLogged()) {
61		* //do actions
62		* }
63		* </code></pre>
64		*
65		* @return bool
66		*/
67	6	public function isLogged() : bool
68		{
69	6	return $this->logged;
70		}
71
72		/**
73		* Opposite to isLogged() method.
74		*
75		* Utilize this method for check if an user in the current session,
76		* is currently not logged in.
77		* <pre><code class="php">$auth = new Authenticate($session, $password);
78		*
79		* if ($auth->isNotLogged()) {
80		* //redirect or other action
81		* }
82		*
83		* //do actions
84		* </code></pre>
85		*
86		* @return bool
87		*/
88	3	public function isNotLogged() : bool
89		{
90	3	return !$this->logged;
91		}
92
93		/**
94		* Get Login Data.
95		*
96		* Return array containing login data.
97		* <pre><code class="php">//after session start and login, session data appear like below array:
98		* [
99		* 'time' => 1479641396
100		* 'expire' => 1800
101		* 'loginTime' => 1479641395
102		* 'login' => [
103		* 'login' => true
104		* 'user_id' => 1
105		* 'user_name' => 'root'
106		* ]
107		* ]
108		* </code></pre>
109		*
110		* @return array
111		*/
112	4	public function getLoginData() : array
113		{
114	4	return $this->data;
115		}
116
117		/**
118		* Try to attemp login for the informations passed by param.
119		*
120		* <pre><code class="php">$user = ''; //user from login page form
121		* $password = ''; //password from login page form
122		*
123		* $storedUser = ''; //user from stored informations
124		* $storedPassword = ''; //password hash from stored informations
125		* $storedId = ''; //user id from stored informations
126		*
127		* $auth = new Authenticate($session, $password);
128		* $auth->login($user, $password, $storedUser, $storedPassword, $storedId);
129		*
130		* //other operation after login
131		* </code></pre>
132		*
133		* @param string $userName
134		* @param string $password
135		* @param string $storedUserName
136		* @param string $storedPassword
137		* @param int $storedId
138		*
139		* @return bool
140		*/
141	6	public function login(string $userName, string $password, string $storedUserName = '', string $storedPassword = '', int $storedId = 0): bool
142		{
143	6	if ($this->theLoginChecksFail($userName, $password, $storedUserName, $storedPassword)) {
144	1	return false;
145		}
146
147		//write valid login on session
148	5	$this->sessionInstance->loginTime = time();
149	5	$this->sessionInstance->login = [
150	5	'login' => true,
151	5	'user_id' => $storedId,
152	5	'user_name' => $storedUserName,
153		];
154
155		//regenerate session id
156	5	$this->sessionInstance->regenerate();
157	5	$this->logged = true;
158
159	5	return true;
160		}
161
162		/**
163		* Check if the login fail.
164		*
165		* @param string $userName
166		* @param string $password
167		* @param string $storedUserName
168		* @param string $storedPassword
169		*
170		* @return bool
171		*/
172	6	private function theLoginChecksFail(string $userName, string $password, string $storedUserName, string $storedPassword) : bool
173		{
174		//check user presence
175	6	if ($userName !== $storedUserName) {
176	1	return true;
177		}
178
179		//if password doesn't match return false
180	6	if (!$this->password->verify($password, $storedPassword)) {
181	1	return true;
182		}
183
184	5	return false;
185		}
186
187		/**
188		* Do logout and delete login information from session.
189		* <pre><code class="php">$auth = new Authenticate();
190		* $auth->logout();
191		* </code></pre>
192		*
193		* @return bool
194		*/
195	2	public function logout(): bool
196		{
197		//remove login data from session
198	2	unset($this->sessionInstance->login, $this->sessionInstance->loginTime);
199
200		//regenerate session id
201	2	$this->sessionInstance->regenerate();
202	2	$this->logged = false;
203
204	2	return true;
205		}
206
207		/**
208		* Check if user is logged, get login data from session and update it.
209		*
210		* @return bool
211		*/
212	10	private function refresh(): bool
213		{
214		//check for login data on in current session
215	10	if (!isset($this->sessionInstance->login)) {
216	10	return false;
217		}
218
219		//take time
220	3	$time = time();
221
222		//check if login expired
223	3	if (($this->sessionInstance->loginTime + $this->sessionInstance->expire) < $time) {
224	2	return false;
225		}
226
227		//update login data
228	2	$this->sessionInstance->loginTime = $time;
229	2	$this->data = $this->sessionInstance->login;
230
231	2	return true;
232		}
233		}
234

linna / framework

Push — master ( fb1bf3...90f035 )

Authenticate::isNotLogged() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like