巨好用的 xmlrpc-epi PHP 封装类

原创作品,转载请注明出处。

在 PHP 中本身带有一个用 C 语言实现的 xmlrpc 扩展,叫 xmlrpc-epi。因为它是用 C 语言实现的,所以从速度上来说比用 PHP 实现的那些 xmlrpc 扩展要快的多。但是在实际应用中却发现很少有人用这个扩展,大都是用 PHP 脚本实现的 xmlrpc 的扩展。原因可能有以下两点:一是这个扩展需要在服务器上打开,如果没有服务器操作权限,使用这个扩展就不现实了。第二个原因就是这个扩展在 PHP 手册中的说明太少了,而且提供的函数都很基础,要使用的话就很麻烦了。针对第二个问题,我对这个扩展进行了封装,将它封装成了3个 类:xmlrpc_error、xmlrpc_client 和 xmlrpc_server。当然最主要的是后两个类,即 xmlrpc_client 和 xmlrpc_server。这两个类大大简化了创建 xmlrpc 客户端和服务器的步骤。

2006年1月11日 更新

修正了某些非标准端口的服务器上指定相对路径进行调用的错误。

2006年1月6日 更新

增加了对 PHP5 的支持。

大家可以通过下面的实例来看一下现在创建 xmlrpc 服务器和客户端的步骤有多么简单。

服务器端代码

server.php
  1. <?php
  2. require_once('class_xmlrpc.php');
  3.  
  4. function Add($method, $params) {
  5.     return $params[0] + $params[1];
  6. }
  7. function Sub($method, $params) {
  8.     return $params[0] - $params[1];
  9. }
  10. function Mul($method, $params) {
  11.     return $params[0] * $params[1];
  12. }
  13. function Div($method, $params) {
  14.     return $params[0] / $params[1];
  15. }
  16.  
  17. $xmlrpc_server = new xmlrpc_server();
  18. $xmlrpc_server->register_method("Math.add", "Add");
  19. $xmlrpc_server->register_method("Math.sub", "Sub");
  20. $xmlrpc_server->register_method("Math.Mul", "Mul");
  21. $xmlrpc_server->register_method("Math.Div", "Div");
  22. $xmlrpc_server->call_method();
  23. ?>

客户端代码

client.php
  1. <?php
  2. require_once('class_xmlrpc.php');
  3.  
  4. $xmlrpc_client = new xmlrpc_client('server.php', 'Math');
  5. $a = 100;
  6. $b = 20;
  7. echo "\$a = $a; \$b = $b <br />";
  8. echo '$a + $b = ' . $xmlrpc_client->add($a, $b) . '<br />';
  9. echo '$a - $b = ' . $xmlrpc_client->sub($a, $b) . '<br />';
  10. echo '$a * $b = ' . $xmlrpc_client->call('Mul', $a, $b) . '<br />';
  11. echo '$a / $b = ' . $xmlrpc_client->invoke('Math.Div', $a, $b) . '<br />';
  12. ?>

虽然上面的代码很简单,但是还是有两点需要注意的地方的。

第一,xmlrpc 的方法是支持名空间(namespace)的,为了简化调用——省略方法前面的名空间,我们在初始化 $xmlrpc_client 时,给出了一个名空间的参数“Math”,这样下面通过方法名直接调用或者通过call来调用方法时,就可以省略名空间前缀了。如果想要改变名空间,只要 给 $xmlrpc_client->namespace 赋值就可以了。如果只是临时改变,也可以通过 invoke 方法来用全名(即带有名空间的方法名)来调用。

第二,xmlrpc 和 PHP5 的方法是区分大小写的,而 PHP4 的方法是不区分大小写的,而且在 PHP4 中,所有的函数或方法名都是储存为小写,因此不论是 add 也好,Sub 也好,最后它们所调用的方法都是小写的。所以 PHP5 中可以直接调用定义中有大写字母的方法,而 PHP4 中却不能。也就是说,如果想要在 PHP4 中直接通过方法名来访问 xmlrpc 方法的话,那么必须保证 xmlrpc 的方法名在定义时是小写的,否则就会产生找不到相应方法的错误。如果要在 PHP4 中调用在定义时就有大写字母的 xmlrpc 方法该怎么办呢?其实很简单,用 call 方法调用就可以了,第一个参数就是要调用的方法名的字符串,这个字符串是可以区分大小写的。也可以用 invoke 方法来调用,不同的地方就是如果有名空间的话,需要明确的写出来。

当然,上面的代码之所以可以那么简单,主要是因为它们包含了这个文件:

