InstitutionConfigurationController::showAction() - Code Metrics - Inspection of "Add authorization context to IdentityQuery" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#239)

by Michiel

created 2018-10-04 13:59 UTC

InstitutionConfigurationController::showAction() A

↳ Parent: InstitutionConfigurationController

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	35
rs	9.36
c	0
b	0
f	0
cc	2
nc	2
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 Psr\Log\LoggerInterface;
use Rhumsaa\Uuid\Uuid;
use Surfnet\Stepup\Configuration\Value\Institution;
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\TransactionAwarePipeline;
use Surfnet\StepupMiddleware\ManagementBundle\Service\DBALConnectionHelper;
use Surfnet\StepupMiddleware\ManagementBundle\Validator\Constraints\ValidReconfigureInstitutionsRequest;
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
{
    /**
     * @return InstitutionConfigurationOptionsService
     */
    private $institutionConfigurationOptionsService;

    /**
     * @return InstitutionAuthorizationService
     */
    private $institutionAuthorizationService;

    /**
     * @return DataCollectingValidator
     */
    private $validator;

    /**
     * @return AllowedSecondFactorListService
     */
    private $allowedSecondFactorListService;

    /**
     * @return LoggerInterface
     */
    private $logger;

    /**
     * @return TransactionAwarePipeline
     */
    private $pipeline;

    /**
     * @var DBALConnectionHelper
     */
    private $connectionHelper;

    public function __construct(
        InstitutionConfigurationOptionsService $institutionConfigurationOptionsService,
        InstitutionAuthorizationService $institutionAuthorizationService,
        DataCollectingValidator $dataCollectingValidator,
        AllowedSecondFactorListService $allowedSecondFactorListService,
        LoggerInterface $logger,
        TransactionAwarePipeline $pipeline,
        DBALConnectionHelper $dbalConnectionHelper
    ) {
        $this->institutionConfigurationOptionsService = $institutionConfigurationOptionsService;
        $this->institutionAuthorizationService = $institutionAuthorizationService;
        $this->validator = $dataCollectingValidator;
        $this->allowedSecondFactorListService = $allowedSecondFactorListService;
        $this->logger = $logger;
        $this->pipeline = $pipeline;
        $this->connectionHelper = $dbalConnectionHelper;
    }

    public function showAction()
    {
        $this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);

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

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

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

            // Get the authorization options for this institution
            $institutionConfigurationOptionsMap = $this->institutionAuthorizationService
                ->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->getAuthorizationOptionsByRole(InstitutionRole::useRa())->jsonSerialize(),
                'use_raa' => $institutionConfigurationOptionsMap->getAuthorizationOptionsByRole(InstitutionRole::useRaa())->jsonSerialize(),
                'select_raa' => $institutionConfigurationOptionsMap->getAuthorizationOptionsByRole(InstitutionRole::selectRaa())->jsonSerialize(),
            ];
        }

        return new JsonResponse($overview);
    }

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

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

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

        if (empty($configuration)) {
            $this->logger->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->logger->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)
    {
        $connectionHelper = $this->connectionHelper;

        $connectionHelper->beginTransaction();

        foreach ($commands as $command) {
            try {
                $this->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();
    }
}


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 Psr\Log\LoggerInterface;
25			use Rhumsaa\Uuid\Uuid;
26			use Surfnet\Stepup\Configuration\Value\Institution;
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\TransactionAwarePipeline;
37			use Surfnet\StepupMiddleware\ManagementBundle\Service\DBALConnectionHelper;
38			use Surfnet\StepupMiddleware\ManagementBundle\Validator\Constraints\ValidReconfigureInstitutionsRequest;
39			use Symfony\Bundle\FrameworkBundle\Controller\Controller;
40			use Symfony\Component\HttpFoundation\JsonResponse;
41			use Symfony\Component\HttpFoundation\Request;
42			use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
43
44			/**
45			* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
46			*/
47			final class InstitutionConfigurationController extends Controller
48			{
49			/**
50			* @return InstitutionConfigurationOptionsService
51			*/
52			private $institutionConfigurationOptionsService;
53
54			/**
55			* @return InstitutionAuthorizationService
56			*/
57			private $institutionAuthorizationService;
58
59			/**
60			* @return DataCollectingValidator
61			*/
62			private $validator;
63
64			/**
65			* @return AllowedSecondFactorListService
66			*/
67			private $allowedSecondFactorListService;
68
69			/**
70			* @return LoggerInterface
71			*/
72			private $logger;
73
74			/**
75			* @return TransactionAwarePipeline
76			*/
77			private $pipeline;
78
79			/**
80			* @var DBALConnectionHelper
81			*/
82			private $connectionHelper;
83
84			public function __construct(
85			InstitutionConfigurationOptionsService $institutionConfigurationOptionsService,
86			InstitutionAuthorizationService $institutionAuthorizationService,
87			DataCollectingValidator $dataCollectingValidator,
88			AllowedSecondFactorListService $allowedSecondFactorListService,
89			LoggerInterface $logger,
90			TransactionAwarePipeline $pipeline,
91			DBALConnectionHelper $dbalConnectionHelper
92			) {
93			$this->institutionConfigurationOptionsService = $institutionConfigurationOptionsService;
94			$this->institutionAuthorizationService = $institutionAuthorizationService;
95			$this->validator = $dataCollectingValidator;
96			$this->allowedSecondFactorListService = $allowedSecondFactorListService;
97			$this->logger = $logger;
98			$this->pipeline = $pipeline;
99			$this->connectionHelper = $dbalConnectionHelper;
100			}
101
102			public function showAction()
103			{
104			$this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);
105
106			$institutionConfigurationOptions = $this->institutionConfigurationOptionsService
107			->findAllInstitutionConfigurationOptions();
108
109			$allowedSecondFactorMap = $this->allowedSecondFactorListService->getAllowedSecondFactorMap();
110
111			$overview = [];
112			foreach ($institutionConfigurationOptions as $options) {
113			// Load the numberOfTokensPerIdentity from the institution config options service
114			$numberOfTokensPerIdentity = $this->institutionConfigurationOptionsService
115			->getMaxNumberOfTokensFor(new Institution($options->institution->getInstitution()));
116
117			// Get the authorization options for this institution
118			$institutionConfigurationOptionsMap = $this->institutionAuthorizationService
119			->findAuthorizationsFor($options->institution);
120
121			$overview[$options->institution->getInstitution()] = [
122			'use_ra_locations' => $options->useRaLocationsOption,
123			'show_raa_contact_information' => $options->showRaaContactInformationOption,
124			'verify_email' => $options->verifyEmailOption,
125			'number_of_tokens_per_identity' => $numberOfTokensPerIdentity,
126			'allowed_second_factors' => $allowedSecondFactorMap->getAllowedSecondFactorListFor(
127			$options->institution
128			),
129			'use_ra' => $institutionConfigurationOptionsMap->getAuthorizationOptionsByRole(InstitutionRole::useRa())->jsonSerialize(),
130			'use_raa' => $institutionConfigurationOptionsMap->getAuthorizationOptionsByRole(InstitutionRole::useRaa())->jsonSerialize(),
131			'select_raa' => $institutionConfigurationOptionsMap->getAuthorizationOptionsByRole(InstitutionRole::selectRaa())->jsonSerialize(),
132			];
133			}
134
135			return new JsonResponse($overview);
136			}
137
138			public function reconfigureAction(Request $request)
139			{
140			$this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);
141
142			$configuration = JsonHelper::decode($request->getContent());
143
144			$violations = $this->validator->validate($configuration, new ValidReconfigureInstitutionsRequest());
145			if ($violations->count() > 0) {
146			throw BadCommandRequestException::withViolations('Invalid reconfigure institutions request', $violations);
147			}
148
149			if (empty($configuration)) {
150			$this->logger->notice(sprintf('No institutions to reconfigure: empty configuration received'));
151
152			return new JsonResponse([
153			'status' => 'OK',
154			'processed_by' => $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
155			'applied_at' => (new DateTime())->format(DateTime::ISO8601),
156			]);
157			}
158
159			$commands = [];
160			foreach ($configuration as $institution => $options) {
161			$command = new ReconfigureInstitutionConfigurationOptionsCommand();
162			$command->UUID = (string) Uuid::uuid4();
163			$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...
164			$command->useRaLocationsOption = $options['use_ra_locations'];
165			$command->showRaaContactInformationOption = $options['show_raa_contact_information'];
166			$command->verifyEmailOption = $options['verify_email'];
167			$command->numberOfTokensPerIdentityOption = $options['number_of_tokens_per_identity'];
168			$command->allowedSecondFactors = $options['allowed_second_factors'];
169
170			// The useRa, useRaa and selectRaa options are optional
171			$command->useRaOption = isset($options['use_ra']) ? $options['use_ra'] : null;
172			$command->useRaaOption = isset($options['use_raa']) ? $options['use_raa'] : null;
173			$command->selectRaaOption = isset($options['select_raa']) ? $options['select_raa'] : null;
174
175			$commands[] = $command;
176			}
177
178			$this->logger->notice(
179			sprintf('Executing %s reconfigure institution configuration options commands', count($commands))
180			);
181
182			$this->handleCommands($commands);
183
184			return new JsonResponse([
185			'status' => 'OK',
186			'processed_by' => $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
187			'applied_at' => (new DateTime())->format(DateTime::ISO8601),
188			]);
189			}
190
191			/**
192			* @param Command[] $commands
193			* @throws Exception
194			*/
195			private function handleCommands(array $commands)
196			{
197			$connectionHelper = $this->connectionHelper;
198
199			$connectionHelper->beginTransaction();
200
201			foreach ($commands as $command) {
202			try {
203			$this->pipeline->process($command);
204			} catch (ForbiddenException $e) {
205			$connectionHelper->rollBack();
206
207			throw new AccessDeniedHttpException(
208			sprintf('Processing of command "%s" is forbidden for this client', $command),
209			$e
210			);
211			} catch (Exception $exception) {
212			$connectionHelper->rollBack();
213
214			throw $exception;
215			}
216			}
217
218			$connectionHelper->commit();
219			}
220			}
221

OpenConext / Stepup-Middleware

Pull Request — develop (#239)

InstitutionConfigurationController::showAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like