-
Notifications
You must be signed in to change notification settings - Fork 5
/
WC_Gateway_Vipps.class.php
3867 lines (3361 loc) · 208 KB
/
WC_Gateway_Vipps.class.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
/*
Delegate class for talking to Vipps MobilePay, encapsulating all the low-level behaviour and mapping error codes to exceptions
This file is part of the plugin Pay with Vipps and MobilePay for WooCommerce
Copyright (c) 2019 WP-Hosting AS
MIT License
Copyright (c) 2019 WP-Hosting AS
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
if ( ! defined('ABSPATH') ) {
exit; // Exit if accessed directly
}
require_once(dirname(__FILE__) . "/VippsApi.class.php");
class WC_Gateway_Vipps extends WC_Payment_Gateway {
public $form_fields = null;
public $dev_form_fields = null;
public $id = 'vipps';
public $icon = '';
public $has_fields = true;
public $method_title = 'Vipps MobilePay';
public $title = 'Vipps MobilePay';
public $method_description = "";
public $apiurl = null;
public $testapiurl = null;
public $api = null;
public $supports = null;
public $express_checkout_supported_product_types;
public $captured_statuses;
private static $instance = null; // This class uses the singleton pattern to make actions easier to handle
protected $keyset = null; // This will contain all api keys etc for the gateway, keyed on the merchant serial number.
// Just to avoid calculating these alot
private $page_templates = null;
private $page_list = null;
// This returns the singleton instance of this class
public static function instance() {
if (null === self::$instance) {
self::$instance = new self();
}
return self::$instance;
}
public function add_image_upload_setting_widget () {
add_action('admin_enqueue_scripts', function ($suff) {
if ($suff == 'woocommerce_page_wc-settings' && (($_REQUEST['section'] ?? false) == 'vipps')) {
if (!did_action('wp_enqueue_media')) {
wp_enqueue_media();
}
}
});
}
// Generates html for the woo_vipps_image settings widget type
public function generate_woo_vipps_image_html ($key, $field) {
$field_key = $this->get_field_key( $key );
$defaults = array(
'title' => '',
'disabled' => false,
'class' => '',
'css' => '',
'placeholder' => '',
'type' => 'woo_vipps_image',
'desc_tip' => false,
'description' => '',
'custom_attributes' => array(),
);
$data = wp_parse_args( $field, $defaults );
$imgid = intval($this->get_option($key));
$image = $imgid ? wp_get_attachment_image_src($imgid) : "";
ob_start();
?>
<tr valign="top">
<th scope="row" class="titledesc">
<label for="<?php echo esc_attr( $field_key ); ?>"><?php echo wp_kses_post( $data['title'] ); ?> <?php echo $this->get_tooltip_html( $data ); // WPCS: XSS ok. ?></label>
</th>
<td class="forminp">
<fieldset>
<legend class="screen-reader-text"><span><?php echo wp_kses_post( $data['title'] ); ?></span></legend>
<?php if ($image): ?>
<a href="#" class="woo-vipps-image-upload"><img style="max-width: 360px; max-height: 360px" src="<?php echo $image[0]; ?>" /><span style="display:none" class='uploadtext'><?php _e('Upload image', 'woo-vipps'); ?></span></a>
<a href="#" class="woo-vipps-image-remove"><?php _e('Remove image', 'woo-vipps');?></a>
<?php else: ?>
<a href="#" class="woo-vipps-image-upload"><img style="display:none; max-width:360px; max-height: 360px"/><span class='uploadtext'><?php _e('Upload image', 'woo-vipps'); ?></span></a>
<a href="#" class="woo-vipps-image-remove" style="display:none;"><?php _e('Remove image', 'woo-vipps');?></a>
<?php endif; ?>
<input type="hidden" class="woo-vipps-image-input <?php echo esc_attr( $data['class'] ); ?>" name="<?php echo esc_attr( $field_key ); ?>" id="<?php echo esc_attr( $field_key ); ?>" value="<?php echo esc_attr($imgid); ?>" <?php echo $this->get_custom_attribute_html( $data ); // WPCS: XSS ok. ?> />
<?php echo $this->get_description_html( $data ); // WPCS: XSS ok. ?>
</fieldset>
</td>
</tr>
<?php
return ob_get_clean();
}
public function __construct() {
$this->testapiurl = 'https://apitest.vipps.no';
$this->apiurl = 'https://api.vipps.no';
$this->method_description = __('Offer Vipps or MobilePay as a payment method', 'woo-vipps');
$this->method_title = __('Vipps MobilePay','woo-vipps');
$this->title = __('Vipps MobilePay','woo-vipps');
$this->icon = plugins_url('img/vmp-logo.png',__FILE__);
$this->init_form_fields();
$this->init_settings();
$this->api = new VippsApi($this);
$this->supports = array('products','refunds');
// We can't guarantee any particular product type being supported, so we must enumerate those we are certain about
// IOK 2020-04-21 Add support for WooCommerce Product Bundles
$supported_types= array('simple','variable','variation','bundle', 'yith_bundle', 'gift-card');
$this->express_checkout_supported_product_types = apply_filters('woo_vipps_express_checkout_supported_product_types', $supported_types);
add_action('woocommerce_update_options_payment_gateways_' . $this->id, array( $this, 'process_admin_options') );
add_action('admin_init', array($this, 'add_image_upload_setting_widget'));
// Capturing, refunding and cancelling the order when transitioning states:
// This are the statuses for which the Vipps MobilePay plugin should try to ensure capture has been made.
// Normally, this is 'processing' and 'completed', but plugins may define other statuses. IOK 2018-10-05
// It is also possible to remove 'processing' from this list. If you do, you may use it as the end-state of the
// Vipps MobilePay transaction (see below in after_vipps_order_status) IOK 2018-12-05
$resultstatus = $this->get_option('result_status');
$captured_statuses = apply_filters('woo_vipps_captured_statuses', array('processing', 'completed'));
$captured_statuses = array_diff($captured_statuses, array($resultstatus));
$this->captured_statuses = $captured_statuses;
$non_completed_captured_statuses = array_diff($captured_statuses, array('completed'));
// This ensures that funds are captured when transitioning from 'on hold' to a status where the money
// should be captured, and refunded when moved from this status to cancelled or refunded
foreach($captured_statuses as $capstatus) {
add_action('woocommerce_order_status_' . $capstatus, array($this, 'maybe_capture_payment'));
}
// We will refund money on cancelled orders, but only if they are *relatively new*. This is to
// avoid accidents and issues where old orders are *somehow* cancelled even though they are complete. IOK 2024-08-12
add_action('woocommerce_order_status_cancelled', array($this, 'order_status_cancelled_wrapper'));
add_action('woocommerce_order_status_refunded', array($this, 'maybe_refund_payment'));
add_action('woocommerce_order_status_pending_to_cancelled', array($this, 'maybe_delete_order'), 99999, 1);
add_action('woocommerce_payment_complete', array($this, 'order_payment_complete'), 10, 1);
}
public function get_icon () {
$src = $this->icon;
if ($this->get_payment_method_name() == "Vipps") {
$src = plugins_url('img/vipps-mark.svg',__FILE__);
} else {
$src = plugins_url('img/mobilepay-mark.png',__FILE__);
}
return '<img src="' . esc_attr($src) . '" alt="' . $this->get_payment_method_name() . '">';
}
// True iff this gateway is currently in test mode. IOK 2019-08-30
public function is_test_mode() {
if (VIPPS_TEST_MODE) return true;
if ($this->get_option('developermode') == 'yes' && $this->get_option('testmode') == 'yes') return true;
return false;
}
// These abstraction gets the correct client id and so forth based on whether or not test mode is on
// "test mode" is now per MSN, so we accept that as an argument IOK 2023-12-19
public function apiurl ($msn="") {
$msn = $msn ?? $this->get_merchant_serial();
$keyset = $this->get_keyset();
$entry = $keyset ? ($keyset[$msn] ?? null) : null;
if (!$entry) {
$testmode = $this->is_test_mode();
} else {
$testmode = $entry['testmode'];
}
if ($testmode) return $this->testapiurl;
return $this->apiurl;
}
// This returns the *current* merchant serial number. There may be more than one, for instance if the test mode is on.
// IOK 2023-12-19
public function get_merchant_serial() {
$merch = $this->get_option('merchantSerialNumber');
$testmerch = @$this->get_option('merchantSerialNumber_test');
if (!empty($testmerch) && $this->is_test_mode()) return $testmerch;
return $merch;
}
// Returns a table of all the keydata of this instance, keyed on MSN. IOK 2023-12-19
public function get_keyset() {
if ($this->keyset) return $this->keyset;
$stored = get_transient('_vipps_keyset');
if ($stored) {
return $stored;
}
$keyset = [];
$main = $this->get_option('merchantSerialNumber');
if ($main) {
$data = ['client_id'=>$clientid=$this->get_option('clientId'),
'client_secret' => $this->get_option('secret'),
'sub_key'=>$this->get_option('Ocp_Apim_Key_eCommerce')];
if (! in_array(false, array_map('boolval', array_values($data)))) {
$data['testmode'] = 0; // Must add after
$keyset[$main] = $data;
}
}
$test = @$this->get_option('merchantSerialNumber_test');
$testmode = @$this->get_option('testmode');
if ($testmode === 'yes' && $test) {
$data = [
'client_id'=>$clientid=$this->get_option('clientId_test'),
'client_secret' => $this->get_option('secret_test'),
'sub_key'=>$this->get_option('Ocp_Apim_Key_eCommerce_test')];
if (! in_array(false, array_map('boolval', array_values($data)))) {
$data['testmode'] = 1;
$keyset[$test] = $data;
}
}
$this->keyset = $keyset;
set_transient('_vipps_keyset', $keyset, DAY_IN_SECONDS);
return $keyset;
}
// Return all webhooks for our MSNs
public function get_webhooks_from_vipps () {
$keys = $this->get_keyset();
$hooks = [];
foreach($keys as $msn=>$data) {
try {
$hooks[$msn] = $this->api->get_webhooks($msn);
} catch (Exception $e) {
$this->log(sprintf(__('Could not get webhooks for Merchant Serial Number %1$s: %2$s', 'woo-vipps'), $msn, $e->getMessage()), 'error');
$hooks[$msn]=[];
}
}
return $hooks;
}
// The rest of the settings gets the correct client id, secret, sub key and order prefix based on the MSN.
public function get_clientid($msn="") {
if (!$msn) $msn = $this->get_merchant_serial();
$keyset = $this->get_keyset();
if (!isset($keyset[$msn])) return false;
return $keyset[$msn]['client_id'];
}
public function get_secret($msn="") {
if (!$msn) $msn = $this->get_merchant_serial();
$keyset = $this->get_keyset();
if (!isset($keyset[$msn])) return false;
return $keyset[$msn]['client_secret'];
}
public function get_key($msn="") {
if (!$msn) $msn = $this->get_merchant_serial();
$keyset = $this->get_keyset();
if (!isset($keyset[$msn])) return false;
return $keyset[$msn]['sub_key'];
}
public function get_orderprefix() {
$prefix = $this->get_option('orderprefix');
return $prefix;
}
// We did shenanigans here earlier, we don't have to do that anymore. IOK 2022-12-09
public function get_return_url($order=null) {
$url = parent::get_return_url($order);
return $url;
}
// Delete express checkout orders with no customer information - these were abandonend before the app started.
// IOK 2019-08-26
public function maybe_delete_order ($orderid) {
$order = wc_get_order($orderid);
if (!$order) return;
if ('vipps' != $order->get_payment_method()) return false;
$express = $order->get_meta('_vipps_express_checkout');
if (!$express) return false;
$email = $order->get_billing_email();
if ($email) return false;
// Only delete if we have to
if ($this->get_option('deletefailedexpressorders') != 'yes') return false;
// Mark this order that an order that wasn't completed with any user info - it can be deleted. IOK 2019-11-13
$order->update_meta_data('_vipps_delendum',1);
$order->save();
return true;
}
// Return the status to use after return from Vipps MobilePay for orders that are not both "virtual" and "downloadable".
// These orders are *not* complete, and payment is *not* captured, which is why the default status is 'on-hold'.
// If you use custom order statuses, or if you don't capture on 'processing' - see filter 'woo_vipps_captured_statuses' -
// you can instead use 'processing' here - which is much nicer.
// If you do so, remember to capture *before* shipping is done on the order - if you send the package and then do 'complete',
// the capture may fail. IOK 2018-12-05
//
// IOK As of 2023-12-22, the default is now 'processing', since this is more in line with what other gateways are using,
// what other integrations and plugins expect, the most popular choice by users; and because of the fact that "on-hold" is
// normally used to indicate "a problem with the order". Not being able to capture a reserved order has to my knowledge at this
// point only happened once, in 2018, with a completely different api and backend.
public function after_vipps_order_status($order=null) {
// Revert to on-hold if the user tries to set a payment status that is a 'captured' status IOK 2024-01-25
$defaultstatus = 'on-hold';
$chosen = $this->get_option('result_status');
$newstatus = apply_filters('woo_vipps_after_vipps_order_status', $chosen, $order);
if (in_array($newstatus, $this->captured_statuses)){
$this->log(sprintf(__("Cannot use %1\$s as status for non-autocapturable orders: payment is captured on this status. See the woo_vipps_captured_statuses-filter.",'woo-vipps'), $newstatus),'debug');
return $defaultstatus;
}
return $newstatus;
}
// Create callback urls' using WC's callback API in a way that works with Vipps MobilePay callbacks and both pretty and not so pretty urls.
private function make_callback_urls($forwhat,$token='', $reference=0) {
// Passing the token as GET arguments, as the Authorize header is stripped. IOK 2018-06-13
// This applies to Ecom, Checkout and Express Checkout callbacks. For epayment, we instead need to use
// the webhook api, which is altogether different. IOK 2023-12-19
$url = home_url("/", 'https');
$queryargs = [];
if ($token) $queryargs['tk']=$token;
if ($reference) $queryargs['id']=$reference;
// HTTPS required. IOK 2018-05-18
// If the user for some reason hasn't enabled pretty links, fall back to ancient version. IOK 2018-04-24
if ( !get_option('permalink_structure')) {
$queryargs['wc-api'] = $forwhat;
} else {
$url = trailingslashit(home_url("wc-api/$forwhat", 'https'));
}
// And we need to add an empty "callback" query arg as the very last arg to receive the actual callback.
// We can't use add_query_arg for that, as an empty argument will remove the equals-sign.
$callbackurl = add_query_arg($queryargs, $url) . "&callback=";
return $callbackurl;
}
// Webhook callbacks do not pass GET arguments at all, but do provide an X-Vipps-Authorization header for verification. IOK 2023-12-19
public function webhook_callback_url () {
$url = home_url("/", 'https');
$queryargs = ['callback'=>'webhook'];
$forwhat = 'wc_gateway_vipps'; // Same callback as for ecom, checkout, express checkout
// HTTPS required. IOK 2018-05-18
// If the user for some reason hasn't enabled pretty links, fall back to ancient version. IOK 2018-04-24
if ( !get_option('permalink_structure')) {
$queryargs['wc-api'] = $forwhat;
} else {
$url = trailingslashit(home_url("wc-api/$forwhat", 'https'));
}
$callbackurl = add_query_arg($queryargs, $url);
return $callbackurl;
}
// The main payment callback
public function payment_callback_url ($token='', $reference=0) {
return $this->make_callback_urls('wc_gateway_vipps',$token, $reference);
}
public function shipping_details_callback_url($token='',$reference=0) {
return $this->make_callback_urls('vipps_shipping_details',$token,$reference);
}
// Callback for the consetn removal callback. Must use template redirect directly, because wc-api doesn't handle DELETE.
// IOK 2018-05-18
public function consent_removal_callback_url () {
$queryargs = [];
$url = home_url("/", 'https');
if ( !get_option('permalink_structure')) {
$queryargs['vipps-consent-removal']=1;
} else {
$url = trailingslashit(home_url('vipps-consent-removal', 'https'));
}
// And we need to add an empty "callback" query arg as the very last arg to receive the actual callback.
// We can't use add_query_arg for that, as an empty argument will remove the equals-sign.
return add_query_arg($queryargs, $url) . "&callback=";
}
// Allow user to select the template to be used for the special Vipps MobilePay pages. IOK 2020-02-17
public function get_theme_page_templates() {
if (!$this->page_templates) {
$choices = array('' => __('Use default template', 'woo-vipps'));
foreach(wp_get_theme()->get_page_templates() as $filename=>$name) {
$choices[$filename]=$name;
}
$this->page_templates = $choices;
}
return $this->page_templates;
}
// We can't use get_pages to get a default list of pages for our settings, because it triggers
// actions that can be used by other plugins. Therefore we must use the database directly and cache the results. IOK 2023-08-22
public function get_pagelist () {
if (!$this->page_list) {
global $wpdb;
$page_list = array(''=>__('Use a simulated page (default)', 'woo-vipps'));
foreach($wpdb->get_results("SELECT ID,post_title FROM {$wpdb->prefix}posts WHERE post_type='page' and post_status='publish'") as $page) {
$page_list[$page->ID] = $page->post_title;
}
$this->page_list = $page_list;
}
return $this->page_list;
}
// Check to see if the product in question can be bought with express checkout IOK 2018-12-04
public function product_supports_express_checkout($product) {
// IOK 2023-12-12 Can only support express checkout for Vipps - not MobilePay (yet!)
if ($this->get_payment_method_name() != 'Vipps') return false;
return apply_filters('woo_vipps_product_supports_express_checkout', $this->product_supports_checkout($product), $product);
}
// Checkout and Express Checkout are very similarily restricted because they both replace the standard
// Woo Checkout page, but express checkout is even more restricted, so we need to separate out the commonalities. IOK 2024-01-11
public function product_supports_checkout($product) {
$type = $product->get_type();
$ok = in_array($type, $this->express_checkout_supported_product_types);
$ok = apply_filters('woo_vipps_product_supports_checkout',$ok,$product);
return $ok;
}
// Almost the same as express checkout - unfortunately not *entirely* the same. IOK 2024-01-11
public function cart_supports_checkout($cart=null) {
if (!$cart) $cart = WC()->cart;
$supports = true;
if (!$cart) return $supports;
# Not supported by Vipps MobilePay
if ($cart->cart_contents_total <= 0) return false;
foreach($cart->get_cart() as $key=>$val) {
$prod = $val['data'];
if (!is_a($prod, 'WC_Product')) continue;
$product_supported = $this->product_supports_checkout($prod);
if (!$product_supported) {
$supports = false;
break;
}
}
$supports = apply_filters('woo_vipps_cart_supports_checkout', $supports, $cart);
return $supports;
}
// Check to see if the cart passed (or the global one) can be bought with express checkout IOK 2018-12-04
public function cart_supports_express_checkout($cart=null) {
if (!$cart) $cart = WC()->cart;
$supports = true;
if (!$cart) return $supports;
# Not supported by Vipps MobilePay
if ($cart->cart_contents_total <= 0) return false;
foreach($cart->get_cart() as $key=>$val) {
$prod = $val['data'];
if (!is_a($prod, 'WC_Product')) continue;
$product_supported = $this->product_supports_express_checkout($prod);
if (!$product_supported) {
$supports = false;
break;
}
}
$supports = apply_filters('woo_vipps_cart_supports_express_checkout', $supports, $cart);
return $supports;
}
// True if "Express checkout" should be displayed IOK 2018-06-18
public function show_express_checkout() {
if (!$this->express_checkout_available()) return false;
$show = ($this->enabled == 'yes') && ($this->get_option('cartexpress') == 'yes') ;
$show = $show && $this->cart_supports_express_checkout();
// By default don't show express checkout in cart if Vipps MobilePay Checkout is enabled
$show = $show && ($this->get_option('vipps_checkout_enabled') != 'yes');
return apply_filters('woo_vipps_show_express_checkout', $show);
}
public function show_login_with_vipps() {
return false;
}
// Called when orders reach the 'cancelled'-status. When this happens, orders will be *refunded*
// when they have been captured, but for added safety, this is only done when the orders are relatively new.
public function order_status_cancelled_wrapper($order_id) {
$order = wc_get_order($order_id);
if ('vipps' != $order->get_payment_method()) return false;
$days_threshold = apply_filters('woo_vipps_cancel_refund_days_threshold', 30);
$order_date = $order->get_date_created();
$days_since_order = (time() - $order_date->getTimestamp()) / (60 * 60 * 24);
$captured = intval($order->get_meta('_vipps_captured'));
// This will just cancel the order, including at Vipps. No funds have been captured.
if ($captured == 0) {
return $this->maybe_cancel_payment($order_id);
}
// If this is true then the order is *too old to refund* which would happen on maybe_cancel_payment.
// add a note instead.
if ($days_since_order > $days_threshold) {
$note = sprintf(__('Order with captured funds older than %d days cancelled - because the order is this old, it will not be automatically refunded at Vipps. Manual refund may be required.', 'woo-vipps'), $days_threshold);
$order->add_order_note($note);
// Add an admin notice in case this is interactive
$msg = sprintf(__("Could not cancel %1\$s payment", 'woo-vipps'), $this->get_payment_method_name());
$this->adminerr(__('Order', 'woo-vipps') . " " . $order->get_id() . ": " . $note);
$order->save();
Vipps::instance()->store_admin_notices();
return false;
}
// If not, then the older is pretty new so we will cancel or refund it, as before
return $this->maybe_cancel_payment($order_id);
}
public function maybe_cancel_payment($orderid) {
$order = wc_get_order($orderid);
if ('vipps' != $order->get_payment_method()) return false;
$ok = 0;
// Now first check to see if we have captured anything, and if we have, refund it. IOK 2018-05-07
$captured = intval($order->get_meta('_vipps_captured'));
$vippsstatus = $order->get_meta('_vipps_status');
if ($captured || $vippsstatus == 'SALE') {
return $this->maybe_refund_payment($orderid);
}
try {
$order = $this->update_vipps_payment_details($order);
} catch (Exception $e) {
//Do nothing with this for now
$this->log(__("Error getting payment details before doing cancel: ", 'woo-vipps') . $e->getMessage(), 'warning');
}
$payment = $this->check_payment_status($order);
if ($payment == 'initiated' || $payment == 'cancelled') {
return true; // Can't cancel these
}
try {
$ok = $this->cancel_payment($order);
} catch (Exception $e) {
// This is handled in sub-methods so we shouldn't actually hit this IOK 2018-05-07
}
if (!$ok) {
// It's just a captured payment, so we'll ignore the illegal status change. IOK 2017-05-07
$msg = sprintf(__("Could not cancel %1\$s payment", 'woo-vipps'), $this->get_payment_method_name());
$this->adminerr($msg);
$order->save();
global $Vipps;
$Vipps->store_admin_notices();
}
}
// IOK 2024-09-01 In general, we can refund most Vipps Mobilepay orders through the api,
// however, this is not the case for the Bank Transfer method available through Vipps Checkout.
public function can_refund_order( $order ) {
$method = $order->get_meta('_vipps_api');
switch ($method) {
case 'banktransfer':
return false;
break;
case 'epayment':
return true;
break;
// Default is old-style ecom v2.
default:
return true;
break;
}
}
// Handle the transition from anything to "refund"
public function maybe_refund_payment($orderid) {
$order = wc_get_order($orderid);
if ('vipps' != $order->get_payment_method()) return false;
$ok = 0;
// IOK 2019-10-03 it is now possible to do capture via other tools than Woo, so we must now first check to see if
// the order is capturable by getting full payment details.
try {
$order = $this->update_vipps_payment_details($order);
} catch (Exception $e) {
//Do nothing with this for now
$this->log(__("Error getting payment details before doing refund: ", 'woo-vipps') . $e->getMessage(), 'warning');
}
// Now first check to see if we have captured anything, and if we haven't, just cancel order IOK 2018-05-07
$vippsstatus = $order->get_meta('_vipps_status');
$captured = intval($order->get_meta('_vipps_captured'));
$to_refund = intval($order->get_meta('_vipps_refund_remaining'));
if (!$captured) {
return $this->maybe_cancel_payment($orderid);
}
if ($to_refund == 0) return true;
try {
$ok = $this->refund_payment($order,$to_refund,'exact');
} catch (TemporaryVippsAPIException $e) {
$this->adminerr(sprintf(__('Temporary error when refunding payment through %1$s - ensure order is refunded manually, or reset the order to "Processing" and try again', 'woo-vipps'), $this->get_payment_method_name()));
$this->adminerr($e->getMessage());
global $Vipps;
$Vipps->store_admin_notices();
return false;
} catch (Exception $e) {
$order->add_order_note(sprintf(__("Error when refunding payment through %1\$s:", 'woo-vipps'), $this->get_payment_method_name()) . ' ' . $e->getMessage());
$order->save();
$this->adminerr($e->getMessage());
}
if (!$ok) {
$msg = sprintf(__('Could not refund payment through %1$s - ensure the refund is handled manually!', 'woo-vipps'), $this->get_payment_method_name());
$this->adminerr($msg);
$order->add_order_note($msg);
// Unfortunately, we can't 'undo' the refund when the user manually sets the status to "Refunded" so we must
// allow the state change here if that happens.
global $Vipps;
$Vipps->store_admin_notices();
return false;
}
}
// This is for orders that are 'reserved' at Vipps but could actually be captured at once because
// they don't require payment. So we try to capture. IOK 2020-09-22
// do NOT call this unless the order is 'reserved' at Vipps!
protected function maybe_complete_payment($order) {
if ('vipps' != $order->get_payment_method()) return false;
if ($order->needs_processing()) return false; // No auto-capture for orders needing processing
// IOK 2018-10-03 when implementing partial capture, this must be modified.
$captured = intval($order->get_meta('_vipps_captured'));
$vippsstatus = $order->get_meta('_vipps_status');
if ($captured || $vippsstatus == 'SALE') {
return true;
}
$ok = 0;
try {
$ok = $this->capture_payment($order);
$order->add_order_note(sprintf(__('Payment automatically captured at %1$s for order not needing processing','woo_vipps'), $this->get_payment_method_name()));
} catch (Exception $e) {
$order->add_order_note(sprintf(__('Order does not need processing, but payment could not be captured at %1$s:','woo_vipps'), $this->get_payment_method_name()) . ' ' . $e->getMessage());
}
if (!$ok) return false;
$order->save();
return true;
}
// This is the Woocommerce refund api called by the "Refund" actions. IOK 2018-05-11
public function process_refund($orderid,$amount=null,$reason='') {
$order = wc_get_order($orderid);
$currency = $order->get_currency();
try {
$order = $this->update_vipps_payment_details($order);
} catch (Exception $e) {
//Do nothing with this for now
$this->log(__("Error getting payment details before doing refund: ", 'woo-vipps') . $e->getMessage(), 'warning');
}
$captured = intval($order->get_meta('_vipps_captured'));
$to_refund = intval($order->get_meta('_vipps_refund_remaining'));
if (!$captured) {
return new WP_Error('Vipps', sprintf(__("Cannot refund through %1\$s - the payment has not been captured yet.", 'woo-vipps'), $this->get_payment_method_name()));
}
if ($amount*100 > $to_refund) {
return new WP_Error('Vipps', sprintf(__("Cannot refund through %1\$s - the refund amount is too large.", 'woo-vipps'), $this->get_payment_method_name()));
}
$ok = 0;
// Specialcase zero, because Vipps treats this as the entire amount IOK 2021-09-14
if (is_numeric($amount) && $amount == 0) {
$order->add_order_note($amount . ' ' . $currency . ' ' . sprintf(__(" refunded through %1\$s:",'woo-vipps'), Vipps::CompanyName()) . ' ' . $reason);
return true;
}
try {
$ok = $this->refund_payment($order,$amount);
} catch (TemporaryVippsApiException $e) {
$this->log(sprintf(__('Could not refund %1$s payment for order id:', 'woo-vipps'), $this->get_payment_method_name()) . ' ' . $orderid . "\n" .$e->getMessage(),'error');
return new WP_Error('Vipps',sprintf(__('%1$s is temporarily unavailable.','woo-vipps'), Vipps::CompanyName()) . ' ' . $e->getMessage());
} catch (Exception $e) {
$msg = sprintf(__('Could not refund %1$s payment','woo-vipps'), Vipps::CompanyName()) . ' ' . $e->getMessage();
$order->add_order_note($msg);
$this->log($msg,'error');
return new WP_Error('Vipps',$msg);
}
if ($ok) {
$order->add_order_note($amount . ' ' . $currency . ' ' . sprintf(__(" refunded through %1\$s:",'woo-vipps'), Vipps::CompanyName()) . ' ' . $reason);
}
return $ok;
}
// Detect default payment method based on store location, user locale, currency NT 2023-11-30
public function detect_default_payment_method_name() {
// IOK 2023-12-01 use the main locale instead of the user locale
$locale = get_locale();
// Countries object not yet available at this point IOK 2023-12-01
// $store_location = WC()->countries->get_base_country();
$store_location= wc_get_base_location();
$store_country = $store_location['country'] ?? '';
$currency = get_woocommerce_currency();
$default_payment_method_name = "MobilePay";
// If store location, locale, or currency is Norwegian, use Vipps
if ($store_country== "NO" || preg_match("/.*_NO/", $locale) || $currency == "NOK") {
$default_payment_method_name = "Vipps";
}
return $default_payment_method_name;
}
// Returns true iff this is a store where Vipps will allow external payment methods.
// Currently this is only Finland, and only Klarna is supported. We need to call this like so because
// most of woocommerce will not be initialized when we need this info. IOK 2024-05-28
public function allow_external_payments_in_checkout() {
$store_location= wc_get_base_location();
$store_country = $store_location['country'] ?? '';
$finland = (get_woocommerce_currency() == "EUR" && $store_country == "FI");
$norway = (get_woocommerce_currency() == "NOK" && $store_country == "NO");
return apply_filters('woo_vipps_allow_external_payment_methods', ($finland || $norway));
}
public function init_form_fields() {
global $Vipps;
// Used for defaults in the admin interface; however this functions is called a loot more often than that.
$page_templates = $this->get_theme_page_templates();
$page_list = $this->get_pagelist();
$orderprefix = $Vipps->generate_order_prefix();
// Default handling based on other parameters and earlier values.
$expresscreateuserdefault = "no";
$vippscreateuserdefault = "no";
// Express checkout uses verified email addresses,so we'll create users if the Login plugin is installed and WooCommerce is set to allow user registration.
if (class_exists('VippsWooLogin')) {
$woodefault = 'yes' === get_option('woocommerce_enable_signup_and_login_from_checkout');
if ($woodefault) {
$expresscreateuserdefault = "yes";
// $vippscreateuserdefault = "yes"; // However, for Vipps Checkout the email address is freetext so we'll treat the default a bit different.
}
}
// We will only show the Vipps Checkout options if the user has activated the feature (thus creating the pages involved etc). IOK 2021-10-01
$vipps_checkout_activated = get_option('woo_vipps_checkout_activated', false);
// This is used for new options,to set reasonable defaults based on older settings. We can't use WC_Settings->get_option for this unfortunately.
$current = get_option('woocommerce_vipps_settings');
// New defaults based on old defaults
$default_static_shipping_for_checkout = 'no';
$default_ask_address_for_express = 'no';
if ($current) {
$default_static_shipping_for_checkout = (isset($current['enablestaticshipping'])) ? $current['enablestaticshipping'] : 'no';
$default_ask_address_for_express = (isset($current['useExplicitCheckoutFlow']) && $current['useExplicitCheckoutFlow'] == "yes") ? "yes" : "no";
// The old default used the same value as for Express Checkout. IOK 2023-07-27
$vippscreateuserdefault = isset($current['expresscreateuser']) ? $current['expresscreateuser'] : $vippscreateuserdefault;
}
// Same issue as above: We need the default payment method name before it is set to be able to provide defaults IOK 2023-12-01
$payment_method_name = $current['payment_method_name'] ?? $this->detect_default_payment_method_name();
$checkoutfields = array(
'checkout_options' => array(
'title' => sprintf(__('Checkout', 'woo-vipps'), Vipps::CompanyName()),
'type' => 'title',
'class' => 'tab',
'description' => sprintf(__("%1\$s is a new service from %2\$s which replaces the usual WooCommerce checkout page entirely, replacing it with a simplified checkout screen providing payment both with %2\$s and credit card. Additionally, your customers will get the option of providing their address information using their %2\$s app directly.", 'woo-vipps'), Vipps::CheckoutName(), Vipps::CompanyName()),
),
'vipps_checkout_enabled' => array(
'title' => sprintf(__('Activate Alternative %1$s', 'woo-vipps'), Vipps::CheckoutName()),
'label' => sprintf(__('Enable Alternative %1$s screen, replacing the standard checkout page', 'woo-vipps'), Vipps::CheckoutName()),
'type' => 'checkbox',
'description' => sprintf(__('If activated, this will <strong>replace</strong> the standard Woo checkout screen with %1$s, providing easy checkout using %1$s or credit card, with no need to type in addresses.', 'woo-vipps'), Vipps::CheckoutName()),
'default' => 'no',
),
'checkoutcreateuser' => array (
'title' => sprintf(__('Create new customers on %1$s', 'woo-vipps'), Vipps::CheckoutName()),
'label' => sprintf(__('Create new customers on %1$s', 'woo-vipps'), Vipps::CheckoutName()),
'type' => 'checkbox',
'description' => sprintf(__('Enable this to create and login customers when using %1$s. Otherwise these will all be guest checkouts. If using, you may want to install Login with Vipps too.', 'woo-vipps'), Vipps::CheckoutName()),
'default' => $vippscreateuserdefault,
),
'enablestaticshipping_checkout' => array(
'title' => sprintf(__('Enable static shipping for %1$s', 'woo-vipps'), Vipps::CheckoutName()),
'label' => __('Enable static shipping', 'woo-vipps'),
'type' => 'checkbox',
'description' => sprintf(__('If your shipping options do not depend on the customers address, you can enable \'Static shipping\', which will precompute the shipping options when using %1$s so that this will be much faster. If you do this and the customer isn\'t logged in, the base location of the store will be used to compute the shipping options for the order. You should only use this if your shipping is actually \'static\', that is, does not vary based on the customers address. So fixed price/free shipping will work. If the customer is logged in, their address as registered in the store will be used, so if your customers are always logged in, you may be able to use this too.', 'woo-vipps'), Vipps::CheckoutName()),
'default' => $default_static_shipping_for_checkout
),
'requireUserInfo_checkout' => array(
'title' => __('Ask the user to consent to share user information', 'woo-vipps'),
'label' => __('Ask the user to consent to share user information', 'woo-vipps'),
'type' => 'checkbox',
'description' => sprintf(__('If using %1$s, ask for the users consent to share user information with the store. This will allow better integration between Login With %1$s but will add another step to first-time buyers.', 'woo-vipps'), Vipps::CompanyName()),
'default' => 'no'
),
'noAddressFields' => array(
'title' => __('Drop the address fields on the Checkout screen', 'woo-vipps'),
'label' => __('Don\'t require the address fields', 'woo-vipps'),
'type' => 'checkbox',
'description' => __('If your products <i>don\'t require shipping</i>, either because they are digital downloads, immaterial products or delivering the products directly on purchase, you can check this box. The user will then not be required to provide an address, which should speed things up a bit. If your products require shipping, this will have no effect. NB: If you have plugins that require shipping information, then this is not going to work very well.','woo-vipps'),
'default' => 'no'
),
'noContactFields' => array(
'title' => __('Drop the contact fields on the Checkout screen', 'woo-vipps'),
'label' => __('Don\'t require the contact fields', 'woo-vipps'),
'type' => 'checkbox',
'description' => __('If your products <i>don\'t require shipping</i> as above, and you also don\'t care about the customers name or contact information, you can drop this too! The customer fields will then be filled with a placeholder. NB: If you have plugins that require contact information, then this is not going to work very well. Also, for this to work you have to check the \'no addresses\' box as well.','woo-vipps'),
'default' => 'no'
),
);
$vipps_checkout_shipping_fields = array(
'checkout_shipping' => array(
'title' => sprintf(__('%1$s Shipping Methods', 'woo-vipps'), Vipps::CheckoutName()),
'type' => 'title',
'description' => sprintf(__("When using %1\$s, you have the option to use %1\$s specific shipping methods with extended features for certain carriers. These will add an apropriate logo as well as extended delivery options for certain methods. For some of these, you need to add integration data from the carriers below. You can then add these shipping methods to your shipping zones the normal way, but they will only appear in the %1\$s screen.", 'woo-vipps'), Vipps::CheckoutName())
),
'vcs_posten' => array(
'title' => __('Posten Norge', 'woo-vipps'),
'class' => 'vcs_posten vcs_main',
'custom_attributes' => array('data-vcs-show'=>'.vcs_depend.vcs_posten'),
'label' => sprintf(__('Support Posten Norge as a shipping method in %1$s', 'woo-vipps'), Vipps::CheckoutName()),
'type' => 'checkbox',
'description' => sprintf(__('Activate this for Posten Norge as a %1$s Shipping method.', 'woo-vipps'), Vipps::CheckoutName()),
'default' => 'yes'
),
'vcs_posti' => array(
'title' => __('Posti', 'woo-vipps'),
'class' => 'vcs_posti vcs_main',
'custom_attributes' => array('data-vcs-show'=>'.vcs_depend.vcs_posti'),
'label' => sprintf(__('Support Posti as a shipping method in %1$s', 'woo-vipps'), Vipps::CheckoutName()),
'type' => 'checkbox',
'description' => sprintf(__('Activate this for Posti as a %1$s Shipping method.', 'woo-vipps'), Vipps::CheckoutName()),
'default' => 'yes'
),
'vcs_postnord' => array(
'title' => __('PostNord', 'woo-vipps'),
'class' => 'vcs_postnord vcs_main',
'custom_attributes' => array('data-vcs-show'=>'.vcs_depend.vcs_postnord'),
'label' => sprintf(__('Support PostenNord as a shipping method in %1$s', 'woo-vipps'), Vipps::CheckoutName()),
'type' => 'checkbox',
'description' => sprintf(__('Activate this for PostNord as a %1$s Shipping method.', 'woo-vipps'), Vipps::CheckoutName()),
'default' => 'yes'
),
'vcs_porterbuddy' => array(
'title' => __('Porterbuddy', 'woo-vipps'),
'class' => 'vcs_porterbuddy vcs_main',
'custom_attributes' => array('data-vcs-show'=>'.vcs_depend.vcs_porterbuddy'),
'label' => sprintf(__('Support Porterbuddy as a shipping method in %1$s', 'woo-vipps'), Vipps::CheckoutName()),
'type' => 'checkbox',
'description' => sprintf(__('Activate this for Porterbuddy as a %1$s Shipping method. Your store address will be used as the pick-up point and your admin email will be used for booking information from Porterbuddy.' ,'woo-vipps'), Vipps::CheckoutName()),
'default' => 'no'
),
'vcs_porterbuddy_publicToken' => array(
'title' => __('Porterbuddy public token', 'woo-vipps'),
'class' => 'vippspw vcs_porterbuddy vcs_depend',
'type' => 'password',
'description' => __('The public key provided to you by Porterbuddy','woo-vipps'),
'default' => '',
),
'vcs_porterbuddy_apiKey' => array(
'title' => __('Porterbuddy API key', 'woo-vipps'),
'class' => 'vippspw vcs_porterbuddy vcs_depend',
'type' => 'password',
'description' => __('The API key provided to you by Porterbuddy','woo-vipps'),
'default' => '',
),
'vcs_porterbuddy_phoneNumber' => array(
'title' => __('Porterbuddy Phone Number', 'woo-vipps'),
'class' => 'vcs_porterbuddy vcs_depend',
'type' => 'text',
'description' => __('Your phone number where Porterbuddy may send you important messages. Format must be MSISDN (including country code). Example: "4791234567"','woo-vipps'),
'default' => '',
),
// Vipps checkout *shipping options* - extra shipping options that only work with Vipps Checkout
'vcs_helthjem' => array(
'title' => __('Helthjem', 'woo-vipps'),
'label' => sprintf(__('Support Helthjem as a shipping method in %1$s', 'woo-vipps'), Vipps::CheckoutName()),
'type' => 'checkbox',
'class' => 'vcs_helthjem vcs_main',
'custom_attributes' => array('data-vcs-show'=>'.vcs_depend.vcs_helthjem'),
'description' => sprintf(__('Activate this for Helthjem as a %1$s Shipping method.' ,'woo-vipps'), Vipps::CheckoutName()),
'default' => 'no'
),
'vcs_helthjem_shopId' => array(
'title' => __('Helthjem Shop Id', 'woo-vipps'),
'class' => 'vcs_helthjem vcs_depend',
'type' => 'number',
'custom_attributes' => array('pattern'=>'[0-9]'),
'description' => __('The ShopId provided to you by Helthjem','woo-vipps'),
'default' => '',
),
'vcs_helthjem_username' => array(
'title' => __('Helthjem Username', 'woo-vipps'),
'class' => 'vcs_helthjem vcs_depend',
'type' => 'text',
'description' => __('The Username provided to you by Helthjem','woo-vipps'),
'default' => '',
),
'vcs_helthjem_password' => array(
'title' => __('Helthjem Password', 'woo-vipps'),
'class' => 'vippspw vcs_helthjem vcs_depend',
'type' => 'password',
'description' => __('Password provided to you by Helthjem','woo-vipps'),
'default' => '',
),
);
/* Support for *certain* external payment methods in Vipps Checkout. IOK 2024-05-27 */
$externals = [];
$external_payment_fields = [];
$allow_external_payments = $this->allow_external_payments_in_checkout();
if ($allow_external_payments) {
if (in_array('KCO_Gateway', Vipps::$installed_gateways) || in_array('WC_Gateway_Klarna_Payments', Vipps::$installed_gateways)) {
$externals['checkout_external_payments_klarna'] = array(
'title' => __('Klarna', 'woo-vipps'),
'label' => __('Klarna', 'woo-vipps'),
'type' => 'checkbox',
'class' => 'external_payments klarna',
'description' => sprintf(__("Allow Klarna as an external payment method in %1\$s",'woo-vipps'), Vipps::CheckoutName()),
'default' => 'no',
);
}
if (!empty($externals)) {
$external_payment_fields = [
'checkout_external_payment_title' => array(
'title' => sprintf(__('External Payment Methods', 'woo-vipps'), Vipps::CheckoutName()),
'type' => 'title',
'description' => sprintf(__("Allow certain external payment methods in %1\$s, returning control to WooCommerce for the order", 'woo-vipps'), Vipps::CheckoutName())
)
];
foreach($externals as $k => $def) $external_payment_fields[$k] = $def;
}
}
$mainfields = array(
'main_options' => array(
'title' => __('Main options', 'woo-vipps'),
'type' => 'title',
'class' => 'tab',
),
'enabled' => array(
'title' => __('Enable/Disable', 'woocommerce'),
'label' => sprintf(__('Enable %1$s', 'woo-vipps'), Vipps::CompanyName()),
'type' => 'checkbox',