ServiceController::outcomeService() - Code Metrics - Inspection of "Upgrade" - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#5329)

by Angel Fernando Quiroz

created 2024-04-18 13:58 UTC

ServiceController::outcomeService() B

↳ Parent: ServiceController

Complexity

Conditions	9
Paths	11

Size

Total Lines	61
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	34
nc	11
nop	1
dl	0
loc	61
rs	8.0555
c	0
b	0
f	0

How to fix Long Method

<?php

declare(strict_types=1);

/* For licensing terms, see /license.txt */

namespace Chamilo\LtiBundle\Controller;

use Chamilo\CoreBundle\Controller\BaseController;
use Chamilo\LtiBundle\Component\OutcomeDeleteRequest;
use Chamilo\LtiBundle\Component\OutcomeReadRequest;
use Chamilo\LtiBundle\Component\OutcomeReplaceRequest;
use Chamilo\LtiBundle\Component\OutcomeResponse;
use Chamilo\LtiBundle\Component\OutcomeUnsupportedRequest;
use Chamilo\LtiBundle\Entity\ExternalTool;
use Doctrine\Persistence\ManagerRegistry;
use OAuthUtil;
use SimpleXMLElement;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;
use Symfony\Contracts\Translation\TranslatorInterface;

class ServiceController extends BaseController
{
    public function __construct(
        private ManagerRegistry $managerRegistry,
        private TranslatorInterface $translator,
    ) {}

    #[Route(path: '/lti/os', name: 'chamilo_lti_os')]
    public function outcomeService(Request $request): Response
    {
        $em = $this->managerRegistry->getManager();
        $toolRepo = $em->getRepository(ExternalTool::class);

        $headers = $request->headers;

        if (empty($headers->get('authorization'))) {
            throw $this->createAccessDeniedException();
        }

        $authParams = OAuthUtil::split_header($headers['Authorization']);

        if (empty($authParams) || empty($authParams['oauth_consumer_key']) || empty($authParams['oauth_signature'])) {
            throw $this->createAccessDeniedException();
        }

        $course = $this->getCourse();
        $tools = $toolRepo->findBy([
            'consumerKey' => $authParams['oauth_consumer_key'],
        ]);
        $url = $this->generateUrl('chamilo_lti_os', [
            'code' => $course->getCode(),
        ]);

        $toolIsFound = false;

        /** @var ExternalTool $tool */
        foreach ($tools as $tool) {
            $signatureIsValid = $this->compareRequestSignature(
                $url,
                $authParams['oauth_consumer_key'],
                $authParams['oauth_signature'],
                $tool
            );

            if ($signatureIsValid) {
                $toolIsFound = true;

                break;
            }
        }

        if (!$toolIsFound) {
            throw $this->createNotFoundException('External tool not found. Signature is not valid');
        }

        $body = file_get_contents('php://input');
        $bodyHash = base64_encode(sha1($body, true));

        if ($bodyHash !== $authParams['oauth_body_hash']) {
            throw $this->createAccessDeniedException('Request is not valid.');
        }

        $process = $this->processServiceRequest();

        $response = new Response($process);
        $response->headers->set('Content-Type', 'application/xml');

        return $response;
    }

