SymfonyClient::expireAuthentication() - Code Metrics - Visithor/VisithorBundle - Measure and Improve Code Quality continuously with Scrutinizer

SymfonyClient::expireAuthentication() A
last analyzed 2016-06-01 14:17 UTC

↳ Parent: SymfonyClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

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

<?php

/*
 * This file is part of the Visithor package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * Feel free to edit as you please, and have fun.
 *
 * @author Marc Morera <[email protected]>
 */

namespace Visithor\Bundle\Client;

use Exception;
use Symfony\Bundle\FrameworkBundle\Client as FrameworkClient;
use Symfony\Component\BrowserKit\Cookie;
use Symfony\Component\HttpFoundation\Session\SessionInterface;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;

use Visithor\Bundle\Environment\Interfaces\EnvironmentBuilderInterface;
use Visithor\Client\Interfaces\ClientInterface;
use Visithor\Model\Url;

/**
 * Class SymfonyClient
 */
class SymfonyClient implements ClientInterface
{
    /**
     * @var FrameworkClient
     *
     * Client
     */
    protected $client;

    /**
     * @var KernelInterface
     *
     * Kernel
     */
    protected $kernel;

    /**
     * @var SessionInterface
     *
     * Session
     */
    protected $session;

    /**
     * @var EnvironmentBuilderInterface
     *
     * Environment Builder
     */
    protected $environmentBuilder;

    /**
     * Construct
     *
     * @param EnvironmentBuilderInterface $environmentBuilder Environment Builder
     */
    public function __construct(
        SessionInterface $session,
        EnvironmentBuilderInterface $environmentBuilder = null,
        \AppKernel $kernel = null
    ) {
        $this->session = $session;
        $this->environmentBuilder = $environmentBuilder;
        $this->kernel = $kernel;
    }

    /**
     * Build client
     *
     * @return $this Self object
     */
    public function buildClient()
    {
        $this->kernel->boot();
        $this->session->clear();

        $this->client = $this
            ->kernel
            ->getContainer()
            ->get('test.client');

        $this
            ->environmentBuilder
            ->setUp($this->kernel);
    }

    /**
     * Get the HTTP Code Response given an URL instance
     *
     * @param Url $url Url
     *
     * @return int Response HTTP Code
     */
    public function getResponseHTTPCode(Url $url)
    {
        try {
            $this->authenticate($url);
            $verb = $url->getOption('verb', 'GET');

            $this
                ->client
                ->request($verb, $url->getPath());

            $result = $this
                ->client
                ->getResponse()
                ->getStatusCode();
        } catch (AccessDeniedHttpException $e) {
            $result = $e->getStatusCode();
        } catch (Exception $e) {
            $result = 'ERR';
        }

        $this->expireAuthentication($url);

        return $result;
    }

    /**
     * Authenticates a user if is needed.
     *
     * A user is needed to be authenticated if in the url a role and a firewall
     * is specified. Otherwise, the system will understand that is a public url
     *
     * @param Url $url Url
     *
     * @return $this Self object
     */
    protected function authenticate(Url $url)
    {
        if (
            !$url->getOption('role') ||
            !$url->getOption('firewall')
        ) {
            return $this;
        }

        $session = $this->session;
        $firewall = $url->getOption('firewall');
        $role = $url->getOption('role');
        $user = $this
            ->environmentBuilder
            ->getAuthenticationUser($url->getOption('role'));

        $token = new UsernamePasswordToken($user, null, $firewall, [$role]);
        $session->set('_security_' . $firewall, serialize($token));
        $session->save();

        $cookie = new Cookie(
            $session->getName(),
            $session->getId()
        );
        $this
            ->client
            ->getCookieJar()
            ->set($cookie);

        return $this;
    }

    /**
     * Expires the authentication if these has been created
     *
     * @param Url $url Url
     *
     * @return $this Self object
     */
    protected function expireAuthentication(Url $url)
    {
        $session = $this->session;
        $session->remove('_security_' . $url->getOption('firewall'));
        $session->save();

        $this
            ->client
            ->getCookieJar()
            ->expire($session->getName());

        return $this;
    }

    /**
     * Destroy client
     *
     * @return $this Self object
     */
    public function destroyClient()
    {
        $this
            ->environmentBuilder
            ->tearDown($this->kernel);
    }
}


