]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - lib/XMLRPC/utils.php
fix dl(), esp. on windows
[SourceForge/phpwiki.git] / lib / XMLRPC / utils.php
1 <?php
2
3 /*
4   This file is part of, or distributed with, libXMLRPC - a C library for 
5   xml-encoded function calls.
6
7   Author: Dan Libby (dan@libby.com)
8   Epinions.com may be contacted at feedback@epinions-inc.com
9 */
10
11 /*  
12   Copyright 2001 Epinions, Inc. 
13
14   Subject to the following 3 conditions, Epinions, Inc.  permits you, free 
15   of charge, to (a) use, copy, distribute, modify, perform and display this 
16   software and associated documentation files (the "Software"), and (b) 
17   permit others to whom the Software is furnished to do so as well.  
18
19   1) The above copyright notice and this permission notice shall be included 
20   without modification in all copies or substantial portions of the 
21   Software.  
22
23   2) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT ANY WARRANTY OR CONDITION OF 
24   ANY KIND, EXPRESS, IMPLIED OR STATUTORY, INCLUDING WITHOUT LIMITATION ANY 
25   IMPLIED WARRANTIES OF ACCURACY, MERCHANTABILITY, FITNESS FOR A PARTICULAR 
26   PURPOSE OR NONINFRINGEMENT.  
27
28   3) IN NO EVENT SHALL EPINIONS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, 
29   SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES OR LOST PROFITS ARISING OUT 
30   OF OR IN CONNECTION WITH THE SOFTWARE (HOWEVER ARISING, INCLUDING 
31   NEGLIGENCE), EVEN IF EPINIONS, INC.  IS AWARE OF THE POSSIBILITY OF SUCH 
32   DAMAGES.    
33
34 */
35
36
37 /* xmlrpc utilities (xu) 
38  * author: Dan Libby (dan@libby.com)
39  */
40
41 // ensure extension is loaded.
42 xu_load_extension();
43
44 // a function to ensure the xmlrpc extension is loaded.
45 // xmlrpc_epi_dir = directory where libxmlrpc.so.0 is located
46 // xmlrpc_php_dir = directory where xmlrpc-epi-php.so is located
47 function xu_load_extension($xmlrpc_php_dir="") {
48    $bSuccess = extension_loaded('xmlrpc');
49    if (!$bSuccess) {
50       putenv("LD_LIBRARY_PATH=/usr/lib/php4/apache/xmlrpc/");
51       if ($xmlrpc_php_dir) {
52           $xmlrpc_php_dir .= '/';
53       }
54       if (substr(PHP_OS,0,3) == 'WIN')
55           $bSuccess = dl("php_xmlrpc.dll");
56       else    
57           $bSuccess = dl($xmlrpc_php_dir . "xmlrpc-epi-php.so");
58    }
59    return $bSuccess;
60 }
61
62 /* generic function to call an http server with post method */
63 function xu_query_http_post($request, $host, $uri, $port, $debug, 
64                             $timeout, $user, $pass, $secure=false) {
65     $response_buf = "";
66     if ($host && $uri && $port) {
67         $content_len = strlen($request);
68
69         $fsockopen = $secure ? "fsockopen_ssl" : "fsockopen";
70
71         dbg1("opening socket to host: $host, port: $port, uri: $uri", $debug);
72         $query_fd = $fsockopen($host, $port, $errno, $errstr, 10);
73
74         if ($query_fd) {
75
76             $auth = "";
77             if ($user) {
78                 $auth = "Authorization: Basic " .
79                     base64_encode($user . ":" . $pass) . "\r\n";
80             }
81
82             $http_request = 
83                 "POST $uri HTTP/1.0\r\n" .
84                 "User-Agent: xmlrpc-epi-php/0.2 (PHP)\r\n" .
85                 "Host: $host:$port\r\n" .
86                 $auth .
87                 "Content-Type: text/xml\r\n" .
88                 "Content-Length: $content_len\r\n" . 
89                 "\r\n" .
90                 $request;
91
92            dbg1("sending http request:</em><br /> <xmp>\n$http_request\n</xmp>", $debug);
93
94            fputs($query_fd, $http_request, strlen($http_request));
95
96            dbg1("receiving response...", $debug);
97
98            $header_parsed = false;
99
100            $line = fgets($query_fd, 4096);
101            while ($line) {
102                if (!$header_parsed) {
103                    if ($line === "\r\n" || $line === "\n") {
104                        $header_parsed = 1;
105                    }
106                    dbg2("got header - $line", $debug);
107                }
108                else {
109                    $response_buf .= $line;
110                }
111                $line = fgets($query_fd, 4096);
112            }
113
114            fclose($query_fd);
115        }
116        else {
117            dbg1("socket open failed", $debug);
118        }
119    }
120    else {
121        dbg1("missing param(s)", $debug);
122    }
123
124    dbg1("got response:</em><br />. <xmp>\n$response_buf\n</xmp>\n", $debug);
125
126    return $response_buf;
127 }
128
129 function xu_fault_code($code, $string) {
130    return array('faultCode' => $code,
131                 'faultString' => $string);
132 }
133
134
135 function find_and_decode_xml($buf, $debug) {
136     if (strlen($buf)) {
137         $xml_begin = substr($buf, strpos($buf, "<?xml"));
138         if (strlen($xml_begin)) {
139
140             $retval = xmlrpc_decode($xml_begin);
141         }
142         else {
143             dbg1("xml start token not found", $debug);
144         }
145     }
146     else {
147         dbg1("no data", $debug);
148     }
149     return $retval;
150 }
151  
152 /**
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:
165  *
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
181  *
182  *   example usage
183  *
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'
189  *                                         );
190  *                   or
191  *
192  *                   $output_options = array('output_type' => 'php');
193  */
194 function xu_rpc_http_concise($params) {
195    $host = $uri = $port = $method = $args = $debug = null;
196    $timeout = $user = $pass = $secure = $debug = null;
197
198    extract($params);
199
200    // default values
201    if(!$port) {
202        $port = 80;
203    }
204    if(!$uri) {
205        $uri = '/';
206    }
207    if(!$output) {
208        $output = array('version' => 'xmlrpc');
209    }
210
211    $response_buf = "";
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
217        $retval = find_and_decode_xml($response_buf, $debug);
218    }
219    return $retval;
220 }
221
222 /* call an xmlrpc method on a remote http server. legacy support. */
223 function xu_rpc_http($method, $args, $host, $uri="/", $port=80, $debug=false, 
224                      $timeout=0, $user=false, $pass=false, $secure=false) {
225         return xu_rpc_http_concise(
226                 array(
227                         'method'  => $method,
228                         'args'    => $args,
229                         'host'    => $host,
230                         'uri'     => $uri,
231                         'port'    => $port,
232                         'debug'   => $debug,
233                         'timeout' => $timeout,
234                         'user'    => $user,
235                         'pass'    => $pass,
236                         'secure'  => $secure
237                 ));
238 }
239
240
241
242 function xu_is_fault($arg) {
243    // xmlrpc extension finally supports this.
244    return is_array($arg) ? xmlrpc_is_fault($arg) : false;
245 }
246
247 /* sets some http headers and prints xml */
248 function xu_server_send_http_response($xml) {
249     header("Content-type: text/xml");
250     header("Content-length: " . strlen($xml) );
251     echo $xml;
252 }
253
254 function dbg($msg) {
255     echo "<em>",$msg,"</em><br />"; flush();
256 }
257 function dbg1($msg, $debug_level) {
258    if ($debug_level >= 1) {
259       dbg($msg);
260    }
261 }
262 function dbg2($msg, $debug_level) {
263    if ($debug_level >= 2) {
264       dbg($msg);
265    }
266 }
267 ?>