CourseController::courseConfigure() - 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-04 16:49 UTC
CourseController::courseConfigure() B

↳ Parent: CourseController
Complexity

Conditions	7
Paths	9
Size

Total Lines	97
Code Lines	57
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	7
eloc	57
nc	9
nop	2
dl	0
loc	97
rs	8.0048
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 Category;
use Chamilo\CoreBundle\Component\Utils\ToolIcon;
use Chamilo\CoreBundle\Entity\Course;
use Chamilo\CoreBundle\Entity\Session;
use Chamilo\CoreBundle\Entity\User;
use Chamilo\CourseBundle\Controller\ToolBaseController;
use Chamilo\CourseBundle\Entity\CTool;
use Chamilo\CourseBundle\Repository\CShortcutRepository;
use Chamilo\LtiBundle\Entity\ExternalTool;
use Chamilo\LtiBundle\Form\ExternalToolType;
use Chamilo\LtiBundle\Util\Utils;
use Display;
use Doctrine\Persistence\ManagerRegistry;
use EvalForm;
use Evaluation;
use Exception;
use HTML_QuickForm_select;
use OAuthConsumer;
use OAuthRequest;
use OAuthSignatureMethod_HMAC_SHA1;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use UserManager;

#[Route(path: '/courses/{cid}/lti')] // ;
class CourseController extends ToolBaseController
{
    public function __construct(
        private readonly CShortcutRepository $shortcutRepository,
        private readonly ManagerRegistry $managerRegistry
    ) {}

    #[Route(path: '/edit/{id}', name: 'chamilo_lti_edit', requirements: ['id' => '\d+'])]
    public function edit(int $id, Request $request): Response
    {
        $em = $this->managerRegistry->getManager();

        /** @var ExternalTool $tool */
        $tool = $em->find(ExternalTool::class, $id);

        if (empty($tool)) {
            throw $this->createNotFoundException('External tool not found');
        }

        $course = $this->getCourse();

        $form = $this->createForm(ExternalToolType::class, $tool);
        $form->get('shareName')->setData($tool->isSharingName());
        $form->get('shareEmail')->setData($tool->isSharingEmail());
        $form->get('sharePicture')->setData($tool->isSharingPicture());
        $form->handleRequest($request);

        if (!$form->isSubmitted() || !$form->isValid()) {
            return $this->render(
                '@ChamiloCore/Lti/course_configure.twig',
                [
                    'title' => $this->trans('Edit external tool'),
                    'added_tools' => [],
                    'global_tools' => [],
                    'form' => $form->createView(),
                    'course' => $course,
                ]
            );
        }

        /** @var ExternalTool $tool */
        $tool = $form->getData();

        $em->persist($tool);

        if (!$tool->isActiveDeepLinking()) {
            $courseTool = $em->getRepository(CTool::class)
                ->findOneBy(
                    [
                        'course' => $course,
                        'link' => $this->generateUrl(
                            'chamilo_lti_show',
                            [
                                'code' => $course->getCode(),
                                'id' => $tool->getId(),
                            ]
                        ),
                    ]
                )
            ;

            if (empty($courseTool)) {
                throw $this->createNotFoundException('Course tool not found.');
            }

            $courseTool->setTitle($tool->getTitle());

            $em->persist($courseTool);
        }

        $em->flush();

        $this->addFlash('success', $this->trans('External tool edited'));

        return $this->redirectToRoute(
            'chamilo_lti_edit',
            [
                'id' => $tool->getId(),
                'cid' => $course->getId(),
            ]
        );
    }

