modules/uc_setcom/uc_setcom.module

<?php
// $Id: uc_setcom.module,v 1.4 2009/10/08 10:56:23 maxheadroom Exp $

/**
* @file
* Integrates setcom.com's redirected payment service.
*
* Developed by Quentin Campbell (Max Headroom).
* Drupal 6 version development sponsored by  http://www.synecobusinessit.co.za.
*/
require_once('uc_setcom.ca.inc');
/*******************************************************************************
* Hook Functions (Drupal)
******************************************************************************/

/**
* Implementation of hook_menu().
*/
function uc_setcom_menu() {
  $items['cart/setcom/complete'] = array(
    'title' => 'Setcom transaction result',
    'page callback' => 'uc_setcom_complete',
    'access callback' => TRUE,
    'type' => MENU_CALLBACK,
  );
  return $items;
}

/**
* Implementation of hook_form_alter().
*/
function uc_setcom_form_alter(&$form, &$form_state, $form_id) {
  if ($form_id == 'uc_cart_checkout_review_form' && ($order_id = intval($_SESSION['cart_order'])) > 0) {
    $order = uc_order_load($order_id);
    
    if ($order->payment_method == 'setcom') {
      unset($form['submit']);
      $form['#prefix'] = '<table style="display: inline; padding-top: 1em;"><tr><td>';
      $form['#suffix'] = '</td><td>'. drupal_get_form('uc_setcom_form', $order) .'</td></tr></table>';
    }
  }
}

/*******************************************************************************
* Hook Functions (Ubercart)
******************************************************************************/

/**
* Implementation of hook_payment_method().
*/
function uc_setcom_payment_method() {
  
  $path = base_path() . drupal_get_path('module', 'uc_setcom');
  $title = variable_get('uc_setcom_method_title', t('Payment via Setcom secure server:'));
  $title .= '<br /><img src="'. $path .'/setcom_small.gif" style="position: relative; left: 2.5em;"><br>';
  
  $methods[] = array(
    'id' => 'setcom',
    'name' => t('Setcom'),
    'title' => $title,
    'desc' => t('Redirect to Setcom payment gateway.'),
    'callback' => 'uc_payment_method_setcom',
    'weight' => 3,
    'checkout' => TRUE,
    'no_gateway' => TRUE,
    );  
  return $methods;
}
 
/*******************************************************************************
* Callback Functions, Forms, and Tables
******************************************************************************/

