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, 'boolean'));
  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(), "int"));
 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(), "double"));
 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(), "string"));
 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->addScalar(false, "boolean");
 277         } else {
 278             $rv->addScalar(true, "boolean");
 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     // create the output value
 331     $v = new Value();
 332     $agar = array();
 333
 334     $max = $sno->count();
 335     PhpXmlRpc\Server::xmlrpc_debugmsg("Found $max array elements");
 336     foreach ($sno as $rec) {
 337         if ($rec->kindOf() != "struct") {
 338             $err = "Found non-struct in array at element $i";
 339             break;
 340         }
 341         // extract name and age from struct
 342         $n = $rec->structmem("name");
 343         $a = $rec->structmem("age");
 344         // $n and $a are xmlrpcvals,
 345         // so get the scalarval from them
 346         $agar[$n->scalarval()] = $a->scalarval();
 347     }
 348
 349     $agesorter_arr = $agar;
 350     // hack, must make global as uksort() won't
 351     // allow us to pass any other auxiliary information
 352     uksort($agesorter_arr, 'agesorter_compare');
 353     $outAr = array();
 354     while (list($key, $val) = each($agesorter_arr)) {
 355         // recreate each struct element
 356         $outAr[] = new Value(array("name" => new Value($key),
 357             "age" => new Value($val, "int"),), "struct");
 358     }
 359     // add this array to the output value
 360     $v->addArray($outAr);
 361
 362     if ($err) {
 363         return new PhpXmlRpc\Response(0, PhpXmlRpc\PhpXmlRpc::$xmlrpcerruser, $err);
 364     } else {
 365         return new PhpXmlRpc\Response($v);
 366     }
 367 }
 368
 369 // signature and instructions, place these in the dispatch map
 370 $mailsend_sig = array(array(
 371     Value::$xmlrpcBoolean, Value::$xmlrpcString, Value::$xmlrpcString,
 372     Value::$xmlrpcString, Value::$xmlrpcString, Value::$xmlrpcString,
 373     Value::$xmlrpcString, Value::$xmlrpcString,
 374 ));
 375 $mailsend_doc = 'mail.send(recipient, subject, text, sender, cc, bcc, mimetype)<br/>
 376 recipient, cc, and bcc are strings, comma-separated lists of email addresses, as described above.<br/>
 377 subject is a string, the subject of the message.<br/>
 378 sender is a string, it\'s the email address of the person sending the message. This string can not be
 379 a comma-separated list, it must contain a single email address only.<br/>
 380 text is a string, it contains the body of the message.<br/>
 381 mimetype, a string, is a standard MIME type, for example, text/plain.
 382 ';
 383 // WARNING; this functionality depends on the sendmail -t option
 384 // it may not work with Windows machines properly; particularly
 385 // the Bcc option. Sneak on your friends at your own risk!
 386 function mailSend($req)
 387 {
 388     $err = "";
 389
 390     $mTo = $req->getParam(0);
 391     $mSub = $req->getParam(1);
 392     $mBody = $req->getParam(2);
 393     $mFrom = $req->getParam(3);
 394     $mCc = $req->getParam(4);
 395     $mBcc = $req->getParam(5);
 396     $mMime = $req->getParam(6);
 397
 398     if ($mTo->scalarval() == "") {
 399         $err = "Error, no 'To' field specified";
 400     }
 401
 402     if ($mFrom->scalarval() == "") {
 403         $err = "Error, no 'From' field specified";
 404     }
 405
 406     $msgHdr = "From: " . $mFrom->scalarval() . "\n";
 407     $msgHdr .= "To: " . $mTo->scalarval() . "\n";
 408
 409     if ($mCc->scalarval() != "") {
 410         $msgHdr .= "Cc: " . $mCc->scalarval() . "\n";
 411     }
 412     if ($mBcc->scalarval() != "") {
 413         $msgHdr .= "Bcc: " . $mBcc->scalarval() . "\n";
 414     }
 415     if ($mMime->scalarval() != "") {
 416         $msgHdr .= "Content-type: " . $mMime->scalarval() . "\n";
 417     }
 418     $msgHdr .= "X-Mailer: XML-RPC for PHP mailer 1.0";
 419
 420     if ($err == "") {
 421         if (!mail("",
 422             $mSub->scalarval(),
 423             $mBody->scalarval(),
 424             $msgHdr)
 425         ) {
 426             $err = "Error, could not send the mail.";
 427         }
 428     }
 429
 430     if ($err) {
 431         return new PhpXmlRpc\Response(0, PhpXmlRpc\PhpXmlRpc::$xmlrpcerruser, $err);
 432     } else {
 433         return new PhpXmlRpc\Response(new Value("true", Value::$xmlrpcBoolean));
 434     }
 435 }
 436
 437 $getallheaders_sig = array(array(Value::$xmlrpcStruct));
 438 $getallheaders_doc = 'Returns a struct containing all the HTTP headers received with the request. Provides limited functionality with IIS';
 439 function getAllHeaders_xmlrpc($req)
 440 {
 441     $encoder = new PhpXmlRpc\Encoder();
 442
 443     if (function_exists('getallheaders')) {
 444         return new PhpXmlRpc\Response($encoder->encode(getallheaders()));
 445     } else {
 446         $headers = array();
 447         // IIS: poor man's version of getallheaders
 448         foreach ($_SERVER as $key => $val) {
 449             if (strpos($key, 'HTTP_') === 0) {
 450                 $key = ucfirst(str_replace('_', '-', strtolower(substr($key, 5))));
 451                 $headers[$key] = $val;
 452             }
 453         }
 454
 455         return new PhpXmlRpc\Response($encoder->encode($headers));
 456     }
 457 }
 458
 459 $setcookies_sig = array(array(Value::$xmlrpcInt, Value::$xmlrpcStruct));
 460 $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)';
 461 function setCookies($req)
 462 {
 463     $encoder = new PhpXmlRpc\Encoder();
 464     $cookies = $req->getParam(0);
 465     foreach ($cookies as $name => $value) {
 466         $cookieDesc = $encoder->decode($value);
 467         setcookie($name, @$cookieDesc['value'], @$cookieDesc['expires'], @$cookieDesc['path'], @$cookieDesc['domain'], @$cookieDesc['secure']);
 468     }
 469
 470     return new PhpXmlRpc\Response(new Value(1, 'int'));
 471 }
 472
 473 $getcookies_sig = array(array(Value::$xmlrpcStruct));
 474 $getcookies_doc = 'Sends to client a response containing all http cookies as received in the request (as struct)';
 475 function getCookies($req)
 476 {
 477     $encoder = new PhpXmlRpc\Encoder();
 478     return new PhpXmlRpc\Response($encoder->encode($_COOKIE));
 479 }
 480
 481 $v1_arrayOfStructs_sig = array(array(Value::$xmlrpcInt, Value::$xmlrpcArray));
 482 $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.';
 483 function v1_arrayOfStructs($req)
 484 {
 485     $sno = $req->getParam(0);
 486     $numCurly = 0;
 487     foreach ($sno as $str) {
 488         foreach ($str as $key => $val) {
 489             if ($key == "curly") {
 490                 $numCurly += $val->scalarval();
 491             }
 492         }
 493     }
 494
 495     return new PhpXmlRpc\Response(new Value($numCurly, "int"));
 496 }
 497
 498 $v1_easyStruct_sig = array(array(Value::$xmlrpcInt, Value::$xmlrpcStruct));
 499 $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.';
 500 function v1_easyStruct($req)
 501 {
 502     $sno = $req->getParam(0);
 503     $moe = $sno->structmem("moe");
 504     $larry = $sno->structmem("larry");
 505     $curly = $sno->structmem("curly");
 506     $num = $moe->scalarval() + $larry->scalarval() + $curly->scalarval();
 507
 508     return new PhpXmlRpc\Response(new Value($num, "int"));
 509 }
 510
 511 $v1_echoStruct_sig = array(array(Value::$xmlrpcStruct, Value::$xmlrpcStruct));
 512 $v1_echoStruct_doc = 'This handler takes a single parameter, a struct. Your handler must return the struct.';
 513 function v1_echoStruct($req)
 514 {
 515     $sno = $req->getParam(0);
 516
 517     return new PhpXmlRpc\Response($sno);
 518 }
 519
 520 $v1_manyTypes_sig = array(array(
 521     Value::$xmlrpcArray, Value::$xmlrpcInt, Value::$xmlrpcBoolean,
 522     Value::$xmlrpcString, Value::$xmlrpcDouble, Value::$xmlrpcDateTime,
 523     Value::$xmlrpcBase64,
 524 ));
 525 $v1_manyTypes_doc = 'This handler takes six parameters, and returns an array containing all the parameters.';
 526 function v1_manyTypes($req)
 527 {
 528     return new PhpXmlRpc\Response(new Value(array(
 529         $req->getParam(0),
 530         $req->getParam(1),
 531         $req->getParam(2),
 532         $req->getParam(3),
 533         $req->getParam(4),
 534         $req->getParam(5),),
 535         "array"
 536     ));
 537 }
 538
 539 $v1_moderateSizeArrayCheck_sig = array(array(Value::$xmlrpcString, Value::$xmlrpcArray));
 540 $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.';
 541 function v1_moderateSizeArrayCheck($req)
 542 {
 543     $ar = $req->getParam(0);
 544     $sz = $ar->count();
 545     $first = $ar->arraymem(0);
 546     $last = $ar->arraymem($sz - 1);
 547
 548     return new PhpXmlRpc\Response(new Value($first->scalarval() .
 549         $last->scalarval(), "string"));
 550 }
 551
 552 $v1_simpleStructReturn_sig = array(array(Value::$xmlrpcStruct, Value::$xmlrpcInt));
 553 $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.';
 554 function v1_simpleStructReturn($req)
 555 {
 556     $sno = $req->getParam(0);
 557     $v = $sno->scalarval();
 558
 559     return new PhpXmlRpc\Response(new Value(array(
 560         "times10" => new Value($v * 10, "int"),
 561         "times100" => new Value($v * 100, "int"),
 562         "times1000" => new Value($v * 1000, "int"),),
 563         "struct"
 564     ));
 565 }
 566
 567 $v1_nestedStruct_sig = array(array(Value::$xmlrpcInt, Value::$xmlrpcStruct));
 568 $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.';
 569 function v1_nestedStruct($req)
 570 {
 571     $sno = $req->getParam(0);
 572
 573     $twoK = $sno->structmem("2000");
 574     $april = $twoK->structmem("04");
 575     $fools = $april->structmem("01");
 576     $curly = $fools->structmem("curly");
 577     $larry = $fools->structmem("larry");
 578     $moe = $fools->structmem("moe");
 579
 580     return new PhpXmlRpc\Response(new Value($curly->scalarval() + $larry->scalarval() + $moe->scalarval(), "int"));
 581 }
 582
 583 $v1_countTheEntities_sig = array(array(Value::$xmlrpcStruct, Value::$xmlrpcString));
 584 $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.';
 585 function v1_countTheEntities($req)
 586 {
 587     $sno = $req->getParam(0);
 588     $str = $sno->scalarval();
 589     $gt = 0;
 590     $lt = 0;
 591     $ap = 0;
 592     $qu = 0;
 593     $amp = 0;
 594     for ($i = 0; $i < strlen($str); $i++) {
 595         $c = substr($str, $i, 1);
 596         switch ($c) {
 597             case ">":
 598                 $gt++;
 599                 break;
 600             case "<":
 601                 $lt++;
 602                 break;
 603             case "\"":
 604                 $qu++;
 605                 break;
 606             case "'":
 607                 $ap++;
 608                 break;
 609             case "&":
 610                 $amp++;
 611                 break;
 612             default:
 613                 break;
 614         }
 615     }
 616
 617     return new PhpXmlRpc\Response(new Value(array(
 618         "ctLeftAngleBrackets" => new Value($lt, "int"),
 619         "ctRightAngleBrackets" => new Value($gt, "int"),
 620         "ctAmpersands" => new Value($amp, "int"),
 621         "ctApostrophes" => new Value($ap, "int"),
 622         "ctQuotes" => new Value($qu, "int"),),
 623         "struct"
 624     ));
 625 }
 626
 627 // trivial interop tests
 628 // http://www.xmlrpc.com/stories/storyReader$1636
 629
 630 $i_echoString_sig = array(array(Value::$xmlrpcString, Value::$xmlrpcString));
 631 $i_echoString_doc = "Echoes string.";
 632
 633 $i_echoStringArray_sig = array(array(Value::$xmlrpcArray, Value::$xmlrpcArray));
 634 $i_echoStringArray_doc = "Echoes string array.";
 635
 636 $i_echoInteger_sig = array(array(Value::$xmlrpcInt, Value::$xmlrpcInt));
 637 $i_echoInteger_doc = "Echoes integer.";
 638
 639 $i_echoIntegerArray_sig = array(array(Value::$xmlrpcArray, Value::$xmlrpcArray));
 640 $i_echoIntegerArray_doc = "Echoes integer array.";
 641
 642 $i_echoFloat_sig = array(array(Value::$xmlrpcDouble, Value::$xmlrpcDouble));
 643 $i_echoFloat_doc = "Echoes float.";
 644
 645 $i_echoFloatArray_sig = array(array(Value::$xmlrpcArray, Value::$xmlrpcArray));
 646 $i_echoFloatArray_doc = "Echoes float array.";
 647
 648 $i_echoStruct_sig = array(array(Value::$xmlrpcStruct, Value::$xmlrpcStruct));
 649 $i_echoStruct_doc = "Echoes struct.";
 650
 651 $i_echoStructArray_sig = array(array(Value::$xmlrpcArray, Value::$xmlrpcArray));
 652 $i_echoStructArray_doc = "Echoes struct array.";
 653
 654 $i_echoValue_doc = "Echoes any value back.";
 655 $i_echoValue_sig = array(array(Value::$xmlrpcValue, Value::$xmlrpcValue));
 656
 657 $i_echoBase64_sig = array(array(Value::$xmlrpcBase64, Value::$xmlrpcBase64));
 658 $i_echoBase64_doc = "Echoes base64.";
 659
 660 $i_echoDate_sig = array(array(Value::$xmlrpcDateTime, Value::$xmlrpcDateTime));
 661 $i_echoDate_doc = "Echoes dateTime.";
 662
 663 function i_echoParam($req)
 664 {
 665     $s = $req->getParam(0);
 666
 667     return new PhpXmlRpc\Response($s);
 668 }
 669
 670 function i_echoString($req)
 671 {
 672     return i_echoParam($req);
 673 }
 674
 675 function i_echoInteger($req)
 676 {
 677     return i_echoParam($req);
 678 }
 679
 680 function i_echoFloat($req)
 681 {
 682     return i_echoParam($req);
 683 }
 684
 685 function i_echoStruct($req)
 686 {
 687     return i_echoParam($req);
 688 }
 689
 690 function i_echoStringArray($req)
 691 {
 692     return i_echoParam($req);
 693 }
 694
 695 function i_echoIntegerArray($req)
 696 {
 697     return i_echoParam($req);
 698 }
 699
 700 function i_echoFloatArray($req)
 701 {
 702     return i_echoParam($req);
 703 }
 704
 705 function i_echoStructArray($req)
 706 {
 707     return i_echoParam($req);
 708 }
 709
 710 function i_echoValue($req)
 711 {
 712     return i_echoParam($req);
 713 }
 714
 715 function i_echoBase64($req)
 716 {
 717     return i_echoParam($req);
 718 }
 719
 720 function i_echoDate($req)
 721 {
 722     return i_echoParam($req);
 723 }
 724
 725 $i_whichToolkit_sig = array(array(Value::$xmlrpcStruct));
 726 $i_whichToolkit_doc = "Returns a struct containing the following strings: toolkitDocsUrl, toolkitName, toolkitVersion, toolkitOperatingSystem.";
 727
 728 function i_whichToolkit($req)
 729 {
 730     global $SERVER_SOFTWARE;
 731     $ret = array(
 732         "toolkitDocsUrl" => "http://phpxmlrpc.sourceforge.net/",
 733         "toolkitName" => PhpXmlRpc\PhpXmlRpc::$xmlrpcName,
 734         "toolkitVersion" => PhpXmlRpc\PhpXmlRpc::$xmlrpcVersion,
 735         "toolkitOperatingSystem" => isset($SERVER_SOFTWARE) ? $SERVER_SOFTWARE : $_SERVER['SERVER_SOFTWARE'],
 736     );
 737
 738     $encoder = new PhpXmlRpc\Encoder();
 739     return new PhpXmlRpc\Response($encoder->encode($ret));
 740 }
 741
 742 $object = new xmlrpcServerMethodsContainer();
 743 $signatures = array(
 744     "examples.getStateName" => array(
 745         "function" => "findState",
 746         "signature" => $findstate_sig,
 747         "docstring" => $findstate_doc,
 748     ),
 749     "examples.sortByAge" => array(
 750         "function" => "ageSorter",
 751         "signature" => $agesorter_sig,
 752         "docstring" => $agesorter_doc,
 753     ),
 754     "examples.addtwo" => array(
 755         "function" => "addTwo",
 756         "signature" => $addtwo_sig,
 757         "docstring" => $addtwo_doc,
 758     ),
 759     "examples.addtwodouble" => array(
 760         "function" => "addTwoDouble",
 761         "signature" => $addtwodouble_sig,
 762         "docstring" => $addtwodouble_doc,
 763     ),
 764     "examples.stringecho" => array(
 765         "function" => "stringEcho",
 766         "signature" => $stringecho_sig,
 767         "docstring" => $stringecho_doc,
 768     ),
 769     "examples.echo" => array(
 770         "function" => "echoBack",
 771         "signature" => $echoback_sig,
 772         "docstring" => $echoback_doc,
 773     ),
 774     "examples.decode64" => array(
 775         "function" => "echoSixtyFour",
 776         "signature" => $echosixtyfour_sig,
 777         "docstring" => $echosixtyfour_doc,
 778     ),
 779     "examples.invertBooleans" => array(
 780         "function" => "bitFlipper",
 781         "signature" => $bitflipper_sig,
 782         "docstring" => $bitflipper_doc,
 783     ),
 784     // signature omitted on purpose
 785     "tests.generatePHPWarning" => array(
 786         "function" => array($object, "phpWarningGenerator"),
 787     ),
 788     // signature omitted on purpose
 789     "tests.raiseException" => array(
 790         "function" => array($object, "exceptionGenerator"),
 791     ),
 792     // Greek word 'kosme'. NB: NOT a valid ISO8859 string!
 793     // NB: we can only register this when setting internal encoding to UTF-8, or it will break system.listMethods
 794     "tests.utf8methodname." . 'κόσμε' => array(
 795         "function" => "stringEcho",
 796         "signature" => $stringecho_sig,
 797         "docstring" => $stringecho_doc,
 798     ),
 799     /*"tests.iso88591methodname." . chr(224) . chr(252) . chr(232) => array(
 800         "function" => "stringEcho",
 801         "signature" => $stringecho_sig,
 802         "docstring" => $stringecho_doc,
 803     ),*/
 804     "examples.getallheaders" => array(
 805         "function" => 'getAllHeaders_xmlrpc',
 806         "signature" => $getallheaders_sig,
 807         "docstring" => $getallheaders_doc,
 808     ),
 809     "examples.setcookies" => array(
 810         "function" => 'setCookies',
 811         "signature" => $setcookies_sig,
 812         "docstring" => $setcookies_doc,
 813     ),
 814     "examples.getcookies" => array(
 815         "function" => 'getCookies',
 816         "signature" => $getcookies_sig,
 817         "docstring" => $getcookies_doc,
 818     ),
 819     "mail.send" => array(
 820         "function" => "mailSend",
 821         "signature" => $mailsend_sig,
 822         "docstring" => $mailsend_doc,
 823     ),
 824     "validator1.arrayOfStructsTest" => array(
 825         "function" => "v1_arrayOfStructs",
 826         "signature" => $v1_arrayOfStructs_sig,
 827         "docstring" => $v1_arrayOfStructs_doc,
 828     ),
 829     "validator1.easyStructTest" => array(
 830         "function" => "v1_easyStruct",
 831         "signature" => $v1_easyStruct_sig,
 832         "docstring" => $v1_easyStruct_doc,
 833     ),
 834     "validator1.echoStructTest" => array(
 835         "function" => "v1_echoStruct",
 836         "signature" => $v1_echoStruct_sig,
 837         "docstring" => $v1_echoStruct_doc,
 838     ),
 839     "validator1.manyTypesTest" => array(
 840         "function" => "v1_manyTypes",
 841         "signature" => $v1_manyTypes_sig,
 842         "docstring" => $v1_manyTypes_doc,
 843     ),
 844     "validator1.moderateSizeArrayCheck" => array(
 845         "function" => "v1_moderateSizeArrayCheck",
 846         "signature" => $v1_moderateSizeArrayCheck_sig,
 847         "docstring" => $v1_moderateSizeArrayCheck_doc,
 848     ),
 849     "validator1.simpleStructReturnTest" => array(
 850         "function" => "v1_simpleStructReturn",
 851         "signature" => $v1_simpleStructReturn_sig,
 852         "docstring" => $v1_simpleStructReturn_doc,
 853     ),
 854     "validator1.nestedStructTest" => array(
 855         "function" => "v1_nestedStruct",
 856         "signature" => $v1_nestedStruct_sig,
 857         "docstring" => $v1_nestedStruct_doc,
 858     ),
 859     "validator1.countTheEntities" => array(
 860         "function" => "v1_countTheEntities",
 861         "signature" => $v1_countTheEntities_sig,
 862         "docstring" => $v1_countTheEntities_doc,
 863     ),
 864     "interopEchoTests.echoString" => array(
 865         "function" => "i_echoString",
 866         "signature" => $i_echoString_sig,
 867         "docstring" => $i_echoString_doc,
 868     ),
 869     "interopEchoTests.echoStringArray" => array(
 870         "function" => "i_echoStringArray",
 871         "signature" => $i_echoStringArray_sig,
 872         "docstring" => $i_echoStringArray_doc,
 873     ),
 874     "interopEchoTests.echoInteger" => array(
 875         "function" => "i_echoInteger",
 876         "signature" => $i_echoInteger_sig,
 877         "docstring" => $i_echoInteger_doc,
 878     ),
 879     "interopEchoTests.echoIntegerArray" => array(
 880         "function" => "i_echoIntegerArray",
 881         "signature" => $i_echoIntegerArray_sig,
 882         "docstring" => $i_echoIntegerArray_doc,
 883     ),
 884     "interopEchoTests.echoFloat" => array(
 885         "function" => "i_echoFloat",
 886         "signature" => $i_echoFloat_sig,
 887         "docstring" => $i_echoFloat_doc,
 888     ),
 889     "interopEchoTests.echoFloatArray" => array(
 890         "function" => "i_echoFloatArray",
 891         "signature" => $i_echoFloatArray_sig,
 892         "docstring" => $i_echoFloatArray_doc,
 893     ),
 894     "interopEchoTests.echoStruct" => array(
 895         "function" => "i_echoStruct",
 896         "signature" => $i_echoStruct_sig,
 897         "docstring" => $i_echoStruct_doc,
 898     ),
 899     "interopEchoTests.echoStructArray" => array(
 900         "function" => "i_echoStructArray",
 901         "signature" => $i_echoStructArray_sig,
 902         "docstring" => $i_echoStructArray_doc,
 903     ),
 904     "interopEchoTests.echoValue" => array(
 905         "function" => "i_echoValue",
 906         "signature" => $i_echoValue_sig,
 907         "docstring" => $i_echoValue_doc,
 908     ),
 909     "interopEchoTests.echoBase64" => array(
 910         "function" => "i_echoBase64",
 911         "signature" => $i_echoBase64_sig,
 912         "docstring" => $i_echoBase64_doc,
 913     ),
 914     "interopEchoTests.echoDate" => array(
 915         "function" => "i_echoDate",
 916         "signature" => $i_echoDate_sig,
 917         "docstring" => $i_echoDate_doc,
 918     ),
 919     "interopEchoTests.whichToolkit" => array(
 920         "function" => "i_whichToolkit",
 921         "signature" => $i_whichToolkit_sig,
 922         "docstring" => $i_whichToolkit_doc,
 923     ),
 924
 925     'tests.getStateName.2' => $findstate2_sig,
 926     'tests.getStateName.3' => $findstate3_sig,
 927     'tests.getStateName.4' => $findstate4_sig,
 928     'tests.getStateName.5' => $findstate5_sig,
 929     'tests.getStateName.6' => $findstate6_sig,
 930     'tests.getStateName.7' => $findstate7_sig,
 931     'tests.getStateName.8' => $findstate8_sig,
 932     'tests.getStateName.9' => $findstate9_sig,
 933     'tests.getStateName.10' => $findstate10_sig,
 934     'tests.getStateName.11' => $findstate11_sig,
 935
 936     'tests.getStateName.12' => array(
 937         "function" => "findStateWithNulls",
 938         "signature" => $findstate12_sig,
 939         "docstring" => $findstate_doc,
 940     ),
 941
 942     'tests.returnPhpObject' => $returnObj_sig,
 943 );
 944
 945 $signatures = array_merge($signatures, $moreSignatures);
 946
 947 // enable support for the NULL extension
 948 PhpXmlRpc\PhpXmlRpc::$xmlrpc_null_extension = true;
 949
 950 $s = new PhpXmlRpc\Server($signatures, false);
 951 $s->setdebug(3);
 952 $s->compress_response = true;
 953
 954 // out-of-band information: let the client manipulate the server operations.
 955 // we do this to help the testsuite script: do not reproduce in production!
 956 if (isset($_GET['RESPONSE_ENCODING'])) {
 957     $s->response_charset_encoding = $_GET['RESPONSE_ENCODING'];
 958 }
 959 if (isset($_GET['EXCEPTION_HANDLING'])) {
 960     $s->exception_handling = $_GET['EXCEPTION_HANDLING'];
 961 }
 962 $s->service();
 963 // that should do all we need!
 964
 965 // out-of-band information: let the client manipulate the server operations.
 966 // we do this to help the testsuite script: do not reproduce in production!
 967 if (isset($_COOKIE['PHPUNIT_SELENIUM_TEST_ID']) && extension_loaded('xdebug')) {
 968     include_once __DIR__ . "/../../vendor/phpunit/phpunit-selenium/PHPUnit/Extensions/SeleniumCommon/append.php";
 969 }