Passed
Pull Request — master (#7060)
by
unknown
09:22
created

SettingsManager::getParametersFromKeyword()   B

Complexity

Conditions 6
Paths 12

Size

Total Lines 37
Code Lines 21

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 6
eloc 21
c 1
b 0
f 0
nc 12
nop 3
dl 0
loc 37
rs 8.9617
1
<?php
2
3
declare(strict_types=1);
4
5
/* For licensing terms, see /license.txt */
6
7
namespace Chamilo\CoreBundle\Settings;
8
9
use Chamilo\CoreBundle\Entity\AccessUrl;
10
use Chamilo\CoreBundle\Entity\Course;
11
use Chamilo\CoreBundle\Entity\SettingsCurrent;
12
use Chamilo\CoreBundle\Helpers\SettingsManagerHelper;
13
use Doctrine\ORM\EntityManager;
14
use Doctrine\ORM\EntityRepository;
15
use InvalidArgumentException;
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\Exception\ValidatorException;
25
26
use const ARRAY_FILTER_USE_KEY;
27
28
/**
29
 * Handles the platform settings.
30
 */
31
class SettingsManager implements SettingsManagerInterface
32
{
33
    protected ?AccessUrl $url = null;
34
35
    protected ServiceRegistryInterface $schemaRegistry;
36
37
    protected EntityManager $manager;
38
39
    protected EntityRepository $repository;
40
41
    protected EventDispatcherInterface $eventDispatcher;
42
43
    /**
44
     * Runtime cache for resolved parameters.
45
     *
46
     * @var Settings[]
47
     */
48
    protected array $resolvedSettings = [];
49
50
    /**
51
     * @var null|array<string, Settings>|mixed[]
52
     */
53
    protected ?array $schemaList;
54
55
    protected RequestStack $request;
56
57
    public function __construct(
58
        ServiceRegistryInterface $schemaRegistry,
59
        EntityManager $manager,
60
        EntityRepository $repository,
61
        EventDispatcherInterface $eventDispatcher,
62
        RequestStack $request,
63
        protected readonly SettingsManagerHelper $settingsManagerHelper,
64
    ) {
65
        $this->schemaRegistry = $schemaRegistry;
66
        $this->manager = $manager;
67
        $this->repository = $repository;
68
        $this->eventDispatcher = $eventDispatcher;
69
        $this->request = $request;
70
        $this->schemaList = [];
71
    }
72
73
    public function getUrl(): ?AccessUrl
74
    {
75
        return $this->url;
76
    }
77
78
    public function setUrl(AccessUrl $url): void
79
    {
80
        $this->url = $url;
81
    }
82
83
    public function updateSchemas(AccessUrl $url): void
84
    {
85
        $this->url = $url;
86
        $schemas = array_keys($this->getSchemas());
87
        foreach ($schemas as $schema) {
88
            $settings = $this->load($this->convertServiceToNameSpace($schema));
89
            $this->update($settings);
90
        }
91
    }
92
93
    public function installSchemas(AccessUrl $url): void
94
    {
95
        $this->url = $url;
96
        $schemas = array_keys($this->getSchemas());
97
        foreach ($schemas as $schema) {
98
            $settings = $this->load($this->convertServiceToNameSpace($schema));
99
            $this->save($settings);
100
        }
101
    }
102
103
    /**
104
     * @return array|AbstractSettingsSchema[]
105
     */
106
    public function getSchemas(): array
107
    {
108
        return $this->schemaRegistry->all();
109
    }
110
111
    public function convertNameSpaceToService(string $category): string
112
    {
113
        return 'chamilo_core.settings.'.$category;
114
    }
115
116
    public function convertServiceToNameSpace(string $category): string
117
    {
118
        return str_replace('chamilo_core.settings.', '', $category);
119
    }
120
121
    public function updateSetting(string $name, $value): void
122
    {
123
        $name = $this->validateSetting($name);
124
125
        [$category, $name] = explode('.', $name);
126
        $settings = $this->load($category);
127
128
        if (!$settings->has($name)) {
129
            $message = \sprintf("Parameter %s doesn't exists.", $name);
130
131
            throw new InvalidArgumentException($message);
132
        }
133
134
        $settings->set($name, $value);
135
        $this->update($settings);
136
    }
137
138
    /**
139
     * Get a specific configuration setting, getting from the previously stored
140
     * PHP session data whenever possible.
141
     *
142
     * @param string $name       The setting name (composed if in a category, i.e. 'platform.institution')
143
     * @param bool   $loadFromDb Whether to load from the database
144
     */
145
    public function getSetting(string $name, bool $loadFromDb = false): mixed
146
    {
147
        $name = $this->validateSetting($name);
148
149
        $overridden = $this->settingsManagerHelper->getOverride($name);
150
151
        if (null !== $overridden) {
152
            return $overridden;
153
        }
154
155
        [$category, $name] = explode('.', $name);
156
157
        if ($loadFromDb) {
158
            $settings = $this->load($category, $name);
159
            if ($settings->has($name)) {
160
                return $settings->get($name);
161
            }
162
163
            return null;
164
        }
165
166
        $this->loadAll();
167
168
        if (!empty($this->schemaList) && isset($this->schemaList[$category])) {
169
            $settings = $this->schemaList[$category];
170
            if ($settings->has($name)) {
171
                return $settings->get($name);
172
            }
173
            error_log("Attempted to access undefined setting '$name' in category '$category'.");
174
175
            return null;
176
        }
177
178
        throw new InvalidArgumentException(\sprintf('Category %s not found', $category));
179
    }
180
181
    public function loadAll(): void
182
    {
183
        $session = null;
184
185
        if ($this->request->getCurrentRequest()) {
186
            $session = $this->request->getCurrentRequest()->getSession();
187
            $schemaList = $session->get('schemas');
188
            if (!empty($schemaList)) {
189
                $this->schemaList = $schemaList;
190
191
                return;
192
            }
193
        }
194
195
        $schemas = array_keys($this->getSchemas());
196
        $schemaList = [];
197
        $settingsBuilder = new SettingsBuilder();
198
        $all = $this->getAllParametersByCategory();
199
200
        foreach ($schemas as $schema) {
201
            $schemaRegister = $this->schemaRegistry->get($schema);
202
            $schemaRegister->buildSettings($settingsBuilder);
203
            $name = $this->convertServiceToNameSpace($schema);
204
            $settings = new Settings();
205
206
            /** @var array<string, mixed> $parameters */
207
            $parameters = $all[$name] ?? [];
208
209
            $knownParameters = array_filter(
210
                $parameters,
211
                fn ($key): bool => $settingsBuilder->isDefined($key),
212
                ARRAY_FILTER_USE_KEY
213
            );
214
215
            $transformers = $settingsBuilder->getTransformers();
216
            foreach ($transformers as $parameter => $transformer) {
217
                if (\array_key_exists($parameter, $knownParameters)) {
218
                    if ('course_creation_use_template' === $parameter) {
219
                        if (empty($knownParameters[$parameter])) {
220
                            $knownParameters[$parameter] = null;
221
                        }
222
                    } else {
223
                        $knownParameters[$parameter] = $transformer->reverseTransform($knownParameters[$parameter]);
224
                    }
225
                }
226
            }
227
228
            $knownParameters = $this->normalizeNullsBeforeResolve($knownParameters, $settingsBuilder);
229
            $parameters = $settingsBuilder->resolve($knownParameters);
230
            $settings->setParameters($parameters);
231
            $schemaList[$name] = $settings;
232
        }
233
        $this->schemaList = $schemaList;
234
        if ($session && $this->request->getCurrentRequest()) {
235
            $session->set('schemas', $schemaList);
236
        }
237
    }
238
239
    public function load(string $schemaAlias, ?string $namespace = null, bool $ignoreUnknown = true): SettingsInterface
240
    {
241
        $settings = new Settings();
242
        $schemaAliasNoPrefix = $schemaAlias;
243
        $schemaAlias = 'chamilo_core.settings.'.$schemaAlias;
244
        if ($this->schemaRegistry->has($schemaAlias)) {
245
            /** @var SchemaInterface $schema */
246
            $schema = $this->schemaRegistry->get($schemaAlias);
247
        } else {
248
            return $settings;
249
        }
250
251
        $settings->setSchemaAlias($schemaAlias);
252
253
        // We need to get a plain parameters array since we use the options resolver on it
254
        $parameters = $this->getParameters($schemaAliasNoPrefix);
255
        $settingsBuilder = new SettingsBuilder();
256
        $schema->buildSettings($settingsBuilder);
257
258
        // Remove unknown settings' parameters (e.g. From a previous version of the settings schema)
259
        if (true === $ignoreUnknown) {
260
            foreach ($parameters as $name => $value) {
261
                if (!$settingsBuilder->isDefined($name)) {
262
                    unset($parameters[$name]);
263
                }
264
            }
265
        }
266
267
        foreach ($settingsBuilder->getTransformers() as $parameter => $transformer) {
268
            if (\array_key_exists($parameter, $parameters)) {
269
                $parameters[$parameter] = $transformer->reverseTransform($parameters[$parameter]);
270
            }
271
        }
272
        $parameters = $this->normalizeNullsBeforeResolve($parameters, $settingsBuilder);
273
        $parameters = $settingsBuilder->resolve($parameters);
274
        $settings->setParameters($parameters);
275
276
        return $settings;
277
    }
278
279
    public function update(SettingsInterface $settings): void
280
    {
281
        $namespace = $settings->getSchemaAlias();
282
283
        /** @var SchemaInterface $schema */
284
        $schema = $this->schemaRegistry->get($settings->getSchemaAlias());
285
286
        $settingsBuilder = new SettingsBuilder();
287
        $schema->buildSettings($settingsBuilder);
288
        $raw = $settings->getParameters();
289
        $raw = $this->normalizeNullsBeforeResolve($raw, $settingsBuilder);
290
        $parameters = $settingsBuilder->resolve($raw);
291
292
        foreach ($parameters as $parameter => $value) {
293
            $parameters[$parameter] = $this->transformToString($value);
294
        }
295
296
        $settings->setParameters($parameters);
297
        $category = $this->convertServiceToNameSpace($settings->getSchemaAlias());
298
299
        // Restrict lookup to current URL so we do not override settings from other URLs.
300
        $criteria = [
301
            'category' => $category,
302
        ];
303
304
        if (null !== $this->url) {
305
            $criteria['url'] = $this->url;
306
        }
307
308
        $persistedParameters = $this->repository->findBy($criteria);
309
310
        $persistedParametersMap = [];
311
312
        /** @var SettingsCurrent $parameter */
313
        foreach ($persistedParameters as $parameter) {
314
            $persistedParametersMap[$parameter->getVariable()] = $parameter;
315
        }
316
317
        $url = $this->getUrl();
318
        $simpleCategoryName = str_replace('chamilo_core.settings.', '', $namespace);
319
320
        foreach ($parameters as $name => $value) {
321
            // MultiURL: respect access_url_changeable defined on main URL.
322
            if (!$this->isSettingChangeableForCurrentUrl($simpleCategoryName, $name)) {
323
                continue;
324
            }
325
326
            if (isset($persistedParametersMap[$name])) {
327
                $parameter = $persistedParametersMap[$name];
328
                $parameter->setSelectedValue($value);
329
                $parameter->setCategory($simpleCategoryName);
330
                $this->manager->persist($parameter);
331
            } else {
332
                $parameter = $this->createSettingForCurrentUrl($simpleCategoryName, $name, $value);
333
                $this->manager->persist($parameter);
334
            }
335
        }
336
337
        $this->manager->flush();
338
    }
339
340
    /**
341
     * @throws ValidatorException
342
     */
343
    public function save(SettingsInterface $settings): void
344
    {
345
        $namespace = $settings->getSchemaAlias();
346
347
        /** @var SchemaInterface $schema */
348
        $schema = $this->schemaRegistry->get($settings->getSchemaAlias());
349
350
        $settingsBuilder = new SettingsBuilder();
351
        $schema->buildSettings($settingsBuilder);
352
        $raw = $settings->getParameters();
353
        $raw = $this->normalizeNullsBeforeResolve($raw, $settingsBuilder);
354
        $parameters = $settingsBuilder->resolve($raw);
355
356
        foreach ($parameters as $parameter => $value) {
357
            $parameters[$parameter] = $this->transformToString($value);
358
        }
359
        $settings->setParameters($parameters);
360
        $criteria = [
361
            'category' => $this->convertServiceToNameSpace($settings->getSchemaAlias()),
362
        ];
363
364
        // Limit to current URL so we do not write across all URLs.
365
        if (null !== $this->url) {
366
            $criteria['url'] = $this->url;
367
        }
368
369
        $persistedParameters = $this->repository->findBy($criteria);
370
        $persistedParametersMap = [];
371
        foreach ($persistedParameters as $parameter) {
372
            $persistedParametersMap[$parameter->getVariable()] = $parameter;
373
        }
374
375
        $url = $this->getUrl();
376
        $simpleCategoryName = str_replace('chamilo_core.settings.', '', $namespace);
377
378
        foreach ($parameters as $name => $value) {
379
            // MultiURL: respect access_url_changeable defined on main URL.
380
            if (!$this->isSettingChangeableForCurrentUrl($simpleCategoryName, $name)) {
381
                continue;
382
            }
383
384
            if (isset($persistedParametersMap[$name])) {
385
                $parameter = $persistedParametersMap[$name];
386
                $parameter->setSelectedValue($value);
387
            } else {
388
                $parameter = $this->createSettingForCurrentUrl($simpleCategoryName, $name, $value);
389
                $this->manager->persist($parameter);
390
            }
391
        }
392
393
        $this->manager->flush();
394
    }
395
396
    /**
397
     * @param string $keyword
398
     */
399
    public function getParametersFromKeywordOrderedByCategory($keyword): array
400
    {
401
        $qb = $this->repository->createQueryBuilder('s')
402
            ->where('s.variable LIKE :keyword OR s.title LIKE :keyword')
403
            ->setParameter('keyword', "%{$keyword}%");
404
405
        // Restrict search to current URL when available.
406
        if (null !== $this->url) {
407
            $qb
408
                ->andWhere('s.url = :url')
409
                ->setParameter('url', $this->url);
410
        }
411
412
        $parametersFromDb = $qb->getQuery()->getResult();
413
        $parameters = [];
414
415
        foreach ($parametersFromDb as $parameter) {
416
            /** @var SettingsCurrent $parameter */
417
            $category = $parameter->getCategory();
418
            $variable = $parameter->getVariable();
419
420
            $hidden = [];
421
            $serviceKey = 'chamilo_core.settings.'.$category;
422
            if ($this->schemaRegistry->has($serviceKey)) {
423
                $schema = $this->schemaRegistry->get($serviceKey);
424
                if (method_exists($schema, 'getHiddenSettings')) {
425
                    $hidden = $schema->getHiddenSettings();
426
                }
427
            }
428
429
            if (\in_array($variable, $hidden, true)) {
430
                continue;
431
            }
432
433
            $parameters[$category][] = $parameter;
434
        }
435
436
        return $parameters;
437
    }
438
439
    /**
440
     * @param string $namespace
441
     * @param string $keyword
442
     * @param bool   $returnObjects
443
     *
444
     * @return array
445
     */
446
    public function getParametersFromKeyword($namespace, $keyword = '', $returnObjects = false)
447
    {
448
        if (empty($keyword)) {
449
            $criteria = [
450
                'category' => $namespace,
451
            ];
452
453
            if (null !== $this->url) {
454
                $criteria['url'] = $this->url;
455
            }
456
457
            $parametersFromDb = $this->repository->findBy($criteria);
458
        } else {
459
            $qb = $this->repository->createQueryBuilder('s')
460
                ->where('s.variable LIKE :keyword')
461
                ->setParameter('keyword', "%{$keyword}%");
462
463
            if (null !== $this->url) {
464
                $qb
465
                    ->andWhere('s.url = :url')
466
                    ->setParameter('url', $this->url);
467
            }
468
469
            $parametersFromDb = $qb->getQuery()->getResult();
470
        }
471
472
        if ($returnObjects) {
473
            return $parametersFromDb;
474
        }
475
        $parameters = [];
476
477
        /** @var SettingsCurrent $parameter */
478
        foreach ($parametersFromDb as $parameter) {
479
            $parameters[$parameter->getVariable()] = $parameter->getSelectedValue();
480
        }
481
482
        return $parameters;
483
    }
484
485
    private function validateSetting(string $name): string
486
    {
487
        if (!str_contains($name, '.')) {
488
            // throw new \InvalidArgumentException(sprintf('Parameter must be in format "namespace.name", "%s" given.', $name));
489
490
            // This code allows the possibility of calling
491
            // api_get_setting('allow_skills_tool') instead of
492
            // the "correct" way api_get_setting('platform.allow_skills_tool')
493
            $items = $this->getVariablesAndCategories();
494
495
            if (isset($items[$name])) {
496
                $originalName = $name;
497
                $name = $this->renameVariable($name);
498
                $category = $this->fixCategory(
499
                    strtolower($name),
500
                    strtolower($items[$originalName])
501
                );
502
                $name = $category.'.'.$name;
503
            } else {
504
                $message = \sprintf('Parameter must be in format "category.name", "%s" given.', $name);
505
506
                throw new InvalidArgumentException($message);
507
            }
508
        }
509
510
        return $name;
511
    }
512
513
    /**
514
     * Load parameter from database.
515
     *
516
     * @param string $namespace
517
     *
518
     * @return array
519
     */
520
    private function getParameters($namespace)
521
    {
522
        $parameters = [];
523
524
        $criteria = ['category' => $namespace];
525
526
        // MultiURL: only parameters for current URL (if set).
527
        if (null !== $this->url) {
528
            $criteria['url'] = $this->url;
529
        }
530
531
        $category = $this->repository->findBy($criteria);
532
533
        /** @var SettingsCurrent $parameter */
534
        foreach ($category as $parameter) {
535
            $parameters[$parameter->getVariable()] = $parameter->getSelectedValue();
536
        }
537
538
        return $parameters;
539
    }
540
541
    private function getAllParametersByCategory()
542
    {
543
        $parameters = [];
544
545
        // MultiURL: either all parameters (single URL mode) or only for current URL.
546
        if (null !== $this->url) {
547
            $all = $this->repository->findBy(['url' => $this->url]);
548
        } else {
549
            $all = $this->repository->findAll();
550
        }
551
552
        /** @var SettingsCurrent $parameter */
553
        foreach ($all as $parameter) {
554
            $parameters[$parameter->getCategory()][$parameter->getVariable()] = $parameter->getSelectedValue();
555
        }
556
557
        return $parameters;
558
    }
559
560
    /**
561
     * Check if a setting is changeable for the current URL, using the
562
     * access_url_changeable flag from the main URL (ID = 1).
563
     */
564
    private function isSettingChangeableForCurrentUrl(string $category, string $variable): bool
565
    {
566
        // No URL bound: behave as legacy single-URL platform.
567
        if (null === $this->url) {
568
            return true;
569
        }
570
571
        // Main URL can always edit settings. UI already restricts who can see/edit fields.
572
        if (1 === $this->url->getId()) {
573
            return true;
574
        }
575
576
        // Try to load main (canonical) URL.
577
        $mainUrl = $this->manager->getRepository(AccessUrl::class)->find(1);
578
        if (null === $mainUrl) {
579
            // If main URL is missing, fallback to permissive behaviour.
580
            return true;
581
        }
582
583
        /** @var SettingsCurrent|null $mainSetting */
584
        $mainSetting = $this->repository->findOneBy([
585
            'category' => $category,
586
            'variable' => $variable,
587
            'url' => $mainUrl,
588
        ]);
589
590
        if (null === $mainSetting) {
591
            // If there is no canonical row, do not block changes.
592
            return true;
593
        }
594
595
        // When access_url_changeable is false/0 on main URL,
596
        // secondary URLs must not override the value.
597
        return (bool) $mainSetting->getAccessUrlChangeable();
598
    }
599
600
    private function createSettingForCurrentUrl(string $category, string $variable, string $value): SettingsCurrent
601
    {
602
        $url = $this->getUrl();
603
604
        // Try to reuse metadata from main URL (ID = 1) as canonical definition.
605
        $mainUrl = $this->manager->getRepository(AccessUrl::class)->find(1);
606
607
        $reference = null;
608
609
        if (null !== $mainUrl) {
610
            $reference = $this->repository->findOneBy([
611
                'category' => $category,
612
                'variable' => $variable,
613
                'url' => $mainUrl,
614
            ]);
615
        }
616
617
        if (!$reference instanceof SettingsCurrent) {
618
            // Fallback: any existing row for this category + variable (legacy / no-URL case).
619
            $reference = $this->repository->findOneBy([
620
                'category' => $category,
621
                'variable' => $variable,
622
            ]);
623
        }
624
625
        $setting = (new SettingsCurrent())
626
            ->setVariable($variable)
627
            ->setCategory($category)
628
            ->setSelectedValue($value)
629
            ->setUrl($url)
630
        ;
631
632
        if ($reference instanceof SettingsCurrent) {
633
            // Copy descriptive metadata so the new URL row behaves like the canonical one.
634
            $setting->setTitle($reference->getTitle());
635
636
            // These fields may or may not exist in the entity in Chamilo 2,
637
            // so we check for method existence to stay safe.
638
            if (method_exists($setting, 'setType') && method_exists($reference, 'getType')) {
639
                $setting->setType($reference->getType());
640
            }
641
642
            if (method_exists($setting, 'setComment') && method_exists($reference, 'getComment')) {
643
                $setting->setComment($reference->getComment());
644
            }
645
646
            if (method_exists($setting, 'setScope') && method_exists($reference, 'getScope')) {
647
                $setting->setScope($reference->getScope());
648
            }
649
650
            if (method_exists($setting, 'setSubkey') && method_exists($reference, 'getSubkey')) {
651
                $setting->setSubkey($reference->getSubkey());
652
            }
653
654
            if (method_exists($setting, 'setSubkeytext') && method_exists($reference, 'getSubkeytext')) {
655
                $setting->setSubkeytext($reference->getSubkeytext());
656
            }
657
658
            // Copy flags and template; the "changeable" flag is still interpreted from main URL.
659
            $setting->setAccessUrlChangeable($reference->getAccessUrlChangeable());
660
            $setting->setAccessUrlLocked($reference->getAccessUrlLocked());
661
662
            if (method_exists($setting, 'setValueTemplate') && method_exists($reference, 'getValueTemplate')) {
663
                $setting->setValueTemplate($reference->getValueTemplate());
664
            }
665
        } else {
666
            // Fallback: minimal metadata if no canonical definition was found.
667
            $setting
668
                ->setTitle($variable)
669
                ->setAccessUrlChangeable(1)
670
                ->setAccessUrlLocked(1)
671
            ;
672
        }
673
674
        return $setting;
675
    }
676
677
    /*private function transformParameters(SettingsBuilder $settingsBuilder, array $parameters)
678
     * {
679
     * $transformedParameters = $parameters;
680
     * foreach ($settingsBuilder->getTransformers() as $parameter => $transformer) {
681
     * if (array_key_exists($parameter, $parameters)) {
682
     * $transformedParameters[$parameter] = $transformer->reverseTransform($parameters[$parameter]);
683
     * }
684
     * }
685
     * return $transformedParameters;
686
     * }*/
687
688
    /**
689
     * Get variables and categories as in 1.11.x.
690
     */
691
    private function getVariablesAndCategories(): array
692
    {
693
        return [
694
            'Institution' => 'Platform',
695
            'InstitutionUrl' => 'Platform',
696
            'siteName' => 'Platform',
697
            'site_name' => 'Platform',
698
            'emailAdministrator' => 'admin',
699
            // 'emailAdministrator' => 'Platform',
700
            'administratorSurname' => 'admin',
701
            'administratorTelephone' => 'admin',
702
            'administratorName' => 'admin',
703
            'show_administrator_data' => 'Platform',
704
            'show_tutor_data' => 'Session',
705
            'show_teacher_data' => 'Platform',
706
            'show_toolshortcuts' => 'Course',
707
            'allow_group_categories' => 'Course',
708
            'server_type' => 'Platform',
709
            'platformLanguage' => 'Language',
710
            'showonline' => 'Platform',
711
            'profile' => 'User',
712
            'default_document_quotum' => 'Course',
713
            'registration' => 'User',
714
            'default_group_quotum' => 'Course',
715
            'allow_registration' => 'Platform',
716
            'allow_registration_as_teacher' => 'Platform',
717
            'allow_lostpassword' => 'Platform',
718
            'allow_user_headings' => 'Course',
719
            'allow_personal_agenda' => 'agenda',
720
            'display_coursecode_in_courselist' => 'Platform',
721
            'display_teacher_in_courselist' => 'Platform',
722
            'permanently_remove_deleted_files' => 'Tools',
723
            'dropbox_allow_overwrite' => 'Tools',
724
            'dropbox_max_filesize' => 'Tools',
725
            'dropbox_allow_just_upload' => 'Tools',
726
            'dropbox_allow_student_to_student' => 'Tools',
727
            'dropbox_allow_group' => 'Tools',
728
            'dropbox_allow_mailing' => 'Tools',
729
            'extended_profile' => 'User',
730
            'student_view_enabled' => 'Platform',
731
            'show_navigation_menu' => 'Course',
732
            'enable_tool_introduction' => 'course',
733
            'page_after_login' => 'Platform',
734
            'time_limit_whosonline' => 'Platform',
735
            'breadcrumbs_course_homepage' => 'Course',
736
            'example_material_course_creation' => 'Platform',
737
            'account_valid_duration' => 'Platform',
738
            'use_session_mode' => 'Session',
739
            'allow_email_editor' => 'Tools',
740
            // 'registered' => null',
741
            // 'donotlistcampus' =>'null',
742
            'show_email_addresses' => 'Platform',
743
            'service_ppt2lp' => 'NULL',
744
            'upload_extensions_list_type' => 'Security',
745
            'upload_extensions_blacklist' => 'Security',
746
            'upload_extensions_whitelist' => 'Security',
747
            'upload_extensions_skip' => 'Security',
748
            'upload_extensions_replace_by' => 'Security',
749
            'show_number_of_courses' => 'Platform',
750
            'show_empty_course_categories' => 'Platform',
751
            'show_back_link_on_top_of_tree' => 'Platform',
752
            'show_different_course_language' => 'Platform',
753
            'split_users_upload_directory' => 'Tuning',
754
            'display_categories_on_homepage' => 'Platform',
755
            'permissions_for_new_directories' => 'Security',
756
            'permissions_for_new_files' => 'Security',
757
            'show_tabs' => 'Platform',
758
            'default_forum_view' => 'Course',
759
            'platform_charset' => 'Languages',
760
            'survey_email_sender_noreply' => 'Course',
761
            'gradebook_enable' => 'Gradebook',
762
            'gradebook_score_display_coloring' => 'Gradebook',
763
            'gradebook_score_display_custom' => 'Gradebook',
764
            'gradebook_score_display_colorsplit' => 'Gradebook',
765
            'gradebook_score_display_upperlimit' => 'Gradebook',
766
            'gradebook_number_decimals' => 'Gradebook',
767
            'user_selected_theme' => 'Platform',
768
            'allow_course_theme' => 'Course',
769
            'show_closed_courses' => 'Platform',
770
            'extendedprofile_registration' => 'User',
771
            'extendedprofile_registrationrequired' => 'User',
772
            'add_users_by_coach' => 'Session',
773
            'extend_rights_for_coach' => 'Security',
774
            'extend_rights_for_coach_on_survey' => 'Security',
775
            'course_create_active_tools' => 'Tools',
776
            'show_session_coach' => 'Session',
777
            'allow_users_to_create_courses' => 'Platform',
778
            'allow_message_tool' => 'Tools',
779
            'allow_social_tool' => 'Tools',
780
            'show_session_data' => 'Session',
781
            'allow_use_sub_language' => 'language',
782
            'show_glossary_in_documents' => 'Course',
783
            'allow_terms_conditions' => 'Platform',
784
            'search_enabled' => 'Search',
785
            'search_prefilter_prefix' => 'Search',
786
            'search_show_unlinked_results' => 'Search',
787
            'allow_coach_to_edit_course_session' => 'Session',
788
            'show_glossary_in_extra_tools' => 'Course',
789
            'send_email_to_admin_when_create_course' => 'Platform',
790
            'go_to_course_after_login' => 'Course',
791
            'math_asciimathML' => 'Editor',
792
            'enabled_asciisvg' => 'Editor',
793
            'include_asciimathml_script' => 'Editor',
794
            'youtube_for_students' => 'Editor',
795
            'block_copy_paste_for_students' => 'Editor',
796
            'more_buttons_maximized_mode' => 'Editor',
797
            'students_download_folders' => 'Document',
798
            'users_copy_files' => 'Tools',
799
            'allow_students_to_create_groups_in_social' => 'Tools',
800
            'allow_send_message_to_all_platform_users' => 'Message',
801
            'message_max_upload_filesize' => 'Tools',
802
            'use_users_timezone' => 'profile',
803
            // 'use_users_timezone' => 'Timezones',
804
            'timezone_value' => 'platform',
805
            // 'timezone_value' => 'Timezones',
806
            'allow_user_course_subscription_by_course_admin' => 'Security',
807
            'show_link_bug_notification' => 'Platform',
808
            'show_link_ticket_notification' => 'Platform',
809
            'course_validation' => 'course',
810
            // 'course_validation' => 'Platform',
811
            'course_validation_terms_and_conditions_url' => 'Platform',
812
            'enabled_wiris' => 'Editor',
813
            'allow_spellcheck' => 'Editor',
814
            'force_wiki_paste_as_plain_text' => 'Editor',
815
            'enabled_googlemaps' => 'Editor',
816
            'enabled_imgmap' => 'Editor',
817
            'enabled_support_svg' => 'Tools',
818
            'pdf_export_watermark_enable' => 'Platform',
819
            'pdf_export_watermark_by_course' => 'Platform',
820
            'pdf_export_watermark_text' => 'Platform',
821
            'enabled_insertHtml' => 'Editor',
822
            'students_export2pdf' => 'Document',
823
            'exercise_min_score' => 'Course',
824
            'exercise_max_score' => 'Course',
825
            'show_users_folders' => 'Tools',
826
            'show_default_folders' => 'Tools',
827
            'show_chat_folder' => 'Tools',
828
            'course_hide_tools' => 'Course',
829
            'show_groups_to_users' => 'Group',
830
            'accessibility_font_resize' => 'Platform',
831
            'hide_courses_in_sessions' => 'Session',
832
            'enable_quiz_scenario' => 'Course',
833
            'filter_terms' => 'Security',
834
            'header_extra_content' => 'Tracking',
835
            'footer_extra_content' => 'Tracking',
836
            'show_documents_preview' => 'Tools',
837
            'htmlpurifier_wiki' => 'Editor',
838
            'cas_activate' => 'CAS',
839
            'cas_server' => 'CAS',
840
            'cas_server_uri' => 'CAS',
841
            'cas_port' => 'CAS',
842
            'cas_protocol' => 'CAS',
843
            'cas_add_user_activate' => 'CAS',
844
            'update_user_info_cas_with_ldap' => 'CAS',
845
            'student_page_after_login' => 'Platform',
846
            'teacher_page_after_login' => 'Platform',
847
            'drh_page_after_login' => 'Platform',
848
            'sessionadmin_page_after_login' => 'Session',
849
            'student_autosubscribe' => 'Platform',
850
            'teacher_autosubscribe' => 'Platform',
851
            'drh_autosubscribe' => 'Platform',
852
            'sessionadmin_autosubscribe' => 'Session',
853
            'scorm_cumulative_session_time' => 'Course',
854
            'allow_hr_skills_management' => 'Gradebook',
855
            'enable_help_link' => 'Platform',
856
            'teachers_can_change_score_settings' => 'Gradebook',
857
            'allow_users_to_change_email_with_no_password' => 'User',
858
            'show_admin_toolbar' => 'display',
859
            'allow_global_chat' => 'Platform',
860
            'languagePriority1' => 'language',
861
            'languagePriority2' => 'language',
862
            'languagePriority3' => 'language',
863
            'languagePriority4' => 'language',
864
            'login_is_email' => 'Platform',
865
            'courses_default_creation_visibility' => 'Course',
866
            'gradebook_enable_grade_model' => 'Gradebook',
867
            'teachers_can_change_grade_model_settings' => 'Gradebook',
868
            'gradebook_default_weight' => 'Gradebook',
869
            'ldap_description' => 'LDAP',
870
            'shibboleth_description' => 'Shibboleth',
871
            'facebook_description' => 'Facebook',
872
            'gradebook_locking_enabled' => 'Gradebook',
873
            'gradebook_default_grade_model_id' => 'Gradebook',
874
            'allow_session_admins_to_manage_all_sessions' => 'Session',
875
            'allow_skills_tool' => 'Platform',
876
            'allow_public_certificates' => 'Course',
877
            'platform_unsubscribe_allowed' => 'Platform',
878
            'enable_iframe_inclusion' => 'Editor',
879
            'show_hot_courses' => 'Platform',
880
            'enable_webcam_clip' => 'Tools',
881
            'use_custom_pages' => 'Platform',
882
            'tool_visible_by_default_at_creation' => 'Tools',
883
            'prevent_session_admins_to_manage_all_users' => 'Session',
884
            'documents_default_visibility_defined_in_course' => 'Tools',
885
            'enabled_mathjax' => 'Editor',
886
            'meta_twitter_site' => 'Tracking',
887
            'meta_twitter_creator' => 'Tracking',
888
            'meta_title' => 'Tracking',
889
            'meta_description' => 'Tracking',
890
            'meta_image_path' => 'Tracking',
891
            'allow_teachers_to_create_sessions' => 'Session',
892
            'institution_address' => 'Platform',
893
            'chamilo_database_version' => 'null',
894
            'cron_remind_course_finished_activate' => 'Crons',
895
            'cron_remind_course_expiration_frequency' => 'Crons',
896
            'cron_remind_course_expiration_activate' => 'Crons',
897
            'allow_coach_feedback_exercises' => 'Session',
898
            'allow_my_files' => 'Platform',
899
            'ticket_allow_student_add' => 'Ticket',
900
            'ticket_send_warning_to_all_admins' => 'Ticket',
901
            'ticket_warn_admin_no_user_in_category' => 'Ticket',
902
            'ticket_allow_category_edition' => 'Ticket',
903
            'load_term_conditions_section' => 'Platform',
904
            'show_terms_if_profile_completed' => 'Profile',
905
            'hide_home_top_when_connected' => 'Platform',
906
            'hide_global_announcements_when_not_connected' => 'Platform',
907
            'course_creation_use_template' => 'Course',
908
            'allow_strength_pass_checker' => 'Security',
909
            'allow_captcha' => 'Security',
910
            'captcha_number_mistakes_to_block_account' => 'Security',
911
            'captcha_time_to_block' => 'Security',
912
            'drh_can_access_all_session_content' => 'Session',
913
            'display_groups_forum_in_general_tool' => 'Tools',
914
            'allow_tutors_to_assign_students_to_session' => 'Session',
915
            'allow_lp_return_link' => 'Course',
916
            'hide_scorm_export_link' => 'Course',
917
            'hide_scorm_copy_link' => 'Course',
918
            'hide_scorm_pdf_link' => 'Course',
919
            'session_days_before_coach_access' => 'Session',
920
            'session_days_after_coach_access' => 'Session',
921
            'pdf_logo_header' => 'Course',
922
            'order_user_list_by_official_code' => 'Platform',
923
            'email_alert_manager_on_new_quiz' => 'exercise',
924
            'show_official_code_exercise_result_list' => 'Tools',
925
            'auto_detect_language_custom_pages' => 'Platform',
926
            'lp_show_reduced_report' => 'Course',
927
            'allow_session_course_copy_for_teachers' => 'Session',
928
            'hide_logout_button' => 'Platform',
929
            'redirect_admin_to_courses_list' => 'Platform',
930
            'course_images_in_courses_list' => 'Course',
931
            'student_publication_to_take_in_gradebook' => 'Gradebook',
932
            'certificate_filter_by_official_code' => 'Gradebook',
933
            'exercise_max_ckeditors_in_page' => 'Tools',
934
            'document_if_file_exists_option' => 'Tools',
935
            'add_gradebook_certificates_cron_task_enabled' => 'Gradebook',
936
            'openbadges_backpack' => 'Gradebook',
937
            'cookie_warning' => 'Tools',
938
            'hide_course_group_if_no_tools_available' => 'Tools',
939
            'registration.soap.php.decode_utf8' => 'Platform',
940
            'allow_delete_attendance' => 'Tools',
941
            'gravatar_enabled' => 'Platform',
942
            'gravatar_type' => 'Platform',
943
            'limit_session_admin_role' => 'Session',
944
            'show_session_description' => 'Session',
945
            'hide_certificate_export_link_students' => 'Gradebook',
946
            'hide_certificate_export_link' => 'Gradebook',
947
            'dropbox_hide_course_coach' => 'Tools',
948
            'dropbox_hide_general_coach' => 'Tools',
949
            'session_course_ordering' => 'Session',
950
            'gamification_mode' => 'Platform',
951
            'prevent_multiple_simultaneous_login' => 'Security',
952
            'gradebook_detailed_admin_view' => 'Gradebook',
953
            'user_reset_password' => 'Security',
954
            'user_reset_password_token_limit' => 'Security',
955
            'my_courses_view_by_session' => 'Session',
956
            'show_full_skill_name_on_skill_wheel' => 'Platform',
957
            'messaging_allow_send_push_notification' => 'WebServices',
958
            'messaging_gdc_project_number' => 'WebServices',
959
            'messaging_gdc_api_key' => 'WebServices',
960
            'teacher_can_select_course_template' => 'Course',
961
            'allow_show_skype_account' => 'Platform',
962
            'allow_show_linkedin_url' => 'Platform',
963
            'enable_profile_user_address_geolocalization' => 'User',
964
            'show_official_code_whoisonline' => 'Profile',
965
            'icons_mode_svg' => 'display',
966
            'default_calendar_view' => 'agenda',
967
            'exercise_invisible_in_session' => 'exercise',
968
            'configure_exercise_visibility_in_course' => 'exercise',
969
            'allow_download_documents_by_api_key' => 'Webservices',
970
            'profiling_filter_adding_users' => 'course',
971
            'donotlistcampus' => 'platform',
972
            'course_creation_splash_screen' => 'Course',
973
            'translate_html' => 'Editor',
974
        ];
975
    }
976
977
    /**
978
     * Rename old variable with variable used in Chamilo 2.0.
979
     *
980
     * @param string $variable
981
     */
982
    private function renameVariable($variable)
983
    {
984
        $list = [
985
            'timezone_value' => 'timezone',
986
            'Institution' => 'institution',
987
            'SiteName' => 'site_name',
988
            'siteName' => 'site_name',
989
            'InstitutionUrl' => 'institution_url',
990
            'registration' => 'required_profile_fields',
991
            'platformLanguage' => 'platform_language',
992
            'languagePriority1' => 'language_priority_1',
993
            'languagePriority2' => 'language_priority_2',
994
            'languagePriority3' => 'language_priority_3',
995
            'languagePriority4' => 'language_priority_4',
996
            'gradebook_score_display_coloring' => 'my_display_coloring',
997
            'ProfilingFilterAddingUsers' => 'profiling_filter_adding_users',
998
            'course_create_active_tools' => 'active_tools_on_create',
999
            'emailAdministrator' => 'administrator_email',
1000
            'administratorSurname' => 'administrator_surname',
1001
            'administratorName' => 'administrator_name',
1002
            'administratorTelephone' => 'administrator_phone',
1003
            'registration.soap.php.decode_utf8' => 'decode_utf8',
1004
            'profile' => 'changeable_options',
1005
        ];
1006
1007
        return $list[$variable] ?? $variable;
1008
    }
1009
1010
    /**
1011
     * Replace old Chamilo 1.x category with 2.0 version.
1012
     *
1013
     * @param string $variable
1014
     * @param string $defaultCategory
1015
     */
1016
    private function fixCategory($variable, $defaultCategory)
1017
    {
1018
        $settings = [
1019
            'cookie_warning' => 'platform',
1020
            'donotlistcampus' => 'platform',
1021
            'administrator_email' => 'admin',
1022
            'administrator_surname' => 'admin',
1023
            'administrator_name' => 'admin',
1024
            'administrator_phone' => 'admin',
1025
            'exercise_max_ckeditors_in_page' => 'exercise',
1026
            'allow_hr_skills_management' => 'skill',
1027
            'accessibility_font_resize' => 'display',
1028
            'account_valid_duration' => 'profile',
1029
            'allow_global_chat' => 'chat',
1030
            'allow_lostpassword' => 'registration',
1031
            'allow_registration' => 'registration',
1032
            'allow_registration_as_teacher' => 'registration',
1033
            'required_profile_fields' => 'registration',
1034
            'allow_skills_tool' => 'skill',
1035
            'allow_terms_conditions' => 'registration',
1036
            'allow_users_to_create_courses' => 'course',
1037
            'auto_detect_language_custom_pages' => 'language',
1038
            'platform_language' => 'language',
1039
            'course_validation' => 'course',
1040
            'course_validation_terms_and_conditions_url' => 'course',
1041
            'display_categories_on_homepage' => 'display',
1042
            'display_coursecode_in_courselist' => 'course',
1043
            'display_teacher_in_courselist' => 'course',
1044
            'drh_autosubscribe' => 'registration',
1045
            'drh_page_after_login' => 'registration',
1046
            'enable_help_link' => 'display',
1047
            'example_material_course_creation' => 'course',
1048
            'login_is_email' => 'profile',
1049
            'noreply_email_address' => 'mail',
1050
            'pdf_export_watermark_by_course' => 'document',
1051
            'pdf_export_watermark_enable' => 'document',
1052
            'pdf_export_watermark_text' => 'document',
1053
            'platform_unsubscribe_allowed' => 'registration',
1054
            'send_email_to_admin_when_create_course' => 'course',
1055
            'show_admin_toolbar' => 'display',
1056
            'show_administrator_data' => 'display',
1057
            'show_back_link_on_top_of_tree' => 'display',
1058
            'show_closed_courses' => 'display',
1059
            'show_different_course_language' => 'display',
1060
            'show_email_addresses' => 'display',
1061
            'show_empty_course_categories' => 'display',
1062
            'show_full_skill_name_on_skill_wheel' => 'skill',
1063
            'show_hot_courses' => 'display',
1064
            'show_link_bug_notification' => 'display',
1065
            'show_number_of_courses' => 'display',
1066
            'show_teacher_data' => 'display',
1067
            'showonline' => 'display',
1068
            'student_autosubscribe' => 'registration',
1069
            'student_page_after_login' => 'registration',
1070
            'student_view_enabled' => 'course',
1071
            'teacher_autosubscribe' => 'registration',
1072
            'teacher_page_after_login' => 'registration',
1073
            'time_limit_whosonline' => 'display',
1074
            'user_selected_theme' => 'profile',
1075
            'hide_global_announcements_when_not_connected' => 'announcement',
1076
            'hide_home_top_when_connected' => 'display',
1077
            'hide_logout_button' => 'display',
1078
            'institution_address' => 'platform',
1079
            'redirect_admin_to_courses_list' => 'admin',
1080
            'use_custom_pages' => 'platform',
1081
            'allow_group_categories' => 'group',
1082
            'allow_user_headings' => 'display',
1083
            'default_document_quotum' => 'document',
1084
            'default_forum_view' => 'forum',
1085
            'default_group_quotum' => 'document',
1086
            'enable_quiz_scenario' => 'exercise',
1087
            'exercise_max_score' => 'exercise',
1088
            'exercise_min_score' => 'exercise',
1089
            'pdf_logo_header' => 'platform',
1090
            'show_glossary_in_documents' => 'document',
1091
            'show_glossary_in_extra_tools' => 'glossary',
1092
            'survey_email_sender_noreply' => 'survey',
1093
            'allow_coach_feedback_exercises' => 'exercise',
1094
            'sessionadmin_autosubscribe' => 'registration',
1095
            'sessionadmin_page_after_login' => 'registration',
1096
            'show_tutor_data' => 'display',
1097
            'allow_social_tool' => 'social',
1098
            'allow_message_tool' => 'message',
1099
            'allow_email_editor' => 'editor',
1100
            'show_link_ticket_notification' => 'display',
1101
            'permissions_for_new_directories' => 'document',
1102
            'enable_profile_user_address_geolocalization' => 'profile',
1103
            'allow_show_skype_account' => 'profile',
1104
            'allow_show_linkedin_url' => 'profile',
1105
            'allow_students_to_create_groups_in_social' => 'social',
1106
            'default_calendar_view' => 'agenda',
1107
            'documents_default_visibility_defined_in_course' => 'document',
1108
            'message_max_upload_filesize' => 'message',
1109
            'course_create_active_tools' => 'course',
1110
            'tool_visible_by_default_at_creation' => 'document',
1111
            'show_users_folders' => 'document',
1112
            'show_default_folders' => 'document',
1113
            'show_chat_folder' => 'chat',
1114
            'enabled_support_svg' => 'editor',
1115
            'enable_webcam_clip' => 'document',
1116
            'permanently_remove_deleted_files' => 'document',
1117
            'allow_delete_attendance' => 'attendance',
1118
            'display_groups_forum_in_general_tool' => 'forum',
1119
            'dropbox_allow_overwrite' => 'dropbox',
1120
            'allow_user_course_subscription_by_course_admin' => 'course',
1121
            'hide_course_group_if_no_tools_available' => 'group',
1122
            'extend_rights_for_coach_on_survey' => 'survey',
1123
            'show_official_code_exercise_result_list' => 'exercise',
1124
            'dropbox_max_filesize' => 'dropbox',
1125
            'dropbox_allow_just_upload' => 'dropbox',
1126
            'dropbox_allow_student_to_student' => 'dropbox',
1127
            'dropbox_allow_group' => 'dropbox',
1128
            'dropbox_allow_mailing' => 'dropbox',
1129
            'upload_extensions_list_type' => 'document',
1130
            'upload_extensions_blacklist' => 'document',
1131
            'upload_extensions_skip' => 'document',
1132
            'changeable_options' => 'profile',
1133
            'users_copy_files' => 'document',
1134
            'document_if_file_exists_option' => 'document',
1135
            'permissions_for_new_files' => 'document',
1136
            'extended_profile' => 'profile',
1137
            'split_users_upload_directory' => 'profile',
1138
            'show_documents_preview' => 'document',
1139
            'messaging_allow_send_push_notification' => 'webservice',
1140
            'messaging_gdc_project_number' => 'webservice',
1141
            'messaging_gdc_api_key' => 'webservice',
1142
            'allow_download_documents_by_api_key' => 'webservice',
1143
            'profiling_filter_adding_users' => 'course',
1144
            'active_tools_on_create' => 'course',
1145
        ];
1146
1147
        return $settings[$variable] ?? $defaultCategory;
1148
    }
1149
1150
    private function transformToString($value): string
1151
    {
1152
        if (\is_array($value)) {
1153
            return implode(',', $value);
1154
        }
1155
1156
        if ($value instanceof Course) {
1157
            return (string) $value->getId();
1158
        }
1159
1160
        if (\is_bool($value)) {
1161
            return $value ? 'true' : 'false';
1162
        }
1163
1164
        if (null === $value) {
1165
            return '';
1166
        }
1167
1168
        return (string) $value;
1169
    }
1170
1171
    private function normalizeNullsBeforeResolve(array $parameters, SettingsBuilder $settingsBuilder): array
1172
    {
1173
        foreach ($parameters as $k => $v) {
1174
            if (null === $v && $settingsBuilder->isDefined($k)) {
1175
                unset($parameters[$k]);
1176
            }
1177
        }
1178
1179
        return $parameters;
1180
    }
1181
}
1182