XML-RPC および XML-RPC サーバクラス¶

クラスの初期化¶

CodeIgniter のほとんどのクラスと同様、XML-RPC および XML-RPCS クラスは、コントローラの中で $this->load->library メソッドを使 って初期化します:

XML-RPC クラスを読み込むには次のようにします:

$this->load->library('xmlrpc');

一旦読み込まれると、xml-rpc ライブラリのオブジェクトは、次のようにして利用できます: $this->xmlrpc

XML-RPC Server クラスを読み込むには次のようにします:

$this->load->library('xmlrpc');
$this->load->library('xmlrpcs');

読み込まれると、xml-rpcs ライブラリのオブジェクトは次のようにして利用できます:: $this->xmlrpcs

XML-RPC リクエストの送信¶

XML-RPC サーバにリクエストを送信するには、次の情報を指定する 必要があります:

• サーバの URL
• 呼び出したいサーバ上のメソッド
• リクエスト データ （後述）

以下は、Ping-o-Matic で、 単純にWeblogs.comにPingを送信する基本的な例です。

$this->load->library('xmlrpc');

$this->xmlrpc->server('http://rpc.pingomatic.com/', 80);
$this->xmlrpc->method('weblogUpdates.ping');

$request = array('My Photoblog', 'http://www.my-site.com/photoblog/');
$this->xmlrpc->request($request);

if ( ! $this->xmlrpc->send_request())
{
        echo $this->xmlrpc->display_error();
}

リクエストの詳細¶

リクエストとは単純に XML-RPC サーバに送信するデータのことです。 リクエストの中の各データはリクエストパラメータとして参照されます。 上の例では、2つのパラメータをもっています: 自分のサイトの URL と タイトルです。XML-RPC サーバがリクエストを受信したとき、必要なパラ メータを探します。

リクエストパラメータは、送信のため、配列に格納する必要があり、 各パラメータは7つのデータ型（文字列、数値、日付 など）のうちのどれか になります。 パラメータが文字列型以外の場合は、データ型をリクエスト の配列に含める必要があります。

下記は、3つのパラメータの単純な配列の例です:

$request = array('John', 'Doe', 'www.some-site.com');
$this->xmlrpc->request($request);

文字列でないデータ型のデータや何種類かの異なるデータ型のデータを 指定するときは、 各パラメータを配列にし、その配列の2番目でデータ 型を指定します:

$request = array(
        array('John', 'string'),
        array('Doe', 'string'),
        array(FALSE, 'boolean'),
        array(12345, 'int')
);
$this->xmlrpc->request($request);

下の`データ型 <#datatypes>`_ のセクションにデータ型の 全リストがあります。

XML-RPC サーバの作成¶

XML-RPC サーバは交通整理役として動作し、送信されてくるリ クエストを待ち受け、 その処理を行う適切なメソッドへリダ イレクトします。

XML-RPC サーバを作成するには、XML-RPC Server クラスを、 送信されてくるリクエストを受け取るコントローラで初期化し、 処理できる適切なクラス/メソッドに送信されてきたリクエスト を送るためにマッピングを指示した配列をセットアップする必 要があります。

次は、説明のための例です:

$this->load->library('xmlrpc');
$this->load->library('xmlrpcs');

$config['functions']['new_post'] = array('function' => 'My_blog.new_entry');
$config['functions']['update_post'] = array('function' => 'My_blog.update_entry');
$config['object'] = $this;

$this->xmlrpcs->initialize($config);
$this->xmlrpcs->serve();

上のサンプルには、サーバが処理できる2つのメソッドが配列に指定されて いる箇所があります。 処理できる公開メソッドは、配列の左側になります。 メソッドのどちらかのリクエストが受信されると、右側で指定したクラスと メソッドにマッピングされます。

‘object’ キーは、インスタンス化されたクラスを渡すための特別なキーです。 これは、あなたがマッピングするメソッドが CodeIgniter スーパーオブジェクト の一部でない場合に必要となります。

言い換えると、XML-RPC クライアントがnew_post メソッドを呼び出すリクエスト を送信した場合、 サーバはMy_blog クラスを読み込み、new_entry メソッドを呼 び出します。 update_post メソッドを呼び出すリクエストを送信した場合は、 サ ーバはMy_blog クラスを読み込み、update_entry メソッドを呼び出します。

The function names in the above example are arbitrary. You’ll decide what they should be called on your server, or if you are using standardized APIs, like the Blogger or MetaWeblog API, you’ll use their function names.

There are two additional configuration keys you may make use of when initializing the server class: debug can be set to TRUE in order to enable debugging, and xss_clean may be set to FALSE to prevent sending data through the Security library’s xss_clean() method.

サーバリクエストの処理¶

When the XML-RPC Server receives a request and loads the class/method for processing, it will pass an object to that method containing the data sent by the client.

