class.ilRpcClient.php

Go to the documentation of this file.

<?php
include_once './Services/WebServices/RPC/classes/class.ilRpcClientException.php';
/* Copyright (c) 1998-2016 ILIAS open source, Extended GPL, see docs/LICENSE */

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

        function __construct ($a_url, $a_prefix = '', $a_timeout = 0, $a_encoding = 'utf-8')
        {
                if(!extension_loaded('xmlrpc'))
                {
                        ilLoggerFactory::getLogger('wsrv')->error('RpcClient Xmlrpc extension not enabled');
                        throw new ilRpcClientException('Xmlrpc extension not enabled.', 50);
                }

                $this->url = (string) $a_url;
                $this->prefix = (string) $a_prefix;
                $this->timeout = (int) $a_timeout;
                $this->encoding = (string) $a_encoding;
        }

        public function __call($a_method, $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
                {
                        include_once './Services/WebServices/Curl/classes/class.ilCurlConnection.php';
                        $curl = new ilCurlConnection($this->url);
                        $curl->init();
                        $curl->setOpt(CURLOPT_HEADER, 'Content-Type: text/xml');
                        $curl->setOpt(CURLOPT_POST, sizeof($post_data));
                        $curl->setOpt(CURLOPT_POSTFIELDS, $post_data);
                        $curl->setOpt(CURLOPT_RETURNTRANSFER , 1);

                        if($this->timeout > 0)
                        {
                                $curl->setOpt(CURLOPT_TIMEOUT, $this->timeout);
                        }
                        ilLoggerFactory::getLogger('wsrv')->info('RpcClient request to ' . $this->url . ' / ' . $method_name);
                        $xml_resp = $curl->exec();
                }
                catch(ilCurlConnectionException $e)
                {
                        ilLoggerFactory::getLogger('wsrv')->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))
                {
                        ilLoggerFactory::getLogger('wsrv')->error('RpcClient recieved error '. $resp['faultCode'] . ': ' . $resp['faultString'] );
                        include_once './Services/WebServices/RPC/classes/class.ilRpcClientException.php';
                        throw new ilRpcClientException('RPC-Server returned fault message: '.$resp['faultString'], $resp['faultCode']);
                }

                return $resp;
        }
}