Service::getPrincipal() - Code Metrics - libreworks/caridea-auth - Measure and Improve Code Quality continuously with Scrutinizer

Service::getPrincipal() A
last analyzed 2018-01-06 18:23 UTC

↳ Parent: Service

Complexity

Conditions	3
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	3

Importance

Changes

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

<?php
declare(strict_types=1);
/**
 * Caridea
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @copyright 2015-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
namespace Caridea\Auth;

use Caridea\Event\Publisher;
use Caridea\Session\Session;
use Caridea\Session\Map;
use Psr\Http\Message\ServerRequestInterface;

/**
 * Authentication service.
 *
 * @copyright 2015-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
class Service implements \Caridea\Event\PublisherAware
{
    use \Psr\Log\LoggerAwareTrait;
    use \Caridea\Event\PublisherSetter;

    /**
     * @var Adapter The default auth adapter
     */
    protected $adapter;
    /**
     * @var \Caridea\Session\Session The session utility
     */
    protected $session;
    /**
     * @var \Caridea\Session\Map The session values
     */
    protected $values;
    /**
     * @var Principal The authenticated principal
     */
    protected $principal;

    /**
     * Creates a new authentication service.
     *
     * @param Session $session The session utility
     * @param Publisher $publisher An event publisher to broadcast authentication events
     * @param Adapter $adapter A default authentication adapter
     */
    public function __construct(Session $session, Publisher $publisher = null, Adapter $adapter = null)
    {
        $this->session = $session;
        $this->values = $session->getValues(__CLASS__);
        $this->publisher = $publisher ?? new \Caridea\Event\NullPublisher();
        $this->adapter = $adapter;
        $this->logger = new \Psr\Log\NullLogger();
    }

    /**
     * Gets the currently authenticated principal.
     *
     * If no one is authenticated, this will return an anonymous Principal. If
     * The session is not started but can be resumed, it will be resumed and the
     * principal will be loaded.
     *
     * @return Principal the authenticated principal
     */
    public function getPrincipal(): Principal
    {
        if ($this->principal === null && !$this->resume()) {
            $this->principal = Principal::getAnonymous();
        }
        return $this->principal;
    }

    /**
     * Authenticates a principal.
     *
     * @param ServerRequestInterface $request The Server Request message containing credentials
     * @param Adapter $adapter An optional adapter to use.
     *     Will use the default authentication adapter if none is specified.
     * @return bool Whether the session could be established
     * @throws \InvalidArgumentException If no adapter is provided and no default adapter is set
     * @throws Exception\UsernameNotFound if the provided username wasn't found
     * @throws Exception\UsernameAmbiguous if the provided username matches multiple accounts
     * @throws Exception\InvalidPassword if the provided password is invalid
     * @throws Exception\ConnectionFailed if the access to a remote data source failed
     *     (e.g. missing flat file, unreachable LDAP server, database login denied)
     */
    public function login(ServerRequestInterface $request, Adapter $adapter = null): bool
    {
        $started = $this->session->resume() || $this->session->start();
        if (!$started) {
            return false;
        }

        $login = $adapter ?? $this->adapter;
        if ($login === null) {
            throw new \InvalidArgumentException('You must specify an adapter for authentication');
        }
        $this->principal = $principal = $login->login($request);

        $this->session->clear();
        $this->session->regenerateId();

        $this->values->offsetSet('principal', $principal);
        $now = microtime(true);
        $this->values->offsetSet('firstActive', $now);
        $this->values->offsetSet('lastActive', $now);

        $this->logger->info(
            "Authentication login: {user}",
            ['user' => $principal]
        );
        return $this->publishLogin($principal);
    }

    /**
     * Publishes the login event.
     *
     * @param \Caridea\Auth\Principal $principal The authenticated principal
     * @return bool Always true
     */
    protected function publishLogin(Principal $principal): bool
    {
        $this->publisher->publish(new Event\Login($this, $principal));
        return true;
    }

    /**
     * Resumes an existing authenticated session.
     *
     * @return bool If an authentication session existed
     */
    public function resume(): bool
    {
        if ($this->values->offsetExists('principal')) {
            $this->principal = $this->values->get('principal');

            $this->logger->info(
                "Authentication resume: {user}",
                ['user' => $this->principal]
            );
            $this->publishResume($this->principal, $this->values);

            $this->values->offsetSet('lastActive', microtime(true));

            return true;
        }
        return false;
    }

    /**
     * Publishes the resume event.
     *
     * @param \Caridea\Auth\Principal $principal The authenticated principal
     * @param \Caridea\Session\Map $values The session values
     */
    protected function publishResume(Principal $principal, Map $values)
    {
        $this->publisher->publish(new Event\Resume(
            $this,
            $principal,
            $values->get('firstActive') ?? 0.0,
            $values->get('lastActive') ?? 0.0
        ));
    }

    /**
     * Logs out the currently authenticated principal.
     *
     * @return bool If a principal existed in the session to log out
     */
    public function logout(): bool
    {
        if ($this->values->offsetExists('principal')) {
            $principal = $this->getPrincipal();
            $this->principal = Principal::getAnonymous();

            $this->session->destroy();

            $this->logger->info(
                "Authentication logout: {user}",
                ['user' => $principal]
            );
            return $this->publishLogout($principal);
        }
        return false;
    }

    /**
     * Publishes the logout event.
     *
     * @param \Caridea\Auth\Principal $principal The authenticated principal
     * @return bool Always true
     */
    protected function publishLogout(Principal $principal): bool
    {
        $this->publisher->publish(new Event\Logout($this, $principal));
        return true;
    }
}


