diff --git includes/common.inc includes/common.inc index 62a5037..517f8a9 100644 --- includes/common.inc +++ includes/common.inc @@ -7603,39 +7603,6 @@ function entity_form_submit_build_entity($entity_type, $entity, $form, &$form_st } /** - * Performs one or more XML-RPC request(s). - * - * Usage example: - * @code - * $result = xmlrpc('http://example.com/xmlrpc.php', array( - * 'service.methodName' => array($parameter, $second, $third), - * )); - * @endcode - * - * @param $url - * An absolute URL of the XML-RPC endpoint. - * @param $args - * An associative array whose keys are the methods to call and whose values - * are the arguments to pass to the respective method. If multiple methods - * are specified, a system.multicall is performed. - * @param $options - * (optional) An array of options to pass along to drupal_http_request(). - * - * @return - * For one request: - * Either the return value of the method on success, or FALSE. - * If FALSE is returned, see xmlrpc_errno() and xmlrpc_error_msg(). - * For multiple requests: - * An array of results. Each result will either be the result - * returned by the method called, or an xmlrpc_error object if the call - * failed. See xmlrpc_error(). - */ -function xmlrpc($url, $args, $options = array()) { - require_once DRUPAL_ROOT . '/includes/xmlrpc.inc'; - return _xmlrpc($url, $args, $options); -} - -/** * Retrieves a list of all available archivers. * * @see hook_archiver_info() diff --git includes/xmlrpc.inc includes/xmlrpc.inc deleted file mode 100644 index 40b0d9d..0000000 --- includes/xmlrpc.inc +++ /dev/null @@ -1,626 +0,0 @@ -data = $data; - if (!$type) { - $type = xmlrpc_value_calculate_type($xmlrpc_value); - } - $xmlrpc_value->type = $type; - if ($type == 'struct') { - // Turn all the values in the array into new xmlrpc_values - foreach ($xmlrpc_value->data as $key => $value) { - $xmlrpc_value->data[$key] = xmlrpc_value($value); - } - } - if ($type == 'array') { - for ($i = 0, $j = count($xmlrpc_value->data); $i < $j; $i++) { - $xmlrpc_value->data[$i] = xmlrpc_value($xmlrpc_value->data[$i]); - } - } - return $xmlrpc_value; -} - -/** - * Maps a PHP type to an XML-RPC type. - * - * @param $xmlrpc_value - * Variable whose type should be mapped. - * - * @return string - * The corresponding XML-RPC type. - * - * @see http://www.xmlrpc.com/spec#scalars - */ -function xmlrpc_value_calculate_type($xmlrpc_value) { - // http://www.php.net/gettype: Never use gettype() to test for a certain type - // [...] Instead, use the is_* functions. - if (is_bool($xmlrpc_value->data)) { - return 'boolean'; - } - if (is_double($xmlrpc_value->data)) { - return 'double'; - } - if (is_int($xmlrpc_value->data)) { - return 'int'; - } - if (is_array($xmlrpc_value->data)) { - // empty or integer-indexed arrays are 'array', string-indexed arrays 'struct' - return empty($xmlrpc_value->data) || range(0, count($xmlrpc_value->data) - 1) === array_keys($xmlrpc_value->data) ? 'array' : 'struct'; - } - if (is_object($xmlrpc_value->data)) { - if (isset($xmlrpc_value->data->is_date)) { - return 'date'; - } - if (isset($xmlrpc_value->data->is_base64)) { - return 'base64'; - } - $xmlrpc_value->data = get_object_vars($xmlrpc_value->data); - return 'struct'; - } - // default - return 'string'; -} - -/** - * Generates XML representing the given value. - * - * @param $xmlrpc_value - * A value to be represented in XML. - * - * @return - * XML representation of $xmlrpc_value. - */ -function xmlrpc_value_get_xml($xmlrpc_value) { - switch ($xmlrpc_value->type) { - case 'boolean': - return '' . (($xmlrpc_value->data) ? '1' : '0') . ''; - - case 'int': - return '' . $xmlrpc_value->data . ''; - - case 'double': - return '' . $xmlrpc_value->data . ''; - - case 'string': - // Note: we don't escape apostrophes because of the many blogging clients - // that don't support numerical entities (and XML in general) properly. - return '' . htmlspecialchars($xmlrpc_value->data) . ''; - - case 'array': - $return = '' . "\n"; - foreach ($xmlrpc_value->data as $item) { - $return .= ' ' . xmlrpc_value_get_xml($item) . "\n"; - } - $return .= ''; - return $return; - - case 'struct': - $return = '' . "\n"; - foreach ($xmlrpc_value->data as $name => $value) { - $return .= " " . check_plain($name) . ""; - $return .= xmlrpc_value_get_xml($value) . "\n"; - } - $return .= ''; - return $return; - - case 'date': - return xmlrpc_date_get_xml($xmlrpc_value->data); - - case 'base64': - return xmlrpc_base64_get_xml($xmlrpc_value->data); - } - return FALSE; -} - -/** - * Constructs an object representing an XML-RPC message. - * - * @param $message - * A string containing an XML message. - * - * @return object - * An XML-RPC object containing the message. - * - * @see http://www.xmlrpc.com/spec - */ -function xmlrpc_message($message) { - $xmlrpc_message = new stdClass(); - // The stack used to keep track of the current array/struct - $xmlrpc_message->array_structs = array(); - // The stack used to keep track of if things are structs or array - $xmlrpc_message->array_structs_types = array(); - // A stack as well - $xmlrpc_message->current_struct_name = array(); - $xmlrpc_message->message = $message; - return $xmlrpc_message; -} - -/** - * Parses an XML-RPC message. - * - * If parsing fails, the faultCode and faultString will be added to the message - * object. - * - * @param $xmlrpc_message - * An object generated by xmlrpc_message(). - * - * @return - * TRUE if parsing succeeded; FALSE otherwise. - */ -function xmlrpc_message_parse($xmlrpc_message) { - $xmlrpc_message->_parser = xml_parser_create(); - // Set XML parser to take the case of tags into account. - xml_parser_set_option($xmlrpc_message->_parser, XML_OPTION_CASE_FOLDING, FALSE); - // Set XML parser callback functions - xml_set_element_handler($xmlrpc_message->_parser, 'xmlrpc_message_tag_open', 'xmlrpc_message_tag_close'); - xml_set_character_data_handler($xmlrpc_message->_parser, 'xmlrpc_message_cdata'); - xmlrpc_message_set($xmlrpc_message); - if (!xml_parse($xmlrpc_message->_parser, $xmlrpc_message->message)) { - return FALSE; - } - xml_parser_free($xmlrpc_message->_parser); - - // Grab the error messages, if any. - $xmlrpc_message = xmlrpc_message_get(); - if (!isset($xmlrpc_message->messagetype)) { - return FALSE; - } - elseif ($xmlrpc_message->messagetype == 'fault') { - $xmlrpc_message->fault_code = $xmlrpc_message->params[0]['faultCode']; - $xmlrpc_message->fault_string = $xmlrpc_message->params[0]['faultString']; - } - return TRUE; -} - -/** - * Stores a copy of the most recent XML-RPC message object temporarily. - * - * @param $value - * An XML-RPC message to store, or NULL to keep the last message. - * - * @return object - * The most recently stored message. - * - * @see xmlrpc_message_get() - */ -function xmlrpc_message_set($value = NULL) { - static $xmlrpc_message; - if ($value) { - $xmlrpc_message = $value; - } - return $xmlrpc_message; -} - -/** - * Returns the most recently stored XML-RPC message object. - * - * @return object - * The most recently stored message. - * - * @see xmlrpc_message_set() - */ -function xmlrpc_message_get() { - return xmlrpc_message_set(); -} - -/** - * Handles opening tags for XML parsing in xmlrpc_message_parse(). - */ -function xmlrpc_message_tag_open($parser, $tag, $attr) { - $xmlrpc_message = xmlrpc_message_get(); - $xmlrpc_message->current_tag_contents = ''; - $xmlrpc_message->last_open = $tag; - switch ($tag) { - case 'methodCall': - case 'methodResponse': - case 'fault': - $xmlrpc_message->messagetype = $tag; - break; - - // Deal with stacks of arrays and structs - case 'data': - $xmlrpc_message->array_structs_types[] = 'array'; - $xmlrpc_message->array_structs[] = array(); - break; - - case 'struct': - $xmlrpc_message->array_structs_types[] = 'struct'; - $xmlrpc_message->array_structs[] = array(); - break; - } - xmlrpc_message_set($xmlrpc_message); -} - -/** - * Handles character data for XML parsing in xmlrpc_message_parse(). - */ -function xmlrpc_message_cdata($parser, $cdata) { - $xmlrpc_message = xmlrpc_message_get(); - $xmlrpc_message->current_tag_contents .= $cdata; - xmlrpc_message_set($xmlrpc_message); -} - -/** - * Handles closing tags for XML parsing in xmlrpc_message_parse(). - */ -function xmlrpc_message_tag_close($parser, $tag) { - $xmlrpc_message = xmlrpc_message_get(); - $value_flag = FALSE; - switch ($tag) { - case 'int': - case 'i4': - $value = (int)trim($xmlrpc_message->current_tag_contents); - $value_flag = TRUE; - break; - - case 'double': - $value = (double)trim($xmlrpc_message->current_tag_contents); - $value_flag = TRUE; - break; - - case 'string': - $value = $xmlrpc_message->current_tag_contents; - $value_flag = TRUE; - break; - - case 'dateTime.iso8601': - $value = xmlrpc_date(trim($xmlrpc_message->current_tag_contents)); - // $value = $iso->getTimestamp(); - $value_flag = TRUE; - break; - - case 'value': - // If no type is indicated, the type is string - // We take special care for empty values - if (trim($xmlrpc_message->current_tag_contents) != '' || (isset($xmlrpc_message->last_open) && ($xmlrpc_message->last_open == 'value'))) { - $value = (string) $xmlrpc_message->current_tag_contents; - $value_flag = TRUE; - } - unset($xmlrpc_message->last_open); - break; - - case 'boolean': - $value = (boolean)trim($xmlrpc_message->current_tag_contents); - $value_flag = TRUE; - break; - - case 'base64': - $value = base64_decode(trim($xmlrpc_message->current_tag_contents)); - $value_flag = TRUE; - break; - - // Deal with stacks of arrays and structs - case 'data': - case 'struct': - $value = array_pop($xmlrpc_message->array_structs); - array_pop($xmlrpc_message->array_structs_types); - $value_flag = TRUE; - break; - - case 'member': - array_pop($xmlrpc_message->current_struct_name); - break; - - case 'name': - $xmlrpc_message->current_struct_name[] = trim($xmlrpc_message->current_tag_contents); - break; - - case 'methodName': - $xmlrpc_message->methodname = trim($xmlrpc_message->current_tag_contents); - break; - } - if ($value_flag) { - if (count($xmlrpc_message->array_structs) > 0) { - // Add value to struct or array - if ($xmlrpc_message->array_structs_types[count($xmlrpc_message->array_structs_types) - 1] == 'struct') { - // Add to struct - $xmlrpc_message->array_structs[count($xmlrpc_message->array_structs) - 1][$xmlrpc_message->current_struct_name[count($xmlrpc_message->current_struct_name) - 1]] = $value; - } - else { - // Add to array - $xmlrpc_message->array_structs[count($xmlrpc_message->array_structs) - 1][] = $value; - } - } - else { - // Just add as a parameter - $xmlrpc_message->params[] = $value; - } - } - if (!in_array($tag, array("data", "struct", "member"))) { - $xmlrpc_message->current_tag_contents = ''; - } - xmlrpc_message_set($xmlrpc_message); -} - -/** - * Constructs an object representing an XML-RPC request. - * - * @param $method - * The name of the method to be called. - * @param $args - * An array of parameters to send with the method. - * - * @return object - * An XML-RPC object representing the request. - */ -function xmlrpc_request($method, $args) { - $xmlrpc_request = new stdClass(); - $xmlrpc_request->method = $method; - $xmlrpc_request->args = $args; - $xmlrpc_request->xml = << - -{$xmlrpc_request->method} - - -EOD; - foreach ($xmlrpc_request->args as $arg) { - $xmlrpc_request->xml .= ''; - $v = xmlrpc_value($arg); - $xmlrpc_request->xml .= xmlrpc_value_get_xml($v); - $xmlrpc_request->xml .= "\n"; - } - $xmlrpc_request->xml .= ''; - return $xmlrpc_request; -} - -/** - * Generates, temporarily saves, and returns an XML-RPC error object. - * - * @param $code - * The error code. - * @param $message - * The error message. - * @param $reset - * TRUE to empty the temporary error storage. Ignored if $code is supplied. - * - * @return object - * An XML-RPC error object representing $code and $message, or the most - * recently stored error object if omitted. - */ -function xmlrpc_error($code = NULL, $message = NULL, $reset = FALSE) { - static $xmlrpc_error; - if (isset($code)) { - $xmlrpc_error = new stdClass(); - $xmlrpc_error->is_error = TRUE; - $xmlrpc_error->code = $code; - $xmlrpc_error->message = $message; - } - elseif ($reset) { - $xmlrpc_error = NULL; - } - return $xmlrpc_error; -} - -/** - * Converts an XML-RPC error object into XML. - * - * @param $xmlrpc_error - * The XML-RPC error object. - * - * @return string - * An XML representation of the error as an XML methodResponse. - */ -function xmlrpc_error_get_xml($xmlrpc_error) { - return << - - - - - faultCode - {$xmlrpc_error->code} - - - faultString - {$xmlrpc_error->message} - - - - - - -EOD; -} - -/** - * Converts a PHP or ISO date/time to an XML-RPC object. - * - * @param $time - * A PHP timestamp or an ISO date-time string. - * - * @return object - * An XML-RPC time/date object. - */ -function xmlrpc_date($time) { - $xmlrpc_date = new stdClass(); - $xmlrpc_date->is_date = TRUE; - // $time can be a PHP timestamp or an ISO one - if (is_numeric($time)) { - $xmlrpc_date->year = gmdate('Y', $time); - $xmlrpc_date->month = gmdate('m', $time); - $xmlrpc_date->day = gmdate('d', $time); - $xmlrpc_date->hour = gmdate('H', $time); - $xmlrpc_date->minute = gmdate('i', $time); - $xmlrpc_date->second = gmdate('s', $time); - $xmlrpc_date->iso8601 = gmdate('Ymd\TH:i:s', $time); - } - else { - $xmlrpc_date->iso8601 = $time; - $time = str_replace(array('-', ':'), '', $time); - $xmlrpc_date->year = substr($time, 0, 4); - $xmlrpc_date->month = substr($time, 4, 2); - $xmlrpc_date->day = substr($time, 6, 2); - $xmlrpc_date->hour = substr($time, 9, 2); - $xmlrpc_date->minute = substr($time, 11, 2); - $xmlrpc_date->second = substr($time, 13, 2); - } - return $xmlrpc_date; -} - -/** - * Converts an XML-RPC date-time object into XML. - * - * @param $xmlrpc_date - * The XML-RPC date-time object. - * - * @return string - * An XML representation of the date/time as XML. - */ -function xmlrpc_date_get_xml($xmlrpc_date) { - return '' . $xmlrpc_date->year . $xmlrpc_date->month . $xmlrpc_date->day . 'T' . $xmlrpc_date->hour . ':' . $xmlrpc_date->minute . ':' . $xmlrpc_date->second . ''; -} - -/** - * Returns an XML-RPC base 64 object. - * - * @param $data - * Base 64 data to store in returned object. - * - * @return object - * An XML-RPC base 64 object. - */ -function xmlrpc_base64($data) { - $xmlrpc_base64 = new stdClass(); - $xmlrpc_base64->is_base64 = TRUE; - $xmlrpc_base64->data = $data; - return $xmlrpc_base64; -} - -/** - * Converts an XML-RPC base 64 object into XML. - * - * @param $xmlrpc_base64 - * The XML-RPC base 64 object. - * - * @return string - * An XML representation of the base 64 data as XML. - */ -function xmlrpc_base64_get_xml($xmlrpc_base64) { - return '' . base64_encode($xmlrpc_base64->data) . ''; -} - -/** - * Performs one or more XML-RPC requests. - * - * @param $url - * An absolute URL of the XML-RPC endpoint, e.g., - * http://example.com/xmlrpc.php - * @param $args - * An associative array whose keys are the methods to call and whose values - * are the arguments to pass to the respective method. If multiple methods - * are specified, a system.multicall is performed. - * @param $options - * (optional) An array of options to pass along to drupal_http_request(). - * - * @return - * A single response (single request) or an array of responses (multicall - * request). Each response is the return value of the method, just as if it - * has been a local function call, on success, or FALSE on failure. If FALSE - * is returned, see xmlrpc_errno() and xmlrpc_error_msg() to get more - * information. - */ -function _xmlrpc($url, $args, $options = array()) { - xmlrpc_clear_error(); - if (count($args) > 1) { - $multicall_args = array(); - foreach ($args as $method => $call) { - $multicall_args[] = array('methodName' => $method, 'params' => $call); - } - $method = 'system.multicall'; - $args = array($multicall_args); - } - else { - $method = key($args); - $args = $args[$method]; - } - $xmlrpc_request = xmlrpc_request($method, $args); - // Required options which will replace any that are passed in. - $options['method'] = 'POST'; - $options['headers']['Content-Type'] = 'text/xml'; - $options['data'] = $xmlrpc_request->xml; - $result = drupal_http_request($url, $options); - if ($result->code != 200) { - xmlrpc_error($result->code, $result->error); - return FALSE; - } - $message = xmlrpc_message($result->data); - // Now parse what we've got back - if (!xmlrpc_message_parse($message)) { - // XML error - xmlrpc_error(-32700, t('Parse error. Not well formed')); - return FALSE; - } - // Is the message a fault? - if ($message->messagetype == 'fault') { - xmlrpc_error($message->fault_code, $message->fault_string); - return FALSE; - } - // We now know that the message is well-formed and a non-fault result. - if ($method == 'system.multicall') { - // Return per-method results or error objects. - $return = array(); - foreach ($message->params[0] as $result) { - if (array_keys($result) == array(0)) { - $return[] = $result[0]; - } - else { - $return[] = xmlrpc_error($result['faultCode'], $result['faultString']); - } - } - } - else { - $return = $message->params[0]; - } - return $return; -} - -/** - * Returns the last XML-RPC client error number. - */ -function xmlrpc_errno() { - $error = xmlrpc_error(); - return ($error != NULL ? $error->code : NULL); -} - -/** - * Returns the last XML-RPC client error message. - */ -function xmlrpc_error_msg() { - $error = xmlrpc_error(); - return ($error != NULL ? $error->message : NULL); -} - -/** - * Clears any previously-saved errors. - * - * @see xmlrpc_error() - */ -function xmlrpc_clear_error() { - xmlrpc_error(NULL, NULL, TRUE); -} - diff --git includes/xmlrpcs.inc includes/xmlrpcs.inc deleted file mode 100644 index fd5a407..0000000 --- includes/xmlrpcs.inc +++ /dev/null @@ -1,386 +0,0 @@ - 'xmlrpc_server_multicall', - array( - 'system.methodSignature', - 'xmlrpc_server_method_signature', - array('array', 'string'), - 'Returns an array describing the return type and required parameters of a method.', - ), - array( - 'system.getCapabilities', - 'xmlrpc_server_get_capabilities', - array('struct'), - 'Returns a struct describing the XML-RPC specifications supported by this server.', - ), - array( - 'system.listMethods', - 'xmlrpc_server_list_methods', - array('array'), - 'Returns an array of available methods on this server.', - ), - array( - 'system.methodHelp', - 'xmlrpc_server_method_help', - array('string', 'string'), - 'Returns a documentation string for the specified method.', - ), - ); - // We build an array of all method names by combining the built-ins - // with those defined by modules implementing the _xmlrpc hook. - // Built-in methods are overridable. - $callbacks = array_merge($defaults, (array) $callbacks); - drupal_alter('xmlrpc', $callbacks); - foreach ($callbacks as $key => $callback) { - // we could check for is_array($callback) - if (is_int($key)) { - $method = $callback[0]; - $xmlrpc_server->callbacks[$method] = $callback[1]; - $xmlrpc_server->signatures[$method] = $callback[2]; - $xmlrpc_server->help[$method] = $callback[3]; - } - else { - $xmlrpc_server->callbacks[$key] = $callback; - $xmlrpc_server->signatures[$key] = ''; - $xmlrpc_server->help[$key] = ''; - } - } - - $data = file_get_contents('php://input'); - if (!$data) { - print 'XML-RPC server accepts POST requests only.'; - drupal_exit(); - } - $xmlrpc_server->message = xmlrpc_message($data); - if (!xmlrpc_message_parse($xmlrpc_server->message)) { - xmlrpc_server_error(-32700, t('Parse error. Request not well formed.')); - } - if ($xmlrpc_server->message->messagetype != 'methodCall') { - xmlrpc_server_error(-32600, t('Server error. Invalid XML-RPC. Request must be a methodCall.')); - } - if (!isset($xmlrpc_server->message->params)) { - $xmlrpc_server->message->params = array(); - } - xmlrpc_server_set($xmlrpc_server); - $result = xmlrpc_server_call($xmlrpc_server, $xmlrpc_server->message->methodname, $xmlrpc_server->message->params); - - if (is_object($result) && !empty($result->is_error)) { - xmlrpc_server_error($result); - } - // Encode the result - $r = xmlrpc_value($result); - // Create the XML - $xml = ' - - - - ' . xmlrpc_value_get_xml($r) . ' - - - - -'; - // Send it - xmlrpc_server_output($xml); -} - -/** - * Throws an XML-RPC error. - * - * @param $error - * An error object or integer error code. - * @param $message - * (optional) The description of the error. Used only if an integer error - * code was passed in. - */ -function xmlrpc_server_error($error, $message = FALSE) { - if ($message && !is_object($error)) { - $error = xmlrpc_error($error, $message); - } - xmlrpc_server_output(xmlrpc_error_get_xml($error)); -} - -/** - * Sends XML-RPC output to the browser. - * - * @param string $xml - * XML to send to the browser. - */ -function xmlrpc_server_output($xml) { - $xml = '' . "\n" . $xml; - drupal_add_http_header('Content-Length', strlen($xml)); - drupal_add_http_header('Content-Type', 'text/xml'); - echo $xml; - drupal_exit(); -} - -/** - * Stores a copy of an XML-RPC request temporarily. - * - * @param object $xmlrpc_server - * (optional) Request object created by xmlrpc_server(). Omit to leave the - * previous server object saved. - * - * @return - * The latest stored request. - * - * @see xmlrpc_server_get() - */ -function xmlrpc_server_set($xmlrpc_server = NULL) { - static $server; - if (!isset($server)) { - $server = $xmlrpc_server; - } - return $server; -} - -/** - * Retrieves the latest stored XML-RPC request. - * - * @return object - * The stored request. - * - * @see xmlrpc_server_set() - */ -function xmlrpc_server_get() { - return xmlrpc_server_set(); -} - -/** - * Dispatches an XML-RPC request and any parameters to the appropriate handler. - * - * @param object $xmlrpc_server - * Object containing information about this XML-RPC server, the methods it - * provides, their signatures, etc. - * @param string $methodname - * The external XML-RPC method name; e.g., 'system.methodHelp'. - * @param array $args - * Array containing any parameters that are to be sent along with the request. - * - * @return - * The results of the call. - */ -function xmlrpc_server_call($xmlrpc_server, $methodname, $args) { - // Make sure parameters are in an array - if ($args && !is_array($args)) { - $args = array($args); - } - // Has this method been mapped to a Drupal function by us or by modules? - if (!isset($xmlrpc_server->callbacks[$methodname])) { - return xmlrpc_error(-32601, t('Server error. Requested method @methodname not specified.', array("@methodname" => $xmlrpc_server->message->methodname))); - } - $method = $xmlrpc_server->callbacks[$methodname]; - $signature = $xmlrpc_server->signatures[$methodname]; - - // If the method has a signature, validate the request against the signature - if (is_array($signature)) { - $ok = TRUE; - $return_type = array_shift($signature); - // Check the number of arguments - if (count($args) != count($signature)) { - return xmlrpc_error(-32602, t('Server error. Wrong number of method parameters.')); - } - // Check the argument types - foreach ($signature as $key => $type) { - $arg = $args[$key]; - switch ($type) { - case 'int': - case 'i4': - if (is_array($arg) || !is_int($arg)) { - $ok = FALSE; - } - break; - - case 'base64': - case 'string': - if (!is_string($arg)) { - $ok = FALSE; - } - break; - - case 'boolean': - if ($arg !== FALSE && $arg !== TRUE) { - $ok = FALSE; - } - break; - - case 'float': - case 'double': - if (!is_float($arg)) { - $ok = FALSE; - } - break; - - case 'date': - case 'dateTime.iso8601': - if (!$arg->is_date) { - $ok = FALSE; - } - break; - } - if (!$ok) { - return xmlrpc_error(-32602, t('Server error. Invalid method parameters.')); - } - } - } - - if (!function_exists($method)) { - return xmlrpc_error(-32601, t('Server error. Requested function @method does not exist.', array("@method" => $method))); - } - // Call the mapped function - return call_user_func_array($method, $args); -} - -/** - * Dispatches multiple XML-RPC requests. - * - * @param array $methodcalls - * An array of XML-RPC requests to make. Each request is an array with the - * following elements: - * - methodName: Name of the method to invoke. - * - params: Parameters to pass to the method. - * - * @return - * An array of the results of each request. - * - * @see xmlrpc_server_call() - */ -function xmlrpc_server_multicall($methodcalls) { - // See http://www.xmlrpc.com/discuss/msgReader$1208 - $return = array(); - $xmlrpc_server = xmlrpc_server_get(); - foreach ($methodcalls as $call) { - $ok = TRUE; - if (!isset($call['methodName']) || !isset($call['params'])) { - $result = xmlrpc_error(3, t('Invalid syntax for system.multicall.')); - $ok = FALSE; - } - $method = $call['methodName']; - $params = $call['params']; - if ($method == 'system.multicall') { - $result = xmlrpc_error(-32600, t('Recursive calls to system.multicall are forbidden.')); - } - elseif ($ok) { - $result = xmlrpc_server_call($xmlrpc_server, $method, $params); - } - if (is_object($result) && !empty($result->is_error)) { - $return[] = array( - 'faultCode' => $result->code, - 'faultString' => $result->message, - ); - } - else { - $return[] = array($result); - } - } - return $return; -} - -/** - * Lists the methods available on this XML-RPC server. - * - * XML-RPC method system.listMethods maps to this function. - * - * @return array - * Array of the names of methods available on this server. - */ -function xmlrpc_server_list_methods() { - $xmlrpc_server = xmlrpc_server_get(); - return array_keys($xmlrpc_server->callbacks); -} - -/** - * Returns a list of the capabilities of this server. - * - * XML-RPC method system.getCapabilities maps to this function. - * - * @return array - * Array of server capabilities. - * - * @see http://groups.yahoo.com/group/xml-rpc/message/2897 - */ -function xmlrpc_server_get_capabilities() { - return array( - 'xmlrpc' => array( - 'specUrl' => 'http://www.xmlrpc.com/spec', - 'specVersion' => 1, - ), - 'faults_interop' => array( - 'specUrl' => 'http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php', - 'specVersion' => 20010516, - ), - 'system.multicall' => array( - 'specUrl' => 'http://www.xmlrpc.com/discuss/msgReader$1208', - 'specVersion' => 1, - ), - 'introspection' => array( - 'specUrl' => 'http://scripts.incutio.com/xmlrpc/introspection.html', - 'specVersion' => 1, - ), - ); -} - -/** - * Returns the method signature of a function. - * - * This is the function mapped to the XML-RPC method system.methodSignature. - * - * A method signature is an array of the input and output types of a method. For - * instance, the method signature of this function is array('array', 'string'), - * because it takes an array and returns a string. - * - * @param string $methodname - * Name of method to return a method signature for. - * - * @return array - * An array of types representing the method signature of the function that - * $methodname maps to. - */ -function xmlrpc_server_method_signature($methodname) { - $xmlrpc_server = xmlrpc_server_get(); - if (!isset($xmlrpc_server->callbacks[$methodname])) { - return xmlrpc_error(-32601, t('Server error. Requested method @methodname not specified.', array("@methodname" => $methodname))); - } - if (!is_array($xmlrpc_server->signatures[$methodname])) { - return xmlrpc_error(-32601, t('Server error. Requested method @methodname signature not specified.', array("@methodname" => $methodname))); - } - // We array of types - $return = array(); - foreach ($xmlrpc_server->signatures[$methodname] as $type) { - $return[] = $type; - } - return $return; -} - -/** - * Returns the help for an XML-RPC method. - * - * XML-RPC method system.methodHelp maps to this function. - * - * @param string $method - * Name of method for which we return a help string. - * - * @return string - * Help text for $method. - */ -function xmlrpc_server_method_help($method) { - $xmlrpc_server = xmlrpc_server_get(); - return $xmlrpc_server->help[$method]; -} - diff --git modules/xmlrpc/xmlrpc.inc modules/xmlrpc/xmlrpc.inc new file mode 100644 index 0000000..40b0d9d --- /dev/null +++ modules/xmlrpc/xmlrpc.inc @@ -0,0 +1,626 @@ +data = $data; + if (!$type) { + $type = xmlrpc_value_calculate_type($xmlrpc_value); + } + $xmlrpc_value->type = $type; + if ($type == 'struct') { + // Turn all the values in the array into new xmlrpc_values + foreach ($xmlrpc_value->data as $key => $value) { + $xmlrpc_value->data[$key] = xmlrpc_value($value); + } + } + if ($type == 'array') { + for ($i = 0, $j = count($xmlrpc_value->data); $i < $j; $i++) { + $xmlrpc_value->data[$i] = xmlrpc_value($xmlrpc_value->data[$i]); + } + } + return $xmlrpc_value; +} + +/** + * Maps a PHP type to an XML-RPC type. + * + * @param $xmlrpc_value + * Variable whose type should be mapped. + * + * @return string + * The corresponding XML-RPC type. + * + * @see http://www.xmlrpc.com/spec#scalars + */ +function xmlrpc_value_calculate_type($xmlrpc_value) { + // http://www.php.net/gettype: Never use gettype() to test for a certain type + // [...] Instead, use the is_* functions. + if (is_bool($xmlrpc_value->data)) { + return 'boolean'; + } + if (is_double($xmlrpc_value->data)) { + return 'double'; + } + if (is_int($xmlrpc_value->data)) { + return 'int'; + } + if (is_array($xmlrpc_value->data)) { + // empty or integer-indexed arrays are 'array', string-indexed arrays 'struct' + return empty($xmlrpc_value->data) || range(0, count($xmlrpc_value->data) - 1) === array_keys($xmlrpc_value->data) ? 'array' : 'struct'; + } + if (is_object($xmlrpc_value->data)) { + if (isset($xmlrpc_value->data->is_date)) { + return 'date'; + } + if (isset($xmlrpc_value->data->is_base64)) { + return 'base64'; + } + $xmlrpc_value->data = get_object_vars($xmlrpc_value->data); + return 'struct'; + } + // default + return 'string'; +} + +/** + * Generates XML representing the given value. + * + * @param $xmlrpc_value + * A value to be represented in XML. + * + * @return + * XML representation of $xmlrpc_value. + */ +function xmlrpc_value_get_xml($xmlrpc_value) { + switch ($xmlrpc_value->type) { + case 'boolean': + return '' . (($xmlrpc_value->data) ? '1' : '0') . ''; + + case 'int': + return '' . $xmlrpc_value->data . ''; + + case 'double': + return '' . $xmlrpc_value->data . ''; + + case 'string': + // Note: we don't escape apostrophes because of the many blogging clients + // that don't support numerical entities (and XML in general) properly. + return '' . htmlspecialchars($xmlrpc_value->data) . ''; + + case 'array': + $return = '' . "\n"; + foreach ($xmlrpc_value->data as $item) { + $return .= ' ' . xmlrpc_value_get_xml($item) . "\n"; + } + $return .= ''; + return $return; + + case 'struct': + $return = '' . "\n"; + foreach ($xmlrpc_value->data as $name => $value) { + $return .= " " . check_plain($name) . ""; + $return .= xmlrpc_value_get_xml($value) . "\n"; + } + $return .= ''; + return $return; + + case 'date': + return xmlrpc_date_get_xml($xmlrpc_value->data); + + case 'base64': + return xmlrpc_base64_get_xml($xmlrpc_value->data); + } + return FALSE; +} + +/** + * Constructs an object representing an XML-RPC message. + * + * @param $message + * A string containing an XML message. + * + * @return object + * An XML-RPC object containing the message. + * + * @see http://www.xmlrpc.com/spec + */ +function xmlrpc_message($message) { + $xmlrpc_message = new stdClass(); + // The stack used to keep track of the current array/struct + $xmlrpc_message->array_structs = array(); + // The stack used to keep track of if things are structs or array + $xmlrpc_message->array_structs_types = array(); + // A stack as well + $xmlrpc_message->current_struct_name = array(); + $xmlrpc_message->message = $message; + return $xmlrpc_message; +} + +/** + * Parses an XML-RPC message. + * + * If parsing fails, the faultCode and faultString will be added to the message + * object. + * + * @param $xmlrpc_message + * An object generated by xmlrpc_message(). + * + * @return + * TRUE if parsing succeeded; FALSE otherwise. + */ +function xmlrpc_message_parse($xmlrpc_message) { + $xmlrpc_message->_parser = xml_parser_create(); + // Set XML parser to take the case of tags into account. + xml_parser_set_option($xmlrpc_message->_parser, XML_OPTION_CASE_FOLDING, FALSE); + // Set XML parser callback functions + xml_set_element_handler($xmlrpc_message->_parser, 'xmlrpc_message_tag_open', 'xmlrpc_message_tag_close'); + xml_set_character_data_handler($xmlrpc_message->_parser, 'xmlrpc_message_cdata'); + xmlrpc_message_set($xmlrpc_message); + if (!xml_parse($xmlrpc_message->_parser, $xmlrpc_message->message)) { + return FALSE; + } + xml_parser_free($xmlrpc_message->_parser); + + // Grab the error messages, if any. + $xmlrpc_message = xmlrpc_message_get(); + if (!isset($xmlrpc_message->messagetype)) { + return FALSE; + } + elseif ($xmlrpc_message->messagetype == 'fault') { + $xmlrpc_message->fault_code = $xmlrpc_message->params[0]['faultCode']; + $xmlrpc_message->fault_string = $xmlrpc_message->params[0]['faultString']; + } + return TRUE; +} + +/** + * Stores a copy of the most recent XML-RPC message object temporarily. + * + * @param $value + * An XML-RPC message to store, or NULL to keep the last message. + * + * @return object + * The most recently stored message. + * + * @see xmlrpc_message_get() + */ +function xmlrpc_message_set($value = NULL) { + static $xmlrpc_message; + if ($value) { + $xmlrpc_message = $value; + } + return $xmlrpc_message; +} + +/** + * Returns the most recently stored XML-RPC message object. + * + * @return object + * The most recently stored message. + * + * @see xmlrpc_message_set() + */ +function xmlrpc_message_get() { + return xmlrpc_message_set(); +} + +/** + * Handles opening tags for XML parsing in xmlrpc_message_parse(). + */ +function xmlrpc_message_tag_open($parser, $tag, $attr) { + $xmlrpc_message = xmlrpc_message_get(); + $xmlrpc_message->current_tag_contents = ''; + $xmlrpc_message->last_open = $tag; + switch ($tag) { + case 'methodCall': + case 'methodResponse': + case 'fault': + $xmlrpc_message->messagetype = $tag; + break; + + // Deal with stacks of arrays and structs + case 'data': + $xmlrpc_message->array_structs_types[] = 'array'; + $xmlrpc_message->array_structs[] = array(); + break; + + case 'struct': + $xmlrpc_message->array_structs_types[] = 'struct'; + $xmlrpc_message->array_structs[] = array(); + break; + } + xmlrpc_message_set($xmlrpc_message); +} + +/** + * Handles character data for XML parsing in xmlrpc_message_parse(). + */ +function xmlrpc_message_cdata($parser, $cdata) { + $xmlrpc_message = xmlrpc_message_get(); + $xmlrpc_message->current_tag_contents .= $cdata; + xmlrpc_message_set($xmlrpc_message); +} + +/** + * Handles closing tags for XML parsing in xmlrpc_message_parse(). + */ +function xmlrpc_message_tag_close($parser, $tag) { + $xmlrpc_message = xmlrpc_message_get(); + $value_flag = FALSE; + switch ($tag) { + case 'int': + case 'i4': + $value = (int)trim($xmlrpc_message->current_tag_contents); + $value_flag = TRUE; + break; + + case 'double': + $value = (double)trim($xmlrpc_message->current_tag_contents); + $value_flag = TRUE; + break; + + case 'string': + $value = $xmlrpc_message->current_tag_contents; + $value_flag = TRUE; + break; + + case 'dateTime.iso8601': + $value = xmlrpc_date(trim($xmlrpc_message->current_tag_contents)); + // $value = $iso->getTimestamp(); + $value_flag = TRUE; + break; + + case 'value': + // If no type is indicated, the type is string + // We take special care for empty values + if (trim($xmlrpc_message->current_tag_contents) != '' || (isset($xmlrpc_message->last_open) && ($xmlrpc_message->last_open == 'value'))) { + $value = (string) $xmlrpc_message->current_tag_contents; + $value_flag = TRUE; + } + unset($xmlrpc_message->last_open); + break; + + case 'boolean': + $value = (boolean)trim($xmlrpc_message->current_tag_contents); + $value_flag = TRUE; + break; + + case 'base64': + $value = base64_decode(trim($xmlrpc_message->current_tag_contents)); + $value_flag = TRUE; + break; + + // Deal with stacks of arrays and structs + case 'data': + case 'struct': + $value = array_pop($xmlrpc_message->array_structs); + array_pop($xmlrpc_message->array_structs_types); + $value_flag = TRUE; + break; + + case 'member': + array_pop($xmlrpc_message->current_struct_name); + break; + + case 'name': + $xmlrpc_message->current_struct_name[] = trim($xmlrpc_message->current_tag_contents); + break; + + case 'methodName': + $xmlrpc_message->methodname = trim($xmlrpc_message->current_tag_contents); + break; + } + if ($value_flag) { + if (count($xmlrpc_message->array_structs) > 0) { + // Add value to struct or array + if ($xmlrpc_message->array_structs_types[count($xmlrpc_message->array_structs_types) - 1] == 'struct') { + // Add to struct + $xmlrpc_message->array_structs[count($xmlrpc_message->array_structs) - 1][$xmlrpc_message->current_struct_name[count($xmlrpc_message->current_struct_name) - 1]] = $value; + } + else { + // Add to array + $xmlrpc_message->array_structs[count($xmlrpc_message->array_structs) - 1][] = $value; + } + } + else { + // Just add as a parameter + $xmlrpc_message->params[] = $value; + } + } + if (!in_array($tag, array("data", "struct", "member"))) { + $xmlrpc_message->current_tag_contents = ''; + } + xmlrpc_message_set($xmlrpc_message); +} + +/** + * Constructs an object representing an XML-RPC request. + * + * @param $method + * The name of the method to be called. + * @param $args + * An array of parameters to send with the method. + * + * @return object + * An XML-RPC object representing the request. + */ +function xmlrpc_request($method, $args) { + $xmlrpc_request = new stdClass(); + $xmlrpc_request->method = $method; + $xmlrpc_request->args = $args; + $xmlrpc_request->xml = << + +{$xmlrpc_request->method} + + +EOD; + foreach ($xmlrpc_request->args as $arg) { + $xmlrpc_request->xml .= ''; + $v = xmlrpc_value($arg); + $xmlrpc_request->xml .= xmlrpc_value_get_xml($v); + $xmlrpc_request->xml .= "\n"; + } + $xmlrpc_request->xml .= ''; + return $xmlrpc_request; +} + +/** + * Generates, temporarily saves, and returns an XML-RPC error object. + * + * @param $code + * The error code. + * @param $message + * The error message. + * @param $reset + * TRUE to empty the temporary error storage. Ignored if $code is supplied. + * + * @return object + * An XML-RPC error object representing $code and $message, or the most + * recently stored error object if omitted. + */ +function xmlrpc_error($code = NULL, $message = NULL, $reset = FALSE) { + static $xmlrpc_error; + if (isset($code)) { + $xmlrpc_error = new stdClass(); + $xmlrpc_error->is_error = TRUE; + $xmlrpc_error->code = $code; + $xmlrpc_error->message = $message; + } + elseif ($reset) { + $xmlrpc_error = NULL; + } + return $xmlrpc_error; +} + +/** + * Converts an XML-RPC error object into XML. + * + * @param $xmlrpc_error + * The XML-RPC error object. + * + * @return string + * An XML representation of the error as an XML methodResponse. + */ +function xmlrpc_error_get_xml($xmlrpc_error) { + return << + + + + + faultCode + {$xmlrpc_error->code} + + + faultString + {$xmlrpc_error->message} + + + + + + +EOD; +} + +/** + * Converts a PHP or ISO date/time to an XML-RPC object. + * + * @param $time + * A PHP timestamp or an ISO date-time string. + * + * @return object + * An XML-RPC time/date object. + */ +function xmlrpc_date($time) { + $xmlrpc_date = new stdClass(); + $xmlrpc_date->is_date = TRUE; + // $time can be a PHP timestamp or an ISO one + if (is_numeric($time)) { + $xmlrpc_date->year = gmdate('Y', $time); + $xmlrpc_date->month = gmdate('m', $time); + $xmlrpc_date->day = gmdate('d', $time); + $xmlrpc_date->hour = gmdate('H', $time); + $xmlrpc_date->minute = gmdate('i', $time); + $xmlrpc_date->second = gmdate('s', $time); + $xmlrpc_date->iso8601 = gmdate('Ymd\TH:i:s', $time); + } + else { + $xmlrpc_date->iso8601 = $time; + $time = str_replace(array('-', ':'), '', $time); + $xmlrpc_date->year = substr($time, 0, 4); + $xmlrpc_date->month = substr($time, 4, 2); + $xmlrpc_date->day = substr($time, 6, 2); + $xmlrpc_date->hour = substr($time, 9, 2); + $xmlrpc_date->minute = substr($time, 11, 2); + $xmlrpc_date->second = substr($time, 13, 2); + } + return $xmlrpc_date; +} + +/** + * Converts an XML-RPC date-time object into XML. + * + * @param $xmlrpc_date + * The XML-RPC date-time object. + * + * @return string + * An XML representation of the date/time as XML. + */ +function xmlrpc_date_get_xml($xmlrpc_date) { + return '' . $xmlrpc_date->year . $xmlrpc_date->month . $xmlrpc_date->day . 'T' . $xmlrpc_date->hour . ':' . $xmlrpc_date->minute . ':' . $xmlrpc_date->second . ''; +} + +/** + * Returns an XML-RPC base 64 object. + * + * @param $data + * Base 64 data to store in returned object. + * + * @return object + * An XML-RPC base 64 object. + */ +function xmlrpc_base64($data) { + $xmlrpc_base64 = new stdClass(); + $xmlrpc_base64->is_base64 = TRUE; + $xmlrpc_base64->data = $data; + return $xmlrpc_base64; +} + +/** + * Converts an XML-RPC base 64 object into XML. + * + * @param $xmlrpc_base64 + * The XML-RPC base 64 object. + * + * @return string + * An XML representation of the base 64 data as XML. + */ +function xmlrpc_base64_get_xml($xmlrpc_base64) { + return '' . base64_encode($xmlrpc_base64->data) . ''; +} + +/** + * Performs one or more XML-RPC requests. + * + * @param $url + * An absolute URL of the XML-RPC endpoint, e.g., + * http://example.com/xmlrpc.php + * @param $args + * An associative array whose keys are the methods to call and whose values + * are the arguments to pass to the respective method. If multiple methods + * are specified, a system.multicall is performed. + * @param $options + * (optional) An array of options to pass along to drupal_http_request(). + * + * @return + * A single response (single request) or an array of responses (multicall + * request). Each response is the return value of the method, just as if it + * has been a local function call, on success, or FALSE on failure. If FALSE + * is returned, see xmlrpc_errno() and xmlrpc_error_msg() to get more + * information. + */ +function _xmlrpc($url, $args, $options = array()) { + xmlrpc_clear_error(); + if (count($args) > 1) { + $multicall_args = array(); + foreach ($args as $method => $call) { + $multicall_args[] = array('methodName' => $method, 'params' => $call); + } + $method = 'system.multicall'; + $args = array($multicall_args); + } + else { + $method = key($args); + $args = $args[$method]; + } + $xmlrpc_request = xmlrpc_request($method, $args); + // Required options which will replace any that are passed in. + $options['method'] = 'POST'; + $options['headers']['Content-Type'] = 'text/xml'; + $options['data'] = $xmlrpc_request->xml; + $result = drupal_http_request($url, $options); + if ($result->code != 200) { + xmlrpc_error($result->code, $result->error); + return FALSE; + } + $message = xmlrpc_message($result->data); + // Now parse what we've got back + if (!xmlrpc_message_parse($message)) { + // XML error + xmlrpc_error(-32700, t('Parse error. Not well formed')); + return FALSE; + } + // Is the message a fault? + if ($message->messagetype == 'fault') { + xmlrpc_error($message->fault_code, $message->fault_string); + return FALSE; + } + // We now know that the message is well-formed and a non-fault result. + if ($method == 'system.multicall') { + // Return per-method results or error objects. + $return = array(); + foreach ($message->params[0] as $result) { + if (array_keys($result) == array(0)) { + $return[] = $result[0]; + } + else { + $return[] = xmlrpc_error($result['faultCode'], $result['faultString']); + } + } + } + else { + $return = $message->params[0]; + } + return $return; +} + +/** + * Returns the last XML-RPC client error number. + */ +function xmlrpc_errno() { + $error = xmlrpc_error(); + return ($error != NULL ? $error->code : NULL); +} + +/** + * Returns the last XML-RPC client error message. + */ +function xmlrpc_error_msg() { + $error = xmlrpc_error(); + return ($error != NULL ? $error->message : NULL); +} + +/** + * Clears any previously-saved errors. + * + * @see xmlrpc_error() + */ +function xmlrpc_clear_error() { + xmlrpc_error(NULL, NULL, TRUE); +} + diff --git modules/xmlrpc/xmlrpc.info modules/xmlrpc/xmlrpc.info new file mode 100644 index 0000000..e462a41 --- /dev/null +++ modules/xmlrpc/xmlrpc.info @@ -0,0 +1,6 @@ +; $Id$ +name = XML-RPC +description = Provides XML-RPC functionality. +package = Core +version = VERSION +core = 7.x diff --git modules/xmlrpc/xmlrpc.module modules/xmlrpc/xmlrpc.module new file mode 100644 index 0000000..a73f457 --- /dev/null +++ modules/xmlrpc/xmlrpc.module @@ -0,0 +1,55 @@ + 'XML-RPC', + 'page callback' => 'xmlrpc_server_page', + 'access callback' => TRUE, + 'type' => MENU_SUGGESTED_ITEM, + 'file' => 'xmlrpc.pages.inc', + ); + return $items; +} + +/** + * Performs one or more XML-RPC request(s). + * + * Usage example: + * @code + * $result = xmlrpc('http://example.com/xmlrpc.php', array( + * 'service.methodName' => array($parameter, $second, $third), + * )); + * @endcode + * + * @param $url + * An absolute URL of the XML-RPC endpoint. + * @param $args + * An associative array whose keys are the methods to call and whose values + * are the arguments to pass to the respective method. If multiple methods + * are specified, a system.multicall is performed. + * @param $options + * (optional) An array of options to pass along to drupal_http_request(). + * + * @return + * For one request: + * Either the return value of the method on success, or FALSE. + * If FALSE is returned, see xmlrpc_errno() and xmlrpc_error_msg(). + * For multiple requests: + * An array of results. Each result will either be the result + * returned by the method called, or an xmlrpc_error object if the call + * failed. See xmlrpc_error(). + */ +function xmlrpc($url, $args, $options = array()) { + require_once DRUPAL_ROOT . 'modules/xmlprc/xmlrpc.inc'; + return _xmlrpc($url, $args, $options); +} + diff --git modules/xmlrpc/xmlrpc.pages.inc modules/xmlrpc/xmlrpc.pages.inc new file mode 100644 index 0000000..5ccc628 --- /dev/null +++ modules/xmlrpc/xmlrpc.pages.inc @@ -0,0 +1,15 @@ + 'xmlrpc_server_multicall', + array( + 'system.methodSignature', + 'xmlrpc_server_method_signature', + array('array', 'string'), + 'Returns an array describing the return type and required parameters of a method.', + ), + array( + 'system.getCapabilities', + 'xmlrpc_server_get_capabilities', + array('struct'), + 'Returns a struct describing the XML-RPC specifications supported by this server.', + ), + array( + 'system.listMethods', + 'xmlrpc_server_list_methods', + array('array'), + 'Returns an array of available methods on this server.', + ), + array( + 'system.methodHelp', + 'xmlrpc_server_method_help', + array('string', 'string'), + 'Returns a documentation string for the specified method.', + ), + ); + // We build an array of all method names by combining the built-ins + // with those defined by modules implementing the _xmlrpc hook. + // Built-in methods are overridable. + $callbacks = array_merge($defaults, (array) $callbacks); + drupal_alter('xmlrpc', $callbacks); + foreach ($callbacks as $key => $callback) { + // we could check for is_array($callback) + if (is_int($key)) { + $method = $callback[0]; + $xmlrpc_server->callbacks[$method] = $callback[1]; + $xmlrpc_server->signatures[$method] = $callback[2]; + $xmlrpc_server->help[$method] = $callback[3]; + } + else { + $xmlrpc_server->callbacks[$key] = $callback; + $xmlrpc_server->signatures[$key] = ''; + $xmlrpc_server->help[$key] = ''; + } + } + + $data = file_get_contents('php://input'); + if (!$data) { + print 'XML-RPC server accepts POST requests only.'; + drupal_exit(); + } + $xmlrpc_server->message = xmlrpc_message($data); + if (!xmlrpc_message_parse($xmlrpc_server->message)) { + xmlrpc_server_error(-32700, t('Parse error. Request not well formed.')); + } + if ($xmlrpc_server->message->messagetype != 'methodCall') { + xmlrpc_server_error(-32600, t('Server error. Invalid XML-RPC. Request must be a methodCall.')); + } + if (!isset($xmlrpc_server->message->params)) { + $xmlrpc_server->message->params = array(); + } + xmlrpc_server_set($xmlrpc_server); + $result = xmlrpc_server_call($xmlrpc_server, $xmlrpc_server->message->methodname, $xmlrpc_server->message->params); + + if (is_object($result) && !empty($result->is_error)) { + xmlrpc_server_error($result); + } + // Encode the result + $r = xmlrpc_value($result); + // Create the XML + $xml = ' + + + + ' . xmlrpc_value_get_xml($r) . ' + + + + +'; + // Send it + xmlrpc_server_output($xml); +} + +/** + * Throws an XML-RPC error. + * + * @param $error + * An error object or integer error code. + * @param $message + * (optional) The description of the error. Used only if an integer error + * code was passed in. + */ +function xmlrpc_server_error($error, $message = FALSE) { + if ($message && !is_object($error)) { + $error = xmlrpc_error($error, $message); + } + xmlrpc_server_output(xmlrpc_error_get_xml($error)); +} + +/** + * Sends XML-RPC output to the browser. + * + * @param string $xml + * XML to send to the browser. + */ +function xmlrpc_server_output($xml) { + $xml = '' . "\n" . $xml; + drupal_add_http_header('Content-Length', strlen($xml)); + drupal_add_http_header('Content-Type', 'text/xml'); + echo $xml; + drupal_exit(); +} + +/** + * Stores a copy of an XML-RPC request temporarily. + * + * @param object $xmlrpc_server + * (optional) Request object created by xmlrpc_server(). Omit to leave the + * previous server object saved. + * + * @return + * The latest stored request. + * + * @see xmlrpc_server_get() + */ +function xmlrpc_server_set($xmlrpc_server = NULL) { + static $server; + if (!isset($server)) { + $server = $xmlrpc_server; + } + return $server; +} + +/** + * Retrieves the latest stored XML-RPC request. + * + * @return object + * The stored request. + * + * @see xmlrpc_server_set() + */ +function xmlrpc_server_get() { + return xmlrpc_server_set(); +} + +/** + * Dispatches an XML-RPC request and any parameters to the appropriate handler. + * + * @param object $xmlrpc_server + * Object containing information about this XML-RPC server, the methods it + * provides, their signatures, etc. + * @param string $methodname + * The external XML-RPC method name; e.g., 'system.methodHelp'. + * @param array $args + * Array containing any parameters that are to be sent along with the request. + * + * @return + * The results of the call. + */ +function xmlrpc_server_call($xmlrpc_server, $methodname, $args) { + // Make sure parameters are in an array + if ($args && !is_array($args)) { + $args = array($args); + } + // Has this method been mapped to a Drupal function by us or by modules? + if (!isset($xmlrpc_server->callbacks[$methodname])) { + return xmlrpc_error(-32601, t('Server error. Requested method @methodname not specified.', array("@methodname" => $xmlrpc_server->message->methodname))); + } + $method = $xmlrpc_server->callbacks[$methodname]; + $signature = $xmlrpc_server->signatures[$methodname]; + + // If the method has a signature, validate the request against the signature + if (is_array($signature)) { + $ok = TRUE; + $return_type = array_shift($signature); + // Check the number of arguments + if (count($args) != count($signature)) { + return xmlrpc_error(-32602, t('Server error. Wrong number of method parameters.')); + } + // Check the argument types + foreach ($signature as $key => $type) { + $arg = $args[$key]; + switch ($type) { + case 'int': + case 'i4': + if (is_array($arg) || !is_int($arg)) { + $ok = FALSE; + } + break; + + case 'base64': + case 'string': + if (!is_string($arg)) { + $ok = FALSE; + } + break; + + case 'boolean': + if ($arg !== FALSE && $arg !== TRUE) { + $ok = FALSE; + } + break; + + case 'float': + case 'double': + if (!is_float($arg)) { + $ok = FALSE; + } + break; + + case 'date': + case 'dateTime.iso8601': + if (!$arg->is_date) { + $ok = FALSE; + } + break; + } + if (!$ok) { + return xmlrpc_error(-32602, t('Server error. Invalid method parameters.')); + } + } + } + + if (!function_exists($method)) { + return xmlrpc_error(-32601, t('Server error. Requested function @method does not exist.', array("@method" => $method))); + } + // Call the mapped function + return call_user_func_array($method, $args); +} + +/** + * Dispatches multiple XML-RPC requests. + * + * @param array $methodcalls + * An array of XML-RPC requests to make. Each request is an array with the + * following elements: + * - methodName: Name of the method to invoke. + * - params: Parameters to pass to the method. + * + * @return + * An array of the results of each request. + * + * @see xmlrpc_server_call() + */ +function xmlrpc_server_multicall($methodcalls) { + // See http://www.xmlrpc.com/discuss/msgReader$1208 + $return = array(); + $xmlrpc_server = xmlrpc_server_get(); + foreach ($methodcalls as $call) { + $ok = TRUE; + if (!isset($call['methodName']) || !isset($call['params'])) { + $result = xmlrpc_error(3, t('Invalid syntax for system.multicall.')); + $ok = FALSE; + } + $method = $call['methodName']; + $params = $call['params']; + if ($method == 'system.multicall') { + $result = xmlrpc_error(-32600, t('Recursive calls to system.multicall are forbidden.')); + } + elseif ($ok) { + $result = xmlrpc_server_call($xmlrpc_server, $method, $params); + } + if (is_object($result) && !empty($result->is_error)) { + $return[] = array( + 'faultCode' => $result->code, + 'faultString' => $result->message, + ); + } + else { + $return[] = array($result); + } + } + return $return; +} + +/** + * Lists the methods available on this XML-RPC server. + * + * XML-RPC method system.listMethods maps to this function. + * + * @return array + * Array of the names of methods available on this server. + */ +function xmlrpc_server_list_methods() { + $xmlrpc_server = xmlrpc_server_get(); + return array_keys($xmlrpc_server->callbacks); +} + +/** + * Returns a list of the capabilities of this server. + * + * XML-RPC method system.getCapabilities maps to this function. + * + * @return array + * Array of server capabilities. + * + * @see http://groups.yahoo.com/group/xml-rpc/message/2897 + */ +function xmlrpc_server_get_capabilities() { + return array( + 'xmlrpc' => array( + 'specUrl' => 'http://www.xmlrpc.com/spec', + 'specVersion' => 1, + ), + 'faults_interop' => array( + 'specUrl' => 'http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php', + 'specVersion' => 20010516, + ), + 'system.multicall' => array( + 'specUrl' => 'http://www.xmlrpc.com/discuss/msgReader$1208', + 'specVersion' => 1, + ), + 'introspection' => array( + 'specUrl' => 'http://scripts.incutio.com/xmlrpc/introspection.html', + 'specVersion' => 1, + ), + ); +} + +/** + * Returns the method signature of a function. + * + * This is the function mapped to the XML-RPC method system.methodSignature. + * + * A method signature is an array of the input and output types of a method. For + * instance, the method signature of this function is array('array', 'string'), + * because it takes an array and returns a string. + * + * @param string $methodname + * Name of method to return a method signature for. + * + * @return array + * An array of types representing the method signature of the function that + * $methodname maps to. + */ +function xmlrpc_server_method_signature($methodname) { + $xmlrpc_server = xmlrpc_server_get(); + if (!isset($xmlrpc_server->callbacks[$methodname])) { + return xmlrpc_error(-32601, t('Server error. Requested method @methodname not specified.', array("@methodname" => $methodname))); + } + if (!is_array($xmlrpc_server->signatures[$methodname])) { + return xmlrpc_error(-32601, t('Server error. Requested method @methodname signature not specified.', array("@methodname" => $methodname))); + } + // We array of types + $return = array(); + foreach ($xmlrpc_server->signatures[$methodname] as $type) { + $return[] = $type; + } + return $return; +} + +/** + * Returns the help for an XML-RPC method. + * + * XML-RPC method system.methodHelp maps to this function. + * + * @param string $method + * Name of method for which we return a help string. + * + * @return string + * Help text for $method. + */ +function xmlrpc_server_method_help($method) { + $xmlrpc_server = xmlrpc_server_get(); + return $xmlrpc_server->help[$method]; +} + diff --git xmlrpc.php xmlrpc.php deleted file mode 100644 index 4b6b115..0000000 --- xmlrpc.php +++ /dev/null @@ -1,19 +0,0 @@ -