Inheritance diagram for ilVirusScanner:

Collaboration diagram for ilVirusScanner:

Public Member Functions
	__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 ()

Static Public Member Functions
static	virusHandling (string $a_file, string $a_orig_name='', bool $a_clean=true)

Data Fields
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

Protected Member Functions
	scanFileFromBuffer (string $buffer)

	createBufferFile (string $buffer)

	removeBufferFile (string $bufferFile)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, $error, $lng, $log, and ILIAS\Repository\lng().

     {
         global $DIC;
         $error = $DIC['ilErr'];
         $lng = $DIC->language();
         $log = $DIC->logger()->root();
 
         $this->error = $error;
         $this->lng = $lng;
         $this->log = $log;
         $this->scanCommand = $scan_command;
         $this->cleanCommand = $clean_command;
 
         $this->type = 'simulate';
         $this->scanZipFiles = false;
     }

Here is the call graph for this function:

Member Function Documentation

◆ cleanFile()

ilVirusScanner::cleanFile	(	string	$file_path,
		string	$org_name = `''`
	)

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

References $cleanResult, and logCleanResult().

                                                                        : string
     {
         $this->cleanFilePath = $file_path;
         $this->cleanFileOrigName = $org_name;
 
         if ($org_name === 'cleanable.txt') {
             $this->cleanFileIsCleaned = true;
             $this->cleanResult =
                 'FILE CLEANED: [' . $file_path . '] (VIRUS: simulated)';
             $this->logCleanResult();
             return $this->cleanResult;
         }
 
         $this->cleanFileIsCleaned = false;
         $this->cleanResult =
             'FILE NOT CLEANED: [' . $file_path . '] (VIRUS: simulated)';
         $this->logCleanResult();
         return '';
     }

Here is the call graph for this function:

◆ createBufferFile()

ilVirusScanner::createBufferFile ( string $buffer )

protected

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

References ilFileUtils\ilTempnam().

