/usr/share/php/XML/RPC/Server.php is in php-xml-rpc 1.5.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 | <?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Server commands for our PHP implementation of the XML-RPC protocol
*
* This is a PEAR-ified version of Useful inc's XML-RPC for PHP.
* It has support for HTTP transport, proxies and authentication.
*
* PHP versions 4 and 5
*
* @category Web Services
* @package XML_RPC
* @author Edd Dumbill <edd@usefulinc.com>
* @author Stig Bakken <stig@php.net>
* @author Martin Jansen <mj@php.net>
* @author Daniel Convissor <danielc@php.net>
* @copyright 1999-2001 Edd Dumbill, 2001-2010 The PHP Group
* @license http://www.php.net/license/3_01.txt PHP License
* @version SVN: $Id: Server.php 293224 2010-01-07 15:36:40Z danielc $
* @link http://pear.php.net/package/XML_RPC
*/
/**
* Pull in the XML_RPC class
*/
require_once 'XML/RPC.php';
/**
* signature for system.listMethods: return = array,
* parameters = a string or nothing
* @global array $GLOBALS['XML_RPC_Server_listMethods_sig']
*/
$GLOBALS['XML_RPC_Server_listMethods_sig'] = array(
array($GLOBALS['XML_RPC_Array'],
$GLOBALS['XML_RPC_String']
),
array($GLOBALS['XML_RPC_Array'])
);
/**
* docstring for system.listMethods
* @global string $GLOBALS['XML_RPC_Server_listMethods_doc']
*/
$GLOBALS['XML_RPC_Server_listMethods_doc'] = 'This method lists all the'
. ' methods that the XML-RPC server knows how to dispatch';
/**
* signature for system.methodSignature: return = array,
* parameters = string
* @global array $GLOBALS['XML_RPC_Server_methodSignature_sig']
*/
$GLOBALS['XML_RPC_Server_methodSignature_sig'] = array(
array($GLOBALS['XML_RPC_Array'],
$GLOBALS['XML_RPC_String']
)
);
/**
* docstring for system.methodSignature
* @global string $GLOBALS['XML_RPC_Server_methodSignature_doc']
*/
$GLOBALS['XML_RPC_Server_methodSignature_doc'] = 'Returns an array of known'
. ' signatures (an array of arrays) for the method name passed. If'
. ' no signatures are known, returns a none-array (test for type !='
. ' array to detect missing signature)';
/**
* signature for system.methodHelp: return = string,
* parameters = string
* @global array $GLOBALS['XML_RPC_Server_methodHelp_sig']
*/
$GLOBALS['XML_RPC_Server_methodHelp_sig'] = array(
array($GLOBALS['XML_RPC_String'],
$GLOBALS['XML_RPC_String']
)
);
/**
* docstring for methodHelp
* @global string $GLOBALS['XML_RPC_Server_methodHelp_doc']
*/
$GLOBALS['XML_RPC_Server_methodHelp_doc'] = 'Returns help text if defined'
. ' for the method passed, otherwise returns an empty string';
/**
* dispatch map for the automatically declared XML-RPC methods.
* @global array $GLOBALS['XML_RPC_Server_dmap']
*/
$GLOBALS['XML_RPC_Server_dmap'] = array(
'system.listMethods' => array(
'function' => 'XML_RPC_Server_listMethods',
'signature' => $GLOBALS['XML_RPC_Server_listMethods_sig'],
'docstring' => $GLOBALS['XML_RPC_Server_listMethods_doc']
),
'system.methodHelp' => array(
'function' => 'XML_RPC_Server_methodHelp',
'signature' => $GLOBALS['XML_RPC_Server_methodHelp_sig'],
'docstring' => $GLOBALS['XML_RPC_Server_methodHelp_doc']
),
'system.methodSignature' => array(
'function' => 'XML_RPC_Server_methodSignature',
'signature' => $GLOBALS['XML_RPC_Server_methodSignature_sig'],
'docstring' => $GLOBALS['XML_RPC_Server_methodSignature_doc']
)
);
/**
* @global string $GLOBALS['XML_RPC_Server_debuginfo']
*/
$GLOBALS['XML_RPC_Server_debuginfo'] = '';
/**
* Lists all the methods that the XML-RPC server knows how to dispatch
*
* @return object a new XML_RPC_Response object
*/
function XML_RPC_Server_listMethods($server, $m)
{
global $XML_RPC_err, $XML_RPC_str, $XML_RPC_Server_dmap;
$v = new XML_RPC_Value();
$outAr = array();
foreach ($server->dmap as $key => $val) {
$outAr[] = new XML_RPC_Value($key, 'string');
}
foreach ($XML_RPC_Server_dmap as $key => $val) {
$outAr[] = new XML_RPC_Value($key, 'string');
}
$v->addArray($outAr);
return new XML_RPC_Response($v);
}
/**
* Returns an array of known signatures (an array of arrays)
* for the given method
*
* If no signatures are known, returns a none-array
* (test for type != array to detect missing signature)
*
* @return object a new XML_RPC_Response object
*/
function XML_RPC_Server_methodSignature($server, $m)
{
global $XML_RPC_err, $XML_RPC_str, $XML_RPC_Server_dmap;
$methName = $m->getParam(0);
$methName = $methName->scalarval();
if (strpos($methName, 'system.') === 0) {
$dmap = $XML_RPC_Server_dmap;
$sysCall = 1;
} else {
$dmap = $server->dmap;
$sysCall = 0;
}
// print "<!-- ${methName} -->\n";
if (isset($dmap[$methName])) {
if ($dmap[$methName]['signature']) {
$sigs = array();
$thesigs = $dmap[$methName]['signature'];
for ($i = 0; $i < sizeof($thesigs); $i++) {
$cursig = array();
$inSig = $thesigs[$i];
for ($j = 0; $j < sizeof($inSig); $j++) {
$cursig[] = new XML_RPC_Value($inSig[$j], 'string');
}
$sigs[] = new XML_RPC_Value($cursig, 'array');
}
$r = new XML_RPC_Response(new XML_RPC_Value($sigs, 'array'));
} else {
$r = new XML_RPC_Response(new XML_RPC_Value('undef', 'string'));
}
} else {
$r = new XML_RPC_Response(0, $XML_RPC_err['introspect_unknown'],
$XML_RPC_str['introspect_unknown']);
}
return $r;
}
/**
* Returns help text if defined for the method passed, otherwise returns
* an empty string
*
* @return object a new XML_RPC_Response object
*/
function XML_RPC_Server_methodHelp($server, $m)
{
global $XML_RPC_err, $XML_RPC_str, $XML_RPC_Server_dmap;
$methName = $m->getParam(0);
$methName = $methName->scalarval();
if (strpos($methName, 'system.') === 0) {
$dmap = $XML_RPC_Server_dmap;
$sysCall = 1;
} else {
$dmap = $server->dmap;
$sysCall = 0;
}
if (isset($dmap[$methName])) {
if ($dmap[$methName]['docstring']) {
$r = new XML_RPC_Response(new XML_RPC_Value($dmap[$methName]['docstring']),
'string');
} else {
$r = new XML_RPC_Response(new XML_RPC_Value('', 'string'));
}
} else {
$r = new XML_RPC_Response(0, $XML_RPC_err['introspect_unknown'],
$XML_RPC_str['introspect_unknown']);
}
return $r;
}
/**
* @return void
*/
function XML_RPC_Server_debugmsg($m)
{
global $XML_RPC_Server_debuginfo;
$XML_RPC_Server_debuginfo = $XML_RPC_Server_debuginfo . $m . "\n";
}
/**
* A server for receiving and replying to XML RPC requests
*
* <code>
* $server = new XML_RPC_Server(
* array(
* 'isan8' =>
* array(
* 'function' => 'is_8',
* 'signature' =>
* array(
* array('boolean', 'int'),
* array('boolean', 'int', 'boolean'),
* array('boolean', 'string'),
* array('boolean', 'string', 'boolean'),
* ),
* 'docstring' => 'Is the value an 8?'
* ),
* ),
* 1,
* 0
* );
* </code>
*
* @category Web Services
* @package XML_RPC
* @author Edd Dumbill <edd@usefulinc.com>
* @author Stig Bakken <stig@php.net>
* @author Martin Jansen <mj@php.net>
* @author Daniel Convissor <danielc@php.net>
* @copyright 1999-2001 Edd Dumbill, 2001-2010 The PHP Group
* @license http://www.php.net/license/3_01.txt PHP License
* @version Release: 1.5.3
* @link http://pear.php.net/package/XML_RPC
*/
class XML_RPC_Server
{
/**
* Should the payload's content be passed through mb_convert_encoding()?
*
* @see XML_RPC_Server::setConvertPayloadEncoding()
* @since Property available since Release 1.5.1
* @var boolean
*/
var $convert_payload_encoding = false;
/**
* The dispatch map, listing the methods this server provides.
* @var array
*/
var $dmap = array();
/**
* The present response's encoding
* @var string
* @see XML_RPC_Message::getEncoding()
*/
var $encoding = '';
/**
* Debug mode (0 = off, 1 = on)
* @var integer
*/
var $debug = 0;
/**
* The response's HTTP headers
* @var string
*/
var $server_headers = '';
/**
* The response's XML payload
* @var string
*/
var $server_payload = '';
/**
* Constructor for the XML_RPC_Server class
*
* @param array $dispMap the dispatch map. An associative array
* explaining each function. The keys of the main
* array are the procedure names used by the
* clients. The value is another associative array
* that contains up to three elements:
* + The 'function' element's value is the name
* of the function or method that gets called.
* To define a class' method: 'class::method'.
* + The 'signature' element (optional) is an
* array describing the return values and
* parameters
* + The 'docstring' element (optional) is a
* string describing what the method does
* @param int $serviceNow should the HTTP response be sent now?
* (1 = yes, 0 = no)
* @param int $debug should debug output be displayed?
* (1 = yes, 0 = no)
*
* @return void
*/
function XML_RPC_Server($dispMap, $serviceNow = 1, $debug = 0)
{
global $HTTP_RAW_POST_DATA;
if ($debug) {
$this->debug = 1;
} else {
$this->debug = 0;
}
$this->dmap = $dispMap;
if ($serviceNow) {
$this->service();
} else {
$this->createServerPayload();
$this->createServerHeaders();
}
}
/**
* @return string the debug information if debug debug mode is on
*/
function serializeDebug()
{
global $XML_RPC_Server_debuginfo, $HTTP_RAW_POST_DATA;
if ($this->debug) {
XML_RPC_Server_debugmsg('vvv POST DATA RECEIVED BY SERVER vvv' . "\n"
. $HTTP_RAW_POST_DATA
. "\n" . '^^^ END POST DATA ^^^');
}
if ($XML_RPC_Server_debuginfo != '') {
return "<!-- PEAR XML_RPC SERVER DEBUG INFO:\n\n"
. $GLOBALS['XML_RPC_func_ereg_replace']('--', '- - ', $XML_RPC_Server_debuginfo)
. "-->\n";
} else {
return '';
}
}
/**
* Sets whether the payload's content gets passed through
* mb_convert_encoding()
*
* Returns PEAR_ERROR object if mb_convert_encoding() isn't available.
*
* @param int $in where 1 = on, 0 = off
*
* @return void
*
* @see XML_RPC_Message::getEncoding()
* @since Method available since Release 1.5.1
*/
function setConvertPayloadEncoding($in)
{
if ($in && !function_exists('mb_convert_encoding')) {
return $this->raiseError('mb_convert_encoding() is not available',
XML_RPC_ERROR_PROGRAMMING);
}
$this->convert_payload_encoding = $in;
}
/**
* Sends the response
*
* The encoding and content-type are determined by
* XML_RPC_Message::getEncoding()
*
* @return void
*
* @uses XML_RPC_Server::createServerPayload(),
* XML_RPC_Server::createServerHeaders()
*/
function service()
{
if (!$this->server_payload) {
$this->createServerPayload();
}
if (!$this->server_headers) {
$this->createServerHeaders();
}
/*
* $server_headers needs to remain a string for compatibility with
* old scripts using this package, but PHP 4.4.2 no longer allows
* line breaks in header() calls. So, we split each header into
* an individual call. The initial replace handles the off chance
* that someone composed a single header with multiple lines, which
* the RFCs allow.
*/
$this->server_headers = $GLOBALS['XML_RPC_func_ereg_replace']("[\r\n]+[ \t]+",
' ', trim($this->server_headers));
$headers = $GLOBALS['XML_RPC_func_split']("[\r\n]+", $this->server_headers);
foreach ($headers as $header)
{
header($header);
}
print $this->server_payload;
}
/**
* Generates the payload and puts it in the $server_payload property
*
* If XML_RPC_Server::setConvertPayloadEncoding() was set to true,
* the payload gets passed through mb_convert_encoding()
* to ensure the payload matches the encoding set in the
* XML declaration. The encoding type can be manually set via
* XML_RPC_Message::setSendEncoding().
*
* @return void
*
* @uses XML_RPC_Server::parseRequest(), XML_RPC_Server::$encoding,
* XML_RPC_Response::serialize(), XML_RPC_Server::serializeDebug()
* @see XML_RPC_Server::setConvertPayloadEncoding()
*/
function createServerPayload()
{
$r = $this->parseRequest();
$this->server_payload = '<?xml version="1.0" encoding="'
. $this->encoding . '"?>' . "\n"
. $this->serializeDebug()
. $r->serialize();
if ($this->convert_payload_encoding) {
$this->server_payload = mb_convert_encoding($this->server_payload,
$this->encoding);
}
}
/**
* Determines the HTTP headers and puts them in the $server_headers
* property
*
* @return boolean TRUE if okay, FALSE if $server_payload isn't set.
*
* @uses XML_RPC_Server::createServerPayload(),
* XML_RPC_Server::$server_headers
*/
function createServerHeaders()
{
if (!$this->server_payload) {
return false;
}
$this->server_headers = 'Content-Length: '
. strlen($this->server_payload) . "\r\n"
. 'Content-Type: text/xml;'
. ' charset=' . $this->encoding;
return true;
}
/**
* @return array
*/
function verifySignature($in, $sig)
{
for ($i = 0; $i < sizeof($sig); $i++) {
// check each possible signature in turn
$cursig = $sig[$i];
if (sizeof($cursig) == $in->getNumParams() + 1) {
$itsOK = 1;
for ($n = 0; $n < $in->getNumParams(); $n++) {
$p = $in->getParam($n);
// print "<!-- $p -->\n";
if ($p->kindOf() == 'scalar') {
$pt = $p->scalartyp();
} else {
$pt = $p->kindOf();
}
// $n+1 as first type of sig is return type
if ($pt != $cursig[$n+1]) {
$itsOK = 0;
$pno = $n+1;
$wanted = $cursig[$n+1];
$got = $pt;
break;
}
}
if ($itsOK) {
return array(1);
}
}
}
if (isset($wanted)) {
return array(0, "Wanted ${wanted}, got ${got} at param ${pno}");
} else {
$allowed = array();
foreach ($sig as $val) {
end($val);
$allowed[] = key($val);
}
$allowed = array_unique($allowed);
$last = count($allowed) - 1;
if ($last > 0) {
$allowed[$last] = 'or ' . $allowed[$last];
}
return array(0,
'Signature permits ' . implode(', ', $allowed)
. ' parameters but the request had '
. $in->getNumParams());
}
}
/**
* @return object a new XML_RPC_Response object
*
* @uses XML_RPC_Message::getEncoding(), XML_RPC_Server::$encoding
*/
function parseRequest($data = '')
{
global $XML_RPC_xh, $HTTP_RAW_POST_DATA,
$XML_RPC_err, $XML_RPC_str, $XML_RPC_errxml,
$XML_RPC_defencoding, $XML_RPC_Server_dmap;
if ($data == '') {
$data = $HTTP_RAW_POST_DATA;
}
$this->encoding = XML_RPC_Message::getEncoding($data);
$parser_resource = xml_parser_create($this->encoding);
$parser = (int) $parser_resource;
$XML_RPC_xh[$parser] = array();
$XML_RPC_xh[$parser]['cm'] = 0;
$XML_RPC_xh[$parser]['isf'] = 0;
$XML_RPC_xh[$parser]['params'] = array();
$XML_RPC_xh[$parser]['method'] = '';
$XML_RPC_xh[$parser]['stack'] = array();
$XML_RPC_xh[$parser]['valuestack'] = array();
$plist = '';
// decompose incoming XML into request structure
xml_parser_set_option($parser_resource, XML_OPTION_CASE_FOLDING, true);
xml_set_element_handler($parser_resource, 'XML_RPC_se', 'XML_RPC_ee');
xml_set_character_data_handler($parser_resource, 'XML_RPC_cd');
if (!xml_parse($parser_resource, $data, 1)) {
// return XML error as a faultCode
$r = new XML_RPC_Response(0,
$XML_RPC_errxml+xml_get_error_code($parser_resource),
sprintf('XML error: %s at line %d',
xml_error_string(xml_get_error_code($parser_resource)),
xml_get_current_line_number($parser_resource)));
xml_parser_free($parser_resource);
} elseif ($XML_RPC_xh[$parser]['isf']>1) {
$r = new XML_RPC_Response(0,
$XML_RPC_err['invalid_request'],
$XML_RPC_str['invalid_request']
. ': '
. $XML_RPC_xh[$parser]['isf_reason']);
xml_parser_free($parser_resource);
} else {
xml_parser_free($parser_resource);
$m = new XML_RPC_Message($XML_RPC_xh[$parser]['method']);
// now add parameters in
for ($i = 0; $i < sizeof($XML_RPC_xh[$parser]['params']); $i++) {
// print '<!-- ' . $XML_RPC_xh[$parser]['params'][$i]. "-->\n";
$plist .= "$i - " . var_export($XML_RPC_xh[$parser]['params'][$i], true) . " \n";
$m->addParam($XML_RPC_xh[$parser]['params'][$i]);
}
if ($this->debug) {
XML_RPC_Server_debugmsg($plist);
}
// now to deal with the method
$methName = $XML_RPC_xh[$parser]['method'];
if (strpos($methName, 'system.') === 0) {
$dmap = $XML_RPC_Server_dmap;
$sysCall = 1;
} else {
$dmap = $this->dmap;
$sysCall = 0;
}
if (isset($dmap[$methName]['function'])
&& is_string($dmap[$methName]['function'])
&& strpos($dmap[$methName]['function'], '::') !== false)
{
$dmap[$methName]['function'] =
explode('::', $dmap[$methName]['function']);
}
if (isset($dmap[$methName]['function'])
&& is_callable($dmap[$methName]['function']))
{
// dispatch if exists
if (isset($dmap[$methName]['signature'])) {
$sr = $this->verifySignature($m,
$dmap[$methName]['signature'] );
}
if (!isset($dmap[$methName]['signature']) || $sr[0]) {
// if no signature or correct signature
if ($sysCall) {
$r = call_user_func($dmap[$methName]['function'], $this, $m);
} else {
$r = call_user_func($dmap[$methName]['function'], $m);
}
if (!is_a($r, 'XML_RPC_Response')) {
$r = new XML_RPC_Response(0, $XML_RPC_err['not_response_object'],
$XML_RPC_str['not_response_object']);
}
} else {
$r = new XML_RPC_Response(0, $XML_RPC_err['incorrect_params'],
$XML_RPC_str['incorrect_params']
. ': ' . $sr[1]);
}
} else {
// else prepare error response
$r = new XML_RPC_Response(0, $XML_RPC_err['unknown_method'],
$XML_RPC_str['unknown_method']);
}
}
return $r;
}
/**
* Echos back the input packet as a string value
*
* @return void
*
* Useful for debugging.
*/
function echoInput()
{
global $HTTP_RAW_POST_DATA;
$r = new XML_RPC_Response(0);
$r->xv = new XML_RPC_Value("'Aha said I: '" . $HTTP_RAW_POST_DATA, 'string');
print $r->serialize();
}
}
/*
* Local variables:
* tab-width: 4
* c-basic-offset: 4
* c-hanging-comment-ender-p: nil
* End:
*/
?>
|