3.2版本的 phpRPC 调试问题

浏览:4172 发布日期:2014/12/13 分类:技术分享 关键字: phpRPC 调试 phprpc_client
我们使用了phpRPC用于前端展示和后端数据层分离,但是使用了一段时间之后,发现 ThinkPHP自带的phpRPC对调试非常不友好。

研究了两天源码,发现是因为phprpc_client 的处理逻辑问题。phprpc_client收Response包的时候,如果发现http 状态码不是200,或者Response 包头中有异常,就直接return 了一个PHPRPC_ERROR 的异常类。
但是具体的调试信息,其实是在Response的消息体里面的。
因为无法显示,所以调试起来非常麻烦。

我修改了phprpc_client 的一点逻辑,主要思路就是:如果发现需要返回异常,则 先将异常保存到一个变量里面,然后拿一个合法的Response Header 替换当前的header,继续执行Response content 的解析,并将content的内容写入到_warning 字段中。 然后再返回之前保存的异常。
这样,在外面就可以根据自己设定的debug参数,选择是否要将 _warning 输出,就行了。
下面是 phprpc_client的代码, 希望 ThinkPHP 官方能把这个思路合并到今后的版本里面,免得以后不敢升级主库了。
同时,我自己封装了一个phpRPC调用的类,可以把调用端的cookie传到phprpc_server端,这样对于重构之前的代码,就简单了许多。<?php
/**********************************************************\
|                                                          |
| The implementation of PHPRPC Protocol 3.0                |
|                                                          |
| phprpc_client.php                                        |
|                                                          |
| Release 3.0.1                                            |
| Copyright by Team-PHPRPC                                 |
|                                                          |
| WebSite:  http://www.phprpc.org/                         |
|           http://www.phprpc.net/                         |
|           http://www.phprpc.com/                         |
|           http://sourceforge.net/projects/php-rpc/       |
|                                                          |
| Authors:  Ma Bingyao <andot@ujn.edu.cn>                  |
|                                                          |
| This file may be distributed and/or modified under the   |
| terms of the GNU General Public License (GPL) version    |
| 2.0 as published by the Free Software Foundation and     |
| appearing in the included file LICENSE.                  |
|                                                          |
\**********************************************************/

/* PHPRPC Client for PHP.
 *
 * Copyright: Ma Bingyao <andot@ujn.edu.cn>
 * Version: 3.0
 * LastModified: Apr 12, 2010
 * This library is free.  You can redistribute it and/or modify it under GPL.
 *
/*
 * Interfaces
 *
 * $rpc_client = new PHPRPC_Client();
 * $rpc_client->setProxy(NULL);
 * $rpc_client->useService('http://www.phprpc.org/server.php');
 * $rpc_client->setKeyLength(1024);
 * $rpc_client->setEncryptMode(3);
 * $args = array(1, 2);
 * echo $rpc_client->invoke('add', &$args);
 * echo "<br />";
 * $n = 3;
 * $args = array(&$n);
 * echo $rpc_client->invoke('inc', &$args, true);
 * echo "<br />";
 * echo $rpc_client->sub(3, 2);
 * echo "<br />";
 * // error handle
 * $result = $rpc_client->mul(1, 2);  // no mul function
 * if (is_a($result, "PHPRPC_Error")) {
 *     echo $result->toString();
 * }
 */


$_PHPRPC_COOKIES = array();
$_PHPRPC_COOKIE = '';
$_PHPRPC_SID = 0;

if (defined('KEEP_PHPRPC_COOKIE_IN_SESSION')) {
    if (isset($_SESSION['phprpc_cookies']) and isset($_SESSION['phprpc_cookie'])) {
        $_PHPRPC_COOKIES = $_SESSION['phprpc_cookies'];
        $_PHPRPC_COOKIE = $_SESSION['phprpc_cookie'];
    }
    function keep_phprpc_cookie_in_session() {
        global $_PHPRPC_COOKIES, $_PHPRPC_COOKIE;
        $_SESSION['phprpc_cookies'] = $_PHPRPC_COOKIES;
        $_SESSION['phprpc_cookie'] = $_PHPRPC_COOKIE;
    }
    register_shutdown_function('keep_phprpc_cookie_in_session');
}

