xmlrpc.inc 30 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
Dries's avatar
   
Dries committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
// by Edd Dumbill (C) 1999-2001
// <edd@usefulinc.com>
// $Id$


// Copyright (c) 1999,2000,2001 Edd Dumbill.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
//    * Redistributions of source code must retain the above copyright
//      notice, this list of conditions and the following disclaimer.
//
//    * Redistributions in binary form must reproduce the above
//      copyright notice, this list of conditions and the following
//      disclaimer in the documentation and/or other materials provided
//      with the distribution.
//
//    * Neither the name of the "XML-RPC for PHP" nor the names of its
//      contributors may be used to endorse or promote products derived
//      from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.

if (!function_exists('xml_parser_create')) {
Dries's avatar
Dries committed
40
  dl("xml.so");
Dries's avatar
   
Dries committed
41
42
43
44
45
46
47
48
49
50
51
52
53
54
}

$xmlrpcI4="i4";
$xmlrpcInt="int";
$xmlrpcBoolean="boolean";
$xmlrpcDouble="double";
$xmlrpcString="string";
$xmlrpcDateTime="dateTime.iso8601";
$xmlrpcBase64="base64";
$xmlrpcArray="array";
$xmlrpcStruct="struct";


$xmlrpcTypes=array($xmlrpcI4 => 1,
Dries's avatar
   
Dries committed
55
56
57
58
59
60
61
62
    $xmlrpcInt => 1,
    $xmlrpcBoolean => 1,
    $xmlrpcString => 1,
    $xmlrpcDouble => 1,
    $xmlrpcDateTime => 1,
    $xmlrpcBase64 => 1,
    $xmlrpcArray => 2,
    $xmlrpcStruct => 3);
Dries's avatar
   
Dries committed
63
64

$xmlEntities=array(   "amp" => "&",
Dries's avatar
   
Dries committed
65
66
67
68
    "quot" => '"',
    "lt" => "<",
    "gt" => ">",
    "apos" => "'");
Dries's avatar
   
Dries committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

$xmlrpcerr["unknown_method"]=1;
$xmlrpcstr["unknown_method"]="Unknown method";
$xmlrpcerr["invalid_return"]=2;
$xmlrpcstr["invalid_return"]="Invalid return payload: enabling debugging to examine incoming payload";
$xmlrpcerr["incorrect_params"]=3;
$xmlrpcstr["incorrect_params"]="Incorrect parameters passed to method";
$xmlrpcerr["introspect_unknown"]=4;
$xmlrpcstr["introspect_unknown"]="Can't introspect: method unknown";
$xmlrpcerr["http_error"]=5;
$xmlrpcstr["http_error"]="Didn't receive 200 OK from remote server.";
$xmlrpcerr["no_data"]=6;
$xmlrpcstr["no_data"]="No data received from server.";
$xmlrpcerr["no_ssl"]=7;
$xmlrpcstr["no_ssl"]="No SSL support compiled in.";
$xmlrpcerr["curl_fail"]=8;
$xmlrpcstr["curl_fail"]="CURL error";

$xmlrpcName="XML-RPC for PHP";
$xmlrpcVersion="1.02";

// let user errors start at 800
$xmlrpcerruser=800;
// let XML parse errors start at 100
$xmlrpcerrxml=100;

// formulate backslashes for escaping regexp
$xmlrpc_backslash=chr(92).chr(92);

// used to store state during parsing
// quick explanation of components:
//   st - used to build up a string for evaluation
//   ac - used to accumulate values
//   qt - used to decide if quotes are needed for evaluation
//   cm - used to denote struct or array (comma needed)
//   isf - used to indicate a fault
//   lv - used to indicate "looking for a value": implements
//        the logic to allow values with no types to be strings
//   params - used to store parameters in method calls
//   method - used to store method name

$_xh=array();

function xmlrpc_entity_decode($string) {
  $top=split("&", $string);
  $op="";
  $i=0;
  while($i<sizeof($top)) {
Dries's avatar
   
Dries committed
117
118
119
120
121
122
123
124
125
126
127
    if (ereg("^([#a-zA-Z0-9]+);", $top[$i], $regs)) {
      $op.=ereg_replace("^[#a-zA-Z0-9]+;",
          xmlrpc_lookup_entity($regs[1]),
          $top[$i]);
    } else {
      if ($i==0)
        $op=$top[$i];
      else
        $op.="&" . $top[$i];
    }
    $i++;
Dries's avatar
   
Dries committed
128
129
130
131
132
133
134
135
  }
  return $op;
}

function xmlrpc_lookup_entity($ent) {
  global $xmlEntities;

  if (isset($xmlEntities[strtolower($ent)]))
Dries's avatar
   
Dries committed
136
    return $xmlEntities[strtolower($ent)];
Dries's avatar
   
Dries committed
137
  if (ereg("^#([0-9]+)$", $ent, $regs))
Dries's avatar
   
Dries committed
138
    return chr($regs[1]);
Dries's avatar
   
Dries committed
139
140
141
142
143
144
145
  return "?";
}

