RaaController::getInstitutionConfigurationOptionsService() - Code Metrics - Inspection of "Add the RAA institution switcher" - OpenConext/Stepup-RA - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — feature/fine-grained-authoriza... (#177)

by Michiel

created 2018-10-30 13:15 UTC

getInstitutionConfigurationOptionsService() A

↳ Parent: RaaController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * Copyright 2018 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\StepupRa\RaBundle\Controller;

use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\Identity;
use Surfnet\StepupRa\RaBundle\Command\ChangeRaaInstitutionCommand;
use Surfnet\StepupRa\RaBundle\Form\Type\RaaInstitutionSelectionType;
use Surfnet\StepupRa\RaBundle\Security\Authentication\Token\SamlToken;
use Surfnet\StepupRa\RaBundle\Service\InstitutionConfigurationOptionsService;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;

class RaaController extends Controller
{
    public function selectInstitutionAction(Request $request)
    {
        $this->denyAccessUnlessGranted(['ROLE_RAA']);

        /** @var SamlToken $token */
        $token  = $this->get('security.token_storage')->getToken();
        $logger = $this->get('logger');

        /** @var Identity $identity */
        $identity = $token->getUser();
        $institution = $identity->institution;

        $logger->notice(sprintf('Select Institution for RAA "%s"', $identity->id));

        $raaSwitcherOptions = $this
            ->getInstitutionConfigurationOptionsService()
            ->getAvailableInstitutionsFor($token->getIdentityInstitution());

        $command = new ChangeRaaInstitutionCommand();
        $command->institution = $institution;
        $command->availableInstitutions = $raaSwitcherOptions;

        $form = $this->createForm(RaaInstitutionSelectionType::class, $command);
        $form->handleRequest($request);

        if ($form->isSubmitted() && $form->isValid()) {

            $institutionConfigurationOptions = $this->getInstitutionConfigurationOptionsService()
                ->getInstitutionConfigurationOptionsFor($command->institution);
            $token->changeInstitutionScope($command->institution, $institutionConfigurationOptions);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

            $flashMessage = $this->get('translator')
                ->trans('ra.sraa.changed_institution', ['%institution%' => $command->institution]);
            $this->get('session')->getFlashBag()->add('success', $flashMessage);

            $logger->notice(sprintf(
                'RAA "%s" successfully switched to institution "%s"',
                $identity->id,
                $command->institution
            ));

            return $this->redirect($this->generateUrl('ra_vetting_search'));
        }

        $logger->notice(sprintf('Showing select institution form for RAA "%s"', $identity->id));

        return $this->render(
            // Reuse the SRAA switcher twig template
            'SurfnetStepupRaRaBundle:Sraa:selectInstitution.html.twig',
            ['form' => $form->createView()]
        );
    }


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


1		<?php
2
3		/**
4		* Copyright 2018 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\StepupRa\RaBundle\Controller;
20
21		use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\Identity;
22		use Surfnet\StepupRa\RaBundle\Command\ChangeRaaInstitutionCommand;
23		use Surfnet\StepupRa\RaBundle\Form\Type\RaaInstitutionSelectionType;
24		use Surfnet\StepupRa\RaBundle\Security\Authentication\Token\SamlToken;
25		use Surfnet\StepupRa\RaBundle\Service\InstitutionConfigurationOptionsService;
26		use Symfony\Bundle\FrameworkBundle\Controller\Controller;
27		use Symfony\Component\HttpFoundation\Request;
28
29		class RaaController extends Controller
30		{
31		public function selectInstitutionAction(Request $request)
32		{
33		$this->denyAccessUnlessGranted(['ROLE_RAA']);
34
35		/** @var SamlToken $token */
36		$token = $this->get('security.token_storage')->getToken();
37		$logger = $this->get('logger');
38
39		/** @var Identity $identity */
40		$identity = $token->getUser();
41		$institution = $identity->institution;
42
43		$logger->notice(sprintf('Select Institution for RAA "%s"', $identity->id));
44
45		$raaSwitcherOptions = $this
46		->getInstitutionConfigurationOptionsService()
47		->getAvailableInstitutionsFor($token->getIdentityInstitution());
48
49		$command = new ChangeRaaInstitutionCommand();
50		$command->institution = $institution;
51		$command->availableInstitutions = $raaSwitcherOptions;
52
53		$form = $this->createForm(RaaInstitutionSelectionType::class, $command);
54		$form->handleRequest($request);
55
56	View Code Duplication	if ($form->isSubmitted() && $form->isValid()) {
		0 ignored issues – show Duplication introduced 2018-08-30 13:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
57		$institutionConfigurationOptions = $this->getInstitutionConfigurationOptionsService()
58		->getInstitutionConfigurationOptionsFor($command->institution);
59		$token->changeInstitutionScope($command->institution, $institutionConfigurationOptions);
		0 ignored issues – show Bug introduced 2018-10-30 13:35 UTC by Report Bug Copy Issue Report It seems like `$institutionConfigurationOptions` defined by `$this->getInstitutionCon...($command->institution)` on line `57` can be `null`; however, `Surfnet\StepupRa\RaBundl...hangeInstitutionScope()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
60
61		$flashMessage = $this->get('translator')
62		->trans('ra.sraa.changed_institution', ['%institution%' => $command->institution]);
63		$this->get('session')->getFlashBag()->add('success', $flashMessage);
64
65		$logger->notice(sprintf(
66		'RAA "%s" successfully switched to institution "%s"',
67		$identity->id,
68		$command->institution
69		));
70
71		return $this->redirect($this->generateUrl('ra_vetting_search'));
72		}
73
74		$logger->notice(sprintf('Showing select institution form for RAA "%s"', $identity->id));
75
76		return $this->render(
77		// Reuse the SRAA switcher twig template
78		'SurfnetStepupRaRaBundle:Sraa:selectInstitution.html.twig',
79		['form' => $form->createView()]
80		);
81		}
82
83
84		/**
85		* @return InstitutionConfigurationOptionsService
86		*/
87		private function getInstitutionConfigurationOptionsService()
88		{
89		return $this->get('ra.service.institution_configuration_options');
90		}
91		}
92

OpenConext / Stepup-RA

Pull Request — feature/fine-grained-authoriza... (#177)

getInstitutionConfigurationOptionsService() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like