Interface to the ClamAV virus protector. More...

Inheritance diagram for ilVirusScannerICapRemote:

Collaboration diagram for ilVirusScannerICapRemote:

Public Member Functions
	__construct ($a_scancommand, $a_cleancommand)
	ilVirusScannerICap constructor. More...

	options ($service)

	getRequest ($method, $service, $body=[], $headers=[])

	send ($request)

	getLastSocketError ()
	Get last error code from socket object. More...

	respMod ($service, $body=[], $headers=[])

	reqMod ($service, $body=[], $headers=[])

Public Member Functions inherited from ilVirusScanner
	__construct ($a_scancommand, $a_cleancommand)
	Constructor @access 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 @access public More...

	logCleanResult ()
	write the result of the last clean to the log @access 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
	$userAgent = 'PHP-CLIENT/0.1.0'

Data Fields inherited from ilVirusScanner
	$type

	$scanZipFiles

	$scanCommand

	$cleanCommand

	$scanFilePath

	$scanFileOrigName

	$cleanFilePath

	$cleanFileOrigName

	$scanFileIsInfected

	$cleanFileIsCleaned

	$scanResult

	$cleanResult

	$ilias

	$lng

	$log

Private Member Functions
	connect ()

	disconnect ()

	parseResponse ($string)

Private Attributes
	$host

	$port

	$socket

Additional Inherited Members
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 15 of file class.ilVirusScannerICapRemote.php.

Constructor & Destructor Documentation

◆ __construct()

ilVirusScannerICapRemote::__construct	(	$a_scancommand,
		$a_cleancommand
	)

ilVirusScannerICap constructor.

Parameters

$a_scancommand
$a_cleancommand

Reimplemented from ilVirusScanner.

