Add 'wsclient_test/' from commit '3db89d98'

<?php

/**

 * @file

 * Utility functions for running the tester UI for web services.

 */

/**

 * FAPI form used to display the options and the results of calling a web

 * service.

 */

function wsclient_tester_operation_test($form, $form_state, $service, $operation) {

  $strings = array(

    '!service_label' => $service->label,

    '!operation_label' => $operation['label'],

  );

  drupal_set_title(t("Testing Web Service : !service_label : !operation_label()", $strings));

  $form  = array();

  $form['uri'] = array(

    '#title' => 'Service URI',

    '#type' => 'textfield',

    '#disabled' => TRUE,

    '#value' => $service->url,

  );

  $form['parameters'] = array(

    '#title' => 'parameters',

    '#type' => 'container',

    '#tree' => TRUE,

    '#value' => t("Enter the parameters to the !operation_label service here. It's up to you to get the data types right. No type validation is done at this end, as it's a debugger to let you throw various errors at the web service and see how it responds.", $strings),

  );

  // Deal with complex types.

  // Each complex type may require its own mini-form for data entry,

  // and these may be nested.

  $datatypes = $service->datatypes;

  foreach ($operation['parameter'] as $param => $info) {

    $form['parameters'][$param] = wsclient_tester_data_entry_form($param, $info['type'], $form_values['parameters'], $datatypes);

  }

  $form['execute'] = array(

    '#type' => 'submit',

    '#value' => 'Execute request',

    '#ajax' => array(

      'event' => 'click',

      'callback' => 'wsclient_tester_prepare_request_callback',

      'wrapper' => 'edit-transaction',

      'method' => 'replace',

      'effect' => 'fade',

    ),

  );

  // Set up result panes. Content for these usually gets filled in via ajax.

  $form['transaction'] = array(

    '#type' => 'fieldset',

    '#title' => 'Transaction',

    '#attributes' => array('id' => 'edit-transaction'),

  );

  $form['transaction']['request'] = array(

    '#type' => 'fieldset',

    '#title' => 'Request',

  );

  $form['transaction']['request']['header'] = array(

    '#markup' => 'Headers go here',

    '#prefix' => '<pre>',

    '#suffix' => '</pre>',

  );

  $form['transaction']['request']['packet'] = array(

    '#markup' => 'Packet goes here',

    '#prefix' => '<pre>',

    '#suffix' => '</pre>',

  );

  $form['transaction']['request']['data'] = array();

  $form['transaction']['response'] = array(

    '#type' => 'fieldset',

    '#title' => 'Response',

  );

  $form['transaction']['response']['header'] = array(

    '#markup' => 'ResponseHeaders go here',

    '#prefix' => '<pre>',

    '#suffix' => '</pre>',

  );

  $form['transaction']['response']['packet'] = array(

    '#markup' => 'ResponsePayload goes here',

    '#prefix' => '<pre>',

    '#suffix' => '</pre>',

  );

  $form['transaction']['response']['data'] = array();

  return $form;

}

/**

 * Callback for the test from 'prepare' button.

 */

function wsclient_tester_prepare_request_callback($form, $form_state) {

  $service = $form_state['build_info']['args'][0];

  $operation = $form_state['build_info']['args'][1];

  // Convert the form values into a data structure suitable for making the query.

  // Magic?

  // service::invoke will cast this array into the correct paramaterized objects

  // According to the $operation['parameter'] schema. Nifty.

  $args = $form_state['values']['parameters'];

  // The service will have an endpoint that will have a SOAPClient.

  // Settings on the service->options may be passed to the SOAPClient.

  // @see WSClientSOAPEndpoint::client()

  // @see http://www.php.net/manual/en/soapclient.soapclient.php

  $service->settings['options']['trace'] = TRUE;

  // Ready to actually invoke the call

  $timer_before = microtime();

  try {

    $response = $service->invoke($operation['name'], $args);

    $return = print_r($response, 1);

  }

  catch (Exception $e) {

    $return = $e->getMessage();

  }

  $timer_duration = $timer_before - microtime();

  $element = $form['transaction'];

  /*

   dpm($service);

   dpm($service->endpoint());

   dpm($service->endpoint()->client());

   dpm($service->endpoint()->client()->__getLastRequest());

   dpm($response);

   */

  // Place the trace data into the display.

  $element['request']['header']['#markup'] = $service->endpoint()->client()->__getLastRequestHeaders();

  $element['request']['packet']['#markup'] = htmlspecialchars(wsclient_tester_prettify_xml($service->endpoint()->client()->__getLastRequest()));

  if (module_exists('devel')) {

    $element['request']['data']['#markup'] = kpr($args, 1);

  }

  $element['response']['header']['#markup'] = $service->endpoint()->client()->__getLastResponseHeaders();

  $element['response']['packet']['#markup'] = htmlspecialchars(wsclient_tester_prettify_xml($service->endpoint()->client()->__getLastResponse()));

  if (module_exists('devel')) {

    $element['response']['data']['#markup'] = kpr($response, 1);

  }

  $element['#value'] = t("Ran at %time, took %duration to execute", array(

    '%time' => time(),

    '%duration' => $timer_duration,

  ));

  return $element;

}

