<?php // by Edd Dumbill (C) 1999-2000 // <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. class xmlrpc { } 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("quot" => '"', "amp" => "&", "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"; // 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); $xmlrpc_twoslash=$xmlrpc_backslash . $xmlrpc_backslash; $xmlrpc_twoslash="2SLS"; // 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 ($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]['lv']=1; $_xh[$parser]['vt']=$xmlrpcString; $_xh[$parser]['ac']=""; // 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 { $_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 { $_xh[$parser]['st'].=$_xh[$parser]['ac']; } $_xh[$parser]['ac']=""; $_xh[$parser]['qt']=0; 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 ($xmlrpcTypes[strtolower($name)]) { $_xh[$parser]['vt']=strtolower($name); } } function xmlrpc_cd($parser, $data) { global $_xh, $xmlrpc_backslash, $xmlrpc_twoslash; //if (ereg("^[\n\r \t]+$", $data)) return; // print "adding [${data}]\n"; if ($_xh[$parser]['lv']==1) { $_xh[$parser]['qt']=1; $_xh[$parser]['lv']=2; } if ($_xh[$parser]['qt']) { // quoted string $_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; } } function faultCode() { return $this->fn; } 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']=""; 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) { $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; 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 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++) { array_append($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; case "unknown type": default: $xmlrpc_val = false; break; } return $xmlrpc_val; } ?>