RegistrationController::displayVettingTypes() - Code Metrics - Inspection of "Feature/symfony6 upgrade" - OpenConext/Stepup-SelfService - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#308)

by Paul

created 2024-01-09 10:23 UTC

RegistrationController::displayVettingTypes() B

↳ Parent: RegistrationController

Complexity

Conditions	6
Paths	4

Size

Total Lines	57
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	6
eloc	35
c	3
b	0
f	0
nc	4
nop	2
dl	0
loc	57
rs	8.7377

How to fix Long Method

<?php

declare(strict_types = 1);

/**
 * Copyright 2014 SURFnet bv
 *
 * 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\StepupSelfService\SelfServiceBundle\Controller;

use DateInterval;
use Mpdf\Mpdf;
use Mpdf\Output\Destination as MpdfDestination;
use Psr\Log\LoggerInterface;
use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\VerifiedSecondFactor;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\ControllerCheckerService;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\InstitutionConfigurationOptionsService;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\RaLocationService;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\RaService;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\SecondFactorAvailabilityHelper;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\SecondFactorService;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\VettingTypeService;
use Surfnet\StepupSelfService\SelfServiceBundle\Value\VettingType\VettingTypeInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\ResponseHeaderBag;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Routing\Attribute\Route;

/**
 * TODO: split into smaller controllers
 * TODO: create PDF generation in dedicated service
 */

class RegistrationController extends AbstractController
{
    public function __construct(

        private readonly VettingTypeService $vettingTypeService,
        private readonly InstitutionConfigurationOptionsService $configurationOptionsService,
        private readonly SecondFactorService $secondFactorService,
        private readonly LoggerInterface $logger,
        private readonly SecondFactorAvailabilityHelper $secondFactorAvailabilityHelper,
        private readonly RaService $raService,
        private readonly RaLocationService $raLocationService,
        private readonly ControllerCheckerService $checkerService,
    ) {
    }

