ApiKeyAuthenticationHandler::__construct() - Code Metrics - Inspection of "update license year" - Ma27/Ma27ApiKeyAuthenticationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (0737e3)

by Maximilian

created 2016-11-18 22:28 UTC

ApiKeyAuthenticationHandler::__construct() A

↳ Parent: ApiKeyAuthenticationHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	15
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	15
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	13
nc	1
nop	6

<?php

namespace Ma27\ApiKeyAuthenticationBundle\Service\Auth;

use Doctrine\Common\Persistence\ObjectManager;
use Ma27\ApiKeyAuthenticationBundle\Event\OnAuthenticationEvent;
use Ma27\ApiKeyAuthenticationBundle\Event\OnInvalidCredentialsEvent;
use Ma27\ApiKeyAuthenticationBundle\Event\OnLogoutEvent;
use Ma27\ApiKeyAuthenticationBundle\Exception\CredentialException;
use Ma27\ApiKeyAuthenticationBundle\Ma27ApiKeyAuthenticationEvents;
use Ma27\ApiKeyAuthenticationBundle\Service\Key\KeyFactoryInterface;
use Ma27\ApiKeyAuthenticationBundle\Service\Password\PasswordHasherInterface;
use Ma27\ApiKeyAuthenticationBundle\Service\Mapping\ClassMetadata;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

/**
 * Concrete handler for api key authorization.
 */
class ApiKeyAuthenticationHandler implements AuthenticationHandlerInterface
{
    /**
     * @var ObjectManager
     */
    private $om;

    /**
     * @var PasswordHasherInterface
     */
    private $passwordHasher;

    /**
     * @var KeyFactoryInterface
     */
    private $keyFactory;

    /**
     * @var EventDispatcherInterface
     */
    private $eventDispatcher;

    /**
     * @var string
     */
    private $modelName;

    /**
     * @var ClassMetadata
     */
    private $classMetadata;

    /**
     * Constructor.
     *
     * @param ObjectManager            $om
     * @param PasswordHasherInterface  $passwordHasher
     * @param KeyFactoryInterface      $keyFactory
     * @param EventDispatcherInterface $dispatcher
     * @param string                   $modelName
     * @param ClassMetadata            $metadata
     */
    public function __construct(
        ObjectManager $om,
        PasswordHasherInterface $passwordHasher,
        KeyFactoryInterface $keyFactory,
        EventDispatcherInterface $dispatcher,
        $modelName,
        ClassMetadata $metadata
    ) {
        $this->om = $om;
        $this->passwordHasher = $passwordHasher;
        $this->keyFactory = $keyFactory;
        $this->eventDispatcher = $dispatcher;
        $this->modelName = (string) $modelName;
        $this->classMetadata = $metadata;
    }

    /**
     * {@inheritdoc}
     */
    public function authenticate(array $credentials)
    {
        $loginProperty = $this->classMetadata->getPropertyName(ClassMetadata::LOGIN_PROPERTY);
        $passwordProperty = $this->classMetadata->getPropertyName(ClassMetadata::PASSWORD_PROPERTY);

        if (!array_key_exists($passwordProperty, $credentials)) {
            throw new \InvalidArgumentException(
                sprintf('Unable to find password property "%s" in credential set!', $passwordProperty)
            );
        }

        if (!array_key_exists($loginProperty, $credentials)) {
            throw new \InvalidArgumentException(
                sprintf('Unable to find login property "%s" in credential set!', $loginProperty)
            );
        }

        $objectRepository = $this->om->getRepository($this->modelName);
        $object = $objectRepository->findOneBy(array($loginProperty => $credentials[$loginProperty]));

        if (null === $object || !$this->passwordHasher->compareWith($object->getPassword(), $credentials[$passwordProperty])) {
            $this->eventDispatcher->dispatch(Ma27ApiKeyAuthenticationEvents::CREDENTIAL_FAILURE, new OnInvalidCredentialsEvent($object));

            throw new CredentialException();
        }

        $this->eventDispatcher->dispatch(Ma27ApiKeyAuthenticationEvents::AUTHENTICATION, new OnAuthenticationEvent($object));

        $key = $this->classMetadata->getPropertyValue($object, ClassMetadata::API_KEY_PROPERTY);
        if (empty($key)) {
            $this->classMetadata->modifyProperty($object, $this->keyFactory->getKey(), ClassMetadata::API_KEY_PROPERTY);
        }

        $this->om->persist($object);

        $this->om->flush();

        return $object;
    }

