php/phpxmlrpc/demo/server/server.php

   1 <?php
   2 /**
   3  * Demo server for xmlrpc library.
   4  *
   5  * Implements a lot of webservices, including a suite of services used for
   6  * interoperability testing (validator1 methods), and some whose only purpose
   7  * is to be used for unit-testing the library.
   8  *
   9  * Please do not copy this file verbatim into your production server.
  10  **/
  11
  12 // give user a chance to see the source for this server instead of running the services
  13 if ($_SERVER['REQUEST_METHOD'] != 'POST' && isset($_GET['showSource'])) {
  14     highlight_file(__FILE__);
  15     die();
  16 }
  17
  18 include_once __DIR__ . "/../../vendor/autoload.php";
  19
  20 // out-of-band information: let the client manipulate the server operations.
  21 // we do this to help the testsuite script: do not reproduce in production!
  22 if (isset($_COOKIE['PHPUNIT_SELENIUM_TEST_ID']) && extension_loaded('xdebug')) {
  23     $GLOBALS['PHPUNIT_COVERAGE_DATA_DIRECTORY'] = '/tmp/phpxmlrpc_coverage';
  24     if (!is_dir($GLOBALS['PHPUNIT_COVERAGE_DATA_DIRECTORY'])) {
  25         mkdir($GLOBALS['PHPUNIT_COVERAGE_DATA_DIRECTORY']);
  26     }
  27
  28     include_once __DIR__ . "/../../vendor/phpunit/phpunit-selenium/PHPUnit/Extensions/SeleniumCommon/prepend.php";
  29 }
  30
  31 use PhpXmlRpc\Value;
  32
  33 /**
  34  * Used to test usage of object methods in dispatch maps and in wrapper code.
  35  */
  36 class xmlrpcServerMethodsContainer
  37 {
  38     /**
  39      * Method used to test logging of php warnings generated by user functions.
  40      * @param PhpXmlRpc\Request $req
  41      * @return PhpXmlRpc\Response
  42      */
  43     public function phpWarningGenerator($req)
  44     {
  45         $a = $undefinedVariable; // this triggers a warning in E_ALL mode, since $undefinedVariable is undefined
  46         return new PhpXmlRpc\Response(new Value(1, Value::$xmlrpcBoolean));
  47     }
  48
  49     /**
  50      * Method used to test catching of exceptions in the server.
  51      * @param PhpXmlRpc\Request $req
  52      * @throws Exception
  53      */
  54     public function exceptionGenerator($req)
  55     {
  56         throw new Exception("it's just a test", 1);
  57     }
  58
  59     /**
  60      * @param string $msg
  61      */
  62     public function debugMessageGenerator($msg)
  63     {
  64         PhpXmlRpc\Server::xmlrpc_debugmsg($msg);
  65     }
  66
  67     /**
  68      * A PHP version of the state-number server. Send me an integer and i'll sell you a state.
  69      * Used to test wrapping of PHP methods into xmlrpc methods.
  70      *
  71      * @param integer $num
  72      * @return string
  73      * @throws Exception
  74      */
  75     public static function findState($num)
  76     {
  77         return inner_findstate($num);
  78     }
  79
  80     /**
  81      * Returns an instance of stdClass.
  82      * Used to test wrapping of PHP objects with class preservation
  83      */
  84     public function returnObject()
  85     {
  86         $obj = new stdClass();
  87         $obj->hello = 'world';
  88         return $obj;
  89     }
  90 }
  91
  92 // a PHP version of the state-number server
  93 // send me an integer and i'll sell you a state
  94
  95 $stateNames = array(
  96     "Alabama", "Alaska", "Arizona", "Arkansas", "California",
  97     "Colorado", "Columbia", "Connecticut", "Delaware", "Florida",
  98     "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas",
  99     "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan",
 100     "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada",
 101     "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina",
 102     "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island",
 103     "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont",
 104     "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming",
 105 );
 106
 107 $findstate_sig = array(array(Value::$xmlrpcString, Value::$xmlrpcInt));
 108 $findstate_doc = 'When passed an integer between 1 and 51 returns the
 109 name of a US state, where the integer is the index of that state name
 110 in an alphabetic order.';
 111
 112 function findState($req)
 113 {
 114     global $stateNames;
 115
 116     $err = "";
 117     // get the first param
 118     $sno = $req->getParam(0);
 119
 120     // param must be there and of the correct type: server object does the validation for us
 121
 122     // extract the value of the state number
 123     $snv = $sno->scalarval();
 124     // look it up in our array (zero-based)
 125     if (isset($stateNames[$snv - 1])) {
 126         $stateName = $stateNames[$snv - 1];
 127     } else {
 128         // not there, so complain
 129         $err = "I don't have a state for the index '" . $snv . "'";
 130     }
 131
 132     // if we generated an error, create an error return response
 133     if ($err) {
 134         return new PhpXmlRpc\Response(0, PhpXmlRpc\PhpXmlRpc::$xmlrpcerruser, $err);
 135     } else {
 136         // otherwise, we create the right response with the state name
 137         return new PhpXmlRpc\Response(new Value($stateName));
 138     }
 139 }
 140
 141 /**
 142  * Inner code of the state-number server.
 143  * Used to test wrapping of PHP functions into xmlrpc methods.
 144  *
 145  * @param integer $stateNo the state number
 146  *
 147  * @return string the name of the state (or error description)
 148  *
 149  * @throws Exception if state is not found
 150  */
 151 function inner_findstate($stateNo)
 152 {
 153     global $stateNames;
 154
 155     if (isset($stateNames[$stateNo - 1])) {
 156         return $stateNames[$stateNo - 1];
 157     } else {
 158         // not, there so complain
 159         throw new Exception("I don't have a state for the index '" . $stateNo . "'", PhpXmlRpc\PhpXmlRpc::$xmlrpcerruser);
 160     }
 161 }
 162
 163 $wrapper = new PhpXmlRpc\Wrapper();
 164
 165 $findstate2_sig = $wrapper->wrapPhpFunction('inner_findstate');
 166
 167 $findstate3_sig = $wrapper->wrapPhpFunction(array('xmlrpcServerMethodsContainer', 'findState'));
 168
 169 $obj = new xmlrpcServerMethodsContainer();
 170 $findstate4_sig = $wrapper->wrapPhpFunction(array($obj, 'findstate'));
 171
 172 $findstate5_sig = $wrapper->wrapPhpFunction('xmlrpcServerMethodsContainer::findState', '', array('return_source' => true));
 173 eval($findstate5_sig['source']);
 174
 175 $findstate6_sig = $wrapper->wrapPhpFunction('inner_findstate', '', array('return_source' => true));
 176 eval($findstate6_sig['source']);
 177
 178 $findstate7_sig = $wrapper->wrapPhpFunction(array('xmlrpcServerMethodsContainer', 'findState'), '', array('return_source' => true));
 179 eval($findstate7_sig['source']);
 180
 181 $obj = new xmlrpcServerMethodsContainer();
 182 $findstate8_sig = $wrapper->wrapPhpFunction(array($obj, 'findstate'), '', array('return_source' => true));
 183 eval($findstate8_sig['source']);
 184
 185 $findstate9_sig = $wrapper->wrapPhpFunction('xmlrpcServerMethodsContainer::findState', '', array('return_source' => true));
 186 eval($findstate9_sig['source']);
 187
 188 $findstate10_sig = array(
 189     "function" => function ($req) { return findState($req); },
 190     "signature" => $findstate_sig,
 191     "docstring" => $findstate_doc,
 192 );
 193
 194 $findstate11_sig = $wrapper->wrapPhpFunction(function ($stateNo) { return inner_findstate($stateNo); });
 195
 196 $c = new xmlrpcServerMethodsContainer;
 197 $moreSignatures = $wrapper->wrapPhpClass($c, array('prefix' => 'tests.', 'method_type' => 'all'));
 198
 199 $returnObj_sig =  $wrapper->wrapPhpFunction(array($c, 'returnObject'), '', array('encode_php_objs' => true));
 200
 201 // used to test signatures with NULL params
 202 $findstate12_sig = array(
 203     array(Value::$xmlrpcString, Value::$xmlrpcInt, Value::$xmlrpcNull),
 204     array(Value::$xmlrpcString, Value::$xmlrpcNull, Value::$xmlrpcInt),
 205 );
 206
 207 function findStateWithNulls($req)
 208 {
 209     $a = $req->getParam(0);
 210     $b = $req->getParam(1);
 211
 212     if ($a->scalartyp() == Value::$xmlrpcNull)
 213         return new PhpXmlRpc\Response(new Value(inner_findstate($b->scalarval())));
 214     else
 215         return new PhpXmlRpc\Response(new Value(inner_findstate($a->scalarval())));
 216 }
 217
 218 $addtwo_sig = array(array(Value::$xmlrpcInt, Value::$xmlrpcInt, Value::$xmlrpcInt));
 219 $addtwo_doc = 'Add two integers together and return the result';
 220 function addTwo($req)
 221 {
 222     $s = $req->getParam(0);
 223     $t = $req->getParam(1);
 224
 225     return new PhpXmlRpc\Response(new Value($s->scalarval() + $t->scalarval(), Value::$xmlrpcInt));
 226 }
 227
 228 $addtwodouble_sig = array(array(Value::$xmlrpcDouble, Value::$xmlrpcDouble, Value::$xmlrpcDouble));
 229 $addtwodouble_doc = 'Add two doubles together and return the result';
 230 function addTwoDouble($req)
 231 {
 232     $s = $req->getParam(0);
 233     $t = $req->getParam(1);
 234
 235     return new PhpXmlRpc\Response(new Value($s->scalarval() + $t->scalarval(), Value::$xmlrpcDouble));
 236 }
 237
 238 $stringecho_sig = array(array(Value::$xmlrpcString, Value::$xmlrpcString));
 239 $stringecho_doc = 'Accepts a string parameter, returns the string.';
 240 function stringEcho($req)
 241 {
 242     // just sends back a string
 243     return new PhpXmlRpc\Response(new Value($req->getParam(0)->scalarval()));
 244 }
 245
 246 $echoback_sig = array(array(Value::$xmlrpcString, Value::$xmlrpcString));
 247 $echoback_doc = 'Accepts a string parameter, returns the entire incoming payload';
 248 function echoBack($req)
 249 {
 250     // just sends back a string with what i got sent to me, just escaped, that's all
 251     $s = "I got the following message:\n" . $req->serialize();
 252
 253     return new PhpXmlRpc\Response(new Value($s));
 254 }
 255
 256 $echosixtyfour_sig = array(array(Value::$xmlrpcString, Value::$xmlrpcBase64));
 257 $echosixtyfour_doc = 'Accepts a base64 parameter and returns it decoded as a string';
 258 function echoSixtyFour($req)
 259 {
 260     // Accepts an encoded value, but sends it back as a normal string.
 261     // This is to test that base64 encoding is working as expected
 262     $incoming = $req->getParam(0);
 263
 264     return new PhpXmlRpc\Response(new Value($incoming->scalarval(), Value::$xmlrpcString));
 265 }
 266
 267 $bitflipper_sig = array(array(Value::$xmlrpcArray, Value::$xmlrpcArray));
 268 $bitflipper_doc = 'Accepts an array of booleans, and returns them inverted';
 269 function bitFlipper($req)
 270 {
 271     $v = $req->getParam(0);
 272     $rv = new Value(array(), Value::$xmlrpcArray);
 273
 274     foreach ($v as $b) {
 275         if ($b->scalarval()) {
 276             $rv[] = new Value(false, Value::$xmlrpcBoolean);
 277         } else {
 278             $rv[] = new Value(true, Value::$xmlrpcBoolean);
 279         }
 280     }
 281
 282     return new PhpXmlRpc\Response($rv);
 283 }
 284
 285 // Sorting demo
 286 //
 287 // send me an array of structs thus:
 288 //
 289 // Dave 35
 290 // Edd  45
 291 // Fred 23
 292 // Barney 37
 293 //
 294 // and I'll return it to you in sorted order
 295
 296 function agesorter_compare($a, $b)
 297 {
 298     global $agesorter_arr;
 299
 300     // don't even ask me _why_ these come padded with hyphens, I couldn't tell you :p
 301     $a = str_replace("-", "", $a);
 302     $b = str_replace("-", "", $b);
 303
 304     if ($agesorter_arr[$a] == $agesorter_arr[$b]) {
 305         return 0;
 306     }
 307
 308     return ($agesorter_arr[$a] > $agesorter_arr[$b]) ? -1 : 1;
 309 }
 310
 311 $agesorter_sig = array(array(Value::$xmlrpcArray, Value::$xmlrpcArray));
 312 $agesorter_doc = 'Send this method an array of [string, int] structs, eg:
 313 <pre>
 314  Dave   35
 315  Edd    45
 316  Fred   23
 317  Barney 37
 318 </pre>
 319 And the array will be returned with the entries sorted by their numbers.
 320 ';
 321 function ageSorter($req)
 322 {
 323     global $agesorter_arr, $s;
 324
 325     PhpXmlRpc\Server::xmlrpc_debugmsg("Entering 'agesorter'");
 326     // get the parameter
 327     $sno = $req->getParam(0);
 328     // error string for [if|when] things go wrong
 329     $err = "";
 330     $agar = array();
 331
 332     $max = $sno->count();
 333     PhpXmlRpc\Server::xmlrpc_debugmsg("Found $max array elements");
 334     foreach ($sno as $i => $rec) {
 335         if ($rec->kindOf() != "struct") {
 336             $err = "Found non-struct in array at element $i";
 337             break;
 338         }
 339         // extract name and age from struct
 340         $n = $rec["name"];
 341         $a = $rec["age"];
 342         // $n and $a are xmlrpcvals,
 343         // so get the scalarval from them
 344         $agar[$n->scalarval()] = $a->scalarval();
 345     }
 346
 347     // create the output value
 348     $v = new Value(array(), Value::$xmlrpcArray);
 349
 350     $agesorter_arr = $agar;
 351     // hack, must make global as uksort() won't
 352     // allow us to pass any other auxiliary information
 353     uksort($agesorter_arr, 'agesorter_compare');
 354     while (list($key, $val) = each($agesorter_arr)) {
 355         // recreate each struct element
 356         $v[] = new Value(
 357             array(
 358                 "name" => new Value($key),
 359                 "age" => new Value($val, "int")
 360             ),
 361             Value::$xmlrpcStruct
 362         );
 363     }
 364
 365     if ($err) {
 366         return new PhpXmlRpc\Response(0, PhpXmlRpc\PhpXmlRpc::$xmlrpcerruser, $err);
 367     } else {
 368         return new PhpXmlRpc\Response($v);
 369     }
 370 }
 371
 372 // signature and instructions, place these in the dispatch map
 373 $mailsend_sig = array(array(
 374     Value::$xmlrpcBoolean, Value::$xmlrpcString, Value::$xmlrpcString,
 375     Value::$xmlrpcString, Value::$xmlrpcString, Value::$xmlrpcString,
 376     Value::$xmlrpcString, Value::$xmlrpcString,
 377 ));
 378 $mailsend_doc = 'mail.send(recipient, subject, text, sender, cc, bcc, mimetype)<br/>
 379 recipient, cc, and bcc are strings, comma-separated lists of email addresses, as described above.<br/>
 380 subject is a string, the subject of the message.<br/>
 381 sender is a string, it\'s the email address of the person sending the message. This string can not be
 382 a comma-separated list, it must contain a single email address only.<br/>
 383 text is a string, it contains the body of the message.<br/>
 384 mimetype, a string, is a standard MIME type, for example, text/plain.
 385 ';
 386 // WARNING; this functionality depends on the sendmail -t option
 387 // it may not work with Windows machines properly; particularly
 388 // the Bcc option. Sneak on your friends at your own risk!
 389 function mailSend($req)
 390 {
 391     $err = "";
 392
 393     $mTo = $req->getParam(0);
 394     $mSub = $req->getParam(1);
 395     $mBody = $req->getParam(2);
 396     $mFrom = $req->getParam(3);
 397     $mCc = $req->getParam(4);
 398     $mBcc = $req->getParam(5);
 399     $mMime = $req->getParam(6);
 400
 401     if ($mTo->scalarval() == "") {
 402         $err = "Error, no 'To' field specified";
 403     }
 404
 405     if ($mFrom->scalarval() == "") {
 406         $err = "Error, no 'From' field specified";
 407     }
 408
 409     $msgHdr = "From: " . $mFrom->scalarval() . "\n";
 410     $msgHdr .= "To: " . $mTo->scalarval() . "\n";
 411
 412     if ($mCc->scalarval() != "") {
 413         $msgHdr .= "Cc: " . $mCc->scalarval() . "\n";
 414     }
 415     if ($mBcc->scalarval() != "") {
 416         $msgHdr .= "Bcc: " . $mBcc->scalarval() . "\n";
 417     }
 418     if ($mMime->scalarval() != "") {
 419         $msgHdr .= "Content-type: " . $mMime->scalarval() . "\n";
 420     }
 421     $msgHdr .= "X-Mailer: XML-RPC for PHP mailer 1.0";
 422
 423     if ($err == "") {
 424         if (!mail("",
 425             $mSub->scalarval(),
 426             $mBody->scalarval(),
 427             $msgHdr)
 428         ) {
 429             $err = "Error, could not send the mail.";
 430         }
 431     }
 432
 433     if ($err) {
 434         return new PhpXmlRpc\Response(0, PhpXmlRpc\PhpXmlRpc::$xmlrpcerruser, $err);
 435     } else {
 436         return new PhpXmlRpc\Response(new Value(true, Value::$xmlrpcBoolean));
 437     }
 438 }
 439
 440 $getallheaders_sig = array(array(Value::$xmlrpcStruct));
 441 $getallheaders_doc = 'Returns a struct containing all the HTTP headers received with the request. Provides limited functionality with IIS';
 442 function getAllHeaders_xmlrpc($req)
 443 {
 444     $encoder = new PhpXmlRpc\Encoder();
 445
 446     if (function_exists('getallheaders')) {
 447         return new PhpXmlRpc\Response($encoder->encode(getallheaders()));
 448     } else {
 449         $headers = array();
 450         // IIS: poor man's version of getallheaders
 451         foreach ($_SERVER as $key => $val) {
 452             if (strpos($key, 'HTTP_') === 0) {
 453                 $key = ucfirst(str_replace('_', '-', strtolower(substr($key, 5))));
 454                 $headers[$key] = $val;
 455             }
 456         }
 457
 458         return new PhpXmlRpc\Response($encoder->encode($headers));
 459     }
 460 }
 461
 462 $setcookies_sig = array(array(Value::$xmlrpcInt, Value::$xmlrpcStruct));
 463 $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)';
 464 function setCookies($req)
 465 {
 466     $encoder = new PhpXmlRpc\Encoder();
 467     $cookies = $req->getParam(0);
 468     foreach ($cookies as $name => $value) {
 469         $cookieDesc = $encoder->decode($value);
 470         setcookie($name, @$cookieDesc['value'], @$cookieDesc['expires'], @$cookieDesc['path'], @$cookieDesc['domain'], @$cookieDesc['secure']);
 471     }
 472
 473     return new PhpXmlRpc\Response(new Value(1, Value::$xmlrpcInt));
 474 }
 475
 476 $getcookies_sig = array(array(Value::$xmlrpcStruct));
 477 $getcookies_doc = 'Sends to client a response containing all http cookies as received in the request (as struct)';
 478 function getCookies($req)
 479 {
 480     $encoder = new PhpXmlRpc\Encoder();
 481     return new PhpXmlRpc\Response($encoder->encode($_COOKIE));
 482 }
 483
 484 $v1_arrayOfStructs_sig = array(array(Value::$xmlrpcInt, Value::$xmlrpcArray));
 485 $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 <i4>s. Your handler must add all the struct elements named curly and return the result.';
 486 function v1_arrayOfStructs($req)
 487 {
 488     $sno = $req->getParam(0);
 489     $numCurly = 0;
 490     foreach ($sno as $str) {
 491         foreach ($str as $key => $val) {
 492             if ($key == "curly") {
 493                 $numCurly += $val->scalarval();
 494             }
 495         }
 496     }
 497
 498     return new PhpXmlRpc\Response(new Value($numCurly, Value::$xmlrpcInt));
 499 }
 500
 501 $v1_easyStruct_sig = array(array(Value::$xmlrpcInt, Value::$xmlrpcStruct));
 502 $v1_easyStruct_doc = 'This handler takes a single parameter, a struct, containing at least three elements named moe, larry and curly, all &lt;i4&gt;s. Your handler must add the three numbers and return the result.';
 503 function v1_easyStruct($req)
 504 {
 505     $sno = $req->getParam(0);
 506     $moe = $sno["moe"];
 507     $larry = $sno["larry"];
 508     $curly = $sno["curly"];
 509     $num = $moe->scalarval() + $larry->scalarval() + $curly->scalarval();
 510
 511     return new PhpXmlRpc\Response(new Value($num, Value::$xmlrpcInt));
 512 }
 513
 514 $v1_echoStruct_sig = array(array(Value::$xmlrpcStruct, Value::$xmlrpcStruct));
 515 $v1_echoStruct_doc = 'This handler takes a single parameter, a struct. Your handler must return the struct.';
 516 function v1_echoStruct($req)
 517 {
 518     $sno = $req->getParam(0);
 519
 520     return new PhpXmlRpc\Response($sno);
 521 }
 522
 523 $v1_manyTypes_sig = array(array(
 524     Value::$xmlrpcArray, Value::$xmlrpcInt, Value::$xmlrpcBoolean,
 525     Value::$xmlrpcString, Value::$xmlrpcDouble, Value::$xmlrpcDateTime,
 526     Value::$xmlrpcBase64,
 527 ));
 528 $v1_manyTypes_doc = 'This handler takes six parameters, and returns an array containing all the parameters.';
 529 function v1_manyTypes($req)
 530 {
 531     return new PhpXmlRpc\Response(new Value(
 532         array(
 533             $req->getParam(0),
 534             $req->getParam(1),
 535             $req->getParam(2),
 536             $req->getParam(3),
 537             $req->getParam(4),
 538             $req->getParam(5)
 539         ),
 540         Value::$xmlrpcArray
 541     ));
 542 }
 543
 544 $v1_moderateSizeArrayCheck_sig = array(array(Value::$xmlrpcString, Value::$xmlrpcArray));
 545 $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.';
 546 function v1_moderateSizeArrayCheck($req)
 547 {
 548     $ar = $req->getParam(0);
 549     $sz = $ar->count();
 550     $first = $ar[0];
 551     $last = $ar[$sz - 1];
 552
 553     return new PhpXmlRpc\Response(new Value($first->scalarval() .
 554         $last->scalarval(), Value::$xmlrpcString));
 555 }
 556
 557 $v1_simpleStructReturn_sig = array(array(Value::$xmlrpcStruct, Value::$xmlrpcInt));
 558 $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.';
 559 function v1_simpleStructReturn($req)
 560 {
 561     $sno = $req->getParam(0);
 562     $v = $sno->scalarval();
 563
 564     return new PhpXmlRpc\Response(new Value(
 565         array(
 566             "times10" => new Value($v * 10, Value::$xmlrpcInt),
 567             "times100" => new Value($v * 100, Value::$xmlrpcInt),
 568             "times1000" => new Value($v * 1000, Value::$xmlrpcInt)
 569         ),
 570         Value::$xmlrpcStruct
 571     ));
 572 }
 573
 574 $v1_nestedStruct_sig = array(array(Value::$xmlrpcInt, Value::$xmlrpcStruct));
 575 $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 &lt;i4&gt;s. Your handler must add the three numbers and return the result.';
 576 function v1_nestedStruct($req)
 577 {
 578     $sno = $req->getParam(0);
 579
 580     $twoK = $sno["2000"];
 581     $april = $twoK["04"];
 582     $fools = $april["01"];
 583     $curly = $fools["curly"];
 584     $larry = $fools["larry"];
 585     $moe = $fools["moe"];
 586
 587     return new PhpXmlRpc\Response(new Value($curly->scalarval() + $larry->scalarval() + $moe->scalarval(), Value::$xmlrpcInt));
 588 }
 589
 590 $v1_countTheEntities_sig = array(array(Value::$xmlrpcStruct, Value::$xmlrpcString));
 591 $v1_countTheEntities_doc = 'This handler takes a single parameter, a string, that contains any number of predefined entities, namely &lt;, &gt;, &amp; \' and ".<BR>Your handler must return a struct that contains five fields, all numbers: ctLeftAngleBrackets, ctRightAngleBrackets, ctAmpersands, ctApostrophes, ctQuotes.';
 592 function v1_countTheEntities($req)
 593 {
 594     $sno = $req->getParam(0);
 595     $str = $sno->scalarval();
 596     $gt = 0;
 597     $lt = 0;
 598     $ap = 0;
 599     $qu = 0;
 600     $amp = 0;
 601     for ($i = 0; $i < strlen($str); $i++) {
 602         $c = substr($str, $i, 1);
 603         switch ($c) {
 604             case ">":
 605                 $gt++;
 606                 break;
 607             case "<":
 608                 $lt++;
 609                 break;
 610             case "\"":
 611                 $qu++;
 612                 break;
 613             case "'":
 614                 $ap++;
 615                 break;
 616             case "&":
 617                 $amp++;
 618                 break;
 619             default:
 620                 break;
 621         }
 622     }
 623
 624     return new PhpXmlRpc\Response(new Value(
 625         array(
 626             "ctLeftAngleBrackets" => new Value($lt, Value::$xmlrpcInt),
 627             "ctRightAngleBrackets" => new Value($gt, Value::$xmlrpcInt),
 628             "ctAmpersands" => new Value($amp, Value::$xmlrpcInt),
 629             "ctApostrophes" => new Value($ap, Value::$xmlrpcInt),
 630             "ctQuotes" => new Value($qu, Value::$xmlrpcInt)
 631         ),
 632         Value::$xmlrpcStruct
 633     ));
 634 }
 635
 636 // trivial interop tests
 637 // http://www.xmlrpc.com/stories/storyReader$1636
 638
 639 $i_echoString_sig = array(array(Value::$xmlrpcString, Value::$xmlrpcString));
 640 $i_echoString_doc = "Echoes string.";
 641
 642 $i_echoStringArray_sig = array(array(Value::$xmlrpcArray, Value::$xmlrpcArray));
 643 $i_echoStringArray_doc = "Echoes string array.";
 644
 645 $i_echoInteger_sig = array(array(Value::$xmlrpcInt, Value::$xmlrpcInt));
 646 $i_echoInteger_doc = "Echoes integer.";
 647
 648 $i_echoIntegerArray_sig = array(array(Value::$xmlrpcArray, Value::$xmlrpcArray));
 649 $i_echoIntegerArray_doc = "Echoes integer array.";
 650
 651 $i_echoFloat_sig = array(array(Value::$xmlrpcDouble, Value::$xmlrpcDouble));
 652 $i_echoFloat_doc = "Echoes float.";
 653
 654 $i_echoFloatArray_sig = array(array(Value::$xmlrpcArray, Value::$xmlrpcArray));
 655 $i_echoFloatArray_doc = "Echoes float array.";
 656
 657 $i_echoStruct_sig = array(array(Value::$xmlrpcStruct, Value::$xmlrpcStruct));
 658 $i_echoStruct_doc = "Echoes struct.";
 659
 660 $i_echoStructArray_sig = array(array(Value::$xmlrpcArray, Value::$xmlrpcArray));
 661 $i_echoStructArray_doc = "Echoes struct array.";
 662
 663 $i_echoValue_doc = "Echoes any value back.";
 664 $i_echoValue_sig = array(array(Value::$xmlrpcValue, Value::$xmlrpcValue));
 665
 666 $i_echoBase64_sig = array(array(Value::$xmlrpcBase64, Value::$xmlrpcBase64));
 667 $i_echoBase64_doc = "Echoes base64.";
 668
 669 $i_echoDate_sig = array(array(Value::$xmlrpcDateTime, Value::$xmlrpcDateTime));
 670 $i_echoDate_doc = "Echoes dateTime.";
 671
 672 function i_echoParam($req)
 673 {
 674     $s = $req->getParam(0);
 675
 676     return new PhpXmlRpc\Response($s);
 677 }
 678
 679 function i_echoString($req)
 680 {
 681     return i_echoParam($req);
 682 }
 683
 684 function i_echoInteger($req)
 685 {
 686     return i_echoParam($req);
 687 }
 688
 689 function i_echoFloat($req)
 690 {
 691     return i_echoParam($req);
 692 }
 693
 694 function i_echoStruct($req)
 695 {
 696     return i_echoParam($req);
 697 }
 698
 699 function i_echoStringArray($req)
 700 {
 701     return i_echoParam($req);
 702 }
 703
 704 function i_echoIntegerArray($req)
 705 {
 706     return i_echoParam($req);
 707 }
 708
 709 function i_echoFloatArray($req)
 710 {
 711     return i_echoParam($req);
 712 }
 713
 714 function i_echoStructArray($req)
 715 {
 716     return i_echoParam($req);
 717 }
 718
 719 function i_echoValue($req)
 720 {
 721     return i_echoParam($req);
 722 }
 723
 724 function i_echoBase64($req)
 725 {
 726     return i_echoParam($req);
 727 }
 728
 729 function i_echoDate($req)
 730 {
 731     return i_echoParam($req);
 732 }
 733
 734 $i_whichToolkit_sig = array(array(Value::$xmlrpcStruct));
 735 $i_whichToolkit_doc = "Returns a struct containing the following strings: toolkitDocsUrl, toolkitName, toolkitVersion, toolkitOperatingSystem.";
 736
 737 function i_whichToolkit($req)
 738 {
 739     global $SERVER_SOFTWARE;
 740     $ret = array(
 741         "toolkitDocsUrl" => "http://phpxmlrpc.sourceforge.net/",
 742         "toolkitName" => PhpXmlRpc\PhpXmlRpc::$xmlrpcName,
 743         "toolkitVersion" => PhpXmlRpc\PhpXmlRpc::$xmlrpcVersion,
 744         "toolkitOperatingSystem" => isset($SERVER_SOFTWARE) ? $SERVER_SOFTWARE : $_SERVER['SERVER_SOFTWARE'],
 745     );
 746
 747     $encoder = new PhpXmlRpc\Encoder();
 748     return new PhpXmlRpc\Response($encoder->encode($ret));
 749 }
 750
 751 $object = new xmlrpcServerMethodsContainer();
 752 $signatures = array(
 753     "examples.getStateName" => array(
 754         "function" => "findState",
 755         "signature" => $findstate_sig,
 756         "docstring" => $findstate_doc,
 757     ),
 758     "examples.sortByAge" => array(
 759         "function" => "ageSorter",
 760         "signature" => $agesorter_sig,
 761         "docstring" => $agesorter_doc,
 762     ),
 763     "examples.addtwo" => array(
 764         "function" => "addTwo",
 765         "signature" => $addtwo_sig,
 766         "docstring" => $addtwo_doc,
 767     ),
 768     "examples.addtwodouble" => array(
 769         "function" => "addTwoDouble",
 770         "signature" => $addtwodouble_sig,
 771         "docstring" => $addtwodouble_doc,
 772     ),
 773     "examples.stringecho" => array(
 774         "function" => "stringEcho",
 775         "signature" => $stringecho_sig,
 776         "docstring" => $stringecho_doc,
 777     ),
 778     "examples.echo" => array(
 779         "function" => "echoBack",
 780         "signature" => $echoback_sig,
 781         "docstring" => $echoback_doc,
 782     ),
 783     "examples.decode64" => array(
 784         "function" => "echoSixtyFour",
 785         "signature" => $echosixtyfour_sig,
 786         "docstring" => $echosixtyfour_doc,
 787     ),
 788     "examples.invertBooleans" => array(
 789         "function" => "bitFlipper",
 790         "signature" => $bitflipper_sig,
 791         "docstring" => $bitflipper_doc,
 792     ),
 793     // signature omitted on purpose
 794     "tests.generatePHPWarning" => array(
 795         "function" => array($object, "phpWarningGenerator"),
 796     ),
 797     // signature omitted on purpose
 798     "tests.raiseException" => array(
 799         "function" => array($object, "exceptionGenerator"),
 800     ),
 801     // Greek word 'kosme'. NB: NOT a valid ISO8859 string!
 802     // NB: we can only register this when setting internal encoding to UTF-8, or it will break system.listMethods
 803     "tests.utf8methodname." . 'κόσμε' => array(
 804         "function" => "stringEcho",
 805         "signature" => $stringecho_sig,
 806         "docstring" => $stringecho_doc,
 807     ),
 808     /*"tests.iso88591methodname." . chr(224) . chr(252) . chr(232) => array(
 809         "function" => "stringEcho",
 810         "signature" => $stringecho_sig,
 811         "docstring" => $stringecho_doc,
 812     ),*/
 813     "examples.getallheaders" => array(
 814         "function" => 'getAllHeaders_xmlrpc',
 815         "signature" => $getallheaders_sig,
 816         "docstring" => $getallheaders_doc,
 817     ),
 818     "examples.setcookies" => array(
 819         "function" => 'setCookies',
 820         "signature" => $setcookies_sig,
 821         "docstring" => $setcookies_doc,
 822     ),
 823     "examples.getcookies" => array(
 824         "function" => 'getCookies',
 825         "signature" => $getcookies_sig,
 826         "docstring" => $getcookies_doc,
 827     ),
 828     "mail.send" => array(
 829         "function" => "mailSend",
 830         "signature" => $mailsend_sig,
 831         "docstring" => $mailsend_doc,
 832     ),
 833     "validator1.arrayOfStructsTest" => array(
 834         "function" => "v1_arrayOfStructs",
 835         "signature" => $v1_arrayOfStructs_sig,
 836         "docstring" => $v1_arrayOfStructs_doc,
 837     ),
 838     "validator1.easyStructTest" => array(
 839         "function" => "v1_easyStruct",
 840         "signature" => $v1_easyStruct_sig,
 841         "docstring" => $v1_easyStruct_doc,
 842     ),
 843     "validator1.echoStructTest" => array(
 844         "function" => "v1_echoStruct",
 845         "signature" => $v1_echoStruct_sig,
 846         "docstring" => $v1_echoStruct_doc,
 847     ),
 848     "validator1.manyTypesTest" => array(
 849         "function" => "v1_manyTypes",
 850         "signature" => $v1_manyTypes_sig,
 851         "docstring" => $v1_manyTypes_doc,
 852     ),
 853     "validator1.moderateSizeArrayCheck" => array(
 854         "function" => "v1_moderateSizeArrayCheck",
 855         "signature" => $v1_moderateSizeArrayCheck_sig,
 856         "docstring" => $v1_moderateSizeArrayCheck_doc,
 857     ),
 858     "validator1.simpleStructReturnTest" => array(
 859         "function" => "v1_simpleStructReturn",
 860         "signature" => $v1_simpleStructReturn_sig,
 861         "docstring" => $v1_simpleStructReturn_doc,
 862     ),
 863     "validator1.nestedStructTest" => array(
 864         "function" => "v1_nestedStruct",
 865         "signature" => $v1_nestedStruct_sig,
 866         "docstring" => $v1_nestedStruct_doc,
 867     ),
 868     "validator1.countTheEntities" => array(
 869         "function" => "v1_countTheEntities",
 870         "signature" => $v1_countTheEntities_sig,
 871         "docstring" => $v1_countTheEntities_doc,
 872     ),
 873     "interopEchoTests.echoString" => array(
 874         "function" => "i_echoString",
 875         "signature" => $i_echoString_sig,
 876         "docstring" => $i_echoString_doc,
 877     ),
 878     "interopEchoTests.echoStringArray" => array(
 879         "function" => "i_echoStringArray",
 880         "signature" => $i_echoStringArray_sig,
 881         "docstring" => $i_echoStringArray_doc,
 882     ),
 883     "interopEchoTests.echoInteger" => array(
 884         "function" => "i_echoInteger",
 885         "signature" => $i_echoInteger_sig,
 886         "docstring" => $i_echoInteger_doc,
 887     ),
 888     "interopEchoTests.echoIntegerArray" => array(
 889         "function" => "i_echoIntegerArray",
 890         "signature" => $i_echoIntegerArray_sig,
 891         "docstring" => $i_echoIntegerArray_doc,
 892     ),
 893     "interopEchoTests.echoFloat" => array(
 894         "function" => "i_echoFloat",
 895         "signature" => $i_echoFloat_sig,
 896         "docstring" => $i_echoFloat_doc,
 897     ),
 898     "interopEchoTests.echoFloatArray" => array(
 899         "function" => "i_echoFloatArray",
 900         "signature" => $i_echoFloatArray_sig,
 901         "docstring" => $i_echoFloatArray_doc,
 902     ),
 903     "interopEchoTests.echoStruct" => array(
 904         "function" => "i_echoStruct",
 905         "signature" => $i_echoStruct_sig,
 906         "docstring" => $i_echoStruct_doc,
 907     ),
 908     "interopEchoTests.echoStructArray" => array(
 909         "function" => "i_echoStructArray",
 910         "signature" => $i_echoStructArray_sig,
 911         "docstring" => $i_echoStructArray_doc,
 912     ),
 913     "interopEchoTests.echoValue" => array(
 914         "function" => "i_echoValue",
 915         "signature" => $i_echoValue_sig,
 916         "docstring" => $i_echoValue_doc,
 917     ),
 918     "interopEchoTests.echoBase64" => array(
 919         "function" => "i_echoBase64",
 920         "signature" => $i_echoBase64_sig,
 921         "docstring" => $i_echoBase64_doc,
 922     ),
 923     "interopEchoTests.echoDate" => array(
 924         "function" => "i_echoDate",
 925         "signature" => $i_echoDate_sig,
 926         "docstring" => $i_echoDate_doc,
 927     ),
 928     "interopEchoTests.whichToolkit" => array(
 929         "function" => "i_whichToolkit",
 930         "signature" => $i_whichToolkit_sig,
 931         "docstring" => $i_whichToolkit_doc,
 932     ),
 933
 934     'tests.getStateName.2' => $findstate2_sig,
 935     'tests.getStateName.3' => $findstate3_sig,
 936     'tests.getStateName.4' => $findstate4_sig,
 937     'tests.getStateName.5' => $findstate5_sig,
 938     'tests.getStateName.6' => $findstate6_sig,
 939     'tests.getStateName.7' => $findstate7_sig,
 940     'tests.getStateName.8' => $findstate8_sig,
 941     'tests.getStateName.9' => $findstate9_sig,
 942     'tests.getStateName.10' => $findstate10_sig,
 943     'tests.getStateName.11' => $findstate11_sig,
 944
 945     'tests.getStateName.12' => array(
 946         "function" => "findStateWithNulls",
 947         "signature" => $findstate12_sig,
 948         "docstring" => $findstate_doc,
 949     ),
 950
 951     'tests.returnPhpObject' => $returnObj_sig,
 952 );
 953
 954 $signatures = array_merge($signatures, $moreSignatures);
 955
 956 // enable support for the NULL extension
 957 PhpXmlRpc\PhpXmlRpc::$xmlrpc_null_extension = true;
 958
 959 $s = new PhpXmlRpc\Server($signatures, false);
 960 $s->setdebug(3);
 961 $s->compress_response = true;
 962
 963 // out-of-band information: let the client manipulate the server operations.
 964 // we do this to help the testsuite script: do not reproduce in production!
 965 if (isset($_GET['RESPONSE_ENCODING'])) {
 966     $s->response_charset_encoding = $_GET['RESPONSE_ENCODING'];
 967 }
 968 if (isset($_GET['DETECT_ENCODINGS'])) {
 969     PhpXmlRpc\PhpXmlRpc::$xmlrpc_detectencodings = $_GET['DETECT_ENCODINGS'];
 970 }
 971 if (isset($_GET['EXCEPTION_HANDLING'])) {
 972     $s->exception_handling = $_GET['EXCEPTION_HANDLING'];
 973 }
 974 $s->service();
 975 // that should do all we need!
 976
 977 // out-of-band information: let the client manipulate the server operations.
 978 // we do this to help the testsuite script: do not reproduce in production!
 979 if (isset($_COOKIE['PHPUNIT_SELENIUM_TEST_ID']) && extension_loaded('xdebug')) {
 980     include_once __DIR__ . "/../../vendor/phpunit/phpunit-selenium/PHPUnit/Extensions/SeleniumCommon/append.php";
 981 }