ilVirusScannerClamAV Class Reference

Inheritance diagram for ilVirusScannerClamAV:

Collaboration diagram for ilVirusScannerClamAV:

Public Member Functions
	__construct (string $scan_command, string $clean_command)
	scanBuffer (string $buffer)
	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
	isBufferScanPossible ()
	processBufferScan (string $buffer)
	buildScanCommand (string $file='-')
	buildScanCommandArguments ($file='-')
	hasDetections (string $detectionReport)
Protected Member Functions inherited from ilVirusScanner
	scanFileFromBuffer (string $buffer)
	createBufferFile (string $buffer)
	removeBufferFile (string $bufferFile)

Private Attributes
const	ADD_SCAN_PARAMS = '--no-summary -i'

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.ilVirusScannerClamAV.php.

Constructor & Destructor Documentation

__construct()

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

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

References ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct($scan_command, $clean_command);
        $this->type = 'clamav';
        $this->scanZipFiles = true;
    }

Here is the call graph for this function:

Member Function Documentation

buildScanCommand()

ilVirusScannerClamAV::buildScanCommand ( string  $file = '-' )

protected

Definition at line 88 of file class.ilVirusScannerClamAV.php.

Referenced by processBufferScan().

                                                           : string
    {
        return $this->scanCommand . ' ' . self::ADD_SCAN_PARAMS . ' ' . $file;
    }

Here is the caller graph for this function:

buildScanCommandArguments()

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

protected

Returns

string $scanCommand

Definition at line 95 of file class.ilVirusScannerClamAV.php.

Referenced by scanFile().

    {
        return ' ' . self::ADD_SCAN_PARAMS . ' ' . $file;
    }

Here is the caller graph for this function:

hasDetections()

ilVirusScannerClamAV::hasDetections ( string  $detectionReport )

protected

Definition at line 101 of file class.ilVirusScannerClamAV.php.

Referenced by processBufferScan(), and scanFile().

                                                             : int
    {
        return preg_match('/FOUND/', $detectionReport);
    }

Here is the caller graph for this function:

isBufferScanPossible()

ilVirusScannerClamAV::isBufferScanPossible ( )

protected

Definition at line 41 of file class.ilVirusScannerClamAV.php.

Referenced by scanBuffer().

                                             : bool
    {
        $functions = ['proc_open', 'proc_close'];

        foreach ($functions as $func) {
            if (function_exists($func)) {
                continue;
            }

            return false;
        }

        return true;
    }

Here is the caller graph for this function:

processBufferScan()

ilVirusScannerClamAV::processBufferScan ( string  $buffer )

protected

Definition at line 56 of file class.ilVirusScannerClamAV.php.

References buildScanCommand(), and hasDetections().

Referenced by scanBuffer().

                                                        : bool
    {
        $descriptor_spec = [
            0 => ['pipe', 'r'],  // stdin is a pipe that the child will read from
            1 => ['pipe', 'w'],  // stdout is a pipe that the child will write to
            2 => ['pipe', 'w']        // stderr for the child
        ];

        $pipes = []; // will look like follows after passing
        // 0 => writeable handle connected to child stdin
        // 1 => readable handle connected to child stdout

        $process = proc_open($this->buildScanCommand(), $descriptor_spec, $pipes);

        if (!is_resource($process)) {
            return false; // no scan, no virus detected
        }

        fwrite($pipes[0], $buffer);
        fclose($pipes[0]);

        $detectionReport = stream_get_contents($pipes[1]);
        fclose($pipes[1]);

        $errorReport = stream_get_contents($pipes[2]);
        fclose($pipes[2]);

        $return = proc_close($process);

        return (bool) $this->hasDetections($detectionReport);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

scanBuffer()

ilVirusScannerClamAV::scanBuffer

(

string

$buffer

)

Definition at line 32 of file class.ilVirusScannerClamAV.php.

References isBufferScanPossible(), processBufferScan(), and ilVirusScanner\scanFileFromBuffer().

                                              : bool
    {
        if (!$this->isBufferScanPossible()) {
            return $this->scanFileFromBuffer($buffer);
        }

        return $this->processBufferScan($buffer);
    }

Here is the call graph for this function:

scanFile()

ilVirusScannerClamAV::scanFile	(	string	$file_path,
		string	$org_name = ''
	)

Definition at line 106 of file class.ilVirusScannerClamAV.php.

References $out, ilVirusScanner\$scanResult, buildScanCommandArguments(), ilShellUtil\escapeShellArg(), ilShellUtil\escapeShellCmd(), ilShellUtil\execQuoted(), hasDetections(), and ilVirusScanner\logScanResult().

                                                                      : string
    {
        $this->scanFilePath = $file_path;
        $this->scanFileOrigName = $org_name;
        // Make group readable for clamdscan
        $currentPermission = fileperms($file_path);
        $perm = $currentPermission | 0640;
        chmod($file_path, $perm);

        $a_filepath = realpath($file_path);
        if (file_exists($file_path)) {
            $args = ilShellUtil::escapeShellArg($file_path);
            $arguments = $this->buildScanCommandArguments($args) . ' 2>&1';
            $cmd = ilShellUtil::escapeShellCmd($this->scanCommand);
            $out = ilShellUtil::execQuoted($cmd, $arguments);
            $this->scanResult = implode("\n", $out);

            if ($perm != $currentPermission) {
                chmod($a_filepath, $currentPermission);
            }

            if ($this->hasDetections($this->scanResult)) {
                $this->scanFileIsInfected = true;
                $this->logScanResult();
                return $this->scanResult;
            } else {
                $this->scanFileIsInfected = false;
                return '';
            }
        }

        $return_error = 'ERROR (Virus Scanner failed): '
            . $this->scanResult
            . '; Path=' . $a_filepath;
        $this->log->write($return_error);
        return $return_error;
    }

Here is the call graph for this function:

Field Documentation

ADD_SCAN_PARAMS

const ilVirusScannerClamAV::ADD_SCAN_PARAMS = '--no-summary -i'

private

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

---

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

• components/ILIAS/VirusScanner/classes/class.ilVirusScannerClamAV.php