CRM-16808 standardisation of paypal express
[civicrm-core.git] / CRM / Contribute / BAO / Contribution / Utils.php
index ddf23e8f8e2fc1707d6c3b4726aadbed72297329..a92cda79435c14592497d46caf1da9e4dd2f695a 100644 (file)
@@ -144,8 +144,7 @@ class CRM_Contribute_BAO_Contribution_Utils {
         // add qfKey so we can send to paypal
         $form->_params['qfKey'] = $form->controller->_key;
         if ($component == 'membership') {
-          $membershipResult = array(1 => $contribution);
-          return $membershipResult;
+          return array('contribution' => $contribution);
         }
         else {
           if (!$isPayLater) {
@@ -185,29 +184,17 @@ class CRM_Contribute_BAO_Contribution_Utils {
         }
       }
     }
-    elseif ($form->_contributeMode == 'express') {
-      if ($form->_values['is_monetary'] && $form->_amount > 0.0) {
-        // determine if express + recurring and direct accordingly
-        if (!empty($paymentParams['is_recur']) && $paymentParams['is_recur'] == 1) {
-          if (is_object($payment)) {
-            $result = $payment->createRecurringPayments($paymentParams);
-          }
-          else {
-            CRM_Core_Error::fatal($paymentObjError);
-          }
+
+    elseif ($isPaymentTransaction && $form->_contributeMode) {
+      if ($form->_contributeMode == 'express' && !empty($paymentParams['is_recur']) && $paymentParams['is_recur'] == 1) {
+        if (is_object($payment)) {
+          $result = $payment->createRecurringPayments($paymentParams);
         }
         else {
-          if (is_object($payment)) {
-            $result = $payment->doExpressCheckout($paymentParams);
-          }
-          else {
-            CRM_Core_Error::fatal($paymentObjError);
-          }
+          CRM_Core_Error::fatal($paymentObjError);
         }
       }
-    }
-    elseif ($isPaymentTransaction) {
-      if ($form->_contributeMode == 'direct') {
+      else {
         $paymentParams['contactID'] = $contactID;
 
         // Fix for CRM-14354. If the membership is recurring, don't create a
@@ -265,20 +252,11 @@ class CRM_Contribute_BAO_Contribution_Utils {
           CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($paymentParams['contributionRecurID']);
         }
 
-        if ($component !== 'membership') {
-          // This is only called from contribution form.
-          // Not sure if there is any reason not to just throw an exception up to it.
-          $result['is_payment_failure'] = TRUE;
-          return $result;
-        }
-        $membershipResult[1] = $result;
+        $result['is_payment_failure'] = TRUE;
+        $result['error'] = $e;
       }
     }
 
-    if ($component == 'membership') {
-      $membershipResult = array();
-    }
-
     if ($result || ($form->_amount == 0.0 && !$form->_params['is_pay_later'])) {
       if ($result) {
         $form->_params = array_merge($form->_params, $result);
@@ -294,19 +272,19 @@ class CRM_Contribute_BAO_Contribution_Utils {
       }
 
       $form->postProcessPremium($premiumParams, $contribution);
-      if (is_array($result) && !empty($result['trxn_id'])) {
-        $contribution->trxn_id = $result['trxn_id'];
+      if (is_array($result)) {
+        if (!empty($result['trxn_id'])) {
+          $contribution->trxn_id = $result['trxn_id'];
+        }
+        if (!empty($result['payment_status_id'])) {
+          $contribution->payment_status_id = $result['payment_status_id'];
+        }
       }
-      $membershipResult[1] = $contribution;
+      $result['contribution'] = $contribution;
     }
-
-    if ($component == 'membership') {
-      return $membershipResult;
-    }
-
     //Do not send an email if Recurring contribution is done via Direct Mode
     //We will send email once the IPN is received.
-    if ($form->_contributeMode == 'direct') {
+    if (!$isPayLater) {
       return $result;
     }
 
@@ -343,15 +321,13 @@ class CRM_Contribute_BAO_Contribution_Utils {
   }
 
   /**
-   * Get the contribution details by month
-   * of the year
+   * Get the contribution details by month of the year.
    *
    * @param int $param
    *   Year.
    *
    * @return array
    *   associated array
-   *
    */
   public static function contributionChartMonthly($param) {
     if ($param) {
@@ -391,7 +367,6 @@ INNER JOIN   civicrm_contact AS contact ON ( contact.id = contrib.contact_id )
    *
    * @return array
    *   associated array
-   *
    */
   public static function contributionChartYearly() {
     $config = CRM_Core_Config::singleton();
@@ -522,293 +497,6 @@ INNER JOIN   civicrm_contact contact ON ( contact.id = contrib.contact_id )
     return TRUE;
   }
 
-  /**
-   * @param array $apiParams
-   * @param $mapper
-   * @param string $type
-   * @param bool $category
-   *
-   * @return array
-   */
-  public static function formatAPIParams($apiParams, $mapper, $type = 'paypal', $category = TRUE) {
-    $type = strtolower($type);
-
-    if (!in_array($type, array(
-      'paypal',
-      'google',
-      'csv',
-    ))
-    ) {
-      // return the params as is
-      return $apiParams;
-    }
-    $params = $transaction = array();
-
-    if ($type == 'paypal') {
-      foreach ($apiParams as $detail => $val) {
-        if (isset($mapper['contact'][$detail])) {
-          $params[$mapper['contact'][$detail]] = $val;
-        }
-        elseif (isset($mapper['location'][$detail])) {
-          $params['address'][1][$mapper['location'][$detail]] = $val;
-        }
-        elseif (isset($mapper['transaction'][$detail])) {
-          switch ($detail) {
-            case 'l_period2':
-              // Sadly, PayPal seems to send two distinct data elements in a single field,
-              // so we break them out here.  This is somewhat ugly and tragic.
-              $freqUnits = array(
-                'D' => 'day',
-                'W' => 'week',
-                'M' => 'month',
-                'Y' => 'year',
-              );
-              list($frequency_interval, $frequency_unit) = explode(' ', $val);
-              $transaction['frequency_interval'] = $frequency_interval;
-              $transaction['frequency_unit'] = $freqUnits[$frequency_unit];
-              break;
-
-            case 'subscriptiondate':
-            case 'timestamp':
-              // PayPal dates are in  ISO-8601 format.  We need a format that
-              // MySQL likes
-              $unix_timestamp = strtotime($val);
-              $transaction[$mapper['transaction'][$detail]] = date('YmdHis', $unix_timestamp);
-              break;
-
-            case 'note':
-            case 'custom':
-            case 'l_number0':
-              if ($val) {
-                $val = "[PayPal_field:{$detail}] {$val}";
-                $transaction[$mapper['transaction'][$detail]] = !empty($transaction[$mapper['transaction'][$detail]]) ? $transaction[$mapper['transaction'][$detail]] . " <br/> " . $val : $val;
-              }
-              break;
-
-            default:
-              $transaction[$mapper['transaction'][$detail]] = $val;
-          }
-        }
-      }
-
-      if (!empty($transaction) && $category) {
-        $params['transaction'] = $transaction;
-      }
-      else {
-        $params += $transaction;
-      }
-
-      self::_fillCommonParams($params, $type);
-
-      return $params;
-    }
-
-    if ($type == 'csv') {
-      $header = $apiParams['header'];
-      unset($apiParams['header']);
-      foreach ($apiParams as $key => $val) {
-        if (isset($mapper['contact'][$header[$key]])) {
-          $params[$mapper['contact'][$header[$key]]] = $val;
-        }
-        elseif (isset($mapper['location'][$header[$key]])) {
-          $params['address'][1][$mapper['location'][$header[$key]]] = $val;
-        }
-        elseif (isset($mapper['transaction'][$header[$key]])) {
-          $transaction[$mapper['transaction'][$header[$key]]] = $val;
-        }
-        else {
-          $params[$header[$key]] = $val;
-        }
-      }
-
-      if (!empty($transaction) && $category) {
-        $params['transaction'] = $transaction;
-      }
-      else {
-        $params += $transaction;
-      }
-
-      self::_fillCommonParams($params, $type);
-
-      return $params;
-    }
-
-    if ($type == 'google') {
-      // return if response smell invalid
-      if (!array_key_exists('risk-information-notification', $apiParams[1][$apiParams[0]]['notifications'])) {
-        return FALSE;
-      }
-      $riskInfo = &$apiParams[1][$apiParams[0]]['notifications']['risk-information-notification'];
-
-      if (array_key_exists('new-order-notification', $apiParams[1][$apiParams[0]]['notifications'])) {
-        $newOrder = &$apiParams[1][$apiParams[0]]['notifications']['new-order-notification'];
-      }
-
-      if ($riskInfo['google-order-number']['VALUE'] == $apiParams[2]['google-order-number']['VALUE']) {
-        foreach ($riskInfo['risk-information']['billing-address'] as $field => $info) {
-          if (!empty($mapper['location'][$field])) {
-            $params['address'][1][$mapper['location'][$field]] = $info['VALUE'];
-          }
-          elseif (!empty($mapper['contact'][$field])) {
-            if ($newOrder && !empty($newOrder['buyer-billing-address']['structured-name'])) {
-              foreach ($newOrder['buyer-billing-address']['structured-name'] as $namePart => $nameValue) {
-                $params[$mapper['contact'][$namePart]] = $nameValue['VALUE'];
-              }
-            }
-            else {
-              $params[$mapper['contact'][$field]] = $info['VALUE'];
-            }
-          }
-          elseif (!empty($mapper['transaction'][$field])) {
-            $transaction[$mapper['transaction'][$field]] = $info['VALUE'];
-          }
-        }
-
-        // Response is an huge array. Lets pickup only those which we ineterested in
-        // using a local mapper, rather than traversing the entire array.
-        $localMapper = array(
-          'google-order-number' => $riskInfo['google-order-number']['VALUE'],
-          'total-charge-amount' => $apiParams[2]['total-charge-amount']['VALUE'],
-          'currency' => $apiParams[2]['total-charge-amount']['currency'],
-          'item-name' => $newOrder['shopping-cart']['items']['item']['item-name']['VALUE'],
-          'timestamp' => $apiParams[2]['timestamp']['VALUE'],
-        );
-        if (array_key_exists('latest-charge-fee', $apiParams[2])) {
-          $localMapper['latest-charge-fee'] = $apiParams[2]['latest-charge-fee']['total']['VALUE'];
-          $localMapper['net-amount'] = $localMapper['total-charge-amount'] - $localMapper['latest-charge-fee'];
-        }
-
-        // This is a subscription (recurring) donation.
-        if (array_key_exists('subscription', $newOrder['shopping-cart']['items']['item'])) {
-          $subscription = $newOrder['shopping-cart']['items']['item']['subscription'];
-          $localMapper['amount'] = $newOrder['order-total']['VALUE'];
-          $localMapper['times'] = $subscription['payments']['subscription-payment']['times'];
-          // Convert Google's period to one compatible with the CiviCRM db field.
-          $freqUnits = array(
-            'DAILY' => 'day',
-            'WEEKLY' => 'week',
-            'MONHTLY' => 'month',
-            'YEARLY' => 'year',
-          );
-          $localMapper['period'] = $freqUnits[$subscription['period']];
-          // Unlike PayPal, Google has no concept of freq. interval, it is always 1.
-          $localMapper['frequency_interval'] = '1';
-          // Google Checkout dates are in ISO-8601 format. We need a format that
-          // MySQL likes
-          $unix_timestamp = strtotime($localMapper['timestamp']);
-          $mysql_date = date('YmdHis', $unix_timestamp);
-          $localMapper['modified_date'] = $mysql_date;
-          $localMapper['start_date'] = $mysql_date;
-          // This is PayPal's nomenclature, but just use it for Google as well since
-          // we act on the value of trxn_type in processAPIContribution().
-          $localMapper['trxn_type'] = 'subscrpayment';
-        }
-
-        foreach ($localMapper as $localKey => $localVal) {
-          if (!empty($mapper['transaction'][$localKey])) {
-            $transaction[$mapper['transaction'][$localKey]] = $localVal;
-          }
-        }
-
-        if (empty($params) && empty($transaction)) {
-          continue;
-        }
-
-        if (!empty($transaction) && $category) {
-          $params['transaction'] = $transaction;
-        }
-        else {
-          $params += $transaction;
-        }
-
-        self::_fillCommonParams($params, $type);
-      }
-      return $params;
-    }
-  }
-
-  /**
-   * @param array $params
-   *
-   * @return bool
-   */
-  public static function processAPIContribution($params) {
-    if (empty($params) || array_key_exists('error', $params)) {
-      return FALSE;
-    }
-
-    // add contact using dedupe rule
-    $dedupeParams = CRM_Dedupe_Finder::formatParams($params, 'Individual');
-    $dedupeParams['check_permission'] = FALSE;
-    $dupeIds = CRM_Dedupe_Finder::dupesByParams($dedupeParams, 'Individual');
-    // if we find more than one contact, use the first one
-    if (!empty($dupeIds[0])) {
-      $params['contact_id'] = $dupeIds[0];
-    }
-    $contact = CRM_Contact_BAO_Contact::create($params);
-    if (!$contact->id) {
-      return FALSE;
-    }
-
-    // only pass transaction params to contribution::create, if available
-    if (array_key_exists('transaction', $params)) {
-      $params = $params['transaction'];
-      $params['contact_id'] = $contact->id;
-    }
-
-    // handle contribution custom data
-    $customFields = CRM_Core_BAO_CustomField::getFields('Contribution',
-      FALSE,
-      FALSE,
-      CRM_Utils_Array::value('financial_type_id',
-        $params
-      )
-    );
-    $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
-      CRM_Utils_Array::value('id', $params, NULL),
-      'Contribution'
-    );
-    // create contribution
-
-    // if this is a recurring contribution then process it first
-    if ($params['trxn_type'] == 'subscrpayment') {
-      // see if a recurring record already exists
-      $recurring = new CRM_Contribute_BAO_ContributionRecur();
-      $recurring->processor_id = $params['processor_id'];
-      if (!$recurring->find(TRUE)) {
-        $recurring = new CRM_Contribute_BAO_ContributionRecur();
-        $recurring->invoice_id = $params['invoice_id'];
-        $recurring->find(TRUE);
-      }
-
-      // This is the same thing the CiviCRM IPN handler does to handle
-      // subsequent recurring payments to avoid duplicate contribution
-      // errors due to invoice ID. See:
-      // ./CRM/Core/Payment/PayPalIPN.php:200
-      if ($recurring->id) {
-        $params['invoice_id'] = md5(uniqid(rand(), TRUE));
-      }
-
-      $recurring->copyValues($params);
-      $recurring->save();
-      if (is_a($recurring, 'CRM_Core_Error')) {
-        return FALSE;
-      }
-      else {
-        $params['contribution_recur_id'] = $recurring->id;
-      }
-    }
-
-    $contribution = &CRM_Contribute_BAO_Contribution::create($params,
-      CRM_Core_DAO::$_nullArray
-    );
-    if (!$contribution->id) {
-      return FALSE;
-    }
-
-    return TRUE;
-  }
-
   /**
    * @param int $contactID
    *