' . t('This is the XML-RPC server configuration page.
Here you may define the maximum and minimum values for the addition or subtraction exposed services.
') . '

' . t('Use the XML-RPC Client example form to experiment', array('!link' => url('examples/xmlrpc/client'))), ); if (variable_get('xmlrpc_example_alter_enabled', FALSE)) { $form['overridden'] = array( '#type' => 'markup', '#markup' => '', ); } return system_settings_form($form); } // The server part of the module ends here. // This is the client part of the module. If defines a form with two input // fields to call xmlrpc_example.add or xmlrpc_example.subtract methods on this // host. Please note that having a user interface to query an XML-RPC service is // not required. A method can be requested to a server using the xmlrpc() // function directly. We have included an user interface to make the testing // easier. // The client user interface part of the module starts here. /** * Present a form to get two arguments, and make a call to an XML-RPC server * using these arguments as input, showing the result in a message. */ function xmlrpc_example_client_form() { $form = array(); $form['explanation'] = array( '#markup' => '', ); // We are going to call add and subtract methods, and they work with integer values. $form['num1'] = array( '#type' => 'textfield', '#title' => t('Enter an integer'), '#default_value' => 2, '#size' => 5, '#required' => TRUE, ); $form['num2'] = array( '#type' => 'textfield', '#title' => t('Enter a second integer'), '#default_value' => 2, '#size' => 5, '#required' => TRUE, ); // Include several buttons, each of them calling a different method. // This button submits a XML-RPC call to the system.listMethods method. $form['information'] = array( '#type' => 'submit', '#value' => t('Request methods'), '#submit' => array('xmlrpc_example_client_request_methods_submit'), ); // This button submits a XML-RPC call to the xmlrpc_example.add method. $form['add'] = array( '#type' => 'submit', '#value' => t('Add the integers'), '#submit' => array('xmlrpc_example_client_add_submit'), ); // This button submits a XML-RPC call to the xmlrpc_example.subtract method. $form['subtract'] = array( '#type' => 'submit', '#value' => t('Subtract the integers'), '#submit' => array('xmlrpc_example_client_subtract_submit'), ); // This button submits a XML-RPC call to the system.multicall method. $form['add_subtract'] = array( '#type' => 'submit', '#value' => t('Add and Subtract'), '#submit' => array('xmlrpc_example_client_multicall_submit'), ); if (variable_get('xmlrpc_example_alter_enabled', FALSE)) { $form['overridden'] = array( '#type' => 'markup', '#markup' => '', ); } return $form; } /** * Submit: query the XML-RPC endpoint for the method system.listMethods * and report the result as a Drupal message. The result is a list of the * available methods in this XML-RPC server. * * Important note: Not all XML-RPC servers implement this method. Drupal's * built-in XML-RPC server implements this method by default. * * @param $form * @param $form_state * * @see xmlrpc() * @see xmlrpc_errno() * @see xmlrpc_error_msg() */ function xmlrpc_example_client_request_methods_submit($form, &$form_state) { // First define the endpoint of the XML-RPC service, in this case this is our // own server. $server = url($GLOBALS['base_url'] . '/xmlrpc.php', array('external' => TRUE)); // Then we should define the method to call. xmlrpc() requires that all the // information related to the called method be passed as an array in the form // of 'method_name' => arguments_array $options = array( 'system.listMethods' => array(), ); // Make the xmlrpc request and process the results. $result = xmlrpc($server, $options); if ($result === FALSE) { drupal_set_message( t('Error return from xmlrpc(): Error: @errno, Message: @message', array('@errno' => xmlrpc_errno(), '@message' => xmlrpc_error_msg())), 'error' ); } else { drupal_set_message( t('The XML-RPC server returned this response:

@response

