Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 | 27 | |
914a49bf | 28 | use Civi\Payment\System; |
353ffa53 | 29 | |
6a488035 | 30 | /** |
3782df3e | 31 | * Class CRM_Core_Payment. |
6a488035 | 32 | * |
3782df3e | 33 | * This class is the main class for the payment processor subsystem. |
6a488035 | 34 | * |
3782df3e EM |
35 | * It is the parent class for payment processors. It also holds some IPN related functions |
36 | * that need to be moved. In particular handlePaymentMethod should be moved to a factory class. | |
6a488035 | 37 | */ |
6a488035 TO |
38 | abstract class CRM_Core_Payment { |
39 | ||
40 | /** | |
100fef9d | 41 | * How are we getting billing information? |
6a488035 TO |
42 | * |
43 | * FORM - we collect it on the same page | |
44 | * BUTTON - the processor collects it and sends it back to us via some protocol | |
45 | */ | |
7da04cde | 46 | const |
6a488035 TO |
47 | BILLING_MODE_FORM = 1, |
48 | BILLING_MODE_BUTTON = 2, | |
49 | BILLING_MODE_NOTIFY = 4; | |
50 | ||
51 | /** | |
100fef9d | 52 | * Which payment type(s) are we using? |
6a488035 TO |
53 | * |
54 | * credit card | |
55 | * direct debit | |
56 | * or both | |
43e5f0f6 | 57 | * @todo create option group - nb omnipay uses a 3rd type - transparent redirect cc |
6a488035 | 58 | */ |
7da04cde | 59 | const |
6a488035 TO |
60 | PAYMENT_TYPE_CREDIT_CARD = 1, |
61 | PAYMENT_TYPE_DIRECT_DEBIT = 2; | |
62 | ||
63 | /** | |
64 | * Subscription / Recurring payment Status | |
65 | * START, END | |
6a488035 | 66 | */ |
7da04cde | 67 | const |
6a488035 TO |
68 | RECURRING_PAYMENT_START = 'START', |
69 | RECURRING_PAYMENT_END = 'END'; | |
70 | ||
353ffa53 | 71 | protected $_paymentProcessor; |
6a488035 TO |
72 | |
73 | /** | |
d09edf64 | 74 | * Singleton function used to manage this object. |
3782df3e | 75 | * |
914a49bf EM |
76 | * We will migrate to calling Civi\Payment\System::singleton()->getByProcessor($paymentProcessor) |
77 | * & Civi\Payment\System::singleton()->getById($paymentProcessor) directly as the main access methods & work | |
78 | * to remove this function all together | |
6a488035 | 79 | * |
6a0b768e TO |
80 | * @param string $mode |
81 | * The mode of operation: live or test. | |
82 | * @param array $paymentProcessor | |
83 | * The details of the payment processor being invoked. | |
84 | * @param object $paymentForm | |
85 | * Deprecated - avoid referring to this if possible. If you have to use it document why as this is scary interaction. | |
86 | * @param bool $force | |
87 | * Should we force a reload of this payment object. | |
88 | * | |
89 | * @return CRM_Core_Payment | |
52767de0 | 90 | * @throws \CRM_Core_Exception |
6a488035 | 91 | */ |
00be9182 | 92 | public static function &singleton($mode = 'test', &$paymentProcessor, &$paymentForm = NULL, $force = FALSE) { |
6a488035 TO |
93 | // make sure paymentProcessor is not empty |
94 | // CRM-7424 | |
95 | if (empty($paymentProcessor)) { | |
96 | return CRM_Core_DAO::$_nullObject; | |
97 | } | |
ef1c2283 EM |
98 | //we use two lines because we can't remove the '&singleton' without risking breakage |
99 | //of extension classes that extend this one | |
353ffa53 | 100 | $object = Civi\Payment\System::singleton()->getByProcessor($paymentProcessor); |
ef1c2283 | 101 | return $object; |
6a488035 TO |
102 | } |
103 | ||
e2bef985 | 104 | /** |
3782df3e EM |
105 | * Log payment notification message to forensic system log. |
106 | * | |
43e5f0f6 | 107 | * @todo move to factory class \Civi\Payment\System (or similar) |
3782df3e EM |
108 | * |
109 | * @param array $params | |
110 | * | |
e2bef985 | 111 | * @return mixed |
112 | */ | |
113 | public static function logPaymentNotification($params) { | |
414e3596 | 114 | $message = 'payment_notification '; |
e2bef985 | 115 | if (!empty($params['processor_name'])) { |
414e3596 | 116 | $message .= 'processor_name=' . $params['processor_name']; |
e2bef985 | 117 | } |
118 | if (!empty($params['processor_id'])) { | |
119 | $message .= 'processor_id=' . $params['processor_id']; | |
120 | } | |
414e3596 | 121 | |
122 | $log = new CRM_Utils_SystemLogger(); | |
123 | $log->alert($message, $_REQUEST); | |
e2bef985 | 124 | } |
125 | ||
fbcb6fba | 126 | /** |
d09edf64 | 127 | * Check if capability is supported. |
3782df3e EM |
128 | * |
129 | * Capabilities have a one to one relationship with capability-related functions on this class. | |
130 | * | |
131 | * Payment processor classes should over-ride the capability-specific function rather than this one. | |
132 | * | |
6a0b768e TO |
133 | * @param string $capability |
134 | * E.g BackOffice, LiveMode, FutureRecurStartDate. | |
fbcb6fba EM |
135 | * |
136 | * @return bool | |
137 | */ | |
138 | public function supports($capability) { | |
139 | $function = 'supports' . ucfirst($capability); | |
140 | if (method_exists($this, $function)) { | |
141 | return $this->$function(); | |
142 | } | |
143 | return FALSE; | |
144 | } | |
145 | ||
146 | /** | |
3782df3e EM |
147 | * Are back office payments supported. |
148 | * | |
149 | * e.g paypal standard won't permit you to enter a credit card associated | |
150 | * with someone else's login. | |
151 | * The intention is to support off-site (other than paypal) & direct debit but that is not all working yet so to | |
152 | * reach a 'stable' point we disable. | |
153 | * | |
fbcb6fba EM |
154 | * @return bool |
155 | */ | |
d8ce0d68 | 156 | protected function supportsBackOffice() { |
9c39fb25 EM |
157 | if ($this->_paymentProcessor['billing_mode'] == 4 || $this->_paymentProcessor['payment_type'] != 1) { |
158 | return FALSE; | |
159 | } | |
160 | else { | |
161 | return TRUE; | |
162 | } | |
fbcb6fba EM |
163 | } |
164 | ||
165 | /** | |
3782df3e EM |
166 | * Are live payments supported - e.g dummy doesn't support this. |
167 | * | |
fbcb6fba EM |
168 | * @return bool |
169 | */ | |
d8ce0d68 | 170 | protected function supportsLiveMode() { |
fbcb6fba EM |
171 | return TRUE; |
172 | } | |
173 | ||
52767de0 | 174 | /** |
d09edf64 | 175 | * Are test payments supported. |
3782df3e | 176 | * |
52767de0 EM |
177 | * @return bool |
178 | */ | |
179 | protected function supportsTestMode() { | |
180 | return TRUE; | |
181 | } | |
182 | ||
fbcb6fba | 183 | /** |
d09edf64 | 184 | * Should the first payment date be configurable when setting up back office recurring payments. |
3782df3e | 185 | * |
fbcb6fba | 186 | * We set this to false for historical consistency but in fact most new processors use tokens for recurring and can support this |
3782df3e | 187 | * |
fbcb6fba EM |
188 | * @return bool |
189 | */ | |
d8ce0d68 | 190 | protected function supportsFutureRecurStartDate() { |
fbcb6fba EM |
191 | return FALSE; |
192 | } | |
193 | ||
6a488035 | 194 | /** |
3782df3e EM |
195 | * Default payment instrument validation. |
196 | * | |
a479fe60 | 197 | * Implement the usual Luhn algorithm via a static function in the CRM_Core_Payment_Form if it's a credit card |
3782df3e EM |
198 | * Not a static function, because I need to check for payment_type. |
199 | * | |
200 | * @param array $values | |
201 | * @param array $errors | |
a479fe60 | 202 | */ |
203 | public function validatePaymentInstrument($values, &$errors) { | |
204 | if ($this->_paymentProcessor['payment_type'] == 1) { | |
205 | CRM_Core_Payment_Form::validateCreditCard($values, $errors); | |
206 | } | |
207 | } | |
208 | ||
6a488035 | 209 | /** |
3782df3e EM |
210 | * Setter for the payment form that wants to use the processor. |
211 | * | |
43e5f0f6 | 212 | * @deprecated |
3782df3e | 213 | * |
ac32ed13 | 214 | * @param CRM_Core_Form $paymentForm |
6a488035 | 215 | */ |
00be9182 | 216 | public function setForm(&$paymentForm) { |
6a488035 TO |
217 | $this->_paymentForm = $paymentForm; |
218 | } | |
219 | ||
220 | /** | |
d09edf64 | 221 | * Getter for payment form that is using the processor. |
43e5f0f6 | 222 | * @deprecated |
16b10e64 CW |
223 | * @return CRM_Core_Form |
224 | * A form object | |
6a488035 | 225 | */ |
00be9182 | 226 | public function getForm() { |
6a488035 TO |
227 | return $this->_paymentForm; |
228 | } | |
229 | ||
230 | /** | |
d09edf64 | 231 | * Getter for accessing member vars. |
6c99ada1 | 232 | * |
43e5f0f6 | 233 | * @todo believe this is unused |
6c99ada1 | 234 | * |
100fef9d | 235 | * @param string $name |
dc913073 EM |
236 | * |
237 | * @return null | |
6a488035 | 238 | */ |
00be9182 | 239 | public function getVar($name) { |
6a488035 TO |
240 | return isset($this->$name) ? $this->$name : NULL; |
241 | } | |
242 | ||
dc913073 | 243 | /** |
d09edf64 | 244 | * Get name for the payment information type. |
43e5f0f6 | 245 | * @todo - use option group + name field (like Omnipay does) |
dc913073 EM |
246 | * @return string |
247 | */ | |
248 | public function getPaymentTypeName() { | |
459091e1 | 249 | return $this->_paymentProcessor['payment_type'] == 1 ? 'credit_card' : 'direct_debit'; |
dc913073 EM |
250 | } |
251 | ||
252 | /** | |
d09edf64 | 253 | * Get label for the payment information type. |
43e5f0f6 | 254 | * @todo - use option group + labels (like Omnipay does) |
dc913073 EM |
255 | * @return string |
256 | */ | |
257 | public function getPaymentTypeLabel() { | |
459091e1 | 258 | return $this->_paymentProcessor['payment_type'] == 1 ? 'Credit Card' : 'Direct Debit'; |
dc913073 EM |
259 | } |
260 | ||
44b6505d | 261 | /** |
d09edf64 | 262 | * Get array of fields that should be displayed on the payment form. |
44b6505d EM |
263 | * @todo make payment type an option value & use it in the function name - currently on debit & credit card work |
264 | * @return array | |
265 | * @throws CiviCRM_API3_Exception | |
266 | */ | |
267 | public function getPaymentFormFields() { | |
dc913073 | 268 | if ($this->_paymentProcessor['billing_mode'] == 4) { |
44b6505d EM |
269 | return array(); |
270 | } | |
271 | return $this->_paymentProcessor['payment_type'] == 1 ? $this->getCreditCardFormFields() : $this->getDirectDebitFormFields(); | |
272 | } | |
273 | ||
274 | /** | |
d09edf64 | 275 | * Get array of fields that should be displayed on the payment form for credit cards. |
dc913073 | 276 | * |
44b6505d EM |
277 | * @return array |
278 | */ | |
279 | protected function getCreditCardFormFields() { | |
280 | return array( | |
281 | 'credit_card_type', | |
282 | 'credit_card_number', | |
283 | 'cvv2', | |
284 | 'credit_card_exp_date', | |
285 | ); | |
286 | } | |
287 | ||
288 | /** | |
d09edf64 | 289 | * Get array of fields that should be displayed on the payment form for direct debits. |
dc913073 | 290 | * |
44b6505d EM |
291 | * @return array |
292 | */ | |
293 | protected function getDirectDebitFormFields() { | |
294 | return array( | |
295 | 'account_holder', | |
296 | 'bank_account_number', | |
297 | 'bank_identification_number', | |
298 | 'bank_name', | |
299 | ); | |
300 | } | |
301 | ||
dc913073 | 302 | /** |
d09edf64 | 303 | * Return an array of all the details about the fields potentially required for payment fields. |
3782df3e | 304 | * |
dc913073 EM |
305 | * Only those determined by getPaymentFormFields will actually be assigned to the form |
306 | * | |
a6c01b45 CW |
307 | * @return array |
308 | * field metadata | |
dc913073 EM |
309 | */ |
310 | public function getPaymentFormFieldsMetadata() { | |
311 | //@todo convert credit card type into an option value | |
312 | $creditCardType = array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::creditCard(); | |
313 | return array( | |
314 | 'credit_card_number' => array( | |
315 | 'htmlType' => 'text', | |
316 | 'name' => 'credit_card_number', | |
317 | 'title' => ts('Card Number'), | |
318 | 'cc_field' => TRUE, | |
319 | 'attributes' => array( | |
320 | 'size' => 20, | |
321 | 'maxlength' => 20, | |
21dfd5f5 | 322 | 'autocomplete' => 'off', |
f803aacb | 323 | 'class' => 'creditcard', |
dc913073 EM |
324 | ), |
325 | 'is_required' => TRUE, | |
326 | ), | |
327 | 'cvv2' => array( | |
328 | 'htmlType' => 'text', | |
329 | 'name' => 'cvv2', | |
330 | 'title' => ts('Security Code'), | |
331 | 'cc_field' => TRUE, | |
332 | 'attributes' => array( | |
333 | 'size' => 5, | |
334 | 'maxlength' => 10, | |
21dfd5f5 | 335 | 'autocomplete' => 'off', |
dc913073 EM |
336 | ), |
337 | 'is_required' => CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, | |
338 | 'cvv_backoffice_required', | |
339 | NULL, | |
340 | 1 | |
341 | ), | |
342 | 'rules' => array( | |
343 | array( | |
344 | '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.'), | |
345 | 'rule_name' => 'integer', | |
346 | 'rule_parameters' => NULL, | |
7c550ca0 | 347 | ), |
353ffa53 | 348 | ), |
dc913073 EM |
349 | ), |
350 | 'credit_card_exp_date' => array( | |
351 | 'htmlType' => 'date', | |
352 | 'name' => 'credit_card_exp_date', | |
353 | 'title' => ts('Expiration Date'), | |
354 | 'cc_field' => TRUE, | |
355 | 'attributes' => CRM_Core_SelectValues::date('creditCard'), | |
356 | 'is_required' => TRUE, | |
357 | 'rules' => array( | |
358 | array( | |
359 | 'rule_message' => ts('Card expiration date cannot be a past date.'), | |
360 | 'rule_name' => 'currentDate', | |
361 | 'rule_parameters' => TRUE, | |
7c550ca0 | 362 | ), |
353ffa53 | 363 | ), |
dc913073 EM |
364 | ), |
365 | 'credit_card_type' => array( | |
366 | 'htmlType' => 'select', | |
367 | 'name' => 'credit_card_type', | |
368 | 'title' => ts('Card Type'), | |
369 | 'cc_field' => TRUE, | |
370 | 'attributes' => $creditCardType, | |
371 | 'is_required' => FALSE, | |
372 | ), | |
373 | 'account_holder' => array( | |
374 | 'htmlType' => 'text', | |
375 | 'name' => 'account_holder', | |
376 | 'title' => ts('Account Holder'), | |
377 | 'cc_field' => TRUE, | |
378 | 'attributes' => array( | |
379 | 'size' => 20, | |
380 | 'maxlength' => 34, | |
21dfd5f5 | 381 | 'autocomplete' => 'on', |
dc913073 EM |
382 | ), |
383 | 'is_required' => TRUE, | |
384 | ), | |
385 | //e.g. IBAN can have maxlength of 34 digits | |
386 | 'bank_account_number' => array( | |
387 | 'htmlType' => 'text', | |
388 | 'name' => 'bank_account_number', | |
389 | 'title' => ts('Bank Account Number'), | |
390 | 'cc_field' => TRUE, | |
391 | 'attributes' => array( | |
392 | 'size' => 20, | |
393 | 'maxlength' => 34, | |
21dfd5f5 | 394 | 'autocomplete' => 'off', |
dc913073 EM |
395 | ), |
396 | 'rules' => array( | |
397 | array( | |
398 | 'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'), | |
399 | 'rule_name' => 'nopunctuation', | |
400 | 'rule_parameters' => NULL, | |
7c550ca0 | 401 | ), |
353ffa53 | 402 | ), |
dc913073 EM |
403 | 'is_required' => TRUE, |
404 | ), | |
405 | //e.g. SWIFT-BIC can have maxlength of 11 digits | |
406 | 'bank_identification_number' => array( | |
407 | 'htmlType' => 'text', | |
408 | 'name' => 'bank_identification_number', | |
409 | 'title' => ts('Bank Identification Number'), | |
410 | 'cc_field' => TRUE, | |
411 | 'attributes' => array( | |
412 | 'size' => 20, | |
413 | 'maxlength' => 11, | |
21dfd5f5 | 414 | 'autocomplete' => 'off', |
dc913073 EM |
415 | ), |
416 | 'is_required' => TRUE, | |
417 | 'rules' => array( | |
418 | array( | |
419 | 'rule_message' => ts('Please enter a valid Bank Identification Number (value must not contain punctuation characters).'), | |
420 | 'rule_name' => 'nopunctuation', | |
421 | 'rule_parameters' => NULL, | |
7c550ca0 | 422 | ), |
353ffa53 | 423 | ), |
dc913073 EM |
424 | ), |
425 | 'bank_name' => array( | |
426 | 'htmlType' => 'text', | |
427 | 'name' => 'bank_name', | |
428 | 'title' => ts('Bank Name'), | |
429 | 'cc_field' => TRUE, | |
430 | 'attributes' => array( | |
431 | 'size' => 20, | |
432 | 'maxlength' => 64, | |
21dfd5f5 | 433 | 'autocomplete' => 'off', |
dc913073 EM |
434 | ), |
435 | 'is_required' => TRUE, | |
436 | ||
21dfd5f5 | 437 | ), |
dc913073 EM |
438 | ); |
439 | } | |
44b6505d | 440 | |
6a488035 | 441 | /** |
8319cf11 EM |
442 | * Calling this from outside the payment subsystem is deprecated - use doPayment. |
443 | * | |
444 | * Does a server to server payment transaction. | |
445 | * | |
446 | * Note that doPayment will throw an exception so the code may need to be modified | |
6a488035 | 447 | * |
6a0b768e TO |
448 | * @param array $params |
449 | * Assoc array of input parameters for this transaction. | |
6a488035 | 450 | * |
a6c01b45 CW |
451 | * @return array |
452 | * the result in an nice formatted array (or an error object) | |
6a488035 TO |
453 | * @abstract |
454 | */ | |
7c550ca0 | 455 | abstract protected function doDirectPayment(&$params); |
6a488035 | 456 | |
c1cc3e0c | 457 | /** |
6c99ada1 EM |
458 | * Process payment - this function wraps around both doTransferPayment and doDirectPayment. |
459 | * | |
460 | * The function ensures an exception is thrown & moves some of this logic out of the form layer and makes the forms | |
461 | * more agnostic. | |
c1cc3e0c EM |
462 | * |
463 | * @param array $params | |
464 | * | |
465 | * @param $component | |
466 | * | |
a6c01b45 CW |
467 | * @return array |
468 | * (modified) | |
c1cc3e0c EM |
469 | * @throws CRM_Core_Exception |
470 | */ | |
8319cf11 | 471 | public function doPayment(&$params, $component = 'contribute') { |
c1cc3e0c EM |
472 | if ($this->_paymentProcessor['billing_mode'] == 4) { |
473 | $result = $this->doTransferCheckout($params, $component); | |
474 | } | |
475 | else { | |
476 | $result = $this->doDirectPayment($params, $component); | |
477 | } | |
478 | if (is_a($result, 'CRM_Core_Error')) { | |
479 | throw new CRM_Core_Exception(CRM_Core_Error::getMessages($result)); | |
480 | } | |
a9cf9972 | 481 | //CRM-15767 - Submit Credit Card Contribution not being saved |
482 | return $result; | |
c1cc3e0c EM |
483 | } |
484 | ||
6a488035 | 485 | /** |
d09edf64 | 486 | * This function checks to see if we have the right config values. |
6a488035 | 487 | * |
a6c01b45 CW |
488 | * @return string |
489 | * the error message if any | |
6a488035 | 490 | */ |
7c550ca0 | 491 | abstract protected function checkConfig(); |
6a488035 | 492 | |
a0ee3941 | 493 | /** |
6c99ada1 EM |
494 | * Redirect for paypal. |
495 | * | |
496 | * @todo move to paypal class or remove | |
497 | * | |
a0ee3941 | 498 | * @param $paymentProcessor |
6c99ada1 | 499 | * |
a0ee3941 EM |
500 | * @return bool |
501 | */ | |
00be9182 | 502 | public static function paypalRedirect(&$paymentProcessor) { |
6a488035 TO |
503 | if (!$paymentProcessor) { |
504 | return FALSE; | |
505 | } | |
506 | ||
507 | if (isset($_GET['payment_date']) && | |
508 | isset($_GET['merchant_return_link']) && | |
509 | CRM_Utils_Array::value('payment_status', $_GET) == 'Completed' && | |
510 | $paymentProcessor['payment_processor_type'] == "PayPal_Standard" | |
511 | ) { | |
512 | return TRUE; | |
513 | } | |
514 | ||
515 | return FALSE; | |
516 | } | |
517 | ||
518 | /** | |
6c99ada1 EM |
519 | * Handle incoming payment notification. |
520 | * | |
521 | * IPNs, also called silent posts are notifications of payment outcomes or activity on an external site. | |
522 | * | |
43e5f0f6 | 523 | * @todo move to0 \Civi\Payment\System factory method |
6a488035 | 524 | * Page callback for civicrm/payment/ipn |
6a488035 | 525 | */ |
00be9182 | 526 | public static function handleIPN() { |
6a488035 TO |
527 | self::handlePaymentMethod( |
528 | 'PaymentNotification', | |
529 | array( | |
530 | 'processor_name' => @$_GET['processor_name'], | |
42b90e8f | 531 | 'processor_id' => @$_GET['processor_id'], |
6a488035 TO |
532 | 'mode' => @$_GET['mode'], |
533 | ) | |
534 | ); | |
160c9df2 | 535 | CRM_Utils_System::civiExit(); |
6a488035 TO |
536 | } |
537 | ||
538 | /** | |
3782df3e EM |
539 | * Payment callback handler. |
540 | * | |
541 | * The processor_name or processor_id is passed in. | |
43d1ae00 EM |
542 | * Note that processor_id is more reliable as one site may have more than one instance of a |
543 | * processor & ideally the processor will be validating the results | |
6a488035 TO |
544 | * Load requested payment processor and call that processor's handle<$method> method |
545 | * | |
3782df3e EM |
546 | * @todo move to \Civi\Payment\System factory method |
547 | * | |
548 | * @param string $method | |
549 | * 'PaymentNotification' or 'PaymentCron' | |
4691b077 | 550 | * @param array $params |
6a488035 | 551 | */ |
00be9182 | 552 | public static function handlePaymentMethod($method, $params = array()) { |
42b90e8f CB |
553 | if (!isset($params['processor_id']) && !isset($params['processor_name'])) { |
554 | CRM_Core_Error::fatal("Either 'processor_id' or 'processor_name' param is required for payment callback"); | |
6a488035 | 555 | } |
e2bef985 | 556 | self::logPaymentNotification($params); |
6a488035 | 557 | |
42b90e8f CB |
558 | $sql = "SELECT ppt.class_name, ppt.name as processor_name, pp.id AS processor_id |
559 | FROM civicrm_payment_processor_type ppt | |
560 | INNER JOIN civicrm_payment_processor pp | |
561 | ON pp.payment_processor_type_id = ppt.id | |
9ff0c7a1 | 562 | AND pp.is_active"; |
42b90e8f CB |
563 | |
564 | if (isset($params['processor_id'])) { | |
565 | $sql .= " WHERE pp.id = %2"; | |
566 | $args[2] = array($params['processor_id'], 'Integer'); | |
3782df3e | 567 | $notFound = "No active instances of payment processor ID#'{$params['processor_id']}' were found."; |
42b90e8f CB |
568 | } |
569 | else { | |
9ff0c7a1 EM |
570 | // This is called when processor_name is passed - passing processor_id instead is recommended. |
571 | $sql .= " WHERE ppt.name = %2 AND pp.is_test = %1"; | |
6c99ada1 EM |
572 | $args[1] = array( |
573 | (CRM_Utils_Array::value('mode', $params) == 'test') ? 1 : 0, | |
574 | 'Integer', | |
575 | ); | |
42b90e8f | 576 | $args[2] = array($params['processor_name'], 'String'); |
3782df3e | 577 | $notFound = "No active instances of the '{$params['processor_name']}' payment processor were found."; |
42b90e8f CB |
578 | } |
579 | ||
580 | $dao = CRM_Core_DAO::executeQuery($sql, $args); | |
6a488035 | 581 | |
3782df3e | 582 | // Check whether we found anything at all. |
6a488035 | 583 | if (!$dao->N) { |
3782df3e | 584 | CRM_Core_Error::fatal($notFound); |
6a488035 TO |
585 | } |
586 | ||
587 | $method = 'handle' . $method; | |
588 | $extension_instance_found = FALSE; | |
589 | ||
590 | // In all likelihood, we'll just end up with the one instance returned here. But it's | |
591 | // possible we may get more. Hence, iterate through all instances .. | |
592 | ||
593 | while ($dao->fetch()) { | |
594 | // Check pp is extension | |
595 | $ext = CRM_Extension_System::singleton()->getMapper(); | |
596 | if ($ext->isExtensionKey($dao->class_name)) { | |
6a488035 TO |
597 | $paymentClass = $ext->keyToClass($dao->class_name, 'payment'); |
598 | require_once $ext->classToPath($paymentClass); | |
599 | } | |
600 | else { | |
43d1ae00 | 601 | // Legacy or extension as module instance |
d031c654 | 602 | if (empty($paymentClass)) { |
43d1ae00 EM |
603 | $paymentClass = 'CRM_Core_' . $dao->class_name; |
604 | ||
605 | } | |
6a488035 TO |
606 | } |
607 | ||
b47b1631 | 608 | $processorInstance = Civi\Payment\System::singleton()->getById($dao->processor_id); |
6a488035 TO |
609 | |
610 | // Should never be empty - we already established this processor_id exists and is active. | |
81ebda7b | 611 | if (empty($processorInstance)) { |
6a488035 TO |
612 | continue; |
613 | } | |
614 | ||
6a488035 TO |
615 | // Does PP implement this method, and can we call it? |
616 | if (!method_exists($processorInstance, $method) || | |
617 | !is_callable(array($processorInstance, $method)) | |
618 | ) { | |
43d1ae00 EM |
619 | // on the off chance there is a double implementation of this processor we should keep looking for another |
620 | // note that passing processor_id is more reliable & we should work to deprecate processor_name | |
621 | continue; | |
6a488035 TO |
622 | } |
623 | ||
624 | // Everything, it seems, is ok - execute pp callback handler | |
625 | $processorInstance->$method(); | |
a5ef96f6 | 626 | $extension_instance_found = TRUE; |
6a488035 TO |
627 | } |
628 | ||
4f99ca55 TO |
629 | if (!$extension_instance_found) { |
630 | CRM_Core_Error::fatal( | |
631 | "No extension instances of the '{$params['processor_name']}' payment processor were found.<br />" . | |
632 | "$method method is unsupported in legacy payment processors." | |
2aa397bc TO |
633 | ); |
634 | } | |
6a488035 TO |
635 | } |
636 | ||
637 | /** | |
100fef9d | 638 | * Check whether a method is present ( & supported ) by the payment processor object. |
6a488035 | 639 | * |
6a0b768e TO |
640 | * @param string $method |
641 | * Method to check for. | |
6a488035 | 642 | * |
7c550ca0 | 643 | * @return bool |
6a488035 | 644 | */ |
00be9182 | 645 | public function isSupported($method = 'cancelSubscription') { |
6a488035 TO |
646 | return method_exists(CRM_Utils_System::getClassName($this), $method); |
647 | } | |
648 | ||
a0ee3941 | 649 | /** |
3782df3e EM |
650 | * Get url for users to manage this recurring contribution for this processor. |
651 | * | |
100fef9d | 652 | * @param int $entityID |
a0ee3941 EM |
653 | * @param null $entity |
654 | * @param string $action | |
655 | * | |
656 | * @return string | |
657 | */ | |
00be9182 | 658 | public function subscriptionURL($entityID = NULL, $entity = NULL, $action = 'cancel') { |
03cfff4c KW |
659 | // Set URL |
660 | switch ($action) { | |
2aa397bc | 661 | case 'cancel': |
03cfff4c KW |
662 | $url = 'civicrm/contribute/unsubscribe'; |
663 | break; | |
2aa397bc TO |
664 | |
665 | case 'billing': | |
03cfff4c | 666 | //in notify mode don't return the update billing url |
68acd6ae | 667 | if (!$this->isSupported('updateSubscriptionBillingInfo')) { |
03cfff4c KW |
668 | return NULL; |
669 | } | |
68acd6ae | 670 | $url = 'civicrm/contribute/updatebilling'; |
03cfff4c | 671 | break; |
2aa397bc TO |
672 | |
673 | case 'update': | |
03cfff4c KW |
674 | $url = 'civicrm/contribute/updaterecur'; |
675 | break; | |
6a488035 TO |
676 | } |
677 | ||
353ffa53 TO |
678 | $session = CRM_Core_Session::singleton(); |
679 | $userId = $session->get('userID'); | |
680 | $contactID = 0; | |
03cfff4c | 681 | $checksumValue = ''; |
353ffa53 | 682 | $entityArg = ''; |
03cfff4c KW |
683 | |
684 | // Find related Contact | |
685 | if ($entityID) { | |
686 | switch ($entity) { | |
2aa397bc | 687 | case 'membership': |
03cfff4c KW |
688 | $contactID = CRM_Core_DAO::getFieldValue("CRM_Member_DAO_Membership", $entityID, "contact_id"); |
689 | $entityArg = 'mid'; | |
690 | break; | |
691 | ||
2aa397bc | 692 | case 'contribution': |
03cfff4c KW |
693 | $contactID = CRM_Core_DAO::getFieldValue("CRM_Contribute_DAO_Contribution", $entityID, "contact_id"); |
694 | $entityArg = 'coid'; | |
695 | break; | |
696 | ||
2aa397bc | 697 | case 'recur': |
03cfff4c | 698 | $sql = " |
6a488035 TO |
699 | SELECT con.contact_id |
700 | FROM civicrm_contribution_recur rec | |
701 | INNER JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id ) | |
702 | WHERE rec.id = %1 | |
703 | GROUP BY rec.id"; | |
03cfff4c KW |
704 | $contactID = CRM_Core_DAO::singleValueQuery($sql, array(1 => array($entityID, 'Integer'))); |
705 | $entityArg = 'crid'; | |
706 | break; | |
6a488035 | 707 | } |
6a488035 TO |
708 | } |
709 | ||
03cfff4c KW |
710 | // Add entity arguments |
711 | if ($entityArg != '') { | |
712 | // Add checksum argument | |
713 | if ($contactID != 0 && $userId != $contactID) { | |
714 | $checksumValue = '&cs=' . CRM_Contact_BAO_Contact_Utils::generateChecksum($contactID, NULL, 'inf'); | |
715 | } | |
716 | return CRM_Utils_System::url($url, "reset=1&{$entityArg}={$entityID}{$checksumValue}", TRUE, NULL, FALSE, TRUE); | |
717 | } | |
718 | ||
719 | // Else login URL | |
6a488035 TO |
720 | if ($this->isSupported('accountLoginURL')) { |
721 | return $this->accountLoginURL(); | |
722 | } | |
03cfff4c KW |
723 | |
724 | // Else default | |
6a488035 TO |
725 | return $this->_paymentProcessor['url_recur']; |
726 | } | |
96025800 | 727 | |
6a488035 | 728 | } |