InstitutionConfigurationController::getValidator() - Code Metrics - Inspection of "Show institution configuration options" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#146)

by A.

created 2016-07-28 14:39 UTC

InstitutionConfigurationController::getValidator() A

↳ Parent: InstitutionConfigurationController

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	4
rs	10
c	1
b	0
f	0
cc	1
eloc	2
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 GuzzleHttp;
use Liip\FunctionalTestBundle\Validator\DataCollectingValidator;
use Rhumsaa\Uuid\Uuid;
use Surfnet\Stepup\Helper\JsonHelper;
use Surfnet\StepupMiddleware\ApiBundle\Configuration\Entity\InstitutionConfigurationOptions;
use Surfnet\StepupMiddleware\ApiBundle\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']);

        $response = array_map(
            function (InstitutionConfigurationOptions $options) {
                return [
                    $options->institution->getInstitution() => [
                        'use_ra_locations'             => $options->useRaLocationsOption->isEnabled(),
                        'show_raa_contact_information' => $options->showRaaContactInformationOption->isEnabled(),
                    ],
                ];
            },
            $this->getInstitutionConfigurationOptionsService()->findAllInstitutionConfigurationOptions()
        );

        return new JsonResponse($response);
    }

    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'];

            $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 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 GuzzleHttp;
24			use Liip\FunctionalTestBundle\Validator\DataCollectingValidator;
25			use Rhumsaa\Uuid\Uuid;
26			use Surfnet\Stepup\Helper\JsonHelper;
27			use Surfnet\StepupMiddleware\ApiBundle\Configuration\Entity\InstitutionConfigurationOptions;
28			use Surfnet\StepupMiddleware\ApiBundle\Service\InstitutionConfigurationOptionsService;
29			use Surfnet\StepupMiddleware\ApiBundle\Exception\BadCommandRequestException;
30			use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Command;
31			use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Command\ReconfigureInstitutionConfigurationOptionsCommand;
			0 ignored issues – show Coding Style introduced 2016-07-26 14:30 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 123 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
32			use Surfnet\StepupMiddleware\CommandHandlingBundle\Exception\ForbiddenException;
33			use Surfnet\StepupMiddleware\CommandHandlingBundle\Pipeline\Pipeline;
34			use Surfnet\StepupMiddleware\ManagementBundle\Service\DBALConnectionHelper;
35			use Surfnet\StepupMiddleware\ManagementBundle\Validator\Constraints\ValidReconfigureInstitutionsRequest;
36			use Symfony\Bridge\Monolog\Logger;
37			use Symfony\Bundle\FrameworkBundle\Controller\Controller;
38			use Symfony\Component\HttpFoundation\JsonResponse;
39			use Symfony\Component\HttpFoundation\Request;
40			use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
41
42			/**
43			* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
44			*/
45			final class InstitutionConfigurationController extends Controller
46			{
47			public function showAction()
48			{
49			$this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);
50
51			$response = array_map(
52			function (InstitutionConfigurationOptions $options) {
53			return [
54			$options->institution->getInstitution() => [
55			'use_ra_locations' => $options->useRaLocationsOption->isEnabled(),
56			'show_raa_contact_information' => $options->showRaaContactInformationOption->isEnabled(),
57			],
58			];
59			},
60			$this->getInstitutionConfigurationOptionsService()->findAllInstitutionConfigurationOptions()
61			);
62
63			return new JsonResponse($response);
64			}
65
66			public function reconfigureAction(Request $request)
67			{
68			$this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);
69
70			$configuration = JsonHelper::decode($request->getContent());
71
72			$violations = $this->getValidator()->validate($configuration, new ValidReconfigureInstitutionsRequest());
73			if ($violations->count() > 0) {
74			throw BadCommandRequestException::withViolations('Invalid reconfigure institutions request', $violations);
75			}
76
77			if (empty($configuration)) {
78			$this->getLogger()->notice(sprintf('No institutions to reconfigure: empty configuration received'));
79
80			return new JsonResponse([
81			'status' => 'OK',
82			'processed_by' => $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
83			'applied_at' => (new DateTime())->format(DateTime::ISO8601),
84			]);
85			}
86
87			$commands = [];
88			foreach ($configuration as $institution => $options) {
89			$command = new ReconfigureInstitutionConfigurationOptionsCommand();
90			$command->UUID = (string) Uuid::uuid4();
91			$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...
92			$command->useRaLocationsOption = $options['use_ra_locations'];
93			$command->showRaaContactInformationOption = $options['show_raa_contact_information'];
94
95			$commands[] = $command;
96			}
97
98			$this->getLogger()->notice(
99			sprintf('Executing %s reconfigure institution configuration options commands', count($commands))
100			);
101
102			$this->handleCommands($commands);
103
104			return new JsonResponse([
105			'status' => 'OK',
106			'processed_by' => $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
107			'applied_at' => (new DateTime())->format(DateTime::ISO8601),
108			]);
109			}
110
111			/**
112			* @param Command[] $commands
113			* @throws Exception
114			*/
115			private function handleCommands(array $commands)
116			{
117			$pipeline = $this->getPipeline();
118			$connectionHelper = $this->getConnectionHelper();
119
120			$connectionHelper->beginTransaction();
121
122			foreach ($commands as $command) {
123			try {
124			$pipeline->process($command);
125			} catch (ForbiddenException $e) {
126			$connectionHelper->rollBack();
127
128			throw new AccessDeniedHttpException(
129			sprintf('Processing of command "%s" is forbidden for this client', $command),
130			$e
131			);
132			} catch (Exception $exception) {
133			$connectionHelper->rollBack();
134
135			throw $exception;
136			}
137			}
138
139			$connectionHelper->commit();
140			}
141
142			/**
143			* @return InstitutionConfigurationOptionsService
144			*/
145			private function getInstitutionConfigurationOptionsService()
146			{
147			return $this->get('surfnet_stepup_middleware_api.service.institution_configuration_options');
148			}
149
150			/**
151			* @return DataCollectingValidator
152			*/
153			private function getValidator()
154			{
155			return $this->get('validator');
156			}
157
158			/**
159			* @return Logger
160			*/
161			private function getLogger()
162			{
163			return $this->get('logger');
164			}
165
166			/**
167			* @return Pipeline
168			*/
169			private function getPipeline()
170			{
171			return $this->get('pipeline');
172			}
173
174			/**
175			* @return DBALConnectionHelper
176			*/
177			private function getConnectionHelper()
178			{
179			return $this->get('surfnet_stepup_middleware_management.dbal_connection_helper');
180			}
181			}
182

OpenConext / Stepup-Middleware

Pull Request — develop (#146)

InstitutionConfigurationController::getValidator() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like