modules/netforum/netforum.module

<?php
// $Id: netforum.module,v 1.12 2009/07/11 13:43:51 jamesmichaelhill Exp $

/**
 * @file
 * The netFORUM xWeb Secure module
 *
 *  Provides a foundation for issuing requests and reading responses from xWeb
 * 
 */


/** 
 * Implementation of hook_menu()
 */
function netforum_menu($may_cache) {
  $items = array();
  
  if ($may_cache) {
    $items[] = array(
      'path' => 'admin/settings/netforum',
      'title' => t('Netforum'),
      'description' => t('Set the connection characteristics for the netFORUM database'),
      'callback' => 'system_admin_menu_block_page',
      'access' => user_access('administer site configuration'),
    );
    $items[] = array(
      'path' => 'admin/settings/netforum/connection',
      'title' => t('xWeb settings'),
      'description' => t('Set the connection characteristics for the netFORUM database'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('netforum_admin_settings'),
      'access' => user_access('administer site configuration'),
    );
    $items[] = array(
      'path' => 'admin/settings/netforum/xwebtest',
      'title' => t('xWeb testing'),
      'description' => t('Test xWeb queries to the database'),
      'callback' => 'netforum_test_page',
      'access' => user_access('administer site configuration'),
      'weight' => 5,
    );
    
    $items[] = array(
      'path' => 'admin/settings/netforum/object-info',
      'title' => t('Object information'),
      'description' => t('View, fetch and delete cached object information'),
      'callback' => 'netforum_objects_page',
      'access' => user_access('administer site configuration'),
      'weight' => 6,
    );
    
    $items[] = array('path' => 'admin/settings/netforum/object-names-refresh',
      'title' => t('Refresh object names'),
      'callback' => 'netforum_objects_refresh_names',
      'description' => t('Contact netFORUM and re-populate the list of available objects'),
      'access' => user_access('administer site configuration'),
      'weight' => 6,
    ); 
    
    $items[] = array('path' => 'admin/settings/netforum/object-autocomplete',
      'title' => t('Netforum object name autocomplete'),
      'callback' => 'netforum_objects_autocomplete',
      'type' => MENU_CALLBACK,
      'access' => user_access('administer site configuration'),
    );
    
    $items[] = array('path' => 'admin/settings/netforum/xwebtest/params_for',
      'title' => 'xWeb testing - parameters as JSON',
      'callback' => 'netforum_test_page_params',
      'access' => user_access('administer site configuration'),
      'type' => MENU_CALLBACK,
    ); 
  }
  else{  
    
  }
  return $items;
}

/**
 * Looks for a function name and returns the parameters as JSON.  Used via AJAX
 *
 * ...
 * @ingroup pages
 */
function netforum_test_page_params($fname) {
  drupal_set_header('Content-Type: text/javascript; charset=utf-8');
  print drupal_to_js(netforum_xweb_function_struct_parameters($fname));
  exit;
}

/**
 * Provides a testing page for xWeb requests, useful for examining output
 *
 * ...
 * @ingroup pages
 * @see netforum_test_form()
 */
function netforum_test_page() {
  $output = t('Test a request here by selecting the function from the drop down list and filling in the parameters below.  The result of the request and debugging information will be shown below.');


  //first, get the functions as an array with function names as keys
  //and an array of function parameters as the value
  $xweb_functions = array();
  $function_list = _netforum_xweb_soap_functions();
  foreach (array_keys($function_list) as $function_name) {
    $xweb_functions[$function_name] = netforum_xweb_function_parameters($function_name);
  }
  
  if (isset($_POST['netforum_request'])) {
    if (is_array($_POST['netforum_params'])) {
      $request_parameters = array_filter_recursive($_POST['netforum_params']);
    }
    else {
      $request_parameters = array();
    }
    
        
    $request_code = '';
    $request_code .= "\$arguments = ". var_export($request_parameters, TRUE) .";\n";
    $request_code .= "\$response = netforum_xweb_request('". $_POST['netforum_request'] ."', \$arguments); ";
    
    $response = netforum_xweb_request($_POST['netforum_request'], $request_parameters);
        
    $form_defaults = array();
    $form_defaults[$_POST['netforum_request']] = $request_parameters;
    drupal_set_html_head("<script type=\"text/javascript\">
        var form_defaults = ". drupal_to_js($form_defaults) .";
      </script>");
      
    //Overwrite the existing set of parameters (that did shallow inspection) with a deep inspection of the current function
    $xweb_functions[$_POST['netforum_request']] = netforum_xweb_function_struct_parameters($_POST['netforum_request']);

  }
  
  //Turn our array of functions and parameters to json for later use
  drupal_set_html_head("<script type=\"text/javascript\">
      var xweb_functions = ". drupal_to_js($xweb_functions) .";
    </script>");
  
  //this is the later use referenced above.  The js here will adjust the form fields 
  //and labels based on the selected function
  drupal_add_js(drupal_get_path('module', 'netforum') .'/jquery.netforum.js');
  drupal_add_js('misc/collapse.js');
  
  
  $output .= drupal_get_form('netforum_test_form', $response, $request_code);
  return $output;
}

/**
 * The form for the xWeb testing page
 *
 * ...
 * @ingroup forms
 * @see netforum_test_page()
 */
function netforum_test_form($response, $request_code = '') {
  
  $request_options = netforum_xweb_functions();
  if (count($request_options) == 0) {
    drupal_set_message("No netFORUM xWeb functions found, perhaps xWeb is currently unavailable?", 'error');
  }
  $request_log = '';
  $request_soap_log = '';
  
  $request_log = netforum_request_log();
  $request_soap_log = netforum_soap_log();
   
  $form['netforum_xweb_request'] = array(
    '#title' => 'xWeb Request',
    '#type' => 'fieldset',
    '#description' => 'Construct the xWeb request'
  );    
  
  $form['netforum_xweb_request']['netforum_request'] = array(
    '#type' => 'select',
    '#title' => t('netFORUM xWeb Function'),
    '#description' => t('The name of the function to call'),
    '#default_value' => $form_values['netforum_request'],
    '#options' => $request_options,
  );
  
  $form['netforum_xweb_request']['parameters'] = array(
    '#type' => 'fieldset',
    '#attributes' => array('id' => 'parameters'),
  );
  
  /*
   * Normally, there would be inputs for the function here, but
   * we're relying on some JS and AJAX to build the right form
   * for the right function
   */
  
  $form['netforum_xweb_request']['submit'] = array(
    '#type' => 'button',
    '#value' => 'submit',
    '#name' => 'clickbutton',
  );

 
  $form['netforum_xweb_results'] = array(
    '#title' => 'xWeb Results',
    '#type' => 'fieldset',
    '#description' => 'Response from xWeb'
  ); 
  
  $form['netforum_xweb_results']['code'] = array(
    '#title' => 'PHP Code',
    '#type' => 'item',
    '#description' => "<pre>". htmlspecialchars($request_code) ."</pre>" ,
  );
  
  $form['netforum_xweb_results']['response'] = array(
    '#title' => 'Response',
    '#type' => 'item',
    '#description' => "<pre>". htmlspecialchars(print_r($response, TRUE)) ."</pre>" ,
  );
  
  $form['netforum_xweb_results']['soap_log'] = array(
    '#title' => 'SOAP Log',
    '#type' => 'item',
    '#description' => "<pre>". htmlspecialchars($request_soap_log) ."</pre>" ,
  );
  
  $form['netforum_xweb_results']['request_log'] = array(
    '#title' => 'xWebSecureClient Class Log',
    '#type' => 'item',
    '#description' => "<pre>". htmlspecialchars($request_log) ."</pre>" ,
  );
    
  $form['#submit'] = array(
    'netforum_test_page' => array(),
  );
  
  $form['#redirect'] = FALSE;
  
  return $form;
}

/**
 * The Objects page provides a way to search for objects available for queries and view the columns
 *
 * ...
 * @ingroup pages
 * @see netforum_objects_form()
 */
function netforum_objects_page() {
  $output = t('Use this page to view columns and column details for netFORUM objects.  Each request clears the cache for that object and fetches the details from xWeb.  If the object is not found, try ') . l(t('refreshing the object names'), 'admin/settings/netforum/object-names-refresh') .'.';
  $object_details = array();
  $obj = new stdClass();
  $obj->obj_key = $obj->obj_defaultcolumns = $obj->obj_defaultorderby = $obj->obj_name = '';
  
  if (isset($_POST['netforum_object_name'])) {
    $name = trim($_POST['netforum_object_name']);
    $res = db_query("SELECT obj_key, obj_defaultcolumns, obj_defaultorderby, obj_name FROM {netforum_object_cache} WHERE obj_name = '%s' ", $name);
    if (db_num_rows($res) > 0) {
      $obj = db_fetch_object($res);
      db_query("UPDATE {netforum_object_cache} SET data = '' WHERE obj_name='%s' ", $name);
      $object_details = netforum_object_fields($name);
    }
    else {
      drupal_set_message(t('Object name not found in the cache, perhaps you need to refresh the object names?'), 'error');
    }
  }
  
  $output .= drupal_get_form('netforum_objects_form', $object_details, $obj);
  
  return $output;
}

/**
 * The form for the objects page
 *
 * ...
 * @ingroup forms
 * @see netforum_objects_page()
 */
function netforum_objects_form($object_details = array(), $obj) {

  $search_on = module_invoke_all('netforum_node_obj_search_on', $obj->obj_name);
  $order_by = module_invoke_all('netforum_node_obj_order_by', $obj->obj_name);
  
  if (count($search_on) == 0) {
    //If the default columns are * or empty, try setting it to the default order by
    if ( ! isset($obj->obj_defaultcolumns) || $obj->obj_defaultcolumns == "*" || trim($obj->obj_defaultcolumns) == '' ) {
      $search_on = $obj->obj_defaultorderby;
    }
    else {
      $search_on = $obj->obj_defaultcolumns;
    }
  }
  else{
    $search_on = implode(",", array_keys($search_on));
  }
  
  if (count($order_by) == 0) {
    $order_by = $obj->obj_defaultorderby;
  }
  else {
    $order_by = implode(",", $order_by);
  }

  $form['netforum_object_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Object Name'),
    '#size' => 50,
    '#autocomplete_path' => 'admin/settings/netforum/object-autocomplete',
  );
  
  $form['submit'] = array(
    '#type' => 'button',
    '#value' => 'Fetch / refresh object details',
    '#name' => 'clickbutton',
  );

 
  $form['netforum_object_details'] = array(
    '#title' => 'Object details',
    '#type' => 'fieldset',
    '#description' => 'Refreshed object details from xWeb'
  );    
  
  $form['netforum_object_details']['key'] = array(
    '#title' => 'Object Key',
    '#type' => 'item',
    '#description' => $obj->obj_key ,
  );
  
  $form['netforum_object_details']['searchcolumns'] = array(
    '#title' => 'Object Search Columns',
    '#type' => 'item',
    '#description' => $search_on,
  );
  
  $form['netforum_object_details']['orderby'] = array(
    '#title' => 'Object Order By',
    '#type' => 'item',
    '#description' => $order_by ,
  );
  
  $form['netforum_object_details']['keyfield'] = array(
    '#title' => 'Key Field',
    '#type' => 'item',
    '#description' => netforum_object_key_field($obj->obj_name),
  );
  
  $form['netforum_object_details']['response'] = array(
    '#title' => 'Object Fields',
    '#type' => 'item',
    '#description' => "<pre>". htmlspecialchars(print_r($object_details, TRUE)) ."</pre>" ,
  );
  
  return $form;
}


function netforum_objects_autocomplete($search="") {
  drupal_set_header('Content-Type: text/javascript; charset=utf-8');
  $obj_names = array();
  if ($search != "") {
    $results = db_query("SELECT obj_name FROM {netforum_object_cache} WHERE obj_name like '%s%%' OR obj_prefix like '%s%%' ORDER BY obj_name", $search, $search);
    while ($obj = db_fetch_object($results)) {
      $obj_names[$obj->obj_name] = check_plain($obj->obj_name);
    }
  }
  print drupal_to_js($obj_names);
  exit;
}

/**
 *  Technically a page, this will refresh the cached list of objects and redirect the user to
 *  the object info page
 *
 * ...
 * @ingroup pages
 */
function netforum_objects_refresh_names() {
  netforum_refresh_object_names();
  drupal_set_message(t('netFORUM object names refreshed'));
  drupal_goto('admin/settings/netforum/object-info');
}


/**
 * The settings form for netFORUM Secure
 *
 * @ingroup forms
 * @see netforum_admin_settings_validate
 */
function netforum_admin_settings() {

  $form['xWeb'] = array(
    '#title' => "xWeb connection",
    '#type' => 'fieldset',
  );

  $form['xWeb']['netforum_wsdl_url'] = array(
    '#type' => 'textfield',
    '#title' => t('Netforum WSDL URL'),
    '#description' => t('xWeb endpoint, commonly https://example.com/xweb/Secure/netFORUMXML.asmx?WSDL'),
    '#default_value' => variable_get('netforum_wsdl_url', 'https://'),
    '#required' => TRUE,
    '#size' => 50,
  );
  
  $form['xWeb']['netforum_xweb_username'] = array(
    '#type' => 'textfield',
    '#title' => t('xWeb User Name'),
    '#description' => t('This is the username that is used to authenticate with netFORUM and gain access'),
    '#default_value' => variable_get('netforum_xweb_username', ''),
    '#size' => 16
  );
  
  $form['xWeb']['netforum_xweb_password'] = array(
    '#type' => 'password',
    '#title' => t('xWeb User Password'),
    '#description' => t('The password to go with the xweb user, commonly requires manually setting usr_pwd in fw_user'),
    '#default_value' => variable_get('netforum_xweb_password', ''),
    '#size' => 16
  );
  
  $form['xWeb']['netforum_hide_error_messages'] = array(
    '#type' => 'checkbox',
    '#title' => t('Hide connection error messages'),
    '#description' => t('Should regular visitors be able to see when the connection to netFORUM is not available?  Site administrators will always see connection errors.'),
    '#default_value' => variable_get('netforum_hide_error_messages', 0),
  );
  
  $form['cache'] = array(
    '#title' => "xWeb caching",
    '#type' => 'fieldset',
  );
  
  $form['cache']['netforum_cache_default'] = array(
    '#type' => 'textfield',
    '#title' => t('Cache Length'),
    '#description' => t('How long should a response be used before fetching new values from xWeb'),
    '#default_value' => variable_get('netforum_cache_default', '1 hour'),
    '#size' => 16
  );
  
  $form['cache']['netforum_cache_max'] = array(
    '#type' => 'textfield',
    '#title' => t('Maximum Cache Length'),
    '#description' => t('If the first request fails how far back in the cache should we search before returning empty data?'),
    '#default_value' => variable_get('netforum_cache_max', '4 days'),
    '#size' => 16
  );
  
  $form['availability'] = array(
    '#title' => "xWeb availability",
    '#type' => 'fieldset',
  );
  
  $form['availability']['netforum_slow_query_limit'] = array(
    '#type' => 'textfield',
    '#title' => t('Slow query limit'),
    '#description' => t('Any xWeb requests over this time limit are marked with warnings in the system logs.'),
    '#after_field' => t('seconds'),
    '#default_value' => variable_get('netforum_slow_query_limit', '1.5'),
    '#field_suffix' => t('seconds'),
    '#size' => 4
  );

  
  $form['availability']['netforum_verify_timeout'] = array(
    '#type' => 'textfield',
    '#title' => t('xWeb timeout'),
    '#description' => t('If netFORUM cannot be contacted in this time it is logged as an error'),
    '#field_suffix' => t('seconds'),
    '#default_value' => variable_get('netforum_verify_timeout', 5),
    '#size' => 4
  );
  
  $form['availability']['netforum_verify_availability'] = array(
    '#type' => 'checkbox',
    '#title' => t('Verify xWeb availability before requests'),
    '#description' => t('Verify that netFORUM is available before issuing requests by trying to open a connection to the server.'),
    '#default_value' => variable_get('netforum_verify_availability', 1),
  );
  
  $form['availability']['netforum_verify_length'] = array(
    '#type' => 'textfield',
    '#title' => t('xWeb verification length'),
    '#description' => t('This sets how frequently netFORUM should be checked for availability.  Think of it as the time between verification checks.  There is overhead associated with this, so anything less than 2 minutes might not be efficient.  Enter zero to disable and check before every request.'),
    '#field_suffix' => t('minutes'),
    '#default_value' => variable_get('netforum_verify_length', 3),
    '#size' => 4
  );
  
  $form['#validate'] = array(
    'netforum_admin_settings_validate' => array()
  );

  return system_settings_form($form);
}

/**
 * Validating the system settings form
 *
 * @see netforum_admin_settings
 */
function netforum_admin_settings_validate($form_id, $form_values, $form) {
  $clear_to_connect = TRUE;
  
  if ( ! valid_url($form_values['netforum_wsdl_url'], TRUE)) {
    form_set_error('netforum_wsdl_url', t('Please enter a valid wsdl url for access'));
    $clear_to_connect = FALSE;
  }
  
  if ( !isset($form_values['netforum_xweb_username']) || trim($form_values['netforum_xweb_username']) == '') {
    form_set_error('netforum_xweb_username', t('Please enter a username'));
    $clear_to_connect = FALSE;
  }
  
  if ( !isset($form_values['netforum_xweb_password']) || trim($form_values['netforum_xweb_password']) == '') {
    $old_password = variable_get('netforum_xweb_password', FALSE);
    if ($old_password) {
      form_set_value($form['xWeb']['netforum_xweb_password'], $old_password);
      $form_values['netforum_xweb_password'] = $old_password;
    }
    else {
      form_set_error('netforum_xweb_password', t('Please enter a password'));
      $clear_to_connect = FALSE;
    }
  }
  
  if (isset($form_values['netforum_cache_default'])) {
    if (substr(trim($form_values['netforum_cache_default']), 0, 1) == '-') {
      form_set_error('netforum_cache_default', t('The default cache cannot be a negative amount of time.'));
    }
    elseif (strtotime($form_values['netforum_cache_default']) === FALSE || strtotime($form_values['netforum_cache_default']) == -1 ) {
      form_set_error('netforum_cache_default', t('The time format was not recognized, please enter something in the format of 4 days or 1 hour'));
    }
  }
  
  if (isset($form_values['netforum_cache_max'])) {
    if (substr(trim($form_values['netforum_cache_max']), 0, 1) == '-') {
      form_set_error('netforum_cache_max', t('The default cache cannot be a negative amount of time.'));
    }
    elseif (strtotime($form_values['netforum_cache_max']) === FALSE || strtotime($form_values['netforum_cache_max']) == -1 ) {
      form_set_error('netforum_cache_max', t('The time format was not recognized, please enter something in the format of 4 days or 1 hour'));
    }
  }
  
  if (isset($form_values['netforum_wsdl_url']) && stristr($form_values['netforum_wsdl_url'], 'netForumXMLOnDemand.asmx')) {
    variable_set('netforum_xweb_od', 1);
  }
  else {
    variable_set('netforum_xweb_od', 0);
  }

  if ($clear_to_connect === TRUE) {
    if ($form_values['netforum_verify_availability'] == 1 && netforum_is_available() === FALSE) {
      drupal_set_message(t('Could not contact netFORUM server'), 'error');
      return;
    }
    _netforum_include_xweb();
    try {
      $error_level = error_reporting(0); //ignore the errors, only catch exceptions
      $verify_timeout = $form_values['netforum_verify_timeout'];
      if ($verify_length != 0) {
        ini_set('default_socket_timeout', $verify_timeout);
      }
      $nfh = new xwebSecureClient($form_values['netforum_wsdl_url'], 
          Array('trace' => TRUE,
          'exceptions' => TRUE,
          'cache_wsdl' => TRUE,
          'xwebUserName' => $form_values['netforum_xweb_username'],
          'xwebUserPass' => $form_values['netforum_xweb_password']));
      $response = $nfh->GetFacadeXMLSchema(array('szObjectName' => 'Customer'));
      if ($response) {
        drupal_set_message(t('Successfully connected to netFORUM server and retreived data'), "status");
      }
      error_reporting($error_level);
    }
    catch(Exception $exception) {
      form_set_error('form_token', t('Could not connect to netFORUM server with specified parameters.<br> @exception_message .', array('@exception_message' => $exception->getMessage())) );
      $wsdl_url_guess = _netforum_guess_xweb_url($form_values['netforum_wsdl_url']);
      if (strtolower($form_values['netforum_wsdl_url']) != strtolower($wsdl_url_guess)) {
        drupal_set_message(t('Perhaps the following WSDL endpoint would work better:<br> @wsdl_url_guess', array('@wsdl_url_guess' => $wsdl_url_guess)), "status");
      }
    }
  }
}

/** 
 * Implementation of hook_cron()
 */
function netforum_cron() {
  $cutoffdate = strftime("%Y-%m-%d %H:%M", strtotime("-". variable_get('netforum_cache_max', '10 days')));
  db_query("DELETE FROM {netforum_request_cache} WHERE add_date <= '$cutoffdate';");
}

/**
 * Verify that netforum is aailable for queries.  
 *
 * This stores the result in a global varaible to prevent repetitive checks in the same request.
 * If the admin setting verify availability is unchecked then this always returns TRUE
 * 
 * @return
 *    Boolean TRUE or FALSE
 */
function netforum_is_available() {
  global $_netforum_is_available;
  
  if (variable_get('netforum_verify_availability', 1) == 0) {
    return TRUE;
  }
  
  if (isset($_netforum_is_available)) {
    return $_netforum_is_available;
  }
  
  $verify_length = variable_get('netforum_verify_length', 3);
  if ($verify_length != 0) {
    $cutoff = strtotime("-". $verify_length ." minutes");
    $last_result = variable_get('netforum_netforum_is_available', array(NULL, NULL));
    if ( is_null($last_result[0]) === FALSE && $last_result[1] >= $cutoff ) {
      return $last_result[0];
    }
  }
  //close down all warnings, because if it does fail we don't want it to show
  $error_level = error_reporting(0);
  
  $address = variable_get('netforum_wsdl_url', NULL);
  if ($address == NULL) {
    $_netforum_is_available = FALSE;
  }
  else {
    $opts = array('http' => array('timeout' => variable_get('netforum_verify_timeout', 5)), 'https' => array('timeout' => variable_get('netforum_verify_timeout', 5)));
    $address_parts = explode('/', $address);
    $server = $address_parts[2];
    $fp = fsockopen($server, 80, $errno, $errstr, variable_get('netforum_verify_timeout', 5));
    if ($fp) {
      $_netforum_is_available = TRUE;
    }
    else {
      $_netforum_is_available = FALSE;
      watchdog('netforum', t("Could not connect to netFORUM server %server - %error", array('%server' => $server, '%error' => $errstr) ), WATCHDOG_ERROR, l(t('settings'), 'admin/settings/netforum/connection'));
    }
  }
  
  //restore the error reporting level
  error_reporting($error_level);
  
  if ($verify_length != 0) {
    variable_set('netforum_netforum_is_available', array($_netforum_is_available, time()));
  }
  
  return $_netforum_is_available;
}

/**
 * Checks to see if it is netFORUM Enterprise
 *
 * @return
 *    Boolean TRUE if enterprise, FALSE otherwise
 */
function netforum_is_enterprise() {
  return (variable_get('netforum_xweb_od', 0) == 0);
}

/**
 * Checks to see if it is netFORUM Team or Pro
 *
 * @return
 *    Boolean TRUE if Team or Pro, FALSE otherwise
 */
function netforum_is_team() {
  return (variable_get('netforum_xweb_od', 0) == 1);
}

function _netforum_include_xweb() {
  $path = drupal_get_path('module', 'netforum');
  if (netforum_is_enterprise()) {
    require_once($path .'/xwebSecureClient.class.inc');
  }
  else {
    require_once($path .'/xwebSecureOD.class.inc');
  }
}

/**
 * Connect to xWeb and return a copy of the global SoapClient handler.
 * If the server is not available set it to only check the local cache.
 */
function netforum_connect_xweb() {
  
  _netforum_include_xweb();
  global $_netforum_xweb_handler;
  if (!isset($_netforum_xweb_handler)) {
    try{
      $error_level = error_reporting(0); //ignore the errors, only catch exceptions
      $verify_timeout = variable_get('netforum_verify_timeout', 5);
      if ($verify_timeout != 0) {
        ini_set('default_socket_timeout', $verify_timeout);
      }
      $_netforum_xweb_handler = new xwebSecureClient(variable_get('netforum_wsdl_url', NULL), 
        Array('trace' => TRUE,
          'exceptions' => TRUE,
          'cache_wsdl' => TRUE,
          'xwebUserName' => variable_get('netforum_xweb_username', NULL),
          'xwebUserPass' => variable_get('netforum_xweb_password', NULL), )
        );
      $_netforum_xweb_handler->setCaching(variable_get('netforum_cache_default', NULL));
      error_reporting($error_level);
    }
    catch(Exception $exception) {
      if (variable_get('netforum_hide_error_messages', 0) == 0 || user_access('administer site configuration')) {
        drupal_set_message(t('Could not connect to netFORUM server, please verify connection settings'), 'error');
      }
    }
  }
  
  if ( isset($_netforum_xweb_handler) ) {
    if (netforum_is_available() === FALSE) {
      $_netforum_xweb_handler->enableOfflineMode();
    }
    else {
      $_netforum_xweb_handler->disableOfflineMode();
    }
  }
  
  return $_netforum_xweb_handler;
}

/**
 *  Issue a request to xWeb and return the result, if any
 *
 *  If $cache_max is not set, it recurses with $cache_max set to the admin set option.  If $cache_max is set it only makes one attempt.
 *
 * @param $fname
 *    A string containing the name of the xWeb function such as GetQuery or InsertFacadeObject; case sensitive
 * @param $arguments
 *    An array with keys set to parameter names and values set to the data.  For example, Array('szObjectName'=>'Individual').  
 * @param $cache_max
 *    A string parseable to a time that indicates how far back in the cache to search.  For example, '1 day'
 * @return
 *    Bare results, a SimpleXML Object, or NULL if no results are found
 *
 * @see netforum_xweb_functions
 * @see netforum_xweb_function_parameters
 * @see netforum_xweb_function_struct_parameters
 * @see netforum_request_log
 * @see netforum_soap_log
 * @see netforum_ind_info_parameters
 * @see netforum_org_info_parameters
 * @see netforum_facade_object_parameters
 */
function netforum_xweb_request($fname, $arguments = array(), $cache_max = NULL) {
  $start_time = microtime();
  $nfh = netforum_connect_xweb();
  
  if ( ! $nfh) {
    watchdog('netforum', t("Received xWeb request for !fname but could not connect to xWeb", array('!fname' => $fname)), WATCHDOG_ERROR);
    return NULL;
  }
  
  $xml_object = NULL;
  $results = NULL;
  
  if (isset($cache_max)) {
    $nfh->setCaching($cache_max);
  }
    
  //we're going to turn off errors for a moment here.  If there is an SSL error the first time, I don't
  //want to display it.  We can throw our own thank you.
  $error_level = error_reporting(0);
   
  try{
    $results = $nfh->{$fname}($arguments);
    if ( !isset($results)) {
      throw new Exception('No results returned from xWeb Query');
    }
  }
  catch(Exception $e) {
    if (isset($cache_max)) {  //this implies that we went even further back in the cache and could not connect, so call it quits
      if (variable_get('netforum_hide_error_messages', 0) == 0 || user_access('administer site configuration')) {
        drupal_set_message(t('Could not retreive data from server or cache.'), 'error');
      }
      $nfh->setCaching(variable_get('netforum_cache_default', '4 hours'));
      if ($fname == 'GetQuery') {
        watchdog('netforum', t("Could not get response to !fname request for !columns from !object: @fault", array('!fname' => $fname, '@fault' => $e->faultstring, '!columns' => $arguments['szColumnList'], '!object' => $arguments['szObjectName'])), WATCHDOG_ERROR);
      }
      else {
        watchdog('netforum', t("Could not get response to !fname request: @fault", array('!fname' => $fname, '@fault' => $e->faultstring)), WATCHDOG_ERROR);
      }
    }
    else {
      //recurse if we hit one snag and try it one more time
      watchdog('netforum', t("First xWeb request for !fname did not return any arguments", array('!fname' => $fname)), WATCHDOG_WARNING);
      $results = netforum_xweb_request($fname, $arguments, variable_get('netforum_cache_max', '4 days'));
    }
  }
  
  if (isset($results)) {
    $fname_result = $fname ."Result";
    //the following is a test for a response containing yet more xml.  If it is a simple request, like WebLogin then the result
    //is workable as a simpleobject and does not need to be parsed further.
    if (isset($results->{$fname_result}->any) && $fname != "GetFacadeXMLSchema") {
      $results = simplexml_load_string($results->{$fname_result}->any, "SimpleXMLElement", LIBXML_NOERROR+LIBXML_NOWARNING);
    }
    
    if ($nfh->cachedLastResponse() == 1) {
      $source = t("from database cache");
    }
    else {
      $source = t("directly from xWeb");
    }
    $elapsed_time = microtime()-$start_time;
    $max_time = (float)variable_get('netforum_slow_query_limit', '1.5');
    if ($max_time != 0 && $elapsed_time > $max_time) {
      watchdog('netforum', t("Slow returning response to xWeb query !fname !source in !elapsed_time seconds, parameters: <br> @arguments", array('!fname' => $fname, '!source' => $source, '!elapsed_time' => $elapsed_time, '@arguments' => print_r($arguments, TRUE))), WATCHDOG_WARNING);
    }
  }
  
  //restore the error reporting level
  error_reporting($error_level);

  return $results;
    
}

/**
 * Find out if the last request came from the database
 *
 * @return
 *    TRUE if the last xWeb request came from the local database cache, FALSE otherwise
 */
function netforum_response_from_cache() {
  $nfh = netforum_connect_xweb();
  if (!$nfh) {
    return;
  }
  return $nfh->lastResponseFromCache();
}

/**
 *  Return a list of fields for a given object
 *
 * By default this will return the cached object info.  If the object info does not exist or is empty, then it will issue a request to
 * xWeb, parse, store, and return the results.  The object name must exist in the database in order to return the fields.
 *
 * @param $obj_name
 *    A string representing the object name.  For example, Individual or EventsRegistrant
 * @return
 *    A hashed array with the keys set to the column names and the values set to the column description
 */
function netforum_object_fields($obj_name) {
  static $seen_objects = array();
  $obj_fields = array();
  
  if ( !isset($obj_name) || $obj_name == '') {
    return $obj_fields;
  }
  
  if (isset($seen_objects[$obj_name])) {
    return $seen_objects[$obj_name];
  }
  
  $cached_result = db_query("SELECT data, obj_prefix, obj_defaultcolumns, obj_defaultorderby FROM {netforum_object_cache} WHERE obj_name = '%s' ", $obj_name);
  if (db_num_rows($cached_result) > 0) {
    $cached_obj = db_fetch_object($cached_result);
    if ($cached_obj->data != '') {
      $obj_fields = unserialize($cached_obj->data);
      $seen_objects[$obj_name] = $obj_fields;
      return $obj_fields;
    }
  }
  else {
    watchdog('netforum', t('Could not find object %objectname in list of netFORUM objects, perhaps the the list of objects needs to be refreshed?', array('%objectname' => $obj_name)), WATCHDOG_WARNING, l(t('refresh object list'), 'admin/settings/netforum/object-names-refresh'));
    return $obj_fields;
  }
  
  set_time_limit(90);
  $updated_object_data = array();
  if (netforum_is_enterprise() ) {
    $arguments = array(
      'szObjectName' => "Object",
      'szColumnList' => "obj_prefix, obj_defaultcolumns, obj_defaultorderby",
      'szWhereClause' => "obj_name = '$obj_name'",
      'szOrderBy' => "",
    );
    $response = netforum_xweb_request('GetQuery', $arguments); 
    if ($response) {
      $obj = $response->ObjectObject;
      $updated_object_data['obj_prefix'] = strval($obj->obj_prefix);
      $updated_object_data['obj_defaultcolumns'] = strval($obj->obj_defaultcolumns);
      $updated_object_data['obj_defaultorderby'] = strval($obj->obj_defaultorderby);
    }
  }
  
  $response = netforum_xweb_request('GetFacadeXMLSchema', array('szObjectName' => $obj_name));
  if (is_null($response)) {
    return $obj_fields;
  }
  
  // so this is not the greatest way to parse out the object descriptions, but it's a way, and it works.  At least it only goes through each node once, 
  // even if it does wade through several thousand of them for the large objects.
  $p = xml_parser_create();
  xml_parser_set_option($p, XML_OPTION_CASE_FOLDING, 0);
  xml_parser_set_option($p, XML_OPTION_SKIP_WHITE, 1);
  xml_parse_into_struct($p, $response->GetFacadeXMLSchemaResult->any, $vals);
  xml_parser_free($p);
  
  foreach ($vals as $node) {
    if (isset($node['tag']) && $node['tag'] == 'xsd:group' && $node['type'] == 'open') {
      $category = $node['attributes']['name'];
      $level = $node['level'];
      $found_close = FALSE;
      while ($found_close === FALSE) {
        $node = next($vals);
        if ($node['tag'] && $node['tag'] == 'xsd:element' && $node['type'] != 'close' && isset($node['attributes']['ref'])) {
          $col = $node['attributes']['ref'];
          if (stristr($col, '_')) {
           $obj_fields[$col] = $category ."::";
          }
          else {
            continue;
          }
        }
        elseif ($node['tag'] && $node['tag'] == 'xsd:group' && $node['type'] == 'close' && $node['level'] == $level) {
          $found_close = TRUE;
        }
      } 
    }
    if (isset($node['tag']) && $node['tag'] == 'xsd:element' && $node['type'] == 'open' && isset($node['attributes']) && isset($node['attributes']['name'])) {
      $col = $node['attributes']['name'];
      if (array_key_exists($col, $obj_fields) === FALSE) {
        continue;
      }
      $level = $node['level'];
      $found_close = FALSE;
      while ($found_close === FALSE) {
        $node = next($vals);
        if ($node['tag'] && $node['tag'] == 'xsd:documentation') {
          $obj_fields[$col] .= trim($node['value'], '.');
        }
        elseif ($node['tag'] && $node['tag'] == 'xsd:element' && $node['type'] == 'close' && $node['level'] == $level) {
          $found_close = TRUE;
        }
      }
    }
  }

  
  $update_query = "UPDATE {netforum_object_cache} SET data='%s', ";
  $update_values = array(serialize($obj_fields));
  foreach($updated_object_data as $k => $v) {
    $update_query .= $k ." = '%s', ";
    $update_values[] = $v;
  }
  
  $update_query = rtrim($update_query, ", ");
  $update_query .= " WHERE obj_name = '%s'";
  $update_values[] = $obj_name;
  db_query($update_query, $update_values); 
  
  $seen_objects[$obj_name] = $obj_fields;
  
  return $obj_fields;  
}

/**
 * Fetch a list of Objects from netForum and stores any new object names and keys in the cache
 * 
 * netFORUM OnDemand doesn't have many of the features needed, so the names for on demand are loaded from a static file
 */
function netforum_refresh_object_names() {
  
  if (netforum_is_team()) {
    //Individual, Organization, Address, and Customer are the only allowed objects for us, calling GetFacadeXMLSchema on anything else is a nogo.
    db_query("INSERT INTO {netforum_object_cache} (obj_name, obj_key, obj_prefix, obj_defaultcolumns, obj_defaultorderby, data, obj_key_field) VALUES ('Individual','f41b6e06-299b-4022-be6f-0641ba87de59','ind','ind_last_name,ind_first_name','ind_last_name,ind_first_name',NULL,NULL); " );
    db_query("INSERT INTO {netforum_object_cache} (obj_name, obj_key, obj_prefix, obj_defaultcolumns, obj_defaultorderby, data, obj_key_field) VALUES ('Organization','9c0100ce-f6c2-4b42-aff2-1c065f3734d9','org','org_name, org_acronym','org_name',NULL,NULL); " );
    db_query("INSERT INTO {netforum_object_cache} (obj_name, obj_key, obj_prefix, obj_defaultcolumns, obj_defaultorderby, data, obj_key_field) VALUES ('Address','0574b4d5-853b-48a9-8b64-8b424b6658bd','adr','*','adr_city',NULL,NULL); " );
    db_query("INSERT INTO {netforum_object_cache} (obj_name, obj_key, obj_prefix, obj_defaultcolumns, obj_defaultorderby, data, obj_key_field) VALUES ('Customer','65f0eb73-0df7-4196-b2ff-11b61f10e532','cst','cst_type,cst_name_cp','cst_sort_name_dn',NULL,NULL); " );
    return;
  }
  
  $empty_obj_struct = array('obj_key' => '', 'obj_name' => '', 'obj_prefix' => '', 'obj_defaultcolumns' => '', 'obj_defaultorderby' => '');
  $columns = array_keys($empty_obj_struct);
  
  $arguments = array(
    'szObjectName' => "Object @TOP -1",
    'szColumnList' => implode(", ", $columns),
    'szWhereClause' => "obj_prefix is not NULL and obj_delete_flag = 0",
    'szOrderBy' => "",
  );
  $response = netforum_xweb_request('GetQuery', $arguments); 
  
  $partial_data = FALSE;
  if (is_null($response) || $response->attributes()->recordReturn < 400) {
    // If we can't use the @TOP directive to override the maximum records returned in the query limit, try it the slow way.
    // according to the avectra wiki, @TOP was added in 2006.01 build
    $response = netforum_xweb_request('GetFacadeObjectList');
    $partial_data = TRUE;
  }
  if ($response) {
    $db_objects = array();
    $to_add = array();
    $to_update = array();
    $db_result = db_query("SELECT ". implode(", ", $columns) ." FROM {netforum_object_cache}");
    while ($obj = db_fetch_object($db_result)) {
      $db_objects[(string)$obj->obj_key] = $obj;
    }
    if ($partial_data) {
      foreach ($response->ObjectObject as $obj) {
        $object_name = (string)$obj->obj_name;
        $object_key = (string)$obj->obj_key;
        if (array_key_exists($object_key, $db_objects)) {
          if ($db_objects[$object_key]->obj_name != $object_name) {
            $to_update[$object_key] = $empty_obj_struct;
            $to_update[$object_key]['obj_name'] = $object_name;
          }
        }
        else {
          $to_add[$object_key] = $empty_obj_struct;
          $to_add[$object_key]['obj_name'] = $object_name;
          $to_add[$object_key]['obj_key'] = $object_key;
        }
      }
    }
    else { //if we got all the data we want, do the same logic but with more data!
      foreach ($response->ObjectObject as $obj) {
        $object_key = (string)$obj->obj_key;
        if (array_key_exists($object_key, $db_objects)) {
          foreach ($columns as $obj_col) {
            $obj_val = (string)$obj->{$obj_col};
            if ($db_objects[$object_key]->{$obj_col} != $obj_val) {
              if (!isset($to_update[$object_key])) {
                $to_update[$object_key] = array();
              }
              $to_update[$object_key][$obj_col] = $obj_val;
            }
          }
        }
        else {
          $to_add[$object_key] = $empty_obj_struct;
          foreach ($columns as $obj_col) {
            $obj_val = (string)$obj->{$obj_col};
            $to_add[$object_key][$obj_col] = $obj_val;
          }
        }
      }
    }
    
    foreach ($to_add as $obj_key => $obj) {
      $query = "INSERT INTO {netforum_object_cache} (". implode(", ", array_keys($obj)) .") ";
      $query .= " VALUES(". implode(", ", array_pad(array(), count($obj), "'%s'")) .");";
      db_query($query, array_values($obj) );
    }
    
    foreach ($to_update as $obj_key => $obj) {
      $updates = array();
      $values = array();
      foreach ($obj as $k => $v) {
        $updates[] = "$k = '%s'";
        $values[] = $v;
      }
      $values[] = $obj_key;
      db_query("UPDATE {netforum_object_cache} SET ". implode(", ", $updates) ." WHERE obj_key = '%s' ;", $values ); 
    }
  }
}

/**
 *  Find the name of an object when given the key
 *
 * @param $obj_key
 *    String with the object key
 * @return
 *    String with the object name if found, empty string otherwise
 */
function netforum_object_name($obj_key) {
  static $name_cache = array();
  $obj_key = (string)$obj_key;
  if ( netforum_is_valid_guid($obj_key) == FALSE ) {
    return '';
  }
  if (array_key_exists($obj_key, $name_cache)) {
    return $name_cache[$obj_key];
  }
  else {
    $res = db_query("SELECT obj_name FROM {netforum_object_cache} WHERE obj_key = '%s' ", $obj_key);
    if (db_num_rows($res) > 0) {
      $obj = db_fetch_object($res);
      $name_cache[$obj_key] = $obj->obj_name;
      return $obj->obj_name;
    }
    else{
      return '';
    }
  }
}

/**
 *  Find the key of an object when given the name
 *
 * @param $obj_name
 *    String with the object name
 * @return
 *    String with the object key if found, FALSE otherwise
 */
function netforum_object_key($obj_name) {
  static $key_cache = array();
  
  if (netforum_is_valid_guid($obj_name)) {
    return $obj_name;
  }
  
  if ( array_key_exists($obj_name, $key_cache)) {
    return $key_cache[$obj_name];
  }
  else {
    $res = db_query("SELECT obj_key FROM {netforum_object_cache} WHERE obj_name = '%s' ", $obj_name);
    if (db_num_rows($res) > 0) {
      $obj = db_fetch_object($res);
      $key_cache[$obj_name] = $obj->obj_key;
      return $obj->obj_key;
    }
    else{
      return FALSE;
    }
  }
}

/**