1		<?php
2		declare(strict_types=1);
3		/**
4		* Caridea
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License"); you may not
7		* use this file except in compliance with the License. You may obtain a copy of
8		* the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14		* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15		* License for the specific language governing permissions and limitations under
16		* the License.
17		*
18		* @copyright 2015-2018 LibreWorks contributors
19		* @license Apache-2.0
20		*/
21		namespace Caridea\Auth;
22
23		use Caridea\Event\Publisher;
24		use Caridea\Session\Session;
25		use Caridea\Session\Map;
26		use Psr\Http\Message\ServerRequestInterface;
27
28		/**
29		* Authentication service.
30		*
31		* @copyright 2015-2018 LibreWorks contributors
32		* @license Apache-2.0
33		*/
34		class Service implements \Caridea\Event\PublisherAware
35		{
36		use \Psr\Log\LoggerAwareTrait;
37		use \Caridea\Event\PublisherSetter;
38
39		/**
40		* @var Adapter The default auth adapter
41		*/
42		protected $adapter;
43		/**
44		* @var \Caridea\Session\Session The session utility
45		*/
46		protected $session;
47		/**
48		* @var \Caridea\Session\Map The session values
49		*/
50		protected $values;
51		/**
52		* @var Principal The authenticated principal
53		*/
54		protected $principal;
55
56		/**
57		* Creates a new authentication service.
58		*
59		* @param Session $session The session utility
60		* @param Publisher $publisher An event publisher to broadcast authentication events
61		* @param Adapter $adapter A default authentication adapter
62		*/
63	4	public function __construct(Session $session, Publisher $publisher = null, Adapter $adapter = null)
64		{
65	4	$this->session = $session;
66	4	$this->values = $session->getValues(__CLASS__);
67	4	$this->publisher = $publisher ?? new \Caridea\Event\NullPublisher();
68	4	$this->adapter = $adapter;
69	4	$this->logger = new \Psr\Log\NullLogger();
70	4	}
71
72		/**
73		* Gets the currently authenticated principal.
74		*
75		* If no one is authenticated, this will return an anonymous Principal. If
76		* The session is not started but can be resumed, it will be resumed and the
77		* principal will be loaded.
78		*
79		* @return Principal the authenticated principal
80		*/
81	2	public function getPrincipal(): Principal
82		{
83	2	if ($this->principal === null && !$this->resume()) {
84	1	$this->principal = Principal::getAnonymous();
85		}
86	2	return $this->principal;
87		}
88
89		/**
90		* Authenticates a principal.
91		*
92		* @param ServerRequestInterface $request The Server Request message containing credentials
93		* @param Adapter $adapter An optional adapter to use.
94		* Will use the default authentication adapter if none is specified.
95		* @return bool Whether the session could be established
96		* @throws \InvalidArgumentException If no adapter is provided and no default adapter is set
97		* @throws Exception\UsernameNotFound if the provided username wasn't found
98		* @throws Exception\UsernameAmbiguous if the provided username matches multiple accounts
99		* @throws Exception\InvalidPassword if the provided password is invalid
100		* @throws Exception\ConnectionFailed if the access to a remote data source failed
101		* (e.g. missing flat file, unreachable LDAP server, database login denied)
102		*/
103	4	public function login(ServerRequestInterface $request, Adapter $adapter = null): bool
104		{
105	4	$started = $this->session->resume() \|\| $this->session->start();
106	4	if (!$started) {
107	1	return false;
108		}
109
110	3	$login = $adapter ?? $this->adapter;
111	3	if ($login === null) {
112	1	throw new \InvalidArgumentException('You must specify an adapter for authentication');
113		}
114	2	$this->principal = $principal = $login->login($request);
115
116	2	$this->session->clear();
117	2	$this->session->regenerateId();
118
119	2	$this->values->offsetSet('principal', $principal);
120	2	$now = microtime(true);
121	2	$this->values->offsetSet('firstActive', $now);
122	2	$this->values->offsetSet('lastActive', $now);
123
124	2	$this->logger->info(
125	2	"Authentication login: {user}",
126	2	['user' => $principal]
127		);
128	2	return $this->publishLogin($principal);
129		}
130
131		/**
132		* Publishes the login event.
133		*
134		* @param \Caridea\Auth\Principal $principal The authenticated principal
135		* @return bool Always true
136		*/
137	2	protected function publishLogin(Principal $principal): bool
138		{
139	2	$this->publisher->publish(new Event\Login($this, $principal));
140	2	return true;
141		}
142
143		/**
144		* Resumes an existing authenticated session.
145		*
146		* @return bool If an authentication session existed
147		*/
148	4	public function resume(): bool
149		{
150	4	if ($this->values->offsetExists('principal')) {
151	3	$this->principal = $this->values->get('principal');
152
153	3	$this->logger->info(
154	3	"Authentication resume: {user}",
155	3	['user' => $this->principal]
156		);
157	3	$this->publishResume($this->principal, $this->values);
158
159	3	$this->values->offsetSet('lastActive', microtime(true));
160
161	3	return true;
162		}
163	1	return false;
164		}
165
166		/**
167		* Publishes the resume event.
168		*
169		* @param \Caridea\Auth\Principal $principal The authenticated principal
170		* @param \Caridea\Session\Map $values The session values
171		*/
172	2	protected function publishResume(Principal $principal, Map $values)
173		{
174	2	$this->publisher->publish(new Event\Resume(
175	2	$this,
176	2	$principal,
177	2	$values->get('firstActive') ?? 0.0,
178	2	$values->get('lastActive') ?? 0.0
179		));
180	2	}
181
182		/**
183		* Logs out the currently authenticated principal.
184		*
185		* @return bool If a principal existed in the session to log out
186		*/
187	3	public function logout(): bool
188		{
189	3	if ($this->values->offsetExists('principal')) {
190	2	$principal = $this->getPrincipal();
191	2	$this->principal = Principal::getAnonymous();
192
193	2	$this->session->destroy();
194
195	2	$this->logger->info(
196	2	"Authentication logout: {user}",
197	2	['user' => $principal]
198		);
199	2	return $this->publishLogout($principal);
200		}
201	1	return false;
202		}
203
204		/**
205		* Publishes the logout event.
206		*
207		* @param \Caridea\Auth\Principal $principal The authenticated principal
208		* @return bool Always true
209		*/
210	2	protected function publishLogout(Principal $principal): bool
211		{
212	2	$this->publisher->publish(new Event\Logout($this, $principal));
213	2	return true;
214		}
215		}
216

libreworks / caridea-auth

Service::getPrincipal() A last analyzed 2018-01-06 18:23 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Service::getPrincipal() A
last analyzed 2018-01-06 18:23 UTC