ilVirusScannerClamAV Class Reference

Interface to the ClamAV virus protector. More...

Inheritance diagram for ilVirusScannerClamAV:

Collaboration diagram for ilVirusScannerClamAV:

Public Member Functions
	__construct ($a_scancommand, $a_cleancommand)
	Constructor public. More...
	scanBuffer ($buffer)
	scanFile ($a_filepath, $a_origname="")
	scan a file for viruses More...
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	ADD_SCAN_PARAMS = '--no-summary -i'
Data Fields inherited from ilVirusScanner
	$type
	$scanZipFiles
	$scanCommand
	$cleanCommand
	$scanFilePath
	$scanFileOrigName
	$cleanFilePath
	$cleanFileOrigName
	$scanFileIsInfected
	$cleanFileIsCleaned
	$scanResult
	$cleanResult
	$ilias
	$lng
	$log

Protected Member Functions
	buildScanCommand ($file='-')
	isBufferScanPossible ()
	processBufferScan ($buffer)
	hasDetections ($detectionReport)
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.ilVirusScannerClamAV.php.

Constructor & Destructor Documentation

__construct()

ilVirusScannerClamAV::__construct	(		$a_scancommand,
			$a_cleancommand
	)

Constructor public.

Parameters

string

virus scanner command

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

    {
        parent::__construct($a_scancommand, $a_cleancommand);
        $this->type = "clamav";
        $this->scanZipFiles = true;
    }

Member Function Documentation

buildScanCommand()

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

protected

Returns

string $scanCommand

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

Referenced by processBufferScan(), and scanFile().

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

Here is the caller graph for this function:

hasDetections()

ilVirusScannerClamAV::hasDetections (   $detectionReport )

protected

Parameters

$detectionReport

Returns

int

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

Referenced by processBufferScan(), and scanFile().

    {
        return preg_match("/FOUND/", $detectionReport);
    }

Here is the caller graph for this function:

isBufferScanPossible()

ilVirusScannerClamAV::isBufferScanPossible ( )

protected

Returns

bool $isBufferScanSupported

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

Referenced by scanBuffer().

    {
        $functions = array('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 (   $buffer )

protected

Parameters

string

$buffer

(any data, binary)

Returns

bool

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

References buildScanCommand(), and hasDetections().

Referenced by scanBuffer().

    {
        $descriptorspec = array(
            0 => array("pipe", "r"),  // stdin is a pipe that the child will read from
            1 => array("pipe", "w"),  // stdout is a pipe that the child will write to
            2 => array("pipe", "w")             // stderr for the child
        );
        
        $pipes = array(); // 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(), $descriptorspec, $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 $this->hasDetections($detectionReport);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

scanBuffer()

ilVirusScannerClamAV::scanBuffer

(

$buffer

)

Parameters

string

$buffer

(any data, binary)

Returns

bool $infected

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

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

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

Here is the call graph for this function:

scanFile()

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

scan a file for viruses

Parameters

string	path of file to check
string	original name of the file to ckeck

Returns

string virus message (empty if not infected) public

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

References $out, $ret, ilVirusScanner\$scanResult, buildScanCommand(), hasDetections(), and ilVirusScanner\logScanResult().

    {
        // This function should:
        // - call the external scanner for a_filepath
        // - set scanFilePath to a_filepath
        // - set scanFileOrigName to a_origname
        // - set scanFileIsInfected according the scan result
        // - set scanResult to the scanner output message
        // - call logScanResult() if file is infected
        // - return the scanResult, if file is infected
        // - return an empty string, if file is not infected

        $this->scanFilePath = $a_filepath;
        $this->scanFileOrigName = $a_origname;

        // Make group readable for clamdscan
        $currentPermission = fileperms($a_filepath);
        $perm = $currentPermission | 0640;
        chmod($a_filepath, $perm);

        // Call of antivir command
        $cmd = $this->buildScanCommand($a_filepath) . " 2>&1";
        exec($cmd, $out, $ret);
        $this->scanResult = implode("\n", $out);

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

        // sophie could be called
        if ($this->hasDetections($this->scanResult)) {
            $this->scanFileIsInfected = true;
            $this->logScanResult();
            return $this->scanResult;
        } else {
            $this->scanFileIsInfected = false;
            return "";
        }

        // antivir has failed (todo)
        $this->log->write("ERROR (Virus Scanner failed): "
            . $this->scanResult
            . "; COMMAMD=" . $cmd);
    }

Here is the call graph for this function:

Field Documentation

ADD_SCAN_PARAMS

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

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

---

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

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