CRM/Core/Payment/BaseIPN.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  * Class CRM_Core_Payment_BaseIPN.
  30  */
  31 class CRM_Core_Payment_BaseIPN {
  32
  33   static $_now = NULL;
  34
  35   /**
  36    * Input parameters from payment processor. Store these so that
  37    * the code does not need to keep retrieving from the http request
  38    * @var array
  39    */
  40   protected $_inputParameters = array();
  41
  42   /**
  43    * Only used by AuthorizeNetIPN.
  44    *
  45    * @deprecated
  46    *
  47    * @var bool
  48    */
  49   protected $_isRecurring = FALSE;
  50
  51   /**
  52    * Only used by AuthorizeNetIPN.
  53    *
  54    * @deprecated
  55    *
  56    * @var bool
  57    */
  58   protected $_isFirstOrLastRecurringPayment = FALSE;
  59
  60   /**
  61    * Constructor.
  62    */
  63   public function __construct() {
  64     self::$_now = date('YmdHis');
  65   }
  66
  67   /**
  68    * Store input array on the class.
  69    *
  70    * @param array $parameters
  71    *
  72    * @throws CRM_Core_Exception
  73    */
  74   public function setInputParameters($parameters) {
  75     if (!is_array($parameters)) {
  76       throw new CRM_Core_Exception('Invalid input parameters');
  77     }
  78     $this->_inputParameters = $parameters;
  79   }
  80
  81   /**
  82    * Validate incoming data.
  83    *
  84    * This function is intended to ensure that incoming data matches
  85    * It provides a form of pseudo-authentication - by checking the calling fn already knows
  86    * the correct contact id & contribution id (this can be problematic when that has changed in
  87    * the meantime for transactions that are delayed & contacts are merged in-between. e.g
  88    * Paypal allows you to resend Instant Payment Notifications if you, for example, moved site
  89    * and didn't update your IPN URL.
  90    *
  91    * @param array $input
  92    *   Interpreted values from the values returned through the IPN.
  93    * @param array $ids
  94    *   More interpreted values (ids) from the values returned through the IPN.
  95    * @param array $objects
  96    *   An empty array that will be populated with loaded object.
  97    * @param bool $required
  98    *   Boolean Return FALSE if the relevant objects don't exist.
  99    * @param int $paymentProcessorID
 100    *   Id of the payment processor ID in use.
 101    *
 102    * @return bool
 103    */
 104   public function validateData(&$input, &$ids, &$objects, $required = TRUE, $paymentProcessorID = NULL) {
 105
 106     // make sure contact exists and is valid
 107     $contact = new CRM_Contact_BAO_Contact();
 108     $contact->id = $ids['contact'];
 109     if (!$contact->find(TRUE)) {
 110       CRM_Core_Error::debug_log_message("Could not find contact record: {$ids['contact']} in IPN request: " . print_r($input, TRUE));
 111       echo "Failure: Could not find contact record: {$ids['contact']}<p>";
 112       return FALSE;
 113     }
 114
 115     // make sure contribution exists and is valid
 116     $contribution = new CRM_Contribute_BAO_Contribution();
 117     $contribution->id = $ids['contribution'];
 118     if (!$contribution->find(TRUE)) {
 119       CRM_Core_Error::debug_log_message("Could not find contribution record: {$contribution->id} in IPN request: " . print_r($input, TRUE));
 120       echo "Failure: Could not find contribution record for {$contribution->id}<p>";
 121       return FALSE;
 122     }
 123     $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date);
 124     $contribution->receipt_date = CRM_Utils_Date::isoToMysql($contribution->receipt_date);
 125
 126     $objects['contact'] = &$contact;
 127     $objects['contribution'] = &$contribution;
 128     if (!$this->loadObjects($input, $ids, $objects, $required, $paymentProcessorID)) {
 129       return FALSE;
 130     }
 131     //the process is that the loadObjects is kind of hacked by loading the objects for the original contribution and then somewhat inconsistently using them for the
 132     //current contribution. Here we ensure that the original contribution is available to the complete transaction function
 133     //we don't want to fix this in the payment processor classes because we would have to fix all of them - so better to fix somewhere central
 134     if (isset($objects['contributionRecur'])) {
 135       $objects['first_contribution'] = $objects['contribution'];
 136     }
 137     return TRUE;
 138   }
 139
 140   /**
 141    * Load objects related to contribution.
 142    *
 143    * @input array information from Payment processor
 144    *
 145    * @param array $input
 146    * @param array $ids
 147    * @param array $objects
 148    * @param bool $required
 149    * @param int $paymentProcessorID
 150    * @param array $error_handling
 151    *
 152    * @return bool|array
 153    */
 154   public function loadObjects(&$input, &$ids, &$objects, $required, $paymentProcessorID, $error_handling = NULL) {
 155     if (empty($error_handling)) {
 156       // default options are that we log an error & echo it out
 157       // note that we should refactor this error handling into error code @ some point
 158       // but for now setting up enough separation so we can do unit tests
 159       $error_handling = array(
 160         'log_error' => 1,
 161         'echo_error' => 1,
 162       );
 163     }
 164     $ids['paymentProcessor'] = $paymentProcessorID;
 165     if (is_a($objects['contribution'], 'CRM_Contribute_BAO_Contribution')) {
 166       $contribution = &$objects['contribution'];
 167     }
 168     else {
 169       //legacy support - functions are 'used' to be able to pass in a DAO
 170       $contribution = new CRM_Contribute_BAO_Contribution();
 171       $contribution->id = CRM_Utils_Array::value('contribution', $ids);
 172       $contribution->find(TRUE);
 173       $objects['contribution'] = &$contribution;
 174     }
 175     try {
 176       $success = $contribution->loadRelatedObjects($input, $ids);
 177       if ($required && empty($contribution->_relatedObjects['paymentProcessor'])) {
 178         throw new CRM_Core_Exception("Could not find payment processor for contribution record: " . $contribution->id);
 179       }
 180     }
 181     catch (Exception $e) {
 182       $success = FALSE;
 183       if (!empty($error_handling['log_error'])) {
 184         CRM_Core_Error::debug_log_message($e->getMessage());
 185       }
 186       if (!empty($error_handling['echo_error'])) {
 187         echo $e->getMessage();
 188       }
 189       if (!empty($error_handling['return_error'])) {
 190         return array(
 191           'is_error' => 1,
 192           'error_message' => ($e->getMessage()),
 193         );
 194       }
 195     }
 196     $objects = array_merge($objects, $contribution->_relatedObjects);
 197     return $success;
 198   }
 199
 200   /**
 201    * Set contribution to failed.
 202    *
 203    * @param array $objects
 204    * @param object $transaction
 205    * @param array $input
 206    *
 207    * @return bool
 208    */
 209   public function failed(&$objects, &$transaction, $input = array()) {
 210     $contribution = &$objects['contribution'];
 211     $memberships = array();
 212     if (!empty($objects['membership'])) {
 213       $memberships = &$objects['membership'];
 214       if (is_numeric($memberships)) {
 215         $memberships = array($objects['membership']);
 216       }
 217     }
 218
 219     $addLineItems = FALSE;
 220     if (empty($contribution->id)) {
 221       $addLineItems = TRUE;
 222     }
 223     $participant = &$objects['participant'];
 224
 225     // CRM-15546
 226     $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
 227         'labelColumn' => 'name',
 228         'flip' => 1,
 229       ));
 230     $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date);
 231     $contribution->receipt_date = CRM_Utils_Date::isoToMysql($contribution->receipt_date);
 232     $contribution->thankyou_date = CRM_Utils_Date::isoToMysql($contribution->thankyou_date);
 233     $contribution->contribution_status_id = $contributionStatuses['Failed'];
 234     $contribution->save();
 235
 236     // Add line items for recurring payments.
 237     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) {
 238       CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($objects['contributionRecur']->id, $contribution);
 239     }
 240
 241     //add new soft credit against current contribution id and
 242     //copy initial contribution custom fields for recurring contributions
 243     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id) {
 244       CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
 245       CRM_Contribute_BAO_ContributionRecur::copyCustomValues($objects['contributionRecur']->id, $contribution->id);
 246     }
 247
 248     if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
 249       if (!empty($memberships)) {
 250         // if transaction is failed then set "Cancelled" as membership status
 251         $membershipStatuses = CRM_Core_PseudoConstant::get('CRM_Member_DAO_Membership', 'status_id', array(
 252             'labelColumn' => 'name',
 253             'flip' => 1,
 254           ));
 255         foreach ($memberships as $membership) {
 256           if ($membership) {
 257             $membership->status_id = $membershipStatuses['Cancelled'];
 258             $membership->save();
 259
 260             //update related Memberships.
 261             $params = array('status_id' => $membershipStatuses['Cancelled']);
 262             CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $params);
 263           }
 264         }
 265       }
 266
 267       if ($participant) {
 268         $participantStatuses = CRM_Core_PseudoConstant::get('CRM_Event_DAO_Participant', 'status_id', array(
 269             'labelColumn' => 'name',
 270             'flip' => 1,
 271           ));
 272         $participant->status_id = $participantStatuses['Cancelled'];
 273         $participant->save();
 274       }
 275     }
 276
 277     $transaction->commit();
 278     CRM_Core_Error::debug_log_message("Setting contribution status to failed");
 279     //echo "Success: Setting contribution status to failed<p>";
 280     return TRUE;
 281   }
 282
 283   /**
 284    * Handled pending contribution status.
 285    *
 286    * @param array $objects
 287    * @param object $transaction
 288    *
 289    * @return bool
 290    */
 291   public function pending(&$objects, &$transaction) {
 292     $transaction->commit();
 293     CRM_Core_Error::debug_log_message("returning since contribution status is pending");
 294     echo "Success: Returning since contribution status is pending<p>";
 295     return TRUE;
 296   }
 297
 298   /**
 299    * Process cancelled payment outcome.
 300    *
 301    * @param array $objects
 302    * @param CRM_Core_Transaction $transaction
 303    * @param array $input
 304    *
 305    * @return bool
 306    */
 307   public function cancelled(&$objects, &$transaction, $input = array()) {
 308     $contribution = &$objects['contribution'];
 309     $memberships = &$objects['membership'];
 310     if (is_numeric($memberships)) {
 311       $memberships = array($objects['membership']);
 312     }
 313
 314     $participant = &$objects['participant'];
 315     $addLineItems = FALSE;
 316     if (empty($contribution->id)) {
 317       $addLineItems = TRUE;
 318     }
 319     $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
 320         'labelColumn' => 'name',
 321         'flip' => 1,
 322       ));
 323     $contribution->contribution_status_id = $contributionStatuses['Cancelled'];
 324     $contribution->cancel_date = self::$_now;
 325     $contribution->cancel_reason = CRM_Utils_Array::value('reasonCode', $input);
 326     $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date);
 327     $contribution->receipt_date = CRM_Utils_Date::isoToMysql($contribution->receipt_date);
 328     $contribution->thankyou_date = CRM_Utils_Date::isoToMysql($contribution->thankyou_date);
 329     $contribution->save();
 330
 331     //add lineitems for recurring payments
 332     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) {
 333       CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($objects['contributionRecur']->id, $contribution);
 334     }
 335
 336     //add new soft credit against current $contribution and
 337     //copy initial contribution custom fields for recurring contributions
 338     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id) {
 339       CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
 340       CRM_Contribute_BAO_ContributionRecur::copyCustomValues($objects['contributionRecur']->id, $contribution->id);
 341     }
 342
 343     if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
 344       if (!empty($memberships)) {
 345         $membershipStatuses = CRM_Core_PseudoConstant::get('CRM_Member_DAO_Membership', 'status_id', array(
 346             'labelColumn' => 'name',
 347             'flip' => 1,
 348           ));
 349         // Cancel only Pending memberships
 350         // CRM-18688
 351         $pendingStatusId = $membershipStatuses['Pending'];
 352         foreach ($memberships as $membership) {
 353           if ($membership && ($membership->status_id == $pendingStatusId)) {
 354             $membership->status_id = $membershipStatuses['Cancelled'];
 355             $membership->save();
 356
 357             //update related Memberships.
 358             $params = array('status_id' => $membershipStatuses['Cancelled']);
 359             CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $params);
 360           }
 361         }
 362       }
 363
 364       if ($participant) {
 365         $participantStatuses = CRM_Core_PseudoConstant::get('CRM_Event_DAO_Participant', 'status_id', array(
 366             'labelColumn' => 'name',
 367             'flip' => 1,
 368           ));
 369         $participant->status_id = $participantStatuses['Cancelled'];
 370         $participant->save();
 371       }
 372     }
 373     $transaction->commit();
 374     CRM_Core_Error::debug_log_message("Setting contribution status to cancelled");
 375     //echo "Success: Setting contribution status to cancelled<p>";
 376     return TRUE;
 377   }
 378
 379   /**
 380    * Rollback unhandled outcomes.
 381    *
 382    * @param array $objects
 383    * @param CRM_Core_Transaction $transaction
 384    *
 385    * @return bool
 386    */
 387   public function unhandled(&$objects, &$transaction) {
 388     $transaction->rollback();
 389     CRM_Core_Error::debug_log_message("returning since contribution status: is not handled");
 390     echo "Failure: contribution status is not handled<p>";
 391     return FALSE;
 392   }
 393
 394   /**
 395    * Jumbled up function.
 396    *
 397    * The purpose of this function is to transition a pending transaction to Completed including updating any
 398    * related entities.
 399    *
 400    * It has been overloaded to also add recurring transactions to the database, cloning the original transaction and
 401    * updating related entities.
 402    *
 403    * It is recommended to avoid calling this function directly and call the api functions:
 404    *  - contribution.completetransaction
 405    *  - contribution.repeattransaction
 406    *
 407    * These functions are the focus of testing efforts and more accurately reflect the division of roles
 408    * (the job of the IPN class is to determine the outcome, transaction id, invoice id & to validate the source
 409    * and from there it should be possible to pass off transaction management.)
 410    *
 411    * This function has been problematic for some time but there are now several tests via the api_v3_Contribution test
 412    * and the Paypal & Authorize.net IPN tests so any refactoring should be done in conjunction with those.
 413    *
 414    * This function needs to have the 'body' moved to the CRM_Contribution_BAO_Contribute class and to undergo
 415    * refactoring to separate the complete transaction and repeat transaction functionality into separate functions with
 416    * a shared function that updates related components.
 417    *
 418    * Note that it is not necessary payment processor extension to implement an IPN class now. In general the code on the
 419    * IPN class is better accessed through the api which de-jumbles it a bit.
 420    *
 421    * e.g the payment class can have a function like (based on Omnipay extension):
 422    *
 423    *   public function handlePaymentNotification() {
 424    *     $response = $this->getValidatedOutcome();
 425    *     if ($response->isSuccessful()) {
 426    *      try {
 427    *        // @todo check if it is a repeat transaction & call repeattransaction instead.
 428    *        civicrm_api3('contribution', 'completetransaction', array('id' => $this->transaction_id));
 429    *      }
 430    *     catch (CiviCRM_API3_Exception $e) {
 431    *     if (!stristr($e->getMessage(), 'Contribution already completed')) {
 432    *       $this->handleError('error', $this->transaction_id  . $e->getMessage(), 'ipn_completion', 9000, 'An error may
 433    *         have occurred. Please check your receipt is correct');
 434    *       $this->redirectOrExit('success');
 435    *     }
 436    *     elseif ($this->transaction_id) {
 437    *        civicrm_api3('contribution', 'create', array('id' => $this->transaction_id, 'contribution_status_id' =>
 438    *        'Failed'));
 439    *     }
 440    *
 441    * @param array $input
 442    * @param array $ids
 443    * @param array $objects
 444    * @param CRM_Core_Transaction $transaction
 445    * @param bool $recur
 446    */
 447   public function completeTransaction(&$input, &$ids, &$objects, &$transaction, $recur = FALSE) {
 448     $isRecurring = $this->_isRecurring;
 449     $isFirstOrLastRecurringPayment = $this->_isFirstOrLastRecurringPayment;
 450     $contribution = &$objects['contribution'];
 451
 452     CRM_Contribute_BAO_Contribution::completeOrder($input, $ids, $objects, $transaction, $recur, $contribution,
 453       $isRecurring, $isFirstOrLastRecurringPayment);
 454   }
 455
 456   /**
 457    * Get site billing ID.
 458    *
 459    * @param array $ids
 460    *
 461    * @return bool
 462    */
 463   public function getBillingID(&$ids) {
 464     $ids['billing'] = CRM_Core_BAO_LocationType::getBilling();
 465     if (!$ids['billing']) {
 466       CRM_Core_Error::debug_log_message(ts('Please set a location type of %1', array(1 => 'Billing')));
 467       echo "Failure: Could not find billing location type<p>";
 468       return FALSE;
 469     }
 470     return TRUE;
 471   }
 472
 473   /**
 474    * Send receipt from contribution.
 475    *
 476    * @deprecated
 477    *
 478    * Note that the compose message part has been moved to contribution
 479    * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it
 480    *
 481    * @param array $input
 482    *   Incoming data from Payment processor.
 483    * @param array $ids
 484    *   Related object IDs.
 485    * @param array $objects
 486    * @param array $values
 487    *   Values related to objects that have already been loaded.
 488    * @param bool $recur
 489    *   Is it part of a recurring contribution.
 490    * @param bool $returnMessageText
 491    *   Should text be returned instead of sent. This.
 492    *   is because the function is also used to generate pdfs
 493    *
 494    * @return array
 495    */
 496   public function sendMail(&$input, &$ids, &$objects, &$values, $recur = FALSE, $returnMessageText = FALSE) {
 497     return CRM_Contribute_BAO_Contribution::sendMail($input, $ids, $objects['contribution']->id, $values, $recur,
 498       $returnMessageText);
 499   }
 500
 501 }