Services/WebServices/RPC/classes/class.ilRPCServerAdapter.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/


define("RPC_TIMEOUT",0);

include_once('Services/WebServices/RPC/classes/class.ilRPCServerSettings.php');

class ilRPCServerAdapter
{
        var $response_timeout = RPC_TIMEOUT;
        var $log = null;
        var $db = null;
        var $err = null;

        var $settings_obj  = null;

        var $rpc_client = null;
        var $rpc_message = null;

        function ilRPCServerAdapter()
        {
                global $ilLog,$ilDB,$ilError;

                $this->log =& $ilLog;
                $this->db =& $ilDB;
                $this->err =& $ilError;

                $this->__checkPear();

                $this->settings_obj =& new ilRPCServerSettings();
        }
        
        function setResponseTimeout($a_response_timeout)
        {
                $this->response_timeout = $a_response_timeout;
        }

        function &send()
        {
                include_once 'XML/RPC.php';
                if(!$response =& $this->rpc_client->send($this->rpc_message,$this->response_timeout))
                {
                        $this->log->write("ilRPCServerAdapter: Communication error");
                        return null;
                }
                if($response->faultCode())
                {
                        $this->log->write("ilRPCServerAdapter: Communication error: ". $response->faultString());
                        return null;
                }
                return XML_RPC_decode($response->value());
        }
        // PRIVATE
        function __checkPear()
        {
                if(!include_once('XML/RPC.php'))
                {
                        $this->log->write('ilLuceneRPCAdapter(): Cannot find pear library XML_RPC. Aborting');
                        $this->err->raiseError("Cannot find pear package 'XML_RPC'. Aborting ",$this->err->MESSAGE);
                }
                return true;
        }

        function __initClient()
        {
                include_once 'XML/RPC.php';

                $this->rpc_client =& new XML_RPC_Client($this->settings_obj->getPath(),
                                                                                                $this->settings_obj->getHost(),
                                                                                                $this->settings_obj->getPort());
                #$this->rpc_client->setDebug(1);

                return true;
        }


        function __initMessage($a_message_name,$params)
        {
                include_once 'XML/RPC.php';
                
                $this->rpc_message =& new XML_RPC_Message($a_message_name,$params);
                
                // We create the payload here since it might be quite time consuming 
                // and this could cause a socket read exception on the server side.
                $this->rpc_message->createPayload();

                return true;
        }
}
?>