-
Notifications
You must be signed in to change notification settings - Fork 42
/
class-sv-wc-payment-gateway-direct.php
1214 lines (950 loc) · 43.8 KB
/
class-sv-wc-payment-gateway-direct.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
/**
* WooCommerce Payment Gateway Framework
*
* This source file is subject to the GNU General Public License v3.0
* that is bundled with this package in the file license.txt.
* It is also available through the world-wide-web at this URL:
* http://www.gnu.org/licenses/gpl-3.0.html
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@skyverge.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade the plugin to newer
* versions in the future. If you wish to customize the plugin for your
* needs please refer to http://www.skyverge.com
*
* @package SkyVerge/WooCommerce/Payment-Gateway/Classes
* @author SkyVerge
* @copyright Copyright (c) 2013-2020, SkyVerge, Inc.
* @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0
*/
namespace SkyVerge\WooCommerce\PluginFramework\v5_10_0;
defined( 'ABSPATH' ) or exit;
if ( ! class_exists( '\\SkyVerge\\WooCommerce\\PluginFramework\\v5_10_0\\SV_WC_Payment_Gateway_Direct' ) ) :
/**
* # WooCommerce Payment Gateway Framework Direct Gateway
*
* @since 1.0.0
*/
abstract class SV_WC_Payment_Gateway_Direct extends SV_WC_Payment_Gateway {
/**
* Validate the payment fields when processing the checkout
*
* NOTE: if we want to bring billing field validation (ie length) into the
* fold, see the Elavon VM Payment Gateway for a sample implementation
*
* @since 1.0.0
* @see WC_Payment_Gateway::validate_fields()
* @return bool true if fields are valid, false otherwise
*/
public function validate_fields() {
$is_valid = parent::validate_fields();
if ( $this->supports_tokenization() ) {
// tokenized transaction?
if ( SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-payment-token' ) ) {
// unknown token?
if ( ! $this->get_payment_tokens_handler()->user_has_token( get_current_user_id(), SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-payment-token' ) ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Payment error, please try another payment method or contact us to complete your transaction.', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
// Check the CSC if enabled
if ( $this->is_credit_card_gateway() && $this->csc_enabled_for_tokens() ) {
$is_valid = $this->validate_csc( SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-csc' ) ) && $is_valid;
}
// no more validation to perform
return $is_valid;
}
}
// validate remaining payment fields
if ( $this->is_credit_card_gateway() ) {
return $this->validate_credit_card_fields( $is_valid );
} elseif ( $this->is_echeck_gateway() ) {
return $this->validate_check_fields( $is_valid );
} else {
$method_name = 'validate_' . str_replace( '-', '_', strtolower( $this->get_payment_type() ) ) . '_fields';
if ( is_callable( array( $this, $method_name ) ) ) {
return $this->$method_name( $is_valid );
}
}
// no more validation to perform. Return the parent method's outcome.
return $is_valid;
}
/**
* Returns true if the posted credit card fields are valid, false otherwise
*
* @since 1.0.0
* @param boolean $is_valid true if the fields are valid, false otherwise
* @return boolean true if the fields are valid, false otherwise
*/
protected function validate_credit_card_fields( $is_valid ) {
$account_number = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-account-number' );
$expiration_month = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-exp-month' );
$expiration_year = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-exp-year' );
$expiry = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-expiry' );
$csc = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-csc' );
// handle single expiry field formatted like "MM / YY" or "MM / YYYY"
if ( ! $expiration_month & ! $expiration_year && $expiry ) {
list( $expiration_month, $expiration_year ) = array_map( 'trim', explode( '/', $expiry ) );
}
$is_valid = $this->validate_credit_card_account_number( $account_number ) && $is_valid;
$is_valid = $this->validate_credit_card_expiration_date( $expiration_month, $expiration_year ) && $is_valid;
// validate card security code
if ( $this->csc_enabled() ) {
$is_valid = $this->validate_csc( $csc ) && $is_valid;
}
/**
* Direct Payment Gateway Validate Credit Card Fields Filter.
*
* Allow actors to filter the credit card field validation.
*
* @since 4.3.0
* @param bool $is_valid true for validation to pass
* @param SV_WC_Payment_Gateway_Direct $this direct gateway class instance
*/
return apply_filters( 'wc_payment_gateway_' . $this->get_id() . '_validate_credit_card_fields', $is_valid, $this );
}
/**
* Validates the provided credit card expiration date
*
* @since 2.1.0
* @param string $expiration_month the credit card expiration month
* @param string $expiration_year the credit card expiration month
* @return boolean true if the card expiration date is valid, false otherwise
*/
protected function validate_credit_card_expiration_date( $expiration_month, $expiration_year ) {
$is_valid = true;
if ( 2 === strlen( $expiration_year ) ) {
$expiration_year = '20' . $expiration_year;
}
// validate expiration data
$current_year = date( 'Y' );
$current_month = date( 'n' );
if ( ! ctype_digit( $expiration_month ) || ! ctype_digit( $expiration_year ) ||
$expiration_month > 12 ||
$expiration_month < 1 ||
$expiration_year < $current_year ||
( $expiration_year == $current_year && $expiration_month < $current_month ) ||
$expiration_year > $current_year + 20
) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Card expiration date is invalid', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
return $is_valid;
}
/**
* Validates the provided credit card account number
*
* @since 2.1.0
* @param string $account_number the credit card account number
* @return boolean true if the card account number is valid, false otherwise
*/
protected function validate_credit_card_account_number( $account_number ) {
$is_valid = true;
// validate card number
$account_number = str_replace( array( ' ', '-' ), '', $account_number );
if ( empty( $account_number ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Card number is missing', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
} else {
if ( strlen( $account_number ) < 12 || strlen( $account_number ) > 19 ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Card number is invalid (wrong length)', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
if ( ! ctype_digit( $account_number ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Card number is invalid (only digits allowed)', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
if ( ! SV_WC_Payment_Gateway_Helper::luhn_check( $account_number ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Card number is invalid', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
}
return $is_valid;
}
/**
* Validates the provided Card Security Code, adding user error messages as
* needed
*
* @since 1.0.0
* @param string $csc the customer-provided card security code
* @return boolean true if the card security code is valid, false otherwise
*/
protected function validate_csc( $csc ) {
$is_valid = true;
// validate security code
if ( ! empty( $csc ) ) {
// digit validation
if ( ! ctype_digit( $csc ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Card security code is invalid (only digits are allowed)', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
// length validation
if ( strlen( $csc ) < 3 || strlen( $csc ) > 4 ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Card security code is invalid (must be 3 or 4 digits)', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
} elseif ( $this->csc_required() ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Card security code is missing', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
return $is_valid;
}
/**
* Returns true if the posted echeck fields are valid, false otherwise
*
* @since 1.0.0
* @param bool $is_valid true if the fields are valid, false otherwise
* @return bool
*/
protected function validate_check_fields( $is_valid ) {
$account_number = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-account-number' );
$routing_number = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-routing-number' );
// optional fields (excluding account type for now)
$drivers_license_number = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-drivers-license-number' );
$check_number = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-check-number' );
// routing number exists?
if ( empty( $routing_number ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Routing Number is missing', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
} else {
// routing number digit validation
if ( ! ctype_digit( $routing_number ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Routing Number is invalid (only digits are allowed)', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
// routing number length validation
if ( 9 != strlen( $routing_number ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Routing number is invalid (must be 9 digits)', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
}
// account number exists?
if ( empty( $account_number ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Account Number is missing', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
} else {
// account number digit validation
if ( ! ctype_digit( $account_number ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Account Number is invalid (only digits are allowed)', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
// account number length validation
if ( strlen( $account_number ) < 5 || strlen( $account_number ) > 17 ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Account number is invalid (must be between 5 and 17 digits)', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
}
// optional drivers license number validation
if ( ! empty( $drivers_license_number ) && preg_match( '/^[a-zA-Z0-9 -]+$/', $drivers_license_number ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Drivers license number is invalid', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
// optional check number validation
if ( ! empty( $check_number ) && ! ctype_digit( $check_number ) ) {
SV_WC_Helper::wc_add_notice( esc_html__( 'Check Number is invalid (only digits are allowed)', 'woocommerce-plugin-framework' ), 'error' );
$is_valid = false;
}
/**
* Direct Payment Gateway Validate eCheck Fields Filter.
*
* Allow actors to filter the eCheck field validation.
*
* @since 4.3.0
* @param bool $is_valid true for validation to pass
* @param SV_WC_Payment_Gateway_Direct $this direct gateway class instance
*/
return apply_filters( 'wc_payment_gateway_' . $this->get_id() . '_validate_echeck_fields', $is_valid, $this );
}
/**
* Handles payment processing.
*
* @see WC_Payment_Gateway::process_payment()
*
* @since 1.0.0
*
* @param int|string $order_id
* @return array associative array with members 'result' and 'redirect'
*/
public function process_payment( $order_id ) {
$default = parent::process_payment( $order_id );
/**
* Direct Gateway Process Payment Filter.
*
* Allow actors to intercept and implement the process_payment() call for
* this transaction. Return an array value from this filter will return it
* directly to the checkout processing code and skip this method entirely.
*
* @since 1.0.0
* @param bool $result default true
* @param int|string $order_id order ID for the payment
* @param SV_WC_Payment_Gateway_Direct $this instance
*/
if ( is_array( $result = apply_filters( 'wc_payment_gateway_' . $this->get_id() . '_process_payment', true, $order_id, $this ) ) ) {
return $result;
}
// add payment information to order
$order = $this->get_order( $order_id );
try {
// handle creating or updating a payment method for registered customers if tokenization is enabled
if ( $this->supports_tokenization() && 0 !== (int) $order->get_user_id() ) {
// if already paying with an existing method, try and updated it locally and remotely
if ( ! empty( $order->payment->token ) ) {
$this->update_transaction_payment_method( $order );
// otherwise, create a new token if desired
} elseif ( $this->get_payment_tokens_handler()->should_tokenize() && ( '0.00' === $order->payment_total || $this->tokenize_before_sale() ) ) {
$order = $this->get_payment_tokens_handler()->create_token( $order );
}
}
// payment failures are handled internally by do_transaction()
// the order amount will be $0 if a WooCommerce Subscriptions free trial product is being processed
// note that customer id & payment token are saved to order when create_token() is called
if ( ( '0.00' === $order->payment_total && ! $this->transaction_forced() ) || $this->do_transaction( $order ) ) {
// add transaction data for zero-dollar "orders"
if ( '0.00' === $order->payment_total ) {
$this->add_transaction_data( $order );
}
/**
* Filters the order status that's considered to be "held".
*
* @since 5.3.0
*
* @param string $status held order status
* @param \WC_Order $order order object
* @param SV_WC_Payment_Gateway_API_Response|null $response API response object, if any
*/
$held_order_status = apply_filters( 'wc_' . $this->get_id() . '_held_order_status', 'on-hold', $order, null );
if ( $order->has_status( $held_order_status ) ) {
// reduce stock for held orders, but don't complete payment (pass order ID so WooCommerce fetches fresh order object with reduced_stock meta set on order status change)
wc_reduce_stock_levels( $order->get_id() );
} else {
// mark order as having received payment
$order->payment_complete();
}
// process_payment() can sometimes be called in an admin-context
if ( isset( WC()->cart ) ) {
WC()->cart->empty_cart();
}
/**
* Payment Gateway Payment Processed Action.
*
* Fired when a payment is processed for an order.
*
* @since 4.1.0
* @param \WC_Order $order order object
* @param SV_WC_Payment_Gateway_Direct $this instance
*/
do_action( 'wc_payment_gateway_' . $this->get_id() . '_payment_processed', $order, $this );
return [
'result' => 'success',
'redirect' => $this->get_return_url( $order ),
];
} else {
return [
'result' => 'failure',
'message' => 'The transaction failed.',
];
}
} catch ( SV_WC_Plugin_Exception $e ) {
$this->mark_order_as_failed( $order, $e->getMessage() );
return [
'result' => 'failure',
'message' => $e->getMessage(),
];
}
return $default;
}
/**
* Handles updating a user's payment method during payment.
*
* This allows us to check the billing address against the last used so we can determine if it needs an update.
*
* @since 5.3.0
*
* @param \WC_Order $order
* @return \WC_Order
*/
protected function update_transaction_payment_method( \WC_Order $order ) {
$token = $this->get_payment_tokens_handler()->get_token( $order->get_user_id(), $order->payment->token );
$address = new Addresses\Customer_Address();
$address->set_from_order( $order );
$new_billing_hash = $address->get_hash();
// if the address & token hash don't match, update
if ( $token->get_billing_hash() !== $new_billing_hash ) {
// if the API supports it, update remotely
if ( $this->get_api()->supports_update_tokenized_payment_method() ) {
$response = null;
try {
$response = $this->get_api()->update_tokenized_payment_method( $order );
// if an address was passed and the token was updated remotely, update the billing hash
if ( $response->transaction_approved() ) {
$token->set_billing_hash( $new_billing_hash );
} else {
if ( $response->get_status_message() ) {
$message = $response->get_status_code() ? $response->get_status_code() . ' - ' . $response->get_status_message() : $response->get_status_message();
} else {
$message = __( 'Unknown error', 'woocommerce-plugin-framework' );
}
throw new SV_WC_Plugin_Exception( $message );
}
} catch ( SV_WC_Plugin_Exception $exception ) {
$message = sprintf(
__( 'Payment method address could not be updated. %s', 'woocommerce-plugin-framework' ),
$exception->getMessage()
);
$order->add_order_note( $message );
if ( $this->debug_log() ) {
$this->get_plugin()->log( $message, $this->get_id() );
}
}
} else {
// updating remotely isn't supported, so just update the hash locally
$token->set_billing_hash( $new_billing_hash );
}
}
// don't halt payment if this fails
$this->get_payment_tokens_handler()->update_token( $order->get_user_id(), $token );
return $order;
}
/**
* Add payment and transaction information as class members of WC_Order
* instance. The standard information that can be added includes:
*
* $order->payment_total - the payment total
* $order->customer_id - optional payment gateway customer id (useful for tokenized payments for certain gateways, etc)
* $order->payment->account_number - the credit card or checking account number
* $order->payment->last_four - the last four digits of the account number
* $order->payment->card_type - the card type (e.g. visa) derived from the account number
* $order->payment->routing_number - account routing number (check transactions only)
* $order->payment->account_type - optional type of account one of 'checking' or 'savings' if type is 'check'
* $order->payment->card_type - optional card type, ie one of 'visa', etc
* $order->payment->exp_month - the 2 digit credit card expiration month (for credit card gateways), e.g. 07
* $order->payment->exp_year - the 2 digit credit card expiration year (for credit card gateways), e.g. 17
* $order->payment->csc - the card security code (for credit card gateways)
* $order->payment->check_number - optional check number (check transactions only)
* $order->payment->drivers_license_number - optional driver license number (check transactions only)
* $order->payment->drivers_license_state - optional driver license state code (check transactions only)
* $order->payment->token - payment token (for tokenized transactions)
*
* Note that not all gateways will necessarily pass or require all of the
* above. These represent the most common attributes used among a variety
* of gateways, it's up to the specific gateway implementation to make use
* of, or ignore them, or add custom ones by overridding this method.
*
* @since 1.0.0
* @see SV_WC_Payment_Gateway::get_order()
* @param int|\WC_Order $order_id order ID being processed
* @return \WC_Order object with payment and transaction information attached
*/
public function get_order( $order_id ) {
$order = parent::get_order( $order_id );
// payment info
if ( SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-account-number' ) && ! SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-payment-token' ) ) {
// common attributes
$order->payment->account_number = str_replace( array( ' ', '-' ), '', SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-account-number' ) );
$order->payment->last_four = substr( $order->payment->account_number, -4 );
if ( $this->is_credit_card_gateway() ) {
// credit card specific attributes
$order->payment->card_type = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-card-type' );
$order->payment->exp_month = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-exp-month' );
$order->payment->exp_year = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-exp-year' );
// add card type for gateways that don't require it displayed at checkout
if ( empty( $order->payment->card_type ) ) {
$order->payment->card_type = SV_WC_Payment_Gateway_Helper::card_type_from_account_number( $order->payment->account_number );
}
// handle single expiry field formatted like "MM / YY" or "MM / YYYY"
if ( SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-expiry' ) ) {
list( $order->payment->exp_month, $order->payment->exp_year ) = array_map( 'trim', explode( '/', SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-expiry' ) ) );
}
// add CSC if enabled
if ( $this->csc_enabled() ) {
$order->payment->csc = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-csc' );
}
} elseif ( $this->is_echeck_gateway() ) {
// echeck specific attributes
$order->payment->routing_number = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-routing-number' );
$order->payment->account_type = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-account-type' );
$order->payment->check_number = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-check-number' );
$order->payment->drivers_license_number = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-drivers-license-number' );
$order->payment->drivers_license_state = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-drivers-license-state' );
}
} elseif ( SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-payment-token' ) ) {
// paying with tokenized payment method (we've already verified that this token exists in the validate_fields method)
$token = $this->get_payment_tokens_handler()->get_token( $order->get_user_id(), SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-payment-token' ) );
$order->payment->token = $token->get_id();
$order->payment->account_number = $token->get_last_four();
$order->payment->last_four = $token->get_last_four();
if ( $this->is_credit_card_gateway() ) {
// credit card specific attributes
$order->payment->card_type = $token->get_card_type();
$order->payment->exp_month = $token->get_exp_month();
$order->payment->exp_year = $token->get_exp_year();
if ( $this->csc_enabled_for_tokens() ) {
$order->payment->csc = SV_WC_Helper::get_posted_value( 'wc-' . $this->get_id_dasherized() . '-csc' );
}
} elseif ( $this->is_echeck_gateway() ) {
// echeck specific attributes
$order->payment->account_type = $token->get_account_type();
}
// make this the new default payment token
$this->get_payment_tokens_handler()->set_default_token( $order->get_user_id(), $token );
}
// standardize expiration date year to 2 digits
if ( ! empty( $order->payment->exp_year ) && 4 === strlen( $order->payment->exp_year ) ) {
$order->payment->exp_year = substr( $order->payment->exp_year, 2 );
}
/**
* Direct Gateway Get Order Filter.
*
* Allow actors to modify the order object.
*
* @since 1.0.0
* @param \WC_Order $order order object
* @param SV_WC_Payment_Gateway_Direct $this instance
*/
return apply_filters( 'wc_payment_gateway_' . $this->get_id() . '_get_order', $order, $this );
}
/**
* Performs a check transaction for the given order and returns the result.
*
* @since 1.0.0
*
* @param \WC_Order $order the order object
* @param SV_WC_Payment_Gateway_API_Response $response optional check transaction response
* @return SV_WC_Payment_Gateway_API_Response the response
* @throws SV_WC_Plugin_Exception network timeouts, etc
*/
protected function do_check_transaction( $order, $response = null ) {
if ( is_null( $response ) ) {
$response = $this->get_api()->check_debit( $order );
}
// success! update order record
if ( $response->transaction_approved() ) {
$last_four = substr( $order->payment->account_number, -4 );
// check order note. there may not be an account_type available, but that's fine
/* translators: Placeholders: %1$s - payment method title, %2$s - payment account type (savings/checking) (may or may not be available), %3$s - last four digits of the account */
$message = sprintf( esc_html__( '%1$s Check Transaction Approved: %2$s account ending in %3$s', 'woocommerce-plugin-framework' ), $this->get_method_title(), $order->payment->account_type, $last_four );
// optional check number
if ( ! empty( $order->payment->check_number ) ) {
/* translators: Placeholders: %s - check number */
$message .= '. ' . sprintf( esc_html__( 'Check number %s', 'woocommerce-plugin-framework' ), $order->payment->check_number );
}
// adds the transaction id (if any) to the order note
if ( $response->get_transaction_id() ) {
$message .= ' ' . sprintf( esc_html__( '(Transaction ID %s)', 'woocommerce-plugin-framework' ), $response->get_transaction_id() );
}
/**
* Direct Gateway eCheck Transaction Approved Order Note Filter.
*
* Allow actors to modify the order note added when an eCheck transaction
* is approved.
*
* @since 4.1.0
*
* @param string $message order note
* @param \WC_Order $order order object
* @param SV_WC_Payment_Gateway_API_Response $response transaction response
* @param SV_WC_Payment_Gateway_Direct $this instance
*/
$message = apply_filters( 'wc_payment_gateway_' . $this->get_id() . '_check_transaction_approved_order_note', $message, $order, $response, $this );
$order->add_order_note( $message );
}
return $response;
}
/**
* Performs a credit card transaction for the given order and returns the result.
*
* @since 1.0.0
*
* @param \WC_Order $order the order object
* @param SV_WC_Payment_Gateway_API_Response $response optional credit card transaction response
* @return SV_WC_Payment_Gateway_API_Response the response
* @throws SV_WC_Plugin_Exception network timeouts, etc
*/
protected function do_credit_card_transaction( $order, $response = null ) {
if ( is_null( $response ) ) {
if ( $this->perform_credit_card_charge( $order ) ) {
$response = $this->get_api()->credit_card_charge( $order );
} else {
$response = $this->get_api()->credit_card_authorization( $order );
}
}
// success! update order record
if ( $response->transaction_approved() ) {
$last_four = substr( $order->payment->account_number, -4 );
// use direct card type if set, or try to guess it from card number
if ( ! empty( $order->payment->card_type ) ) {
$card_type = $order->payment->card_type;
} elseif ( $first_four = substr( $order->payment->account_number, 0, 4 ) ) {
$card_type = SV_WC_Payment_Gateway_Helper::card_type_from_account_number( $first_four );
} else {
$card_type = 'card';
}
// credit card order note
$message = sprintf(
/* translators: Placeholders: %1$s - payment method title, %2$s - environment ("Test"), %3$s - transaction type (authorization/charge), %4$s - card type (mastercard, visa, ...), %5$s - last four digits of the card */
esc_html__( '%1$s %2$s %3$s Approved: %4$s ending in %5$s', 'woocommerce-plugin-framework' ),
$this->get_method_title(),
$this->is_test_environment() ? esc_html_x( 'Test', 'noun, software environment', 'woocommerce-plugin-framework' ) : '',
$this->perform_credit_card_authorization( $order ) ? esc_html_x( 'Authorization', 'credit card transaction type', 'woocommerce-plugin-framework' ) : esc_html_x( 'Charge', 'noun, credit card transaction type', 'woocommerce-plugin-framework' ),
SV_WC_Payment_Gateway_Helper::payment_type_to_name( $card_type ),
$last_four
);
// add the expiry date if it is available
if ( ! empty( $order->payment->exp_month ) && ! empty( $order->payment->exp_year ) ) {
$message .= ' ' . sprintf(
/** translators: Placeholders: %s - credit card expiry date */
__( '(expires %s)', 'woocommerce-plugin-framework' ),
$order->payment->exp_month . '/' . substr( $order->payment->exp_year, -2 )
);
}
// adds the transaction id (if any) to the order note
if ( $response->get_transaction_id() ) {
/* translators: Placeholders: %s - transaction ID */
$message .= ' ' . sprintf( esc_html__( '(Transaction ID %s)', 'woocommerce-plugin-framework' ), $response->get_transaction_id() );
}
/**
* Direct Gateway Credit Card Transaction Approved Order Note Filter.
*
* Allow actors to modify the order note added when a Credit Card transaction
* is approved.
*
* @since 4.1.0
*
* @param string $message order note
* @param \WC_Order $order order object
* @param SV_WC_Payment_Gateway_API_Response $response transaction response
* @param SV_WC_Payment_Gateway_Direct $this instance
*/
$message = apply_filters( 'wc_payment_gateway_' . $this->get_id() . '_credit_card_transaction_approved_order_note', $message, $order, $response, $this );
$order->add_order_note( $message );
}
return $response;
}
/**
* Create a transaction.
*
* @since 1.0.0
*
* @param \WC_Order $order the order object
* @return bool
* @throws SV_WC_Plugin_Exception
*/
protected function do_transaction( $order ) {
// perform the credit card or check transaction
if ( $this->is_credit_card_gateway() ) {
$response = $this->do_credit_card_transaction( $order );
} elseif ( $this->is_echeck_gateway() ) {
$response = $this->do_check_transaction( $order );
} else {
$do_payment_type_transaction = 'do_' . $this->get_payment_type() . '_transaction';
$response = $this->$do_payment_type_transaction( $order );
}
// handle the response
if ( $response->transaction_approved() || $response->transaction_held() ) {
if ( $this->supports_tokenization() && 0 != $order->get_user_id() && $this->get_payment_tokens_handler()->should_tokenize() &&
( $order->payment_total > 0 && ( $this->tokenize_with_sale() || $this->tokenize_after_sale() ) ) ) {
try {
$order = $this->get_payment_tokens_handler()->create_token( $order, $response );
} catch ( SV_WC_Plugin_Exception $e ) {
// handle the case of a "tokenize-after-sale" request failing by marking the order as on-hold with an explanatory note
if ( ! $response->transaction_held() && ! ( $this->supports( self::FEATURE_CREDIT_CARD_AUTHORIZATION ) && $this->perform_credit_card_authorization( $order ) ) ) {
// transaction has already been successful, but we've encountered an issue with the post-tokenization, add an order note to that effect and continue on
$message = sprintf(
/* translators: Placeholders: %s - failure message */
esc_html__( 'Tokenization Request Failed: %s', 'woocommerce-plugin-framework' ),
$e->getMessage()
);
$this->mark_order_as_held( $order, $message, $response );
} else {
// transaction has already been successful, but we've encountered an issue with the post-tokenization, add an order note to that effect and continue on
$message = sprintf(
/* translators: Placeholders: %1$s - payment method title, %2$s - failure message */
esc_html__( '%1$s Tokenization Request Failed: %2$s', 'woocommerce-plugin-framework' ),
$this->get_method_title(),
$e->getMessage()
);
$order->add_order_note( $message );
}
}
}
// add the standard transaction data
$this->add_transaction_data( $order, $response );
// allow the concrete class to add any gateway-specific transaction data to the order
$this->add_payment_gateway_transaction_data( $order, $response );
// if the transaction was held (ie fraud validation failure) mark it as such
// TODO: consider checking whether the response *was* an authorization, rather than blanket-assuming it was because of the settings. There are times when an auth will be used rather than charge, ie when performing in-plugin AVS handling (moneris)
if ( $response->transaction_held() || ( $this->supports( self::FEATURE_CREDIT_CARD_AUTHORIZATION ) && $this->perform_credit_card_authorization( $order ) ) ) {
// TODO: need to make this more flexible, and not force the message to 'Authorization only transaction' for auth transactions (re moneris efraud handling)
/* translators: This is a message describing that the transaction in question only performed a credit card authorization and did not capture any funds. */
$this->mark_order_as_held( $order, $this->supports( self::FEATURE_CREDIT_CARD_AUTHORIZATION ) && $this->perform_credit_card_authorization( $order ) ? esc_html__( 'Authorization only transaction', 'woocommerce-plugin-framework' ) : $response->get_status_message(), $response );
}
return true;
} else { // failure
return $this->do_transaction_failed_result( $order, $response );
}
}
/** Add Payment Method feature ********************************************/
/**
* Entry method for the Add Payment Method feature flow. Note this is *not*
* stubbed in the WC_Payment_Gateway abstract class, but is called if the
* gateway declares support for it.
*
* @since 4.0.0
*/
public function add_payment_method() {
assert( $this->supports_add_payment_method() );
$order = $this->get_order_for_add_payment_method();
try {
$result = $this->do_add_payment_method_transaction( $order );
} catch ( SV_WC_Plugin_Exception $e ) {
$result = array(
/* translators: Placeholders: %s - failure message. Payment method as in a specific credit card, e-check or bank account */
'message' => sprintf( esc_html__( 'Oops, adding your new payment method failed: %s', 'woocommerce-plugin-framework' ), $e->getMessage() ),
'success' => false,
);
}
SV_WC_Helper::wc_add_notice( $result['message'], $result['success'] ? 'success' : 'error' );
if ( $result['success'] ) {
$redirect_url = wc_get_account_endpoint_url( 'payment-methods' );
} else {
$redirect_url = wc_get_endpoint_url( 'add-payment-method' );
}
wp_safe_redirect( $redirect_url );
exit();
}
/**
* Performs the transaction to add the customer's payment method to their account.
*
* @since 4.0.0
*
* @param \WC_Order $order order object
* @param SV_WC_Payment_Gateway_API_Create_Payment_Token_Response $response optional payment token transaction response
* @return array result with success/error message and request status (success/failure)
* @throws SV_WC_Plugin_Exception
*/
protected function do_add_payment_method_transaction( \WC_Order $order, SV_WC_Payment_Gateway_API_Create_Payment_Token_Response $response = null ) {
if ( is_null( $response ) ) {
$response = $this->get_api()->tokenize_payment_method( $order );
}
if ( $response->transaction_approved() ) {
$token = $response->get_payment_token();
// set the token to the user account
$this->get_payment_tokens_handler()->add_token( $order->get_user_id(), $token );
// order note based on gateway type
if ( $this->is_credit_card_gateway() ) {
/* translators: Payment method as in a specific credit card. Placeholders: %1$s - card type (visa, mastercard, ...), %2$s - last four digits of the card, %3$s - card expiry date */
$message = sprintf( esc_html__( 'Nice! New payment method added: %1$s ending in %2$s (expires %3$s)', 'woocommerce-plugin-framework' ),
$token->get_type_full(),
$token->get_last_four(),
$token->get_exp_date()
);
} elseif ( $this->is_echeck_gateway() ) {
// account type (checking/savings) may or may not be available, which is fine
/* translators: Payment method as in a specific e-check account. Placeholders: %1$s - account type (checking/savings), %2$s - last four digits of the account */
$message = sprintf( esc_html__( 'Nice! New payment method added: %1$s account ending in %2$s', 'woocommerce-plugin-framework' ),
$token->get_account_type(),
$token->get_last_four()
);
} else {
/* translators: Payment method as in a specific credit card, e-check or bank account */
$message = esc_html__( 'Nice! New payment method added.', 'woocommerce-plugin-framework' );
}
// add transaction data to user meta
$this->add_add_payment_method_transaction_data( $response );
// add customer data, primarily customer ID to user meta
$this->add_add_payment_method_customer_data( $order, $response );
/**
* Fires after a new payment method is added by a customer.
*
* @since 5.0.0
*
* @param string $token_id new token ID
* @param int $user_id user ID
* @param SV_WC_Payment_Gateway_API_Response $response API response object
*/
do_action( 'wc_payment_gateway_' . $this->get_id() . '_payment_method_added', $token->get_id(), $order->get_user_id(), $response );
$result = array( 'message' => $message, 'success' => true );
} else {
if ( $response->get_status_code() && $response->get_status_message() ) {
$message = sprintf( 'Status code %s: %s', $response->get_status_code(), $response->get_status_message() );
} elseif ( $response->get_status_code() ) {
$message = sprintf( 'Status code: %s', $response->get_status_code() );
} elseif ( $response->get_status_message() ) {
$message = sprintf( 'Status message: %s', $response->get_status_message() );
} else {
$message = 'Unknown Error';
}
$result = array( 'message' => $message, 'success' => false );
}
/**