    /**
     * {@inheritdoc}
     */
    public function removeSession($user, $purgeJob = false)
    {
        $this->classMetadata->modifyProperty($user, null, ClassMetadata::API_KEY_PROPERTY);

        $event = new OnLogoutEvent($user);
        if ($purgeJob) {
            $event->markAsPurgeJob();
        }

        $this->eventDispatcher->dispatch(Ma27ApiKeyAuthenticationEvents::LOGOUT, $event);

        $this->om->persist($user);

        // on purge jobs one big flush will be commited to the db after the whole action
        if (!$purgeJob) {
            $this->om->flush();
        }
    }

    /**
     * Getter for the object manager.
     *
     * @return ObjectManager
     */
    protected function getOm()
    {
        return $this->om;
    }

    /**
     * Getter for the password hasher.
     *
     * @return PasswordHasherInterface
     */
    protected function getPasswordHasher()
    {
        return $this->passwordHasher;
    }

    /**
     * Getter for the key factory.
     *
     * @return KeyFactoryInterface
     */
    protected function getKeyFactory()
    {
        return $this->keyFactory;
    }

    /**
     * Getter for the dispatcher.
     *
     * @return EventDispatcherInterface
     */
    protected function getEventDispatcher()
    {
        return $this->eventDispatcher;
    }

    /**
     * Getter for the model name.
     *
     * @return string
     */
    protected function getModelName()
    {
        return $this->modelName;
    }

    /**
     * @return ClassMetadata
     */
    public function getClassMetadata()
    {
        return $this->classMetadata;
    }
}