Reimplemented in ilVirusScannerICapRemoteAvClient.

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

    {
        parent::__construct($a_scancommand, $a_cleancommand);
        $this->host = IL_ICAP_HOST;
        $this->port = IL_ICAP_PORT;
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ connect()

ilVirusScannerICapRemote::connect ( )

private

Returns: bool

Exceptions

ErrorException

Definition at line 135 of file class.ilVirusScannerICapRemote.php.

    {
        $this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
        try{
            if (!socket_connect($this->socket, $this->host, $this->port)) {
                return false;
            }
        } catch(ErrorException $e){
            throw $e;
        }
 
        return true;
    }

References Vendor\Package\$e.

Referenced by send().

Here is the caller graph for this function:

◆ disconnect()

ilVirusScannerICapRemote::disconnect ( )

private

Definition at line 161 of file class.ilVirusScannerICapRemote.php.

    {
        socket_shutdown($this->socket);
        socket_close($this->socket);
    }

Referenced by send().

Here is the caller graph for this function:

◆ getLastSocketError()

ilVirusScannerICapRemote::getLastSocketError ( )

Get last error code from socket object.

Returns: int Socket error code

Definition at line 153 of file class.ilVirusScannerICapRemote.php.

    {
        return socket_last_error($this->socket);
    }

Referenced by send().

Here is the caller graph for this function:

◆ getRequest()

ilVirusScannerICapRemote::getRequest	(	$method,
		$service,
		$body = `[]`,
		$headers = `[]`
	)

Parameters

	$method
	$service
array	$body
array	$headers

Returns: string

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

    {
        if (!array_key_exists('Host', $headers)) {
            $headers['Host'] = $this->host;
        }
        if (!array_key_exists('User-Agent', $headers)) {
            $headers['User-Agent'] = $this->userAgent;
        }
        if (!array_key_exists('Connection', $headers)) {
            $headers['Connection'] = 'close';
        }
        $bodyData     = '';
        $hasBody      = false;
        $encapsulated = [];
        foreach ($body as $type => $data) {
            switch ($type) {
                case 'req-hdr':
                case 'res-hdr':
                    $encapsulated[$type] = strlen($bodyData);
                    $bodyData            .= $data;
                    break;
                case 'req-body':
                case 'res-body':
                    $encapsulated[$type] = strlen($bodyData);
                    $bodyData            .= dechex(strlen($data)) . "\r\n";
                    $bodyData            .= $data;
                    $bodyData            .= "\r\n";
                    $hasBody             = true;
                    break;
            }
        }
        if ($hasBody) {
            $bodyData .= "0\r\n\r\n";
        } elseif (count($encapsulated) > 0) {
            $encapsulated['null-body'] = strlen($bodyData);
        }
        if (count($encapsulated) > 0) {
            $headers['Encapsulated'] = '';
            foreach ($encapsulated as $section => $offset) {
                $headers['Encapsulated'] .= $headers['Encapsulated'] === '' ? '' : ', ';
                $headers['Encapsulated'] .= "{$section}={$offset}";
            }
        }
        $request = "{$method} icap://{$this->host}/{$service} ICAP/1.0\r\n";
        foreach ($headers as $header => $value) {
            $request .= "{$header}: {$value}\r\n";
        }
        $request .= "\r\n";
        $request .= $bodyData;
        return $request;
    }

References $data, $host, $section, ilVirusScanner\$type, and $userAgent.

Referenced by options(), reqMod(), and respMod().

Here is the caller graph for this function:

◆ options()

ilVirusScannerICapRemote::options ( $service )

Parameters

$service

Returns: array

Definition at line 42 of file class.ilVirusScannerICapRemote.php.

    {
        $request  = $this->getRequest('OPTIONS', $service);
        $response = $this->send($request);
        if(strlen($response) > 0) {
            return $this->parseResponse($response);
        }
        return [];
    }

References $response, $service, getRequest(), parseResponse(), and send().

Referenced by ilVirusScannerICapRemoteAvClient\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseResponse()

ilVirusScannerICapRemote::parseResponse ( $string )

private

Parameters

$string

Returns: array

Definition at line 171 of file class.ilVirusScannerICapRemote.php.

    {
        $response = [
            'protocol' => [],
            'headers'  => [],
            'body'     => [],
            'rawBody'  => ''
        ];
        foreach (preg_split('/\r?\n/', $string) as $line) {
            if ([] === $response['protocol']) {
                if (0 !== strpos($line, 'ICAP/')) {
                    throw new RuntimeException('Unknown ICAP response');
                }
                $parts                = preg_split('/ +/', $line, 3);
                $response['protocol'] = [
                    'icap'    => isset($parts[0]) ? $parts[0] : '',
                    'code'    => isset($parts[1]) ? $parts[1] : '',
                    'message' => isset($parts[2]) ? $parts[2] : '',
                ];
                continue;
            }
            if ('' === $line) {
                break;
            }
            $parts = preg_split('/: /', $line, 2);
            if (isset($parts[0])) {
                $response['headers'][$parts[0]] = isset($parts[1]) ? $parts[1] : '';
            }
        }
        $body = preg_split('/\r?\n\r?\n/', $string, 2);
        if (isset($body[1])) {
            $response['rawBody'] = $body[1];
            if (array_key_exists('Encapsulated', $response['headers'])) {
                $encapsulated = [];
                $params       = preg_split('/, /', $response['headers']['Encapsulated']);
                if (count($params) > 0) {
                    foreach ($params as $param) {
                        $parts = preg_split('/=/', $param);
                        if (count($parts) !== 2) {
                            continue;
                        }
                        $encapsulated[$parts[0]] = $parts[1];
                    }
                }
                foreach ($encapsulated as $section => $offset) {
                    $data = substr($body[1], $offset);
                    switch ($section) {
                        case 'req-hdr':
                        case 'res-hdr':
                            $response['body'][$section] = preg_split('/\r?\n\r?\n/', $data, 2)[0];
                            break;
                        case 'req-body':
                        case 'res-body':
                            $parts = preg_split('/\r?\n/', $data, 2);
                            if (count($parts) === 2) {
                                $response['body'][$section] = substr($parts[1], 0, hexdec($parts[0]));
                            }
                            break;
                    }
                }
            }
        }
        return $response;
    }

References $data, $param, $response, and $section.

Referenced by options(), reqMod(), and respMod().

Here is the caller graph for this function:

◆ reqMod()

ilVirusScannerICapRemote::reqMod	(	$service,
		$body = `[]`,
		$headers = `[]`
	)

Parameters

	$service
array	$body
array	$headers

Returns: array

Definition at line 255 of file class.ilVirusScannerICapRemote.php.

    {
        $request  = $this->getRequest('REQMOD', $service, $body, $headers);
        $response = $this->send($request);
        return $this->parseResponse($response);
    }

References $response, $service, getRequest(), parseResponse(), and send().

Here is the call graph for this function:

◆ respMod()

ilVirusScannerICapRemote::respMod	(	$service,
		$body = `[]`,
		$headers = `[]`
	)

Parameters

	$service
array	$body
array	$headers

Returns: array

Definition at line 242 of file class.ilVirusScannerICapRemote.php.

    {
        $request  = $this->getRequest('RESPMOD', $service, $body, $headers);
        $response = $this->send($request);
        return $this->parseResponse($response);
    }

References $response, $service, getRequest(), parseResponse(), and send().

Here is the call graph for this function:

◆ send()

ilVirusScannerICapRemote::send ( $request )

Parameters

$request

Returns: string

Definition at line 115 of file class.ilVirusScannerICapRemote.php.

    {
        $response = '';
        try{
            $this->connect();
            socket_write($this->socket, $request);
            while ($buffer = socket_read($this->socket, 2048)) {
                $response .= $buffer;
            }
            $this->disconnect();
        } catch(ErrorException $e){
            $this->log->warning("Cannot connect to icap://{$this->host}:{$this->port} (Socket error: " . $this->getLastSocketError() . ")");
        }
        return $response;
    }