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