    #[Route(
        path: '/registration/select-token',
        name: 'ss_registration_display_types',
        methods: ['GET'],
    )]
    public function displaySecondFactorTypes(): Response

    {
        $institution = $this->getUser()->getIdentity()->institution;
        $institutionConfigurationOptions = $this->configurationOptionsService
            ->getInstitutionConfigurationOptionsFor($institution);

        $identity = $this->getUser()->getIdentity();

        // Get all available second factors from the config.
        $allSecondFactors = $this->getParameter('ss.enabled_second_factors');

        $secondFactors = $this->secondFactorService->getSecondFactorsForIdentity(
            $identity,
            $allSecondFactors,
            $institutionConfigurationOptions->allowedSecondFactors,
            $institutionConfigurationOptions->numberOfTokensPerIdentity
        );

        if ($secondFactors->getRegistrationsLeft() <= 0) {
            $this->logger->notice(
                'User tried to register a new token but maximum number of tokens is reached. Redirecting to overview'
            );
            return $this->forward(
                'Surfnet\StepupSelfService\SelfServiceBundle\Controller\SecondFactor\SecondFactorListController'
            );
        }

        $availableTokens = $this->secondFactorAvailabilityHelper->filter($secondFactors);

        return $this->render(
            'registration/display_second_factor_types.html.twig',
            [
                'commonName' => $this->getUser()->getIdentity()->commonName,
                'availableSecondFactors' => $availableTokens,
                'verifyEmail' => $this->checkerService->emailVerificationIsRequired(),
            ]
        );
    }

    #[Route(
        path: '/second-factor/{secondFactorId}/vetting-types',
        name: 'ss_second_factor_vetting_types',
        methods:  ['GET'],
    )]
    public function displayVettingTypes(Request $request, string $secondFactorId): Response

    {
        $vettingTypeCollection = $this->vettingTypeService->vettingTypes($this->getUser()->getIdentity(), $secondFactorId);

        $nudgeSelfAssertedTokens = $vettingTypeCollection->isPreferred(VettingTypeInterface::SELF_ASSERTED_TOKENS);
        $nudgeRaVetting = $vettingTypeCollection->isPreferred(VettingTypeInterface::ON_PREMISE);

        // Nudging section: helping the Identity into choosing the right vetting type:

        // Option 1: A self-asserted token registration nudge was requested via query string (?activate=self)
        if ($nudgeSelfAssertedTokens && $vettingTypeCollection->allowSelfAssertedTokens()) {
            $this->logger->notice('Nudging (forcing) self-asserted token registration');
            return $this->forward(
                'Surfnet\StepupSelfService\SelfServiceBundle\Controller\SelfAssertedTokensController::selfAssertedTokenRegistration',
                ['secondFactorId' => $secondFactorId]
            );
        }

        // Option 2: A ra-vetting nudge was requested via query string (?activate=ra)
        if ($nudgeRaVetting) {
            $this->logger->notice('Nudging (forcing) RA vetting');
            return $this->forward(
                'Surfnet\StepupSelfService\SelfServiceBundle\Controller\RegistrationController::sendRegistrationEmail',
                ['secondFactorId' => $secondFactorId]
            );
        }

        // Option 3: non-formal nudge, skip over selection screen. As only ra vetting is available.
        if (!$vettingTypeCollection->allowSelfVetting() && !$vettingTypeCollection->allowSelfAssertedTokens()) {
            $this->logger
                ->notice(
                    'Skipping ahead to the RA vetting option as self vetting or self-asserted tokens are not allowed'
                );
            return $this->forward(
                'Surfnet\StepupSelfService\SelfServiceBundle\Controller\RegistrationController::sendRegistrationEmail',
                ['secondFactorId' => $secondFactorId]
            );
        }

        $institution = $this->getUser()->getIdentity()->institution;
        $currentLocale = $request->getLocale();
        $vettingTypeHint = $this->vettingTypeService->vettingTypeHint($institution, $currentLocale);

        return $this->render(
            'registration/display_vetting_types.html.twig',
            [
                'allowSelfVetting' => $vettingTypeCollection->allowSelfVetting(),
                'allowSelfAssertedTokens' => $vettingTypeCollection->allowSelfAssertedTokens(),
                'hasVettingTypeHint' => !is_null($vettingTypeHint),
                'vettingTypeHint' => $vettingTypeHint,
                'verifyEmail' => $this->checkerService->emailVerificationIsRequired(),
                'secondFactorId' => $secondFactorId,
            ]
        );
    }


    #[Route(
        path: '/registration/{secondFactorId}/email-verification-email-sent',
        name: 'ss_registration_email_verification_email_sent',
        methods: ['GET'],
    )]
    public function emailVerificationEmailSent(): Response

    {
        return $this->render(
            view: 'registration/email_verification_email_sent.html.twig',
            parameters: ['email' => $this->getUser()->getIdentity()->email]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }

    #[Route(
        path: '/verify-email',
        name: 'ss_registration_verify_email',
        methods: ['GET'],
    )]
    public function verifyEmail(Request $request): Response

    {
        $nonce = $request->query->get('n', '');
        $identityId = $this->getUser()->getIdentity()->id;
        $secondFactor = $this->secondFactorService->findUnverifiedByVerificationNonce($identityId, $nonce);

        if ($secondFactor === null) {
            throw new NotFoundHttpException('No second factor can be verified using this URL.');
        }

        if ($this->secondFactorService->verifyEmail($identityId, $nonce)) {
            return $this->redirectToRoute(
                'ss_second_factor_vetting_types',
                ['secondFactorId' => $secondFactor->id]
            );
        }

        return $this->render('registration/verify_email.html.twig');
    }

    /**

     * Intermediate action where the registration mail is sent. After which the
     * email-sent page is displayed. Preventing the mail message from being sent
     * over and over again when the user performs a page reload.
     */

    #[Route(
        path: '/registration/{secondFactorId}/send-registration-email',
        name: 'ss_registration_send_registration_email',
        methods: ['GET'],
    )]

    public function sendRegistrationEmail(string $secondFactorId): RedirectResponse
    {
        // Send the registration email
        $this->raService
            ->sendRegistrationMailMessage($this->getUser()->getIdentity()->id, $secondFactorId);
        return $this->redirectToRoute(
            'ss_registration_registration_email_sent',
            ['secondFactorId' => $secondFactorId]
        );
    }

    /**

     * @param $secondFactorId

     * @return Response

     */
    #[Route(
        path: '/registration/{secondFactorId}/registration-email-sent',
        name: 'ss_registration_registration_email_sent',
        methods: ['GET'],
    )]
    public function registrationEmailSent($secondFactorId): Response
    {
        $parameters = $this->buildRegistrationActionParameters($secondFactorId);
        // Report that it was sent
        return $this->render(
            'registration/registration_email_sent.html.twig',
            $parameters
        );
    }

    /**

     * @param $secondFactorId

     * @return Response

     */
    #[Route(
        path: '/registration/{secondFactorId}/registration-pdf',
        name: 'ss_registration_registration_pdf',
        methods: ['GET'],
    )]
    public function registrationPdf($secondFactorId): Response
    {
        $parameters = $this->buildRegistrationActionParameters($secondFactorId);

        $content = $this->renderView('registration/registration_email_sent_pdf.html.twig', $parameters);

        $mpdf = new Mpdf(
            ['tempDir' => sys_get_temp_dir()]
        );
        $mpdf->setLogger($this->logger);

        $mpdf->WriteHTML($content);
        $output = $mpdf->Output('registration-code.pdf', MpdfDestination::STRING_RETURN);

        $response = new Response($output);
        $disposition = $response->headers->makeDisposition(
            ResponseHeaderBag::DISPOSITION_ATTACHMENT,
            'registration-code.pdf'
        );

        $response->headers->set('Content-Disposition', $disposition);
        $response->headers->set('Content-Description', 'File Transfer');
        $response->headers->set('Content-Transfer-Encoding', 'binary');
        $response->headers->set('Cache-Control', 'public, must-revalidate, max-age=0');
        $response->headers->set('Pragma', 'public');
        $response->headers->set('Expires', 'Sat, 26 Jul 1997 05:00:00 GMT');
        $response->headers->set('Last-Modified', '' . gmdate('D, d M Y H:i:s') . ' GMT');
        $response->headers->set('Content-Type', 'application/pdf');

        return $response;
    }

    private function buildRegistrationActionParameters($secondFactorId): array

    {
        $identity = $this->getUser()->getIdentity();

        /** @var VerifiedSecondFactor $secondFactor */

        $secondFactor = $this->secondFactorService->findOneVerified($secondFactorId);

        $parameters = [
            'email'            => $identity->email,
            'secondFactorId'   => $secondFactor->id,
            'registrationCode' => $secondFactor->registrationCode,
            'expirationDate'   => $secondFactor->registrationRequestedAt->add(
                new DateInterval('P14D')
            ),
            'locale'           => $identity->preferredLocale,
            'verifyEmail'      => $this->checkerService->emailVerificationIsRequired(),
        ];

        $institutionConfigurationOptions = $this->configurationOptionsService
            ->getInstitutionConfigurationOptionsFor($identity->institution);

        if ($institutionConfigurationOptions->useRaLocations) {
            $parameters['raLocations'] = $this->raLocationService->listRaLocationsFor($identity->institution);
        } elseif (!$institutionConfigurationOptions->showRaaContactInformation) {
            $parameters['ras'] = $this->raService->listRasWithoutRaas($identity->institution);
        } else {
            $parameters['ras'] = $this->raService->listRas($identity->institution);
        }

        return $parameters;
    }
}