function xmlrpc_se($parser, $name, $attrs) {
  global $_xh, $xmlrpcDateTime, $xmlrpcString;

  switch($name) {
Dries's avatar
   
Dries committed
146
147
148
    case "STRUCT":
      case "ARRAY":
      $_xh[$parser]['st'].="array(";
Dries's avatar
   
Dries committed
149
150
151
152
153
154
    $_xh[$parser]['cm']++;
    // this last line turns quoting off
    // this means if we get an empty array we'll
    // simply get a bit of whitespace in the eval
    $_xh[$parser]['qt']=0;
    break;
Dries's avatar
   
Dries committed
155
156
    case "NAME":
      $_xh[$parser]['st'].="'"; $_xh[$parser]['ac']="";
Dries's avatar
   
Dries committed
157
    break;
Dries's avatar
   
Dries committed
158
159
    case "FAULT":
      $_xh[$parser]['isf']=1;
Dries's avatar
   
Dries committed
160
    break;
Dries's avatar
   
Dries committed
161
162
    case "PARAM":
      $_xh[$parser]['st']="";
Dries's avatar
   
Dries committed
163
    break;
Dries's avatar
   
Dries committed
164
165
    case "VALUE":
      $_xh[$parser]['st'].="new xmlrpcval(";
Dries's avatar
   
Dries committed
166
167
168
169
170
171
172
173
174
    $_xh[$parser]['vt']=$xmlrpcString;
    $_xh[$parser]['ac']="";
    $_xh[$parser]['qt']=0;
    $_xh[$parser]['lv']=1;
    // look for a value: if this is still 1 by the
    // time we reach the first data segment then the type is string
    // by implication and we need to add in a quote
    break;

Dries's avatar
   
Dries committed
175
176
177
178
179
180
181
182
    case "I4":
      case "INT":
      case "STRING":
      case "BOOLEAN":
      case "DOUBLE":
      case "DATETIME.ISO8601":
      case "BASE64":
      $_xh[$parser]['ac']=""; // reset the accumulator
Dries's avatar
   
Dries committed
183
184
185
186
187
188
189
190
191
192
193
194
195
196

    if ($name=="DATETIME.ISO8601" || $name=="STRING") {
      $_xh[$parser]['qt']=1;
      if ($name=="DATETIME.ISO8601")
        $_xh[$parser]['vt']=$xmlrpcDateTime;
    } else if ($name=="BASE64") {
      $_xh[$parser]['qt']=2;
    } else {
      // No quoting is required here -- but
      // at the end of the element we must check
      // for data format errors.
      $_xh[$parser]['qt']=0;
    }
    break;
Dries's avatar
   
Dries committed
197
198
    case "MEMBER":
      $_xh[$parser]['ac']="";
Dries's avatar
   
Dries committed
199
    break;
Dries's avatar
   
Dries committed
200
    default:
Dries's avatar
   
Dries committed
201
202
203
204
205
206
207
208
209
210
    break;
  }

  if ($name!="VALUE") $_xh[$parser]['lv']=0;
}