/**
* Callback for setcom payment method settings.
*/
function uc_payment_method_setcom($op, &$arg1) {
  switch ($op) {
  case 'cart-details':
    return uc_setcom_get_details();
    
  case 'cart-process':
    $_SESSION['pay_method'] = $_POST['pay_method'];
    return;
    
  case 'settings':
    //Setcom Settings
    $form['setcom_settings'] = array(
      '#type' => 'fieldset',
      '#title' => t('Setcom settings'),
      );
    
    $form['setcom_settings']['setcom_transaction_mode'] = array(
      '#type' => 'select',
      '#title' => t('Transaction mode'),
      '#description' => t('Transaction mode used for processing orders. Be sure that you do your testing in Test mode.'),
      '#options' => array(
        'production' => t('Production'),
        'test' => t('Test'),
        ),
      '#default_value' => variable_get('setcom_transaction_mode', 'test'),
      );
    
    $form['setcom_settings']['setcom_username'] = array(
      '#type' => 'textfield',
      '#title' => t('Setcom Username'),
      '#default_value' => variable_get('setcom_username', ''),
      '#description' => t('Username you are registered with at Setcom.'),
      );
    
    $form['setcom_settings']['setcom_pwd'] = array(
      '#type' => 'textfield',
      '#title' => t('Setcom Password'),
      '#default_value' => variable_get('setcom_pwd', ' '),
      '#description' => t('Password you are registered with at Setcom.'),
      );  
    
    $form['setcom_settings']['setcom_merchant_id'] = array(
      '#type' => 'textfield',
      '#title' => t('Merchant ID'),
      '#default_value' => variable_get('setcom_merchant_id', ''),
      '#description' => t('Merchant ID provided by Setcom when you\'ve create a seller account with them.'),
      );
    
    $form['setcom_settings']['setcom_test_username'] = array(
      '#type' => 'textfield',
      '#title' => t('Setcom Username for <strong> testing</strong>'),
      '#default_value' => variable_get('setcom_test_username', 'testseller3@setcom.com'),
      '#description' => t('Username at Setcom for <strong>testing</strong>. You can use testseller1@setcom.com up to testseller5@setcom.com with the same password: "testseller". Please log in at www.setcom.com with the test user name and password and under Profile >> Selling Preferences >> Website Payment Preferences, enter the Return URL supplied below into the Redirect URL field under Auto-Redirect. '),
      );
    
    $form['setcom_settings']['setcom_test_pwd'] = array(
      '#type' => 'textfield',
      '#title' => t('Setcom Password for <strong> testing</strong>'),
      '#default_value' => variable_get('setcom_test_pwd', 'testseller'),
      '#description' => t('Password at Setcom for <strong>testing.</strong> Defaults to "testseller".'),
      );
    
    $form['setcom_settings']['setcom_test_merchant_id'] = array(
      '#type' => 'textfield',
      '#title' => t('Merchant ID for <strong> testing</strong>'),
      '#default_value' => variable_get('setcom_test_merchant_id', '1234567893'),
      '#description' => t('Merchant ID at Setcom for <strong>testing.</strong> Can range from 1234567891 to 1234567895, corresponding to the test email account you use '),
      );
    
    $form['setcom_settings']['setcom_return_url'] = array(
      '#type' => 'item',
      '#title' => t('Return URL'),
      '#value' => variable_get('setcom_return_url', url('cart/setcom/complete/', $options = array('query' => NULL, 'fragment' => NULL, 'absolute' => TRUE))),
      '#description' => t('The URL to where Setcom must return to after a transaction. Please log in to your Setcom account and under Profile >> Selling Preferences >> Website Payment Preferences, enter this Return URL into the Redirect URL field under Auto-Redirect.'),
      );
    
    $form['setcom_settings']['setcom_currency'] = array(
      '#type' => 'select',
      '#title' => t('Currency code'),
      '#description' => t('Currency you use with your cart. Please note Setcom only use USD, EUR, GBP and ZAR.'),
      '#options' => array(
        'USD' => t('USD'),
        'EUR' => t('EUR'),
        'GBP' => t('GBP'),
        'ZAR' => t('ZAR'),
        ),
      '#default_value' => variable_get('setcom_currency', (variable_get('uc_currency_code', 'USD'))),
      );
    
    $form['setcom_settings']['setcom_template'] = array(
      '#type' => 'textfield',
      '#title' => t('Setcom template name'),
      '#default_value' => variable_get('setcom_template', 0),
      '#description' => t('Sets the Custom Payment Page Template for payment pages associated with this button/link. The value of TemplateID is the same as the Template Name you chose when adding or editing the page style. You can add and edit Custom Payment Page from the <strong>Selling Preferences</strong> subtab of the <strong>Profile</strong> tab. Maximum length of 30 characters. Valid character set is alphanumeric only, plus underscore. It cannot include spaces.'),
      );
    
    $form['setcom_settings']['setcom_buyer_info'] = array(
      '#type' => 'checkbox',
      '#title' => t('Send buyer information'),
      '#default_value' => variable_get('setcom_buyer_info', TRUE),
      '#description' => t('Send client information to Setcom so that their system pre-populate the signup form for new users.') 
      );
    
    $form['setcom_settings']['setcom_shipping'] = array(
      '#type' => 'checkbox',
      '#title' => 'Setcom do shipping',
      '#default_value' => variable_get('setcom_shipping', FALSE),
      '#description' => t('Set if you want Setcom to handle shipping charges.'),
      );  
    
    $form['setcom_settings']['setcom_do_email'] = array(
      '#type' => 'checkbox',
      '#title' => 'Send email on error',
      '#default_value' => variable_get('setcom_do_email', TRUE),
      '#description' => t('Send an email to address below if there was a transaction or communications error. Recommended'),
      );
    
    $form['setcom_settings']['setcom_error_email'] = array(
      '#type' => 'textfield',
      '#title' => t('Email for errors'),
      '#default_value' => variable_get('setcom_error_email', variable_get('site_mail', ini_get('sendmail_from'))),
      '#description' => t('Email address for error notifications. Defaults to site owner.'),
      );
    
    // $form['setcom_settings']['setcom_button_action'] = array(
    // '#type' => 'textfield',
    // '#title' => t('Setcom button action'),
    // '#default_value' => variable_get('setcom_button_action', 'checkout'),
    // '#description' => t(' This setting is here for future compatibility. Tells Setcom this is a Checkout Button. Should be set to <strong>\'checkout\'</strong>. This variable is required and should not be changed. Changing this argument will cause your Checkout to malfunction. '),
    // );
    
    //Setcom payment methods
    $form['setcom_payment_methods'] = array(
      '#type' => 'fieldset',
      '#title' => t('Setcom payment methods'),
      '#description' => t('Setcom allows for various payment methods fot buyers, but not all methods would be suitable for sellers. Some methods requires a waiting period of up to a few days for payment to clear. Setcom have all payments methods available on their site by default. You can request for payment methods to be removed by contacting Setcom. However, you must inform your buyers which payment methods you would accept'),
      );
    
    $allowed_options = array('Allow, and ship on order completed and payment received (payment is cleared immediately
      )', 'Allow, and ship only after payment has cleared at a later date', 'Do not allow this option');
    
    $form['setcom_payment_methods']['uc_setcom_credit_card'] = array(
      '#type' => 'select',
      '#title' => t('Allow payment by Credit Card'),
      '#default_value' => variable_get('uc_setcom_credit_card', 0),
      '#options' => $allowed_options,     
      );
    
    $form['setcom_payment_methods']['uc_setcom_poli'] = array(
      '#type' => 'select',
      '#title' => t('Allow payment by Setcom POLi/SID'),
      '#default_value' => variable_get('uc_setcom_poli', 0),
      '#options' => $allowed_options,
      );
    
    $form['setcom_payment_methods']['uc_setcom_balance'] = array(
      '#type' => 'select',
      '#title' => t('Allow payment with available credit at Setcom'),
      '#default_value' => variable_get('uc_setcom_balance', 0),
      '#options' => $allowed_options,
      );
    
    $form['setcom_payment_methods']['uc_setcom_echeque'] = array(
      '#type' => 'select',
      '#title' => t('Allow payment by Setcom eCheque'),
      '#default_value' => variable_get('uc_setcom_echeque', 2),
      '#options' => $allowed_options,
      );
    
    $form['setcom_payment_methods']['uc_setcom_edeposit'] = array(
      '#type' => 'select',
      '#title' => t('Allow payment by Setcom eDeposit'),
      '#default_value' => variable_get('uc_setcom_edeposit', 2),
      '#options' => $allowed_options,
      );
    
    //Setcom Checkout
    $form['setcom_checkout'] = array(
      '#type' => 'fieldset',
      '#title' => t('Setcom checkout settings'),
      );
    
    $form['setcom_checkout']['uc_setcom_method_title'] = array(
      '#type' => 'textfield',
      '#title' => t('Payment method title'),
      '#default_value' => variable_get('uc_setcom_method_title', t('Payment via Setcom secure server.')),
      );
    
    $form['setcom_checkout']['uc_setcom_method_title_icons'] = array(
      '#type' => 'checkbox',
      '#title' => t('Show icons beside the payment method title.'),
      '#default_value' => variable_get('uc_setcom_method_title_icons', TRUE),
      );
    
    $form['setcom_checkout']['uc_setcom_checkout_button'] = array(
      '#type' => 'textfield',
      '#title' => t('Order review submit button text'),
      '#description' => t('Provide Setcom specific text for the submit button on the order review page.'),
      '#default_value' => variable_get('uc_setcom_checkout_button', t('Submit Order')),
      );
    
    $form['setcom_checkout']['uc_checkout_review_instructions_format'] = filter_form(variable_get('uc_checkout_review_instructions_format', 3), NULL, array('uc_checkout_review_instructions_format'));
    return $form;
  }
}

