bin/ContributionProcessor.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  32  */
  33 class CiviContributeProcessor {
  34   static $_paypalParamsMapper = array(
  35     //category    => array(paypal_param    => civicrm_field);
  36     'contact' => array(
  37       'salutation' => 'prefix_id',
  38       'firstname' => 'first_name',
  39       'lastname' => 'last_name',
  40       'middlename' => 'middle_name',
  41       'suffix' => 'suffix_id',
  42       'email' => 'email',
  43     ),
  44     'location' => array(
  45       'shiptoname' => 'address_name',
  46       'shiptostreet' => 'street_address',
  47       'shiptostreet2' => 'supplemental_address_1',
  48       'shiptocity' => 'city',
  49       'shiptostate' => 'state_province',
  50       'shiptozip' => 'postal_code',
  51       'countrycode' => 'country',
  52     ),
  53     'transaction' => array(
  54       'amt' => 'total_amount',
  55       'feeamt' => 'fee_amount',
  56       'transactionid' => 'trxn_id',
  57       'currencycode' => 'currency',
  58       'l_name0' => 'source',
  59       'ordertime' => 'receive_date',
  60       'note' => 'note',
  61       'custom' => 'note',
  62       'l_number0' => 'note',
  63       'is_test' => 'is_test',
  64       'transactiontype' => 'trxn_type',
  65       'recurrences' => 'installments',
  66       'l_amt2' => 'amount',
  67       'l_period2' => 'lol',
  68       'invnum' => 'invoice_id',
  69       'subscriptiondate' => 'start_date',
  70       'subscriptionid' => 'processor_id',
  71       'timestamp' => 'modified_date',
  72     ),
  73   );
  74
  75   static $_csvParamsMapper = array(
  76     // Note: if csv header is not present in the mapper, header itself
  77     // is considered as a civicrm field.
  78     //category    => array(csv_header      => civicrm_field);
  79     'contact' => array(
  80       'first_name' => 'first_name',
  81       'last_name' => 'last_name',
  82       'middle_name' => 'middle_name',
  83       'email' => 'email',
  84     ),
  85     'location' => array(
  86       'street_address' => 'street_address',
  87       'supplemental_address_1' => 'supplemental_address_1',
  88       'city' => 'city',
  89       'postal_code' => 'postal_code',
  90       'country' => 'country',
  91     ),
  92     'transaction' => array(
  93       'total_amount' => 'total_amount',
  94       'trxn_id' => 'trxn_id',
  95       'currency' => 'currency',
  96       'source' => 'source',
  97       'receive_date' => 'receive_date',
  98       'note' => 'note',
  99       'is_test' => 'is_test',
 100     ),
 101   );
 102
 103   /**
 104    * @param $paymentProcessor
 105    * @param $paymentMode
 106    * @param $start
 107    * @param $end
 108    */
 109   public static function paypal($paymentProcessor, $paymentMode, $start, $end) {
 110     $url = "{$paymentProcessor['url_api']}nvp";
 111
 112     $keyArgs = array(
 113       'user' => $paymentProcessor['user_name'],
 114       'pwd' => $paymentProcessor['password'],
 115       'signature' => $paymentProcessor['signature'],
 116       'version' => 3.0,
 117     );
 118
 119     $args = $keyArgs;
 120     $args += array(
 121       'method' => 'TransactionSearch',
 122       'startdate' => $start,
 123       'enddate' => $end,
 124     );
 125
 126     require_once 'CRM/Core/Payment/PayPalImpl.php';
 127
 128     // as invokeAPI fetch only last 100 transactions.
 129     // we should require recursive calls to process more than 100.
 130     // first fetch transactions w/ give date intervals.
 131     // if we get error code w/ result, which means we do have more than 100
 132     // manipulate date interval accordingly and fetch again.
 133
 134     do {
 135       $result = CRM_Core_Payment_PayPalImpl::invokeAPI($args, $url);
 136       require_once "CRM/Contribute/BAO/Contribution/Utils.php";
 137
 138       $keyArgs['method'] = 'GetTransactionDetails';
 139       foreach ($result as $name => $value) {
 140         if (substr($name, 0, 15) == 'l_transactionid') {
 141
 142           // We don't/can't process subscription notifications, which appear
 143           // to be identified by transaction ids beginning with S-
 144           if (substr($value, 0, 2) == 'S-') {
 145             continue;
 146           }
 147
 148           // Before we bother making a remote API call to PayPal to lookup
 149           // details about a transaction, let's make sure that it doesn't
 150           // already exist in the database.
 151           require_once 'CRM/Contribute/DAO/Contribution.php';
 152           $dao = new CRM_Contribute_DAO_Contribution();
 153           $dao->trxn_id = $value;
 154           if ($dao->find(TRUE)) {
 155             preg_match('/(\d+)$/', $name, $matches);
 156             $seq = $matches[1];
 157             $email = $result["l_email{$seq}"];
 158             $amt = $result["l_amt{$seq}"];
 159             CRM_Core_Error::debug_log_message("Skipped (already recorded) - $email, $amt, $value ..<p>", TRUE);
 160             continue;
 161           }
 162
 163           $keyArgs['transactionid'] = $value;
 164           $trxnDetails = CRM_Core_Payment_PayPalImpl::invokeAPI($keyArgs, $url);
 165           if (is_a($trxnDetails, 'CRM_Core_Error')) {
 166             echo "PAYPAL ERROR: Skipping transaction id: $value<p>";
 167             continue;
 168           }
 169
 170           // only process completed payments
 171           if (strtolower($trxnDetails['paymentstatus']) != 'completed') {
 172             continue;
 173           }
 174
 175           // only process receipts, not payments
 176           if (strtolower($trxnDetails['transactiontype']) == 'sendmoney') {
 177             continue;
 178           }
 179
 180           $params = self::formatAPIParams($trxnDetails,
 181             self::$_paypalParamsMapper,
 182             'paypal'
 183           );
 184           if ($paymentMode == 'test') {
 185             $params['transaction']['is_test'] = 1;
 186           }
 187           else {
 188             $params['transaction']['is_test'] = 0;
 189           }
 190
 191           if (self::processAPIContribution($params)) {
 192             CRM_Core_Error::debug_log_message("Processed - {$trxnDetails['email']}, {$trxnDetails['amt']}, {$value} ..<p>", TRUE);
 193           }
 194           else {
 195             CRM_Core_Error::debug_log_message("Skipped - {$trxnDetails['email']}, {$trxnDetails['amt']}, {$value} ..<p>", TRUE);
 196           }
 197         }
 198       }
 199       if ($result['l_errorcode0'] == '11002') {
 200         $end = $result['l_timestamp99'];
 201         $end_time = strtotime("{$end}", time());
 202         $end_date = date('Y-m-d\T00:00:00.00\Z', $end_time);
 203         $args['enddate'] = $end_date;
 204       }
 205     } while ($result['l_errorcode0'] == '11002');
 206   }
 207
 208   public static function csv() {
 209     $csvFile = '/home/deepak/Desktop/crm-4247.csv';
 210     $delimiter = ";";
 211     $row = 1;
 212
 213     $handle = fopen($csvFile, "r");
 214     if (!$handle) {
 215       CRM_Core_Error::fatal("Can't locate csv file.");
 216     }
 217
 218     require_once "CRM/Contribute/BAO/Contribution/Utils.php";
 219     while (($data = fgetcsv($handle, 1000, $delimiter)) !== FALSE) {
 220       if ($row !== 1) {
 221         $data['header'] = $header;
 222         $params = self::formatAPIParams($data,
 223           self::$_csvParamsMapper,
 224           'csv'
 225         );
 226         if (self::processAPIContribution($params)) {
 227           CRM_Core_Error::debug_log_message("Processed - line $row of csv file .. {$params['email']}, {$params['transaction']['total_amount']}, {$params['transaction']['trxn_id']} ..<p>", TRUE);
 228         }
 229         else {
 230           CRM_Core_Error::debug_log_message("Skipped - line $row of csv file .. {$params['email']}, {$params['transaction']['total_amount']}, {$params['transaction']['trxn_id']} ..<p>", TRUE);
 231         }
 232
 233         // clean up memory from dao's
 234         CRM_Core_DAO::freeResult();
 235       }
 236       else {
 237         // we assuming - first row is always the header line
 238         $header = $data;
 239         CRM_Core_Error::debug_log_message("Considering first row ( line $row ) as HEADER ..<p>", TRUE);
 240
 241         if (empty($header)) {
 242           CRM_Core_Error::fatal("Header is empty.");
 243         }
 244       }
 245       $row++;
 246     }
 247     fclose($handle);
 248   }
 249
 250   public static function process() {
 251     require_once 'CRM/Utils/Request.php';
 252
 253     $type = CRM_Utils_Request::retrieve('type', 'String', CRM_Core_DAO::$_nullObject, FALSE, 'csv', 'REQUEST');
 254     $type = strtolower($type);
 255
 256     switch ($type) {
 257       case 'paypal':
 258         $start = CRM_Utils_Request::retrieve('start', 'String',
 259           CRM_Core_DAO::$_nullObject, FALSE, 31, 'REQUEST'
 260         );
 261         $end = CRM_Utils_Request::retrieve('end', 'String',
 262           CRM_Core_DAO::$_nullObject, FALSE, 0, 'REQUEST'
 263         );
 264         if ($start < $end) {
 265           CRM_Core_Error::fatal("Start offset can't be less than End offset.");
 266         }
 267
 268         $start = date('Y-m-d', time() - $start * 24 * 60 * 60) . 'T00:00:00.00Z';
 269         $end = date('Y-m-d', time() - $end * 24 * 60 * 60) . 'T23:59:00.00Z';
 270
 271         $ppID = CRM_Utils_Request::retrieve('ppID', 'Integer',
 272           CRM_Core_DAO::$_nullObject, TRUE, NULL, 'REQUEST'
 273         );
 274         $mode = CRM_Utils_Request::retrieve('ppMode', 'String',
 275           CRM_Core_DAO::$_nullObject, FALSE, 'live', 'REQUEST'
 276         );
 277
 278         $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($ppID, $mode);
 279
 280         CRM_Core_Error::debug_log_message("Start Date=$start,  End Date=$end, ppID=$ppID, mode=$mode <p>", TRUE);
 281
 282         return self::$type($paymentProcessor, $mode, $start, $end);
 283
 284       case 'csv':
 285         return self::csv();
 286     }
 287   }
 288
 289   /**
 290    * @param array $apiParams
 291    * @param $mapper
 292    * @param string $type
 293    * @param bool $category
 294    *
 295    * @return array
 296    */
 297   public static function formatAPIParams($apiParams, $mapper, $type = 'paypal', $category = TRUE) {
 298     $type = strtolower($type);
 299
 300     if (!in_array($type, array(
 301       'paypal',
 302       'csv',
 303     ))
 304     ) {
 305       // return the params as is
 306       return $apiParams;
 307     }
 308     $params = $transaction = array();
 309
 310     if ($type == 'paypal') {
 311       foreach ($apiParams as $detail => $val) {
 312         if (isset($mapper['contact'][$detail])) {
 313           $params[$mapper['contact'][$detail]] = $val;
 314         }
 315         elseif (isset($mapper['location'][$detail])) {
 316           $params['address'][1][$mapper['location'][$detail]] = $val;
 317         }
 318         elseif (isset($mapper['transaction'][$detail])) {
 319           switch ($detail) {
 320             case 'l_period2':
 321               // Sadly, PayPal seems to send two distinct data elements in a single field,
 322               // so we break them out here.  This is somewhat ugly and tragic.
 323               $freqUnits = array(
 324                 'D' => 'day',
 325                 'W' => 'week',
 326                 'M' => 'month',
 327                 'Y' => 'year',
 328               );
 329               list($frequency_interval, $frequency_unit) = explode(' ', $val);
 330               $transaction['frequency_interval'] = $frequency_interval;
 331               $transaction['frequency_unit'] = $freqUnits[$frequency_unit];
 332               break;
 333
 334             case 'subscriptiondate':
 335             case 'timestamp':
 336               // PayPal dates are in  ISO-8601 format.  We need a format that
 337               // MySQL likes
 338               $unix_timestamp = strtotime($val);
 339               $transaction[$mapper['transaction'][$detail]] = date('YmdHis', $unix_timestamp);
 340               break;
 341
 342             case 'note':
 343             case 'custom':
 344             case 'l_number0':
 345               if ($val) {
 346                 $val = "[PayPal_field:{$detail}] {$val}";
 347                 $transaction[$mapper['transaction'][$detail]] = !empty($transaction[$mapper['transaction'][$detail]]) ? $transaction[$mapper['transaction'][$detail]] . " <br/> " . $val : $val;
 348               }
 349               break;
 350
 351             default:
 352               $transaction[$mapper['transaction'][$detail]] = $val;
 353           }
 354         }
 355       }
 356
 357       if (!empty($transaction) && $category) {
 358         $params['transaction'] = $transaction;
 359       }
 360       else {
 361         $params += $transaction;
 362       }
 363
 364       CRM_Contribute_BAO_Contribution_Utils::_fillCommonParams($params, $type);
 365
 366       return $params;
 367     }
 368
 369     if ($type == 'csv') {
 370       $header = $apiParams['header'];
 371       unset($apiParams['header']);
 372       foreach ($apiParams as $key => $val) {
 373         if (isset($mapper['contact'][$header[$key]])) {
 374           $params[$mapper['contact'][$header[$key]]] = $val;
 375         }
 376         elseif (isset($mapper['location'][$header[$key]])) {
 377           $params['address'][1][$mapper['location'][$header[$key]]] = $val;
 378         }
 379         elseif (isset($mapper['transaction'][$header[$key]])) {
 380           $transaction[$mapper['transaction'][$header[$key]]] = $val;
 381         }
 382         else {
 383           $params[$header[$key]] = $val;
 384         }
 385       }
 386
 387       if (!empty($transaction) && $category) {
 388         $params['transaction'] = $transaction;
 389       }
 390       else {
 391         $params += $transaction;
 392       }
 393
 394       CRM_Contribute_BAO_Contribution_Utils::_fillCommonParams($params, $type);
 395
 396       return $params;
 397     }
 398
 399   }
 400
 401   /**
 402    * @param array $params
 403    *
 404    * @return bool
 405    */
 406   public static function processAPIContribution($params) {
 407     if (empty($params) || array_key_exists('error', $params)) {
 408       return FALSE;
 409     }
 410
 411     // add contact using dedupe rule
 412     $dedupeParams = CRM_Dedupe_Finder::formatParams($params, 'Individual');
 413     $dedupeParams['check_permission'] = FALSE;
 414     $dupeIds = CRM_Dedupe_Finder::dupesByParams($dedupeParams, 'Individual');
 415     // if we find more than one contact, use the first one
 416     if (!empty($dupeIds[0])) {
 417       $params['contact_id'] = $dupeIds[0];
 418     }
 419     $contact = CRM_Contact_BAO_Contact::create($params);
 420     if (!$contact->id) {
 421       return FALSE;
 422     }
 423
 424     // only pass transaction params to contribution::create, if available
 425     if (array_key_exists('transaction', $params)) {
 426       $params = $params['transaction'];
 427       $params['contact_id'] = $contact->id;
 428     }
 429
 430     // handle contribution custom data
 431     $customFields = CRM_Core_BAO_CustomField::getFields('Contribution',
 432       FALSE,
 433       FALSE,
 434       CRM_Utils_Array::value('financial_type_id',
 435         $params
 436       )
 437     );
 438     $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 439       CRM_Utils_Array::value('id', $params, NULL),
 440       'Contribution'
 441     );
 442     // create contribution
 443
 444     // if this is a recurring contribution then process it first
 445     if ($params['trxn_type'] == 'subscrpayment') {
 446       // see if a recurring record already exists
 447       $recurring = new CRM_Contribute_BAO_ContributionRecur();
 448       $recurring->processor_id = $params['processor_id'];
 449       if (!$recurring->find(TRUE)) {
 450         $recurring = new CRM_Contribute_BAO_ContributionRecur();
 451         $recurring->invoice_id = $params['invoice_id'];
 452         $recurring->find(TRUE);
 453       }
 454
 455       // This is the same thing the CiviCRM IPN handler does to handle
 456       // subsequent recurring payments to avoid duplicate contribution
 457       // errors due to invoice ID. See:
 458       // ./CRM/Core/Payment/PayPalIPN.php:200
 459       if ($recurring->id) {
 460         $params['invoice_id'] = md5(uniqid(rand(), TRUE));
 461       }
 462
 463       $recurring->copyValues($params);
 464       $recurring->save();
 465       if (is_a($recurring, 'CRM_Core_Error')) {
 466         return FALSE;
 467       }
 468       else {
 469         $params['contribution_recur_id'] = $recurring->id;
 470       }
 471     }
 472
 473     $contribution = CRM_Contribute_BAO_Contribution::create($params);
 474     if (!$contribution->id) {
 475       return FALSE;
 476     }
 477
 478     return TRUE;
 479   }
 480
 481 }
 482
 483 // bootstrap the environment and run the processor
 484 session_start();
 485 require_once '../civicrm.config.php';
 486 require_once 'CRM/Core/Config.php';
 487 $config = CRM_Core_Config::singleton();
 488
 489 CRM_Utils_System::authenticateScript(TRUE);
 490
 491 //log the execution of script
 492 CRM_Core_Error::debug_log_message('ContributionProcessor.php');
 493
 494 $lock = Civi::lockManager()->acquire('worker.contribute.CiviContributeProcessor');
 495
 496 if ($lock->isAcquired()) {
 497   // try to unset any time limits
 498   if (!ini_get('safe_mode')) {
 499     set_time_limit(0);
 500   }
 501
 502   CiviContributeProcessor::process();
 503 }
 504 else {
 505   throw new Exception('Could not acquire lock, another CiviContributeProcessor process is running');
 506 }
 507
 508 $lock->release();
 509
 510 echo "Done processing<p>";