    #[Route(path: '/launch/{id}', name: 'chamilo_lti_launch', requirements: ['id' => '\d+'])]
    public function launch(int $id, Utils $ltiUtil): Response
    {
        $em = $this->managerRegistry->getManager();

        /** @var null|ExternalTool $tool */
        $tool = $em->find(ExternalTool::class, $id);

        if (empty($tool)) {
            throw $this->createNotFoundException();
        }

        $settingsManager = $this->get('chamilo.settings.manager');

        /** @var User $user */
        $user = $this->getUser();
        $course = $this->getCourse();
        $session = $this->getCourseSession();

        if (empty($tool->getCourse()) || $tool->getCourse()->getId() !== $course->getId()) {
            throw $this->createAccessDeniedException('');
        }

        $institutionDomain = $ltiUtil->getInstitutionDomain();
        $toolUserId = $ltiUtil->generateToolUserId($user->getId());

        $params = [];
        $params['lti_version'] = 'LTI-1p0';

        if ($tool->isActiveDeepLinking()) {
            $params['lti_message_type'] = 'ContentItemSelectionRequest';
            $params['content_item_return_url'] = $this->generateUrl(
                'chamilo_lti_return_item',
                [
                    'code' => $course->getCode(),
                ],
                UrlGeneratorInterface::ABSOLUTE_URL
            );
            $params['accept_media_types'] = '*/*';
            $params['accept_presentation_document_targets'] = 'iframe';
            $params['title'] = $tool->getTitle();
            $params['text'] = $tool->getDescription();
            $params['data'] = 'tool:'.$tool->getId();
        } else {
            $params['lti_message_type'] = 'basic-lti-launch-request';
            $params['resource_link_id'] = $tool->getId();
            $params['resource_link_title'] = $tool->getTitle();
            $params['resource_link_description'] = $tool->getDescription();

            $toolEval = $tool->getGradebookEval();

            if (!empty($toolEval)) {
                $params['lis_result_sourcedid'] = json_encode(
                    [
                        'e' => $toolEval->getId(),
                        'u' => $user->getId(),
                        'l' => uniqid(),
                        'lt' => time(),
                    ]
                );
                $params['lis_outcome_service_url'] = api_get_path(WEB_PATH).'lti/os';
                /* $params['lis_outcome_service_url'] = $this->generateUrl(
                    'chamilo_lti_os',
                    [],
                    UrlGeneratorInterface::ABSOLUTE_URL
                ); */
                $params['lis_person_sourcedid'] = "{$institutionDomain}:{$toolUserId}";
                $params['lis_course_section_sourcedid'] = "{$institutionDomain}:".$course->getId();

                if ($session) {
                    $params['lis_course_section_sourcedid'] .= ':'.$session->getId();
                }
            }
        }

        $params['user_id'] = $toolUserId;

        if ($tool->isSharingPicture()) {
            $params['user_image'] = UserManager::getUserPicture($user->getId());
        }

        $params['roles'] = Utils::generateUserRoles($user);

        if ($tool->isSharingName()) {
            $params['lis_person_name_given'] = $user->getFirstname();
            $params['lis_person_name_family'] = $user->getLastname();
            $params['lis_person_name_full'] = $user->getFirstname().' '.$user->getLastname();
        }

        if ($tool->isSharingEmail()) {
            $params['lis_person_contact_email_primary'] = $user->getEmail();
        }

        if ($user->hasRole('ROLE_RRHH')) {
            $scopeMentor = $ltiUtil->generateRoleScopeMentor($user);

            if (!empty($scopeMentor)) {
                $params['role_scope_mentor'] = $scopeMentor;
            }
        }

        $params['context_id'] = $course->getId();
        $params['context_type'] = 'CourseSection';
        $params['context_label'] = $course->getCode();
        $params['context_title'] = $course->getTitle();
        $params['launch_presentation_locale'] = 'en';
        $params['launch_presentation_document_target'] = 'iframe';
        $params['tool_consumer_info_product_family_code'] = 'Chamilo LMS';
        $params['tool_consumer_info_version'] = '2.0';
        $params['tool_consumer_instance_guid'] = $institutionDomain;
        $params['tool_consumer_instance_name'] = $settingsManager->getSetting('platform.site_name');
        $params['tool_consumer_instance_url'] = $this->generateUrl(
            'home',
            [],
            UrlGeneratorInterface::ABSOLUTE_URL
        );
        $params['tool_consumer_instance_contact_email'] = $settingsManager->getSetting('admin.administrator_email');

        $params['oauth_callback'] = 'about:blank';

        $customParams = $tool->parseCustomParams();
        Utils::trimParams($customParams);
        $this->variableSubstitution($params, $customParams, $user, $course, $session);

        $params += $customParams;
        Utils::trimParams($params);

        if (!empty($tool->getConsumerKey()) && !empty($tool->getSharedSecret())) {
            $consumer = new OAuthConsumer(
                $tool->getConsumerKey(),
                $tool->getSharedSecret(),
                null
            );
            $hmacMethod = new OAuthSignatureMethod_HMAC_SHA1();

            $request = OAuthRequest::from_consumer_and_token(
                $consumer,
                '',
                'POST',
                $tool->getLaunchUrl(),
                $params
            );
            $request->sign_request($hmacMethod, $consumer, '');

            $params = $request->get_parameters();
        }

        Utils::removeQueryParamsFromLaunchUrl($tool, $params);

        return $this->render(
            '@ChamiloCore/Lti/launch.html.twig',
            [
                'params' => $params,
                'launch_url' => $tool->getLaunchUrl(),
            ]
        );
    }

