CRM/Core/Payment.php

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