-
Notifications
You must be signed in to change notification settings - Fork 5
/
payline.php
3086 lines (2885 loc) · 151 KB
/
payline.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Payline module for PrestaShop
*
* @author Monext <support@payline.com>
* @copyright Monext - http://www.payline.com
* @version 2.1.0
*/
if (!defined('_PS_VERSION_')) {
exit;
}
require_once(_PS_ROOT_DIR_ . DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR . 'payline' . DIRECTORY_SEPARATOR . 'lib' . DIRECTORY_SEPARATOR . 'autoload.php');
require_once(_PS_ROOT_DIR_ . DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR . 'payline' . DIRECTORY_SEPARATOR . 'class' . DIRECTORY_SEPARATOR . 'PaylineToken.php');
require_once(_PS_ROOT_DIR_ . DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR . 'payline' . DIRECTORY_SEPARATOR . 'class' . DIRECTORY_SEPARATOR . 'PaylinePaymentGateway.php');
class payline extends PaymentModule
{
/**
* Order state for Payline specific processes
* @var array
*/
protected $customOrderStateList = array(
'PAYLINE_ID_STATE_AUTOR' => array(
'name' => array(
'en' => 'Authorized payment',
'fr' => 'Paiement autorisé',
),
'send_email' => true,
'color' => '#dfe0ff',
'hidden' => false,
'delivery' => false,
'logable' => true,
'invoice' => true,
'template' => 'payment',
),
'PAYLINE_ID_STATE_PENDING' => array(
'name' => array(
'en' => 'Waiting for payment confirmation',
'fr' => 'En attente de confirmation de paiement',
),
'send_email' => false,
'color' => '#4169e1',
'hidden' => false,
'delivery' => false,
'logable' => true,
'invoice' => false,
'template' => 'payment',
),
'PAYLINE_ID_ORDER_STATE_NX' => array(
'name' => array(
'en' => 'Partially paid with Payline',
'fr' => 'Payé partiellement via Payline',
),
'send_email' => false,
'color' => '#bbddee',
'hidden' => false,
'delivery' => false,
'logable' => true,
'invoice' => true,
'template' => 'payment',
),
'PAYLINE_ID_STATE_ALERT_SCHEDULE' => array(
'name' => array(
'en' => 'Alert scheduler',
'fr' => 'Alerte échéancier',
),
'send_email' => false,
'color' => '#ffcdcf',
'hidden' => false,
'delivery' => false,
'logable' => true,
'invoice' => true,
),
);
// Errors constants
const INVALID_AMOUNT = 1;
const INVALID_CART_ID = 2;
const SUBSCRIPTION_ERROR = 3;
/**
* Module __construct
* @since 2.0.0
* @return void
*/
public function __construct()
{
$this->name = 'payline';
$this->tab = 'payments_gateways';
$this->module_key = '';
$this->version = '2.2.4';
$this->author = 'Monext';
$this->need_instance = true;
$this->bootstrap = true;
parent::__construct();
$this->displayName = 'Payline';
$this->description = $this->l('Pay with secure payline gateway');
$this->confirmUninstall = $this->l('Do you really want to remove the module?');
$this->limited_countries = array();
$this->limited_currencies = array();
// if (version_compare(_PS_VERSION_, '1.7.0.0', '>=')) {
// Set minimum compliancy for PrestaShop 1.7
// $this->ps_versions_compliancy = array('min' => '1.7.1.0', 'max' => _PS_VERSION_);
// }
}
/**
* Create Payline-related tables
* @since 2.1.0
* @return bool
*/
protected function createTables()
{
$res = Db::getInstance()->execute('
CREATE TABLE IF NOT EXISTS `'._DB_PREFIX_.'payline_token` (
`id_order` int(10) UNSIGNED NOT NULL,
`id_cart` int(10) UNSIGNED NOT NULL,
`token` varchar(255) NULL,
`payment_record_id` varchar(12),
`transaction_id` varchar(50),
UNIQUE `id_order` (`id_order`),
UNIQUE `id_cart` (`id_cart`)
) ENGINE='._MYSQL_ENGINE_.' CHARSET=utf8');
return $res;
}
/**
* Create custom order state
* @since 2.0.0
* @return bool
*/
public function createCustomOrderState()
{
foreach ($this->customOrderStateList as $configurationKey => $customOrderState) {
$idOrderState = Configuration::get($configurationKey);
if (!empty($idOrderState)) {
// Check if order state needs update...
$orderState = new OrderState($idOrderState);
if (!Validate::isLoadedObject($orderState)) {
$idOrderState = false;
}
}
if (empty($idOrderState)) {
// Order state has to be created
$orderState = new OrderState($idOrderState);
$orderState->logo = 'paylineLogo';
foreach ($customOrderState as $k => $v) {
if ($k != 'name') {
$orderState->{$k} = $v;
} else {
$orderState->name = array();
foreach ($v as $isoLang => $name) {
$idLang = Language::getIdByIso($isoLang);
if (!empty($idLang)) {
$orderState->name[$idLang] = $name;
}
}
}
}
if ($orderState->save()) {
// Save id_order_state
Configuration::updateValue($configurationKey, $orderState->id);
// Associate icon
$sourceLogo = _PS_MODULE_DIR_ . $this->name . DIRECTORY_SEPARATOR . 'logo.gif';
if (file_exists($sourceLogo) && is_readable($sourceLogo)) {
if (is_writable(_PS_IMG_DIR_ . 'os')) {
copy($sourceLogo, _PS_IMG_DIR_ . 'os' . DIRECTORY_SEPARATOR . (int)$orderState->id. '.gif');
}
}
} else {
return false;
}
} else {
// Update order state if needed
$orderState = new OrderState($idOrderState);
if (Validate::isLoadedObject($orderState)) {
$dirty = false;
foreach ($customOrderState as $k => $v) {
if ($k != 'name' && $k != 'color') {
if ($orderState->{$k} != $v) {
$dirty = true;
$orderState->{$k} = $v;
}
}
}
if ($dirty) {
try {
$orderState->save();
} catch (Exception $e) {
PrestaShopLogger::addLog('payline::createCustomOrderState - Cannot save Order State', 3, null, 'OrderState', $idOrderState);
}
}
}
}
}
return true;
}
/**
* Module install
* @since 2.0.0
* @return bool
*/
public function install()
{
// Init some configuration values
Configuration::updateValue('PAYLINE_API_STATUS', false);
Configuration::updateValue('PAYLINE_LIVE_MODE', false);
Configuration::updateValue('PAYLINE_MERCHANT_ID', false);
Configuration::updateValue('PAYLINE_ACCESS_KEY', false);
Configuration::updateValue('PAYLINE_POS', false);
Configuration::updateValue('PAYLINE_PROXY_HOST', false);
Configuration::updateValue('PAYLINE_PROXY_PORT', false);
Configuration::updateValue('PAYLINE_PROXY_LOGIN', false);
Configuration::updateValue('PAYLINE_PROXY_PASSWORD', false);
Configuration::updateValue('PAYLINE_CONTRACTS', false);
Configuration::updateValue('PAYLINE_ALT_CONTRACTS', false);
// Run parent install process, register to hooks, then force update module position
if (!parent::install()
// Generic hooks
|| !$this->registerHook('displayBackOfficeHeader')
|| !$this->registerHook('displayHeader')
|| !$this->registerHook('displayAdminOrderLeft')
|| !$this->registerHook('displayCustomerAccount')
|| !$this->registerHook('actionAdminOrdersListingResultsModifier')
|| !$this->registerHook('actionObjectOrderSlipAddAfter')
|| !$this->registerHook('actionOrderStatusUpdate')
|| (version_compare(_PS_VERSION_, '1.7.0.0', '<') && !$this->registerHook('displayPayment'))
|| !$this->registerHook('paymentReturn')
|| !$this->registerHook('paymentOptions')
// Install custom order state
|| !$this->createCustomOrderState()
// Install tables
|| !$this->createTables()
) {
return false;
}
return true;
}
/**
* Add the CSS & JavaScript files you want to be loaded in the FO.
* @since 2.0.0
* @return void
*/
public function hookDisplayHeader()
{
// Display alert if payment failed
if (($this->context->controller instanceof OrderController || $this->context->controller instanceof OrderOpcController || $this->context->controller instanceof paylinePaymentModuleFrontController) && Tools::getValue('paylineError') && Tools::getValue('paylinetoken')) {
$this->context->controller->errors[] = $this->l('There was an error while processing your previous payment.');
if (Tools::getIsset('paylineErrorCode')) {
$errorCode = (int)Tools::getValue('paylineErrorCode');
$humanErrorCode = $this->getHumanErrorCode($errorCode);
if (!empty($humanErrorCode)) {
$this->context->controller->errors[] = $humanErrorCode;
}
}
$this->context->controller->errors[] = $this->l('Please try to use another payment method or another credit card.');
}
// Add front.css on OPC
if ($this->isPaymentAvailable() && version_compare(_PS_VERSION_, '1.7.0.0', '<') && $this->context->controller instanceof OrderOpcController) {
$this->context->controller->addCSS($this->_path.'views/css/front.css');
}
}
/**
* Add the CSS & JavaScript files you want to be loaded in the BO.
* @since 2.0.0
* @return void
*/
public function hookDisplayBackOfficeHeader()
{
if (Tools::getValue('configure') == $this->name || Tools::getValue('module_name') == $this->name) {
$this->context->controller->addJquery();
$this->context->controller->addJqueryUi('ui.sortable');
$this->context->controller->addJS($this->_path.'views/js/back.js');
$this->context->controller->addCSS($this->_path.'views/css/back.css');
}
if (Tools::getValue('controller') == 'AdminOrders' && Tools::getValue('id_order')) {
$this->context->controller->addJquery();
$this->context->controller->addJS($this->_path.'views/js/order.js');
}
if (Tools::getValue('controller') == 'AdminOrders' && Tools::getValue('id_order') && Tools::getValue('paylineCapture')) {
$idTransaction = Tools::getValue('paylineCapture');
$idOrder = (int)Tools::getValue('id_order');
$order = new Order($idOrder);
if (!empty($idTransaction) && Validate::isLoadedObject($order)) {
// Process capture of a specific transaction
$this->processTransactionCapture($order, $idTransaction);
}
} elseif (Tools::getValue('controller') == 'AdminOrders' && Tools::getValue('id_order') && Tools::getValue('paylineReset')) {
$idTransaction = Tools::getValue('paylineReset');
$idOrder = (int)Tools::getValue('id_order');
$order = new Order($idOrder);
if (!empty($idTransaction) && Validate::isLoadedObject($order)) {
// Process reset of a specific transaction
$this->processTransactionReset($order, $idTransaction);
}
} elseif (Tools::getValue('controller') == 'AdminOrders' && Tools::getValue('id_order') && Tools::getValue('paylineProcessFullRefund')) {
$idOrder = (int)Tools::getValue('id_order');
$order = new Order($idOrder);
if (Validate::isLoadedObject($order)) {
// Process full refund of a specific order
$this->processFullOrderRefund($order);
}
} elseif (Tools::getValue('controller') == 'AdminOrders' && Tools::getValue('id_order') && Tools::getValue('paylineCaptureOK')) {
// Capture OK, show confirmation message
$this->context->controller->confirmations[] = $this->l('Order was successfully captured');
} elseif (Tools::getValue('controller') == 'AdminOrders' && Tools::getValue('id_order') && Tools::getValue('paylineResetOK')) {
// Reset OK, show confirmation message
$this->context->controller->confirmations[] = $this->l('Order was successfully cancelled (authorization reset)');
} elseif (Tools::getValue('controller') == 'AdminOrders' && Tools::getValue('id_order') && Tools::getValue('paylineFullRefundOK')) {
// Full refund OK, show confirmation message
$this->context->controller->confirmations[] = $this->l('Order was successfully refunded');
}
}
/**
* Process full refund on an order (from BO)
* @param Order $order
* @return void
*/
protected function processFullOrderRefund(Order $order)
{
// Check if transaction ID is the same
$idTransaction = null;
$orderPayments = OrderPayment::getByOrderReference($order->reference);
if (sizeof($orderPayments)) {
// Retrieve transaction ID
$paylineTransaction = current($orderPayments);
$idTransaction = $paylineTransaction->transaction_id;
$transaction = PaylinePaymentGateway::getTransactionInformations($idTransaction);
if (PaylinePaymentGateway::isValidResponse($transaction)) {
$refund = PaylinePaymentGateway::refundTransaction($idTransaction, null, $this->l('Manual refund from PrestaShop BackOffice'));
if (PaylinePaymentGateway::isValidResponse($refund)) {
// Refund OK
// Change order state
$history = new OrderHistory();
$history->id_order = (int)$order->id;
$history->changeIdOrderState(_PS_OS_REFUND_, (int)$order->id);
$history->addWithemail();
// Force reload of $order (because it has been edited by OrderHistory)
$order = new Order($order->id);
$orderInvoice = new OrderInvoice($order->invoice_number);
if (!Validate::isLoadedObject($orderInvoice)) {
$orderInvoice = null;
}
$orderSlipDetailsList = array();
// Amount for refund
$amountToRefund = 0.00;
foreach ($order->getProducts() as $idOrderDetail => $product) {
if (($product['product_quantity'] - $product['product_quantity_refunded']) > 0) {
$orderSlipDetailsList[(int)$idOrderDetail] = array(
'id_order_detail' => $idOrderDetail,
'quantity' => ($product['product_quantity'] - $product['product_quantity_refunded']),
'unit_price' => (float)$product['unit_price_tax_excl'],
'amount' => $product['unit_price_tax_incl'] * ($product['product_quantity'] - $product['product_quantity_refunded']),
);
}
$amountToRefund += round(($product['product_price_wt'] * $product['product_quantity']), 2);
}
$amountToRefund += (float)($order->total_shipping);
// Create order slip (available since PS 1.6.0.11)
if (method_exists('OrderSlip', 'create')) {
OrderSlip::create($order, $orderSlipDetailsList, null);
}
$this->addOrderPaymentAfterRefund($order, $amountToRefund * -1, null, $refund['transaction']['id'], null, null, $orderInvoice);
// Wait 1s because Payline API may take some time to be updated after a refund
sleep(1);
Tools::redirectAdmin($this->context->link->getAdminLink('AdminOrders') . '&id_order=' . $order->id . '&vieworder&paylineFullRefundOK=1');
} else {
// Refund NOK
$errors = PaylinePaymentGateway::getErrorResponse($refund);
$this->context->controller->errors[] = sprintf($this->l('Unable to process the refund, Payline reported the following error: “%s“ (code %s)'), $errors['longMessage'], $errors['code']);
}
} else {
$errors = PaylinePaymentGateway::getErrorResponse($transaction);
$this->context->controller->errors[] = sprintf($this->l('Unable to process the refund, Payline reported the following error: “%s“ (code %s)'), $errors['longMessage'], $errors['code']);
}
} else {
$this->context->controller->errors[] = $this->l('Unable to find any Payline transaction ID on this order');
}
}
/**
* Process transaction capture (from BO)
* @param Order $order
* @param int $idTransaction
* @param bool $doRedirect
* @return void
*/
protected function processTransactionCapture(Order $order, $idTransaction, $doRedirect = true)
{
$transaction = PaylinePaymentGateway::getTransactionInformations($idTransaction);
if (PaylinePaymentGateway::isValidResponse($transaction)) {
$capture = PaylinePaymentGateway::captureTransaction($idTransaction, 'CPT', $this->l('Manual capture from PrestaShop BackOffice'));
if (PaylinePaymentGateway::isValidResponse($capture)) {
// Capture OK
// Change order state
$history = new OrderHistory();
$history->id_order = (int)$order->id;
$history->changeIdOrderState(_PS_OS_PAYMENT_, (int)$order->id);
$history->addWithemail();
if ($doRedirect) {
// Wait 1s because Payline API may take some time to be updated after a capture
sleep(1);
Tools::redirectAdmin($this->context->link->getAdminLink('AdminOrders') . '&id_order=' . $order->id . '&vieworder&paylineCaptureOK=1');
}
} else {
// Capture NOK
$errors = PaylinePaymentGateway::getErrorResponse($capture);
$this->context->controller->errors[] = sprintf($this->l('Unable to process the capture, Payline reported the following error: “%s“ (code %s)'), $errors['longMessage'], $errors['code']);
}
} else {
$errors = PaylinePaymentGateway::getErrorResponse($transaction);
$this->context->controller->errors[] = sprintf($this->l('Unable to process the capture, Payline reported the following error: “%s“ (code %s)'), $errors['longMessage'], $errors['code']);
}
}
/**
* Process transaction reset (from BO)
* @param Order $order
* @param int $idTransaction
* @return void
*/
protected function processTransactionReset(Order $order, $idTransaction)
{
$transaction = PaylinePaymentGateway::getTransactionInformations($idTransaction);
if (PaylinePaymentGateway::isValidResponse($transaction)) {
$capture = PaylinePaymentGateway::resetTransaction($idTransaction, $this->l('Manual reset from PrestaShop BackOffice'));
if (PaylinePaymentGateway::isValidResponse($capture)) {
// Reset OK
// Change order state
$history = new OrderHistory();
$history->id_order = (int)$order->id;
$history->changeIdOrderState(_PS_OS_ERROR_, (int)$order->id);
$history->addWithemail();
// Wait 1s because Payline API may take some time to be updated after a capture
sleep(1);
Tools::redirectAdmin($this->context->link->getAdminLink('AdminOrders') . '&id_order=' . $order->id . '&vieworder&paylineResetOK=1');
} else {
// Reset NOK
$errors = PaylinePaymentGateway::getErrorResponse($capture);
$this->context->controller->errors[] = sprintf($this->l('Unable to process the reset, Payline reported the following error: “%s“ (code %s)'), $errors['longMessage'], $errors['code']);
}
} else {
$errors = PaylinePaymentGateway::getErrorResponse($transaction);
$this->context->controller->errors[] = sprintf($this->l('Unable to process the reset, Payline reported the following error: “%s“ (code %s)'), $errors['longMessage'], $errors['code']);
}
}
/**
* Display payment result on confirmation page
* @since 2.1.0
* @param array $params
* @return void
*/
public function hookActionAdminOrdersListingResultsModifier($params)
{
$idOrderStateNx = (int)Configuration::get('PAYLINE_ID_ORDER_STATE_NX');
if (!empty($idOrderStateNx) && !empty($params['list']) && is_array($params['list'])) {
foreach ($params['list'] as $orderListRow) {
$idOrderList[] = (int)$orderListRow['id_order'];
}
// Get id_order list with the right order state
$idOrderWaitingList = array();
$idOrderWaitingListResult = Db::getInstance()->executeS('SELECT `id_order` FROM `'._DB_PREFIX_.'orders` WHERE `current_state`=' . (int)$idOrderStateNx . ' AND `id_shop` IN ('.implode(', ', Shop::getContextListShopID()).')');
if (is_array($idOrderWaitingListResult)) {
foreach ($idOrderWaitingListResult as $row) {
$idOrderWaitingList[] = (int)$row['id_order'];
}
}
foreach ($params['list'] as &$orderListRow) {
if (in_array((int)$orderListRow['id_order'], $idOrderWaitingList)) {
// Retrieve info from Payline
$order = new Order((int)$orderListRow['id_order']);
if (Validate::isLoadedObject($order) && $order->module == 'payline') {
// Retrieve original transaction via token
$token = PaylineToken::getTokenByIdOrder($order->id);
if (!empty($token)) {
$originalTransaction = PaylinePaymentGateway::getPaymentInformations($token);
if (!empty($originalTransaction['paymentRecordId']) && !empty($originalTransaction['payment']['mode']) &&
$originalTransaction['payment']['mode'] == 'NX' &&
isset($originalTransaction['billingRecordList']) && is_array($originalTransaction['billingRecordList']) &&
isset($originalTransaction['billingRecordList']['billingRecord']) && is_array($originalTransaction['billingRecordList']['billingRecord'])
) {
$paymentRecord = PaylinePaymentGateway::getPaymentRecord($originalTransaction['payment']['contractNumber'], $originalTransaction['paymentRecordId']);
if (!empty($paymentRecord['recurring'])) {
// Retrieve validated payment count
$validTransactionCount = PaylinePaymentGateway::getValidatedRecurringPayment($paymentRecord);
// Change order state name
$orderListRow['osname'] = sprintf($this->l('Scheduler %s/%s paid'), (int)$validTransactionCount, (int)$paymentRecord['recurring']['billingLeft']);
}
}
}
}
}
}
}
}
/**
* Display subscribe information into customer account
* @since 2.2.0
* @param array $params
* @return string
*/
public function hookDisplayCustomerAccount($params)
{
$output = '';
$this->context->smarty->assign(array(
'subscriptionControllerLink' => $this->context->link->getModuleLink('payline', 'subscriptions', array(), true),
));
if (version_compare(_PS_VERSION_, '1.7.0.0', '>=')) {
$output .= $this->context->smarty->fetch($this->local_path.'views/templates/hook/1.7/customer_account.tpl');
} else {
$output .= $this->display(__FILE__, 'customer_account.tpl');
}
return $output;
}
/**
* Display payment result on confirmation page
* @since 2.0.0
* @param array $params
* @return string
*/
public function hookDisplayAdminOrderLeft($params)
{
// Check if module is enabled
if (!$this->active) {
return;
}
$output = '';
if (!empty($params['id_order'])) {
$order = new Order($params['id_order']);
if (Validate::isLoadedObject($order) && $order->module == 'payline') {
// Retrieve original transaction via token
$token = PaylineToken::getTokenByIdOrder($order->id);
if (!empty($token)) {
$originalTransaction = PaylinePaymentGateway::getPaymentInformations($token);
} else {
$idTransaction = PaylineToken::getIdTransactionByIdOrder($order->id);
if (!empty($idTransaction)) {
$originalTransaction = PaylinePaymentGateway::getTransactionInformations($idTransaction);
}
}
if (!empty($originalTransaction['formatedPrivateDataList']['payment_method']) && $originalTransaction['formatedPrivateDataList']['payment_method'] == PaylinePaymentGateway::SUBSCRIBE_PAYMENT_METHOD) {
// Subscription, get payment recordId
$paymentRecordId = PaylineToken::getPaymentRecordIdByIdOrder($order->id);
if (!empty($paymentRecordId)) {
// Get payment record
$paymentRecord = PaylinePaymentGateway::getPaymentRecord($originalTransaction['payment']['contractNumber'], $paymentRecordId);
if (PaylinePaymentGateway::isValidResponse($paymentRecord, array('02500'))) {
// Add Order ID to each rows
foreach ($paymentRecord['billingRecordList']['billingRecord'] as &$billingRecord) {
if (isset($billingRecord['transaction']['id'])) {
$linkedIdOrder = PaylineToken::getIdOrderByIdTransaction($billingRecord['transaction']['id']);
if (!empty($linkedIdOrder)) {
$billingRecord['pl_linkedIdOrder'] = $linkedIdOrder;
$billingRecord['pl_linkToOrder'] = $this->context->link->getAdminLink('AdminOrders') . '&id_order=' . $linkedIdOrder . '&vieworder';
}
}
}
// Display all records
$this->context->smarty->assign(array(
'id_order' => (int)$params['id_order'],
'billingListRec' => $paymentRecord['billingRecordList']['billingRecord'],
'paymentRecordId' => $paymentRecordId,
));
}
}
} elseif (!empty($originalTransaction['payment']['mode']) && $originalTransaction['payment']['mode'] == 'NX') {
if (isset($originalTransaction['billingRecordList']) && is_array($originalTransaction['billingRecordList']) && isset($originalTransaction['billingRecordList']['billingRecord']) && is_array($originalTransaction['billingRecordList']['billingRecord'])) {
// Display all records
$this->context->smarty->assign(array(
'id_order' => (int)$params['id_order'],
'billingList' => $originalTransaction['billingRecordList']['billingRecord'],
'paymentRecordId' => $originalTransaction['paymentRecordId'],
));
}
}
// Retrieve order payments
$orderPayments = OrderPayment::getByOrderReference($order->reference);
$sameTransactionID = false;
$transactionsList = array();
foreach ($orderPayments as $orderPayment) {
if (preg_match('/payline/i', $orderPayment->payment_method) && !empty($orderPayment->transaction_id)) {
$transaction = PaylinePaymentGateway::getTransactionInformations($orderPayment->transaction_id);
if (isset($transaction['associatedTransactionsList']) && isset($transaction['associatedTransactionsList']['associatedTransactions']) && sizeof($transaction['associatedTransactionsList']['associatedTransactions'])) {
foreach ($transaction['associatedTransactionsList']['associatedTransactions'] as $associatedTransaction) {
$transactionsList[$associatedTransaction['transactionId']] = $associatedTransaction;
$transactionsList[$associatedTransaction['transactionId']]['originalTransaction'] = $transaction;
}
}
}
}
// Do we allow capture action ?
$allowCapture = !count($order->getHistory((int)$this->context->language->id, false, true, OrderState::FLAG_PAID));
// Do we allow refund action ?
$allowRefund = !$allowCapture && !count($order->getHistory((int)$this->context->language->id, _PS_OS_REFUND_, true));
// Do we allow reset action
$allowReset = $allowCapture;
$this->context->smarty->assign(array(
'id_order' => (int)$params['id_order'],
'transactionsList' => $transactionsList,
'allowCapture' => $allowCapture,
'allowRefund' => $allowRefund,
'allowReset' => $allowReset,
));
if (version_compare(_PS_VERSION_, '1.7.0.0', '>=')) {
$output .= $this->context->smarty->fetch($this->local_path.'views/templates/hook/admin_order.tpl');
} else {
$output .= $this->display(__FILE__, 'admin_order.tpl');
}
}
}
return $output;
}
/**
* Process capture when order enter in a specific state
* @since 2.0.0
* @param array $params
* @return void
*/
public function hookActionOrderStatusUpdate($params)
{
if (!empty($params['id_order']) && !empty($params['newOrderStatus']) && Validate::isLoadedObject($params['newOrderStatus']) && $params['newOrderStatus']->id == Configuration::get('PAYLINE_WEB_CASH_VALIDATION') && '100' == Configuration::get('PAYLINE_WEB_CASH_ACTION')) {
// We have to trigger capture here
$idTransaction = null;
$order = new Order((int)$params['id_order']);
if (Validate::isLoadedObject($order)) {
$orderPayments = OrderPayment::getByOrderReference($order->reference);
if (sizeof($orderPayments)) {
// Retrieve transaction ID
$paylineTransaction = current($orderPayments);
$idTransaction = $paylineTransaction->transaction_id;
}
}
if (!empty($idTransaction) && Validate::isLoadedObject($order)) {
// Process capture of a specific transaction
$this->processTransactionCapture($order, $idTransaction, false);
}
}
}
/**
* Process partial refund on card used for the payment
* @since 2.0.0
* @param array $params
* @return void
*/
public function hookActionObjectOrderSlipAddAfter($params)
{
// Prevent order slip creation in case we are into a full refund process
if (Tools::getValue('paylineProcessFullRefund')) {
return;
}
$order = new Order($params['object']->id_order);
$amountToRefund = (float)$params['object']->total_products_tax_incl + (float)$params['object']->total_shipping_tax_incl;
if (Context::getContext()->employee->isLoggedBack()
&& Validate::isLoadedObject($order)
&& $order->module == $this->name
&& $order->hasBeenPaid()
&& $amountToRefund > 0
&& !Tools::getValue('generateDiscount') && !Tools::getValue('generateDiscountRefund')) {
$idTransaction = null;
$orderPayments = OrderPayment::getByOrderReference($order->reference);
if (sizeof($orderPayments)) {
// Retrieve transaction ID
$paylineTransaction = current($orderPayments);
$idTransaction = $paylineTransaction->transaction_id;
// Get transaction informations
$transaction = PaylinePaymentGateway::getTransactionInformations($idTransaction);
if (PaylinePaymentGateway::isValidResponse($transaction)) {
$refund = PaylinePaymentGateway::refundTransaction($idTransaction, $amountToRefund, $this->l('Manual partial refund from PrestaShop BackOffice'));
if (PaylinePaymentGateway::isValidResponse($refund)) {
// Refund OK
$orderInvoice = new OrderInvoice($order->invoice_number);
if (!Validate::isLoadedObject($orderInvoice)) {
$orderInvoice = null;
}
$this->addOrderPaymentAfterRefund($order, $amountToRefund * -1, null, $refund['transaction']['id'], null, null, $orderInvoice);
// Wait 1s because Payline API may take some time to be updated after a refund
sleep(1);
// Partial refund OK, show confirmation message
$this->context->controller->confirmations[] = $this->l('Order was successfully partially refunded');
} else {
// Refund NOK
$errors = PaylinePaymentGateway::getErrorResponse($refund);
$this->context->controller->errors[] = sprintf($this->l('Unable to process the refund, Payline reported the following error: “%s“ (code %s)'), $errors['longMessage'], $errors['code']);
}
} else {
$errors = PaylinePaymentGateway::getErrorResponse($transaction);
$this->context->controller->errors[] = sprintf($this->l('Unable to process the refund, Payline reported the following error: “%s“ (code %s)'), $errors['longMessage'], $errors['code']);
}
} else {
$this->context->controller->errors[] = $this->l('Unable to find any Payline transaction ID on this order');
}
}
}
/**
* Display payment result on confirmation page
* @since 2.0.0
* @param string $params
* @return array
*/
public function hookPaymentReturn($params)
{
// Check if module is enabled and PS < 1.7
if (!$this->active || version_compare(_PS_VERSION_, '1.7.0.0', '>=')) {
return;
}
// Order
$order = $params['objOrder'];
// Last order state
// $state = $order->getCurrentState();
$idTransaction = null;
$orderPayments = OrderPayment::getByOrderReference($order->reference);
if (sizeof($orderPayments)) {
// Retrieve transaction ID
$paylineTransaction = current($orderPayments);
$idTransaction = $paylineTransaction->transaction_id;
}
$this->smarty->assign(array(
'payline_transaction_id' => $idTransaction,
));
return $this->display(__FILE__, 'payment_return.tpl');
}
/**
* Display payment button into payment module list (last order step)
* @since 2.0.0
* @param array $params
* @return array of PaymentOption
*/
public function hookPaymentOptions($params)
{
// Check if module is enabled and payment gateway is configured for at least one payment method
// Check if current cart currency is allowed
if (!$this->isPaymentAvailable()) {
return;
}
$paymentMethodList = array();
// Assign to template enabled cards/contracts
$currentPos = Configuration::get('PAYLINE_POS');
$enabledContracts = PaylinePaymentGateway::getEnabledContracts();
$contractsList = PaylinePaymentGateway::getContractsByPosLabel($currentPos, $enabledContracts, true);
$this->smarty->assign(array(
'payline_contracts' => $contractsList,
));
// Web payment
if (Configuration::get('PAYLINE_WEB_CASH_ENABLE')) {
$uxMode = Configuration::get('PAYLINE_WEB_CASH_UX');
$webCash = new PrestaShop\PrestaShop\Core\Payment\PaymentOption();
$webCashTitle = Configuration::get('PAYLINE_WEB_CASH_TITLE', $this->context->language->id);
$webCashSubTitle = Configuration::get('PAYLINE_WEB_CASH_SUBTITLE', $this->context->language->id);
if (!strlen($webCashTitle)) {
$webCashTitle = $this->l('Simple payment');
}
$webCash->setModuleName($this->name)->setCallToActionText($webCashTitle);
// Add additionnal information text
$this->smarty->assign(array(
'payline_title' => $webCashTitle,
'payline_subtitle' => $webCashSubTitle,
));
$webCash->setAdditionalInformation($this->fetch('module:payline/views/templates/front/1.7/payment_additional_information.tpl'));
if ($uxMode == 'lightbox') {
list($paymentRequest, $paymentRequestParams) = PaylinePaymentGateway::createPaymentRequest($this->context, PaylinePaymentGateway::WEB_PAYMENT_METHOD);
if (!empty($paymentRequest['token'])) {
$this->smarty->assign(array(
'payline_token' => $paymentRequest['token'],
'payline_ux_mode' => Configuration::get('PAYLINE_WEB_CASH_UX'),
'payline_assets' => PaylinePaymentGateway::getAssetsToRegister(),
'payline_title' => $webCashTitle,
'payline_subtitle' => $webCashSubTitle,
));
$webCash->setAction('javascript:Payline.Api.init()');
$webCash->setAdditionalInformation($this->fetch('module:payline/views/templates/front/1.7/lightbox.tpl'));
} else {
$webCash = null;
}
} elseif ($uxMode == 'redirect') {
list($paymentRequest, $paymentRequestParams) = PaylinePaymentGateway::createPaymentRequest($this->context, PaylinePaymentGateway::WEB_PAYMENT_METHOD);
if (!empty($paymentRequest['redirectURL'])) {
$webCash->setAction($paymentRequest['redirectURL']);
} else {
$webCash = null;
}
} else {
$webCash->setAction($this->context->link->getModuleLink($this->name, 'payment', array(), true));
}
if ($webCash !== null) {
$paymentMethodList[] = $webCash;
}
}
// Recurring payment
if (Configuration::get('PAYLINE_RECURRING_ENABLE') && (!Configuration::get('PAYLINE_RECURRING_TRIGGER') || ($this->context->cart->getOrderTotal() > Configuration::get('PAYLINE_RECURRING_TRIGGER')))) {
$uxMode = Configuration::get('PAYLINE_RECURRING_UX');
$recurringPayment = new PrestaShop\PrestaShop\Core\Payment\PaymentOption();
$recurringTitle = Configuration::get('PAYLINE_RECURRING_TITLE', $this->context->language->id);
$recurringSubTitle = Configuration::get('PAYLINE_RECURRING_SUBTITLE', $this->context->language->id);
if (!strlen($recurringTitle)) {
$recurringTitle = $this->l('Nx payment');
}
$recurringPayment->setModuleName($this->name)->setCallToActionText($recurringTitle);
// Add additionnal information text
$this->smarty->assign(array(
'payline_title' => $recurringTitle,
'payline_subtitle' => $recurringSubTitle,
));
$recurringPayment->setAdditionalInformation($this->fetch('module:payline/views/templates/front/1.7/payment_additional_information.tpl'));
if ($uxMode == 'lightbox') {
list($paymentRequest, $paymentRequestParams) = PaylinePaymentGateway::createPaymentRequest($this->context, PaylinePaymentGateway::RECURRING_PAYMENT_METHOD);
if (!empty($paymentRequest['token'])) {
$this->smarty->assign(array(
'payline_token' => $paymentRequest['token'],
'payline_ux_mode' => Configuration::get('PAYLINE_RECURRING_UX'),
'payline_assets' => PaylinePaymentGateway::getAssetsToRegister(),
'payline_title' => $recurringTitle,
'payline_subtitle' => $recurringSubTitle,
));
$recurringPayment->setAction('javascript:Payline.Api.init()');
$recurringPayment->setAdditionalInformation($this->fetch('module:payline/views/templates/front/1.7/lightbox.tpl'));
} else {
$recurringPayment = null;
}
} elseif ($uxMode == 'redirect') {
list($paymentRequest, $paymentRequestParams) = PaylinePaymentGateway::createPaymentRequest($this->context, PaylinePaymentGateway::RECURRING_PAYMENT_METHOD);
if (!empty($paymentRequest['redirectURL'])) {
$recurringPayment->setAction($paymentRequest['redirectURL']);
} else {
$recurringPayment = null;
}
} else {
$recurringPayment->setAction($this->context->link->getModuleLink($this->name, 'payment_nx', array(), true));
}
if ($recurringPayment !== null) {
$paymentMethodList[] = $recurringPayment;
}
}
// Subscribe payment (must be logged customer, not guest)
if (Configuration::get('PAYLINE_SUBSCRIBE_ENABLE') && !empty($this->context->cookie->id_customer) && $this->context->customer->isLogged()) {
$subscribePayment = new PrestaShop\PrestaShop\Core\Payment\PaymentOption();
$subscribeTitle = Configuration::get('PAYLINE_SUBSCRIBE_TITLE', $this->context->language->id);
$subscribeSubTitle = Configuration::get('PAYLINE_SUBSCRIBE_SUBTITLE', $this->context->language->id);
if (!strlen($subscribeTitle)) {
$subscribeTitle = $this->l('Recurring payment');
}
$subscribePayment->setModuleName($this->name)->setCallToActionText($subscribeTitle);
// Add additionnal information text
$this->smarty->assign(array(
'payline_title' => $subscribeTitle,
'payline_subtitle' => $subscribeSubTitle,
));
$subscribePayment->setAdditionalInformation($this->fetch('module:payline/views/templates/front/1.7/payment_additional_information.tpl'));
list($paymentRequest, $paymentRequestParams) = PaylinePaymentGateway::createPaymentRequest($this->context, PaylinePaymentGateway::SUBSCRIBE_PAYMENT_METHOD);
if (!empty($paymentRequest['redirectURL'])) {
$subscribePayment->setAction($paymentRequest['redirectURL']);
} else {
$subscribePayment = null;
}
if ($subscribePayment !== null) {
// Retrieve exclusive product list
$exclusiveProductList = $this->getSubscribeProductList();
if (!Configuration::get('PAYLINE_SUBSCRIBE_EXCLUSIVE')) {
// Non-exclusive method, check if products in cart are correct and eligible
if (is_array($exclusiveProductList) && sizeof($exclusiveProductList)) {
$cartProductList = $this->context->cart->getProducts();
if (is_array($cartProductList)) {
foreach ($cartProductList as $cartProduct) {
// We have to disable this method, no product are eligible
if (!in_array($cartProduct['id_product'], $exclusiveProductList)) {
$subscribePayment = null;
break;
}
}
}
}
if ($subscribePayment !== null) {
$paymentMethodList[] = $subscribePayment;
}
} else {
// Exclusive method, check if products in cart are correct
$cartProductList = $this->context->cart->getProducts();
$cartIntegrity = false;
$cartFullIntegrity = true;
$breakingIntegrityList = array();
// We have at least, one product OK
if (is_array($cartProductList)) {
foreach ($cartProductList as $cartProduct) {
if (in_array($cartProduct['id_product'], $exclusiveProductList)) {
$cartIntegrity = true;
} else {
$cartFullIntegrity = false;
$breakingIntegrityList[] = $cartProduct['id_product'];
}
}
}
if (!$cartIntegrity) {
// We have to disable this method, no product are eligible
$subscribePayment = null;
} elseif (!$cartFullIntegrity) {
// We have to disable payment via Payline, wrong cart content
$breakingProductList = array();
foreach ($breakingIntegrityList as $idProduct) {
$product = new Product($idProduct, false, $this->context->cookie->id_lang);
$breakingProductList[] = $product->name;
}
$this->smarty->assign(array(
'paylineBreakingProductList' => $breakingProductList
));
$subscribePayment->setAdditionalInformation($this->fetch('module:payline/views/templates/front/1.7/payment_sub_error.tpl'));
if ($subscribePayment !== null) {
$paymentMethodList[] = $subscribePayment;
}
} elseif ($cartIntegrity && $cartFullIntegrity) {
// We have to hide any other methods...
$paymentMethodList = array($subscribePayment);
}
}
}
}
return $paymentMethodList;
}
/**
* Display payment button into payment module list (last order step)
* @since 2.0.0
* @param array $params
* @return string
*/
public function hookDisplayPayment($params)
{
// Check if module is enabled and payment gateway is configured for at least one payment method
// Check if PS < 1.7
if (!$this->isPaymentAvailable() || version_compare(_PS_VERSION_, '1.7.0.0', '>=')) {
return;
}
// Assign to template enabled cards/contracts