class PHPRPC_Error {
    var $Number;
    var $Message;
    function PHPRPC_Error($errno, $errstr) {
        $this->Number = $errno;
        $this->Message = $errstr;
    }
    function toString() {
        return $this->Number . ":" . $this->Message;
    }
    function __toString() {
        return $this->toString();
    }
    function getNumber() {
        return $this->Number;
    }
    function getMessage() {
        return $this->Message;
    }
}

class _PHPRPC_Client {
    var $_server;
    var $_timeout;
    var $_output;
    var $_warning;
    var $_proxy;
    var $_key;
    var $_keylen;
    var $_encryptMode;
    var $_charset;
    var $_socket;
    var $_clientid;
    var $_http_version;
    var $_keep_alive;
    var $_debug;

    function setDebugMode($debug = true)
    {
        $this->_debug = $debug ? true : false;
    }
    // Public Methods
    function _PHPRPC_Client($serverURL = '') {
        global $_PHPRPC_SID;
        require_once('compat.php');
        //register_shutdown_function(array(&$this, "_disconnect"));
        $this->_proxy = NULL;
        $this->_timeout = 30;
        $this->_clientid = 'php' . rand(1 << 30, 1 << 31) . time() . $_PHPRPC_SID;
        $_PHPRPC_SID++;
        $this->_socket = false;
        if ($serverURL != '') {
            $this->useService($serverURL);
        }
    }
    function useService($serverURL, $username = NULL, $password = NULL) {
        $this->_disconnect();
        $this->_http_version = "1.1";
        $this->_keep_alive = true;
        $this->_server = array();
        $this->_key = NULL;
        $this->_keylen = 128;
        $this->_encryptMode = 0;
        $this->_charset = 'utf-8';
        $urlparts = parse_url($serverURL);
        if (!isset($urlparts['host'])) {
            if (isset($_SERVER["HTTP_HOST"])) {
                $urlparts['host'] = $_SERVER["HTTP_HOST"];
            }
            else if (isset($_SERVER["SERVER_NAME"])) {
                $urlparts['host'] = $_SERVER["SERVER_NAME"];
            }
            else {
                $urlparts['host'] = "localhost";
            }
            if (!isset($_SERVER["HTTPS"]) ||
                $_SERVER["HTTPS"] == "off"  ||
                $_SERVER["HTTPS"] == "") {
                $urlparts['scheme'] = "http";
            }
            else {
                $urlparts['scheme'] = "https";
            }
            $urlparts['port'] = $_SERVER["SERVER_PORT"];
        }

        if (!isset($urlparts['port'])) {
            if ($urlparts['scheme'] == "https") {
                $urlparts['port'] = 443;
            }
            else {
                $urlparts['port'] = 80;
            }
        }

        if (!isset($urlparts['path'])) {
            $urlparts['path'] = "/";
        }
        else if (($urlparts['path']{0} != '/') && ($_SERVER["PHP_SELF"]{0} == '/')) {
            $urlparts['path'] = substr($_SERVER["PHP_SELF"], 0, strrpos($_SERVER["PHP_SELF"], '/') + 1) . $urlparts['path'];
        }

        if (isset($urlparts['query'])) {
            $urlparts['path'] .= '?' . $urlparts['query'];
        }

        if (!isset($urlparts['user']) || !is_null($username)) {
            $urlparts['user'] = $username;
        }

        if (!isset($urlparts['pass']) || !is_null($password)) {
            $urlparts['pass'] = $password;
        }

        $this->_server['scheme'] = $urlparts['scheme'];
        $this->_server['host'] = $urlparts['host'];
        $this->_server['port'] = $urlparts['port'];
        $this->_server['path'] = $urlparts['path'];
        $this->_server['user'] = $urlparts['user'];
        $this->_server['pass'] = $urlparts['pass'];
    }
    function setProxy($host, $port = NULL, $username = NULL, $password = NULL) {
        if (is_null($host)) {
            $this->_proxy = NULL;
        }
        else {
            if (is_null($port)) {
                $urlparts = parse_url($host);
                if (isset($urlparts['host'])) {
                    $host = $urlparts['host'];
                }
                if (isset($urlparts['port'])) {
                    $port = $urlparts['port'];
                }
                else {
                    $port = 80;
                }
                if (isset($urlparts['user']) && is_null($username)) {
                    $username = $urlparts['user'];
                }
                if (isset($urlparts['pass']) && is_null($password)) {
                    $password = $urlparts['pass'];
                }
            }
            $this->_proxy = array();
            $this->_proxy['host'] = $host;
            $this->_proxy['port'] = $port;
            $this->_proxy['user'] = $username;
            $this->_proxy['pass'] = $password;
        }
    }
    function setKeyLength($keylen) {
        if (!is_null($this->_key)) {
            return false;
        }
        else {
            $this->_keylen = $keylen;
            return true;
        }
    }
    function getKeyLength() {
        return $this->_keylen;
    }
    function setEncryptMode($encryptMode) {
        if (($encryptMode >= 0) && ($encryptMode <= 3)) {
            $this->_encryptMode = (int)($encryptMode);
            return true;
        }
        else {
            $this->_encryptMode = 0;
            return false;
        }
    }
    function getEncryptMode() {
        return $this->_encryptMode;
    }
    function setCharset($charset) {
        $this->_charset = $charset;
    }
    function getCharset() {
        return $this->_charset;
    }
    function setTimeout($timeout) {
        $this->_timeout = $timeout;
    }
    function getTimeout() {
        return $this->_timeout;
    }
    function invoke($funcname, &$args, $byRef = false) {
        $result = $this->_key_exchange();
        if (is_a($result, 'PHPRPC_Error')) {
            return $result;
        }
        $request = "phprpc_func=$funcname";
        if (count($args) > 0) {
            $request .= "&phprpc_args=" . base64_encode($this->_encrypt(serialize_fix($args), 1));
        }
        $request .= "&phprpc_encrypt={$this->_encryptMode}";
        if (!$byRef) {
            $request .= "&phprpc_ref=false";
        }
        $request = str_replace('+', '%2B', $request);
        $result = $this->_post($request);
        if (is_a($result, 'PHPRPC_Error')) {
            return $result;
        }
        $phprpc_errno = 0;
        $phprpc_errstr = NULL;
        if (isset($result['phprpc_errno'])) {
            $phprpc_errno = intval($result['phprpc_errno']);
        }
        if (isset($result['phprpc_errstr'])) {
            $phprpc_errstr = base64_decode($result['phprpc_errstr']);
        }
        if(!$this->_debug && $phprpc_errno && $phprpc_errstr)
        {
            $this->_warning = new PHPRPC_Error($phprpc_errno, $phprpc_errstr);
        }
        if (array_key_exists('phprpc_output', $result)) {
            $this->_output = base64_decode($result['phprpc_output']);
            if ($this->_server['version'] >= 3) {
                $this->_output = $this->_decrypt($this->_output, 3);
            }
        }
        else {
            $this->_output = '';
        }
        if (array_key_exists('phprpc_result', $result)) {
            if (array_key_exists('phprpc_args', $result)) {
                $arguments = unserialize($this->_decrypt(base64_decode($result['phprpc_args']), 1));
                for ($i = 0; $i < count($arguments); $i++) {
                    $args[$i] = $arguments[$i];
                }
            }
            $result = unserialize($this->_decrypt(base64_decode($result['phprpc_result']), 2));
        }
        else {
            $result = $this->_warning;
        }
        return $result;
    }