function xmlrpc_ee($parser, $name) {
  global $_xh,$xmlrpcTypes,$xmlrpcString;

  switch($name) {
Dries's avatar
   
Dries committed
211
212
213
214
215
    case "STRUCT":
      case "ARRAY":
      if ($_xh[$parser]['cm'] && substr($_xh[$parser]['st'], -1) ==',') {
        $_xh[$parser]['st']=substr($_xh[$parser]['st'],0,-1);
      }
Dries's avatar
   
Dries committed
216
217
218
219
    $_xh[$parser]['st'].=")";
    $_xh[$parser]['vt']=strtolower($name);
    $_xh[$parser]['cm']--;
    break;
Dries's avatar
   
Dries committed
220
221
    case "NAME":
      $_xh[$parser]['st'].= $_xh[$parser]['ac'] . "' => ";
Dries's avatar
   
Dries committed
222
    break;
Dries's avatar
   
Dries committed
223
224
225
226
227
228
229
    case "BOOLEAN":
      // special case here: we translate boolean 1 or 0 into PHP
      // constants true or false
      if ($_xh[$parser]['ac']=='1')
        $_xh[$parser]['ac']="true";
      else
        $_xh[$parser]['ac']="false";
Dries's avatar
   
Dries committed
230
231
    $_xh[$parser]['vt']=strtolower($name);
    // Drop through intentionally.
Dries's avatar
   
Dries committed
232
233
234
235
236
237
238
239
240
241
242
243
    case "I4":
      case "INT":
      case "STRING":
      case "DOUBLE":
      case "DATETIME.ISO8601":
      case "BASE64":
      if ($_xh[$parser]['qt']==1) {
        // we use double quotes rather than single so backslashification works OK
        $_xh[$parser]['st'].="\"". $_xh[$parser]['ac'] . "\"";
      } else if ($_xh[$parser]['qt']==2) {
        $_xh[$parser]['st'].="base64_decode('". $_xh[$parser]['ac'] . "')";
      } else if ($name=="BOOLEAN") {
Dries's avatar
   
Dries committed
244
        $_xh[$parser]['st'].=$_xh[$parser]['ac'];
Dries's avatar
   
Dries committed
245
246
247
248
249
250
251
252
253
254
255
256
      } else {
        // we have an I4, INT or a DOUBLE
        // we must check that only 0123456789-.<space> are characters here
        if (!ereg("^\-?[0123456789 \t\.]+$", $_xh[$parser]['ac'])) {
          // TODO: find a better way of throwing an error
          // than this!
          error_log("XML-RPC: non numeric value received in INT or DOUBLE");
          $_xh[$parser]['st'].="ERROR_NON_NUMERIC_FOUND";
        } else {
          // it's ok, add it on
          $_xh[$parser]['st'].=$_xh[$parser]['ac'];
        }
Dries's avatar
   
Dries committed
257
258
259
260
      }
    $_xh[$parser]['ac']=""; $_xh[$parser]['qt']=0;
    $_xh[$parser]['lv']=3; // indicate we've found a value
    break;
Dries's avatar
   
Dries committed
261
262
263
264
265
266
    case "VALUE":
      // deal with a string value
      if (strlen($_xh[$parser]['ac'])>0 &&
          $_xh[$parser]['vt']==$xmlrpcString) {
        $_xh[$parser]['st'].="\"". $_xh[$parser]['ac'] . "\"";
      }
Dries's avatar
   
Dries committed
267
268
269
270
271
272
273
274
    // This if() detects if no scalar was inside <VALUE></VALUE>
    // and pads an empty "".
    if($_xh[$parser]['st'][strlen($_xh[$parser]['st'])-1] == '(') {
      $_xh[$parser]['st'].= '""';
    }
    $_xh[$parser]['st'].=", '" . $_xh[$parser]['vt'] . "')";
    if ($_xh[$parser]['cm']) $_xh[$parser]['st'].=",";
    break;
Dries's avatar
   
Dries committed
275
276
    case "MEMBER":
      $_xh[$parser]['ac']=""; $_xh[$parser]['qt']=0;
Dries's avatar
   
Dries committed
277
    break;
Dries's avatar
   
Dries committed
278
279
    case "DATA":
      $_xh[$parser]['ac']=""; $_xh[$parser]['qt']=0;
Dries's avatar
   
Dries committed
280
    break;
Dries's avatar
   
Dries committed
281
282
    case "PARAM":
      $_xh[$parser]['params'][]=$_xh[$parser]['st'];
Dries's avatar
   
Dries committed
283
    break;
Dries's avatar
   
Dries committed
284
285
286
287
288
289
290
291
292
293
294
    case "METHODNAME":
      $_xh[$parser]['method']=ereg_replace("^[\n\r\t ]+", "",
          $_xh[$parser]['ac']);
    break;
    case "BOOLEAN":
      // special case here: we translate boolean 1 or 0 into PHP
      // constants true or false
      if ($_xh[$parser]['ac']=='1')
        $_xh[$parser]['ac']="true";
      else
        $_xh[$parser]['ac']="false";
Dries's avatar
   
Dries committed
295
296
    $_xh[$parser]['vt']=strtolower($name);
    break;
Dries's avatar
   
Dries committed
297
    default:
Dries's avatar
   
Dries committed
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
    break;
  }
  // if it's a valid type name, set the type
  if (isset($xmlrpcTypes[strtolower($name)])) {
    $_xh[$parser]['vt']=strtolower($name);
  }

}

function xmlrpc_cd($parser, $data)
{
  global $_xh, $xmlrpc_backslash;

  //if (ereg("^[\n\r \t]+$", $data)) return;
  // print "adding [${data}]\n";

  if ($_xh[$parser]['lv']!=3) {
    // "lookforvalue==3" means that we've found an entire value
    // and should discard any further character data
    if ($_xh[$parser]['lv']==1) {
      // if we've found text and we're just in a <value> then
      // turn quoting on, as this will be a string
      $_xh[$parser]['qt']=1;
      // and say we've found a value
      $_xh[$parser]['lv']=2;
    }
Dries's avatar
   
Dries committed
324
325
326
327
328
    // replace characters that eval would
    // do special things with
    $_xh[$parser]['ac'].=str_replace('$', '\$',
        str_replace('"', '\"', str_replace(chr(92),
            $xmlrpc_backslash, $data)));
Dries's avatar
   
Dries committed
329
330
331
332
333
334
335
336
337
338
339
340
341
  }
}

function xmlrpc_dh($parser, $data)
{
  global $_xh;
  if (substr($data, 0, 1) == "&" && substr($data, -1, 1) == ";") {
    if ($_xh[$parser]['lv']==1) {
      $_xh[$parser]['qt']=1;
      $_xh[$parser]['lv']=2;
    }
    $_xh[$parser]['ac'].=str_replace('$', '\$',
        str_replace('"', '\"', str_replace(chr(92),
Dries's avatar
   
Dries committed
342
            $xmlrpc_backslash, $data)));
Dries's avatar
   
Dries committed
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
  }
}

