InstitutionConfigurationController::getInstitutionAuthorizationService() - Code Metrics - Inspection of "Fix default value for authorizations" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/authz-service ( 2625fb...8f3145 )

unknown

created 2018-09-30 19:15 UTC

getInstitutionAuthorizationService() A

↳ Parent: InstitutionConfigurationController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/**
 * Copyright 2016 SURFnet B.V.
 *
 * 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.
 */

namespace Surfnet\StepupMiddleware\ManagementBundle\Controller;

use DateTime;
use Exception;
use Liip\FunctionalTestBundle\Validator\DataCollectingValidator;
use Rhumsaa\Uuid\Uuid;
use Surfnet\Stepup\Configuration\Value\Institution;
use Surfnet\Stepup\Configuration\Value\InstitutionAuthorizationOptionMap;
use Surfnet\Stepup\Configuration\Value\InstitutionRole;
use Surfnet\Stepup\Helper\JsonHelper;
use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\AllowedSecondFactorListService;
use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\InstitutionAuthorizationService;
use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\InstitutionConfigurationOptionsService;
use Surfnet\StepupMiddleware\ApiBundle\Exception\BadCommandRequestException;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Command;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Command\ReconfigureInstitutionConfigurationOptionsCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Exception\ForbiddenException;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Pipeline\Pipeline;
use Surfnet\StepupMiddleware\ManagementBundle\Service\DBALConnectionHelper;
use Surfnet\StepupMiddleware\ManagementBundle\Validator\Constraints\ValidReconfigureInstitutionsRequest;
use Symfony\Bridge\Monolog\Logger;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
final class InstitutionConfigurationController extends Controller
{
    public function showAction()
    {
        $this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);

        $institutionConfigurationOptions = $this->getInstitutionConfigurationOptionsService()
            ->findAllInstitutionConfigurationOptions();

        $allowedSecondFactorMap = $this->getAllowedSecondFactorListService()->getAllowedSecondFactorMap();

        $overview = [];
        foreach ($institutionConfigurationOptions as $options) {
            // Load the numberOfTokensPerIdentity from the institution config options service
            $numberOfTokensPerIdentity = $this->getInstitutionConfigurationOptionsService()
                ->getMaxNumberOfTokensFor(new Institution($options->institution->getInstitution()));

            // Get the authorization options for this institution
            $institutionConfigurationOptionsMap = $this->getInstitutionAuthorizationService()
                ->findAuthorizationsFor($options->institution);

            $overview[$options->institution->getInstitution()] = [
                'use_ra_locations' => $options->useRaLocationsOption,
                'show_raa_contact_information' => $options->showRaaContactInformationOption,
                'verify_email' => $options->verifyEmailOption,
                'number_of_tokens_per_identity' => $numberOfTokensPerIdentity,
                'allowed_second_factors' => $allowedSecondFactorMap->getAllowedSecondFactorListFor(
                    $options->institution
                ),
                'use_ra' => $institutionConfigurationOptionsMap->getInstitutionAuthorizationOptionsByRole(InstitutionRole::useRa())->jsonSerialize(),
                'use_raa' => $institutionConfigurationOptionsMap->getInstitutionAuthorizationOptionsByRole(InstitutionRole::useRaa())->jsonSerialize(),
                'select_raa' => $institutionConfigurationOptionsMap->getInstitutionAuthorizationOptionsByRole(InstitutionRole::selectRaa())->jsonSerialize(),
            ];
        }

