class.ilRpcClient.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

/* Copyright (c) 1998-2016 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilRpcClient
{
    protected string $url;
    protected string $prefix = '';
    protected int $timeout = 0;
    protected string $encoding = '';

    protected ilLogger $logger;

    public function __construct(string $a_url, string $a_prefix = '', int $a_timeout = 0, string $a_encoding = 'utf-8')
    {
        global $DIC;

        $this->logger = $DIC->logger()->wsrv();

        if (!extension_loaded('xmlrpc')) {
            ilLoggerFactory::getLogger('wsrv')->error('RpcClient Xmlrpc extension not enabled');
            throw new ilRpcClientException('Xmlrpc extension not enabled.', 50);
        }

        $this->url = $a_url;
        $this->prefix = $a_prefix;
        $this->timeout = $a_timeout;
        $this->encoding = $a_encoding;
    }

    public function __call(string $a_method, array $a_params)
    {
        //prepare xml post data
        $method_name = str_replace('_', '.', $this->prefix . $a_method);
        $rpc_options = array(
            'verbosity' => 'newlines_only',
            'escaping' => 'markup'
        );

        if ($this->encoding) {
            $rpc_options['encoding'] = $this->encoding;
        }
        $post_data = xmlrpc_encode_request($method_name, $a_params, $rpc_options);
        //try to connect to the given url
        try {
            $curl = new ilCurlConnection($this->url);
            $curl->init(false);
            $curl->setOpt(CURLOPT_HTTPHEADER, ['Content-Type: text/xml']);
            $curl->setOpt(CURLOPT_POST, (strlen($post_data) > 0));
            $curl->setOpt(CURLOPT_POSTFIELDS, $post_data);
            $curl->setOpt(CURLOPT_RETURNTRANSFER, 1);

            if ($this->timeout > 0) {
                $curl->setOpt(CURLOPT_TIMEOUT, $this->timeout);
            }
            $this->logger->debug('RpcClient request to ' . $this->url . ' / ' . $method_name);
            $xml_resp = $curl->exec();
        } catch (ilCurlConnectionException $e) {
            $this->logger->error(
                'RpcClient could not connect to ' . $this->url . ' ' .
                'Reason ' . $e->getCode() . ': ' . $e->getMessage()
            );
            throw new ilRpcClientException($e->getMessage(), $e->getCode());
        }

        //prepare output, throw exception if rpc fault is detected
        $resp = xmlrpc_decode($xml_resp, $this->encoding);

        //xmlrpc_is_fault can just handle arrays as response
        if (is_array($resp) && xmlrpc_is_fault($resp)) {
            $this->logger->error('RpcClient recieved error ' . $resp['faultCode'] . ': ' . $resp['faultString']);
            throw new ilRpcClientException(
                'RPC-Server returned fault message: ' .
                $resp['faultString'],
                $resp['faultCode']
            );
        }
        return $resp;
    }
}