    #[Route(path: '/item_return', name: 'chamilo_lti_return_item')]
    public function returnItem(Request $request): Response
    {
        $contentItems = $request->get('content_items');
        $data = $request->get('data');

        if (empty($contentItems) || empty($data)) {
            throw $this->createAccessDeniedException();
        }

        $em = $this->managerRegistry->getManager();

        /** @var ExternalTool $tool */
        $tool = $em->find(ExternalTool::class, str_replace('tool:', '', $data));

        if (empty($tool)) {
            throw $this->createNotFoundException('External tool not found');
        }

        $course = $this->getCourse();
        $url = $this->generateUrl(
            'chamilo_lti_return_item',
            [
                'code' => $course->getCode(),
            ],
            UrlGeneratorInterface::ABSOLUTE_URL
        );

        $signatureIsValid = Utils::checkRequestSignature(
            $url,
            $request->get('oauth_consumer_key'),
            $request->get('oauth_signature'),
            $tool
        );

        if (!$signatureIsValid) {
            throw $this->createAccessDeniedException();
        }

        $contentItems = json_decode($contentItems, true)['@graph'];

        $supportedItemTypes = ['LtiLinkItem'];

        foreach ($contentItems as $contentItem) {
            if (!\in_array($contentItem['@type'], $supportedItemTypes, true)) {
                continue;
            }

            if ('LtiLinkItem' === $contentItem['@type']) {
                $newTool = $this->createLtiLink($contentItem, $tool);

                $this->addFlash(
                    'success',
                    sprintf(
                        $this->trans('External tool added: %s'),
                        $newTool->getTitle()
                    )
                );
            }
        }

        return $this->render(
            '@ChamiloCore/Lti/item_return.html.twig',
            [
                'course' => $course,
            ]
        );
    }

    #[Route(path: '/{id}', name: 'chamilo_lti_show', requirements: ['id' => '\d+'])]
    public function show(int $id): Response
    {
        $course = $this->getCourse();

        $em = $this->managerRegistry->getManager();

        /** @var null|ExternalTool $externalTool */
        $externalTool = $em->find(ExternalTool::class, $id);

        if (empty($externalTool)) {
            throw $this->createNotFoundException();
        }

        if (empty($externalTool->getCourse()) || $externalTool->getCourse()->getId() !== $course->getId()) {
            throw $this->createAccessDeniedException('');
        }

        return $this->render(
            '@ChamiloCore/Lti/iframe.html.twig',
            [
                'tool' => $externalTool,
                'course' => $course,
            ]
        );
    }

