PluginProbe
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More / 5.4
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More v5.4
6.35 6.34 6.33.1 6.33 6.32.1 6.32 6.31 6.25 6.25.1 6.26 6.26.1 6.27 6.28 6.29 6.3 6.3.1 6.3.2 6.30 6.4 6.4.1 6.4.2 6.5 6.5.1 6.5.2 6.5.3 All 141 releases
← All changes | classes/models/FrmEntryValidate.php +174 -506 6.295.4 View file →
@@ -3,22 +3,8 @@
3 3 die( 'You are not allowed to call this page directly.' );
4 4 }
5 5
6 6 class FrmEntryValidate {
7 -
8 - /**
9 - * @since 6.17
10 - *
11 - * @var array|null
12 - */
13 - private static $name_text_fields;
14 -
15 - /**
16 - * @param array $values
17 - * @param bool|string[] $exclude
18 - *
19 - * @return array
20 - */
21 7 public static function validate( $values, $exclude = false ) {
22 8 FrmEntry::sanitize_entry_post( $values );
23 9 $errors = array();
24 10
@@ -23,17 +9,17 @@
23 9 $errors = array();
24 10
25 11 if ( ! isset( $values['form_id'] ) || ! isset( $values['item_meta'] ) ) {
26 12 $errors['form'] = __( 'There was a problem with your submission. Please try again.', 'formidable' );
13 +
27 14 return $errors;
28 15 }
29 16
30 - if ( FrmAppHelper::is_admin() && is_user_logged_in() && ( ! isset( $values[ 'frm_submit_entry_' . $values['form_id'] ] ) || ! wp_verify_nonce( $values[ 'frm_submit_entry_' . $values['form_id'] ], 'frm_submit_entry_nonce' ) ) ) { // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
17 + if ( FrmAppHelper::is_admin() && is_user_logged_in() && ( ! isset( $values[ 'frm_submit_entry_' . $values['form_id'] ] ) || ! wp_verify_nonce( $values[ 'frm_submit_entry_' . $values['form_id'] ], 'frm_submit_entry_nonce' ) ) ) {
31 18 $frm_settings = FrmAppHelper::get_settings();
32 19 $errors['form'] = $frm_settings->admin_permission;
33 20 }
34 21
35 - self::maybe_fix_item_meta();
36 22 self::set_item_key( $values );
37 23
38 24 $posted_fields = self::get_fields_to_validate( $values, $exclude );
39 25
@@ -44,9 +30,9 @@
44 30 self::validate_field( $posted_field, $errors, $values, $args );
45 31 unset( $posted_field );
46 32 }
47 33
48 - if ( ! $errors ) {
34 + if ( empty( $errors ) ) {
49 35 self::spam_check( $exclude, $values, $errors );
50 36 }
51 37
52 38 /**
@@ -57,56 +43,21 @@
57 43 * @param array $errors Errors data.
58 44 * @param array $values Value data of the form.
59 45 * @param array $args Custom arguments. Contains `exclude` and `posted_fields`.
60 46 */
61 - $filtered_errors = apply_filters( 'frm_validate_entry', $errors, $values, compact( 'exclude', 'posted_fields' ) );
47 + $errors = apply_filters( 'frm_validate_entry', $errors, $values, compact( 'exclude', 'posted_fields' ) );
62 48
63 - if ( is_array( $filtered_errors ) ) {
64 - $errors = $filtered_errors;
65 - } else {
66 - _doing_it_wrong( __METHOD__, 'Only arrays should be returned when using the frm_validate_entry filter.', '6.3' );
67 - }
68 -
69 49 return $errors;
70 50 }
71 51
72 - /**
73 - * In case $_POST['item_meta'] is not an array, change it to an empty array.
74 - * This helps to avoid some warnings and errors when $_POST['item_meta'] is updated.
75 - *
76 - * @since 6.6
77 - *
78 - * @return void
79 - */
80 - private static function maybe_fix_item_meta() {
81 - // phpcs:ignore WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput.InputNotValidated
82 - if ( ! isset( $_POST['item_meta'] ) || ! is_array( $_POST['item_meta'] ) ) {
83 - $_POST['item_meta'] = array();
84 - }
85 - }
86 -
87 - /**
88 - * @param array $values
89 - *
90 - * @return void
91 - */
92 52 private static function set_item_key( &$values ) {
93 - // phpcs:ignore Universal.Operators.StrictComparisons
94 - if ( isset( $values['item_key'] ) && $values['item_key'] != '' ) {
95 - return;
53 + if ( ! isset( $values['item_key'] ) || $values['item_key'] == '' ) {
54 + global $wpdb;
55 + $values['item_key'] = FrmAppHelper::get_unique_key( '', $wpdb->prefix . 'frm_items', 'item_key' );
56 + $_POST['item_key'] = $values['item_key'];
96 57 }
97 -
98 - global $wpdb;
99 - $values['item_key'] = FrmAppHelper::get_unique_key( '', $wpdb->prefix . 'frm_items', 'item_key' );
100 - $_POST['item_key'] = $values['item_key'];
101 58 }
102 59
103 - /**
104 - * @param array $values
105 - * @param array|string $exclude
106 - *
107 - * @return array
108 - */
109 60 private static function get_fields_to_validate( $values, $exclude ) {
110 61 $where = apply_filters( 'frm_posted_field_ids', array( 'fi.form_id' => $values['form_id'] ) );
111 62
112 63 // Don't get subfields
@@ -112,9 +63,9 @@
112 63 // Don't get subfields
113 64 $where['fr.parent_form_id'] = array( null, 0 );
114 65
115 66 // Don't get excluded fields (like file upload fields in the ajax validation)
116 - if ( $exclude ) {
67 + if ( ! empty( $exclude ) ) {
117 68 $where['fi.type not'] = $exclude;
118 69 }
119 70
120 71 $fields = FrmField::getAll( $where, 'field_order' );
@@ -129,29 +80,23 @@
129 80 */
130 81 return apply_filters( 'frm_fields_to_validate', $fields, compact( 'values', 'exclude', 'where' ) );
131 82 }
132 83
133 - /**
134 - * @param object $posted_field
135 - * @param array $errors
136 - * @param array $values
137 - * @param array $args
138 - *
139 - * @return void
140 - */
141 84 public static function validate_field( $posted_field, &$errors, $values, $args = array() ) {
142 85 $defaults = array(
143 86 'id' => $posted_field->id,
144 - // The id of the repeat or embed form.
145 - 'parent_field_id' => '',
146 - // The pointer in the posted array.
147 - 'key_pointer' => '',
148 - // Exclude these field types from validation.
149 - 'exclude' => array(),
87 + 'parent_field_id' => '', // the id of the repeat or embed form
88 + 'key_pointer' => '', // the pointer in the posted array
89 + 'exclude' => array(), // exclude these field types from validation
90 + );
91 + $args = wp_parse_args( $args, $defaults );
150 92
151 - );
152 - $args = wp_parse_args( $args, $defaults );
153 - $value = ! empty( $args['parent_field_id'] ) ? $values : ( $values['item_meta'][ $args['id'] ] ?? '' );
93 + if ( empty( $args['parent_field_id'] ) ) {
94 + $value = isset( $values['item_meta'][ $args['id'] ] ) ? $values['item_meta'][ $args['id'] ] : '';
95 + } else {
96 + // value is from a nested form
97 + $value = $values;
98 + }
154 99
155 100 // Check for values in "Other" fields
156 101 FrmEntriesHelper::maybe_set_other_validation( $posted_field, $value, $args );
157 102
@@ -156,10 +101,9 @@
156 101 FrmEntriesHelper::maybe_set_other_validation( $posted_field, $value, $args );
157 102
158 103 self::maybe_clear_value_for_default_blank_setting( $posted_field, $value );
159 104
160 - $should_trim = is_array( $value ) && count( $value ) === 1 && isset( $value[0] ) && $posted_field->type !== 'checkbox';
161 -
105 + $should_trim = is_array( $value ) && count( $value ) == 1 && isset( $value[0] ) && $posted_field->type !== 'checkbox';
162 106 if ( $should_trim ) {
163 107 $value = reset( $value );
164 108 }
165 109
@@ -166,9 +110,8 @@
166 110 if ( ! is_array( $value ) ) {
167 111 $value = trim( $value );
168 112 }
169 113
170 - // phpcs:ignore Universal.Operators.StrictComparisons
171 114 if ( $posted_field->required == '1' && FrmAppHelper::is_empty_value( $value ) ) {
172 115 $errors[ 'field' . $args['id'] ] = FrmFieldsHelper::get_error_msg( $posted_field, 'blank' );
173 116 } elseif ( ! isset( $_POST['item_name'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
174 117 self::maybe_add_item_name( $value, $posted_field );
@@ -175,9 +118,8 @@
175 118 }
176 119
177 120 FrmEntriesHelper::set_posted_value( $posted_field, $value, $args );
178 121
179 - self::validate_options( $errors, $posted_field, $value, $args );
180 122 self::validate_field_types( $errors, $posted_field, $value, $args );
181 123
182 124 // Field might want to modify value before other parts of the system
183 125 // e.g. trim off excess values like in the case of fields with limit.
@@ -182,9 +124,8 @@
182 124 // Field might want to modify value before other parts of the system
183 125 // e.g. trim off excess values like in the case of fields with limit.
184 126 $value = apply_filters( 'frm_modify_posted_field_value', $value, $errors, $posted_field, $args );
185 127
186 - // phpcs:ignore Universal.Operators.StrictComparisons
187 128 if ( $value != '' ) {
188 129 self::validate_phone_field( $errors, $posted_field, $value, $args );
189 130 }
190 131
@@ -189,212 +130,19 @@
189 130 }
190 131
191 132 $errors = apply_filters( 'frm_validate_' . $posted_field->type . '_field_entry', $errors, $posted_field, $value, $args );
192 133 $errors = apply_filters( 'frm_validate_field_entry', $errors, $posted_field, $value, $args );
193 -
194 - if ( ! FrmAppHelper::pro_is_installed() && empty( $args['other'] ) ) {
195 - FrmEntriesHelper::get_posted_value( $posted_field, $value, $args );
196 - }
197 134 }
198 135
199 136 /**
200 - * @since 6.21
201 - *
202 - * @param array $errors
203 - * @param object $posted_field
204 - * @param array|string $value
205 - * @param array $args
206 - *
207 - * @return void
208 - */
209 - private static function validate_options( &$errors, $posted_field, $value, $args ) {
210 - if ( empty( $posted_field->options ) ) {
211 - return;
212 - }
213 -
214 - $option_is_valid = self::option_is_valid( $posted_field, $value, $posted_field->options );
215 -
216 - /**
217 - * @since 6.21
218 - *
219 - * @param bool $option_is_valid
220 - * @param array|string $value
221 - * @param object $field
222 - */
223 - $option_is_valid = (bool) apply_filters( 'frm_option_is_valid', $option_is_valid, $value, $posted_field );
224 -
225 - if ( ! $option_is_valid ) {
226 - $errors[ 'field' . $args['id'] ] = FrmFieldsHelper::get_error_msg( $posted_field, 'invalid' );
227 - }
228 - }
229 -
230 - /**
231 - * Validate that value matches one of the options for the field.
232 - *
233 - * @since 6.21
234 - *
235 - * @param stdClass $field
236 - * @param array|string $value
237 - * @param array $options
238 - *
239 - * @return bool
240 - */
241 - private static function option_is_valid( $field, $value, $options ) { // phpcs:ignore SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh
242 - if ( '' === $value ) {
243 - return true;
244 - }
245 -
246 - $field_object = FrmFieldFactory::get_field_type( $field->type, $field );
247 -
248 - if ( ! $field_object->field_type_has_options_settings() ) {
249 - return true;
250 - }
251 -
252 - if ( in_array( $field->type, array( 'likert', 'ranking' ), true ) ) {
253 - // Ignore these field types automatically.
254 - return true;
255 - }
256 -
257 - if ( 'product' === $field->type && 'user_def' === FrmField::get_option( $field, 'data_type' ) ) {
258 - return true;
259 - }
260 -
261 - if ( ! empty( $field->field_options['post_field'] ) ) {
262 - return true;
263 - }
264 -
265 - $value = (array) $value;
266 -
267 - foreach ( $value as $current_value ) {
268 - $match = false;
269 -
270 - foreach ( $options as $key => $option ) {
271 - if ( str_starts_with( $key, 'other_' ) ) {
272 - // Always return true if an other option is found.
273 - return true;
274 - }
275 -
276 - if ( is_array( $option ) ) {
277 - $separate_value = FrmField::get_option( $field, 'separate_value' );
278 - $option_value = $separate_value ? $option['value'] : $option['label'];
279 - } else {
280 - $option_value = $option;
281 - }
282 -
283 - /**
284 - * @var string $current_value
285 - */
286 - $match = trim( $current_value ) === trim( $option_value );
287 -
288 - if ( $match ) {
289 - break;
290 - }
291 -
292 - $match = trim( $current_value ) === trim( do_shortcode( $option_value ) );
293 -
294 - if ( $match ) {
295 - break;
296 - }
297 -
298 - $match = self::is_filtered_match( $current_value, $option_value );
299 -
300 - if ( $match ) {
301 - break;
302 - }
303 -
304 - if ( ! is_numeric( $current_value ) ) {
305 - continue;
306 - }
307 -
308 - $match = (int) $current_value === (int) $option_value;
309 -
310 - if ( $match ) {
311 - break;
312 - }
313 - }//end foreach
314 -
315 - if ( ! $match ) {
316 - return self::options_are_dynamic_based_on_hook( $field, $value );
317 - }
318 - }//end foreach
319 -
320 - return true;
321 - }
322 -
323 - /**
324 - * Make an extra check after passing $option_value through the_content filter.
325 - * This is to help catch cases where the option's formatting has been modified using
326 - * the_content filter.
327 - *
328 - * @since 6.22
329 - *
330 - * @param string $value
331 - * @param string $option_value
332 - *
333 - * @return bool
334 - */
335 - private static function is_filtered_match( $value, $option_value ) {
336 - // First remove the wpautop filter so it doesn't add extra tags to $option_value.
337 - $filter_priority = has_filter( 'the_content', 'wpautop' );
338 -
339 - if ( is_numeric( $filter_priority ) ) {
340 - remove_filter( 'the_content', 'wpautop', $filter_priority );
341 - }
342 -
343 - $filtered_option = apply_filters( 'the_content', $option_value );
344 -
345 - if ( is_numeric( $filter_priority ) ) {
346 - add_filter( 'the_content', 'wpautop', $filter_priority );
347 - }
348 -
349 - return trim( $value ) === trim( $filtered_option );
350 - }
351 -
352 - /**
353 - * Do not validate options if they have been modified with a hook.
354 - * This is to help avoid issues where the options could be based on a URL param for example.
355 - *
356 - * @since 6.21
357 - *
358 - * @param object $field_object The field object.
359 - * @param array|string $value The value to validate.
360 - *
361 - * @return bool
362 - */
363 - private static function options_are_dynamic_based_on_hook( $field_object, $value ) {
364 - $values = (array) $field_object;
365 - $values['value'] = $value;
366 - FrmFieldsHelper::prepare_new_front_field( $values, $field_object );
367 -
368 - $separate_value = FrmField::get_option( $field_object, 'separate_value' );
369 - $map_callback = function ( $option ) use ( $separate_value ) {
370 - if ( is_array( $option ) ) {
371 - $option_value = $separate_value ? $option['value'] : $option['label'];
372 - } else {
373 - $option_value = $option;
374 - }
375 - return do_shortcode( $option_value );
376 - };
377 -
378 - $values_options = array_map( $map_callback, $values['options'] );
379 - $field_object_options = array_map( $map_callback, $field_object->options );
380 -
381 - return $values_options !== $field_object_options;
382 - }
383 -
384 - /**
385 137 * Maybe add item_name to $_POST to save it in items table.
386 138 *
387 139 * @since 5.2.02
388 140 *
389 - * @param array|string $value Field value.
390 - * @param object $field Field object.
391 - *
392 - * @return void
141 + * @param object $field Field object.
393 142 */
394 143 private static function maybe_add_item_name( $value, $field ) {
395 144 $item_name = false;
396 -
397 145 if ( 'name' === $field->type ) {
398 146 $field_obj = FrmFieldFactory::get_field_object( $field );
399 147 $item_name = $field_obj->get_display_value( $value );
400 148 } elseif ( 'text' === $field->type ) {
@@ -401,10 +149,9 @@
401 149 $item_name = $value;
402 150 }
403 151
404 152 if ( false !== $item_name ) {
405 - // Item name has a max length of 255 characters so truncate it so it doesn't fail to save in the database.
406 - $_POST['item_name'] = substr( $item_name, 0, 255 );
153 + $_POST['item_name'] = $item_name;
407 154 }
408 155 }
409 156
410 157 /**
@@ -411,14 +158,11 @@
411 158 * Set $value to an empty string if it matches its label
412 159 *
413 160 * @param object $field
414 161 * @param string $value
415 - *
416 - * @return void
417 162 */
418 163 private static function maybe_clear_value_for_default_blank_setting( $field, &$value ) {
419 164 $position = FrmField::get_option( $field, 'label' );
420 -
421 165 if ( ! $position ) {
422 166 $position = FrmStylesController::get_style_val( 'position', $field->form_id );
423 167 }
424 168
@@ -426,16 +170,8 @@
426 170 $value = '';
427 171 }
428 172 }
429 173
430 - /**
431 - * @param array $errors
432 - * @param object $posted_field
433 - * @param mixed $value
434 - * @param array $args
435 - *
436 - * @return void
437 - */
438 174 public static function validate_field_types( &$errors, $posted_field, $value, $args ) {
439 175 $field_obj = FrmFieldFactory::get_field_object( $posted_field );
440 176 $args['value'] = $value;
441 177 $args['errors'] = $errors;
@@ -440,41 +176,24 @@
440 176 $args['value'] = $value;
441 177 $args['errors'] = $errors;
442 178
443 179 $new_errors = $field_obj->validate( $args );
444 -
445 - if ( $new_errors ) {
180 + if ( ! empty( $new_errors ) ) {
446 181 $errors = array_merge( $errors, $new_errors );
447 182 }
448 183 }
449 184
450 - /**
451 - * @param array $errors
452 - * @param object $field
453 - * @param string $value
454 - * @param array $args
455 - *
456 - * @return void
457 - */
458 185 public static function validate_phone_field( &$errors, $field, $value, $args ) {
459 - $format_value = FrmField::get_option( $field, 'format' );
186 + if ( $field->type == 'phone' || ( $field->type == 'text' && FrmField::is_option_true_in_object( $field, 'format' ) ) ) {
460 187
461 - if ( $field->type !== 'phone' && ( $field->type !== 'text' || ! $format_value || FrmCurrencyHelper::is_currency_format( $format_value ) ) ) {
462 - return;
463 - }
188 + $pattern = self::phone_format( $field );
464 189
465 - $pattern = self::phone_format( $field );
466 -
467 - if ( ! preg_match( $pattern, $value ) ) {
468 - $errors[ 'field' . $args['id'] ] = FrmFieldsHelper::get_error_msg( $field, 'invalid' );
190 + if ( ! preg_match( $pattern, $value ) ) {
191 + $errors[ 'field' . $args['id'] ] = FrmFieldsHelper::get_error_msg( $field, 'invalid' );
192 + }
469 193 }
470 194 }
471 195
472 - /**
473 - * @param object $field
474 - *
475 - * @return string
476 - */
477 196 public static function phone_format( $field ) {
478 197 if ( FrmField::is_option_empty( $field, 'format' ) ) {
479 198 $pattern = self::default_phone_format();
480 199 } else {
@@ -480,25 +199,22 @@
480 199 } else {
481 200 $pattern = FrmField::get_option( $field, 'format' );
482 201 }
483 202
484 - // Ampersands are saved as &.
485 - // Reverse it here so we are checking for the correct character.
486 - $pattern = html_entity_decode( $pattern );
487 203 $pattern = apply_filters( 'frm_phone_pattern', $pattern, $field );
488 204
489 205 // Create a regexp if format is not already a regexp
490 - if ( ! str_starts_with( $pattern, '^' ) ) {
206 + if ( strpos( $pattern, '^' ) !== 0 ) {
491 207 $pattern = self::create_regular_expression_from_format( $pattern );
492 208 }
493 209
494 - return '/' . $pattern . '/';
210 + $pattern = '/' . $pattern . '/';
211 +
212 + return $pattern;
495 213 }
496 214
497 215 /**
498 216 * @since 3.01
499 - *
500 - * @return string
501 217 */
502 218 private static function default_phone_format() {
503 219 return '^((\+\d{1,3}(-|.| )?\(?\d\)?(-| |.)?\d{1,5})|(\(?\d{2,6}\)?))(-|.| )?(\d{3,4})(-|.| )?(\d{4})(( x| ext)\d{1,5}){0,1}$';
504 220 }
@@ -524,57 +240,44 @@
524 240 $pattern = str_replace( 'a', '[a-zA-Z]', $pattern );
525 241 $pattern = str_replace( '*', 'w', $pattern );
526 242 $pattern = str_replace( '/', '\/', $pattern );
527 243
528 - if ( str_contains( $pattern, '\?' ) ) {
244 + if ( strpos( $pattern, '\?' ) !== false ) {
529 245 $parts = explode( '\?', $pattern );
530 246 $pattern = '';
531 -
532 247 foreach ( $parts as $part ) {
533 - if ( $pattern ) {
248 + if ( empty( $pattern ) ) {
249 + $pattern .= $part;
250 + } else {
534 251 $pattern .= '(' . $part . ')?';
535 - } else {
536 - $pattern .= $part;
537 252 }
538 253 }
539 254 }
255 + $pattern = '^' . $pattern . '$';
540 256
541 - return '^' . $pattern . '$';
257 + return $pattern;
542 258 }
543 259
544 260 /**
545 - * Check for spam.
261 + * Check for spam
546 262 *
547 - * @param bool $exclude
263 + * @param boolean $exclude
548 264 * @param array $values
549 - * @param array $errors By reference.
550 - *
551 - * @return void
265 + * @param array $errors by reference
552 266 */
553 267 public static function spam_check( $exclude, $values, &$errors ) {
554 - if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
555 - // Do not check spam on importing.
268 + if ( ! empty( $exclude ) || ! isset( $values['item_meta'] ) || empty( $values['item_meta'] ) || ! empty( $errors ) ) {
269 + // only check spam if there are no other errors
556 270 return;
557 271 }
558 272
559 - if ( $exclude || empty( $values['item_meta'] ) || $errors ) {
560 - // Only check spam if there are no other errors
561 - return;
562 - }
563 -
564 273 $antispam_check = self::is_antispam_check( $values['form_id'] );
565 - $spam_msg = FrmAntiSpamController::get_default_spam_message();
566 -
567 274 if ( is_string( $antispam_check ) ) {
568 275 $errors['spam'] = $antispam_check;
569 276 } elseif ( self::is_honeypot_spam( $values ) || self::is_spam_bot() ) {
570 - $errors['spam'] = $spam_msg;
571 - } else {
572 - $is_spam = FrmAntiSpamController::is_spam( $values );
573 -
574 - if ( $is_spam ) {
575 - $errors['spam'] = $is_spam;
576 - }
277 + $errors['spam'] = __( 'Your entry appears to be spam!', 'formidable' );
278 + } elseif ( self::blacklist_check( $values ) ) {
279 + $errors['spam'] = __( 'Your entry appears to be blocked spam!', 'formidable' );
577 280 }
578 281
579 282 if ( isset( $errors['spam'] ) || self::form_is_in_progress( $values ) ) {
580 283 return;
@@ -590,23 +293,19 @@
590 293 *
591 294 * @since 5.0.13
592 295 *
593 296 * @param array $values The values.
594 - *
595 297 * @return bool
596 298 */
597 299 private static function form_is_in_progress( $values ) {
598 - // phpcs:disable Generic.WhiteSpace.ScopeIndent
599 300 return FrmAppHelper::pro_is_installed() &&
600 301 ( isset( $values[ 'frm_page_order_' . $values['form_id'] ] ) || FrmAppHelper::get_post_param( 'frm_next_page' ) ) &&
601 302 FrmField::get_all_types_in_form( $values['form_id'], 'break' );
602 - // phpcs:enable Generic.WhiteSpace.ScopeIndent
603 303 }
604 304
605 305 /**
606 306 * @param int $form_id
607 - *
608 - * @return bool|string
307 + * @return boolean
609 308 */
610 309 private static function is_antispam_check( $form_id ) {
611 310 $aspm = new FrmAntiSpam( $form_id );
612 311 return $aspm->validate();
@@ -613,10 +312,9 @@
613 312 }
614 313
615 314 /**
616 315 * @param array $values
617 - *
618 - * @return bool
316 + * @return boolean
619 317 */
620 318 private static function is_honeypot_spam( $values ) {
621 319 $honeypot = new FrmHoneypot( $values['form_id'] );
622 320 return ! $honeypot->validate();
@@ -622,51 +320,90 @@
622 320 return ! $honeypot->validate();
623 321 }
624 322
625 323 /**
626 - * @return bool
324 + * @return boolean
627 325 */
628 326 private static function is_spam_bot() {
629 - return ! FrmAppHelper::get_ip_address();
327 + $ip = FrmAppHelper::get_ip_address();
328 +
329 + return empty( $ip );
630 330 }
631 331
632 332 /**
633 333 * @param array $values
634 - *
635 - * @return bool
334 + * @return boolean
636 335 */
637 336 private static function is_akismet_spam( $values ) {
638 337 global $wpcom_api_key;
639 - return is_callable( 'Akismet::http_post' ) && ( get_option( 'wordpress_api_key' ) || $wpcom_api_key ) && self::akismet( $values );
338 +
339 + return ( is_callable( 'Akismet::http_post' ) && ( get_option( 'wordpress_api_key' ) || $wpcom_api_key ) && self::akismet( $values ) );
640 340 }
641 341
642 342 /**
643 343 * @param int $form_id
644 - *
645 344 * @return bool
646 345 */
647 346 private static function is_akismet_enabled_for_user( $form_id ) {
648 347 $form = FrmForm::getOne( $form_id );
649 - return ! empty( $form->options['akismet'] ) && ( $form->options['akismet'] !== 'logged' || ! is_user_logged_in() );
348 +
349 + return ( ! empty( $form->options['akismet'] ) && ( $form->options['akismet'] !== 'logged' || ! is_user_logged_in() ) );
650 350 }
651 351
352 + public static function blacklist_check( $values ) {
353 + if ( ! apply_filters( 'frm_check_blacklist', true, $values ) ) {
354 + return false;
355 + }
356 +
357 + $mod_keys = trim( self::get_disallowed_words() );
358 + if ( empty( $mod_keys ) ) {
359 + return false;
360 + }
361 +
362 + $content = FrmEntriesHelper::entry_array_to_string( $values );
363 + if ( empty( $content ) ) {
364 + return false;
365 + }
366 +
367 + self::prepare_values_for_spam_check( $values );
368 + $ip = FrmAppHelper::get_ip_address();
369 + $user_agent = FrmAppHelper::get_server_value( 'HTTP_USER_AGENT' );
370 + $user_info = self::get_spam_check_user_info( $values );
371 +
372 + return self::check_disallowed_words( $user_info['comment_author'], $user_info['comment_author_email'], $user_info['comment_author_url'], $content, $ip, $user_agent );
373 + }
374 +
652 375 /**
653 - * Checks spam using WordPress disallowed words and Frm denylist.
376 + * For WP 5.5 compatibility.
654 377 *
655 - * @param array $values Entry values.
378 + * @since 4.06.02
379 + */
380 + private static function check_disallowed_words( $author, $email, $url, $content, $ip, $user_agent ) {
381 + if ( function_exists( 'wp_check_comment_disallowed_list' ) ) {
382 + return wp_check_comment_disallowed_list( $author, $email, $url, $content, $ip, $user_agent );
383 + } else {
384 + return wp_blacklist_check( $author, $email, $url, $content, $ip, $user_agent );
385 + }
386 + }
387 +
388 + /**
389 + * For WP 5.5 compatibility.
656 390 *
657 - * @return bool
391 + * @since 4.06.02
658 392 */
659 - public static function blacklist_check( $values ) {
660 - return FrmAntiSpamController::contains_wp_disallowed_words( $values ) || FrmAntiSpamController::is_denylist_spam( $values );
393 + private static function get_disallowed_words() {
394 + $keys = get_option( 'disallowed_keys' );
395 + if ( false === $keys ) {
396 + // Fallback for WP < 5.5.
397 + $keys = get_option( 'blacklist_keys' );
398 + }
399 + return $keys;
661 400 }
662 401
663 402 /**
664 403 * Check entries for Akismet spam
665 404 *
666 - * @param array $values Entry values.
667 - *
668 - * @return bool true if is spam
405 + * @return boolean true if is spam
669 406 */
670 407 public static function akismet( $values ) {
671 408 if ( empty( $values['item_meta'] ) ) {
672 409 return false;
@@ -688,18 +425,13 @@
688 425
689 426 $query_string = _http_build_query( $datas, '', '&' );
690 427 $response = Akismet::http_post( $query_string, 'comment-check' );
691 428
692 - return is_array( $response ) && $response[1] === 'true';
429 + return ( is_array( $response ) && $response[1] == 'true' );
693 430 }
694 431
695 432 /**
696 433 * @since 2.0
697 - *
698 - * @param array $datas The array of values being sent to Akismet.
699 - * @param array $values Entry values.
700 - *
701 - * @return void
702 434 */
703 435 private static function parse_akismet_array( &$datas, $values ) {
704 436 self::add_site_info_to_akismet( $datas );
705 437 self::add_server_values_to_akismet( $datas );
@@ -704,19 +436,13 @@
704 436 self::add_site_info_to_akismet( $datas );
705 437 self::add_server_values_to_akismet( $datas );
706 438
707 439 self::prepare_values_for_spam_check( $values );
708 - self::skip_adding_values_to_akismet( $values );
709 440
710 441 self::add_user_info_to_akismet( $datas, $values );
711 442 self::add_comment_content_to_akismet( $datas, $values );
712 443 }
713 444
714 - /**
715 - * @param array $datas
716 - *
717 - * @return void
718 - */
719 445 private static function add_site_info_to_akismet( &$datas ) {
720 446 $datas['blog'] = FrmAppHelper::site_url();
721 447 $datas['user_ip'] = preg_replace( '/[^0-9., ]/', '', FrmAppHelper::get_ip_address() );
722 448 $datas['user_agent'] = FrmAppHelper::get_server_value( 'HTTP_USER_AGENT' );
@@ -728,14 +454,8 @@
728 454 $datas['is_test'] = 'true';
729 455 }
730 456 }
731 457
732 - /**
733 - * @param array $datas
734 - * @param array $values
735 - *
736 - * @return void
737 - */
738 458 private static function add_user_info_to_akismet( &$datas, $values ) {
739 459 $user_info = self::get_spam_check_user_info( $values );
740 460 $datas = $datas + $user_info;
741 461
@@ -747,15 +467,13 @@
747 467 /**
748 468 * Gets user info for Akismet spam check.
749 469 *
750 470 * @since 5.0.13 Separate code for guest. Handle value of embedded|repeater.
751 - * @since 6.21 This changed from private to public.
752 471 *
753 472 * @param array $values Entry values after running through {@see FrmEntryValidate::prepare_values_for_spam_check()}.
754 - *
755 473 * @return array
756 474 */
757 - public static function get_spam_check_user_info( $values ) {
475 + private static function get_spam_check_user_info( $values ) {
758 476 if ( ! is_user_logged_in() ) {
759 477 return self::get_spam_check_user_info_for_guest( $values );
760 478 }
761 479
@@ -775,9 +493,8 @@
775 493 *
776 494 * @since 5.0.13
777 495 *
778 496 * @param array $values Entry values after flattened.
779 - *
780 497 * @return array
781 498 */
782 499 private static function get_spam_check_user_info_for_guest( $values ) {
783 500 $datas = array(
@@ -809,16 +526,13 @@
809 526 *
810 527 * @param array $datas Guest data.
811 528 * @param array $values The values.
812 529 * @param int|null $custom_index Custom index (or field ID).
813 - *
814 - * @return void
815 530 */
816 531 private static function recursive_add_akismet_guest_info( &$datas, $values, $custom_index = null ) {
817 532 foreach ( $values as $index => $value ) {
818 533 if ( ! $datas['missing_keys'] ) {
819 - // Found all info.
820 - return;
534 + return; // Found all info.
821 535 }
822 536
823 537 if ( is_array( $value ) ) {
824 538 self::recursive_add_akismet_guest_info( $datas, $value, $index );
@@ -825,21 +539,17 @@
825 539 continue;
826 540 }
827 541
828 542 $field_id = ! is_null( $custom_index ) ? $custom_index : $index;
829 -
830 543 foreach ( $datas['missing_keys'] as $key_index => $key ) {
831 - $found = self::is_akismet_guest_info_value( $key, $value, $field_id, $datas['name_field_ids'], $values );
832 -
833 - if ( ! $found ) {
834 - continue;
544 + $found = self::is_akismet_guest_info_value( $key, $value, $field_id, $datas['name_field_ids'] );
545 + if ( $found ) {
546 + $datas[ $key ] = $value;
547 + $datas['frm_duplicated'][] = $field_id;
548 + unset( $datas['missing_keys'][ $key_index ] );
835 549 }
836 -
837 - $datas[ $key ] = $value;
838 - $datas['frm_duplicated'][] = $field_id;
839 - unset( $datas['missing_keys'][ $key_index ] );
840 550 }
841 - }//end foreach
551 + }
842 552 }
843 553
844 554 /**
845 555 * Checks if given value is an akismet guest info.
@@ -849,13 +559,11 @@
849 559 * @param string $key Guest info key.
850 560 * @param string $value Value to check.
851 561 * @param int $field_id Field ID.
852 562 * @param array $name_field_ids Name field IDs.
853 - * @param array $values Array of posted values.
854 - *
855 563 * @return bool
856 564 */
857 - private static function is_akismet_guest_info_value( $key, &$value, $field_id, $name_field_ids, $values ) {
565 + private static function is_akismet_guest_info_value( $key, $value, $field_id, $name_field_ids ) {
858 566 if ( ! $value || is_numeric( $value ) ) {
859 567 return false;
860 568 }
861 569
@@ -860,79 +568,24 @@
860 568 }
861 569
862 570 switch ( $key ) {
863 571 case 'comment_author_email':
864 - return str_contains( $value, '@' ) && is_email( $value );
572 + return strpos( $value, '@' ) && is_email( $value );
865 573
866 574 case 'comment_author_url':
867 - return str_starts_with( $value, 'http' );
575 + return 0 === strpos( $value, 'http' );
868 576
869 577 case 'comment_author':
870 - if ( $name_field_ids && in_array( $field_id, $name_field_ids, true ) ) {
578 + if ( $name_field_ids ) {
871 579 // If there is name field in the form, we should always use it as author name.
872 - return true;
580 + return in_array( $field_id, $name_field_ids, true );
873 581 }
582 + return strlen( $value ) < 200;
583 + }
874 584
875 - $form_id = FrmAppHelper::get_post_param( 'form_id', 0, 'absint' );
876 - $fields = self::get_name_text_fields( $form_id );
877 -
878 - foreach ( $fields as $index => $field ) {
879 - if ( 'Name' !== $field->name ) {
880 - continue;
881 - }
882 -
883 - if ( isset( $fields[ $index + 1 ] ) && 'Last' === $fields[ $index + 1 ]->name ) {
884 - if ( empty( $values[ absint( $fields[ $index + 1 ]->id ) ] ) ) {
885 - continue;
886 - }
887 -
888 - $value .= ' ' . $values[ $fields[ $index + 1 ]->id ];
889 - return true;
890 - }
891 - }
892 - }//end switch
893 -
894 585 return false;
895 586 }
896 587
897 - /**
898 - * Returns fields that have 'Name' and 'Last' as their name.
899 - *
900 - * @since 6.17
901 - *
902 - * @param int $form_id
903 - *
904 - * @return array
905 - */
906 - private static function get_name_text_fields( $form_id ) {
907 - $name_text_fields_is_initialized = is_array( self::$name_text_fields );
908 -
909 - if ( $name_text_fields_is_initialized && isset( self::$name_text_fields[ $form_id ] ) ) {
910 - return self::$name_text_fields[ $form_id ];
911 - }
912 -
913 - if ( ! $name_text_fields_is_initialized ) {
914 - self::$name_text_fields = array();
915 - }
916 - self::$name_text_fields[ $form_id ] = FrmDb::get_results(
917 - 'frm_fields',
918 - array(
919 - 'form_id' => $form_id,
920 - 'type' => 'text',
921 - 'name' => array( 'Name', 'Last' ),
922 - ),
923 - 'id,name',
924 - array( 'order_by' => 'field_order ASC' )
925 - );
926 -
927 - return self::$name_text_fields[ $form_id ];
928 - }
929 -
930 - /**
931 - * @param array $datas
932 - *
933 - * @return void
934 - */
935 588 private static function add_server_values_to_akismet( &$datas ) {
936 589 foreach ( $_SERVER as $key => $value ) {
937 590 $include_value = is_string( $value ) && ! preg_match( '/^HTTP_COOKIE/', $key ) && preg_match( '/^(HTTP_|REMOTE_ADDR|REQUEST_URI|DOCUMENT_URI)/', $key );
938 591
@@ -950,10 +603,8 @@
950 603 * @since 5.0.09
951 604 *
952 605 * @param array $datas The array of values being sent to Akismet.
953 606 * @param array $values Entry values.
954 - *
955 - * @return void
956 607 */
957 608 private static function add_comment_content_to_akismet( &$datas, $values ) {
958 609 if ( isset( $datas['frm_duplicated'] ) ) {
959 610 foreach ( $datas['frm_duplicated'] as $index ) {
@@ -965,8 +616,10 @@
965 616 }
966 617 unset( $datas['frm_duplicated'] );
967 618 }
968 619
620 + self::skip_adding_values_to_akismet( $values );
621 +
969 622 $datas['comment_content'] = FrmEntriesHelper::entry_array_to_string( $values );
970 623 }
971 624
972 625 /**
@@ -974,28 +627,22 @@
974 627 *
975 628 * @since 5.0.09
976 629 *
977 630 * @param array $values Entry values.
978 - *
979 - * @return void
980 631 */
981 632 private static function skip_adding_values_to_akismet( &$values ) {
982 633 $skipped_fields = self::get_akismet_skipped_field_ids( $values );
983 -
984 634 foreach ( $skipped_fields as $skipped_field ) {
985 635 if ( ! isset( $values['item_meta'][ $skipped_field->id ] ) ) {
986 636 continue;
987 637 }
988 638
989 - if ( ! self::should_really_skip_field( $skipped_field, $values ) ) {
990 - continue;
639 + if ( self::should_really_skip_field( $skipped_field, $values ) ) {
640 + unset( $values['item_meta'][ $skipped_field->id ] );
641 + if ( isset( $values['item_meta']['other'][ $skipped_field->id ] ) ) {
642 + unset( $values['item_meta']['other'][ $skipped_field->id ] );
643 + }
991 644 }
992 -
993 - unset( $values['item_meta'][ $skipped_field->id ] );
994 -
995 - if ( isset( $values['item_meta']['other'][ $skipped_field->id ] ) ) {
996 - unset( $values['item_meta']['other'][ $skipped_field->id ] );
997 - }
998 645 }
999 646 }
1000 647
1001 648 /**
@@ -1004,28 +651,25 @@
1004 651 * @since 5.02.04
1005 652 *
1006 653 * @param object $field_data Object contains `id` and `options`.
1007 654 * @param array $values Entry values.
1008 - *
1009 655 * @return bool
1010 656 */
1011 657 private static function should_really_skip_field( $field_data, $values ) {
1012 - if ( empty( $field_data->options ) ) {
1013 - // This is skipped field types.
658 + if ( empty( $field_data->options ) ) { // This is skipped field types.
1014 659 return true;
1015 660 }
1016 661
1017 662 FrmAppHelper::unserialize_or_decode( $field_data->options );
1018 -
1019 - if ( ! $field_data->options ) {
1020 - // Check if an error happens when unserializing, or empty options.
663 + if ( ! $field_data->options ) { // Check if an error happens when unserializing, or empty options.
1021 664 return true;
1022 665 }
1023 666
1024 - $last_key = array_key_last( $field_data->options );
667 + end( $field_data->options );
668 + $last_key = key( $field_data->options );
1025 669
1026 670 // If a choice field has no Other option.
1027 - if ( is_numeric( $last_key ) || ! str_starts_with( $last_key, 'other_' ) ) {
671 + if ( is_numeric( $last_key ) || 0 !== strpos( $last_key, 'other_' ) ) {
1028 672 return true;
1029 673 }
1030 674
1031 675 // If a choice field has Other option, but Other is not selected.
@@ -1034,10 +678,9 @@
1034 678 }
1035 679
1036 680 // Check if submitted value is same as one of field option.
1037 681 foreach ( $field_data->options as $option ) {
1038 - $option_value = is_array( $option ) ? ( $option['value'] ?? '' ) : $option;
1039 -
682 + $option_value = ! is_array( $option ) ? $option : ( isset( $option['value'] ) ? $option['value'] : '' );
1040 683 if ( $values['item_meta']['other'][ $field_data->id ] === $option_value ) {
1041 684 return true;
1042 685 }
1043 686 }
@@ -1052,9 +695,8 @@
1052 695 * @since 5.0.13 Move out get_all_form_ids_and_flatten_meta() call and get `form_ids` from `$values`.
1053 696 * @since 5.2.04 This method returns array of object contains `id` and `options` instead of array of `id` only.
1054 697 *
1055 698 * @param array $values Entry values after running through {@see FrmEntryValidate::prepare_values_for_spam_check()}.
1056 - *
1057 699 * @return array
1058 700 */
1059 701 private static function get_akismet_skipped_field_ids( $values ) {
1060 702 if ( empty( $values['form_ids'] ) ) {
@@ -1077,16 +719,14 @@
1077 719 /**
1078 720 * Prepares values array for spam check.
1079 721 *
1080 722 * @since 5.0.13
1081 - * @since 6.21 This changed from private to public.
1082 723 *
1083 724 * @param array $values Entry values.
1084 - *
1085 - * @return void
1086 725 */
1087 - public static function prepare_values_for_spam_check( &$values ) {
1088 - $values['form_ids'] = self::get_all_form_ids_and_flatten_meta( $values );
726 + private static function prepare_values_for_spam_check( &$values ) {
727 + $form_ids = self::get_all_form_ids_and_flatten_meta( $values );
728 + $values['form_ids'] = $form_ids;
1089 729 }
1090 730
1091 731 /**
1092 732 * Gets all form IDs (include child form IDs) and flatten item_meta array. Used for skipping values sent to Akismet.
@@ -1095,20 +735,17 @@
1095 735 * @since 5.0.09
1096 736 * @since 5.0.13 Convert name field value to string.
1097 737 *
1098 738 * @param array $values Entry values.
1099 - *
1100 739 * @return array Form IDs.
1101 740 */
1102 - private static function get_all_form_ids_and_flatten_meta( &$values ) { // phpcs:ignore SlevomatCodingStandard.Complexity.Cognitive.ComplexityTooHigh
741 + private static function get_all_form_ids_and_flatten_meta( &$values ) {
1103 742 $values['name_field_ids'] = array();
1104 743
1105 744 // Blacklist check for File field in the old version doesn't contain `form_id`.
1106 745 $form_ids = isset( $values['form_id'] ) ? array( absint( $values['form_id'] ) ) : array();
1107 -
1108 746 foreach ( $values['item_meta'] as $field_id => $value ) {
1109 - if ( ! is_numeric( $field_id ) ) {
1110 - // Maybe `other`.
747 + if ( ! is_numeric( $field_id ) ) { // Maybe `other`.
1111 748 continue;
1112 749 }
1113 750
1114 751 // Convert name array to string.
@@ -1139,20 +776,51 @@
1139 776 }
1140 777
1141 778 // Convert name array to string.
1142 779 if ( isset( $subsubvalue['first'] ) && isset( $subsubvalue['last'] ) ) {
1143 - $subsubvalue = trim( implode( ' ', $subsubvalue ) );
780 + $subsubvalue = trim( implode( ' ', $subsubvalue ) );
781 +
1144 782 $values['name_field_ids'][] = $subsubindex;
1145 783 }
1146 784
1147 - if ( is_array( $values['item_meta'][ $subsubindex ] ) ) {
1148 - $values['item_meta'][ $subsubindex ][] = $subsubvalue;
1149 - }
785 + $values['item_meta'][ $subsubindex ][] = $subsubvalue;
1150 786 }
1151 - }//end foreach
787 + }
1152 788
1153 789 unset( $values['item_meta'][ $field_id ] );
1154 - }//end foreach
790 + }
1155 791
1156 792 return $form_ids;
793 + }
794 +
795 + /**
796 + * @deprecated 3.0
797 + * @codeCoverageIgnore
798 + */
799 + public static function validate_url_field( &$errors, $field, $value, $args ) {
800 + FrmDeprecated::validate_url_field( $errors, $field, $value, $args );
801 + }
802 +
803 + /**
804 + * @deprecated 3.0
805 + * @codeCoverageIgnore
806 + */
807 + public static function validate_email_field( &$errors, $field, $value, $args ) {
808 + FrmDeprecated::validate_email_field( $errors, $field, $value, $args );
809 + }
810 +
811 + /**
812 + * @deprecated 3.0
813 + * @codeCoverageIgnore
814 + */
815 + public static function validate_number_field( &$errors, $field, $value, $args ) {
816 + FrmDeprecated::validate_number_field( $errors, $field, $value, $args );
817 + }
818 +
819 + /**
820 + * @deprecated 3.0
821 + * @codeCoverageIgnore
822 + */
823 + public static function validate_recaptcha( &$errors, $field, $args ) {
824 + FrmDeprecated::validate_recaptcha( $errors, $field, $args );
1157 825 }
1158 826 }