/**

 * Indent and format XML for display.

 */

function wsclient_tester_prettify_xml($xml) {

  $dom = new DOMDocument;

  $dom->preserveWhiteSpace = FALSE;

  $dom->loadXML($xml);

  $dom->formatOutput = TRUE;

  return $dom->saveXml();

}

/**

 * A mini form element representing the given data type.

 * textfield for most things, but nested fieldsets for complex types.

 *

 * This recurses through complex types until it hits core types.

 *

 * @return a FAPI form fragment.

 */

function wsclient_tester_data_entry_form($label, $type, $data, $datatypes) {

  if (isset($datatypes[$type])) {

    // Build a complex type.

    $datatype = $datatypes[$type];

    $element = array(

      '#type' => 'fieldset',

      '#title' => check_plain("$label ({$datatype['label']})"),

      '#collapsible' => TRUE,

    );

    foreach ($datatype['property info'] as $field_id => $field_info) {

      // Recurse and get each bit to render its own input element.

      $element[$field_id] = wsclient_tester_data_entry_form($field_id, $field_info['type'], $data[$field_id], $datatypes);

    }

    return $element;

  }

  elseif (preg_match('/^list\<(.*)\>$/', $type, $matches)) {

    // Strange notation, type="list<MyType>" means a list of those things.

    // @see wsclient_soap_type_mapper()

    // This becomes a numerically indexed array.

    // Present it in the form as a nested list.

    $actual_type = $matches[1];

    $element = array(

      '#type' => 'fieldset',

      '#title' => t("List of %label (%type)", array('%label' => $label, '%type' => $type)),

      '#collapsible' => TRUE,

    );

    for ($field_id = 0; $field_id < 3; $field_id++) {

      // Recurse and get each bit to render its own input element

      $element[$field_id] = wsclient_tester_data_entry_form($field_id, $actual_type, $data[$field_id], $datatypes);

      $element[$field_id]['#collapsed'] = TRUE;

    }

    return $element;

  }

  else {

    // A textfield will normally do for primitives.

    return array(

      '#type' => 'textfield',

      '#title' => t("%label (%type)", array('%label' => $label, '%type' => $type)),

      '#default_value' => $data,

      '#size' => 20,

    );

  }

}

name = "Web service client Tester"

description = "Extends the webservice client UI with a form for realtime web service debugging."

core = "7.x"

package = Services

dependencies[] = "wsclient_ui"

 No newline at end of file

<?php

/**

 * @file

 * Provides a UI for testing known services.

 *

 * Use this to see what is happening under the hood when you use wsclient to

 * talk to a remote service.

 *

 * Visiting the web service client management page

 * (/admin/config/services/wsclient/{service})

 * you will find a 'Test' button added to the available 'Operations'.

 * Using that will present a webform exposing fields derived from the WSDL

 * and somewhat emulating the data structure that is expected to make up a

 * service request.

 * Validation is not done at that stage, so it's up to you to enter the correct

 * basic data types (e.g., date in a date field, int in an integer field)

 *

 * Executing that request will then display the request that is being made

 * (in raw form with headers and payload) and the response that came back,

 * also displaying the response headers and response data or message if any.

 *

 * If you have devel.module enabled, a rendered dump of the data structure

 * (PHP objects constructed by the wsclient) will also be displayed.

 */

/**

 * Add our 'test' operation to the services overview form.

 * @see wsclient_service_form()

 *

 * Implements hook_form_FORM_ID_alter().

 */

function wsclient_tester_form_wsclient_service_form_alter(&$form, &$form_state) {

  $service = $form_state['build_info']['args'][0];

  foreach ($form['operations']['#rows'] as $operation => $row) {

    $name = $row[0]['data']['#name'];

    $form['operations']['#rows'][$operation][] = l(t('Test'), WSCLIENT_UI_PATH . '/manage/' . $service->name . '/operation/' . $name . '/test');

  }

  $form['operations']['#header'][1]['colspan'] += 1;

}

/**

 * Publish our testing UI and ajax callbacks.

 *

 * hook_menu()

 */

function wsclient_tester_menu() {

  // wsclient ui is a little clever with its paths ... Copy it in case it changes.

  $id_count = count(explode('/', WSCLIENT_UI_PATH)) + 1;

  $op_count = $id_count + 2;

  $items[WSCLIENT_UI_PATH . '/manage/%wsclient_service/operation/%wsclient_ui_operation/test'] = array(

    'title' => 'test operation',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('wsclient_tester_operation_test', $id_count, $op_count),

    'load arguments' => array($id_count),

    'access arguments' => array('administer web services'),

    'file' => 'wsclient_tester.inc',

    'file path' => drupal_get_path('module', 'wsclient_tester'),

  );

  return $items;

}