Base class for the interface to an external virus scanner This class is abstract and needs to be extended for actual scanners Only scanFile() and cleanFile() need to be redefined Child Constructors should call ilVirusScanner() Scan and Clean are independent and may work on different files Logging and message generation are generic. More...

Inheritance diagram for ilVirusScanner:

Collaboration diagram for ilVirusScanner:

Public Member Functions
	__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
	$type

	$scanZipFiles

	$scanCommand

	$cleanCommand

	$scanFilePath

	$scanFileOrigName

	$cleanFilePath

	$cleanFileOrigName

	$scanFileIsInfected

	$cleanFileIsCleaned

	$scanResult

	$cleanResult

	$ilias

	$lng

	$log

Protected Member Functions
	scanFileFromBuffer ($buffer)

	createBufferFile ($buffer)

	removeBufferFile ($bufferFile)

Detailed Description

Base class for the interface to an external virus scanner This class is abstract and needs to be extended for actual scanners Only scanFile() and cleanFile() need to be redefined Child Constructors should call ilVirusScanner() Scan and Clean are independent and may work on different files Logging and message generation are generic.

Author: Fred Neumann fred..nosp@m.neum.nosp@m.ann@f.nosp@m.im.u.nosp@m.ni-er.nosp@m.lang.nosp@m.en.de

Version: $Id$

Definition at line 14 of file class.ilVirusScanner.php.

Constructor & Destructor Documentation

◆ __construct()

ilVirusScanner::__construct	(	$a_scancommand,
		$a_cleancommand
	)

Constructor public.

Definition at line 127 of file class.ilVirusScanner.php.

References $DIC, $ilias, $lng, and $log.

     {
         global $DIC;
         $ilias = $DIC['ilias'];
         $lng = $DIC['lng'];
         $log = $DIC['log'];
 
         $this->ilias = $ilias;
         $this->lng = $lng;
         $this->log = $log;
         $this->scanCommand = $a_scancommand;
         $this->cleanCommand = $a_cleancommand;
 
         $this->type = "simulate";
         $this->scanZipFiles = false;
     }

Member Function Documentation

◆ cleanFile()

ilVirusScanner::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

Parameters

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

Returns: string clean message (empty if not cleaned) public

Definition at line 233 of file class.ilVirusScanner.php.

References $cleanResult, and logCleanResult().

     {
         // This function needs to be redefined in child classes
         // It should:
         // - call the external cleaner
         // - set cleanFilePath to a_filepath
         // - set cleanFileOrigName to a_origname
         // - set cleanFileIsCleaned according the clean result
         // - set cleanResult to the cleaner output message
         // - call logCleanResult in any case
         // - return the output message, if file is cleaned
         // - return an empty string, if file is not cleaned
 
         $this->cleanFilePath = $a_filepath;
         $this->cleanFileOrigName = $a_origname;
 
         if ($a_origname == "cleanable.txt") {
             $this->cleanFileIsCleaned = true;
             $this->cleanResult =
                 "FILE CLEANED: [" . $a_filepath . "] (VIRUS: simulated)";
             $this->logCleanResult();
             return $this->cleanResult;
         } else {
             $this->cleanFileIsCleaned = false;
             $this->cleanResult =
                 "FILE NOT CLEANED: [" . $a_filepath . "] (VIRUS: simulated)";
             $this->logCleanResult();
             return "";
         }
     }

Here is the call graph for this function:

◆ createBufferFile()

ilVirusScanner::createBufferFile ( $buffer )

protected

Parameters

string $buffer (any data, binary)

Returns: string $bufferFile

Definition at line 169 of file class.ilVirusScanner.php.

References ilUtil\ilTempnam().