class xmlrpc_client {
  var $path;
  var $server;
  var $port;
  var $errno;
  var $errstring;
  var $debug=0;
  var $username="";
  var $password="";
  var $cert="";
  var $certpass="";

  function xmlrpc_client($path, $server, $port=0) {
    $this->port=$port; $this->server=$server; $this->path=$path;
  }

  function setDebug($in) {
    if ($in) {
      $this->debug=1;
    } else {
      $this->debug=0;
    }
  }

  function setCredentials($u, $p) {
    $this->username=$u;
    $this->password=$p;
  }

  function setCertificate($cert, $certpass) {
    $this->cert = $cert;
    $this->certpass = $certpass;
  }

  function send($msg, $timeout=0, $method='http') {
    // where msg is an xmlrpcmsg
    $msg->debug=$this->debug;

    if ($method == 'https') {
      return $this->sendPayloadHTTPS($msg,
Dries's avatar
   
Dries committed
386
387
388
389
390
          $this->server,
          $this->port, $timeout,
          $this->username, $this->password,
          $this->cert,
          $this->certpass);
Dries's avatar
   
Dries committed
391
392
    } else {
      return $this->sendPayloadHTTP10($msg, $this->server, $this->port,
Dries's avatar
   
Dries committed
393
394
          $timeout, $this->username,
          $this->password);
Dries's avatar
   
Dries committed
395
396
397
398
    }
  }

  function sendPayloadHTTP10($msg, $server, $port, $timeout=0,
Dries's avatar
   
Dries committed
399
      $username="", $password="") {
Dries's avatar
   
Dries committed
400
401
402
    if ($port==0) $port=80;
    if($timeout>0)
      $fp=fsockopen($server, $port,
Dries's avatar
   
Dries committed
403
          $this->errno, $this->errstr, $timeout);
Dries's avatar
   
Dries committed
404
405
    else
      $fp=fsockopen($server, $port,
Dries's avatar
   
Dries committed
406
          $this->errno, $this->errstr);
Dries's avatar
   
Dries committed
407
408
409
410
411
412
413
414
415
416
417
    if (!$fp) {
      return 0;
    }
    // Only create the payload if it was not created previously
    if(empty($msg->payload)) $msg->createPayload();

    // thanks to Grant Rauscher <grant7@firstworld.net>
    // for this
    $credentials="";
    if ($username!="") {
      $credentials="Authorization: Basic " .
Dries's avatar
   
Dries committed
418
        base64_encode($username . ":" . $password) . "\r\n";
Dries's avatar
   
Dries committed
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
    }

    $op= "POST " . $this->path. " HTTP/1.0\r\nUser-Agent: PHP XMLRPC 1.0\r\n" .
      "Host: ". $this->server  . "\r\n" .
      $credentials .
      "Content-Type: text/xml\r\nContent-Length: " .
      strlen($msg->payload) . "\r\n\r\n" .
      $msg->payload;

    if (!fputs($fp, $op, strlen($op))) {
      $this->errstr="Write error";
      return 0;
    }
    $resp=$msg->parseResponseFile($fp);
    fclose($fp);
    return $resp;
  }

  // contributed by Justin Miller <justin@voxel.net>
  // requires curl to be built into PHP
  function sendPayloadHTTPS($msg, $server, $port, $timeout=0,
Dries's avatar
   
Dries committed
440
441
      $username="", $password="", $cert="",
      $certpass="") {
Dries's avatar
   
Dries committed
442
443
444
445
446
447
448
449
    global $xmlrpcerr, $xmlrpcstr;
    if ($port == 0) $port = 443;

    // Only create the payload if it was not created previously
    if(empty($msg->payload)) $msg->createPayload();

    if (!function_exists("curl_init")) {
      $r=new xmlrpcresp(0, $xmlrpcerr["no_ssl"],
Dries's avatar
   
Dries committed
450
          $xmlrpcstr["no_ssl"]);
Dries's avatar
   
Dries committed
451
452
453
454
      return $r;
    }

    $curl = curl_init("https://" . $server . ':' . $port .
Dries's avatar
   
Dries committed
455
        $this->path);
Dries's avatar
   
Dries committed
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472

    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    // results into variable
    if ($this->debug) {
      curl_setopt($curl, CURLOPT_VERBOSE, 1);
    }
    curl_setopt($curl, CURLOPT_USERAGENT, 'PHP XMLRPC 1.0');
    // required for XMLRPC
    curl_setopt($curl, CURLOPT_POST, 1);
    // post the data
    curl_setopt($curl, CURLOPT_POSTFIELDS, $msg->payload);
    // the data
    curl_setopt($curl, CURLOPT_HEADER, 1);
    // return the header too
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: text/xml'));
    // required for XMLRPC
    if ($timeout) curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 :
Dries's avatar
   
Dries committed
473
        $timeout - 1);
Dries's avatar
   
Dries committed
474
475
    // timeout is borked
    if ($username && $password) curl_setopt($curl, CURLOPT_USERPWD,
Dries's avatar
   
Dries committed
476
        "$username:$password");
Dries's avatar
   
Dries committed
477
478
479
480
    // set auth stuff
    if ($cert) curl_setopt($curl, CURLOPT_SSLCERT, $cert);
    // set cert file
    if ($certpass) curl_setopt($curl, CURLOPT_SSLCERTPASSWD,
Dries's avatar
   
Dries committed
481
        $certpass);
Dries's avatar
   
Dries committed
482
483
484
485
486
487
    // set cert password

