class.ilVirusScanner.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilVirusScanner
{
    public $type;

    public $scanZipFiles;

    public $scanCommand;

    public $cleanCommand;

    public $scanFilePath;

    public $scanFileOrigName;

    public $cleanFilePath;

    public $cleanFileOrigName;

    public $scanFileIsInfected;

    public $cleanFileIsCleaned;

    public $scanResult;

    public $cleanResult;

    public $ilias;

    public $lng;

    public $log;

    public function __construct($a_scancommand, $a_cleancommand)
    {
        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;
    }
    
    public function scanBuffer($buffer)
    {
        return $this->scanFileFromBuffer($buffer);
    }
    
    protected function scanFileFromBuffer($buffer)
    {
        $bufferFile = $this->createBufferFile($buffer);
        $isInfected = $this->scanFile($bufferFile);
        $this->removeBufferFile($bufferFile);
        return $isInfected;
    }
    
    protected function createBufferFile($buffer)
    {
        $bufferFile = ilUtil::ilTempnam();
        file_put_contents($bufferFile, $buffer);
        return $bufferFile;
    }
    
    protected function removeBufferFile($bufferFile)
    {
        unlink($bufferFile);
    }
    
    public function scanFile($a_filepath, $a_origname = "")
    {
        // 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 "";
        }
    }

    public function cleanFile($a_filepath, $a_origname = "")
    {
        // 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 "";
        }
    }

    public function fileCleaned()
    {
        return $this->cleanFileIsCleaned;
    }

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

        $this->log->write($mess);
    }

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

        $this->log->write($mess);
    }

    public function getScanResult()
    {
        return $this->scanResult;
    }

    public function getCleanResult()
    {
        return $this->cleanResult;
    }

    public function getScanMessage()
    {
        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;
    }

    public function getCleanMessage()
    {
        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;
    }

    public function getScanZipFiles()
    {
        return $this->scanZipFiles;
    }
}