Inheritance diagram for ilVirusScannerICapRemote:

Collaboration diagram for ilVirusScannerICapRemote:

Public Member Functions
	__construct (string $scan_command, string $clean_command)

	options (string $service)

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

	send (string $request)

	getLastSocketError ()

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

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

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

Data Fields
string	$userAgent = 'PHP-CLIENT/0.1.0'

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

Private Member Functions
	connect ()

	disconnect ()

	parseResponse (string $string)

Private Attributes
string	$host

int	$port

	$socket

Additional Inherited Members
Static Public Member Functions inherited from ilVirusScanner
static	virusHandling (string $a_file, string $a_orig_name='', bool $a_clean=true)

Protected Member Functions inherited from ilVirusScanner
	scanFileFromBuffer (string $buffer)

	createBufferFile (string $buffer)

	removeBufferFile (string $bufferFile)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilVirusScanner.

Reimplemented in ilVirusScannerICapRemoteAvClient.

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

    {
        parent::__construct($scan_command, $clean_command);
        $this->host = IL_ICAP_HOST;
        $this->port = (int) IL_ICAP_PORT;
    }

References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\int().

Here is the call graph for this function:

Member Function Documentation

◆ connect()

ilVirusScannerICapRemote::connect ( )

private

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

                              : bool
    {
        $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 133 of file class.ilVirusScannerICapRemote.php.

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

Referenced by send().

Here is the caller graph for this function:

◆ getLastSocketError()

ilVirusScannerICapRemote::getLastSocketError ( )

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

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

Referenced by send().

Here is the caller graph for this function:

◆ getRequest()

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

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

                                                                                                      : string
    {
        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, ilVirusScanner\$type, and $userAgent.

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

Here is the caller graph for this function:

◆ options()

ilVirusScannerICapRemote::options ( string $service )

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

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

References $response, 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 $string )

private

Returns: array<string, array<string, string>>|array<string, string>

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

                                                  : array
    {
        $response = [
            'protocol' => [],
            'headers' => [],
            'body' => [],
            'rawBody' => ''
        ];
        foreach (preg_split('/\r?\n/', $string) as $line) {
            if ([] === $response['protocol']) {
                if (!str_starts_with($line, 'ICAP/')) {
                    throw new RuntimeException('Unknown ICAP response');
                }
                $parts = preg_split('/ +/', $line, 3);
                $response['protocol'] = [
                    'icap' => $parts[0] ?? '',
                    'code' => $parts[1] ?? '',
                    'message' => $parts[2] ?? '',
                ];
                continue;
            }
            if ('' === $line) {
                break;
            }
            $parts = explode(": ", $line, 2);
            if (isset($parts[0])) {
                $response['headers'][$parts[0]] = $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 = explode(", ", $response['headers']['Encapsulated']);
                if (count($params) > 0) {
                    foreach ($params as $param) {
                        $parts = explode("=", $param);
                        if (count($parts) !== 2) {
                            continue;
                        }
                        $encapsulated[$parts[0]] = $parts[1];
                    }
                }
                foreach ($encapsulated as $section => $offset) {
                    $data = substr($body[1], (int) $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, $params, $parts, and $response.

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

Here is the caller graph for this function:

◆ reqMod()

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

Returns: array<string, array<string, string>>|array<string, string>

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

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

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

Here is the call graph for this function:

◆ respMod()

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

Returns: array<string, array<string, string>>|array<string, string>

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

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

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

Here is the call graph for this function:

◆ send()

ilVirusScannerICapRemote::send ( string $request )

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

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