    $result = curl_exec($curl);

    if (!$result) {
      $resp=new xmlrpcresp(0,
Dries's avatar
   
Dries committed
488
489
490
          $xmlrpcerr["curl_fail"],
          $xmlrpcstr["curl_fail"]. ": ".
          curl_error($curl));
Dries's avatar
   
Dries committed
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
    } else {
      $resp = $msg->parseResponse($result);
    }
    curl_close($curl);
    return $resp;
  }

} // end class xmlrpc_client

class xmlrpcresp {
  var $xv;
  var $fn;
  var $fs;
  var $hdrs;

  function xmlrpcresp($val, $fcode=0, $fstr="") {
    if ($fcode!=0) {
      $this->xv=0;
      $this->fn=$fcode;
      $this->fs=htmlspecialchars($fstr);
    } else {
      $this->xv=$val;
      $this->fn=0;
    }
  }

  function faultCode() {
    if (isset($this->fn))
      return $this->fn;
    else
      return 0;
  }

  function faultString() { return $this->fs; }
  function value() { return $this->xv; }

  function serialize() {
Dries's avatar
   
Dries committed
528
529
530
531
532
533
    $rs="<methodResponse>\n";
    if ($this->fn) {
      $rs.="<fault>
        <value>
        <struct>
        <member>
Dries's avatar
   
Dries committed
534
535
        <name>faultCode</name>
        <value><int>" . $this->fn . "</int></value>
Dries's avatar
   
Dries committed
536
537
        </member>
        <member>
Dries's avatar
   
Dries committed
538
539
        <name>faultString</name>
        <value><string>" . $this->fs . "</string></value>
Dries's avatar
   
Dries committed
540
541
542
543
544
545
546
547
548
549
        </member>
        </struct>
        </value>
        </fault>";
    } else {
      $rs.="<params>\n<param>\n" . $this->xv->serialize() .
        "</param>\n</params>";
    }
    $rs.="\n</methodResponse>";
    return $rs;
Dries's avatar
   
Dries committed
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
  }
}

class xmlrpcmsg {
  var $payload;
  var $methodname;
  var $params=array();
  var $debug=0;

  function xmlrpcmsg($meth, $pars=0) {
    $this->methodname=$meth;
    if (is_array($pars) && sizeof($pars)>0) {
      for($i=0; $i<sizeof($pars); $i++)
        $this->addParam($pars[$i]);
    }
  }

  function xml_header() {
Dries's avatar
   
Dries committed
568
    return "<?xml version=\"1.0\"?>\n<methodCall>\n";
Dries's avatar
   
Dries committed
569
570
571
  }

  function xml_footer() {
Dries's avatar
   
Dries committed
572
    return "</methodCall>\n";
Dries's avatar
   
Dries committed
573
574
575
  }

  function createPayload() {
Dries's avatar
   
Dries committed
576
577
578
    $this->payload=$this->xml_header();
    $this->payload.="<methodName>" . $this->methodname . "</methodName>\n";
    //  if (sizeof($this->params)) {
Dries's avatar
   
Dries committed
579
580
    $this->payload.="<params>\n";
    for($i=0; $i<sizeof($this->params); $i++) {
Dries's avatar
   
Dries committed
581
582
583
      $p=$this->params[$i];
      $this->payload.="<param>\n" . $p->serialize() .
        "</param>\n";
Dries's avatar
   
Dries committed
584
585
    }
    $this->payload.="</params>\n";
Dries's avatar
   
Dries committed
586
587
588
    // }
    $this->payload.=$this->xml_footer();
    $this->payload=str_replace("\n", "\r\n", $this->payload);
Dries's avatar
   
Dries committed
589
590
591
  }

  function method($meth="") {
Dries's avatar
   
Dries committed
592
593
594
595
    if ($meth!="") {
      $this->methodname=$meth;
    }
    return $this->methodname;
Dries's avatar
   
Dries committed
596
597
598
599
600
601
602
603
604
605
606
607
  }

  function serialize() {
    $this->createPayload();
    return $this->payload;
  }

  function addParam($par) { $this->params[]=$par; }
  function getParam($i) { return $this->params[$i]; }
  function getNumParams() { return sizeof($this->params); }

  function parseResponseFile($fp) {
Dries's avatar
   
Dries committed
608
    $ipd="";
Dries's avatar
   
Dries committed
609

Dries's avatar
   
Dries committed
610
611
612
613
    while($data=fread($fp, 32768)) {
      $ipd.=$data;
    }
    return $this->parseResponse($ipd);
Dries's avatar
   
Dries committed
614
615
616
  }