Using the above example, if the new_post method is requested, the server will expect a class to exist with this prototype:

class My_blog extends CI_Controller {

        public function new_post($request)
        {

        }
}

The $request variable is an object compiled by the Server, which contains the data sent by the XML-RPC Client. Using this object you will have access to the request parameters enabling you to process the request. When you are done you will send a Response back to the Client.

Below is a real-world example, using the Blogger API. One of the methods in the Blogger API is getUserInfo(). Using this method, an XML-RPC Client can send the Server a username and password, in return the Server sends back information about that particular user (nickname, user ID, email address, etc.). Here is how the processing function might look:

class My_blog extends CI_Controller {

        public function getUserInfo($request)
        {
                $username = 'smitty';
                $password = 'secretsmittypass';

                $this->load->library('xmlrpc');

                $parameters = $request->output_parameters();

                if ($parameters[1] != $username && $parameters[2] != $password)
                {
                        return $this->xmlrpc->send_error_message('100', 'Invalid Access');
                }

                $response = array(
                        array(
                                'nickname'  => array('Smitty', 'string'),
                                'userid'    => array('99', 'string'),
                                'url'       => array('http://yoursite.com', 'string'),
                                'email'     => array('jsmith@yoursite.com', 'string'),
                                'lastname'  => array('Smith', 'string'),
                                'firstname' => array('John', 'string')
                        ),
                         'struct'
                );

                return $this->xmlrpc->send_response($response);
        }
}

レスポンスのフォーマット¶

Similar to Requests, Responses must be formatted as an array. However, unlike requests, a response is an array that contains a single item. This item can be an array with several additional arrays, but there can be only one primary array index. In other words, the basic prototype is this:

$response = array('Response data', 'array');

Responses, however, usually contain multiple pieces of information. In order to accomplish this we must put the response into its own array so that the primary array continues to contain a single piece of data. Here’s an example showing how this might be accomplished:

$response = array(
        array(
                'first_name' => array('John', 'string'),
                'last_name' => array('Doe', 'string'),
                'member_id' => array(123435, 'int'),
                'todo_list' => array(array('clean house', 'call mom', 'water plants'), 'array'),
        ),
        'struct'
);

Notice that the above array is formatted as a struct. This is the most common data type for responses.

As with Requests, a response can be one of the seven data types listed in the Data Types section.

エラー応答の送信¶

If you need to send the client an error response you will use the following:

return $this->xmlrpc->send_error_message('123', 'Requested data not available');

The first parameter is the error number while the second parameter is the error message.

独自のクライアントとサーバの作成¶

To help you understand everything we’ve covered thus far, let’s create a couple controllers that act as XML-RPC Client and Server. You’ll use the Client to send a request to the Server and receive a response.

<?php

class Xmlrpc_client extends CI_Controller {

        public function index()
        {
                $this->load->helper('url');
                $server_url = site_url('xmlrpc_server');

                $this->load->library('xmlrpc');

                $this->xmlrpc->server($server_url, 80);
                $this->xmlrpc->method('Greetings');

                $request = array('How is it going?');
                $this->xmlrpc->request($request);

                if ( ! $this->xmlrpc->send_request())
                {
                        echo $this->xmlrpc->display_error();
                }
                else
                {
                        echo '<pre>';
                        print_r($this->xmlrpc->display_response());
                        echo '</pre>';
                }
        }
}
?>

<?php

class Xmlrpc_server extends CI_Controller {

        public function index()
        {
                $this->load->library('xmlrpc');
                $this->load->library('xmlrpcs');

                $config['functions']['Greetings'] = array('function' => 'Xmlrpc_server.process');

                $this->xmlrpcs->initialize($config);
                $this->xmlrpcs->serve();
        }


        public function process($request)
        {
                $parameters = $request->output_parameters();

                $response = array(
                        array(
                                'you_said'  => $parameters[0],
                                'i_respond' => 'Not bad at all.'
                        ),
                        'struct'
                );

                return $this->xmlrpc->send_response($response);
        }
}

example.com/index.php/xmlrpc_client/

リクエストパラメータに連想配列を使用する¶

If you wish to use an associative array in your method parameters you will need to use a struct datatype:

$request = array(
        array(
                // Param 0
                array('name' => 'John'),
                'struct'
        ),
        array(
                // Param 1
                array(
                        'size' => 'large',
                        'shape'=>'round'
                ),
                'struct'
        )
);

$this->xmlrpc->request($request);

You can retrieve the associative array when processing the request in the Server.

$parameters = $request->output_parameters();
$name = $parameters[0]['name'];
$size = $parameters[1]['size'];
$shape = $parameters[1]['shape'];

データ型¶

According to the XML-RPC spec there are seven types of values that you can send via XML-RPC:

• int or i4
• boolean
• string
• double
• dateTime.iso8601
• base64
• struct (contains array of values)
• array (contains array of values)