webmaster@1: data = $data;
webmaster@1: if (!$type) {
webmaster@1: $type = xmlrpc_value_calculate_type($xmlrpc_value);
webmaster@1: }
webmaster@1: $xmlrpc_value->type = $type;
webmaster@1: if ($type == 'struct') {
webmaster@1: // Turn all the values in the array into new xmlrpc_values
webmaster@1: foreach ($xmlrpc_value->data as $key => $value) {
webmaster@1: $xmlrpc_value->data[$key] = xmlrpc_value($value);
webmaster@1: }
webmaster@1: }
webmaster@1: if ($type == 'array') {
webmaster@1: for ($i = 0, $j = count($xmlrpc_value->data); $i < $j; $i++) {
webmaster@1: $xmlrpc_value->data[$i] = xmlrpc_value($xmlrpc_value->data[$i]);
webmaster@1: }
webmaster@1: }
webmaster@1: return $xmlrpc_value;
webmaster@1: }
webmaster@1:
webmaster@1: /**
webmaster@1: * Map PHP type to XML-RPC type.
webmaster@1: *
webmaster@1: * @param $xmlrpc_value
webmaster@1: * Variable whose type should be mapped.
webmaster@1: * @return
webmaster@1: * XML-RPC type as string.
webmaster@1: * @see
webmaster@1: * http://www.xmlrpc.com/spec#scalars
webmaster@1: */
webmaster@1: function xmlrpc_value_calculate_type(&$xmlrpc_value) {
webmaster@1: // http://www.php.net/gettype: Never use gettype() to test for a certain type [...] Instead, use the is_* functions.
webmaster@1: if (is_bool($xmlrpc_value->data)) {
webmaster@1: return 'boolean';
webmaster@1: }
webmaster@1: if (is_double($xmlrpc_value->data)) {
webmaster@1: return 'double';
webmaster@1: }
webmaster@1: if (is_int($xmlrpc_value->data)) {
webmaster@1: return 'int';
webmaster@1: }
webmaster@1: if (is_array($xmlrpc_value->data)) {
webmaster@1: // empty or integer-indexed arrays are 'array', string-indexed arrays 'struct'
webmaster@1: return empty($xmlrpc_value->data) || range(0, count($xmlrpc_value->data) - 1) === array_keys($xmlrpc_value->data) ? 'array' : 'struct';
webmaster@1: }
webmaster@1: if (is_object($xmlrpc_value->data)) {
webmaster@1: if ($xmlrpc_value->data->is_date) {
webmaster@1: return 'date';
webmaster@1: }
webmaster@1: if ($xmlrpc_value->data->is_base64) {
webmaster@1: return 'base64';
webmaster@1: }
webmaster@1: $xmlrpc_value->data = get_object_vars($xmlrpc_value->data);
webmaster@1: return 'struct';
webmaster@1: }
webmaster@1: // default
webmaster@1: return 'string';
webmaster@1: }
webmaster@1:
webmaster@1: /**
webmaster@1: * Generate XML representing the given value.
webmaster@1: *
webmaster@1: * @param $xmlrpc_value
webmaster@1: * @return
webmaster@1: * XML representation of value.
webmaster@1: */
webmaster@1: function xmlrpc_value_get_xml($xmlrpc_value) {
webmaster@1: switch ($xmlrpc_value->type) {
webmaster@1: case 'boolean':
webmaster@1: return ''. (($xmlrpc_value->data) ? '1' : '0') .'';
webmaster@1: break;
webmaster@1: case 'int':
webmaster@1: return ''. $xmlrpc_value->data .'';
webmaster@1: break;
webmaster@1: case 'double':
webmaster@1: return ''. $xmlrpc_value->data .'';
webmaster@1: break;
webmaster@1: case 'string':
webmaster@1: // Note: we don't escape apostrophes because of the many blogging clients
webmaster@1: // that don't support numerical entities (and XML in general) properly.
webmaster@1: return ''. htmlspecialchars($xmlrpc_value->data) .'';
webmaster@1: break;
webmaster@1: case 'array':
webmaster@1: $return = ''."\n";
webmaster@1: foreach ($xmlrpc_value->data as $item) {
webmaster@1: $return .= ' '. xmlrpc_value_get_xml($item) ."\n";
webmaster@1: }
webmaster@1: $return .= '';
webmaster@1: return $return;
webmaster@1: break;
webmaster@1: case 'struct':
webmaster@1: $return = ''."\n";
webmaster@1: foreach ($xmlrpc_value->data as $name => $value) {
webmaster@1: $return .= " ". check_plain($name) ."";
webmaster@1: $return .= xmlrpc_value_get_xml($value) ."\n";
webmaster@1: }
webmaster@1: $return .= '';
webmaster@1: return $return;
webmaster@1: break;
webmaster@1: case 'date':
webmaster@1: return xmlrpc_date_get_xml($xmlrpc_value->data);
webmaster@1: break;
webmaster@1: case 'base64':
webmaster@1: return xmlrpc_base64_get_xml($xmlrpc_value->data);
webmaster@1: break;
webmaster@1: }
webmaster@1: return FALSE;
webmaster@1: }
webmaster@1:
webmaster@1: /**
webmaster@1: * Construct an object representing an XML-RPC message.
webmaster@1: *
webmaster@1: * @param $message
webmaster@1: * String containing XML as defined at http://www.xmlrpc.com/spec
webmaster@1: * @return
webmaster@1: * Object
webmaster@1: */
webmaster@1: function xmlrpc_message($message) {
webmaster@1: $xmlrpc_message = new stdClass();
webmaster@1: $xmlrpc_message->array_structs = array(); // The stack used to keep track of the current array/struct
webmaster@1: $xmlrpc_message->array_structs_types = array(); // The stack used to keep track of if things are structs or array
webmaster@1: $xmlrpc_message->current_struct_name = array(); // A stack as well
webmaster@1: $xmlrpc_message->message = $message;
webmaster@1: return $xmlrpc_message;
webmaster@1: }
webmaster@1:
webmaster@1: /**
webmaster@1: * Parse an XML-RPC message. If parsing fails, the faultCode and faultString
webmaster@1: * will be added to the message object.
webmaster@1: *
webmaster@1: * @param $xmlrpc_message
webmaster@1: * Object generated by xmlrpc_message()
webmaster@1: * @return
webmaster@1: * TRUE if parsing succeeded; FALSE otherwise
webmaster@1: */
webmaster@1: function xmlrpc_message_parse(&$xmlrpc_message) {
webmaster@1: // First remove the XML declaration
webmaster@1: $xmlrpc_message->message = preg_replace('/<\?xml(.*)?\?'.'>/', '', $xmlrpc_message->message);
webmaster@1: if (trim($xmlrpc_message->message) == '') {
webmaster@1: return FALSE;
webmaster@1: }
webmaster@1: $xmlrpc_message->_parser = xml_parser_create();
webmaster@1: // Set XML parser to take the case of tags into account.
webmaster@1: xml_parser_set_option($xmlrpc_message->_parser, XML_OPTION_CASE_FOLDING, FALSE);
webmaster@1: // Set XML parser callback functions
webmaster@1: xml_set_element_handler($xmlrpc_message->_parser, 'xmlrpc_message_tag_open', 'xmlrpc_message_tag_close');
webmaster@1: xml_set_character_data_handler($xmlrpc_message->_parser, 'xmlrpc_message_cdata');
webmaster@1: xmlrpc_message_set($xmlrpc_message);
webmaster@1: if (!xml_parse($xmlrpc_message->_parser, $xmlrpc_message->message)) {
webmaster@1: return FALSE;
webmaster@1: }
webmaster@1: xml_parser_free($xmlrpc_message->_parser);
webmaster@1: // Grab the error messages, if any
webmaster@1: $xmlrpc_message = xmlrpc_message_get();
webmaster@1: if ($xmlrpc_message->messagetype == 'fault') {
webmaster@1: $xmlrpc_message->fault_code = $xmlrpc_message->params[0]['faultCode'];
webmaster@1: $xmlrpc_message->fault_string = $xmlrpc_message->params[0]['faultString'];
webmaster@1: }
webmaster@1: return TRUE;
webmaster@1: }
webmaster@1:
webmaster@1: /**
webmaster@1: * Store a copy of the $xmlrpc_message object temporarily.
webmaster@1: *
webmaster@1: * @param $value
webmaster@1: * Object
webmaster@1: * @return
webmaster@1: * The most recently stored $xmlrpc_message
webmaster@1: */
webmaster@1: function xmlrpc_message_set($value = NULL) {
webmaster@1: static $xmlrpc_message;
webmaster@1: if ($value) {
webmaster@1: $xmlrpc_message = $value;
webmaster@1: }
webmaster@1: return $xmlrpc_message;
webmaster@1: }
webmaster@1:
webmaster@1: function xmlrpc_message_get() {
webmaster@1: return xmlrpc_message_set();
webmaster@1: }
webmaster@1:
webmaster@1: function xmlrpc_message_tag_open($parser, $tag, $attr) {
webmaster@1: $xmlrpc_message = xmlrpc_message_get();
webmaster@1: $xmlrpc_message->current_tag_contents = '';
webmaster@1: $xmlrpc_message->last_open = $tag;
webmaster@1: switch ($tag) {
webmaster@1: case 'methodCall':
webmaster@1: case 'methodResponse':
webmaster@1: case 'fault':
webmaster@1: $xmlrpc_message->messagetype = $tag;
webmaster@1: break;
webmaster@1: // Deal with stacks of arrays and structs
webmaster@1: case 'data':
webmaster@1: $xmlrpc_message->array_structs_types[] = 'array';
webmaster@1: $xmlrpc_message->array_structs[] = array();
webmaster@1: break;
webmaster@1: case 'struct':
webmaster@1: $xmlrpc_message->array_structs_types[] = 'struct';
webmaster@1: $xmlrpc_message->array_structs[] = array();
webmaster@1: break;
webmaster@1: }
webmaster@1: xmlrpc_message_set($xmlrpc_message);
webmaster@1: }
webmaster@1:
webmaster@1: function xmlrpc_message_cdata($parser, $cdata) {
webmaster@1: $xmlrpc_message = xmlrpc_message_get();
webmaster@1: $xmlrpc_message->current_tag_contents .= $cdata;
webmaster@1: xmlrpc_message_set($xmlrpc_message);
webmaster@1: }
webmaster@1:
webmaster@1: function xmlrpc_message_tag_close($parser, $tag) {
webmaster@1: $xmlrpc_message = xmlrpc_message_get();
webmaster@1: $value_flag = FALSE;
webmaster@1: switch ($tag) {
webmaster@1: case 'int':
webmaster@1: case 'i4':
webmaster@1: $value = (int)trim($xmlrpc_message->current_tag_contents);
webmaster@1: $value_flag = TRUE;
webmaster@1: break;
webmaster@1: case 'double':
webmaster@1: $value = (double)trim($xmlrpc_message->current_tag_contents);
webmaster@1: $value_flag = TRUE;
webmaster@1: break;
webmaster@1: case 'string':
webmaster@1: $value = $xmlrpc_message->current_tag_contents;
webmaster@1: $value_flag = TRUE;
webmaster@1: break;
webmaster@1: case 'dateTime.iso8601':
webmaster@1: $value = xmlrpc_date(trim($xmlrpc_message->current_tag_contents));
webmaster@1: // $value = $iso->getTimestamp();
webmaster@1: $value_flag = TRUE;
webmaster@1: break;
webmaster@1: case 'value':
webmaster@1: // If no type is indicated, the type is string
webmaster@1: // We take special care for empty values
webmaster@5: if (trim($xmlrpc_message->current_tag_contents) != '' || (isset($xmlrpc_message->last_open) && ($xmlrpc_message->last_open == 'value'))) {
webmaster@1: $value = (string)$xmlrpc_message->current_tag_contents;
webmaster@1: $value_flag = TRUE;
webmaster@1: }
webmaster@1: unset($xmlrpc_message->last_open);
webmaster@1: break;
webmaster@1: case 'boolean':
webmaster@1: $value = (boolean)trim($xmlrpc_message->current_tag_contents);
webmaster@1: $value_flag = TRUE;
webmaster@1: break;
webmaster@1: case 'base64':
webmaster@1: $value = base64_decode(trim($xmlrpc_message->current_tag_contents));
webmaster@1: $value_flag = TRUE;
webmaster@1: break;
webmaster@1: // Deal with stacks of arrays and structs
webmaster@1: case 'data':
webmaster@1: case 'struct':
webmaster@1: $value = array_pop($xmlrpc_message->array_structs );
webmaster@1: array_pop($xmlrpc_message->array_structs_types);
webmaster@1: $value_flag = TRUE;
webmaster@1: break;
webmaster@1: case 'member':
webmaster@1: array_pop($xmlrpc_message->current_struct_name);
webmaster@1: break;
webmaster@1: case 'name':
webmaster@1: $xmlrpc_message->current_struct_name[] = trim($xmlrpc_message->current_tag_contents);
webmaster@1: break;
webmaster@1: case 'methodName':
webmaster@1: $xmlrpc_message->methodname = trim($xmlrpc_message->current_tag_contents);
webmaster@1: break;
webmaster@1: }
webmaster@1: if ($value_flag) {
webmaster@1: if (count($xmlrpc_message->array_structs ) > 0) {
webmaster@1: // Add value to struct or array
webmaster@1: if ($xmlrpc_message->array_structs_types[count($xmlrpc_message->array_structs_types)-1] == 'struct') {
webmaster@1: // Add to struct
webmaster@1: $xmlrpc_message->array_structs [count($xmlrpc_message->array_structs )-1][$xmlrpc_message->current_struct_name[count($xmlrpc_message->current_struct_name)-1]] = $value;
webmaster@1: }
webmaster@1: else {
webmaster@1: // Add to array
webmaster@1: $xmlrpc_message->array_structs [count($xmlrpc_message->array_structs )-1][] = $value;
webmaster@1: }
webmaster@1: }
webmaster@1: else {
webmaster@1: // Just add as a parameter
webmaster@1: $xmlrpc_message->params[] = $value;
webmaster@1: }
webmaster@1: }
webmaster@1: if (!in_array($tag, array("data", "struct", "member"))) {
webmaster@1: $xmlrpc_message->current_tag_contents = '';
webmaster@1: }
webmaster@1: xmlrpc_message_set($xmlrpc_message);
webmaster@1: }
webmaster@1:
webmaster@1: /**
webmaster@1: * Construct an object representing an XML-RPC request
webmaster@1: *
webmaster@1: * @param $method
webmaster@1: * The name of the method to be called
webmaster@1: * @param $args
webmaster@1: * An array of parameters to send with the method.
webmaster@1: * @return
webmaster@1: * Object
webmaster@1: */
webmaster@1: function xmlrpc_request($method, $args) {
webmaster@1: $xmlrpc_request = new stdClass();
webmaster@1: $xmlrpc_request->method = $method;
webmaster@1: $xmlrpc_request->args = $args;
webmaster@1: $xmlrpc_request->xml = <<
webmaster@1:
webmaster@1: {$xmlrpc_request->method}
webmaster@1:
webmaster@1:
webmaster@1: EOD;
webmaster@1: foreach ($xmlrpc_request->args as $arg) {
webmaster@1: $xmlrpc_request->xml .= '';
webmaster@1: $v = xmlrpc_value($arg);
webmaster@1: $xmlrpc_request->xml .= xmlrpc_value_get_xml($v);
webmaster@1: $xmlrpc_request->xml .= "\n";
webmaster@1: }
webmaster@1: $xmlrpc_request->xml .= '';
webmaster@1: return $xmlrpc_request;
webmaster@1: }
webmaster@1:
webmaster@1:
webmaster@11: function xmlrpc_error($code = NULL, $message = NULL, $reset = FALSE) {
webmaster@1: static $xmlrpc_error;
webmaster@1: if (isset($code)) {
webmaster@1: $xmlrpc_error = new stdClass();
webmaster@1: $xmlrpc_error->is_error = TRUE;
webmaster@1: $xmlrpc_error->code = $code;
webmaster@1: $xmlrpc_error->message = $message;
webmaster@1: module_invoke('system', 'check_http_request');
webmaster@1: }
webmaster@11: elseif ($reset) {
webmaster@11: $xmlrpc_error = NULL;
webmaster@11: }
webmaster@1: return $xmlrpc_error;
webmaster@1: }
webmaster@1:
webmaster@1: function xmlrpc_error_get_xml($xmlrpc_error) {
webmaster@1: return <<
webmaster@1:
webmaster@1:
webmaster@1:
webmaster@1:
webmaster@1: faultCode
webmaster@1: {$xmlrpc_error->code}
webmaster@1:
webmaster@1:
webmaster@1: faultString
webmaster@1: {$xmlrpc_error->message}
webmaster@1:
webmaster@1:
webmaster@1:
webmaster@1:
webmaster@1:
webmaster@1:
webmaster@1: EOD;
webmaster@1: }
webmaster@1:
webmaster@1: function xmlrpc_date($time) {
webmaster@1: $xmlrpc_date = new stdClass();
webmaster@1: $xmlrpc_date->is_date = TRUE;
webmaster@1: // $time can be a PHP timestamp or an ISO one
webmaster@1: if (is_numeric($time)) {
webmaster@1: $xmlrpc_date->year = date('Y', $time);
webmaster@1: $xmlrpc_date->month = date('m', $time);
webmaster@1: $xmlrpc_date->day = date('d', $time);
webmaster@1: $xmlrpc_date->hour = date('H', $time);
webmaster@1: $xmlrpc_date->minute = date('i', $time);
webmaster@1: $xmlrpc_date->second = date('s', $time);
webmaster@1: $xmlrpc_date->iso8601 = date('Ymd\TH:i:s', $time);
webmaster@1: }
webmaster@1: else {
webmaster@1: $xmlrpc_date->iso8601 = $time;
webmaster@1: $time = str_replace(array('-', ':'), '', $time);
webmaster@1: $xmlrpc_date->year = substr($time, 0, 4);
webmaster@1: $xmlrpc_date->month = substr($time, 4, 2);
webmaster@1: $xmlrpc_date->day = substr($time, 6, 2);
webmaster@1: $xmlrpc_date->hour = substr($time, 9, 2);
webmaster@1: $xmlrpc_date->minute = substr($time, 11, 2);
webmaster@1: $xmlrpc_date->second = substr($time, 13, 2);
webmaster@1: }
webmaster@1: return $xmlrpc_date;
webmaster@1: }
webmaster@1:
webmaster@1: function xmlrpc_date_get_xml($xmlrpc_date) {
webmaster@1: return ''. $xmlrpc_date->year . $xmlrpc_date->month . $xmlrpc_date->day .'T'. $xmlrpc_date->hour .':'. $xmlrpc_date->minute .':'. $xmlrpc_date->second .'';
webmaster@1: }
webmaster@1:
webmaster@1: function xmlrpc_base64($data) {
webmaster@1: $xmlrpc_base64 = new stdClass();
webmaster@1: $xmlrpc_base64->is_base64 = TRUE;
webmaster@1: $xmlrpc_base64->data = $data;
webmaster@1: return $xmlrpc_base64;
webmaster@1: }
webmaster@1:
webmaster@1: function xmlrpc_base64_get_xml($xmlrpc_base64) {
webmaster@1: return ''. base64_encode($xmlrpc_base64->data) .'';
webmaster@1: }
webmaster@1:
webmaster@1: /**
webmaster@1: * Execute an XML remote procedural call. This is private function; call xmlrpc()
webmaster@1: * in common.inc instead of this function.
webmaster@1: *
webmaster@1: * @return
webmaster@1: * A $xmlrpc_message object if the call succeeded; FALSE if the call failed
webmaster@1: */
webmaster@1: function _xmlrpc() {
webmaster@1: $args = func_get_args();
webmaster@1: $url = array_shift($args);
webmaster@11: xmlrpc_clear_error();
webmaster@1: if (is_array($args[0])) {
webmaster@1: $method = 'system.multicall';
webmaster@1: $multicall_args = array();
webmaster@1: foreach ($args[0] as $call) {
webmaster@1: $multicall_args[] = array('methodName' => array_shift($call), 'params' => $call);
webmaster@1: }
webmaster@1: $args = array($multicall_args);
webmaster@1: }
webmaster@1: else {
webmaster@1: $method = array_shift($args);
webmaster@1: }
webmaster@1: $xmlrpc_request = xmlrpc_request($method, $args);
webmaster@1: $result = drupal_http_request($url, array("Content-Type" => "text/xml"), 'POST', $xmlrpc_request->xml);
webmaster@1: if ($result->code != 200) {
webmaster@1: xmlrpc_error($result->code, $result->error);
webmaster@1: return FALSE;
webmaster@1: }
webmaster@1: $message = xmlrpc_message($result->data);
webmaster@1: // Now parse what we've got back
webmaster@1: if (!xmlrpc_message_parse($message)) {
webmaster@1: // XML error
webmaster@1: xmlrpc_error(-32700, t('Parse error. Not well formed'));
webmaster@1: return FALSE;
webmaster@1: }
webmaster@1: // Is the message a fault?
webmaster@1: if ($message->messagetype == 'fault') {
webmaster@1: xmlrpc_error($message->fault_code, $message->fault_string);
webmaster@1: return FALSE;
webmaster@1: }
webmaster@1: // Message must be OK
webmaster@1: return $message->params[0];
webmaster@1: }
webmaster@1:
webmaster@1: /**
webmaster@1: * Returns the last XML-RPC client error number
webmaster@1: */
webmaster@1: function xmlrpc_errno() {
webmaster@1: $error = xmlrpc_error();
webmaster@7: return ($error != NULL ? $error->code : NULL);
webmaster@1: }
webmaster@1:
webmaster@1: /**
webmaster@1: * Returns the last XML-RPC client error message
webmaster@1: */
webmaster@1: function xmlrpc_error_msg() {
webmaster@1: $error = xmlrpc_error();
webmaster@7: return ($error != NULL ? $error->message : NULL);
webmaster@1: }
webmaster@11:
webmaster@11: /**
webmaster@11: * Clears any previous error.
webmaster@11: */
webmaster@11: function xmlrpc_clear_error() {
webmaster@11: xmlrpc_error(NULL, NULL, TRUE);
webmaster@11: }