3 This file is part of, or distributed with, libXMLRPC - a C library for
4 xml-encoded function calls.
6 Author: Dan Libby (dan@libby.com)
7 Epinions.com may be contacted at feedback@epinions-inc.com
11 Copyright 2001 Epinions, Inc.
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.
18 1) The above copyright notice and this permission notice shall be included
19 without modification in all copies or substantial portions of the
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.
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
36 /* xmlrpc utilities (xu)
37 * author: Dan Libby (dan@libby.com)
40 // ensure extension is loaded.
43 // a function to ensure the xmlrpc extension is loaded.
44 // xmlrpc_epi_dir = directory where libxmlrpc.so.0 is located
45 // xmlrpc_php_dir = directory where xmlrpc-epi-php.so is located
46 function xu_load_extension($xmlrpc_php_dir="") {
47 $bSuccess = extension_loaded('xmlrpc');
49 putenv("LD_LIBRARY_PATH=/usr/lib/php4/apache/xmlrpc/");
50 if ($xmlrpc_php_dir) {
51 $xmlrpc_php_dir .= '/';
53 if (substr(PHP_OS,0,3) == 'WIN')
54 $bSuccess = dl("php_xmlrpc.dll");
56 $bSuccess = dl($xmlrpc_php_dir . "xmlrpc-epi-php.so");
61 /* generic function to call an http server with post method */
62 function xu_query_http_post($request, $host, $uri, $port, $debug,
63 $timeout, $user, $pass, $secure=false) {
65 if ($host && $uri && $port) {
66 $content_len = strlen($request);
68 $fsockopen = $secure ? "fsockopen_ssl" : "fsockopen";
70 dbg1("opening socket to host: $host, port: $port, uri: $uri", $debug);
72 $query_fd = fsockopen_ssl($host, $port, $errno, $errstr, 10);
74 $query_fd = fsockopen($host, $port, $errno, $errstr, 10);
80 $auth = "Authorization: Basic " .
81 base64_encode($user . ":" . $pass) . "\r\n";
85 "POST $uri HTTP/1.0\r\n" .
86 "User-Agent: xmlrpc-epi-php/0.2 (PHP)\r\n" .
87 "Host: $host:$port\r\n" .
89 "Content-Type: text/xml\r\n" .
90 "Content-Length: $content_len\r\n" .
94 dbg1("sending http request:</em><br /> <xmp>\n$http_request\n</xmp>", $debug);
95 fputs($query_fd, $http_request, strlen($http_request));
96 dbg1("receiving response...", $debug);
98 $header_parsed = false;
100 $line = fgets($query_fd, 4096);
102 if (!$header_parsed) {
103 if ($line === "\r\n" || $line === "\n") {
106 dbg2("got header - $line", $debug);
109 $response_buf .= $line;
111 $line = fgets($query_fd, 4096);
117 dbg1("socket open failed", $debug);
121 dbg1("missing param(s)", $debug);
124 dbg1("got response:</em><br />. <xmp>\n$response_buf\n</xmp>\n", $debug);
126 return $response_buf;
129 function xu_fault_code($code, $string) {
130 return array('faultCode' => $code,
131 'faultString' => $string);
135 function find_and_decode_xml($buf, $debug) {
137 $xml_begin = substr($buf, strpos($buf, "<?xml"));
138 if (strlen($xml_begin)) {
140 $retval = xmlrpc_decode($xml_begin);
143 dbg1("xml start token not found", $debug);
147 dbg1("no data", $debug);
153 * @param params a struct containing 3 or more of these key/val pairs:
154 * @param host remote host (required)
155 * @param uri remote uri (required)
156 * @param port remote port (required)
157 * @param method name of method to call
158 * @param args arguments to send (parameters to remote xmlrpc server)
159 * @param debug debug level (0 none, 1, some, 2 more)
160 * @param timeout timeout in secs. (0 = never)
161 * @param user user name for authentication.
162 * @param pass password for authentication
163 * @param secure secure. wether to use fsockopen_ssl. (requires special php build).
164 * @param output array. xml output options. can be null. details below:
166 * output_type: return data as either php native data types or xml
167 * encoded. if php is used, then the other values are ignored. default = xml
168 * verbosity: determine compactness of generated xml. options are
169 * no_white_space, newlines_only, and pretty. default = pretty
170 * escaping: determine how/whether to escape certain characters. 1 or
171 * more values are allowed. If multiple, they need to be specified as
172 * a sub-array. options are: cdata, non-ascii, non-print, and
173 * markup. default = non-ascii | non-print | markup
174 * version: version of xml vocabulary to use. currently, three are
175 * supported: xmlrpc, soap 1.1, and simple. The keyword auto is also
176 * recognized to mean respond in whichever version the request came
177 * in. default = auto (when applicable), xmlrpc
178 * encoding: the encoding that the data is in. Since PHP defaults to
179 * iso-8859-1 you will usually want to use that. Change it if you know
180 * what you are doing. default=iso-8859-1
184 * $output_options = array('output_type' => 'xml',
185 * 'verbosity' => 'pretty',
186 * 'escaping' => array('markup', 'non-ascii', 'non-print'),
187 * 'version' => 'xmlrpc',
188 * 'encoding' => 'utf-8'
192 * $output_options = array('output_type' => 'php');
194 function xu_rpc_http_concise($params) {
195 $host = $uri = $port = $method = $args = $debug = null;
196 $timeout = $user = $pass = $secure = $cookies = null;
208 $output = array('version' => 'xmlrpc');
212 if ($host && $uri && $port) {
213 $request_xml = xmlrpc_encode_request($method, $args, $output);
214 $response_buf = xu_query_http_post($request_xml, $host, $uri, $port, $debug,
215 $timeout, $user, $pass, $secure);
216 $retval = find_and_decode_xml($response_buf, $debug);
221 /* call an xmlrpc method on a remote http server. legacy support. */
222 function xu_rpc_http($method, $args, $host, $uri="/", $port=80, $debug=false,
223 $timeout=0, $user=false, $pass=false, $secure=false) {
224 return xu_rpc_http_concise(
232 'timeout' => $timeout,
241 function xu_is_fault($arg) {
242 // xmlrpc extension finally supports this.
243 return is_array($arg) ? xmlrpc_is_fault($arg) : false;
246 /* sets some http headers and prints xml */
247 function xu_server_send_http_response($xml) {
248 header("Content-type: text/xml");
249 header("Content-length: " . strlen($xml) );
254 echo "<em>",$msg,"</em><br />"; flush();
256 function dbg1($msg, $debug_level) {
257 if ($debug_level >= 1) {
261 function dbg2($msg, $debug_level) {
262 if ($debug_level >= 2) {