1			<?php
2
3			declare(strict_types = 1);
4
5			/**
6			* Copyright 2014 SURFnet bv
7			*
8			* Licensed under the Apache License, Version 2.0 (the "License");
9			* you may not use this file except in compliance with the License.
10			* You may obtain a copy of the License at
11			*
12			* http://www.apache.org/licenses/LICENSE-2.0
13			*
14			* Unless required by applicable law or agreed to in writing, software
15			* distributed under the License is distributed on an "AS IS" BASIS,
16			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17			* See the License for the specific language governing permissions and
18			* limitations under the License.
19			*/
			0 ignored issues – show Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history... Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing @link tag in file comment Loading history...
20
21			namespace Surfnet\StepupSelfService\SelfServiceBundle\Controller;
22
23			use DateInterval;
24			use Mpdf\Mpdf;
25			use Mpdf\Output\Destination as MpdfDestination;
26			use Psr\Log\LoggerInterface;
27			use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\VerifiedSecondFactor;
28			use Surfnet\StepupSelfService\SelfServiceBundle\Service\ControllerCheckerService;
29			use Surfnet\StepupSelfService\SelfServiceBundle\Service\InstitutionConfigurationOptionsService;
30			use Surfnet\StepupSelfService\SelfServiceBundle\Service\RaLocationService;
31			use Surfnet\StepupSelfService\SelfServiceBundle\Service\RaService;
32			use Surfnet\StepupSelfService\SelfServiceBundle\Service\SecondFactorAvailabilityHelper;
33			use Surfnet\StepupSelfService\SelfServiceBundle\Service\SecondFactorService;
34			use Surfnet\StepupSelfService\SelfServiceBundle\Service\VettingTypeService;
35			use Surfnet\StepupSelfService\SelfServiceBundle\Value\VettingType\VettingTypeInterface;
36			use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
37			use Symfony\Component\HttpFoundation\RedirectResponse;
38			use Symfony\Component\HttpFoundation\Request;
39			use Symfony\Component\HttpFoundation\Response;
40			use Symfony\Component\HttpFoundation\ResponseHeaderBag;
41			use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
42			use Symfony\Component\Routing\Attribute\Route;
43
44			/**
45			* TODO: split into smaller controllers
46			* TODO: create PDF generation in dedicated service
47			*/
			0 ignored issues – show Coding Style introduced 2023-12-21 16:49 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2023-12-21 16:49 UTC by Report Bug Copy Issue Report Missing @package tag in class comment Loading history... Coding Style introduced 2023-12-21 16:49 UTC by Report Bug Copy Issue Report Missing @author tag in class comment Loading history... Coding Style introduced 2023-12-21 16:49 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2023-12-21 16:49 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
