Skip to content
Snippets Groups Projects
Commit 1b7510ee authored by Dries Buytaert's avatar Dries Buytaert
Browse files 

- Added an XML-RPC server.  Modules that want to export remote procedure
  calls can implement the new 'xmlrpc' hook.

  Example:

   function mymodule_xmlrpc() {
     return array("drupal.myfunction" => array("function" => "mymodule_myfunction"));
   }
parent 8df2ec0e
Branches
Tags
2 merge requests!7452Issue #1797438. HTML5 validation is preventing form submit and not fully...,!789Issue #3210310: Adjust Database API to remove deprecated Drupal 9 code in Drupal 10
Show whitespace changes
Inline Side-by-side
includes/xmlrpc.inc 0 → 100644
+ 973
− 0
View file @ 1b7510ee
<?php // -*-c++-*-
// by Edd Dumbill (C) 1999-2001
// <edd@usefulinc.com>
// $Id$
// License is granted to use or modify this software ("XML-RPC for PHP")
// for commercial or non-commercial use provided the copyright of the author
// is preserved in any distributed or derivative work.
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESSED 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 AUTHOR 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')) {
// Win 32 fix. From: "Leo West" <lwest@imaginet.fr>
if($WINDIR) {
dl("php3_xml.dll");
} else {
dl("xml.so");
}
}
$xmlrpcI4="i4";
$xmlrpcInt="int";
$xmlrpcBoolean="boolean";
$xmlrpcDouble="double";
$xmlrpcString="string";
$xmlrpcDateTime="dateTime.iso8601";
$xmlrpcBase64="base64";
$xmlrpcArray="array";
$xmlrpcStruct="struct";
$xmlrpcTypes=array($xmlrpcI4 => 1,
$xmlrpcInt => 1,
$xmlrpcBoolean => 1,
$xmlrpcString => 1,
$xmlrpcDouble => 1,
$xmlrpcDateTime => 1,
$xmlrpcBase64 => 1,
$xmlrpcArray => 2,
$xmlrpcStruct => 3);
$xmlEntities=array( "amp" => "&",
"quot" => '"',
"lt" => "<",
"gt" => ">",
"apos" => "'");
$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.";
$xmlrpc_defencoding="UTF-8";
$xmlrpcName="XML-RPC for PHP";
$xmlrpcVersion="1.0b9";
// 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)) {
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++;
}
return $op;
}
function xmlrpc_lookup_entity($ent) {
global $xmlEntities;
if (isset($xmlEntities[strtolower($ent)]))
return $xmlEntities[strtolower($ent)];
if (ereg("^#([0-9]+)$", $ent, $regs))
return chr($regs[1]);
return "?";
}
function xmlrpc_se($parser, $name, $attrs) {
global $_xh, $xmlrpcDateTime, $xmlrpcString;
switch($name) {
case "STRUCT":
case "ARRAY":
$_xh[$parser]['st'].="array(";
$_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;
case "NAME":
$_xh[$parser]['st'].="'"; $_xh[$parser]['ac']="";
break;
case "FAULT":
$_xh[$parser]['isf']=1;
break;
case "PARAM":
$_xh[$parser]['st']="";
break;
case "VALUE":
$_xh[$parser]['st'].="new xmlrpcval(";
$_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;
case "I4":
case "INT":
case "STRING":
case "BOOLEAN":
case "DOUBLE":
case "DATETIME.ISO8601":
case "BASE64":
$_xh[$parser]['ac']=""; // reset the accumulator
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;
case "MEMBER":
$_xh[$parser]['ac']="";
break;
default:
break;
}
if ($name!="VALUE") $_xh[$parser]['lv']=0;
}
function xmlrpc_ee($parser, $name) {
global $_xh,$xmlrpcTypes,$xmlrpcString;
switch($name) {
case "STRUCT":
case "ARRAY":
if ($_xh[$parser]['cm'] && substr($_xh[$parser]['st'], -1) ==',') {
$_xh[$parser]['st']=substr($_xh[$parser]['st'],0,-1);
}
$_xh[$parser]['st'].=")";
$_xh[$parser]['vt']=strtolower($name);
$_xh[$parser]['cm']--;
break;
case "NAME":
$_xh[$parser]['st'].= $_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";
$_xh[$parser]['vt']=strtolower($name);
// Drop through intentionally.
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") {
$_xh[$parser]['st'].=$_xh[$parser]['ac'];
} 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'];
}
}
$_xh[$parser]['ac']=""; $_xh[$parser]['qt']=0;
$_xh[$parser]['lv']=3; // indicate we've found a value
break;
case "VALUE":
// deal with a string value
if (strlen($_xh[$parser]['ac'])>0 &&
$_xh[$parser]['vt']==$xmlrpcString) {
$_xh[$parser]['st'].="\"". $_xh[$parser]['ac'] . "\"";
}
// 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;
case "MEMBER":
$_xh[$parser]['ac']=""; $_xh[$parser]['qt']=0;
break;
case "DATA":
$_xh[$parser]['ac']=""; $_xh[$parser]['qt']=0;
break;
case "PARAM":
$_xh[$parser]['params'][]=$_xh[$parser]['st'];
break;
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";
$_xh[$parser]['vt']=strtolower($name);
break;
default:
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;
}
if (isset($_xh[$parser]['qt']) &&
$_xh[$parser]['qt']) {
// quoted string: replace characters that eval would
// do special things with
$_xh[$parser]['ac'].=str_replace('$', '\$',
str_replace('"', '\"',
str_replace(chr(92),$xmlrpc_backslash, $data)));
}
else
$_xh[$parser]['ac'].=$data;
}
}
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'].=$data;
}
}
class xmlrpc_client {
var $path;
var $server;
var $port;
var $errno;
var $errstring;
var $debug=0;
var $username="";
var $password="";
function xmlrpc_client($path, $server, $port=80) {
$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 send($msg, $timeout=0) {
// where msg is an xmlrpcmsg
$msg->debug=$this->debug;
return $this->sendPayloadHTTP10($msg, $this->server, $this->port,
$timeout, $this->username,
$this->password);
}
function sendPayloadHTTP10($msg, $server, $port, $timeout=0,
$username="", $password="") {
if($timeout>0)
$fp=fsockopen($server, $port,
&$this->errno, &$this->errstr, $timeout);
else
$fp=fsockopen($server, $port,
&$this->errno, &$this->errstr);
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 " .
base64_encode($username . ":" . $password) . "\r\n";
}
$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;
}
} // end class xmlrpc_client
class xmlrpcresp {
var $xv;
var $fn;
var $fs;
var $hdrs;
function xmlrpcresp($val, $fcode=0, $fstr="") {
if ($fcode!=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() {
$rs="<methodResponse>\n";
if ($this->fn) {
$rs.="<fault>
<value>
<struct>
<member>
<name>faultCode</name>
<value><int>" . $this->fn . "</int></value>
</member>
<member>
<name>faultString</name>
<value><string>" . $this->fs . "</string></value>
</member>
</struct>
</value>
</fault>";
} else {
$rs.="<params>\n<param>\n" . $this->xv->serialize() .
"</param>\n</params>";
}
$rs.="\n</methodResponse>";
return $rs;
}
}
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() {
return "<?xml version=\"1.0\"?>\n<methodCall>\n";
}
function xml_footer() {
return "</methodCall>\n";
}
function createPayload() {
$this->payload=$this->xml_header();
$this->payload.="<methodName>" . $this->methodname . "</methodName>\n";
// if (sizeof($this->params)) {
$this->payload.="<params>\n";
for($i=0; $i<sizeof($this->params); $i++) {
$p=$this->params[$i];
$this->payload.="<param>\n" . $p->serialize() .
"</param>\n";
}
$this->payload.="</params>\n";
// }
$this->payload.=$this->xml_footer();
$this->payload=str_replace("\n", "\r\n", $this->payload);
}
function method($meth="") {
if ($meth!="") {
$this->methodname=$meth;
}
return $this->methodname;
}
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) {
$ipd="";
while($data=fread($fp, 32768)) {
$ipd.=$data;
}
return $this->parseResponse($ipd);
}
function parseResponse($data="") {
global $_xh,$xmlrpcerr,$xmlrpcstr;
global $xmlrpc_defencoding;
$parser = xml_parser_create($xmlrpc_defencoding);
$_xh[$parser]=array();
$_xh[$parser]['st']="";
$_xh[$parser]['cm']=0;
$_xh[$parser]['isf']=0;
$_xh[$parser]['ac']="";
$_xh[$parser]['qt']="";
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
xml_set_element_handler($parser, "xmlrpc_se", "xmlrpc_ee");
xml_set_character_data_handler($parser, "xmlrpc_cd");
xml_set_default_handler($parser, "xmlrpc_dh");
$xmlrpc_value=new xmlrpcval;
$hdrfnd=0;
if ($this->debug)
print "<PRE>---GOT---\n" . htmlspecialchars($data) .
"\n---END---\n</PRE>";
// 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"],
$xmlrpcstr["http_error"]. " (" . $errstr . ")");
xml_parser_free($parser);
return $r;
}
// gotta get rid of headers here
if ((!$hdrfnd) && ereg("^(.*)\r\n\r\n",$data,$_xh[$parser]['ha'])) {
$data=ereg_replace("^.*\r\n\r\n", "", $data);
$hdrfnd=1;
}
if (!xml_parse($parser, $data, sizeof($data))) {
// thanks to Peter Kocks <peter.kocks@baygate.com>
if((xml_get_current_line_number($parser)) == 1)
$errstr = "XML error at line 1, check URL";
else
$errstr = sprintf("XML error: %s at line %d",
xml_error_string(xml_get_error_code($parser)),
xml_get_current_line_number($parser));
error_log($errstr);
$r=new xmlrpcresp(0, $xmlrpcerr["invalid_return"],
$xmlrpcstr["invalid_return"]);
xml_parser_free($parser);
return $r;
}
xml_parser_free($parser);
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"]);
} else {
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);
}
}
$r->hdrs=split("\r?\n", $_xh[$parser]['ha'][1]);
return $r;
}
}
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);
}
else if ($xmlrpcTypes[$type]==2)
$this->addArray($val);
else if ($xmlrpcTypes[$type]==3)
$this->addStruct($val);
}
}
function addScalar($val, $type="string") {
global $xmlrpcTypes, $xmlrpcBoolean;
if ($this->mytype==1) {
echo "<B>xmlrpcval</B>: scalar can have only one value<BR>";
return 0;
}
$typeof=$xmlrpcTypes[$type];
if ($typeof!=1) {
echo "<B>xmlrpcval</B>: not a scalar type (${typeof})<BR>";
return 0;
}
if ($type==$xmlrpcBoolean) {
if (strcasecmp($val,"true")==0 ||
$val==1 || ($val==true &&
strcasecmp($val,"false"))) {
$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) {
echo "<B>xmlrpcval</B>: already initialized as a [" .
$this->kindOf() . "]<BR>";
return 0;
}
$this->mytype=$xmlrpcTypes["array"];
$this->me["array"]=$vals;
return 1;
}
function addStruct($vals) {
global $xmlrpcTypes;
if ($this->mytype!=0) {
echo "<B>xmlrpcval</B>: already initialized as a [" .
$this->kindOf() . "]<BR>";
return 0;
}
$this->mytype=$xmlrpcTypes["struct"];
$this->me["struct"]=$vals;
return 1;
}
function dump($ar) {
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>";
}
}
}
function kindOf() {
switch($this->mytype) {
case 3:
return "struct";
break;
case 2:
return "array";
break;
case 1:
return "scalar";
break;
default:
return "undef";
}
}
function serializedata($typ, $val) {
$rs="";
global $xmlrpcTypes, $xmlrpcBase64, $xmlrpcString,
$xmlrpcBoolean;
switch($xmlrpcTypes[$typ]) {
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>";
break;
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}>";
}
break;
default:
break;
}
return $rs;
}
function serialize() {
return $this->serializeval($this);
}
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
// i've created a new method here, so as to
// 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})",
$idate, $regs)) {
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]);
}
}
return $t;
}
/****************************************************************
* xmlrpc_decode takes a message in PHP xmlrpc object format and *
* tranlates it into native PHP types. *
* *
* author: Dan Libby (dan@libby.com) *
****************************************************************/
function xmlrpc_decode($xmlrpc_val) {
$kind = $xmlrpc_val->kindOf();
if($kind == "scalar") {
return $xmlrpc_val->scalarval();
}
else if($kind == "array") {
$size = $xmlrpc_val->arraysize();
$arr = array();
for($i = 0; $i < $size; $i++) {
$arr[]=xmlrpc_decode($xmlrpc_val->arraymem($i));
}
return $arr;
}
else if($kind == "struct") {
$xmlrpc_val->structreset();
$arr = array();
while(list($key,$value)=$xmlrpc_val->structeach()) {
$arr[$key] = xmlrpc_decode($value);
}
return $arr;
}
}
/****************************************************************
* xmlrpc_encode takes native php types and encodes them into *
* xmlrpc PHP object format. *
* BUG: All sequential arrays are turned into structs. I don't *
* know of a good way to determine if an array is sequential *
* only. *
* *
* feature creep -- could support more types via optional type *
* argument. *
* *
* author: Dan Libby (dan@libby.com) *
****************************************************************/
function xmlrpc_encode($php_val) {
global $xmlrpcInt;
global $xmlrpcDouble;
global $xmlrpcString;
global $xmlrpcArray;
global $xmlrpcStruct;
$type = gettype($php_val);
$xmlrpc_val = new xmlrpcval;
switch($type) {
case "array":
case "object":
$arr = array();
while (list($k,$v) = each($php_val)) {
$arr[$k] = xmlrpc_encode($v);
}
$xmlrpc_val->addStruct($arr);
break;
case "integer":
$xmlrpc_val->addScalar($php_val, $xmlrpcInt);
break;
case "double":
$xmlrpc_val->addScalar($php_val, $xmlrpcDouble);
break;
case "string":
$xmlrpc_val->addScalar($php_val, $xmlrpcString);
break;
// <G_Giunta_2001-02-29>
// Add support for encoding/decoding of booleans, since they are supported in PHP
case "boolean":
$xmlrpc_val->addScalar($php_val, $xmlrpcBoolean);
break;
// </G_Giunta_2001-02-29>
case "unknown type":
default:
$xmlrpc_val = false;
break;
}
return $xmlrpc_val;
}
?>
includes/xmlrpcs.inc 0 → 100644
+ 287
− 0
View file @ 1b7510ee
<?php
// by Edd Dumbill (C) 1999-2001
// <edd@usefulinc.com>
// $Id$
// License is granted to use or modify this software ("XML-RPC for PHP")
// for commercial or non-commercial use provided the copyright of the author
// is preserved in any distributed or derivative work.
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESSED 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 AUTHOR 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.
// XML RPC Server class
// requires: xmlrpc.inc
// listMethods: either a string, or nothing
$_xmlrpcs_listMethods_sig=array(array($xmlrpcArray, $xmlrpcString),
array($xmlrpcArray));
$_xmlrpcs_listMethods_doc='This method lists all the methods that the XML-RPC server knows how to dispatch';
function _xmlrpcs_listMethods($server, $m) {
global $xmlrpcerr, $xmlrpcstr, $_xmlrpcs_dmap;
$v=new xmlrpcval();
$dmap=$server->dmap;
$outAr=array();
for(reset($dmap); list($key, $val)=each($dmap); ) {
$outAr[]=new xmlrpcval($key, "string");
}
$dmap=$_xmlrpcs_dmap;
for(reset($dmap); list($key, $val)=each($dmap); ) {
$outAr[]=new xmlrpcval($key, "string");
}
$v->addArray($outAr);
return new xmlrpcresp($v);
}
$_xmlrpcs_methodSignature_sig=array(array($xmlrpcArray, $xmlrpcString));
$_xmlrpcs_methodSignature_doc='Returns an array of known signatures (an array of arrays) for the method name passed. If no signatures are known, returns a none-array (test for type != array to detect missing signature)';
function _xmlrpcs_methodSignature($server, $m) {
global $xmlrpcerr, $xmlrpcstr, $_xmlrpcs_dmap;
$methName=$m->getParam(0);
$methName=$methName->scalarval();
if (ereg("^system\.", $methName)) {
$dmap=$_xmlrpcs_dmap; $sysCall=1;
} else {
$dmap=$server->dmap; $sysCall=0;
}
// print "<!-- ${methName} -->\n";
if (isset($dmap[$methName])) {
if ($dmap[$methName]["signature"]) {
$sigs=array();
$thesigs=$dmap[$methName]["signature"];
for($i=0; $i<sizeof($thesigs); $i++) {
$cursig=array();
$inSig=$thesigs[$i];
for($j=0; $j<sizeof($inSig); $j++) {
$cursig[]=new xmlrpcval($inSig[$j], "string");
}
$sigs[]=new xmlrpcval($cursig, "array");
}
$r=new xmlrpcresp(new xmlrpcval($sigs, "array"));
} else {
$r=new xmlrpcresp(new xmlrpcval("undef", "string"));
}
} else {
$r=new xmlrpcresp(0,
$xmlrpcerr["introspect_unknown"],
$xmlrpcstr["introspect_unknown"]);
}
return $r;
}
$_xmlrpcs_methodHelp_sig=array(array($xmlrpcString, $xmlrpcString));
$_xmlrpcs_methodHelp_doc='Returns help text if defined for the method passed, otherwise returns an empty string';
function _xmlrpcs_methodHelp($server, $m) {
global $xmlrpcerr, $xmlrpcstr, $_xmlrpcs_dmap;
$methName=$m->getParam(0);
$methName=$methName->scalarval();
if (ereg("^system\.", $methName)) {
$dmap=$_xmlrpcs_dmap; $sysCall=1;
} else {
$dmap=$server->dmap; $sysCall=0;
}
// print "<!-- ${methName} -->\n";
if (isset($dmap[$methName])) {
if ($dmap[$methName]["docstring"]) {
$r=new xmlrpcresp(new xmlrpcval($dmap[$methName]["docstring"]),
"string");
} else {
$r=new xmlrpcresp(new xmlrpcval("", "string"));
}
} else {
$r=new xmlrpcresp(0,
$xmlrpcerr["introspect_unknown"],
$xmlrpcstr["introspect_unknown"]);
}
return $r;
}
$_xmlrpcs_dmap=array(
"system.listMethods" =>
array("function" => "_xmlrpcs_listMethods",
"signature" => $_xmlrpcs_listMethods_sig,
"docstring" => $_xmlrpcs_listMethods_doc),
"system.methodHelp" =>
array("function" => "_xmlrpcs_methodHelp",
"signature" => $_xmlrpcs_methodHelp_sig,
"docstring" => $_xmlrpcs_methodHelp_doc),
"system.methodSignature" =>
array("function" => "_xmlrpcs_methodSignature",
"signature" => $_xmlrpcs_methodSignature_sig,
"docstring" => $_xmlrpcs_methodSignature_doc)
);
$_xmlrpc_debuginfo="";
function xmlrpc_debugmsg($m) {
global $_xmlrpc_debuginfo;
$_xmlrpc_debuginfo=$_xmlrpc_debuginfo . $m . "\n";
}
class xmlrpc_server {
var $dmap=array();
function xmlrpc_server($dispMap, $serviceNow=1) {
global $HTTP_RAW_POST_DATA;
// dispMap is a despatch array of methods
// mapped to function names and signatures
// if a method
// doesn't appear in the map then an unknown
// method error is generated
$this->dmap=$dispMap;
if ($serviceNow) {
$this->service();
}
}
function serializeDebug() {
global $_xmlrpc_debuginfo;
if ($_xmlrpc_debuginfo!="")
return "<!-- DEBUG INFO:\n\n" .
$_xmlrpc_debuginfo . "\n-->\n";
else
return "";
}
function service() {
$r=$this->parseRequest();
$payload="<?xml version=\"1.0\"?>\n" .
$this->serializeDebug() .
$r->serialize();
Header("Content-type: text/xml\r\nContent-length: " .
strlen($payload));
print $payload;
}
function verifySignature($in, $sig) {
for($i=0; $i<sizeof($sig); $i++) {
// check each possible signature in turn
$cursig=$sig[$i];
if (sizeof($cursig)==$in->getNumParams()+1) {
$itsOK=1;
for($n=0; $n<$in->getNumParams(); $n++) {
$p=$in->getParam($n);
// print "<!-- $p -->\n";
if ($p->kindOf() == "scalar") {
$pt=$p->scalartyp();
} else {
$pt=$p->kindOf();
}
// $n+1 as first type of sig is return type
if ($pt != $cursig[$n+1]) {
$itsOK=0;
$pno=$n+1; $wanted=$cursig[$n+1]; $got=$pt;
break;
}
}
if ($itsOK)
return array(1);
}
}
return array(0, "Wanted ${wanted}, got ${got} at param ${pno})");
}
function parseRequest($data="") {
global $_xh,$HTTP_RAW_POST_DATA;
global $xmlrpcerr, $xmlrpcstr, $xmlrpcerrxml, $xmlrpc_defencoding,
$_xmlrpcs_dmap;
if ($data=="") {
$data=$HTTP_RAW_POST_DATA;
}
$parser = xml_parser_create($xmlrpc_defencoding);
$_xh[$parser]=array();
$_xh[$parser]['st']="";
$_xh[$parser]['cm']=0;
$_xh[$parser]['isf']=0;
$_xh[$parser]['params']=array();
$_xh[$parser]['method']="";
// decompose incoming XML into request structure
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
xml_set_element_handler($parser, "xmlrpc_se", "xmlrpc_ee");
xml_set_character_data_handler($parser, "xmlrpc_cd");
xml_set_default_handler($parser, "xmlrpc_dh");
if (!xml_parse($parser, $data, 1)) {
// return XML error as a faultCode
$r=new xmlrpcresp(0,
$xmlrpcerrxml+xml_get_error_code($parser),
sprintf("XML error: %s at line %d",
xml_error_string(xml_get_error_code($parser)),
xml_get_current_line_number($parser)));
xml_parser_free($parser);
} else {
xml_parser_free($parser);
$m=new xmlrpcmsg($_xh[$parser]['method']);
// now add parameters in
for($i=0; $i<sizeof($_xh[$parser]['params']); $i++) {
//print "<!-- " . $_xh[$parser]['params'][$i]. "-->\n";
$plist.="$i - " . $_xh[$parser]['params'][$i]. " \n";
eval('$m->addParam(' . $_xh[$parser]['params'][$i]. ");");
}
// uncomment this to really see what the server's getting!
// xmlrpc_debugmsg($plist);
// now to deal with the method
$methName=$_xh[$parser]['method'];
if (ereg("^system\.", $methName)) {
$dmap=$_xmlrpcs_dmap; $sysCall=1;
} else {
$dmap=$this->dmap; $sysCall=0;
}
if (isset($dmap[$methName]['function'])) {
// dispatch if exists
if (isset($dmap[$methName]['signature'])) {
$sr=$this->verifySignature($m,
$dmap[$methName]['signature'] );
}
if ( (!isset($dmap[$methName]['signature']))
|| $sr[0]) {
// if no signature or correct signature
if ($sysCall) {
eval('$r=' . $dmap[$methName]['function'] .
'($this, $m);');
} else {
eval('$r=' . $dmap[$methName]['function'] .
'($m);');
}
} else {
$r=new xmlrpcresp(0,
$xmlrpcerr["incorrect_params"],
$xmlrpcstr["incorrect_params"].": ". $sr[1]);
}
} else {
// else prepare error response
$r=new xmlrpcresp(0,
$xmlrpcerr["unknown_method"],
$xmlrpcstr["unknown_method"]);
}
}
return $r;
}
function echoInput() {
global $HTTP_RAW_POST_DATA;
// a debugging routine: just echos back the input
// packet as a string value
$r=new xmlrpcresp;
$r->xv=new xmlrpcval( "'Aha said I: '" . $HTTP_RAW_POST_DATA, "string");
print $r->serialize();
}
}
?>
xmlrpc.php 0 → 100644
+ 16
− 0
View file @ 1b7510ee
<?php
include_once("includes/xmlrpcs.inc");
include_once "includes/common.inc";
$functions = array();
foreach (module_list() as $name) {
if (module_hook($name, "xmlrpc")) {
$functions = array_merge($functions, module_invoke($name, "xmlrpc"));
}
}
$server = new xmlrpc_server($functions);
?>
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment