Express Checkout Feature Addition

I suspect the current Express Checkout code in this module is close to right, so that's where I would concentrate if it would meet your needs.

Eventually I also want to move the EC code out to its own submodule, which would avoid the conflict issues.

Does that answer your question?

I too am after this functionality. I will submit a patch in the next hour or so that will separate the PayPal Express code out into its own sub-module. Once that initial patch is committed, I will proceed to submit bug-fix and code-cleanup (per http://drupal.org/coding-standards) patches.

Kwinters, I would be happy to join this project as a co-maintainer if you're interested as I have several clients using this service.

Cheers,

Antoine

Antoine: Sure, I could use the help (busy busy). Check out the 6.x-2.x branch for my ideas on how to split it up. Send me a contact re: CVS access and we can work out the details.

Noloco: I think Express Checkout is supposed to tie directly into your PFP account and deposit the money there. I'm not entirely sure about it though.

Attached is a patch that moves the Express Checkout code into its own sub-module. This patch is a direct backport from the 2.x branch. I did not add an update hook to automatically enable the new sub-module because it is my understanding that this code has never been used because it doesn't work. Please correct me if I am wrong and point me to what I can use to detect if the user is currently using this portion of the code. I will then re-roll the patch with an update hook.

Cheers,

Antoine

And here is the patch!

Cheers,

Antoine

noloco,

Looks like I missed the form settings. Attached is a new patch that also removes the Express Checkout form settings from the uc_payflowpro module. Also, if you could update the status after you test a patch, it would help the module maintainers ;)

kwinters,

In the 6.x-2.x branch there are also some recurring form settings removed from the main module and put into the Express Checkout module. I'm not sure if those were specific to trying to use the uc_recurring project and should still be moved over to the new Express Checkout sub-module. Your input would be appreciated.

Cheers,

Antoine

Oh boy, lots of stuff going on here.

Re: upgrade path - The Express checkout may have worked in D5, but I'm pretty certain it has never worked in D6. I wouldn't write an upgrade path unless someone actually needs it. There are only a handful of D5 installs in the wild anyway.

2.x branch - The uc_recurring module mainly just acts as a bridge between the PFP recurring API code (not PayPal) with ubercart core, eliminating some code from the module and allowing better integration with other recurring logic via standardization and hooks. The uc_recurring code is in a separate submodule in 2.x, so using any other module for recurring would be possible. As for Express Checkout and recurring, any of that would be specific to the PFP EC sub-module or potentially the PayPal module (but I think yours is an unusual case).

2.x settings - which settings are you talking about, specifically? Anything that ended up in the EC submodule could have been an accident, since I was basically just getting that code out of the way. I don't remember *adding* any settings for uc_recurring, but that was a while ago and I could be mistaken.

kwinters,