  function parseResponse($data="") {
Dries's avatar
   
Dries committed
617
618
619
    global $_xh,$xmlrpcerr,$xmlrpcstr;


620
621
    $xmlparser = drupal_xml_parser_create($data);
    $parser = (int)$xmlparser;
Dries's avatar
   
Dries committed
622
623
624
625
626
627
628
629
630
631
632

    $_xh[$parser]=array();

    $_xh[$parser]['st']="";
    $_xh[$parser]['cm']=0;
    $_xh[$parser]['isf']=0;
    $_xh[$parser]['ac']="";
    $_xh[$parser]['qt']="";
    $_xh[$parser]['ha']="";
    $_xh[$parser]['ac']="";

633
634
635
636
    xml_parser_set_option($xmlparser, XML_OPTION_CASE_FOLDING, true);
    xml_set_element_handler($xmlparser, "xmlrpc_se", "xmlrpc_ee");
    xml_set_character_data_handler($xmlparser, "xmlrpc_cd");
    xml_set_default_handler($xmlparser, "xmlrpc_dh");
Dries's avatar
   
Dries committed
637
638
639
640
641
642
643
644
645
    $xmlrpc_value=new xmlrpcval;

    if ($this->debug)
##print "<pre>---GOT---\n" . htmlspecialchars($data) .  "\n---END---\n</pre>";
##print "<p>---GOT---\n" . nl2br(htmlspecialchars($data)) .  "\n---END---\n</p>";
      print "<p>---GOT---\n" . nl2br($data) .  "\n---END---\n</p>";
    if ($data=="") {
      error_log("No response received from server.");
      $r=new xmlrpcresp(0, $xmlrpcerr["no_data"],
Dries's avatar
   
Dries committed
646
          $xmlrpcstr["no_data"]);
647
      xml_parser_free($xmlparser);
Dries's avatar
   
Dries committed
648
649
650
651
652
653
654
655
656
      return $r;
    }
    // see if we got an HTTP 200 OK, else bomb
    // but only do this if we're using the HTTP protocol.
    if (ereg("^HTTP",$data) &&
        !ereg("^HTTP/[0-9\.]+ 200 ", $data)) {
      $errstr= substr($data, 0, strpos($data, "\n")-1);
      error_log("HTTP error, got response: " .$errstr);
      $r=new xmlrpcresp(0, $xmlrpcerr["http_error"],
Dries's avatar
   
Dries committed
657
          $xmlrpcstr["http_error"]. " (" . $errstr . ")");
658
      xml_parser_free($xmlparser);
Dries's avatar
   
Dries committed
659
660
      return $r;
    }
Dries's avatar
   
Dries committed
661

Dries's avatar
   
Dries committed
662
663
664
665
666
667
668
669
670
671
672
673
674
    // if using HTTP, then gotta get rid of HTTP headers here
    // and we store them in the 'ha' bit of our data array
    if (ereg("^HTTP", $data)) {
      $ar=explode("\r\n", $data);
      $newdata="";
      $hdrfnd=0;
      for ($i=0; $i<sizeof($ar); $i++) {
        if (!$hdrfnd) {
          if (strlen($ar[$i])>0) {
            $_xh[$parser]['ha'].=$ar[$i]. "\r\n";
          } else {
            $hdrfnd=1;
          }
Dries's avatar
   
Dries committed
675
        } else {
Dries's avatar
   
Dries committed
676
          $newdata.=$ar[$i] . "\r\n";
Dries's avatar
   
Dries committed
677
678
        }
      }
Dries's avatar
   
Dries committed
679
      $data=$newdata;
Dries's avatar
   
Dries committed
680
681
    }

682
    if (!xml_parse($xmlparser, $data, sizeof($data))) {
Dries's avatar
   
Dries committed
683
      // thanks to Peter Kocks <peter.kocks@baygate.com>
684
      if((xml_get_current_line_number($xmlparser)) == 1)
Dries's avatar
   
Dries committed
685
686
687
        $errstr = "XML error at line 1, check URL";
      else
        $errstr = sprintf("XML error: %s at line %d",
688
689
            xml_error_string(xml_get_error_code($xmlparser)),
            xml_get_current_line_number($xmlparser));
Dries's avatar
   
Dries committed
690
691
692
      error_log($errstr);
      $r=new xmlrpcresp(0, $xmlrpcerr["invalid_return"],
          $xmlrpcstr["invalid_return"]);
693
      xml_parser_free($xmlparser);
Dries's avatar
   
Dries committed
694
695
      return $r;
    }
696
    xml_parser_free($xmlparser);
Dries's avatar
   
Dries committed
697
698
699
700
701
702
703
704
705
706
707
    if ($this->debug) {
      print "<pre>---EVALING---[" .
        strlen($_xh[$parser]['st']) . " chars]---\n" .
        htmlspecialchars($_xh[$parser]['st']) . ";\n---END---</pre>";
    }
    if (strlen($_xh[$parser]['st'])==0) {
      // then something odd has happened
      // and it's time to generate a client side error
      // indicating something odd went on
      $r=new xmlrpcresp(0, $xmlrpcerr["invalid_return"],
          $xmlrpcstr["invalid_return"]);
Dries's avatar
   
Dries committed
708
    } else {
Dries's avatar
   
Dries committed
709
710
711
712
713
714
715
716
717
      eval('$v=' . $_xh[$parser]['st'] . '; $allOK=1;');
      if ($_xh[$parser]['isf']) {
        $f=$v->structmem("faultCode");
        $fs=$v->structmem("faultString");
        $r=new xmlrpcresp($v, $f->scalarval(),
            $fs->scalarval());
      } else {
        $r=new xmlrpcresp($v);
      }
Dries's avatar
   
Dries committed
718
    }
Dries's avatar
   
Dries committed
719
720
    $r->hdrs=split("\r?\n", $_xh[$parser]['ha']);
    return $r;
Dries's avatar
   
Dries committed
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
  }

}

