Inheritance diagram for ilVirusScannerICapClient:

Collaboration diagram for ilVirusScannerICapClient:

Public Member Functions
	__construct (string $scan_command, string $clean_command)

	scanFile (string $file_path, string $org_name="")

Public Member Functions inherited from ilVirusScanner
	__construct (string $scan_command, string $clean_command)

	scanBuffer (string $buffer)

	scanFile (string $file_path, string $org_name="")

	logScanResult ()

	cleanFile (string $file_path, string $org_name="")

	logCleanResult ()

	fileCleaned ()

	getScanResult ()

	getCleanResult ()

	getScanMessage ()

	getCleanMessage ()

	getScanZipFiles ()

Protected Member Functions
	buildScanCommandArguments ($file='-')

Protected Member Functions inherited from ilVirusScanner
	scanFileFromBuffer (string $buffer)

	createBufferFile (string $buffer)

	removeBufferFile (string $bufferFile)

Private Attributes
const	HEADER_INFECTION_FOUND = 'X-Infection-Found'

Additional Inherited Members
Static Public Member Functions inherited from ilVirusScanner
static	virusHandling (string $a_file, string $a_orig_name='', bool $a_clean=true)

Data Fields inherited from ilVirusScanner
string	$type

bool	$scanZipFiles

string	$scanCommand

string	$cleanCommand

string	$scanFilePath

string	$scanFileOrigName

string	$cleanFilePath

string	$cleanFileOrigName

bool	$scanFileIsInfected

bool	$cleanFileIsCleaned

string	$scanResult

string	$cleanResult

ilErrorHandling	$error

ilLanguage	$lng

ilLogger	$log

Detailed Description

Definition at line 21 of file class.ilVirusScannerICapClient.php.

Constructor & Destructor Documentation

◆ __construct()

ilVirusScannerICapClient::__construct	(	string	$scan_command,
		string	$clean_command
	)

Reimplemented from ilVirusScanner.

Definition at line 25 of file class.ilVirusScannerICapClient.php.

    {
        parent::__construct($scan_command, $clean_command);
        $this->scanCommand = IL_ICAP_CLIENT;
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ buildScanCommandArguments()

ilVirusScannerICapClient::buildScanCommandArguments ( $file = '-' )

protected

Parameters

string $file

Returns: string

Definition at line 35 of file class.ilVirusScannerICapClient.php.

    {
        return ' -i ' . IL_ICAP_HOST . ' -p ' . IL_ICAP_PORT . ' -v -s ' . IL_ICAP_AV_COMMAND . ' -f ' . $file;
    }

Referenced by scanFile().

Here is the caller graph for this function:

◆ scanFile()

ilVirusScannerICapClient::scanFile	(	string	$file_path,
		string	$org_name = `""`
	)

Reimplemented from ilVirusScanner.

Definition at line 40 of file class.ilVirusScannerICapClient.php.

                                                                      : string
    {
        $return_string = '';
        if (file_exists($file_path)) {
            if (is_readable($file_path)) {
                $file_path     = realpath($file_path);
                $args           = ilShellUtil::escapeShellArg($file_path);
                $arguments      = $this->buildScanCommandArguments($args) . " 2>&1";
                $cmd            = ilShellUtil::escapeShellCmd($this->scanCommand);
                $out            = ilShellUtil::execQuoted($cmd, $arguments);
                $timeout        = preg_grep('/failed\/timedout.*/', $out);
                $virus_detected = preg_grep('/' . self::HEADER_INFECTION_FOUND . '.*/', $out);
                if (is_array($virus_detected) && count($virus_detected) > 0) {
                    $return_string = sprintf('Virus detected in %s', $file_path);
                    $this->log->warning($return_string);
 
                } elseif (is_array($timeout) && count($timeout) > 0) {
                    $return_string = 'Cannot connect to icap server.';
                    $this->log->warning($return_string);
                }
                $this->scanResult = implode("\n", $out);
            } else {
                $return_string = sprintf('File "%s" not readable.', $file_path);
                $this->log->info($return_string);
            }
        } else {
            $return_string = sprintf('File "%s" not found.', $file_path);
            $this->log->info($return_string);
        }
 
        $this->log->info(sprintf('No virus found in file "%s".', $file_path));
        return $return_string;
    }