// Form to build the submission to setcom.com
function uc_setcom_form(&$form_state, $order) {
  global $user;
  $country = uc_get_country_data(array('country_id' => $order->billing_country));
  
  if (variable_get('setcom_transaction_mode', 'test') == 'production') {
    $merchant_identifier = variable_get('setcom_merchant_id', '');
  }
  else{
    $merchant_identifier = variable_get('setcom_test_merchant_id', '');
  }
  
  $data = array(
    'ButtonAction' => variable_get('setcom_button_action', 'checkout'),  
    'merchantIdentifier' => $merchant_identifier,
    'CurrencyAlphaCode' => variable_get('setcom_currency', (variable_get('uc_currency_code', 'USD'))),
    'MerchCustom' => $order->order_id,
    'TemplateID' => variable_get('setcom_template', 0),
    'BuyerInformation' => variable_get('setcom_buyer_info', TRUE),
    'FirstName' => $order->billing_first_name,
    'LastName' => $order->billing_last_name,
    'Address1' => $order->billing_street1,
    'Address2' => $order->billing_street2,
    'City' => $order->billing_city,
    'State' => uc_get_zone_code($order->billing_zone),
    'PostalCode' => $order->delivery_postal_code,
    'Country' => $country['country_iso_code_2'],
    'Email' => $order->primary_email,
    'MobileNumber' => $order->billing_phone,     
    );
  
  $i = 0;
  foreach ($order->products as $product) {
    $j =($i == 0)?'':$i;
    $data['LIDSKU'. $j] = $product->model;
    $data['LIDDesc'. $j] = $product->title;
    $data['LIDPrice'. $j] = uc_currency_format($product->price, FALSE, FALSE, '.');
    $data['LIDQty'. $j] = $product->qty;
    $data['ShippingRequired'. $j] = variable_get('setcom_shipping', FALSE);
    $data['IsVoucher'. $j] = 0;   
    $i++;
  }
  $do_shipping = variable_get('setcom_shipping', FALSE);
  if (!$do_shipping) {
    $data['LIDSKU'. $i] = 'shipping';
    $data['LIDDesc'. $i] = 'Shipping cost';
    $data['LIDPrice'. $i] = uc_currency_format($order->quote['rate'], FALSE, FALSE, '.');
    $data['LIDQty'. $i] = 1;
    $data['ShippingRequired'. $i] = 0;
    $data['IsVoucher'. $i] = 0;
    $i++;
  }
  
  $form['#action'] = 'https://www.setcom.com/secure/'; 
  
  foreach ($data as $name => $value) {
    $form[$name] = array('#type' => 'hidden', '#value' => $value);
  }
  
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => variable_get('uc_setcom_checkout_button', t('Submit Order')),
    );
  
  return $form;
}

