src/CoreBundle/Settings/SettingsManager.php line 216

  1. <?php
  3. declare(strict_types=1);
  5. /* For licensing terms, see /license.txt */
  7. namespace Chamilo\CoreBundle\Settings;
  9. use Chamilo\CoreBundle\Entity\AccessUrl;
  10. use Chamilo\CoreBundle\Entity\Course;
  11. use Chamilo\CoreBundle\Entity\SettingsCurrent;
  12. use Doctrine\ORM\EntityManager;
  13. use Doctrine\ORM\EntityRepository;
  14. use InvalidArgumentException;
  15. use Sylius\Bundle\SettingsBundle\Event\SettingsEvent;
  16. use Sylius\Bundle\SettingsBundle\Manager\SettingsManagerInterface;
  17. use Sylius\Bundle\SettingsBundle\Model\Settings;
  18. use Sylius\Bundle\SettingsBundle\Model\SettingsInterface;
  19. use Sylius\Bundle\SettingsBundle\Registry\ServiceRegistryInterface;
  20. use Sylius\Bundle\SettingsBundle\Schema\SchemaInterface;
  21. use Sylius\Bundle\SettingsBundle\Schema\SettingsBuilder;
  22. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  23. use Symfony\Component\HttpFoundation\RequestStack;
  24. use Symfony\Component\Validator\ConstraintViolationListInterface;
  25. use Symfony\Component\Validator\Exception\ValidatorException;
  27. /**
  28.  * Handles the platform settings.
  29.  */
  30. class SettingsManager implements SettingsManagerInterface
  31. {
  32.     protected ?AccessUrl $url = null;
  34.     protected ServiceRegistryInterface $schemaRegistry;
  36.     protected EntityManager $manager;
  38.     protected EntityRepository $repository;
  40.     protected EventDispatcherInterface $eventDispatcher;
  42.     /**
  43.      * Runtime cache for resolved parameters.
  44.      *
  45.      * @var Settings[]
  46.      */
  47.     protected array $resolvedSettings = [];
  49.     /**
  50.      * @var null|array<string, Settings>|mixed[]
  51.      */
  52.     protected ?array $schemaList;
  54.     protected RequestStack $request;
  56.     public function __construct(
  57.         ServiceRegistryInterface $schemaRegistry,
  58.         EntityManager $manager,
  59.         EntityRepository $repository,
  60.         EventDispatcherInterface $eventDispatcher,
  61.         RequestStack $request
  62.     ) {
  63.         $this->schemaRegistry = $schemaRegistry;
  64.         $this->manager = $manager;
  65.         $this->repository = $repository;
  66.         $this->eventDispatcher = $eventDispatcher;
  67.         $this->request = $request;
  68.         $this->schemaList = [];
  69.     }
  71.     public function getUrl(): ?AccessUrl
  72.     {
  73.         return $this->url;
  74.     }
  76.     public function setUrl(AccessUrl $url): void
  77.     {
  78.         $this->url = $url;
  79.     }
  81.     public function updateSchemas(AccessUrl $url): void
  82.     {
  83.         $this->url = $url;
  84.         $schemas = array_keys($this->getSchemas());
  85.         foreach ($schemas as $schema) {
  86.             $settings = $this->load($this->convertServiceToNameSpace($schema));
  87.             $this->update($settings);
  88.         }
  89.     }
  91.     public function installSchemas(AccessUrl $url): void
  92.     {
  93.         $this->url = $url;
  94.         $schemas = array_keys($this->getSchemas());
  95.         foreach ($schemas as $schema) {
  96.             $settings = $this->load($this->convertServiceToNameSpace($schema));
  97.             $this->save($settings);
  98.         }
  99.     }
  101.     /**
  102.      * @return array|AbstractSettingsSchema[]
  103.      */
  104.     public function getSchemas(): array
  105.     {
  106.         return $this->schemaRegistry->all();
  107.     }
  109.     public function convertNameSpaceToService(string $category): string
  110.     {
  111.         return 'chamilo_core.settings.'.$category;
  112.     }
  114.     public function convertServiceToNameSpace(string $category): string
  115.     {
  116.         return str_replace('chamilo_core.settings.', '', $category);
  117.     }
  119.     public function updateSetting(string $name, $value): void
  120.     {
  121.         $name = $this->validateSetting($name);
  123.         [$category, $name] = explode('.', $name);
  124.         $settings = $this->load($category);
  126.         if (!$settings->has($name)) {
  127.             $message = sprintf("Parameter %s doesn't exists.", $name);
  129.             throw new InvalidArgumentException($message);
  130.         }
  132.         $settings->set($name, $value);
  133.         $this->update($settings);
  134.     }
  136.     /**
  137.      * Get a specific configuration setting, getting from the previously stored
  138.      * PHP session data whenever possible.
  139.      *
  140.      * @param string $name       The setting name (composed if in a category, i.e. 'platform.theme')
  141.      * @param bool   $loadFromDb Whether to load from the database
  142.      */
  143.     public function getSetting(string $name, bool $loadFromDb = false): mixed
  144.     {
  145.         $name = $this->validateSetting($name);
  147.         [$category, $name] = explode('.', $name);
  149.         if ($loadFromDb) {
  150.             $settings = $this->load($category, $name);
  151.             if ($settings->has($name)) {
  152.                 return $settings->get($name);
  153.             } else {
  154.                 return null;
  155.             }
  156.         }
  158.         $this->loadAll();
  160.         if (!empty($this->schemaList) && isset($this->schemaList[$category])) {
  161.             $settings = $this->schemaList[$category];
  162.             if ($settings->has($name)) {
  163.                 return $settings->get($name);
  164.             } else {
  165.                 error_log("Attempted to access undefined setting '$name' in category '$category'.");
  166.                 return null;
  167.             }
  168.         }
  170.         throw new InvalidArgumentException(sprintf('Category %s not found', $category));
  171.     }
  173.     public function loadAll(): void
  174.     {
  175.         $session = null;
  177.         if ($this->request->getCurrentRequest()) {
  178.             $session = $this->request->getCurrentRequest()->getSession();
  179.             $schemaList = $session->get('schemas');
  180.             if (!empty($schemaList)) {
  181.                 $this->schemaList = $schemaList;
  182.                 return;
  183.             }
  184.         }
  186.         $schemas = array_keys($this->getSchemas());
  187.         $schemaList = [];
  188.         $settingsBuilder = new SettingsBuilder();
  189.         $all = $this->getAllParametersByCategory();
  191.         foreach ($schemas as $schema) {
  192.             $schemaRegister = $this->schemaRegistry->get($schema);
  193.             $schemaRegister->buildSettings($settingsBuilder);
  194.             $name = $this->convertServiceToNameSpace($schema);
  195.             $settings = new Settings();
  196.             $parameters = $all[$name] ?? [];
  198.             $knownParameters = array_filter($parameters, function ($key) use ($settingsBuilder) {
  199.                 return $settingsBuilder->isDefined($key);
  200.             }, ARRAY_FILTER_USE_KEY);
  202.             $transformers = $settingsBuilder->getTransformers();
  203.             foreach ($transformers as $parameter => $transformer) {
  204.                 if (\array_key_exists($parameter, $knownParameters)) {
  205.                     if ('course_creation_use_template' === $parameter) {
  206.                         if (empty($knownParameters[$parameter])) {
  207.                             $knownParameters[$parameter] = null;
  208.                         }
  209.                     } else {
  210.                         $knownParameters[$parameter] = $transformer->reverseTransform($knownParameters[$parameter]);
  211.                     }
  212.                 }
  213.             }
  215.             $parameters = $settingsBuilder->resolve($knownParameters);
  216.             $settings->setParameters($parameters);
  217.             $schemaList[$name] = $settings;
  218.         }
  219.         $this->schemaList = $schemaList;
  220.         if ($session && $this->request->getCurrentRequest()) {
  221.             $session->set('schemas', $schemaList);
  222.         }
  223.     }
  225.     public function load(string $schemaAlias, ?string $namespace = null, bool $ignoreUnknown = true): SettingsInterface
  226.     {
  227.         $settings = new Settings();
  228.         $schemaAliasNoPrefix = $schemaAlias;
  229.         $schemaAlias = 'chamilo_core.settings.'.$schemaAlias;
  230.         if ($this->schemaRegistry->has($schemaAlias)) {
  231.             /** @var SchemaInterface $schema */
  232.             $schema = $this->schemaRegistry->get($schemaAlias);
  233.         } else {
  234.             return $settings;
  235.         }
  237.         $settings->setSchemaAlias($schemaAlias);
  239.         // We need to get a plain parameters array since we use the options resolver on it
  240.         $parameters = $this->getParameters($schemaAliasNoPrefix);
  241.         $settingsBuilder = new SettingsBuilder();
  242.         $schema->buildSettings($settingsBuilder);
  244.         // Remove unknown settings' parameters (e.g. From a previous version of the settings schema)
  245.         if (true === $ignoreUnknown) {
  246.             foreach ($parameters as $name => $value) {
  247.                 if (!$settingsBuilder->isDefined($name)) {
  248.                     unset($parameters[$name]);
  249.                 }
  250.             }
  251.         }
  253.         foreach ($settingsBuilder->getTransformers() as $parameter => $transformer) {
  254.             if (\array_key_exists($parameter, $parameters)) {
  255.                 if ('course_creation_use_template' === $parameter) {
  256.                     if (empty($parameters[$parameter])) {
  257.                         $parameters[$parameter] = null;
  258.                     }
  259.                 } else {
  260.                     $parameters[$parameter] = $transformer->reverseTransform($parameters[$parameter]);
  261.                 }
  262.             }
  263.         }
  265.         $parameters = $settingsBuilder->resolve($parameters);
  266.         $settings->setParameters($parameters);
  268.         return $settings;
  269.     }
  271.     public function update(SettingsInterface $settings): void
  272.     {
  273.         $namespace = $settings->getSchemaAlias();
  275.         /** @var SchemaInterface $schema */
  276.         $schema = $this->schemaRegistry->get($settings->getSchemaAlias());
  278.         $settingsBuilder = new SettingsBuilder();
  279.         $schema->buildSettings($settingsBuilder);
  280.         $parameters = $settingsBuilder->resolve($settings->getParameters());
  281.         // Transform value. Example array to string using transformer. Example:
  282.         // 1. Setting "tool_visible_by_default_at_creation" it's a multiple select
  283.         // 2. Is defined as an array in class DocumentSettingsSchema
  284.         // 3. Add transformer for that variable "ArrayToIdentifierTransformer"
  285.         // 4. Here we recover the transformer and convert the array to string
  286.         foreach ($settingsBuilder->getTransformers() as $parameter => $transformer) {
  287.             if (\array_key_exists($parameter, $parameters)) {
  288.                 $parameters[$parameter] = $transformer->transform($parameters[$parameter]);
  289.             }
  290.         }
  292.         $settings->setParameters($parameters);
  293.         $category = $this->convertServiceToNameSpace($settings->getSchemaAlias());
  294.         $persistedParameters = $this->repository->findBy([
  295.             'category' => $category,
  296.         ]);
  298.         $persistedParametersMap = [];
  300.         /** @var SettingsCurrent $parameter */
  301.         foreach ($persistedParameters as $parameter) {
  302.             $persistedParametersMap[$parameter->getVariable()] = $parameter;
  303.         }
  305.         $url = $this->getUrl();
  306.         $simpleCategoryName = str_replace('chamilo_core.settings.', '', $namespace);
  308.         foreach ($parameters as $name => $value) {
  309.             if (isset($persistedParametersMap[$name])) {
  310.                 $parameter = $persistedParametersMap[$name];
  311.                 $parameter->setSelectedValue($value);
  312.                 $parameter->setCategory($simpleCategoryName);
  313.                 $this->manager->persist($parameter);
  314.             } else {
  315.                 $parameter = (new SettingsCurrent())
  316.                     ->setVariable($name)
  317.                     ->setCategory($simpleCategoryName)
  318.                     ->setTitle($name)
  319.                     ->setSelectedValue($value)
  320.                     ->setUrl($url)
  321.                     ->setAccessUrlChangeable(1)
  322.                     ->setAccessUrlLocked(1)
  323.                 ;
  325.                 // @var ConstraintViolationListInterface $errors
  326.                 /*$errors = $this->validator->validate($parameter);
  327.                 if (0 < $errors->count()) {
  328.                     throw new ValidatorException($errors->get(0)->getMessage());
  329.                 }*/
  330.                 $this->manager->persist($parameter);
  331.             }
  332.         }
  334.         $this->manager->flush();
  335.     }
  337.     /**
  338.      * @throws ValidatorException
  339.      */
  340.     public function save(SettingsInterface $settings): void
  341.     {
  342.         $namespace = $settings->getSchemaAlias();
  344.         /** @var SchemaInterface $schema */
  345.         $schema = $this->schemaRegistry->get($settings->getSchemaAlias());
  347.         $settingsBuilder = new SettingsBuilder();
  348.         $schema->buildSettings($settingsBuilder);
  349.         $parameters = $settingsBuilder->resolve($settings->getParameters());
  350.         // Transform value. Example array to string using transformer. Example:
  351.         // 1. Setting "tool_visible_by_default_at_creation" it's a multiple select
  352.         // 2. Is defined as an array in class DocumentSettingsSchema
  353.         // 3. Add transformer for that variable "ArrayToIdentifierTransformer"
  354.         // 4. Here we recover the transformer and convert the array to string
  355.         foreach ($settingsBuilder->getTransformers() as $parameter => $transformer) {
  356.             if (\array_key_exists($parameter, $parameters)) {
  357.                 $parameters[$parameter] = $transformer->transform($parameters[$parameter]);
  358.             }
  359.         }
  360.         $settings->setParameters($parameters);
  361.         $persistedParameters = $this->repository->findBy([
  362.             'category' => $this->convertServiceToNameSpace($settings->getSchemaAlias()),
  363.         ]);
  364.         $persistedParametersMap = [];
  365.         foreach ($persistedParameters as $parameter) {
  366.             $persistedParametersMap[$parameter->getVariable()] = $parameter;
  367.         }
  369.         // @var SettingsEvent $event
  370.         /*$event = $this->eventDispatcher->dispatch(
  371.             SettingsEvent::PRE_SAVE,
  372.             new SettingsEvent($settings, $parameters)
  373.         );*/
  375.         $url = $this->getUrl();
  376.         $simpleCategoryName = str_replace('chamilo_core.settings.', '', $namespace);
  378.         foreach ($parameters as $name => $value) {
  379.             if (isset($persistedParametersMap[$name])) {
  380.                 $parameter = $persistedParametersMap[$name];
  381.                 $parameter->setSelectedValue($value);
  382.             } else {
  383.                 $parameter = (new SettingsCurrent())
  384.                     ->setVariable($name)
  385.                     ->setCategory($simpleCategoryName)
  386.                     ->setTitle($name)
  387.                     ->setSelectedValue($value)
  388.                     ->setUrl($url)
  389.                     ->setAccessUrlChangeable(1)
  390.                     ->setAccessUrlLocked(1)
  391.                 ;
  393.                 // @var ConstraintViolationListInterface $errors
  394.                 /*$errors = $this->validator->validate($parameter);
  395.                 if (0 < $errors->count()) {
  396.                     throw new ValidatorException($errors->get(0)->getMessage());
  397.                 }*/
  398.                 $this->manager->persist($parameter);
  399.             }
  400.             $this->manager->persist($parameter);
  401.         }
  403.         $this->manager->flush();
  405.         //        $schemaAlias = $settings->getSchemaAlias();
  406.         //        $schemaAliasChamilo = str_replace('chamilo_core.settings.', '', $schemaAlias);
  407.         //
  408.         //        $schema = $this->schemaRegistry->get($schemaAlias);
  409.         //
  410.         //        $settingsBuilder = new SettingsBuilder();
  411.         //        $schema->buildSettings($settingsBuilder);
  412.         //
  413.         //        $parameters = $settingsBuilder->resolve($settings->getParameters());
  414.         //
  415.         //        foreach ($settingsBuilder->getTransformers() as $parameter => $transformer) {
  416.         //            if (array_key_exists($parameter, $parameters)) {
  417.         //                $parameters[$parameter] = $transformer->transform($parameters[$parameter]);
  418.         //            }
  419.         //        }
  420.         //
  421.         //        /** @var \Sylius\Bundle\SettingsBundle\Event\SettingsEvent $event */
  422.         //        $event = $this->eventDispatcher->dispatch(
  423.         //            SettingsEvent::PRE_SAVE,
  424.         //            new SettingsEvent($settings)
  425.         //        );
  426.         //
  427.         //        /** @var SettingsCurrent $url */
  428.         //        $url = $event->getSettings()->getAccessUrl();
  429.         //
  430.         //        foreach ($parameters as $name => $value) {
  431.         //            if (isset($persistedParametersMap[$name])) {
  432.         //                if ($value instanceof Course) {
  433.         //                    $value = $value->getId();
  434.         //                }
  435.         //                $persistedParametersMap[$name]->setValue($value);
  436.         //            } else {
  437.         //                $setting = new Settings();
  438.         //                $setting->setSchemaAlias($schemaAlias);
  439.         //
  440.         //                $setting
  441.         //                    ->setNamespace($schemaAliasChamilo)
  442.         //                    ->setName($name)
  443.         //                    ->setValue($value)
  444.         //                    ->setUrl($url)
  445.         //                    ->setAccessUrlLocked(0)
  446.         //                    ->setAccessUrlChangeable(1)
  447.         //                ;
  448.         //
  449.         //                /** @var ConstraintViolationListInterface $errors */
  450.         //                /*$errors = $this->->validate($parameter);
  451.         //                if (0 < $errors->count()) {
  452.         //                    throw new ValidatorException($errors->get(0)->getMessage());
  453.         //                }*/
  454.         //                $this->manager->persist($setting);
  455.         //                $this->manager->flush();
  456.         //            }
  457.         //        }
  458.         /*$parameters = $settingsBuilder->resolve($settings->getParameters());
  459.         $settings->setParameters($parameters);
  461.         $this->eventDispatcher->dispatch(SettingsEvent::PRE_SAVE, new SettingsEvent($settings));
  463.         $this->manager->persist($settings);
  464.         $this->manager->flush();
  466.         $this->eventDispatcher->dispatch(SettingsEvent::POST_SAVE, new SettingsEvent($settings));*/
  467.     }
  469.     /**
  470.      * @param string $keyword
  471.      */
  472.     public function getParametersFromKeywordOrderedByCategory($keyword): array
  473.     {
  474.         $query = $this->repository->createQueryBuilder('s')
  475.             ->where('s.variable LIKE :keyword OR s.title LIKE :keyword')
  476.             ->setParameter('keyword', "%{$keyword}%")
  477.         ;
  478.         $parametersFromDb = $query->getQuery()->getResult();
  479.         $parameters = [];
  481.         /** @var SettingsCurrent $parameter */
  482.         foreach ($parametersFromDb as $parameter) {
  483.             $parameters[$parameter->getCategory()][] = $parameter;
  484.         }
  486.         return $parameters;
  487.     }
  489.     /**
  490.      * @param string $namespace
  491.      * @param string $keyword
  492.      * @param bool   $returnObjects
  493.      *
  494.      * @return array
  495.      */
  496.     public function getParametersFromKeyword($namespace, $keyword = '', $returnObjects = false)
  497.     {
  498.         if (empty($keyword)) {
  499.             $criteria = [
  500.                 'category' => $namespace,
  501.             ];
  502.             $parametersFromDb = $this->repository->findBy($criteria);
  503.         } else {
  504.             $query = $this->repository->createQueryBuilder('s')
  505.                 ->where('s.variable LIKE :keyword')
  506.                 ->setParameter('keyword', "%{$keyword}%")
  507.             ;
  508.             $parametersFromDb = $query->getQuery()->getResult();
  509.         }
  511.         if ($returnObjects) {
  512.             return $parametersFromDb;
  513.         }
  514.         $parameters = [];
  516.         /** @var SettingsCurrent $parameter */
  517.         foreach ($parametersFromDb as $parameter) {
  518.             $parameters[$parameter->getVariable()] = $parameter->getSelectedValue();
  519.         }
  521.         return $parameters;
  522.     }
  524.     private function validateSetting(string $name): string
  525.     {
  526.         if (!str_contains($name, '.')) {
  527.             // throw new \InvalidArgumentException(sprintf('Parameter must be in format "namespace.name", "%s" given.', $name));
  529.             // This code allows the possibility of calling
  530.             // api_get_setting('allow_skills_tool') instead of
  531.             // the "correct" way api_get_setting('platform.allow_skills_tool')
  532.             $items = $this->getVariablesAndCategories();
  534.             if (isset($items[$name])) {
  535.                 $originalName = $name;
  536.                 $name = $this->renameVariable($name);
  537.                 $category = $this->fixCategory(
  538.                     strtolower($name),
  539.                     strtolower($items[$originalName])
  540.                 );
  541.                 $name = $category.'.'.$name;
  542.             } else {
  543.                 $message = sprintf('Parameter must be in format "category.name", "%s" given.', $name);
  545.                 throw new InvalidArgumentException($message);
  546.             }
  547.         }
  549.         return $name;
  550.     }
  552.     /**
  553.      * Load parameter from database.
  554.      *
  555.      * @param string $namespace
  556.      *
  557.      * @return array
  558.      */
  559.     private function getParameters($namespace)
  560.     {
  561.         $parameters = [];
  562.         $category = $this->repository->findBy(['category' => $namespace]);
  564.         /** @var SettingsCurrent $parameter */
  565.         foreach ($category as $parameter) {
  566.             $parameters[$parameter->getVariable()] = $parameter->getSelectedValue();
  567.         }
  569.         return $parameters;
  570.     }
  572.     private function getAllParametersByCategory()
  573.     {
  574.         $parameters = [];
  575.         $all = $this->repository->findAll();
  577.         /** @var SettingsCurrent $parameter */
  578.         foreach ($all as $parameter) {
  579.             $parameters[$parameter->getCategory()][$parameter->getVariable()] = $parameter->getSelectedValue();
  580.         }
  582.         return $parameters;
  583.     }
  585.     /*private function transformParameters(SettingsBuilder $settingsBuilder, array $parameters)
  586.     {
  587.         $transformedParameters = $parameters;
  589.         foreach ($settingsBuilder->getTransformers() as $parameter => $transformer) {
  590.             if (array_key_exists($parameter, $parameters)) {
  591.                 $transformedParameters[$parameter] = $transformer->reverseTransform($parameters[$parameter]);
  592.             }
  593.         }
  595.         return $transformedParameters;
  596.     }*/
  598.     /**
  599.      * Get variables and categories as in 1.11.x.
  600.      */
  601.     private function getVariablesAndCategories(): array
  602.     {
  603.         return [
  604.             'Institution' => 'Platform',
  605.             'InstitutionUrl' => 'Platform',
  606.             'siteName' => 'Platform',
  607.             'site_name' => 'Platform',
  608.             'emailAdministrator' => 'admin',
  609.             // 'emailAdministrator' => 'Platform',
  610.             'administratorSurname' => 'admin',
  611.             'administratorTelephone' => 'admin',
  612.             'administratorName' => 'admin',
  613.             'show_administrator_data' => 'Platform',
  614.             'show_tutor_data' => 'Session',
  615.             'show_teacher_data' => 'Platform',
  616.             'show_toolshortcuts' => 'Course',
  617.             'allow_group_categories' => 'Course',
  618.             'server_type' => 'Platform',
  619.             'platformLanguage' => 'Language',
  620.             'showonline' => 'Platform',
  621.             'profile' => 'User',
  622.             'default_document_quotum' => 'Course',
  623.             'registration' => 'User',
  624.             'default_group_quotum' => 'Course',
  625.             'allow_registration' => 'Platform',
  626.             'allow_registration_as_teacher' => 'Platform',
  627.             'allow_lostpassword' => 'Platform',
  628.             'allow_user_headings' => 'Course',
  629.             'allow_personal_agenda' => 'agenda',
  630.             'display_coursecode_in_courselist' => 'Platform',
  631.             'display_teacher_in_courselist' => 'Platform',
  632.             'permanently_remove_deleted_files' => 'Tools',
  633.             'dropbox_allow_overwrite' => 'Tools',
  634.             'dropbox_max_filesize' => 'Tools',
  635.             'dropbox_allow_just_upload' => 'Tools',
  636.             'dropbox_allow_student_to_student' => 'Tools',
  637.             'dropbox_allow_group' => 'Tools',
  638.             'dropbox_allow_mailing' => 'Tools',
  639.             'extended_profile' => 'User',
  640.             'student_view_enabled' => 'Platform',
  641.             'show_navigation_menu' => 'Course',
  642.             'enable_tool_introduction' => 'course',
  643.             'page_after_login' => 'Platform',
  644.             'time_limit_whosonline' => 'Platform',
  645.             'breadcrumbs_course_homepage' => 'Course',
  646.             'example_material_course_creation' => 'Platform',
  647.             'account_valid_duration' => 'Platform',
  648.             'use_session_mode' => 'Session',
  649.             'allow_email_editor' => 'Tools',
  650.             // 'registered' => null',
  651.             // 'donotlistcampus' =>'null',
  652.             'show_email_addresses' => 'Platform',
  653.             'service_ppt2lp' => 'NULL',
  654.             'stylesheets' => 'stylesheets',
  655.             'upload_extensions_list_type' => 'Security',
  656.             'upload_extensions_blacklist' => 'Security',
  657.             'upload_extensions_whitelist' => 'Security',
  658.             'upload_extensions_skip' => 'Security',
  659.             'upload_extensions_replace_by' => 'Security',
  660.             'show_number_of_courses' => 'Platform',
  661.             'show_empty_course_categories' => 'Platform',
  662.             'show_back_link_on_top_of_tree' => 'Platform',
  663.             'show_different_course_language' => 'Platform',
  664.             'split_users_upload_directory' => 'Tuning',
  665.             'hide_dltt_markup' => 'Languages',
  666.             'display_categories_on_homepage' => 'Platform',
  667.             'permissions_for_new_directories' => 'Security',
  668.             'permissions_for_new_files' => 'Security',
  669.             'show_tabs' => 'Platform',
  670.             'default_forum_view' => 'Course',
  671.             'platform_charset' => 'Languages',
  672.             'noreply_email_address' => 'Platform',
  673.             'survey_email_sender_noreply' => 'Course',
  674.             'gradebook_enable' => 'Gradebook',
  675.             'gradebook_score_display_coloring' => 'Gradebook',
  676.             'gradebook_score_display_custom' => 'Gradebook',
  677.             'gradebook_score_display_colorsplit' => 'Gradebook',
  678.             'gradebook_score_display_upperlimit' => 'Gradebook',
  679.             'gradebook_number_decimals' => 'Gradebook',
  680.             'user_selected_theme' => 'Platform',
  681.             'allow_course_theme' => 'Course',
  682.             'show_closed_courses' => 'Platform',
  683.             'extendedprofile_registration' => 'User',
  684.             'extendedprofile_registrationrequired' => 'User',
  685.             'add_users_by_coach' => 'Session',
  686.             'extend_rights_for_coach' => 'Security',
  687.             'extend_rights_for_coach_on_survey' => 'Security',
  688.             'course_create_active_tools' => 'Tools',
  689.             'show_session_coach' => 'Session',
  690.             'allow_users_to_create_courses' => 'Platform',
  691.             'allow_message_tool' => 'Tools',
  692.             'allow_social_tool' => 'Tools',
  693.             'allow_students_to_browse_courses' => 'Platform',
  694.             'show_session_data' => 'Session',
  695.             'allow_use_sub_language' => 'language',
  696.             'show_glossary_in_documents' => 'Course',
  697.             'allow_terms_conditions' => 'Platform',
  698.             'search_enabled' => 'Search',
  699.             'search_prefilter_prefix' => 'Search',
  700.             'search_show_unlinked_results' => 'Search',
  701.             'show_courses_descriptions_in_catalog' => 'Course',
  702.             'allow_coach_to_edit_course_session' => 'Session',
  703.             'show_glossary_in_extra_tools' => 'Course',
  704.             'send_email_to_admin_when_create_course' => 'Platform',
  705.             'go_to_course_after_login' => 'Course',
  706.             'math_asciimathML' => 'Editor',
  707.             'enabled_asciisvg' => 'Editor',
  708.             'include_asciimathml_script' => 'Editor',
  709.             'youtube_for_students' => 'Editor',
  710.             'block_copy_paste_for_students' => 'Editor',
  711.             'more_buttons_maximized_mode' => 'Editor',
  712.             'students_download_folders' => 'Document',
  713.             'users_copy_files' => 'Tools',
  714.             'allow_students_to_create_groups_in_social' => 'Tools',
  715.             'allow_send_message_to_all_platform_users' => 'Message',
  716.             'message_max_upload_filesize' => 'Tools',
  717.             'use_users_timezone' => 'profile',
  718.             // 'use_users_timezone' => 'Timezones',
  719.             'timezone_value' => 'platform',
  720.             // 'timezone_value' => 'Timezones',
  721.             'allow_user_course_subscription_by_course_admin' => 'Security',
  722.             'show_link_bug_notification' => 'Platform',
  723.             'show_link_ticket_notification' => 'Platform',
  724.             'course_validation' => 'course',
  725.             // 'course_validation' => 'Platform',
  726.             'course_validation_terms_and_conditions_url' => 'Platform',
  727.             'enabled_wiris' => 'Editor',
  728.             'allow_spellcheck' => 'Editor',
  729.             'force_wiki_paste_as_plain_text' => 'Editor',
  730.             'enabled_googlemaps' => 'Editor',
  731.             'enabled_imgmap' => 'Editor',
  732.             'enabled_support_svg' => 'Tools',
  733.             'pdf_export_watermark_enable' => 'Platform',
  734.             'pdf_export_watermark_by_course' => 'Platform',
  735.             'pdf_export_watermark_text' => 'Platform',
  736.             'enabled_insertHtml' => 'Editor',
  737.             'students_export2pdf' => 'Document',
  738.             'exercise_min_score' => 'Course',
  739.             'exercise_max_score' => 'Course',
  740.             'show_users_folders' => 'Tools',
  741.             'show_default_folders' => 'Tools',
  742.             'show_chat_folder' => 'Tools',
  743.             'enabled_text2audio' => 'Tools',
  744.             'course_hide_tools' => 'Course',
  745.             'enabled_support_pixlr' => 'Tools',
  746.             'show_groups_to_users' => 'Session',
  747.             'accessibility_font_resize' => 'Platform',
  748.             'hide_courses_in_sessions' => 'Session',
  749.             'enable_quiz_scenario' => 'Course',
  750.             'filter_terms' => 'Security',
  751.             'header_extra_content' => 'Tracking',
  752.             'footer_extra_content' => 'Tracking',
  753.             'show_documents_preview' => 'Tools',
  754.             'htmlpurifier_wiki' => 'Editor',
  755.             'cas_activate' => 'CAS',
  756.             'cas_server' => 'CAS',
  757.             'cas_server_uri' => 'CAS',
  758.             'cas_port' => 'CAS',
  759.             'cas_protocol' => 'CAS',
  760.             'cas_add_user_activate' => 'CAS',
  761.             'update_user_info_cas_with_ldap' => 'CAS',
  762.             'student_page_after_login' => 'Platform',
  763.             'teacher_page_after_login' => 'Platform',
  764.             'drh_page_after_login' => 'Platform',
  765.             'sessionadmin_page_after_login' => 'Session',
  766.             'student_autosubscribe' => 'Platform',
  767.             'teacher_autosubscribe' => 'Platform',
  768.             'drh_autosubscribe' => 'Platform',
  769.             'sessionadmin_autosubscribe' => 'Session',
  770.             'scorm_cumulative_session_time' => 'Course',
  771.             'allow_hr_skills_management' => 'Gradebook',
  772.             'enable_help_link' => 'Platform',
  773.             'teachers_can_change_score_settings' => 'Gradebook',
  774.             'allow_users_to_change_email_with_no_password' => 'User',
  775.             'show_admin_toolbar' => 'display',
  776.             'allow_global_chat' => 'Platform',
  777.             'languagePriority1' => 'language',
  778.             'languagePriority2' => 'language',
  779.             'languagePriority3' => 'language',
  780.             'languagePriority4' => 'language',
  781.             'login_is_email' => 'Platform',
  782.             'courses_default_creation_visibility' => 'Course',
  783.             'gradebook_enable_grade_model' => 'Gradebook',
  784.             'teachers_can_change_grade_model_settings' => 'Gradebook',
  785.             'gradebook_default_weight' => 'Gradebook',
  786.             'ldap_description' => 'LDAP',
  787.             'shibboleth_description' => 'Shibboleth',
  788.             'facebook_description' => 'Facebook',
  789.             'gradebook_locking_enabled' => 'Gradebook',
  790.             'gradebook_default_grade_model_id' => 'Gradebook',
  791.             'allow_session_admins_to_manage_all_sessions' => 'Session',
  792.             'allow_skills_tool' => 'Platform',
  793.             'allow_public_certificates' => 'Course',
  794.             'platform_unsubscribe_allowed' => 'Platform',
  795.             'enable_iframe_inclusion' => 'Editor',
  796.             'show_hot_courses' => 'Platform',
  797.             'enable_webcam_clip' => 'Tools',
  798.             'use_custom_pages' => 'Platform',
  799.             'tool_visible_by_default_at_creation' => 'Tools',
  800.             'prevent_session_admins_to_manage_all_users' => 'Session',
  801.             'documents_default_visibility_defined_in_course' => 'Tools',
  802.             'enabled_mathjax' => 'Editor',
  803.             'meta_twitter_site' => 'Tracking',
  804.             'meta_twitter_creator' => 'Tracking',
  805.             'meta_title' => 'Tracking',
  806.             'meta_description' => 'Tracking',
  807.             'meta_image_path' => 'Tracking',
  808.             'allow_teachers_to_create_sessions' => 'Session',
  809.             'institution_address' => 'Platform',
  810.             'chamilo_database_version' => 'null',
  811.             'cron_remind_course_finished_activate' => 'Crons',
  812.             'cron_remind_course_expiration_frequency' => 'Crons',
  813.             'cron_remind_course_expiration_activate' => 'Crons',
  814.             'allow_coach_feedback_exercises' => 'Session',
  815.             'allow_my_files' => 'Platform',
  816.             'ticket_allow_student_add' => 'Ticket',
  817.             'ticket_send_warning_to_all_admins' => 'Ticket',
  818.             'ticket_warn_admin_no_user_in_category' => 'Ticket',
  819.             'ticket_allow_category_edition' => 'Ticket',
  820.             'load_term_conditions_section' => 'Platform',
  821.             'show_terms_if_profile_completed' => 'Ticket',
  822.             'hide_home_top_when_connected' => 'Platform',
  823.             'hide_global_announcements_when_not_connected' => 'Platform',
  824.             'course_creation_use_template' => 'Course',
  825.             'allow_strength_pass_checker' => 'Security',
  826.             'allow_captcha' => 'Security',
  827.             'captcha_number_mistakes_to_block_account' => 'Security',
  828.             'captcha_time_to_block' => 'Security',
  829.             'drh_can_access_all_session_content' => 'Session',
  830.             'display_groups_forum_in_general_tool' => 'Tools',
  831.             'allow_tutors_to_assign_students_to_session' => 'Session',
  832.             'allow_lp_return_link' => 'Course',
  833.             'hide_scorm_export_link' => 'Course',
  834.             'hide_scorm_copy_link' => 'Course',
  835.             'hide_scorm_pdf_link' => 'Course',
  836.             'session_days_before_coach_access' => 'Session',
  837.             'session_days_after_coach_access' => 'Session',
  838.             'pdf_logo_header' => 'Course',
  839.             'order_user_list_by_official_code' => 'Platform',
  840.             'email_alert_manager_on_new_quiz' => 'exercise',
  841.             'show_official_code_exercise_result_list' => 'Tools',
  842.             'course_catalog_hide_private' => 'Platform',
  843.             'catalog_show_courses_sessions' => 'Platform',
  844.             'auto_detect_language_custom_pages' => 'Platform',
  845.             'lp_show_reduced_report' => 'Course',
  846.             'allow_session_course_copy_for_teachers' => 'Session',
  847.             'hide_logout_button' => 'Platform',
  848.             'redirect_admin_to_courses_list' => 'Platform',
  849.             'course_images_in_courses_list' => 'Course',
  850.             'student_publication_to_take_in_gradebook' => 'Gradebook',
  851.             'certificate_filter_by_official_code' => 'Gradebook',
  852.             'exercise_max_ckeditors_in_page' => 'Tools',
  853.             'document_if_file_exists_option' => 'Tools',
  854.             'add_gradebook_certificates_cron_task_enabled' => 'Gradebook',
  855.             'openbadges_backpack' => 'Gradebook',
  856.             'cookie_warning' => 'Tools',
  857.             'hide_course_group_if_no_tools_available' => 'Tools',
  858.             'catalog_allow_session_auto_subscription' => 'Session',
  859.             'registration.soap.php.decode_utf8' => 'Platform',
  860.             'allow_delete_attendance' => 'Tools',
  861.             'gravatar_enabled' => 'Platform',
  862.             'gravatar_type' => 'Platform',
  863.             'limit_session_admin_role' => 'Session',
  864.             'show_session_description' => 'Session',
  865.             'hide_certificate_export_link_students' => 'Gradebook',
  866.             'hide_certificate_export_link' => 'Gradebook',
  867.             'dropbox_hide_course_coach' => 'Tools',
  868.             'dropbox_hide_general_coach' => 'Tools',
  869.             'session_course_ordering' => 'Session',
  870.             'gamification_mode' => 'Platform',
  871.             'prevent_multiple_simultaneous_login' => 'Security',
  872.             'gradebook_detailed_admin_view' => 'Gradebook',
  873.             'course_catalog_published' => 'Course',
  874.             'user_reset_password' => 'Security',
  875.             'user_reset_password_token_limit' => 'Security',
  876.             'my_courses_view_by_session' => 'Session',
  877.             'show_full_skill_name_on_skill_wheel' => 'Platform',
  878.             'messaging_allow_send_push_notification' => 'WebServices',
  879.             'messaging_gdc_project_number' => 'WebServices',
  880.             'messaging_gdc_api_key' => 'WebServices',
  881.             'teacher_can_select_course_template' => 'Course',
  882.             'enable_record_audio' => 'Tools',
  883.             'allow_show_skype_account' => 'Platform',
  884.             'allow_show_linkedin_url' => 'Platform',
  885.             'enable_profile_user_address_geolocalization' => 'User',
  886.             'show_official_code_whoisonline' => 'Profile',
  887.             'icons_mode_svg' => 'display',
  888.             'user_name_order' => 'display',
  889.             'user_name_sort_by' => 'display',
  890.             'default_calendar_view' => 'agenda',
  891.             'exercise_invisible_in_session' => 'exercise',
  892.             'configure_exercise_visibility_in_course' => 'exercise',
  893.             'allow_download_documents_by_api_key' => 'Webservices',
  894.             'profiling_filter_adding_users' => 'profile',
  895.             'donotlistcampus' => 'platform',
  896.             'course_creation_splash_screen' => 'Course',
  897.             'translate_html' => 'Editor',
  898.             'enable_bootstrap_in_documents_html' => 'Course',
  899.         ];
  900.     }
  902.     /**
  903.      * Rename old variable with variable used in Chamilo 2.0.
  904.      *
  905.      * @param string $variable
  906.      */
  907.     private function renameVariable($variable)
  908.     {
  909.         $list = [
  910.             'timezone_value' => 'timezone',
  911.             'Institution' => 'institution',
  912.             'SiteName' => 'site_name',
  913.             'siteName' => 'site_name',
  914.             'InstitutionUrl' => 'institution_url',
  915.             'registration' => 'required_profile_fields',
  916.             'stylesheets' => 'theme',
  917.             'platformLanguage' => 'platform_language',
  918.             'languagePriority1' => 'language_priority_1',
  919.             'languagePriority2' => 'language_priority_2',
  920.             'languagePriority3' => 'language_priority_3',
  921.             'languagePriority4' => 'language_priority_4',
  922.             'gradebook_score_display_coloring' => 'my_display_coloring',
  923.             'ProfilingFilterAddingUsers' => 'profiling_filter_adding_users',
  924.             'course_create_active_tools' => 'active_tools_on_create',
  925.             'emailAdministrator' => 'administrator_email',
  926.             'administratorSurname' => 'administrator_surname',
  927.             'administratorName' => 'administrator_name',
  928.             'administratorTelephone' => 'administrator_phone',
  929.             'registration.soap.php.decode_utf8' => 'decode_utf8',
  930.             'profile' => 'changeable_options',
  931.         ];
  933.         return $list[$variable] ?? $variable;
  934.     }
  936.     /**
  937.      * Replace old Chamilo 1.x category with 2.0 version.
  938.      *
  939.      * @param string $variable
  940.      * @param string $defaultCategory
  941.      */
  942.     private function fixCategory($variable, $defaultCategory)
  943.     {
  944.         $settings = [
  945.             'cookie_warning' => 'platform',
  946.             'donotlistcampus' => 'platform',
  947.             'administrator_email' => 'admin',
  948.             'administrator_surname' => 'admin',
  949.             'administrator_name' => 'admin',
  950.             'administrator_phone' => 'admin',
  951.             'exercise_max_ckeditors_in_page' => 'exercise',
  952.             'allow_hr_skills_management' => 'skill',
  953.             'accessibility_font_resize' => 'display',
  954.             'account_valid_duration' => 'profile',
  955.             'allow_global_chat' => 'chat',
  956.             'allow_lostpassword' => 'registration',
  957.             'allow_registration' => 'registration',
  958.             'allow_registration_as_teacher' => 'registration',
  959.             'required_profile_fields' => 'registration',
  960.             'allow_skills_tool' => 'skill',
  961.             'allow_students_to_browse_courses' => 'display',
  962.             'allow_terms_conditions' => 'registration',
  963.             'allow_users_to_create_courses' => 'course',
  964.             'auto_detect_language_custom_pages' => 'language',
  965.             'platform_language' => 'language',
  966.             'course_validation' => 'course',
  967.             'course_validation_terms_and_conditions_url' => 'course',
  968.             'display_categories_on_homepage' => 'display',
  969.             'display_coursecode_in_courselist' => 'course',
  970.             'display_teacher_in_courselist' => 'course',
  971.             'drh_autosubscribe' => 'registration',
  972.             'drh_page_after_login' => 'registration',
  973.             'enable_help_link' => 'display',
  974.             'example_material_course_creation' => 'course',
  975.             'login_is_email' => 'profile',
  976.             'noreply_email_address' => 'mail',
  977.             'page_after_login' => 'registration',
  978.             'pdf_export_watermark_by_course' => 'document',
  979.             'pdf_export_watermark_enable' => 'document',
  980.             'pdf_export_watermark_text' => 'document',
  981.             'platform_unsubscribe_allowed' => 'registration',
  982.             'send_email_to_admin_when_create_course' => 'course',
  983.             'show_admin_toolbar' => 'display',
  984.             'show_administrator_data' => 'display',
  985.             'show_back_link_on_top_of_tree' => 'display',
  986.             'show_closed_courses' => 'display',
  987.             'show_different_course_language' => 'display',
  988.             'show_email_addresses' => 'display',
  989.             'show_empty_course_categories' => 'display',
  990.             'show_full_skill_name_on_skill_wheel' => 'skill',
  991.             'show_hot_courses' => 'display',
  992.             'show_link_bug_notification' => 'display',
  993.             'show_number_of_courses' => 'display',
  994.             'show_teacher_data' => 'display',
  995.             'showonline' => 'display',
  996.             'student_autosubscribe' => 'registration',
  997.             'student_page_after_login' => 'registration',
  998.             'student_view_enabled' => 'course',
  999.             'teacher_autosubscribe' => 'registration',
  1000.             'teacher_page_after_login' => 'registration',
  1001.             'time_limit_whosonline' => 'display',
  1002.             'user_selected_theme' => 'profile',
  1003.             'hide_global_announcements_when_not_connected' => 'announcement',
  1004.             'hide_home_top_when_connected' => 'display',
  1005.             'hide_logout_button' => 'display',
  1006.             'institution_address' => 'platform',
  1007.             'redirect_admin_to_courses_list' => 'admin',
  1008.             'use_custom_pages' => 'platform',
  1009.             'allow_group_categories' => 'group',
  1010.             'allow_user_headings' => 'display',
  1011.             'default_document_quotum' => 'document',
  1012.             'default_forum_view' => 'forum',
  1013.             'default_group_quotum' => 'document',
  1014.             'enable_quiz_scenario' => 'exercise',
  1015.             'exercise_max_score' => 'exercise',
  1016.             'exercise_min_score' => 'exercise',
  1017.             'pdf_logo_header' => 'platform',
  1018.             'show_glossary_in_documents' => 'document',
  1019.             'show_glossary_in_extra_tools' => 'glossary',
  1020.             'survey_email_sender_noreply' => 'survey',
  1021.             'allow_coach_feedback_exercises' => 'exercise',
  1022.             'sessionadmin_autosubscribe' => 'registration',
  1023.             'sessionadmin_page_after_login' => 'registration',
  1024.             'show_tutor_data' => 'display',
  1025.             'allow_social_tool' => 'social',
  1026.             'allow_message_tool' => 'message',
  1027.             'allow_email_editor' => 'editor',
  1028.             'show_link_ticket_notification' => 'display',
  1029.             'permissions_for_new_directories' => 'document',
  1030.             'enable_profile_user_address_geolocalization' => 'profile',
  1031.             'allow_show_skype_account' => 'profile',
  1032.             'allow_show_linkedin_url' => 'profile',
  1033.             'allow_students_to_create_groups_in_social' => 'social',
  1034.             'default_calendar_view' => 'agenda',
  1035.             'documents_default_visibility_defined_in_course' => 'document',
  1036.             'message_max_upload_filesize' => 'message',
  1037.             'course_create_active_tools' => 'course',
  1038.             'tool_visible_by_default_at_creation' => 'document',
  1039.             'show_users_folders' => 'document',
  1040.             'show_default_folders' => 'document',
  1041.             'show_chat_folder' => 'chat',
  1042.             'enabled_support_svg' => 'editor',
  1043.             'enabled_support_pixlr' => 'editor',
  1044.             'enable_webcam_clip' => 'document',
  1045.             'enable_record_audio' => 'course',
  1046.             'enabled_text2audio' => 'document',
  1047.             'permanently_remove_deleted_files' => 'document',
  1048.             'allow_delete_attendance' => 'attendance',
  1049.             'display_groups_forum_in_general_tool' => 'forum',
  1050.             'dropbox_allow_overwrite' => 'dropbox',
  1051.             'allow_user_course_subscription_by_course_admin' => 'course',
  1052.             'hide_course_group_if_no_tools_available' => 'group',
  1053.             'extend_rights_for_coach_on_survey' => 'survey',
  1054.             'show_official_code_exercise_result_list' => 'exercise',
  1055.             'dropbox_max_filesize' => 'dropbox',
  1056.             'dropbox_allow_just_upload' => 'dropbox',
  1057.             'dropbox_allow_student_to_student' => 'dropbox',
  1058.             'dropbox_allow_group' => 'dropbox',
  1059.             'dropbox_allow_mailing' => 'dropbox',
  1060.             'upload_extensions_list_type' => 'document',
  1061.             'upload_extensions_blacklist' => 'document',
  1062.             'upload_extensions_skip' => 'document',
  1063.             'changeable_options' => 'profile',
  1064.             'users_copy_files' => 'document',
  1065.             'document_if_file_exists_option' => 'document',
  1066.             'permissions_for_new_files' => 'document',
  1067.             'extended_profile' => 'profile',
  1068.             'split_users_upload_directory' => 'profile',
  1069.             'show_documents_preview' => 'document',
  1070.             'messaging_allow_send_push_notification' => 'webservice',
  1071.             'messaging_gdc_project_number' => 'webservice',
  1072.             'messaging_gdc_api_key' => 'webservice',
  1073.             'allow_download_documents_by_api_key' => 'webservice',
  1074.             'profiling_filter_adding_users' => 'profile',
  1075.             'hide_dltt_markup' => 'language',
  1076.             'active_tools_on_create' => 'course',
  1077.         ];
  1079.         return $settings[$variable] ?? $defaultCategory;
  1080.     }
  1081. }