This code is found in the uc_payflowpro_settings_form() function in the uc_payflowpro.module file.

  $form['payflowpro_settings']['recurring'] = array(
    '#type' => 'fieldset',
    '#title' => t('Recurring Settings'),
    '#description' => t('Settings specific to recurring profiles.'),
    '#collapsible' => TRUE,
    '#collapsied' => TRUE,
  );
  $form['payflowpro_settings']['recurring']['uc_payflowpro_enable_recurring'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable recurring products'),
    '#default_value' => variable_get('uc_payflowpro_enable_recurring', FALSE),
    '#description' => t('Checking this box will enabled recurring profiles on
                        products that have an expiration.'),
  );
  $form['payflowpro_settings']['recurring']['uc_payflowpro_recurring_create_order'] = array(
    '#type' => 'checkbox',
    '#title' => t('Successful recurring payments should create a duplicate order'),
    '#default_value' => variable_get('uc_payflowpro_recurring_create_order', FALSE),
    '#description' => t('If this box is unchecked, the original order will be updated instead.'),
  );
  $form['payflowpro_settings']['recurring']['uc_payflowpro_recurring_site_key'] = array(
    '#type' => 'textfield',
    '#title' => t('Site key'),
    '#description' => t('The site key is used to namespace your site from other
                        sites. This should be short, all letters or numbers or both,
                        e.g. mysite, or prodsite, etc.'),
    '#default_value' => variable_get('uc_payflowpro_recurring_site_key', ''),
  );

The above code no longer exists in the uc_payflowpro module in the 2.x branch. However, this code is found in the uc_payflowpro_ec_form_uc_payment_gateways_form_alter() function in the uc_payflowpro_ec.module file in the 2.x branch (it is commented out as if it was still under heavy development).

  /*$fields = array(
    '#type' => 'fieldset',
    '#title' => t('Recurring Settings'),
    '#description' => t('Settings specific to recurring profiles.'),
    '#collapsible' => TRUE,
    '#collapsied' => TRUE,
  );
  // TODO: remove this option? also change in uninstall / update hooks
  $fields['uc_payflowpro_recurring_create_order'] = array(
    '#type' => 'checkbox',
    '#title' => t('Successful recurring payments should create a duplicate order'),
    '#default_value' => variable_get('uc_payflowpro_recurring_create_order', FALSE),
    '#description' => t('If this box is unchecked, the original order will be updated instead.'),
  );
  $fields['uc_payflowpro_recurring_site_key'] = array(
    '#type' => 'textfield',
    '#title' => t('Site key'),
    '#description' => t('The site key is used to namespace your site from other
                        sites. This should be short, all letters or numbers or both,
                        e.g. mysite, or prodsite, etc.'),
    '#default_value' => variable_get('uc_payflowpro_recurring_site_key', ''),
  );

  $form['gateways']['payflowpro']['payflowpro_settings']['recurring'] = $fields;*/

I wasn't sure if this code was accidentally copied over, if it was necessary for integrating with the uc_recurring module, or if it is required for recurring to work at all? Any insight is helpful. If you are unsure, I'll begin digging deeper tomorrow.

Cheers,

Antoine

uc_payflowpro_recurring_create_order and uc_payflowpro_recurring_site_key were moved to the _recurring submodule (function uc_payflowpro_recurring_form_uc_payment_gateways_form_alter). uc_payflowpro_enable_recurring was no longer needed, as it's implied by the module being enabled.

None of them should be in the EC module. Even if EC ends up with its own recurring logic, the setting keys should probably still be changed.

kwinters,

OK... So #14 is a non-issue since the patch leaves the original code in the main module and does not add it to the new PFP EC sub-module. Please let me know if there are any other concerns with the patch of if you think this is RTCB.

Cheers,

Antoine

re: #17 - That is the correct recurring module, which provides the interface for adding recurring features to products, etc. All of the credit card actions still pass through the PFP recurring API though: initial setup, the periodic charges, recurring cancellation, etc.

The uc_recurring module doesn't really add any new features, just offloads things that the module already did. However, this should make it more useful with uc_roles, etc. since it's a standard.

re: #16 - The patch looks mostly fine. I want to follow up on a few things in detail, mostly uninstall related.

I renamed the issue, since it became more about EC than anything.

This seems like an accident (it was copied to the new location as-is):

$order->billing_street1 = $response->PayPalResult->EMail;

The original Express Checkout code was copied from either the 5.x-1.x or the 6.x-1.x uc_paypal module and is greatly outdated. I have completely rewritten the Express Checkout code copying the latest code from the uc_paypal module and making the necessary changes to work with the PayFlow Pro gateway per the developers documentation linked comment #6. Patch attached.

Note: This patch was generated from the GIT repository below because trying to generate patches that include adding new folders/files is near impossible with CVS.

Cheers,

Antoine

AntoineSolutions, please run through all the changes and check for XSS issues, then commit. It will need a CHANGELOG entry, too.

This is the section I noticed, but there may be others: $order->billing_street1 = $response['STREET'];

Hey kwinters,

I have attached a new patch.

After reviewing the documentation listed below, I believe I have been incorrectly using check_plain(). The check_plain() function should only be used on user submitted data when outputting, not when saving, and only in circumstances where Drupal is not already performing the check for us. Please review the documentation listed below and my changes to the patch and let me know if you concur with my findings.

http://drupal.org/writing-secure-code
http://drupal.org/node/101495
http://drupal.org/node/28984

Cheers,

Antoine

subscribing - intending to deploy PayPal Express and Pay Flow Pro with no recurring (for now...) and will be testing last patch

Just tested this with Paypal Sandbox accounts using PayPal Express and Pay Flow Pro (no recurring).

Seems to work fine until confirming the purchase on Paypal. I get a white screen upon redirection.

Warning: call_user_func_array() [<a href='function.call-user-func-array'>function.call-user-func-array</a>]: First argument is expected to be a valid callback, 'uc_payflowpro_ec_review_redirect' was given in menu_execute_active_handler() (line 348 of /htdocs/includes/menu.inc).

Probably due to chunks failing during install - From the .rej file:

***************
*** 25,63 ****
   * Implementation of hook_menu()
   */
  function uc_payflowpro_menu() {
- 
-   // Callback functions for Express Checkout
-   $items['cart/echeckout/selected'] = array(
-     'title' => 'Review order',
-     'page callback' => 'uc_payflowpro_ec_review_redirect',
-     'access arguments' => array('access content'),
-     'type' => MENU_CALLBACK,
-   );
-   $items['cart/echeckout/review'] = array(
-     'title' => 'Review payment',
-     'page callback' => 'uc_payflowpro_ec_review',
-     'access arguments' => array('access content'),
-     'type' => MENU_CALLBACK,
-   );
-   $items['cart/echeckout/submit'] = array(
-     'title' => 'Submit order',
-     'page callback' => 'uc_payflowpro_ec_submit',
-     'access arguments' => array('access content'),
-     'type' => MENU_CALLBACK,
-   );
-   $items['cart/echeckout/complete'] = array(
-     'title' => 'Order complete',
-     'page callback' => 'uc_payflowpro_ec_complete',
-     'access arguments' => array('access content'),
-     'type' => MENU_CALLBACK,
-   );
-   $items['cart/echeckout/cancel'] = array(
-     'title' => 'PayPal payment cancelled',
-     'page callback' => 'uc_payflowpro_ec_cancel',
-     'access arguments' => array('access content'),
-     'type' => MENU_CALLBACK,
-   );
- 
    // Recurring Billing administration
    $items['admin/store/settings/uc_recurring'] = array(
      'title' => 'Payflow Pro Recurring Settings',
--- 25,30 ----
   * Implementation of hook_menu()
   */
  function uc_payflowpro_menu() {
    // Recurring Billing administration
    $items['admin/store/settings/uc_recurring'] = array(
      'title' => 'Payflow Pro Recurring Settings',

Any follow-up to this? The patch in #22 allows us to use Express Checkout (the module did not work previously) however I have not yet been able to test all the way through. We need to get this working... any updates would be appreciated, otherwise I will try to work on it myself now.

@bbqsauced: you have to apply the patch to the -dev version, then it'll apply correctly.

+1 for the patch in #22.

I don't know about anyone else, but I suggest asking AntoineSolutions if he'd be willing to co-maintain the module and add all of his patches so this module can finally work correctly.

The only way this could be improved would be to have an update script in uc_payflowpro.install to automatically enable the module if the checkout pane was enabled.

FYI if you're using my patch from #1661716: Code in uc_payflowpro_form_alter() causes checkout to fail you have to first revert that patch (easy way: download uc_payflowpro-6.x-1.x-dev again) and then apply this patch.

Note that if you're using the patch from #22 -- which substantially works -- you will find that the Paypal checkout page's left-hand-column order summary doesn't contain the details of the customer's order if any of the following are applied to the order in Ubercart:

• Shipping
• Taxes
• Coupon Discounts
• Multiple quantities of any product in the cart

The module still works, and customers can still check out, but they won't see a summary of their order (and thus not the total amount they are signing in to pay for) in most circumstances.

Paypal's Payflow Pro Express Checkout API will only display the order summary if the order total (the AMT parameter) equals the sum of the item total (ITEMAMT), taxes (TAXAMT) and shipping (FREIGHTAMT).

Shipping and Tax

This module does not pass shipping or tax information to Paypal at all, so unless you have a tax-free order with no shipping you will not see the order summary.

We added the passing of shipping and tax in the uc_payflowpro_ec_checkout() function of uc_payflowpro_ec.module with:

$tax = 0;
$shipping = 0;

if (is_array($order->line_items)) {
  foreach ($order->line_items as $item) {
    if ($item['type'] == 'shipping') {
      $shipping += $item['amount'];
    }
  }
}

if (module_exists('uc_taxes')) {
  foreach (uc_taxes_calculate($order) as $tax_item) {
    $tax += $tax_item->amount;
  }
}

and then adding these to the $request array:

    'TAXAMT' => substr(uc_price($tax, $context, $options), 0, 10),
    'FREIGHTAMT' => substr(uc_price($shipping, $context, $options), 0, 10),

Coupon Discounts

Also, this module does not add a line item for coupon discounts (applied, for example, by the uc_coupon module). Note that if you plan to modify the module to handle coupons, if you pass the DISCOUNT parameter this will appear in the Paypal order summary as "Shipping Discount" and note also that the ADJUSTMENTAMT parameter appears to be only for Paypal internal use. Our solution was to add a line item with a negative amount, like this (where $discount is the amount of the discount, a negative number, and $discountlabel is the label to show with the discount in the Paypal order summary), in the uc_payflowpro_ec_checkout() function in uc_payflowpro_ec.module:

if ($discount < 0) {
  $maxnum = 0;
  foreach($request as $k => $v) {
    if (substr($k,0,6) == 'L_NAME') {
      $num = str_replace('L_NAME','',$k);
      if ($num > $maxnum) {
        $maxnum = $num;
      }
    }
  } 
  $newnum = $maxnum + 1;

  $request['L_NAME' . $newnum] = 'Discounts';
  $request['L_DESC' . $newnum] = substr(check_plain($discountlabel), 0, 35);
  $request['L_COST' . $newnum] = substr(uc_price($discount, $ec_context, $ec_options), 0, 10);
  $request['L_QTY' . $newnum] = 1;

  $subtotal += $discount;

  // Set the updated item subtotal amount now that we've applied discounts
  $request['ITEMAMT'] = substr(uc_price($subtotal, $ec_context, $ec_options), 0, 10);
}

Multiple quantities of any product in the cart

Paypal's Payflow Pro Express Checkout API expects the L_COSTn parameter passed to be the unit cost of the product; as it stands the module passes the aggregate cost (qty * price). This means that if the quantity is more than one Paypal will not display the order summary.

We fixed this by modifying the uc_payflowpro_ec_request_products() function in uc_payflowpro_ex.inc so that the the line:

$request['L_COST' . $i] = substr(uc_price($price_info, $ec_context, $ec_options), 0, 10);

passes $priceinfo with a 'qty' key of '1'.

With all of the above added to the module, we are now successfully getting the Paypal order summary on all orders:

That's some excellent work. Any chance you could get this in a patch as well? We suffer from the same issue, and I'd love to test a proper patch. I would also be able to modify this to work with UC Gift Certificates, as using them for partial payment is essentially the same as including a coupon discount, and requires its own negative line item in the order.

Thanks!