Referenced by scanFileFromBuffer().

     {
         $bufferFile = ilUtil::ilTempnam();
         file_put_contents($bufferFile, $buffer);
         return $bufferFile;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fileCleaned()

ilVirusScanner::fileCleaned ( )

returns wether file has been cleaned successfully or not

Returns: boolean true, if last clean operation has been successful

Definition at line 268 of file class.ilVirusScanner.php.

References $cleanFileIsCleaned.

     {
         return $this->cleanFileIsCleaned;
     }

◆ getCleanMessage()

ilVirusScanner::getCleanMessage ( )

get a located message with the result from the last clean

Returns: string public

Definition at line 353 of file class.ilVirusScanner.php.

References $cleanFileOrigName, and $ret.

     {
         if ($this->cleanFileIsCleaned) {
             $ret = sprintf($this->lng->txt("virus_cleaned"), $this->cleanFileOrigName);
         } else {
             $ret = sprintf($this->lng->txt("virus_not_cleaned"), $this->cleanFileOrigName);
         }
 
         if ($this->cleanResult) {
             $ret .= " " . $this->lng->txt("virus_clean_message")
                 . "<br />"
                 . str_replace(
                     $this->cleanFilePath,
                     $this->cleanFileOrigName,
                     nl2br($this->cleanResult)
                 );
         }
         return $ret;
     }

◆ getCleanResult()

ilVirusScanner::getCleanResult ( )

get the pure output of the external scan

Returns: string public

Definition at line 318 of file class.ilVirusScanner.php.

References $cleanResult.

     {
         return $this->cleanResult;
     }

◆ getScanMessage()

ilVirusScanner::getScanMessage ( )

get a located message with the result from the last scan

Returns: string public

Definition at line 328 of file class.ilVirusScanner.php.

References $ret, and $scanFileOrigName.

     {
         if ($this->scanFileIsInfected) {
             $ret = sprintf($this->lng->txt("virus_infected"), $this->scanFileOrigName);
         } else {
             $ret = sprintf($this->lng->txt("virus_not_infected"), $this->scanFileOrigName);
         }
 
         if ($this->scanResult) {
             $ret .= " " . $this->lng->txt("virus_scan_message")
                 . "<br />"
                 . str_replace(
                     $this->scanFilePath,
                     $this->scanFileOrigName,
                     nl2br($this->scanResult)
                 );
         }
         return $ret;
     }

◆ getScanResult()

ilVirusScanner::getScanResult ( )

get the pure output of the external scan

Returns: string public

Definition at line 308 of file class.ilVirusScanner.php.

References $scanResult.

     {
         return $this->scanResult;
     }

◆ getScanZipFiles()

ilVirusScanner::getScanZipFiles ( )

get info if class can scan ZIP files

Returns: boolean public

Definition at line 378 of file class.ilVirusScanner.php.

References $scanZipFiles.

     {
         return $this->scanZipFiles;
     }

◆ logCleanResult()

ilVirusScanner::logCleanResult ( )

write the result of the last clean to the log public

Definition at line 292 of file class.ilVirusScanner.php.

Referenced by ilVirusScannerSophos\cleanFile(), and cleanFile().

     {
         $mess = "Virus Cleaner (" . $this->type . ")";
         if ($this->cleanFileOrigName) {
             $mess .= " (File " . $this->cleanFileOrigName . ")";
         }
         $mess .= ": " . preg_replace('/[\r\n]+/', "; ", $this->cleanResult);
 
         $this->log->write($mess);
     }

Here is the caller graph for this function:

◆ logScanResult()

ilVirusScanner::logScanResult ( )

write the result of the last scan to the log public

Definition at line 277 of file class.ilVirusScanner.php.

Referenced by ilVirusScannerAntiVir\scanFile(), ilVirusScannerSophos\scanFile(), ilVirusScannerClamAV\scanFile(), and scanFile().

     {
         $mess = "Virus Scanner (" . $this->type . ")";
         if ($this->scanFileOrigName) {
             $mess .= " (File " . $this->scanFileOrigName . ")";
         }
         $mess .= ": " . preg_replace('/[\r\n]+/', "; ", $this->scanResult);
 
         $this->log->write($mess);
     }

Here is the caller graph for this function:

◆ removeBufferFile()

ilVirusScanner::removeBufferFile ( $bufferFile )

protected

Parameters

string $bufferFile

Definition at line 179 of file class.ilVirusScanner.php.

Referenced by scanFileFromBuffer().

     {
         unlink($bufferFile);
     }

Here is the caller graph for this function:

◆ scanBuffer()

ilVirusScanner::scanBuffer ( $buffer )

Parameters

string $buffer (any data, binary)

Returns: bool $infected

Definition at line 148 of file class.ilVirusScanner.php.

References scanFileFromBuffer().

     {
         return $this->scanFileFromBuffer($buffer);
     }

Here is the call graph for this function:

◆ scanFile()

ilVirusScanner::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

Parameters

string	path of file to scan
string	original name of the file to scan

Returns: string virus message (empty if not infected) public

Definition at line 194 of file class.ilVirusScanner.php.

References $scanResult, and logScanResult().

Referenced by scanFileFromBuffer().

     {
         // This function needs to be redefined in child classes.
         // It 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 output message, if file is infected
         // - return an empty string, if file is not infected
 
         $this->scanFilePath = $a_filepath;
         $this->scanFileOrigName = $a_origname;
 
         if ($a_origname == "infected.txt" or $a_origname == "cleanable.txt") {
             $this->scanFileIsInfected = true;
             $this->scanResult =
                 "FILE INFECTED: [" . $a_filepath . "] (VIRUS: simulated)";
             $this->logScanResult();
             return $this->scanResult;
         } else {
             $this->scanFileIsInfected = false;
             $this->scanResult = "";
             return "";
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ scanFileFromBuffer()

ilVirusScanner::scanFileFromBuffer ( $buffer )

protected

Parameters

string $buffer (any data, binary)

Returns: bool $infected

Definition at line 157 of file class.ilVirusScanner.php.

References createBufferFile(), removeBufferFile(), and scanFile().

Referenced by ilVirusScannerClamAV\scanBuffer(), and scanBuffer().

     {
         $bufferFile = $this->createBufferFile($buffer);
         $isInfected = $this->scanFile($bufferFile);
         $this->removeBufferFile($bufferFile);
         return $isInfected;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $cleanCommand

ilVirusScanner::$cleanCommand

Definition at line 44 of file class.ilVirusScanner.php.

◆ $cleanFileIsCleaned

ilVirusScanner::$cleanFileIsCleaned

Definition at line 86 of file class.ilVirusScanner.php.

Referenced by fileCleaned().

◆ $cleanFileOrigName

ilVirusScanner::$cleanFileOrigName

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

Referenced by getCleanMessage().

◆ $cleanFilePath

ilVirusScanner::$cleanFilePath

Definition at line 65 of file class.ilVirusScanner.php.

◆ $cleanResult

ilVirusScanner::$cleanResult

Definition at line 100 of file class.ilVirusScanner.php.

Referenced by ilVirusScannerSophos\cleanFile(), cleanFile(), and getCleanResult().

◆ $ilias

ilVirusScanner::$ilias

Definition at line 107 of file class.ilVirusScanner.php.

Referenced by __construct().

◆ $lng

ilVirusScanner::$lng

Definition at line 114 of file class.ilVirusScanner.php.

Referenced by __construct().

◆ $log

ilVirusScanner::$log

Definition at line 121 of file class.ilVirusScanner.php.

Referenced by __construct().

◆ $scanCommand

ilVirusScanner::$scanCommand

Definition at line 37 of file class.ilVirusScanner.php.

◆ $scanFileIsInfected

ilVirusScanner::$scanFileIsInfected

Definition at line 79 of file class.ilVirusScanner.php.

◆ $scanFileOrigName

ilVirusScanner::$scanFileOrigName

Definition at line 58 of file class.ilVirusScanner.php.

Referenced by getScanMessage().

◆ $scanFilePath

ilVirusScanner::$scanFilePath

Definition at line 51 of file class.ilVirusScanner.php.

◆ $scanResult

ilVirusScanner::$scanResult

Definition at line 93 of file class.ilVirusScanner.php.

Referenced by getScanResult(), ilVirusScannerSophos\scanFile(), ilVirusScannerAntiVir\scanFile(), ilVirusScannerClamAV\scanFile(), and scanFile().

◆ $scanZipFiles

ilVirusScanner::$scanZipFiles

Definition at line 30 of file class.ilVirusScanner.php.

Referenced by getScanZipFiles().

◆ $type

ilVirusScanner::$type

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

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

Services/VirusScanner/classes/class.ilVirusScanner.php

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cleanFile()

◆ createBufferFile()

◆ fileCleaned()

◆ getCleanMessage()

◆ getCleanResult()

◆ getScanMessage()

◆ getScanResult()

◆ getScanZipFiles()

◆ logCleanResult()

◆ logScanResult()

◆ removeBufferFile()

◆ scanBuffer()

◆ scanFile()

◆ scanFileFromBuffer()

Field Documentation

◆ $cleanCommand

◆ $cleanFileIsCleaned

◆ $cleanFileOrigName

◆ $cleanFilePath

◆ $cleanResult

◆ $ilias

◆ $lng

◆ $log

◆ $scanCommand

◆ $scanFileIsInfected

◆ $scanFileOrigName

◆ $scanFilePath

◆ $scanResult

◆ $scanZipFiles

◆ $type