48			class RegistrationController extends AbstractController
49			{
50			public function __construct(
			0 ignored issues – show Coding Style introduced 2023-11-28 13:30 UTC by Report Bug Copy Issue Report Missing doc comment for function __construct() Loading history...
51			private readonly VettingTypeService $vettingTypeService,
52			private readonly InstitutionConfigurationOptionsService $configurationOptionsService,
53			private readonly SecondFactorService $secondFactorService,
54			private readonly LoggerInterface $logger,
55			private readonly SecondFactorAvailabilityHelper $secondFactorAvailabilityHelper,
56			private readonly RaService $raService,
57			private readonly RaLocationService $raLocationService,
58			private readonly ControllerCheckerService $checkerService,
59			) {
60			}
61
62			#[Route(
63			path: '/registration/select-token',
64			name: 'ss_registration_display_types',
65			methods: ['GET'],
66			)]
67			public function displaySecondFactorTypes(): Response
			0 ignored issues – show Coding Style introduced 2023-11-28 15:12 UTC by Report Bug Copy Issue Report Missing doc comment for function displaySecondFactorTypes() Loading history...
68			{
69			$institution = $this->getUser()->getIdentity()->institution;
70			$institutionConfigurationOptions = $this->configurationOptionsService
71			->getInstitutionConfigurationOptionsFor($institution);
72
73			$identity = $this->getUser()->getIdentity();
74
75			// Get all available second factors from the config.
76			$allSecondFactors = $this->getParameter('ss.enabled_second_factors');
77
78			$secondFactors = $this->secondFactorService->getSecondFactorsForIdentity(
79			$identity,
80			$allSecondFactors,
81			$institutionConfigurationOptions->allowedSecondFactors,
82			$institutionConfigurationOptions->numberOfTokensPerIdentity
83			);
84
85			if ($secondFactors->getRegistrationsLeft() <= 0) {
86			$this->logger->notice(
87			'User tried to register a new token but maximum number of tokens is reached. Redirecting to overview'
88			);
89			return $this->forward(
90			'Surfnet\StepupSelfService\SelfServiceBundle\Controller\SecondFactor\SecondFactorListController'
91			);
92			}
93
94			$availableTokens = $this->secondFactorAvailabilityHelper->filter($secondFactors);
95
96			return $this->render(
97			'registration/display_second_factor_types.html.twig',
98			[
99			'commonName' => $this->getUser()->getIdentity()->commonName,
100			'availableSecondFactors' => $availableTokens,
101			'verifyEmail' => $this->checkerService->emailVerificationIsRequired(),
102			]
103			);
104			}
105
106			#[Route(
107			path: '/second-factor/{secondFactorId}/vetting-types',
108			name: 'ss_second_factor_vetting_types',
109			methods: ['GET'],
110			)]
111			public function displayVettingTypes(Request $request, string $secondFactorId): Response
			0 ignored issues – show Coding Style introduced 2023-11-28 15:12 UTC by Report Bug Copy Issue Report Missing doc comment for function displayVettingTypes() Loading history...