    /**
     * @Security("is_granted('ROLE_TEACHER')")
     */
    #[Route(path: '/', name: 'chamilo_lti_configure')]
    #[Route(path: '/add/{id}', name: 'chamilo_lti_configure_global', requirements: ['id' => '\d+'])]
    public function courseConfigure(?int $id, Request $request): Response
    {
        $em = $this->managerRegistry->getManager();
        $repo = $em->getRepository(ExternalTool::class);

        $externalTool = new ExternalTool();

        if (null !== $id) {
            $parentTool = $repo->findOneBy([
                'id' => $id,
                'course' => null,
            ]);

            if (empty($parentTool)) {
                throw $this->createNotFoundException('External tool not found');
            }

            $externalTool = clone $parentTool;
            $externalTool->setToolParent($parentTool);
        }

        $course = $this->getCourse();

        $form = $this->createForm(ExternalToolType::class, $externalTool);
        $form->get('shareName')->setData($externalTool->isSharingName());
        $form->get('shareEmail')->setData($externalTool->isSharingEmail());
        $form->get('sharePicture')->setData($externalTool->isSharingPicture());
        $form->handleRequest($request);

        if (!$form->isSubmitted() || !$form->isValid()) {
            $categories = Category::load(null, null, $course->getId());
            $actions = '';

            if (!empty($categories)) {
                $actions .= Display::url(
                    Display::getMdiIcon(ToolIcon::GRADEBOOK, 'ch-tool-icon', null, ICON_SIZE_MEDIUM, get_lang('Add to gradebook')),
                    $this->generateUrl(
                        'chamilo_lti_grade',
                        [
                            'catId' => $categories[0]->get_id(),
                            'course_code' => $course->getCode(),
                        ]
                    )
                );
            }

            return $this->render(
                '@ChamiloCore/Lti/course_configure.twig',
                [
                    'title' => $this->trans('Add external tool'),
                    'added_tools' => $repo->findBy([
                        'course' => $course,
                    ]),
                    'global_tools' => $repo->findBy([
                        'parent' => null,
                        'course' => null,
                    ]),
                    'form' => $form->createView(),
                    'course' => $course,
                    'actions' => $actions,
                ]
            );
        }

        /** @var ExternalTool $externalTool */
        $externalTool = $form->getData();
        $externalTool
            ->setCourse($course)
            ->setParent($course)
            ->addCourseLink($course)
        ;

        $em->persist($externalTool);
        $em->flush();

        $this->addFlash('success', $this->trans('External tool added'));

        /** @var User $user */
        $user = $this->getUser();

        if (!$externalTool->isActiveDeepLinking()) {
            $this->shortcutRepository->addShortCut($externalTool, $user, $course);

            return $this->redirectToRoute(
                'chamilo_core_course_home',
                [
                    'cid' => $course->getId(),
                ]
            );
        }

        return $this->redirectToRoute(
            'chamilo_lti_configure',
            [
                'course' => $course->getCode(),
            ]
        );
    }

    /**
     * @Security("is_granted('ROLE_TEACHER')")
     *
     * @param string $catId
     *
     * @throws Exception
     */
    #[Route(path: '/grade/{catId}', name: 'chamilo_lti_grade', requirements: ['catId' => '\d+'])]
    public function grade(int $catId): Response
    {
        $em = $this->managerRegistry->getManager();
        $toolRepo = $em->getRepository(ExternalTool::class);
        $course = $this->getCourse();

        /** @var User $user */
        $user = $this->getUser();

        $categories = Category::load(null, null, $course->getId());

        if (empty($categories)) {
            throw $this->createNotFoundException();
        }

        $evaladd = new Evaluation();
        $evaladd->set_user_id($user->getId());

        if (!empty($catId)) {
            $evaladd->set_category_id($catId);
            $evaladd->set_course_code($course->getCode());
                      set_course_code($course->getCode());
        } else {
            $evaladd->set_category_id(0);
        }

        $form = new EvalForm(
            EvalForm::TYPE_ADD,
            $evaladd,
            null,
            'add_eval_form',
            null,
            $this->generateUrl(
                'chamilo_lti_grade',
                [
                    'catId' => $catId,
                    'code' => $course->getCode(),
                ]
            ).'?'.api_get_cidreq()
        );
        $form->removeElement('name');
        $form->removeElement('addresult');

        /** @var HTML_QuickForm_select $slcLtiTools */
        $slcLtiTools = $form->createElement('select', 'name', $this->trans('External tool'));
        $form->insertElementBefore($slcLtiTools, 'hid_category_id');
        $form->addRule('name', get_lang('Required field'), 'required');

        $tools = $toolRepo->findBy([
            'course' => $course,
            'gradebookEval' => null,
        ]);

        /** @var ExternalTool $tool */
        foreach ($tools as $tool) {
            $slcLtiTools->addOption($tool->getTitle(), $tool->getId());
        }

        if (!$form->validate()) {
            return $this->render(
                '@ChamiloCore/Lti/gradebook.html.twig',
                [
                    'form' => $form->returnForm(),
                ]
            );
        }

        $values = $form->exportValues();

        $tool = $toolRepo->find($values['name']);

        if (empty($tool)) {
            throw $this->createNotFoundException();
        }

        $eval = new Evaluation();
        $eval->set_name($tool->getTitle());
        $eval->set_description($values['description']);
        $eval->set_user_id($values['hid_user_id']);

        if (!empty($values['hid_course_code'])) {
            $eval->set_course_code($values['hid_course_code']);
        }

        $eval->set_course_code($course->getCode());
        $eval->set_category_id($values['hid_category_id']);

        $values['weight'] = $values['weight_mask'];

        $eval->set_weight($values['weight']);
        $eval->set_max($values['max']);
        $eval->set_visible(empty($values['visible']) ? 0 : 1);
        $eval->add();

        $gradebookEval = $em->find('ChamiloCoreBundle:GradebookEvaluation', $eval->get_id());

        $tool->setGradebookEval($gradebookEval);

        $em->persist($tool);
        $em->flush();

        $this->addFlash('success', $this->trans('Evaluation for external tool added'));

        return $this->redirect(api_get_course_url());
    }

