Commit | Line | Data |
---|---|---|
71a6ba5c LMM |
1 | <?php |
2 | /* | |
93b42747 LMM |
3 | * This file is part of CiviCRM. |
4 | * | |
5 | * CiviCRM is free software: you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License as published by | |
7 | * the Free Software Foundation, either version 3 of the License, or | |
8 | * (at your option) any later version. | |
9 | * | |
10 | * CiviCRM is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | * GNU General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU General Public License | |
16 | * along with CiviCRM. If not, see <http://www.gnu.org/licenses/>. | |
17 | * | |
71a6ba5c LMM |
18 | * Copyright (C) 2012 |
19 | * Licensed to CiviCRM under the GPL v3 or higher | |
20 | * | |
21 | * Written and contributed by Ward Vandewege <ward@fsf.org> (http://www.fsf.org) | |
68f3cf09 | 22 | * Modified by Lisa Marie Maginnis <lisa@fsf.org> (http://www.fsf.org) |
71a6ba5c LMM |
23 | * |
24 | */ | |
25 | ||
26 | // Define logging level (0 = off, 4 = log everything) | |
27 | define('TRUSTCOMMERCE_LOGGING_LEVEL', 4); | |
28 | ||
29 | require_once 'CRM/Core/Payment.php'; | |
30 | class org_fsf_payment_trustcommerce extends CRM_Core_Payment { | |
31 | CONST CHARSET = 'iso-8859-1'; | |
32 | CONST AUTH_APPROVED = 'approve'; | |
33 | CONST AUTH_DECLINED = 'decline'; | |
34 | CONST AUTH_BADDATA = 'baddata'; | |
35 | CONST AUTH_ERROR = 'error'; | |
36 | ||
37 | static protected $_mode = NULL; | |
38 | ||
39 | static protected $_params = array(); | |
40 | ||
41 | /** | |
42 | * We only need one instance of this object. So we use the singleton | |
43 | * pattern and cache the instance in this variable | |
44 | * | |
45 | * @var object | |
46 | * @static | |
47 | */ | |
48 | static private $_singleton = NULL; | |
49 | ||
50 | /** | |
51 | * Constructor | |
52 | * | |
53 | * @param string $mode the mode of operation: live or test | |
54 | * | |
55 | * @return void | |
56 | */ function __construct($mode, &$paymentProcessor) { | |
57 | $this->_mode = $mode; | |
58 | ||
59 | $this->_paymentProcessor = $paymentProcessor; | |
60 | ||
61 | $this->_processorName = ts('TrustCommerce'); | |
62 | ||
63 | $config = CRM_Core_Config::singleton(); | |
64 | $this->_setParam('user_name', $paymentProcessor['user_name']); | |
65 | $this->_setParam('password', $paymentProcessor['password']); | |
66 | ||
67 | $this->_setParam('timestamp', time()); | |
68 | srand(time()); | |
69 | $this->_setParam('sequence', rand(1, 1000)); | |
70 | $this->logging_level = TRUSTCOMMERCE_LOGGING_LEVEL; | |
71 | } | |
72 | ||
73 | /** | |
74 | * singleton function used to manage this object | |
75 | * | |
76 | * @param string $mode the mode of operation: live or test | |
77 | * | |
78 | * @return object | |
79 | * @static | |
80 | * | |
81 | */ | |
82 | static | |
83 | function &singleton($mode, &$paymentProcessor) { | |
84 | $processorName = $paymentProcessor['name']; | |
85 | if (self::$_singleton[$processorName] === NULL) { | |
86 | self::$_singleton[$processorName] = new org_fsf_payment_trustcommerce($mode, $paymentProcessor); | |
87 | } | |
88 | return self::$_singleton[$processorName]; | |
89 | } | |
90 | ||
91 | /** | |
e0273c0a LMM |
92 | * Submit a payment using the TC API |
93 | * @param array $params The params we will be sending to tclink_send() | |
94 | * @return mixed An array of our results, or an error object if the transaction fails. | |
71a6ba5c LMM |
95 | * @public |
96 | */ | |
97 | function doDirectPayment(&$params) { | |
98 | if (!extension_loaded("tclink")) { | |
99 | return self::error(9001, 'TrustCommerce requires that the tclink module is loaded'); | |
100 | } | |
101 | ||
f322addf LMM |
102 | /* Copy our paramaters to ourself */ |
103 | foreach ($params as $field => $value) { | |
71a6ba5c LMM |
104 | $this->_setParam($field, $value); |
105 | } | |
106 | ||
f322addf LMM |
107 | /* Get our fields to pass to tclink_send() */ |
108 | $tc_params = $this->_getTrustCommerceFields(); | |
71a6ba5c | 109 | |
f322addf LMM |
110 | /* Are we recurring? If so add the extra API fields. */ |
111 | if (CRM_Utils_Array::value('is_recur', $params) && $params['contributionRecurID']) { | |
112 | $tc_params = $this->_getRecurPaymentFields($tc_params); | |
113 | } | |
71a6ba5c | 114 | |
f322addf | 115 | /* Pass our cooked params to the alter hook, per Core/Payment/Dummy.php */ |
32bf0975 | 116 | CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $tc_params); |
71a6ba5c LMM |
117 | |
118 | // TrustCommerce will not refuse duplicates, so we should check if the user already submitted this transaction | |
f322addf | 119 | if ($this->_checkDupe($tc_params['ticket'])) { |
71a6ba5c LMM |
120 | return self::error(9004, 'It appears that this transaction is a duplicate. Have you already submitted the form once? If so there may have been a connection problem. You can try your transaction again. If you continue to have problems please contact the site administrator.'); |
121 | } | |
122 | ||
f322addf | 123 | /* Call the TC API, and grab the reply */ |
e990a9a5 | 124 | $reply = $this->_sendTCRequest($tc_params); |
71a6ba5c | 125 | |
f322addf | 126 | /* Parse our reply */ |
5efae07f | 127 | $result = $this->_getTCReply($reply); |
71a6ba5c | 128 | |
f322addf LMM |
129 | if($result == 0) { |
130 | /* We were successful, congrats. Lets wrap it up: | |
131 | * Convert back to dollars | |
132 | * Save the transaction ID | |
133 | */ | |
134 | $params['trxn_id'] = $reply['transid']; | |
135 | $params['gross_amount'] = $tc_params['amount'] / 100; | |
71a6ba5c | 136 | |
f322addf | 137 | return $params; |
71a6ba5c | 138 | |
f322addf LMM |
139 | } else { |
140 | /* Otherwise we return the error object */ | |
141 | return $result; | |
142 | } | |
71a6ba5c LMM |
143 | } |
144 | ||
e055e8ef LMM |
145 | function _sendTCRequest($request) { |
146 | $this->_logger($request); | |
147 | return tclink_send($request); | |
148 | } | |
149 | ||
150 | function _logger($params) { | |
e990a9a5 | 151 | $msg = ''; |
69a1e975 | 152 | foreach ($params as $key => $data) { |
e055e8ef LMM |
153 | /* Delete any data we should not be writing to disk. This includes: |
154 | * custid, password, cc, exp, and cvv | |
155 | */ | |
e055e8ef | 156 | switch($key) { |
e990a9a5 LMM |
157 | case 'custid': |
158 | case 'password': | |
159 | case 'cc': | |
160 | case 'exp': | |
161 | case 'cvv': | |
e055e8ef LMM |
162 | break; |
163 | default: | |
e990a9a5 | 164 | $msg .= ' '.$key.' => '.$data; |
e055e8ef LMM |
165 | } |
166 | } | |
e990a9a5 | 167 | error_log('TrustCommerce:'.$msg); |
e055e8ef LMM |
168 | } |
169 | ||
71a6ba5c | 170 | /** |
f322addf LMM |
171 | * Gets the recurring billing fields for the TC API |
172 | * @param array $fields The fields to modify. | |
173 | * @return array The fields for tclink_send(), modified for recurring billing. | |
71a6ba5c LMM |
174 | * @public |
175 | */ | |
f322addf | 176 | function _getRecurPaymentFields($fields) { |
285eaf25 LMM |
177 | $payments = $this->_getParam('frequency_interval'); |
178 | $cycle = $this->_getParam('frequency_unit'); | |
71a6ba5c | 179 | |
f322addf | 180 | /* Translate billing cycle from CiviCRM -> TC */ |
285eaf25 LMM |
181 | switch($cycle) { |
182 | case 'day': | |
183 | $cycle = 'd'; | |
184 | break; | |
185 | case 'week': | |
186 | $cycle = 'w'; | |
187 | break; | |
188 | case 'month': | |
189 | $cycle = 'm'; | |
190 | break; | |
191 | case 'year': | |
192 | $cycle = 'y'; | |
193 | break; | |
71a6ba5c | 194 | } |
bc323ec4 LMM |
195 | |
196 | /* Translate frequency interval from CiviCRM -> TC | |
197 | * Payments are the same, HOWEVER a payment of 1 (forever) should be 0 in TC */ | |
198 | if($payments == 1) { | |
199 | $payments = 0; | |
71a6ba5c | 200 | } |
71a6ba5c | 201 | |
bc323ec4 LMM |
202 | $fields['cycle'] = '1'.$cycle; /* The billing cycle in years, months, weeks, or days. */ |
203 | $fields['payments'] = $payments; | |
204 | $fields['action'] = 'store'; /* Change our mode to `store' mode. */ | |
71a6ba5c | 205 | |
bc323ec4 | 206 | return $fields; |
a79ba043 LMM |
207 | } |
208 | ||
209 | /* Parses a response from TC via the tclink_send() command. | |
210 | * @param $reply array The result of a call to tclink_send(). | |
211 | * @return mixed self::error() if transaction failed, otherwise returns 0. | |
212 | */ | |
5efae07f | 213 | function _getTCReply($reply) { |
71a6ba5c | 214 | |
285eaf25 | 215 | /* DUPLIATE CODE, please refactor. ~lisa */ |
bc323ec4 | 216 | if (!$reply) { |
285eaf25 | 217 | return self::error(9002, 'Could not initiate connection to payment gateway'); |
71a6ba5c LMM |
218 | } |
219 | ||
bc323ec4 | 220 | switch($reply['status']) { |
285eaf25 LMM |
221 | case self::AUTH_APPROVED: |
222 | // It's all good | |
223 | break; | |
224 | case self::AUTH_DECLINED: | |
225 | // TODO FIXME be more or less specific? | |
226 | // declinetype can be: decline, avs, cvv, call, expiredcard, carderror, authexpired, fraud, blacklist, velocity | |
227 | // See TC documentation for more info | |
a8c5366f | 228 | return self::error(9009, "Your transaction was declined: {$reply['declinetype']}"); |
285eaf25 LMM |
229 | break; |
230 | case self::AUTH_BADDATA: | |
a8c5366f LMM |
231 | // TODO FIXME do something with $reply['error'] and $reply['offender'] |
232 | return self::error(9011, "Invalid credit card information. The following fields were invalid: {$reply['offenders']}."); | |
285eaf25 LMM |
233 | break; |
234 | case self::AUTH_ERROR: | |
235 | return self::error(9002, 'Could not initiate connection to payment gateway'); | |
236 | break; | |
71a6ba5c | 237 | } |
a79ba043 | 238 | return 0; |
71a6ba5c LMM |
239 | } |
240 | ||
241 | function _getTrustCommerceFields() { | |
242 | // Total amount is from the form contribution field | |
243 | $amount = $this->_getParam('total_amount'); | |
244 | // CRM-9894 would this ever be the case?? | |
245 | if (empty($amount)) { | |
246 | $amount = $this->_getParam('amount'); | |
247 | } | |
248 | $fields = array(); | |
249 | $fields['custid'] = $this->_getParam('user_name'); | |
250 | $fields['password'] = $this->_getParam('password'); | |
251 | $fields['action'] = 'sale'; | |
252 | ||
253 | // Enable address verification | |
254 | $fields['avs'] = 'y'; | |
255 | ||
256 | $fields['address1'] = $this->_getParam('street_address'); | |
257 | $fields['zip'] = $this->_getParam('postal_code'); | |
258 | ||
259 | $fields['name'] = $this->_getParam('billing_first_name') . ' ' . $this->_getParam('billing_last_name'); | |
260 | ||
261 | // This assumes currencies where the . is used as the decimal point, like USD | |
262 | $amount = preg_replace("/([^0-9\\.])/i", "", $amount); | |
263 | ||
264 | // We need to pass the amount to TrustCommerce in dollar cents | |
265 | $fields['amount'] = $amount * 100; | |
266 | ||
267 | // Unique identifier | |
268 | $fields['ticket'] = substr($this->_getParam('invoiceID'), 0, 20); | |
269 | ||
270 | // cc info | |
271 | $fields['cc'] = $this->_getParam('credit_card_number'); | |
272 | $fields['cvv'] = $this->_getParam('cvv2'); | |
273 | $exp_month = str_pad($this->_getParam('month'), 2, '0', STR_PAD_LEFT); | |
274 | $exp_year = substr($this->_getParam('year'),-2); | |
275 | $fields['exp'] = "$exp_month$exp_year"; | |
276 | ||
277 | if ($this->_mode != 'live') { | |
278 | $fields['demo'] = 'y'; | |
279 | } | |
71a6ba5c LMM |
280 | return $fields; |
281 | } | |
282 | ||
283 | /** | |
284 | * Checks to see if invoice_id already exists in db | |
285 | * | |
286 | * @param int $invoiceId The ID to check | |
287 | * | |
288 | * @return bool True if ID exists, else false | |
289 | */ | |
290 | function _checkDupe($invoiceId) { | |
291 | require_once 'CRM/Contribute/DAO/Contribution.php'; | |
292 | $contribution = new CRM_Contribute_DAO_Contribution(); | |
293 | $contribution->invoice_id = $invoiceId; | |
294 | return $contribution->find(); | |
295 | } | |
296 | ||
297 | /** | |
298 | * Get the value of a field if set | |
299 | * | |
300 | * @param string $field the field | |
301 | * | |
302 | * @return mixed value of the field, or empty string if the field is | |
303 | * not set | |
304 | */ | |
305 | function _getParam($field) { | |
306 | return CRM_Utils_Array::value($field, $this->_params, ''); | |
307 | } | |
308 | ||
309 | function &error($errorCode = NULL, $errorMessage = NULL) { | |
310 | $e = CRM_Core_Error::singleton(); | |
311 | if ($errorCode) { | |
312 | $e->push($errorCode, 0, NULL, $errorMessage); | |
313 | } | |
314 | else { | |
315 | $e->push(9001, 0, NULL, 'Unknown System Error.'); | |
316 | } | |
317 | return $e; | |
318 | } | |
319 | ||
320 | /** | |
321 | * Set a field to the specified value. Value must be a scalar (int, | |
322 | * float, string, or boolean) | |
323 | * | |
324 | * @param string $field | |
325 | * @param mixed $value | |
326 | * | |
327 | * @return bool false if value is not a scalar, true if successful | |
328 | */ | |
329 | function _setParam($field, $value) { | |
330 | if (!is_scalar($value)) { | |
331 | return FALSE; | |
332 | } | |
333 | else { | |
334 | $this->_params[$field] = $value; | |
335 | } | |
336 | } | |
337 | ||
338 | /** | |
339 | * This function checks to see if we have the right config values | |
340 | * | |
341 | * @return string the error message if any | |
342 | * @public | |
343 | */ | |
344 | function checkConfig() { | |
345 | $error = array(); | |
346 | if (empty($this->_paymentProcessor['user_name'])) { | |
347 | $error[] = ts('Customer ID is not set for this payment processor'); | |
348 | } | |
349 | ||
350 | if (empty($this->_paymentProcessor['password'])) { | |
351 | $error[] = ts('Password is not set for this payment processor'); | |
352 | } | |
353 | ||
354 | if (!empty($error)) { | |
355 | return implode('<p>', $error); | |
356 | } else { | |
357 | return NULL; | |
358 | } | |
359 | } | |
360 | ||
14f15ff3 | 361 | function cancelSubscription(&$message = '', $params = array()) { |
7964e0e9 LMM |
362 | $tc_params['custid'] = $this->_getParam('user_name'); |
363 | $tc_params['password'] = $this->_getParam('password'); | |
364 | $tc_params['action'] = 'unstore'; | |
cbf5200e | 365 | $tc_params['billingid'] = CRM_Utils_Array::value('trxn_id', $params); |
e055e8ef | 366 | |
e990a9a5 | 367 | $result = $this->_sendTCRequest($tc_params); |
71a6ba5c | 368 | |
7964e0e9 LMM |
369 | /* Test if call failed */ |
370 | if(!$result) { | |
71a6ba5c LMM |
371 | return self::error(9002, 'Could not initiate connection to payment gateway'); |
372 | } | |
7964e0e9 | 373 | /* We are done, pass success */ |
71a6ba5c LMM |
374 | return TRUE; |
375 | } | |
376 | ||
377 | public function install() { | |
378 | return TRUE; | |
379 | } | |
380 | ||
381 | public function uninstall() { | |
382 | return TRUE; | |
383 | } | |
384 | ||
385 | } |