3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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
;
29 use Civi\Payment\Exception\PaymentProcessorException
;
32 * Class CRM_Core_Payment.
34 * This class is the main class for the payment processor subsystem.
36 * It is the parent class for payment processors. It also holds some IPN related functions
37 * that need to be moved. In particular handlePaymentMethod should be moved to a factory class.
39 abstract class CRM_Core_Payment
{
42 * Component - ie. event or contribute.
44 * This is used for setting return urls.
48 protected $_component;
51 * How are we getting billing information.
53 * We are trying to completely deprecate these parameters.
55 * FORM - we collect it on the same page
56 * BUTTON - the processor collects it and sends it back to us via some protocol
59 BILLING_MODE_FORM
= 1,
60 BILLING_MODE_BUTTON
= 2,
61 BILLING_MODE_NOTIFY
= 4;
64 * Which payment type(s) are we using?
69 * @todo create option group - nb omnipay uses a 3rd type - transparent redirect cc
72 PAYMENT_TYPE_CREDIT_CARD
= 1,
73 PAYMENT_TYPE_DIRECT_DEBIT
= 2;
76 * Subscription / Recurring payment Status
80 RECURRING_PAYMENT_START
= 'START',
81 RECURRING_PAYMENT_END
= 'END';
83 protected $_paymentProcessor;
86 * Base url of the calling form.
88 * This is used for processors that need to return the browser back to the CiviCRM site.
92 protected $baseReturnUrl;
95 * The profile configured to show on the billing form.
97 * Currently only the pseudo-profile 'billing' is supported but hopefully in time we will take an id and
98 * load that from the DB and the processor will be able to return a set of fields that combines it's minimum
99 * requirements with the configured requirements.
101 * Currently only the pseudo-processor 'manual' or 'pay-later' uses this setting to return a 'curated' set
104 * Note this change would probably include converting 'billing' to a reserved profile.
108 protected $billingProfile;
111 * Set Base return URL.
114 * Url of site to return browser to.
116 public function setBaseReturnUrl($url) {
117 $this->baseReturnUrl
= $url;
121 * Set the configured payment profile.
123 * @param int|string $value
125 public function setBillingProfile($value) {
126 $this->billingProfile
= $value;
130 * Opportunity for the payment processor to override the entire form build.
132 * @param CRM_Core_Form $form
135 * Should form building stop at this point?
137 public function buildForm(&$form) {
142 * Log payment notification message to forensic system log.
144 * @todo move to factory class \Civi\Payment\System (or similar)
146 * @param array $params
150 public static function logPaymentNotification($params) {
151 $message = 'payment_notification ';
152 if (!empty($params['processor_name'])) {
153 $message .= 'processor_name=' . $params['processor_name'];
155 if (!empty($params['processor_id'])) {
156 $message .= 'processor_id=' . $params['processor_id'];
159 $log = new CRM_Utils_SystemLogger();
160 $log->alert($message, $_REQUEST);
164 * Check if capability is supported.
166 * Capabilities have a one to one relationship with capability-related functions on this class.
168 * Payment processor classes should over-ride the capability-specific function rather than this one.
170 * @param string $capability
171 * E.g BackOffice, LiveMode, FutureRecurStartDate.
175 public function supports($capability) {
176 $function = 'supports' . ucfirst($capability);
177 if (method_exists($this, $function)) {
178 return $this->$function();
184 * Are back office payments supported.
186 * e.g paypal standard won't permit you to enter a credit card associated
187 * with someone else's login.
188 * The intention is to support off-site (other than paypal) & direct debit but that is not all working yet so to
189 * reach a 'stable' point we disable.
193 protected function supportsBackOffice() {
194 if ($this->_paymentProcessor
['billing_mode'] == 4 ||
$this->_paymentProcessor
['payment_type'] != 1) {
203 * Can more than one transaction be processed at once?
205 * In general processors that process payment by server to server communication support this while others do not.
207 * In future we are likely to hit an issue where this depends on whether a token already exists.
211 protected function supportsMultipleConcurrentPayments() {
212 if ($this->_paymentProcessor
['billing_mode'] == 4 ||
$this->_paymentProcessor
['payment_type'] != 1) {
221 * Are live payments supported - e.g dummy doesn't support this.
225 protected function supportsLiveMode() {
230 * Are test payments supported.
234 protected function supportsTestMode() {
239 * Should the first payment date be configurable when setting up back office recurring payments.
241 * We set this to false for historical consistency but in fact most new processors use tokens for recurring and can support this
245 protected function supportsFutureRecurStartDate() {
250 * Does this processor support cancelling recurring contributions through code.
252 * If the processor returns true it must be possible to take action from within CiviCRM
253 * that will result in no further payments being processed. In the case of token processors (e.g
254 * IATS, eWay) updating the contribution_recur table is probably sufficient.
258 protected function supportsCancelRecurring() {
259 return method_exists(CRM_Utils_System
::getClassName($this), 'cancelSubscription');
263 * Does this processor support pre-approval.
265 * This would generally look like a redirect to enter credentials which can then be used in a later payment call.
267 * Currently Paypal express supports this, with a redirect to paypal after the 'Main' form is submitted in the
268 * contribution page. This token can then be processed at the confirm phase. Although this flow 'looks' like the
269 * 'notify' flow a key difference is that in the notify flow they don't have to return but in this flow they do.
273 protected function supportsPreApproval() {
278 * Can recurring contributions be set against pledges.
280 * In practice all processors that use the baseIPN function to finish transactions or
281 * call the completetransaction api support this by looking up previous contributions in the
282 * series and, if there is a prior contribution against a pledge, and the pledge is not complete,
283 * adding the new payment to the pledge.
285 * However, only enabling for processors it has been tested against.
289 protected function supportsRecurContributionsForPledges() {
294 * Function to action pre-approval if supported
296 * @param array $params
297 * Parameters from the form
299 * This function returns an array which should contain
300 * - pre_approval_parameters (this will be stored on the calling form & available later)
301 * - redirect_url (if set the browser will be redirected to this.
303 public function doPreApproval(&$params) {}
306 * Get any details that may be available to the payment processor due to an approval process having happened.
308 * In some cases the browser is redirected to enter details on a processor site. Some details may be available as a
311 * @param array $storedDetails
315 public function getPreApprovalDetails($storedDetails) {
320 * Default payment instrument validation.
322 * Implement the usual Luhn algorithm via a static function in the CRM_Core_Payment_Form if it's a credit card
323 * Not a static function, because I need to check for payment_type.
325 * @param array $values
326 * @param array $errors
328 public function validatePaymentInstrument($values, &$errors) {
329 CRM_Core_Form
::validateMandatoryFields($this->getMandatoryFields(), $values, $errors);
330 if ($this->_paymentProcessor
['payment_type'] == 1) {
331 CRM_Core_Payment_Form
::validateCreditCard($values, $errors);
336 * Getter for the payment processor.
338 * The payment processor array is based on the civicrm_payment_processor table entry.
341 * Payment processor array.
343 public function getPaymentProcessor() {
344 return $this->_paymentProcessor
;
348 * Setter for the payment processor.
350 * @param array $processor
352 public function setPaymentProcessor($processor) {
353 $this->_paymentProcessor
= $processor;
357 * Setter for the payment form that wants to use the processor.
361 * @param CRM_Core_Form $paymentForm
363 public function setForm(&$paymentForm) {
364 $this->_paymentForm
= $paymentForm;
368 * Getter for payment form that is using the processor.
370 * @return CRM_Core_Form
373 public function getForm() {
374 return $this->_paymentForm
;
378 * Getter for accessing member vars.
380 * @todo believe this is unused
382 * @param string $name
386 public function getVar($name) {
387 return isset($this->$name) ?
$this->$name : NULL;
391 * Get name for the payment information type.
392 * @todo - use option group + name field (like Omnipay does)
395 public function getPaymentTypeName() {
396 return $this->_paymentProcessor
['payment_type'] == 1 ?
'credit_card' : 'direct_debit';
400 * Get label for the payment information type.
401 * @todo - use option group + labels (like Omnipay does)
404 public function getPaymentTypeLabel() {
405 return $this->_paymentProcessor
['payment_type'] == 1 ?
'Credit Card' : 'Direct Debit';
409 * Get array of fields that should be displayed on the payment form.
410 * @todo make payment type an option value & use it in the function name - currently on debit & credit card work
412 * @throws CiviCRM_API3_Exception
414 public function getPaymentFormFields() {
415 if ($this->_paymentProcessor
['billing_mode'] == 4) {
418 return $this->_paymentProcessor
['payment_type'] == 1 ?
$this->getCreditCardFormFields() : $this->getDirectDebitFormFields();
422 * Get an array of the fields that can be edited on the recurring contribution.
424 * Some payment processors support editing the amount and other scheduling details of recurring payments, especially
425 * those which use tokens. Others are fixed. This function allows the processor to return an array of the fields that
426 * can be updated from the contribution recur edit screen.
428 * The fields are likely to be a subset of these
431 * - 'frequency_interval',
432 * - 'frequency_unit',
434 * - 'next_sched_contribution_date',
436 * - 'failure_retry_day',
438 * The form does not restrict which fields from the contribution_recur table can be added (although if the html_type
439 * metadata is not defined in the xml for the field it will cause an error.
441 * Open question - would it make sense to return membership_id in this - which is sometimes editable and is on that
442 * form (UpdateSubscription).
446 public function getEditableRecurringScheduleFields() {
447 if (method_exists($this, 'changeSubscriptionAmount')) {
448 return array('amount');
453 * Get the help text to present on the recurring update page.
455 * This should reflect what can or cannot be edited.
459 public function getRecurringScheduleUpdateHelpText() {
460 if (!in_array('amount', $this->getEditableRecurringScheduleFields())) {
461 return ts('Updates made using this form will change the recurring contribution information stored in your CiviCRM database, but will NOT be sent to the payment processor. You must enter the same changes using the payment processor web site.');
463 return ts('Use this form to change the amount or number of installments for this recurring contribution. Changes will be automatically sent to the payment processor. You can not change the contribution frequency.');
467 * Get the metadata for all required fields.
471 protected function getMandatoryFields() {
472 $mandatoryFields = array();
473 foreach ($this->getAllFields() as $field_name => $field_spec) {
474 if (!empty($field_spec['is_required'])) {
475 $mandatoryFields[$field_name] = $field_spec;
478 return $mandatoryFields;
482 * Get the metadata of all the fields configured for this processor.
486 protected function getAllFields() {
487 $paymentFields = array_intersect_key($this->getPaymentFormFieldsMetadata(), array_flip($this->getPaymentFormFields()));
488 $billingFields = array_intersect_key($this->getBillingAddressFieldsMetadata(), array_flip($this->getBillingAddressFields()));
489 return array_merge($paymentFields, $billingFields);
492 * Get array of fields that should be displayed on the payment form for credit cards.
496 protected function getCreditCardFormFields() {
499 'credit_card_number',
501 'credit_card_exp_date',
506 * Get array of fields that should be displayed on the payment form for direct debits.
510 protected function getDirectDebitFormFields() {
513 'bank_account_number',
514 'bank_identification_number',
520 * Return an array of all the details about the fields potentially required for payment fields.
522 * Only those determined by getPaymentFormFields will actually be assigned to the form
527 public function getPaymentFormFieldsMetadata() {
528 //@todo convert credit card type into an option value
529 $creditCardType = array('' => ts('- select -')) + CRM_Contribute_PseudoConstant
::creditCard();
531 'credit_card_number' => array(
532 'htmlType' => 'text',
533 'name' => 'credit_card_number',
534 'title' => ts('Card Number'),
536 'attributes' => array(
539 'autocomplete' => 'off',
540 'class' => 'creditcard',
542 'is_required' => TRUE,
545 'htmlType' => 'text',
547 'title' => ts('Security Code'),
549 'attributes' => array(
552 'autocomplete' => 'off',
554 'is_required' => Civi
::settings()->get('cvv_backoffice_required'),
557 '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.'),
558 'rule_name' => 'integer',
559 'rule_parameters' => NULL,
563 'credit_card_exp_date' => array(
564 'htmlType' => 'date',
565 'name' => 'credit_card_exp_date',
566 'title' => ts('Expiration Date'),
568 'attributes' => CRM_Core_SelectValues
::date('creditCard'),
569 'is_required' => TRUE,
572 'rule_message' => ts('Card expiration date cannot be a past date.'),
573 'rule_name' => 'currentDate',
574 'rule_parameters' => TRUE,
578 'credit_card_type' => array(
579 'htmlType' => 'select',
580 'name' => 'credit_card_type',
581 'title' => ts('Card Type'),
583 'attributes' => $creditCardType,
584 'is_required' => FALSE,
586 'account_holder' => array(
587 'htmlType' => 'text',
588 'name' => 'account_holder',
589 'title' => ts('Account Holder'),
591 'attributes' => array(
594 'autocomplete' => 'on',
596 'is_required' => TRUE,
598 //e.g. IBAN can have maxlength of 34 digits
599 'bank_account_number' => array(
600 'htmlType' => 'text',
601 'name' => 'bank_account_number',
602 'title' => ts('Bank Account Number'),
604 'attributes' => array(
607 'autocomplete' => 'off',
611 'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
612 'rule_name' => 'nopunctuation',
613 'rule_parameters' => NULL,
616 'is_required' => TRUE,
618 //e.g. SWIFT-BIC can have maxlength of 11 digits
619 'bank_identification_number' => array(
620 'htmlType' => 'text',
621 'name' => 'bank_identification_number',
622 'title' => ts('Bank Identification Number'),
624 'attributes' => array(
627 'autocomplete' => 'off',
629 'is_required' => TRUE,
632 'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
633 'rule_name' => 'nopunctuation',
634 'rule_parameters' => NULL,
638 'bank_name' => array(
639 'htmlType' => 'text',
640 'name' => 'bank_name',
641 'title' => ts('Bank Name'),
643 'attributes' => array(
646 'autocomplete' => 'off',
648 'is_required' => TRUE,
655 * Get billing fields required for this processor.
657 * We apply the existing default of returning fields only for payment processor type 1. Processors can override to
660 * @param int $billingLocationID
664 public function getBillingAddressFields($billingLocationID = NULL) {
665 if (!$billingLocationID) {
666 // Note that although the billing id is passed around the forms the idea that it would be anything other than
667 // the result of the function below doesn't seem to have eventuated.
668 // So taking this as a param is possibly something to be removed in favour of the standard default.
669 $billingLocationID = CRM_Core_BAO_LocationType
::getBilling();
671 if ($this->_paymentProcessor
['billing_mode'] != 1 && $this->_paymentProcessor
['billing_mode'] != 3) {
675 'first_name' => 'billing_first_name',
676 'middle_name' => 'billing_middle_name',
677 'last_name' => 'billing_last_name',
678 'street_address' => "billing_street_address-{$billingLocationID}",
679 'city' => "billing_city-{$billingLocationID}",
680 'country' => "billing_country_id-{$billingLocationID}",
681 'state_province' => "billing_state_province_id-{$billingLocationID}",
682 'postal_code' => "billing_postal_code-{$billingLocationID}",
687 * Get form metadata for billing address fields.
689 * @param int $billingLocationID
692 * Array of metadata for address fields.
694 public function getBillingAddressFieldsMetadata($billingLocationID = NULL) {
695 if (!$billingLocationID) {
696 // Note that although the billing id is passed around the forms the idea that it would be anything other than
697 // the result of the function below doesn't seem to have eventuated.
698 // So taking this as a param is possibly something to be removed in favour of the standard default.
699 $billingLocationID = CRM_Core_BAO_LocationType
::getBilling();
702 $metadata['billing_first_name'] = array(
703 'htmlType' => 'text',
704 'name' => 'billing_first_name',
705 'title' => ts('Billing First Name'),
707 'attributes' => array(
710 'autocomplete' => 'off',
712 'is_required' => TRUE,
715 $metadata['billing_middle_name'] = array(
716 'htmlType' => 'text',
717 'name' => 'billing_middle_name',
718 'title' => ts('Billing Middle Name'),
720 'attributes' => array(
723 'autocomplete' => 'off',
725 'is_required' => FALSE,
728 $metadata['billing_last_name'] = array(
729 'htmlType' => 'text',
730 'name' => 'billing_last_name',
731 'title' => ts('Billing Last Name'),
733 'attributes' => array(
736 'autocomplete' => 'off',
738 'is_required' => TRUE,
741 $metadata["billing_street_address-{$billingLocationID}"] = array(
742 'htmlType' => 'text',
743 'name' => "billing_street_address-{$billingLocationID}",
744 'title' => ts('Street Address'),
746 'attributes' => array(
749 'autocomplete' => 'off',
751 'is_required' => TRUE,
754 $metadata["billing_city-{$billingLocationID}"] = array(
755 'htmlType' => 'text',
756 'name' => "billing_city-{$billingLocationID}",
757 'title' => ts('City'),
759 'attributes' => array(
762 'autocomplete' => 'off',
764 'is_required' => TRUE,
767 $metadata["billing_state_province_id-{$billingLocationID}"] = array(
768 'htmlType' => 'chainSelect',
769 'title' => ts('State/Province'),
770 'name' => "billing_state_province_id-{$billingLocationID}",
772 'is_required' => TRUE,
775 $metadata["billing_postal_code-{$billingLocationID}"] = array(
776 'htmlType' => 'text',
777 'name' => "billing_postal_code-{$billingLocationID}",
778 'title' => ts('Postal Code'),
780 'attributes' => array(
783 'autocomplete' => 'off',
785 'is_required' => TRUE,
788 $metadata["billing_country_id-{$billingLocationID}"] = array(
789 'htmlType' => 'select',
790 'name' => "billing_country_id-{$billingLocationID}",
791 'title' => ts('Country'),
793 'attributes' => array(
794 '' => ts('- select -'),
795 ) + CRM_Core_PseudoConstant
::country(),
796 'is_required' => TRUE,
802 * Get base url dependent on component.
804 * (or preferably set it using the setter function).
808 protected function getBaseReturnUrl() {
809 if ($this->baseReturnUrl
) {
810 return $this->baseReturnUrl
;
812 if ($this->_component
== 'event') {
813 $baseURL = 'civicrm/event/register';
816 $baseURL = 'civicrm/contribute/transact';
822 * Get url to return to after cancelled or failed transaction
825 * @param $participantID
827 * @return string cancel url
829 public function getCancelUrl($qfKey, $participantID) {
830 if ($this->_component
== 'event') {
831 return CRM_Utils_System
::url($this->getBaseReturnUrl(), array(
834 'participantId' => $participantID,
840 return CRM_Utils_System
::url($this->getBaseReturnUrl(), array(
841 '_qf_Main_display' => 1,
850 * Get URL to return the browser to on success.
856 protected function getReturnSuccessUrl($qfKey) {
857 return CRM_Utils_System
::url($this->getBaseReturnUrl(), array(
858 '_qf_ThankYou_display' => 1,
866 * Get URL to return the browser to on failure.
869 * @param int $participantID
870 * @param int $eventID
873 * URL for a failing transactor to be redirected to.
875 protected function getReturnFailUrl($key, $participantID = NULL, $eventID = NULL) {
876 $test = $this->_is_test ?
'&action=preview' : '';
877 if ($this->_component
== "event") {
878 return CRM_Utils_System
::url('civicrm/event/register',
879 "reset=1&cc=fail&participantId={$participantID}&id={$eventID}{$test}&qfKey={$key}",
884 return CRM_Utils_System
::url('civicrm/contribute/transact',
885 "_qf_Main_display=1&cancel=1&qfKey={$key}{$test}",
892 * Get URl for when the back button is pressed.
898 protected function getGoBackUrl($qfKey) {
899 return CRM_Utils_System
::url($this->getBaseReturnUrl(), array(
900 '_qf_Confirm_display' => 'true',
908 * Get the notify (aka ipn, web hook or silent post) url.
910 * If there is no '.' in it we assume that we are dealing with localhost or
911 * similar and it is unreachable from the web & hence invalid.
914 * URL to notify outcome of transaction.
916 protected function getNotifyUrl() {
917 $url = CRM_Utils_System
::url(
918 'civicrm/payment/ipn/' . $this->_paymentProcessor
['id'],
922 return (stristr($url, '.')) ?
$url : '';
926 * Calling this from outside the payment subsystem is deprecated - use doPayment.
928 * Does a server to server payment transaction.
930 * @param array $params
931 * Assoc array of input parameters for this transaction.
934 * the result in an nice formatted array (or an error object - but throwing exceptions is preferred)
936 protected function doDirectPayment(&$params) {
941 * Process payment - this function wraps around both doTransferPayment and doDirectPayment.
943 * The function ensures an exception is thrown & moves some of this logic out of the form layer and makes the forms
946 * Payment processors should set payment_status_id. This function adds some historical defaults ie. the
947 * assumption that if a 'doDirectPayment' processors comes back it completed the transaction & in fact
948 * doTransferCheckout would not traditionally come back.
950 * doDirectPayment does not do an immediate payment for Authorize.net or Paypal so the default is assumed
953 * Once this function is fully rolled out then it will be preferred for processors to throw exceptions than to
954 * return Error objects
956 * @param array $params
958 * @param string $component
963 * @throws \Civi\Payment\Exception\PaymentProcessorException
965 public function doPayment(&$params, $component = 'contribute') {
966 $this->_component
= $component;
967 $statuses = CRM_Contribute_BAO_Contribution
::buildOptions('contribution_status_id');
969 // If we have a $0 amount, skip call to processor and set payment_status to Completed.
970 // Conceivably a processor might override this - perhaps for setting up a token - but we don't
971 // have an example of that at the mome.
972 if ($params['amount'] == 0) {
973 $result['payment_status_id'] = array_search('Completed', $statuses);
977 if ($this->_paymentProcessor
['billing_mode'] == 4) {
978 $result = $this->doTransferCheckout($params, $component);
979 if (is_array($result) && !isset($result['payment_status_id'])) {
980 $result['payment_status_id'] = array_search('Pending', $statuses);
984 $result = $this->doDirectPayment($params, $component);
985 if (is_array($result) && !isset($result['payment_status_id'])) {
986 if (!empty($params['is_recur'])) {
987 // See comment block.
988 $result['payment_status_id'] = array_search('Pending', $statuses);
991 $result['payment_status_id'] = array_search('Completed', $statuses);
995 if (is_a($result, 'CRM_Core_Error')) {
996 throw new PaymentProcessorException(CRM_Core_Error
::getMessages($result));
1002 * Query payment processor for details about a transaction.
1004 * @param array $params
1005 * Array of parameters containing one of:
1006 * - trxn_id Id of an individual transaction.
1007 * - processor_id Id of a recurring contribution series as stored in the civicrm_contribution_recur table.
1010 * Extra parameters retrieved.
1011 * Any parameters retrievable through this should be documented in the function comments at
1012 * CRM_Core_Payment::doQuery. Currently:
1013 * - fee_amount Amount of fee paid
1015 public function doQuery($params) {
1020 * This function checks to see if we have the right config values.
1023 * the error message if any
1025 abstract protected function checkConfig();
1028 * Redirect for paypal.
1030 * @todo move to paypal class or remove
1032 * @param $paymentProcessor
1036 public static function paypalRedirect(&$paymentProcessor) {
1037 if (!$paymentProcessor) {
1041 if (isset($_GET['payment_date']) &&
1042 isset($_GET['merchant_return_link']) &&
1043 CRM_Utils_Array
::value('payment_status', $_GET) == 'Completed' &&
1044 $paymentProcessor['payment_processor_type'] == "PayPal_Standard"
1053 * Handle incoming payment notification.
1055 * IPNs, also called silent posts are notifications of payment outcomes or activity on an external site.
1057 * @todo move to0 \Civi\Payment\System factory method
1058 * Page callback for civicrm/payment/ipn
1060 public static function handleIPN() {
1061 self
::handlePaymentMethod(
1062 'PaymentNotification',
1064 'processor_name' => @$_GET['processor_name'],
1065 'processor_id' => @$_GET['processor_id'],
1066 'mode' => @$_GET['mode'],
1070 CRM_Utils_System
::civiExit();
1074 * Payment callback handler.
1076 * The processor_name or processor_id is passed in.
1077 * Note that processor_id is more reliable as one site may have more than one instance of a
1078 * processor & ideally the processor will be validating the results
1079 * Load requested payment processor and call that processor's handle<$method> method
1081 * @todo move to \Civi\Payment\System factory method
1083 * @param string $method
1084 * 'PaymentNotification' or 'PaymentCron'
1085 * @param array $params
1087 * @throws \CRM_Core_Exception
1088 * @throws \Exception
1090 public static function handlePaymentMethod($method, $params = array()) {
1091 if (!isset($params['processor_id']) && !isset($params['processor_name'])) {
1092 $q = explode('/', CRM_Utils_Array
::value('q', $params, ''));
1093 $lastParam = array_pop($q);
1094 if (is_numeric($lastParam)) {
1095 $params['processor_id'] = $_GET['processor_id'] = $lastParam;
1098 throw new CRM_Core_Exception("Either 'processor_id' (recommended) or 'processor_name' (deprecated) is required for payment callback.");
1102 self
::logPaymentNotification($params);
1104 $sql = "SELECT ppt.class_name, ppt.name as processor_name, pp.id AS processor_id
1105 FROM civicrm_payment_processor_type ppt
1106 INNER JOIN civicrm_payment_processor pp
1107 ON pp.payment_processor_type_id = ppt.id
1110 if (isset($params['processor_id'])) {
1111 $sql .= " WHERE pp.id = %2";
1112 $args[2] = array($params['processor_id'], 'Integer');
1113 $notFound = ts("No active instances of payment processor %1 were found.", array(1 => $params['processor_id']));
1116 // This is called when processor_name is passed - passing processor_id instead is recommended.
1117 $sql .= " WHERE ppt.name = %2 AND pp.is_test = %1";
1119 (CRM_Utils_Array
::value('mode', $params) == 'test') ?
1 : 0,
1122 $args[2] = array($params['processor_name'], 'String');
1123 $notFound = ts("No active instances of payment processor '%1' were found.", array(1 => $params['processor_name']));
1126 $dao = CRM_Core_DAO
::executeQuery($sql, $args);
1128 // Check whether we found anything at all.
1130 CRM_Core_Error
::fatal($notFound);
1133 $method = 'handle' . $method;
1134 $extension_instance_found = FALSE;
1136 // In all likelihood, we'll just end up with the one instance returned here. But it's
1137 // possible we may get more. Hence, iterate through all instances ..
1139 while ($dao->fetch()) {
1140 // Check pp is extension - is this still required - surely the singleton below handles it.
1141 $ext = CRM_Extension_System
::singleton()->getMapper();
1142 if ($ext->isExtensionKey($dao->class_name
)) {
1143 $paymentClass = $ext->keyToClass($dao->class_name
, 'payment');
1144 require_once $ext->classToPath($paymentClass);
1147 $processorInstance = System
::singleton()->getById($dao->processor_id
);
1149 // Should never be empty - we already established this processor_id exists and is active.
1150 if (empty($processorInstance)) {
1154 // Does PP implement this method, and can we call it?
1155 if (!method_exists($processorInstance, $method) ||
1156 !is_callable(array($processorInstance, $method))
1158 // on the off chance there is a double implementation of this processor we should keep looking for another
1159 // note that passing processor_id is more reliable & we should work to deprecate processor_name
1163 // Everything, it seems, is ok - execute pp callback handler
1164 $processorInstance->$method();
1165 $extension_instance_found = TRUE;
1168 if (!$extension_instance_found) {
1169 $message = "No extension instances of the '%1' payment processor were found.<br />" .
1170 "%2 method is unsupported in legacy payment processors.";
1171 CRM_Core_Error
::fatal(ts($message, array(1 => $params['processor_name'], 2 => $method)));
1176 * Check whether a method is present ( & supported ) by the payment processor object.
1178 * @deprecated - use $paymentProcessor->supports(array('cancelRecurring');
1180 * @param string $method
1181 * Method to check for.
1185 public function isSupported($method) {
1186 return method_exists(CRM_Utils_System
::getClassName($this), $method);
1190 * Some processors replace the form submit button with their own.
1192 * Returning false here will leave the button off front end forms.
1194 * At this stage there is zero cross-over between back-office processors and processors that suppress the submit.
1196 public function isSuppressSubmitButtons() {
1201 * Checks to see if invoice_id already exists in db.
1203 * It's arguable if this belongs in the payment subsystem at all but since several processors implement it
1204 * it is better to standardise to being here.
1206 * @param int $invoiceId The ID to check.
1208 * @param null $contributionID
1209 * If a contribution exists pass in the contribution ID.
1212 * True if invoice ID otherwise exists, else false
1214 protected function checkDupe($invoiceId, $contributionID = NULL) {
1215 $contribution = new CRM_Contribute_DAO_Contribution();
1216 $contribution->invoice_id
= $invoiceId;
1217 if ($contributionID) {
1218 $contribution->whereAdd("id <> $contributionID");
1220 return $contribution->find();
1224 * Get url for users to manage this recurring contribution for this processor.
1226 * @param int $entityID
1227 * @param null $entity
1228 * @param string $action
1232 public function subscriptionURL($entityID = NULL, $entity = NULL, $action = 'cancel') {
1236 $url = 'civicrm/contribute/unsubscribe';
1240 //in notify mode don't return the update billing url
1241 if (!$this->isSupported('updateSubscriptionBillingInfo')) {
1244 $url = 'civicrm/contribute/updatebilling';
1248 $url = 'civicrm/contribute/updaterecur';
1252 $userId = CRM_Core_Session
::singleton()->get('userID');
1254 $checksumValue = '';
1257 // Find related Contact
1261 $contactID = CRM_Core_DAO
::getFieldValue("CRM_Member_DAO_Membership", $entityID, "contact_id");
1265 case 'contribution':
1266 $contactID = CRM_Core_DAO
::getFieldValue("CRM_Contribute_DAO_Contribution", $entityID, "contact_id");
1267 $entityArg = 'coid';
1272 SELECT con.contact_id
1273 FROM civicrm_contribution_recur rec
1274 INNER JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
1277 $contactID = CRM_Core_DAO
::singleValueQuery($sql, array(1 => array($entityID, 'Integer')));
1278 $entityArg = 'crid';
1283 // Add entity arguments
1284 if ($entityArg != '') {
1285 // Add checksum argument
1286 if ($contactID != 0 && $userId != $contactID) {
1287 $checksumValue = '&cs=' . CRM_Contact_BAO_Contact_Utils
::generateChecksum($contactID, NULL, 'inf');
1289 return CRM_Utils_System
::url($url, "reset=1&{$entityArg}={$entityID}{$checksumValue}", TRUE, NULL, FALSE, TRUE);
1293 if ($this->isSupported('accountLoginURL')) {
1294 return $this->accountLoginURL();
1298 return isset($this->_paymentProcessor
['url_recur']) ?
$this->_paymentProcessor
['url_recur'] : '';
1302 * Get description of payment to pass to processor.
1304 * This is often what people see in the interface so we want to get
1305 * as much unique information in as possible within the field length (& presumably the early part of the field)
1307 * People seeing these can be assumed to be advanced users so quantity of information probably trumps
1308 * having field names to clarify
1310 * @param array $params
1311 * @param int $length
1315 protected function getPaymentDescription($params, $length = 24) {
1316 $parts = array('contactID', 'contributionID', 'description', 'billing_first_name', 'billing_last_name');
1317 $validParts = array();
1318 if (isset($params['description'])) {
1319 $uninformativeStrings = array(ts('Online Event Registration: '), ts('Online Contribution: '));
1320 $params['description'] = str_replace($uninformativeStrings, '', $params['description']);
1322 foreach ($parts as $part) {
1323 if ((!empty($params[$part]))) {
1324 $validParts[] = $params[$part];
1327 return substr(implode('-', $validParts), 0, $length);
1331 * Checks if backoffice recurring edit is allowed
1335 public function supportsEditRecurringContribution() {
1340 * Should a receipt be sent out for a pending payment.
1342 * e.g for traditional pay later & ones with a delayed settlement a pending receipt makes sense.
1344 public function isSendReceiptForPending() {