ilVirusScannerICapClient Class Reference

Interface to the ClamAV virus protector. More...

Inheritance diagram for ilVirusScannerICapClient:

Collaboration diagram for ilVirusScannerICapClient:

Public Member Functions
	__construct ($a_scancommand, $a_cleancommand)
	ilVirusScannerICapClient constructor. More...
	scanFile ($a_filepath, $a_origname="")
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_INFECTION_FOUND = 'X-Infection-Found'
Data Fields inherited from ilVirusScanner
	$type
	$scanZipFiles
	$scanCommand
	$cleanCommand
	$scanFilePath
	$scanFileOrigName
	$cleanFilePath
	$cleanFileOrigName
	$scanFileIsInfected
	$cleanFileIsCleaned
	$scanResult
	$cleanResult
	$ilias
	$lng
	$log

Protected Member Functions
	buildScanCommandArguments ($file='-')
Protected Member Functions inherited from ilVirusScanner
	scanFileFromBuffer ($buffer)
	createBufferFile ($buffer)
	removeBufferFile ($bufferFile)

Detailed Description

Interface to the ClamAV virus protector.

Author

Ralf Schenk rs@da.nosp@m.taba.nosp@m.y.de

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilVirusScannerICapClient::__construct	(		$a_scancommand,
			$a_cleancommand
	)

ilVirusScannerICapClient constructor.

Parameters

$a_scancommand
$a_cleancommand

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

References ILIAS\GlobalScreen\Provider\__construct().

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

Here is the call graph for this function:

Member Function Documentation

buildScanCommandArguments()

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

protected

Parameters

string

$file

Returns

string

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

Referenced by scanFile().

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

Here is the caller graph for this function:

scanFile()

ilVirusScannerICapClient::scanFile	(		$a_filepath,
			$a_origname = ""
	)

Parameters

	$a_filepath
string	$a_origname

Returns

bool|string

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

References $out, buildScanCommandArguments(), ilUtil\escapeShellArg(), ilUtil\escapeShellCmd(), and ilUtil\execQuoted().

    {
        $return_string = '';
        if (file_exists($a_filepath)) {
            if (is_readable($a_filepath)) {
                $a_filepath     = realpath($a_filepath);
                $args           = ilUtil::escapeShellArg($a_filepath);
                $arguments      = $this->buildScanCommandArguments($args) . " 2>&1";
                $cmd            = ilUtil::escapeShellCmd($this->scanCommand);
                $out            = ilUtil::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', $a_filepath);
                    $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.', $a_filepath);
                $this->log->info($return_string);
            }
        } else {
            $return_string = sprintf('File "%s" not found.', $a_filepath);
            $this->log->info($return_string);
        }
        $this->log->info(sprintf('No virus found in file "%s".', $a_filepath));
        return $return_string;
    }

Here is the call graph for this function:

Field Documentation

HEADER_INFECTION_FOUND

const ilVirusScannerICapClient::HEADER_INFECTION_FOUND = 'X-Infection-Found'

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

---

The documentation for this class was generated from the following file:

• Services/VirusScanner/classes/class.ilVirusScannerICapClient.php