2 // by Edd Dumbill (C) 1999-2002
5 // Copyright (c) 1999,2000,2002 Edd Dumbill.
6 // All rights reserved.
8 // Redistribution and use in source and binary forms, with or without
9 // modification, are permitted provided that the following conditions
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
15 // * Redistributions in binary form must reproduce the above
16 // copyright notice, this list of conditions and the following
17 // disclaimer in the documentation and/or other materials provided
18 // with the distribution.
20 // * Neither the name of the "XML-RPC for PHP" nor the names of its
21 // contributors may be used to endorse or promote products derived
22 // from this software without specific prior written permission.
24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28 // REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30 // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
31 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
33 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
35 // OF THE POSSIBILITY OF SUCH DAMAGE.
37 /******************************************************************************
41 * This file is only used to insure backwards compatibility
42 * with the API of the library <= rev. 3
44 * If it is included, the library will work without any further autoloading.
46 * NB: including this file will also alter the library configuration setting the
47 * expected charset encoding used by the app to ISO-8859-1. Please see the
48 * file api_changes_v4.md for how to change this if required.
49 *****************************************************************************/
51 include_once(__DIR__.'/../src/Client.php');
52 include_once(__DIR__.'/../src/Encoder.php');
53 include_once(__DIR__.'/../src/PhpXmlRpc.php');
54 include_once(__DIR__.'/../src/Request.php');
55 include_once(__DIR__.'/../src/Response.php');
56 include_once(__DIR__.'/../src/Value.php');
57 include_once(__DIR__.'/../src/Exception/HttpException.php');
58 include_once(__DIR__.'/../src/Exception/PhpXmlrpcException.php');
59 include_once(__DIR__.'/../src/Helper/Charset.php');
60 include_once(__DIR__.'/../src/Helper/Date.php');
61 include_once(__DIR__.'/../src/Helper/Http.php');
62 include_once(__DIR__.'/../src/Helper/Logger.php');
63 include_once(__DIR__.'/../src/Helper/XMLParser.php');
66 use PhpXmlRpc\Encoder;
67 use PhpXmlRpc\Request;
68 use PhpXmlRpc\Response;
70 use PhpXmlRpc\Helper\Charset;
71 use PhpXmlRpc\Helper\Date;
72 use PhpXmlRpc\Helper\Http;
73 use PhpXmlRpc\Helper\XMLParser;
75 /* Expose the global variables which used to be defined */
76 PhpXmlRpc\PhpXmlRpc::$xmlrpc_internalencoding = 'ISO-8859-1'; // old default
77 PhpXmlRpc\PhpXmlRpc::exportGlobals();
79 /* some stuff deprecated enough that we do not want to put it in the new lib version */
82 $GLOBALS['xmlEntities'] = array(
90 // formulate backslashes for escaping regexp
91 // Not in use anymore since 2.0. Shall we remove it?
93 $GLOBALS['xmlrpc_backslash'] = chr(92).chr(92);
95 /* Expose with the old names the classes which have been namespaced */
98 * @todo reinstate access to method serializedata ?
100 class xmlrpcval extends Value
104 * @param xmlrpcval $o
107 public function serializeval($o)
109 // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
110 //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
116 return '<value>' . $this->serializedata($typ, $val) . "</value>\n";
121 * @deprecated this code looks like it is very fragile and has not been fixed
122 * for a long long time. Shall we remove it for 2.0?
124 public function getval()
127 $b = reset($this->me);
129 // contributed by I Sofer, 2001-03-24
130 // add support for nested arrays to scalarval
131 // i've created a new method here, so as to
132 // preserve back compatibility
135 foreach($b as $id => $cont) {
136 $b[$id] = $cont->scalarval();
140 // add support for structures directly encoding php objects
142 $t = get_object_vars($b);
143 foreach($t as $id => $cont) {
144 $t[$id] = $cont->scalarval();
146 foreach($t as $id => $cont) {
154 /// reset functionality added by parent class: same as it would happen if no interface was declared
155 public function count()
160 /// reset functionality added by parent class: same as it would happen if no interface was declared
161 public function getIterator()
163 return new ArrayIterator($this);
168 * @todo reinstate access to method parseResponseHeaders ?
170 class xmlrpcmsg extends Request
174 class xmlrpcresp extends Response
179 * @todo reinstate access to methods sendPayloadHTTP10, sendPayloadHTTPS, sendPayloadCURL, _try_multicall ?
181 class xmlrpc_client extends Client
185 /* Expose as global functions the ones which are now class methods */
187 /// Wrong speling, but we are adamant on backwards compatibility!
188 function xmlrpc_encode_entitites($data, $srcEncoding='', $destEncoding='')
190 return Charset::instance()->encodeEntities($data, $srcEncoding, $destEncoding);
193 function iso8601_encode($timeT, $utc=0)
195 return Date::iso8601Encode($timeT, $utc);
198 function iso8601_decode($iDate, $utc=0)
200 return Date::iso8601Decode($iDate, $utc);
203 function decode_chunked($buffer)
205 return Http::decodeChunked($buffer);
208 function php_xmlrpc_decode($xmlrpcVal, $options=array())
210 $encoder = new Encoder();
211 return $encoder->decode($xmlrpcVal, $options);
214 function php_xmlrpc_encode($phpVal, $options=array())
216 $encoder = new Encoder();
217 return $encoder->encode($phpVal, $options);
220 function php_xmlrpc_decode_xml($xmlVal, $options=array())
222 $encoder = new Encoder();
223 return $encoder->decodeXml($xmlVal, $options);
226 function guess_encoding($httpHeader='', $xmlChunk='', $encodingPrefs=null)
228 return XMLParser::guessEncoding($httpHeader, $xmlChunk, $encodingPrefs);
231 function has_encoding($xmlChunk)
233 return XMLParser::hasEncoding($xmlChunk);
236 function is_valid_charset($encoding, $validList)
238 return Charset::instance()->isValidCharset($encoding, $validList);