-
Notifications
You must be signed in to change notification settings - Fork 0
/
class-kickbox-gf-addon.php
783 lines (691 loc) · 24.2 KB
/
class-kickbox-gf-addon.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
<?php
use Skip405\Kickbox\WordPress\Client as Kickbox_Client;
GFForms::include_addon_framework();
class Kickbox_GF_Addon extends GFAddOn {
protected $_version = KICKBOX_GF_VERSION;
protected $_min_gravityforms_version = '1.9';
protected $_slug = 'kickbox';
protected $_path = 'kickbox-gf/kickbox-gf.php';
protected $_full_path = __FILE__;
protected $_title = 'Gravity Forms Kickbox Add-On';
protected $_short_title = 'Kickbox';
private static $_instance = null;
private static $_suggested_email_placeholder = '%suggested-email%';
/**
* Get an instance of this class.
*
* @return Kickbox_GF_Addon
*/
public static function get_instance() : Kickbox_GF_Addon {
if ( null === self::$_instance ) {
self::$_instance = new Kickbox_GF_Addon();
}
return self::$_instance;
}
/**
* Get a suggested email placeholder.
*
* @return string
*/
public static function get_suggested_email_placeholder() : string {
return self::$_suggested_email_placeholder;
}
/**
* Handles hooks and loading of language files.
*
* @return void
*/
public function init() {
parent::init();
add_action( 'gform_field_advanced_settings', array( $this, 'add_field_setting' ), 10, 2 );
add_filter( 'gform_validation', array( $this, 'verify_via_kickbox' ), apply_filters( 'kickbox_gf_validation_priority', 11 ) );
add_action( 'gform_editor_js', array( $this, 'editor_script' ) );
add_action( Kickbox_GF_Cache::CRON_ACTION, array( 'GFKickboxCache', 'prune_old_verifications' ) );
if ( ! wp_next_scheduled( Kickbox_GF_Cache::CRON_ACTION ) ) {
wp_schedule_event( time(), 'daily', Kickbox_GF_Cache::CRON_ACTION );
}
do_action( 'kickbox_gf_init' );
}
/**
* Configures the settings which should be rendered on the add-on settings tab.
*
* @return array
*/
public function plugin_settings_fields() : array {
return array(
array(
'title' => esc_html__( 'Kickbox Settings', 'kickbox-gf' ),
'fields' => array(
array(
'name' => 'api_key',
'tooltip' => esc_html__( 'Enter your API key here', 'kickbox-gf' ),
/* translators: 1: Number of days */
'label' => sprintf(
'%1$s (<small><a href="%2$s" target="_blank">%3$s</a></small>)',
esc_html__( 'Kickbox API Key', 'kickbox-gf' ),
'https://docs.kickbox.com/docs/using-the-api#getting-an-api-key',
esc_html__( 'Documentation', 'kickbox-gf' )
),
'type' => 'text',
'class' => 'small',
),
array(
'label' => esc_html__( 'Disable Kickbox Verification', 'kickbox-gf' ),
'description' => esc_html__( 'Tick this if you want to disable Kickbox Verifications globally, even if they are enabled in forms.', 'kickbox-gf' ),
'type' => 'checkbox',
'name' => 'globally_disabled',
'choices' => array(
array(
'label' => esc_html__( 'Disabled', 'kickbox-gf' ),
'name' => 'globally_disabled',
),
),
),
),
),
$this->get_verification_configuration_section(),
$this->get_custom_configuration_settings_section(),
array(
'title' => esc_html__( 'Verification Results Caching Settings', 'kickbox-gf' ),
'description' => esc_html__( 'Enable this setting if you want to cache Kickbox Verification Results and store them in the database. This will allow you to avoid excessive checking when multiple submissions from the same user are expected.', 'kickbox-gf' ),
'fields' => array(
array(
'label' => esc_html__( 'Enable Kickbox Verification Results Caching', 'kickbox-gf' ),
'type' => 'checkbox',
'name' => 'results_caching_enabled',
'choices' => array(
array(
'label' => esc_html__( 'Enabled', 'kickbox-gf' ),
'name' => 'results_caching_enabled',
),
),
),
array(
'name' => 'results_caching_duration',
'label' => esc_html__( 'Caching Duration (in days)', 'kickbox-gf' ),
'description' => sprintf(
/* translators: 1: Number of days */
esc_html__( 'Default duration is %1$s days.', 'kickbox-gf' ),
'7'
),
'type' => 'text',
'default_value' => '7',
'min' => 0,
'input_type' => 'number',
),
array(
'label' => esc_html_x( 'Cache Domains', 'Cache is a verb here', 'kickbox-gf' ),
'description' => sprintf(
/* translators: 1, 2, 4: Email addresses 3: Domain name */
esc_html__( 'Emails are used as cache keys. By default this will verify both %1$s and %2$s. When enabled, verifications will be cached for %3$s and %4$s will not be verified.', 'kickbox-gf' ),
'<code>john.doe@example.com</code>',
'<code>jane.doe@example.com</code>',
'<code>example.com</code>',
'<code>john.smith@example.com</code>'
),
'type' => 'checkbox',
'name' => 'domain_caching_enabled',
'choices' => array(
array(
'label' => esc_html__( 'Enabled', 'kickbox-gf' ),
'name' => 'domain_caching_enabled',
),
),
),
),
),
$this->get_error_messages_section(),
);
}
/**
* Outputs verification configuration types description.
*
* @return void
*/
public function settings_verification_setup_type() {
printf(
'<p>%s</p>',
esc_html__( 'Verification configuration allows you to choose what you can afford to receive as a valid response from Kickbox.', 'kickbox-gf' )
);
?>
<ul>
<li>
<b>
<?php
/* translators: Name of a predefined configuration choice */
esc_html_e( 'Strict', 'kickbox-gf' );
?>
:
</b>
<?php
printf(
/* translators: 1: Response result type named 'deliverable'
2: Sendex value
*/
esc_html__( 'allows %1$s emails only with Sendex of %2$s and higher.', 'kickbox-gf' ),
'<code>deliverable</code>',
'<code>0.7</code>'
);
?>
</li>
<li>
<b>
<?php
/* translators: Name of a predefined configuration choice */
esc_html_e( 'Permissive', 'kickbox-gf' );
?>
:
</b>
<?php
printf(
/* translators: 1: Response result type named 'deliverable'
2: Response result type named 'risky'
3: Response result type named 'unknown'
4: Sendex value
*/
esc_html__( 'allows emails with result types %1$s, %2$s and %3$s with Sendex of %4$s and higher.', 'kickbox-gf' ),
'<code>deliverable</code>',
'<code>risky</code>',
'<code>unknown</code>',
'<code>0.4</code>'
);
?>
</li>
<li>
<b>
<?php
/* translators: Name of a predefined configuration choice */
esc_html_e( 'Custom', 'kickbox-gf' );
?>
:
</b>
<?php esc_html_e( 'allows you to set everything up (see section below).', 'kickbox-gf' ); ?>
</li>
<?php
$addon = get_kickbox_gf_addon();
$form = $addon->get_current_form();
if ( ! empty( $form ) ) {
?>
<li>
<b>
<?php
esc_html_e( 'Disabled', 'kickbox-gf' );
?>
:
</b>
<?php esc_html_e( 'doesn\'t override the configuration from the plugin settings.', 'kickbox-gf' ); ?>
</li>
<?php
}
?>
</ul>
<?php
}
/**
* Configures the settings which should be rendered on the Form Settings > Kickbox tab.
*
* @param $form
*
* @return array
*/
public function form_settings_fields( $form ) : array {
return array(
$this->get_verification_configuration_section( 'form' ),
$this->get_custom_configuration_settings_section( 'form' ),
$this->get_error_messages_section( 'form' ),
);
}
/**
* Checks if passed value is a valid Sendex.
*
* @param string|float $value Value to check.
* @return bool
*/
public function is_valid_sendex_setting( $value ) : bool {
$float_value = (float) $value;
return $float_value > 0 && $float_value <= 1;
}
/**
* Filters submitted values and checks the needed one via Kickbox.
*
* @return array Validation result
*/
public function verify_via_kickbox( $validation_result ) : array {
$addon = get_kickbox_gf_addon();
$disabled_globally = $addon->get_plugin_setting( 'disabled' );
if ( ! empty( $disabled_globally ) ) {
return $validation_result;
}
$api_key = apply_filters( 'kickbox_gf_api_key', $addon->get_plugin_setting( 'api_key' ) );
if ( empty( $api_key ) ) {
return $validation_result;
}
$plugin_configuration = $addon->get_plugin_setting( 'verification_configuration' );
if ( empty( $plugin_configuration ) ) {
return $validation_result;
}
$form = $validation_result['form'];
$local_settings = $form['kickbox'] ?? array();
if ( ! empty( $local_settings['disabled'] ) ) {
return $validation_result;
}
$current_page = rgpost( 'gform_source_page_number_' . $form['id'] ) ? rgpost( 'gform_source_page_number_' . $form['id'] ) : 1;
foreach ( $form['fields'] as $field ) {
if ( ! $field->should_verify_via_kickbox || $field->failed_validation ) {
continue;
}
$field_page = $field->pageNumber;
$is_hidden = RGFormsModel::is_field_hidden( $form, $field, array() );
if ( ( (int) $field_page !== (int) $current_page ) || $is_hidden ) {
continue;
}
$field_name = apply_filters( 'kickbox_gf_field_name_before_verification', "input_{$field['id']}" );
$field_value = apply_filters( 'kickbox_gf_field_value_before_verification', rgpost( $field_name ) );
$is_fresh_cache = Kickbox_GF_Cache::is_cached_verification_fresh( $field_value );
if ( $is_fresh_cache ) {
$verification = $this->get_verification_from_cache( $field_value );
} else {
$verification = $this->get_verification_from_kickbox( $field_value, $api_key );
}
$interpretation = $this->interpret_verification( $verification );
if ( $interpretation['valid'] ) {
if ( ! $is_fresh_cache ) {
Kickbox_GF_Cache::cache_verification( $verification );
}
continue;
}
$validation_result['is_valid'] = false;
$field->failed_validation = true;
$field->validation_message = $interpretation['message'];
}
$validation_result['form'] = $form;
return $validation_result;
}
/**
* Outputs Kickbox verification field settings in the Advanced section.
*
* @return void
*/
public function add_field_setting( $position ) {
if ( -1 === $position ) {
?>
<li class="verify_via_kickbox_setting field_setting">
<input type="checkbox" id="should_verify_via_kickbox" onclick="SetFieldProperty('should_verify_via_kickbox', this.checked);" />
<label for="should_verify_via_kickbox">
<?php esc_html_e( 'Verify the value from this field via Kickbox', 'kickbox-gf' ); ?>
</label>
</li>
<?php
}
}
/**
* Outputs Kickbox verification field editor script.
*
* @return void
*/
public function editor_script() {
?>
<script type='text/javascript'>
fieldSettings.email += ', .verify_via_kickbox_setting';
jQuery(document).on('gform_load_field_settings', function(event, field) {
jQuery( '#should_verify_via_kickbox' ).prop( 'checked', Boolean( rgar( field, 'should_verify_via_kickbox' ) ) );
});
</script>
<?php
}
/**
* Gets a cached verification from the database.
*
* @param string $email Email being verified.
*
* @return array Cached verification
*/
private function get_verification_from_cache( string $email ) : array {
$cache_key = Kickbox_GF_Cache::get_verification_cache_key( $email );
$cached_verification = Kickbox_GF_Cache::get_cached_verification( $cache_key );
$cached_verification['kickbox']['from-cache'] = true;
do_action( 'kickbox_gf_cached_verification', $email, $cached_verification );
return apply_filters( 'kickbox_gf_verification', $cached_verification['kickbox'] );
}
/**
* Filters submitted values and checks the needed one via Kickbox.
*
* @param string $value The field value.
* @param string $api_key Kickbox API key.
*
* @return array Verification details
*/
private function get_verification_from_kickbox( string $value, string $api_key ) : array {
$kickbox_client = new Kickbox_Client( $api_key );
$verification = $kickbox_client->verify( $value );
do_action( 'kickbox_gf_pre_verification', $value );
if ( is_wp_error( $verification['data'] ) ) {
$verification = apply_filters(
'kickbox_gf_verification_error',
array(
'success' => false,
'data' => $verification['data'],
)
);
} else {
$verification = apply_filters(
'kickbox_gf_verification_success',
array(
'success' => true,
'from-cache' => false,
'data' => $verification['data'],
)
);
}
do_action( 'kickbox_gf_past_verification', $value, $verification );
return apply_filters( 'kickbox_gf_verification', $verification );
}
/**
* Interprets Kickbox verification and returns the verdict.
*
* @param array $verification The field value.
*
* @return array Verification interpretation
*/
private function interpret_verification( array $verification ) : array {
$interpretation = array(
'valid' => true,
'message' => '',
);
// interpret as valid if the HTTP-call errored or there's insufficient balance
if ( ! $verification['success'] || ! $verification['data']['body']['success'] ) {
do_action( 'kickbox_gf_verification_interpreted', $verification, $interpretation );
return apply_filters( 'kickbox_gf_interpretation', $interpretation );
}
$ignored_validation_reasons = apply_filters(
'kickbox_gf_ignored_reasons',
array(
'timeout',
'unexpected_error',
)
);
if ( in_array( $verification['data']['body']['reason'], $ignored_validation_reasons, true ) ) {
do_action( 'kickbox_gf_verification_interpreted', $verification, $interpretation );
return apply_filters( 'kickbox_gf_interpretation', $interpretation );
}
$config = $this->get_kickbox_configuration();
if ( ! in_array( $verification['data']['body']['result'], $config['valid-types'], true ) ) {
$message = Kickbox_GF_Error_Messages::get_message( $verification['data']['body']['reason'] );
if ( ! empty( $verification['data']['body']['did_you_mean'] ) ) {
$message = str_replace(
self::$_suggested_email_placeholder,
$verification['data']['body']['did_you_mean'],
Kickbox_GF_Error_Messages::get_message( 'suggested_email' )
);
}
$interpretation = array(
'valid' => false,
'message' => $message,
);
} elseif ( $verification['data']['body']['sendex'] <= $config['sendex'] ) {
$interpretation = array(
'valid' => false,
'message' => Kickbox_GF_Error_Messages::get_message( $verification['data']['body']['reason'] ),
);
}
do_action( 'kickbox_gf_verification_interpreted', $verification, $interpretation );
return apply_filters( 'kickbox_gf_interpretation', $interpretation );
}
/**
* Returns configuration choices labels and values.
*
* @return array[] Verification choices
*/
private function get_configuration_choices( $location ) : array {
$configuration_choices = array();
if ( 'form' === $location ) {
$configuration_choices[] = array(
'label' => esc_html__( 'Disabled', 'kickbox-gf' ),
'value' => 'disabled',
);
}
return array_merge(
array(
array(
'label' => esc_html__( 'Strict', 'kickbox-gf' ),
'value' => 'strict',
),
array(
'label' => esc_html__( 'Permissive', 'kickbox-gf' ),
'value' => 'permissive',
),
array(
'label' => esc_html__( 'Custom', 'kickbox-gf' ),
'value' => 'custom',
),
),
$configuration_choices
);
}
/**
* Returns the Verification Configuration section settings for the plugin and form settings pages.
*
* @param string $location Location where the section is used. 'plugin' and 'form' are valid values.
*
* @return array Verification Configuration section settings
*/
private function get_verification_configuration_section( string $location = 'plugin' ) : array {
$configuration_choices = $this->get_configuration_choices( $location );
$settings_description = '';
$required = true;
if ( 'form' === $location ) {
$addon = get_kickbox_gf_addon();
$plugin_configuration = $addon->get_plugin_setting( 'verification_configuration' );
$required = false;
$current_choice = array_values(
array_filter(
$configuration_choices,
function( $choice ) use ( $plugin_configuration ) {
return $plugin_configuration === $choice['value'];
}
)
);
$settings_description = esc_html__( 'Use these settings to override the plugin defaults.', 'kickbox-gf' );
if ( ! empty( $current_choice ) ) {
$settings_description .= sprintf(
' %s <code>%s</code>',
esc_html__( 'Configuration type on the plugin settings page:', 'kickbox-gf' ),
$current_choice[0]['label']
);
}
}
return array(
'title' => esc_html__( 'Kickbox Verification Settings', 'kickbox-gf' ),
'fields' => array(
array(
'label' => esc_html__( 'Verification Configuration', 'kickbox-gf' ),
'description' => $settings_description,
'type' => 'radio',
'name' => 'verification_configuration',
'required' => $required,
'horizontal' => true,
'choices' => $configuration_choices,
),
array(
'type' => 'verification_setup_type',
'name' => 'verification_setup_description',
),
),
);
}
/**
* Returns the Custom Configuration section settings for the plugin and form settings pages.
*
* @param string $location Location where the section is used. 'plugin' and 'form' are valid values.
*
* @return array Custom Configuration section settings
*/
private function get_custom_configuration_settings_section( string $location = 'plugin' ) : array {
$settings_description = sprintf(
/* translators: Name of a predefined configuration choice */
esc_html__( 'These settings work if %1$s is chosen as the Verification Configuration above.', 'kickbox-gf' ),
'<code>' . esc_html__( 'Custom', 'kickbox-gf' ) . '</code>'
);
if ( 'form' === $location ) {
$settings_description = sprintf(
/* translators: Name of a predefined configuration choice */
esc_html__( 'These settings work if %1$s is chosen as the Verification Configuration above or on the plugin settings page.', 'kickbox-gf' ),
'<code>' . esc_html__( 'Custom', 'kickbox-gf' ) . '</code>'
);
$settings_description = esc_html__( 'Use these settings to override the plugin defaults.', 'kickbox-gf' ) . ' ' . $settings_description;
}
return array(
'title' => esc_html__( 'Custom Configuration Settings', 'kickbox-gf' ),
'description' => $settings_description,
'fields' => array(
array(
'description' => esc_html__( 'Choose which Kickbox result types are considered valid (will not result in a validation error).', 'kickbox-gf' ),
'label' => sprintf(
'%s (<small><a href="https://docs.kickbox.com/docs/terminology" target="_blank">%s</a></small>)',
esc_html__( 'Valid Kickbox Result Types', 'kickbox-gf' ),
esc_html__( 'Documentation', 'kickbox-gf' )
),
'type' => 'checkbox',
'name' => 'custom_valid_result_types',
'choices' => array(
array(
'label' => 'deliverable',
'name' => 'type_deliverable',
'disabled' => 'disabled',
'default_value' => true,
),
array(
'label' => 'undeliverable',
'name' => 'type_undeliverable',
),
array(
'label' => 'risky',
'name' => 'type_risky',
),
array(
'label' => 'unknown',
'name' => 'type_unknown',
),
),
),
array(
'feedback_callback' => array( $this, 'is_valid_sendex_setting' ),
'label' => sprintf(
'%s (<small><a href="https://docs.kickbox.com/docs/the-sendex" target="_blank">%s</a></small>)',
esc_html__( 'Minimal Sendex Value', 'kickbox-gf' ),
esc_html__( 'Documentation', 'kickbox-gf' )
),
'description' => sprintf(
/* translators: default Sendex value */
esc_html__( 'Count emails with such Sendex value or lower as not valid. Please use a value between 0 and 1. Default is %s.', 'kickbox-gf' ),
'<code>0.4</code>'
),
'type' => 'text',
'name' => 'custom_minimal_sendex_value',
'input_type' => 'number',
'min' => 0,
'max' => 1,
'step' => 0.1,
),
),
);
}
/**
* Returns the Error Messages section settings for the plugin and form settings pages.
*
* @param string $location Location where the section is used. 'plugin' and 'form' are valid values.
*
* @return array Error Messages section settings
*/
private function get_error_messages_section( string $location = 'plugin' ) : array {
$description = esc_html__( 'Specify error messages to show when Kickbox verifies an email as not valid.', 'kickbox-gf' );
if ( 'form' === $location ) {
$description = esc_html__( 'Use these settings to override the plugin defaults.', 'kickbox-gf' ) . ' ' . $description;
}
return array(
'title' => esc_html__( 'Error Messages', 'kickbox-gf' ),
'description' => $description,
'fields' => array(
array(
'label' => esc_html__( 'Generic Error Message', 'kickbox-gf' ),
'type' => 'text',
'name' => 'generic_error_message',
'after_input' => esc_html__( 'Specifying error messages for specific Kickbox result reasons is available to developers via filters.', 'kickbox-gf' ),
),
array(
'label' => esc_html__( 'Suggested Email Error Message', 'kickbox-gf' ),
'description' => sprintf(
/* translators:
1: An example of email correction
2, 3: Suggested Email placeholder
4: Current/Default error message
*/
esc_html__( 'This error message will be shown when a suggested email is returned if a possible spelling error was detected (%1$s). Use %2$s in the message, it\'ll be replaced with the one from Kickbox. Example: %3$s seems more like it.', 'kickbox-gf' ),
'<code>jane.doe@gamil.com</code> -> <code>jane.doe@gmail.com</code>',
'<code>' . self::$_suggested_email_placeholder . '</code>',
self::$_suggested_email_placeholder
),
'type' => 'text',
'name' => 'suggested_email_error_message',
),
),
);
}
/**
* Constructs the Configuration to check verifications against.
*
* @return array Configuration
*/
private function get_kickbox_configuration() : array {
$config = array(
'valid-types' => array( 'deliverable' ),
'sendex' => 0.4,
);
$form_settings_override = false;
$addon = get_kickbox_gf_addon();
$configuration = $addon->get_plugin_setting( 'verification_configuration' );
$form_settings = $addon->get_form_settings( $addon->get_current_form() );
if ( ! empty( $form_settings['verification_configuration'] ) && 'disabled' !== $form_settings['verification_configuration'] ) {
$configuration = $form_settings['verification_configuration'];
$form_settings_override = true;
}
switch ( $configuration ) {
case 'strict':
$config['sendex'] = 0.7;
break;
case 'permissive':
$config['valid-types'] = array( 'deliverable', 'risky', 'unknown' );
break;
case 'custom':
$potential_valid_types = array( 'undeliverable', 'risky', 'unknown' );
$sendex_value = $config['sendex'];
if ( $form_settings_override ) {
if ( ! empty( $form_settings['custom_minimal_sendex_value'] ) ) {
$sendex_value = (float) $form_settings['custom_minimal_sendex_value'];
}
foreach ( $potential_valid_types as $type ) {
if ( ! empty( $form_settings["type_$type"] ) ) {
$config['valid-types'][] = $type;
}
}
} else {
$custom_minimal_sendex_value = $addon->get_plugin_setting( 'custom_minimal_sendex_value' );
if ( ! empty( $custom_minimal_sendex_value ) ) {
$sendex_value = (float) $custom_minimal_sendex_value;
}
foreach ( $potential_valid_types as $type ) {
if ( ! empty( $addon->get_plugin_setting( "type_$type" ) ) ) {
$config['valid-types'][] = $type;
}
}
}
if ( $this->is_valid_sendex_setting( $sendex_value ) ) {
$config['sendex'] = $sendex_value;
}
break;
default:
break;
}
return apply_filters( 'kickbox_gf_configuration', $config );
}
}