class xmlrpcval {
  var $me=array();
  var $mytype=0;

  function xmlrpcval($val=-1, $type="") {
    global $xmlrpcTypes;
    $this->me=array();
    $this->mytype=0;
    if ($val!=-1 || $type!="") {
      if ($type=="") $type="string";
      if ($xmlrpcTypes[$type]==1) {
        $this->addScalar($val,$type);
      }
Dries's avatar
   
Dries committed
738
739
      else if ($xmlrpcTypes[$type]==2)
        $this->addArray($val);
Dries's avatar
   
Dries committed
740
741
742
743
744
745
746
747
748
      else if ($xmlrpcTypes[$type]==3)
        $this->addStruct($val);
    }
  }

  function addScalar($val, $type="string") {
    global $xmlrpcTypes, $xmlrpcBoolean;

    if ($this->mytype==1) {
749
      echo "<strong>xmlrpcval</strong>: scalar can have only one value<br />";
Dries's avatar
   
Dries committed
750
751
752
753
      return 0;
    }
    $typeof=$xmlrpcTypes[$type];
    if ($typeof!=1) {
754
      echo "<strong>xmlrpcval</strong>: not a scalar type (${typeof})<br />";
Dries's avatar
   
Dries committed
755
756
757
758
759
760
      return 0;
    }

    if ($type==$xmlrpcBoolean) {
      if (strcasecmp($val,"true")==0 ||
          $val==1 || ($val==true &&
Dries's avatar
   
Dries committed
761
            strcasecmp($val,"false"))) {
Dries's avatar
   
Dries committed
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
        $val=1;
      } else {
        $val=0;
      }
    }

    if ($this->mytype==2) {
      // we're adding to an array here
      $ar=$this->me["array"];
      $ar[]=new xmlrpcval($val, $type);
      $this->me["array"]=$ar;
    } else {
      // a scalar, so set the value and remember we're scalar
      $this->me[$type]=$val;
      $this->mytype=$typeof;
    }
    return 1;
  }

  function addArray($vals) {
    global $xmlrpcTypes;
    if ($this->mytype!=0) {
784
      echo "<strong>xmlrpcval</strong>: already initialized as a [" .
Dries's avatar
   
Dries committed
785
        $this->kindOf() . "]<br />";
Dries's avatar
   
Dries committed
786
787
788
789
790
791
792
793
794
      return 0;
    }

    $this->mytype=$xmlrpcTypes["array"];
    $this->me["array"]=$vals;
    return 1;
  }

  function addStruct($vals) {
Dries's avatar
   
Dries committed
795
796
797
798
799
800
801
802
803
    global $xmlrpcTypes;
    if ($this->mytype!=0) {
      echo "<strong>xmlrpcval</strong>: already initialized as a [" .
        $this->kindOf() . "]<br />";
      return 0;
    }
    $this->mytype=$xmlrpcTypes["struct"];
    $this->me["struct"]=$vals;
    return 1;
Dries's avatar
   
Dries committed
804
805
806
  }

  function dump($ar) {
Dries's avatar
   
Dries committed
807
808
809
810
811
812
813
    reset($ar);
    while ( list( $key, $val ) = each( $ar ) ) {
      echo "$key => $val<br />";
      if ($key == 'array')
        while ( list( $key2, $val2 ) = each( $val ) ) {
          echo "-- $key2 => $val2<br />";
        }
Dries's avatar
   
Dries committed
814
815
816
817
    }
  }

  function kindOf() {
Dries's avatar
   
Dries committed
818
819
820
821
822
823
824
825
826
827
828
829
830
    switch($this->mytype) {
      case 3:
        return "struct";
        break;
      case 2:
        return "array";
        break;
      case 1:
        return "scalar";
        break;
      default:
        return "undef";
    }
Dries's avatar
   
Dries committed
831
832
833
834
835
  }

