CRM/Core/Payment.php

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