Fixes for Paypal recurring fees handler (uc_recurring_hosted)

Hello,
I don't know what category this should really go under... I recently installed the uc_recurring module for a site I'm doing for a customer. However, upon installation I found that it was returning various errors. I tracked down some of the errors and I've made some modifications to the code to make it work w/the latest versions of Ubercart and Drupal.

Some of the items I fixed looked like they were typos, and there were others that were using function calls that either didn't exist anymore in Ubercart, or the function had changed to something different.

For the uc_order_admin function, I simply copied the function from an older version of uc_order. This is not intended as a permanent fix, rather as a band-aid until a view can be created for this purpose. (see http://drupal.org/node/1283352)

Most of the changes are related to the paypal portion of the module, since that was the payment processor that my client needed.

I hope my changes are useful to someone else, I've attached diffs below of what I've changed.
(I did these changes on the 7.x-2.x-dev version dated 2011-Dec-16)

-kevin hanser
Energy Web Design
http://www.energywebdevelopment.com

uc_recurring.module.diff

--- /sites/all/modules/uc_recurring/uc_recurring.module	Tue Jan 10 16:16:37 2012
+++ /sites/all/modules/uc_recurring/uc_recurring.module.updated	Tue Jan 10 16:14:46 2012
@@ -1233,3 +1233,122 @@
     'path' => drupal_get_path('module', 'uc_recurring') . '/views',
   );
 }
+
+/**
+ * Latest version of ubercart 3.x doesn't have this function anymore.
+ * (uses views instead to create the admin interface)
+ * However uc_recurring currently still looks for this function (see http://drupal.org/node/1283352)
+ * 
+ * As a temporary work-around, this function was copied 
+ * from ubercart-7.x-3.0-beta4/uc_order/uc_order.admin.inc
+ * 
+ */
+
+/**
+ * Displays the main order admin screen, an overview of all received orders.
+ */
+function uc_order_admin($condition = NULL, $search = FALSE) {
+  $header = array(
+    array('data' => t('Actions')),
+    array('data' => t('Order ID'), 'field' => 'o.order_id', 'sort' => 'desc'),
+    array('data' => t('Customer')),
+    array('data' => t('Total'), 'align' => 'center', 'field' => 'o.order_total'),
+    array('data' => t('Purchase date'), 'align' => 'center', 'field' => 'o.created'),
+    array('data' => t('Status'), 'field' => 'os.title'),
+  );
+
+  $address = variable_get('uc_customer_list_address', 'billing') == 'shipping' ? 'delivery' : 'billing';
+
+  $query = db_select('uc_orders', 'o')
+    ->fields('o', array(
+      'order_id',
+      'uid',
+      'order_total',
+      'created',
+      $address . '_first_name',
+      $address . '_last_name',
+      'order_status',
+    ));
+
+  $query->leftJoin('uc_order_statuses', 'os', 'o.order_status = os.order_status_id');
+  $query->fields('os', array('title'));
+
+  if (!is_null($condition) && $condition->count()) {
+    $query->condition($condition);
+  }
+
+  if (!isset($_GET['status']) || $_GET['status'] != 'all') {
+    if (!empty($_GET['status']) && is_string($_GET['status'])) {
+      $query->condition('o.order_status', $_GET['status']);
+    }
+    else {
+      $query->condition('o.order_status', uc_order_status_list('general', TRUE), 'IN');
+    }
+  }
+
+  $query = $query->extend('PagerDefault')->extend('TableSort')
+    ->orderByHeader($header)
+    ->limit(variable_get('uc_order_number_displayed', 30));
+
+  $rows = array();
+
+  $result = $query->execute();
+  foreach ($result as $order) {
+    $order_name = trim($order->{$address . '_first_name'} . ' ' . $order->{$address . '_last_name'});
+    if (!$order_name) {
+      if ($order->uid && $account = db_query("SELECT name FROM {users} WHERE uid = :uid", array(':uid' => $order->uid))->fetchField()) {
+        $order_name = t('User: !name', array('!name' => $account));
+      }
+      else {
+        $order_name = t('User: none');
+      }
+    }
+
+    $rows[] = array(
+      'data' => array(
+        array('data' => uc_order_actions($order, TRUE), 'nowrap' => 'nowrap'),
+        array('data' => $order->order_id),
+        array('data' => check_plain($order_name), 'nowrap' => 'nowrap'),
+        array('data' => array('#theme' => 'uc_price', '#price' => $order->order_total), 'align' => 'right'),
+        array('data' => format_date($order->created, 'uc_store'), 'align' => 'center'),
+        array('data' => $order->title),
+      ),
+      'id' => 'order-' . $order->order_id,
+    );
+  }
+
+  drupal_add_js(array(
+    'ucURL' => array(
+      'adminOrders' => url('admin/store/orders/'),
+    ),
+  ), 'setting');
+  drupal_add_js(drupal_get_path('module', 'uc_order') . '/uc_order.js');
+
+  $build = array();
+
+  if ($search === FALSE) {
+    $build['order_overview_select_form'] = drupal_get_form('uc_order_select_form') + array(
+      '#prefix' => '<div class="order-overview-form">',
+      '#suffix' => '</div>',
+    );
+    $build['order_overview_admin_sort_form'] = drupal_get_form('uc_order_admin_sort_form') + array(
+      '#prefix' => '<div class="order-overview-form">',
+      '#suffix' => '</div>',
+    );
+  }
+
+  $build['orders'] = array(
+    '#theme' => 'table',
+    '#header' => $header,
+    '#rows' => $rows,
+    '#attributes' => array('class' => array('uc-orders-table')),
+    '#weight' => 1,
+  );
+  $build['pager'] = array(
+    '#theme' => 'pager',
+    '#element' => 0,
+    '#weight' => 5,
+  );
+
+  return $build;
+}