  function serializedata($typ, $val) {
    $rs="";
    global $xmlrpcTypes, $xmlrpcBase64, $xmlrpcString,
Dries's avatar
   
Dries committed
836
    $xmlrpcBoolean;
Dries's avatar
   
Dries committed
837
    switch($xmlrpcTypes[$typ]) {
Dries's avatar
   
Dries committed
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
      case 3:
        // struct
        $rs.="<struct>\n";
        reset($val);
        while(list($key2, $val2)=each($val)) {
          $rs.="<member><name>${key2}</name>\n";
          $rs.=$this->serializeval($val2);
          $rs.="</member>\n";
        }
        $rs.="</struct>";
        break;
      case 2:
        // array
        $rs.="<array>\n<data>\n";
        for($i=0; $i<sizeof($val); $i++) {
          $rs.=$this->serializeval($val[$i]);
        }
        $rs.="</data>\n</array>";
Dries's avatar
   
Dries committed
856
        break;
Dries's avatar
   
Dries committed
857
858
859
860
861
862
863
864
865
866
867
868
869
870
      case 1:
        switch ($typ) {
          case $xmlrpcBase64:
            $rs.="<${typ}>" . base64_encode($val) . "</${typ}>";
            break;
          case $xmlrpcBoolean:
            $rs.="<${typ}>" . ($val ? "1" : "0") . "</${typ}>";
            break;
          case $xmlrpcString:
            $rs.="<${typ}>" . htmlspecialchars($val). "</${typ}>";
            break;
          default:
            $rs.="<${typ}>${val}</${typ}>";
        }
Dries's avatar
   
Dries committed
871
872
        break;
      default:
Dries's avatar
   
Dries committed
873
        break;
Dries's avatar
   
Dries committed
874
875
876
877
878
    }
    return $rs;
  }

  function serialize() {
Dries's avatar
   
Dries committed
879
    return $this->serializeval($this);
Dries's avatar
   
Dries committed
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
  }

  function serializeval($o) {
    global $xmlrpcTypes;
    $rs="";
    $ar=$o->me;
    reset($ar);
    list($typ, $val) = each($ar);
    $rs.="<value>";
    $rs.=$this->serializedata($typ, $val);
    $rs.="</value>\n";
    return $rs;
  }

  function structmem($m) {
    $nv=$this->me["struct"][$m];
    return $nv;
  }

  function structreset() {
    reset($this->me["struct"]);
  }

  function structeach() {
    return each($this->me["struct"]);
  }

  function getval() {
    // UNSTABLE
    global $xmlrpcBoolean, $xmlrpcBase64;
    reset($this->me);
    list($a,$b)=each($this->me);
    // contributed by I Sofer, 2001-03-24
    // add support for nested arrays to scalarval
914
    // I've created a new method here, so as to
Dries's avatar
   
Dries committed
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
    // preserve back compatibility

    if (is_array($b))    {
      foreach ($b as $id => $cont) {
        $b[$id] = $cont->scalarval();
      }
    }

    // add support for structures directly encoding php objects
    if (is_object($b))  {
      $t = get_object_vars($b);
      foreach ($t as $id => $cont) {
        $t[$id] = $cont->scalarval();
      }
      foreach ($t as $id => $cont) {
        eval('$b->'.$id.' = $cont;');
      }
    }
    // end contrib
    return $b;
  }

  function scalarval() {
    global $xmlrpcBoolean, $xmlrpcBase64;
    reset($this->me);
    list($a,$b)=each($this->me);
    return $b;
  }

  function scalartyp() {
    global $xmlrpcI4, $xmlrpcInt;
    reset($this->me);
    list($a,$b)=each($this->me);
    if ($a==$xmlrpcI4)
      $a=$xmlrpcInt;
    return $a;
  }

  function arraymem($m) {
    $nv=$this->me["array"][$m];
    return $nv;
  }

  function arraysize() {
    reset($this->me);
    list($a,$b)=each($this->me);
    return sizeof($b);
  }
}

// date helpers
function iso8601_encode($timet, $utc=0) {
  // return an ISO8601 encoded string
  // really, timezones ought to be supported
  // but the XML-RPC spec says:
  //
  // "Don't assume a timezone. It should be specified by the server in its
  // documentation what assumptions it makes about timezones."
  //
  // these routines always assume localtime unless
  // $utc is set to 1, in which case UTC is assumed
  // and an adjustment for locale is made when encoding
  if (!$utc) {
    $t=strftime("%Y%m%dT%H:%M:%S", $timet);
  } else {
    if (function_exists("gmstrftime"))
      // gmstrftime doesn't exist in some versions
      // of PHP
      $t=gmstrftime("%Y%m%dT%H:%M:%S", $timet);
    else {
      $t=strftime("%Y%m%dT%H:%M:%S", $timet-date("Z"));
    }
  }
  return $t;
}

function iso8601_decode($idate, $utc=0) {
  // return a timet in the localtime, or UTC
  $t=0;
  if (ereg("([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})",
Dries's avatar
   
Dries committed
995
        $idate, $regs)) {
Dries's avatar
   
Dries committed
996
997
998
999
1000
    if ($utc) {
      $t=gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
    } else {
      $t=mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
    }
For faster browsing, not all history is shown. View entire blame