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
  47 include_once(__DIR__.'/../src/PhpXmlRpc.php');
  48 include_once(__DIR__.'/../src/Value.php');
  49 include_once(__DIR__.'/../src/Request.php');
  50 include_once(__DIR__.'/../src/Response.php');
  51 include_once(__DIR__.'/../src/Client.php');
  52 include_once(__DIR__.'/../src/Encoder.php');
  53 include_once(__DIR__.'/../src/Helper/Charset.php');
  54 include_once(__DIR__.'/../src/Helper/Date.php');
  55 include_once(__DIR__.'/../src/Helper/Http.php');
  56 include_once(__DIR__.'/../src/Helper/Logger.php');
  57 include_once(__DIR__.'/../src/Helper/XMLParser.php');
  58
  59 use PhpXmlRpc\Helper\Charset;
  60 use PhpXmlRpc\Helper\Date;
  61 use PhpXmlRpc\Helper\Http;
  62 use PhpXmlRpc\Helper\XMLParser;
  63 use PhpXmlRpc\Encoder;
  64
  65 /* Expose the global variables which used to be defined */
  66 PhpXmlRpc\PhpXmlRpc::$xmlrpc_internalencoding = 'ISO-8859-1'; // old default
  67 PhpXmlRpc\PhpXmlRpc::exportGlobals();
  68
  69 /* some stuff deprecated enough that we do not want to put it in the new lib version */
  70
  71 /// @deprecated
  72 $GLOBALS['xmlEntities'] = array(
  73     'amp'  => '&',
  74     'quot' => '"',
  75     'lt'   => '<',
  76     'gt'   => '>',
  77     'apos' => "'"
  78 );
  79
  80 // formulate backslashes for escaping regexp
  81 // Not in use anymore since 2.0. Shall we remove it?
  82 /// @deprecated
  83 $GLOBALS['xmlrpc_backslash'] = chr(92).chr(92);
  84
  85 /* Expose with the old names the classes which have been namespaced */
  86
  87 class xmlrpcval extends PhpXmlRpc\Value
  88 {
  89     /**
  90      * @deprecated
  91      * @param xmlrpcval $o
  92      * @return string
  93      */
  94     public function serializeval($o)
  95     {
  96         // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
  97         //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
  98         //{
  99         $ar = $o->me;
 100         $val = reset($ar);
 101         $typ = key($ar);
 102
 103         return '<value>' . $this->serializedata($typ, $val) . "</value>\n";
 104         //}
 105     }
 106
 107     /**
 108      * @deprecated this code looks like it is very fragile and has not been fixed
 109      * for a long long time. Shall we remove it for 2.0?
 110      */
 111     public function getval()
 112     {
 113         // UNSTABLE
 114         $b = reset($this->me);
 115         $a = key($this->me);
 116         // contributed by I Sofer, 2001-03-24
 117         // add support for nested arrays to scalarval
 118         // i've created a new method here, so as to
 119         // preserve back compatibility
 120
 121         if (is_array($b)) {
 122             foreach($b as $id => $cont) {
 123                 $b[$id] = $cont->scalarval();
 124             }
 125         }
 126
 127         // add support for structures directly encoding php objects
 128         if (is_object($b)) {
 129             $t = get_object_vars($b);
 130             foreach($t as $id => $cont) {
 131                 $t[$id] = $cont->scalarval();
 132             }
 133             foreach($t as $id => $cont) {
 134                 @$b->$id = $cont;
 135             }
 136         }
 137         // end contrib
 138         return $b;
 139     }
 140
 141     /// reset functionality added by parent class: same as it would happen if no interface was declared
 142     public function count()
 143     {
 144         return 1;
 145     }
 146
 147     /// reset functionality added by parent class: same as it would happen if no interface was declared
 148     public function getIterator() {
 149         return new ArrayIterator($this);
 150     }
 151 }
 152
 153 class xmlrpcmsg extends PhpXmlRpc\Request
 154 {
 155 }
 156
 157 class xmlrpcresp extends PhpXmlRpc\Response
 158 {
 159 }
 160
 161 class xmlrpc_client extends PhpXmlRpc\Client
 162 {
 163 }
 164
 165 /* Expose as global functions the ones which are now class methods */
 166
 167 /// Wrong speling, but we are adamant on backwards compatibility!
 168 function xmlrpc_encode_entitites($data, $srcEncoding='', $destEncoding='')
 169 {
 170     return Charset::instance()->encodeEntities($data, $srcEncoding, $destEncoding);
 171 }
 172
 173 function iso8601_encode($timeT, $utc=0)
 174 {
 175     return Date::iso8601Encode($timeT, $utc);
 176 }
 177
 178 function iso8601_decode($iDate, $utc=0)
 179 {
 180     return Date::iso8601Decode($iDate, $utc);
 181 }
 182
 183 function decode_chunked($buffer)
 184 {
 185     return Http::decodeChunked($buffer);
 186 }
 187
 188 function php_xmlrpc_decode($xmlrpcVal, $options=array())
 189 {
 190     $encoder = new Encoder();
 191     return $encoder->decode($xmlrpcVal, $options);
 192 }
 193
 194 function php_xmlrpc_encode($phpVal, $options=array())
 195 {
 196     $encoder = new Encoder();
 197     return $encoder->encode($phpVal, $options);
 198 }
 199
 200 function php_xmlrpc_decode_xml($xmlVal, $options=array())
 201 {
 202     $encoder = new Encoder();
 203     return $encoder->decodeXml($xmlVal, $options);
 204 }
 205
 206 function guess_encoding($httpHeader='', $xmlChunk='', $encodingPrefs=null)
 207 {
 208     return XMLParser::guessEncoding($httpHeader, $xmlChunk, $encodingPrefs);
 209 }
 210
 211 function has_encoding($xmlChunk)
 212 {
 213     return XMLParser::hasEncoding($xmlChunk);
 214 }
 215
 216 function is_valid_charset($encoding, $validList)
 217 {
 218     return Charset::instance()->isValidCharset($encoding, $validList);
 219 }