lib/xmlrpc.inc

   1 <?php
   2 // by Edd Dumbill (C) 1999-2002
   3 // <edd@usefulinc.com>
   4
   5 // Copyright (c) 1999,2000,2002 Edd Dumbill.
   6 // All rights reserved.
   7 //
   8 // Redistribution and use in source and binary forms, with or without
   9 // modification, are permitted provided that the following conditions
  10 // are met:
  11 //
  12 //    * Redistributions of source code must retain the above copyright
  13 //      notice, this list of conditions and the following disclaimer.
  14 //
  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.
  19 //
  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.
  23 //
  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.
  36
  37 /******************************************************************************
  38  *
  39  * *** DEPRECATED ***
  40  *
  41  * This file is only used to insure backwards compatibility
  42  * with the API of the library <= rev. 3
  43  *
  44  * If it is included, the library will work without any further autoloading.
  45  *
  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  *****************************************************************************/
  50
  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/Helper/Charset.php');
  58 include_once(__DIR__.'/../src/Helper/Date.php');
  59 include_once(__DIR__.'/../src/Helper/Http.php');
  60 include_once(__DIR__.'/../src/Helper/Logger.php');
  61 include_once(__DIR__.'/../src/Helper/XMLParser.php');
  62
  63 use PhpXmlRpc\Client;
  64 use PhpXmlRpc\Encoder;
  65 use PhpXmlRpc\Request;
  66 use PhpXmlRpc\Response;
  67 use PhpXmlRpc\Value;
  68 use PhpXmlRpc\Helper\Charset;
  69 use PhpXmlRpc\Helper\Date;
  70 use PhpXmlRpc\Helper\Http;
  71 use PhpXmlRpc\Helper\XMLParser;
  72
  73 /* Expose the global variables which used to be defined */
  74 PhpXmlRpc\PhpXmlRpc::$xmlrpc_internalencoding = 'ISO-8859-1'; // old default
  75 PhpXmlRpc\PhpXmlRpc::exportGlobals();
  76
  77 /* some stuff deprecated enough that we do not want to put it in the new lib version */
  78
  79 /// @deprecated
  80 $GLOBALS['xmlEntities'] = array(
  81     'amp'  => '&',
  82     'quot' => '"',
  83     'lt'   => '<',
  84     'gt'   => '>',
  85     'apos' => "'"
  86 );
  87
  88 // formulate backslashes for escaping regexp
  89 // Not in use anymore since 2.0. Shall we remove it?
  90 /// @deprecated
  91 $GLOBALS['xmlrpc_backslash'] = chr(92).chr(92);
  92
  93 /* Expose with the old names the classes which have been namespaced */
  94
  95 /**
  96  * @todo reinstate access to method serializedata ?
  97  */
  98 class xmlrpcval extends Value
  99 {
 100     /**
 101      * @deprecated
 102      * @param xmlrpcval $o
 103      * @return string
 104      */
 105     public function serializeval($o)
 106     {
 107         // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
 108         //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
 109         //{
 110         $ar = $o->me;
 111         $val = reset($ar);
 112         $typ = key($ar);
 113
 114         return '<value>' . $this->serializedata($typ, $val) . "</value>\n";
 115         //}
 116     }
 117
 118     /**
 119      * @deprecated this code looks like it is very fragile and has not been fixed
 120      * for a long long time. Shall we remove it for 2.0?
 121      */
 122     public function getval()
 123     {
 124         // UNSTABLE
 125         $b = reset($this->me);
 126         $a = key($this->me);
 127         // contributed by I Sofer, 2001-03-24
 128         // add support for nested arrays to scalarval
 129         // i've created a new method here, so as to
 130         // preserve back compatibility
 131
 132         if (is_array($b)) {
 133             foreach($b as $id => $cont) {
 134                 $b[$id] = $cont->scalarval();
 135             }
 136         }
 137
 138         // add support for structures directly encoding php objects
 139         if (is_object($b)) {
 140             $t = get_object_vars($b);
 141             foreach($t as $id => $cont) {
 142                 $t[$id] = $cont->scalarval();
 143             }
 144             foreach($t as $id => $cont) {
 145                 @$b->$id = $cont;
 146             }
 147         }
 148         // end contrib
 149         return $b;
 150     }
 151
 152     /// reset functionality added by parent class: same as it would happen if no interface was declared
 153     public function count()
 154     {
 155         return 1;
 156     }
 157
 158     /// reset functionality added by parent class: same as it would happen if no interface was declared
 159     public function getIterator()
 160     {
 161         return new ArrayIterator($this);
 162     }
 163 }
 164
 165 /**
 166  * @todo reinstate access to method parseResponseHeaders ?
 167  */
 168 class xmlrpcmsg extends Request
 169 {
 170 }
 171
 172 class xmlrpcresp extends Response
 173 {
 174 }
 175
 176 /**
 177  * @todo reinstate access to methods sendPayloadHTTP10, sendPayloadHTTPS, sendPayloadCURL, _try_multicall ?
 178  */
 179 class xmlrpc_client extends Client
 180 {
 181 }
 182
 183 /* Expose as global functions the ones which are now class methods */
 184
 185 /// Wrong speling, but we are adamant on backwards compatibility!
 186 function xmlrpc_encode_entitites($data, $srcEncoding='', $destEncoding='')
 187 {
 188     return Charset::instance()->encodeEntities($data, $srcEncoding, $destEncoding);
 189 }
 190
 191 function iso8601_encode($timeT, $utc=0)
 192 {
 193     return Date::iso8601Encode($timeT, $utc);
 194 }
 195
 196 function iso8601_decode($iDate, $utc=0)
 197 {
 198     return Date::iso8601Decode($iDate, $utc);
 199 }
 200
 201 function decode_chunked($buffer)
 202 {
 203     return Http::decodeChunked($buffer);
 204 }
 205
 206 function php_xmlrpc_decode($xmlrpcVal, $options=array())
 207 {
 208     $encoder = new Encoder();
 209     return $encoder->decode($xmlrpcVal, $options);
 210 }
 211
 212 function php_xmlrpc_encode($phpVal, $options=array())
 213 {
 214     $encoder = new Encoder();
 215     return $encoder->encode($phpVal, $options);
 216 }
 217
 218 function php_xmlrpc_decode_xml($xmlVal, $options=array())
 219 {
 220     $encoder = new Encoder();
 221     return $encoder->decodeXml($xmlVal, $options);
 222 }
 223
 224 function guess_encoding($httpHeader='', $xmlChunk='', $encodingPrefs=null)
 225 {
 226     return XMLParser::guessEncoding($httpHeader, $xmlChunk, $encodingPrefs);
 227 }
 228
 229 function has_encoding($xmlChunk)
 230 {
 231     return XMLParser::hasEncoding($xmlChunk);
 232 }
 233
 234 function is_valid_charset($encoding, $validList)
 235 {
 236     return Charset::instance()->isValidCharset($encoding, $validList);
 237 }