class.ilVirusScannerSetupConfig.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2019 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */

use ILIAS\Setup;
use ILIAS\Data\Password;

class ilVirusScannerSetupConfig implements Setup\Config
{
    const VIRUS_SCANNER_NONE = "none";
    const VIRUS_SCANNER_SOPHOS = "sophos";
    const VIRUS_SCANNER_ANTIVIR = "antivir";
    const VIRUS_SCANNER_CLAMAV = "clamav";
    const VIRUS_SCANNER_ICAP = "icap";

    protected $virus_scanner;

    protected $path_to_scan;

    protected $path_to_clean;

    protected $icap_host;

    protected $icap_port;

    protected $icap_service_name;

    protected $icap_client_path;

    public function __construct(
        string $virus_scanner,
        ?string $path_to_scan,
        ?string $path_to_clean,
        ?string $icap_host,
        ?string $icap_port,
        ?string $icap_service_name,
        ?string $icap_client_path
    ) {
        $scanners = [
            self::VIRUS_SCANNER_NONE,
            self::VIRUS_SCANNER_SOPHOS,
            self::VIRUS_SCANNER_ANTIVIR,
            self::VIRUS_SCANNER_CLAMAV,
            self::VIRUS_SCANNER_ICAP
        ];
        if (!in_array($virus_scanner, $scanners)) {
            throw new \InvalidArgumentException(
                "Unknown virus scanner: '$virus_scanner'"
            );
        }
        if($virus_scanner === self::VIRUS_SCANNER_ICAP) {
            $this->icap_host = $this->toLinuxConvention($icap_host);
            $this->icap_port = $this->toLinuxConvention($icap_port);
            $this->icap_service_name = $this->toLinuxConvention($icap_service_name);
            $this->icap_client_path = $this->toLinuxConvention($icap_client_path);
        } elseif ($virus_scanner !== self::VIRUS_SCANNER_NONE && (!$path_to_scan || !$path_to_clean)) {
            throw new \InvalidArgumentException(
                "Missing path to scan and/or clean commands for virus scanner."
            );
        }
        $this->virus_scanner = $virus_scanner;
        $this->path_to_scan = $this->toLinuxConvention($path_to_scan);
        $this->path_to_clean = $this->toLinuxConvention($path_to_clean);
    }

    protected function toLinuxConvention(?string $p) : ?string
    {
        if (!$p) {
            return null;
        }
        return preg_replace("/\\\\/", "/", $p);
    }

    public function getVirusScanner() : string
    {
        return $this->virus_scanner;
    }

    public function getPathToScan() : ?string
    {
        return $this->path_to_scan;
    }

    public function getPathToClean() : ?string
    {
        return $this->path_to_clean;
    }

    public function getIcapHost() : ?string
    {
        return $this->icap_host;
    }

    public function getIcapPort() : ?string
    {
        return $this->icap_port;
    }

    public function getIcapServiceName() : ?string
    {
        return $this->icap_service_name;
    }

    public function getIcapClientPath() : ?string
    {
        return $this->icap_client_path;
    }
}