Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
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 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
fa938177 | 31 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
32 | */ |
33 | class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { | |
34 | ||
35 | static $_paymentProcessor = NULL; | |
c8aa607b | 36 | |
37 | /** | |
38 | * Input parameters from payment processor. Store these so that | |
39 | * the code does not need to keep retrieving from the http request | |
40 | * @var array | |
41 | */ | |
42 | protected $_inputParameters = array(); | |
43 | ||
44 | /** | |
fe482240 | 45 | * Store for the variables from the invoice string. |
c8aa607b | 46 | * @var array |
47 | */ | |
48 | protected $_invoiceData = array(); | |
49 | ||
50 | /** | |
fe482240 | 51 | * Is this a payment express transaction. |
c8aa607b | 52 | */ |
53 | protected $_isPaymentExpress = FALSE; | |
54 | ||
55 | /** | |
56 | * Are we dealing with an event an 'anything else' (contribute) | |
57 | * @var string component | |
58 | */ | |
59 | protected $_component = 'contribute'; | |
0dbefed3 | 60 | |
c8aa607b | 61 | /** |
fe482240 | 62 | * Constructor function. |
0dbefed3 | 63 | * |
6a0b768e TO |
64 | * @param array $inputData |
65 | * Contents of HTTP REQUEST. | |
0dbefed3 EM |
66 | * |
67 | * @throws CRM_Core_Exception | |
c8aa607b | 68 | */ |
00be9182 | 69 | public function __construct($inputData) { |
c8aa607b | 70 | $this->setInputParameters($inputData); |
71 | $this->setInvoiceData(); | |
6a488035 TO |
72 | parent::__construct(); |
73 | } | |
74 | ||
c8aa607b | 75 | /** |
fe482240 | 76 | * get the values from the rp_invoice_id string. |
77b97be7 | 77 | * |
6a0b768e TO |
78 | * @param string $name |
79 | * E.g. i, values are stored in the string with letter codes. | |
80 | * @param bool $abort | |
16b10e64 | 81 | * Throw exception if not found |
77b97be7 EM |
82 | * |
83 | * @throws CRM_Core_Exception | |
16b10e64 | 84 | * @return mixed |
c8aa607b | 85 | */ |
00be9182 | 86 | public function getValue($name, $abort = TRUE) { |
c8aa607b | 87 | if ($abort && empty($this->_invoiceData[$name])) { |
88 | throw new CRM_Core_Exception("Failure: Missing Parameter $name"); | |
6a488035 TO |
89 | } |
90 | else { | |
c8aa607b | 91 | return CRM_Utils_Array::value($name, $this->_invoiceData); |
92 | } | |
93 | } | |
94 | ||
95 | /** | |
96 | * Set $this->_invoiceData from the input array | |
97 | */ | |
00be9182 | 98 | public function setInvoiceData() { |
22e263ad | 99 | if (empty($this->_inputParameters['rp_invoice_id'])) { |
c8aa607b | 100 | $this->_isPaymentExpress = TRUE; |
101 | return; | |
102 | } | |
103 | $rpInvoiceArray = explode('&', $this->_inputParameters['rp_invoice_id']); | |
104 | // for clarify let's also store without the single letter unreadable | |
105 | //@todo after more refactoring we might ditch storing the one letter stuff | |
106 | $mapping = array( | |
107 | 'i' => 'invoice_id', | |
108 | 'm' => 'component', | |
109 | 'c' => 'contact_id', | |
110 | 'b' => 'contribution_id', | |
111 | 'r' => 'contribution_recur_id', | |
112 | 'p' => 'participant_id', | |
113 | 'e' => 'event_id', | |
114 | ); | |
115 | foreach ($rpInvoiceArray as $rpInvoiceValue) { | |
116 | $rpValueArray = explode('=', $rpInvoiceValue); | |
117 | $this->_invoiceData[$rpValueArray[0]] = $rpValueArray[1]; | |
118 | $this->_inputParameters[$mapping[$rpValueArray[0]]] = $rpValueArray[1]; | |
119 | // p has been overloaded & could mean contribution page or participant id. Clearly we need an | |
120 | // alphabet with more letters. | |
121 | // the mode will always be resolved before the mystery p is reached | |
22e263ad | 122 | if ($rpValueArray[1] == 'contribute') { |
c8aa607b | 123 | $mapping['p'] = 'contribution_page_id'; |
124 | } | |
6a488035 | 125 | } |
22e263ad | 126 | if (empty($this->_inputParameters['component'])) { |
949babe8 JM |
127 | $this->_isPaymentExpress = TRUE; |
128 | } | |
6a488035 TO |
129 | } |
130 | ||
c8aa607b | 131 | /** |
6a0b768e TO |
132 | * @param string $name |
133 | * Of variable to return. | |
134 | * @param string $type | |
135 | * Data type. | |
c8aa607b | 136 | * - String |
137 | * - Integer | |
6a0b768e TO |
138 | * @param string $location |
139 | * Deprecated. | |
140 | * @param bool $abort | |
141 | * Abort if empty. | |
77b97be7 EM |
142 | * |
143 | * @throws CRM_Core_Exception | |
72b3a70c | 144 | * @return mixed |
c8aa607b | 145 | */ |
00be9182 | 146 | public function retrieve($name, $type, $location = 'POST', $abort = TRUE) { |
c8aa607b | 147 | $value = CRM_Utils_Type::validate( |
148 | CRM_Utils_Array::value($name, $this->_inputParameters), | |
149 | $type, | |
150 | FALSE | |
6a488035 TO |
151 | ); |
152 | if ($abort && $value === NULL) { | |
c8aa607b | 153 | throw new CRM_Core_Exception("Could not find an entry for $name in $location"); |
6a488035 TO |
154 | } |
155 | return $value; | |
156 | } | |
157 | ||
c8aa607b | 158 | /** |
fe482240 | 159 | * Process recurring contributions. |
c8aa607b | 160 | * @param array $input |
161 | * @param array $ids | |
162 | * @param array $objects | |
6a0b768e | 163 | * @param bool $first |
0b014509 | 164 | * @return bool |
c8aa607b | 165 | */ |
00be9182 | 166 | public function recur(&$input, &$ids, &$objects, $first) { |
6a488035 TO |
167 | if (!isset($input['txnType'])) { |
168 | CRM_Core_Error::debug_log_message("Could not find txn_type in input request"); | |
169 | echo "Failure: Invalid parameters<p>"; | |
170 | return FALSE; | |
171 | } | |
172 | ||
173 | if ($input['txnType'] == 'recurring_payment' && | |
174 | $input['paymentStatus'] != 'Completed' | |
175 | ) { | |
176 | CRM_Core_Error::debug_log_message("Ignore all IPN payments that are not completed"); | |
177 | echo "Failure: Invalid parameters<p>"; | |
178 | return FALSE; | |
179 | } | |
180 | ||
181 | $recur = &$objects['contributionRecur']; | |
182 | ||
183 | // make sure the invoice ids match | |
184 | // make sure the invoice is valid and matches what we have in | |
185 | // the contribution record | |
186 | if ($recur->invoice_id != $input['invoice']) { | |
187 | CRM_Core_Error::debug_log_message("Invoice values dont match between database and IPN request recur is " . $recur->invoice_id . " input is " . $input['invoice']); | |
188 | echo "Failure: Invoice values dont match between database and IPN request recur is " . $recur->invoice_id . " input is " . $input['invoice']; | |
189 | return FALSE; | |
190 | } | |
191 | ||
192 | $now = date('YmdHis'); | |
193 | ||
194 | // fix dates that already exist | |
195 | $dates = array('create', 'start', 'end', 'cancel', 'modified'); | |
196 | foreach ($dates as $date) { | |
197 | $name = "{$date}_date"; | |
198 | if ($recur->$name) { | |
199 | $recur->$name = CRM_Utils_Date::isoToMysql($recur->$name); | |
200 | } | |
201 | } | |
202 | ||
203 | $sendNotification = FALSE; | |
204 | $subscriptionPaymentStatus = NULL; | |
205 | //List of Transaction Type | |
206 | /* | |
e70a7fc0 | 207 | recurring_payment_profile_created RP Profile Created |
b44e3f84 | 208 | recurring_payment RP Successful Payment |
e70a7fc0 TO |
209 | recurring_payment_failed RP Failed Payment |
210 | recurring_payment_profile_cancel RP Profile Cancelled | |
211 | recurring_payment_expired RP Profile Expired | |
212 | recurring_payment_skipped RP Profile Skipped | |
b44e3f84 | 213 | recurring_payment_outstanding_payment RP Successful Outstanding Payment |
e70a7fc0 TO |
214 | recurring_payment_outstanding_payment_failed RP Failed Outstanding Payment |
215 | recurring_payment_suspended RP Profile Suspended | |
216 | recurring_payment_suspended_due_to_max_failed_payment RP Profile Suspended due to Max Failed Payment | |
217 | */ | |
6a488035 | 218 | |
6a488035 | 219 | //set transaction type |
c8aa607b | 220 | $txnType = $this->retrieve('txn_type', 'String'); |
6a488035 | 221 | //Changes for paypal pro recurring payment |
e25b58d1 E |
222 | $contributionStatuses = civicrm_api3('contribution', 'getoptions', array('field' => 'contribution_status_id')); |
223 | $contributionStatuses = $contributionStatuses['values']; | |
6a488035 TO |
224 | switch ($txnType) { |
225 | case 'recurring_payment_profile_created': | |
353ffa53 TO |
226 | if (in_array($recur->contribution_status_id, array( |
227 | array_search('Pending', $contributionStatuses), | |
d5cc0fc2 | 228 | array_search('In Progress', $contributionStatuses), |
353ffa53 TO |
229 | )) |
230 | && !empty($recur->processor_id) | |
231 | ) { | |
e25b58d1 | 232 | echo "already handled"; |
0b014509 | 233 | return FALSE; |
e25b58d1 | 234 | } |
6a488035 TO |
235 | $recur->create_date = $now; |
236 | $recur->contribution_status_id = 2; | |
d57577d4 | 237 | $recur->processor_id = $this->retrieve('recurring_payment_id', 'String'); |
6a488035 TO |
238 | $recur->trxn_id = $recur->processor_id; |
239 | $subscriptionPaymentStatus = CRM_Core_Payment::RECURRING_PAYMENT_START; | |
240 | $sendNotification = TRUE; | |
241 | break; | |
242 | ||
243 | case 'recurring_payment': | |
244 | if ($first) { | |
245 | $recur->start_date = $now; | |
246 | } | |
247 | else { | |
248 | $recur->modified_date = $now; | |
249 | } | |
250 | ||
251 | //contribution installment is completed | |
c8aa607b | 252 | if ($this->retrieve('profile_status', 'String') == 'Expired') { |
22e263ad | 253 | if (!empty($recur->end_date)) { |
e25b58d1 | 254 | echo "already handled"; |
0b014509 | 255 | return FALSE; |
e25b58d1 | 256 | } |
6a488035 TO |
257 | $recur->contribution_status_id = 1; |
258 | $recur->end_date = $now; | |
259 | $sendNotification = TRUE; | |
260 | $subscriptionPaymentStatus = CRM_Core_Payment::RECURRING_PAYMENT_END; | |
261 | } | |
262 | ||
263 | // make sure the contribution status is not done | |
264 | // since order of ipn's is unknown | |
265 | if ($recur->contribution_status_id != 1) { | |
266 | $recur->contribution_status_id = 5; | |
267 | } | |
268 | break; | |
269 | } | |
270 | ||
271 | $recur->save(); | |
272 | ||
273 | if ($sendNotification) { | |
274 | $autoRenewMembership = FALSE; | |
275 | if ($recur->id && | |
276 | isset($ids['membership']) && $ids['membership'] | |
277 | ) { | |
278 | $autoRenewMembership = TRUE; | |
279 | } | |
280 | //send recurring Notification email for user | |
281 | CRM_Contribute_BAO_ContributionPage::recurringNotify($subscriptionPaymentStatus, | |
282 | $ids['contact'], | |
283 | $ids['contributionPage'], | |
284 | $recur, | |
285 | $autoRenewMembership | |
286 | ); | |
287 | } | |
288 | ||
289 | if ($txnType != 'recurring_payment') { | |
0b014509 | 290 | return TRUE; |
6a488035 TO |
291 | } |
292 | ||
293 | if (!$first) { | |
bc66bc9e PJ |
294 | //check if this contribution transaction is already processed |
295 | //if not create a contribution and then get it processed | |
6a488035 | 296 | $contribution = new CRM_Contribute_BAO_Contribution(); |
bc66bc9e PJ |
297 | $contribution->trxn_id = $input['trxn_id']; |
298 | if ($contribution->trxn_id && $contribution->find()) { | |
299 | CRM_Core_Error::debug_log_message("returning since contribution has already been handled"); | |
300 | echo "Success: Contribution has already been handled<p>"; | |
301 | return TRUE; | |
302 | } | |
303 | ||
73004adf | 304 | $contribution->contact_id = $recur->contact_id; |
353ffa53 | 305 | $contribution->financial_type_id = $objects['contributionType']->id; |
6a488035 TO |
306 | $contribution->contribution_page_id = $ids['contributionPage']; |
307 | $contribution->contribution_recur_id = $ids['contributionRecur']; | |
6a488035 TO |
308 | $contribution->currency = $objects['contribution']->currency; |
309 | $contribution->payment_instrument_id = $objects['contribution']->payment_instrument_id; | |
310 | $contribution->amount_level = $objects['contribution']->amount_level; | |
94d1bc8d | 311 | $contribution->campaign_id = $objects['contribution']->campaign_id; |
6a488035 TO |
312 | $objects['contribution'] = &$contribution; |
313 | } | |
da88a16b | 314 | // CRM-13737 - am not aware of any reason why payment_date would not be set - this if is a belt & braces |
2aa397bc | 315 | $objects['contribution']->receive_date = !empty($input['payment_date']) ? date('YmdHis', strtotime($input['payment_date'])) : $now; |
6a488035 TO |
316 | |
317 | $this->single($input, $ids, $objects, | |
318 | TRUE, $first | |
319 | ); | |
320 | } | |
321 | ||
6c786a9b EM |
322 | /** |
323 | * @param $input | |
324 | * @param $ids | |
325 | * @param $objects | |
326 | * @param bool $recur | |
327 | * @param bool $first | |
7a9ab499 EM |
328 | * |
329 | * @return bool | |
6c786a9b | 330 | */ |
00be9182 | 331 | public function single(&$input, &$ids, &$objects, $recur = FALSE, $first = FALSE) { |
6a488035 TO |
332 | $contribution = &$objects['contribution']; |
333 | ||
334 | // make sure the invoice is valid and matches what we have in the contribution record | |
335 | if ((!$recur) || ($recur && $first)) { | |
336 | if ($contribution->invoice_id != $input['invoice']) { | |
337 | CRM_Core_Error::debug_log_message("Invoice values dont match between database and IPN request"); | |
338 | echo "Failure: Invoice values dont match between database and IPN request<p>contribution is" . $contribution->invoice_id . " and input is " . $input['invoice']; | |
339 | return FALSE; | |
340 | } | |
341 | } | |
342 | else { | |
343 | $contribution->invoice_id = md5(uniqid(rand(), TRUE)); | |
344 | } | |
345 | ||
346 | if (!$recur) { | |
347 | if ($contribution->total_amount != $input['amount']) { | |
348 | CRM_Core_Error::debug_log_message("Amount values dont match between database and IPN request"); | |
349 | echo "Failure: Amount values dont match between database and IPN request<p>"; | |
350 | return FALSE; | |
351 | } | |
352 | } | |
353 | else { | |
354 | $contribution->total_amount = $input['amount']; | |
355 | } | |
356 | ||
357 | $transaction = new CRM_Core_Transaction(); | |
358 | ||
6a488035 TO |
359 | $participant = &$objects['participant']; |
360 | $membership = &$objects['membership']; | |
361 | ||
362 | $status = $input['paymentStatus']; | |
363 | if ($status == 'Denied' || $status == 'Failed' || $status == 'Voided') { | |
364 | return $this->failed($objects, $transaction); | |
365 | } | |
366 | elseif ($status == 'Pending') { | |
367 | return $this->pending($objects, $transaction); | |
368 | } | |
369 | elseif ($status == 'Refunded' || $status == 'Reversed') { | |
370 | return $this->cancelled($objects, $transaction); | |
371 | } | |
372 | elseif ($status != 'Completed') { | |
373 | return $this->unhandled($objects, $transaction); | |
374 | } | |
375 | ||
376 | // check if contribution is already completed, if so we ignore this ipn | |
377 | if ($contribution->contribution_status_id == 1) { | |
378 | $transaction->commit(); | |
379 | CRM_Core_Error::debug_log_message("returning since contribution has already been handled"); | |
380 | echo "Success: Contribution has already been handled<p>"; | |
381 | return TRUE; | |
382 | } | |
383 | ||
384 | $this->completeTransaction($input, $ids, $objects, $transaction, $recur); | |
385 | } | |
386 | ||
c8aa607b | 387 | /** |
388 | * This is the main function to call. It should be sufficient to instantiate the class | |
389 | * (with the input parameters) & call this & all will be done | |
390 | * | |
391 | * @todo the references to POST throughout this class need to be removed | |
0b014509 | 392 | * @return bool |
c8aa607b | 393 | */ |
00be9182 | 394 | public function main() { |
6a488035 TO |
395 | CRM_Core_Error::debug_var('GET', $_GET, TRUE, TRUE); |
396 | CRM_Core_Error::debug_var('POST', $_POST, TRUE, TRUE); | |
22e263ad | 397 | if ($this->_isPaymentExpress) { |
c8aa607b | 398 | $this->handlePaymentExpress(); |
0b014509 | 399 | return FALSE; |
c8aa607b | 400 | } |
6a488035 | 401 | $objects = $ids = $input = array(); |
353ffa53 | 402 | $this->_component = $input['component'] = self::getValue('m'); |
949babe8 | 403 | $input['invoice'] = self::getValue('i', TRUE); |
6a488035 TO |
404 | // get the contribution and contact ids from the GET params |
405 | $ids['contact'] = self::getValue('c', TRUE); | |
406 | $ids['contribution'] = self::getValue('b', TRUE); | |
407 | ||
408 | $this->getInput($input, $ids); | |
409 | ||
c8aa607b | 410 | if ($this->_component == 'event') { |
6a488035 TO |
411 | $ids['event'] = self::getValue('e', TRUE); |
412 | $ids['participant'] = self::getValue('p', TRUE); | |
413 | $ids['contributionRecur'] = self::getValue('r', FALSE); | |
414 | } | |
415 | else { | |
416 | // get the optional ids | |
c8aa607b | 417 | //@ how can this not be broken retrieving from GET as we are dealing with a POST request? |
418 | // copy & paste? Note the retrieve function now uses data from _REQUEST so this will be included | |
6a488035 TO |
419 | $ids['membership'] = self::retrieve('membershipID', 'Integer', 'GET', FALSE); |
420 | $ids['contributionRecur'] = self::getValue('r', FALSE); | |
421 | $ids['contributionPage'] = self::getValue('p', FALSE); | |
422 | $ids['related_contact'] = self::retrieve('relatedContactID', 'Integer', 'GET', FALSE); | |
423 | $ids['onbehalf_dupe_alert'] = self::retrieve('onBehalfDupeAlert', 'Integer', 'GET', FALSE); | |
424 | } | |
425 | ||
426 | if (!$ids['membership'] && $ids['contributionRecur']) { | |
427 | $sql = " | |
428 | SELECT m.id | |
429 | FROM civicrm_membership m | |
430 | INNER JOIN civicrm_membership_payment mp ON m.id = mp.membership_id AND mp.contribution_id = %1 | |
431 | WHERE m.contribution_recur_id = %2 | |
432 | LIMIT 1"; | |
2aa397bc | 433 | $sqlParams = array( |
353ffa53 | 434 | 1 => array($ids['contribution'], 'Integer'), |
6a488035 TO |
435 | 2 => array($ids['contributionRecur'], 'Integer'), |
436 | ); | |
437 | if ($membershipId = CRM_Core_DAO::singleValueQuery($sql, $sqlParams)) { | |
438 | $ids['membership'] = $membershipId; | |
439 | } | |
440 | } | |
441 | ||
8b8e1e57 | 442 | // This is an unreliable method as there could be more than one instance. |
443 | // Recommended approach is to use the civicrm/payment/ipn/xx url where xx is the payment | |
444 | // processor id & the handleNotification function (which should call the completetransaction api & by-pass this | |
445 | // entirely). The only thing the IPN class should really do is extract data from the request, validate it | |
446 | // & call completetransaction or call fail? (which may not exist yet). | |
447 | $paymentProcessorTypeID = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType', | |
6a488035 TO |
448 | 'PayPal', 'id', 'name' |
449 | ); | |
8b8e1e57 | 450 | $paymentProcessorID = (int) civicrm_api3('PaymentProcessor', 'getvalue', array( |
451 | 'is_test' => 0, | |
452 | 'options' => array('limit' => 1), | |
453 | 'payment_processor_type_id' => $paymentProcessorTypeID, | |
454 | 'return' => 'id', | |
455 | )); | |
6a488035 TO |
456 | |
457 | if (!$this->validateData($input, $ids, $objects, TRUE, $paymentProcessorID)) { | |
458 | return FALSE; | |
459 | } | |
460 | ||
461 | self::$_paymentProcessor = &$objects['paymentProcessor']; | |
c8aa607b | 462 | //?? how on earth would we not have component be one of these? |
463 | // they are the only valid settings & this IPN file can't even be called without one of them | |
464 | // grepping for this class doesn't find other paths to call this class | |
465 | if ($this->_component == 'contribute' || $this->_component == 'event') { | |
6a488035 TO |
466 | if ($ids['contributionRecur']) { |
467 | // check if first contribution is completed, else complete first contribution | |
468 | $first = TRUE; | |
469 | if ($objects['contribution']->contribution_status_id == 1) { | |
470 | $first = FALSE; | |
471 | } | |
472 | return $this->recur($input, $ids, $objects, $first); | |
473 | } | |
474 | else { | |
475 | return $this->single($input, $ids, $objects, FALSE, FALSE); | |
476 | } | |
477 | } | |
478 | else { | |
479 | return $this->single($input, $ids, $objects, FALSE, FALSE); | |
480 | } | |
481 | } | |
482 | ||
6c786a9b EM |
483 | /** |
484 | * @param $input | |
485 | * @param $ids | |
486 | * | |
72b3a70c | 487 | * @return bool |
6c786a9b EM |
488 | * @throws CRM_Core_Exception |
489 | */ | |
00be9182 | 490 | public function getInput(&$input, &$ids) { |
6a488035 TO |
491 | |
492 | if (!$this->getBillingID($ids)) { | |
493 | return FALSE; | |
494 | } | |
495 | ||
496 | $input['txnType'] = self::retrieve('txn_type', 'String', 'POST', FALSE); | |
497 | $input['paymentStatus'] = self::retrieve('payment_status', 'String', 'POST', FALSE); | |
6a488035 TO |
498 | |
499 | $input['amount'] = self::retrieve('mc_gross', 'Money', 'POST', FALSE); | |
500 | $input['reasonCode'] = self::retrieve('ReasonCode', 'String', 'POST', FALSE); | |
501 | ||
502 | $billingID = $ids['billing']; | |
503 | $lookup = array( | |
504 | "first_name" => 'first_name', | |
505 | "last_name" => 'last_name', | |
506 | "street_address-{$billingID}" => 'address_street', | |
507 | "city-{$billingID}" => 'address_city', | |
508 | "state-{$billingID}" => 'address_state', | |
509 | "postal_code-{$billingID}" => 'address_zip', | |
510 | "country-{$billingID}" => 'address_country_code', | |
511 | ); | |
512 | foreach ($lookup as $name => $paypalName) { | |
513 | $value = self::retrieve($paypalName, 'String', 'POST', FALSE); | |
514 | $input[$name] = $value ? $value : NULL; | |
515 | } | |
516 | ||
353ffa53 | 517 | $input['is_test'] = self::retrieve('test_ipn', 'Integer', 'POST', FALSE); |
6a488035 TO |
518 | $input['fee_amount'] = self::retrieve('mc_fee', 'Money', 'POST', FALSE); |
519 | $input['net_amount'] = self::retrieve('settle_amount', 'Money', 'POST', FALSE); | |
353ffa53 | 520 | $input['trxn_id'] = self::retrieve('txn_id', 'String', 'POST', FALSE); |
12829b5d | 521 | $input['payment_date'] = $input['receive_date'] = self::retrieve('payment_date', 'String', 'POST', FALSE); |
6a488035 | 522 | } |
c8aa607b | 523 | |
524 | /** | |
fe482240 | 525 | * Handle payment express IPNs. |
c8aa607b | 526 | * For one off IPNS no actual response is required |
527 | * Recurring is more difficult as we have limited confirmation material | |
949babe8 JM |
528 | * lets look up invoice id in recur_contribution & rely on the unique transaction id to ensure no |
529 | * duplicated | |
530 | * this may not be acceptable to all sites - e.g. if they are shipping or delivering something in return | |
531 | * then the quasi security of the ids array might be required - although better to | |
532 | * http://stackoverflow.com/questions/4848227/validate-that-ipn-call-is-from-paypal | |
533 | * but let's assume knowledge on invoice id & schedule is enough for now esp for donations | |
534 | * only contribute is handled | |
c8aa607b | 535 | */ |
00be9182 | 536 | public function handlePaymentExpress() { |
2aa397bc TO |
537 | //@todo - loads of copy & paste / code duplication but as this not going into core need to try to |
538 | // keep discreet | |
539 | // also note that a lot of the complexity above could be removed if we used | |
540 | // http://stackoverflow.com/questions/4848227/validate-that-ipn-call-is-from-paypal | |
541 | // as membership id etc can be derived by the load objects fn | |
949babe8 JM |
542 | $objects = $ids = $input = array(); |
543 | $isFirst = FALSE; | |
353ffa53 | 544 | $input['txnType'] = $this->retrieve('txn_type', 'String'); |
22e263ad | 545 | if ($input['txnType'] != 'recurring_payment') { |
949babe8 JM |
546 | throw new CRM_Core_Exception('Paypal IPNS not handled other than recurring_payments'); |
547 | } | |
548 | $input['invoice'] = self::getValue('i', FALSE); | |
549 | $this->getInput($input, $ids); | |
d3e86119 | 550 | if ($this->transactionExists($input['trxn_id'])) { |
949babe8 JM |
551 | throw new CRM_Core_Exception('This transaction has already been processed'); |
552 | } | |
553 | ||
353ffa53 TO |
554 | $contributionRecur = civicrm_api3('contribution_recur', 'getsingle', array( |
555 | 'return' => 'contact_id, id', | |
d5cc0fc2 | 556 | 'invoice_id' => $input['invoice'], |
353ffa53 | 557 | )); |
949babe8 JM |
558 | $ids['contact'] = $contributionRecur['contact_id']; |
559 | $ids['contributionRecur'] = $contributionRecur['id']; | |
481a74f4 | 560 | $result = civicrm_api3('contribution', 'getsingle', array('invoice_id' => $input['invoice'])); |
949babe8 JM |
561 | |
562 | $ids['contribution'] = $result['id']; | |
563 | //@todo hard - coding 'pending' for now | |
22e263ad | 564 | if ($result['contribution_status_id'] == 2) { |
2aa397bc | 565 | $isFirst = TRUE; |
949babe8 JM |
566 | } |
567 | // arg api won't get this - fix it | |
353ffa53 TO |
568 | $ids['contributionPage'] = CRM_Core_DAO::singleValueQuery("SELECT contribution_page_id FROM civicrm_contribution WHERE invoice_id = %1", array( |
569 | 1 => array( | |
570 | $ids['contribution'], | |
d5cc0fc2 | 571 | 'Integer', |
572 | ), | |
353ffa53 | 573 | )); |
949babe8 JM |
574 | // only handle component at this stage - not terribly sure how a recurring event payment would arise |
575 | // & suspec main function may be a victom of copy & paste | |
576 | // membership would be an easy add - but not relevant to my customer... | |
353ffa53 | 577 | $this->_component = $input['component'] = 'contribute'; |
949babe8 | 578 | $input['trxn_date'] = date('Y-m-d-H-i-s', strtotime(self::retrieve('time_created', 'String'))); |
9db13a40 | 579 | $paymentProcessorID = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType', |
949babe8 JM |
580 | 'PayPal', 'id', 'name' |
581 | ); | |
582 | ||
583 | if (!$this->validateData($input, $ids, $objects, TRUE, $paymentProcessorID)) { | |
584 | throw new CRM_Core_Exception('Data did not validate'); | |
585 | } | |
586 | return $this->recur($input, $ids, $objects, $isFirst); | |
587 | } | |
588 | ||
589 | /** | |
fe482240 | 590 | * Function check if transaction already exists. |
949babe8 | 591 | * @param string $trxn_id |
72b3a70c | 592 | * @return bool|void |
949babe8 | 593 | */ |
00be9182 | 594 | public function transactionExists($trxn_id) { |
22e263ad | 595 | if (CRM_Core_DAO::singleValueQuery("SELECT count(*) FROM civicrm_contribution WHERE trxn_id = %1", |
949babe8 | 596 | array( |
21dfd5f5 | 597 | 1 => array($trxn_id, 'String'), |
353ffa53 TO |
598 | )) |
599 | ) { | |
949babe8 JM |
600 | return TRUE; |
601 | } | |
c8aa607b | 602 | } |
96025800 | 603 | |
6a488035 | 604 | } |