CRM/Core/Payment.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 use Civi\Payment\System;
  13 use Civi\Payment\Exception\PaymentProcessorException;
  14 use Civi\Payment\PropertyBag;
  15
  16 /**
  17  * Class CRM_Core_Payment.
  18  *
  19  * This class is the main class for the payment processor subsystem.
  20  *
  21  * It is the parent class for payment processors. It also holds some IPN related functions
  22  * that need to be moved. In particular handlePaymentMethod should be moved to a factory class.
  23  */
  24 abstract class CRM_Core_Payment {
  25
  26   /**
  27    * Component - ie. event or contribute.
  28    *
  29    * This is used for setting return urls.
  30    *
  31    * @var string
  32    */
  33   protected $_component;
  34
  35   /**
  36    * How are we getting billing information.
  37    *
  38    * We are trying to completely deprecate these parameters.
  39    *
  40    * FORM   - we collect it on the same page
  41    * BUTTON - the processor collects it and sends it back to us via some protocol
  42    */
  43   const
  44     BILLING_MODE_FORM = 1,
  45     BILLING_MODE_BUTTON = 2,
  46     BILLING_MODE_NOTIFY = 4;
  47
  48   /**
  49    * Which payment type(s) are we using?
  50    *
  51    * credit card
  52    * direct debit
  53    * or both
  54    * @todo create option group - nb omnipay uses a 3rd type - transparent redirect cc
  55    */
  56   const
  57     PAYMENT_TYPE_CREDIT_CARD = 1,
  58     PAYMENT_TYPE_DIRECT_DEBIT = 2;
  59
  60   /**
  61    * Subscription / Recurring payment Status
  62    * START, END
  63    */
  64   const
  65     RECURRING_PAYMENT_START = 'START',
  66     RECURRING_PAYMENT_END = 'END';
  67
  68   /**
  69    * @var array
  70    */
  71   protected $_paymentProcessor;
  72
  73   /**
  74    * Base url of the calling form (offsite processors).
  75    *
  76    * @var string
  77    */
  78   protected $baseReturnUrl;
  79
  80   /**
  81    * Return url upon success (offsite processors).
  82    *
  83    * @var string
  84    */
  85   protected $successUrl;
  86
  87   /**
  88    * Return url upon failure (offsite processors).
  89    *
  90    * @var string
  91    */
  92   protected $cancelUrl;
  93
  94   /**
  95    * Processor type label.
  96    *
  97    * (Deprecated parameter but used in some messages).
  98    *
  99    * @var string
 100    * @deprecated
 101    *
 102    */
 103   public $_processorName;
 104
 105   /**
 106    * The profile configured to show on the billing form.
 107    *
 108    * Currently only the pseudo-profile 'billing' is supported but hopefully in time we will take an id and
 109    * load that from the DB and the processor will be able to return a set of fields that combines it's minimum
 110    * requirements with the configured requirements.
 111    *
 112    * Currently only the pseudo-processor 'manual' or 'pay-later' uses this setting to return a 'curated' set
 113    * of fields.
 114    *
 115    * Note this change would probably include converting 'billing' to a reserved profile.
 116    *
 117    * @var int|string
 118    */
 119   protected $billingProfile;
 120
 121   /**
 122    * Payment instrument ID.
 123    *
 124    * This is normally retrieved from the payment_processor table.
 125    *
 126    * @var int
 127    */
 128   protected $paymentInstrumentID;
 129
 130   /**
 131    * Is this a back office transaction.
 132    *
 133    * @var bool
 134    */
 135   protected $backOffice = FALSE;
 136
 137   /**
 138    * This is only needed during the transitional phase. In future you should
 139    * pass your own PropertyBag into the method you're calling.
 140    *
 141    * New code should NOT use $this->propertyBag.
 142    *
 143    * @var Civi\Payment\PropertyBag
 144    */
 145   protected $propertyBag;
 146
 147   /**
 148    * Return the payment instrument ID to use.
 149    *
 150    * Note:
 151    * We normally SHOULD be returning the payment instrument of the payment processor.
 152    * However there is an outstanding case where this needs overriding, which is
 153    * when using CRM_Core_Payment_Manual which uses the pseudoprocessor (id = 0).
 154    *
 155    * i.e. If you're writing a Payment Processor you should NOT be using
 156    * setPaymentInstrumentID() at all.
 157    *
 158    * @todo
 159    * Ideally this exception-to-the-rule should be handled outside of this class
 160    * i.e. this class's getPaymentInstrumentID method should return it from the
 161    * payment processor and CRM_Core_Payment_Manual could override it to provide 0.
 162    *
 163    * @return int
 164    */
 165   public function getPaymentInstrumentID() {
 166     return isset($this->paymentInstrumentID)
 167       ? $this->paymentInstrumentID
 168       : (int) ($this->_paymentProcessor['payment_instrument_id'] ?? 0);
 169   }
 170
 171   /**
 172    * Getter for the id Payment Processor ID.
 173    *
 174    * @return int
 175    */
 176   public function getID() {
 177     return (int) $this->_paymentProcessor['id'];
 178   }
 179
 180   /**
 181    * @deprecated Set payment Instrument id - see note on getPaymentInstrumentID.
 182    *
 183    * By default we actually ignore the form value. The manual processor takes
 184    * it more seriously.
 185    *
 186    * @param int $paymentInstrumentID
 187    */
 188   public function setPaymentInstrumentID($paymentInstrumentID) {
 189     $this->paymentInstrumentID = (int) $paymentInstrumentID;
 190     // See note on getPaymentInstrumentID().
 191     return $this->getPaymentInstrumentID();
 192   }
 193
 194   /**
 195    * @return bool
 196    */
 197   public function isBackOffice() {
 198     return $this->backOffice;
 199   }
 200
 201   /**
 202    * Set back office property.
 203    *
 204    * @param bool $isBackOffice
 205    */
 206   public function setBackOffice($isBackOffice) {
 207     $this->backOffice = $isBackOffice;
 208   }
 209
 210   /**
 211    * Set base return path (offsite processors).
 212    *
 213    * This is only useful with an internal civicrm form.
 214    *
 215    * @param string $url
 216    *   Internal civicrm path.
 217    */
 218   public function setBaseReturnUrl($url) {
 219     $this->baseReturnUrl = $url;
 220   }
 221
 222   /**
 223    * Set success return URL (offsite processors).
 224    *
 225    * This overrides $baseReturnUrl
 226    *
 227    * @param string $url
 228    *   Full url of site to return browser to upon success.
 229    */
 230   public function setSuccessUrl($url) {
 231     $this->successUrl = $url;
 232   }
 233
 234   /**
 235    * Set cancel return URL (offsite processors).
 236    *
 237    * This overrides $baseReturnUrl
 238    *
 239    * @param string $url
 240    *   Full url of site to return browser to upon failure.
 241    */
 242   public function setCancelUrl($url) {
 243     $this->cancelUrl = $url;
 244   }
 245
 246   /**
 247    * Set the configured payment profile.
 248    *
 249    * @param int|string $value
 250    */
 251   public function setBillingProfile($value) {
 252     $this->billingProfile = $value;
 253   }
 254
 255   /**
 256    * Opportunity for the payment processor to override the entire form build.
 257    *
 258    * @param CRM_Core_Form $form
 259    *
 260    * @return bool
 261    *   Should form building stop at this point?
 262    */
 263   public function buildForm(&$form) {
 264     return FALSE;
 265   }
 266
 267   /**
 268    * Log payment notification message to forensic system log.
 269    *
 270    * @todo move to factory class \Civi\Payment\System (or similar)
 271    *
 272    * @param array $params
 273    */
 274   public static function logPaymentNotification($params) {
 275     $message = 'payment_notification ';
 276     if (!empty($params['processor_name'])) {
 277       $message .= 'processor_name=' . $params['processor_name'];
 278     }
 279     if (!empty($params['processor_id'])) {
 280       $message .= 'processor_id=' . $params['processor_id'];
 281     }
 282
 283     $log = new CRM_Utils_SystemLogger();
 284     // $_REQUEST doesn't handle JSON, to support providers that POST JSON we need the raw POST data.
 285     $rawRequestData = file_get_contents("php://input");
 286     if (CRM_Utils_JSON::isValidJSON($rawRequestData)) {
 287       $log->alert($message, json_decode($rawRequestData, TRUE));
 288     }
 289     else {
 290       $log->alert($message, $_REQUEST);
 291     }
 292   }
 293
 294   /**
 295    * Check if capability is supported.
 296    *
 297    * Capabilities have a one to one relationship with capability-related functions on this class.
 298    *
 299    * Payment processor classes should over-ride the capability-specific function rather than this one.
 300    *
 301    * @param string $capability
 302    *   E.g BackOffice, LiveMode, FutureRecurStartDate.
 303    *
 304    * @return bool
 305    */
 306   public function supports($capability) {
 307     $function = 'supports' . ucfirst($capability);
 308     if (method_exists($this, $function)) {
 309       return $this->$function();
 310     }
 311     return FALSE;
 312   }
 313
 314   /**
 315    * Are back office payments supported.
 316    *
 317    * e.g paypal standard won't permit you to enter a credit card associated
 318    * with someone else's login.
 319    * The intention is to support off-site (other than paypal) & direct debit but that is not all working yet so to
 320    * reach a 'stable' point we disable.
 321    *
 322    * @return bool
 323    */
 324   protected function supportsBackOffice() {
 325     if ($this->_paymentProcessor['billing_mode'] == 4 || $this->_paymentProcessor['payment_type'] != 1) {
 326       return FALSE;
 327     }
 328     else {
 329       return TRUE;
 330     }
 331   }
 332
 333   /**
 334    * Can more than one transaction be processed at once?
 335    *
 336    * In general processors that process payment by server to server communication support this while others do not.
 337    *
 338    * In future we are likely to hit an issue where this depends on whether a token already exists.
 339    *
 340    * @return bool
 341    */
 342   protected function supportsMultipleConcurrentPayments() {
 343     if ($this->_paymentProcessor['billing_mode'] == 4 || $this->_paymentProcessor['payment_type'] != 1) {
 344       return FALSE;
 345     }
 346     else {
 347       return TRUE;
 348     }
 349   }
 350
 351   /**
 352    * Are live payments supported - e.g dummy doesn't support this.
 353    *
 354    * @return bool
 355    */
 356   protected function supportsLiveMode() {
 357     return empty($this->_paymentProcessor['is_test']) ? TRUE : FALSE;
 358   }
 359
 360   /**
 361    * Are test payments supported.
 362    *
 363    * @return bool
 364    */
 365   protected function supportsTestMode() {
 366     return empty($this->_paymentProcessor['is_test']) ? FALSE : TRUE;
 367   }
 368
 369   /**
 370    * Does this payment processor support refund?
 371    *
 372    * @return bool
 373    */
 374   public function supportsRefund() {
 375     return FALSE;
 376   }
 377
 378   /**
 379    * Should the first payment date be configurable when setting up back office recurring payments.
 380    *
 381    * We set this to false for historical consistency but in fact most new processors use tokens for recurring and can support this
 382    *
 383    * @return bool
 384    */
 385   protected function supportsFutureRecurStartDate() {
 386     return FALSE;
 387   }
 388
 389   /**
 390    * Does this processor support cancelling recurring contributions through code.
 391    *
 392    * If the processor returns true it must be possible to take action from within CiviCRM
 393    * that will result in no further payments being processed. In the case of token processors (e.g
 394    * IATS, eWay) updating the contribution_recur table is probably sufficient.
 395    *
 396    * @return bool
 397    */
 398   protected function supportsCancelRecurring() {
 399     return method_exists(CRM_Utils_System::getClassName($this), 'cancelSubscription');
 400   }
 401
 402   /**
 403    * Does this processor support pre-approval.
 404    *
 405    * This would generally look like a redirect to enter credentials which can then be used in a later payment call.
 406    *
 407    * Currently Paypal express supports this, with a redirect to paypal after the 'Main' form is submitted in the
 408    * contribution page. This token can then be processed at the confirm phase. Although this flow 'looks' like the
 409    * 'notify' flow a key difference is that in the notify flow they don't have to return but in this flow they do.
 410    *
 411    * @return bool
 412    */
 413   protected function supportsPreApproval() {
 414     return FALSE;
 415   }
 416
 417   /**
 418    * Does this processor support updating billing info for recurring contributions through code.
 419    *
 420    * If the processor returns true then it must be possible to update billing info from within CiviCRM
 421    * that will be updated at the payment processor.
 422    *
 423    * @return bool
 424    */
 425   protected function supportsUpdateSubscriptionBillingInfo() {
 426     return method_exists(CRM_Utils_System::getClassName($this), 'updateSubscriptionBillingInfo');
 427   }
 428
 429   /**
 430    * Can recurring contributions be set against pledges.
 431    *
 432    * In practice all processors that use the baseIPN function to finish transactions or
 433    * call the completetransaction api support this by looking up previous contributions in the
 434    * series and, if there is a prior contribution against a pledge, and the pledge is not complete,
 435    * adding the new payment to the pledge.
 436    *
 437    * However, only enabling for processors it has been tested against.
 438    *
 439    * @return bool
 440    */
 441   protected function supportsRecurContributionsForPledges() {
 442     return FALSE;
 443   }
 444
 445   /**
 446    * Does the processor work without an email address?
 447    *
 448    * The historic assumption is that all processors require an email address. This capability
 449    * allows a processor to state it does not need to be provided with an email address.
 450    * NB: when this was added (Feb 2020), the Manual processor class overrides this but
 451    * the only use of the capability is in the webform_civicrm module.  It is not currently
 452    * used in core but may be in future.
 453    *
 454    * @return bool
 455    */
 456   protected function supportsNoEmailProvided() {
 457     return FALSE;
 458   }
 459
 460   /**
 461    * Function to action pre-approval if supported
 462    *
 463    * @param array $params
 464    *   Parameters from the form
 465    *
 466    * This function returns an array which should contain
 467    *   - pre_approval_parameters (this will be stored on the calling form & available later)
 468    *   - redirect_url (if set the browser will be redirected to this.
 469    */
 470   public function doPreApproval(&$params) {
 471   }
 472
 473   /**
 474    * Get any details that may be available to the payment processor due to an approval process having happened.
 475    *
 476    * In some cases the browser is redirected to enter details on a processor site. Some details may be available as a
 477    * result.
 478    *
 479    * @param array $storedDetails
 480    *
 481    * @return array
 482    */
 483   public function getPreApprovalDetails($storedDetails) {
 484     return [];
 485   }
 486
 487   /**
 488    * Default payment instrument validation.
 489    *
 490    * Implement the usual Luhn algorithm via a static function in the CRM_Core_Payment_Form if it's a credit card
 491    * Not a static function, because I need to check for payment_type.
 492    *
 493    * @param array $values
 494    * @param array $errors
 495    */
 496   public function validatePaymentInstrument($values, &$errors) {
 497     CRM_Core_Form::validateMandatoryFields($this->getMandatoryFields(), $values, $errors);
 498     if ($this->_paymentProcessor['payment_type'] == 1) {
 499       CRM_Core_Payment_Form::validateCreditCard($values, $errors, $this->_paymentProcessor['id']);
 500     }
 501   }
 502
 503   /**
 504    * Getter for the payment processor.
 505    *
 506    * The payment processor array is based on the civicrm_payment_processor table entry.
 507    *
 508    * @return array
 509    *   Payment processor array.
 510    */
 511   public function getPaymentProcessor() {
 512     return $this->_paymentProcessor;
 513   }
 514
 515   /**
 516    * Setter for the payment processor.
 517    *
 518    * @param array $processor
 519    */
 520   public function setPaymentProcessor($processor) {
 521     $this->_paymentProcessor = $processor;
 522   }
 523
 524   /**
 525    * Setter for the payment form that wants to use the processor.
 526    *
 527    * @deprecated
 528    *
 529    * @param CRM_Core_Form $paymentForm
 530    */
 531   public function setForm(&$paymentForm) {
 532     $this->_paymentForm = $paymentForm;
 533   }
 534
 535   /**
 536    * Getter for payment form that is using the processor.
 537    * @deprecated
 538    * @return CRM_Core_Form
 539    *   A form object
 540    */
 541   public function getForm() {
 542     return $this->_paymentForm;
 543   }
 544
 545   /**
 546    * Get help text information (help, description, etc.) about this payment,
 547    * to display to the user.
 548    *
 549    * @param string $context
 550    *   Context of the text.
 551    *   Only explicitly supported contexts are handled without error.
 552    *   Currently supported:
 553    *   - contributionPageRecurringHelp (params: is_recur_installments, is_email_receipt)
 554    *   - contributionPageContinueText (params: amount, is_payment_to_existing)
 555    *   - cancelRecurDetailText (params: mode, amount, currency, frequency_interval, frequency_unit, installments, {membershipType|only if mode=auto_renew})
 556    *   - cancelRecurNotSupportedText
 557    *
 558    * @param array $params
 559    *   Parameters for the field, context specific.
 560    *
 561    * @return string
 562    */
 563   public function getText($context, $params) {
 564     // I have deliberately added a noisy fail here.
 565     // The function is intended to be extendable, but not by changes
 566     // not documented clearly above.
 567     switch ($context) {
 568       case 'contributionPageRecurringHelp':
 569         // require exactly two parameters
 570         if (array_keys($params) == [
 571           'is_recur_installments',
 572           'is_email_receipt',
 573         ]) {
 574           $gotText = ts('Your recurring contribution will be processed automatically.');
 575           if ($params['is_recur_installments']) {
 576             $gotText .= ' ' . ts('You can specify the number of installments, or you can leave the number of installments blank if you want to make an open-ended commitment. In either case, you can choose to cancel at any time.');
 577           }
 578           if ($params['is_email_receipt']) {
 579             $gotText .= ' ' . ts('You will receive an email receipt for each recurring contribution.');
 580           }
 581         }
 582         return $gotText;
 583
 584       case 'contributionPageContinueText':
 585         if ($params['amount'] <= 0) {
 586           return ts('To complete this transaction, click the <strong>Continue</strong> button below.');
 587         }
 588         if ($this->_paymentProcessor['billing_mode'] == 4) {
 589           return ts('Click the <strong>Continue</strong> button to go to %1, where you will select your payment method and complete the contribution.', [$this->_paymentProcessor['payment_processor_type']]);
 590         }
 591         if ($params['is_payment_to_existing']) {
 592           return ts('To complete this transaction, click the <strong>Make Payment</strong> button below.');
 593         }
 594         return ts('To complete your contribution, click the <strong>Continue</strong> button below.');
 595
 596       case 'cancelRecurDetailText':
 597         if ($params['mode'] === 'auto_renew') {
 598           return ts('Click the button below if you want to cancel the auto-renewal option for your %1 membership. This will not cancel your membership. However you will need to arrange payment for renewal when your membership expires.',
 599             [1 => $params['membershipType']]
 600           );
 601         }
 602         else {
 603           $text = ts('Recurring Contribution Details: %1 every %2 %3', [
 604             1 => CRM_Utils_Money::format($params['amount'], $params['currency']),
 605             2 => $params['frequency_interval'],
 606             3 => $params['frequency_unit'],
 607           ]);
 608           if (!empty($params['installments'])) {
 609             $text .= ' ' . ts('for %1 installments', [1 => $params['installments']]) . '.';
 610           }
 611           $text = "<strong>{$text}</strong><div class='content'>";
 612           $text .= ts('Click the button below to cancel this commitment and stop future transactions. This does not affect contributions which have already been completed.');
 613           $text .= '</div>';
 614           return $text;
 615         }
 616
 617       case 'cancelRecurNotSupportedText':
 618         return ts('Automatic cancellation is not supported for this payment processor. You or the contributor will need to manually cancel this recurring contribution using the payment processor website.');
 619
 620     }
 621     CRM_Core_Error::deprecatedFunctionWarning('Calls to getText must use a supported method');
 622     return '';
 623   }
 624
 625   /**
 626    * Getter for accessing member vars.
 627    *
 628    * @todo believe this is unused
 629    *
 630    * @param string $name
 631    *
 632    * @return null
 633    */
 634   public function getVar($name) {
 635     return $this->$name ?? NULL;
 636   }
 637
 638   /**
 639    * Get name for the payment information type.
 640    * @todo - use option group + name field (like Omnipay does)
 641    * @return string
 642    */
 643   public function getPaymentTypeName() {
 644     return $this->_paymentProcessor['payment_type'] == 1 ? 'credit_card' : 'direct_debit';
 645   }
 646
 647   /**
 648    * Get label for the payment information type.
 649    * @todo - use option group + labels (like Omnipay does)
 650    * @return string
 651    */
 652   public function getPaymentTypeLabel() {
 653     return $this->_paymentProcessor['payment_type'] == 1 ? ts('Credit Card') : ts('Direct Debit');
 654   }
 655
 656   /**
 657    * Get array of fields that should be displayed on the payment form.
 658    *
 659    * Common results are
 660    *   array('credit_card_type', 'credit_card_number', 'cvv2', 'credit_card_exp_date')
 661    *   or
 662    *   array('account_holder', 'bank_account_number', 'bank_identification_number', 'bank_name')
 663    *   or
 664    *   array()
 665    *
 666    * @return array
 667    *   Array of payment fields appropriate to the payment processor.
 668    *
 669    * @throws CiviCRM_API3_Exception
 670    */
 671   public function getPaymentFormFields() {
 672     if ($this->_paymentProcessor['billing_mode'] == 4) {
 673       return [];
 674     }
 675     return $this->_paymentProcessor['payment_type'] == 1 ? $this->getCreditCardFormFields() : $this->getDirectDebitFormFields();
 676   }
 677
 678   /**
 679    * Get an array of the fields that can be edited on the recurring contribution.
 680    *
 681    * Some payment processors support editing the amount and other scheduling details of recurring payments, especially
 682    * those which use tokens. Others are fixed. This function allows the processor to return an array of the fields that
 683    * can be updated from the contribution recur edit screen.
 684    *
 685    * The fields are likely to be a subset of these
 686    *  - 'amount',
 687    *  - 'installments',
 688    *  - 'frequency_interval',
 689    *  - 'frequency_unit',
 690    *  - 'cycle_day',
 691    *  - 'next_sched_contribution_date',
 692    *  - 'end_date',
 693    * - 'failure_retry_day',
 694    *
 695    * The form does not restrict which fields from the contribution_recur table can be added (although if the html_type
 696    * metadata is not defined in the xml for the field it will cause an error.
 697    *
 698    * Open question - would it make sense to return membership_id in this - which is sometimes editable and is on that
 699    * form (UpdateSubscription).
 700    *
 701    * @return array
 702    */
 703   public function getEditableRecurringScheduleFields() {
 704     if ($this->supports('changeSubscriptionAmount')) {
 705       return ['amount'];
 706     }
 707     return [];
 708   }
 709
 710   /**
 711    * Get the help text to present on the recurring update page.
 712    *
 713    * This should reflect what can or cannot be edited.
 714    *
 715    * @return string
 716    */
 717   public function getRecurringScheduleUpdateHelpText() {
 718     if (!in_array('amount', $this->getEditableRecurringScheduleFields())) {
 719       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.');
 720     }
 721     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.');
 722   }
 723
 724   /**
 725    * Get the metadata for all required fields.
 726    *
 727    * @return array;
 728    */
 729   protected function getMandatoryFields() {
 730     $mandatoryFields = [];
 731     foreach ($this->getAllFields() as $field_name => $field_spec) {
 732       if (!empty($field_spec['is_required'])) {
 733         $mandatoryFields[$field_name] = $field_spec;
 734       }
 735     }
 736     return $mandatoryFields;
 737   }
 738
 739   /**
 740    * Get the metadata of all the fields configured for this processor.
 741    *
 742    * @return array
 743    *
 744    * @throws \CiviCRM_API3_Exception
 745    */
 746   protected function getAllFields() {
 747     $paymentFields = array_intersect_key($this->getPaymentFormFieldsMetadata(), array_flip($this->getPaymentFormFields()));
 748     $billingFields = array_intersect_key($this->getBillingAddressFieldsMetadata(), array_flip($this->getBillingAddressFields()));
 749     return array_merge($paymentFields, $billingFields);
 750   }
 751
 752   /**
 753    * Get array of fields that should be displayed on the payment form for credit cards.
 754    *
 755    * @return array
 756    */
 757   protected function getCreditCardFormFields() {
 758     return [
 759       'credit_card_type',
 760       'credit_card_number',
 761       'cvv2',
 762       'credit_card_exp_date',
 763     ];
 764   }
 765
 766   /**
 767    * Get array of fields that should be displayed on the payment form for direct debits.
 768    *
 769    * @return array
 770    */
 771   protected function getDirectDebitFormFields() {
 772     return [
 773       'account_holder',
 774       'bank_account_number',
 775       'bank_identification_number',
 776       'bank_name',
 777     ];
 778   }
 779
 780   /**
 781    * Return an array of all the details about the fields potentially required for payment fields.
 782    *
 783    * Only those determined by getPaymentFormFields will actually be assigned to the form
 784    *
 785    * @return array
 786    *   field metadata
 787    */
 788   public function getPaymentFormFieldsMetadata() {
 789     //@todo convert credit card type into an option value
 790     $creditCardType = ['' => ts('- select -')] + CRM_Contribute_PseudoConstant::creditCard();
 791     $isCVVRequired = Civi::settings()->get('cvv_backoffice_required');
 792     if (!$this->isBackOffice()) {
 793       $isCVVRequired = TRUE;
 794     }
 795     return [
 796       'credit_card_number' => [
 797         'htmlType' => 'text',
 798         'name' => 'credit_card_number',
 799         'title' => ts('Card Number'),
 800         'attributes' => [
 801           'size' => 20,
 802           'maxlength' => 20,
 803           'autocomplete' => 'off',
 804           'class' => 'creditcard',
 805         ],
 806         'is_required' => TRUE,
 807         // 'description' => '16 digit card number', // If you enable a description field it will be shown below the field on the form
 808       ],
 809       'cvv2' => [
 810         'htmlType' => 'text',
 811         'name' => 'cvv2',
 812         'title' => ts('Security Code'),
 813         'attributes' => [
 814           'size' => 5,
 815           'maxlength' => 10,
 816           'autocomplete' => 'off',
 817         ],
 818         'is_required' => $isCVVRequired,
 819         'rules' => [
 820           [
 821             '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.'),
 822             'rule_name' => 'integer',
 823             'rule_parameters' => NULL,
 824           ],
 825         ],
 826       ],
 827       'credit_card_exp_date' => [
 828         'htmlType' => 'date',
 829         'name' => 'credit_card_exp_date',
 830         'title' => ts('Expiration Date'),
 831         'attributes' => CRM_Core_SelectValues::date('creditCard'),
 832         'is_required' => TRUE,
 833         'rules' => [
 834           [
 835             'rule_message' => ts('Card expiration date cannot be a past date.'),
 836             'rule_name' => 'currentDate',
 837             'rule_parameters' => TRUE,
 838           ],
 839         ],
 840         'extra' => ['class' => 'crm-form-select'],
 841       ],
 842       'credit_card_type' => [
 843         'htmlType' => 'select',
 844         'name' => 'credit_card_type',
 845         'title' => ts('Card Type'),
 846         'attributes' => $creditCardType,
 847         'is_required' => FALSE,
 848       ],
 849       'account_holder' => [
 850         'htmlType' => 'text',
 851         'name' => 'account_holder',
 852         'title' => ts('Account Holder'),
 853         'attributes' => [
 854           'size' => 20,
 855           'maxlength' => 34,
 856           'autocomplete' => 'on',
 857         ],
 858         'is_required' => TRUE,
 859       ],
 860       //e.g. IBAN can have maxlength of 34 digits
 861       'bank_account_number' => [
 862         'htmlType' => 'text',
 863         'name' => 'bank_account_number',
 864         'title' => ts('Bank Account Number'),
 865         'attributes' => [
 866           'size' => 20,
 867           'maxlength' => 34,
 868           'autocomplete' => 'off',
 869         ],
 870         'rules' => [
 871           [
 872             'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
 873             'rule_name' => 'nopunctuation',
 874             'rule_parameters' => NULL,
 875           ],
 876         ],
 877         'is_required' => TRUE,
 878       ],
 879       //e.g. SWIFT-BIC can have maxlength of 11 digits
 880       'bank_identification_number' => [
 881         'htmlType' => 'text',
 882         'name' => 'bank_identification_number',
 883         'title' => ts('Bank Identification Number'),
 884         'attributes' => [
 885           'size' => 20,
 886           'maxlength' => 11,
 887           'autocomplete' => 'off',
 888         ],
 889         'is_required' => TRUE,
 890         'rules' => [
 891           [
 892             'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'),
 893             'rule_name' => 'nopunctuation',
 894             'rule_parameters' => NULL,
 895           ],
 896         ],
 897       ],
 898       'bank_name' => [
 899         'htmlType' => 'text',
 900         'name' => 'bank_name',
 901         'title' => ts('Bank Name'),
 902         'attributes' => [
 903           'size' => 20,
 904           'maxlength' => 64,
 905           'autocomplete' => 'off',
 906         ],
 907         'is_required' => TRUE,
 908
 909       ],
 910       'check_number' => [
 911         'htmlType' => 'text',
 912         'name' => 'check_number',
 913         'title' => ts('Check Number'),
 914         'is_required' => FALSE,
 915         'attributes' => NULL,
 916       ],
 917       'pan_truncation' => [
 918         'htmlType' => 'text',
 919         'name' => 'pan_truncation',
 920         'title' => ts('Last 4 digits of the card'),
 921         'is_required' => FALSE,
 922         'attributes' => [
 923           'size' => 4,
 924           'maxlength' => 4,
 925           'minlength' => 4,
 926           'autocomplete' => 'off',
 927         ],
 928         'rules' => [
 929           [
 930             'rule_message' => ts('Please enter valid last 4 digit card number.'),
 931             'rule_name' => 'numeric',
 932             'rule_parameters' => NULL,
 933           ],
 934         ],
 935       ],
 936       'payment_token' => [
 937         'htmlType' => 'hidden',
 938         'name' => 'payment_token',
 939         'title' => ts('Authorization token'),
 940         'is_required' => FALSE,
 941         'attributes' => [
 942           'size' => 10,
 943           'autocomplete' => 'off',
 944           'id' => 'payment_token',
 945         ],
 946       ],
 947     ];
 948   }
 949
 950   /**
 951    * Get billing fields required for this processor.
 952    *
 953    * We apply the existing default of returning fields only for payment processor type 1. Processors can override to
 954    * alter.
 955    *
 956    * @param int $billingLocationID
 957    *
 958    * @return array
 959    */
 960   public function getBillingAddressFields($billingLocationID = NULL) {
 961     if (!$billingLocationID) {
 962       // Note that although the billing id is passed around the forms the idea that it would be anything other than
 963       // the result of the function below doesn't seem to have eventuated.
 964       // So taking this as a param is possibly something to be removed in favour of the standard default.
 965       $billingLocationID = CRM_Core_BAO_LocationType::getBilling();
 966     }
 967     if ($this->_paymentProcessor['billing_mode'] != 1 && $this->_paymentProcessor['billing_mode'] != 3) {
 968       return [];
 969     }
 970     return [
 971       'first_name' => 'billing_first_name',
 972       'middle_name' => 'billing_middle_name',
 973       'last_name' => 'billing_last_name',
 974       'street_address' => "billing_street_address-{$billingLocationID}",
 975       'city' => "billing_city-{$billingLocationID}",
 976       'country' => "billing_country_id-{$billingLocationID}",
 977       'state_province' => "billing_state_province_id-{$billingLocationID}",
 978       'postal_code' => "billing_postal_code-{$billingLocationID}",
 979     ];
 980   }
 981
 982   /**
 983    * Get form metadata for billing address fields.
 984    *
 985    * @param int $billingLocationID
 986    *
 987    * @return array
 988    *   Array of metadata for address fields.
 989    */
 990   public function getBillingAddressFieldsMetadata($billingLocationID = NULL) {
 991     if (!$billingLocationID) {
 992       // Note that although the billing id is passed around the forms the idea that it would be anything other than
 993       // the result of the function below doesn't seem to have eventuated.
 994       // So taking this as a param is possibly something to be removed in favour of the standard default.
 995       $billingLocationID = CRM_Core_BAO_LocationType::getBilling();
 996     }
 997     $metadata = [];
 998     $metadata['billing_first_name'] = [
 999       'htmlType' => 'text',
1000       'name' => 'billing_first_name',
1001       'title' => ts('Billing First Name'),
1002       'cc_field' => TRUE,
1003       'attributes' => [
1004         'size' => 30,
1005         'maxlength' => 60,
1006         'autocomplete' => 'off',
1007       ],
1008       'is_required' => TRUE,
1009     ];
1010
1011     $metadata['billing_middle_name'] = [
1012       'htmlType' => 'text',
1013       'name' => 'billing_middle_name',
1014       'title' => ts('Billing Middle Name'),
1015       'cc_field' => TRUE,
1016       'attributes' => [
1017         'size' => 30,
1018         'maxlength' => 60,
1019         'autocomplete' => 'off',
1020       ],
1021       'is_required' => FALSE,
1022     ];
1023
1024     $metadata['billing_last_name'] = [
1025       'htmlType' => 'text',
1026       'name' => 'billing_last_name',
1027       'title' => ts('Billing Last Name'),
1028       'cc_field' => TRUE,
1029       'attributes' => [
1030         'size' => 30,
1031         'maxlength' => 60,
1032         'autocomplete' => 'off',
1033       ],
1034       'is_required' => TRUE,
1035     ];
1036
1037     $metadata["billing_street_address-{$billingLocationID}"] = [
1038       'htmlType' => 'text',
1039       'name' => "billing_street_address-{$billingLocationID}",
1040       'title' => ts('Street Address'),
1041       'cc_field' => TRUE,
1042       'attributes' => [
1043         'size' => 30,
1044         'maxlength' => 60,
1045         'autocomplete' => 'off',
1046       ],
1047       'is_required' => TRUE,
1048     ];
1049
1050     $metadata["billing_city-{$billingLocationID}"] = [
1051       'htmlType' => 'text',
1052       'name' => "billing_city-{$billingLocationID}",
1053       'title' => ts('City'),
1054       'cc_field' => TRUE,
1055       'attributes' => [
1056         'size' => 30,
1057         'maxlength' => 60,
1058         'autocomplete' => 'off',
1059       ],
1060       'is_required' => TRUE,
1061     ];
1062
1063     $metadata["billing_state_province_id-{$billingLocationID}"] = [
1064       'htmlType' => 'chainSelect',
1065       'title' => ts('State/Province'),
1066       'name' => "billing_state_province_id-{$billingLocationID}",
1067       'cc_field' => TRUE,
1068       'is_required' => TRUE,
1069     ];
1070
1071     $metadata["billing_postal_code-{$billingLocationID}"] = [
1072       'htmlType' => 'text',
1073       'name' => "billing_postal_code-{$billingLocationID}",
1074       'title' => ts('Postal Code'),
1075       'cc_field' => TRUE,
1076       'attributes' => [
1077         'size' => 30,
1078         'maxlength' => 60,
1079         'autocomplete' => 'off',
1080       ],
1081       'is_required' => TRUE,
1082     ];
1083
1084     $metadata["billing_country_id-{$billingLocationID}"] = [
1085       'htmlType' => 'select',
1086       'name' => "billing_country_id-{$billingLocationID}",
1087       'title' => ts('Country'),
1088       'cc_field' => TRUE,
1089       'attributes' => [
1090         '' => ts('- select -'),
1091       ] + CRM_Core_PseudoConstant::country(),
1092       'is_required' => TRUE,
1093     ];
1094     return $metadata;
1095   }
1096
1097   /**
1098    * Get base url dependent on component.
1099    *
1100    * (or preferably set it using the setter function).
1101    *
1102    * @return string
1103    */
1104   protected function getBaseReturnUrl() {
1105     if ($this->baseReturnUrl) {
1106       return $this->baseReturnUrl;
1107     }
1108     if ($this->_component == 'event') {
1109       $baseURL = 'civicrm/event/register';
1110     }
1111     else {
1112       $baseURL = 'civicrm/contribute/transact';
1113     }
1114     return $baseURL;
1115   }
1116
1117   /**
1118    * Get the currency for the transaction from the params.
1119    *
1120    * Legacy wrapper. Better for a method to work on its own PropertyBag.
1121    *
1122    * This code now uses PropertyBag to allow for old inputs like currencyID.
1123    *
1124    * @param $params
1125    *
1126    * @return string
1127    */
1128   protected function getCurrency($params = []) {
1129     $localPropertyBag = new PropertyBag();
1130     $localPropertyBag->mergeLegacyInputParams($params);
1131     return $localPropertyBag->getCurrency();
1132   }
1133
1134   /**
1135    * Legacy. Better for a method to work on its own PropertyBag,
1136    * but also, this function does not do very much.
1137    *
1138    * @param array $params
1139    *
1140    * @return string
1141    * @throws \CRM_Core_Exception
1142    */
1143   protected function getAmount($params = []) {
1144     return CRM_Utils_Money::format($params['amount'], NULL, NULL, TRUE);
1145   }
1146
1147   /**
1148    * Get url to return to after cancelled or failed transaction.
1149    *
1150    * @param string $qfKey
1151    * @param int $participantID
1152    *
1153    * @return string cancel url
1154    */
1155   public function getCancelUrl($qfKey, $participantID) {
1156     if (isset($this->cancelUrl)) {
1157       return $this->cancelUrl;
1158     }
1159
1160     if ($this->_component == 'event') {
1161       return CRM_Utils_System::url($this->getBaseReturnUrl(), [
1162         'reset' => 1,
1163         'cc' => 'fail',
1164         'participantId' => $participantID,
1165       ],
1166         TRUE, NULL, FALSE
1167       );
1168     }
1169
1170     return CRM_Utils_System::url($this->getBaseReturnUrl(), [
1171       '_qf_Main_display' => 1,
1172       'qfKey' => $qfKey,
1173       'cancel' => 1,
1174     ],
1175       TRUE, NULL, FALSE
1176     );
1177   }
1178
1179   /**
1180    * Get URL to return the browser to on success.
1181    *
1182    * @param $qfKey
1183    *
1184    * @return string
1185    */
1186   protected function getReturnSuccessUrl($qfKey) {
1187     if (isset($this->successUrl)) {
1188       return $this->successUrl;
1189     }
1190
1191     return CRM_Utils_System::url($this->getBaseReturnUrl(), [
1192       '_qf_ThankYou_display' => 1,
1193       'qfKey' => $qfKey,
1194     ],
1195       TRUE, NULL, FALSE
1196     );
1197   }
1198
1199   /**
1200    * Get URL to return the browser to on failure.
1201    *
1202    * @param string $key
1203    * @param int $participantID
1204    * @param int $eventID
1205    *
1206    * @return string
1207    *   URL for a failing transactor to be redirected to.
1208    */
1209   protected function getReturnFailUrl($key, $participantID = NULL, $eventID = NULL) {
1210     if (isset($this->cancelUrl)) {
1211       return $this->cancelUrl;
1212     }
1213
1214     $test = $this->_is_test ? '&action=preview' : '';
1215     if ($this->_component == "event") {
1216       return CRM_Utils_System::url('civicrm/event/register',
1217         "reset=1&cc=fail&participantId={$participantID}&id={$eventID}{$test}&qfKey={$key}",
1218         FALSE, NULL, FALSE
1219       );
1220     }
1221     else {
1222       return CRM_Utils_System::url('civicrm/contribute/transact',
1223         "_qf_Main_display=1&cancel=1&qfKey={$key}{$test}",
1224         FALSE, NULL, FALSE
1225       );
1226     }
1227   }
1228
1229   /**
1230    * Get URl for when the back button is pressed.
1231    *
1232    * @param $qfKey
1233    *
1234    * @return string url
1235    */
1236   protected function getGoBackUrl($qfKey) {
1237     return CRM_Utils_System::url($this->getBaseReturnUrl(), [
1238       '_qf_Confirm_display' => 'true',
1239       'qfKey' => $qfKey,
1240     ],
1241       TRUE, NULL, FALSE
1242     );
1243   }
1244
1245   /**
1246    * Get the notify (aka ipn, web hook or silent post) url.
1247    *
1248    * If there is no '.' in it we assume that we are dealing with localhost or
1249    * similar and it is unreachable from the web & hence invalid.
1250    *
1251    * @return string
1252    *   URL to notify outcome of transaction.
1253    */
1254   protected function getNotifyUrl() {
1255     $url = CRM_Utils_System::url(
1256       'civicrm/payment/ipn/' . $this->_paymentProcessor['id'],
1257       [],
1258       TRUE,
1259       NULL,
1260       FALSE,
1261       TRUE
1262     );
1263     return (stristr($url, '.')) ? $url : '';
1264   }
1265
1266   /**
1267    * Calling this from outside the payment subsystem is deprecated - use doPayment.
1268    * @deprecated
1269    * Does a server to server payment transaction.
1270    *
1271    * @param array $params
1272    *   Assoc array of input parameters for this transaction.
1273    *
1274    * @return array
1275    *   the result in an nice formatted array (or an error object - but throwing exceptions is preferred)
1276    */
1277   protected function doDirectPayment(&$params) {
1278     return $params;
1279   }
1280
1281   /**
1282    * Processors may need to inspect, validate, cast and copy data that is
1283    * specific to this Payment Processor from the input array to custom fields
1284    * on the PropertyBag.
1285    *
1286    * @param Civi\Payment\PropertyBag $propertyBag
1287    * @param array $params
1288    * @param string $component
1289    *
1290    * @throws \Civi\Payment\Exception\PaymentProcessorException
1291    */
1292   public function extractCustomPropertiesForDoPayment(PropertyBag $propertyBag, array $params, $component = 'contribute') {
1293     // example
1294     // (validation and casting goes first)
1295     // $propertyBag->setCustomProperty('myprocessor_customPropertyName', $value);
1296   }
1297
1298   /**
1299    * Process payment - this function wraps around both doTransferCheckout and doDirectPayment.
1300    * Any processor that still implements the deprecated doTransferCheckout() or doDirectPayment() should be updated to use doPayment().
1301    *
1302    * This function adds some historical defaults ie. the assumption that if a 'doDirectPayment' processors comes back it completed
1303    *   the transaction & in fact doTransferCheckout would not traditionally come back.
1304    * Payment processors should throw exceptions and not return Error objects as they may have done with the old functions.
1305    *
1306    * Payment processors should set payment_status_id (which is really contribution_status_id) in the returned array. The default is assumed to be Pending.
1307    *   In some cases the IPN will set the payment to "Completed" some time later.
1308    *
1309    * @fixme Creating a contribution record is inconsistent! We should always create a contribution BEFORE calling doPayment...
1310    *  For the current status see: https://lab.civicrm.org/dev/financial/issues/53
1311    * If we DO have a contribution ID, then the payment processor can (and should) update parameters on the contribution record as necessary.
1312    *
1313    * @param array|PropertyBag $params
1314    *
1315    * @param string $component
1316    *
1317    * @return array
1318    *   Result array (containing at least the key payment_status_id)
1319    *
1320    * @throws \Civi\Payment\Exception\PaymentProcessorException
1321    */
1322   public function doPayment(&$params, $component = 'contribute') {
1323     $this->_component = $component;
1324     $statuses = CRM_Contribute_BAO_Contribution::buildOptions('contribution_status_id', 'validate');
1325
1326     // If we have a $0 amount, skip call to processor and set payment_status to Completed.
1327     // Conceivably a processor might override this - perhaps for setting up a token - but we don't
1328     // have an example of that at the mome.
1329     if ($params['amount'] == 0) {
1330       $result['payment_status_id'] = array_search('Completed', $statuses);
1331       return $result;
1332     }
1333
1334     if ($this->_paymentProcessor['billing_mode'] == 4) {
1335       $result = $this->doTransferCheckout($params, $component);
1336       if (is_array($result) && !isset($result['payment_status_id'])) {
1337         $result['payment_status_id'] = array_search('Pending', $statuses);
1338       }
1339     }
1340     else {
1341       $result = $this->doDirectPayment($params, $component);
1342       if (is_array($result) && !isset($result['payment_status_id'])) {
1343         if (!empty($params['is_recur'])) {
1344           // See comment block.
1345           $result['payment_status_id'] = array_search('Pending', $statuses);
1346         }
1347         else {
1348           $result['payment_status_id'] = array_search('Completed', $statuses);
1349         }
1350       }
1351     }
1352     if (is_a($result, 'CRM_Core_Error')) {
1353       throw new PaymentProcessorException(CRM_Core_Error::getMessages($result));
1354     }
1355     return $result;
1356   }
1357
1358   /**
1359    * Cancel a recurring subscription.
1360    *
1361    * Payment processor classes should override this rather than implementing cancelSubscription.
1362    *
1363    * A PaymentProcessorException should be thrown if the update of the contribution_recur
1364    * record should not proceed (in many cases this function does nothing
1365    * as the payment processor does not need to take any action & this should silently
1366    * proceed. Note the form layer will only call this after calling
1367    * $processor->supports('cancelRecurring');
1368    *
1369    * @param \Civi\Payment\PropertyBag $propertyBag
1370    *
1371    * @return array
1372    *
1373    * @throws \Civi\Payment\Exception\PaymentProcessorException
1374    */
1375   public function doCancelRecurring(PropertyBag $propertyBag) {
1376     if (method_exists($this, 'cancelSubscription')) {
1377       $message = NULL;
1378       if ($this->cancelSubscription($message, $propertyBag)) {
1379         return ['message' => $message];
1380       }
1381       throw new PaymentProcessorException($message);
1382     }
1383     return ['message' => ts('Recurring contribution cancelled')];
1384   }
1385
1386   /**
1387    * Refunds payment
1388    *
1389    * Payment processors should set payment_status_id if it set the status to Refunded in case the transaction is successful
1390    *
1391    * @param array $params
1392    *
1393    * @throws \Civi\Payment\Exception\PaymentProcessorException
1394    */
1395   public function doRefund(&$params) {}
1396
1397   /**
1398    * Query payment processor for details about a transaction.
1399    *
1400    * @param array $params
1401    *   Array of parameters containing one of:
1402    *   - trxn_id Id of an individual transaction.
1403    *   - processor_id Id of a recurring contribution series as stored in the civicrm_contribution_recur table.
1404    *
1405    * @return array
1406    *   Extra parameters retrieved.
1407    *   Any parameters retrievable through this should be documented in the function comments at
1408    *   CRM_Core_Payment::doQuery. Currently:
1409    *   - fee_amount Amount of fee paid
1410    */
1411   public function doQuery($params) {
1412     return [];
1413   }
1414
1415   /**
1416    * This function checks to see if we have the right config values.
1417    *
1418    * @return string
1419    *   the error message if any
1420    */
1421   abstract protected function checkConfig();
1422
1423   /**
1424    * Redirect for paypal.
1425    *
1426    * @todo move to paypal class or remove
1427    *
1428    * @param $paymentProcessor
1429    *
1430    * @return bool
1431    */
1432   public static function paypalRedirect(&$paymentProcessor) {
1433     if (!$paymentProcessor) {
1434       return FALSE;
1435     }
1436
1437     if (isset($_GET['payment_date']) &&
1438       isset($_GET['merchant_return_link']) &&
1439       CRM_Utils_Array::value('payment_status', $_GET) == 'Completed' &&
1440       $paymentProcessor['payment_processor_type'] == "PayPal_Standard"
1441     ) {
1442       return TRUE;
1443     }
1444
1445     return FALSE;
1446   }
1447
1448   /**
1449    * Handle incoming payment notification.
1450    *
1451    * IPNs, also called silent posts are notifications of payment outcomes or activity on an external site.
1452    *
1453    * @todo move to0 \Civi\Payment\System factory method
1454    * Page callback for civicrm/payment/ipn
1455    */
1456   public static function handleIPN() {
1457     try {
1458       self::handlePaymentMethod(
1459         'PaymentNotification',
1460         [
1461           'processor_name' => CRM_Utils_Request::retrieveValue('processor_name', 'String'),
1462           'processor_id' => CRM_Utils_Request::retrieveValue('processor_id', 'Integer'),
1463           'mode' => CRM_Utils_Request::retrieveValue('mode', 'Alphanumeric'),
1464         ]
1465       );
1466     }
1467     catch (CRM_Core_Exception $e) {
1468       Civi::log()->error('ipn_payment_callback_exception', [
1469         'context' => [
1470           'backtrace' => CRM_Core_Error::formatBacktrace(debug_backtrace()),
1471         ],
1472       ]);
1473     }
1474     CRM_Utils_System::civiExit();
1475   }
1476
1477   /**
1478    * Payment callback handler.
1479    *
1480    * The processor_name or processor_id is passed in.
1481    * Note that processor_id is more reliable as one site may have more than one instance of a
1482    * processor & ideally the processor will be validating the results
1483    * Load requested payment processor and call that processor's handle<$method> method
1484    *
1485    * @todo move to \Civi\Payment\System factory method
1486    *
1487    * @param string $method
1488    *   'PaymentNotification' or 'PaymentCron'
1489    * @param array $params
1490    *
1491    * @throws \CRM_Core_Exception
1492    * @throws \Exception
1493    */
1494   public static function handlePaymentMethod($method, $params = []) {
1495     if (!isset($params['processor_id']) && !isset($params['processor_name'])) {
1496       $q = explode('/', CRM_Utils_Array::value(CRM_Core_Config::singleton()->userFrameworkURLVar, $_GET, ''));
1497       $lastParam = array_pop($q);
1498       if (is_numeric($lastParam)) {
1499         $params['processor_id'] = $_GET['processor_id'] = $lastParam;
1500       }
1501       else {
1502         self::logPaymentNotification($params);
1503         throw new CRM_Core_Exception("Either 'processor_id' (recommended) or 'processor_name' (deprecated) is required for payment callback.");
1504       }
1505     }
1506
1507     self::logPaymentNotification($params);
1508
1509     $sql = "SELECT ppt.class_name, ppt.name as processor_name, pp.id AS processor_id
1510               FROM civicrm_payment_processor_type ppt
1511         INNER JOIN civicrm_payment_processor pp
1512                 ON pp.payment_processor_type_id = ppt.id
1513                AND pp.is_active";
1514
1515     if (isset($params['processor_id'])) {
1516       $sql .= " WHERE pp.id = %2";
1517       $args[2] = [$params['processor_id'], 'Integer'];
1518       $notFound = ts("No active instances of payment processor %1 were found.", [1 => $params['processor_id']]);
1519     }
1520     else {
1521       // This is called when processor_name is passed - passing processor_id instead is recommended.
1522       $sql .= " WHERE ppt.name = %2 AND pp.is_test = %1";
1523       $args[1] = [
1524         (CRM_Utils_Array::value('mode', $params) == 'test') ? 1 : 0,
1525         'Integer',
1526       ];
1527       $args[2] = [$params['processor_name'], 'String'];
1528       $notFound = ts("No active instances of payment processor '%1' were found.", [1 => $params['processor_name']]);
1529     }
1530
1531     $dao = CRM_Core_DAO::executeQuery($sql, $args);
1532
1533     // Check whether we found anything at all.
1534     if (!$dao->N) {
1535       throw new CRM_Core_Exception($notFound);
1536     }
1537
1538     $method = 'handle' . $method;
1539     $extension_instance_found = FALSE;
1540
1541     // In all likelihood, we'll just end up with the one instance returned here. But it's
1542     // possible we may get more. Hence, iterate through all instances ..
1543
1544     while ($dao->fetch()) {
1545       // Check pp is extension - is this still required - surely the singleton below handles it.
1546       $ext = CRM_Extension_System::singleton()->getMapper();
1547       if ($ext->isExtensionKey($dao->class_name)) {
1548         $paymentClass = $ext->keyToClass($dao->class_name, 'payment');
1549         require_once $ext->classToPath($paymentClass);
1550       }
1551
1552       $processorInstance = System::singleton()->getById($dao->processor_id);
1553
1554       // Should never be empty - we already established this processor_id exists and is active.
1555       if (empty($processorInstance)) {
1556         continue;
1557       }
1558
1559       // Does PP implement this method, and can we call it?
1560       if (!method_exists($processorInstance, $method) ||
1561         !is_callable([$processorInstance, $method])
1562       ) {
1563         // on the off chance there is a double implementation of this processor we should keep looking for another
1564         // note that passing processor_id is more reliable & we should work to deprecate processor_name
1565         continue;
1566       }
1567
1568       // Everything, it seems, is ok - execute pp callback handler
1569       $processorInstance->$method();
1570       $extension_instance_found = TRUE;
1571     }
1572
1573     // Call IPN postIPNProcess hook to allow for custom processing of IPN data.
1574     $IPNParams = array_merge($_GET, $_REQUEST);
1575     CRM_Utils_Hook::postIPNProcess($IPNParams);
1576     if (!$extension_instance_found) {
1577       $message = "No extension instances of the '%1' payment processor were found.<br />" .
1578         "%2 method is unsupported in legacy payment processors.";
1579       throw new CRM_Core_Exception(ts($message, [
1580         1 => $params['processor_name'],
1581         2 => $method,
1582       ]));
1583     }
1584   }
1585
1586   /**
1587    * Check whether a method is present ( & supported ) by the payment processor object.
1588    *
1589    * @deprecated - use $paymentProcessor->supports(array('cancelRecurring');
1590    *
1591    * @param string $method
1592    *   Method to check for.
1593    *
1594    * @return bool
1595    */
1596   public function isSupported($method) {
1597     return method_exists(CRM_Utils_System::getClassName($this), $method);
1598   }
1599
1600   /**
1601    * Some processors replace the form submit button with their own.
1602    *
1603    * Returning false here will leave the button off front end forms.
1604    *
1605    * At this stage there is zero cross-over between back-office processors and processors that suppress the submit.
1606    */
1607   public function isSuppressSubmitButtons() {
1608     return FALSE;
1609   }
1610
1611   /**
1612    * Checks to see if invoice_id already exists in db.
1613    *
1614    * It's arguable if this belongs in the payment subsystem at all but since several processors implement it
1615    * it is better to standardise to being here.
1616    *
1617    * @param int $invoiceId The ID to check.
1618    *
1619    * @param null $contributionID
1620    *   If a contribution exists pass in the contribution ID.
1621    *
1622    * @return bool
1623    *   True if invoice ID otherwise exists, else false
1624    */
1625   protected function checkDupe($invoiceId, $contributionID = NULL) {
1626     $contribution = new CRM_Contribute_DAO_Contribution();
1627     $contribution->invoice_id = $invoiceId;
1628     if ($contributionID) {
1629       $contribution->whereAdd("id <> $contributionID");
1630     }
1631     return $contribution->find();
1632   }
1633
1634   /**
1635    * Get url for users to manage this recurring contribution for this processor.
1636    *
1637    * @param int $entityID
1638    * @param null $entity
1639    * @param string $action
1640    *
1641    * @return string
1642    */
1643   public function subscriptionURL($entityID = NULL, $entity = NULL, $action = 'cancel') {
1644     // Set URL
1645     switch ($action) {
1646       case 'cancel':
1647         if (!$this->supports('cancelRecurring')) {
1648           return NULL;
1649         }
1650         $url = 'civicrm/contribute/unsubscribe';
1651         break;
1652
1653       case 'billing':
1654         //in notify mode don't return the update billing url
1655         if (!$this->supports('updateSubscriptionBillingInfo')) {
1656           return NULL;
1657         }
1658         $url = 'civicrm/contribute/updatebilling';
1659         break;
1660
1661       case 'update':
1662         if (!$this->supports('changeSubscriptionAmount') && !$this->supports('editRecurringContribution')) {
1663           return NULL;
1664         }
1665         $url = 'civicrm/contribute/updaterecur';
1666         break;
1667     }
1668
1669     $userId = CRM_Core_Session::singleton()->get('userID');
1670     $contactID = 0;
1671     $checksumValue = '';
1672     $entityArg = '';
1673
1674     // Find related Contact
1675     if ($entityID) {
1676       switch ($entity) {
1677         case 'membership':
1678           $contactID = CRM_Core_DAO::getFieldValue("CRM_Member_DAO_Membership", $entityID, "contact_id");
1679           $entityArg = 'mid';
1680           break;
1681
1682         case 'contribution':
1683           $contactID = CRM_Core_DAO::getFieldValue("CRM_Contribute_DAO_Contribution", $entityID, "contact_id");
1684           $entityArg = 'coid';
1685           break;
1686
1687         case 'recur':
1688           $sql = "
1689     SELECT DISTINCT con.contact_id
1690       FROM civicrm_contribution_recur rec
1691 INNER JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
1692      WHERE rec.id = %1";
1693           $contactID = CRM_Core_DAO::singleValueQuery($sql, [
1694             1 => [
1695               $entityID,
1696               'Integer',
1697             ],
1698           ]);
1699           $entityArg = 'crid';
1700           break;
1701       }
1702     }
1703
1704     // Add entity arguments
1705     if ($entityArg != '') {
1706       // Add checksum argument
1707       if ($contactID != 0 && $userId != $contactID) {
1708         $checksumValue = '&cs=' . CRM_Contact_BAO_Contact_Utils::generateChecksum($contactID, NULL, 'inf');
1709       }
1710       return CRM_Utils_System::url($url, "reset=1&{$entityArg}={$entityID}{$checksumValue}", TRUE, NULL, FALSE, TRUE);
1711     }
1712
1713     // Else login URL
1714     if ($this->supports('accountLoginURL')) {
1715       return $this->accountLoginURL();
1716     }
1717
1718     // Else default
1719     return $this->_paymentProcessor['url_recur'] ?? '';
1720   }
1721
1722   /**
1723    * Get description of payment to pass to processor.
1724    *
1725    * This is often what people see in the interface so we want to get
1726    * as much unique information in as possible within the field length (& presumably the early part of the field)
1727    *
1728    * People seeing these can be assumed to be advanced users so quantity of information probably trumps
1729    * having field names to clarify
1730    *
1731    * @param array $params
1732    * @param int $length
1733    *
1734    * @return string
1735    */
1736   protected function getPaymentDescription($params = [], $length = 24) {
1737     $propertyBag = PropertyBag::cast($params);
1738     $parts = [
1739       $propertyBag->getter('contactID', TRUE),
1740       $propertyBag->getter('contributionID', TRUE),
1741       $propertyBag->getter('description', TRUE) ?: ($propertyBag->getter('isRecur', TRUE) ? ts('Recurring payment') : NULL),
1742       $propertyBag->getter('billing_first_name', TRUE),
1743       $propertyBag->getter('billing_last_name', TRUE),
1744     ];
1745     return substr(implode('-', array_filter($parts)), 0, $length);
1746   }
1747
1748   /**
1749    * Checks if back-office recurring edit is allowed
1750    *
1751    * @return bool
1752    */
1753   public function supportsEditRecurringContribution() {
1754     return FALSE;
1755   }
1756
1757   /**
1758    * Does this processor support changing the amount for recurring contributions through code.
1759    *
1760    * If the processor returns true then it must be possible to update the amount from within CiviCRM
1761    * that will be updated at the payment processor.
1762    *
1763    * @return bool
1764    */
1765   protected function supportsChangeSubscriptionAmount() {
1766     return method_exists(CRM_Utils_System::getClassName($this), 'changeSubscriptionAmount');
1767   }
1768
1769   /**
1770    * Checks if payment processor supports recurring contributions
1771    *
1772    * @return bool
1773    */
1774   public function supportsRecurring() {
1775     if (!empty($this->_paymentProcessor['is_recur'])) {
1776       return TRUE;
1777     }
1778     return FALSE;
1779   }
1780
1781   /**
1782    * Checks if payment processor supports an account login URL
1783    * TODO: This is checked by self::subscriptionURL but is only used if no entityID is found.
1784    * TODO: It is implemented by AuthorizeNET, any others?
1785    *
1786    * @return bool
1787    */
1788   protected function supportsAccountLoginURL() {
1789     return method_exists(CRM_Utils_System::getClassName($this), 'accountLoginURL');
1790   }
1791
1792   /**
1793    * Should a receipt be sent out for a pending payment.
1794    *
1795    * e.g for traditional pay later & ones with a delayed settlement a pending receipt makes sense.
1796    */
1797   public function isSendReceiptForPending() {
1798     return FALSE;
1799   }
1800
1801 }