modules/uc_recurring_hosted/uc_recurring_hosted.module.diff

--- /sites/all/modules/uc_recurring/modules/uc_recurring_hosted/uc_recurring_hosted.module	Tue Jan 10 16:20:08 2012
+++ /sites/all/modules/uc_recurring/modules/uc_recurring_hosted/uc_recurring_hosted.module.updated	Fri Jan  6 12:40:27 2012
@@ -24,7 +24,7 @@
     $items['uc_recurring_hosted/paypal/ipn'] = array(
       'title' => 'PayPal IPN',
       'page callback' => 'uc_recurring_hosted_paypal_ipn',
-      'access callback' => 'uc_paypal_ipn_access',
+      'access callback' => TRUE, //'uc_paypal_ipn_access',
       'type' => MENU_CALLBACK,
       'file' => 'uc_recurring_hosted.paypal_ipn.inc',
     );
@@ -32,7 +32,7 @@
       'title' => 'PayPal IPN',
       'page callback' => 'uc_recurring_hosted_paypal_ipn',
       'page arguments' => array(3),
-      'access callback' => 'uc_paypal_ipn_access',
+      'access callback' => TRUE, //'uc_paypal_ipn_access',
       'type' => MENU_CALLBACK,
       'file' => 'uc_recurring_hosted.paypal_ipn.inc',
     );
