3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
28 use Civi\Payment\System
;
31 * Class CRM_Core_Payment.
33 * This class is the main class for the payment processor subsystem.
35 * It is the parent class for payment processors. It also holds some IPN related functions
36 * that need to be moved. In particular handlePaymentMethod should be moved to a factory class.
38 abstract class CRM_Core_Payment
{
41 * How are we getting billing information?
43 * FORM - we collect it on the same page
44 * BUTTON - the processor collects it and sends it back to us via some protocol
47 BILLING_MODE_FORM
= 1,
48 BILLING_MODE_BUTTON
= 2,
49 BILLING_MODE_NOTIFY
= 4;
52 * Which payment type(s) are we using?
57 * @todo create option group - nb omnipay uses a 3rd type - transparent redirect cc
60 PAYMENT_TYPE_CREDIT_CARD
= 1,
61 PAYMENT_TYPE_DIRECT_DEBIT
= 2;
64 * Subscription / Recurring payment Status
68 RECURRING_PAYMENT_START
= 'START',
69 RECURRING_PAYMENT_END
= 'END';
71 protected $_paymentProcessor;
74 * Singleton function used to manage this object.
76 * We will migrate to calling Civi\Payment\System::singleton()->getByProcessor($paymentProcessor)
77 * & Civi\Payment\System::singleton()->getById($paymentProcessor) directly as the main access methods & work
78 * to remove this function all together
81 * The mode of operation: live or test.
82 * @param array $paymentProcessor
83 * The details of the payment processor being invoked.
84 * @param object $paymentForm
85 * Deprecated - avoid referring to this if possible. If you have to use it document why as this is scary interaction.
87 * Should we force a reload of this payment object.
89 * @return CRM_Core_Payment
90 * @throws \CRM_Core_Exception
92 public static function singleton($mode = 'test', &$paymentProcessor, &$paymentForm = NULL, $force = FALSE) {
93 // make sure paymentProcessor is not empty
95 if (empty($paymentProcessor)) {
96 return CRM_Core_DAO
::$_nullObject;
98 //we use two lines because we can't remove the '&singleton' without risking breakage
99 //of extension classes that extend this one
100 $object = Civi\Payment\System
::singleton()->getByProcessor($paymentProcessor);
105 * Log payment notification message to forensic system log.
107 * @todo move to factory class \Civi\Payment\System (or similar)
109 * @param array $params
113 public static function logPaymentNotification($params) {
114 $message = 'payment_notification ';
115 if (!empty($params['processor_name'])) {
116 $message .= 'processor_name=' . $params['processor_name'];
118 if (!empty($params['processor_id'])) {
119 $message .= 'processor_id=' . $params['processor_id'];
122 $log = new CRM_Utils_SystemLogger();
123 $log->alert($message, $_REQUEST);
127 * Check if capability is supported.
129 * Capabilities have a one to one relationship with capability-related functions on this class.
131 * Payment processor classes should over-ride the capability-specific function rather than this one.
133 * @param string $capability
134 * E.g BackOffice, LiveMode, FutureRecurStartDate.
138 public function supports($capability) {
139 $function = 'supports' . ucfirst($capability);
140 if (method_exists($this, $function)) {
141 return $this->$function();
147 * Are back office payments supported.
149 * e.g paypal standard won't permit you to enter a credit card associated
150 * with someone else's login.
151 * The intention is to support off-site (other than paypal) & direct debit but that is not all working yet so to
152 * reach a 'stable' point we disable.
156 protected function supportsBackOffice() {
157 if ($this->_paymentProcessor
['billing_mode'] == 4 ||
$this->_paymentProcessor
['payment_type'] != 1) {
166 * Are live payments supported - e.g dummy doesn't support this.
170 protected function supportsLiveMode() {
175 * Are test payments supported.
179 protected function supportsTestMode() {
184 * Should the first payment date be configurable when setting up back office recurring payments.
186 * We set this to false for historical consistency but in fact most new processors use tokens for recurring and can support this
190 protected function supportsFutureRecurStartDate() {
195 * Default payment instrument validation.
197 * Implement the usual Luhn algorithm via a static function in the CRM_Core_Payment_Form if it's a credit card
198 * Not a static function, because I need to check for payment_type.
200 * @param array $values
201 * @param array $errors
203 public function validatePaymentInstrument($values, &$errors) {
204 if ($this->_paymentProcessor
['payment_type'] == 1) {
205 CRM_Core_Payment_Form
::validateCreditCard($values, $errors);
210 * Getter for the payment processor.
212 * The payment processor array is based on the civicrm_payment_processor table entry.
215 * Payment processor array.
217 public function getPaymentProcessor() {
218 return $this->_paymentProcessor
;
222 * Setter for the payment processor.
224 * @param array $processor
226 public function setPaymentProcessor($processor) {
227 $this->_paymentProcessor
= $processor;
231 * Setter for the payment form that wants to use the processor.
235 * @param CRM_Core_Form $paymentForm
237 public function setForm(&$paymentForm) {
238 $this->_paymentForm
= $paymentForm;
242 * Getter for payment form that is using the processor.
244 * @return CRM_Core_Form
247 public function getForm() {
248 return $this->_paymentForm
;
252 * Getter for accessing member vars.
254 * @todo believe this is unused
256 * @param string $name
260 public function getVar($name) {
261 return isset($this->$name) ?
$this->$name : NULL;
265 * Get name for the payment information type.
266 * @todo - use option group + name field (like Omnipay does)
269 public function getPaymentTypeName() {
270 return $this->_paymentProcessor
['payment_type'] == 1 ?
'credit_card' : 'direct_debit';
274 * Get label for the payment information type.
275 * @todo - use option group + labels (like Omnipay does)
278 public function getPaymentTypeLabel() {
279 return $this->_paymentProcessor
['payment_type'] == 1 ?
'Credit Card' : 'Direct Debit';
283 * Get array of fields that should be displayed on the payment form.
284 * @todo make payment type an option value & use it in the function name - currently on debit & credit card work
286 * @throws CiviCRM_API3_Exception
288 public function getPaymentFormFields() {
289 if ($this->_paymentProcessor
['billing_mode'] == 4) {
292 return $this->_paymentProcessor
['payment_type'] == 1 ?
$this->getCreditCardFormFields() : $this->getDirectDebitFormFields();
296 * Get array of fields that should be displayed on the payment form for credit cards.
300 protected function getCreditCardFormFields() {
303 'credit_card_number',
305 'credit_card_exp_date',
310 * Get array of fields that should be displayed on the payment form for direct debits.
314 protected function getDirectDebitFormFields() {
317 'bank_account_number',
318 'bank_identification_number',
324 * Return an array of all the details about the fields potentially required for payment fields.
326 * Only those determined by getPaymentFormFields will actually be assigned to the form
331 public function getPaymentFormFieldsMetadata() {
332 //@todo convert credit card type into an option value
333 $creditCardType = array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::creditCard();
335 'credit_card_number' => array(
336 'htmlType' => 'text',
337 'name' => 'credit_card_number',
338 'title' => ts('Card Number'),
340 'attributes' => array(
343 'autocomplete' => 'off',
344 'class' => 'creditcard',
346 'is_required' => TRUE,
349 'htmlType' => 'text',
351 'title' => ts('Security Code'),
353 'attributes' => array(
356 'autocomplete' => 'off',
358 'is_required' => CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
,
359 'cvv_backoffice_required',
365 'rule_message' => ts('Please enter a valid value for your card security code. This is usually the last 3-4 digits on the card\'s signature panel.'),
366 'rule_name' => 'integer',
367 'rule_parameters' => NULL,
371 'credit_card_exp_date' => array(
372 'htmlType' => 'date',
373 'name' => 'credit_card_exp_date',
374 'title' => ts('Expiration Date'),
376 'attributes' => CRM_Core_SelectValues
::date('creditCard'),
377 'is_required' => TRUE,
380 'rule_message' => ts('Card expiration date cannot be a past date.'),
381 'rule_name' => 'currentDate',
382 'rule_parameters' => TRUE,
386 'credit_card_type' => array(
387 'htmlType' => 'select',
388 'name' => 'credit_card_type',
389 'title' => ts('Card Type'),
391 'attributes' => $creditCardType,
392 'is_required' => FALSE,
394 'account_holder' => array(
395 'htmlType' => 'text',
396 'name' => 'account_holder',
397 'title' => ts('Account Holder'),
399 'attributes' => array(
402 'autocomplete' => 'on',
404 'is_required' => TRUE,
406 //e.g. IBAN can have maxlength of 34 digits
407 'bank_account_number' => array(
408 'htmlType' => 'text',
409 'name' => 'bank_account_number',
410 'title' => ts('Bank Account Number'),
412 'attributes' => array(
415 'autocomplete' => 'off',
419 'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
420 'rule_name' => 'nopunctuation',
421 'rule_parameters' => NULL,
424 'is_required' => TRUE,
426 //e.g. SWIFT-BIC can have maxlength of 11 digits
427 'bank_identification_number' => array(
428 'htmlType' => 'text',
429 'name' => 'bank_identification_number',
430 'title' => ts('Bank Identification Number'),
432 'attributes' => array(
435 'autocomplete' => 'off',
437 'is_required' => TRUE,
440 'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
441 'rule_name' => 'nopunctuation',
442 'rule_parameters' => NULL,
446 'bank_name' => array(
447 'htmlType' => 'text',
448 'name' => 'bank_name',
449 'title' => ts('Bank Name'),
451 'attributes' => array(
454 'autocomplete' => 'off',
456 'is_required' => TRUE,
463 * Calling this from outside the payment subsystem is deprecated - use doPayment.
465 * Does a server to server payment transaction.
467 * Note that doPayment will throw an exception so the code may need to be modified
469 * @param array $params
470 * Assoc array of input parameters for this transaction.
473 * the result in an nice formatted array (or an error object)
476 abstract protected function doDirectPayment(&$params);
479 * Process payment - this function wraps around both doTransferPayment and doDirectPayment.
481 * The function ensures an exception is thrown & moves some of this logic out of the form layer and makes the forms
484 * @param array $params
490 * @throws CRM_Core_Exception
492 public function doPayment(&$params, $component = 'contribute') {
493 if ($this->_paymentProcessor
['billing_mode'] == 4) {
494 $result = $this->doTransferCheckout($params, $component);
497 $result = $this->doDirectPayment($params, $component);
499 if (is_a($result, 'CRM_Core_Error')) {
500 throw new CRM_Core_Exception(CRM_Core_Error
::getMessages($result));
502 //CRM-15767 - Submit Credit Card Contribution not being saved
507 * This function checks to see if we have the right config values.
510 * the error message if any
512 abstract protected function checkConfig();
515 * Redirect for paypal.
517 * @todo move to paypal class or remove
519 * @param $paymentProcessor
523 public static function paypalRedirect(&$paymentProcessor) {
524 if (!$paymentProcessor) {
528 if (isset($_GET['payment_date']) &&
529 isset($_GET['merchant_return_link']) &&
530 CRM_Utils_Array
::value('payment_status', $_GET) == 'Completed' &&
531 $paymentProcessor['payment_processor_type'] == "PayPal_Standard"
540 * Handle incoming payment notification.
542 * IPNs, also called silent posts are notifications of payment outcomes or activity on an external site.
544 * @todo move to0 \Civi\Payment\System factory method
545 * Page callback for civicrm/payment/ipn
547 public static function handleIPN() {
548 self
::handlePaymentMethod(
549 'PaymentNotification',
551 'processor_name' => @$_GET['processor_name'],
552 'processor_id' => @$_GET['processor_id'],
553 'mode' => @$_GET['mode'],
556 CRM_Utils_System
::civiExit();
560 * Payment callback handler.
562 * The processor_name or processor_id is passed in.
563 * Note that processor_id is more reliable as one site may have more than one instance of a
564 * processor & ideally the processor will be validating the results
565 * Load requested payment processor and call that processor's handle<$method> method
567 * @todo move to \Civi\Payment\System factory method
569 * @param string $method
570 * 'PaymentNotification' or 'PaymentCron'
571 * @param array $params
573 public static function handlePaymentMethod($method, $params = array()) {
574 if (!isset($params['processor_id']) && !isset($params['processor_name'])) {
575 CRM_Core_Error
::fatal("Either 'processor_id' or 'processor_name' param is required for payment callback");
577 self
::logPaymentNotification($params);
579 $sql = "SELECT ppt.class_name, ppt.name as processor_name, pp.id AS processor_id
580 FROM civicrm_payment_processor_type ppt
581 INNER JOIN civicrm_payment_processor pp
582 ON pp.payment_processor_type_id = ppt.id
585 if (isset($params['processor_id'])) {
586 $sql .= " WHERE pp.id = %2";
587 $args[2] = array($params['processor_id'], 'Integer');
588 $notFound = "No active instances of payment processor ID#'{$params['processor_id']}' were found.";
591 // This is called when processor_name is passed - passing processor_id instead is recommended.
592 $sql .= " WHERE ppt.name = %2 AND pp.is_test = %1";
594 (CRM_Utils_Array
::value('mode', $params) == 'test') ?
1 : 0,
597 $args[2] = array($params['processor_name'], 'String');
598 $notFound = "No active instances of the '{$params['processor_name']}' payment processor were found.";
601 $dao = CRM_Core_DAO
::executeQuery($sql, $args);
603 // Check whether we found anything at all.
605 CRM_Core_Error
::fatal($notFound);
608 $method = 'handle' . $method;
609 $extension_instance_found = FALSE;
611 // In all likelihood, we'll just end up with the one instance returned here. But it's
612 // possible we may get more. Hence, iterate through all instances ..
614 while ($dao->fetch()) {
615 // Check pp is extension
616 $ext = CRM_Extension_System
::singleton()->getMapper();
617 if ($ext->isExtensionKey($dao->class_name
)) {
618 $paymentClass = $ext->keyToClass($dao->class_name
, 'payment');
619 require_once $ext->classToPath($paymentClass);
622 // Legacy or extension as module instance
623 $paymentClass = 'CRM_Core_' . $dao->class_name
;
626 $processorInstance = Civi\Payment\System
::singleton()->getById($dao->processor_id
);
628 // Should never be empty - we already established this processor_id exists and is active.
629 if (empty($processorInstance)) {
633 // Does PP implement this method, and can we call it?
634 if (!method_exists($processorInstance, $method) ||
635 !is_callable(array($processorInstance, $method))
637 // on the off chance there is a double implementation of this processor we should keep looking for another
638 // note that passing processor_id is more reliable & we should work to deprecate processor_name
642 // Everything, it seems, is ok - execute pp callback handler
643 $processorInstance->$method();
644 $extension_instance_found = TRUE;
647 if (!$extension_instance_found) {
648 CRM_Core_Error
::fatal(
649 "No extension instances of the '{$params['processor_name']}' payment processor were found.<br />" .
650 "$method method is unsupported in legacy payment processors."
656 * Check whether a method is present ( & supported ) by the payment processor object.
658 * @param string $method
659 * Method to check for.
663 public function isSupported($method = 'cancelSubscription') {
664 return method_exists(CRM_Utils_System
::getClassName($this), $method);
668 * Get url for users to manage this recurring contribution for this processor.
670 * @param int $entityID
671 * @param null $entity
672 * @param string $action
676 public function subscriptionURL($entityID = NULL, $entity = NULL, $action = 'cancel') {
680 $url = 'civicrm/contribute/unsubscribe';
684 //in notify mode don't return the update billing url
685 if (!$this->isSupported('updateSubscriptionBillingInfo')) {
688 $url = 'civicrm/contribute/updatebilling';
692 $url = 'civicrm/contribute/updaterecur';
696 $session = CRM_Core_Session
::singleton();
697 $userId = $session->get('userID');
702 // Find related Contact
706 $contactID = CRM_Core_DAO
::getFieldValue("CRM_Member_DAO_Membership", $entityID, "contact_id");
711 $contactID = CRM_Core_DAO
::getFieldValue("CRM_Contribute_DAO_Contribution", $entityID, "contact_id");
717 SELECT con.contact_id
718 FROM civicrm_contribution_recur rec
719 INNER JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
722 $contactID = CRM_Core_DAO
::singleValueQuery($sql, array(1 => array($entityID, 'Integer')));
728 // Add entity arguments
729 if ($entityArg != '') {
730 // Add checksum argument
731 if ($contactID != 0 && $userId != $contactID) {
732 $checksumValue = '&cs=' . CRM_Contact_BAO_Contact_Utils
::generateChecksum($contactID, NULL, 'inf');
734 return CRM_Utils_System
::url($url, "reset=1&{$entityArg}={$entityID}{$checksumValue}", TRUE, NULL, FALSE, TRUE);
738 if ($this->isSupported('accountLoginURL')) {
739 return $this->accountLoginURL();
743 return $this->_paymentProcessor
['url_recur'];