    function getOutput() {
        return $this->_output;
    }

    function getWarning() {
        return $this->_warning;
    }

    function _connect() {
        if (is_null($this->_proxy)) {
            $host = (($this->_server['scheme'] == "https") ? "ssl://" : "") . $this->_server['host'];
            $this->_socket = @pfsockopen($host, $this->_server['port'], $errno, $errstr, $this->_timeout);
        }
        else {
            $host = (($this->_server['scheme'] == "https") ? "ssl://" : "") . $this->_proxy['host'];
            $this->_socket = @pfsockopen($host, $this->_proxy['port'], $errno, $errstr, $this->_timeout);
        }
        if ($this->_socket === false) {
            return new PHPRPC_Error($errno, $errstr);
        }
        stream_set_write_buffer($this->_socket, 0);
        socket_set_timeout($this->_socket, $this->_timeout);
        return true;
    }

    function _disconnect() {
        if ($this->_socket !== false) {
            fclose($this->_socket);
            $this->_socket = false;
        }
    }

    function _socket_read($size) {
        $content = "";
        while (!feof($this->_socket) && ($size > 0)) {
            $str = fread($this->_socket, $size);
            $content .= $str;
            $size -= strlen($str);
        }
        return $content;
    }
    function _post($request_body) {
        global $_PHPRPC_COOKIE;
        $request_body = 'phprpc_id=' . $this->_clientid . '&' . $request_body;
        if ($this->_socket === false) {
            $error = $this->_connect();
            if (is_a($error, 'PHPRPC_Error')) {
                return $error;
            }
        }
        if (is_null($this->_proxy)) {
            $url = $this->_server['path'];
            $connection = "Connection: " . ($this->_keep_alive ? 'Keep-Alive' : 'Close') . "\r\n" .
                          "Cache-Control: no-cache\r\n";
        }
        else {
            $url = "{$this->_server['scheme']}://{$this->_server['host']}:{$this->_server['port']}{$this->_server['path']}";
            $connection = "Proxy-Connection: " . ($this->_keep_alive ? 'keep-alive' : 'close') . "\r\n";
            if (!is_null($this->_proxy['user'])) {
                $connection .= "Proxy-Authorization: Basic " . base64_encode($this->_proxy['user'] . ":" . $this->_proxy['pass']) . "\r\n";
            }
        }
        $auth = '';
        if (!is_null($this->_server['user'])) {
            $auth = "Authorization: Basic " . base64_encode($this->_server['user'] . ":" . $this->_server['pass']) . "\r\n";
        }
        $cookie = '';
        if ($_PHPRPC_COOKIE) {
            $cookie = "Cookie: " . $_PHPRPC_COOKIE . "\r\n";
        }
        $content_len = strlen($request_body);
        $request =
            "POST $url HTTP/{$this->_http_version}\r\n" .
            "Host: {$this->_server['host']}:{$this->_server['port']}\r\n" .
            "User-Agent: PHPRPC Client 3.0 for PHP\r\n" .
            $auth .
            $connection .
            $cookie .
            "Accept: */*\r\n" .
            "Accept-Encoding: gzip,deflate\r\n" .
            "Content-Type: application/x-www-form-urlencoded; charset={$this->_charset}\r\n" .
            "Content-Length: {$content_len}\r\n" .
            "\r\n" .
            $request_body;
        fputs($this->_socket, $request, strlen($request));
        $error_flag = 0;
        while (!feof($this->_socket)) {
            $line = fgets($this->_socket);
            if (preg_match('/HTTP\/(\d\.\d)\s+(\d+)([^(\r|\n)]*)(\r\n|$)/i', $line, $match)) {
                $this->_http_version = $match[1];
                $status = (int)$match[2];
                $status_message = trim($match[3]);
                if ($status != 100 && $status != 200) {
                    $this->_disconnect();
                    return new PHPRPC_Error($status, $status_message);
                }
            }
            else {
                $this->_disconnect();
                return new PHPRPC_Error(E_ERROR, "Illegal HTTP server.");
            }
            $header = array();
            while (!feof($this->_socket) && (($line = fgets($this->_socket)) != "\r\n")) {
                $line = explode(':', $line, 2);
                $header[strtolower($line[0])][] =trim($line[1]);
            }
            if ($status == 100) continue;
            $response_header = $this->_parseHeader($header);
            if (is_a($response_header, 'PHPRPC_Error')) {
                $error_flag = $response_header;
                $response_header = $this->test_header();
                //$this->_disconnect();
                //return $response_header;
            }
            break;
        }
        $response_body = '';
        if (isset($response_header['transfer_encoding']) && (strtolower($response_header['transfer_encoding']) == 'chunked')) {
            $s = fgets($this->_socket);
            if ($s == "") {
                $this->_disconnect();
                return array();
            }
            $chunk_size = (int)hexdec($s);
            while ($chunk_size > 0) {
                $response_body .= $this->_socket_read($chunk_size);
                if (fgets($this->_socket) != "\r\n") {
                    $response_header = $this->test_header();
                    //$this->_disconnect();
                    $error_flag =  new PHPRPC_Error(1, "Response is incorrect.");
                }
                $chunk_size = (int)hexdec(fgets($this->_socket));
            }
            fgets($this->_socket);
        }
        elseif (isset($response_header['content_length']) && !is_null($response_header['content_length'])) {
            $response_body = $this->_socket_read($response_header['content_length']);
        }
        else {
            while (!feof($this->_socket)) {
                $response_body .= fread($this->_socket, 4096);
            }
            $this->_keep_alive = false;
            $this->_disconnect();
        }
        if (isset($response_header['content_encoding']) && (strtolower($response_header['content_encoding']) == 'gzip')) {
            $response_body = gzdecode($response_body);
        }
        if (!$this->_keep_alive) $this->_disconnect();
        if ($this->_keep_alive && strtolower($response_header['connection']) == 'close') {
            $this->_keep_alive = false;
            $this->_disconnect();
        }
        if($this->_debug)
        {
            $this->_warning .= $response_body . ';';
        }

        if(is_a($error_flag, 'PHPRPC_Error'))
        {
            $this->_disconnect();
            return $error_flag;
        }
        return $this->_parseBody($response_body);
    }

