From 576b2a488c45c951ae1b8c6bb94de3a41506a693 Mon Sep 17 00:00:00 2001 From: christianbeeznst Date: Wed, 27 Mar 2024 00:35:45 -0500 Subject: [PATCH] Course: Refactor course creation service --- assets/vue/components/course/Form.vue | 4 +- assets/vue/views/course/Create.vue | 27 +- .../Controller/CourseController.php | 49 +- .../Repository/Node/CourseRepository.php | 25 +- src/CoreBundle/Service/CourseService.php | 749 ++++++++++++++++++ src/CoreBundle/Service/EventLoggerService.php | 61 ++ 6 files changed, 878 insertions(+), 37 deletions(-) create mode 100644 src/CoreBundle/Service/CourseService.php create mode 100644 src/CoreBundle/Service/EventLoggerService.php diff --git a/assets/vue/components/course/Form.vue b/assets/vue/components/course/Form.vue index 93ec575b4ef..b871e60fb85 100644 --- a/assets/vue/components/course/Form.vue +++ b/assets/vue/components/course/Form.vue @@ -45,12 +45,12 @@ v-model="fillDemoContent" name="" /> - + /-->
diff --git a/assets/vue/views/course/Create.vue b/assets/vue/views/course/Create.vue index 85fb9969f10..a2e1c50f0ae 100644 --- a/assets/vue/views/course/Create.vue +++ b/assets/vue/views/course/Create.vue @@ -29,6 +29,7 @@ import { useRouter } from "vue-router" import Message from 'primevue/message' import courseService from "../../services/courseService" import { useI18n } from "vue-i18n" +import { useNotification } from "../../composables/notification" const store = useStore() const item = ref({}) @@ -38,24 +39,26 @@ const { t } = useI18n() const isLoading = computed(() => store.getters['course/getField']('isLoading')) const violations = computed(() => store.getters['course/getField']('violations')) const courseData = ref({}) +const { showSuccessNotification, showErrorNotification } = useNotification() const submitCourse = async (formData) => { isLoading.value = true try { - let tempResponse = await courseService.createCourse(formData) - if (tempResponse.success) { - const courseId = tempResponse.courseId - const sessionId = 0 - await router.push(`/course/${courseId}/home?sid=${sessionId}`) - } else { - console.error(tempResponse.message) - } + const response = await courseService.createCourse(formData) + const courseId = response.courseId + const sessionId = 0 + showSuccessNotification(t('Course created successfully.')) + await router.push(`/course/${courseId}/home?sid=${sessionId}`) } catch (error) { console.error(error) - if (error.response && error.response.data) { - violations.value = error.response.data - } else { - console.error('An unexpected error occurred.') + + const errorMessage = error.response && error.response.data && error.response.data.message + ? error.response.data.message + : t('An unexpected error occurred.') + showErrorNotification(errorMessage) + + if (error.response && error.response.data && error.response.data.violations) { + violations.value = error.response.data.violations } } finally { isLoading.value = false diff --git a/src/CoreBundle/Controller/CourseController.php b/src/CoreBundle/Controller/CourseController.php index c72fcd91f38..c25867be349 100644 --- a/src/CoreBundle/Controller/CourseController.php +++ b/src/CoreBundle/Controller/CourseController.php @@ -23,6 +23,7 @@ use Chamilo\CoreBundle\Repository\Node\IllustrationRepository; use Chamilo\CoreBundle\Repository\TagRepository; use Chamilo\CoreBundle\Security\Authorization\Voter\CourseVoter; +use Chamilo\CoreBundle\Service\CourseService; use Chamilo\CoreBundle\ServiceHelper\AccessUrlHelper; use Chamilo\CoreBundle\Settings\SettingsManager; use Chamilo\CoreBundle\Tool\ToolChain; @@ -721,7 +722,7 @@ public function searchCourseTemplates( foreach ($courseList as $course) { $title = $course['title']; $results['items'][] = [ - 'id' => $course['code'], + 'id' => $course['id'], 'name' => $title.' ('.$course['code'].') ', ]; } @@ -730,36 +731,34 @@ public function searchCourseTemplates( } #[Route('/create', name: 'chamilo_core_course_create')] - public function createCourse(Request $request, TranslatorInterface $translator): JsonResponse - { + public function createCourse( + Request $request, + TranslatorInterface $translator, + CourseService $courseService + ): JsonResponse { $courseData = json_decode($request->getContent(), true); + $title = $courseData['name'] ?? null; $wantedCode = $courseData['code'] ?? null; + $courseLanguage = $courseData['language']['id'] ?? null; $categoryCode = $courseData['category'] ?? null; - $title = $courseData['name']; - $courseLanguage = isset($courseData['language']) ? $courseData['language']['id'] : ''; $exemplaryContent = $courseData['fillDemoContent'] ?? false; $template = $courseData['template'] ?? ''; - if (empty($wantedCode)) { - $wantedCode = CourseManager::generate_course_code(substr($title, 0, CourseManager::MAX_COURSE_LENGTH_CODE)); - } - - $courseCodeOk = !CourseManager::course_code_exists($wantedCode); - if ($courseCodeOk) { - $params = [ - 'title' => $title, - 'exemplary_content' => $exemplaryContent, - 'wanted_code' => $wantedCode, - 'course_language' => $courseLanguage, - 'course_template' => $template, - ]; + $params = [ + 'title' => $title, + 'wanted_code' => $wantedCode, + 'course_language' => $courseLanguage, + 'exemplary_content' => $exemplaryContent, + 'course_template' => $template, + ]; - if ($categoryCode) { - $params['course_categories'] = $categoryCode; - } + if ($categoryCode) { + $params['course_categories'] = $categoryCode; + } - $course = CourseManager::create_course($params); + try { + $course = $courseService->createCourse($params); if ($course) { return new JsonResponse([ 'success' => true, @@ -767,6 +766,12 @@ public function createCourse(Request $request, TranslatorInterface $translator): 'courseId' => $course->getId(), ]); } + } catch (\Exception $e) { + + return new JsonResponse([ + 'success' => false, + 'message' => $translator->trans($e->getMessage()) + ], Response::HTTP_BAD_REQUEST); } return new JsonResponse(['success' => false, 'message' => $translator->trans('An error occurred while creating the course.')]); diff --git a/src/CoreBundle/Repository/Node/CourseRepository.php b/src/CoreBundle/Repository/Node/CourseRepository.php index 38707134e89..62b531273de 100644 --- a/src/CoreBundle/Repository/Node/CourseRepository.php +++ b/src/CoreBundle/Repository/Node/CourseRepository.php @@ -10,10 +10,10 @@ use Chamilo\CoreBundle\Entity\AccessUrl; use Chamilo\CoreBundle\Entity\Course; use Chamilo\CoreBundle\Entity\CourseRelUser; -use Chamilo\CoreBundle\Entity\ResourceNode; use Chamilo\CoreBundle\Entity\User; use Chamilo\CoreBundle\Repository\ResourceRepository; use Doctrine\Common\Collections\Criteria; +use Doctrine\ORM\AbstractQuery; use Doctrine\ORM\Query\Expr\Join; use Doctrine\ORM\QueryBuilder; use Doctrine\Persistence\ManagerRegistry; @@ -207,4 +207,27 @@ public function getSubscribedUsersByStatus(Course $course, int $status) return $queryBuilder; } + + public function courseCodeExists(string $code): bool + { + $qb = $this->createQueryBuilder('c') + ->select('count(c.id)') + ->where('c.code = :code OR c.visualCode = :code') + ->setParameter('code', $code) + ->getQuery(); + + return (int) $qb->getSingleScalarResult() > 0; + } + + public function findCourseAsArray($id) + { + $qb = $this->createQueryBuilder('c') + ->select('c.id, c.code, c.title, c.visualCode, c.courseLanguage, c.departmentUrl, c.departmentName') + ->where('c.id = :id') + ->setParameter('id', $id); + + $query = $qb->getQuery(); + + return $query->getOneOrNullResult(AbstractQuery::HYDRATE_ARRAY); + } } diff --git a/src/CoreBundle/Service/CourseService.php b/src/CoreBundle/Service/CourseService.php new file mode 100644 index 00000000000..a0bc6920306 --- /dev/null +++ b/src/CoreBundle/Service/CourseService.php @@ -0,0 +1,749 @@ +generateCourseCode($params['title']); + } + + if ($this->courseRepository->courseCodeExists($params['wanted_code'])) { + throw new \Exception('The course code already exists: ' . $params['wanted_code']); + } + + $keys = $this->defineCourseKeys($params['wanted_code']); + + $params = array_merge($params, $keys); + $course = $this->registerCourse($params); + if ($course) { + $this->handlePostCourseCreation($course, $params); + } + + return $course; + } + + public function registerCourse(array $rawParams): ?Course + { + try { + /* @var User $currentUser */ + $currentUser = $this->security->getUser(); + + $params = $this->prepareAndValidateCourseData($rawParams); + + $course = new Course(); + $course + ->setTitle($params['title']) + ->setCode($params['code']) + ->setVisualCode($params['visualCode']) + ->setCourseLanguage($params['courseLanguage']) + ->setDescription($this->translator->trans('Course Description')) + ->setVisibility((int) $params['visibility']) + ->setShowScore(1) + ->setDiskQuota((int) $params['diskQuota']) + ->setExpirationDate($params['expirationDate']) + ->setDepartmentName($params['departmentName'] ?? '') + ->setDepartmentUrl($params['departmentUrl']) + ->setSubscribe($params['subscribe']) + ->setSticky($params['sticky'] ?? false) + ->setVideoUrl($params['videoUrl'] ?? '') + ->setUnsubscribe($params['unsubscribe']) + ->setCreator($currentUser); + + if (!empty($params['categories'])) { + foreach ($params['categories'] as $categoryId) { + $category = $this->courseCategoryRepository->find($categoryId); + if ($category) { + $course->addCategory($category); + } + } + } + + $addTeacher = $params['add_user_as_teacher'] ?? true; + $user = $currentUser; + if (!empty($params['user_id'])) { + $user = $this->userRepository->find((int) $params['user_id']); + } + if ($addTeacher) { + $courseRelTutor = (new CourseRelUser()) + ->setCourse($course) + ->setUser($user) + ->setStatus(1) + ->setTutor(true) + ->setRelationType(0) + ->setUserCourseCat(0) + ; + $course->addSubscription($courseRelTutor); + } + + if (!empty($params['teachers'])) { + foreach ($params['teachers'] as $teacherId) { + $teacher = $this->userRepository->find($teacherId); + if ($teacher) { + $courseRelTeacher = (new CourseRelUser()) + ->setCourse($course) + ->setUser($teacher) + ->setStatus(1) + ->setTutor(false) + ->setRelationType(0) + ->setUserCourseCat(0) + ; + $course->addSubscription($courseRelTeacher); + } + } + } + + $this->courseRepository->create($course); + + if ($rawParams['exemplary_content']) { + $this->fillCourse($course, $params); + } + + if (isset($rawParams['course_template'])) { + $this->useTemplateAsBasisIfRequired( + $course->getCode(), + $rawParams['course_template'] + ); + } + + return $course; + + } catch (\Exception $e) { + return null; + } + } + + public function sendEmailToAdmin(Course $course): void + { + $siteName = $this->getDefaultSetting('platform.site_name'); + $recipientEmail = $this->getDefaultSetting('admin.administrator_email'); + $recipientName = $this->getDefaultSetting('admin.administrator_name') . ' ' . $this->getDefaultSetting('admin.administrator_surname'); + $institutionName = $this->getDefaultSetting('platform.institution'); + $courseName = $course->getTitle(); + + $subject = $this->translator->trans('New Course Created in'). "$siteName - $institutionName"; + + $greeting = $this->translator->trans('email.greeting'); + $intro = $this->translator->trans('email.course_created_intro'); + $courseNameLabel = $this->translator->trans('email.course_name'); + + $message = "$greeting $recipientName,\n\n"; + $message .= "$intro $siteName - $institutionName.\n"; + $message .= "$courseNameLabel $courseName\n"; + $message .= $this->translator->trans('Course name: ').$course->getTitle() . "\n"; + + foreach ($course->getCategories() as $category) { + $message .= $this->translator->trans('Category: ').$category->getCode() . "\n"; + } + + $message .= $this->translator->trans('Coach: ').$course->getTutorName() . "\n"; + $message .= $this->translator->trans('Language: ').$course->getCourseLanguage(); + + $email = (new Email()) + ->from($recipientEmail) + ->to($recipientEmail) + ->subject($subject) + ->text($message); + + $this->mailer->send($email); + } + + public function defineCourseKeys( + string $wantedCode, + string $prefixForAll = '', + string $prefixForPath = '', + bool $addUniquePrefix = false, + bool $useCodeIndependentKeys = true + ): array { + $wantedCode = $this->generateCourseCode($wantedCode); + $keysCourseCode = $useCodeIndependentKeys ? $wantedCode : ''; + + $uniquePrefix = $addUniquePrefix ? substr(md5(uniqid((string) rand(), true)), 0, 10) : ''; + + $keys = []; + $finalSuffix = ['CourseId' => '', 'CourseDir' => '']; + $limitNumTry = 100; + $tryCount = 0; + + $keysAreUnique = false; + + while (!$keysAreUnique && $tryCount < $limitNumTry) { + $keysCourseId = $prefixForAll . $uniquePrefix . $keysCourseCode . $finalSuffix['CourseId']; + $keysCourseRepository = $prefixForPath . $uniquePrefix . $wantedCode . $finalSuffix['CourseDir']; + + if ($this->courseRepository->courseCodeExists($keysCourseId)) { + $finalSuffix['CourseId'] = substr(md5(uniqid((string) rand(), true)), 0, 4); + $tryCount++; + } else { + $keysAreUnique = true; + } + } + + if ($keysAreUnique) { + $keys = [ + 'code' => $keysCourseCode, + 'visual_code' => $keysCourseId, + 'directory' => $keysCourseRepository, + ]; + } + + return $keys; + } + + public function fillCourse(Course $course, array $params): void + { + $entityManager = $this->entityManager; + + $this->insertCourseSettings($course); + + $this->createGroupCategory($course); + + $gradebook = $this->createRootGradebook($course); + + if ('true' === $this->settingsManager->getSetting('course.example_material_course_creation')) { + $this->insertExampleContent($course, $gradebook); + } + + $this->installCoursePlugins($course->getId()); + + $entityManager->flush(); + } + + private function insertCourseSettings(Course $course): void + { + $defaultEmailExerciseAlert = 0; + if ('true' === $this->settingsManager->getSetting('exercise.email_alert_manager_on_new_quiz')) { + $defaultEmailExerciseAlert = 1; + } + + $settings = [ + 'email_alert_manager_on_new_doc' => ['title' => '', 'default' => 0, 'category' => 'work'], + 'email_alert_on_new_doc_dropbox' => ['default' => 0, 'category' => 'dropbox'], + 'allow_user_edit_agenda' => ['default' => 0, 'category' => 'agenda'], + 'allow_user_edit_announcement' => ['default' => 0, 'category' => 'announcement'], + 'email_alert_manager_on_new_quiz' => ['default' => $defaultEmailExerciseAlert, 'category' => 'quiz'], + 'allow_user_image_forum' => ['default' => 1, 'category' => 'forum'], + 'course_theme' => ['default' => '', 'category' => 'theme'], + 'allow_learning_path_theme' => ['default' => 1, 'category' => 'theme'], + 'allow_open_chat_window' => ['default' => 1, 'category' => 'chat'], + 'email_alert_to_teacher_on_new_user_in_course' => ['default' => 0, 'category' => 'registration'], + 'allow_user_view_user_list' => ['default' => 1, 'category' => 'user'], + 'display_info_advance_inside_homecourse' => ['default' => 1, 'category' => 'thematic_advance'], + 'email_alert_students_on_new_homework' => ['default' => 0, 'category' => 'work'], + 'enable_lp_auto_launch' => ['default' => 0, 'category' => 'learning_path'], + 'enable_exercise_auto_launch' => ['default' => 0, 'category' => 'exercise'], + 'enable_document_auto_launch' => ['default' => 0, 'category' => 'document'], + 'pdf_export_watermark_text' => ['default' => '', 'category' => 'learning_path'], + 'allow_public_certificates' => [ + 'default' => 'true' === $this->settingsManager->getSetting('course.allow_public_certificates') ? 1 : '', + 'category' => 'certificates', + ], + 'documents_default_visibility' => ['default' => 'visible', 'category' => 'document'], + 'show_course_in_user_language' => ['default' => 2, 'category' => null], + 'email_to_teachers_on_new_work_feedback' => ['default' => 1, 'category' => null], + ]; + + foreach ($settings as $variable => $setting) { + $courseSetting = new CCourseSetting(); + $courseSetting->setCId($course->getId()); + $courseSetting->setVariable($variable); + $courseSetting->setTitle($setting['title'] ?? ''); + $courseSetting->setValue((string)$setting['default']); + $courseSetting->setCategory($setting['category'] ?? ''); + + $this->entityManager->persist($courseSetting); + } + + $this->entityManager->flush(); + } + + private function createGroupCategory(Course $course): void + { + $groupCategory = new CGroupCategory(); + $groupCategory + ->setTitle($this->translator->trans('Default groups')) + ->setParent($course) + ->addCourseLink($course) + ; + + $this->entityManager->persist($groupCategory); + $this->entityManager->flush(); + } + + private function createRootGradebook(Course $course): GradebookCategory + { + /* @var User $currentUser */ + $currentUser = $this->security->getUser(); + if (!$currentUser) { + throw new \LogicException('There is no user currently authenticated..'); + } + + $gradebookCategory = new GradebookCategory(); + $gradebookCategory + ->setTitle($course->getCode()) + ->setLocked(0) + ->setGenerateCertificates(false) + ->setDescription('') + ->setCourse($course) + ->setWeight(100) + ->setVisible(false) + ->setCertifMinScore(75) + ->setUser($currentUser); + + $this->entityManager->persist($gradebookCategory); + $this->entityManager->flush(); + + return $gradebookCategory; + } + + private function insertExampleContent(Course $course, GradebookCategory $gradebook): void + { + /* @var User $currentUser */ + $currentUser = $this->security->getUser(); + + $files = [ + ['path' => '/audio', 'title' => $this->translator->trans('Audio'), 'filetype' => 'folder', 'size' => 0], + ['path' => '/images', 'title' => $this->translator->trans('Images'), 'filetype' => 'folder', 'size' => 0], + ['path' => '/images/gallery', 'title' => $this->translator->trans('Gallery'), 'filetype' => 'folder', 'size' => 0], + ['path' => '/video', 'title' => $this->translator->trans('Video'), 'filetype' => 'folder', 'size' => 0], + ]; + $paths = []; + $courseInfo = ['real_id' => $course->getId(), 'code' => $course->getCode()]; + foreach ($files as $file) { + $doc = DocumentManager::addDocument( + $courseInfo, + $file['path'], + $file['filetype'], + $file['size'], + $file['title'], + null, + 0, + null, + 0, + 0, + 0, + false + ); + $paths[$file['path']] = $doc->getIid(); + } + + $projectDir = $this->parameterBag->get('kernel.project_dir'); + $defaultPath = $projectDir . '/public/img/document'; + + $request = $this->requestStack->getCurrentRequest(); + $baseUrl = $request->getSchemeAndHttpHost() . $request->getBasePath(); + + $finder = new Finder(); + $finder->in($defaultPath); + + /** @var SplFileInfo $file */ + foreach ($finder as $file) { + $parentName = dirname(str_replace($defaultPath, '', $file->getRealPath())); + if ('/' === $parentName || '/certificates' === $parentName) { + continue; + } + + $title = $file->getFilename(); + $parentId = $paths[$parentName]; + + if ($file->isDir()) { + $realPath = str_replace($defaultPath, '', $file->getRealPath()); + $document = DocumentManager::addDocument( + $courseInfo, + $realPath, + 'folder', + null, + $title, + '', + null, + null, + null, + null, + null, + false, + null, + $parentId, + $file->getRealPath() + ); + $paths[$realPath] = $document->getIid(); + } else { + $realPath = str_replace($defaultPath, '', $file->getRealPath()); + $document = DocumentManager::addDocument( + $courseInfo, + $realPath, + 'file', + $file->getSize(), + $title, + '', + null, + null, + null, + null, + null, + false, + null, + $parentId, + $file->getRealPath() + ); + } + } + + $now = new \DateTime('now', new \DateTimeZone('UTC')); + $formattedNow = $now->format('Y-m-d H:i:s'); + + $agenda = new Agenda('course'); + $agenda->set_course($courseInfo); + $agenda->addEvent( + $formattedNow, + $formattedNow, + 0, + $this->translator->trans('Course creation'), + $this->translator->trans('This course was created at this time'), + ['everyone' => 'everyone'] + ); + + /* Links tool */ + $link = new Link(); + $link->setCourse($courseInfo); + $links = [ + [ + 'c_id' => $course->getId(), + 'url' => 'http://www.google.com', + 'title' => 'Quick and powerful search engine', + 'description' => $this->translator->trans('Quick and powerful search engine'), + 'category_id' => 0, + 'on_homepage' => 0, + 'target' => '_self', + 'session_id' => 0, + ], + [ + 'c_id' => $course->getId(), + 'url' => 'http://www.wikipedia.org', + 'title' => 'Free online encyclopedia', + 'description' => $this->translator->trans('Free online encyclopedia'), + 'category_id' => 0, + 'on_homepage' => 0, + 'target' => '_self', + 'session_id' => 0, + ], + ]; + + foreach ($links as $params) { + $link->save($params, false, false); + } + + /* Announcement tool */ + AnnouncementManager::add_announcement( + $courseInfo, + 0, + $this->translator->trans('This is an announcement example'), + $this->translator->trans('This is an announcement example. Only trainers are allowed to publish announcements.'), + ['everyone' => 'everyone'], + null, + null, + $formattedNow + ); + + /* Exercise tool */ + $exercise = new Exercise($course->getId()); + $exercise->exercise = $this->translator->trans('Sample test'); + $html = ' + + + +
+ + '.$this->translator->trans('Irony').'
'; + $exercise->type = 1; + $exercise->setRandom(0); + $exercise->active = 1; + $exercise->results_disabled = 0; + $exercise->description = $html; + $exercise->save(); + + $question = new MultipleAnswer(); + $question->course = $courseInfo; + $question->question = $this->translator->trans('Socratic irony is...'); + $question->description = $this->translator->trans('(more than one answer can be true)'); + $question->weighting = 10; + $question->position = 1; + $question->course = $courseInfo; + $question->save($exercise); + $questionId = $question->id; + + $answer = new Answer($questionId, $courseInfo['real_id']); + $answer->createAnswer($this->translator->trans('Ridiculise one\'s interlocutor in order to have him concede he is wrong.'), 0, $this->translator->trans('No. Socratic irony is not a matter of psychology, it concerns argumentation.'), -5, 1); + $answer->createAnswer($this->translator->trans('Admit one\'s own errors to invite one\'s interlocutor to do the same.'), 0, $this->translator->trans('No. Socratic irony is not a seduction strategy or a method based on the example.'), -5, 2); + $answer->createAnswer($this->translator->trans('Compell one\'s interlocutor, by a series of questions and sub-questions, to admit he doesn\'t know what he claims to know.'), 1, $this->translator->trans('Indeed'), 5, 3); + $answer->createAnswer($this->translator->trans('Use the Principle of Non Contradiction to force one\'s interlocutor into a dead end.'), 1, $this->translator->trans('This answer is not false. It is true that the revelation of the interlocutor\'s ignorance means showing the contradictory conclusions where lead his premisses.'), 5, 4); + $answer->save(); + + // Forums. + $params = [ + 'forum_category_title' => $this->translator->trans('Example Forum Category'), + 'forum_category_comment' => '', + ]; + + $forumCategoryId = saveForumCategory($params, $courseInfo, false); + + $params = [ + 'forum_category' => $forumCategoryId, + 'forum_title' => $this->translator->trans('Example Forum'), + 'forum_comment' => '', + 'default_view_type_group' => ['default_view_type' => 'flat'], + ]; + + $forumId = store_forum($params, $courseInfo, true); + $repo = $this->entityManager->getRepository(CForum::class); + $forumEntity = $repo->find($forumId); + + $params = [ + 'post_title' => $this->translator->trans('Example Thread'), + 'forum_id' => $forumId, + 'post_text' => $this->translator->trans('Example ThreadContent'), + 'calification_notebook_title' => '', + 'numeric_calification' => '', + 'weight_calification' => '', + 'forum_category' => $forumCategoryId, + 'thread_peer_qualify' => 0, + ]; + + saveThread($forumEntity, $params, $courseInfo, false); + + $this->createExampleGradebookContent($course, $gradebook, $exercise->id); + } + + private function createExampleGradebookContent(Course $course, GradebookCategory $parentCategory, int $refId): void + { + $manager = $this->entityManager; + + /* Gradebook tool */ + $courseCode = $course->getCode(); + + $childGradebookCategory = new GradebookCategory(); + $childGradebookCategory->setTitle($courseCode); + $childGradebookCategory->setLocked(0); + $childGradebookCategory->setGenerateCertificates(false); + $childGradebookCategory->setDescription(''); + $childGradebookCategory->setCourse($course); + $childGradebookCategory->setWeight(100); + $childGradebookCategory->setVisible(true); + $childGradebookCategory->setCertifMinScore(75); + $childGradebookCategory->setParent($parentCategory); + $childGradebookCategory->setUser(api_get_user_entity()); + + $manager->persist($childGradebookCategory); + $manager->flush(); + + $gradebookLink = new GradebookLink(); + + $gradebookLink->setType(1); + $gradebookLink->setRefId($refId); + $gradebookLink->setUser(api_get_user_entity()); + $gradebookLink->setCourse($course); + $gradebookLink->setCategory($childGradebookCategory); + $gradebookLink->setCreatedAt(new \DateTime()); + $gradebookLink->setWeight(100); + $gradebookLink->setVisible(1); + $gradebookLink->setLocked(0); + + $manager->persist($gradebookLink); + $manager->flush(); + } + + private function installCoursePlugins(int $courseId): void + { + $app_plugin = new AppPlugin(); + $app_plugin->install_course_plugins($courseId); + } + + public function useTemplateAsBasisIfRequired($courseCode, $courseTemplate): void + { + $templateSetting = $this->settingsManager->getSetting('course.course_creation_use_template'); + $teacherCanSelectCourseTemplate = 'true' === $this->settingsManager->getSetting('course.teacher_can_select_course_template'); + $courseTemplate = isset($courseTemplate) ? intval($courseTemplate) : 0; + + $useTemplate = false; + + if ($teacherCanSelectCourseTemplate && $courseTemplate) { + $useTemplate = true; + $originCourse = $this->courseRepository->findCourseAsArray($courseTemplate); + } elseif (!empty($templateSetting)) { + $useTemplate = true; + $originCourse = $this->courseRepository->findCourseAsArray($templateSetting); + } + + if ($useTemplate && $originCourse) { + $originCourse['official_code'] = $originCourse['code']; + $cb = new CourseBuilder(null, $originCourse); + $course = $cb->build(null, $originCourse['code']); + $cr = new CourseRestorer($course); + $cr->set_file_option(); + $cr->restore($courseCode); + } + } + + private function prepareAndValidateCourseData(array $params): array + { + $title = str_replace('&', '&', $params['title'] ?? ''); + $code = $params['code'] ?? ''; + $visualCode = $params['visual_code'] ?? ''; + $directory = $params['directory'] ?? ''; + $tutorName = $params['tutor_name'] ?? null; + $courseLanguage = !empty($params['course_language']) ? $params['course_language'] : $this->getDefaultSetting('language.platform_language'); + $departmentName = $params['department_name'] ?? null; + $departmentUrl = $this->fixDepartmentUrl($params['department_url'] ?? ''); + $diskQuota = $params['disk_quota'] ?? $this->getDefaultSetting('document.default_document_quotum'); + $visibility = $params['visibility'] ?? $this->getDefaultSetting('course.courses_default_creation_visibility', Course::OPEN_PLATFORM); + $subscribe = $params['subscribe'] ?? ($visibility == Course::OPEN_PLATFORM); + $unsubscribe = $params['unsubscribe'] ?? false; + $expirationDate = $params['expiration_date'] ?? $this->getFutureExpirationDate(); + $teachers = $params['teachers'] ?? []; + $categories = $params['course_categories'] ?? []; + $notifyAdmins = $this->getDefaultSetting('course.send_email_to_admin_when_create_course'); + + $errors = []; + if (empty($code)) $errors[] = 'courseSysCode is missing'; + if (empty($visualCode)) $errors[] = 'courseScreenCode is missing'; + if (empty($directory)) $errors[] = 'courseRepository is missing'; + if (empty($title)) $errors[] = 'title is missing'; + if ($visibility < 0 || $visibility > 4) $errors[] = 'visibility is invalid'; + + if (!empty($errors)) { + throw new \Exception(implode(', ', $errors)); + } + + return [ + 'title' => $title, + 'code' => $code, + 'visualCode' => $visualCode, + 'directory' => $directory, + 'tutorName' => $tutorName, + 'courseLanguage' => $courseLanguage, + 'departmentName' => $departmentName, + 'departmentUrl' => $departmentUrl, + 'diskQuota' => $diskQuota, + 'visibility' => $visibility, + 'subscribe' => $subscribe, + 'unsubscribe' => $unsubscribe, + 'expirationDate' => new \DateTime($expirationDate), + 'teachers' => $teachers, + 'categories' => $categories, + 'notifyAdmins' => $notifyAdmins, + ]; + } + + private function getDefaultSetting(string $name, $default = null) + { + $settingValue = $this->settingsManager->getSetting($name); + + return $settingValue !== null ? $settingValue : $default; + } + + private function fixDepartmentUrl(string $url): string + { + if (!empty($url) && !str_starts_with($url, 'http://') && !str_starts_with($url, 'https://')) { + return 'http://' . $url; + } + return $url === 'http://' ? '' : $url; + } + + private function getFutureExpirationDate(): string + { + return (new \DateTime())->modify('+1 year')->format('Y-m-d H:i:s'); + } + + private function generateCourseCode(string $title): string + { + $cleanTitle = preg_replace('/[^A-Z0-9]/', '', strtoupper($this->replaceDangerousChar($title))); + + return substr($cleanTitle, 0, self::MAX_COURSE_LENGTH_CODE); + } + + private function replaceDangerousChar(string $text): string + { + $encoding = mb_detect_encoding($text, mb_detect_order(), true); + if ($encoding !== 'UTF-8') { + $text = mb_convert_encoding($text, 'UTF-8', $encoding); + } + + $text = str_replace(' ', '-', $text); + $text = preg_replace('/[^-\w]+/', '', $text); + $text = preg_replace('/\.+$/', '', $text); + + return $text; + } + + private function handlePostCourseCreation(Course $course, array $params): void + { + if ($params['notifyAdmins'] ?? false) { + $this->sendEmailToAdmin($course); + } + + $this->eventLoggerService->addEvent( + 'course_created', + 'course_id', + $course->getId(), + null, + $this->security->getUser()->getId(), + $course->getId() + ); + } +} diff --git a/src/CoreBundle/Service/EventLoggerService.php b/src/CoreBundle/Service/EventLoggerService.php new file mode 100644 index 00000000000..9929cdf26d8 --- /dev/null +++ b/src/CoreBundle/Service/EventLoggerService.php @@ -0,0 +1,61 @@ +cidReqHelper->getCourseId(); + $sessionId = $sessionId ?? $this->cidReqHelper->getSessionId(); + $userId = $userId ?? $this->security->getUser()->getId(); + + $value = $this->serializeEventValue($value); + + $trackEvent = new TrackEDefault(); + $trackEvent + ->setDefaultUserId($userId) + ->setCId($courseId) + ->setDefaultDate($dateTime ?? new \DateTime('now', new \DateTimeZone('UTC'))) + ->setDefaultEventType($eventType) + ->setDefaultValueType($valueType) + ->setDefaultValue($value) + ->setSessionId((int) $sessionId); + + $this->entityManager->persist($trackEvent); + $this->entityManager->flush(); + + return true; + } + + + private function serializeEventValue($value): string + { + return serialize($value); + } +}