1			<?php
2
3			namespace Ma27\ApiKeyAuthenticationBundle\Service\Auth;
4
5			use Doctrine\Common\Persistence\ObjectManager;
6			use Ma27\ApiKeyAuthenticationBundle\Event\OnAuthenticationEvent;
7			use Ma27\ApiKeyAuthenticationBundle\Event\OnInvalidCredentialsEvent;
8			use Ma27\ApiKeyAuthenticationBundle\Event\OnLogoutEvent;
9			use Ma27\ApiKeyAuthenticationBundle\Exception\CredentialException;
10			use Ma27\ApiKeyAuthenticationBundle\Ma27ApiKeyAuthenticationEvents;
11			use Ma27\ApiKeyAuthenticationBundle\Service\Key\KeyFactoryInterface;
12			use Ma27\ApiKeyAuthenticationBundle\Service\Password\PasswordHasherInterface;
13			use Ma27\ApiKeyAuthenticationBundle\Service\Mapping\ClassMetadata;
14			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
15
16			/**
17			* Concrete handler for api key authorization.
18			*/
19			class ApiKeyAuthenticationHandler implements AuthenticationHandlerInterface
20			{
21			/**
22			* @var ObjectManager
23			*/
24			private $om;
25
26			/**
27			* @var PasswordHasherInterface
28			*/
29			private $passwordHasher;
30
31			/**
32			* @var KeyFactoryInterface
33			*/
34			private $keyFactory;
35
36			/**
37			* @var EventDispatcherInterface
38			*/
39			private $eventDispatcher;
40
41			/**
42			* @var string
43			*/
44			private $modelName;
45
46			/**
47			* @var ClassMetadata
48			*/
49			private $classMetadata;
50
51			/**
52			* Constructor.
53			*
54			* @param ObjectManager $om
55			* @param PasswordHasherInterface $passwordHasher
56			* @param KeyFactoryInterface $keyFactory
57			* @param EventDispatcherInterface $dispatcher
58			* @param string $modelName
59			* @param ClassMetadata $metadata
60			*/
61			public function __construct(
62			ObjectManager $om,
63			PasswordHasherInterface $passwordHasher,
64			KeyFactoryInterface $keyFactory,
65			EventDispatcherInterface $dispatcher,
66			$modelName,
67			ClassMetadata $metadata
68			) {
69			$this->om = $om;
70			$this->passwordHasher = $passwordHasher;
71			$this->keyFactory = $keyFactory;
72			$this->eventDispatcher = $dispatcher;
73			$this->modelName = (string) $modelName;
74			$this->classMetadata = $metadata;
75			}
76
77			/**
78			* {@inheritdoc}
79			*/
80			public function authenticate(array $credentials)
81			{
82			$loginProperty = $this->classMetadata->getPropertyName(ClassMetadata::LOGIN_PROPERTY);
83			$passwordProperty = $this->classMetadata->getPropertyName(ClassMetadata::PASSWORD_PROPERTY);
84
85			if (!array_key_exists($passwordProperty, $credentials)) {
86			throw new \InvalidArgumentException(
87			sprintf('Unable to find password property "%s" in credential set!', $passwordProperty)
88			);
89			}
90
91			if (!array_key_exists($loginProperty, $credentials)) {
92			throw new \InvalidArgumentException(
93			sprintf('Unable to find login property "%s" in credential set!', $loginProperty)
94			);
95			}
96
97			$objectRepository = $this->om->getRepository($this->modelName);
98			$object = $objectRepository->findOneBy(array($loginProperty => $credentials[$loginProperty]));
99
100			if (null === $object \|\| !$this->passwordHasher->compareWith($object->getPassword(), $credentials[$passwordProperty])) {
101			$this->eventDispatcher->dispatch(Ma27ApiKeyAuthenticationEvents::CREDENTIAL_FAILURE, new OnInvalidCredentialsEvent($object));
102
103			throw new CredentialException();
104			}
105
106			$this->eventDispatcher->dispatch(Ma27ApiKeyAuthenticationEvents::AUTHENTICATION, new OnAuthenticationEvent($object));
107
108			$key = $this->classMetadata->getPropertyValue($object, ClassMetadata::API_KEY_PROPERTY);
109			if (empty($key)) {
110			$this->classMetadata->modifyProperty($object, $this->keyFactory->getKey(), ClassMetadata::API_KEY_PROPERTY);
111			}
112
113			$this->om->persist($object);
114
115			$this->om->flush();
116
117			return $object;
118			}
119
120			/**
121			* {@inheritdoc}
122			*/
123			public function removeSession($user, $purgeJob = false)
124			{
125			$this->classMetadata->modifyProperty($user, null, ClassMetadata::API_KEY_PROPERTY);
126
127			$event = new OnLogoutEvent($user);
128			if ($purgeJob) {
129			$event->markAsPurgeJob();
130			}
131
132			$this->eventDispatcher->dispatch(Ma27ApiKeyAuthenticationEvents::LOGOUT, $event);
133
134			$this->om->persist($user);
135
136			// on purge jobs one big flush will be commited to the db after the whole action
137			if (!$purgeJob) {
138			$this->om->flush();
139			}
140			}
141
142			/**
143			* Getter for the object manager.
144			*
145			* @return ObjectManager
146			*/
147			protected function getOm()
148			{
149			return $this->om;
150			}
151
152			/**
153			* Getter for the password hasher.
154			*
155			* @return PasswordHasherInterface
156			*/
157			protected function getPasswordHasher()
158			{
159			return $this->passwordHasher;
160			}
161
162			/**
163			* Getter for the key factory.
164			*
165			* @return KeyFactoryInterface
166			*/
167			protected function getKeyFactory()
168			{
169			return $this->keyFactory;
170			}
171
172			/**
173			* Getter for the dispatcher.
174			*
175			* @return EventDispatcherInterface
176			*/
177			protected function getEventDispatcher()
178			{
179			return $this->eventDispatcher;
180			}
181
182			/**
183			* Getter for the model name.
184			*
185			* @return string
186			*/
187			protected function getModelName()
188			{
189			return $this->modelName;
190			}
191
192			/**
193			* @return ClassMetadata
194			*/
195			public function getClassMetadata()
196			{
197			return $this->classMetadata;
198			}
199			}
200

Ma27 / Ma27ApiKeyAuthenticationBundle

GitHub Access Token became invalid

Branch — develop (0737e3)

ApiKeyAuthenticationHandler::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like