-
Notifications
You must be signed in to change notification settings - Fork 7
/
class-gf-paypalpaymentspro.php
1696 lines (1435 loc) · 61.2 KB
/
class-gf-paypalpaymentspro.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
// don't load directly
if ( ! defined( 'ABSPATH' ) ) {
die();
}
GFForms::include_payment_addon_framework();
class GFPayPalPaymentsPro extends GFPaymentAddOn {
protected $_version = GF_PAYPALPAYMENTSPRO_VERSION;
protected $_min_gravityforms_version = '1.9.16';
protected $_slug = 'gravityformspaypalpaymentspro';
protected $_path = 'gravityformspaypalpaymentspro/paypalpaymentspro.php';
protected $_full_path = __FILE__;
protected $_url = 'http://www.gravityforms.com';
protected $_title = 'Gravity Forms PayPal Payments Pro Add-On';
protected $_short_title = 'PayPal Payments Pro';
protected $_supports_callbacks = true;
protected $_requires_credit_card = true;
protected $_enable_rg_autoupgrade = true;
/**
* Members plugin integration
*
* @access protected
* @var array
*/
protected $_capabilities = array(
'gravityforms_paypalpaymentspro',
'gravityforms_paypalpaymentspro_uninstall',
'gravityforms_paypalpaymentspro_plugin_page',
);
/**
* Permissions
*/
protected $_capabilities_settings_page = 'gravityforms_paypalpaymentspro';
protected $_capabilities_form_settings = 'gravityforms_paypalpaymentspro';
protected $_capabilities_uninstall = 'gravityforms_paypalpaymentspro_uninstall';
protected $_capabilities_plugin_page = 'gravityforms_paypalpaymentspro_plugin_page';
private static $_instance = null;
/**
* Get an instance of this class.
*
* @return GFPayPalPaymentsPro
*/
public static function get_instance() {
if ( self::$_instance == null ) {
self::$_instance = new GFPayPalPaymentsPro();
}
return self::$_instance;
}
// # ADMIN FUNCTIONS -----------------------------------------------------------------------------------------------
/**
* Includes the admin hooks.
*
* @since 2.5
*/
public function init_admin() {
parent::init_admin();
add_filter( 'gform_entry_detail_meta_boxes', array( $this, 'filter_entry_detail_meta_boxes' ), 50, 2 );
}
/**
* Triggers updating of the entry payment status for subscriptions started before the cron job was fixed.
*
* @since 2.5
*
* @param array $meta_boxes The properties for the meta boxes.
* @param array $entry The entry currently being viewed/edited.
*
* @return array
*/
public function filter_entry_detail_meta_boxes( $meta_boxes, $entry ) {
if ( ! empty( $meta_boxes['payment'] ) && $this->has_subscription( $entry ) ) {
$this->maybe_update_subscription_status( $entry );
}
return $meta_boxes;
}
/**
* Updates the entry payment status and sets the entry meta so the cron can check the status of active subscriptions.
*
* @since 2.5
*
* @param array $entry The entry currently being viewed/edited.
*/
public function maybe_update_subscription_status( $entry ) {
$this->log_debug( __METHOD__ . "(): Checking if entry #{$entry['id']} needs to be registered with the cron for subscription status checks." );
if ( rgar( $entry, 'payment_status' ) !== 'Active' ) {
$this->log_debug( __METHOD__ . '(): aborting; not active' );
return;
}
$meta_key = $this->get_cron_entry_meta_key();
if ( ! empty( gform_get_meta( $entry['id'], $meta_key ) ) ) {
$this->log_debug( __METHOD__ . '(): aborting; already has meta key' );
return;
}
$feed = $this->get_payment_feed( $entry );
$profile = $this->get_subscription_status( $entry['transaction_id'], $feed, $entry['form_id'] );
if ( rgar( $profile, 'RESULT' ) !== '0' ) {
return;
}
$this->insert_subscription_transactions( $entry, $feed );
switch ( strtolower( rgar( $profile, 'STATUS' ) ) ) {
case 'active' :
$next_timestamp = $this->get_timestamp_from_mdy( $profile['NEXTPAYMENT'] );
gform_update_meta( $entry['id'], $meta_key, $next_timestamp );
$this->log_debug( sprintf( '%s(): %s meta for entry #%d set to %d.', __METHOD__, $meta_key, $entry['id'], $next_timestamp ) );
$this->add_note( $entry['id'], esc_html__( 'Entry registered for subscription status checks by the cron job.', 'gravityformspaypalpaymentspro' ) );
return;
case 'expired' :
GFAPI::update_entry_property( $entry['id'], 'payment_status', 'Expired' );
$entry['payment_status'] = 'Expired';
GFEntryDetail::set_current_entry( $entry );
$this->log_debug( sprintf( '%s(): Entry #%d subscription status changed to expired.', __METHOD__, $entry['id'] ) );
$this->add_note( $entry['id'], esc_html__( 'Subscription has expired.', 'gravityformspaypalpaymentspro' ) );
return;
default:
GFAPI::update_entry_property( $entry['id'], 'payment_status', 'Cancelled' );
$entry['payment_status'] = 'Cancelled';
GFEntryDetail::set_current_entry( $entry );
$this->log_debug( sprintf( '%s(): Entry #%d subscription status changed to cancelled.', __METHOD__, $entry['id'] ) );
$this->add_note( $entry['id'], esc_html__( 'Subscription has been cancelled.', 'gravityformspaypalpaymentspro' ) );
return;
}
}
/**
* Adds the subscription transactions to the database.
*
* The setup fee was added during form submission by GFPayPalPaymentsPro::process_subscription().
*
* @since 2.5
*
* @param array $entry The current entry.
* @param array|false $feed The feed which created the subscription.
*/
public function insert_subscription_transactions( $entry, $feed ) {
$transactions = $this->get_subscription_transactions( $entry['transaction_id'], $feed, $entry['form_id'] );
if ( empty( $transactions ) ) {
return;
}
global $wpdb;
$table = $wpdb->prefix . 'gf_addon_payment_transaction';
$inserted = array();
foreach ( $transactions as $transaction ) {
if ( ! $this->is_valid_transaction_state( $transaction ) ) {
continue;
}
$date = date( 'Y-m-d H:i:s', strtotime( $transaction['TRANSTIME'] ) );
$inserted[] = sprintf( '%s (%s)', $transaction['PNREF'], $date );
$wpdb->insert(
$table,
array(
'lead_id' => $entry['id'],
'transaction_type' => 'payment',
'transaction_id' => $transaction['PNREF'],
'subscription_id' => $entry['transaction_id'],
'is_recurring' => 1,
'amount' => $transaction['AMT'],
'date_created' => $date,
),
array(
'%d',
'%s',
'%s',
'%s',
'%d',
'%f',
'%s',
)
);
}
if ( ! empty( $inserted ) ) {
$this->add_note( $entry['id'], sprintf( esc_html__( 'Historical transactions added: %s.', 'gravityformspaypalpaymentspro' ), implode( ', ', $inserted ) ), 'success' );
}
}
// ------- Plugin settings -------
/**
* Return the plugin's icon for the plugin/form settings menu.
*
* @since 2.4
*
* @return string
*/
public function get_menu_icon() {
return file_get_contents( $this->get_base_path() . '/images/menu-icon.svg' );
}
/**
* Configures the settings which should be rendered on the add-on settings tab.
*
* @return array
*/
public function plugin_settings_fields() {
$description = '<p style="text-align: left;">' . sprintf( esc_html__( 'PayPal Payments Pro is a merchant account and gateway in one. Use Gravity Forms to collect payment information and automatically integrate to your PayPal Payments Pro account. If you don\'t have a PayPal Payments Pro account, you can %ssign up for one here.%s', 'gravityformspaypalpaymentspro' ), '<a href="https://registration.paypal.com/welcomePage.do?bundleCode=C3&country=US&partner=PayPal" target="_blank">', '</a>' ) . '</p>';
return array(
array(
'description' => $description,
'fields' => array(
array(
'name' => 'mode',
'label' => esc_html__( 'API', 'gravityformspaypalpaymentspro' ),
'type' => 'radio',
'default_value' => 'production',
'choices' => array(
array(
'label' => esc_html__( 'Live', 'gravityformspaypalpaymentspro' ),
'value' => 'production',
),
array(
'label' => esc_html__( 'Sandbox', 'gravityformspaypalpaymentspro' ),
'value' => 'test',
),
),
'horizontal' => true,
),
array(
'name' => 'username',
'label' => esc_html__( 'Username', 'gravityformspaypalpaymentspro' ),
'type' => 'text',
'class' => 'medium',
'feedback_callback' => array( $this, 'is_valid_api_credentials' ),
),
array(
'name' => 'password',
'label' => esc_html__( 'Password', 'gravityformspaypalpaymentspro' ),
'type' => 'password',
'class' => 'medium',
'feedback_callback' => array( $this, 'check_valid_api_credential_setting' ),
),
array(
'name' => 'vendor',
'label' => esc_html__( 'Vendor (optional)', 'gravityformspaypalpaymentspro' ),
'description' => esc_html__( 'Your merchant login ID if different from Username above.', 'gravityformspaypalpaymentspro' ),
'type' => 'text',
'class' => 'medium',
'feedback_callback' => array( $this, 'check_valid_api_credential_setting' ),
),
array(
'name' => 'partner',
'label' => esc_html__( 'Partner', 'gravityformspaypalpaymentspro' ),
'description' => esc_html__( 'If you have registered with a PayPal Reseller, enter their ID above.', 'gravityformspaypalpaymentspro' ),
'type' => 'text',
'class' => 'medium',
'default_value' => 'PayPal',
'feedback_callback' => array( $this, 'check_valid_api_credential_setting' ),
),
),
),
);
}
/**
* Define the markup for the password type field.
*
* @param array $field The field properties.
* @param bool|true $echo Should the setting markup be echoed.
*
* @return string|void
*/
public function settings_password( $field, $echo = true ) {
$field['type'] = 'text';
$password_field = $this->settings_text( $field, false );
//switch type="text" to type="password" so the password is not visible
$password_field = str_replace( 'type="text"','type="password"', $password_field );
if ( $echo ) {
echo $password_field;
}
return $password_field;
}
//-------- Form Settings ---------
/**
* Prevent feeds being listed or created if the api keys aren't valid.
*
* @return bool
*/
public function can_create_feed() {
return $this->is_valid_api_credentials();
}
/**
* Configures the settings which should be rendered on the feed edit page.
*
* @return array The feed settings.
*/
public function feed_settings_fields() {
$default_settings = parent::feed_settings_fields();
// Remove default options before adding custom.
$default_settings = parent::remove_field( 'options', $default_settings );
$default_settings = parent::remove_field( 'billingCycle', $default_settings );
$default_settings = parent::remove_field( 'trial', $default_settings );
// Add pay period if subscription.
if ( $this->get_setting( 'transactionType' ) == 'subscription' ) {
$pay_period_field = array(
'name' => 'payPeriod',
'label' => esc_html__( 'Pay Period', 'gravityformspaypalpaymentspro' ),
'type' => 'select',
'choices' => array(
array(
'label' => esc_html__( 'Weekly', 'gravityformspaypalpaymentspro' ),
'value' => 'WEEK',
),
array(
'label' => esc_html__( 'Every Two Weeks', 'gravityformspaypalpaymentspro' ),
'value' => 'BIWK',
),
array(
'label' => esc_html__( 'Twice Every Month', 'gravityformspaypalpaymentspro' ),
'value' => 'SMMO',
),
array(
'label' => esc_html__( 'Every Four Weeks', 'gravityformspaypalpaymentspro' ),
'value' => 'FRWK',
),
array(
'label' => esc_html__( 'Monthly', 'gravityformspaypalpaymentspro' ),
'value' => 'MONT',
),
array(
'label' => esc_html__( 'Quarterly', 'gravityformspaypalpaymentspro' ),
'value' => 'QTER',
),
array(
'label' => esc_html__( 'Twice Every Year', 'gravityformspaypalpaymentspro' ),
'value' => 'SMYR',
),
array(
'label' => esc_html__( 'Yearly', 'gravityformspaypalpaymentspro' ),
'value' => 'YEAR',
),
),
'tooltip' => '<h6>' . esc_html__( 'Pay Period', 'gravityformspaypalpaymentspro' ) . '</h6>' . esc_html__( 'Select pay period. This determines how often the recurring payment should occur.', 'gravityformspaypalpaymentspro' ),
);
$default_settings = $this->add_field_after( 'recurringAmount', $pay_period_field, $default_settings );
// Add post fields if form has a post.
$form = $this->get_current_form();
if ( GFCommon::has_post_field( $form['fields'] ) ) {
$post_settings = array(
'name' => 'post_checkboxes',
'label' => esc_html__( 'Posts', 'gravityformspaypalpaymentspro' ),
'type' => 'checkbox',
'tooltip' => '<h6>' . esc_html__( 'Posts', 'gravityformspaypalpaymentspro' ) . '</h6>' . esc_html__( 'Enable this option if you would like to change the post status when a subscription is cancelled.', 'gravityformspaypalpaymentspro' ),
'choices' => array(
array(
'label' => esc_html__( 'Update Post when subscription is cancelled.', 'gravityformspaypalpaymentspro' ),
'name' => 'change_post_status',
'onChange' => 'var action = this.checked ? "draft" : ""; jQuery("#update_post_action").val(action);',
),
),
);
$default_settings = $this->add_field_after( 'billingInformation', $post_settings, $default_settings );
}
}
if ( $this->is_gravityforms_supported( '2.5-dev-1' ) ) {
$dependency = array(
'live' => true,
'fields' => array(
array(
'field' => 'apiSettingsEnabled',
'values' => array( 'apiSettingsEnabled' ),
),
),
);
$api_settings_onchange = '';
$hidden = false;
} else {
$dependency = false;
$api_settings_onchange = "if(jQuery(this).prop('checked')){
jQuery('#gaddon-setting-row-overrideMode').show();
jQuery('#gaddon-setting-row-overrideUsername').show();
jQuery('#gaddon-setting-row-overridePassword').show();
jQuery('#gaddon-setting-row-overrideVendor').show();
jQuery('#gaddon-setting-row-overridePartner').show();
} else {
jQuery('#gaddon-setting-row-overrideMode').hide();
jQuery('#gaddon-setting-row-overrideUsername').hide();
jQuery('#gaddon-setting-row-overridePassword').hide();
jQuery('#gaddon-setting-row-overrideVendor').hide();
jQuery('#gaddon-setting-row-overridePartner').hide();
jQuery('#overrideUsername').val('');
jQuery('#overridePassword').val('');
jQuery('#overrideVendor').val('');
//jQuery('#overridePartner').val('');
jQuery('i').removeClass('icon-check fa-check gf_valid');
}";
$hidden = ! $this->get_setting( 'apiSettingsEnabled' );
}
$fields = array(
array(
'name' => 'apiSettingsEnabled',
'label' => esc_html__( 'API Settings', 'gravityformspaypalpaymentspro' ),
'type' => 'checkbox',
'tooltip' => '<h6>' . esc_html__( 'API Settings', 'gravityformspaypalpaymentspro' ) . '</h6>' . esc_html__( 'Override the settings provided on the PayPal Payments Pro Settings page and use these instead for this feed.', 'gravityformspaypalpaymentspro' ),
'choices' => array(
array(
'label' => 'Override Default Settings',
'name' => 'apiSettingsEnabled',
),
),
'onchange' => $api_settings_onchange,
),
array(
'name' => 'overrideMode',
'label' => esc_html__( 'API', 'gravityformspaypalpaymentspro' ),
'type' => 'radio',
'tooltip' => '<h6>' . esc_html__( 'API', 'gravityformspaypalpaymentspro' ) . '</h6>' . esc_html__( 'Select either Production or Sandbox API to override the chosen mode on the PayPal Payments Pro Settings page.', 'gravityformspaypalpaymentspro' ),
'choices' => array(
array(
'label' => esc_html__( 'Production', 'gravityformspaypalpaymentspro' ),
'value' => 'production',
),
array(
'label' => esc_html__( 'Sandbox', 'gravityformspaypalpaymentspro' ),
'value' => 'test',
),
),
'horizontal' => true,
'dependency' => $dependency,
'hidden' => $hidden,
),
array(
'name' => 'overrideUsername',
'label' => esc_html__( 'Username', 'gravityformspaypalpaymentspro' ),
'type' => 'text',
'class' => 'medium',
'tooltip' => '<h6>' . esc_html__( 'Username', 'gravityformspaypalpaymentspro' ) . '</h6>' . esc_html__( 'Enter a new value to override the Username on the PayPal Payments Pro Settings page.', 'gravityformspaypalpaymentspro' ),
'feedback_callback' => array( $this, 'is_valid_override_credentials' ),
'dependency' => $dependency,
'hidden' => $hidden,
),
array(
'name' => 'overridePassword',
'label' => esc_html__( 'Password', 'gravityformspaypalpaymentspro' ),
'type' => 'password',
'class' => 'medium',
'tooltip' => '<h6>' . esc_html__( 'Password', 'gravityformspaypalpaymentspro' ) . '</h6>' . esc_html__( 'Enter a new value to override the Password on the PayPal Payments Pro Settings page.', 'gravityformspaypalpaymentspro' ),
'feedback_callback' => array( $this, 'check_valid_override_credential_setting' ),
'dependency' => $dependency,
'hidden' => $hidden,
),
array(
'name' => 'overrideVendor',
'label' => esc_html__( 'Vendor (optional)', 'gravityformspaypalpaymentspro' ),
'type' => 'text',
'description' => esc_html__( 'Your merchant login ID if different from Username above.', 'gravityformspaypalpaymentspro' ),
'class' => 'medium',
'tooltip' => '<h6>' . esc_html__( 'Vendor', 'gravityformspaypalpaymentspro' ) . '</h6>' . esc_html__( 'Enter a new value to override the Vendor on the PayPal Payments Pro Settings page.', 'gravityformspaypalpaymentspro' ),
'feedback_callback' => array( $this, 'check_valid_override_credential_setting' ),
'dependency' => $dependency,
'hidden' => $hidden,
),
array(
'name' => 'overridePartner',
'label' => esc_html__( 'Partner', 'gravityformspaypalpaymentspro' ),
'description' => esc_html__( 'If you have registered with a PayPal Reseller, enter their ID above.', 'gravityformspaypalpaymentspro' ),
'type' => 'text',
'class' => 'medium',
'tooltip' => '<h6>' . esc_html__( 'Partner', 'gravityformspaypalpaymentspro' ) . '</h6>' . esc_html__( 'Enter a new value to override the Partner on the PayPal Payments Pro Settings page.', 'gravityformspaypalpaymentspro' ),
'default_value' => 'PayPal',
'feedback_callback' => array( $this, 'check_valid_override_credential_setting' ),
'dependency' => $dependency,
'hidden' => $hidden,
),
);
$default_settings = $this->add_field_after( 'conditionalLogic', $fields, $default_settings );
return $default_settings;
}
/**
* Returns the markup for the change post status checkbox item.
*
* @param array $choice The choice properties.
* @param string $attributes The attributes for the input tag.
* @param string $value Currently selection (1 if field has been checked. 0 or null otherwise).
* @param string $tooltip The tooltip for this checkbox item.
*
* @return string
*/
public function checkbox_input_change_post_status( $choice, $attributes, $value, $tooltip ) {
$markup = $this->checkbox_input( $choice, $attributes, $value, $tooltip );
$dropdown_field = array(
'name' => 'update_post_action',
'choices' => array(
array( 'label' => '' ),
array( 'label' => esc_html__( 'Mark Post as Draft', 'gravityformspaypalpaymentspro' ), 'value' => 'draft' ),
array( 'label' => esc_html__( 'Delete Post', 'gravityformspaypalpaymentspro' ), 'value' => 'delete' ),
),
'onChange' => "var checked = jQuery(this).val() ? 'checked' : false; jQuery('#change_post_status').attr('checked', checked);",
);
$markup .= ' ' . $this->settings_select( $dropdown_field, false );
return $markup;
}
/**
* Prepend the name fields to the default billing_info_fields added by the framework.
*
* @return array
*/
public function billing_info_fields() {
$fields = array(
array(
'name' => 'lastName',
'label' => esc_html__( 'Last Name', 'gravityformspaypalpaymentspro' ),
'required' => false,
),
array(
'name' => 'firstName',
'label' => esc_html__( 'First Name', 'gravityformspaypalpaymentspro' ),
'required' => false,
),
);
return array_merge( $fields, parent::billing_info_fields() );
}
/**
* Add supported notification events.
*
* @param array $form The form currently being processed.
*
* @return array
*/
public function supported_notification_events( $form ) {
if ( ! $this->has_feed( $form['id'] ) ) {
return false;
}
return array(
'complete_payment' => esc_html__( 'Payment Completed', 'gravityformspaypalpaymentspro' ),
'create_subscription' => esc_html__( 'Subscription Created', 'gravityformspaypalpaymentspro' ),
'cancel_subscription' => esc_html__( 'Subscription Canceled', 'gravityformspaypalpaymentspro' ),
'expire_subscription' => esc_html__( 'Subscription Expired', 'gravityformspaypalpaymentspro' ),
'add_subscription_payment' => esc_html__( 'Subscription Payment Added', 'gravityformspaypalpaymentspro' ),
);
}
// -------- Entry Detail ---------
/**
* Handle cancelling the subscription from the entry detail page.
*
* @param array $entry The entry object currently being processed.
* @param array $feed The feed object currently being processed.
*
* @return bool
*/
public function cancel( $entry, $feed ) {
$args = array( 'TRXTYPE' => 'R',
'TENDER' => 'C',
'ORIGPROFILEID' => $entry['transaction_id'],
'ACTION' => 'C'
);
$settings = $this->get_api_settings( $feed );
$response = $this->post_to_payflow( $args, $settings, $entry['form_id'] );
if ( ! empty( $response ) && $response['RESULT'] == '0' ) {
return true;
}
return false;
}
/**
* Check if the current entry was processed by this add-on.
*
* @param int $entry_id The ID of the current Entry.
*
* @return bool
*/
public function is_payment_gateway( $entry_id ) {
if ( $this->is_payment_gateway ) {
return true;
}
$gateway = gform_get_meta( $entry_id, 'payment_gateway' );
return in_array( $gateway, array( 'paypalpaymentspro', $this->_slug ) );
}
// # SUBMISSION ----------------------------------------------------------------------------------------------------
/**
* Authorize and capture the transaction for the product & services type feed.
*
* @param array $feed The feed object currently being processed.
* @param array $submission_data The customer and transaction data.
* @param array $form The form object currently being processed.
* @param array $entry The entry object currently being processed.
*
* @return array
*/
public function authorize( $feed, $submission_data, $form, $entry ) {
// Credit Card Information.
$args = $this->prepare_credit_card_transaction( $feed, $submission_data, $form, $entry );
// Setting up sale transaction parameters.
$args['TRXTYPE'] = 'S';
/**
* Filter the transaction properties for the product and service feed.
*
* @since 1.0.0
* @since 2.0.0 Added the $submission_data, $feed, and $entry parameters.
*
* @param array $args The transaction properties.
* @param int $form_id The ID of the form currently being processed.
* @param array $submission_data The customer and transaction data.
* @param array $feed The feed object currently being processed.
* @param array $entry The entry object currently being processed.
*/
$args = apply_filters( 'gform_paypalpaymentspro_args_before_payment', $args, $form['id'], $submission_data, $feed, $entry );
if ( empty( $args['ACCT'] ) ) {
return array(
'is_authorized' => false,
'error_message' => esc_html__( 'Please enter your credit card information.', 'gravityformspaypalpaymentspro' ),
);
}
$settings = $this->get_api_settings( $feed );
$response = $this->post_to_payflow( $args, $settings, $form['id'] );
if ( isset( $response['RESULT'] ) && $response['RESULT'] == 0 ) {
$this->log_debug( __METHOD__ . "(): Funds captured successfully. Amount: {$args['AMT']}. Transaction Id: {$response['PNREF']}." );
$captured_payment = array(
'is_success' => true,
'error_message' => '',
'transaction_id' => $response['PNREF'],
'amount' => $args['AMT'],
);
$auth = array(
'is_authorized' => true,
'transaction_id' => $response['PNREF'],
'captured_payment' => $captured_payment,
);
$config = $this->get_config( $feed, $submission_data );
/**
* @deprecated
*/
do_action( 'gform_paypalpaymentspro_post_capture', $args['AMT'], $entry, $form, $config );
} else {
$this->log_error( __METHOD__ . '(): Funds could not be captured.' );
$auth = array(
'is_success' => false,
'transaction_id' => $response['PNREF'],
'error_message' => $response['RESPMSG'],
);
}
return $auth;
}
/**
* Create a recurring profile for the user and return any errors which occur.
*
* @param array $feed The feed object currently being processed.
* @param array $submission_data The customer and transaction data.
* @param array $form The form object currently being processed.
* @param array $entry The entry object currently being processed.
*
* @return array
*/
public function subscribe( $feed, $submission_data, $form, $entry ) {
$subscription = $this->prepare_credit_card_transaction( $feed, $submission_data, $form, $entry );
// Setting up recurring transaction parameters
$subscription['TRXTYPE'] = 'R';
$subscription['ACTION'] = 'A';
$subscription['START'] = date( 'mdY', mktime( 0, 0, 0, date( 'm' ), date( 'd' ) + 1, date( 'y' ) ) );
$subscription['PROFILENAME'] = $subscription['FIRSTNAME'] . ' ' . $subscription['LASTNAME'];
$subscription['MAXFAILEDPAYMENTS'] = '0';
$subscription['PAYPERIOD'] = $feed['meta']['payPeriod'];
$subscription['TERM'] = $feed['meta']['recurringTimes'];
$subscription['AMT'] = $submission_data['payment_amount'];
if ( $feed['meta']['setupFee_enabled'] && ! empty( $submission_data['setup_fee'] ) && $submission_data['setup_fee'] > 0 ) {
$subscription['OPTIONALTRX'] = 'S';
$subscription['OPTIONALTRXAMT'] = $submission_data['setup_fee'];
} else {
$subscription['OPTIONALTRX'] = 'A';
}
/**
* Filter the subscription transaction properties.
*
* @since 1.0.0
* @since 2.0.0 Added the $submission_data, $feed, and $entry parameters.
*
* @param array $subscription The subscription transaction properties.
* @param int $form_id The ID of the form currently being processed.
* @param array $submission_data The customer and transaction data.
* @param array $feed The feed object currently being processed.
* @param array $entry The entry object currently being processed.
*/
$subscription = apply_filters( 'gform_paypalpaymentspro_args_before_subscription', $subscription, $form['id'], $submission_data, $feed, $entry );
if ( empty( $subscription['ACCT'] ) ) {
return array(
'is_success' => false,
'error_message' => esc_html__( 'Please enter your credit card information.', 'gravityformspaypalpaymentspro' ),
);
}
$this->log_debug( __METHOD__ . '(): Creating recurring profile.' );
$settings = $this->get_api_settings( $feed );
$response = $this->post_to_payflow( $subscription, $settings, $form['id'] );
if ( $response['RESULT'] == 0 ) {
$subscription_id = $response['PROFILEID'];
$this->log_debug( __METHOD__ . "(): Subscription created successfully. Subscription Id: {$subscription_id}" );
if ( $feed['meta']['setupFee_enabled'] ) {
$captured_payment = array(
'is_success' => true,
'transaction_id' => rgar( $response, 'RPREF' ),
'amount' => $submission_data['setup_fee'],
);
$subscription_result = array(
'is_success' => true,
'subscription_id' => $subscription_id,
'captured_payment' => $captured_payment,
'amount' => $subscription['AMT'],
'subscription_start_date' => $subscription['START'],
);
} else {
$subscription_result = array(
'is_success' => true,
'subscription_id' => $subscription_id,
'amount' => $subscription['AMT'],
'subscription_start_date' => $subscription['START'],
);
}
} else {
$this->log_error( __METHOD__ . '(): There was an error creating Subscription.' );
$error_message = $this->get_error_message( $response );
$subscription_result = array( 'is_success' => false, 'error_message' => $error_message );
}
return $subscription_result;
}
/**
* Processes the subscription after the entry has been saved.
*
* @since 2.5 Overrode to fix cron not processing entries due to missing entry meta.
*
* @param array $authorization The subscription details from GFPayPalPaymentsPro::subscribe().
* @param array $feed The feed which created the subscription.
* @param array $submission_data The submission data which was used to create the subscription.
* @param array $form The form currently being processed.
* @param array $entry The entry currently being processed.
*
* @return array
*/
public function process_subscription( $authorization, $feed, $submission_data, $form, $entry ) {
gform_update_meta( $entry['id'], $this->get_cron_entry_meta_key(), $this->get_timestamp_from_mdy( $authorization['subscription']['subscription_start_date'] ) );
return parent::process_subscription( $authorization, $feed, $submission_data, $form, $entry );
}
// # CRON JOB ------------------------------------------------------------------------------------------------------
/**
* Check subscription status; Active subscriptions will be checked to see if their status needs to be updated.
*
* @since 2.0
* @since 2.5 Fixed cron not processing subscriptions created by v2.0+.
*/
public function check_status() {
$query_timestamp = time();
$meta_key = $this->get_cron_entry_meta_key();
$this->log_debug( sprintf( '%s(): Searching for entries with active subscriptions and %s meta less than %d.', __METHOD__, $meta_key, $query_timestamp ) );
// Get entry table names and entry ID column.
$entry_table = self::get_entry_table_name();
$entry_meta_table = self::get_entry_meta_table_name();
$entry_id_column = version_compare( self::get_gravityforms_db_version(), '2.3-dev-1', '<' ) ? 'lead_id' : 'entry_id';
global $wpdb;
$results = $wpdb->get_results( $wpdb->prepare(
"SELECT l.id, l.form_id, l.transaction_id, m.meta_value as payment_date
FROM {$entry_table} l INNER JOIN {$entry_meta_table} m ON l.id = m.{$entry_id_column}
WHERE l.transaction_type = 2 AND l.payment_status = 'Active' AND meta_key = %s AND meta_value < %d",
$meta_key, $query_timestamp
) );
if ( empty( $results ) ) {
$this->log_debug( __METHOD__ . '(): No matching entries found.' );
return;
}
$this->log_debug( sprintf( '%s(): Checking subscription statuses for %d entries.', __METHOD__, count( $results ) ) );
foreach ( $results as $result ) {
$this->log_debug( __METHOD__ . '(): Processing entry => ' . json_encode( $result ) );
$entry_id = $result->id;
$feed = $this->get_payment_feed( array( 'id' => $entry_id ) );
$profile = $this->get_subscription_status( $result->transaction_id, $feed, $result->form_id );
if ( rgar( $profile, 'RESULT' ) !== '0' ) {
continue;
}
$entry = GFAPI::get_entry( $entry_id );
$status = $profile['STATUS'];
$subscription_id = $profile['PROFILEID'];
switch ( strtolower( $status ) ) {
case 'active' :
if ( $result->payment_date == $this->get_timestamp_from_mdy( $profile['LASTCHANGED'] ) ) {
gform_update_meta( $entry_id, $meta_key, $this->get_timestamp_from_mdy( $profile['NEXTPAYMENT'] ) );
if ( $this->process_last_subscription_transaction( $entry, $feed ) ) {
//deprecated
do_action( 'gform_paypalpaymentspro_after_subscription_payment', $entry, $subscription_id, $profile['AMT'] );
}
} else {
$this->log_debug( __METHOD__ . "(): No change to subscription for entry #{$entry_id}." );
}
break;
case 'expired' :
gform_delete_meta( $entry['id'], $meta_key );
$this->process_last_subscription_transaction( $entry, $feed );
$action = array(
'subscription_id' => $subscription_id,
'type' => 'expire_subscription'
);
$this->expire_subscription( $entry, $action );
//deprecated
do_action( 'gform_paypalpaymentspro_subscription_expired', $entry, $subscription_id );
break;
default:
gform_delete_meta( $entry['id'], $meta_key );
$this->process_last_subscription_transaction( $entry, $feed );
$this->cancel_subscription( $entry, $feed );
do_action( 'gform_paypalpaymentspro_subscription_canceled', $entry, $subscription_id );
break;
}
}
}
/**
* Returns the entry meta key used by the cron when finding the entries to process.
*
* @since 2.5
*
* @return string
*/
public function get_cron_entry_meta_key() {
return $this->get_slug() . '_cron_timestamp';
}
/**
* Returns the timestamp for the supplied date string.
*
* @since 2.5
*
* @param string $mdy_date A date in the mdY format.
*
* @return false|int
*/
public function get_timestamp_from_mdy( $mdy_date ) {
preg_match( '/(?<month>[\d]{2})(?<day>[\d]{2})(?<year>[\d]{4})/', $mdy_date, $matches );
$date = sprintf( '%s-%s-%s 00:00:00', $matches['year'], $matches['month'], $matches['day'] );
return strtotime( $date );
}
/**
* Requests the current status of the subscription from PayPal.
*
* @since 2.5
*
* @param string $profile_id The PayPal profile ID for the subscription (The entry transaction ID).
* @param array $feed The feed which created the subscription.
* @param int $form_id The ID of the form which created the subscription.
* @param bool $return_transactions Indicates if the transactions should be returned instead of subscription profile. Default is false.
*
* @return array
*/
public function get_subscription_status( $profile_id, $feed, $form_id, $return_transactions = false ) {
$request_args = array(
'TRXTYPE' => 'R',
'TENDER' => 'C',
'ACTION' => 'I',
'ORIGPROFILEID' => $profile_id,
);
if ( $return_transactions ) {
$request_args['PAYMENTHISTORY'] = 'Y';
}
return $this->post_to_payflow( $request_args, $this->get_api_settings( $feed ), $form_id );
}
/**
* Requests the recurring transactions for the specified subscription from PayPal.
*
* @since 2.5
*
* @param string $profile_id The PayPal profile ID for the subscription (The entry transaction ID).
* @param array $feed The feed which created the subscription.
* @param int $form_id The ID of the form which created the subscription.
*
* @return array
*/
public function get_subscription_transactions( $profile_id, $feed, $form_id ) {
$transactions = array();
$history = $this->get_subscription_status( $profile_id, $feed, $form_id, true );
if ( rgar( $history, 'RESULT' ) !== '0' ) {
return $transactions;
}
for ( $n = 1; ; $n ++ ) {
if ( ! isset( $history[ 'P_PNREF' . $n ] ) ) {
break;