forked from wp-premium/gravityformspaypal
-
Notifications
You must be signed in to change notification settings - Fork 1
/
class-gf-paypal.php
2254 lines (1781 loc) · 83.5 KB
/
class-gf-paypal.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
defined( 'ABSPATH' ) || die();
add_action( 'wp', array( 'GFPayPal', 'maybe_thankyou_page' ), 5 );
GFForms::include_payment_addon_framework();
class GFPayPal extends GFPaymentAddOn {
protected $_version = GF_PAYPAL_VERSION;
protected $_min_gravityforms_version = '1.9.3';
protected $_slug = 'gravityformspaypal';
protected $_path = 'gravityformspaypal/paypal.php';
protected $_full_path = __FILE__;
protected $_url = 'http://www.gravityforms.com';
protected $_title = 'Gravity Forms PayPal Standard Add-On';
protected $_short_title = 'PayPal';
protected $_supports_callbacks = true;
private $production_url = 'https://www.paypal.com/cgi-bin/webscr/';
private $sandbox_url = 'https://www.sandbox.paypal.com/cgi-bin/webscr/';
// Members plugin integration
protected $_capabilities = array( 'gravityforms_paypal', 'gravityforms_paypal_uninstall' );
// Permissions
protected $_capabilities_settings_page = 'gravityforms_paypal';
protected $_capabilities_form_settings = 'gravityforms_paypal';
protected $_capabilities_uninstall = 'gravityforms_paypal_uninstall';
// Automatic upgrade enabled
protected $_enable_rg_autoupgrade = true;
private static $_instance = null;
public static function get_instance() {
if ( self::$_instance == null ) {
self::$_instance = new GFPayPal();
}
return self::$_instance;
}
private function __clone() {
} /* do nothing */
public function init_frontend() {
parent::init_frontend();
add_filter( 'gform_disable_post_creation', array( $this, 'delay_post' ), 10, 3 );
add_filter( 'gform_disable_notification', array( $this, 'delay_notification' ), 10, 4 );
}
/**
* Returns what should be used to prepare the payment amount; form_total or the ID of a specific product field.
*
* @since 3.3
*
* @param array $feed The current feed.
*
* @return string
*/
public function get_payment_field( $feed ) {
switch ( rgars( $feed, 'meta/transactionType' ) ) {
case 'subscription':
$key = 'recurringAmount';
break;
case 'product':
case 'donation':
$key = 'paymentAmount';
break;
}
return rgars( $feed, 'meta/' . $key, 'form_total' );
}
//----- SETTINGS PAGES ----------//
/**
* Return the plugin's icon for the plugin/form settings menu.
*
* @since 3.2
*
* @return string
*/
public function get_menu_icon() {
return file_get_contents( $this->get_base_path() . '/images/menu-icon.svg' );
}
/**
* Register needed styles.
*
* @since 3.2
*
* @return array $styles
*/
public function styles() {
$min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG || isset( $_GET['gform_debug'] ) ? '' : '.min';
$styles = array(
array(
'handle' => 'gform_paypal_form_settings_css',
'src' => $this->get_base_url() . "/css/form_settings{$min}.css",
'version' => $this->_version,
'enqueue' => array(
array( 'admin_page' => array( 'form_settings' ) ),
),
),
);
return array_merge( parent::styles(), $styles );
}
public function plugin_settings_fields() {
$description = '
<p style="text-align: left;">' .
esc_html__( 'Gravity Forms requires IPN to be enabled on your PayPal account. Follow the following steps to confirm IPN is enabled.', 'gravityformspaypal' ) .
'</p>
<ul>
<li>' . sprintf( esc_html__( 'Navigate to your PayPal %sIPN Settings page.%s', 'gravityformspaypal' ), '<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=_profile-ipn-notify" target="_blank">', '</a>' ) . '</li>' .
'<li>' . esc_html__( 'If IPN is already enabled, you will see your current IPN settings along with a button to turn off IPN. If that is the case, just check the confirmation box below and you are ready to go!', 'gravityformspaypal' ) . '</li>' .
'<li>' . esc_html__( "If IPN is not enabled, click the 'Choose IPN Settings' button.", 'gravityformspaypal' ) . '</li>' .
'<li>' . sprintf( esc_html__( 'Click the box to enable IPN and enter the following Notification URL: %s', 'gravityformspaypal' ), '<strong>' . esc_url( $this->get_callback_url() ) . '</strong>' ) . '</li>' .
'</ul>
<br/>';
return array(
array(
'title' => '',
'description' => $description,
'fields' => array(
array(
'name' => 'gf_paypal_configured',
'label' => esc_html__( 'PayPal IPN Setting', 'gravityformspaypal' ),
'type' => 'checkbox',
'choices' => array( array( 'label' => esc_html__( 'Confirm that you have configured your PayPal account to enable IPN', 'gravityformspaypal' ), 'name' => 'gf_paypal_configured' ) )
),
),
),
);
}
public function feed_list_no_item_message() {
$settings = $this->get_plugin_settings();
if ( ! rgar( $settings, 'gf_paypal_configured' ) ) {
return sprintf( esc_html__( 'To get started, please configure your %sPayPal Settings%s!', 'gravityformspaypal' ), '<a href="' . admin_url( 'admin.php?page=gf_settings&subview=' . $this->_slug ) . '">', '</a>' );
} else {
return parent::feed_list_no_item_message();
}
}
public function feed_settings_fields() {
$default_settings = parent::feed_settings_fields();
//--add PayPal Email Address field
$fields = array(
array(
'name' => 'paypalEmail',
'label' => esc_html__( 'PayPal Email Address ', 'gravityformspaypal' ),
'type' => 'text',
'class' => 'medium',
'required' => true,
'tooltip' => '<h6>' . esc_html__( 'PayPal Email Address', 'gravityformspaypal' ) . '</h6>' . esc_html__( 'Enter the PayPal email address where payment should be received.', 'gravityformspaypal' )
),
array(
'name' => 'mode',
'label' => esc_html__( 'Mode', 'gravityformspaypal' ),
'type' => 'radio',
'choices' => array(
array( 'id' => 'gf_paypal_mode_production', 'label' => esc_html__( 'Production', 'gravityformspaypal' ), 'value' => 'production' ),
array( 'id' => 'gf_paypal_mode_test', 'label' => esc_html__( 'Test', 'gravityformspaypal' ), 'value' => 'test' ),
),
'horizontal' => true,
'default_value' => 'production',
'tooltip' => '<h6>' . esc_html__( 'Mode', 'gravityformspaypal' ) . '</h6>' . esc_html__( 'Select Production to receive live payments. Select Test for testing purposes when using the PayPal development sandbox.', 'gravityformspaypal' )
),
);
$default_settings = parent::add_field_after( 'feedName', $fields, $default_settings );
//--------------------------------------------------------------------------------------
//--add donation to transaction type drop down
$transaction_type = parent::get_field( 'transactionType', $default_settings );
$choices = $transaction_type['choices'];
$add_donation = true;
foreach ( $choices as $choice ) {
//add donation option if it does not already exist
if ( $choice['value'] == 'donation' ) {
$add_donation = false;
}
}
if ( $add_donation ) {
//add donation transaction type
$choices[] = array( 'label' => __( 'Donations', 'gravityformspaypal' ), 'value' => 'donation' );
}
$transaction_type['choices'] = $choices;
$default_settings = $this->replace_field( 'transactionType', $transaction_type, $default_settings );
//-------------------------------------------------------------------------------------------------
//--add Image URL, Cancel URL
$fields = array(
array(
'name' => 'imageURL',
'label' => esc_html__( 'Image URL', 'gravityformspaypal' ),
'type' => 'text',
'class' => 'medium',
'required' => false,
'tooltip' => '<h6>' . esc_html__( 'Image URL', 'gravityformspaypal' ) . '</h6>' . esc_html__( 'This option allows you to enter the URL of the 150x50-pixel image displayed as your logo in the upper left corner of the PayPal checkout pages. Default is your business name, if you have a PayPal Business account or your email address, if you have PayPal Premier or Personal account.', 'gravityformspaypal' )
),
array(
'name' => 'cancelUrl',
'label' => esc_html__( 'Cancel URL', 'gravityformspaypal' ),
'type' => 'text',
'class' => 'medium',
'required' => false,
'tooltip' => '<h6>' . esc_html__( 'Cancel URL', 'gravityformspaypal' ) . '</h6>' . esc_html__( 'Enter the URL the user should be sent to should they cancel before completing their PayPal payment.', 'gravityformspaypal' )
),
array(
'name' => 'options',
'label' => esc_html__( 'Options', 'gravityformspaypal' ),
'type' => 'options',
'tooltip' => '<h6>' . esc_html__( 'Options', 'gravityformspaypal' ) . '</h6>' . esc_html__( 'Turn on or off the available PayPal checkout options.', 'gravityformspaypal' ),
'choices' => array(
array(
'label' => esc_html__( 'Do not prompt buyer to include a shipping address.', 'gravityformspaypal' ),
'name' => 'disableShipping',
),
array(
'label' => esc_html__( 'Do not prompt buyer to include a note with payment.', 'gravityformspaypal' ),
'name' => 'disableNote',
),
),
),
);
if ( $this->get_setting( 'delayNotification' ) || ! $this->is_gravityforms_supported( '1.9.12' ) ) {
$fields[] = array(
'name' => 'notifications',
'label' => esc_html__( 'Notifications', 'gravityformspaypal' ),
'type' => 'notifications',
'tooltip' => '<h6>' . esc_html__( 'Notifications', 'gravityformspaypal' ) . '</h6>' . esc_html__( "Enable this option if you would like to only send out this form's notifications for the 'Form is submitted' event after payment has been received. Leaving this option disabled will send these notifications immediately after the form is submitted. Notifications which are configured for other events will not be affected by this option.", 'gravityformspaypal' )
);
}
//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', 'gravityformspaypal' ),
'type' => 'checkbox',
'tooltip' => '<h6>' . esc_html__( 'Posts', 'gravityformspaypal' ) . '</h6>' . esc_html__( 'Enable this option if you would like to only create the post after payment has been received.', 'gravityformspaypal' ),
'choices' => array(
array( 'label' => esc_html__( 'Create post only when payment is received.', 'gravityformspaypal' ), 'name' => 'delayPost' ),
),
);
if ( $this->get_setting( 'transactionType' ) == 'subscription' ) {
$post_settings['choices'][] = array(
'label' => esc_html__( 'Change post status when subscription is canceled.', 'gravityformspaypal' ),
'name' => 'change_post_status',
'onChange' => 'var action = this.checked ? "draft" : ""; jQuery("#update_post_action").val(action);',
);
}
$fields[] = $post_settings;
}
//Adding custom settings for backwards compatibility with hook 'gform_paypal_add_option_group'
$fields[] = array(
'name' => 'custom_options',
'label' => '',
'type' => 'custom',
);
$default_settings = $this->add_field_after( 'billingInformation', $fields, $default_settings );
//-----------------------------------------------------------------------------------------
//--get billing info section and add customer first/last name
$billing_info = parent::get_field( 'billingInformation', $default_settings );
$billing_fields = $billing_info['field_map'];
$add_first_name = true;
$add_last_name = true;
foreach ( $billing_fields as $mapping ) {
//add first/last name if it does not already exist in billing fields
if ( $mapping['name'] == 'firstName' ) {
$add_first_name = false;
} else if ( $mapping['name'] == 'lastName' ) {
$add_last_name = false;
}
}
if ( $add_last_name ) {
//add last name
array_unshift( $billing_info['field_map'], array( 'name' => 'lastName', 'label' => esc_html__( 'Last Name', 'gravityformspaypal' ), 'required' => false ) );
}
if ( $add_first_name ) {
array_unshift( $billing_info['field_map'], array( 'name' => 'firstName', 'label' => esc_html__( 'First Name', 'gravityformspaypal' ), 'required' => false ) );
}
$default_settings = parent::replace_field( 'billingInformation', $billing_info, $default_settings );
//----------------------------------------------------------------------------------------------------
//hide default display of setup fee, not used by PayPal Standard
$default_settings = parent::remove_field( 'setupFee', $default_settings );
//--add trial period
$trial_period = array(
'name' => 'trialPeriod',
'label' => esc_html__( 'Trial Period', 'gravityformspaypal' ),
'type' => 'trial_period',
'hidden' => ! $this->get_setting( 'trial_enabled' ),
'tooltip' => '<h6>' . esc_html__( 'Trial Period', 'gravityformspaypal' ) . '</h6>' . esc_html__( 'Select the trial period length.', 'gravityformspaypal' )
);
$default_settings = parent::add_field_after( 'trial', $trial_period, $default_settings );
//-----------------------------------------------------------------------------------------
//--Add Try to bill again after failed attempt.
$recurring_retry = array(
'name' => 'recurringRetry',
'label' => esc_html__( 'Recurring Retry', 'gravityformspaypal' ),
'type' => 'checkbox',
'horizontal' => true,
'choices' => array( array( 'label' => esc_html__( 'Try to bill again after failed attempt.', 'gravityformspaypal' ), 'name' => 'recurringRetry', 'value' => '1' ) ),
'tooltip' => '<h6>' . esc_html__( 'Recurring Retry', 'gravityformspaypal' ) . '</h6>' . esc_html__( 'Turn on or off whether to try to bill again after failed attempt.', 'gravityformspaypal' )
);
$default_settings = parent::add_field_after( 'recurringTimes', $recurring_retry, $default_settings );
//-----------------------------------------------------------------------------------------------------
/**
* Filter through the feed settings fields for the Paypal feed
*
* @param array $default_settings The Default feed settings
* @param array $form The Form object to filter through
*/
return apply_filters( 'gform_paypal_feed_settings_fields', $default_settings, $form );
}
public function supported_billing_intervals() {
$billing_cycles = array(
'day' => array( 'label' => esc_html__( 'day(s)', 'gravityformspaypal' ), 'min' => 1, 'max' => 90 ),
'week' => array( 'label' => esc_html__( 'week(s)', 'gravityformspaypal' ), 'min' => 1, 'max' => 52 ),
'month' => array( 'label' => esc_html__( 'month(s)', 'gravityformspaypal' ), 'min' => 1, 'max' => 24 ),
'year' => array( 'label' => esc_html__( 'year(s)', 'gravityformspaypal' ), 'min' => 1, 'max' => 5 )
);
return $billing_cycles;
}
public function field_map_title() {
return esc_html__( 'PayPal Field', 'gravityformspaypal' );
}
public function settings_trial_period( $field, $echo = true ) {
//use the parent billing cycle function to make the drop down for the number and type
$html = parent::settings_billing_cycle( $field, false );
if ( $echo ) {
echo $html;
}
return $html;
}
public function set_trial_onchange( $field ) {
//return the javascript for the onchange event
$row_id = $this->is_gravityforms_supported( '2.5-dev-1' ) ? '#gform_setting_trialPeriod' : '#gaddon-setting-row-trialPeriod';
return "
if(jQuery(this).prop('checked')){
jQuery('#{$field['name']}_product').show('slow');
jQuery('{$row_id}').show('slow');
if (jQuery('#{$field['name']}_product').val() == 'enter_amount'){
jQuery('#{$field['name']}_amount').show('slow');
}
else{
jQuery('#{$field['name']}_amount').hide();
}
}
else {
jQuery('#{$field['name']}_product').hide('slow');
jQuery('#{$field['name']}_amount').hide();
jQuery('{$row_id}').hide('slow');
}";
}
public function settings_options( $field, $echo = true ) {
$html = $this->settings_checkbox( $field, false );
//--------------------------------------------------------
//For backwards compatibility.
ob_start();
do_action( 'gform_paypal_action_fields', $this->get_current_feed(), $this->get_current_form() );
$html .= ob_get_clean();
//--------------------------------------------------------
if ( $echo ) {
echo $html;
}
return $html;
}
public function settings_custom( $field, $echo = true ) {
ob_start();
?>
<div id='gf_paypal_custom_settings'>
<?php
do_action( 'gform_paypal_add_option_group', $this->get_current_feed(), $this->get_current_form() );
?>
</div>
<?php
$html = ob_get_clean();
if ( $echo ) {
echo $html;
}
return $html;
}
public function settings_notifications( $field, $echo = true ) {
$checkboxes = array(
'name' => 'delay_notification',
'type' => 'checkboxes',
'onclick' => 'ToggleNotifications();',
'choices' => array(
array(
'label' => esc_html__( "Send notifications for the 'Form is submitted' event only when payment is received.", 'gravityformspaypal' ),
'name' => 'delayNotification',
),
)
);
$html = $this->settings_checkbox( $checkboxes, false );
$html .= $this->settings_hidden( array( 'name' => 'selectedNotifications', 'id' => 'selectedNotifications' ), false );
$form = $this->get_current_form();
$has_delayed_notifications = $this->get_setting( 'delayNotification' );
ob_start();
?>
<ul id="gf_paypal_notification_container" style="padding-left:20px; margin-top:10px; <?php echo $has_delayed_notifications ? '' : 'display:none;' ?>">
<?php
if ( ! empty( $form ) && is_array( $form['notifications'] ) ) {
$selected_notifications = $this->get_setting( 'selectedNotifications' );
if ( ! is_array( $selected_notifications ) ) {
$selected_notifications = array();
}
//$selected_notifications = empty($selected_notifications) ? array() : json_decode($selected_notifications);
$notifications = GFCommon::get_notifications( 'form_submission', $form );
foreach ( $notifications as $notification ) {
?>
<li class="gf_paypal_notification">
<input type="checkbox" class="notification_checkbox" value="<?php echo $notification['id'] ?>" onclick="SaveNotifications();" <?php checked( true, in_array( $notification['id'], $selected_notifications ) ) ?> />
<label class="inline" for="gf_paypal_selected_notifications"><?php echo $notification['name']; ?></label>
</li>
<?php
}
}
?>
</ul>
<script type='text/javascript'>
function SaveNotifications() {
var notifications = [];
jQuery('.notification_checkbox').each(function () {
if (jQuery(this).is(':checked')) {
notifications.push(jQuery(this).val());
}
});
jQuery('#selectedNotifications').val(jQuery.toJSON(notifications));
}
function ToggleNotifications() {
var container = jQuery('#gf_paypal_notification_container');
var isChecked = jQuery('#delaynotification').is(':checked');
if (isChecked) {
container.slideDown();
jQuery('.gf_paypal_notification input').prop('checked', true);
}
else {
container.slideUp();
jQuery('.gf_paypal_notification input').prop('checked', false);
}
SaveNotifications();
}
</script>
<?php
$html .= ob_get_clean();
if ( $echo ) {
echo $html;
}
return $html;
}
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', 'gravityformspaypal' ), 'value' => 'draft' ),
array( 'label' => esc_html__( 'Delete Post', 'gravityformspaypal' ), '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;
}
/**
* Prevent the GFPaymentAddOn version of the options field being added to the feed settings.
*
* @return bool
*/
public function option_choices() {
return false;
}
public function save_feed_settings( $feed_id, $form_id, $settings ) {
//--------------------------------------------------------
//For backwards compatibility
$feed = $this->get_feed( $feed_id );
//Saving new fields into old field names to maintain backwards compatibility for delayed payments
$settings['type'] = $settings['transactionType'];
if ( isset( $settings['recurringAmount'] ) ) {
$settings['recurring_amount_field'] = $settings['recurringAmount'];
}
$feed['meta'] = $settings;
$feed = apply_filters( 'gform_paypal_save_config', $feed );
//call hook to validate custom settings/meta added using gform_paypal_action_fields or gform_paypal_add_option_group action hooks
$is_validation_error = apply_filters( 'gform_paypal_config_validation', false, $feed );
if ( $is_validation_error ) {
//fail save
return false;
}
$settings = $feed['meta'];
//--------------------------------------------------------
return parent::save_feed_settings( $feed_id, $form_id, $settings );
}
public function check_ipn_request() {
$dismiss = isset( $_GET['dismiss_ipn_check'] );
if ( $dismiss ) {
add_option( 'dismiss_ipn_check', 1 );
}
if ( get_option( 'dismiss_ipn_check' ) ) {
return;
}
$can_verify_ipn = get_option( 'can_verify_ipn' );
if ( $can_verify_ipn == 'yes' ) {
return;
}
if ( empty( $can_verify_ipn ) ) {
$url = 'https://www.sandbox.paypal.com/cgi-bin/webscr/';
$request = new WP_Http();
$response = $request->post( $url, array( 'httpversion' => '1.1', 'sslverify' => false, 'ssl' => true, 'body' => 'cmd=_notify-validate', 'timeout' => 20 ) );
if ( ! is_wp_error( $response ) && rgar( $response, 'body' ) == 'INVALID' ) {
$can_verify_ipn = 'yes';
} else {
wp_mail( get_bloginfo( 'admin_email' ), 'Immediate Action Required: SSL certificate is outdated', 'WARNING: Your web server does not currently support the SHA-2 SSL Certificate standard required by PayPal. <a href="https://devblog.paypal.com/paypal-ssl-certificate-changes/">For details see PayPal\'s changeover announcement</a>. Please contact your web host to resolve this issue as soon as possible.' );
$can_verify_ipn = 'no';
}
update_option( 'can_verify_ipn', $can_verify_ipn );
}
if ( $can_verify_ipn == 'no' ) {
//display message
echo '<div class="error"> <p><strong>WARNING:</strong> Your web server does not currently support the SHA-2 SSL Certificate standard required by PayPal. <a href="https://devblog.paypal.com/paypal-ssl-certificate-changes/">For details see PayPal\'s changeover announcement</a>. Please contact your web host to resolve this issue as soon as possible. <a href="' . add_query_arg( array( 'dismiss_ipn_check' => 1 ) ) . '">Dismiss</a></p></div>';
}
}
//------ SENDING TO PAYPAL -----------//
public function redirect_url( $feed, $submission_data, $form, $entry ) {
//Don't process redirect url if request is a PayPal return
if ( ! rgempty( 'gf_paypal_return', $_GET ) ) {
return false;
}
//updating lead's payment_status to Processing
GFAPI::update_entry_property( $entry['id'], 'payment_status', 'Processing' );
//Getting Url (Production or Sandbox)
$url = $feed['meta']['mode'] == 'production' ? $this->production_url : $this->sandbox_url;
$invoice_id = apply_filters( 'gform_paypal_invoice', '', $form, $entry );
$invoice = empty( $invoice_id ) ? '' : "&invoice={$invoice_id}";
//Current Currency
$currency = rgar( $entry, 'currency' );
//Customer fields
$customer_fields = $this->customer_query_string( $feed, $entry );
//Image URL
$image_url = ! empty( $feed['meta']['imageURL'] ) ? '&image_url=' . urlencode( $feed['meta']['imageURL'] ) : '';
//Set return mode to 2 (PayPal will post info back to page). rm=1 seems to create lots of problems with the redirect back to the site. Defaulting it to 2.
$return_mode = '2';
$return_url = '&return=' . urlencode( $this->return_url( $form['id'], $entry['id'] ) ) . "&rm={$return_mode}";
//Cancel URL
$cancel_url = ! empty( $feed['meta']['cancelUrl'] ) ? '&cancel_return=' . urlencode( $feed['meta']['cancelUrl'] ) : '';
//Don't display note section
$disable_note = ! empty( $feed['meta']['disableNote'] ) ? '&no_note=1' : '';
//Don't display shipping section
$disable_shipping = ! empty( $feed['meta']['disableShipping'] ) ? '&no_shipping=1' : '';
//URL that will listen to notifications from PayPal
$ipn_url = urlencode( $this->get_callback_url() );
$business_email = urlencode( trim( $feed['meta']['paypalEmail'] ) );
$custom_field = $entry['id'] . '|' . wp_hash( $entry['id'] );
$url .= "?notify_url={$ipn_url}&charset=UTF-8¤cy_code={$currency}&business={$business_email}&custom={$custom_field}{$invoice}{$customer_fields}{$image_url}{$cancel_url}{$disable_note}{$disable_shipping}{$return_url}";
$query_string = '';
switch ( $feed['meta']['transactionType'] ) {
case 'product' :
//build query string using $submission_data
$query_string = $this->get_product_query_string( $submission_data, $entry['id'] );
break;
case 'donation' :
$query_string = $this->get_donation_query_string( $submission_data, $entry['id'] );
break;
case 'subscription' :
$query_string = $this->get_subscription_query_string( $feed, $submission_data, $entry['id'] );
break;
}
$query_string = gf_apply_filters( 'gform_paypal_query', $form['id'], $query_string, $form, $entry, $feed, $submission_data );
if ( ! $query_string ) {
$this->log_debug( __METHOD__ . '(): NOT sending to PayPal: The price is either zero or the gform_paypal_query filter was used to remove the querystring that is sent to PayPal.' );
return '';
}
$url .= $query_string;
$url = gf_apply_filters( 'gform_paypal_request', $form['id'], $url, $form, $entry, $feed, $submission_data );
//add the bn code (build notation code)
$url .= '&bn=Rocketgenius_SP';
$this->log_debug( __METHOD__ . "(): Sending to PayPal: {$url}" );
return $url;
}
public function get_product_query_string( $submission_data, $entry_id ) {
if ( empty( $submission_data ) ) {
return false;
}
$query_string = '';
$payment_amount = rgar( $submission_data, 'payment_amount' );
$setup_fee = rgar( $submission_data, 'setup_fee' );
$trial_amount = rgar( $submission_data, 'trial' );
$line_items = rgar( $submission_data, 'line_items' );
$discounts = rgar( $submission_data, 'discounts' );
$product_index = 1;
$shipping = '';
$discount_amt = 0;
$cmd = '_cart';
$extra_qs = '&upload=1';
//work on products
if ( is_array( $line_items ) ) {
foreach ( $line_items as $item ) {
$product_name = urlencode( $item['name'] );
$quantity = $item['quantity'];
$unit_price = $item['unit_price'];
$options = rgar( $item, 'options' );
$product_id = $item['id'];
$is_shipping = rgar( $item, 'is_shipping' );
if ( $is_shipping ) {
//populate shipping info
$shipping .= ! empty( $unit_price ) ? "&shipping_1={$unit_price}" : '';
} else {
//add product info to querystring
$query_string .= "&item_name_{$product_index}={$product_name}&amount_{$product_index}={$unit_price}&quantity_{$product_index}={$quantity}";
}
//add options
if ( ! empty( $options ) ) {
if ( is_array( $options ) ) {
$option_index = 1;
foreach ( $options as $option ) {
// Trim option label to prevent PayPal displaying an error instead of the cart.
$option_label = urlencode( substr( $option['field_label'], 0, 64 ) );
$option_name = urlencode( $option['option_name'] );
$query_string .= "&on{$option_index}_{$product_index}={$option_label}&os{$option_index}_{$product_index}={$option_name}";
$option_index ++;
}
}
}
$product_index ++;
}
}
//look for discounts
if ( is_array( $discounts ) ) {
foreach ( $discounts as $discount ) {
$discount_full = abs( $discount['unit_price'] ) * $discount['quantity'];
$discount_amt += $discount_full;
}
if ( $discount_amt > 0 ) {
$query_string .= "&discount_amount_cart={$discount_amt}";
}
}
$query_string .= "{$shipping}&cmd={$cmd}{$extra_qs}";
//save payment amount to lead meta
gform_update_meta( $entry_id, 'payment_amount', $payment_amount );
return $payment_amount > 0 ? $query_string : false;
}
public function get_donation_query_string( $submission_data, $entry_id ) {
if ( empty( $submission_data ) ) {
return false;
}
$query_string = '';
$payment_amount = rgar( $submission_data, 'payment_amount' );
$line_items = rgar( $submission_data, 'line_items' );
$purpose = '';
$cmd = '_donations';
//work on products
if ( is_array( $line_items ) ) {
foreach ( $line_items as $item ) {
$product_name = $item['name'];
$quantity = $item['quantity'];
$quantity_label = $quantity > 1 ? $quantity . ' ' : '';
$options = rgar( $item, 'options' );
$is_shipping = rgar( $item, 'is_shipping' );
$product_options = '';
if ( ! $is_shipping ) {
//add options
if ( ! empty( $options ) ) {
if ( is_array( $options ) ) {
$product_options = ' (';
foreach ( $options as $option ) {
$product_options .= $option['option_name'] . ', ';
}
$product_options = substr( $product_options, 0, strlen( $product_options ) - 2 ) . ')';
}
}
$purpose .= $quantity_label . $product_name . $product_options . ', ';
}
}
}
if ( ! empty( $purpose ) ) {
$purpose = substr( $purpose, 0, strlen( $purpose ) - 2 );
}
$purpose = urlencode( $purpose );
//truncating to maximum length allowed by PayPal
if ( strlen( $purpose ) > 127 ) {
$purpose = substr( $purpose, 0, 124 ) . '...';
}
$query_string = "&amount={$payment_amount}&item_name={$purpose}&cmd={$cmd}";
//save payment amount to lead meta
gform_update_meta( $entry_id, 'payment_amount', $payment_amount );
return $payment_amount > 0 ? $query_string : false;
}
public function get_subscription_query_string( $feed, $submission_data, $entry_id ) {
if ( empty( $submission_data ) ) {
return false;
}
$query_string = '';
$payment_amount = rgar( $submission_data, 'payment_amount' );
$setup_fee = rgar( $submission_data, 'setup_fee' );
$trial_enabled = rgar( $feed['meta'], 'trial_enabled' );
$line_items = rgar( $submission_data, 'line_items' );
$discounts = rgar( $submission_data, 'discounts' );
$recurring_field = rgar( $submission_data, 'payment_amount' ); //will be field id or the text 'form_total'
$product_index = 1;
$shipping = '';
$discount_amt = 0;
$cmd = '_xclick-subscriptions';
$extra_qs = '';
$name_without_options = '';
$item_name = '';
//work on products
if ( is_array( $line_items ) ) {
foreach ( $line_items as $item ) {
$product_id = $item['id'];
$product_name = $item['name'];
$quantity = $item['quantity'];
$quantity_label = $quantity > 1 ? $quantity . ' ' : '';
$unit_price = $item['unit_price'];
$options = rgar( $item, 'options' );
$product_id = $item['id'];
$is_shipping = rgar( $item, 'is_shipping' );
$product_options = '';
if ( ! $is_shipping ) {
//add options
if ( ! empty( $options ) && is_array( $options ) ) {
$product_options = ' (';
foreach ( $options as $option ) {
$product_options .= $option['option_name'] . ', ';
}
$product_options = substr( $product_options, 0, strlen( $product_options ) - 2 ) . ')';
}
$item_name .= $quantity_label . $product_name . $product_options . ', ';
$name_without_options .= $product_name . ', ';
}
}
//look for discounts to pass in the item_name
if ( is_array( $discounts ) ) {
foreach ( $discounts as $discount ) {
$product_name = $discount['name'];
$quantity = $discount['quantity'];
$quantity_label = $quantity > 1 ? $quantity . ' ' : '';
$item_name .= $quantity_label . $product_name . ' (), ';
$name_without_options .= $product_name . ', ';
}
}
if ( ! empty( $item_name ) ) {
$item_name = substr( $item_name, 0, strlen( $item_name ) - 2 );
}
//if name is larger than max, remove options from it.
if ( strlen( $item_name ) > 127 ) {
$item_name = substr( $name_without_options, 0, strlen( $name_without_options ) - 2 );
//truncating name to maximum allowed size
if ( strlen( $item_name ) > 127 ) {
$item_name = substr( $item_name, 0, 124 ) . '...';
}
}
$item_name = urlencode( $item_name );
}
$trial = '';
//see if a trial exists
if ( $trial_enabled ) {
$trial_amount = rgar( $submission_data, 'trial' ) ? rgar( $submission_data, 'trial' ) : 0;
$trial_period_number = rgar( $feed['meta'], 'trialPeriod_length' );
$trial_period_type = $this->convert_interval( rgar( $feed['meta'], 'trialPeriod_unit' ), 'char' );
$trial = "&a1={$trial_amount}&p1={$trial_period_number}&t1={$trial_period_type}";
}
//check for recurring times
$recurring_times = rgar( $feed['meta'], 'recurringTimes' ) ? '&srt=' . rgar( $feed['meta'], 'recurringTimes' ) : '';
$recurring_retry = rgar( $feed['meta'], 'recurringRetry' ) ? '1' : '0';
$billing_cycle_number = rgar( $feed['meta'], 'billingCycle_length' );
$billing_cycle_type = $this->convert_interval( rgar( $feed['meta'], 'billingCycle_unit' ), 'char' );
$query_string = "&cmd={$cmd}&item_name={$item_name}{$trial}&a3={$payment_amount}&p3={$billing_cycle_number}&t3={$billing_cycle_type}&src=1&sra={$recurring_retry}{$recurring_times}";
//save payment amount to lead meta
gform_update_meta( $entry_id, 'payment_amount', $payment_amount );
return $payment_amount > 0 ? $query_string : false;
}
public function customer_query_string( $feed, $entry ) {
$fields = '';
foreach ( $this->get_customer_fields() as $field ) {
$field_id = $feed['meta'][ $field['meta_name'] ];
$value = rgar( $entry, $field_id );
if ( $field['name'] == 'country' ) {
$value = class_exists( 'GF_Field_Address' ) ? GF_Fields::get( 'address' )->get_country_code( $value ) : GFCommon::get_country_code( $value );
} elseif ( $field['name'] == 'state' ) {
$value = class_exists( 'GF_Field_Address' ) ? GF_Fields::get( 'address' )->get_us_state_code( $value ) : GFCommon::get_us_state_code( $value );
}
if ( ! empty( $value ) ) {
$fields .= "&{$field['name']}=" . urlencode( $value );
}
}
return $fields;
}
public function return_url( $form_id, $lead_id ) {
$pageURL = GFCommon::is_ssl() ? 'https://' : 'http://';
$server_port = apply_filters( 'gform_paypal_return_url_port', $_SERVER['SERVER_PORT'] );
if ( $server_port != '80' ) {
$pageURL .= $_SERVER['SERVER_NAME'] . ':' . $server_port . $_SERVER['REQUEST_URI'];
} else {
$pageURL .= $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI'];
}
$ids_query = "ids={$form_id}|{$lead_id}";
$ids_query .= '&hash=' . wp_hash( $ids_query );
$url = add_query_arg( 'gf_paypal_return', base64_encode( $ids_query ), $pageURL );
$query = 'gf_paypal_return=' . base64_encode( $ids_query );
/**
* Filters PayPal's return URL, which is the URL that users will be sent to after completing the payment on PayPal's site.
* Useful when URL isn't created correctly (could happen on some server configurations using PROXY servers).
*
* @since 2.4.5
*
* @param string $url The URL to be filtered.
* @param int $form_id The ID of the form being submitted.
* @param int $entry_id The ID of the entry that was just created.
* @param string $query The query string portion of the URL.
*/
return apply_filters( 'gform_paypal_return_url', $url, $form_id, $lead_id, $query );
}
public static function maybe_thankyou_page() {
$instance = self::get_instance();
if ( ! $instance->is_gravityforms_supported() ) {
return;
}
if ( $str = rgget( 'gf_paypal_return' ) ) {
$str = base64_decode( $str );
parse_str( $str, $query );
if ( wp_hash( 'ids=' . $query['ids'] ) == $query['hash'] ) {
list( $form_id, $lead_id ) = explode( '|', $query['ids'] );
$form = GFAPI::get_form( $form_id );