', array('@response' => print_r($result, TRUE))) ); } } /** * Submit: query the XML-RPC endpoint for the method xmlrpc_example.add * and report the result as a Drupal message. * * @param $form * @param $form_state * * @see xmlrpc() * @see xmlrpc_errno() * @see xmlrpc_error_msg() */ function xmlrpc_example_client_add_submit($form, &$form_state) { // First define the endpoint of the XML-RPC service, in this case is our // own server. $server = url($GLOBALS['base_url'] . '/xmlrpc.php', array('external' => TRUE)); // Then we should define the method to call. xmlrpc() requires that all the // information related to the called method is passed as an array in the form // of 'method_name' => arguments_array $options = array( 'xmlrpc_example.add' => array( (int) $form_state['values']['num1'], (int) $form_state['values']['num2'], ), ); // Make the xmlrpc request and process the results. $result = xmlrpc($server, $options); if ($result === FALSE) { drupal_set_message( t('Error return from xmlrpc(): Error: @errno, Message: @message', array('@errno' => xmlrpc_errno(), '@message' => xmlrpc_error_msg())), 'error' ); } else { drupal_set_message( t('The XML-RPC server returned this response: @response', array('@response' => print_r($result, TRUE))) ); } } /** * Submit: query the XML-RPC endpoint for the method xmlrpc_example.subtract * and report the result as a Drupal message. * * @param $form * @param $form_state * * @see xmlrpc() * @see xmlrpc_errno() * @see xmlrpc_error_msg() * @see xmlrpc_example_client_add_submit() */ function xmlrpc_example_client_subtract_submit($form, &$form_state) { $server = url($GLOBALS['base_url'] . '/xmlrpc.php', array('external' => TRUE)); $options = array( 'xmlrpc_example.subtract' => array( (int) $form_state['values']['num1'], (int) $form_state['values']['num2'], ), ); // Make the xmlrpc request and process the results. $result = xmlrpc($server, $options); if ($result === FALSE) { drupal_set_message( t('Error return from xmlrpc(): Error: @errno, Message: @message', array('@errno' => xmlrpc_errno(), '@message' => xmlrpc_error_msg())), 'error' ); } else { drupal_set_message( t('The XML-RPC server returned this response: @response', array('@response' => print_r($result, TRUE))) ); } } /** * Submit a multicall request: query the XML-RPC endpoint for the methods * xmlrpc_example.add and xmlrpc_example.subtract and report the result as a * Drupal message. Drupal's XML-RPC client builds the system.multicall request * automatically when there is more than one method to call. * * @param $form * @param $form_state * * @see xmlrpc() * @see xmlrpc_errno() * @see xmlrpc_error_msg() * @see xmlrpc_example_client_multicall_submit() */ function xmlrpc_example_client_multicall_submit($form, &$form_state) { $server = url($GLOBALS['base_url'] . '/xmlrpc.php', array('external' => TRUE)); /* * Drupal's built-in xmlrpc server supports the system.multicall method. * * To make a multicall request, the main invoked method should be the * function 'system.multicall', and the arguments to make this call must be * defined as an array of single method calls, being the array keys the * service methods to be called, and the array elements the method arguments. * * See the code below this comment as example. */ // Build an array of several calls, Drupal's xmlrpc built-in support will // construct the correct system.multicall request for the server. $options = array( 'xmlrpc_example.add' => array( (int) $form_state['values']['num1'], (int) $form_state['values']['num2'], ), 'xmlrpc_example.subtract' => array( (int) $form_state['values']['num1'], (int) $form_state['values']['num2'], ), ); // Make the xmlrpc request and process the results. $result = xmlrpc($server, $options); if ($result === FALSE) { drupal_set_message( t('Error return from xmlrpc(): Error: @errno, Message: @message', array('@errno' => xmlrpc_errno(), '@message' => xmlrpc_error_msg())) ); } else { drupal_set_message( t('The XML-RPC server returned this response:

@response

', array('@response' => print_r($result, TRUE))) ); } } // The client part of the module ends here. // The alteration part of the module starts here. hook_xmlrpc_alter() is // useful when you want to extend, limit or alter methods defined by other // modules. This part is not required to have an XML-RPC server or client // working, but is useful to understand what can we do using current xmlrpc // API provided by drupal. // // This code can be defined in other module to alter the methods exposed by // this xmlrpc demonstration server, or can be used to alter methods defined // by other modules implementing hook_xmlrpc() // // As with the rest of the example module, an user interface is not required to // make use of this hook. A configuration form is included to enable/disable // this functionality, but this part is optional if you want to implement // hook_xmlrpc_alter() // This is the XML-RPC code for the alteration part. It will check if an option // to enable the functionality is enabled and then alter it. We alter the // 'xmlrpc_example.add' and 'xmlrpc_example.subtract' methods, changing the // associated callback with custom functions. The modified methods (with // new callbacks associated) will perform the addition or subtraction of the // integer inputs, but will never check for limits nor return errors. /** * Implements hook_xmlrpc_alter(). * * Check to see if xmlrpc_example.add and xmlrpc_example.subtract methods are * defined and replace their callbacks with custom code. * * @see hook_xmlrpc_alter() */ function xmlrpc_example_xmlrpc_alter(&$methods) { // Only perform alterations if instructed to do so. if (!variable_get('xmlrpc_example_alter_enabled', 0)) { return; } // Loop all defined methods (other modules may have include additional methods) foreach ($methods as $index => $method) { // First element in the method array is the method name. if ($method[0] == 'xmlrpc_example.add') { // Replace current callback with custom callback (second argument of the array) $methods[$index][1] = '_xmlrpc_example_alter_add'; } // Do the same for the substraction method. if ($method[0] == 'xmlrpc_example.subtract') { $methods[$index][1] = '_xmlrpc_example_alter_subtract'; } } } // Now we define the custom callbacks replacing the original defined by the // altered methods: xmlrpc_example.add and _xmlrpc_example.subtract . These // new callbacks will not check if the result of the operation is within the // limits defined by the server and will always return the value of the operation. /** * Sum the two arguments without limit checking. * * This is the replacement callback for the xmlrpc_example.add xmlrpc method. * * @param $num1 * @param $num2 * @return * The sum of the arguments */ function _xmlrpc_example_alter_add($num1, $num2) { return $num1 + $num2; } /** * Return the difference of the two arguments without limit checking. * * This is the replacement callback for the xmlrpc_example.subtract xmlrpc method. * * @param numeric $num1 * @param numeric $num2 * @return * The difference of the two arguments */ function _xmlrpc_example_alter_subtract($num1, $num2) { return $num1 - $num2; } // Our implementation of hook_xmlrpc_alter will work only if a system variable // is set to true, and we need a configuration form to enable/disable this // 'feature'. This is the user interface to enable or disable the hook_xmlrpc_alter // operations. /** * Present a form to enable or disable the code implemented in hook_xmlrpc_alter. */ function xmlrpc_example_alter_form() { $form = array(); $form['explanation'] = array( '#markup' => '', ); $form['xmlrpc_example_alter_enabled'] = array( '#type' => 'checkbox', '#title' => t('Overide current xmlrpc_example.add and xmlrpc_example.subtraction methods'), '#description' => t('If this checkbox is enabled, the default methods will be replaced with custom methods that ignore the XML-RPC server maximum and minimum restrictions.'), '#default_value' => variable_get('xmlrpc_example_alter_enabled', 0), ); $form['info'] = array( '#markup' => '', ); return system_settings_form($form); } // The alteration part of the module ends here.