function uc_setcom_complete($cart_id = 0) {
  
  $s_front = url();
  $tnxid=$_GET['tnxid'];
  $checksum=$_GET['checksum'];
  $parity=$_GET['parity'];
  
  $page = variable_get('uc_cart_checkout_complete_page', '');
  if (!empty($page)) {
    drupal_goto(variable_get('uc_cart_checkout_complete_page', ''));
  }
  
  $err_msg = '';
  if (empty($tnxid)) {
    $err_msg .= 'tnxid not found.';
  }
  if (empty($checksum)) {
    $err_msg .= 'checksum not found.';
  }
  if (empty($parity)) {
    $err_msg .= 'parity not found.';
  }
  
  if ($err_msg) {
    drupal_set_message('Communication error: '. $err_msg .'<br> No futher action or processing will be done.', 'error');
    if (variable_get('setcom_do_email', TRUE) == TRUE) {
      drupal_set_message('<b>The store owner has been notified and will look into the problem.', 'error');
      uc_setcom_send_error('Communication error: '. $err_msg, 'Communication error: '. $err_msg .' No futher action or processing will be done.');
    }
    watchdog('Setcom', $err_msg, WATCHDOG_WARNING);
  }
  
  // Web page receives Synchro Auto-Redirect variables from Setcom.
  if (variable_get('setcom_transaction_mode', 'test') == 'production') {
    $merchant_identifier = variable_get('setcom_merchant_id', '');
    $username = variable_get('setcom_username', '');
    $password = variable_get('setcom_pwd', '');
  }
  else{
    $merchant_identifier = variable_get('setcom_test_merchant_id', '1234567893');
    $username = variable_get('setcom_test_username', 'testseller3@setcom.com');
    $password = variable_get('setcom_test_pwd', 'testseller');
  }
  
  /*
  Now we open a communication line to the HTTP Synchro Service.
  */
  $setcom_string = 'method='.'order_synchro'.
  '&identifier='. $merchant_identifier .
  '&usrname='. $username .
  '&pwd='. $password .
  '&tnxid='. $tnxid .
  '&checksum='. $checksum .
  '&parity='. $parity;
  
  // send $setcom_string to Setcom by utilizing CURL
  $setcom_url = "https://www.setcom.com/secure/components/synchro.cfc?wsdl";
  
  // Setcom Synchro url
  $ch = curl_init(); // initialize curl handle
  curl_setopt($ch, CURLOPT_URL, $setcom_url); // set $setcom_url to post to Setcom
  curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
  curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
  curl_setopt($ch, CURLOPT_HEADER, 0);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); // return into a variable
  curl_setopt($ch, CURLOPT_POST, 1); // set POST method
  curl_setopt($ch, CURLOPT_POSTFIELDS, $setcom_string); // set Post variable
  $setcom_result = curl_exec($ch); // Perform the POST and get the data returned by Setcom.
  if (curl_errno($ch)) {
    $scurlerror = curl_error($ch); // If CURL returns an error, stores it in a variable.
    Drupal_set_message($scurlerror);
  } 
  else {
    $scurlerror = '';
    curl_close($ch);
  }
  if (empty($scurlerror)) {
    //filter result for XML
    $setcom_wddx = trim($setcom_result);
    $setcom_xml = wddx_deserialize($setcom_wddx);
    $order_synchro = simplexml_load_string($setcom_xml);
    
    //tnx details
    $tnx_status = $order_synchro->outcome->status;
    $tnx_id = $order_synchro->outcome->order->id;
    $funds_avail = $order_synchro->outcome->order->funds_available;
    
    //error details
    $error_code = $order_synchro->outcome->error_code;
    $error_desc = $order_synchro->outcome->error_desc;
    $error_solution = $order_synchro->outcome->error_solution;
    
    //seller details
    $seller_ref = $order_synchro->seller->reference;
    $seller_email = $order_synchro->seller->username;
    $order = uc_order_load($seller_ref);
    
    //buyer details
    $buyer_ref = $order_synchro->buyer->reference;
    $buyer_uname = $order_synchro->buyer->username;
    $buyer_title = $order_synchro->buyer->billing_address->title;
    $buyer_fname = $order_synchro->buyer->billing_address->firstname;
    $buyer_lname = $order_synchro->buyer->billing_address->lastname;
    $buyer_email = $order_synchro->buyer->billing_address->email_address;
    $buyer_street1 = $order_synchro->buyer->billing_address->street1;
    $buyer_street2 = $order_synchro->buyer->billing_address->street2;
    $buyer_city = $order_synchro->buyer->billing_address->city;
    $buyer_state = $order_synchro->buyer->billing_address->state;
    $buyer_zip = $order_synchro->buyer->billing_address->zip;
    $buyer_country = $order_synchro->buyer->billing_address->country;
    $buyer_cnumber = $order_synchro->buyer->billing_address->contact_number;
    
    //payment details
    $pmt_type = $order_synchro->payment_instrument->type;
    
    //financial details
    $tnx_amount = $order_synchro->financial->amount_total;
    $currency = $order_synchro->financial->currency;
    /*validation of transaction outcome in order to display the correct information to the buyer */
    
    //transaction is unsuccessful
    if ($error_code != '0') { 
      $somestring = '<strong>Your order has been Declined.</strong><br><br>';
      $somestring .= 'Sorry '. $buyer_title .' '. $buyer_fname .' '. $buyer_surname .' your payment to '. $seller_email .' was <strong>unsuccesful</strong>.<br><br>';
      $somestring .= ' The order has not been processed<br><br>';
      $somestring .= 'Error Code: '. $error_code .'<br>';
      $somestring .= 'Error Description: '. $error_desc .'<br>';
      $somestring .= 'Error Solution: '. $error_solution .'<br>';
      drupal_set_message($somestring, 'error');
      watchdog('Setcom', $somestring, array(), WATCHDOG_WARNING);
      $output = '<br /><a href="'. $s_front .'">Click to return to the front page.</a>';
    } 
    else { //end transaction is unsuccessful     
      //transaction is successful  
      $cur_tnx_amount = getcurrency($tnx_amount, $currency);
      $somearray['tnx_amount'] = $tnx_amount/100; //returned amount is without decimal
      
      if (!$pmt_type) {
        $somearray['pmt_type'] ='unknown type';
      }
      else{
        $somearray['pmt_type'] = $pmt_type;
      }                                                                                  
      
      $somearray['order'] = $seller_ref;     
      $somestring = 'Your transaction is <strong>'. $tnx_status .'</strong><br><br>';
      $somestring .= 'Payment by '. $somearray['pmt_type'] .'. <br>';
      $somestring .= ' Thank you, '. $buyer_title .' '. $buyer_fname .' '. $buyer_surname .'for your business<br>';
      $somestring .= '<strong>Transaction ID</strong>: '. $tnx_id .'<br>';
      $somestring .= '<strong>Transaction Amount</strong>: '. $cur_tnx_amount .'<br>';
      $somestring .= '<strong>Funds Available</strong>: '. $funds_avail .'<br>';
      $somestring .= '<strong>Reference</strong>: '. $seller_ref .'<br>';
      
      switch ($pmt_type) {
      case 'Credit Card':
        $somearray['setting'] = variable_get('uc_setcom_credit_card', 0);
        list($output, $somestring) = uc_setcom_check_trans($somearray, $somestring);
        break;
        
      case 'POLi':
        $somearray['setting'] = variable_get('uc_setcom_poli', 0);
        list($output, $somestring) = uc_setcom_check_trans($somearray, $somestring);
        break;
        
      case 'Balance':
        $somearray['setting'] = variable_get('uc_setcom_balance', 0);
        list($output, $somestring) = uc_setcom_check_trans($somearray, $somestring);
        break;       
        
      case 'eCheque':
        $somearray['setting'] = variable_get('uc_setcom_echeque', 0);
        list($output, $somestring) = uc_setcom_check_trans($somearray, $somestring); 
        break;
        
      case 'eDeposit':
        $somearray['setting'] = variable_get('uc_setcom_edeposit', 0);
        list($output, $somestring) = uc_setcom_check_trans($somearray, $somestring);
        break;
        
      default:
        $somearray['setting'] = 3;
        list($output, $somestring) = uc_setcom_check_trans($somearray, $somestring);
        break;
      }
      if ($pmt_type != 'Credit Card' && $somearray['setting'] != 2) {  
        foreach ($order_synchro->outcome->order->alerts->alert as $alerts) {
          $somestring .= '<br><br><u>Transaction notification from <strong>SETCOM</strong>: </u><fieldset>'. $alerts->text .'<br></fieldset><br>';  
        }
      }
      if ($somestring) {
        drupal_set_message($somestring, 'status');
        watchdog('Setcom', $somestring, array(), WATCHDOG_NOTICE);
      }
    } //end tnx successful
    return $output;
  }
  else { // END - [if (empty($scurlerror))]
    drupal_set_message(t('There was an error in the communication with Setcom. No confirmation reply from their server. ') , 'error');
    if (variable_get('setcom_do_email', TRUE) == TRUE) {
      drupal_set_message(t('<b>The store owner has been notified and will look into the problem.', 'error'));
      uc_setcom_send_error('No Curl received', 'No Curl data was send from Setcom.');
    }
    watchdog('Setcom', $somestring,  array(), WATCHDOG_NOTICE);
  }
}