        return new JsonResponse($overview);
    }

    public function reconfigureAction(Request $request)
    {
        $this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);

        $configuration = JsonHelper::decode($request->getContent());

        $violations = $this->getValidator()->validate($configuration, new ValidReconfigureInstitutionsRequest());
        if ($violations->count() > 0) {
            throw BadCommandRequestException::withViolations('Invalid reconfigure institutions request', $violations);
        }

        if (empty($configuration)) {
            $this->getLogger()->notice(sprintf('No institutions to reconfigure: empty configuration received'));

            return new JsonResponse([
                'status'       => 'OK',
                'processed_by' =>  $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
                'applied_at'   => (new DateTime())->format(DateTime::ISO8601),
            ]);
        }

        $commands = [];
        foreach ($configuration as $institution => $options) {
            $command                                  = new ReconfigureInstitutionConfigurationOptionsCommand();
            $command->UUID                            = (string) Uuid::uuid4();
            $command->institution                     = $institution;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            $command->useRaLocationsOption            = $options['use_ra_locations'];
            $command->showRaaContactInformationOption = $options['show_raa_contact_information'];
            $command->verifyEmailOption               = $options['verify_email'];
            $command->numberOfTokensPerIdentityOption = $options['number_of_tokens_per_identity'];
            $command->allowedSecondFactors            = $options['allowed_second_factors'];

            // The useRa, useRaa and selectRaa options are optional
            $command->useRaOption = isset($options['use_ra']) ? $options['use_ra'] : null;
            $command->useRaaOption = isset($options['use_raa']) ? $options['use_raa'] : null;
            $command->selectRaaOption = isset($options['select_raa']) ? $options['select_raa'] : null;

            $commands[] = $command;
        }

        $this->getLogger()->notice(
            sprintf('Executing %s reconfigure institution configuration options commands', count($commands))
        );

        $this->handleCommands($commands);

        return new JsonResponse([
            'status'       => 'OK',
            'processed_by' =>  $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
            'applied_at'   => (new DateTime())->format(DateTime::ISO8601),
        ]);
    }

    /**
     * @param Command[] $commands
     * @throws Exception
     */
    private function handleCommands(array $commands)
    {
        $pipeline         = $this->getPipeline();
        $connectionHelper = $this->getConnectionHelper();

        $connectionHelper->beginTransaction();

        foreach ($commands as $command) {
            try {
                $pipeline->process($command);
            } catch (ForbiddenException $e) {
                $connectionHelper->rollBack();

                throw new AccessDeniedHttpException(
                    sprintf('Processing of command "%s" is forbidden for this client', $command),
                    $e
                );
            } catch (Exception $exception) {
                $connectionHelper->rollBack();

                throw $exception;
            }
        }

        $connectionHelper->commit();
    }

    /**
     * @return InstitutionConfigurationOptionsService
     */
    private function getInstitutionConfigurationOptionsService()
    {
        return $this->get('surfnet_stepup_middleware_api.service.institution_configuration_options');
    }

    /**
     * @return InstitutionAuthorizationService
     */
    private function getInstitutionAuthorizationService()
    {
        return $this->get('surfnet_stepup_middleware_api.service.institution_authorization');
    }

    /**
     * @return AllowedSecondFactorListService
     */
    private function getAllowedSecondFactorListService()
    {
        return $this->get('surfnet_stepup_middleware_api.service.allowed_second_factor_list');
    }

    /**
     * @return DataCollectingValidator
     */
    private function getValidator()
    {
        return $this->get('validator');
    }

    /**
     * @return Logger
     */
    private function getLogger()
    {
        return $this->get('logger');
    }

    /**
     * @return Pipeline
     */
    private function getPipeline()
    {
        return $this->get('pipeline');
    }

    /**
     * @return DBALConnectionHelper
     */
    private function getConnectionHelper()
    {
        return $this->get('surfnet_stepup_middleware_management.dbal_connection_helper');
    }
}


