class.ilMathJaxConfigCheckedObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Setup;

class ilMathJaxConfigCheckedObjective implements Setup\Objective
{
    protected ?\ilMathJaxSetupConfig $setup_config = null;

    public function __construct(?\ilMathJaxSetupConfig $setup_config = null)
    {
        $this->setup_config = $setup_config;
    }

    public function getHash(): string
    {
        return hash("sha256", self::class);
    }

    public function getLabel(): string
    {
        return "Check configuration of Services/MathJax";
    }

    public function isNotable(): bool
    {
        return false;
    }

    public function getPreconditions(Setup\Environment $environment): array
    {
        return [
            new \ilSettingsFactoryExistsObjective()
        ];
    }

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
        $interaction = $environment->getResource(Setup\Environment::RESOURCE_ADMIN_INTERACTION);

        $repo = new ilMathJaxConfigSettingsRepository($factory->settingsFor('MathJax'));
        if (!empty($new_config = $this->checkClientScriptUrl($repo->getConfig(), $interaction))) {
            $repo->updateConfig($new_config);
        }

        return $environment;
    }

    public function isApplicable(Setup\Environment $environment): bool
    {
        return true;
    }

    protected function checkClientScriptUrl(ilMathJaxConfig $config, Setup\AdminInteraction $interaction): ?ilMathJaxConfig
    {
        $change = false;
        $recommended = 'https://cdn.jsdelivr.net/npm/mathjax@2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML,Safe';
        $outdated = [
            'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML',
            'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML,Safe',
            'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML',
            'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML,Safe',
            'https://cdn.jsdelivr.net/npm/mathjax@2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML',
            'https://cdn.jsdelivr.net/npm/mathjax@2.7.9/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
        ];

        if (in_array($config->getClientScriptUrl(), $outdated)) {
            if ($config->isClientEnabled()) {
                $change = $interaction->confirmOrDeny("Replace outdated or unsave MathJax URL with $recommended ?");
            } else {
                $interaction->inform("Replaced inactive outdated MathJax URL with $recommended");
                $change = true;
            }
        }
        if ($change
            && $this->setup_config !== null
            && in_array($this->setup_config->getConfig()->getClientScriptUrl(), $outdated)
        ) {
            $interaction->inform("Please change the URL in the setup.json to avoid this message in the next update.");
        }

        if ($change) {
            return $config->withClientScriptUrl($recommended);
        }
        return null;
    }
}