/******************************************************************************
* Helper Functions and Script
******************************************************************************/

/**
* helper function for transaction type. 
*/
function uc_setcom_check_trans($somearray, $somestring) {
  $order_check = uc_order_load($somearray['order']);
  
  switch ($somearray['setting']) {
    
  case 0: 
    $output = uc_cart_complete_sale($order_check, variable_get('uc_new_customer_login', FALSE));
    uc_order_comment_save($order_check->order_id, 0, $somestring);
    uc_payment_enter($order_check->order_id, 'Setcom', $somearray['tnx_amount'], 0, NULL, $somestring);
    ca_pull_trigger('setcom_payment_received', $order_check, $user->uid == 0 ? $account : $user);
    break;
    
  case 1:
    $somestring .= t('<strong>Order will only ship when funds clear in our bank account.</strong>');
    $output = uc_cart_complete_sale($order_check, variable_get('uc_new_customer_login', FALSE));
    uc_order_comment_save($order_check->order_id, 0,  $somestring);
    ca_pull_trigger('setcom_payment_pending', $order_check, $user->uid == 0 ? $account : $user);
    break;
    
  case 2:
    $somestring = t('<strong>We do not accept payment via '. $somearray['pmt_type'] .'.</strong><br> We can not honour payment for this order.<br> If you have already made a payment, please contact Setcom to reverse this payment.<br> You can do a checkout the order again and select a different method of payment on the Setcom page.<br>'); 
    $somestring .= uc_setcom_get_details();
    
    if (variable_get('setcom_do_email', TRUE) == TRUE) {
      uc_setcom_send_error(t('Payment method not allowed', 'Customer tried to buy with '. $somearray['pmt_type'] .', a payment method that is not allowed. Order no.:'. $order_check->order_id .' Order user ID:'. $order_check->uid));
    }
    drupal_set_message($somestring, 'error');
    watchdog('Setcom', $somestring, array(),  WATCHDOG_NOTICE);
    $output ='<a href="'. url() .'">Click to return to the front page.</a>';
    $somestring = '';
    ca_pull_trigger('setcom_payment_denied', $order_check, $user->uid == 0 ? $account : $user);
    break;
    
  case 3:
  default:
    $somestring .= '<br>'. t('Even though the transaction is successful, there was an error in that we could not determine which payment method was used in this transaction.'); 
    
    if (variable_get('setcom_do_email', TRUE) == TRUE) {
      $somestring .= t('<br>The store owner has been notified and will look into the problem.');
      uc_setcom_send_error('Transaction method error', 'Transaction method could not be determined. Contact Setcom regarding this problem. The order was not processed (stay Pending). Order no.:'. $order_check->order_id .' Order user ID:'. $order_check->uid);
    }
    watchdog('Setcom', $somestring, array(),  WATCHDOG_NOTICE);
    $output ='<a href="'. url() .'">Click to return to the front page.</a>';
    uc_order_comment_save($order_check->order_id, 0, $somestring);
    break;
    
  }
  return array($output, $somestring);
}