Referenced by scanFileFromBuffer().

                                                        : string
     {
         $bufferFile = ilFileUtils::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 ( )

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

References $cleanFileIsCleaned.

                                  : bool
     {
         return $this->cleanFileIsCleaned;
     }

◆ getCleanMessage()

ilVirusScanner::getCleanMessage ( )

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

References $cleanFileOrigName, and ILIAS\Repository\lng().

                                      : string
     {
         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;
     }

Here is the call graph for this function:

◆ getCleanResult()

ilVirusScanner::getCleanResult ( )

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

References $cleanResult.

                                     : string
     {
         return $this->cleanResult;
     }

◆ getScanMessage()

ilVirusScanner::getScanMessage ( )

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

References $scanFileOrigName, and ILIAS\Repository\lng().

                                     : string
     {
         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;
     }

Here is the call graph for this function:

◆ getScanResult()

ilVirusScanner::getScanResult ( )

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

References $scanResult.

                                    : string
     {
         return $this->scanResult;
     }

◆ getScanZipFiles()

ilVirusScanner::getScanZipFiles ( )

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

References $scanZipFiles.

                                      : bool
     {
         return $this->scanZipFiles;
     }

◆ logCleanResult()

ilVirusScanner::logCleanResult ( )

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

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

                                     : void
     {
         $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 ( )

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

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

                                    : void
     {
         $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 ( string $bufferFile )

protected

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

Referenced by scanFileFromBuffer().

                                                            : void
     {
         unlink($bufferFile);
     }

Here is the caller graph for this function:

◆ scanBuffer()

ilVirusScanner::scanBuffer ( string $buffer )

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

References scanFileFromBuffer().

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

Here is the call graph for this function:

◆ scanFile()

ilVirusScanner::scanFile	(	string	$file_path,
		string	$org_name = `''`
	)

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

References $scanResult, and logScanResult().

Referenced by scanFileFromBuffer().

                                                                       : string
     {
         $this->scanFilePath = $file_path;
         $this->scanFileOrigName = $org_name;
 
         if ($org_name === 'infected.txt' || $org_name === 'cleanable.txt') {
             $this->scanFileIsInfected = true;
             $this->scanResult =
                 'FILE INFECTED: [' . $file_path . '] (VIRUS: simulated)';
             $this->logScanResult();
             return $this->scanResult;
         }
 
         $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 ( string $buffer )

protected

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

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

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

                                                          : bool
     {
         $bufferFile = $this->createBufferFile($buffer);
         $infection = $this->scanFile($bufferFile);
         $this->removeBufferFile($bufferFile);
         return $infection !== '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ virusHandling()

static ilVirusScanner::virusHandling	(	string	$a_file,
		string	$a_orig_name = `''`,
		bool	$a_clean = `true`
	)

static

Returns: array{0: bool, 1: string}

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

References $DIC, ilVirusScannerFactory\_getInstance(), and ilLanguage\txt().

Referenced by ilUploadFiles\_copyUploadFile(), ilMultipleChoiceWizardInputGUI\checkInput(), ilFileWizardInputGUI\checkInput(), ilFileInputGUI\checkInput(), ilMatchingWizardInputGUI\checkInput(), ilImagemapFileInputGUI\checkInput(), ilSingleChoiceWizardInputGUI\checkInput(), ilKprimChoiceWizardInputGUI\checkUploads(), ilMultipleImagesInputGUI\onCheckInput(), and ilExSubmission\processZipFile().

                                                                                                         : array
     {
         global $DIC;
 
         $lng = $DIC->language();
 
         if ((defined('IL_VIRUS_SCANNER') && IL_VIRUS_SCANNER !== 'None') || (defined(
             'IL_ICAP_HOST'
         ) && IL_ICAP_HOST !== '')) {
             $vs = ilVirusScannerFactory::_getInstance();
             if (($vs_txt = $vs->scanFile($a_file, $a_orig_name)) !== '') {
                 if ($a_clean && defined('IL_VIRUS_CLEAN_COMMAND') && IL_VIRUS_CLEAN_COMMAND !== '') {
                     $clean_txt = $vs->cleanFile($a_file, $a_orig_name);
                     if ($vs->fileCleaned()) {
                         $vs_txt .= '<br />' . $lng->txt('cleaned_file') . '<br />' . $clean_txt;
                         $vs_txt .= '<br />' . $lng->txt('repeat_scan');
                         if (($vs2_txt = $vs->scanFile($a_file, $a_orig_name)) !== '') {
                             return [
                                 false,
                                 nl2br($vs_txt) . '<br />' . $lng->txt('repeat_scan_failed') . '<br />' . nl2br($vs2_txt)
                             ];
                         }
 
                         return [true, nl2br($vs_txt) . '<br />' . $lng->txt('repeat_scan_succeded')];
                     }
 
                     return [false, nl2br($vs_txt) . '<br />' . $lng->txt('cleaning_failed')];
                 }
 
                 return [false, nl2br($vs_txt)];
             }
         }
 
         return [true, ''];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $cleanCommand

string ilVirusScanner::$cleanCommand

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

◆ $cleanFileIsCleaned

bool ilVirusScanner::$cleanFileIsCleaned

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

Referenced by fileCleaned().

◆ $cleanFileOrigName

string ilVirusScanner::$cleanFileOrigName

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

Referenced by getCleanMessage().

◆ $cleanFilePath

string ilVirusScanner::$cleanFilePath

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

◆ $cleanResult

string ilVirusScanner::$cleanResult

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

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

◆ $error

ilErrorHandling ilVirusScanner::$error

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

Referenced by __construct().

◆ $lng

ilLanguage ilVirusScanner::$lng

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

Referenced by __construct().

◆ $log

ilLogger ilVirusScanner::$log

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

Referenced by __construct().

◆ $scanCommand

string ilVirusScanner::$scanCommand

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

◆ $scanFileIsInfected

bool ilVirusScanner::$scanFileIsInfected

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

◆ $scanFileOrigName

string ilVirusScanner::$scanFileOrigName

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

Referenced by getScanMessage().

◆ $scanFilePath

string ilVirusScanner::$scanFilePath

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

◆ $scanResult

string ilVirusScanner::$scanResult

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

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

◆ $scanZipFiles

bool ilVirusScanner::$scanZipFiles

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

Referenced by getScanZipFiles().

◆ $type

string ilVirusScanner::$type

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

Referenced by ilVirusScannerICapRemote\getRequest().

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

components/ILIAS/VirusScanner/classes/class.ilVirusScanner.php

Public Member Functions

Static 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()

◆ virusHandling()

Field Documentation

◆ $cleanCommand

◆ $cleanFileIsCleaned

◆ $cleanFileOrigName

◆ $cleanFilePath

◆ $cleanResult

◆ $error

◆ $lng

◆ $log

◆ $scanCommand

◆ $scanFileIsInfected

◆ $scanFileOrigName

◆ $scanFilePath

◆ $scanResult

◆ $scanZipFiles

◆ $type