@@ -575,8 +575,10 @@
  * same trick to alter the paypal form, its a messy hack but works for now.
  */
 function uc_recurring_hosted_form_uc_paypal_wps_form_alter(&$form, $form_state) {
-  $order = $form['#parameters'][2];
-
+//  $order = $form['#parameters'][2];
+//  fix from: http://drupal.org/node/1380694
+  $order = $form_state['build_info']['args'][0];
+  
   $recurring_fees = array();
   // if recurring fees exist in the order
   if (module_exists('uc_recurring_product')) {

modules/uc_recurring_hosted/uc_recurring_hosted.paypal_ipn.inc.diff
--- /sites/all/modules/uc_recurring/modules/uc_recurring_hosted/uc_recurring_hosted.paypal_ipn.inc	Tue Jan 10 16:20:39 2012
+++ /sites/all/modules/uc_recurring/modules/uc_recurring_hosted/uc_recurring_hosted.paypal_ipn.inc.updated	Fri Jan  6 16:44:57 2012
@@ -35,6 +35,7 @@
   }
 
   if (_uc_recurring_hosted_paypal_ipn_validate($ipn)) {
+    watchdog('uc_recurring_hosted', 'Paypal IPN transaction type %txn_type for order id @order_id', array('%txn_type' => $ipn->txn_type, '@order_id' => $order->order_id));
     switch ($ipn->txn_type) {
       case 'subscr_signup':
       case 'recurring_payment_profile_created':
@@ -139,14 +140,15 @@
 
   switch ($ipn->payment_status) {
     case 'Canceled_Reversal':
-      uc_order_comment_save($ipn->order_id, 0, t('PayPal has cancelled the reversal and returned !amount !currency to your account.', array('!amount' => uc_price($ipn->mc_gross, $context, $options), '!currency' => $ipn->mc_currency)), 'admin');
+      uc_order_comment_save($ipn->order_id, 0, t('PayPal has cancelled the reversal and returned !amount !currency to your account.', array('!amount' => uc_currency_format($ipn->mc_gross, $options['sign']), '!currency' => $ipn->mc_currency)), 'admin');
       break;
 
     case 'Completed':
       $comment = t('PayPal transaction ID: @txn_id', array('@txn_id' => $ipn->txn_id));
+      // save the transaction in the order log
+      uc_order_comment_save($ipn->order_id, 0, t('Payment of @amount @currency submitted through PayPal.', array('@amount' => uc_currency_format($ipn->mc_gross, $options['sign']), '@currency' => $ipn->mc_currency)), 'order', 'payment_received');
+      uc_order_comment_save($ipn->order_id, 0, t('PayPal IPN reported a payment of @amount @currency.', array('@amount' => uc_currency_format($ipn->mc_gross, $options['sign']), '@currency' => $ipn->mc_currency)));
       uc_payment_enter($ipn->order_id, 'paypal_wps', $ipn->mc_gross, $user->uid, NULL, $comment);
-      uc_order_comment_save($ipn->order_id, 0, t('Payment of @amount @currency submitted through PayPal.', array('@amount' => uc_price($ipn->mc_gross, $context, $options), '@currency' => $ipn->mc_currency)), 'order', 'payment_received');
-      uc_order_comment_save($ipn->order_id, 0, t('PayPal IPN reported a payment of @amount @currency.', array('@amount' => uc_price($ipn->mc_gross, $context, $options), '@currency' => $ipn->mc_currency)));
       break;
 
     case 'Denied':
@@ -184,6 +186,11 @@
     case 'Voided':
       uc_order_comment_save($ipn->order_id, 0, t('The authorization has been voided.'), 'admin');
       break;
+      
+    default:
+      watchdog('uc_recurring_hosted', 'Payment status @status not recognized.  Nothing to do. !debug',
+        array('@status' => $ipn->payment_status, '!debug' => variable_get('uc_paypal_wps_debug_ipn', FALSE) ? '<pre>' . check_plain(print_r($_POST, TRUE)) . '</pre>' : ''));
+      break;
   }
 }
 
@@ -248,11 +255,11 @@
   else {
     $host = variable_get('uc_paypal_wps_server', 'https://www.sandbox.paypal.com/cgi-bin/webscr');
   }
-  $response = drupal_http_request($host, array('headers' => array('headers' => array(
+  $response = drupal_http_request($host, array(
         'headers' => array(),
         'method' => 'POST',
         'data' => $req,
-      ))));
+      ));
 
   // @todo: Change this to property_exists when we have a PHP requirement >= 5.1.
   if (array_key_exists('error', $response)) {
@@ -275,17 +282,14 @@
  * Check if we have already recieved a IPN with the same details.
  */
 function _uc_recurring_hosted_paypal_ipn_is_duplicate($ipn) {
-  if ($ipn->txn_id) {
-    $duplicate = db_query("SELECT COUNT(*) FROM {uc_payment_paypal_ipn} WHERE txn_id = :txn_id AND txn_type = :txn_type AND status <> :status", array(':txn_id' => : txn_id, ':txn_type' => : txn_type, ':status' => : status, '' => array(
-        ':txn_id' => : txn_id,
-        ':txn_type' => : txn_type,
-        ':status' => : status,
-        '' => array(
+  if (isset($ipn->txn_id)) {
+    $duplicate = db_query("SELECT COUNT(*) FROM {uc_payment_paypal_ipn} WHERE txn_id = :txn_id AND txn_type = :txn_type AND status <> :status", 
+        array(
           ':txn_id' => $ipn->txn_id,
           ':txn_type' => $ipn->txn_type,
           ':status' => 'Pending',
-        ),
-      )))->fetchField();
+        )
+      )->fetchField();
     if ($duplicate > 0) {
       watchdog('uc_recurring_hosted', 'IPN (Order:@order_id Txn: @txn_id) has been processed before.', array('@order_id' => $ipn->order_id, '@txn_id' => $ipn->txn_id), WATCHDOG_NOTICE);
       return TRUE;