Add handling for sagePay intolerance for empty card

Hopefully thephpleague/omnipay-sagepay#158
will be merged but for now SagePay assumes that an empty card is an ignore-everything-else-card

Also declare support sagepay alternate function choices per
thephpleague/omnipay-sagepay#157

Author: eileenmcnaughton

CRM/Core/Payment/OmnipayMultiProcessor.php

@@ -156,7 +156,9 @@ public function doPayment(&$params, $component = 'contribute') {
       if (!empty($params['token'])) {
         $response = $this->doTokenPayment($params);
       }
-      elseif (!empty($params['is_recur'])) {
+      // 'create_card_action' is a bit of a sagePay hack - see https://github.com/thephpleague/omnipay-sagepay/issues/157
+      // don't rely on it being unchanged - tests & comments are your friend.
+      elseif (!empty($params['is_recur']) && $this->getProcessorTypeMetadata('create_card_action') !== 'purchase') {
         $response = $this->gateway->createCard($this->getCreditCardOptions(array_merge($params, ['action' => 'Purchase']), $this->_component))->send();
       }
       else {
@@ -462,7 +464,7 @@ private function camelFieldName($fieldName) {
    *
    * @param array $params
    *
-   * @return array
+   * @return array|null
    */
   private function getCreditCardObjectParams($params) {
     $billingID = $locationTypes = CRM_Core_BAO_LocationType::getBilling();
@@ -516,6 +518,10 @@ private function getCreditCardObjectParams($params) {
         }
       }
     }
+    if (empty(array_filter($cardFields))) {
+      // sagepay hack - see https://github.com/thephpleague/omnipay-sagepay/issues/157#issuecomment-757448484
+      return NULL;
+    }
     return $cardFields;
   }
 
@@ -578,7 +584,12 @@ protected function getCreditCardOptions(array $params): array {
     $creditCardOptions = array_merge($creditCardOptions, $this->getProcessorPassThroughFields());
 
     CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $creditCardOptions);
-    $creditCardOptions['card'] = array_merge($creditCardOptions['card'], $this->getSensitiveCreditCardObjectOptions($params));
+    // This really is a hack just for sagepay. I meant to filter all
+    // empty but other processors expect it to be an object. Test cover exists.
+    // https://github.com/thephpleague/omnipay-sagepay/pull/158
+    if (!empty($creditCardOptions['card']) || !$this->getProcessorTypeMetadata('token_pay_action')) {
+      $creditCardOptions['card'] = array_merge($creditCardOptions['card'], $this->getSensitiveCreditCardObjectOptions($params));
+    }
     return $creditCardOptions;
   }
 

Metadata/omnipay_Sagepay_Server.mgd.php

@@ -74,6 +74,8 @@
       'ipn_processing_delay' => 0,
       // See https://github.com/thephpleague/omnipay-sagepay/pull/154
       'pass_through_fields' => ['billingForShipping' => 1],
+      'create_card_action' => 'purchase',
+      'token_pay_action' => 'repeatPurchase',
     ],
     'params' =>
       [
@@ -86,6 +88,7 @@
         'class_name' => 'Payment_OmnipayMultiProcessor',
         'billing_mode' => 4,
         'payment_type' => 3,
+        'is_recur' => TRUE,
       ],
   ],
 ];