From 5b0b061574fa8458d5a92c24c20d077ad832cf63 Mon Sep 17 00:00:00 2001 From: gggeek Date: Sat, 21 Feb 2015 18:52:19 +0000 Subject: [PATCH] Reformat source code: demos --- demo/client/agesort.php | 2 +- demo/client/client.php | 65 +- demo/client/comment.php | 291 +++---- demo/client/introspect.php | 2 +- demo/client/mail.php | 68 +- demo/client/simple_call.php | 86 +- demo/client/which.php | 2 +- demo/client/wrap.php | 76 +- demo/client/zopetest.php | 36 +- demo/demo3.xml | 36 +- demo/server/discuss.php | 177 ++--- demo/server/proxy.php | 140 ++-- demo/server/server.php | 1492 ++++++++++++++++++----------------- demo/vardemo.php | 134 ++-- 14 files changed, 1319 insertions(+), 1288 deletions(-) diff --git a/demo/client/agesort.php b/demo/client/agesort.php index 86febd17..8ae87ff7 100644 --- a/demo/client/agesort.php +++ b/demo/client/agesort.php @@ -1 +1 @@ - xmlrpc

Agesort demo

Send an array of 'name' => 'age' pairs to the server that will send it back sorted.

The source code demonstrates basic lib usage, including handling of xmlrpc arrays and structs

24, "Edd" => 45, "Joe" => 37, "Fred" => 27); reset($inAr); print "This is the input data:
";
while (list($key, $val)=each($inAr)) {
  print $key . ", " . $val . "\n";
}
print "
"; // create parameters from the input array: an xmlrpc array of xmlrpc structs $p=array(); foreach($inAr as $key => $val) { $p[]=new xmlrpcval(array("name" => new xmlrpcval($key), "age" => new xmlrpcval($val, "int")), "struct"); } $v=new xmlrpcval($p, "array"); print "Encoded into xmlrpc format it looks like this:
\n" .  htmlentities($v->serialize()). "
\n"; // create client and message objects $f=new xmlrpcmsg('examples.sortByAge', array($v)); $c=new xmlrpc_client("/server.php", "phpxmlrpc.sourceforge.net", 80); // set maximum debug level, to have the complete communication printed to screen $c->setDebug(2); // send request print "Now sending request (detailed debug info follows)"; $r=&$c->send($f); // check response for errors, and take appropriate action if (!$r->faultCode()) { print "The server gave me these results:
";
  $v=$r->value();
  $max=$v->arraysize();
  for($i=0; $i<$max; $i++) {
    $rec=$v->arraymem($i);
    $n=$rec->structmem("name");
    $a=$rec->structmem("age");
    print htmlspecialchars($n->scalarval()) . ", " . htmlspecialchars($a->scalarval()) . "\n";
  }

  print "
For nerds: I got this value back
" .
    htmlentities($r->serialize()). "

\n"; } else { print "An error occurred:
";
  print "Code: " . htmlspecialchars($r->faultCode()) .
    "\nReason: '" . htmlspecialchars($r->faultString()).'\'

'; } ?> \ No newline at end of file + xmlrpc

Agesort demo

Send an array of 'name' => 'age' pairs to the server that will send it back sorted.

The source code demonstrates basic lib usage, including handling of xmlrpc arrays and structs

24, "Edd" => 45, "Joe" => 37, "Fred" => 27); reset($inAr); print "This is the input data:
";
while (list($key, $val) = each($inAr)) {
    print $key . ", " . $val . "\n";
}
print "
"; // create parameters from the input array: an xmlrpc array of xmlrpc structs $p = array(); foreach ($inAr as $key => $val) { $p[] = new xmlrpcval(array("name" => new xmlrpcval($key), "age" => new xmlrpcval($val, "int")), "struct"); } $v = new xmlrpcval($p, "array"); print "Encoded into xmlrpc format it looks like this:
\n" . htmlentities($v->serialize()) . "
\n"; // create client and message objects $f = new xmlrpcmsg('examples.sortByAge', array($v)); $c = new xmlrpc_client("/server.php", "phpxmlrpc.sourceforge.net", 80); // set maximum debug level, to have the complete communication printed to screen $c->setDebug(2); // send request print "Now sending request (detailed debug info follows)"; $r = &$c->send($f); // check response for errors, and take appropriate action if (!$r->faultCode()) { print "The server gave me these results:
";
    $v = $r->value();
    $max = $v->arraysize();
    for ($i = 0; $i < $max; $i++) {
        $rec = $v->arraymem($i);
        $n = $rec->structmem("name");
        $a = $rec->structmem("age");
        print htmlspecialchars($n->scalarval()) . ", " . htmlspecialchars($a->scalarval()) . "\n";
    }

    print "
For nerds: I got this value back
" .
        htmlentities($r->serialize()) . "

\n"; } else { print "An error occurred:
";
    print "Code: " . htmlspecialchars($r->faultCode()) .
        "\nReason: '" . htmlspecialchars($r->faultString()) . '\'

'; } ?> \ No newline at end of file diff --git a/demo/client/client.php b/demo/client/client.php index 2db593f4..755729de 100644 --- a/demo/client/client.php +++ b/demo/client/client.php @@ -2,48 +2,43 @@ xmlrpc

Getstatename demo

+

Send a U.S. state number to the server and get back the state name

+

The code demonstrates usage of the php_xmlrpc_encode function

Sending the following request:\n\n" . htmlentities($f->serialize()) . "\n\nDebug info of server data follows...\n\n"; - $c=new xmlrpc_client("/server.php", "phpxmlrpc.sourceforge.net", 80); - $c->setDebug(1); - $r=&$c->send($f); - if(!$r->faultCode()) - { - $v=$r->value(); - print "

State number " . $stateno . " is " - . htmlspecialchars($v->scalarval()) . "
"; - // print "
I got this value back
" .
-            //  htmlentities($r->serialize()). "

\n"; - } - else - { - print "An error occurred: "; - print "Code: " . htmlspecialchars($r->faultCode()) - . " Reason: '" . htmlspecialchars($r->faultString()) . "'

"; - } - } - else - { - $stateno = ""; +if (isset($HTTP_POST_VARS["stateno"]) && $HTTP_POST_VARS["stateno"] != "") { + $stateno = (integer)$HTTP_POST_VARS["stateno"]; + $f = new xmlrpcmsg('examples.getStateName', + array(php_xmlrpc_encode($stateno)) + ); + print "
Sending the following request:\n\n" . htmlentities($f->serialize()) . "\n\nDebug info of server data follows...\n\n";
+    $c = new xmlrpc_client("/server.php", "phpxmlrpc.sourceforge.net", 80);
+    $c->setDebug(1);
+    $r = &$c->send($f);
+    if (!$r->faultCode()) {
+        $v = $r->value();
+        print "

State number " . $stateno . " is " + . htmlspecialchars($v->scalarval()) . "
"; + // print "
I got this value back
" .
+        //  htmlentities($r->serialize()). "

\n"; + } else { + print "An error occurred: "; + print "Code: " . htmlspecialchars($r->faultCode()) + . " Reason: '" . htmlspecialchars($r->faultString()) . "'
"; } +} else { + $stateno = ""; +} - print "
+print "

Enter a state number to query its name

"; diff --git a/demo/client/comment.php b/demo/client/comment.php index 090c18c8..e457836f 100644 --- a/demo/client/comment.php +++ b/demo/client/comment.php @@ -1,185 +1,210 @@ "; exit(); } -function dispatch($client, $method, $args) { - $msg=new xmlrpcmsg($method, $args); - $resp=$client->send($msg); - if (!$resp) { print "

IO error: ".$client->errstr."

"; bomb(); } +function bomb() +{ + print ""; + exit(); +} + +function dispatch($client, $method, $args) +{ + $msg = new xmlrpcmsg($method, $args); + $resp = $client->send($msg); + if (!$resp) { + print "

IO error: " . $client->errstr . "

"; + bomb(); + } if ($resp->faultCode()) { print "

There was an error: " . $resp->faultCode() . " " . $resp->faultString() . "

"; bomb(); } + return php_xmlrpc_decode($resp->value()); } // create client for discussion server -$dclient=new xmlrpc_client("${mydir}/discuss.php", - "xmlrpc.usefulinc.com", 80); +$dclient = new xmlrpc_client("${mydir}/discuss.php", + "xmlrpc.usefulinc.com", 80); // check if we're posting a comment, and send it if so -@$storyid=$_POST["storyid"]; +@$storyid = $_POST["storyid"]; if ($storyid) { - // print "Returning to " . $HTTP_POST_VARS["returnto"]; - $res=dispatch($dclient, "discuss.addComment", - array(new xmlrpcval($storyid), - new xmlrpcval(stripslashes - (@$_POST["name"])), - new xmlrpcval(stripslashes - (@$_POST["commenttext"])))); + $res = dispatch($dclient, "discuss.addComment", + array(new xmlrpcval($storyid), + new xmlrpcval(stripslashes(@$_POST["name"])), + new xmlrpcval(stripslashes(@$_POST["commenttext"])),)); // send the browser back to the originating page Header("Location: ${mydir}/comment.php?catid=" . - $_POST["catid"] . "&chanid=" . - $_POST["chanid"] . "&oc=" . - $_POST["catid"]); + $_POST["catid"] . "&chanid=" . + $_POST["chanid"] . "&oc=" . + $_POST["catid"]); exit(0); } // now we've got here, we're exploring the story store ?> -meerkat browser + +meerkat browser

Meerkat integration

-

Make a comment on the story

-
-

Your name:

-

Your comment:

- -" /> - - - -
+ ?> +

Make a comment on the story

+
+

Your name:

+ +

Your comment:

+ + "/> + + + +
new xmlrpcval($chanid, "int"), - "ids" => new xmlrpcval(1, "int"), - "descriptions" => new xmlrpcval(200, "int"), - "num_items" => new xmlrpcval(5, "int"), - "dates" => new xmlrpcval(0, "int") - ), "struct"))); + array(new xmlrpcval( + array( + "channel" => new xmlrpcval($chanid, "int"), + "ids" => new xmlrpcval(1, "int"), + "descriptions" => new xmlrpcval(200, "int"), + "num_items" => new xmlrpcval(5, "int"), + "dates" => new xmlrpcval(0, "int"), + ), "struct"))); } -?> -
-

Subject area:
-

- -

News source:
- -

+ ?> + +

Subject area:
+

+ +

News source:
+ +

+ + + ?> -

- -
+

+ + - - -

Stories available

- -"; - print ""; - print "\n"; - // now look for existing comments - $res=dispatch($dclient, "discuss.getComments", - array(new xmlrpcval($v['id']))); - if (sizeof($res)>0) { - print "\n"; - } - print "\n"; - } -?> -
" . $v['title'] . "
"; - print $v['description'] . "
"; - print "Read full story "; - print "Comment on this story"; - print ""; - print "

" . - "Comments on this story:

"; - for($i=0; $iFrom: " . htmlentities($s['name']) . "
"; - print "Comment: " . htmlentities($s['comment']) . "

"; - } - print "

- - + +

Stories available

+ + "; + print ""; + print "\n"; + // now look for existing comments + $res = dispatch($dclient, "discuss.getComments", + array(new xmlrpcval($v['id']))); + if (sizeof($res) > 0) { + print "\n"; + } + print "\n"; + } + ?> +
" . $v['title'] . "
"; + print $v['description'] . "
"; + print "Read full story "; + print "Comment on this story"; + print ""; + print "

" . + "Comments on this story:

"; + for ($i = 0; $i < sizeof($res); $i++) { + $s = $res[$i]; + print "

From: " . htmlentities($s['name']) . "
"; + print "Comment: " . htmlentities($s['comment']) . "