    function _parseHeader($header) {
        global $_PHPRPC_COOKIE, $_PHPRPC_COOKIES;
        if (preg_match('/PHPRPC Server\/([^,]*)(,|$)/i', implode(',', $header['x-powered-by']), $match)) {
            $this->_server['version'] = (float)$match[1];
        }
        else {
            return new PHPRPC_Error(E_ERROR, "Illegal PHPRPC server.");
        }
        if (preg_match('/text\/plain\; charset\=([^,;]*)([,;]|$)/i', $header['content-type'][0], $match)) {
            $this->_charset = $match[1];
        }
        if (isset($header['set-cookie'])) {
            foreach ($header['set-cookie'] as $cookie) {
                foreach (preg_split('/[;,]\s?/', $cookie) as $c) {
                    list($name, $value) = explode('=', $c, 2);
                    if (!in_array($name, array('domain', 'expires', 'path', 'secure'))) {
                        $_PHPRPC_COOKIES[$name] = $value;
                    }
                }
            }
            $cookies = array();
            foreach ($_PHPRPC_COOKIES as $name => $value) {
                $cookies[] = "$name=$value";
            }
            $_PHPRPC_COOKIE = join('; ', $cookies);
        }
        if (isset($header['content-length'])) {
            $content_length = (int)$header['content-length'][0];
        }
        else {
            $content_length = NULL;
        }
        $transfer_encoding = isset($header['transfer-encoding']) ? $header['transfer-encoding'][0] : '';
        $content_encoding = isset($header['content-encoding']) ? $header['content-encoding'][0] : '';
        $connection = isset($header['connection']) ? $header['connection'][0] : 'close';
        return array('transfer_encoding' => $transfer_encoding,
                     'content_encoding' => $content_encoding,
                     'content_length' => $content_length,
                     'connection' => $connection);
    }
    function _parseBody($body) {
        $body = explode(";\r\n", $body);
        $result = array();
        $n = count($body);
        for ($i = 0; $i < $n; $i++) {
            $p = strpos($body[$i], '=');
            if ($p !== false) {
                $l = substr($body[$i], 0, $p);
                $r = substr($body[$i], $p + 1);
                $result[$l] = trim($r, '"');
            }
        }
        return $result;
    }
    function _key_exchange() {
        if (!is_null($this->_key) || ($this->_encryptMode == 0)) return true;
        $request = "phprpc_encrypt=true&phprpc_keylen={$this->_keylen}";
        $result = $this->_post($request);
        if (is_a($result, 'PHPRPC_Error')) {
            return $result;
        }
        if (array_key_exists('phprpc_keylen', $result)) {
            $this->_keylen = (int)$result['phprpc_keylen'];
        }
        else {
            $this->_keylen = 128;
        }
        if (array_key_exists('phprpc_encrypt', $result)) {
            $encrypt = unserialize(base64_decode($result['phprpc_encrypt']));
            require_once('bigint.php');
            require_once('xxtea.php');
            $x = bigint_random($this->_keylen - 1, true);
            $key = bigint_powmod(bigint_dec2num($encrypt['y']), $x, bigint_dec2num($encrypt['p']));
            if ($this->_keylen == 128) {
                $key = bigint_num2str($key);
            }
            else {
                $key = pack('H*', md5(bigint_num2dec($key)));
            }
            $this->_key = str_pad($key, 16, "\0", STR_PAD_LEFT);
            $encrypt = bigint_num2dec(bigint_powmod(bigint_dec2num($encrypt['g']), $x, bigint_dec2num($encrypt['p'])));
            $request = "phprpc_encrypt=$encrypt";
            $result = $this->_post($request);
            if (is_a($result, 'PHPRPC_Error')) {
                return $result;
            }
        }
        else {
            $this->_key = NULL;
            $this->_encryptMode = 0;
        }
        return true;
    }
    function _encrypt($str, $level) {
        if (!is_null($this->_key) && ($this->_encryptMode >= $level)) {
            $str = xxtea_encrypt($str, $this->_key);
        }
        return $str;
    }
    function _decrypt($str, $level) {
        if (!is_null($this->_key) && ($this->_encryptMode >= $level)) {
            $str = xxtea_decrypt($str, $this->_key);
        }
        return $str;
    }
    function test_header()
    {
        return array('transfer_encoding' => '',
                     'content_encoding' => '',
                     'content_length' => 1024,
                     'connection' => 'close',
                     );
    }
}

