PluginProbe
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More / 6.8.2
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More v6.8.2
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
formidable / classes / models / FrmForm.php

FrmForm.php in Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More 6.8.2, at classes/models/FrmForm.php

1,232 lines 34.4 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 if ( ! defined( 'ABSPATH' ) ) {
3 die( 'You are not allowed to call this page directly.' );
4 }
5
6 class FrmForm {
7
8 /**
9 * @param array $values
10 * @return int|bool id on success or false on failure.
11 */
12 public static function create( $values ) {
13 global $wpdb;
14
15 $values = FrmAppHelper::maybe_filter_array( $values, array( 'name', 'description' ) );
16
17 $new_values = array(
18 'form_key' => FrmAppHelper::get_unique_key( $values['form_key'], $wpdb->prefix . 'frm_forms', 'form_key' ),
19 'name' => $values['name'],
20 'description' => $values['description'],
21 'status' => isset( $values['status'] ) ? $values['status'] : 'published',
22 'logged_in' => isset( $values['logged_in'] ) ? $values['logged_in'] : 0,
23 'is_template' => isset( $values['is_template'] ) ? (int) $values['is_template'] : 0,
24 'parent_form_id' => isset( $values['parent_form_id'] ) ? absint( $values['parent_form_id'] ) : 0,
25 'editable' => isset( $values['editable'] ) ? (int) $values['editable'] : 0,
26 'created_at' => isset( $values['created_at'] ) ? $values['created_at'] : current_time( 'mysql', 1 ),
27 );
28
29 $options = isset( $values['options'] ) ? (array) $values['options'] : array();
30 FrmFormsHelper::fill_form_options( $options, $values );
31
32 $options['before_html'] = isset( $values['options']['before_html'] ) ? $values['options']['before_html'] : FrmFormsHelper::get_default_html( 'before' );
33 $options['after_html'] = isset( $values['options']['after_html'] ) ? $values['options']['after_html'] : FrmFormsHelper::get_default_html( 'after' );
34 $options['submit_html'] = isset( $values['options']['submit_html'] ) ? $values['options']['submit_html'] : FrmFormsHelper::get_default_html( 'submit' );
35
36 /**
37 * Allows modifying form options before updating or creating.
38 *
39 * @since 5.4 Add the third param.
40 *
41 * @param array $options Form options.
42 * @param array $values Form data.
43 * @param bool $update Is form updating or creating. It's `true` if is updating.
44 */
45 $options = apply_filters( 'frm_form_options_before_update', $options, $values, false );
46 $options = self::maybe_filter_form_options( $options );
47 $new_values['options'] = serialize( $options );
48
49 $wpdb->insert( $wpdb->prefix . 'frm_forms', $new_values );
50
51 $id = $wpdb->insert_id;
52
53 // Clear form caching
54 self::clear_form_cache();
55
56 return $id;
57 }
58
59 /**
60 * @since 5.0.08
61 *
62 * @param array $options
63 * @return array
64 */
65 private static function maybe_filter_form_options( $options ) {
66 if ( ! FrmAppHelper::allow_unfiltered_html() && ! empty( $options['submit_html'] ) ) {
67 $options['submit_html'] = FrmAppHelper::kses_submit_button( $options['submit_html'] );
68 }
69 return FrmAppHelper::maybe_filter_array( $options, array( 'submit_value', 'success_msg', 'before_html', 'after_html' ) );
70 }
71
72 /**
73 * @return int|boolean ID on success or false on failure
74 */
75 public static function duplicate( $id, $template = false, $copy_keys = false, $blog_id = false ) {
76 global $wpdb;
77
78 $values = self::getOne( $id, $blog_id );
79 if ( ! $values ) {
80 return false;
81 }
82
83 $new_key = $copy_keys ? $values->form_key : '';
84
85 $new_values = array(
86 'form_key' => FrmAppHelper::get_unique_key( $new_key, $wpdb->prefix . 'frm_forms', 'form_key' ),
87 'name' => $values->name,
88 'description' => $values->description,
89 'status' => $values->status ? $values->status : 'published',
90 'logged_in' => $values->logged_in ? $values->logged_in : 0,
91 'editable' => $values->editable ? $values->editable : 0,
92 'created_at' => current_time( 'mysql', 1 ),
93 'is_template' => $template ? 1 : 0,
94 );
95
96 if ( $blog_id ) {
97 $new_values['status'] = 'published';
98 $new_options = $values->options;
99 FrmAppHelper::unserialize_or_decode( $new_options );
100 $new_options['email_to'] = get_option( 'admin_email' );
101 $new_options['copy'] = false;
102 $new_values['options'] = $new_options;
103 } else {
104 $new_values['options'] = $values->options;
105 }
106
107 if ( is_array( $new_values['options'] ) ) {
108 $new_values['options'] = serialize( $new_values['options'] );
109 }
110
111 $query_results = $wpdb->insert( $wpdb->prefix . 'frm_forms', $new_values );
112
113 if ( $query_results ) {
114 // Clear form caching
115 self::clear_form_cache();
116
117 $form_id = $wpdb->insert_id;
118 FrmField::duplicate( $id, $form_id, $copy_keys, $blog_id );
119
120 // update form settings after fields are created
121 do_action( 'frm_after_duplicate_form', $form_id, $new_values, array( 'old_id' => $id ) );
122
123 return $form_id;
124 }
125
126 return false;
127 }
128
129 public static function after_duplicate( $form_id, $values ) {
130 $new_opts = $values['options'];
131 FrmAppHelper::unserialize_or_decode( $new_opts );
132 $values['options'] = $new_opts;
133
134 if ( isset( $new_opts['success_msg'] ) ) {
135 $new_opts['success_msg'] = FrmFieldsHelper::switch_field_ids( $new_opts['success_msg'] );
136 }
137
138 $new_opts = apply_filters( 'frm_after_duplicate_form_values', $new_opts, $form_id );
139
140 if ( $new_opts != $values['options'] ) {
141 global $wpdb;
142 $wpdb->update( $wpdb->prefix . 'frm_forms', array( 'options' => maybe_serialize( $new_opts ) ), array( 'id' => $form_id ) );
143 }
144
145 self::switch_field_ids_in_fields( $form_id );
146 }
147
148 /**
149 * Switches field ID in fields.
150 *
151 * @since 5.3
152 *
153 * @param int $form_id Form ID.
154 */
155 private static function switch_field_ids_in_fields( $form_id ) {
156 global $wpdb;
157
158 // Keys of fields that you want to check to replace field ID.
159 $keys = array( 'default_value', 'field_options' );
160 $sql_cols = 'fi.id';
161 foreach ( $keys as $key ) {
162 $sql_cols .= ( ',fi.' . $key );
163 }
164
165 $fields = FrmDb::get_results(
166 "{$wpdb->prefix}frm_fields AS fi LEFT OUTER JOIN {$wpdb->prefix}frm_forms AS fr ON fi.form_id = fr.id",
167 array(
168 'or' => 1,
169 'fi.form_id' => $form_id,
170 'fr.parent_form_id' => $form_id,
171 ),
172 $sql_cols
173 );
174
175 if ( ! $fields || ! is_array( $fields ) ) {
176 return;
177 }
178
179 foreach ( $fields as $field ) {
180 self::switch_field_ids_in_field( (array) $field );
181 }
182 }
183
184 /**
185 * Switches field ID in a field.
186 *
187 * @since 5.3
188 *
189 * @param array $field Field array.
190 */
191 private static function switch_field_ids_in_field( $field ) {
192 $new_values = array();
193 foreach ( $field as $key => $value ) {
194 if ( 'id' === $key || ! $value ) {
195 continue;
196 }
197
198 if ( ! is_string( $value ) && ! is_array( $value ) ) {
199 continue;
200 }
201
202 if ( 'field_options' === $key ) {
203 // Need to loop through field_options to prevent breaking serialized string when length changed.
204 FrmAppHelper::unserialize_or_decode( $value );
205 $new_val = FrmFieldsHelper::switch_field_ids( $value );
206 $new_val = serialize( $new_val );
207 } else {
208 $new_val = FrmFieldsHelper::switch_field_ids( $value );
209 }
210
211 if ( $new_val !== $value ) {
212 $new_values[ $key ] = $new_val;
213 }
214 }//end foreach
215
216 if ( ! empty( $new_values ) ) {
217 FrmField::update( $field['id'], $new_values );
218 }
219 }
220
221 /**
222 * @return int|boolean
223 */
224 public static function update( $id, $values, $create_link = false ) {
225 global $wpdb;
226
227 $values = FrmAppHelper::maybe_filter_array( $values, array( 'name', 'description' ) );
228
229 if ( ! isset( $values['status'] ) && ( $create_link || isset( $values['options'] ) || isset( $values['item_meta'] ) || isset( $values['field_options'] ) ) ) {
230 $values['status'] = 'published';
231 }
232
233 if ( isset( $values['form_key'] ) ) {
234 $values['form_key'] = FrmAppHelper::get_unique_key( $values['form_key'], $wpdb->prefix . 'frm_forms', 'form_key', $id );
235 }
236
237 $form_fields = array( 'form_key', 'name', 'description', 'status', 'parent_form_id' );
238
239 $new_values = self::set_update_options( array(), $values, array( 'form_id' => $id ) );
240
241 foreach ( $values as $value_key => $value ) {
242 if ( $value_key && in_array( $value_key, $form_fields ) ) {
243 $new_values[ $value_key ] = $value;
244 }
245 }
246
247 if ( isset( $values['new_status'] ) && ! empty( $values['new_status'] ) ) {
248 $new_values['status'] = $values['new_status'];
249 }
250
251 if ( ! empty( $new_values ) ) {
252 $query_results = $wpdb->update( $wpdb->prefix . 'frm_forms', $new_values, array( 'id' => $id ) );
253 if ( $query_results ) {
254 self::clear_form_cache();
255 }
256 } else {
257 $query_results = true;
258 }
259 unset( $new_values );
260
261 $values = self::update_fields( $id, $values );
262
263 do_action( 'frm_update_form', $id, $values );
264 do_action( 'frm_update_form_' . $id, $values );
265
266 return $query_results;
267 }
268
269 /**
270 * @param array $new_values
271 * @param array $values
272 * @param array $args
273 * @return array
274 */
275 public static function set_update_options( $new_values, $values, $args = array() ) {
276 if ( ! isset( $values['options'] ) ) {
277 return $new_values;
278 }
279
280 $options = ! empty( $values['options'] ) ? (array) $values['options'] : array();
281 FrmFormsHelper::fill_form_options( $options, $values );
282
283 $options['custom_style'] = isset( $values['options']['custom_style'] ) ? $values['options']['custom_style'] : 0;
284 $options['before_html'] = isset( $values['options']['before_html'] ) ? $values['options']['before_html'] : FrmFormsHelper::get_default_html( 'before' );
285 $options['after_html'] = isset( $values['options']['after_html'] ) ? $values['options']['after_html'] : FrmFormsHelper::get_default_html( 'after' );
286 $options['submit_html'] = ( isset( $values['options']['submit_html'] ) && '' !== $values['options']['submit_html'] ) ? $values['options']['submit_html'] : FrmFormsHelper::get_default_html( 'submit' );
287
288 /**
289 * Allows modifying form options before updating or creating.
290 *
291 * @since 5.4 Added the third param.
292 *
293 * @param array $options Form options.
294 * @param array $values Form data.
295 * @param bool $update Is form updating or creating. It's `true` if is updating.
296 */
297 $options = apply_filters( 'frm_form_options_before_update', $options, $values, true );
298 $options = self::maybe_filter_form_options( $options );
299 $new_values['options'] = serialize( $options );
300
301 return $new_values;
302 }
303
304 /**
305 * @return array
306 */
307 public static function update_fields( $id, $values ) {
308
309 if ( ! isset( $values['item_meta'] ) && ! isset( $values['field_options'] ) ) {
310 return $values;
311 }
312
313 $all_fields = FrmField::get_all_for_form( $id );
314 if ( empty( $all_fields ) ) {
315 return $values;
316 }
317
318 if ( ! isset( $values['item_meta'] ) ) {
319 $values['item_meta'] = array();
320 }
321
322 $field_array = array();
323 $existing_keys = array_keys( $values['item_meta'] );
324 foreach ( $all_fields as $fid ) {
325 if ( ! in_array( $fid->id, $existing_keys ) && ( isset( $values['frm_fields_submitted'] ) && in_array( $fid->id, $values['frm_fields_submitted'] ) ) || isset( $values['options'] ) ) {
326 $values['item_meta'][ $fid->id ] = '';
327 }
328 $field_array[ $fid->id ] = $fid;
329 }
330 unset( $all_fields );
331
332 foreach ( $values['item_meta'] as $field_id => $default_value ) {
333 if ( isset( $field_array[ $field_id ] ) ) {
334 $field = $field_array[ $field_id ];
335 } else {
336 $field = FrmField::getOne( $field_id );
337 }
338
339 if ( ! $field ) {
340 continue;
341 }
342
343 $is_settings_page = ( isset( $values['options'] ) || isset( $values['field_options'][ 'custom_html_' . $field_id ] ) );
344 if ( $is_settings_page ) {
345 self::get_settings_page_html( $values, $field );
346
347 if ( ! defined( 'WP_IMPORTING' ) ) {
348 continue;
349 }
350 }
351
352 // Updating the form.
353 $update_options = FrmFieldsHelper::get_default_field_options_from_field( $field );
354 // Don't check for POST html.
355 unset( $update_options['custom_html'] );
356 $update_options = apply_filters( 'frm_field_options_to_update', $update_options );
357
358 foreach ( $update_options as $opt => $default ) {
359 $field->field_options[ $opt ] = isset( $values['field_options'][ $opt . '_' . $field_id ] ) ? $values['field_options'][ $opt . '_' . $field_id ] : $default;
360 self::sanitize_field_opt( $opt, $field->field_options[ $opt ] );
361 }
362
363 $field->field_options = apply_filters( 'frm_update_field_options', $field->field_options, $field, $values );
364
365 $new_field = array(
366 'field_options' => $field->field_options,
367 'default_value' => isset( $values[ 'default_value_' . $field_id ] ) ? FrmAppHelper::maybe_json_encode( $values[ 'default_value_' . $field_id ] ) : '',
368 );
369
370 if ( ! FrmAppHelper::allow_unfiltered_html() && isset( $values['field_options'][ 'options_' . $field_id ] ) && is_array( $values['field_options'][ 'options_' . $field_id ] ) ) {
371 foreach ( $values['field_options'][ 'options_' . $field_id ] as $option_key => $option ) {
372 if ( is_array( $option ) ) {
373 foreach ( $option as $key => $item ) {
374 $values['field_options'][ 'options_' . $field_id ][ $option_key ][ $key ] = FrmAppHelper::kses( $item, 'all' );
375 }
376 }
377 }
378 }
379
380 self::prepare_field_update_values( $field, $values, $new_field );
381 self::maybe_update_max_option( $field, $values, $new_field );
382
383 FrmField::update( $field_id, $new_field );
384
385 FrmField::delete_form_transient( $field->form_id );
386 }//end foreach
387 self::clear_form_cache();
388
389 return $values;
390 }
391
392 /**
393 * Resets the 'max' option of a field when changing paragraph field type to other field types like text, email etc.
394 *
395 * @since 6.7
396 *
397 * @param array $field
398 * @param array $values
399 * @param array $new_field
400 * @return void
401 */
402 private static function maybe_update_max_option( $field, $values, &$new_field ) {
403 if ( $field->type === 'textarea' &&
404 ! empty( $values['field_options'][ 'type_' . $field->id ] ) &&
405 in_array( $values['field_options'][ 'type_' . $field->id ], array( 'text', 'email', 'url', 'password', 'phone' ), true ) ) {
406
407 $new_field['field_options']['max'] = '';
408
409 /**
410 * Update posted field setting so that new 'max' option is displayed after form is saved and page reloads.
411 * FrmFieldsHelper::fill_default_field_opts populates field options by calling self::get_posted_field_setting.
412 */
413 $_POST['field_options'][ 'max_' . $field->id ] = '';
414 }
415 }
416
417 /**
418 * @param string $opt
419 * @param mixed $value
420 * @return void
421 */
422 private static function sanitize_field_opt( $opt, &$value ) {
423 if ( ! is_string( $value ) ) {
424 return;
425 }
426
427 /**
428 * Allow the option to turn off sanitization for a field. This way a custom rule can be used instead.
429 * Make sure to add custom sanitization using the frm_update_field_options filter as the data will no longer be sanitized.
430 *
431 * @since 6.0
432 *
433 * @param bool $should_sanitize
434 * @param string $opt
435 */
436 $should_sanitize = apply_filters( 'frm_should_sanitize_field_opt_string', true, $opt );
437
438 if ( ! $should_sanitize ) {
439 return;
440 }
441
442 if ( $opt === 'calc' ) {
443 $value = self::sanitize_calc( $value );
444 } else {
445 $value = FrmAppHelper::kses( $value, 'all' );
446 }
447
448 $value = trim( $value );
449 }
450
451 /**
452 * @param string $value
453 * @return string
454 */
455 private static function sanitize_calc( $value ) {
456 if ( false !== strpos( $value, '<' ) ) {
457 $value = self::normalize_calc_spaces( $value );
458 }
459 // Allow <= and >=.
460 $allow = array( '<= ', ' >=' );
461 $temp = array( '< = ', ' > =' );
462 $value = str_replace( $allow, $temp, $value );
463 $value = strip_tags( $value );
464 $value = str_replace( $temp, $allow, $value );
465 return $value;
466 }
467
468 /**
469 * Format a comparison like 5<10 to 5 < 10. Also works on 5< 10, 5 <10, 5<=10 variations.
470 * This is to avoid an issue with unspaced calculations being recognized as HTML that gets removed when strip_tags is called.
471 *
472 * @param string $calc
473 * @return string
474 */
475 private static function normalize_calc_spaces( $calc ) {
476 // Check for a pattern with 5 parts
477 // $1 \d the first comparison digit.
478 // $2 a space (optional).
479 // $3 an equals sign (optional) that follows the < operator for <= comparisons.
480 // $4 another space (optional).
481 // $5 \d the second comparison digit.
482 return preg_replace( '/(\d)( ){0,1}<(=){0,1}( ){0,1}(\d)/', '$1 <$3 $5', $calc );
483 }
484
485 /**
486 * Updating the settings page
487 */
488 private static function get_settings_page_html( $values, &$field ) {
489 if ( isset( $values['field_options'][ 'custom_html_' . $field->id ] ) ) {
490 $prev_opts = array();
491 $fallback_html = isset( $field->field_options['custom_html'] ) ? $field->field_options['custom_html'] : FrmFieldsHelper::get_default_html( $field->type );
492
493 $field->field_options['custom_html'] = isset( $values['field_options'][ 'custom_html_' . $field->id ] ) ? $values['field_options'][ 'custom_html_' . $field->id ] : $fallback_html;
494 } elseif ( $field->type == 'hidden' || $field->type == 'user_id' ) {
495 $prev_opts = $field->field_options;
496 }
497
498 if ( isset( $prev_opts ) ) {
499 $field->field_options = apply_filters( 'frm_update_form_field_options', $field->field_options, $field, $values );
500 if ( $prev_opts != $field->field_options ) {
501 FrmField::update( $field->id, array( 'field_options' => $field->field_options ) );
502 }
503 }
504 }
505
506 private static function prepare_field_update_values( $field, $values, &$new_field ) {
507 $field_cols = array(
508 'field_order' => 0,
509 'field_key' => '',
510 'required' => false,
511 'type' => '',
512 'description' => '',
513 'options' => '',
514 'name' => '',
515 );
516 foreach ( $field_cols as $col => $default ) {
517 $default = ( $default === '' ) ? $field->{$col} : $default;
518
519 $new_field[ $col ] = isset( $values['field_options'][ $col . '_' . $field->id ] ) ? $values['field_options'][ $col . '_' . $field->id ] : $default;
520 }
521
522 // Don't save the template option.
523 if ( is_array( $new_field['options'] ) && isset( $new_field['options']['000'] ) ) {
524 unset( $new_field['options']['000'] );
525 }
526 }
527
528 /**
529 * Get a list of all form settings that should be translated
530 * on a multilingual site.
531 *
532 * @since 3.06.01
533 * @param object $form The form object.
534 */
535 public static function translatable_strings( $form ) {
536 $strings = array(
537 'name',
538 'description',
539 'submit_value',
540 'submit_msg',
541 'success_msg',
542 'invalid_msg',
543 'failed_msg',
544 'login_msg',
545 'admin_permission',
546 );
547
548 return apply_filters( 'frm_form_strings', $strings, $form );
549 }
550
551 /**
552 * @param int $id
553 * @param string $status
554 *
555 * @return int|boolean
556 */
557 public static function set_status( $id, $status ) {
558 if ( 'trash' == $status ) {
559 return self::trash( $id );
560 }
561
562 $statuses = array( 'published', 'draft', 'trash' );
563 if ( ! in_array( $status, $statuses ) ) {
564 return false;
565 }
566
567 global $wpdb;
568
569 if ( is_array( $id ) ) {
570 $where = array(
571 'id' => $id,
572 'parent_form_id' => $id,
573 'or' => 1,
574 );
575 FrmDb::get_where_clause_and_values( $where );
576 array_unshift( $where['values'], $status );
577
578 $query_results = $wpdb->query( $wpdb->prepare( 'UPDATE ' . $wpdb->prefix . 'frm_forms SET status = %s ' . $where['where'], $where['values'] ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
579 } else {
580 $query_results = $wpdb->update( $wpdb->prefix . 'frm_forms', array( 'status' => $status ), array( 'id' => $id ) );
581 $wpdb->update( $wpdb->prefix . 'frm_forms', array( 'status' => $status ), array( 'parent_form_id' => $id ) );
582 }
583
584 if ( $query_results ) {
585 self::clear_form_cache();
586 }
587
588 return $query_results;
589 }
590
591 /**
592 * @return int|boolean
593 */
594 public static function trash( $id ) {
595 if ( ! EMPTY_TRASH_DAYS ) {
596 return self::destroy( $id );
597 }
598
599 $form = self::getOne( $id );
600 if ( ! $form ) {
601 return false;
602 }
603
604 $options = $form->options;
605 $options['trash_time'] = time();
606
607 global $wpdb;
608 $query_results = $wpdb->update(
609 $wpdb->prefix . 'frm_forms',
610 array(
611 'status' => 'trash',
612 'options' => serialize( $options ),
613 ),
614 array(
615 'id' => $id,
616 )
617 );
618
619 $wpdb->update(
620 $wpdb->prefix . 'frm_forms',
621 array(
622 'status' => 'trash',
623 'options' => serialize( $options ),
624 ),
625 array(
626 'parent_form_id' => $id,
627 )
628 );
629
630 if ( $query_results ) {
631 self::clear_form_cache();
632 }
633
634 return $query_results;
635 }
636
637 /**
638 * @return int|boolean
639 */
640 public static function destroy( $id ) {
641 global $wpdb;
642
643 $form = self::getOne( $id );
644 if ( ! $form ) {
645 return false;
646 }
647 $id = $form->id;
648
649 // Disconnect the entries from this form
650 $entries = FrmDb::get_col( $wpdb->prefix . 'frm_items', array( 'form_id' => $id ) );
651 foreach ( $entries as $entry_id ) {
652 FrmEntry::destroy( $entry_id );
653 unset( $entry_id );
654 }
655
656 // Disconnect the fields from this form
657 $wpdb->query( $wpdb->prepare( 'DELETE fi FROM ' . $wpdb->prefix . 'frm_fields AS fi LEFT JOIN ' . $wpdb->prefix . 'frm_forms fr ON (fi.form_id = fr.id) WHERE fi.form_id=%d OR parent_form_id=%d', $id, $id ) );
658
659 $query_results = $wpdb->query( $wpdb->prepare( 'DELETE FROM ' . $wpdb->prefix . 'frm_forms WHERE id=%d OR parent_form_id=%d', $id, $id ) );
660 if ( $query_results ) {
661 // Delete all form actions linked to this form
662 $action_control = FrmFormActionsController::get_form_actions( 'email' );
663 $action_control->destroy( $id, 'all' );
664
665 // Clear form caching
666 self::clear_form_cache();
667
668 do_action( 'frm_destroy_form', $id );
669 do_action( 'frm_destroy_form_' . $id );
670 }
671
672 return $query_results;
673 }
674
675 /**
676 * Delete trashed forms based on how long they have been trashed
677 *
678 * @return int The number of forms deleted
679 */
680 public static function scheduled_delete( $delete_timestamp = '' ) {
681 global $wpdb;
682
683 $trash_forms = FrmDb::get_results( $wpdb->prefix . 'frm_forms', array( 'status' => 'trash' ), 'id, parent_form_id, options' );
684
685 if ( ! $trash_forms ) {
686 return 0;
687 }
688
689 if ( empty( $delete_timestamp ) ) {
690 $delete_timestamp = time() - ( DAY_IN_SECONDS * EMPTY_TRASH_DAYS );
691 }
692
693 $count = 0;
694 foreach ( $trash_forms as $form ) {
695 FrmAppHelper::unserialize_or_decode( $form->options );
696 if ( ! isset( $form->options['trash_time'] ) || $form->options['trash_time'] < $delete_timestamp ) {
697 self::destroy( $form->id );
698 if ( empty( $form->parent_form_id ) ) {
699 $count ++;
700 }
701 }
702
703 unset( $form );
704 }
705
706 return $count;
707 }
708
709 /**
710 * @return string form name
711 */
712 public static function getName( $id ) {
713 $form = FrmDb::check_cache( $id, 'frm_form' );
714 if ( $form ) {
715 $r = stripslashes( $form->name );
716
717 return $r;
718 }
719
720 $query_key = is_numeric( $id ) ? 'id' : 'form_key';
721 $r = FrmDb::get_var( 'frm_forms', array( $query_key => $id ), 'name' );
722
723 // An empty form name can result in a null value.
724 $r = is_null( $r ) ? '' : stripslashes( $r );
725
726 return $r;
727 }
728
729 /**
730 * @since 3.0
731 *
732 * @param string $key
733 *
734 * @return int form id
735 */
736 public static function get_id_by_key( $key ) {
737 return (int) FrmDb::get_var( 'frm_forms', array( 'form_key' => sanitize_title( $key ) ) );
738 }
739
740 /**
741 * @since 3.0
742 *
743 * @param int $id
744 *
745 * @return string form key
746 */
747 public static function get_key_by_id( $id ) {
748 $id = (int) $id;
749 $cache = FrmDb::check_cache( $id, 'frm_form' );
750 if ( $cache ) {
751 return $cache->form_key;
752 }
753
754 $key = FrmDb::get_var( 'frm_forms', array( 'id' => $id ), 'form_key' );
755
756 return $key;
757 }
758
759 /**
760 * If $form is numeric, get the form object
761 *
762 * @param object|int $form
763 *
764 * @since 2.0.9
765 */
766 public static function maybe_get_form( &$form ) {
767 if ( ! is_object( $form ) && ! is_array( $form ) && ! empty( $form ) ) {
768 $form = self::getOne( $form );
769 }
770 }
771
772 /**
773 * @return object form
774 */
775 public static function getOne( $id, $blog_id = false ) {
776 global $wpdb;
777
778 if ( $blog_id && is_multisite() ) {
779 global $wpmuBaseTablePrefix;
780 $prefix = $wpmuBaseTablePrefix ? $wpmuBaseTablePrefix . $blog_id . '_' : $wpdb->get_blog_prefix( $blog_id );
781
782 $table_name = $prefix . 'frm_forms';
783 } else {
784 $table_name = $wpdb->prefix . 'frm_forms';
785 $cache = wp_cache_get( $id, 'frm_form' );
786 if ( $cache ) {
787 if ( isset( $cache->options ) ) {
788 FrmAppHelper::unserialize_or_decode( $cache->options );
789 }
790
791 return apply_filters( 'frm_form_object', wp_unslash( $cache ) );
792 }
793 }
794
795 if ( is_numeric( $id ) ) {
796 $where = array( 'id' => $id );
797 } else {
798 $where = array( 'form_key' => $id );
799 }
800
801 $results = FrmDb::get_row( $table_name, $where );
802
803 if ( isset( $results->options ) ) {
804 FrmDb::set_cache( $results->id, $results, 'frm_form' );
805 FrmAppHelper::unserialize_or_decode( $results->options );
806 }
807
808 return apply_filters( 'frm_form_object', wp_unslash( $results ) );
809 }
810
811 /**
812 * @return object|array of objects
813 */
814 public static function getAll( $where = array(), $order_by = '', $limit = '' ) {
815 if ( is_array( $where ) && ! empty( $where ) ) {
816 if ( isset( $where['is_template'] ) && $where['is_template'] && ! isset( $where['status'] ) && ! isset( $where['status !'] ) ) {
817 // don't get trashed templates
818 $where['status'] = array( null, '', 'published' );
819 }
820
821 $results = FrmDb::get_results( 'frm_forms', $where, '*', compact( 'order_by', 'limit' ) );
822 } else {
823 global $wpdb;
824
825 // The query has already been prepared if this is not an array.
826 $query = 'SELECT * FROM ' . $wpdb->prefix . 'frm_forms' . FrmDb::prepend_and_or_where( ' WHERE ', $where ) . FrmDb::esc_order( $order_by ) . FrmDb::esc_limit( $limit );
827 $results = $wpdb->get_results( $query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
828 }
829
830 if ( $results ) {
831 foreach ( $results as $result ) {
832 FrmDb::set_cache( $result->id, $result, 'frm_form' );
833 FrmAppHelper::unserialize_or_decode( $result->options );
834 }
835 }
836
837 if ( $limit == ' LIMIT 1' || $limit == 1 ) {
838 // return the first form object if we are only getting one form
839 $results = reset( $results );
840 }
841
842 return wp_unslash( $results );
843 }
844
845 /**
846 * Get all published forms
847 *
848 * @since 2.0
849 *
850 * @param array $query
851 * @param int $limit
852 * @param string $inc_children
853 * @return array|object of forms A single form object would be passed if $limit was set to 1.
854 */
855 public static function get_published_forms( $query = array(), $limit = 999, $inc_children = 'exclude' ) {
856 $query['is_template'] = 0;
857 $query['status'] = array( null, '', 'published' );
858 if ( $inc_children == 'exclude' ) {
859 $query['parent_form_id'] = array( null, 0 );
860 }
861
862 $forms = self::getAll( $query, 'name', $limit );
863
864 return $forms;
865 }
866
867 /**
868 * @return object count of forms
869 */
870 public static function get_count() {
871 global $wpdb;
872
873 $cache_key = 'frm_form_counts';
874
875 $counts = wp_cache_get( $cache_key, 'frm_form' );
876 if ( false !== $counts ) {
877 return $counts;
878 }
879
880 $results = (array) FrmDb::get_results(
881 'frm_forms',
882 array(
883 'or' => 1,
884 'parent_form_id' => null,
885 'parent_form_id <' => 0,
886 ),
887 'status, is_template'
888 );
889
890 $statuses = array( 'published', 'draft', 'template', 'trash' );
891 $counts = array_fill_keys( $statuses, 0 );
892
893 foreach ( $results as $row ) {
894 if ( 'trash' != $row->status ) {
895 if ( $row->is_template ) {
896 $counts['template'] ++;
897 } else {
898 $counts['published'] ++;
899 }
900 } else {
901 $counts['trash'] ++;
902 }
903
904 if ( 'draft' == $row->status ) {
905 $counts['draft'] ++;
906 }
907
908 unset( $row );
909 }
910
911 $counts = (object) $counts;
912 FrmDb::set_cache( $cache_key, $counts, 'frm_form' );
913
914 return $counts;
915 }
916
917 /**
918 * Clear form caching
919 * Called when a form is created, updated, duplicated, or deleted
920 * or when the form status is changed
921 *
922 * @since 2.0.4
923 */
924 public static function clear_form_cache() {
925 FrmDb::cache_delete_group( 'frm_form' );
926 }
927
928 /**
929 * @return array of errors
930 */
931 public static function validate( $values ) {
932 $errors = array();
933
934 return apply_filters( 'frm_validate_form', $errors, $values );
935 }
936
937 public static function get_params( $form = null ) {
938 global $frm_vars;
939
940 if ( ! $form ) {
941 $form = self::getAll( array(), 'name', 1 );
942 } else {
943 self::maybe_get_form( $form );
944 }
945
946 if ( isset( $frm_vars['form_params'] ) && is_array( $frm_vars['form_params'] ) && isset( $frm_vars['form_params'][ $form->id ] ) ) {
947 return $frm_vars['form_params'][ $form->id ];
948 }
949
950 $action_var = isset( $_REQUEST['frm_action'] ) ? 'frm_action' : 'action'; // phpcs:ignore WordPress.Security.NonceVerification.Missing
951 $action = apply_filters( 'frm_show_new_entry_page', FrmAppHelper::get_param( $action_var, 'new', 'get', 'sanitize_title' ), $form );
952
953 $default_values = array(
954 'id' => '',
955 'form_name' => '',
956 'paged' => 1,
957 'form' => $form->id,
958 'form_id' => $form->id,
959 'field_id' => '',
960 'search' => '',
961 'sort' => '',
962 'sdir' => '',
963 'action' => $action,
964 );
965
966 $values = array();
967 $values['posted_form_id'] = FrmAppHelper::get_param( 'form_id', '', 'get', 'absint' );
968 if ( ! $values['posted_form_id'] ) {
969 $values['posted_form_id'] = FrmAppHelper::get_param( 'form', '', 'get', 'absint' );
970 }
971
972 if ( $form->id == $values['posted_form_id'] ) {
973 // If there are two forms on the same page, make sure not to submit both.
974 foreach ( $default_values as $var => $default ) {
975 if ( $var == 'action' ) {
976 $values[ $var ] = FrmAppHelper::get_param( $action_var, $default, 'get', 'sanitize_title' );
977 } else {
978 $values[ $var ] = FrmAppHelper::get_param( $var, $default, 'get', 'sanitize_text_field' );
979 }
980 unset( $var, $default );
981 }
982 } else {
983 foreach ( $default_values as $var => $default ) {
984 $values[ $var ] = $default;
985 unset( $var, $default );
986 }
987 }
988
989 if ( in_array( $values['action'], array( 'create', 'update' ) ) &&
990 ( ! $_POST || ( ! isset( $_POST['action'] ) && ! isset( $_POST['frm_action'] ) ) ) // phpcs:ignore WordPress.Security.NonceVerification.Missing
991 ) {
992 $values['action'] = 'new';
993 }
994
995 return $values;
996 }
997
998 public static function list_page_params() {
999 $values = array();
1000 $defaults = array(
1001 'template' => 0,
1002 'id' => '',
1003 'paged' => 1,
1004 'form' => '',
1005 'search' => '',
1006 'sort' => '',
1007 'sdir' => '',
1008 );
1009 foreach ( $defaults as $var => $default ) {
1010 $values[ $var ] = FrmAppHelper::get_param( $var, $default, 'get', 'sanitize_text_field' );
1011 }
1012
1013 return $values;
1014 }
1015
1016 public static function get_admin_params( $form = null ) {
1017 $form_id = $form;
1018 if ( $form === null ) {
1019 $form_id = self::get_current_form_id();
1020 } elseif ( $form && is_object( $form ) ) {
1021 $form_id = $form->id;
1022 }
1023
1024 $values = array();
1025 $defaults = array(
1026 'id' => '',
1027 'form_name' => '',
1028 'paged' => 1,
1029 'form' => $form_id,
1030 'field_id' => '',
1031 'search' => '',
1032 'sort' => '',
1033 'sdir' => '',
1034 'fid' => '',
1035 'keep_post' => '',
1036 );
1037 foreach ( $defaults as $var => $default ) {
1038 $values[ $var ] = FrmAppHelper::get_param( $var, $default, 'get', 'sanitize_text_field' );
1039 }
1040
1041 return $values;
1042 }
1043
1044 public static function get_current_form_id( $default_form = 'none' ) {
1045 if ( 'first' == $default_form ) {
1046 $form = self::get_current_form();
1047 } else {
1048 $form = self::maybe_get_current_form();
1049 }
1050 $form_id = $form ? $form->id : 0;
1051
1052 return $form_id;
1053 }
1054
1055 public static function maybe_get_current_form( $form_id = 0 ) {
1056 global $frm_vars;
1057
1058 if ( isset( $frm_vars['current_form'] ) && $frm_vars['current_form'] && ( ! $form_id || $form_id == $frm_vars['current_form']->id ) ) {
1059 return $frm_vars['current_form'];
1060 }
1061
1062 $form_id = FrmAppHelper::get_param( 'form', $form_id, 'get', 'absint' );
1063 if ( $form_id ) {
1064 $form_id = self::set_current_form( $form_id );
1065 }
1066
1067 return $form_id;
1068 }
1069
1070 public static function get_current_form( $form_id = 0 ) {
1071 $form = self::maybe_get_current_form( $form_id );
1072 if ( is_numeric( $form ) ) {
1073 $form = self::set_current_form( $form );
1074 }
1075
1076 return $form;
1077 }
1078
1079 public static function set_current_form( $form_id ) {
1080 global $frm_vars;
1081
1082 $query = array();
1083 if ( $form_id ) {
1084 $query['id'] = $form_id;
1085 }
1086
1087 $frm_vars['current_form'] = self::get_published_forms( $query, 1 );
1088
1089 return $frm_vars['current_form'];
1090 }
1091
1092 public static function is_form_loaded( $form, $this_load, $global_load ) {
1093 global $frm_vars;
1094 $small_form = new stdClass();
1095 foreach ( array( 'id', 'form_key', 'name' ) as $var ) {
1096 $small_form->{$var} = $form->{$var};
1097 unset( $var );
1098 }
1099
1100 $frm_vars['forms_loaded'][] = $small_form;
1101
1102 if ( $this_load && empty( $global_load ) ) {
1103 $global_load = true;
1104 $frm_vars['load_css'] = true;
1105 }
1106
1107 return ( ( ! isset( $frm_vars['css_loaded'] ) || ! $frm_vars['css_loaded'] ) && $global_load );
1108 }
1109
1110 /**
1111 * @since 4.06.03
1112 *
1113 * @param object $form
1114 *
1115 * @return bool
1116 */
1117 public static function &is_visible_to_user( $form ) {
1118 if ( $form->logged_in && isset( $form->options['logged_in_role'] ) ) {
1119 $visible = FrmAppHelper::user_has_permission( $form->options['logged_in_role'] );
1120 } else {
1121 $visible = true;
1122 }
1123
1124 return $visible;
1125 }
1126
1127 public static function show_submit( $form ) {
1128 $show = ( ! $form->is_template && $form->status == 'published' && ! FrmAppHelper::is_admin() );
1129 $show = apply_filters( 'frm_show_submit_button', $show, $form );
1130
1131 return $show;
1132 }
1133
1134 /**
1135 * @since 2.3
1136 */
1137 public static function get_option( $atts ) {
1138 $form = $atts['form'];
1139 $default = isset( $atts['default'] ) ? $atts['default'] : '';
1140
1141 return isset( $form->options[ $atts['option'] ] ) ? $form->options[ $atts['option'] ] : $default;
1142 }
1143
1144 /**
1145 * Get the link to edit this form.
1146 *
1147 * @since 4.0
1148 * @param int $form_id The id of the form.
1149 */
1150 public static function get_edit_link( $form_id ) {
1151 return admin_url( 'admin.php?page=formidable&frm_action=edit&id=' . $form_id );
1152 }
1153
1154 /**
1155 * Check if the "Submit this form with AJAX" setting is toggled on.
1156 *
1157 * @since 6.2
1158 *
1159 * @param stdClass $form
1160 * @return bool
1161 */
1162 public static function is_ajax_on( $form ) {
1163 return ! empty( $form->options['ajax_submit'] );
1164 }
1165
1166 /**
1167 * Get the latest form available.
1168 *
1169 * @since 6.8
1170 * @return object
1171 */
1172 public static function get_latest_form() {
1173
1174 $args = array(
1175 array(
1176 'or' => 1,
1177 'parent_form_id' => null,
1178 'parent_form_id <' => 1,
1179 ),
1180 'is_template' => 0,
1181 'status !' => 'trash',
1182 );
1183
1184 return self::getAll( $args, 'created_at desc', 1 );
1185 }
1186
1187 /**
1188 * Count and return total forms.
1189 *
1190 * @since 6.8
1191 * @return int
1192 */
1193 public static function get_forms_count() {
1194
1195 $args = array(
1196 array(
1197 'or' => 1,
1198 'parent_form_id' => null,
1199 'parent_form_id <' => 1,
1200 ),
1201 'is_template' => 0,
1202 'status !' => 'trash',
1203 );
1204
1205 return FrmDb::get_count( 'frm_forms', $args );
1206 }
1207
1208 /**
1209 * @deprecated 2.03.05 This is still referenced in a few add ons (API, locations).
1210 * @codeCoverageIgnore
1211 *
1212 * @param string $key
1213 * @return int form id
1214 */
1215 public static function getIdByKey( $key ) {
1216 _deprecated_function( __FUNCTION__, '2.03.05', 'FrmForm::get_id_by_key' );
1217 return self::get_id_by_key( $key );
1218 }
1219
1220 /**
1221 * @deprecated 2.03.05 This is still referenced in the API add on as of v1.13.
1222 * @codeCoverageIgnore
1223 *
1224 * @param string|int $id
1225 * @return string
1226 */
1227 public static function getKeyById( $id ) {
1228 _deprecated_function( __FUNCTION__, '2.03.05', 'FrmForm::get_key_by_id' );
1229 return self::get_key_by_id( $id );
1230 }
1231 }
1232