1			<?php
2
3			/**
4			* Copyright 2016 SURFnet B.V.
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of 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,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19			namespace Surfnet\StepupMiddleware\ManagementBundle\Controller;
20
21			use DateTime;
22			use Exception;
23			use Liip\FunctionalTestBundle\Validator\DataCollectingValidator;
24			use Rhumsaa\Uuid\Uuid;
25			use Surfnet\Stepup\Configuration\Value\Institution;
26			use Surfnet\Stepup\Configuration\Value\InstitutionAuthorizationOptionMap;
27			use Surfnet\Stepup\Configuration\Value\InstitutionRole;
28			use Surfnet\Stepup\Helper\JsonHelper;
29			use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\AllowedSecondFactorListService;
30			use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\InstitutionAuthorizationService;
31			use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\InstitutionConfigurationOptionsService;
32			use Surfnet\StepupMiddleware\ApiBundle\Exception\BadCommandRequestException;
33			use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Command;
34			use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Command\ReconfigureInstitutionConfigurationOptionsCommand;
35			use Surfnet\StepupMiddleware\CommandHandlingBundle\Exception\ForbiddenException;
36			use Surfnet\StepupMiddleware\CommandHandlingBundle\Pipeline\Pipeline;
37			use Surfnet\StepupMiddleware\ManagementBundle\Service\DBALConnectionHelper;
38			use Surfnet\StepupMiddleware\ManagementBundle\Validator\Constraints\ValidReconfigureInstitutionsRequest;
39			use Symfony\Bridge\Monolog\Logger;
40			use Symfony\Bundle\FrameworkBundle\Controller\Controller;
41			use Symfony\Component\HttpFoundation\JsonResponse;
42			use Symfony\Component\HttpFoundation\Request;
43			use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
44
45			/**
46			* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
47			*/
48			final class InstitutionConfigurationController extends Controller
49			{
50			public function showAction()
51			{
52			$this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);
53
54			$institutionConfigurationOptions = $this->getInstitutionConfigurationOptionsService()
55			->findAllInstitutionConfigurationOptions();
56
57			$allowedSecondFactorMap = $this->getAllowedSecondFactorListService()->getAllowedSecondFactorMap();
58
59			$overview = [];
60			foreach ($institutionConfigurationOptions as $options) {
61			// Load the numberOfTokensPerIdentity from the institution config options service
62			$numberOfTokensPerIdentity = $this->getInstitutionConfigurationOptionsService()
63			->getMaxNumberOfTokensFor(new Institution($options->institution->getInstitution()));
64
65			// Get the authorization options for this institution
66			$institutionConfigurationOptionsMap = $this->getInstitutionAuthorizationService()
67			->findAuthorizationsFor($options->institution);
68
69			$overview[$options->institution->getInstitution()] = [
70			'use_ra_locations' => $options->useRaLocationsOption,
71			'show_raa_contact_information' => $options->showRaaContactInformationOption,
72			'verify_email' => $options->verifyEmailOption,
73			'number_of_tokens_per_identity' => $numberOfTokensPerIdentity,
74			'allowed_second_factors' => $allowedSecondFactorMap->getAllowedSecondFactorListFor(
75			$options->institution
76			),
77			'use_ra' => $institutionConfigurationOptionsMap->getInstitutionAuthorizationOptionsByRole(InstitutionRole::useRa())->jsonSerialize(),
78			'use_raa' => $institutionConfigurationOptionsMap->getInstitutionAuthorizationOptionsByRole(InstitutionRole::useRaa())->jsonSerialize(),
79			'select_raa' => $institutionConfigurationOptionsMap->getInstitutionAuthorizationOptionsByRole(InstitutionRole::selectRaa())->jsonSerialize(),
80			];
81			}
82
83			return new JsonResponse($overview);
84			}
85
86			public function reconfigureAction(Request $request)
87			{
88			$this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);
89
90			$configuration = JsonHelper::decode($request->getContent());
91
92			$violations = $this->getValidator()->validate($configuration, new ValidReconfigureInstitutionsRequest());
93			if ($violations->count() > 0) {
94			throw BadCommandRequestException::withViolations('Invalid reconfigure institutions request', $violations);
95			}
96
97			if (empty($configuration)) {
98			$this->getLogger()->notice(sprintf('No institutions to reconfigure: empty configuration received'));
99
100			return new JsonResponse([
101			'status' => 'OK',
102			'processed_by' => $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
103			'applied_at' => (new DateTime())->format(DateTime::ISO8601),
104			]);
105			}
106
107			$commands = [];
108			foreach ($configuration as $institution => $options) {
109			$command = new ReconfigureInstitutionConfigurationOptionsCommand();
110			$command->UUID = (string) Uuid::uuid4();
111			$command->institution = $institution;
			0 ignored issues – show Documentation Bug introduced 2016-07-26 14:30 UTC by Report Bug Copy Issue Report It seems like `$institution` can also be of type `integer`. However, the property `$institution` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
112			$command->useRaLocationsOption = $options['use_ra_locations'];
113			$command->showRaaContactInformationOption = $options['show_raa_contact_information'];
114			$command->verifyEmailOption = $options['verify_email'];
115			$command->numberOfTokensPerIdentityOption = $options['number_of_tokens_per_identity'];
116			$command->allowedSecondFactors = $options['allowed_second_factors'];
117
118			// The useRa, useRaa and selectRaa options are optional
119			$command->useRaOption = isset($options['use_ra']) ? $options['use_ra'] : null;
120			$command->useRaaOption = isset($options['use_raa']) ? $options['use_raa'] : null;
121			$command->selectRaaOption = isset($options['select_raa']) ? $options['select_raa'] : null;
122
123			$commands[] = $command;
124			}
125
126			$this->getLogger()->notice(
127			sprintf('Executing %s reconfigure institution configuration options commands', count($commands))
128			);
129
130			$this->handleCommands($commands);
131
132			return new JsonResponse([
133			'status' => 'OK',
134			'processed_by' => $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
135			'applied_at' => (new DateTime())->format(DateTime::ISO8601),
136			]);
137			}
138
139			/**
140			* @param Command[] $commands
141			* @throws Exception
142			*/
143			private function handleCommands(array $commands)
144			{
145			$pipeline = $this->getPipeline();
146			$connectionHelper = $this->getConnectionHelper();
147
148			$connectionHelper->beginTransaction();
149
150			foreach ($commands as $command) {
151			try {
152			$pipeline->process($command);
153			} catch (ForbiddenException $e) {
154			$connectionHelper->rollBack();
155
156			throw new AccessDeniedHttpException(
157			sprintf('Processing of command "%s" is forbidden for this client', $command),
158			$e
159			);
160			} catch (Exception $exception) {
161			$connectionHelper->rollBack();
162
163			throw $exception;
164			}
165			}
166
167			$connectionHelper->commit();
168			}
169
170			/**
171			* @return InstitutionConfigurationOptionsService
172			*/
173			private function getInstitutionConfigurationOptionsService()
174			{
175			return $this->get('surfnet_stepup_middleware_api.service.institution_configuration_options');
176			}
177
178			/**
179			* @return InstitutionAuthorizationService
180			*/
181			private function getInstitutionAuthorizationService()
182			{
183			return $this->get('surfnet_stepup_middleware_api.service.institution_authorization');
184			}
185
186			/**
187			* @return AllowedSecondFactorListService
188			*/
189			private function getAllowedSecondFactorListService()
190			{
191			return $this->get('surfnet_stepup_middleware_api.service.allowed_second_factor_list');
192			}
193
194			/**
195			* @return DataCollectingValidator
196			*/
197			private function getValidator()
198			{
199			return $this->get('validator');
200			}
201
202			/**
203			* @return Logger
204			*/
205			private function getLogger()
206			{
207			return $this->get('logger');
208			}
209
210			/**
211			* @return Pipeline
212			*/
213			private function getPipeline()
214			{
215			return $this->get('pipeline');
216			}
217
218			/**
219			* @return DBALConnectionHelper
220			*/
221			private function getConnectionHelper()
222			{
223			return $this->get('surfnet_stepup_middleware_management.dbal_connection_helper');
224			}
225			}
226

OpenConext / Stepup-Middleware

Push — feature/authz-service ( 2625fb...8f3145 )

getInstitutionAuthorizationService() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like