112			{
113			$vettingTypeCollection = $this->vettingTypeService->vettingTypes($this->getUser()->getIdentity(), $secondFactorId);
114
115			$nudgeSelfAssertedTokens = $vettingTypeCollection->isPreferred(VettingTypeInterface::SELF_ASSERTED_TOKENS);
116			$nudgeRaVetting = $vettingTypeCollection->isPreferred(VettingTypeInterface::ON_PREMISE);
117
118			// Nudging section: helping the Identity into choosing the right vetting type:
119
120			// Option 1: A self-asserted token registration nudge was requested via query string (?activate=self)
121			if ($nudgeSelfAssertedTokens && $vettingTypeCollection->allowSelfAssertedTokens()) {
122			$this->logger->notice('Nudging (forcing) self-asserted token registration');
123			return $this->forward(
124			'Surfnet\StepupSelfService\SelfServiceBundle\Controller\SelfAssertedTokensController::selfAssertedTokenRegistration',
125			['secondFactorId' => $secondFactorId]
126			);
127			}
128
129			// Option 2: A ra-vetting nudge was requested via query string (?activate=ra)
130			if ($nudgeRaVetting) {
131			$this->logger->notice('Nudging (forcing) RA vetting');
132			return $this->forward(
133			'Surfnet\StepupSelfService\SelfServiceBundle\Controller\RegistrationController::sendRegistrationEmail',
134			['secondFactorId' => $secondFactorId]
135			);
136			}
137
138			// Option 3: non-formal nudge, skip over selection screen. As only ra vetting is available.
139			if (!$vettingTypeCollection->allowSelfVetting() && !$vettingTypeCollection->allowSelfAssertedTokens()) {
140			$this->logger
141			->notice(
142			'Skipping ahead to the RA vetting option as self vetting or self-asserted tokens are not allowed'
143			);
144			return $this->forward(
145			'Surfnet\StepupSelfService\SelfServiceBundle\Controller\RegistrationController::sendRegistrationEmail',
146			['secondFactorId' => $secondFactorId]
147			);
148			}
149
150			$institution = $this->getUser()->getIdentity()->institution;
151			$currentLocale = $request->getLocale();
152			$vettingTypeHint = $this->vettingTypeService->vettingTypeHint($institution, $currentLocale);
153
154			return $this->render(
155			'registration/display_vetting_types.html.twig',
156			[
157			'allowSelfVetting' => $vettingTypeCollection->allowSelfVetting(),
158			'allowSelfAssertedTokens' => $vettingTypeCollection->allowSelfAssertedTokens(),
159			'hasVettingTypeHint' => !is_null($vettingTypeHint),
160			'vettingTypeHint' => $vettingTypeHint,
161			'verifyEmail' => $this->checkerService->emailVerificationIsRequired(),
162			'secondFactorId' => $secondFactorId,
163			]
164			);
165			}
166
167
168			#[Route(
169			path: '/registration/{secondFactorId}/email-verification-email-sent',
170			name: 'ss_registration_email_verification_email_sent',
171			methods: ['GET'],
172			)]
173			public function emailVerificationEmailSent(): Response
			0 ignored issues – show Coding Style introduced 2023-11-28 15:12 UTC by Report Bug Copy Issue Report Missing doc comment for function emailVerificationEmailSent() Loading history...