if (function_exists("overload") && version_compare(phpversion(), "5", "<")) {
    eval('
    class PHPRPC_Client extends _PHPRPC_Client {
        function __call($function, $arguments, &$return) {
            $return = $this->invoke($function, $arguments);
            return true;
        }
    }
    overload("phprpc_client");
    ');
}
else {
    class PHPRPC_Client extends _PHPRPC_Client {
        function __call($function, $arguments) {
            return $this->invoke($function, $arguments);
        }
    }
}
?>
我自己封装了一个PHPRPC调用的类,比直接用底层的方便:<?php
/**
 * 封装了phprpc的调用,用于对 Api 接口的直接调用。调用实例:
 * 
 * $api = new QloApiAction('Help');
 * $api->_setActionName('Help');
 * $a = $api->get_help_info('domain_add');
 * var_dump($a);
 * 
*/
namespace Home\Action;
define('KEEP_PHPRPC_COOKIE_IN_SESSION', true);

class QloApiAction extends Action {
    protected $debug = 1;   // 标志是否输出 rpc服务器端的输出。 1 为debug,0 为关闭。
    protected $phprpc;
    
    public function __call($method,$args)
    {
        $ret = call_user_func_array(array($this->phprpc, $method),$args);
        if($this->debug)
        {
            echo $this->phprpc->getOutput();
            echo $this->phprpc->getWarning();
        }
        return $ret;
    }
    
    public function __construct($action_name = '') {
        global $_PHPRPC_COOKIE;
        parent::__construct();

        Vendor('phpRPC.phprpc_client');
        $qlo_rpc_server = C('QLOCENTER_API_SERVER');

        $this->putCookiesToRpcServer();
        $this->phprpc = new \PHPRPC_Client();
        if($this->debug)
        {
            $this->phprpc->setDebugMode(true);
        }
        //将cookie带过去
        if(!empty($action_name))
        {
            $this->phprpc->useService($qlo_rpc_server . trim($action_name));
        }
        return $this->phprpc;
    }
    //$_COOKIE['_verify']
    private function putCookiesToRpcServer()
    {
        global $_PHPRPC_COOKIE;
        if(!empty($_COOKIE))
        {
            $cookie_str = '';
            foreach($_COOKIE as $k => $v)
            {
                if($k != 'PHPSESSID')
                {
                    $cookie_str .= ' ' . $k . '=' . $v . ';';
                }
                
            }
            $cookie_str = trim($cookie_str);
            $cookie_str = trim($cookie_str, ';');
            $_PHPRPC_COOKIE = $cookie_str;
            
        }
        
    }

    public function _setActionName($action_name)
    {
        $qlo_rpc_server = C('API_SERVER');
        $this->phprpc->useService($qlo_rpc_server . trim($action_name));
        return $this->phprpc;
    }

}


最佳答案
评论( 相关
后面还有条评论,点击查看>>