CRM/Core/Payment/PayPalIPN.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_PayPalIPN extends CRM_Core_Payment_BaseIPN {
  36
  37   static $_paymentProcessor = NULL;
  38
  39   /**
  40    * Constructor
  41    */
  42   function __construct() {
  43     parent::__construct();
  44   }
  45
  46   /**
  47    * @param $name
  48    * @param $type
  49    * @param string $location
  50    * @param bool $abort
  51    *
  52    * @return mixed
  53    */
  54   static function retrieve($name, $type, $location = 'POST', $abort = TRUE) {
  55     static $store = NULL;
  56     $value = CRM_Utils_Request::retrieve($name, $type, $store,
  57       FALSE, NULL, $location
  58     );
  59     if ($abort && $value === NULL) {
  60       CRM_Core_Error::debug_log_message("Could not find an entry for $name in $location");
  61       echo "Failure: Missing Parameter<p>";
  62       exit();
  63     }
  64     return $value;
  65   }
  66
  67   /**
  68    * @param $input
  69    * @param $ids
  70    * @param $objects
  71    * @param $first
  72    */
  73   function recur(&$input, &$ids, &$objects, $first) {
  74     if (!isset($input['txnType'])) {
  75       CRM_Core_Error::debug_log_message("Could not find txn_type in input request");
  76       echo "Failure: Invalid parameters<p>";
  77       return FALSE;
  78     }
  79
  80     if ($input['txnType'] == 'subscr_payment' &&
  81       $input['paymentStatus'] != 'Completed'
  82     ) {
  83       CRM_Core_Error::debug_log_message("Ignore all IPN payments that are not completed");
  84       echo "Failure: Invalid parameters<p>";
  85       return FALSE;
  86     }
  87
  88     $recur = &$objects['contributionRecur'];
  89
  90     // make sure the invoice ids match
  91     // make sure the invoice is valid and matches what we have in the contribution record
  92     if ($recur->invoice_id != $input['invoice']) {
  93       CRM_Core_Error::debug_log_message("Invoice values dont match between database and IPN request");
  94       echo "Failure: Invoice values dont match between database and IPN request<p>";
  95       return FALSE;
  96     }
  97
  98     $now = date('YmdHis');
  99
 100     // fix dates that already exist
 101     $dates = array('create', 'start', 'end', 'cancel', 'modified');
 102     foreach ($dates as $date) {
 103       $name = "{$date}_date";
 104       if ($recur->$name) {
 105         $recur->$name = CRM_Utils_Date::isoToMysql($recur->$name);
 106       }
 107     }
 108     $sendNotification = FALSE;
 109     $subscriptionPaymentStatus = NULL;
 110     //set transaction type
 111     $txnType = $_POST['txn_type'];
 112     switch ($txnType) {
 113       case 'subscr_signup':
 114         $recur->create_date = $now;
 115         //some times subscr_signup response come after the
 116         //subscr_payment and set to pending mode.
 117         $statusID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionRecur',
 118           $recur->id, 'contribution_status_id'
 119         );
 120         if ($statusID != 5) {
 121           $recur->contribution_status_id = 2;
 122         }
 123         $recur->processor_id = $_POST['subscr_id'];
 124         $recur->trxn_id = $recur->processor_id;
 125         $sendNotification = TRUE;
 126         $subscriptionPaymentStatus = CRM_Core_Payment::RECURRING_PAYMENT_START;
 127         break;
 128
 129       case 'subscr_eot':
 130         if ($recur->contribution_status_id != 3) {
 131           $recur->contribution_status_id = 1;
 132         }
 133         $recur->end_date = $now;
 134         $sendNotification = TRUE;
 135         $subscriptionPaymentStatus = CRM_Core_Payment::RECURRING_PAYMENT_END;
 136         break;
 137
 138       case 'subscr_cancel':
 139         $recur->contribution_status_id = 3;
 140         $recur->cancel_date = $now;
 141         break;
 142
 143       case 'subscr_failed':
 144         $recur->contribution_status_id = 4;
 145         $recur->modified_date = $now;
 146         break;
 147
 148       case 'subscr_modify':
 149         CRM_Core_Error::debug_log_message("We do not handle modifications to subscriptions right now");
 150         echo "Failure: We do not handle modifications to subscriptions right now<p>";
 151         return FALSE;
 152
 153       case 'subscr_payment':
 154         if ($first) {
 155           $recur->start_date = $now;
 156         }
 157         else {
 158           $recur->modified_date = $now;
 159         }
 160
 161         // make sure the contribution status is not done
 162         // since order of ipn's is unknown
 163         if ($recur->contribution_status_id != 1) {
 164           $recur->contribution_status_id = 5;
 165         }
 166         break;
 167     }
 168
 169     $recur->save();
 170
 171     if ($sendNotification) {
 172
 173       $autoRenewMembership = FALSE;
 174       if ($recur->id &&
 175         isset($ids['membership']) && $ids['membership']
 176       ) {
 177         $autoRenewMembership = TRUE;
 178       }
 179
 180       //send recurring Notification email for user
 181       CRM_Contribute_BAO_ContributionPage::recurringNotify($subscriptionPaymentStatus,
 182         $ids['contact'],
 183         $ids['contributionPage'],
 184         $recur,
 185         $autoRenewMembership
 186       );
 187     }
 188
 189     if ($txnType != 'subscr_payment') {
 190       return;
 191     }
 192
 193     if (!$first) {
 194       //check if this contribution transaction is already processed
 195       //if not create a contribution and then get it processed
 196       $contribution = new CRM_Contribute_BAO_Contribution();
 197       $contribution->trxn_id = $input['trxn_id'];
 198       if ($contribution->trxn_id && $contribution->find()) {
 199         CRM_Core_Error::debug_log_message("returning since contribution has already been handled");
 200         echo "Success: Contribution has already been handled<p>";
 201         return TRUE;
 202       }
 203
 204       $contribution->contact_id = $ids['contact'];
 205       $contribution->financial_type_id  = $objects['contributionType']->id;
 206       $contribution->contribution_page_id = $ids['contributionPage'];
 207       $contribution->contribution_recur_id = $ids['contributionRecur'];
 208       $contribution->receive_date = $now;
 209       $contribution->currency = $objects['contribution']->currency;
 210       $contribution->payment_instrument_id = $objects['contribution']->payment_instrument_id;
 211       $contribution->amount_level = $objects['contribution']->amount_level;
 212       $contribution->campaign_id = $objects['contribution']->campaign_id;
 213
 214       $objects['contribution'] = &$contribution;
 215     }
 216
 217     $this->single($input, $ids, $objects,
 218       TRUE, $first
 219     );
 220   }
 221
 222   /**
 223    * @param $input
 224    * @param $ids
 225    * @param $objects
 226    * @param bool $recur
 227    * @param bool $first
 228    */
 229   function single(&$input, &$ids, &$objects,
 230     $recur = FALSE,
 231     $first = FALSE
 232   ) {
 233     $contribution = &$objects['contribution'];
 234
 235     // make sure the invoice is valid and matches what we have in the contribution record
 236     if ((!$recur) || ($recur && $first)) {
 237       if ($contribution->invoice_id != $input['invoice']) {
 238         CRM_Core_Error::debug_log_message("Invoice values dont match between database and IPN request");
 239         echo "Failure: Invoice values dont match between database and IPN request<p>";
 240         return FALSE;
 241       }
 242     }
 243     else {
 244       $contribution->invoice_id = md5(uniqid(rand(), TRUE));
 245     }
 246
 247     if (!$recur) {
 248       if ($contribution->total_amount != $input['amount']) {
 249         CRM_Core_Error::debug_log_message("Amount values dont match between database and IPN request");
 250         echo "Failure: Amount values dont match between database and IPN request<p>";
 251         return FALSE;
 252       }
 253     }
 254     else {
 255       $contribution->total_amount = $input['amount'];
 256     }
 257
 258     $transaction = new CRM_Core_Transaction();
 259
 260     $participant = &$objects['participant'];
 261     $membership = &$objects['membership'];
 262
 263     $status = $input['paymentStatus'];
 264     if ($status == 'Denied' || $status == 'Failed' || $status == 'Voided') {
 265       return $this->failed($objects, $transaction);
 266     }
 267     elseif ($status == 'Pending') {
 268       return $this->pending($objects, $transaction);
 269     }
 270     elseif ($status == 'Refunded' || $status == 'Reversed') {
 271       return $this->cancelled($objects, $transaction);
 272     }
 273     elseif ($status != 'Completed') {
 274       return $this->unhandled($objects, $transaction);
 275     }
 276
 277     // check if contribution is already completed, if so we ignore this ipn
 278     if ($contribution->contribution_status_id == 1) {
 279       $transaction->commit();
 280       CRM_Core_Error::debug_log_message("returning since contribution has already been handled");
 281       echo "Success: Contribution has already been handled<p>";
 282       return TRUE;
 283     }
 284
 285     $this->completeTransaction($input, $ids, $objects, $transaction, $recur);
 286   }
 287
 288   function main() {
 289     // CRM_Core_Error::debug_var( 'GET' , $_GET , true, true );
 290     // CRM_Core_Error::debug_var( 'POST', $_POST, true, true );
 291    //@todo - this could be refactored like PayPalProIPN & a test could be added
 292
 293     $objects = $ids = $input = array();
 294     $component = CRM_Utils_Array::value('module', $_GET);
 295     $input['component'] = $component;
 296
 297     // get the contribution and contact ids from the GET params
 298     $ids['contact'] = self::retrieve('contactID', 'Integer', 'GET', TRUE);
 299     $ids['contribution'] = self::retrieve('contributionID', 'Integer', 'GET', TRUE);
 300
 301     $this->getInput($input, $ids);
 302
 303     if ($component == 'event') {
 304       $ids['event'] = self::retrieve('eventID', 'Integer', 'GET', TRUE);
 305       $ids['participant'] = self::retrieve('participantID', 'Integer', 'GET', TRUE);
 306     }
 307     else {
 308       // get the optional ids
 309       $ids['membership'] = self::retrieve('membershipID', 'Integer', 'GET', FALSE);
 310       $ids['contributionRecur'] = self::retrieve('contributionRecurID', 'Integer', 'GET', FALSE);
 311       $ids['contributionPage'] = self::retrieve('contributionPageID', 'Integer', 'GET', FALSE);
 312       $ids['related_contact'] = self::retrieve('relatedContactID', 'Integer', 'GET', FALSE);
 313       $ids['onbehalf_dupe_alert'] = self::retrieve('onBehalfDupeAlert', 'Integer', 'GET', FALSE);
 314     }
 315
 316     $paymentProcessorID = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType',
 317       'PayPal_Standard', 'id', 'name'
 318     );
 319
 320     if (!$this->validateData($input, $ids, $objects, TRUE, $paymentProcessorID)) {
 321       return FALSE;
 322     }
 323
 324     self::$_paymentProcessor = &$objects['paymentProcessor'];
 325     if ($component == 'contribute') {
 326       if ($ids['contributionRecur']) {
 327         // check if first contribution is completed, else complete first contribution
 328         $first = TRUE;
 329         if ($objects['contribution']->contribution_status_id == 1) {
 330           $first = FALSE;
 331         }
 332         return $this->recur($input, $ids, $objects, $first);
 333       }
 334       else {
 335         return $this->single($input, $ids, $objects, FALSE, FALSE);
 336       }
 337     }
 338     else {
 339       return $this->single($input, $ids, $objects, FALSE, FALSE);
 340     }
 341   }
 342
 343   /**
 344    * @param $input
 345    * @param $ids
 346    */
 347   function getInput(&$input, &$ids) {
 348     if (!$this->getBillingID($ids)) {
 349       return FALSE;
 350     }
 351
 352     $input['txnType'] = self::retrieve('txn_type', 'String', 'POST', FALSE);
 353     $input['paymentStatus'] = self::retrieve('payment_status', 'String', 'POST', FALSE);
 354     $input['invoice'] = self::retrieve('invoice', 'String', 'POST', TRUE);
 355     $input['amount'] = self::retrieve('mc_gross', 'Money', 'POST', FALSE);
 356     $input['reasonCode'] = self::retrieve('ReasonCode', 'String', 'POST', FALSE);
 357
 358     $billingID = $ids['billing'];
 359     $lookup = array(
 360       "first_name" => 'first_name',
 361       "last_name" => 'last_name',
 362       "street_address-{$billingID}" => 'address_street',
 363       "city-{$billingID}" => 'address_city',
 364       "state-{$billingID}" => 'address_state',
 365       "postal_code-{$billingID}" => 'address_zip',
 366       "country-{$billingID}" => 'address_country_code',
 367     );
 368     foreach ($lookup as $name => $paypalName) {
 369       $value = self::retrieve($paypalName, 'String', 'POST', FALSE);
 370       $input[$name] = $value ? $value : NULL;
 371     }
 372
 373     $input['is_test']    = self::retrieve('test_ipn', 'Integer', 'POST', FALSE);
 374     $input['fee_amount'] = self::retrieve('mc_fee', 'Money', 'POST', FALSE);
 375     $input['net_amount'] = self::retrieve('settle_amount', 'Money', 'POST', FALSE);
 376     $input['trxn_id']    = self::retrieve('txn_id', 'String', 'POST', FALSE);
 377   }
 378 }