Finish deprecating BaseIPN->completeTransaction
[civicrm-core.git] / CRM / Core / Payment / AuthorizeNetIPN.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
5 | |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
10 */
11
12 /**
13 *
14 * @package CRM
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
16 */
17 class CRM_Core_Payment_AuthorizeNetIPN extends CRM_Core_Payment_BaseIPN {
18
19 /**
20 * Constructor function.
21 *
22 * @param array $inputData
23 * contents of HTTP REQUEST.
24 *
25 * @throws CRM_Core_Exception
26 */
27 public function __construct($inputData) {
28 $this->setInputParameters($inputData);
29 parent::__construct();
30 }
31
32 /**
33 * @param string $component
34 *
35 * @return bool|void
36 */
37 public function main($component = 'contribute') {
38
39 //we only get invoice num as a key player from payment gateway response.
40 //for ARB we get x_subscription_id and x_subscription_paynum
41 $x_subscription_id = $this->retrieve('x_subscription_id', 'String');
42 $ids = $objects = $input = [];
43
44 if ($x_subscription_id) {
45 // Presence of the id means it is approved.
46 $input['component'] = $component;
47
48 // load post vars in $input
49 $this->getInput($input, $ids);
50
51 // load post ids in $ids
52 $this->getIDs($ids, $input);
53
54 // Attempt to get payment processor ID from URL
55 if (!empty($this->_inputParameters['processor_id'])) {
56 $paymentProcessorID = $this->_inputParameters['processor_id'];
57 }
58 else {
59 // This is an unreliable method as there could be more than one instance.
60 // Recommended approach is to use the civicrm/payment/ipn/xx url where xx is the payment
61 // processor id & the handleNotification function (which should call the completetransaction api & by-pass this
62 // entirely). The only thing the IPN class should really do is extract data from the request, validate it
63 // & call completetransaction or call fail? (which may not exist yet).
64 Civi::log()->warning('Unreliable method used to get payment_processor_id for AuthNet IPN - this will cause problems if you have more than one instance');
65 $paymentProcessorTypeID = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType',
66 'AuthNet', 'id', 'name'
67 );
68 $paymentProcessorID = (int) civicrm_api3('PaymentProcessor', 'getvalue', [
69 'is_test' => 0,
70 'options' => ['limit' => 1],
71 'payment_processor_type_id' => $paymentProcessorTypeID,
72 'return' => 'id',
73 ]);
74 }
75
76 if (!$this->validateData($input, $ids, $objects, TRUE, $paymentProcessorID)) {
77 return FALSE;
78 }
79 if (!empty($ids['paymentProcessor']) && $objects['contributionRecur']->payment_processor_id != $ids['paymentProcessor']) {
80 Civi::log()->warning('Payment Processor does not match the recurring processor id.', ['civi.tag' => 'deprecated']);
81 }
82
83 if ($component == 'contribute' && $ids['contributionRecur']) {
84 // check if first contribution is completed, else complete first contribution
85 $first = TRUE;
86 if ($objects['contribution']->contribution_status_id == 1) {
87 $first = FALSE;
88 }
89 return $this->recur($input, $ids, $objects, $first);
90 }
91 }
92 return TRUE;
93 }
94
95 /**
96 * @param array $input
97 * @param array $ids
98 * @param array $objects
99 * @param $first
100 *
101 * @return bool
102 */
103 public function recur($input, $ids, $objects, $first) {
104 $this->_isRecurring = TRUE;
105 $recur = &$objects['contributionRecur'];
106 $paymentProcessorObject = $objects['contribution']->_relatedObjects['paymentProcessor']['object'];
107
108 // do a subscription check
109 if ($recur->processor_id != $input['subscription_id']) {
110 CRM_Core_Error::debug_log_message('Unrecognized subscription.');
111 echo 'Failure: Unrecognized subscription<p>';
112 return FALSE;
113 }
114
115 $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
116
117 $now = date('YmdHis');
118
119 //load new contribution object if required.
120 if (!$first) {
121 // create a contribution and then get it processed
122 $contribution = new CRM_Contribute_BAO_Contribution();
123 $contribution->contact_id = $ids['contact'];
124 $contribution->financial_type_id = $objects['contributionType']->id;
125 $contribution->contribution_page_id = $ids['contributionPage'];
126 $contribution->contribution_recur_id = $ids['contributionRecur'];
127 $contribution->receive_date = $input['receive_date'];
128 $contribution->currency = $objects['contribution']->currency;
129 $contribution->payment_instrument_id = $objects['contribution']->payment_instrument_id;
130 $contribution->amount_level = $objects['contribution']->amount_level;
131 $contribution->address_id = $objects['contribution']->address_id;
132 $contribution->campaign_id = $objects['contribution']->campaign_id;
133 $contribution->_relatedObjects = $objects['contribution']->_relatedObjects;
134
135 $objects['contribution'] = &$contribution;
136 }
137 $objects['contribution']->invoice_id = md5(uniqid(rand(), TRUE));
138 $objects['contribution']->total_amount = $input['amount'];
139 $objects['contribution']->trxn_id = $input['trxn_id'];
140
141 $isFirstOrLastRecurringPayment = FALSE;
142 if ($input['response_code'] == 1) {
143 // Approved
144 if ($first) {
145 $recur->start_date = $now;
146 $recur->trxn_id = $recur->processor_id;
147 $isFirstOrLastRecurringPayment = CRM_Core_Payment::RECURRING_PAYMENT_START;
148 }
149
150 if (($recur->installments > 0) &&
151 ($input['subscription_paynum'] >= $recur->installments)
152 ) {
153 // this is the last payment
154 $recur->end_date = $now;
155 $isFirstOrLastRecurringPayment = CRM_Core_Payment::RECURRING_PAYMENT_END;
156 // This end date update should occur in ContributionRecur::updateOnNewPayment
157 // testIPNPaymentRecurNoReceipt has test cover.
158 $recur->save();
159 }
160 }
161 else {
162 // Declined
163 // failed status
164 $recur->contribution_status_id = array_search('Failed', $contributionStatus);
165 $recur->cancel_date = $now;
166 $recur->save();
167
168 $message = ts('Subscription payment failed - %1', [1 => htmlspecialchars($input['response_reason_text'])]);
169 CRM_Core_Error::debug_log_message($message);
170
171 // the recurring contribution has declined a payment or has failed
172 // so we just fix the recurring contribution and not change any of
173 // the existing contributions
174 // CRM-9036
175 return TRUE;
176 }
177
178 // check if contribution is already completed, if so we ignore this ipn
179 if ($objects['contribution']->contribution_status_id == 1) {
180 CRM_Core_Error::debug_log_message("Returning since contribution has already been handled.");
181 echo 'Success: Contribution has already been handled<p>';
182 return TRUE;
183 }
184
185 CRM_Contribute_BAO_Contribution::completeOrder($input, [
186 'related_contact' => $ids['related_contact'] ?? NULL,
187 'participant' => !empty($objects['participant']) ? $objects['participant']->id : NULL,
188 'contributionRecur' => !empty($objects['contributionRecur']) ? $objects['contributionRecur']->id : NULL,
189 ], $objects);
190
191 // Only Authorize.net does this so it is on the a.net class. If there is a need for other processors
192 // to do this we should make it available via the api, e.g as a parameter, changing the nuance
193 // from isSentReceipt to an array of which receipts to send.
194 // Note that there is site-by-site opinions on which notifications are good to send.
195 if ($isFirstOrLastRecurringPayment) {
196 CRM_Contribute_BAO_ContributionRecur::sendRecurringStartOrEndNotification($ids, $recur,
197 $isFirstOrLastRecurringPayment);
198 }
199
200 }
201
202 /**
203 * Get the input from passed in fields.
204 *
205 * @param array $input
206 *
207 * @throws \CRM_Core_Exception
208 */
209 public function getInput(&$input) {
210 $input['amount'] = $this->retrieve('x_amount', 'String');
211 $input['subscription_id'] = $this->retrieve('x_subscription_id', 'Integer');
212 $input['response_code'] = $this->retrieve('x_response_code', 'Integer');
213 $input['MD5_Hash'] = $this->retrieve('x_MD5_Hash', 'String', FALSE, '');
214 $input['response_reason_code'] = $this->retrieve('x_response_reason_code', 'String', FALSE);
215 $input['response_reason_text'] = $this->retrieve('x_response_reason_text', 'String', FALSE);
216 $input['subscription_paynum'] = $this->retrieve('x_subscription_paynum', 'Integer', FALSE, 0);
217 $input['trxn_id'] = $this->retrieve('x_trans_id', 'String', FALSE);
218 $input['receive_date'] = $this->retrieve('receive_date', 'String', FALSE, date('YmdHis', strtotime('now')));
219
220 if ($input['trxn_id']) {
221 $input['is_test'] = 0;
222 }
223 // Only assume trxn_id 'should' have been returned for success.
224 // Per CRM-17611 it would also not be passed back for a decline.
225 elseif ($input['response_code'] == 1) {
226 $input['is_test'] = 1;
227 $input['trxn_id'] = md5(uniqid(rand(), TRUE));
228 }
229
230 $billingID = CRM_Core_BAO_LocationType::getBilling();
231 $params = [
232 'first_name' => 'x_first_name',
233 'last_name' => 'x_last_name',
234 "street_address-{$billingID}" => 'x_address',
235 "city-{$billingID}" => 'x_city',
236 "state-{$billingID}" => 'x_state',
237 "postal_code-{$billingID}" => 'x_zip',
238 "country-{$billingID}" => 'x_country',
239 "email-{$billingID}" => 'x_email',
240 ];
241 foreach ($params as $civiName => $resName) {
242 $input[$civiName] = $this->retrieve($resName, 'String', FALSE);
243 }
244 }
245
246 /**
247 * Get ids from input.
248 *
249 * @param array $ids
250 * @param array $input
251 *
252 * @throws \CRM_Core_Exception
253 */
254 public function getIDs(&$ids, &$input) {
255 $ids['contact'] = $this->retrieve('x_cust_id', 'Integer', FALSE, 0);
256 $ids['contribution'] = $this->retrieve('x_invoice_num', 'Integer');
257
258 // joining with contribution table for extra checks
259 $sql = "
260 SELECT cr.id, cr.contact_id
261 FROM civicrm_contribution_recur cr
262 INNER JOIN civicrm_contribution co ON co.contribution_recur_id = cr.id
263 WHERE cr.processor_id = '{$input['subscription_id']}' AND
264 (cr.contact_id = {$ids['contact']} OR co.id = {$ids['contribution']})
265 LIMIT 1";
266 $contRecur = CRM_Core_DAO::executeQuery($sql);
267 $contRecur->fetch();
268 $ids['contributionRecur'] = $contRecur->id;
269 if ($ids['contact'] != $contRecur->contact_id) {
270 $message = ts("Recurring contribution appears to have been re-assigned from id %1 to %2, continuing with %2.", [1 => $ids['contact'], 2 => $contRecur->contact_id]);
271 CRM_Core_Error::debug_log_message($message);
272 $ids['contact'] = $contRecur->contact_id;
273 }
274 if (!$ids['contributionRecur']) {
275 $message = ts("Could not find contributionRecur id");
276 $log = new CRM_Utils_SystemLogger();
277 $log->error('payment_notification', ['message' => $message, 'ids' => $ids, 'input' => $input]);
278 throw new CRM_Core_Exception($message);
279 }
280
281 // get page id based on contribution id
282 $ids['contributionPage'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
283 $ids['contribution'],
284 'contribution_page_id'
285 );
286
287 if ($input['component'] == 'event') {
288 // FIXME: figure out fields for event
289 }
290 else {
291 // Get membershipId. Join with membership payment table for additional checks
292 $sql = "
293 SELECT m.id
294 FROM civicrm_membership m
295 INNER JOIN civicrm_membership_payment mp ON m.id = mp.membership_id AND mp.contribution_id = {$ids['contribution']}
296 WHERE m.contribution_recur_id = {$ids['contributionRecur']}
297 LIMIT 1";
298 if ($membershipId = CRM_Core_DAO::singleValueQuery($sql)) {
299 $ids['membership'] = $membershipId;
300 }
301
302 // FIXME: todo related_contact and onBehalfDupeAlert. Check paypalIPN.
303 }
304 }
305
306 /**
307 * @param string $name
308 * Parameter name.
309 * @param string $type
310 * Parameter type.
311 * @param bool $abort
312 * Abort if not present.
313 * @param null $default
314 * Default value.
315 *
316 * @throws CRM_Core_Exception
317 * @return mixed
318 */
319 public function retrieve($name, $type, $abort = TRUE, $default = NULL) {
320 $value = CRM_Utils_Type::validate(
321 empty($this->_inputParameters[$name]) ? $default : $this->_inputParameters[$name],
322 $type,
323 FALSE
324 );
325 if ($abort && $value === NULL) {
326 throw new CRM_Core_Exception("Could not find an entry for $name");
327 }
328 return $value;
329 }
330
331 }