1			<?php
2
3			/*
4			* This file is part of the Visithor package.
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*
9			* Feel free to edit as you please, and have fun.
10			*
11			* @author Marc Morera <[email protected]>
12			*/
13
14			namespace Visithor\Bundle\Client;
15
16			use Exception;
17			use Symfony\Bundle\FrameworkBundle\Client as FrameworkClient;
18			use Symfony\Component\BrowserKit\Cookie;
19			use Symfony\Component\HttpFoundation\Session\SessionInterface;
20			use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
21			use Symfony\Component\HttpKernel\KernelInterface;
22			use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
23
24			use Visithor\Bundle\Environment\Interfaces\EnvironmentBuilderInterface;
25			use Visithor\Client\Interfaces\ClientInterface;
26			use Visithor\Model\Url;
27
28			/**
29			* Class SymfonyClient
30			*/
31			class SymfonyClient implements ClientInterface
32			{
33			/**
34			* @var FrameworkClient
35			*
36			* Client
37			*/
38			protected $client;
39
40			/**
41			* @var KernelInterface
42			*
43			* Kernel
44			*/
45			protected $kernel;
46
47			/**
48			* @var SessionInterface
49			*
50			* Session
51			*/
52			protected $session;
53
54			/**
55			* @var EnvironmentBuilderInterface
56			*
57			* Environment Builder
58			*/
59			protected $environmentBuilder;
60
61			/**
62			* Construct
63			*
64			* @param EnvironmentBuilderInterface $environmentBuilder Environment Builder
65			*/
66			public function __construct(
67			SessionInterface $session,
68			EnvironmentBuilderInterface $environmentBuilder = null,
69			\AppKernel $kernel = null
70			) {
71			$this->session = $session;
72			$this->environmentBuilder = $environmentBuilder;
73			$this->kernel = $kernel;
74			}
75
76			/**
77			* Build client
78			*
79			* @return $this Self object
80			*/
81			public function buildClient()
82			{
83			$this->kernel->boot();
84			$this->session->clear();
85
86			$this->client = $this
87			->kernel
88			->getContainer()
89			->get('test.client');
90
91			$this
92			->environmentBuilder
93			->setUp($this->kernel);
94			}
95
96			/**
97			* Get the HTTP Code Response given an URL instance
98			*
99			* @param Url $url Url
100			*
101			* @return int Response HTTP Code
102			*/
103			public function getResponseHTTPCode(Url $url)
104			{
105			try {
106			$this->authenticate($url);
107			$verb = $url->getOption('verb', 'GET');
108
109			$this
110			->client
111			->request($verb, $url->getPath());
112
113			$result = $this
114			->client
115			->getResponse()
116			->getStatusCode();
117			} catch (AccessDeniedHttpException $e) {
118			$result = $e->getStatusCode();
119			} catch (Exception $e) {
120			$result = 'ERR';
121			}
122
123			$this->expireAuthentication($url);
124
125			return $result;
126			}
127
128			/**
129			* Authenticates a user if is needed.
130			*
131			* A user is needed to be authenticated if in the url a role and a firewall
132			* is specified. Otherwise, the system will understand that is a public url
133			*
134			* @param Url $url Url
135			*
136			* @return $this Self object
137			*/
138			protected function authenticate(Url $url)
139			{
140			if (
141			!$url->getOption('role') \|\|
142			!$url->getOption('firewall')
143			) {
144			return $this;
145			}
146
147			$session = $this->session;
148			$firewall = $url->getOption('firewall');
149			$role = $url->getOption('role');
150			$user = $this
151			->environmentBuilder
152			->getAuthenticationUser($url->getOption('role'));
153
154			$token = new UsernamePasswordToken($user, null, $firewall, [$role]);
155			$session->set('_security_' . $firewall, serialize($token));
156			$session->save();
157
158			$cookie = new Cookie(
159			$session->getName(),
160			$session->getId()
161			);
162			$this
163			->client
164			->getCookieJar()
165			->set($cookie);
166
167			return $this;
168			}
169
170			/**
171			* Expires the authentication if these has been created
172			*
173			* @param Url $url Url
174			*
175			* @return $this Self object
176			*/
177			protected function expireAuthentication(Url $url)
178			{
179			$session = $this->session;
180			$session->remove('_security_' . $url->getOption('firewall'));
181			$session->save();
182
183			$this
184			->client
185			->getCookieJar()
186			->expire($session->getName());
187
188			return $this;
189			}
190
191			/**
192			* Destroy client
193			*
194			* @return $this Self object
195			*/
196			public function destroyClient()
197			{
198			$this
199			->environmentBuilder
200			->tearDown($this->kernel);
201			}
202			}
203

Visithor / VisithorBundle

SymfonyClient::expireAuthentication() A last analyzed 2016-06-01 14:17 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SymfonyClient::expireAuthentication() A
last analyzed 2016-06-01 14:17 UTC