crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/bin/ContributionProcessor.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  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   public static function paypal($paymentProcessor, $paymentMode, $start, $end) {
 146     $url = "{$paymentProcessor['url_api']}nvp";
 147
 148     $keyArgs = array(
 149       'user' => $paymentProcessor['user_name'],
 150       'pwd' => $paymentProcessor['password'],
 151       'signature' => $paymentProcessor['signature'],
 152       'version' => 3.0,
 153     );
 154
 155     $args = $keyArgs;
 156     $args += array(
 157       'method' => 'TransactionSearch',
 158       'startdate' => $start,
 159       'enddate' => $end,
 160     );
 161
 162     require_once 'CRM/Core/Payment/PayPalImpl.php';
 163
 164     // as invokeAPI fetch only last 100 transactions.
 165     // we should require recursive calls to process more than 100.
 166     // first fetch transactions w/ give date intervals.
 167     // if we get error code w/ result, which means we do have more than 100
 168     // manipulate date interval accordingly and fetch again.
 169
 170     do {
 171       $result = CRM_Core_Payment_PayPalImpl::invokeAPI($args, $url);
 172       require_once "CRM/Contribute/BAO/Contribution/Utils.php";
 173
 174       $keyArgs['method'] = 'GetTransactionDetails';
 175       foreach ($result as $name => $value) {
 176         if (substr($name, 0, 15) == 'l_transactionid') {
 177
 178           // We don't/can't process subscription notifications, which appear
 179           // to be identified by transaction ids beginning with S-
 180           if (substr($value, 0, 2) == 'S-') {
 181             continue;
 182           }
 183
 184           // Before we bother making a remote API call to PayPal to lookup
 185           // details about a transaction, let's make sure that it doesn't
 186           // already exist in the database.
 187           require_once 'CRM/Contribute/DAO/Contribution.php';
 188           $dao = new CRM_Contribute_DAO_Contribution();
 189           $dao->trxn_id = $value;
 190           if ($dao->find(TRUE)) {
 191             preg_match('/(\d+)$/', $name, $matches);
 192             $seq = $matches[1];
 193             $email = $result["l_email{$seq}"];
 194             $amt = $result["l_amt{$seq}"];
 195             CRM_Core_Error::debug_log_message("Skipped (already recorded) - $email, $amt, $value ..<p>", TRUE);
 196             continue;
 197           }
 198
 199           $keyArgs['transactionid'] = $value;
 200           $trxnDetails = CRM_Core_Payment_PayPalImpl::invokeAPI($keyArgs, $url);
 201           if (is_a($trxnDetails, 'CRM_Core_Error')) {
 202             echo "PAYPAL ERROR: Skipping transaction id: $value<p>";
 203             continue;
 204           }
 205
 206           // only process completed payments
 207           if (strtolower($trxnDetails['paymentstatus']) != 'completed') {
 208             continue;
 209           }
 210
 211           // only process receipts, not payments
 212           if (strtolower($trxnDetails['transactiontype']) == 'sendmoney') {
 213             continue;
 214           }
 215
 216           $params = CRM_Contribute_BAO_Contribution_Utils::formatAPIParams($trxnDetails,
 217             self::$_paypalParamsMapper,
 218             'paypal'
 219           );
 220           if ($paymentMode == 'test') {
 221             $params['transaction']['is_test'] = 1;
 222           }
 223           else {
 224             $params['transaction']['is_test'] = 0;
 225           }
 226
 227           if (CRM_Contribute_BAO_Contribution_Utils::processAPIContribution($params)) {
 228             CRM_Core_Error::debug_log_message("Processed - {$trxnDetails['email']}, {$trxnDetails['amt']}, {$value} ..<p>", TRUE);
 229           }
 230           else {
 231             CRM_Core_Error::debug_log_message("Skipped - {$trxnDetails['email']}, {$trxnDetails['amt']}, {$value} ..<p>", TRUE);
 232           }
 233         }
 234       }
 235       if ($result['l_errorcode0'] == '11002') {
 236         $end = $result['l_timestamp99'];
 237         $end_time = strtotime("{$end}", time());
 238         $end_date = date('Y-m-d\T00:00:00.00\Z', $end_time);
 239         $args['enddate'] = $end_date;
 240       }
 241     } while ($result['l_errorcode0'] == '11002');
 242   }
 243
 244   /**
 245    * @param $paymentProcessor
 246    * @param $paymentMode
 247    * @param $start
 248    * @param $end
 249    */
 250   public static function google($paymentProcessor, $paymentMode, $start, $end) {
 251     require_once "CRM/Contribute/BAO/Contribution/Utils.php";
 252     require_once 'CRM/Core/Payment/Google.php';
 253     $nextPageToken = TRUE;
 254     $searchParams = array(
 255       'start' => $start,
 256       'end' => $end,
 257       'notification-types' => array('charge-amount'),
 258     );
 259
 260     $response = CRM_Core_Payment_Google::invokeAPI($paymentProcessor, $searchParams);
 261
 262     while ($nextPageToken) {
 263       if ($response[0] == 'error') {
 264         CRM_Core_Error::debug_log_message("GOOGLE ERROR: " .
 265           $response[1]['error']['error-message']['VALUE'], TRUE
 266         );
 267       }
 268       $nextPageToken = isset($response[1][$response[0]]['next-page-token']['VALUE']) ? $response[1][$response[0]]['next-page-token']['VALUE'] : FALSE;
 269
 270       if (is_array($response[1][$response[0]]['notifications']['charge-amount-notification'])) {
 271
 272         if (array_key_exists('google-order-number',
 273           $response[1][$response[0]]['notifications']['charge-amount-notification']
 274         )) {
 275           // sometimes 'charge-amount-notification' itself is an absolute
 276           // array and not array of arrays. This is the case when there is only one
 277           // charge-amount-notification. Hack for this special case -
 278           $chrgAmt = $response[1][$response[0]]['notifications']['charge-amount-notification'];
 279           unset($response[1][$response[0]]['notifications']['charge-amount-notification']);
 280           $response[1][$response[0]]['notifications']['charge-amount-notification'][] = $chrgAmt;
 281         }
 282
 283         foreach ($response[1][$response[0]]['notifications']['charge-amount-notification'] as $amtData) {
 284           $searchParams = array(
 285             'order-numbers' => array($amtData['google-order-number']['VALUE']),
 286             'notification-types' => array('risk-information', 'new-order', 'charge-amount'),
 287           );
 288           $response = CRM_Core_Payment_Google::invokeAPI($paymentProcessor,
 289             $searchParams
 290           );
 291           // append amount information as well
 292           $response[] = $amtData;
 293
 294           $params = CRM_Contribute_BAO_Contribution_Utils::formatAPIParams($response,
 295             self::$_googleParamsMapper,
 296             'google'
 297           );
 298           if ($paymentMode == 'test') {
 299             $params['transaction']['is_test'] = 1;
 300           }
 301           else {
 302             $params['transaction']['is_test'] = 0;
 303           }
 304           if (CRM_Contribute_BAO_Contribution_Utils::processAPIContribution($params)) {
 305             CRM_Core_Error::debug_log_message("Processed - {$params['email']}, {$amtData['total-charge-amount']['VALUE']}, {$amtData['google-order-number']['VALUE']} ..<p>", TRUE);
 306           }
 307           else {
 308             CRM_Core_Error::debug_log_message("Skipped - {$params['email']}, {$amtData['total-charge-amount']['VALUE']}, {$amtData['google-order-number']['VALUE']} ..<p>", TRUE);
 309           }
 310         }
 311
 312         if ($nextPageToken) {
 313           $searchParams = array('next-page-token' => $nextPageToken);
 314           $response = CRM_Core_Payment_Google::invokeAPI($paymentProcessor, $searchParams);
 315         }
 316       }
 317     }
 318   }
 319
 320   public static function csv() {
 321     $csvFile = '/home/deepak/Desktop/crm-4247.csv';
 322     $delimiter = ";";
 323     $row = 1;
 324
 325     $handle = fopen($csvFile, "r");
 326     if (!$handle) {
 327       CRM_Core_Error::fatal("Can't locate csv file.");
 328     }
 329
 330     require_once "CRM/Contribute/BAO/Contribution/Utils.php";
 331     while (($data = fgetcsv($handle, 1000, $delimiter)) !== FALSE) {
 332       if ($row !== 1) {
 333         $data['header'] = $header;
 334         $params = CRM_Contribute_BAO_Contribution_Utils::formatAPIParams($data,
 335           self::$_csvParamsMapper,
 336           'csv'
 337         );
 338         if (CRM_Contribute_BAO_Contribution_Utils::processAPIContribution($params)) {
 339           CRM_Core_Error::debug_log_message("Processed - line $row of csv file .. {$params['email']}, {$params['transaction']['total_amount']}, {$params['transaction']['trxn_id']} ..<p>", TRUE);
 340         }
 341         else {
 342           CRM_Core_Error::debug_log_message("Skipped - line $row of csv file .. {$params['email']}, {$params['transaction']['total_amount']}, {$params['transaction']['trxn_id']} ..<p>", TRUE);
 343         }
 344
 345         // clean up memory from dao's
 346         CRM_Core_DAO::freeResult();
 347       }
 348       else {
 349         // we assuming - first row is always the header line
 350         $header = $data;
 351         CRM_Core_Error::debug_log_message("Considering first row ( line $row ) as HEADER ..<p>", TRUE);
 352
 353         if (empty($header)) {
 354           CRM_Core_Error::fatal("Header is empty.");
 355         }
 356       }
 357       $row++;
 358     }
 359     fclose($handle);
 360   }
 361
 362   public static function process() {
 363     require_once 'CRM/Utils/Request.php';
 364
 365     $type = CRM_Utils_Request::retrieve('type', 'String', CRM_Core_DAO::$_nullObject, FALSE, 'csv', 'REQUEST');
 366     $type = strtolower($type);
 367
 368     switch ($type) {
 369       case 'paypal':
 370       case 'google':
 371         $start = CRM_Utils_Request::retrieve('start', 'String',
 372           CRM_Core_DAO::$_nullObject, FALSE, 31, 'REQUEST'
 373         );
 374         $end = CRM_Utils_Request::retrieve('end', 'String',
 375           CRM_Core_DAO::$_nullObject, FALSE, 0, 'REQUEST'
 376         );
 377         if ($start < $end) {
 378           CRM_Core_Error::fatal("Start offset can't be less than End offset.");
 379         }
 380
 381         $start = date('Y-m-d', time() - $start * 24 * 60 * 60) . 'T00:00:00.00Z';
 382         $end = date('Y-m-d', time() - $end * 24 * 60 * 60) . 'T23:59:00.00Z';
 383
 384         $ppID = CRM_Utils_Request::retrieve('ppID', 'Integer',
 385           CRM_Core_DAO::$_nullObject, TRUE, NULL, 'REQUEST'
 386         );
 387         $mode = CRM_Utils_Request::retrieve('ppMode', 'String',
 388           CRM_Core_DAO::$_nullObject, FALSE, 'live', 'REQUEST'
 389         );
 390
 391         $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($ppID, $mode);
 392
 393         CRM_Core_Error::debug_log_message("Start Date=$start,  End Date=$end, ppID=$ppID, mode=$mode <p>", TRUE);
 394
 395         return self::$type($paymentProcessor, $mode, $start, $end);
 396
 397       case 'csv':
 398         return self::csv();
 399     }
 400   }
 401
 402 }
 403
 404 // bootstrap the environment and run the processor
 405 session_start();
 406 require_once '../civicrm.config.php';
 407 require_once 'CRM/Core/Config.php';
 408 $config = CRM_Core_Config::singleton();
 409
 410 CRM_Utils_System::authenticateScript(TRUE);
 411
 412 //log the execution of script
 413 CRM_Core_Error::debug_log_message('ContributionProcessor.php');
 414
 415 $lock = Civi\Core\Container::singleton()->get('lockManager')->acquire('worker.contribute.CiviContributeProcessor');
 416
 417 if ($lock->isAcquired()) {
 418   // try to unset any time limits
 419   if (!ini_get('safe_mode')) {
 420     set_time_limit(0);
 421   }
 422
 423   CiviContributeProcessor::process();
 424 }
 425 else {
 426   throw new Exception('Could not acquire lock, another CiviContributeProcessor process is running');
 427 }
 428
 429 $lock->release();
 430
 431 echo "Done processing<p>";