/**
* helper function for payment type details. 
*/
function uc_setcom_get_details() {
  $is_allowed=array();
  $is_allowed_wait=array();
  $not_allowed=array();
  
  if (variable_get('uc_setcom_credit_card', 0)==0) {
    $is_allowed[] ='Credit Card';
  } 
  elseif (variable_get('uc_setcom_credit_card', 0)==1) {
    $is_allowed_wait[] = ' Credit Card';
  } 
  else {
    $not_allowed[] =' Credit Card';
  }
  
  if (variable_get('uc_setcom_poli', 0)==0) {
    $is_allowed[] =' POLi/SID';
  }
  elseif (variable_get('uc_setcom_credit_poli', 0)==1) {
    $is_allowed_wait[] = ' POLi/SID';
  }
  else {
    $not_allowed[] =' POLi/SID';
  }
  
  if (variable_get('uc_setcom_balance', 0)==0) {
    $is_allowed[] =' Setcom Balance';
  }
  elseif (variable_get('uc_setcom_balance', 0)==1) {
    $is_allowed_wait[] = ' Setcom Balance';
  }
  else {
    $not_allowed[] =' Setcom Balance';
  }
  
  if (variable_get('uc_setcom_echeque', 0)==0) {
    $is_allowed[] =' eCheque';
  }
  elseif (variable_get('uc_setcom_echeque', 0)==1) {
    $is_allowed_wait[] = ' eCheque';
  }
  else {
    $not_allowed[] =' eCheque';
  }
  
  if (variable_get('uc_setcom_edeposit', 0)==0) {
    $is_allowed[] =' eDeposit';
  }
  elseif (variable_get('uc_setcom_edeposit', 0)==1) {
    $is_allowed_wait[] = ' eDeposit';
  }
  else {
    $not_allowed[] = ' eDeposit';
  }
  
  $details = t('<u><h4>Setcom offers a variety of payment methods. The following conditions apply to this shop:</h4> </u>');
  
  if ($is_allowed) {
    $details .= t('<u>Accepted payment methods that clear and dispatch immediate: </u><br>') . implode(", ", $is_allowed) .'.<br>';
  }
  if ($is_allowed_wait) {
    $details .= t('<u>Accepted payment methods that clear after a few days and will be dispatched only when payment received: </u><br>') . implode(", ", $is_allowed_wait) .'.<br>';
  }
  if ($not_allowed) {
    $details .= t('<u>These payment methods are not accepted. Order will not be honoured should you use them: </u><br>') . implode(", ", $not_allowed) .'.<br>';
  }
  return $details;
}