class_xmlrpc.php
  1. <?php
  2. /**
  3. * @author 马秉尧
  4. * @copyright (C) 2005 CoolCode.CN
  5. * @package xmlrpc-epi-php
  6. * @version 0.7
  7. */
  8.  
  9. class xmlrpc_error {
  10.     var $faultCode;
  11.     var $faultString;
  12.     function xmlrpc_error($code, $string) {
  13.         $this->faultCode = $code;
  14.         $this->faultString = $string;
  15.     }
  16. }
  17.  
  18. class xmlrpc_server {
  19.     var $server;
  20.     function xmlrpc_server() {
  21.         $this->server = xmlrpc_server_create();
  22.         register_shutdown_function(array(&$this, "__xmlrpc_server"));
  23.     }
  24.  
  25.     function register_method($method_name, $function) {
  26.         xmlrpc_server_register_method($this->server, $method_name, $function);
  27.     }
  28.  
  29.     function xmlrpc_server_add_introspection_data($desc) {
  30.         xmlrpc_server_add_introspection_data($this->server, $desc);
  31.     }
  32.  
  33.     function register_introspection_callback($function) {
  34.         xmlrpc_server_register_introspection_callback($this->server, $function);
  35.     }
  36.  
  37.     function call_method($user_data = null) {
  38.         if (isset($GLOBALS['HTTP_RAW_POST_DATA'])) {
  39.             $request = $GLOBALS['HTTP_RAW_POST_DATA'];
  40.         } 
  41.         else { 
  42.             $request = '';
  43.         }
  44.         $output_options = array(
  45.                        "output_type" => "xml",
  46.                        "verbosity" => "pretty",
  47.                        "escaping" => array("markup"),
  48.                        "version" => "xmlrpc",
  49.                        "encoding" => "utf-8"
  50.                       );
  51.         $response = xmlrpc_server_call_method($this->server, $request, $user_data, $output_options);
  52.         header("HTTP/1.1 200 OK");
  53.         header("Connection: close");
  54.         header("Content-Length: " . strlen($response));
  55.         header("Content-Type: text/xml; charset=utf-8");
  56.         header("Date: " . gmdate("D, d M Y H:i:s") . " GMT");
  57.         print $response;
  58.     }
  59.  
  60.     function __xmlrpc_server() {
  61.         xmlrpc_server_destroy($this->server);
  62.     }
  63. }
  64.  
  65. class __xmlrpc_client {
  66.     var $scheme;
  67.     var $host;
  68.     var $port;
  69.     var $path;
  70.     var $user;
  71.     var $pass;
  72.     var $namespace;
  73.     var $timeout;
  74.  
  75.     function __xmlrpc_client($url, $namespace = '', $user = '', $pass = '', $timeout = 10) {
  76.         $this->use_service($url);
  77.         $this->namespace = $namespace;
  78.         $this->user = $user;
  79.         $this->pass = $pass;
  80.         $this->timeout = $timeout;
  81.     }
  82.  
  83.     function use_service($url) {
  84.         $urlparts = parse_url($url);
  85.  
  86.         if (!isset($urlparts['host'])) {
  87.             if (isset($_SERVER["HTTP_HOST"])) {
  88.                 $urlparts['host'] = $_SERVER["HTTP_HOST"];
  89.             }
  90.             else if (isset($_SERVER["SERVER_NAME"])) {
  91.                 $urlparts['host'] = $_SERVER["SERVER_NAME"];
  92.             }
  93.             else {
  94.                 $urlparts['host'] = "localhost";
  95.             }
  96.             if (!isset($urlparts['scheme'])) {
  97.                 if (!isset($_SERVER["HTTPS"]) ||
  98.                     $_SERVER["HTTPS"] == "off"  ||
  99.                     $_SERVER["HTTPS"] == "") {
  100.                     $urlparts['scheme'] = "";
  101.                 }
  102.                 else {
  103.                     $urlparts['scheme'] = "https";
  104.                 }
  105.             }
  106.             if (!isset($urlparts['port'])) {
  107.                 $urlparts['port'] = $_SERVER["SERVER_PORT"];
  108.             }
  109.         }
  110.  
  111.         if (isset($urlparts['scheme']) && ($urlparts['scheme'] == "https")) {
  112.             $urlparts['scheme'] = "ssl";
  113.         }
  114.         else {
  115.             $urlparts['scheme'] = "";
  116.         }
  117.  
  118.         if (!isset($urlparts['port'])) {
  119.             if ($urlparts['scheme'] == "ssl") {
  120.                 $urlparts['port'] = 443;
  121.             }
  122.             else {
  123.                 $urlparts['port'] = 80;
  124.             }
  125.         }
  126.  
  127.         if (!isset($urlparts['path'])) {
  128.             $urlparts['path'] = "/";
  129.         }
  130.         else if (($urlparts['path']{0} != '/') && ($_SERVER["PHP_SELF"]{0} == '/')) {
  131.             $urlparts['path'] = substr($_SERVER["PHP_SELF"], 0, strrpos($_SERVER["PHP_SELF"], '/') + 1) . $urlparts['path'];
  132.         }
  133.  
  134.         $this->scheme = $urlparts['scheme'];
  135.         $this->host = $urlparts['host'];
  136.         $this->port = $urlparts['port'];
  137.         $this->path = $urlparts['path'];
  138.     }
  139.  
  140.     function __invoke($function, $arguments) {
  141.         $output = array(
  142.             "output_type" => "xml",
  143.             "verbosity" => "pretty",
  144.             "escaping" => array("markup"),
  145.             "version" => "xmlrpc",
  146.             "encoding" => "utf-8");
  147.         $request = xmlrpc_encode_request($function, $arguments, $output);
  148.         $content_len = strlen($request);
  149.         $errno = 0;
  150.         $errstr = '';
  151.         $host = ($this->scheme) ? $this->scheme . "://" . $this->host : $this->host;
  152.         $handle = @fsockopen($host, $this->port, $errno, $errstr, $this->timeout);
  153.         $buf = '';
  154.         if ($handle) {
  155.             $auth = '';
  156.             if ($this->user) {
  157.                 $auth = "Authorization: Basic " . base64_encode($this->user . ":" . $this->pass) . "\r\n";
  158.             }
  159.             $http_request =
  160.                 "POST $this->path HTTP/1.0\r\n" .
  161.                 "User-Agent: xmlrpc-epi-php/0.6 (PHP)\r\n" .
  162.                 "Host: $this->host:$this->port\r\n" .
  163.                 $auth .
  164.                 "Content-Type: text/xml; charset=utf-8\r\n" .
  165.                 "Content-Length: $content_len\r\n" .
  166.                 "\r\n" .
  167.                 $request;
  168.             fputs($handle, $http_request, strlen($http_request));
  169.             while (!feof($handle)) {
  170.                 $buf .= fgets($handle, 128);
  171.             }
  172.             fclose($handle);
  173.             if (strlen($buf)) {
  174.                 $xml = substr($buf, strpos($buf, "<?xml"));
  175.                 if (strlen($xml)) {
  176.                     $result = xmlrpc_decode($xml);
  177.                 }
  178.                 else {
  179.                     $result = new xmlrpc_error(6, "No data received from server");
  180.                 }
  181.             }
  182.             else {
  183.                 $result = new xmlrpc_error(6, "No data received from server");
  184.             }
  185.         }
  186.         else {
  187.             $result = new xmlrpc_error(5, "Didn't receive 200 OK from remote server");
  188.         }
  189.         return $result;
  190.     }
  191.  
  192.     function invoke($function, $args) {
  193.         $arguments = func_get_args();
  194.         array_shift($arguments);
  195.         return $this->__invoke($function, $arguments);
  196.     }
  197.  
  198.     function call($function, $args) {
  199.         $function = ($this->namespace == '') ? $function : $this->namespace . '.' . $function;
  200.         $arguments = func_get_args();
  201.         array_shift($arguments);
  202.         return $this->__invoke($function, $arguments);
  203.     }
  204. }
  205.  
  206. if (function_exists("overload") && version_compare(phpversion(), "5", "<")) {
  207.     require_once('php4_xmlrpc_client.php');
  208. }
  209. else {
  210.     require_once('php5_xmlrpc_client.php');
  211. }
  212. ?>
