ilVirusScannerSophos Class Reference

Inheritance diagram for ilVirusScannerSophos:

Collaboration diagram for ilVirusScannerSophos:

Public Member Functions
	__construct (string $scan_command, string $clean_command)
	scanFile (string $file_path, string $org_name='')
	cleanFile (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 ()

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
Protected Member Functions inherited from ilVirusScanner
	scanFileFromBuffer (string $buffer)
	createBufferFile (string $buffer)
	removeBufferFile (string $bufferFile)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

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

References ILIAS\GlobalScreen\Provider\__construct().

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

Here is the call graph for this function:

Member Function Documentation

cleanFile()

ilVirusScannerSophos::cleanFile	(	string	$file_path,
		string	$org_name = ''
	)

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

References ilVirusScanner\$cleanResult, $out, and ilVirusScanner\logCleanResult().

                                                                       : string
    {
        $this->cleanFilePath = $file_path;
        $this->cleanFileOrigName = $org_name;

        // Call of sweep from Sophos (www.sophos.com)
        // -di: Disinfect infected items
        // -nc: Don't ask for confirmation before disinfection/deletion
        // -ss: Don't display anything except on error or virus
        // -eec: Use extended error codes
        // -archive: sweep inside archives

        $cmd = $this->cleanCommand . ' -di -nc -ss -eec -archive ' . $file_path . ' 2>&1';
        exec($cmd, $out, $ret);
        $this->cleanResult = implode("\n", $out) . ' [' . $ret . ']';

        // always log the result from a clean attempt
        $this->logCleanResult();

        // Extended error codes from sweep:
        // 0      If no errors are encountered and no viruses are found.
        // 8      If survivable errors have occurred.
        // 12     If compressed files have been found and decompressed.
        // 16     If compressed files have been found and not decompressed.
        // 20     If viruses have been found and disinfected.
        // 24     If viruses have been found and not disinfected.
        // 28     If viruses have been found in memory.
        // 32     If there has been an integrity check failure.
        // 36     If unsurvivable errors have occurred.
        // 40     If execution has been interrupted.
        if ((int) $ret === 20) {
            $this->cleanFileIsCleaned = true;
            return $this->cleanResult;
        }

        $this->cleanFileIsCleaned = false;
        return '';
    }

Here is the call graph for this function:

scanFile()

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

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

References $out, ilVirusScanner\$scanResult, ilShellUtil\escapeShellArg(), ilShellUtil\escapeShellCmd(), ILIAS\Repository\lng(), and ilVirusScanner\logScanResult().

                                                                      : string
    {
        $this->scanFilePath = $file_path;
        $this->scanFileOrigName = $org_name;

        // Call of scan_file from Sophie (www.vanja.com/tools/sophie)
        // sophie must run as a process
        $a_filepath = realpath($file_path);
        $cmd = ilShellUtil::escapeShellCmd($this->scanCommand);
        $args = ilShellUtil::escapeShellArg(' ' . $a_filepath . ' ');
        $cmd .= ' ' . $args . ' 2>&1';
        exec($cmd, $out, $ret);
        $this->scanResult = implode("\n", $out);

        // sophie could be called
        if ((int) $ret === 0) {
            if (preg_match('/FILE INFECTED/', $this->scanResult)) {
                $this->scanFileIsInfected = true;
                $this->logScanResult();
                return $this->scanResult;
            }

            $this->scanFileIsInfected = false;
            return '';
        }

        // sophie has failed (probably the daemon doesn't run)
        $this->log->write(
            'ERROR (Virus Scanner failed): '
            . $this->scanResult
            . '; COMMAMD=' . $cmd
        );

        // try fallback: scan by cleaner command (sweep)
        // -ss: Don't display anything except on error or virus
        // -archive: sweep inside archives
        unset($out, $ret);
        $cmd = $this->cleanCommand . ' -ss -archive ' . $file_path . ' 2>&1';
        exec($cmd, $out, $ret);
        $this->scanResult = implode("\n", $out) . ' [' . $ret . ']';

        //  error codes from sweep:
        // 0  If no errors are encountered and no viruses are found.
        // 1  If  the user interrupts SWEEP (usually by pressing control-C) or kills the process.
        // 2  If some error preventing further execution is discovered.
        // 3  If viruses or virus fragments are discovered.
        if ((int) $ret === 0) {
            $this->cleanFileIsCleaned = false;
            return '';
        } elseif ((int) $ret === 3) {
            $this->scanFileIsInfected = true;
            $this->logScanResult();
            return $this->scanResult;
        }

        $this->error->raiseError(
            $this->lng->txt('virus_scan_error') . ' '
            . $this->lng->txt('virus_scan_message') . ' '
            . $this->scanResult,
            $this->error->WARNING
        );
    }

Here is the call graph for this function:

---

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

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