bin/ContributionProcessor.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35 class CiviContributeProcessor {
  36   static $_paypalParamsMapper = array(
  37     //category    => array(paypal_param    => civicrm_field);
  38     'contact' => array(
  39       'salutation' => 'prefix_id',
  40       'firstname' => 'first_name',
  41       'lastname' => 'last_name',
  42       'middlename' => 'middle_name',
  43       'suffix' => 'suffix_id',
  44       'email' => 'email',
  45     ),
  46     'location' => array(
  47       'shiptoname' => 'address_name',
  48       'shiptostreet' => 'street_address',
  49       'shiptostreet2' => 'supplemental_address_1',
  50       'shiptocity' => 'city',
  51       'shiptostate' => 'state_province',
  52       'shiptozip' => 'postal_code',
  53       'countrycode' => 'country',
  54     ),
  55     'transaction' => array(
  56       'amt' => 'total_amount',
  57       'feeamt' => 'fee_amount',
  58       'transactionid' => 'trxn_id',
  59       'currencycode' => 'currency',
  60       'l_name0' => 'source',
  61       'ordertime' => 'receive_date',
  62       'note' => 'note',
  63       'custom' => 'note',
  64       'l_number0' => 'note',
  65       'is_test' => 'is_test',
  66       'transactiontype' => 'trxn_type',
  67       'recurrences' => 'installments',
  68       'l_amt2' => 'amount',
  69       'l_period2' => 'lol',
  70       'invnum' => 'invoice_id',
  71       'subscriptiondate' => 'start_date',
  72       'subscriptionid' => 'processor_id',
  73       'timestamp' => 'modified_date',
  74     ),
  75   );
  76
  77   static $_googleParamsMapper = array(
  78     //category    => array(google_param    => civicrm_field);
  79     'contact' => array(
  80       'first-name' => 'first_name',
  81       'last-name' => 'last_name',
  82       'contact-name' => 'display_name',
  83       'email' => 'email',
  84     ),
  85     'location' => array(
  86       'address1' => 'street_address',
  87       'address2' => 'supplemental_address_1',
  88       'city' => 'city',
  89       'postal-code' => 'postal_code',
  90       'country-code' => 'country',
  91     ),
  92     'transaction' => array(
  93       'total-charge-amount' => 'total_amount',
  94       'google-order-number' => 'trxn_id',
  95       'currency' => 'currency',
  96       'item-name' => 'source',
  97       'item-description' => 'note',
  98       'timestamp' => 'receive_date',
  99       'latest-charge-fee' => 'fee_amount',
 100       'net-amount' => 'net_amount',
 101       'times' => 'installments',
 102       'period' => 'frequency_unit',
 103       'frequency_interval' => 'frequency_interval',
 104       'start_date' => 'start_date',
 105       'modified_date' => 'modified_date',
 106       'trxn_type' => 'trxn_type',
 107       'amount' => 'amount',
 108     ),
 109   );
 110
 111   static $_csvParamsMapper = array(
 112     // Note: if csv header is not present in the mapper, header itself
 113     // is considered as a civicrm field.
 114     //category    => array(csv_header      => civicrm_field);
 115     'contact' => array(
 116       'first_name' => 'first_name',
 117       'last_name' => 'last_name',
 118       'middle_name' => 'middle_name',
 119       'email' => 'email',
 120     ),
 121     'location' => array(
 122       'street_address' => 'street_address',
 123       'supplemental_address_1' => 'supplemental_address_1',
 124       'city' => 'city',
 125       'postal_code' => 'postal_code',
 126       'country' => 'country',
 127     ),
 128     'transaction' => array(
 129       'total_amount' => 'total_amount',
 130       'trxn_id' => 'trxn_id',
 131       'currency' => 'currency',
 132       'source' => 'source',
 133       'receive_date' => 'receive_date',
 134       'note' => 'note',
 135       'is_test' => 'is_test',
 136     ),
 137   );
 138
 139   /**
 140    * @param $paymentProcessor
 141    * @param $paymentMode
 142    * @param $start
 143    * @param $end
 144    */
 145   static
 146   function paypal($paymentProcessor, $paymentMode, $start, $end) {
 147     $url = "{$paymentProcessor['url_api']}nvp";
 148
 149     $keyArgs = array(
 150       'user' => $paymentProcessor['user_name'],
 151       'pwd' => $paymentProcessor['password'],
 152       'signature' => $paymentProcessor['signature'],
 153       'version' => 3.0,
 154     );
 155
 156     $args = $keyArgs;
 157     $args += array(
 158       'method' => 'TransactionSearch',
 159       'startdate' => $start,
 160       'enddate' => $end,
 161     );
 162
 163     require_once 'CRM/Core/Payment/PayPalImpl.php';
 164
 165     // as invokeAPI fetch only last 100 transactions.
 166     // we should require recursive calls to process more than 100.
 167     // first fetch transactions w/ give date intervals.
 168     // if we get error code w/ result, which means we do have more than 100
 169     // manipulate date interval accordingly and fetch again.
 170
 171     do {
 172       $result = CRM_Core_Payment_PayPalImpl::invokeAPI($args, $url);
 173       require_once "CRM/Contribute/BAO/Contribution/Utils.php";
 174
 175       $keyArgs['method'] = 'GetTransactionDetails';
 176       foreach ($result as $name => $value) {
 177         if (substr($name, 0, 15) == 'l_transactionid') {
 178
 179           // We don't/can't process subscription notifications, which appear
 180           // to be identified by transaction ids beginning with S-
 181           if (substr($value, 0, 2) == 'S-') {
 182             continue;
 183           }
 184
 185           // Before we bother making a remote API call to PayPal to lookup
 186           // details about a transaction, let's make sure that it doesn't
 187           // already exist in the database.
 188           require_once 'CRM/Contribute/DAO/Contribution.php';
 189           $dao = new CRM_Contribute_DAO_Contribution;
 190           $dao->trxn_id = $value;
 191           if ($dao->find(TRUE)) {
 192             preg_match('/(\d+)$/', $name, $matches);
 193             $seq   = $matches[1];
 194             $email = $result["l_email{$seq}"];
 195             $amt   = $result["l_amt{$seq}"];
 196             CRM_Core_Error::debug_log_message("Skipped (already recorded) - $email, $amt, $value ..<p>", TRUE);
 197             continue;
 198           }
 199
 200           $keyArgs['transactionid'] = $value;
 201           $trxnDetails = CRM_Core_Payment_PayPalImpl::invokeAPI($keyArgs, $url);
 202           if (is_a($trxnDetails, 'CRM_Core_Error')) {
 203             echo "PAYPAL ERROR: Skipping transaction id: $value<p>";
 204             continue;
 205           }
 206
 207           // only process completed payments
 208           if (strtolower($trxnDetails['paymentstatus']) != 'completed') {
 209             continue;
 210           }
 211
 212           // only process receipts, not payments
 213           if (strtolower($trxnDetails['transactiontype']) == 'sendmoney') {
 214             continue;
 215           }
 216
 217           $params = CRM_Contribute_BAO_Contribution_Utils::formatAPIParams($trxnDetails,
 218             self::$_paypalParamsMapper,
 219             'paypal'
 220           );
 221           if ($paymentMode == 'test') {
 222             $params['transaction']['is_test'] = 1;
 223           }
 224           else {
 225             $params['transaction']['is_test'] = 0;
 226           }
 227
 228           if (CRM_Contribute_BAO_Contribution_Utils::processAPIContribution($params)) {
 229             CRM_Core_Error::debug_log_message("Processed - {$trxnDetails['email']}, {$trxnDetails['amt']}, {$value} ..<p>", TRUE);
 230           }
 231           else {
 232             CRM_Core_Error::debug_log_message("Skipped - {$trxnDetails['email']}, {$trxnDetails['amt']}, {$value} ..<p>", TRUE);
 233           }
 234         }
 235       }
 236       if ($result['l_errorcode0'] == '11002') {
 237         $end             = $result['l_timestamp99'];
 238         $end_time        = strtotime("{$end}", time());
 239         $end_date        = date('Y-m-d\T00:00:00.00\Z', $end_time);
 240         $args['enddate'] = $end_date;
 241       }
 242     } while ($result['l_errorcode0'] == '11002');
 243   }
 244
 245   /**
 246    * @param $paymentProcessor
 247    * @param $paymentMode
 248    * @param $start
 249    * @param $end
 250    */
 251   static
 252   function google($paymentProcessor, $paymentMode, $start, $end) {
 253     require_once "CRM/Contribute/BAO/Contribution/Utils.php";
 254     require_once 'CRM/Core/Payment/Google.php';
 255     $nextPageToken = TRUE;
 256     $searchParams = array(
 257       'start' => $start,
 258       'end' => $end,
 259       'notification-types' => array('charge-amount'),
 260     );
 261
 262     $response = CRM_Core_Payment_Google::invokeAPI($paymentProcessor, $searchParams);
 263
 264     while ($nextPageToken) {
 265       if ($response[0] == 'error') {
 266         CRM_Core_Error::debug_log_message("GOOGLE ERROR: " .
 267           $response[1]['error']['error-message']['VALUE'], TRUE
 268         );
 269       }
 270       $nextPageToken = isset($response[1][$response[0]]['next-page-token']['VALUE']) ? $response[1][$response[0]]['next-page-token']['VALUE'] : FALSE;
 271
 272       if (is_array($response[1][$response[0]]['notifications']['charge-amount-notification'])) {
 273
 274         if (array_key_exists('google-order-number',
 275             $response[1][$response[0]]['notifications']['charge-amount-notification']
 276           )) {
 277           // sometimes 'charge-amount-notification' itself is an absolute
 278           // array and not array of arrays. This is the case when there is only one
 279           // charge-amount-notification. Hack for this special case -
 280           $chrgAmt = $response[1][$response[0]]['notifications']['charge-amount-notification'];
 281           unset($response[1][$response[0]]['notifications']['charge-amount-notification']);
 282           $response[1][$response[0]]['notifications']['charge-amount-notification'][] = $chrgAmt;
 283         }
 284
 285         foreach ($response[1][$response[0]]['notifications']['charge-amount-notification']
 286           as $amtData
 287         ) {
 288           $searchParams = array('order-numbers' => array($amtData['google-order-number']['VALUE']),
 289             'notification-types' => array('risk-information', 'new-order', 'charge-amount'),
 290           );
 291           $response = CRM_Core_Payment_Google::invokeAPI($paymentProcessor,
 292             $searchParams
 293           );
 294           // append amount information as well
 295           $response[] = $amtData;
 296
 297           $params = CRM_Contribute_BAO_Contribution_Utils::formatAPIParams($response,
 298             self::$_googleParamsMapper,
 299             'google'
 300           );
 301           if ($paymentMode == 'test') {
 302             $params['transaction']['is_test'] = 1;
 303           }
 304           else {
 305             $params['transaction']['is_test'] = 0;
 306           }
 307           if (CRM_Contribute_BAO_Contribution_Utils::processAPIContribution($params)) {
 308             CRM_Core_Error::debug_log_message("Processed - {$params['email']}, {$amtData['total-charge-amount']['VALUE']}, {$amtData['google-order-number']['VALUE']} ..<p>", TRUE);
 309           }
 310           else {
 311             CRM_Core_Error::debug_log_message("Skipped - {$params['email']}, {$amtData['total-charge-amount']['VALUE']}, {$amtData['google-order-number']['VALUE']} ..<p>", TRUE);
 312           }
 313         }
 314
 315         if ($nextPageToken) {
 316           $searchParams = array('next-page-token' => $nextPageToken);
 317           $response = CRM_Core_Payment_Google::invokeAPI($paymentProcessor, $searchParams);
 318         }
 319       }
 320     }
 321   }
 322
 323   static
 324   function csv() {
 325     $csvFile   = '/home/deepak/Desktop/crm-4247.csv';
 326     $delimiter = ";";
 327     $row       = 1;
 328
 329     $handle = fopen($csvFile, "r");
 330     if (!$handle) {
 331       CRM_Core_Error::fatal("Can't locate csv file.");
 332     }
 333
 334     require_once "CRM/Contribute/BAO/Contribution/Utils.php";
 335     while (($data = fgetcsv($handle, 1000, $delimiter)) !== FALSE) {
 336       if ($row !== 1) {
 337         $data['header'] = $header;
 338         $params = CRM_Contribute_BAO_Contribution_Utils::formatAPIParams($data,
 339           self::$_csvParamsMapper,
 340           'csv'
 341         );
 342         if (CRM_Contribute_BAO_Contribution_Utils::processAPIContribution($params)) {
 343           CRM_Core_Error::debug_log_message("Processed - line $row of csv file .. {$params['email']}, {$params['transaction']['total_amount']}, {$params['transaction']['trxn_id']} ..<p>", TRUE);
 344         }
 345         else {
 346           CRM_Core_Error::debug_log_message("Skipped - line $row of csv file .. {$params['email']}, {$params['transaction']['total_amount']}, {$params['transaction']['trxn_id']} ..<p>", TRUE);
 347         }
 348
 349         // clean up memory from dao's
 350         CRM_Core_DAO::freeResult();
 351       }
 352       else {
 353         // we assuming - first row is always the header line
 354         $header = $data;
 355         CRM_Core_Error::debug_log_message("Considering first row ( line $row ) as HEADER ..<p>", TRUE);
 356
 357         if (empty($header)) {
 358           CRM_Core_Error::fatal("Header is empty.");
 359         }
 360       }
 361       $row++;
 362     }
 363     fclose($handle);
 364   }
 365
 366   static
 367   function process() {
 368     require_once 'CRM/Utils/Request.php';
 369
 370     $type = CRM_Utils_Request::retrieve('type', 'String', CRM_Core_DAO::$_nullObject, FALSE, 'csv', 'REQUEST');
 371     $type = strtolower($type);
 372
 373     switch ($type) {
 374       case 'paypal':
 375       case 'google':
 376         $start = CRM_Utils_Request::retrieve('start', 'String',
 377           CRM_Core_DAO::$_nullObject, FALSE, 31, 'REQUEST'
 378         );
 379         $end = CRM_Utils_Request::retrieve('end', 'String',
 380           CRM_Core_DAO::$_nullObject, FALSE, 0, 'REQUEST'
 381         );
 382         if ($start < $end) {
 383           CRM_Core_Error::fatal("Start offset can't be less than End offset.");
 384         }
 385
 386         $start = date('Y-m-d', time() - $start * 24 * 60 * 60) . 'T00:00:00.00Z';
 387         $end = date('Y-m-d', time() - $end * 24 * 60 * 60) . 'T23:59:00.00Z';
 388
 389         $ppID = CRM_Utils_Request::retrieve('ppID', 'Integer',
 390           CRM_Core_DAO::$_nullObject, TRUE, NULL, 'REQUEST'
 391         );
 392         $mode = CRM_Utils_Request::retrieve('ppMode', 'String',
 393           CRM_Core_DAO::$_nullObject, FALSE, 'live', 'REQUEST'
 394         );
 395
 396         $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($ppID, $mode);
 397
 398         CRM_Core_Error::debug_log_message("Start Date=$start,  End Date=$end, ppID=$ppID, mode=$mode <p>", TRUE);
 399
 400         return self::$type($paymentProcessor, $mode, $start, $end);
 401
 402       case 'csv':
 403         return self::csv();
 404     }
 405   }
 406 }
 407
 408 // bootstrap the environment and run the processor
 409 session_start();
 410 require_once '../civicrm.config.php';
 411 require_once 'CRM/Core/Config.php';
 412 $config = CRM_Core_Config::singleton();
 413
 414 CRM_Utils_System::authenticateScript(TRUE);
 415
 416 //log the execution of script
 417 CRM_Core_Error::debug_log_message('ContributionProcessor.php');
 418
 419 require_once 'CRM/Core/Lock.php';
 420 $lock = new CRM_Core_Lock('CiviContributeProcessor');
 421
 422 if ($lock->isAcquired()) {
 423   // try to unset any time limits
 424   if (!ini_get('safe_mode')) {
 425     set_time_limit(0);
 426   }
 427
 428   CiviContributeProcessor::process();
 429 }
 430 else {
 431   throw new Exception('Could not acquire lock, another CiviMailProcessor process is running');
 432 }
 433
 434 $lock->release();
 435
 436 echo "Done processing<p>";
 437