CRM/Core/Payment.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
  36 abstract class CRM_Core_Payment {
  37
  38   /**
  39    * how are we getting billing information?
  40    *
  41    * FORM   - we collect it on the same page
  42    * BUTTON - the processor collects it and sends it back to us via some protocol
  43    */
  44   CONST
  45     BILLING_MODE_FORM = 1,
  46     BILLING_MODE_BUTTON = 2,
  47     BILLING_MODE_NOTIFY = 4;
  48
  49   /**
  50    * which payment type(s) are we using?
  51    *
  52    * credit card
  53    * direct debit
  54    * or both
  55    *
  56    */
  57   CONST
  58     PAYMENT_TYPE_CREDIT_CARD = 1,
  59     PAYMENT_TYPE_DIRECT_DEBIT = 2;
  60
  61   /**
  62    * Subscription / Recurring payment Status
  63    * START, END
  64    *
  65    */
  66   CONST
  67     RECURRING_PAYMENT_START = 'START',
  68     RECURRING_PAYMENT_END = 'END';
  69
  70   /**
  71    * We only need one instance of this object. So we use the singleton
  72    * pattern and cache the instance in this variable
  73    *
  74    * @var object
  75    * @static
  76    */
  77   static private $_singleton = NULL;
  78
  79   protected $_paymentProcessor;
  80
  81   /**
  82    * @var CRM_Core_Form
  83    */
  84   protected $_paymentForm = NULL;
  85
  86   /**
  87    * singleton function used to manage this object
  88    *
  89    * @param string  $mode the mode of operation: live or test
  90    * @param array  $paymentProcessor the details of the payment processor being invoked
  91    * @param object  $paymentForm      reference to the form object if available
  92    * @param boolean $force            should we force a reload of this payment object
  93    *
  94    * @return object
  95    * @static
  96    *
  97    */
  98   static function &singleton($mode = 'test', &$paymentProcessor, &$paymentForm = NULL, $force = FALSE) {
  99     // make sure paymentProcessor is not empty
 100     // CRM-7424
 101     if (empty($paymentProcessor)) {
 102       return CRM_Core_DAO::$_nullObject;
 103     }
 104
 105     $cacheKey = "{$mode}_{$paymentProcessor['id']}_" . (int)isset($paymentForm);
 106     if (!isset(self::$_singleton[$cacheKey]) || $force) {
 107       $config = CRM_Core_Config::singleton();
 108       $ext = CRM_Extension_System::singleton()->getMapper();
 109       if ($ext->isExtensionKey($paymentProcessor['class_name'])) {
 110         $paymentClass = $ext->keyToClass($paymentProcessor['class_name'], 'payment');
 111         require_once ($ext->classToPath($paymentClass));
 112       }
 113       else {
 114         $paymentClass = 'CRM_Core_' . $paymentProcessor['class_name'];
 115         require_once (str_replace('_', DIRECTORY_SEPARATOR, $paymentClass) . '.php');
 116       }
 117
 118       //load the object.
 119       self::$_singleton[$cacheKey] = $paymentClass::singleton($mode, $paymentProcessor);
 120     }
 121
 122     //load the payment form for required processor.
 123     if ($paymentForm !== NULL) {
 124       self::$_singleton[$cacheKey]->setForm($paymentForm);
 125     }
 126
 127     return self::$_singleton[$cacheKey];
 128   }
 129
 130   /**
 131    * @param $params
 132    *
 133    * @return mixed
 134    */
 135   public static function logPaymentNotification($params) {
 136     $message = 'payment_notification ';
 137     if (!empty($params['processor_name'])) {
 138       $message .= 'processor_name=' . $params['processor_name'];
 139     }
 140     if (!empty($params['processor_id'])) {
 141       $message .= 'processor_id=' . $params['processor_id'];
 142     }
 143
 144     $log = new CRM_Utils_SystemLogger();
 145     $log->alert($message, $_REQUEST);
 146   }
 147
 148   /**
 149    * Setter for the payment form that wants to use the processor
 150    *
 151    * @param CRM_Core_Form $paymentForm
 152    *
 153    */
 154   function setForm(&$paymentForm) {
 155     $this->_paymentForm = $paymentForm;
 156   }
 157
 158   /**
 159    * Getter for payment form that is using the processor
 160    *
 161    * @return CRM_Core_Form  A form object
 162    */
 163   function getForm() {
 164     return $this->_paymentForm;
 165   }
 166
 167   /**
 168    * Getter for accessing member vars
 169    *
 170    */
 171   function getVar($name) {
 172     return isset($this->$name) ? $this->$name : NULL;
 173   }
 174
 175   /**
 176    * This function collects all the information from a web/api form and invokes
 177    * the relevant payment processor specific functions to perform the transaction
 178    *
 179    * @param  array $params assoc array of input parameters for this transaction
 180    *
 181    * @return array the result in an nice formatted array (or an error object)
 182    * @abstract
 183    */
 184   abstract function doDirectPayment(&$params);
 185
 186   /**
 187    * This function checks to see if we have the right config values
 188    *
 189    * @internal param string $mode the mode we are operating in (live or test)
 190    *
 191    * @return string the error message if any
 192    * @public
 193    */
 194   abstract function checkConfig();
 195
 196   static function paypalRedirect(&$paymentProcessor) {
 197     if (!$paymentProcessor) {
 198       return FALSE;
 199     }
 200
 201     if (isset($_GET['payment_date']) &&
 202       isset($_GET['merchant_return_link']) &&
 203       CRM_Utils_Array::value('payment_status', $_GET) == 'Completed' &&
 204       $paymentProcessor['payment_processor_type'] == "PayPal_Standard"
 205     ) {
 206       return TRUE;
 207     }
 208
 209     return FALSE;
 210   }
 211
 212   /**
 213    * Page callback for civicrm/payment/ipn
 214    * @public
 215    */
 216   static function handleIPN() {
 217     self::handlePaymentMethod(
 218       'PaymentNotification',
 219       array(
 220         'processor_name' => @$_GET['processor_name'],
 221         'processor_id' => @$_GET['processor_id'],
 222         'mode' => @$_GET['mode'],
 223       )
 224     );
 225   }
 226
 227   /**
 228    * Payment callback handler. The processor_name or processor_id is passed in.
 229    * Note that processor_id is more reliable as one site may have more than one instance of a
 230    * processor & ideally the processor will be validating the results
 231    * Load requested payment processor and call that processor's handle<$method> method
 232    *
 233    * @public
 234    * @param $method
 235    * @param array $params
 236    */
 237   static function handlePaymentMethod($method, $params = array()) {
 238     if (!isset($params['processor_id']) && !isset($params['processor_name'])) {
 239       CRM_Core_Error::fatal("Either 'processor_id' or 'processor_name' param is required for payment callback");
 240     }
 241     self::logPaymentNotification($params);
 242
 243     // Query db for processor ..
 244     $mode = @$params['mode'];
 245
 246     $sql = "SELECT ppt.class_name, ppt.name as processor_name, pp.id AS processor_id
 247               FROM civicrm_payment_processor_type ppt
 248         INNER JOIN civicrm_payment_processor pp
 249                 ON pp.payment_processor_type_id = ppt.id
 250                AND pp.is_active
 251                AND pp.is_test = %1";
 252     $args[1] = array($mode == 'test' ? 1 : 0, 'Integer');
 253
 254     if (isset($params['processor_id'])) {
 255       $sql .= " WHERE pp.id = %2";
 256       $args[2] = array($params['processor_id'], 'Integer');
 257       $notfound = "No active instances of payment processor ID#'{$params['processor_id']}'  were found.";
 258     }
 259     else {
 260       $sql .= " WHERE ppt.name = %2";
 261       $args[2] = array($params['processor_name'], 'String');
 262       $notfound = "No active instances of the '{$params['processor_name']}' payment processor were found.";
 263     }
 264
 265     $dao = CRM_Core_DAO::executeQuery($sql, $args);
 266
 267     // Check whether we found anything at all ..
 268     if (!$dao->N) {
 269       CRM_Core_Error::fatal($notfound);
 270     }
 271
 272     $method = 'handle' . $method;
 273     $extension_instance_found = FALSE;
 274
 275     // In all likelihood, we'll just end up with the one instance returned here. But it's
 276     // possible we may get more. Hence, iterate through all instances ..
 277
 278     while ($dao->fetch()) {
 279       // Check pp is extension
 280       $ext = CRM_Extension_System::singleton()->getMapper();
 281       if ($ext->isExtensionKey($dao->class_name)) {
 282         $paymentClass = $ext->keyToClass($dao->class_name, 'payment');
 283         require_once $ext->classToPath($paymentClass);
 284       }
 285       else {
 286         // Legacy or extension as module instance
 287         if (empty($paymentClass)) {
 288           $paymentClass = 'CRM_Core_' . $dao->class_name;
 289
 290         }
 291       }
 292
 293       $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($dao->processor_id, $mode);
 294
 295       // Should never be empty - we already established this processor_id exists and is active.
 296       if (empty($paymentProcessor)) {
 297         continue;
 298       }
 299
 300       // Instantiate PP
 301       $processorInstance = $paymentClass::singleton($mode, $paymentProcessor);
 302
 303       // Does PP implement this method, and can we call it?
 304       if (!method_exists($processorInstance, $method) ||
 305         !is_callable(array($processorInstance, $method))
 306       ) {
 307         // on the off chance there is a double implementation of this processor we should keep looking for another
 308         // note that passing processor_id is more reliable & we should work to deprecate processor_name
 309         continue;
 310       }
 311
 312       // Everything, it seems, is ok - execute pp callback handler
 313       $processorInstance->$method();
 314       $extension_instance_found = TRUE;
 315     }
 316
 317     if (!$extension_instance_found) CRM_Core_Error::fatal(
 318       "No extension instances of the '{$params['processor_name']}' payment processor were found.<br />" .
 319       "$method method is unsupported in legacy payment processors."
 320     );
 321
 322     // Exit here on web requests, allowing just the plain text response to be echoed
 323     if ($method == 'handlePaymentNotification') {
 324       CRM_Utils_System::civiExit();
 325     }
 326   }
 327
 328   /**
 329    * Function to check whether a method is present ( & supported ) by the payment processor object.
 330    *
 331    * @param  string $method method to check for.
 332    *
 333    * @return boolean
 334    * @public
 335    */
 336   function isSupported($method = 'cancelSubscription') {
 337     return method_exists(CRM_Utils_System::getClassName($this), $method);
 338   }
 339
 340   function subscriptionURL($entityID = NULL, $entity = NULL, $action = 'cancel') {
 341     if ($action == 'cancel') {
 342       $url = 'civicrm/contribute/unsubscribe';
 343     }
 344     elseif ($action == 'billing') {
 345       //in notify mode don't return the update billing url
 346       if ($this->_paymentProcessor['billing_mode'] == self::BILLING_MODE_NOTIFY) {
 347         return NULL;
 348       }
 349       $url = 'civicrm/contribute/updatebilling';
 350     }
 351     elseif ($action == 'update') {
 352       $url = 'civicrm/contribute/updaterecur';
 353     }
 354     $session       = CRM_Core_Session::singleton();
 355     $userId        = $session->get('userID');
 356     $checksumValue = "";
 357
 358     if ($entityID && $entity == 'membership') {
 359       if (!$userId) {
 360         $contactID     = CRM_Core_DAO::getFieldValue("CRM_Member_DAO_Membership", $entityID, "contact_id");
 361         $checksumValue = CRM_Contact_BAO_Contact_Utils::generateChecksum($contactID, NULL, 'inf');
 362         $checksumValue = "&cs={$checksumValue}";
 363       }
 364       return CRM_Utils_System::url($url, "reset=1&mid={$entityID}{$checksumValue}", TRUE, NULL, FALSE, TRUE);
 365     }
 366
 367     if ($entityID && $entity == 'contribution') {
 368       if (!$userId) {
 369         $contactID     = CRM_Core_DAO::getFieldValue("CRM_Contribute_DAO_Contribution", $entityID, "contact_id");
 370         $checksumValue = CRM_Contact_BAO_Contact_Utils::generateChecksum($contactID, NULL, 'inf');
 371         $checksumValue = "&cs={$checksumValue}";
 372       }
 373       return CRM_Utils_System::url($url, "reset=1&coid={$entityID}{$checksumValue}", TRUE, NULL, FALSE, TRUE);
 374     }
 375
 376     if ($entityID && $entity == 'recur') {
 377       if (!$userId) {
 378         $sql = "
 379     SELECT con.contact_id
 380       FROM civicrm_contribution_recur rec
 381 INNER JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
 382      WHERE rec.id = %1
 383   GROUP BY rec.id";
 384         $contactID     = CRM_Core_DAO::singleValueQuery($sql, array(1 => array($entityID, 'Integer')));
 385         $checksumValue = CRM_Contact_BAO_Contact_Utils::generateChecksum($contactID, NULL, 'inf');
 386         $checksumValue = "&cs={$checksumValue}";
 387       }
 388       return CRM_Utils_System::url($url, "reset=1&crid={$entityID}{$checksumValue}", TRUE, NULL, FALSE, TRUE);
 389     }
 390
 391     if ($this->isSupported('accountLoginURL')) {
 392       return $this->accountLoginURL();
 393     }
 394     return $this->_paymentProcessor['url_recur'];
 395   }
 396 }