    private function processServiceRequest(): ?OutcomeResponse
    {
        $requestContent = file_get_contents('php://input');

        if (empty($requestContent)) {
            return null;
        }

        $xml = new SimpleXMLElement($requestContent);

        if (empty($xml)) {
            return null;
        }

        $bodyChildren = $xml->imsx_POXBody->children();

        if (empty($bodyChildren)) {
            return null;
        }

        $name = $bodyChildren->getName();

        switch ($name) {
            case 'replaceResultRequest':
                $serviceRequest = new OutcomeReplaceRequest($xml);

                break;

            case 'readResultRequest':
                $serviceRequest = new OutcomeReadRequest($xml);

                break;

            case 'deleteResultRequest':
                $serviceRequest = new OutcomeDeleteRequest($xml);

                break;

            default:
                $name = str_replace(['ResultRequest', 'Request'], '', $name);

                $serviceRequest = new OutcomeUnsupportedRequest($xml, $name);

                break;
        }

        $serviceRequest->setEntityManager($this->managerRegistry->getManager());
        $serviceRequest->setTranslator($this->translator);

        return $serviceRequest->process();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/* For licensing terms, see /license.txt */
6
7			namespace Chamilo\LtiBundle\Controller;
8
9			use Chamilo\CoreBundle\Controller\BaseController;
10			use Chamilo\LtiBundle\Component\OutcomeDeleteRequest;
11			use Chamilo\LtiBundle\Component\OutcomeReadRequest;
12			use Chamilo\LtiBundle\Component\OutcomeReplaceRequest;
13			use Chamilo\LtiBundle\Component\OutcomeResponse;
14			use Chamilo\LtiBundle\Component\OutcomeUnsupportedRequest;
15			use Chamilo\LtiBundle\Entity\ExternalTool;
16			use Doctrine\Persistence\ManagerRegistry;
17			use OAuthUtil;
18			use SimpleXMLElement;
19			use Symfony\Component\HttpFoundation\Request;
20			use Symfony\Component\HttpFoundation\Response;
21			use Symfony\Component\Routing\Attribute\Route;
22			use Symfony\Contracts\Translation\TranslatorInterface;
23
24			class ServiceController extends BaseController
25			{
26			public function __construct(
27			private ManagerRegistry $managerRegistry,
28			private TranslatorInterface $translator,
29			) {}
30
31			#[Route(path: '/lti/os', name: 'chamilo_lti_os')]
32			public function outcomeService(Request $request): Response
33			{
34			$em = $this->managerRegistry->getManager();
35			$toolRepo = $em->getRepository(ExternalTool::class);
36
37			$headers = $request->headers;
38
39			if (empty($headers->get('authorization'))) {
40			throw $this->createAccessDeniedException();
41			}
42
43			$authParams = OAuthUtil::split_header($headers['Authorization']);
44
45			if (empty($authParams) \|\| empty($authParams['oauth_consumer_key']) \|\| empty($authParams['oauth_signature'])) {
46			throw $this->createAccessDeniedException();
47			}
48
49			$course = $this->getCourse();
50			$tools = $toolRepo->findBy([
51			'consumerKey' => $authParams['oauth_consumer_key'],
52			]);
53			$url = $this->generateUrl('chamilo_lti_os', [
54			'code' => $course->getCode(),
55			]);
56
57			$toolIsFound = false;
58
59			/** @var ExternalTool $tool */
60			foreach ($tools as $tool) {
61			$signatureIsValid = $this->compareRequestSignature(
62			$url,
63			$authParams['oauth_consumer_key'],
64			$authParams['oauth_signature'],
65			$tool
66			);
67
68			if ($signatureIsValid) {
69			$toolIsFound = true;
70
71			break;
72			}
73			}
74
75			if (!$toolIsFound) {
76			throw $this->createNotFoundException('External tool not found. Signature is not valid');
77			}
78
79			$body = file_get_contents('php://input');
80			$bodyHash = base64_encode(sha1($body, true));
81
82			if ($bodyHash !== $authParams['oauth_body_hash']) {
83			throw $this->createAccessDeniedException('Request is not valid.');
84			}
85
86			$process = $this->processServiceRequest();
87
88			$response = new Response($process);
89			$response->headers->set('Content-Type', 'application/xml');
90
91			return $response;
92			}
93
94			private function processServiceRequest(): ?OutcomeResponse
95			{
96			$requestContent = file_get_contents('php://input');
97
98			if (empty($requestContent)) {
99			return null;
100			}
101
102			$xml = new SimpleXMLElement($requestContent);
103
104			if (empty($xml)) {
105			return null;
106			}
107
108			$bodyChildren = $xml->imsx_POXBody->children();
109
110			if (empty($bodyChildren)) {
111			return null;
112			}
113
114			$name = $bodyChildren->getName();
115
116			switch ($name) {
117			case 'replaceResultRequest':
118			$serviceRequest = new OutcomeReplaceRequest($xml);
119
120			break;
121
122			case 'readResultRequest':
123			$serviceRequest = new OutcomeReadRequest($xml);
124
125			break;
126
127			case 'deleteResultRequest':
128			$serviceRequest = new OutcomeDeleteRequest($xml);
129
130			break;
131
132			default:
133			$name = str_replace(['ResultRequest', 'Request'], '', $name);
134
135			$serviceRequest = new OutcomeUnsupportedRequest($xml, $name);
136
137			break;
138			}
139
140			$serviceRequest->setEntityManager($this->managerRegistry->getManager());
141			$serviceRequest->setTranslator($this->translator);
142
143			return $serviceRequest->process();
144			}
145			}
146

chamilo / chamilo-lms

Pull Request — master (#5329)

ServiceController::outcomeService() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like