lib/XMLRPC/utils.php

   1 <?php
   2 /*
   3   This file is part of, or distributed with, libXMLRPC - a C library for
   4   xml-encoded function calls.
   5
   6   Author: Dan Libby (dan@libby.com)
   7   Epinions.com may be contacted at feedback@epinions-inc.com
   8 */
   9
  10 /*
  11   Copyright 2001 Epinions, Inc.
  12
  13   Subject to the following 3 conditions, Epinions, Inc.  permits you, free
  14   of charge, to (a) use, copy, distribute, modify, perform and display this
  15   software and associated documentation files (the "Software"), and (b)
  16   permit others to whom the Software is furnished to do so as well.
  17
  18   1) The above copyright notice and this permission notice shall be included
  19   without modification in all copies or substantial portions of the
  20   Software.
  21
  22   2) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT ANY WARRANTY OR CONDITION OF
  23   ANY KIND, EXPRESS, IMPLIED OR STATUTORY, INCLUDING WITHOUT LIMITATION ANY
  24   IMPLIED WARRANTIES OF ACCURACY, MERCHANTABILITY, FITNESS FOR A PARTICULAR
  25   PURPOSE OR NONINFRINGEMENT.
  26
  27   3) IN NO EVENT SHALL EPINIONS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT,
  28   SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES OR LOST PROFITS ARISING OUT
  29   OF OR IN CONNECTION WITH THE SOFTWARE (HOWEVER ARISING, INCLUDING
  30   NEGLIGENCE), EVEN IF EPINIONS, INC.  IS AWARE OF THE POSSIBILITY OF SUCH
  31   DAMAGES.
  32
  33 */
  34
  35 /* xmlrpc utilities (xu)
  36  * author: Dan Libby (dan@libby.com)
  37  */
  38
  39 // ensure extension is loaded.
  40 xu_load_extension();
  41
  42 // a function to ensure the xmlrpc extension is loaded.
  43 // xmlrpc_epi_dir = directory where libxmlrpc.so.0 is located
  44 // xmlrpc_php_dir = directory where xmlrpc-epi-php.so is located
  45 function xu_load_extension($xmlrpc_php_dir="") {
  46    $bSuccess = extension_loaded('xmlrpc');
  47    if (!$bSuccess) {
  48       putenv("LD_LIBRARY_PATH=/usr/lib/php4/apache/xmlrpc/");
  49       if ($xmlrpc_php_dir) {
  50           $xmlrpc_php_dir .= '/';
  51       }
  52       if (substr(PHP_OS,0,3) == 'WIN')
  53           $bSuccess = dl("php_xmlrpc.dll");
  54       else
  55           $bSuccess = dl($xmlrpc_php_dir . "xmlrpc-epi-php.so");
  56    }
  57    return $bSuccess;
  58 }
  59
  60 /* generic function to call an http server with post method */
  61 function xu_query_http_post($request, $host, $uri, $port, $debug,
  62                             $timeout, $user, $pass, $secure=false) {
  63     $response_buf = "";
  64     if ($host && $uri && $port) {
  65         $content_len = strlen($request);
  66
  67         $fsockopen = $secure ? "fsockopen_ssl" : "fsockopen";
  68
  69         dbg1("opening socket to host: $host, port: $port, uri: $uri", $debug);
  70     if ($secure)
  71             $query_fd = fsockopen_ssl($host, $port, $errno, $errstr, 10);
  72     else
  73             $query_fd = fsockopen($host, $port, $errno, $errstr, 10);
  74
  75         if ($query_fd) {
  76
  77             $auth = "";
  78             if ($user) {
  79                 $auth = "Authorization: Basic " .
  80                     base64_encode($user . ":" . $pass) . "\r\n";
  81             }
  82
  83             $http_request =
  84                 "POST $uri HTTP/1.0\r\n" .
  85                 "User-Agent: xmlrpc-epi-php/0.2 (PHP)\r\n" .
  86                 "Host: $host:$port\r\n" .
  87                 $auth .
  88                 "Content-Type: text/xml\r\n" .
  89                 "Content-Length: $content_len\r\n" .
  90                 "\r\n" .
  91                 $request;
  92
  93            dbg1("sending http request:</em><br /> <xmp>\n$http_request\n</xmp>", $debug);
  94            fputs($query_fd, $http_request, strlen($http_request));
  95            dbg1("receiving response...", $debug);
  96
  97            $header_parsed = false;
  98
  99            $line = fgets($query_fd, 4096);
 100            while ($line) {
 101                if (!$header_parsed) {
 102                    if ($line === "\r\n" || $line === "\n") {
 103                        $header_parsed = 1;
 104                    }
 105                    dbg2("got header - $line", $debug);
 106                }
 107                else {
 108                    $response_buf .= $line;
 109                }
 110                $line = fgets($query_fd, 4096);
 111            }
 112
 113            fclose($query_fd);
 114        }
 115        else {
 116            dbg1("socket open failed", $debug);
 117        }
 118    }
 119    else {
 120        dbg1("missing param(s)", $debug);
 121    }
 122
 123    dbg1("got response:</em><br />. <xmp>\n$response_buf\n</xmp>\n", $debug);
 124
 125    return $response_buf;
 126 }
 127
 128 function xu_fault_code($code, $string) {
 129    return array('faultCode' => $code,
 130                 'faultString' => $string);
 131 }
 132
 133 function find_and_decode_xml($buf, $debug) {
 134     if (strlen($buf)) {
 135         $xml_begin = substr($buf, strpos($buf, "<?xml"));
 136         if (strlen($xml_begin)) {
 137
 138             $retval = xmlrpc_decode($xml_begin);
 139         }
 140         else {
 141             dbg1("xml start token not found", $debug);
 142         }
 143     }
 144     else {
 145         dbg1("no data", $debug);
 146     }
 147     return $retval;
 148 }
 149
 150 /**
 151  * @param params   a struct containing 3 or more of these key/val pairs:
 152  * @param host           remote host (required)
 153  * @param uri            remote uri      (required)
 154  * @param port           remote port (required)
 155  * @param method   name of method to call
 156  * @param args      arguments to send (parameters to remote xmlrpc server)
 157  * @param debug  debug level (0 none, 1, some, 2 more)
 158  * @param timeout        timeout in secs.  (0 = never)
 159  * @param user           user name for authentication.
 160  * @param pass           password for authentication
 161  * @param secure         secure. wether to use fsockopen_ssl. (requires special php build).
 162  * @param output         array. xml output options. can be null.  details below:
 163  *
 164  *     output_type: return data as either php native data types or xml
 165  *                  encoded. if php is used, then the other values are ignored. default = xml
 166  *     verbosity:   determine compactness of generated xml. options are
 167  *                  no_white_space, newlines_only, and pretty. default = pretty
 168  *     escaping:    determine how/whether to escape certain characters. 1 or
 169  *                  more values are allowed. If multiple, they need to be specified as
 170  *                  a sub-array. options are: cdata, non-ascii, non-print, and
 171  *                  markup. default = non-ascii | non-print | markup
 172  *     version:     version of xml vocabulary to use. currently, three are
 173  *                  supported: xmlrpc, soap 1.1, and simple. The keyword auto is also
 174  *                  recognized to mean respond in whichever version the request came
 175  *                  in. default = auto (when applicable), xmlrpc
 176  *     encoding:    the encoding that the data is in. Since PHP defaults to
 177  *                  iso-8859-1 you will usually want to use that. Change it if you know
 178  *                  what you are doing. default=iso-8859-1
 179  *
 180  *   example usage
 181  *
 182  *                   $output_options = array('output_type' => 'xml',
 183  *                                           'verbosity' => 'pretty',
 184  *                                           'escaping' => array('markup', 'non-ascii', 'non-print'),
 185  *                                           'version' => 'xmlrpc',
 186  *                                           'encoding' => 'utf-8'
 187  *                                         );
 188  *                   or
 189  *
 190  *                   $output_options = array('output_type' => 'php');
 191  */
 192 function xu_rpc_http_concise($params) {
 193    $host = $uri = $port = $method = $args = $debug = null;
 194    $timeout = $user = $pass = $secure = $cookies = null;
 195
 196    extract($params);
 197
 198    // default values
 199    if(!$port) {
 200        $port = 80;
 201    }
 202    if(!$uri) {
 203        $uri = '/';
 204    }
 205    if(!$output) {
 206        $output = array('version' => 'xmlrpc');
 207    }
 208
 209    $response_buf = "";
 210    if ($host && $uri && $port) {
 211        $request_xml = xmlrpc_encode_request($method, $args, $output);
 212        $response_buf = xu_query_http_post($request_xml, $host, $uri, $port, $debug,
 213                                           $timeout, $user, $pass, $secure);
 214        $retval = find_and_decode_xml($response_buf, $debug);
 215    }
 216    return $retval;
 217 }
 218
 219 /* call an xmlrpc method on a remote http server. legacy support. */
 220 function xu_rpc_http($method, $args, $host, $uri="/", $port=80, $debug=false,
 221                      $timeout=0, $user=false, $pass=false, $secure=false) {
 222     return xu_rpc_http_concise(
 223         array(
 224             'method'  => $method,
 225             'args'    => $args,
 226             'host'    => $host,
 227             'uri'     => $uri,
 228             'port'    => $port,
 229             'debug'   => $debug,
 230             'timeout' => $timeout,
 231             'user'    => $user,
 232             'pass'    => $pass,
 233             'secure'  => $secure
 234         ));
 235 }
 236
 237 function xu_is_fault($arg) {
 238    // xmlrpc extension finally supports this.
 239    return is_array($arg) ? xmlrpc_is_fault($arg) : false;
 240 }
 241
 242 /* sets some http headers and prints xml */
 243 function xu_server_send_http_response($xml) {
 244     header("Content-type: text/xml");
 245     header("Content-length: " . strlen($xml) );
 246     echo $xml;
 247 }
 248
 249 function dbg($msg) {
 250     echo "<em>",$msg,"</em><br />"; flush();
 251 }
 252 function dbg1($msg, $debug_level) {
 253    if ($debug_level >= 1) {
 254       dbg($msg);
 255    }
 256 }
 257 function dbg2($msg, $debug_level) {
 258    if ($debug_level >= 2) {
 259       dbg($msg);
 260    }
 261 }
 262 ?>