class.ilVirusScannerConfigStoredObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Setup;

class ilVirusScannerConfigStoredObjective implements Setup\Objective
{
    protected ilVirusScannerSetupConfig $config;

    public function __construct(
        ilVirusScannerSetupConfig $config
    ) {
        $this->config = $config;
    }

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

    public function getLabel(): string
    {
        return 'Fill ini with settings for components/ILIAS/VirusScanner_';
    }

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

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

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);

        $ini->setVariable('tools', 'vscantype', $this->config->getVirusScanner());
        $ini->setVariable('tools', 'scancommand', (string) $this->config->getPathToScan());
        $ini->setVariable('tools', 'cleancommand', (string) $this->config->getPathToClean());
        $ini->setVariable('tools', 'icap_host', (string) $this->config->getIcapHost());
        $ini->setVariable('tools', 'icap_port', (string) $this->config->getIcapPort());
        $ini->setVariable('tools', 'icap_service_name', (string) $this->config->getIcapServiceName());
        $ini->setVariable('tools', 'icap_client_path', (string) $this->config->getIcapClientPath());

        if (!$ini->write()) {
            throw new Setup\UnachievableException('Could not write ilias.ini.php');
        }

        return $environment;
    }

    public function isApplicable(Setup\Environment $environment): bool
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);

        return
            $ini->readVariable('tools', 'vscantype') !== $this->config->getVirusScanner() ||
            $ini->readVariable('tools', 'scancommand') !== $this->config->getPathToScan() ||
            $ini->readVariable('tools', 'cleancommand') !== $this->config->getPathToClean() ||
            $ini->readVariable('tools', 'icap_host') !== $this->config->getIcapHost() ||
            $ini->readVariable('tools', 'icap_port') !== $this->config->getIcapPort() ||
            $ini->readVariable('tools', 'icap_service_name') !== $this->config->getIcapServiceName() ||
            $ini->readVariable('tools', 'icap_client_path') !== $this->config->getIcapClientPath();
    }
}