CRM/Contribute/BAO/Contribution/Utils.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35 class CRM_Contribute_BAO_Contribution_Utils {
  36
  37   /**
  38    * Function to process payment after confirmation
  39    *
  40    * @param object  $form   form object
  41    * @param array   $paymentParams   array with payment related key
  42    * value pairs
  43    * @param array   $premiumParams   array with premium related key
  44    * value pairs
  45    * @param int     $contactID       contact id
  46      * @param int     $contributionTypeId   financial type id
  47    * @param int     $component   component id
  48    *
  49    * @return array associated array
  50    *
  51    * @static
  52    * @access public
  53    */
  54   static function processConfirm(&$form,
  55     &$paymentParams,
  56     &$premiumParams,
  57     $contactID,
  58     $contributionTypeId,
  59     $component = 'contribution',
  60     $fieldTypes = NULL
  61   ) {
  62     CRM_Core_Payment_Form::mapParams($form->_bltID, $form->_params, $paymentParams, TRUE);
  63
  64     $contributionType = new CRM_Financial_DAO_FinancialType();
  65     if (isset($paymentParams['financial_type'])) {
  66       $contributionType->id = $paymentParams['financial_type'];
  67     }
  68     elseif (CRM_Utils_Array::value('pledge_id', $form->_values)) {
  69       $contributionType->id = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_Pledge',
  70         $form->_values['pledge_id'],
  71         'financial_type_id'
  72       );
  73     }
  74     else {
  75       $contributionType->id = $contributionTypeId;
  76     }
  77     if (!$contributionType->find(TRUE)) {
  78       CRM_Core_Error::fatal('Could not find a system table');
  79     }
  80
  81     // add some financial type details to the params list
  82     // if folks need to use it
  83     $paymentParams['contributionType_name'] = $form->_params['contributionType_name'] = $contributionType->name;
  84     //CRM-11456
  85     $paymentParams['contributionType_accounting_code'] = $form->_params['contributionType_accounting_code'] = CRM_Financial_BAO_FinancialAccount::getAccountingCode($contributionType->id);
  86     $paymentParams['contributionPageID'] = $form->_params['contributionPageID'] = $form->_values['id'];
  87
  88
  89     $payment = NULL;
  90     $paymentObjError = ts('The system did not record payment details for this payment and so could not process the transaction. Please report this error to the site administrator.');
  91     if ($form->_values['is_monetary'] && $form->_amount > 0.0 && is_array($form->_paymentProcessor)) {
  92       $payment = CRM_Core_Payment::singleton($form->_mode, $form->_paymentProcessor, $form);
  93     }
  94
  95     //fix for CRM-2062
  96     $now = date('YmdHis');
  97
  98     $result = NULL;
  99     if ($form->_contributeMode == 'notify' ||
 100       $form->_params['is_pay_later']
 101     ) {
 102       // this is not going to come back, i.e. we fill in the other details
 103       // when we get a callback from the payment processor
 104       // also add the contact ID and contribution ID to the params list
 105       $paymentParams['contactID'] = $form->_params['contactID'] = $contactID;
 106       $contribution = CRM_Contribute_Form_Contribution_Confirm::processContribution(
 107         $form,
 108         $paymentParams,
 109         NULL,
 110         $contactID,
 111         $contributionType,
 112         TRUE, TRUE, TRUE
 113       );
 114
 115       if ($contribution) {
 116       $form->_params['contributionID'] = $contribution->id;
 117       }
 118
 119       $form->_params['contributionTypeID'] = $contributionType->id;
 120       $form->_params['item_name'] = $form->_params['description'];
 121       $form->_params['receive_date'] = $now;
 122
 123       if ($contribution && $form->_values['is_recur'] &&
 124         $contribution->contribution_recur_id
 125       ) {
 126         $form->_params['contributionRecurID'] = $contribution->contribution_recur_id;
 127       }
 128
 129       $form->set('params', $form->_params);
 130       $form->postProcessPremium($premiumParams, $contribution);
 131
 132       if ($form->_values['is_monetary'] && $form->_amount > 0.0) {
 133         // add qfKey so we can send to paypal
 134         $form->_params['qfKey'] = $form->controller->_key;
 135         if ($component == 'membership') {
 136           $membershipResult = array(1 => $contribution);
 137           return $membershipResult;
 138         }
 139         else {
 140           if (!$form->_params['is_pay_later']) {
 141             if (is_object($payment)) {
 142               // call postprocess hook before leaving
 143               $form->postProcessHook();
 144               // this does not return
 145               $result = &$payment->doTransferCheckout($form->_params, 'contribute');
 146             }
 147             else{
 148               CRM_Core_Error::fatal($paymentObjError);
 149             }
 150           }
 151           else {
 152             // follow similar flow as IPN
 153             // send the receipt mail
 154             $form->set('params', $form->_params);
 155             if ($contributionType->is_deductible) {
 156               $form->assign('is_deductible', TRUE);
 157               $form->set('is_deductible', TRUE);
 158             }
 159             if (isset($paymentParams['contribution_source'])) {
 160               $form->_params['source'] = $paymentParams['contribution_source'];
 161             }
 162
 163             // get the price set values for receipt.
 164             if ($form->_priceSetId && $form->_lineItem) {
 165               $form->_values['lineItem'] = $form->_lineItem;
 166               $form->_values['priceSetID'] = $form->_priceSetId;
 167             }
 168
 169             $form->_values['contribution_id'] = $contribution->id;
 170             $form->_values['contribution_page_id'] = $contribution->contribution_page_id;
 171
 172             CRM_Contribute_BAO_ContributionPage::sendMail($contactID,
 173               $form->_values,
 174               $contribution->is_test
 175             );
 176             return;
 177           }
 178         }
 179       }
 180     }
 181     elseif ($form->_contributeMode == 'express') {
 182       if ($form->_values['is_monetary'] && $form->_amount > 0.0) {
 183         // determine if express + recurring and direct accordingly
 184         if ($paymentParams['is_recur'] == 1) {
 185           if (is_object($payment)) {
 186             $result = $payment->createRecurringPayments($paymentParams);
 187           }
 188           else {
 189             CRM_Core_Error::fatal($paymentObjError);
 190           }
 191         }
 192         else {
 193           if (is_object($payment)) {
 194             $result = $payment->doExpressCheckout($paymentParams);
 195           }
 196           else {
 197             CRM_Core_Error::fatal($paymentObjError);
 198           }
 199         }
 200       }
 201     }
 202     elseif ($form->_values['is_monetary'] && $form->_amount > 0.0) {
 203       if (CRM_Utils_Array::value('is_recur', $paymentParams) &&
 204         $form->_contributeMode == 'direct'
 205       ) {
 206
 207         // For recurring contribution, create Contribution Record first.
 208         // Contribution ID, Recurring ID and Contact ID needed
 209         // When we get a callback from the payment processor
 210
 211         $paymentParams['contactID'] = $contactID;
 212         $contribution = CRM_Contribute_Form_Contribution_Confirm::processContribution(
 213           $form,
 214           $paymentParams,
 215           NULL,
 216           $contactID,
 217           $contributionType,
 218           TRUE, TRUE, TRUE
 219         );
 220
 221         $paymentParams['contributionID'] = $contribution->id;
 222         $paymentParams['contributionTypeID'] = $contribution->financial_type_id;
 223         $paymentParams['contributionPageID'] = $contribution->contribution_page_id;
 224
 225         if ($form->_values['is_recur'] && $contribution->contribution_recur_id) {
 226           $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id;
 227         }
 228       }
 229       if (is_object($payment)) {
 230         $result = $payment->doDirectPayment($paymentParams);
 231       }
 232       else {
 233         CRM_Core_Error::fatal($paymentObjError);
 234       }
 235     }
 236
 237     if ($component == 'membership') {
 238       $membershipResult = array();
 239     }
 240
 241     if (is_a($result, 'CRM_Core_Error')) {
 242       //make sure to cleanup db for recurring case.
 243       if (CRM_Utils_Array::value('contributionID', $paymentParams)) {
 244         CRM_Contribute_BAO_Contribution::deleteContribution($paymentParams['contributionID']);
 245       }
 246       if (CRM_Utils_Array::value('contributionRecurID', $paymentParams)) {
 247         CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($paymentParams['contributionRecurID']);
 248       }
 249
 250       if ($component !== 'membership') {
 251         CRM_Core_Error::displaySessionError($result);
 252         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact',
 253             "_qf_Main_display=true&qfKey={$form->_params['qfKey']}"
 254           ));
 255       }
 256       $membershipResult[1] = $result;
 257     }
 258     elseif ($result) {
 259       if ($result) {
 260         $form->_params = array_merge($form->_params, $result);
 261       }
 262       $form->_params['receive_date'] = $now;
 263       $form->set('params', $form->_params);
 264       $form->assign('trxn_id', CRM_Utils_Array::value('trxn_id', $result));
 265       $form->assign('receive_date',
 266         CRM_Utils_Date::mysqlToIso($form->_params['receive_date'])
 267       );
 268
 269       // result has all the stuff we need
 270       // lets archive it to a financial transaction
 271       if ($contributionType->is_deductible) {
 272         $form->assign('is_deductible', TRUE);
 273         $form->set('is_deductible', TRUE);
 274       }
 275
 276       if (isset($paymentParams['contribution_source'])) {
 277         $form->_params['source'] = $paymentParams['contribution_source'];
 278       }
 279
 280       // check if pending was set to true by payment processor
 281       $pending = FALSE;
 282       if (CRM_Utils_Array::value('contribution_status_pending',
 283           $form->_params
 284         )) {
 285         $pending = TRUE;
 286       }
 287       if (!(!empty($paymentParams['is_recur']) && $form->_contributeMode == 'direct')) {
 288         $contribution = CRM_Contribute_Form_Contribution_Confirm::processContribution($form,
 289           $form->_params, $result,
 290           $contactID, $contributionType,
 291           TRUE, $pending, TRUE
 292         );
 293       }
 294       $form->postProcessPremium($premiumParams, $contribution);
 295
 296       $membershipResult[1] = $contribution;
 297     }
 298
 299     if ($component == 'membership') {
 300       return $membershipResult;
 301     }
 302
 303     //Do not send an email if Recurring contribution is done via Direct Mode
 304     //We will send email once the IPN is received.
 305     if (!empty($paymentParams['is_recur']) && $form->_contributeMode == 'direct') {
 306       return TRUE;
 307     }
 308
 309     // get the price set values for receipt.
 310     if ($form->_priceSetId && $form->_lineItem) {
 311       $form->_values['lineItem'] = $form->_lineItem;
 312       $form->_values['priceSetID'] = $form->_priceSetId;
 313     }
 314
 315     // finally send an email receipt
 316     if ($contribution) {
 317     $form->_values['contribution_id'] = $contribution->id;
 318       CRM_Contribute_BAO_ContributionPage::sendMail($contactID,
 319         $form->_values, $contribution->is_test,
 320       FALSE, $fieldTypes
 321     );
 322   }
 323   }
 324
 325   /**
 326    * Function to get the contribution details by month
 327    * of the year
 328    *
 329    * @param int     $param year
 330    *
 331    * @return array associated array
 332    *
 333    * @static
 334    * @access public
 335    */
 336   static function contributionChartMonthly($param) {
 337     if ($param) {
 338       $param = array(1 => array($param, 'Integer'));
 339     }
 340     else {
 341       $param = date("Y");
 342       $param = array(1 => array($param, 'Integer'));
 343     }
 344
 345     $query = "
 346     SELECT   sum(contrib.total_amount) AS ctAmt,
 347              MONTH( contrib.receive_date) AS contribMonth
 348       FROM   civicrm_contribution AS contrib
 349 INNER JOIN   civicrm_contact AS contact ON ( contact.id = contrib.contact_id )
 350      WHERE   contrib.contact_id = contact.id
 351        AND   ( contrib.is_test = 0 OR contrib.is_test IS NULL )
 352        AND   contrib.contribution_status_id = 1
 353        AND   date_format(contrib.receive_date,'%Y') = %1
 354        AND   contact.is_deleted = 0
 355   GROUP BY   contribMonth
 356   ORDER BY   month(contrib.receive_date)";
 357
 358     $dao = CRM_Core_DAO::executeQuery($query, $param);
 359
 360     $params = NULL;
 361     while ($dao->fetch()) {
 362       if ($dao->contribMonth) {
 363         $params['By Month'][$dao->contribMonth] = $dao->ctAmt;
 364       }
 365     }
 366     return $params;
 367   }
 368
 369   /**
 370    * Function to get the contribution details by year
 371    *
 372    * @return array associated array
 373    *
 374    * @static
 375    * @access public
 376    */
 377   static function contributionChartYearly() {
 378     $config = CRM_Core_Config::singleton();
 379     $yearClause = "year(contrib.receive_date) as contribYear";
 380     if (!empty($config->fiscalYearStart) && ($config->fiscalYearStart['M'] != 1 || $config->fiscalYearStart['d'] != 1)) {
 381       $yearClause = "CASE
 382         WHEN (MONTH(contrib.receive_date)>= " . $config->fiscalYearStart['M'] . "
 383                 && DAYOFMONTH(contrib.receive_date)>= " . $config->fiscalYearStart['d'] . " )
 384           THEN
 385             concat(YEAR(contrib.receive_date), '-',YEAR(contrib.receive_date)+1)
 386           ELSE
 387             concat(YEAR(contrib.receive_date)-1,'-', YEAR(contrib.receive_date))
 388         END AS contribYear";
 389     }
 390
 391     $query = "
 392     SELECT   sum(contrib.total_amount) AS ctAmt,
 393              {$yearClause}
 394       FROM   civicrm_contribution AS contrib
 395 INNER JOIN   civicrm_contact contact ON ( contact.id = contrib.contact_id )
 396      WHERE   ( contrib.is_test = 0 OR contrib.is_test IS NULL )
 397        AND   contrib.contribution_status_id = 1
 398        AND   contact.is_deleted = 0
 399   GROUP BY   contribYear
 400   ORDER BY   contribYear";
 401     $dao = CRM_Core_DAO::executeQuery($query);
 402
 403     $params = NULL;
 404     while ($dao->fetch()) {
 405       if (!empty($dao->contribYear)) {
 406         $params['By Year'][$dao->contribYear] = $dao->ctAmt;
 407       }
 408     }
 409     return $params;
 410   }
 411
 412   static function createCMSUser(&$params, $contactID, $mail) {
 413     // lets ensure we only create one CMS user
 414     static $created = FALSE;
 415
 416     if ($created) {
 417       return;
 418     }
 419     $created = TRUE;
 420
 421     if (CRM_Utils_Array::value('cms_create_account', $params)) {
 422       $params['contactID'] = $contactID;
 423       if (!CRM_Core_BAO_CMSUser::create($params, $mail)) {
 424         CRM_Core_Error::statusBounce(ts('Your profile is not saved and Account is not created.'));
 425       }
 426     }
 427   }
 428
 429   static function _fillCommonParams(&$params, $type = 'paypal') {
 430     if (array_key_exists('transaction', $params)) {
 431       $transaction = &$params['transaction'];
 432     }
 433     else {
 434       $transaction = &$params;
 435     }
 436
 437     $params['contact_type'] = 'Individual';
 438
 439     $billingLocTypeId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_LocationType', 'Billing', 'id', 'name');
 440     if (!$billingLocTypeId) {
 441       $billingLocTypeId = 1;
 442     }
 443     if (!CRM_Utils_System::isNull($params['address'])) {
 444       $params['address'][1]['is_primary'] = 1;
 445       $params['address'][1]['location_type_id'] = $billingLocTypeId;
 446     }
 447     if (!CRM_Utils_System::isNull($params['email'])) {
 448       $params['email'] = array(
 449         1 => array('email' => $params['email'],
 450           'location_type_id' => $billingLocTypeId,
 451         ));
 452     }
 453
 454     if (isset($transaction['trxn_id'])) {
 455       // set error message if transaction has already been processed.
 456       $contribution = new CRM_Contribute_DAO_Contribution();
 457       $contribution->trxn_id = $transaction['trxn_id'];
 458       if ($contribution->find(TRUE)) {
 459         $params['error'][] = ts('transaction already processed.');
 460       }
 461     }
 462     else {
 463       // generate a new transaction id, if not already exist
 464       $transaction['trxn_id'] = md5(uniqid(rand(), TRUE));
 465     }
 466
 467     if (!isset( $transaction['financial_type_id'])) {
 468       $contributionTypes = array_keys(CRM_Contribute_PseudoConstant::financialType());
 469       $transaction['financial_type_id'] = $contributionTypes[0];
 470     }
 471
 472     if (($type == 'paypal') && (!isset($transaction['net_amount']))) {
 473       $transaction['net_amount'] = $transaction['total_amount'] - CRM_Utils_Array::value('fee_amount', $transaction, 0);
 474     }
 475
 476     if (!isset($transaction['invoice_id'])) {
 477       $transaction['invoice_id'] = $transaction['trxn_id'];
 478     }
 479
 480     $source = ts('ContributionProcessor: %1 API',
 481       array(1 => ucfirst($type))
 482     );
 483     if (isset($transaction['source'])) {
 484       $transaction['source'] = $source . ':: ' . $transaction['source'];
 485     }
 486     else {
 487       $transaction['source'] = $source;
 488     }
 489
 490     return TRUE;
 491   }
 492
 493   static function formatAPIParams($apiParams, $mapper, $type = 'paypal', $category = TRUE) {
 494     $type = strtolower($type);
 495
 496     if (!in_array($type, array(
 497       'paypal', 'google', 'csv'))) {
 498       // return the params as is
 499       return $apiParams;
 500     }
 501     $params = $transaction = array();
 502
 503     if ($type == 'paypal') {
 504       foreach ($apiParams as $detail => $val) {
 505         if (isset($mapper['contact'][$detail])) {
 506           $params[$mapper['contact'][$detail]] = $val;
 507         }
 508         elseif (isset($mapper['location'][$detail])) {
 509           $params['address'][1][$mapper['location'][$detail]] = $val;
 510         }
 511         elseif (isset($mapper['transaction'][$detail])) {
 512           switch ($detail) {
 513             case 'l_period2':
 514               // Sadly, PayPal seems to send two distinct data elements in a single field,
 515               // so we break them out here.  This is somewhat ugly and tragic.
 516               $freqUnits = array(
 517                 'D' => 'day',
 518                 'W' => 'week',
 519                 'M' => 'month',
 520                 'Y' => 'year',
 521               );
 522               list($frequency_interval, $frequency_unit) = explode(' ', $val);
 523               $transaction['frequency_interval'] = $frequency_interval;
 524               $transaction['frequency_unit'] = $freqUnits[$frequency_unit];
 525               break;
 526
 527             case 'subscriptiondate':
 528             case 'timestamp':
 529               // PayPal dates are in  ISO-8601 format.  We need a format that
 530               // MySQL likes
 531               $unix_timestamp = strtotime($val);
 532               $transaction[$mapper['transaction'][$detail]] = date('YmdHis', $unix_timestamp);
 533               break;
 534
 535             case 'note':
 536             case 'custom':
 537             case 'l_number0':
 538               if ($val) {
 539                 $val = "[PayPal_field:{$detail}] {$val}";
 540                 $transaction[$mapper['transaction'][$detail]] = !empty($transaction[$mapper['transaction'][$detail]]) ? $transaction[$mapper['transaction'][$detail]] . " <br/> " . $val : $val;
 541               }
 542               break;
 543
 544             default:
 545               $transaction[$mapper['transaction'][$detail]] = $val;
 546           }
 547         }
 548       }
 549
 550       if (!empty($transaction) && $category) {
 551         $params['transaction'] = $transaction;
 552       }
 553       else {
 554         $params += $transaction;
 555       }
 556
 557       self::_fillCommonParams($params, $type);
 558
 559       return $params;
 560     }
 561
 562     if ($type == 'csv') {
 563       $header = $apiParams['header'];
 564       unset($apiParams['header']);
 565       foreach ($apiParams as $key => $val) {
 566         if (isset($mapper['contact'][$header[$key]])) {
 567           $params[$mapper['contact'][$header[$key]]] = $val;
 568         }
 569         elseif (isset($mapper['location'][$header[$key]])) {
 570           $params['address'][1][$mapper['location'][$header[$key]]] = $val;
 571         }
 572         elseif (isset($mapper['transaction'][$header[$key]])) {
 573           $transaction[$mapper['transaction'][$header[$key]]] = $val;
 574         }
 575         else {
 576           $params[$header[$key]] = $val;
 577         }
 578       }
 579
 580       if (!empty($transaction) && $category) {
 581         $params['transaction'] = $transaction;
 582       }
 583       else {
 584         $params += $transaction;
 585       }
 586
 587       self::_fillCommonParams($params, $type);
 588
 589       return $params;
 590     }
 591
 592     if ($type == 'google') {
 593       // return if response smell invalid
 594       if (!array_key_exists('risk-information-notification', $apiParams[1][$apiParams[0]]['notifications'])) {
 595         return FALSE;
 596       }
 597       $riskInfo = &$apiParams[1][$apiParams[0]]['notifications']['risk-information-notification'];
 598
 599       if (array_key_exists('new-order-notification', $apiParams[1][$apiParams[0]]['notifications'])) {
 600         $newOrder = &$apiParams[1][$apiParams[0]]['notifications']['new-order-notification'];
 601       }
 602
 603       if ($riskInfo['google-order-number']['VALUE'] == $apiParams[2]['google-order-number']['VALUE']) {
 604         foreach ($riskInfo['risk-information']['billing-address'] as $field => $info) {
 605           if (CRM_Utils_Array::value($field, $mapper['location'])) {
 606             $params['address'][1][$mapper['location'][$field]] = $info['VALUE'];
 607           }
 608           elseif (CRM_Utils_Array::value($field, $mapper['contact'])) {
 609             if ($newOrder && CRM_Utils_Array::value('structured-name', $newOrder['buyer-billing-address'])) {
 610               foreach ($newOrder['buyer-billing-address']['structured-name'] as $namePart => $nameValue) {
 611                 $params[$mapper['contact'][$namePart]] = $nameValue['VALUE'];
 612               }
 613             }
 614             else {
 615               $params[$mapper['contact'][$field]] = $info['VALUE'];
 616             }
 617           }
 618           elseif (CRM_Utils_Array::value($field, $mapper['transaction'])) {
 619             $transaction[$mapper['transaction'][$field]] = $info['VALUE'];
 620           }
 621         }
 622
 623         // Response is an huge array. Lets pickup only those which we ineterested in
 624         // using a local mapper, rather than traversing the entire array.
 625         $localMapper = array(
 626           'google-order-number' => $riskInfo['google-order-number']['VALUE'],
 627           'total-charge-amount' => $apiParams[2]['total-charge-amount']['VALUE'],
 628           'currency' => $apiParams[2]['total-charge-amount']['currency'],
 629           'item-name' => $newOrder['shopping-cart']['items']['item']['item-name']['VALUE'],
 630           'timestamp' => $apiParams[2]['timestamp']['VALUE'],
 631         );
 632         if (array_key_exists('latest-charge-fee', $apiParams[2])) {
 633           $localMapper['latest-charge-fee'] = $apiParams[2]['latest-charge-fee']['total']['VALUE'];
 634           $localMapper['net-amount'] = $localMapper['total-charge-amount'] - $localMapper['latest-charge-fee'];
 635         }
 636
 637         // This is a subscription (recurring) donation.
 638         if (array_key_exists('subscription', $newOrder['shopping-cart']['items']['item'])) {
 639           $subscription = $newOrder['shopping-cart']['items']['item']['subscription'];
 640           $localMapper['amount'] = $newOrder['order-total']['VALUE'];
 641           $localMapper['times'] = $subscription['payments']['subscription-payment']['times'];
 642           // Convert Google's period to one compatible with the CiviCRM db field.
 643           $freqUnits = array(
 644             'DAILY' => 'day',
 645             'WEEKLY' => 'week',
 646             'MONHTLY' => 'month',
 647             'YEARLY' => 'year',
 648           );
 649           $localMapper['period'] = $freqUnits[$subscription['period']];
 650           // Unlike PayPal, Google has no concept of freq. interval, it is always 1.
 651           $localMapper['frequency_interval'] = '1';
 652           // Google Checkout dates are in ISO-8601 format. We need a format that
 653           // MySQL likes
 654           $unix_timestamp = strtotime($localMapper['timestamp']);
 655           $mysql_date = date('YmdHis', $unix_timestamp);
 656           $localMapper['modified_date'] = $mysql_date;
 657           $localMapper['start_date'] = $mysql_date;
 658           // This is PayPal's nomenclature, but just use it for Google as well since
 659           // we act on the value of trxn_type in processAPIContribution().
 660           $localMapper['trxn_type'] = 'subscrpayment';
 661         }
 662
 663         foreach ($localMapper as $localKey => $localVal) {
 664           if (CRM_Utils_Array::value($localKey, $mapper['transaction'])) {
 665             $transaction[$mapper['transaction'][$localKey]] = $localVal;
 666           }
 667         }
 668
 669         if (empty($params) && empty($transaction)) {
 670           continue;
 671         }
 672
 673         if (!empty($transaction) && $category) {
 674           $params['transaction'] = $transaction;
 675         }
 676         else {
 677           $params += $transaction;
 678         }
 679
 680         self::_fillCommonParams($params, $type);
 681       }
 682       return $params;
 683     }
 684   }
 685
 686   static function processAPIContribution($params) {
 687     if (empty($params) || array_key_exists('error', $params)) {
 688       return FALSE;
 689     }
 690
 691     // add contact using dedupe rule
 692     $dedupeParams = CRM_Dedupe_Finder::formatParams($params, 'Individual');
 693     $dedupeParams['check_permission'] = FALSE;
 694     $dupeIds = CRM_Dedupe_Finder::dupesByParams($dedupeParams, 'Individual');
 695     // if we find more than one contact, use the first one
 696     if (CRM_Utils_Array::value(0, $dupeIds)) {
 697       $params['contact_id'] = $dupeIds[0];
 698     }
 699     $contact = CRM_Contact_BAO_Contact::create($params);
 700     if (!$contact->id) {
 701       return FALSE;
 702     }
 703
 704     // only pass transaction params to contribution::create, if available
 705     if (array_key_exists('transaction', $params)) {
 706       $params = $params['transaction'];
 707       $params['contact_id'] = $contact->id;
 708     }
 709
 710     // handle contribution custom data
 711     $customFields = CRM_Core_BAO_CustomField::getFields('Contribution',
 712       FALSE,
 713       FALSE,
 714       CRM_Utils_Array::value('financial_type_id',
 715         $params
 716       )
 717     );
 718     $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 719       $customFields,
 720       CRM_Utils_Array::value('id', $params, NULL),
 721       'Contribution'
 722     );
 723     // create contribution
 724
 725     // if this is a recurring contribution then process it first
 726     if ($params['trxn_type'] == 'subscrpayment') {
 727       // see if a recurring record already exists
 728       $recurring = new CRM_Contribute_BAO_ContributionRecur;
 729       $recurring->processor_id = $params['processor_id'];
 730       if (!$recurring->find(TRUE)) {
 731         $recurring = new CRM_Contribute_BAO_ContributionRecur;
 732         $recurring->invoice_id = $params['invoice_id'];
 733         $recurring->find(TRUE);
 734       }
 735
 736       // This is the same thing the CiviCRM IPN handler does to handle
 737       // subsequent recurring payments to avoid duplicate contribution
 738       // errors due to invoice ID. See:
 739       // ./CRM/Core/Payment/PayPalIPN.php:200
 740       if ($recurring->id) {
 741         $params['invoice_id'] = md5(uniqid(rand(), TRUE));
 742       }
 743
 744       $recurring->copyValues($params);
 745       $recurring->save();
 746       if (is_a($recurring, 'CRM_Core_Error')) {
 747         return FALSE;
 748       }
 749       else {
 750         $params['contribution_recur_id'] = $recurring->id;
 751       }
 752     }
 753
 754     $contribution = &CRM_Contribute_BAO_Contribution::create($params,
 755       CRM_Core_DAO::$_nullArray
 756     );
 757     if (!$contribution->id) {
 758       return FALSE;
 759     }
 760
 761     return TRUE;
 762   }
 763
 764   static function getFirstLastDetails($contactID) {
 765     static $_cache;
 766
 767     if (!$_cache) {
 768       $_cache = array();
 769     }
 770
 771     if (!isset($_cache[$contactID])) {
 772       $sql = "
 773 SELECT   total_amount, receive_date
 774 FROM     civicrm_contribution c
 775 WHERE    contact_id = %1
 776 ORDER BY receive_date ASC
 777 LIMIT 1
 778 ";
 779       $params = array(1 => array($contactID, 'Integer'));
 780
 781       $dao = CRM_Core_DAO::executeQuery($sql, $params);
 782       $details = array(
 783         'first' => NULL,
 784         'last' => NULL,
 785       );
 786       if ($dao->fetch()) {
 787         $details['first'] = array(
 788           'total_amount' => $dao->total_amount,
 789           'receive_date' => $dao->receive_date,
 790         );
 791       }
 792
 793       // flip asc and desc to get the last query
 794       $sql = str_replace('ASC', 'DESC', $sql);
 795       $dao = CRM_Core_DAO::executeQuery($sql, $params);
 796       if ($dao->fetch()) {
 797         $details['last'] = array(
 798           'total_amount' => $dao->total_amount,
 799           'receive_date' => $dao->receive_date,
 800         );
 801       }
 802
 803       $_cache[$contactID] = $details;
 804     }
 805     return $_cache[$contactID];
 806   }
 807 }
 808