"; + } + print "

+ + -
+

-Meerkat powered, yeah! + Meerkat powered, yeah!

diff --git a/demo/client/introspect.php b/demo/client/introspect.php index f606ba62..1fff47ab 100644 --- a/demo/client/introspect.php +++ b/demo/client/introspect.php @@ -1 +1 @@ - xmlrpc

Introspect demo

Query server for available methods and their description

The code demonstrates usage of multicall and introspection methods

faultCode() . " Reason: '" .$r->faultString()."'
"; } // 'new style' client constuctor $c = new xmlrpc_client("http://phpxmlrpc.sourceforge.net/server.php"); print "

methods available at http://" . $c->server . $c->path . "

\n"; $m = new xmlrpcmsg('system.listMethods'); $r =& $c->send($m); if($r->faultCode()) { display_error($r); } else { $v=$r->value(); for($i=0; $i<$v->arraysize(); $i++) { $mname=$v->arraymem($i); print "

" . $mname->scalarval() . "

\n"; // build messages first, add params later $m1 = new xmlrpcmsg('system.methodHelp'); $m2 = new xmlrpcmsg('system.methodSignature'); $val = new xmlrpcval($mname->scalarval(), "string"); $m1->addParam($val); $m2->addParam($val); // send multiple messages in one pass. // If server does not support multicall, client will fall back to 2 separate calls $ms = array($m1, $m2); $rs =& $c->send($ms); if($rs[0]->faultCode()) { display_error($rs[0]); } else { $val=$rs[0]->value(); $txt=$val->scalarval(); if($txt != "") { print "

Documentation

${txt}

\n"; } else { print "

No documentation available.

\n"; } } if($rs[1]->faultCode()) { display_error($rs[1]); } else { print "

Signature

\n"; $val = $rs[1]->value(); if($val->kindOf()=="array") { for($j=0; $j<$val->arraysize(); $j++) { $x = $val->arraymem($j); $ret = $x->arraymem(0); print "" . $ret->scalarval() . " " . $mname->scalarval() . "("; if($x->arraysize()>1) { for($k=1; $k<$x->arraysize(); $k++) { $y = $x->arraymem($k); print $y->scalarval(); if($k < $x->arraysize()-1) { print ", "; } } } print ")
\n"; } } else { print "Signature unknown\n"; } print "

\n"; } } } ?> \ No newline at end of file + xmlrpc

Introspect demo

Query server for available methods and their description

The code demonstrates usage of multicall and introspection methods

faultCode() . " Reason: '" . $r->faultString() . "'
"; } // 'new style' client constuctor $c = new xmlrpc_client("http://phpxmlrpc.sourceforge.net/server.php"); print "

methods available at http://" . $c->server . $c->path . "

\n"; $m = new xmlrpcmsg('system.listMethods'); $r = &$c->send($m); if ($r->faultCode()) { display_error($r); } else { $v = $r->value(); for ($i = 0; $i < $v->arraysize(); $i++) { $mname = $v->arraymem($i); print "

" . $mname->scalarval() . "

\n"; // build messages first, add params later $m1 = new xmlrpcmsg('system.methodHelp'); $m2 = new xmlrpcmsg('system.methodSignature'); $val = new xmlrpcval($mname->scalarval(), "string"); $m1->addParam($val); $m2->addParam($val); // send multiple messages in one pass. // If server does not support multicall, client will fall back to 2 separate calls $ms = array($m1, $m2); $rs = &$c->send($ms); if ($rs[0]->faultCode()) { display_error($rs[0]); } else { $val = $rs[0]->value(); $txt = $val->scalarval(); if ($txt != "") { print "

Documentation

${txt}

\n"; } else { print "

No documentation available.

\n"; } } if ($rs[1]->faultCode()) { display_error($rs[1]); } else { print "

Signature

\n"; $val = $rs[1]->value(); if ($val->kindOf() == "array") { for ($j = 0; $j < $val->arraysize(); $j++) { $x = $val->arraymem($j); $ret = $x->arraymem(0); print "" . $ret->scalarval() . " " . $mname->scalarval() . "("; if ($x->arraysize() > 1) { for ($k = 1; $k < $x->arraysize(); $k++) { $y = $x->arraymem($k); print $y->scalarval(); if ($k < $x->arraysize() - 1) { print ", "; } } } print ")
\n"; } } else { print "Signature unknown\n"; } print "

\n"; } } } ?> \ No newline at end of file diff --git a/demo/client/mail.php b/demo/client/mail.php index 9f6de319..6b6abd44 100644 --- a/demo/client/mail.php +++ b/demo/client/mail.php @@ -1,32 +1,44 @@ xmlrpc

Mail demo

+

This form enables you to send mail via an XML-RPC server. For public use -only the "Userland" server will work (see Dave Winer's message). -When you press Send this page will reload, showing you the XML-RPC request sent to the host server, the XML-RPC response received and the internal evaluation done by the PHP implementation.

+ only the "Userland" server will work (see Dave Winer's + message). + When you press Send this page will reload, showing you the XML-RPC request sent to the host server, the + XML-RPC response received and the internal evaluation done by the PHP implementation.

+

You can find the source to this page here: mail.php
-And the source to a functionally identical mail-by-XML-RPC server in the file server.php included with the library (look for the 'mail_send' method)

+ And the source to a functionally identical mail-by-XML-RPC server in the file server.php included with the library (look for the 'mail_send' + method)

addParam(new xmlrpcval($HTTP_POST_VARS["mailto"])); $f->addParam(new xmlrpcval($HTTP_POST_VARS["mailsub"])); $f->addParam(new xmlrpcval($HTTP_POST_VARS["mailmsg"])); @@ -35,9 +47,9 @@ if (isset($HTTP_POST_VARS["server"]) && $HTTP_POST_VARS["server"]) { $f->addParam(new xmlrpcval($HTTP_POST_VARS["mailbcc"])); $f->addParam(new xmlrpcval("text/plain")); - $c=new xmlrpc_client($XP, $XS, 80); + $c = new xmlrpc_client($XP, $XS, 80); $c->setDebug(2); - $r=&$c->send($f); + $r = &$c->send($f); if (!$r->faultCode()) { print "Mail sent OK
\n"; } else { @@ -45,25 +57,27 @@ if (isset($HTTP_POST_VARS["server"]) && $HTTP_POST_VARS["server"]) { print "Mail send failed
\n"; print "Fault: "; print "Code: " . htmlspecialchars($r->faultCode()) . - " Reason: '" . htmlspecialchars($r->faultString()) . "'
"; + " Reason: '" . htmlspecialchars($r->faultString()) . "'
"; print "
"; } } ?>
-Server -
-From
-
-To
-Cc
-Bcc
-
-Subject -
-Body
- + Server +
+ From
+
+ To
+ Cc
+ Bcc
+
+ Subject +
+ Body
+
diff --git a/demo/client/simple_call.php b/demo/client/simple_call.php index 9764b7fa..8a36eceb 100644 --- a/demo/client/simple_call.php +++ b/demo/client/simple_call.php @@ -1,57 +1,53 @@ send(new xmlrpcmsg($remote_function_name, $xmlrpcval_array)); + $xmlrpcval_array = array(); + foreach ($varargs as $parameter) { + $xmlrpcval_array[] = php_xmlrpc_encode($parameter); } + + return $client->send(new xmlrpcmsg($remote_function_name, $xmlrpcval_array)); } +} diff --git a/demo/client/which.php b/demo/client/which.php index 8b1ba488..db2d8c17 100644 --- a/demo/client/which.php +++ b/demo/client/which.php @@ -1 +1 @@ - xmlrpc

Which toolkit demo

Query server for toolkit information

The code demonstrates usage of the php_xmlrpc_decode function

send($f); if(!$r->faultCode()) { $v = php_xmlrpc_decode($r->value()); print "
";

		print "name: " . htmlspecialchars($v["toolkitName"]) . "\n";

		print "version: " . htmlspecialchars($v["toolkitVersion"]) . "\n";

		print "docs: " . htmlspecialchars($v["toolkitDocsUrl"]) . "\n";

		print "os: " . htmlspecialchars($v["toolkitOperatingSystem"]) . "\n";

		print "
"; } else { print "An error occurred: "; print "Code: " . htmlspecialchars($r->faultCode()) . " Reason: '" . htmlspecialchars($r->faultString()) . "'\n"; } ?> \ No newline at end of file + xmlrpc

Which toolkit demo

Query server for toolkit information

The code demonstrates usage of the php_xmlrpc_decode function

send($f); if (!$r->faultCode()) { $v = php_xmlrpc_decode($r->value()); print "
";


    print "name: " . htmlspecialchars($v["toolkitName"]) . "\n";


    print "version: " . htmlspecialchars($v["toolkitVersion"]) . "\n";


    print "docs: " . htmlspecialchars($v["toolkitDocsUrl"]) . "\n";


    print "os: " . htmlspecialchars($v["toolkitOperatingSystem"]) . "\n";


    print "
"; } else { print "An error occurred: "; print "Code: " . htmlspecialchars($r->faultCode()) . " Reason: '" . htmlspecialchars($r->faultString()) . "'\n"; } ?> \ No newline at end of file diff --git a/demo/client/wrap.php b/demo/client/wrap.php index 8ec452cd..27a9794f 100644 --- a/demo/client/wrap.php +++ b/demo/client/wrap.php @@ -2,55 +2,49 @@ xmlrpc

Webservice wrappper demo

+

Wrap methods exposed by server into php functions

+

The code demonstrates usage of the most automagic client usage possible:
-1) client that returns php values instead of xmlrpcval objects
-2) wrapping of remote methods into php functions + 1) client that returns php values instead of xmlrpcval objects
+ 2) wrapping of remote methods into php functions

return_type = 'phpvals'; // let client give us back php values instead of xmlrpcvals - $r =& $c->send(new xmlrpcmsg('system.listMethods')); - if($r->faultCode()) - { - echo "

Server methods list could not be retrieved: error '".htmlspecialchars($r->faultString())."'

\n"; - } - else - { - $testcase = ''; - echo "

Server methods list retrieved, now wrapping it up...

\n\n"; + if ($testcase) { + echo "Now testing function $testcase: remote method to convert U.S. state number into state name"; + $statenum = 25; + $statename = $testcase($statenum, 2); + echo "State number $statenum is " . htmlspecialchars($statename); + } +} ?> diff --git a/demo/client/zopetest.php b/demo/client/zopetest.php index 84102a59..ea93525d 100644 --- a/demo/client/zopetest.php +++ b/demo/client/zopetest.php @@ -2,28 +2,26 @@ xmlrpc

Zope test demo

+

The code demonstrates usage of basic authentication to connect to the server

