CRM/Core/Payment/PayPalProIPN.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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 CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN {
  36
  37   static $_paymentProcessor = NULL;
  38
  39   /**
  40    * Input parameters from payment processor. Store these so that
  41    * the code does not need to keep retrieving from the http request
  42    * @var array
  43    */
  44   protected $_inputParameters = array();
  45
  46   /**
  47    * store for the variables from the invoice string
  48    * @var array
  49    */
  50   protected $_invoiceData = array();
  51
  52   /**
  53    * Is this a payment express transaction
  54    */
  55   protected $_isPaymentExpress = FALSE;
  56
  57   /**
  58    * Are we dealing with an event an 'anything else' (contribute)
  59    * @var string component
  60    */
  61   protected $_component = 'contribute';
  62   /**
  63    * constructor function
  64    */
  65   function __construct($inputData) {
  66     $this->setInputParameters($inputData);
  67     $this->setInvoiceData();
  68     parent::__construct();
  69   }
  70
  71   /**
  72    * function exists to get the values from the rp_invoice_id string
  73    * @param string $name e.g. i, values are stored in the string with letter codes
  74    * @param boolean $abort fatal if not found?
  75    * @return unknown
  76    */
  77   function getValue($name, $abort = TRUE) {
  78     if ($abort && empty($this->_invoiceData[$name])) {
  79       throw new CRM_Core_Exception("Failure: Missing Parameter $name");
  80     }
  81     else {
  82       return CRM_Utils_Array::value($name, $this->_invoiceData);
  83     }
  84   }
  85
  86   /**
  87    * Set $this->_invoiceData from the input array
  88    */
  89   function setInvoiceData() {
  90     if(empty($this->_inputParameters['rp_invoice_id'])) {
  91       $this->_isPaymentExpress = TRUE;
  92       return;
  93     }
  94     $rpInvoiceArray = explode('&', $this->_inputParameters['rp_invoice_id']);
  95     // for clarify let's also store without the single letter unreadable
  96     //@todo after more refactoring we might ditch storing the one letter stuff
  97     $mapping = array(
  98       'i' => 'invoice_id',
  99       'm' => 'component',
 100       'c' => 'contact_id',
 101       'b' => 'contribution_id',
 102       'r' => 'contribution_recur_id',
 103       'p' => 'participant_id',
 104       'e' => 'event_id',
 105     );
 106     foreach ($rpInvoiceArray as $rpInvoiceValue) {
 107       $rpValueArray = explode('=', $rpInvoiceValue);
 108       $this->_invoiceData[$rpValueArray[0]] = $rpValueArray[1];
 109       $this->_inputParameters[$mapping[$rpValueArray[0]]] = $rpValueArray[1];
 110       // p has been overloaded & could mean contribution page or participant id. Clearly we need an
 111       // alphabet with more letters.
 112       // the mode will always be resolved before the mystery p is reached
 113       if($rpValueArray[1] == 'contribute') {
 114         $mapping['p'] = 'contribution_page_id';
 115       }
 116     }
 117   }
 118
 119   /**
 120    * @param string $name of variable to return
 121    * @param string $type data type
 122    *   - String
 123    *   - Integer
 124    * @param string $location - deprecated
 125    * @param boolean $abort abort if empty
 126    * @return Ambigous <mixed, NULL, value, unknown, array, number>
 127    */
 128   function retrieve($name, $type, $location = 'POST', $abort = TRUE) {
 129     $value = CRM_Utils_Type::validate(
 130       CRM_Utils_Array::value($name, $this->_inputParameters),
 131       $type,
 132       FALSE
 133     );
 134     if ($abort && $value === NULL) {
 135       throw new CRM_Core_Exception("Could not find an entry for $name in $location");
 136     }
 137     return $value;
 138   }
 139
 140   /**
 141    * Process recurring contributions
 142    * @param array $input
 143    * @param array $ids
 144    * @param array $objects
 145    * @param boolean $first
 146    * @return void|boolean
 147    */
 148   function recur(&$input, &$ids, &$objects, $first) {
 149     if (!isset($input['txnType'])) {
 150       CRM_Core_Error::debug_log_message("Could not find txn_type in input request");
 151       echo "Failure: Invalid parameters<p>";
 152       return FALSE;
 153     }
 154
 155     if ($input['txnType'] == 'recurring_payment' &&
 156       $input['paymentStatus'] != 'Completed'
 157     ) {
 158       CRM_Core_Error::debug_log_message("Ignore all IPN payments that are not completed");
 159       echo "Failure: Invalid parameters<p>";
 160       return FALSE;
 161     }
 162
 163     $recur = &$objects['contributionRecur'];
 164
 165     // make sure the invoice ids match
 166     // make sure the invoice is valid and matches what we have in
 167     // the contribution record
 168     if ($recur->invoice_id != $input['invoice']) {
 169       CRM_Core_Error::debug_log_message("Invoice values dont match between database and IPN request recur is " . $recur->invoice_id . " input is " . $input['invoice']);
 170       echo "Failure: Invoice values dont match between database and IPN request recur is " . $recur->invoice_id . " input is " . $input['invoice'];
 171       return FALSE;
 172     }
 173
 174     $now = date('YmdHis');
 175
 176     // fix dates that already exist
 177     $dates = array('create', 'start', 'end', 'cancel', 'modified');
 178     foreach ($dates as $date) {
 179       $name = "{$date}_date";
 180       if ($recur->$name) {
 181         $recur->$name = CRM_Utils_Date::isoToMysql($recur->$name);
 182       }
 183     }
 184
 185     $sendNotification = FALSE;
 186     $subscriptionPaymentStatus = NULL;
 187     //List of Transaction Type
 188     /*
 189          recurring_payment_profile_created          RP Profile Created
 190          recurring_payment           RP Sucessful Payment
 191          recurring_payment_failed                               RP Failed Payment
 192          recurring_payment_profile_cancel           RP Profile Cancelled
 193          recurring_payment_expired         RP Profile Expired
 194          recurring_payment_skipped        RP Profile Skipped
 195          recurring_payment_outstanding_payment      RP Sucessful Outstanding Payment
 196          recurring_payment_outstanding_payment_failed          RP Failed Outstanding Payment
 197          recurring_payment_suspended        RP Profile Suspended
 198          recurring_payment_suspended_due_to_max_failed_payment  RP Profile Suspended due to Max Failed Payment
 199         */
 200
 201
 202     //set transaction type
 203     $txnType = $this->retrieve('txn_type', 'String');
 204     //Changes for paypal pro recurring payment
 205
 206     switch ($txnType) {
 207       case 'recurring_payment_profile_created':
 208         $recur->create_date = $now;
 209         $recur->contribution_status_id = 2;
 210         $recur->processor_id = $this->retrieve('recurring_payment_id', 'String');
 211         $recur->trxn_id = $recur->processor_id;
 212         $subscriptionPaymentStatus = CRM_Core_Payment::RECURRING_PAYMENT_START;
 213         $sendNotification = TRUE;
 214         break;
 215
 216       case 'recurring_payment':
 217         if ($first) {
 218           $recur->start_date = $now;
 219         }
 220         else {
 221           $recur->modified_date = $now;
 222         }
 223
 224         //contribution installment is completed
 225         if ($this->retrieve('profile_status', 'String') == 'Expired') {
 226           $recur->contribution_status_id = 1;
 227           $recur->end_date = $now;
 228           $sendNotification = TRUE;
 229           $subscriptionPaymentStatus = CRM_Core_Payment::RECURRING_PAYMENT_END;
 230         }
 231
 232         // make sure the contribution status is not done
 233         // since order of ipn's is unknown
 234         if ($recur->contribution_status_id != 1) {
 235           $recur->contribution_status_id = 5;
 236         }
 237         break;
 238     }
 239
 240     $recur->save();
 241
 242     if ($sendNotification) {
 243       $autoRenewMembership = FALSE;
 244       if ($recur->id &&
 245         isset($ids['membership']) && $ids['membership']
 246       ) {
 247         $autoRenewMembership = TRUE;
 248       }
 249       //send recurring Notification email for user
 250       CRM_Contribute_BAO_ContributionPage::recurringNotify($subscriptionPaymentStatus,
 251         $ids['contact'],
 252         $ids['contributionPage'],
 253         $recur,
 254         $autoRenewMembership
 255       );
 256     }
 257
 258     if ($txnType != 'recurring_payment') {
 259       return;
 260     }
 261
 262     if (!$first) {
 263       //check if this contribution transaction is already processed
 264       //if not create a contribution and then get it processed
 265       $contribution = new CRM_Contribute_BAO_Contribution();
 266       $contribution->trxn_id = $input['trxn_id'];
 267       if ($contribution->trxn_id && $contribution->find()) {
 268         CRM_Core_Error::debug_log_message("returning since contribution has already been handled");
 269         echo "Success: Contribution has already been handled<p>";
 270         return TRUE;
 271       }
 272
 273       $contribution->contact_id = $recur->contact_id;
 274       $contribution->financial_type_id  = $objects['contributionType']->id;
 275       $contribution->contribution_page_id = $ids['contributionPage'];
 276       $contribution->contribution_recur_id = $ids['contributionRecur'];
 277       $contribution->currency = $objects['contribution']->currency;
 278       $contribution->payment_instrument_id = $objects['contribution']->payment_instrument_id;
 279       $contribution->amount_level = $objects['contribution']->amount_level;
 280       $contribution->campaign_id = $objects['contribution']->campaign_id;
 281       $objects['contribution'] = &$contribution;
 282     }
 283     // CRM-13737 - am not aware of any reason why payment_date would not be set - this if is a belt & braces
 284     $objects['contribution']->receive_date = !empty($input['payment_date']) ? date('YmdHis', strtotime($input['payment_date'])): $now;
 285
 286     $this->single($input, $ids, $objects,
 287       TRUE, $first
 288     );
 289   }
 290
 291   function single(&$input, &$ids, &$objects, $recur = FALSE, $first = FALSE) {
 292     $contribution = &$objects['contribution'];
 293
 294     // make sure the invoice is valid and matches what we have in the contribution record
 295     if ((!$recur) || ($recur && $first)) {
 296       if ($contribution->invoice_id != $input['invoice']) {
 297         CRM_Core_Error::debug_log_message("Invoice values dont match between database and IPN request");
 298         echo "Failure: Invoice values dont match between database and IPN request<p>contribution is" . $contribution->invoice_id . " and input is " . $input['invoice'];
 299         return FALSE;
 300       }
 301     }
 302     else {
 303       $contribution->invoice_id = md5(uniqid(rand(), TRUE));
 304     }
 305
 306     if (!$recur) {
 307       if ($contribution->total_amount != $input['amount']) {
 308         CRM_Core_Error::debug_log_message("Amount values dont match between database and IPN request");
 309         echo "Failure: Amount values dont match between database and IPN request<p>";
 310         return FALSE;
 311       }
 312     }
 313     else {
 314       $contribution->total_amount = $input['amount'];
 315     }
 316
 317     $transaction = new CRM_Core_Transaction();
 318
 319     $participant = &$objects['participant'];
 320     $membership = &$objects['membership'];
 321
 322     $status = $input['paymentStatus'];
 323     if ($status == 'Denied' || $status == 'Failed' || $status == 'Voided') {
 324       return $this->failed($objects, $transaction);
 325     }
 326     elseif ($status == 'Pending') {
 327       return $this->pending($objects, $transaction);
 328     }
 329     elseif ($status == 'Refunded' || $status == 'Reversed') {
 330       return $this->cancelled($objects, $transaction);
 331     }
 332     elseif ($status != 'Completed') {
 333       return $this->unhandled($objects, $transaction);
 334     }
 335
 336     // check if contribution is already completed, if so we ignore this ipn
 337     if ($contribution->contribution_status_id == 1) {
 338       $transaction->commit();
 339       CRM_Core_Error::debug_log_message("returning since contribution has already been handled");
 340       echo "Success: Contribution has already been handled<p>";
 341       return TRUE;
 342     }
 343
 344     $this->completeTransaction($input, $ids, $objects, $transaction, $recur);
 345   }
 346
 347   /**
 348    * This is the main function to call. It should be sufficient to instantiate the class
 349    * (with the input parameters) & call this & all will be done
 350    *
 351    * @todo the references to POST throughout this class need to be removed
 352    * @return void|boolean|Ambigous <void, boolean>
 353    */
 354   function main() {
 355     CRM_Core_Error::debug_var('GET', $_GET, TRUE, TRUE);
 356     CRM_Core_Error::debug_var('POST', $_POST, TRUE, TRUE);
 357     if($this->_isPaymentExpress) {
 358       $this->handlePaymentExpress();
 359       return;
 360     }
 361     $objects = $ids = $input = array();
 362     $this->_component  = $input['component'] = self::getValue('m');
 363
 364     // get the contribution and contact ids from the GET params
 365     $ids['contact'] = self::getValue('c', TRUE);
 366     $ids['contribution'] = self::getValue('b', TRUE);
 367
 368     $this->getInput($input, $ids);
 369
 370     if ($this->_component == 'event') {
 371       $ids['event'] = self::getValue('e', TRUE);
 372       $ids['participant'] = self::getValue('p', TRUE);
 373       $ids['contributionRecur'] = self::getValue('r', FALSE);
 374     }
 375     else {
 376       // get the optional ids
 377       //@ how can this not be broken retrieving from GET as we are dealing with a POST request?
 378       // copy & paste? Note the retrieve function now uses data from _REQUEST so this will be included
 379       $ids['membership'] = self::retrieve('membershipID', 'Integer', 'GET', FALSE);
 380       $ids['contributionRecur'] = self::getValue('r', FALSE);
 381       $ids['contributionPage'] = self::getValue('p', FALSE);
 382       $ids['related_contact'] = self::retrieve('relatedContactID', 'Integer', 'GET', FALSE);
 383       $ids['onbehalf_dupe_alert'] = self::retrieve('onBehalfDupeAlert', 'Integer', 'GET', FALSE);
 384     }
 385
 386     if (!$ids['membership'] && $ids['contributionRecur']) {
 387       $sql = "
 388     SELECT m.id
 389       FROM civicrm_membership m
 390 INNER JOIN civicrm_membership_payment mp ON m.id = mp.membership_id AND mp.contribution_id = %1
 391      WHERE m.contribution_recur_id = %2
 392      LIMIT 1";
 393       $sqlParams = array(1 => array($ids['contribution'], 'Integer'),
 394         2 => array($ids['contributionRecur'], 'Integer'),
 395       );
 396       if ($membershipId = CRM_Core_DAO::singleValueQuery($sql, $sqlParams)) {
 397         $ids['membership'] = $membershipId;
 398       }
 399     }
 400
 401     $paymentProcessorID = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType',
 402       'PayPal', 'id', 'name'
 403     );
 404
 405     if (!$this->validateData($input, $ids, $objects, TRUE, $paymentProcessorID)) {
 406       return FALSE;
 407     }
 408
 409     self::$_paymentProcessor = &$objects['paymentProcessor'];
 410     //?? how on earth would we not have component be one of these?
 411     // they are the only valid settings & this IPN file can't even be called without one of them
 412     // grepping for this class doesn't find other paths to call this class
 413     if ($this->_component == 'contribute' || $this->_component == 'event') {
 414       if ($ids['contributionRecur']) {
 415         // check if first contribution is completed, else complete first contribution
 416         $first = TRUE;
 417         if ($objects['contribution']->contribution_status_id == 1) {
 418           $first = FALSE;
 419         }
 420         return $this->recur($input, $ids, $objects, $first);
 421       }
 422       else {
 423         return $this->single($input, $ids, $objects, FALSE, FALSE);
 424       }
 425     }
 426     else {
 427       return $this->single($input, $ids, $objects, FALSE, FALSE);
 428     }
 429   }
 430
 431   function getInput(&$input, &$ids) {
 432
 433     if (!$this->getBillingID($ids)) {
 434       return FALSE;
 435     }
 436
 437     $input['txnType'] = self::retrieve('txn_type', 'String', 'POST', FALSE);
 438     $input['paymentStatus'] = self::retrieve('payment_status', 'String', 'POST', FALSE);
 439     $input['invoice'] = self::getValue('i', TRUE);
 440
 441     $input['amount'] = self::retrieve('mc_gross', 'Money', 'POST', FALSE);
 442     $input['reasonCode'] = self::retrieve('ReasonCode', 'String', 'POST', FALSE);
 443
 444     $billingID = $ids['billing'];
 445     $lookup = array(
 446       "first_name" => 'first_name',
 447       "last_name" => 'last_name',
 448       "street_address-{$billingID}" => 'address_street',
 449       "city-{$billingID}" => 'address_city',
 450       "state-{$billingID}" => 'address_state',
 451       "postal_code-{$billingID}" => 'address_zip',
 452       "country-{$billingID}" => 'address_country_code',
 453     );
 454     foreach ($lookup as $name => $paypalName) {
 455       $value = self::retrieve($paypalName, 'String', 'POST', FALSE);
 456       $input[$name] = $value ? $value : NULL;
 457     }
 458
 459     $input['is_test']    = self::retrieve('test_ipn', 'Integer', 'POST', FALSE);
 460     $input['fee_amount'] = self::retrieve('mc_fee', 'Money', 'POST', FALSE);
 461     $input['net_amount'] = self::retrieve('settle_amount', 'Money', 'POST', FALSE);
 462     $input['trxn_id']    = self::retrieve('txn_id', 'String', 'POST', FALSE);
 463     $input['payment_date'] = self::retrieve('payment_date', 'String', 'POST', FALSE);
 464   }
 465
 466   /**
 467    * Handle payment express IPNs
 468    * For one off IPNS no actual response is required
 469    * Recurring is more difficult as we have limited confirmation material
 470    */
 471   function handlePaymentExpress() {
 472     throw new CRM_Core_Exception('Payment Express IPNS not currently handled');
 473   }
 474 }
 475