Index: xmlrpc_example.info =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/examples/xmlrpc_example/xmlrpc_example.info,v retrieving revision 1.6 diff -u -r1.6 xmlrpc_example.info --- xmlrpc_example/xmlrpc_example.info 11 Aug 2010 23:16:28 -0000 1.6 +++ xmlrpc_example/xmlrpc_example.info 20 Sep 2010 01:11:12 -0000 @@ -1,8 +1,9 @@ ; $Id: xmlrpc_example.info,v 1.6 2010/08/11 23:16:28 rfay Exp $ name = XMLRPC example -description = This is an example of how to implement XML-RPC callbacks by implementing a validation suite. +description = This is an example of how to implement client and server communications using XML-RPC. package = Example modules core = 7.x +files[] = xmlrpc_example.install files[] = xmlrpc_example.module files[] = xmlrpc_example.test Index: xmlrpc_example.module =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/examples/xmlrpc_example/xmlrpc_example.module,v retrieving revision 1.4 diff -u -r1.4 xmlrpc_example.module --- xmlrpc_example/xmlrpc_example.module 27 Aug 2010 10:37:15 -0000 1.4 +++ xmlrpc_example/xmlrpc_example.module 20 Sep 2010 00:55:51 -0000 @@ -3,14 +3,15 @@ /** * @file - * This is an example of how to implement XML-RPC callbacks by registering - * an XMLRPC server function and then calling it with the xmlrpc() function. + * This is an example of how to implement and XML-RPC server by registering + * callbacks to specific methods and how to make xmlrpc calls using the builtin + * xmlrpc() factory provided by Drupal. * * For experimentation you may be interested in the - * @link http://drupal.org/project/xmlrpctester XMLRPC Tester module @endlink. + * @link http://drupal.org/project/xmlrpctester XML-RPC Tester module @endlink. * * Note that the @link http://drupal.org/project/services Services module @endlink - * is probably the more common way to do XMLRPC at this time. + * is probably the more common way to do XML-RPC at this time. * * @see hook_xmlrpc() * @see xmlrpc() @@ -18,97 +19,241 @@ * @see xmlrpc_error_msg() */ -// This is the server part of the module, implementing a silly -// little xmlrpc server. +// This is the common part of the module, implementing all the code required +// for the client and the server part (most of this code is UI related). The +// menu definition is the only part shared in this implementation. + +/** + * Implements hook_menu(). + * Register all the demonstration forms. + */ +function xmlrpc_example_menu() { + // This is the server configuration form menu entry. This form can be used to + // configure the settings of the exposed services. An XML-RPC server does not + // require a configuration form, and has been included here as an example. + $items['examples/xmlrpc_server'] = array( + 'title' => 'XML-RPC Server configuration', + 'description' => 'Server configuration form', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('xmlrpc_example_server_form'), + 'access callback' => TRUE, + 'weight' => 0, + ); + // This is the client form menu entry. This form is used to allow user + // interaction with the services, but again, user interface is not required + // to create an XML-RPC client with Drupal. + $items['examples/xmlrpc_client'] = array( + 'title' => 'XML-RPC Client form', + 'description' => 'Demonstrates client side XML-RPC calls with Drupal', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('xmlrpc_example_client_form'), + 'access callback' => TRUE, + 'weight' => 1, + ); + // This part is completely optional. It will allow the modification of services + // defined by this or other modules. This configuration form is used to + // enable the hook_xmlrpc_alter API and alter current existing services + $items['examples/xmlrpc_alter'] = array( + 'title' => 'XMLRPC Alterations', + 'description' => 'Demonstrates how to alter defined XML-RPC services', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('xmlrpc_example_alter_form'), + 'access callback' => TRUE, + 'weight' => 2, + ); + return $items; +} + + +// This is the server part of the module, implementing a simple and little +// server with just two simple services. The server is divided in two +// different parts: the xml-rpc implementation (required) and a graphical user +// interface (optional) to configure some settings in the server side. +// +// The XMLRPC server will define two different services: +// +// - sub: perform the subtraction of two numbers. The minimum and maximum values +// returned by the server can be configured in the server configuration form. +// - add: perform the addition of two numbers. The minimum and maximum values +// returned by the server can be configured in the server configuration form. +// +// If the result value for the operation is over the maximum limit, a custom error +// number 10001 is returned. This is an arbitrary number and could be any number. +// If the result value for the operation is below the minimum limit, a custom error +// number 10002 is returned. Again, this value is arbitrary and could be any other +// number. Client applications must know the meaning of the error numbers returned +// by the server. + + +// The following code is the XML-RPC implmentation of the server part. The fisrt +// step is to define the methods. This methods should be associated to callbacks +// that will be defined later. + /** * Implements hook_xmlrpc(). * - * Provides Drupal with an array to map XML-RPC callbacks to the - * functions implemented by this module. + * Provides Drupal with an array to map XML-RPC callbacks to existing functions. + * This functions may be defined in other modules. The example implementation + * defines specific functions for the example services. + * * @see hook_xmlrpc() */ function xmlrpc_example_xmlrpc() { $methods[] = array( + // First argument is the method name. 'xmlrpc_example.add', - '_xmlrpc_example_add', + // Callback to execute when this method is requested. + '_xmlrpc_example_server_add', + // An array defines the types of output and input values for this method. array( - 'int', // the type of the return value - 'int', // the type of the first argument - 'int', // the type of the second argument + // The first value is the return type, an integer in this case. + 'int', + // First operand is an integer. + 'int', + // Second operatnd is an integer. + 'int', ), - t('Returns the sum of the two arguments.') + // Include a little description that is shown when XML-RCP server is + // requested for the implemented methods list. + t('Returns the sum of the two arguments.') // Method description ); + // The subtract method is similiar to the addition, only the method name, + // callback and description are different. $methods[] = array( 'xmlrpc_example.subtract', - '_xmlrpc_example_subtract', + '_xmlrpc_example_server_subtract', array('int', 'int', 'int'), t('Return difference of the two arguments.') ); return $methods; } + +// The following code for the server is optional if the callbacks already exist. +// A server may implement methods associated to callbacks like node_load(), +// variable_get() or any other existing function (php functions as well). +// +// If the callbacks callbacks associated to the methods don't exist they must be +// created. This implementation requires two specific callbacks: +// - _xmlrpc_example_server_add +// - _xmlrpc_example_server_subtract +// + /** - * Sum the two arguments. + * This is the callback for the xmlrpc_example.add method. + * + * Sum the two arguments and return value or an error if the result is out of the + * configured limits. + * * @param $num1 * @param $num2 * @return - * The sum of the arguments. + * The sum of the arguments, or error if it is not in server defined bounds. * * @see xmlrpc_error() */ -function _xmlrpc_example_add($num1, $num2) { +function _xmlrpc_example_server_add($num1, $num2) { $sum = $num1 + $num2; - if ($sum <= 10) { - return $sum; + // If result is not within maximum and minimum limits, return corresponding error + if ($sum > variable_get('xmlrpc_example_server_max', 10)) { + return xmlrpc_error(10001, t("Result is over the upper limit defined by the server.")); } - else { - return xmlrpc_error(10001, t("Sorry, I only have ten fingers and can't count past that.")); + if ($sum < variable_get('xmlrpc_example_server_min', 0)) { + return xmlrpc_error(10002, t("Result is under the lower limit defined by the server.")); } + // Otherwise return the result. + return $sum; } /** - * Return the difference of the two arguments. + * This is the callback for the xmlrpc_example.subtract xmlrpc method. + * + * Return the difference of the two arguments, or an error if the result is out of the + * configured limits.. + * + * * @param numeric $num1 * @param numeric $num2 * @return - * The difference of the two arguments. + * The difference of the two arguments, or error if it is not in server defined bounds. * * @see xmlrpc_error() */ -function _xmlrpc_example_subtract($num1, $num2) { - $difference = $num1 - $num2; - if ($difference >= 0) { - return $difference; +function _xmlrpc_example_server_subtract($num1, $num2) { + $diference = $num1 - $num2; + // If result is not within maximum and minimum limits, return corresponding error + if ($diference > variable_get('xmlrpc_example_server_max', 10)) { + return xmlrpc_error(10001, t("Result is over the upper limit defined by the server.")); } - else { - return xmlrpc_error(10002, t("I have not learned to do negative numbers yet.")); + if ($diference < variable_get('xmlrpc_example_server_min', 0)) { + return xmlrpc_error(10002, t("Result is under the lower limit defined by the server.")); } + // Otherwise return the result. + return $diference; } +// + + +// User interface for the XML-RPC Server part. +// A server does not require an interface at all. In this implementation we +// use a server configuration form to set the limits available for the addition +// and subtraction operations. -// Now begins the client/UI portion of the module. /** - * Implements hook_menu for a simple explanation page. + * Present a form to configure the service options. In this case the maximum + * and minimum values for any of the operations (add or subtraction). */ -function xmlrpc_example_menu() { - $items['examples/xmlrpc_example'] = array( - 'title' => 'XMLRPC example', - 'description' => 'Demonstrates client and server side XMLRPC with Drupal', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('xmlrpc_example_demo_form'), - 'access callback' => TRUE, +function xmlrpc_example_server_form() { + $form = array(); + $form['explanation'] = array( + '#markup' => "
" . t("This is the XML-RPC server configuration page.
Here you may define the maximum and minimum values for the add or subtraction exposed services.
") . "
", ); - return $items; + $form['xmlrpc_example_server_min'] = array( + '#type' => 'textfield', + '#title' => t("Enter the minimum value returned by the subtraction or addition methods"), + '#description' => t("if the result of the operation is lower than this value, a custom XML-RPC error will be returned: 10002."), + '#default_value' => variable_get('xmlrpc_example_server_min', 0), + '#size' => 5, + '#required' => TRUE, + ); + $form['xmlrpc_example_server_max'] = array( + '#type' => 'textfield', + '#title' => t("Enter the maximum value returned by sub or add methods"), + '#description' => t("if the result of the operation is bigger than this value, a custom XML-RPC error will be returned: 10001."), + '#default_value' => variable_get('xmlrpc_example_server_max', 10), + '#size' => 5, + '#required' => TRUE, + ); + 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 xmlrcp_example.add or xmlrpc_example.subtract methods on this host. +// Please notice that having a user interface to query an XML-RPC service is not +// required. A method can be requested to a server using the xmlrcp() function +// directly. We have included an user interface to make the testing eassier. + +// The client user interface part of the module starts here. + /** - * Present a form that uses xmlrpc to add or subtract. + * Present a form to get two arguments, and make a call to an XML-RCP server using + * these arguments as input, showing the result in a message. */ -function xmlrpc_example_demo_form() { +function xmlrpc_example_client_form() { $form = array(); $form['explanation'] = array( - '#markup' => "
" . t("The XMLRPC example demonstrates the use of the XMLRPC client and server in Drupal.
It uses the xmlrpc() function to act as a client, calling itself as a server to demonstrate both sides of the operation.") . "
", + '#markup' => "
" . t("This example demonstrates how to make XML-RPC calls with Drupal.
It uses the xmlrpc() function to act as a client, calling itself for some defined methods.
An xmlrpc error will result if the result is out of bounds defined by the server. These error numbers are defined by the server.
") . "
", ); + // 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"), @@ -119,26 +264,28 @@ $form['num2'] = array( '#type' => 'textfield', '#title' => t("Enter a second integer"), - '#description' => t("An xmlrpc error will result if they sum to more than 10 or the difference is less than 0."), '#default_value' => 2, '#size' => 5, '#required' => TRUE, ); + // Include two buttons, each of them calling a different method. $form['add'] = array( '#type' => 'submit', '#value' => t("Add the integers"), - '#submit' => array('xmlrpc_example_add_submit'), + '#submit' => array('xmlrpc_example_client_add_submit'), ); $form['subtract'] = array( '#type' => 'submit', '#value' => t("Subtract the integers"), - '#submit' => array('xmlrpc_example_subtract_submit'), + '#submit' => array('xmlrpc_example_client_subtract_submit'), ); return $form; } /** - * Submit: Call the xmlrpc method to add and report the result. + * 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 * @@ -146,42 +293,171 @@ * @see xmlrpc_errno() * @see xmlrpc_error_msg() */ -function xmlrpc_example_add_submit($form, &$form_state) { - $server = url($GLOBALS['base_url'] . "/xmlrpc.php"); - $result = xmlrpc($server, array('xmlrpc_example.add' => array( - (int) $form_state['values']['num1'], - (int) $form_state['values']['num2'], - ))); - +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 = $GLOBALS['base_url'] . "/xmlrpc.php"; + // 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()))); } else { - drupal_set_message(t("The XMLRPC server returned this response: @response", array('@response' => print_r($result, TRUE)))); + drupal_set_message(t("The XML-RPC server returned this response: @response", array('@response' => print_r($result, TRUE)))); } } /** - * Submit for subtraction: Call the xmlrpc method and report the result. + * 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_subtract_submit($form, &$form_state) { - $server = url($GLOBALS['base_url'] . "/xmlrpc.php"); - $result = xmlrpc($server, array('xmlrpc_example.subtract' => array( - (int) $form_state['values']['num1'], - (int) $form_state['values']['num2'], - ))); - +function xmlrpc_example_client_subtract_submit($form, &$form_state) { + $server = $GLOBALS['base_url'] . "/xmlrpc.php"; + $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()))); } else { - drupal_set_message(t("The XMLRPC server returned this response: @response", array('@response' => print_r($result, TRUE)))); + 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. + + + + + + +// Here starts the alteration part of the module. The 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 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 enable and then alter the 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(). + * + * Look 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 implmementation 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' => "
" . t("This is a configuration form to enable the alteration of XML-RPC methods using hook_xmlrpc_alter.
HOOK_XMLRPC_ALTER can be used to alter the current defined methods by other modules. In this case as demonstration, we will overide current add and subtraction methods with others not being limited. Remember that this hook is optional and is not required to create XMLRPC services.
") . "
", + ); + $form['xmlrpc_example_alter_enabled'] = array( + '#type' => 'checkbox', + '#title' => t("Overide current xmlrpc_example.add and xmlrpc_example.subtraction methods"), + '#description' => t("Enabling this checkbox, the default methods will be replaced with custom methods not considering the XML-RPC server limit restrictions."), + '#default_value' => variable_get('xmlrpc_example_alter_enabled', 0), + ); + return system_settings_form($form); +} + +// The alteration part of the module ends here. Index: xmlrpc_example.test =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/examples/xmlrpc_example/xmlrpc_example.test,v retrieving revision 1.2 diff -u -r1.2 xmlrpc_example.test --- xmlrpc_example/xmlrpc_example.test 27 Aug 2010 10:37:15 -0000 1.2 +++ xmlrpc_example/xmlrpc_example.test 20 Sep 2010 01:08:13 -0000 @@ -3,7 +3,7 @@ /** * @file - * Test case for the xmlrpc example module. + * Test case for the XML-RPC example module. * * This file contains the test cases to check if module is performing as * expected. @@ -32,7 +32,7 @@ } /** - * Perform several calls the xmlrpc inteface to test the services. + * Perform several calls to the XML-RPC inteface to test the services. */ function testXmlrpcExampleBasic() { // Unit test functionality. @@ -42,13 +42,73 @@ $result = xmlrpc($this->xmlrpc_url, array('xmlrpc_example.subtract' => array(4, 3))); $this->assertEqual($result, 1, t('Successfully subtracted 4-3 = 1')); + // Verify default limits + $result = xmlrpc($this->xmlrpc_url, array('xmlrpc_example.subtract' => array(3, 4))); + $this->assertEqual(xmlrpc_errno(), 10002, t('Results below minimum return custom error: 10002')); + + $result = xmlrpc($this->xmlrpc_url, array('xmlrpc_example.add' => array(7, 4))); + $this->assertEqual(xmlrpc_errno(), 10001, t('Results beyond maximum return custom error: 10001')); + } + + + /** + * Perform several calls using XML-RPC web client. + */ + function testXmlrpcExampleClient() { // Now test the UI. $edit = array('num1' => 3, 'num2' => 5); - $this->drupalPost('examples/xmlrpc_example', $edit, t('Add the integers')); - $this->assertText(t("The XMLRPC server returned this response: @num", array('@num' => 8))); + $this->drupalPost('examples/xmlrpc_client', $edit, t('Add the integers')); + $this->assertText(t("The XML-RPC server returned this response: @num", array('@num' => 8))); $edit = array('num1' => 8, 'num2' => 3); - $this->drupalPost('examples/xmlrpc_example', $edit, t('Subtract the integers')); - $this->assertText(t("The XMLRPC server returned this response: @num", array('@num' => 5))); + $this->drupalPost('examples/xmlrpc_client', $edit, t('Subtract the integers')); + $this->assertText(t("The XML-RPC server returned this response: @num", array('@num' => 5))); } + + /** + * Perform several XML-RPC requests with different server settings. + */ + function testXmlrpcExampleServer() { + // Set different minimum and maxmimum valuesI. + $options = array('xmlrpc_example_server_min' => 3, 'xmlrpc_example_server_max' => 7); + $this->drupalPost('examples/xmlrpc_server', $options, t('Save configuration')); + $this->assertText(t("The configuration options have been saved"), t("Results limited to >= 3 and <= 7")); + + $edit = array('num1' => 8, 'num2' => 3); + $this->drupalPost('examples/xmlrpc_client', $edit, t('Subtract the integers')); + $this->assertText(t("The XML-RPC server returned this response: @num", array('@num' => 5))); + + $result = xmlrpc($this->xmlrpc_url, array('xmlrpc_example.add' => array(3, 4))); + $this->assertEqual($result, 7, t('Successfully added 3+4 = 7')); + + $result = xmlrpc($this->xmlrpc_url, array('xmlrpc_example.subtract' => array(4, 3))); + $this->assertEqual(xmlrpc_errno(), 10002, t('subtracting 4-3 = 1 returns custom error: 10002')); + + $result = xmlrpc($this->xmlrpc_url, array('xmlrpc_example.add' => array(7, 4))); + $this->assertEqual(xmlrpc_errno(), 10001, t('Adding 7 + 4 = 11 returns custom error: 10001')); + } + + /** + * Perform several XML-RPC requests altering the server behaviour with + * hook_xmlrpc_alter API + */ + function testXmlrpcExampleAlter() { + // Enable XML-RPC service altering functionality. + $options = array('xmlrpc_example_alter_enabled' => 1); + $this->drupalPost('examples/xmlrpc_alter', $options, t('Save configuration')); + $this->assertText(t("The configuration options have been saved"), t("Results are not limited due to methods alteration")); + + // After altering the functionality, the add and subtract methods have no + // limits and should not return any error. + $edit = array('num1' => 80, 'num2' => 3); + $this->drupalPost('examples/xmlrpc_client', $edit, t('Subtract the integers')); + $this->assertText(t("The XML-RPC server returned this response: @num", array('@num' => 77))); + + $result = xmlrpc($this->xmlrpc_url, array('xmlrpc_example.add' => array(30, 4))); + $this->assertEqual($result, 34, t('Successfully added 30+4 = 34')); + + $result = xmlrpc($this->xmlrpc_url, array('xmlrpc_example.subtract' => array(4, 30))); + $this->assertEqual($result, -26, t('Successfully substracted 4-30 = -26')); + } + } --- xmlrpc_example/xmlrpc_example.install +++ xmlrpc_example/xmlrpc_example.install @@ -0,0 +1,23 @@ +