Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | abstract class CRM_Core_Payment { | |
37 | ||
38 | /** | |
39 | * how are we getting billing information? | |
40 | * | |
41 | * FORM - we collect it on the same page | |
42 | * BUTTON - the processor collects it and sends it back to us via some protocol | |
43 | */ | |
44 | CONST | |
45 | BILLING_MODE_FORM = 1, | |
46 | BILLING_MODE_BUTTON = 2, | |
47 | BILLING_MODE_NOTIFY = 4; | |
48 | ||
49 | /** | |
50 | * which payment type(s) are we using? | |
51 | * | |
52 | * credit card | |
53 | * direct debit | |
54 | * or both | |
55 | * | |
56 | */ | |
57 | CONST | |
58 | PAYMENT_TYPE_CREDIT_CARD = 1, | |
59 | PAYMENT_TYPE_DIRECT_DEBIT = 2; | |
60 | ||
61 | /** | |
62 | * Subscription / Recurring payment Status | |
63 | * START, END | |
64 | * | |
65 | */ | |
66 | CONST | |
67 | RECURRING_PAYMENT_START = 'START', | |
68 | RECURRING_PAYMENT_END = 'END'; | |
69 | ||
70 | /** | |
71 | * We only need one instance of this object. So we use the singleton | |
72 | * pattern and cache the instance in this variable | |
73 | * | |
74 | * @var object | |
75 | * @static | |
76 | */ | |
77 | static private $_singleton = NULL; | |
78 | ||
79 | protected $_paymentProcessor; | |
80 | ||
ac32ed13 EM |
81 | /** |
82 | * @var CRM_Core_Form | |
83 | */ | |
6a488035 TO |
84 | protected $_paymentForm = NULL; |
85 | ||
86 | /** | |
87 | * singleton function used to manage this object | |
88 | * | |
89 | * @param string $mode the mode of operation: live or test | |
d77a0a58 | 90 | * @param array $paymentProcessor the details of the payment processor being invoked |
6a488035 TO |
91 | * @param object $paymentForm reference to the form object if available |
92 | * @param boolean $force should we force a reload of this payment object | |
93 | * | |
94 | * @return object | |
95 | * @static | |
96 | * | |
97 | */ | |
98 | static function &singleton($mode = 'test', &$paymentProcessor, &$paymentForm = NULL, $force = FALSE) { | |
99 | // make sure paymentProcessor is not empty | |
100 | // CRM-7424 | |
101 | if (empty($paymentProcessor)) { | |
102 | return CRM_Core_DAO::$_nullObject; | |
103 | } | |
104 | ||
105 | $cacheKey = "{$mode}_{$paymentProcessor['id']}_" . (int)isset($paymentForm); | |
106 | if (!isset(self::$_singleton[$cacheKey]) || $force) { | |
107 | $config = CRM_Core_Config::singleton(); | |
108 | $ext = CRM_Extension_System::singleton()->getMapper(); | |
109 | if ($ext->isExtensionKey($paymentProcessor['class_name'])) { | |
110 | $paymentClass = $ext->keyToClass($paymentProcessor['class_name'], 'payment'); | |
111 | require_once ($ext->classToPath($paymentClass)); | |
112 | } | |
113 | else { | |
114 | $paymentClass = 'CRM_Core_' . $paymentProcessor['class_name']; | |
115 | require_once (str_replace('_', DIRECTORY_SEPARATOR, $paymentClass) . '.php'); | |
116 | } | |
117 | ||
118 | //load the object. | |
0e6e8724 | 119 | self::$_singleton[$cacheKey] = $paymentClass::singleton($mode, $paymentProcessor); |
6a488035 TO |
120 | } |
121 | ||
122 | //load the payment form for required processor. | |
123 | if ($paymentForm !== NULL) { | |
124 | self::$_singleton[$cacheKey]->setForm($paymentForm); | |
125 | } | |
126 | ||
127 | return self::$_singleton[$cacheKey]; | |
128 | } | |
129 | ||
e2bef985 | 130 | /** |
131 | * @param $params | |
132 | * | |
133 | * @return mixed | |
134 | */ | |
135 | public static function logPaymentNotification($params) { | |
414e3596 | 136 | $message = 'payment_notification '; |
e2bef985 | 137 | if (!empty($params['processor_name'])) { |
414e3596 | 138 | $message .= 'processor_name=' . $params['processor_name']; |
e2bef985 | 139 | } |
140 | if (!empty($params['processor_id'])) { | |
141 | $message .= 'processor_id=' . $params['processor_id']; | |
142 | } | |
414e3596 | 143 | |
144 | $log = new CRM_Utils_SystemLogger(); | |
145 | $log->alert($message, $_REQUEST); | |
e2bef985 | 146 | } |
147 | ||
6a488035 TO |
148 | /** |
149 | * Setter for the payment form that wants to use the processor | |
150 | * | |
ac32ed13 | 151 | * @param CRM_Core_Form $paymentForm |
6a488035 TO |
152 | * |
153 | */ | |
154 | function setForm(&$paymentForm) { | |
155 | $this->_paymentForm = $paymentForm; | |
156 | } | |
157 | ||
158 | /** | |
159 | * Getter for payment form that is using the processor | |
160 | * | |
ac32ed13 | 161 | * @return CRM_Core_Form A form object |
6a488035 TO |
162 | */ |
163 | function getForm() { | |
164 | return $this->_paymentForm; | |
165 | } | |
166 | ||
167 | /** | |
168 | * Getter for accessing member vars | |
169 | * | |
170 | */ | |
171 | function getVar($name) { | |
172 | return isset($this->$name) ? $this->$name : NULL; | |
173 | } | |
174 | ||
175 | /** | |
176 | * This function collects all the information from a web/api form and invokes | |
177 | * the relevant payment processor specific functions to perform the transaction | |
178 | * | |
179 | * @param array $params assoc array of input parameters for this transaction | |
180 | * | |
181 | * @return array the result in an nice formatted array (or an error object) | |
182 | * @abstract | |
183 | */ | |
184 | abstract function doDirectPayment(&$params); | |
185 | ||
186 | /** | |
187 | * This function checks to see if we have the right config values | |
188 | * | |
414e3596 | 189 | * @internal param string $mode the mode we are operating in (live or test) |
6a488035 TO |
190 | * |
191 | * @return string the error message if any | |
192 | * @public | |
193 | */ | |
194 | abstract function checkConfig(); | |
195 | ||
a0ee3941 EM |
196 | /** |
197 | * @param $paymentProcessor | |
198 | * | |
199 | * @return bool | |
200 | */ | |
6a488035 TO |
201 | static function paypalRedirect(&$paymentProcessor) { |
202 | if (!$paymentProcessor) { | |
203 | return FALSE; | |
204 | } | |
205 | ||
206 | if (isset($_GET['payment_date']) && | |
207 | isset($_GET['merchant_return_link']) && | |
208 | CRM_Utils_Array::value('payment_status', $_GET) == 'Completed' && | |
209 | $paymentProcessor['payment_processor_type'] == "PayPal_Standard" | |
210 | ) { | |
211 | return TRUE; | |
212 | } | |
213 | ||
214 | return FALSE; | |
215 | } | |
216 | ||
217 | /** | |
218 | * Page callback for civicrm/payment/ipn | |
219 | * @public | |
220 | */ | |
221 | static function handleIPN() { | |
222 | self::handlePaymentMethod( | |
223 | 'PaymentNotification', | |
224 | array( | |
225 | 'processor_name' => @$_GET['processor_name'], | |
42b90e8f | 226 | 'processor_id' => @$_GET['processor_id'], |
6a488035 TO |
227 | 'mode' => @$_GET['mode'], |
228 | ) | |
229 | ); | |
230 | } | |
231 | ||
232 | /** | |
43d1ae00 EM |
233 | * Payment callback handler. The processor_name or processor_id is passed in. |
234 | * Note that processor_id is more reliable as one site may have more than one instance of a | |
235 | * processor & ideally the processor will be validating the results | |
6a488035 TO |
236 | * Load requested payment processor and call that processor's handle<$method> method |
237 | * | |
238 | * @public | |
4691b077 EM |
239 | * @param $method |
240 | * @param array $params | |
6a488035 | 241 | */ |
4691b077 | 242 | static function handlePaymentMethod($method, $params = array()) { |
42b90e8f CB |
243 | if (!isset($params['processor_id']) && !isset($params['processor_name'])) { |
244 | CRM_Core_Error::fatal("Either 'processor_id' or 'processor_name' param is required for payment callback"); | |
6a488035 | 245 | } |
e2bef985 | 246 | self::logPaymentNotification($params); |
6a488035 TO |
247 | |
248 | // Query db for processor .. | |
249 | $mode = @$params['mode']; | |
250 | ||
42b90e8f CB |
251 | $sql = "SELECT ppt.class_name, ppt.name as processor_name, pp.id AS processor_id |
252 | FROM civicrm_payment_processor_type ppt | |
253 | INNER JOIN civicrm_payment_processor pp | |
254 | ON pp.payment_processor_type_id = ppt.id | |
255 | AND pp.is_active | |
256 | AND pp.is_test = %1"; | |
257 | $args[1] = array($mode == 'test' ? 1 : 0, 'Integer'); | |
258 | ||
259 | if (isset($params['processor_id'])) { | |
260 | $sql .= " WHERE pp.id = %2"; | |
261 | $args[2] = array($params['processor_id'], 'Integer'); | |
262 | $notfound = "No active instances of payment processor ID#'{$params['processor_id']}' were found."; | |
263 | } | |
264 | else { | |
265 | $sql .= " WHERE ppt.name = %2"; | |
266 | $args[2] = array($params['processor_name'], 'String'); | |
267 | $notfound = "No active instances of the '{$params['processor_name']}' payment processor were found."; | |
268 | } | |
269 | ||
270 | $dao = CRM_Core_DAO::executeQuery($sql, $args); | |
6a488035 TO |
271 | |
272 | // Check whether we found anything at all .. | |
273 | if (!$dao->N) { | |
42b90e8f | 274 | CRM_Core_Error::fatal($notfound); |
6a488035 TO |
275 | } |
276 | ||
277 | $method = 'handle' . $method; | |
278 | $extension_instance_found = FALSE; | |
279 | ||
280 | // In all likelihood, we'll just end up with the one instance returned here. But it's | |
281 | // possible we may get more. Hence, iterate through all instances .. | |
282 | ||
283 | while ($dao->fetch()) { | |
284 | // Check pp is extension | |
285 | $ext = CRM_Extension_System::singleton()->getMapper(); | |
286 | if ($ext->isExtensionKey($dao->class_name)) { | |
6a488035 TO |
287 | $paymentClass = $ext->keyToClass($dao->class_name, 'payment'); |
288 | require_once $ext->classToPath($paymentClass); | |
289 | } | |
290 | else { | |
43d1ae00 | 291 | // Legacy or extension as module instance |
d031c654 | 292 | if (empty($paymentClass)) { |
43d1ae00 EM |
293 | $paymentClass = 'CRM_Core_' . $dao->class_name; |
294 | ||
295 | } | |
6a488035 TO |
296 | } |
297 | ||
298 | $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($dao->processor_id, $mode); | |
299 | ||
300 | // Should never be empty - we already established this processor_id exists and is active. | |
301 | if (empty($paymentProcessor)) { | |
302 | continue; | |
303 | } | |
304 | ||
305 | // Instantiate PP | |
0e6e8724 | 306 | $processorInstance = $paymentClass::singleton($mode, $paymentProcessor); |
6a488035 TO |
307 | |
308 | // Does PP implement this method, and can we call it? | |
309 | if (!method_exists($processorInstance, $method) || | |
310 | !is_callable(array($processorInstance, $method)) | |
311 | ) { | |
43d1ae00 EM |
312 | // on the off chance there is a double implementation of this processor we should keep looking for another |
313 | // note that passing processor_id is more reliable & we should work to deprecate processor_name | |
314 | continue; | |
6a488035 TO |
315 | } |
316 | ||
317 | // Everything, it seems, is ok - execute pp callback handler | |
318 | $processorInstance->$method(); | |
a5ef96f6 | 319 | $extension_instance_found = TRUE; |
6a488035 TO |
320 | } |
321 | ||
322 | if (!$extension_instance_found) CRM_Core_Error::fatal( | |
323 | "No extension instances of the '{$params['processor_name']}' payment processor were found.<br />" . | |
324 | "$method method is unsupported in legacy payment processors." | |
325 | ); | |
326 | ||
327 | // Exit here on web requests, allowing just the plain text response to be echoed | |
328 | if ($method == 'handlePaymentNotification') { | |
329 | CRM_Utils_System::civiExit(); | |
330 | } | |
331 | } | |
332 | ||
333 | /** | |
334 | * Function to check whether a method is present ( & supported ) by the payment processor object. | |
335 | * | |
336 | * @param string $method method to check for. | |
337 | * | |
338 | * @return boolean | |
339 | * @public | |
340 | */ | |
341 | function isSupported($method = 'cancelSubscription') { | |
342 | return method_exists(CRM_Utils_System::getClassName($this), $method); | |
343 | } | |
344 | ||
a0ee3941 EM |
345 | /** |
346 | * @param null $entityID | |
347 | * @param null $entity | |
348 | * @param string $action | |
349 | * | |
350 | * @return string | |
351 | */ | |
6a488035 | 352 | function subscriptionURL($entityID = NULL, $entity = NULL, $action = 'cancel') { |
03cfff4c KW |
353 | // Set URL |
354 | switch ($action) { | |
355 | case 'cancel' : | |
356 | $url = 'civicrm/contribute/unsubscribe'; | |
357 | break; | |
358 | ||
359 | case 'billing' : | |
360 | //in notify mode don't return the update billing url | |
361 | if ($this->_paymentProcessor['billing_mode'] == self::BILLING_MODE_NOTIFY) { | |
362 | return NULL; | |
363 | } | |
364 | $url = 'civicrm/contribute/updatebilling'; | |
365 | break; | |
6a488035 | 366 | |
03cfff4c KW |
367 | case 'update' : |
368 | $url = 'civicrm/contribute/updaterecur'; | |
369 | break; | |
6a488035 TO |
370 | } |
371 | ||
03cfff4c KW |
372 | $session = CRM_Core_Session::singleton(); |
373 | $userId = $session->get('userID'); | |
374 | $contactID = 0; | |
375 | $checksumValue = ''; | |
376 | $entityArg = ''; | |
377 | ||
378 | // Find related Contact | |
379 | if ($entityID) { | |
380 | switch ($entity) { | |
381 | case 'membership' : | |
382 | $contactID = CRM_Core_DAO::getFieldValue("CRM_Member_DAO_Membership", $entityID, "contact_id"); | |
383 | $entityArg = 'mid'; | |
384 | break; | |
385 | ||
386 | case 'contribution' : | |
387 | $contactID = CRM_Core_DAO::getFieldValue("CRM_Contribute_DAO_Contribution", $entityID, "contact_id"); | |
388 | $entityArg = 'coid'; | |
389 | break; | |
390 | ||
391 | case 'recur' : | |
392 | $sql = " | |
6a488035 TO |
393 | SELECT con.contact_id |
394 | FROM civicrm_contribution_recur rec | |
395 | INNER JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id ) | |
396 | WHERE rec.id = %1 | |
397 | GROUP BY rec.id"; | |
03cfff4c KW |
398 | $contactID = CRM_Core_DAO::singleValueQuery($sql, array(1 => array($entityID, 'Integer'))); |
399 | $entityArg = 'crid'; | |
400 | break; | |
6a488035 | 401 | } |
6a488035 TO |
402 | } |
403 | ||
03cfff4c KW |
404 | // Add entity arguments |
405 | if ($entityArg != '') { | |
406 | // Add checksum argument | |
407 | if ($contactID != 0 && $userId != $contactID) { | |
408 | $checksumValue = '&cs=' . CRM_Contact_BAO_Contact_Utils::generateChecksum($contactID, NULL, 'inf'); | |
409 | } | |
410 | return CRM_Utils_System::url($url, "reset=1&{$entityArg}={$entityID}{$checksumValue}", TRUE, NULL, FALSE, TRUE); | |
411 | } | |
412 | ||
413 | // Else login URL | |
6a488035 TO |
414 | if ($this->isSupported('accountLoginURL')) { |
415 | return $this->accountLoginURL(); | |
416 | } | |
03cfff4c KW |
417 | |
418 | // Else default | |
6a488035 TO |
419 | return $this->_paymentProcessor['url_recur']; |
420 | } | |
6a488035 | 421 | } |