setCredentials("username", "password"); - $c->setDebug(2); - $r = $c->send($f); - if(!$r->faultCode()) - { - $v = $r->value(); - print "I received:" . htmlspecialchars($v->scalarval()) . "
"; - print "
I got this value back
pre>" . - htmlentities($r->serialize()). "\n"; - } - else - { - print "An error occurred: "; - print "Code: " . htmlspecialchars($r->faultCode()) - . " Reason: '" . ($r->faultString()) . "'
"; - } +$f = new xmlrpcmsg('document_src', array()); +$c = new xmlrpc_client("/index_html", "pingu.heddley.com", 9080); +$c->setCredentials("username", "password"); +$c->setDebug(2); +$r = $c->send($f); +if (!$r->faultCode()) { + $v = $r->value(); + print "I received:" . htmlspecialchars($v->scalarval()) . "
"; + print "
I got this value back
pre>" . + htmlentities($r->serialize()) . "\n"; +} else { + print "An error occurred: "; + print "Code: " . htmlspecialchars($r->faultCode()) + . " Reason: '" . ($r->faultString()) . "'
"; +} ?> diff --git a/demo/demo3.xml b/demo/demo3.xml index e77a4af3..ed94aaba 100644 --- a/demo/demo3.xml +++ b/demo/demo3.xml @@ -1,21 +1,21 @@ - - - - - faultCode - - 4 - - - - faultString - - Too many parameters. - - - - - + + + + + faultCode + + 4 + + + + faultString + + Too many parameters. + + + + + diff --git a/demo/server/discuss.php b/demo/server/discuss.php index 6996564f..7e6e4e97 100644 --- a/demo/server/discuss.php +++ b/demo/server/discuss.php @@ -1,117 +1,102 @@ getParam(0)); - $dbh=dba_open("/tmp/comments.db", "r", "db2"); - if($dbh) - { - $countID="${msgID}_count"; - if(dba_exists($countID, $dbh)) - { - $count=dba_fetch($countID, $dbh); - for($i=0; $i<$count; $i++) - { - $name=dba_fetch("${msgID}_name_${i}", $dbh); - $comment=dba_fetch("${msgID}_comment_${i}", $dbh); - // push a new struct onto the return array - $ra[] = array( - "name" => $name, - "comment" => $comment - ); - } +function getcomments($m) +{ + global $xmlrpcerruser; + $err = ""; + $ra = array(); + $msgID = php_xmlrpc_decode($m->getParam(0)); + $dbh = dba_open("/tmp/comments.db", "r", "db2"); + if ($dbh) { + $countID = "${msgID}_count"; + if (dba_exists($countID, $dbh)) { + $count = dba_fetch($countID, $dbh); + for ($i = 0; $i < $count; $i++) { + $name = dba_fetch("${msgID}_name_${i}", $dbh); + $comment = dba_fetch("${msgID}_comment_${i}", $dbh); + // push a new struct onto the return array + $ra[] = array( + "name" => $name, + "comment" => $comment, + ); } } - // if we generated an error, create an error return response - if($err) - { - return new xmlrpcresp(0, $xmlrpcerruser, $err); - } - else - { - // otherwise, we create the right response - // with the state name - return new xmlrpcresp(php_xmlrpc_encode($ra)); - } } + // if we generated an error, create an error return response + if ($err) { + return new xmlrpcresp(0, $xmlrpcerruser, $err); + } else { + // otherwise, we create the right response + // with the state name + return new xmlrpcresp(php_xmlrpc_encode($ra)); + } +} - $s = new xmlrpc_server(array( - "discuss.addComment" => array( - "function" => "addcomment", - "signature" => $addcomment_sig, - "docstring" => $addcomment_doc - ), - "discuss.getComments" => array( - "function" => "getcomments", - "signature" => $getcomments_sig, - "docstring" => $getcomments_doc - ) - )); +$s = new xmlrpc_server(array( + "discuss.addComment" => array( + "function" => "addcomment", + "signature" => $addcomment_sig, + "docstring" => $addcomment_doc, + ), + "discuss.getComments" => array( + "function" => "getcomments", + "signature" => $getcomments_sig, + "docstring" => $getcomments_doc, + ), +)); diff --git a/demo/server/proxy.php b/demo/server/proxy.php index 4f03f460..80a3f605 100644 --- a/demo/server/proxy.php +++ b/demo/server/proxy.php @@ -2,85 +2,83 @@ /** * XMLRPC server acting as proxy for requests to other servers * (useful e.g. for ajax-originated calls that can only connect back to - * the originating server) + * the originating server). * * @author Gaetano Giunta * @copyright (C) 2006-2014 G. Giunta * @license code licensed under the BSD License: http://phpxmlrpc.sourceforge.net/license.txt */ +include_once __DIR__ . "/../../vendor/autoload.php"; - include_once(__DIR__."/../../vendor/autoload.php"); +include_once __DIR__ . "/../../lib/xmlrpc.inc"; +include_once __DIR__ . "/../../lib/xmlrpcs.inc"; - include_once(__DIR__."/../../lib/xmlrpc.inc"); - include_once(__DIR__."/../../lib/xmlrpcs.inc"); - - /** - * Forward an xmlrpc request to another server, and return to client the response received. - * @param xmlrpcmsg $m (see method docs below for a description of the expected parameters) - * @return xmlrpcresp - */ - function forward_request($m) - { - // create client - $timeout = 0; - $url = php_xmlrpc_decode($m->getParam(0)); - $c = new xmlrpc_client($url); - if ($m->getNumParams() > 3) - { - // we have to set some options onto the client. - // Note that if we do not untaint the received values, warnings might be generated... - $options = php_xmlrpc_decode($m->getParam(3)); - foreach($options as $key => $val) - { - switch($key) - { - case 'Cookie': - break; - case 'Credentials': - break; - case 'RequestCompression': - $c->setRequestCompression($val); - break; - case 'SSLVerifyHost': - $c->setSSLVerifyHost($val); - break; - case 'SSLVerifyPeer': - $c->setSSLVerifyPeer($val); - break; - case 'Timeout': - $timeout = (integer) $val; - break; - } // switch - } - } - - // build call for remote server - /// @todo find a weay to forward client info (such as IP) to server, either - /// - as xml comments in the payload, or - /// - using std http header conventions, such as X-forwarded-for... - $method = php_xmlrpc_decode($m->getParam(1)); - $pars = $m->getParam(2); - $m = new xmlrpcmsg($method); - for ($i = 0; $i < $pars->arraySize(); $i++) - { - $m->addParam($pars->arraymem($i)); +/** + * Forward an xmlrpc request to another server, and return to client the response received. + * + * @param xmlrpcmsg $m (see method docs below for a description of the expected parameters) + * + * @return xmlrpcresp + */ +function forward_request($m) +{ + // create client + $timeout = 0; + $url = php_xmlrpc_decode($m->getParam(0)); + $c = new xmlrpc_client($url); + if ($m->getNumParams() > 3) { + // we have to set some options onto the client. + // Note that if we do not untaint the received values, warnings might be generated... + $options = php_xmlrpc_decode($m->getParam(3)); + foreach ($options as $key => $val) { + switch ($key) { + case 'Cookie': + break; + case 'Credentials': + break; + case 'RequestCompression': + $c->setRequestCompression($val); + break; + case 'SSLVerifyHost': + $c->setSSLVerifyHost($val); + break; + case 'SSLVerifyPeer': + $c->setSSLVerifyPeer($val); + break; + case 'Timeout': + $timeout = (integer)$val; + break; + } // switch } + } - // add debug info into response we give back to caller - xmlrpc_debugmsg("Sending to server $url the payload: ".$m->serialize()); - return $c->send($m, $timeout); + // build call for remote server + /// @todo find a weay to forward client info (such as IP) to server, either + /// - as xml comments in the payload, or + /// - using std http header conventions, such as X-forwarded-for... + $method = php_xmlrpc_decode($m->getParam(1)); + $pars = $m->getParam(2); + $m = new xmlrpcmsg($method); + for ($i = 0; $i < $pars->arraySize(); $i++) { + $m->addParam($pars->arraymem($i)); } - // run the server - $server = new xmlrpc_server( - array( - 'xmlrpcproxy.call' => array( - 'function' => 'forward_request', - 'signature' => array( - array('mixed', 'string', 'string', 'array'), - array('mixed', 'string', 'string', 'array', 'stuct'), - ), - 'docstring' => 'forwards xmlrpc calls to remote servers. Returns remote method\'s response. Accepts params: remote server url (might include basic auth credentials), method name, array of params, and (optionally) a struct containing call options' - ) - ) - ); + // add debug info into response we give back to caller + xmlrpc_debugmsg("Sending to server $url the payload: " . $m->serialize()); + + return $c->send($m, $timeout); +} + +// run the server +$server = new xmlrpc_server( + array( + 'xmlrpcproxy.call' => array( + 'function' => 'forward_request', + 'signature' => array( + array('mixed', 'string', 'string', 'array'), + array('mixed', 'string', 'string', 'array', 'stuct'), + ), + 'docstring' => 'forwards xmlrpc calls to remote servers. Returns remote method\'s response. Accepts params: remote server url (might include basic auth credentials), method name, array of params, and (optionally) a struct containing call options', + ), + ) +); diff --git a/demo/server/server.php b/demo/server/server.php index 2d37e800..5f34c751 100644 --- a/demo/server/server.php +++ b/demo/server/server.php @@ -7,248 +7,239 @@ * is to be used for unit-testing the library. * * Please do not copy this file verbatim into your production server. - * **/ // give user a chance to see the source for this server instead of running the services -if ($_SERVER['REQUEST_METHOD'] != 'POST' && isset($_GET['showSource'])) -{ +if ($_SERVER['REQUEST_METHOD'] != 'POST' && isset($_GET['showSource'])) { highlight_file(__FILE__); die(); } - include_once(__DIR__."/../../vendor/autoload.php"); +include_once __DIR__ . "/../../vendor/autoload.php"; - include_once(__DIR__."/../../lib/xmlrpc.inc"); - include_once(__DIR__."/../../lib/xmlrpcs.inc"); - include_once(__DIR__."/../../lib/xmlrpc_wrappers.inc"); +include_once __DIR__ . "/../../lib/xmlrpc.inc"; +include_once __DIR__ . "/../../lib/xmlrpcs.inc"; +include_once __DIR__ . "/../../lib/xmlrpc_wrappers.inc"; +/** + * Used to test usage of object methods in dispatch maps and in wrapper code. + */ +class xmlrpc_server_methods_container +{ /** - * Used to test usage of object methods in dispatch maps and in wrapper code - */ - class xmlrpc_server_methods_container + * Method used to test logging of php warnings generated by user functions. + */ + public function phpwarninggenerator($m) { - /** - * Method used to test logging of php warnings generated by user functions. - */ - function phpwarninggenerator($m) - { - $a = $b; // this triggers a warning in E_ALL mode, since $b is undefined - return new xmlrpcresp(new xmlrpcval(1, 'boolean')); - } - - /** - * Method used to testcatching of exceptions in the server. - */ - function exceptiongenerator($m) - { - throw new Exception("it's just a test", 1); - } - - /** - * a PHP version of the state-number server. Send me an integer and i'll sell you a state - * @param integer $s - * @return string - */ - static function findstate($s) - { - return inner_findstate($s); - } + $a = $b; // this triggers a warning in E_ALL mode, since $b is undefined + return new xmlrpcresp(new xmlrpcval(1, 'boolean')); } + /** + * Method used to testcatching of exceptions in the server. + */ + public function exceptiongenerator($m) + { + throw new Exception("it's just a test", 1); + } - // a PHP version - // of the state-number server - // send me an integer and i'll sell you a state - - $stateNames = array( - "Alabama", "Alaska", "Arizona", "Arkansas", "California", - "Colorado", "Columbia", "Connecticut", "Delaware", "Florida", - "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", - "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", - "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", - "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", - "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", - "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", - "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming" - ); + /* + * a PHP version of the state-number server. Send me an integer and i'll sell you a state + * @param integer $s + * @return string + */ + public static function findstate($s) + { + return inner_findstate($s); + } +} - $findstate_sig=array(array($xmlrpcString, $xmlrpcInt)); - $findstate_doc='When passed an integer between 1 and 51 returns the +// a PHP version +// of the state-number server +// send me an integer and i'll sell you a state + +$stateNames = array( + "Alabama", "Alaska", "Arizona", "Arkansas", "California", + "Colorado", "Columbia", "Connecticut", "Delaware", "Florida", + "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", + "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", + "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", + "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", + "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", + "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", + "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming", +); + +$findstate_sig = array(array($xmlrpcString, $xmlrpcInt)); +$findstate_doc = 'When passed an integer between 1 and 51 returns the name of a US state, where the integer is the index of that state name in an alphabetic order.'; +function findstate($m) +{ + global $xmlrpcerruser, $stateNames; + $err = ""; + // get the first param + $sno = $m->getParam(0); + + // param must be there and of the correct type: server object does the + // validation for us + + // extract the value of the state number + $snv = $sno->scalarval(); + // look it up in our array (zero-based) + if (isset($stateNames[$snv - 1])) { + $sname = $stateNames[$snv - 1]; + } else { + // not, there so complain + $err = "I don't have a state for the index '" . $snv . "'"; + } - function findstate($m) - { - global $xmlrpcerruser, $stateNames; - $err=""; - // get the first param - $sno=$m->getParam(0); - - // param must be there and of the correct type: server object does the - // validation for us - - // extract the value of the state number - $snv=$sno->scalarval(); - // look it up in our array (zero-based) - if (isset($stateNames[$snv-1])) - { - $sname=$stateNames[$snv-1]; - } - else - { - // not, there so complain - $err="I don't have a state for the index '" . $snv . "'"; - } - - // if we generated an error, create an error return response - if ($err) - { - return new xmlrpcresp(0, $xmlrpcerruser, $err); - } - else - { - // otherwise, we create the right response - // with the state name - return new xmlrpcresp(new xmlrpcval($sname)); - } + // if we generated an error, create an error return response + if ($err) { + return new xmlrpcresp(0, $xmlrpcerruser, $err); + } else { + // otherwise, we create the right response + // with the state name + return new xmlrpcresp(new xmlrpcval($sname)); } +} - /** - * Inner code of the state-number server. - * Used to test auto-registration of PHP funcions as xmlrpc methods. - * @param integer $stateno the state number - * @return string the name of the state (or error descrption) - */ - function inner_findstate($stateno) - { - global $stateNames; - if (isset($stateNames[$stateno-1])) - { - return $stateNames[$stateno-1]; - } - else - { - // not, there so complain - return "I don't have a state for the index '" . $stateno . "'"; - } +/** + * Inner code of the state-number server. + * Used to test auto-registration of PHP funcions as xmlrpc methods. + * + * @param integer $stateno the state number + * + * @return string the name of the state (or error descrption) + */ +function inner_findstate($stateno) +{ + global $stateNames; + if (isset($stateNames[$stateno - 1])) { + return $stateNames[$stateno - 1]; + } else { + // not, there so complain + return "I don't have a state for the index '" . $stateno . "'"; } - $findstate2_sig = wrap_php_function('inner_findstate'); +} - $findstate3_sig = wrap_php_function(array('xmlrpc_server_methods_container', 'findstate')); +$findstate2_sig = wrap_php_function('inner_findstate'); - $findstate5_sig = wrap_php_function('xmlrpc_server_methods_container::findstate'); +$findstate3_sig = wrap_php_function(array('xmlrpc_server_methods_container', 'findstate')); - $obj = new xmlrpc_server_methods_container(); - $findstate4_sig = wrap_php_function(array($obj, 'findstate')); +$findstate5_sig = wrap_php_function('xmlrpc_server_methods_container::findstate'); - $addtwo_sig=array(array($xmlrpcInt, $xmlrpcInt, $xmlrpcInt)); - $addtwo_doc='Add two integers together and return the result'; - function addtwo($m) - { - $s=$m->getParam(0); - $t=$m->getParam(1); - return new xmlrpcresp(new xmlrpcval($s->scalarval()+$t->scalarval(),"int")); - } +$obj = new xmlrpc_server_methods_container(); +$findstate4_sig = wrap_php_function(array($obj, 'findstate')); - $addtwodouble_sig=array(array($xmlrpcDouble, $xmlrpcDouble, $xmlrpcDouble)); - $addtwodouble_doc='Add two doubles together and return the result'; - function addtwodouble($m) - { - $s=$m->getParam(0); - $t=$m->getParam(1); - return new xmlrpcresp(new xmlrpcval($s->scalarval()+$t->scalarval(),"double")); - } +$addtwo_sig = array(array($xmlrpcInt, $xmlrpcInt, $xmlrpcInt)); +$addtwo_doc = 'Add two integers together and return the result'; +function addtwo($m) +{ + $s = $m->getParam(0); + $t = $m->getParam(1); - $stringecho_sig=array(array($xmlrpcString, $xmlrpcString)); - $stringecho_doc='Accepts a string parameter, returns the string.'; - function stringecho($m) - { - // just sends back a string - $s=$m->getParam(0); - $v = $s->scalarval(); - return new xmlrpcresp(new xmlrpcval($s->scalarval())); - } + return new xmlrpcresp(new xmlrpcval($s->scalarval() + $t->scalarval(), "int")); +} - $echoback_sig=array(array($xmlrpcString, $xmlrpcString)); - $echoback_doc='Accepts a string parameter, returns the entire incoming payload'; - function echoback($m) - { - // just sends back a string with what i got - // sent to me, just escaped, that's all - // - // $m is an incoming message - $s="I got the following message:\n" . $m->serialize(); - return new xmlrpcresp(new xmlrpcval($s)); - } +$addtwodouble_sig = array(array($xmlrpcDouble, $xmlrpcDouble, $xmlrpcDouble)); +$addtwodouble_doc = 'Add two doubles together and return the result'; +function addtwodouble($m) +{ + $s = $m->getParam(0); + $t = $m->getParam(1); - $echosixtyfour_sig=array(array($xmlrpcString, $xmlrpcBase64)); - $echosixtyfour_doc='Accepts a base64 parameter and returns it decoded as a string'; - function echosixtyfour($m) - { - // accepts an encoded value, but sends it back - // as a normal string. this is to test base64 encoding - // is working as expected - $incoming=$m->getParam(0); - return new xmlrpcresp(new xmlrpcval($incoming->scalarval(), "string")); - } + return new xmlrpcresp(new xmlrpcval($s->scalarval() + $t->scalarval(), "double")); +} - $bitflipper_sig=array(array($xmlrpcArray, $xmlrpcArray)); - $bitflipper_doc='Accepts an array of booleans, and returns them inverted'; - function bitflipper($m) - { - global $xmlrpcArray; - - $v=$m->getParam(0); - $sz=$v->arraysize(); - $rv=new xmlrpcval(array(), $xmlrpcArray); - - for($j=0; $j<$sz; $j++) - { - $b=$v->arraymem($j); - if ($b->scalarval()) - { - $rv->addScalar(false, "boolean"); - } - else - { - $rv->addScalar(true, "boolean"); - } - } +$stringecho_sig = array(array($xmlrpcString, $xmlrpcString)); +$stringecho_doc = 'Accepts a string parameter, returns the string.'; +function stringecho($m) +{ + // just sends back a string + $s = $m->getParam(0); + $v = $s->scalarval(); - return new xmlrpcresp($rv); - } + return new xmlrpcresp(new xmlrpcval($s->scalarval())); +} - // Sorting demo - // - // send me an array of structs thus: - // - // Dave 35 - // Edd 45 - // Fred 23 - // Barney 37 +$echoback_sig = array(array($xmlrpcString, $xmlrpcString)); +$echoback_doc = 'Accepts a string parameter, returns the entire incoming payload'; +function echoback($m) +{ + // just sends back a string with what i got + // sent to me, just escaped, that's all // - // and I'll return it to you in sorted order + // $m is an incoming message + $s = "I got the following message:\n" . $m->serialize(); - function agesorter_compare($a, $b) - { - global $agesorter_arr; + return new xmlrpcresp(new xmlrpcval($s)); +} + +$echosixtyfour_sig = array(array($xmlrpcString, $xmlrpcBase64)); +$echosixtyfour_doc = 'Accepts a base64 parameter and returns it decoded as a string'; +function echosixtyfour($m) +{ + // accepts an encoded value, but sends it back + // as a normal string. this is to test base64 encoding + // is working as expected + $incoming = $m->getParam(0); - // don't even ask me _why_ these come padded with - // hyphens, I couldn't tell you :p - $a=str_replace("-", "", $a); - $b=str_replace("-", "", $b); + return new xmlrpcresp(new xmlrpcval($incoming->scalarval(), "string")); +} - if ($agesorter_arr[$a]==$agesorter_arr[$b]) - { - return 0; +$bitflipper_sig = array(array($xmlrpcArray, $xmlrpcArray)); +$bitflipper_doc = 'Accepts an array of booleans, and returns them inverted'; +function bitflipper($m) +{ + global $xmlrpcArray; + + $v = $m->getParam(0); + $sz = $v->arraysize(); + $rv = new xmlrpcval(array(), $xmlrpcArray); + + for ($j = 0; $j < $sz; $j++) { + $b = $v->arraymem($j); + if ($b->scalarval()) { + $rv->addScalar(false, "boolean"); + } else { + $rv->addScalar(true, "boolean"); } - return ($agesorter_arr[$a] > $agesorter_arr[$b]) ? -1 : 1; } - $agesorter_sig=array(array($xmlrpcArray, $xmlrpcArray)); - $agesorter_doc='Send this method an array of [string, int] structs, eg: + return new xmlrpcresp($rv); +} + +// Sorting demo +// +// send me an array of structs thus: +// +// Dave 35 +// Edd 45 +// Fred 23 +// Barney 37 +// +// and I'll return it to you in sorted order + +function agesorter_compare($a, $b) +{ + global $agesorter_arr; + + // don't even ask me _why_ these come padded with + // hyphens, I couldn't tell you :p + $a = str_replace("-", "", $a); + $b = str_replace("-", "", $b); + + if ($agesorter_arr[$a] == $agesorter_arr[$b]) { + return 0; + } + + return ($agesorter_arr[$a] > $agesorter_arr[$b]) ? -1 : 1; +} + +$agesorter_sig = array(array($xmlrpcArray, $xmlrpcArray)); +$agesorter_doc = 'Send this method an array of [string, int] structs, eg:
  Dave   35
  Edd    45
@@ -257,80 +248,69 @@ in an alphabetic order.';
 
And the array will be returned with the entries sorted by their numbers. '; - function agesorter($m) - { - global $agesorter_arr, $xmlrpcerruser, $s; - - xmlrpc_debugmsg("Entering 'agesorter'"); - // get the parameter - $sno=$m->getParam(0); - // error string for [if|when] things go wrong - $err=""; - // create the output value - $v=new xmlrpcval(); - $agar=array(); - - if (isset($sno) && $sno->kindOf()=="array") - { - $max=$sno->arraysize(); - // TODO: create debug method to print can work once more - // print "\n"; - for($i=0; $i<$max; $i++) - { - $rec=$sno->arraymem($i); - if ($rec->kindOf()!="struct") - { - $err="Found non-struct in array at element $i"; - break; - } - // extract name and age from struct - $n=$rec->structmem("name"); - $a=$rec->structmem("age"); - // $n and $a are xmlrpcvals, - // so get the scalarval from them - $agar[$n->scalarval()]=$a->scalarval(); - } - - $agesorter_arr=$agar; - // hack, must make global as uksort() won't - // allow us to pass any other auxilliary information - uksort($agesorter_arr, agesorter_compare); - $outAr=array(); - while (list( $key, $val ) = each( $agesorter_arr ) ) - { - // recreate each struct element - $outAr[]=new xmlrpcval(array("name" => - new xmlrpcval($key), - "age" => - new xmlrpcval($val, "int")), "struct"); +function agesorter($m) +{ + global $agesorter_arr, $xmlrpcerruser, $s; + + xmlrpc_debugmsg("Entering 'agesorter'"); + // get the parameter + $sno = $m->getParam(0); + // error string for [if|when] things go wrong + $err = ""; + // create the output value + $v = new xmlrpcval(); + $agar = array(); + + if (isset($sno) && $sno->kindOf() == "array") { + $max = $sno->arraysize(); + // TODO: create debug method to print can work once more + // print "\n"; + for ($i = 0; $i < $max; $i++) { + $rec = $sno->arraymem($i); + if ($rec->kindOf() != "struct") { + $err = "Found non-struct in array at element $i"; + break; } - // add this array to the output value - $v->addArray($outAr); - } - else - { - $err="Must be one parameter, an array of structs"; + // extract name and age from struct + $n = $rec->structmem("name"); + $a = $rec->structmem("age"); + // $n and $a are xmlrpcvals, + // so get the scalarval from them + $agar[$n->scalarval()] = $a->scalarval(); } - if ($err) - { - return new xmlrpcresp(0, $xmlrpcerruser, $err); - } - else - { - return new xmlrpcresp($v); + $agesorter_arr = $agar; + // hack, must make global as uksort() won't + // allow us to pass any other auxilliary information + uksort($agesorter_arr, agesorter_compare); + $outAr = array(); + while (list($key, $val) = each($agesorter_arr)) { + // recreate each struct element + $outAr[] = new xmlrpcval(array("name" => new xmlrpcval($key), + "age" => new xmlrpcval($val, "int"),), "struct"); } + // add this array to the output value + $v->addArray($outAr); + } else { + $err = "Must be one parameter, an array of structs"; } - // signature and instructions, place these in the dispatch - // map - $mail_send_sig=array(array( - $xmlrpcBoolean, $xmlrpcString, $xmlrpcString, - $xmlrpcString, $xmlrpcString, $xmlrpcString, - $xmlrpcString, $xmlrpcString - )); + if ($err) { + return new xmlrpcresp(0, $xmlrpcerruser, $err); + } else { + return new xmlrpcresp($v); + } +} - $mail_send_doc='mail.send(recipient, subject, text, sender, cc, bcc, mimetype)
+// signature and instructions, place these in the dispatch +// map +$mail_send_sig = array(array( + $xmlrpcBoolean, $xmlrpcString, $xmlrpcString, + $xmlrpcString, $xmlrpcString, $xmlrpcString, + $xmlrpcString, $xmlrpcString, +)); + +$mail_send_doc = 'mail.send(recipient, subject, text, sender, cc, bcc, mimetype)
recipient, cc, and bcc are strings, comma-separated lists of email addresses, as described above.
subject is a string, the subject of the message.
sender is a string, it\'s the email address of the person sending the message. This string can not be @@ -338,516 +318,562 @@ a comma-separated list, it must contain a single email address only.
text is a string, it contains the body of the message.
mimetype, a string, is a standard MIME type, for example, text/plain. '; - // WARNING; this functionality depends on the sendmail -t option - // it may not work with Windows machines properly; particularly - // the Bcc option. Sneak on your friends at your own risk! - function mail_send($m) - { - global $xmlrpcerruser, $xmlrpcBoolean; - $err=""; - - $mTo=$m->getParam(0); - $mSub=$m->getParam(1); - $mBody=$m->getParam(2); - $mFrom=$m->getParam(3); - $mCc=$m->getParam(4); - $mBcc=$m->getParam(5); - $mMime=$m->getParam(6); - - if ($mTo->scalarval()=="") - { - $err="Error, no 'To' field specified"; - } - - if ($mFrom->scalarval()=="") - { - $err="Error, no 'From' field specified"; - } +// WARNING; this functionality depends on the sendmail -t option +// it may not work with Windows machines properly; particularly +// the Bcc option. Sneak on your friends at your own risk! +function mail_send($m) +{ + global $xmlrpcerruser, $xmlrpcBoolean; + $err = ""; + + $mTo = $m->getParam(0); + $mSub = $m->getParam(1); + $mBody = $m->getParam(2); + $mFrom = $m->getParam(3); + $mCc = $m->getParam(4); + $mBcc = $m->getParam(5); + $mMime = $m->getParam(6); + + if ($mTo->scalarval() == "") { + $err = "Error, no 'To' field specified"; + } - $msghdr="From: " . $mFrom->scalarval() . "\n"; - $msghdr.="To: ". $mTo->scalarval() . "\n"; + if ($mFrom->scalarval() == "") { + $err = "Error, no 'From' field specified"; + } - if ($mCc->scalarval()!="") - { - $msghdr.="Cc: " . $mCc->scalarval(). "\n"; - } - if ($mBcc->scalarval()!="") - { - $msghdr.="Bcc: " . $mBcc->scalarval(). "\n"; - } - if ($mMime->scalarval()!="") - { - $msghdr.="Content-type: " . $mMime->scalarval() . "\n"; - } - $msghdr.="X-Mailer: XML-RPC for PHP mailer 1.0"; - - if ($err=="") - { - if (!mail("", - $mSub->scalarval(), - $mBody->scalarval(), - $msghdr)) - { - $err="Error, could not send the mail."; - } - } + $msghdr = "From: " . $mFrom->scalarval() . "\n"; + $msghdr .= "To: " . $mTo->scalarval() . "\n"; - if ($err) - { - return new xmlrpcresp(0, $xmlrpcerruser, $err); - } - else - { - return new xmlrpcresp(new xmlrpcval("true", $xmlrpcBoolean)); + if ($mCc->scalarval() != "") { + $msghdr .= "Cc: " . $mCc->scalarval() . "\n"; + } + if ($mBcc->scalarval() != "") { + $msghdr .= "Bcc: " . $mBcc->scalarval() . "\n"; + } + if ($mMime->scalarval() != "") { + $msghdr .= "Content-type: " . $mMime->scalarval() . "\n"; + } + $msghdr .= "X-Mailer: XML-RPC for PHP mailer 1.0"; + + if ($err == "") { + if (!mail("", + $mSub->scalarval(), + $mBody->scalarval(), + $msghdr) + ) { + $err = "Error, could not send the mail."; } } - $getallheaders_sig=array(array($xmlrpcStruct)); - $getallheaders_doc='Returns a struct containing all the HTTP headers received with the request. Provides limited functionality with IIS'; - function getallheaders_xmlrpc($m) - { - global $xmlrpcerruser; - if (function_exists('getallheaders')) - { - return new xmlrpcresp(php_xmlrpc_encode(getallheaders())); - } - else - { - $headers = array(); - // IIS: poor man's version of getallheaders - foreach ($_SERVER as $key => $val) - if (strpos($key, 'HTTP_') === 0) - { - $key = ucfirst(str_replace('_', '-', strtolower(substr($key, 5)))); - $headers[$key] = $val; - } - return new xmlrpcresp(php_xmlrpc_encode($headers)); - } + if ($err) { + return new xmlrpcresp(0, $xmlrpcerruser, $err); + } else { + return new xmlrpcresp(new xmlrpcval("true", $xmlrpcBoolean)); } +} - $setcookies_sig=array(array($xmlrpcInt, $xmlrpcStruct)); - $setcookies_doc='Sends to client a response containing a single \'1\' digit, and sets to it http cookies as received in the request (array of structs describing a cookie)'; - function setcookies($m) - { - $m = $m->getParam(0); - while(list($name,$value) = $m->structeach()) - { - $cookiedesc = php_xmlrpc_decode($value); - setcookie($name, @$cookiedesc['value'], @$cookiedesc['expires'], @$cookiedesc['path'], @$cookiedesc['domain'], @$cookiedesc['secure']); +$getallheaders_sig = array(array($xmlrpcStruct)); +$getallheaders_doc = 'Returns a struct containing all the HTTP headers received with the request. Provides limited functionality with IIS'; +function getallheaders_xmlrpc($m) +{ + global $xmlrpcerruser; + if (function_exists('getallheaders')) { + return new xmlrpcresp(php_xmlrpc_encode(getallheaders())); + } else { + $headers = array(); + // IIS: poor man's version of getallheaders + foreach ($_SERVER as $key => $val) { + if (strpos($key, 'HTTP_') === 0) { + $key = ucfirst(str_replace('_', '-', strtolower(substr($key, 5)))); + $headers[$key] = $val; + } } - return new xmlrpcresp(new xmlrpcval(1, 'int')); + + return new xmlrpcresp(php_xmlrpc_encode($headers)); } +} - $getcookies_sig=array(array($xmlrpcStruct)); - $getcookies_doc='Sends to client a response containing all http cookies as received in the request (as struct)'; - function getcookies($m) - { - return new xmlrpcresp(php_xmlrpc_encode($_COOKIE)); +$setcookies_sig = array(array($xmlrpcInt, $xmlrpcStruct)); +$setcookies_doc = 'Sends to client a response containing a single \'1\' digit, and sets to it http cookies as received in the request (array of structs describing a cookie)'; +function setcookies($m) +{ + $m = $m->getParam(0); + while (list($name, $value) = $m->structeach()) { + $cookiedesc = php_xmlrpc_decode($value); + setcookie($name, @$cookiedesc['value'], @$cookiedesc['expires'], @$cookiedesc['path'], @$cookiedesc['domain'], @$cookiedesc['secure']); } - $v1_arrayOfStructs_sig=array(array($xmlrpcInt, $xmlrpcArray)); - $v1_arrayOfStructs_doc='This handler takes a single parameter, an array of structs, each of which contains at least three elements named moe, larry and curly, all s. Your handler must add all the struct elements named curly and return the result.'; - function v1_arrayOfStructs($m) - { - $sno=$m->getParam(0); - $numcurly=0; - for($i=0; $i<$sno->arraysize(); $i++) - { - $str=$sno->arraymem($i); - $str->structreset(); - while(list($key,$val)=$str->structeach()) - { - if ($key=="curly") - { - $numcurly+=$val->scalarval(); - } + return new xmlrpcresp(new xmlrpcval(1, 'int')); +} + +$getcookies_sig = array(array($xmlrpcStruct)); +$getcookies_doc = 'Sends to client a response containing all http cookies as received in the request (as struct)'; +function getcookies($m) +{ + return new xmlrpcresp(php_xmlrpc_encode($_COOKIE)); +} + +$v1_arrayOfStructs_sig = array(array($xmlrpcInt, $xmlrpcArray)); +$v1_arrayOfStructs_doc = 'This handler takes a single parameter, an array of structs, each of which contains at least three elements named moe, larry and curly, all s. Your handler must add all the struct elements named curly and return the result.'; +function v1_arrayOfStructs($m) +{ + $sno = $m->getParam(0); + $numcurly = 0; + for ($i = 0; $i < $sno->arraysize(); $i++) { + $str = $sno->arraymem($i); + $str->structreset(); + while (list($key, $val) = $str->structeach()) { + if ($key == "curly") { + $numcurly += $val->scalarval(); } } - return new xmlrpcresp(new xmlrpcval($numcurly, "int")); } - $v1_easyStruct_sig=array(array($xmlrpcInt, $xmlrpcStruct)); - $v1_easyStruct_doc='This handler takes a single parameter, a struct, containing at least three elements named moe, larry and curly, all <i4>s. Your handler must add the three numbers and return the result.'; - function v1_easyStruct($m) - { - $sno=$m->getParam(0); - $moe=$sno->structmem("moe"); - $larry=$sno->structmem("larry"); - $curly=$sno->structmem("curly"); - $num=$moe->scalarval() + $larry->scalarval() + $curly->scalarval(); - return new xmlrpcresp(new xmlrpcval($num, "int")); - } + return new xmlrpcresp(new xmlrpcval($numcurly, "int")); +} - $v1_echoStruct_sig=array(array($xmlrpcStruct, $xmlrpcStruct)); - $v1_echoStruct_doc='This handler takes a single parameter, a struct. Your handler must return the struct.'; - function v1_echoStruct($m) - { - $sno=$m->getParam(0); - return new xmlrpcresp($sno); - } +$v1_easyStruct_sig = array(array($xmlrpcInt, $xmlrpcStruct)); +$v1_easyStruct_doc = 'This handler takes a single parameter, a struct, containing at least three elements named moe, larry and curly, all <i4>s. Your handler must add the three numbers and return the result.'; +function v1_easyStruct($m) +{ + $sno = $m->getParam(0); + $moe = $sno->structmem("moe"); + $larry = $sno->structmem("larry"); + $curly = $sno->structmem("curly"); + $num = $moe->scalarval() + $larry->scalarval() + $curly->scalarval(); + + return new xmlrpcresp(new xmlrpcval($num, "int")); +} + +$v1_echoStruct_sig = array(array($xmlrpcStruct, $xmlrpcStruct)); +$v1_echoStruct_doc = 'This handler takes a single parameter, a struct. Your handler must return the struct.'; +function v1_echoStruct($m) +{ + $sno = $m->getParam(0); - $v1_manyTypes_sig=array(array( - $xmlrpcArray, $xmlrpcInt, $xmlrpcBoolean, - $xmlrpcString, $xmlrpcDouble, $xmlrpcDateTime, - $xmlrpcBase64 + return new xmlrpcresp($sno); +} + +$v1_manyTypes_sig = array(array( + $xmlrpcArray, $xmlrpcInt, $xmlrpcBoolean, + $xmlrpcString, $xmlrpcDouble, $xmlrpcDateTime, + $xmlrpcBase64, +)); +$v1_manyTypes_doc = 'This handler takes six parameters, and returns an array containing all the parameters.'; +function v1_manyTypes($m) +{ + return new xmlrpcresp(new xmlrpcval(array( + $m->getParam(0), + $m->getParam(1), + $m->getParam(2), + $m->getParam(3), + $m->getParam(4), + $m->getParam(5),), + "array" )); - $v1_manyTypes_doc='This handler takes six parameters, and returns an array containing all the parameters.'; - function v1_manyTypes($m) - { - return new xmlrpcresp(new xmlrpcval(array( - $m->getParam(0), - $m->getParam(1), - $m->getParam(2), - $m->getParam(3), - $m->getParam(4), - $m->getParam(5)), - "array" - )); - } +} - $v1_moderateSizeArrayCheck_sig=array(array($xmlrpcString, $xmlrpcArray)); - $v1_moderateSizeArrayCheck_doc='This handler takes a single parameter, which is an array containing between 100 and 200 elements. Each of the items is a string, your handler must return a string containing the concatenated text of the first and last elements.'; - function v1_moderateSizeArrayCheck($m) - { - $ar=$m->getParam(0); - $sz=$ar->arraysize(); - $first=$ar->arraymem(0); - $last=$ar->arraymem($sz-1); - return new xmlrpcresp(new xmlrpcval($first->scalarval() . +$v1_moderateSizeArrayCheck_sig = array(array($xmlrpcString, $xmlrpcArray)); +$v1_moderateSizeArrayCheck_doc = 'This handler takes a single parameter, which is an array containing between 100 and 200 elements. Each of the items is a string, your handler must return a string containing the concatenated text of the first and last elements.'; +function v1_moderateSizeArrayCheck($m) +{ + $ar = $m->getParam(0); + $sz = $ar->arraysize(); + $first = $ar->arraymem(0); + $last = $ar->arraymem($sz - 1); + + return new xmlrpcresp(new xmlrpcval($first->scalarval() . $last->scalarval(), "string")); - } +} - $v1_simpleStructReturn_sig=array(array($xmlrpcStruct, $xmlrpcInt)); - $v1_simpleStructReturn_doc='This handler takes one parameter, and returns a struct containing three elements, times10, times100 and times1000, the result of multiplying the number by 10, 100 and 1000.'; - function v1_simpleStructReturn($m) - { - $sno=$m->getParam(0); - $v=$sno->scalarval(); - return new xmlrpcresp(new xmlrpcval(array( - "times10" => new xmlrpcval($v*10, "int"), - "times100" => new xmlrpcval($v*100, "int"), - "times1000" => new xmlrpcval($v*1000, "int")), - "struct" - )); - } +$v1_simpleStructReturn_sig = array(array($xmlrpcStruct, $xmlrpcInt)); +$v1_simpleStructReturn_doc = 'This handler takes one parameter, and returns a struct containing three elements, times10, times100 and times1000, the result of multiplying the number by 10, 100 and 1000.'; +function v1_simpleStructReturn($m) +{ + $sno = $m->getParam(0); + $v = $sno->scalarval(); + + return new xmlrpcresp(new xmlrpcval(array( + "times10" => new xmlrpcval($v * 10, "int"), + "times100" => new xmlrpcval($v * 100, "int"), + "times1000" => new xmlrpcval($v * 1000, "int"),), + "struct" + )); +} - $v1_nestedStruct_sig=array(array($xmlrpcInt, $xmlrpcStruct)); - $v1_nestedStruct_doc='This handler takes a single parameter, a struct, that models a daily calendar. At the top level, there is one struct for each year. Each year is broken down into months, and months into days. Most of the days are empty in the struct you receive, but the entry for April 1, 2000 contains a least three elements named moe, larry and curly, all <i4>s. Your handler must add the three numbers and return the result.'; - function v1_nestedStruct($m) - { - $sno=$m->getParam(0); - - $twoK=$sno->structmem("2000"); - $april=$twoK->structmem("04"); - $fools=$april->structmem("01"); - $curly=$fools->structmem("curly"); - $larry=$fools->structmem("larry"); - $moe=$fools->structmem("moe"); - return new xmlrpcresp(new xmlrpcval($curly->scalarval() + $larry->scalarval() + $moe->scalarval(), "int")); - } +$v1_nestedStruct_sig = array(array($xmlrpcInt, $xmlrpcStruct)); +$v1_nestedStruct_doc = 'This handler takes a single parameter, a struct, that models a daily calendar. At the top level, there is one struct for each year. Each year is broken down into months, and months into days. Most of the days are empty in the struct you receive, but the entry for April 1, 2000 contains a least three elements named moe, larry and curly, all <i4>s. Your handler must add the three numbers and return the result.'; +function v1_nestedStruct($m) +{ + $sno = $m->getParam(0); - $v1_countTheEntities_sig=array(array($xmlrpcStruct, $xmlrpcString)); - $v1_countTheEntities_doc='This handler takes a single parameter, a string, that contains any number of predefined entities, namely <, >, & \' and ".
Your handler must return a struct that contains five fields, all numbers: ctLeftAngleBrackets, ctRightAngleBrackets, ctAmpersands, ctApostrophes, ctQuotes.'; - function v1_countTheEntities($m) - { - $sno=$m->getParam(0); - $str=$sno->scalarval(); - $gt=0; $lt=0; $ap=0; $qu=0; $amp=0; - for($i=0; $i": - $gt++; - break; - case "<": - $lt++; - break; - case "\"": - $qu++; - break; - case "'": - $ap++; - break; - case "&": - $amp++; - break; - default: - break; - } + $twoK = $sno->structmem("2000"); + $april = $twoK->structmem("04"); + $fools = $april->structmem("01"); + $curly = $fools->structmem("curly"); + $larry = $fools->structmem("larry"); + $moe = $fools->structmem("moe"); + + return new xmlrpcresp(new xmlrpcval($curly->scalarval() + $larry->scalarval() + $moe->scalarval(), "int")); +} + +$v1_countTheEntities_sig = array(array($xmlrpcStruct, $xmlrpcString)); +$v1_countTheEntities_doc = 'This handler takes a single parameter, a string, that contains any number of predefined entities, namely <, >, & \' and ".
Your handler must return a struct that contains five fields, all numbers: ctLeftAngleBrackets, ctRightAngleBrackets, ctAmpersands, ctApostrophes, ctQuotes.'; +function v1_countTheEntities($m) +{ + $sno = $m->getParam(0); + $str = $sno->scalarval(); + $gt = 0; + $lt = 0; + $ap = 0; + $qu = 0; + $amp = 0; + for ($i = 0; $i < strlen($str); $i++) { + $c = substr($str, $i, 1); + switch ($c) { + case ">": + $gt++; + break; + case "<": + $lt++; + break; + case "\"": + $qu++; + break; + case "'": + $ap++; + break; + case "&": + $amp++; + break; + default: + break; } - return new xmlrpcresp(new xmlrpcval(array( - "ctLeftAngleBrackets" => new xmlrpcval($lt, "int"), - "ctRightAngleBrackets" => new xmlrpcval($gt, "int"), - "ctAmpersands" => new xmlrpcval($amp, "int"), - "ctApostrophes" => new xmlrpcval($ap, "int"), - "ctQuotes" => new xmlrpcval($qu, "int")), - "struct" - )); } - // trivial interop tests - // http://www.xmlrpc.com/stories/storyReader$1636 + return new xmlrpcresp(new xmlrpcval(array( + "ctLeftAngleBrackets" => new xmlrpcval($lt, "int"), + "ctRightAngleBrackets" => new xmlrpcval($gt, "int"), + "ctAmpersands" => new xmlrpcval($amp, "int"), + "ctApostrophes" => new xmlrpcval($ap, "int"), + "ctQuotes" => new xmlrpcval($qu, "int"),), + "struct" + )); +} - $i_echoString_sig=array(array($xmlrpcString, $xmlrpcString)); - $i_echoString_doc="Echoes string."; +// trivial interop tests +// http://www.xmlrpc.com/stories/storyReader$1636 - $i_echoStringArray_sig=array(array($xmlrpcArray, $xmlrpcArray)); - $i_echoStringArray_doc="Echoes string array."; +$i_echoString_sig = array(array($xmlrpcString, $xmlrpcString)); +$i_echoString_doc = "Echoes string."; - $i_echoInteger_sig=array(array($xmlrpcInt, $xmlrpcInt)); - $i_echoInteger_doc="Echoes integer."; +$i_echoStringArray_sig = array(array($xmlrpcArray, $xmlrpcArray)); +$i_echoStringArray_doc = "Echoes string array."; - $i_echoIntegerArray_sig=array(array($xmlrpcArray, $xmlrpcArray)); - $i_echoIntegerArray_doc="Echoes integer array."; +$i_echoInteger_sig = array(array($xmlrpcInt, $xmlrpcInt)); +$i_echoInteger_doc = "Echoes integer."; - $i_echoFloat_sig=array(array($xmlrpcDouble, $xmlrpcDouble)); - $i_echoFloat_doc="Echoes float."; +$i_echoIntegerArray_sig = array(array($xmlrpcArray, $xmlrpcArray)); +$i_echoIntegerArray_doc = "Echoes integer array."; - $i_echoFloatArray_sig=array(array($xmlrpcArray, $xmlrpcArray)); - $i_echoFloatArray_doc="Echoes float array."; +$i_echoFloat_sig = array(array($xmlrpcDouble, $xmlrpcDouble)); +$i_echoFloat_doc = "Echoes float."; - $i_echoStruct_sig=array(array($xmlrpcStruct, $xmlrpcStruct)); - $i_echoStruct_doc="Echoes struct."; +$i_echoFloatArray_sig = array(array($xmlrpcArray, $xmlrpcArray)); +$i_echoFloatArray_doc = "Echoes float array."; - $i_echoStructArray_sig=array(array($xmlrpcArray, $xmlrpcArray)); - $i_echoStructArray_doc="Echoes struct array."; +$i_echoStruct_sig = array(array($xmlrpcStruct, $xmlrpcStruct)); +$i_echoStruct_doc = "Echoes struct."; - $i_echoValue_doc="Echoes any value back."; - $i_echoValue_sig=array(array($xmlrpcValue, $xmlrpcValue)); +$i_echoStructArray_sig = array(array($xmlrpcArray, $xmlrpcArray)); +$i_echoStructArray_doc = "Echoes struct array."; - $i_echoBase64_sig=array(array($xmlrpcBase64, $xmlrpcBase64)); - $i_echoBase64_doc="Echoes base64."; +$i_echoValue_doc = "Echoes any value back."; +$i_echoValue_sig = array(array($xmlrpcValue, $xmlrpcValue)); - $i_echoDate_sig=array(array($xmlrpcDateTime, $xmlrpcDateTime)); - $i_echoDate_doc="Echoes dateTime."; +$i_echoBase64_sig = array(array($xmlrpcBase64, $xmlrpcBase64)); +$i_echoBase64_doc = "Echoes base64."; - function i_echoParam($m) - { - $s=$m->getParam(0); - return new xmlrpcresp($s); - } +$i_echoDate_sig = array(array($xmlrpcDateTime, $xmlrpcDateTime)); +$i_echoDate_doc = "Echoes dateTime."; - function i_echoString($m) { return i_echoParam($m); } - function i_echoInteger($m) { return i_echoParam($m); } - function i_echoFloat($m) { return i_echoParam($m); } - function i_echoStruct($m) { return i_echoParam($m); } - function i_echoStringArray($m) { return i_echoParam($m); } - function i_echoIntegerArray($m) { return i_echoParam($m); } - function i_echoFloatArray($m) { return i_echoParam($m); } - function i_echoStructArray($m) { return i_echoParam($m); } - function i_echoValue($m) { return i_echoParam($m); } - function i_echoBase64($m) { return i_echoParam($m); } - function i_echoDate($m) { return i_echoParam($m); } - - $i_whichToolkit_sig=array(array($xmlrpcStruct)); - $i_whichToolkit_doc="Returns a struct containing the following strings: toolkitDocsUrl, toolkitName, toolkitVersion, toolkitOperatingSystem."; - - function i_whichToolkit($m) - { - global $xmlrpcName, $xmlrpcVersion,$SERVER_SOFTWARE; - $ret=array( - "toolkitDocsUrl" => "http://phpxmlrpc.sourceforge.net/", - "toolkitName" => $xmlrpcName, - "toolkitVersion" => $xmlrpcVersion, - "toolkitOperatingSystem" => isset ($SERVER_SOFTWARE) ? $SERVER_SOFTWARE : $_SERVER['SERVER_SOFTWARE'] - ); - return new xmlrpcresp ( php_xmlrpc_encode($ret)); - } +function i_echoParam($m) +{ + $s = $m->getParam(0); + + return new xmlrpcresp($s); +} + +function i_echoString($m) +{ + return i_echoParam($m); +} + +function i_echoInteger($m) +{ + return i_echoParam($m); +} + +function i_echoFloat($m) +{ + return i_echoParam($m); +} + +function i_echoStruct($m) +{ + return i_echoParam($m); +} + +function i_echoStringArray($m) +{ + return i_echoParam($m); +} + +function i_echoIntegerArray($m) +{ + return i_echoParam($m); +} - $o=new xmlrpc_server_methods_container; - $a=array( - "examples.getStateName" => array( - "function" => "findstate", - "signature" => $findstate_sig, - "docstring" => $findstate_doc - ), - "examples.sortByAge" => array( - "function" => "agesorter", - "signature" => $agesorter_sig, - "docstring" => $agesorter_doc - ), - "examples.addtwo" => array( - "function" => "addtwo", - "signature" => $addtwo_sig, - "docstring" => $addtwo_doc - ), - "examples.addtwodouble" => array( - "function" => "addtwodouble", - "signature" => $addtwodouble_sig, - "docstring" => $addtwodouble_doc - ), - "examples.stringecho" => array( - "function" => "stringecho", - "signature" => $stringecho_sig, - "docstring" => $stringecho_doc - ), - "examples.echo" => array( - "function" => "echoback", - "signature" => $echoback_sig, - "docstring" => $echoback_doc - ), - "examples.decode64" => array( - "function" => "echosixtyfour", - "signature" => $echosixtyfour_sig, - "docstring" => $echosixtyfour_doc - ), - "examples.invertBooleans" => array( - "function" => "bitflipper", - "signature" => $bitflipper_sig, - "docstring" => $bitflipper_doc - ), - "examples.generatePHPWarning" => array( - "function" => array($o, "phpwarninggenerator") - //'function' => 'xmlrpc_server_methods_container::phpwarninggenerator' - ), - "examples.raiseException" => array( - "function" => array($o, "exceptiongenerator") - ), - "examples.getallheaders" => array( - "function" => 'getallheaders_xmlrpc', - "signature" => $getallheaders_sig, - "docstring" => $getallheaders_doc - ), - "examples.setcookies" => array( - "function" => 'setcookies', - "signature" => $setcookies_sig, - "docstring" => $setcookies_doc - ), - "examples.getcookies" => array( - "function" => 'getcookies', - "signature" => $getcookies_sig, - "docstring" => $getcookies_doc - ), - "mail.send" => array( - "function" => "mail_send", - "signature" => $mail_send_sig, - "docstring" => $mail_send_doc - ), - "validator1.arrayOfStructsTest" => array( - "function" => "v1_arrayOfStructs", - "signature" => $v1_arrayOfStructs_sig, - "docstring" => $v1_arrayOfStructs_doc - ), - "validator1.easyStructTest" => array( - "function" => "v1_easyStruct", - "signature" => $v1_easyStruct_sig, - "docstring" => $v1_easyStruct_doc - ), - "validator1.echoStructTest" => array( - "function" => "v1_echoStruct", - "signature" => $v1_echoStruct_sig, - "docstring" => $v1_echoStruct_doc - ), - "validator1.manyTypesTest" => array( - "function" => "v1_manyTypes", - "signature" => $v1_manyTypes_sig, - "docstring" => $v1_manyTypes_doc - ), - "validator1.moderateSizeArrayCheck" => array( - "function" => "v1_moderateSizeArrayCheck", - "signature" => $v1_moderateSizeArrayCheck_sig, - "docstring" => $v1_moderateSizeArrayCheck_doc - ), - "validator1.simpleStructReturnTest" => array( - "function" => "v1_simpleStructReturn", - "signature" => $v1_simpleStructReturn_sig, - "docstring" => $v1_simpleStructReturn_doc - ), - "validator1.nestedStructTest" => array( - "function" => "v1_nestedStruct", - "signature" => $v1_nestedStruct_sig, - "docstring" => $v1_nestedStruct_doc - ), - "validator1.countTheEntities" => array( - "function" => "v1_countTheEntities", - "signature" => $v1_countTheEntities_sig, - "docstring" => $v1_countTheEntities_doc - ), - "interopEchoTests.echoString" => array( - "function" => "i_echoString", - "signature" => $i_echoString_sig, - "docstring" => $i_echoString_doc - ), - "interopEchoTests.echoStringArray" => array( - "function" => "i_echoStringArray", - "signature" => $i_echoStringArray_sig, - "docstring" => $i_echoStringArray_doc - ), - "interopEchoTests.echoInteger" => array( - "function" => "i_echoInteger", - "signature" => $i_echoInteger_sig, - "docstring" => $i_echoInteger_doc - ), - "interopEchoTests.echoIntegerArray" => array( - "function" => "i_echoIntegerArray", - "signature" => $i_echoIntegerArray_sig, - "docstring" => $i_echoIntegerArray_doc - ), - "interopEchoTests.echoFloat" => array( - "function" => "i_echoFloat", - "signature" => $i_echoFloat_sig, - "docstring" => $i_echoFloat_doc - ), - "interopEchoTests.echoFloatArray" => array( - "function" => "i_echoFloatArray", - "signature" => $i_echoFloatArray_sig, - "docstring" => $i_echoFloatArray_doc - ), - "interopEchoTests.echoStruct" => array( - "function" => "i_echoStruct", - "signature" => $i_echoStruct_sig, - "docstring" => $i_echoStruct_doc - ), - "interopEchoTests.echoStructArray" => array( - "function" => "i_echoStructArray", - "signature" => $i_echoStructArray_sig, - "docstring" => $i_echoStructArray_doc - ), - "interopEchoTests.echoValue" => array( - "function" => "i_echoValue", - "signature" => $i_echoValue_sig, - "docstring" => $i_echoValue_doc - ), - "interopEchoTests.echoBase64" => array( - "function" => "i_echoBase64", - "signature" => $i_echoBase64_sig, - "docstring" => $i_echoBase64_doc - ), - "interopEchoTests.echoDate" => array( - "function" => "i_echoDate", - "signature" => $i_echoDate_sig, - "docstring" => $i_echoDate_doc - ), - "interopEchoTests.whichToolkit" => array( - "function" => "i_whichToolkit", - "signature" => $i_whichToolkit_sig, - "docstring" => $i_whichToolkit_doc - ) +function i_echoFloatArray($m) +{ + return i_echoParam($m); +} + +function i_echoStructArray($m) +{ + return i_echoParam($m); +} + +function i_echoValue($m) +{ + return i_echoParam($m); +} + +function i_echoBase64($m) +{ + return i_echoParam($m); +} + +function i_echoDate($m) +{ + return i_echoParam($m); +} + +$i_whichToolkit_sig = array(array($xmlrpcStruct)); +$i_whichToolkit_doc = "Returns a struct containing the following strings: toolkitDocsUrl, toolkitName, toolkitVersion, toolkitOperatingSystem."; + +function i_whichToolkit($m) +{ + global $xmlrpcName, $xmlrpcVersion, $SERVER_SOFTWARE; + $ret = array( + "toolkitDocsUrl" => "http://phpxmlrpc.sourceforge.net/", + "toolkitName" => $xmlrpcName, + "toolkitVersion" => $xmlrpcVersion, + "toolkitOperatingSystem" => isset($SERVER_SOFTWARE) ? $SERVER_SOFTWARE : $_SERVER['SERVER_SOFTWARE'], ); - if ($findstate2_sig) - $a['examples.php.getStateName'] = $findstate2_sig; + return new xmlrpcresp(php_xmlrpc_encode($ret)); +} + +$o = new xmlrpc_server_methods_container(); +$a = array( + "examples.getStateName" => array( + "function" => "findstate", + "signature" => $findstate_sig, + "docstring" => $findstate_doc, + ), + "examples.sortByAge" => array( + "function" => "agesorter", + "signature" => $agesorter_sig, + "docstring" => $agesorter_doc, + ), + "examples.addtwo" => array( + "function" => "addtwo", + "signature" => $addtwo_sig, + "docstring" => $addtwo_doc, + ), + "examples.addtwodouble" => array( + "function" => "addtwodouble", + "signature" => $addtwodouble_sig, + "docstring" => $addtwodouble_doc, + ), + "examples.stringecho" => array( + "function" => "stringecho", + "signature" => $stringecho_sig, + "docstring" => $stringecho_doc, + ), + "examples.echo" => array( + "function" => "echoback", + "signature" => $echoback_sig, + "docstring" => $echoback_doc, + ), + "examples.decode64" => array( + "function" => "echosixtyfour", + "signature" => $echosixtyfour_sig, + "docstring" => $echosixtyfour_doc, + ), + "examples.invertBooleans" => array( + "function" => "bitflipper", + "signature" => $bitflipper_sig, + "docstring" => $bitflipper_doc, + ), + "examples.generatePHPWarning" => array( + "function" => array($o, "phpwarninggenerator"), + //'function' => 'xmlrpc_server_methods_container::phpwarninggenerator' + ), + "examples.raiseException" => array( + "function" => array($o, "exceptiongenerator"), + ), + "examples.getallheaders" => array( + "function" => 'getallheaders_xmlrpc', + "signature" => $getallheaders_sig, + "docstring" => $getallheaders_doc, + ), + "examples.setcookies" => array( + "function" => 'setcookies', + "signature" => $setcookies_sig, + "docstring" => $setcookies_doc, + ), + "examples.getcookies" => array( + "function" => 'getcookies', + "signature" => $getcookies_sig, + "docstring" => $getcookies_doc, + ), + "mail.send" => array( + "function" => "mail_send", + "signature" => $mail_send_sig, + "docstring" => $mail_send_doc, + ), + "validator1.arrayOfStructsTest" => array( + "function" => "v1_arrayOfStructs", + "signature" => $v1_arrayOfStructs_sig, + "docstring" => $v1_arrayOfStructs_doc, + ), + "validator1.easyStructTest" => array( + "function" => "v1_easyStruct", + "signature" => $v1_easyStruct_sig, + "docstring" => $v1_easyStruct_doc, + ), + "validator1.echoStructTest" => array( + "function" => "v1_echoStruct", + "signature" => $v1_echoStruct_sig, + "docstring" => $v1_echoStruct_doc, + ), + "validator1.manyTypesTest" => array( + "function" => "v1_manyTypes", + "signature" => $v1_manyTypes_sig, + "docstring" => $v1_manyTypes_doc, + ), + "validator1.moderateSizeArrayCheck" => array( + "function" => "v1_moderateSizeArrayCheck", + "signature" => $v1_moderateSizeArrayCheck_sig, + "docstring" => $v1_moderateSizeArrayCheck_doc, + ), + "validator1.simpleStructReturnTest" => array( + "function" => "v1_simpleStructReturn", + "signature" => $v1_simpleStructReturn_sig, + "docstring" => $v1_simpleStructReturn_doc, + ), + "validator1.nestedStructTest" => array( + "function" => "v1_nestedStruct", + "signature" => $v1_nestedStruct_sig, + "docstring" => $v1_nestedStruct_doc, + ), + "validator1.countTheEntities" => array( + "function" => "v1_countTheEntities", + "signature" => $v1_countTheEntities_sig, + "docstring" => $v1_countTheEntities_doc, + ), + "interopEchoTests.echoString" => array( + "function" => "i_echoString", + "signature" => $i_echoString_sig, + "docstring" => $i_echoString_doc, + ), + "interopEchoTests.echoStringArray" => array( + "function" => "i_echoStringArray", + "signature" => $i_echoStringArray_sig, + "docstring" => $i_echoStringArray_doc, + ), + "interopEchoTests.echoInteger" => array( + "function" => "i_echoInteger", + "signature" => $i_echoInteger_sig, + "docstring" => $i_echoInteger_doc, + ), + "interopEchoTests.echoIntegerArray" => array( + "function" => "i_echoIntegerArray", + "signature" => $i_echoIntegerArray_sig, + "docstring" => $i_echoIntegerArray_doc, + ), + "interopEchoTests.echoFloat" => array( + "function" => "i_echoFloat", + "signature" => $i_echoFloat_sig, + "docstring" => $i_echoFloat_doc, + ), + "interopEchoTests.echoFloatArray" => array( + "function" => "i_echoFloatArray", + "signature" => $i_echoFloatArray_sig, + "docstring" => $i_echoFloatArray_doc, + ), + "interopEchoTests.echoStruct" => array( + "function" => "i_echoStruct", + "signature" => $i_echoStruct_sig, + "docstring" => $i_echoStruct_doc, + ), + "interopEchoTests.echoStructArray" => array( + "function" => "i_echoStructArray", + "signature" => $i_echoStructArray_sig, + "docstring" => $i_echoStructArray_doc, + ), + "interopEchoTests.echoValue" => array( + "function" => "i_echoValue", + "signature" => $i_echoValue_sig, + "docstring" => $i_echoValue_doc, + ), + "interopEchoTests.echoBase64" => array( + "function" => "i_echoBase64", + "signature" => $i_echoBase64_sig, + "docstring" => $i_echoBase64_doc, + ), + "interopEchoTests.echoDate" => array( + "function" => "i_echoDate", + "signature" => $i_echoDate_sig, + "docstring" => $i_echoDate_doc, + ), + "interopEchoTests.whichToolkit" => array( + "function" => "i_whichToolkit", + "signature" => $i_whichToolkit_sig, + "docstring" => $i_whichToolkit_doc, + ), +); + +if ($findstate2_sig) { + $a['examples.php.getStateName'] = $findstate2_sig; +} - if ($findstate3_sig) - $a['examples.php2.getStateName'] = $findstate3_sig; +if ($findstate3_sig) { + $a['examples.php2.getStateName'] = $findstate3_sig; +} - if ($findstate4_sig) - $a['examples.php3.getStateName'] = $findstate4_sig; +if ($findstate4_sig) { + $a['examples.php3.getStateName'] = $findstate4_sig; +} - if ($findstate5_sig) - $a['examples.php4.getStateName'] = $findstate5_sig; +if ($findstate5_sig) { + $a['examples.php4.getStateName'] = $findstate5_sig; +} - $s=new xmlrpc_server($a, false); - $s->setdebug(3); - $s->compress_response = true; +$s = new xmlrpc_server($a, false); +$s->setdebug(3); +$s->compress_response = true; - // out-of-band information: let the client manipulate the server operations. - // we do this to help the testsuite script: do not reproduce in production! - if (isset($_GET['RESPONSE_ENCODING'])) - $s->response_charset_encoding = $_GET['RESPONSE_ENCODING']; - if (isset($_GET['EXCEPTION_HANDLING'])) - $s->exception_handling = $_GET['EXCEPTION_HANDLING']; - $s->service(); - // that should do all we need! +// out-of-band information: let the client manipulate the server operations. +// we do this to help the testsuite script: do not reproduce in production! +if (isset($_GET['RESPONSE_ENCODING'])) { + $s->response_charset_encoding = $_GET['RESPONSE_ENCODING']; +} +if (isset($_GET['EXCEPTION_HANDLING'])) { + $s->exception_handling = $_GET['EXCEPTION_HANDLING']; +} +$s->service(); +// that should do all we need! diff --git a/demo/vardemo.php b/demo/vardemo.php index b501cd60..0b542e74 100644 --- a/demo/vardemo.php +++ b/demo/vardemo.php @@ -2,61 +2,61 @@ xmlrpc Testing value serialization\n"; - - $v = new xmlrpcval(23, "int"); - print "
" . htmlentities($v->serialize()) . "
"; - $v = new xmlrpcval("What are you saying? >> << &&"); - print "
" . htmlentities($v->serialize()) . "
"; - - $v = new xmlrpcval(array( - new xmlrpcval("ABCDEFHIJ"), - new xmlrpcval(1234, 'int'), - new xmlrpcval(1, 'boolean')), - "array" - ); - - print "
" . htmlentities($v->serialize()) . "
"; - - $v = new xmlrpcval( - array( - "thearray" => new xmlrpcval( - array( - new xmlrpcval("ABCDEFHIJ"), - new xmlrpcval(1234, 'int'), - new xmlrpcval(1, 'boolean'), - new xmlrpcval(0, 'boolean'), - new xmlrpcval(true, 'boolean'), - new xmlrpcval(false, 'boolean') - ), - "array" +include_once __DIR__ . "/../vendor/autoload.php"; + +include_once __DIR__ . "/../lib/xmlrpc.inc"; + +$f = new xmlrpcmsg('examples.getStateName'); + +print "

Testing value serialization

\n"; + +$v = new xmlrpcval(23, "int"); +print "
" . htmlentities($v->serialize()) . "
"; +$v = new xmlrpcval("What are you saying? >> << &&"); +print "
" . htmlentities($v->serialize()) . "
"; + +$v = new xmlrpcval(array( + new xmlrpcval("ABCDEFHIJ"), + new xmlrpcval(1234, 'int'), + new xmlrpcval(1, 'boolean'),), + "array" +); + +print "
" . htmlentities($v->serialize()) . "
"; + +$v = new xmlrpcval( + array( + "thearray" => new xmlrpcval( + array( + new xmlrpcval("ABCDEFHIJ"), + new xmlrpcval(1234, 'int'), + new xmlrpcval(1, 'boolean'), + new xmlrpcval(0, 'boolean'), + new xmlrpcval(true, 'boolean'), + new xmlrpcval(false, 'boolean'), ), - "theint" => new xmlrpcval(23, 'int'), - "thestring" => new xmlrpcval("foobarwhizz"), - "thestruct" => new xmlrpcval( - array( - "one" => new xmlrpcval(1, 'int'), - "two" => new xmlrpcval(2, 'int') - ), - "struct" - ) + "array" ), - "struct" - ); + "theint" => new xmlrpcval(23, 'int'), + "thestring" => new xmlrpcval("foobarwhizz"), + "thestruct" => new xmlrpcval( + array( + "one" => new xmlrpcval(1, 'int'), + "two" => new xmlrpcval(2, 'int'), + ), + "struct" + ), + ), + "struct" +); - print "
" . htmlentities($v->serialize()) . "
"; +print "
" . htmlentities($v->serialize()) . "
"; - $w = new xmlrpcval(array($v, new xmlrpcval("That was the struct!")), "array"); +$w = new xmlrpcval(array($v, new xmlrpcval("That was the struct!")), "array"); - print "
" . htmlentities($w->serialize()) . "
"; +print "
" . htmlentities($w->serialize()) . "
"; - $w = new xmlrpcval("Mary had a little lamb, +$w = new xmlrpcval("Mary had a little lamb, Whose fleece was white as snow, And everywhere that Mary went the lamb was sure to go. @@ -65,29 +65,29 @@ Mary had a little lamb She tied it to a pylon Ten thousand volts went down its back And turned it into nylon", "base64" - ); - print "
" . htmlentities($w->serialize()) . "
"; - print "
Value of base64 string is: '" . $w->scalarval() . "'
"; +); +print "
" . htmlentities($w->serialize()) . "
"; +print "
Value of base64 string is: '" . $w->scalarval() . "'
"; - $f->method(''); - $f->addParam(new xmlrpcval("41", "int")); +$f->method(''); +$f->addParam(new xmlrpcval("41", "int")); - print "

Testing request serialization

\n"; - $op = $f->serialize(); - print "
" . htmlentities($op) . "
"; +print "

Testing request serialization

\n"; +$op = $f->serialize(); +print "
" . htmlentities($op) . "
"; - print "

Testing ISO date format

\n";
+print "

Testing ISO date format

\n";
 
-    $t = time();
-    $date = iso8601_encode($t);
-    print "Now is $t --> $date\n";
-    print "Or in UTC, that is " . iso8601_encode($t, 1) . "\n";
-    $tb = iso8601_decode($date);
-    print "That is to say $date --> $tb\n";
-    print "Which comes out at " . iso8601_encode($tb) . "\n";
-    print "Which was the time in UTC at " . iso8601_decode($date, 1) . "\n";
+$t = time();
+$date = iso8601_encode($t);
+print "Now is $t --> $date\n";
+print "Or in UTC, that is " . iso8601_encode($t, 1) . "\n";
+$tb = iso8601_decode($date);
+print "That is to say $date --> $tb\n";
+print "Which comes out at " . iso8601_encode($tb) . "\n";
+print "Which was the time in UTC at " . iso8601_decode($date, 1) . "\n";
 
-    print "
\n"; +print "
\n"; ?> -- 2.47.0