174			{
175			return $this->render(
176			view: 'registration/email_verification_email_sent.html.twig',
177			parameters: ['email' => $this->getUser()->getIdentity()->email]);
			0 ignored issues – show Coding Style introduced 2023-12-20 14:36 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `8` spaces, but found `12`. Loading history... Coding Style introduced 2023-12-20 14:36 UTC by Report Bug Copy Issue Report For multi-line function calls, the closing parenthesis should be on a new line. If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line: someFunctionCall( $firstArgument, $secondArgument, $thirdArgument ); // Closing parenthesis on a new line. Loading history...
178			}
179
180			#[Route(
181			path: '/verify-email',
182			name: 'ss_registration_verify_email',
183			methods: ['GET'],
184			)]
185			public function verifyEmail(Request $request): Response
			0 ignored issues – show Coding Style introduced 2023-11-28 15:12 UTC by Report Bug Copy Issue Report Missing doc comment for function verifyEmail() Loading history...
186			{
187			$nonce = $request->query->get('n', '');
188			$identityId = $this->getUser()->getIdentity()->id;
189			$secondFactor = $this->secondFactorService->findUnverifiedByVerificationNonce($identityId, $nonce);
190
191			if ($secondFactor === null) {
192			throw new NotFoundHttpException('No second factor can be verified using this URL.');
193			}
194
195			if ($this->secondFactorService->verifyEmail($identityId, $nonce)) {
196			return $this->redirectToRoute(
197			'ss_second_factor_vetting_types',
198			['secondFactorId' => $secondFactor->id]
199			);
200			}
201
202			return $this->render('registration/verify_email.html.twig');
203			}
204
205			/**
			0 ignored issues – show Coding Style introduced 2023-12-20 14:44 UTC by Report Bug Copy Issue Report Parameter `$secondFactorId` should have a doc-comment as per coding-style. Loading history...
206			* Intermediate action where the registration mail is sent. After which the
207			* email-sent page is displayed. Preventing the mail message from being sent
208			* over and over again when the user performs a page reload.
209			*/
			0 ignored issues – show Coding Style introduced 2023-11-28 11:59 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history... Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
