Inheritance diagram for ilVirusScannerICapRemoteAvClient:

Collaboration diagram for ilVirusScannerICapRemoteAvClient:

Public Member Functions
	__construct ($a_scancommand, $a_cleancommand)
	ilVirusScannerICapAvClient constructor. More...

	scanFile ($a_filepath, $a_origname="")

Public Member Functions inherited from ilVirusScannerICapRemote
	__construct ($a_scancommand, $a_cleancommand)
	ilVirusScannerICap constructor. More...

	options ($service)

	getRequest ($method, $service, $body=[], $headers=[])

	send ($request)

	getLastSocketError ()
	Get last error code from socket object. More...

	respMod ($service, $body=[], $headers=[])

	reqMod ($service, $body=[], $headers=[])

Public Member Functions inherited from ilVirusScanner
	__construct ($a_scancommand, $a_cleancommand)
	Constructor public. More...

	scanBuffer ($buffer)

	scanFile ($a_filepath, $a_origname="")
	scan a file for viruses needs to be redefined in child classes here it simulates a scan "infected.txt" or "cleanable.txt" are expected to be infected More...

	cleanFile ($a_filepath, $a_origname="")
	clean an infected file needs to be redefined in child classes here it simulates a clean "cleanable.txt" is expected to be cleanable More...

	fileCleaned ()
	returns wether file has been cleaned successfully or not More...

	logScanResult ()
	write the result of the last scan to the log public More...

	logCleanResult ()
	write the result of the last clean to the log public More...

	getScanResult ()
	get the pure output of the external scan More...

	getCleanResult ()
	get the pure output of the external scan More...

	getScanMessage ()
	get a located message with the result from the last scan More...

	getCleanMessage ()
	get a located message with the result from the last clean More...

	getScanZipFiles ()
	get info if class can scan ZIP files More...

Data Fields
const	HEADER = 'headers'

const	HEADER_VIOLATION_FOUND = 'X-Violations-Found'

const	HEADER_INFECTION_FOUND = 'X-Infection-Found'

Data Fields inherited from ilVirusScannerICapRemote
	$userAgent = 'PHP-CLIENT/0.1.0'

Data Fields inherited from ilVirusScanner
	$type

	$scanZipFiles

	$scanCommand

	$cleanCommand

	$scanFilePath

	$scanFileOrigName

	$cleanFilePath

	$cleanFileOrigName

	$scanFileIsInfected

	$cleanFileIsCleaned

	$scanResult

	$cleanResult

	$ilias

	$lng

	$log

Protected Member Functions
	analyseHeader ($header)

Protected Member Functions inherited from ilVirusScanner
	scanFileFromBuffer ($buffer)

	createBufferFile ($buffer)

	removeBufferFile ($bufferFile)

Detailed Description

Definition at line 5 of file class.ilVirusScannerICapRemoteAvClient.php.

Constructor & Destructor Documentation

◆ __construct()

ilVirusScannerICapRemoteAvClient::__construct	(	$a_scancommand,
		$a_cleancommand
	)

ilVirusScannerICapAvClient constructor.

Parameters

$a_scancommand
$a_cleancommand

Definition at line 16 of file class.ilVirusScannerICapRemoteAvClient.php.

References ILIAS\GlobalScreen\Provider\__construct(), and ilVirusScannerICapRemote\options().

     {
         parent::__construct($a_scancommand, $a_cleancommand);
         $this->options(IL_ICAP_AV_COMMAND);
     }

Here is the call graph for this function:

Member Function Documentation

◆ analyseHeader()

ilVirusScannerICapRemoteAvClient::analyseHeader ( $header )

protected

Parameters

$header

Returns: bool

Definition at line 60 of file class.ilVirusScannerICapRemoteAvClient.php.

Referenced by scanFile().

     {
         $virus_found = false;
         if (array_key_exists(self::HEADER, $header)) {
             $header = $header[self::HEADER];
             if (array_key_exists(self::HEADER_VIOLATION_FOUND, $header)) {
                 if ($header[self::HEADER_VIOLATION_FOUND] > 0) {
                     $virus_found = true;
                 }
             }
             if (array_key_exists(self::HEADER_INFECTION_FOUND, $header)) {
                 if (strlen($header[self::HEADER_INFECTION_FOUND]) > 0) {
                     $infection_split = preg_split('/;/', $header[self::HEADER_INFECTION_FOUND]);
                     foreach ($infection_split as $infection) {
                         $parts = preg_split('/=/', $infection);
                         if ($parts !== false &&
                             is_array($parts) &&
                             count($parts) > 0 &&
                             strlen($parts[0]) > 0) {
                             $this->log->warning(trim($parts[0]) . ': ' . trim($parts[1]));
                         }
                     }
                     $virus_found = true;
                 }
             }
         }
         return $virus_found;
     }

Here is the caller graph for this function:

◆ scanFile()

ilVirusScannerICapRemoteAvClient::scanFile	(	$a_filepath,
		$a_origname = `""`
	)

Parameters

	$a_filepath
string	$a_origname

Returns: bool|string

Definition at line 27 of file class.ilVirusScannerICapRemoteAvClient.php.

References $results, and analyseHeader().

     {
         $return_string = '';
         if (file_exists($a_filepath)) {
             if (is_readable($a_filepath)) {
                 $a_filepath = realpath($a_filepath);
                 $results = ($this->reqmod(
                     'avscan',
                     [
                         'req-hdr'  => "POST /test HTTP/1.1\r\nHost: 127.0.0.1\r\n\r\n",
                         'req-body' => file_get_contents($a_filepath) //Todo: find a better way
                     ]
                 ));
                 if ($this->analyseHeader($results)) {
                     $return_string = sprintf('Virus found in file "%s"!', $a_filepath);
                     $this->log->warning($return_string);
                 }
             } else {
                 $return_string = sprintf('File "%s" not readable.', $a_filepath);
                 $this->log->warning($return_string);
             }
         } else {
             $return_string = sprintf('File "%s" not found.', $a_filepath);
             $this->log->warning($return_string);
         }
         $this->log->info(sprintf('No virus found in file "%s".', $a_filepath));
         return $return_string;
     }