| '; - $form['#suffix'] = ' | '. drupal_get_form('uc_migs_form', $order) .' |
Please upload appropriate logos to have the correct credit card icons beside the payment method (if the next checkbox is enabled). The missing file(s) are: ". - theme('item_list', $missing_cc_logos, '', 'ul', array('class' => 'error')) . '
' ; - } - $form['uc_migs_method_title_icons']['#description'] = 'The following logos can be displayed:@get', array('@get' => print_r($_GET,1)), WATCHDOG_WARNING ); - return theme('uc_migs_order_incomplete', 'Transaction could not be validated'); - } - else { - // validation success; fall thru to next phase - } - } else { - // Secure Hash was not validated, none there to validate - drupal_set_title('Transaction could not be processed'); - $order = uc_order_load($orderInfo); - watchdog( 'uc_migs', 'MIGS gateway rejected payment, and returned data did not contain a secure hash. $_GET was:
@get', array('@get' => print_r($_GET,1)), WATCHDOG_WARNING ); - return theme('uc_migs_order_incomplete', 'Transaction could not be validated', $receiptNo, $orderInfo, $order); - } - - $order = uc_order_load($orderInfo); - if ($order === FALSE) { - drupal_set_title('Transaction could not be processed'); - watchdog('uc_migs', 'MIGS gateway unable to find order to process. The Order ID returned from MIGS was @order_id, and $_GET was
@get', array('@order_id' => $orderInfo, '@get' => print_r($_GET,1)), WATCHDOG_WARNING); - return theme('uc_migs_order_incomplete', 'Order could not be found'); - } - - switch (uc_order_status_data($order->order_status, 'state')) { - case 'in_checkout' : - watchdog('uc_migs', 'MIGS payment notification received for order @order_id.', array('@order_id'=>$orderInfo)); - break ; - case 'post_checkout' : - if ( variable_get('uc_migs_repeat_checkouts', FALSE) ) { - watchdog('uc_migs', 'MIGS payment repeat notification received for order @order_id.', array('@order_id'=>$orderInfo)); - drupal_set_message('Permitting repeat checkout via MIGS.'); // it's for debug! localize the nag away if you must. - break ; - } - - drupal_set_title('Order Already Completed'); - // this happens when people reload the completion page. It's OK, - // but we'll make a note of it anyway. - watchdog('uc_migs', 'MIGS payment notification received for already checked out order @order_id.', array('@order_id'=>$orderInfo)); - return theme('uc_migs_order_incomplete', 'Order already completed', $receiptNo, $orderInfo, $order); - default: - drupal_set_title('Order Error'); - watchdog('uc_migs', 'MIGS payment notification received for order @order_id which is not yet in checkout status.', array('@order_id'=>$orderInfo)); - return theme('uc_migs_order_incomplete', 'Order not in checkout', $receiptNo, $orderInfo, $order); - } - - if ( $txnResponseCode != "0") { - // validation success, payment fail - drupal_set_title(t('Order Error')); - $errmsg = _uc_migs_get_response_description($txnResponseCode) ; - watchdog( 'uc_migs', 'A payment via MIGS failed. The error message was: %errmsg.
@get
@order', array('@get' => print_r($_GET,1), '@order' => print_r($order,1), '%errmsg' => $errmsg), WATCHDOG_WARNING ); - uc_order_comment_save($order->order_id, 0, t('Error processing payment for this order.'), 'admin'); - return theme('uc_migs_order_incomplete', $errmsg, $receiptNo, $orderInfo, $order) ; - } else { - // success - $targs = array( - '@order' => $orderInfo, - '@receipt' => $receiptNo, - '@trans' => $transactionNo, - '@amount' => uc_currency_format($amount/100), - ) ; - $comment = t('A payment of @amount for order #@order was made via MIGS by credit card with receipt number: @receipt and transaction number: @trans', $targs); - // we also attach the MIGS receipt number to the order so we can - // use it in an order token. Some MIGS banks require this number - // be displayed to the purchaser in order to more readily process - // complaints. - $order->data['migs_receiptno'] = $receiptNo ; - uc_order_save($order); - // uc_order_save() saves order_status so it needs to happen before uc_payment_enter() - uc_payment_enter($order->order_id, 'migs', $amount/100, 0, NULL, $comment); - - // Empty the cart... - uc_cart_empty($cart_id); - - $do_login = variable_get('uc_new_customer_login', FALSE ); - $output = uc_cart_complete_sale($order, $do_login); - $output = str_replace('[site-url]', url(), $output); - - // Add a comment to let sales team know this came in through the site. - uc_order_comment_save($order->order_id, 0, t('A payment has been accepted.'), 'admin'); - } - return $output; -} - -/** - * This method uses the QSI Response code retrieved from the Digital - * Receipt and returns an appropriate description for the QSI Response Code - * - * @param $responseCode String containing the QSI Response Code - * - * @return String containing the appropriate description - */ -function _uc_migs_get_response_description($responseCode) { - switch ($responseCode) { - case "0" : - $result = "Transaction Successful"; - break; - case "?" : - $result = "Transaction status is unknown"; - break; - case "1" : - $result = "Transaction could not be processed"; - break; - case "2" : - $result = "Bank Declined Transaction"; - break ; - case "3" : - $result = "No Reply from Bank"; - break ; - case "4" : - $result = "Expired Card"; - break ; - case "5" : - $result = "Insufficient funds"; - break ; - case "6" : - $result = "Error Communicating with Bank"; - break ; - case "7" : - $result = "Payment Server System Error"; - break ; - case "8" : - $result = "Transaction Type Not Supported"; - break ; - case "9" : - $result = "Bank declined transaction (Do not contact Bank)"; - break ; - case "A" : - $result = "Transaction Aborted"; - break ; - case "C" : - $result = "Transaction Cancelled"; - break ; - case "D" : - $result = "Deferred transaction has been received and is awaiting processing"; - break ; - case "F" : - $result = "3D Secure Authentication failed"; - break ; - case "I" : - $result = "Card Security Code verification failed"; - break ; - case "L" : - $result = "Shopping Transaction Locked (Please try the transaction again later)"; - break ; - case "N" : - $result = "Cardholder is not enrolled in Authentication scheme"; - break ; - case "P" : - $result = "Transaction has been received by the Payment Adaptor and is being processed"; - break ; - case "R" : - $result = "Transaction was not processed - Reached limit of retry attempts allowed"; - break ; - case "S" : - $result = "Duplicate SessionID (OrderInfo)"; - break ; - case "T" : - $result = "Address Verification Failed"; - break ; - case "U" : - $result = "Card Security Code Failed"; - break ; - case "V" : - $result = "Address Verification and Card Security Code Failed"; - break ; - default : - $result = "Unable to be determined"; - } - return $result; -} - -/** - * Helper function to return a named array of CC provider logos to display. - * - * Note that you need not override this; you can simply alter the - * variables or replace the files in the default location. - */ -function _uc_migs_cc_logos() { - $cc_logos = array( - 'MasterCard' => variable_get('uc_migs_logo_mastercard', file_directory_path() .'/uc_migs/mastercard.gif'), - 'Visa' => variable_get('uc_migs_logo_visa', file_directory_path() .'/uc_migs/visa.gif'), - ) ; - return $cc_logos ; -} - -/** - * Allow people to override the logo display. - * - * return theme('imagecache', 'cc_logo', $filename, $alttext) ; - * - * I like to then do something like the above in my theme. Of course, - * you can always modify the provider logos, but why open Photoshop - * when you have Drupal? 'cc_logo' is a scale preset with height=50. - */ -function theme_uc_migs_cc_logo($filename, $alttext='') { - return theme('image', $filename, $alttext) ; -} - -/** - * Implementation of hook_token_values(). (token.module) - */ -function uc_migs_token_values($type, $object = NULL) { - switch ($type) { - case 'order': - $order = $object; - if ( isset($order->data['migs_receiptno']) ) { - $values['order-migs-receiptno'] = $order->data['migs_receiptno'] ; - } - break; - } - return $values; -} - -/** - * Implementation of hook_token_list(). (token.module) - */ -function uc_migs_token_list($type = 'all') { - if ($type == 'order' || $type == 'ubercart' || $type == 'all') { - $tokens['order']['order-migs-receiptno'] = t('MIGS Receipt Number (if payment processed via uc_migs)'); - } - return $tokens; -} - -/** - * Preprocess function for uc_migs_order_incomplete() - */ -function template_preprocess_uc_migs_order_incomplete(&$variables) { - if ( empty($variables['order_info']) ) { - $variables['order_id'] = 'Unknown Order ID' ; - } - else { - $variables['order_id'] = t('Order #@order_info', array('@order_info' => $variables['order_info'])); - } - if ( empty($variables['response_receiptno']) ) { - $variables['receipt_no'] = 'Unknown Receipt No' ; - } - else { - $variables['receipt_no'] = t('Receipt #@receipt_no', array('@receipt_no' => $variables['response_receiptno'])); - } - // by doing this, we make it possible for sites to reveal more - // detailed error messages via themeing, and still conceal them - // by default which keeps MIGS happy (by default) - switch ( $variables['response_message'] ) { - // these variables indicate a site config issue or other - // issue we don't want to share with the great unwashed - case 'Site configuration error' : - case 'Transaction could not be validated' : - case 'Transaction could not be processed' : - case 'Order could not be found' : - $variables['error_message'] = 'Transaction error.' ; - break ; - - // however, if the problem is with the buyer's CC, we want to tell them what's wrong - default : - $variables['error_message'] = $variables['response_message'] ; - } -} - -/** - * Implementation of hook_ucga_display from UC Google Analytics module - */ -function uc_migs_ucga_display() { - if (arg(0) == 'cart' && arg(1) == 'migs' && arg(2) == 'complete') { - return TRUE; - } - return FALSE; -} + array( + 'arguments' => array( + 'response_message' => '', // will be replaced with error description + 'response_receiptno' => '', // RRN from MIGS + 'order_info' => '', // order ID from Ubercart + 'order' => NULL, // order, if applicable + ), + 'template' => 'uc-migs-order-incomplete', + ), + 'uc_migs_cc_logo' => array( + 'variables' => array( + 'path' => '', + 'alt' => '', + ), + ), + ); +} + +/** + * Implementation of hook_menu(). + */ +function uc_migs_menu() { + $items['cart/migs/complete'] = array( + 'title' => 'Order complete', + 'page callback' => 'uc_migs_complete', + 'access arguments' => array('access content'), + 'type' => MENU_CALLBACK, + ); + return $items; +} + +/** + * Implementation of hook_form_alter(). + */ +function uc_migs_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 == 'migs') { + unset($form['submit']); + $form['#prefix'] = '
| '; + $form['#suffix'] = ' | '. drupal_get_form('uc_migs_form', $order) .' |
Please upload appropriate logos to have the correct credit card icons beside the payment method (if the next checkbox is enabled). The missing file(s) are: ". + theme('item_list', $missing_cc_logos, '', 'ul', array('class' => 'error')) . '
' ; + } + $form['uc_migs_method_title_icons']['#description'] = 'The following logos can be displayed:@get', array('@get' => print_r($_GET,1)), WATCHDOG_WARNING ); + return theme('uc_migs_order_incomplete', 'Transaction could not be validated'); + } + else { + // validation success; fall thru to next phase + } + } else { + // Secure Hash was not validated, none there to validate + drupal_set_title('Transaction could not be processed'); + $order = uc_order_load($orderInfo); + watchdog( 'uc_migs', 'MIGS gateway rejected payment, and returned data did not contain a secure hash. $_GET was:
@get', array('@get' => print_r($_GET,1)), WATCHDOG_WARNING ); + return theme('uc_migs_order_incomplete', 'Transaction could not be validated', $receiptNo, $orderInfo, $order); + } + + $order = uc_order_load($orderInfo); + if ($order === FALSE) { + drupal_set_title('Transaction could not be processed'); + watchdog('uc_migs', 'MIGS gateway unable to find order to process. The Order ID returned from MIGS was @order_id, and $_GET was
@get', array('@order_id' => $orderInfo, '@get' => print_r($_GET,1)), WATCHDOG_WARNING); + return theme('uc_migs_order_incomplete', 'Order could not be found'); + } + + switch (uc_order_status_data($order->order_status, 'state')) { + case 'in_checkout' : + watchdog('uc_migs', 'MIGS payment notification received for order @order_id.', array('@order_id'=>$orderInfo)); + break ; + case 'post_checkout' : + if ( variable_get('uc_migs_repeat_checkouts', FALSE) ) { + watchdog('uc_migs', 'MIGS payment repeat notification received for order @order_id.', array('@order_id'=>$orderInfo)); + drupal_set_message('Permitting repeat checkout via MIGS.'); // it's for debug! localize the nag away if you must. + break ; + } + + drupal_set_title('Order Already Completed'); + // this happens when people reload the completion page. It's OK, + // but we'll make a note of it anyway. + watchdog('uc_migs', 'MIGS payment notification received for already checked out order @order_id.', array('@order_id'=>$orderInfo)); + return theme('uc_migs_order_incomplete', 'Order already completed', $receiptNo, $orderInfo, $order); + default: + drupal_set_title('Order Error'); + watchdog('uc_migs', 'MIGS payment notification received for order @order_id which is not yet in checkout status.', array('@order_id'=>$orderInfo)); + return theme('uc_migs_order_incomplete', 'Order not in checkout', $receiptNo, $orderInfo, $order); + } + + if ( $txnResponseCode != "0") { + // validation success, payment fail + drupal_set_title(t('Order Error')); + $errmsg = _uc_migs_get_response_description($txnResponseCode) ; + watchdog( 'uc_migs', 'A payment via MIGS failed. The error message was: %errmsg.
@get
@order', array('@get' => print_r($_GET,1), '@order' => print_r($order,1), '%errmsg' => $errmsg), WATCHDOG_WARNING ); + uc_order_comment_save($order->order_id, 0, t('Error processing payment for this order.'), 'admin'); + return theme('uc_migs_order_incomplete', $errmsg, $receiptNo, $orderInfo, $order) ; + } else { + // success + $targs = array( + '@order' => $orderInfo, + '@receipt' => $receiptNo, + '@trans' => $transactionNo, + '@amount' => uc_currency_format($amount/100), + ) ; + $comment = t('A payment of @amount for order #@order was made via MIGS by credit card with receipt number: @receipt and transaction number: @trans', $targs); + // we also attach the MIGS receipt number to the order so we can + // use it in an order token. Some MIGS banks require this number + // be displayed to the purchaser in order to more readily process + // complaints. + $order->data['migs_receiptno'] = $receiptNo ; + uc_order_save($order); + // uc_order_save() saves order_status so it needs to happen before uc_payment_enter() + uc_payment_enter($order->order_id, 'migs', $amount/100, 0, NULL, $comment); + + // Empty the cart... + uc_cart_empty($cart_id); + + $do_login = variable_get('uc_new_customer_login', FALSE ); + $output = uc_cart_complete_sale($order, $do_login); + $output = str_replace('[site-url]', url(), $output); + + // Add a comment to let sales team know this came in through the site. + uc_order_comment_save($order->order_id, 0, t('A payment has been accepted.'), 'admin'); + } + return $output; +} + +/** + * This method uses the QSI Response code retrieved from the Digital + * Receipt and returns an appropriate description for the QSI Response Code + * + * @param $responseCode String containing the QSI Response Code + * + * @return String containing the appropriate description + */ +function _uc_migs_get_response_description($responseCode) { + switch ($responseCode) { + case "0" : + $result = "Transaction Successful"; + break; + case "?" : + $result = "Transaction status is unknown"; + break; + case "1" : + $result = "Transaction could not be processed"; + break; + case "2" : + $result = "Bank Declined Transaction"; + break ; + case "3" : + $result = "No Reply from Bank"; + break ; + case "4" : + $result = "Expired Card"; + break ; + case "5" : + $result = "Insufficient funds"; + break ; + case "6" : + $result = "Error Communicating with Bank"; + break ; + case "7" : + $result = "Payment Server System Error"; + break ; + case "8" : + $result = "Transaction Type Not Supported"; + break ; + case "9" : + $result = "Bank declined transaction (Do not contact Bank)"; + break ; + case "A" : + $result = "Transaction Aborted"; + break ; + case "C" : + $result = "Transaction Cancelled"; + break ; + case "D" : + $result = "Deferred transaction has been received and is awaiting processing"; + break ; + case "F" : + $result = "3D Secure Authentication failed"; + break ; + case "I" : + $result = "Card Security Code verification failed"; + break ; + case "L" : + $result = "Shopping Transaction Locked (Please try the transaction again later)"; + break ; + case "N" : + $result = "Cardholder is not enrolled in Authentication scheme"; + break ; + case "P" : + $result = "Transaction has been received by the Payment Adaptor and is being processed"; + break ; + case "R" : + $result = "Transaction was not processed - Reached limit of retry attempts allowed"; + break ; + case "S" : + $result = "Duplicate SessionID (OrderInfo)"; + break ; + case "T" : + $result = "Address Verification Failed"; + break ; + case "U" : + $result = "Card Security Code Failed"; + break ; + case "V" : + $result = "Address Verification and Card Security Code Failed"; + break ; + default : + $result = "Unable to be determined"; + } + return $result; +} + +/** + * Helper function to return a named array of CC provider logos to display. + * + * Note that you need not override this; you can simply alter the + * variables or replace the files in the default location. + Drupal 7: + file_directory_path() has been removed: http://drupal.org/update/modules/6/7#file_directory_path + + */ +function _uc_migs_cc_logos() { +// $files_path = variable_get('file_public_path', conf_path() . '/files'); + $cc_logos = array( +// 'MasterCard' => variable_get('uc_migs_logo_mastercard', file_directory_path() .'/uc_migs/mastercard.gif'), + 'MasterCard' => uc_migs_credit_image('mastercard'), +// 'Visa' => variable_get('uc_migs_logo_visa', file_directory_path() .'/uc_migs/visa.gif'), + 'Visa' => uc_migs_credit_image('visa'), + ) ; + return $cc_logos ; +} + + +function uc_migs_credit_image($type) { + static $cc_types = array('visa', 'mastercard', 'discover', 'amex'); + static $path; + if(!isset($path)) { $path = base_path() . drupal_get_path('module', 'uc_credit'); } + if(in_array($type, $cc_types)) { + if (variable_get('uc_credit_' . $type, TRUE)) { + return $path . '/images/' . $type . '.gif'; + } + } + return ''; +} + + +/** + * Allow people to override the logo display. + * + * return theme('imagecache', 'cc_logo', $filename, $alttext) ; + * + * I like to then do something like the above in my theme. Of course, + * you can always modify the provider logos, but why open Photoshop + * when you have Drupal? 'cc_logo' is a scale preset with height=50. + */ +function theme_uc_migs_cc_logo($variables) { +// return theme('image', $filename, $alttext) ; + return theme('image', $variables) ; +} + +/** + * Implementation of hook_token_values(). (token.module) + */ +function uc_migs_token_values($type, $object = NULL) { + switch ($type) { + case 'order': + $order = $object; + if ( isset($order->data['migs_receiptno']) ) { + $values['order-migs-receiptno'] = $order->data['migs_receiptno'] ; + } + break; + } + return $values; +} + +/** + * Implementation of hook_token_list(). (token.module) + */ +function uc_migs_token_list($type = 'all') { + if ($type == 'order' || $type == 'ubercart' || $type == 'all') { + $tokens['order']['order-migs-receiptno'] = t('MIGS Receipt Number (if payment processed via uc_migs)'); + } + return $tokens; +} + +/** + * Preprocess function for uc_migs_order_incomplete() + */ +function template_preprocess_uc_migs_order_incomplete(&$variables) { + if ( empty($variables['order_info']) ) { + $variables['order_id'] = 'Unknown Order ID' ; + } + else { + $variables['order_id'] = t('Order #@order_info', array('@order_info' => $variables['order_info'])); + } + if ( empty($variables['response_receiptno']) ) { + $variables['receipt_no'] = 'Unknown Receipt No' ; + } + else { + $variables['receipt_no'] = t('Receipt #@receipt_no', array('@receipt_no' => $variables['response_receiptno'])); + } + // by doing this, we make it possible for sites to reveal more + // detailed error messages via themeing, and still conceal them + // by default which keeps MIGS happy (by default) + switch ( $variables['response_message'] ) { + // these variables indicate a site config issue or other + // issue we don't want to share with the great unwashed + case 'Site configuration error' : + case 'Transaction could not be validated' : + case 'Transaction could not be processed' : + case 'Order could not be found' : + $variables['error_message'] = 'Transaction error.' ; + break ; + + // however, if the problem is with the buyer's CC, we want to tell them what's wrong + default : + $variables['error_message'] = $variables['response_message'] ; + } +} + +/** + * Implementation of hook_ucga_display from UC Google Analytics module + */ +function uc_migs_ucga_display() { + if (arg(0) == 'cart' && arg(1) == 'migs' && arg(2) == 'complete') { + return TRUE; + } + return FALSE; +}