/**
* helper function for error email. 
*/
function uc_setcom_send_error($subject, $body) {
  $mail_to = variable_get('setcom_error_email', variable_get('site_mail', ini_get('sendmail_from')));
//  drupal_mail('setcom_error', $mail_to, $subject, $body, $mail_to);
  /* TODO Create a hook_mail($key, &$message, $params) function to generate
  the message body when called by drupal_mail. */
  $account = array(); // Set this as needed
  $language = user_preferred_language($account);
  $object = array(); // Replace this as needed
  $context['subject'] = $subject;
  $context['body'] = $body;
  $params = array('account' => $account, 'object' => $object, 'context' => $context);
  drupal_mail('uc_setcom', 'setcom_error', $mail_to, $language, $params, $mail_to);
}

/**
* Replacement function if wddx_deserialize does not exist. 
*/
if (!function_exists('wddx_deserialize')) {
  // Clone implementation of wddx_deserialize
  function wddx_deserialize($xmlpacket) {
    if ($xmlpacket instanceof SimpleXMLElement) {
      if (!empty($xmlpacket->struct)) {
        $struct = array();
        foreach ($xmlpacket->xpath("struct/var") as $var) {
          if (!empty($var["name"])) {
            $key = (string) $var["name"];
            $struct[$key] = wddx_deserialize($var);
          }
        }
        return $struct;
      }
      else if (!empty($xmlpacket->array)) { //jEdit php parser thinks this is an error, maybe because of the use of 'array' name as an object variable?
        $array = array();
        foreach ($xmlpacket->xpath("array/*") as $var) {
          array_push($array, wddx_deserialize($var));
        }
        return $array;
      } 
      else if (!empty($xmlpacket->string)) {
        return (string) $xmlpacket->string;
      } 
      else if (!empty($xmlpacket->number)) {
        return (int) $xmlpacket->number;
      } 
      else {
        if (is_numeric((string) $xmlpacket)) {
          return (int) $xmlpacket;
        } 
        else {
          return (string) $xmlpacket;
        }
      }
    }
    else {
      $sxe = simplexml_load_string($xmlpacket);
      $datanode = $sxe->xpath("/wddxPacket[@version='1.0']/data");
      return wddx_deserialize($datanode[0]);
    }
  }
}

/**
* Reformat amount values
**/
function getcurrency($amt, $cur) {
  if (strlen($cur) > 0) {
    switch (strtoupper($cur)) {
      
    case 'ZAR' :
      $cur_sym = 'R';
      break;
      
    case 'GBP' :
      $cur_sym = '�';
      break;
      
    case 'USD' :
      $cur_sym = '$';
      break;
      
    case 'EUR' :
      $cur_sym = 'E';
      break;
      
    default:
      $cur_sym = '';
    }
  } 
  else {
    $cur_sym = '';
  }
  if ($amt < 0) { 
    $amt=abs($amt);
    $new_amt = '-'. $cur_sym . number_format(($amt / 100), 2, '.', '');
  } 
  else {
    $new_amt = $cur_sym . number_format(($amt / 100), 2, '.', '');
  }
  return $new_amt;
}