210			#[Route(
211			path: '/registration/{secondFactorId}/send-registration-email',
212			name: 'ss_registration_send_registration_email',
213			methods: ['GET'],
214			)]
215
216			public function sendRegistrationEmail(string $secondFactorId): RedirectResponse
217			{
218			// Send the registration email
219			$this->raService
220			->sendRegistrationMailMessage($this->getUser()->getIdentity()->id, $secondFactorId);
221			return $this->redirectToRoute(
222			'ss_registration_registration_email_sent',
223			['secondFactorId' => $secondFactorId]
224			);
225			}
226
227			/**
			0 ignored issues – show Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
228			* @param $secondFactorId
			0 ignored issues – show Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Tag value for @param tag indented incorrectly; expected 2 spaces but found 1 Loading history...
229			* @return Response
			0 ignored issues – show Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
230			*/
231			#[Route(
232			path: '/registration/{secondFactorId}/registration-email-sent',
233			name: 'ss_registration_registration_email_sent',
234			methods: ['GET'],
235			)]
236			public function registrationEmailSent($secondFactorId): Response
237			{
238			$parameters = $this->buildRegistrationActionParameters($secondFactorId);
239			// Report that it was sent
240			return $this->render(
241			'registration/registration_email_sent.html.twig',
242			$parameters
243			);
244			}
245
246			/**
			0 ignored issues – show Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
247			* @param $secondFactorId
			0 ignored issues – show Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Tag value for @param tag indented incorrectly; expected 2 spaces but found 1 Loading history...
248			* @return Response
			0 ignored issues – show Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Tag @return cannot be grouped with parameter tags in a doc comment Loading history...
249			*/
250			#[Route(
251			path: '/registration/{secondFactorId}/registration-pdf',
252			name: 'ss_registration_registration_pdf',
253			methods: ['GET'],
254			)]
255			public function registrationPdf($secondFactorId): Response
256			{
257			$parameters = $this->buildRegistrationActionParameters($secondFactorId);
258
259			$content = $this->renderView('registration/registration_email_sent_pdf.html.twig', $parameters);
260
261			$mpdf = new Mpdf(
262			['tempDir' => sys_get_temp_dir()]
263			);
264			$mpdf->setLogger($this->logger);
265
266			$mpdf->WriteHTML($content);
267			$output = $mpdf->Output('registration-code.pdf', MpdfDestination::STRING_RETURN);
268
269			$response = new Response($output);
270			$disposition = $response->headers->makeDisposition(
271			ResponseHeaderBag::DISPOSITION_ATTACHMENT,
272			'registration-code.pdf'
273			);
274
275			$response->headers->set('Content-Disposition', $disposition);
276			$response->headers->set('Content-Description', 'File Transfer');
277			$response->headers->set('Content-Transfer-Encoding', 'binary');
278			$response->headers->set('Cache-Control', 'public, must-revalidate, max-age=0');
279			$response->headers->set('Pragma', 'public');
280			$response->headers->set('Expires', 'Sat, 26 Jul 1997 05:00:00 GMT');
281			$response->headers->set('Last-Modified', '' . gmdate('D, d M Y H:i:s') . ' GMT');
282			$response->headers->set('Content-Type', 'application/pdf');
283
284			return $response;
285			}
286
287			private function buildRegistrationActionParameters($secondFactorId): array
			0 ignored issues – show Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Private method name "RegistrationController::buildRegistrationActionParameters" must be prefixed with an underscore Loading history... Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing doc comment for function buildRegistrationActionParameters() Loading history...
288			{
289			$identity = $this->getUser()->getIdentity();
290
291			/** @var VerifiedSecondFactor $secondFactor */
			0 ignored issues – show Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report The open comment tag must be the only content on the line Loading history... Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2023-11-16 15:54 UTC by Report Bug Copy Issue Report The close comment tag must be the only content on the line Loading history...
292			$secondFactor = $this->secondFactorService->findOneVerified($secondFactorId);
293
294			$parameters = [
295			'email' => $identity->email,
296			'secondFactorId' => $secondFactor->id,
297			'registrationCode' => $secondFactor->registrationCode,
298			'expirationDate' => $secondFactor->registrationRequestedAt->add(
299			new DateInterval('P14D')
300			),
301			'locale' => $identity->preferredLocale,
302			'verifyEmail' => $this->checkerService->emailVerificationIsRequired(),
303			];
304
305			$institutionConfigurationOptions = $this->configurationOptionsService
306			->getInstitutionConfigurationOptionsFor($identity->institution);
307
308			if ($institutionConfigurationOptions->useRaLocations) {
309			$parameters['raLocations'] = $this->raLocationService->listRaLocationsFor($identity->institution);
310			} elseif (!$institutionConfigurationOptions->showRaaContactInformation) {
311			$parameters['ras'] = $this->raService->listRasWithoutRaas($identity->institution);
312			} else {
313			$parameters['ras'] = $this->raService->listRas($identity->institution);
314			}
315
316			return $parameters;
317			}
318			}
319

OpenConext / Stepup-SelfService

Pull Request — main (#308)

RegistrationController::displayVettingTypes() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like