    private function variableSubstitution(
        array $params,
        array &$customParams,
        User $user,
        Course $course,
        ?Session $session = null
    ): void {
        $replaceable = self::getReplaceableVariables($user, $course, $session);
        $variables = array_keys($replaceable);

        foreach ($customParams as $customKey => $customValue) {
            if (!\in_array($customValue, $variables, true)) {
                continue;
            }

            $val = $replaceable[$customValue];

            if (\is_array($val)) {
                $val = current($val);

                if (\array_key_exists($val, $params)) {
                    $customParams[$customKey] = $params[$val];

                    continue;
                }
                $val = false;
            }

            if (false === $val) {
                $customParams[$customKey] = $customValue;

                continue;
            }

            $customParams[$customKey] = $replaceable[$customValue];
        }
    }

    private static function getReplaceableVariables(User $user, Course $course, ?Session $session = null): array
    {
        return [
            '$User.id' => $user->getId(),
            '$User.image' => ['user_image'],
            '$User.username' => $user->getUsername(),

            '$Person.sourcedId' => false,
            '$Person.name.full' => $user->getFullname(),
            '$Person.name.family' => $user->getLastname(),
            '$Person.name.given' => $user->getFirstname(),
            '$Person.name.middle' => false,
            '$Person.name.prefix' => false,
            '$Person.name.suffix' => false,
            '$Person.address.street1' => $user->getAddress(),
            '$Person.address.street2' => false,
            '$Person.address.street3' => false,
            '$Person.address.street4' => false,
            '$Person.address.locality' => false,
            '$Person.address.statepr' => false,
            '$Person.address.country' => false,
            '$Person.address.postcode' => false,
            '$Person.address.timezone' => false,
            // $user->getTimezone(),
            '$Person.phone.mobile' => false,
            '$Person.phone.primary' => $user->getPhone(),
            '$Person.phone.home' => false,
            '$Person.phone.work' => false,
            '$Person.email.primary' => $user->getEmail(),
            '$Person.email.personal' => false,
            '$Person.webaddress' => false,
            // $user->getWebsite(),
            '$Person.sms' => false,

            '$CourseTemplate.sourcedId' => false,
            '$CourseTemplate.label' => false,
            '$CourseTemplate.title' => false,
            '$CourseTemplate.shortDescription' => false,
            '$CourseTemplate.longDescription' => false,
            '$CourseTemplate.courseNumber' => false,
            '$CourseTemplate.credits' => false,

            '$CourseOffering.sourcedId' => false,
            '$CourseOffering.label' => false,
            '$CourseOffering.title' => false,
            '$CourseOffering.shortDescription' => false,
            '$CourseOffering.longDescription' => false,
            '$CourseOffering.courseNumber' => false,
            '$CourseOffering.credits' => false,
            '$CourseOffering.academicSession' => false,

            '$CourseSection.sourcedId' => ['lis_course_section_sourcedid'],
            '$CourseSection.label' => $course->getCode(),
            '$CourseSection.title' => $course->getTitle(),
            '$CourseSection.shortDescription' => false,
            '$CourseSection.longDescription' => $session && $session->getShowDescription()
                ? $session->getDescription()
                : false,
            '$CourseSection.courseNumber' => false,
            '$CourseSection.credits' => false,
            '$CourseSection.maxNumberofStudents' => false,
            '$CourseSection.numberofStudents' => false,
            '$CourseSection.dept' => false,
            '$CourseSection.timeFrame.begin' => $session && $session->getDisplayStartDate()
                ? $session->getDisplayStartDate()->format('Y-m-d\TH:i:sP')
                : false,
            '$CourseSection.timeFrame.end' => $session && $session->getDisplayEndDate()
                ? $session->getDisplayEndDate()->format('Y-m-d\TH:i:sP')
                : false,
            '$CourseSection.enrollControl.accept' => false,
            '$CourseSection.enrollControl.allowed' => false,
            '$CourseSection.dataSource' => false,
            '$CourseSection.sourceSectionId' => false,

            '$Group.sourcedId' => false,
            '$Group.grouptype.scheme' => false,
            '$Group.grouptype.typevalue' => false,
            '$Group.grouptype.level' => false,
            '$Group.email' => false,
            '$Group.url' => false,
            '$Group.timeFrame.begin' => false,
            '$Group.timeFrame.end' => false,
            '$Group.enrollControl.accept' => false,
            '$Group.enrollControl.allowed' => false,
            '$Group.shortDescription' => false,
            '$Group.longDescription' => false,
            '$Group.parentId' => false,

            '$Membership.sourcedId' => false,
            '$Membership.collectionSourcedId' => false,
            '$Membership.personSourcedId' => false,
            '$Membership.status' => false,
            '$Membership.role' => ['roles'],
            '$Membership.createdTimestamp' => false,
            '$Membership.dataSource' => false,

            '$LineItem.sourcedId' => false,
            '$LineItem.type' => false,
            '$LineItem.type.displayName' => false,
            '$LineItem.resultValue.max' => false,
            '$LineItem.resultValue.list' => false,
            '$LineItem.dataSource' => false,

            '$Result.sourcedGUID' => ['lis_result_sourcedid'],
            '$Result.sourcedId' => ['lis_result_sourcedid'],
            '$Result.createdTimestamp' => false,
            '$Result.status' => false,
            '$Result.resultScore' => false,
            '$Result.dataSource' => false,

            '$ResourceLink.title' => ['resource_link_title'],
            '$ResourceLink.description' => ['resource_link_description'],
        ];
    }

    private function createLtiLink(array &$contentItem, ExternalTool $baseTool): ExternalTool
    {
        $newTool = clone $baseTool;
        $newTool->setToolParent($baseTool);
        $newTool->setActiveDeepLinking(false);

        if (!empty($contentItem['title'])) {
            $newTool->setTitle($contentItem['title']);
        }

        if (!empty($contentItem['text'])) {
            $newTool->setDescription($contentItem['text']);
        }

        if (!empty($contentItem['url'])) {
            $newTool->setLaunchUrl($contentItem['url']);
        }

        if (!empty($contentItem['custom'])) {
            $newTool->setCustomParams(
                $newTool->encodeCustomParams($contentItem['custom'])
            );
        }

        $em = $this->managerRegistry->getManager();

        $course = $newTool->getCourse();

        $newTool->addCourseLink($course);

        $em->persist($newTool);
        $em->flush();

        /** @var User $user */
        $user = $this->getUser();
        $this->shortcutRepository->addShortCut($newTool, $user, $course);

        return $newTool;
    }
}

chamilo / chamilo-lms

Pull Request — master (#5329)

CourseController::courseConfigure() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