php4_xmlrpc_client.php
  1. <?php
  2.     class xmlrpc_client extends __xmlrpc_client {
  3.         function __call($function, $arguments, &$return) {
  4.             $function = ($this->namespace == '') ? $function : $this->namespace . '.' . $function;
  5.             $return = $this->__invoke($function, $arguments);
  6.             return true;
  7.         }
  8.     }
  9.     overload('xmlrpc_client');
  10. ?>
php5_xmlrpc_client.php
  1. <?php
  2.     class xmlrpc_client extends __xmlrpc_client {
  3.         function __call($function, $arguments) {
  4.             $function = ($this->namespace == '') ? $function : $this->namespace . '.' . $function;
  5.             return $this->__invoke($function, $arguments);
  6.         }
  7.     }
  8. ?>

好了,有了上面这个文件,以后再用 php 作 xmlrpc 程序就易如反掌了。哈哈哈哈~~~~

当然这两个类还包含其它一些功能,比如客户端调用时可以使用 http 基本认证,可以设置连接服务器的超时时间(默认10秒),服务器端你还可以给各个方法添加自我描述的文档。这些我就不举例子了。

关于自我描述文档请参考:http://xmlrpc-epi.sourceforge.net/specs/rfc.system.describeMethods.php

关于xmlrpc-epi请参考:http://xmlrpc-epi.sourceforge.net

关于xmlrpc请参考:http://www.xmlrpc.org

原创作品,转载请注明出处。

标签: Ajax, PHP

« 上一篇 | 下一篇 »

只显示10条记录相关文章

1 条回复至 "巨好用的 xmlrpc-epi PHP 封装类" 的评论

每个人都有一道伤口 或深或浅,盖上布,[www.bjkz010.com]以为不存在。 我把最殷红的鲜血流在那里。

北京刻章 于 2011-08-03 12:31:28 提交#1


发表评论

评论 (必须):