← All changes | classes/models/FrmSettings.php +66 -336 6.26 → 6.2 View file →

		@@ -4,254 +4,59 @@
4	4	}
5	5
6	6	#[\AllowDynamicProperties]
7	7	class FrmSettings {
8		-
9		- /**
10		- * @var string
11		- */
12	8	public $option_name = 'frm_options';
13		-
14		- /**
15		- * @var int
16		- */
17	9	public $menu;
18		-
19		- /**
20		- * @var int
21		- */
22	10	public $mu_menu;
23		-
24		- /**
25		- * @var int
26		- */
	11	+ public $use_html;
	12	+ public $jquery_css;
	13	+ public $accordion_js;
27	14	public $fade_form;
28		-
29		- /**
30		- * @var bool
31		- */
	15	+ public $old_css;
32	16	public $admin_bar;
33	17
34		- /**
35		- * @var string
36		- */
37	18	public $success_msg;
38		-
39		- /**
40		- * @var string
41		- */
42	19	public $blank_msg;
43		-
44		- /**
45		- * @var string
46		- */
47	20	public $unique_msg;
48		-
49		- /**
50		- * @var string
51		- */
52	21	public $invalid_msg;
53		-
54		- /**
55		- * @var string
56		- */
57	22	public $failed_msg;
58		-
59		- /**
60		- * @var string
61		- */
62	23	public $submit_value;
63		-
64		- /**
65		- * @var string
66		- */
67	24	public $login_msg;
68		-
69		- /**
70		- * @var string
71		- */
72	25	public $admin_permission;
73	26
74		- /**
75		- * @var string
76		- */
77	27	public $email_to;
78		-
79		- /**
80		- * @var string|null
81		- */
82	28	public $load_style;
83		-
84		- /**
85		- * @var bool|int|null
86		- */
87	29	public $custom_style;
88	30
89		- /**
90		- * @var string|null
91		- */
92	31	public $active_captcha;
93		-
94		- /**
95		- * Settings for reCAPTCHA.
96		- */
97		-
98		- /**
99		- * @var string|null
100		- */
	32	+ public $hcaptcha_pubkey;
	33	+ public $hcaptcha_privkey;
101	34	public $pubkey;
102		-
103		- /**
104		- * @var string|null
105		- */
106	35	public $privkey;
107		-
108		- /**
109		- * @var string|null
110		- */
111	36	public $re_lang;
112		-
113		- /**
114		- * @var string|null
115		- */
116	37	public $re_type;
117		-
118		- /**
119		- * @var string
120		- */
121	38	public $re_msg;
122		-
123		- /**
124		- * @var bool
125		- */
126	39	public $re_multi;
127	40
128		- /**
129		- * @var float|string|null
130		- */
131		- public $re_threshold;
132		-
133		- /**
134		- * Settings for hCaptcha.
135		- */
136		-
137		- /**
138		- * @var string
139		- */
140		- public $hcaptcha_pubkey;
141		-
142		- /**
143		- * @var string|null
144		- */
145		- public $hcaptcha_privkey;
146		-
147		- /**
148		- * Settings for Turnstile.
149		- */
150		-
151		- /**
152		- * @var string
153		- */
154		- public $turnstile_pubkey;
155		-
156		- /**
157		- * @var string|null
158		- */
159		- public $turnstile_privkey;
160		-
161		- /**
162		- * @var bool
163		- */
164	41	public $no_ips;
165		-
166		- /**
167		- * @var string
168		- */
169	42	public $custom_header_ip;
170		-
171		- /**
172		- * @var int
173		- */
174	43	public $current_form = 0;
175		-
176		- /**
177		- * @var bool
178		- */
179	44	public $tracking;
180	45
181	46	/**
182		- * @var bool
183		- */
184		- public $summary_emails;
185		-
186		- /**
187		- * @var string
188		- */
189		- public $summary_emails_recipients;
190		-
191		- /**
192		- * @var string|null
193		- */
194		- public $default_email;
195		-
196		- /**
197		- * @var string
198		- */
199		- public $from_email;
200		-
201		- /**
202		- * @var string|null
203		- */
204		- public $currency;
205		-
206		- /**
207	47	* @since 6.0
208	48	*
209		- * @var false|string|null
	49	+ * @var string|false|null
210	50	*/
211	51	public $custom_css;
212	52
213		- /**
214		- * @var string
215		- */
216		- public $honeypot;
217		-
218		- /**
219		- * @var bool
220		- */
221		- public $wp_spam_check;
222		-
223		- /**
224		- * @var bool
225		- */
226		- public $denylist_check;
227		-
228		- /**
229		- * @since 6.25.1
230		- *
231		- * @var int|null 1 if installed after welcome tour update, null otherwise.
232		- */
233		- public $installed_after_welcome_tour_update;
234		-
235		- /**
236		- * @var string
237		- */
238		- public $disallowed_words;
239		-
240		- /**
241		- * @var string
242		- */
243		- public $allowed_words;
244		-
245		- /**
246		- * @param array $args
247		- */
248	53	public function __construct( $args = array() ) {
249	54	if ( ! defined( 'ABSPATH' ) ) {
250	55	die( 'You are not allowed to call this page directly.' );
251	56	}
252	57
253		- $settings = get_option( $this->option_name );
	58	+ $settings = get_transient( $this->option_name );
254	59
255	60	if ( ! is_object( $settings ) ) {
256	61	$settings = $this->translate_settings( $settings );
257	62	}
		@@ -265,24 +70,30 @@
265	70
266	71	$this->maybe_filter_for_form( $args );
267	72	}
268	73
269		- /**
270		- * @param false|object $settings
271		- *
272		- * @return object
273		- */
274	74	private function translate_settings( $settings ) {
275		- if ( $settings ) {
276		- // Workaround for W3 total cache conflict.
	75	+ if ( $settings ) { //workaround for W3 total cache conflict
277	76	return unserialize( serialize( $settings ) );
278	77	}
279	78
280		- // If unserializing didn't work.
281		- $settings = $this;
	79	+ $settings = get_option( $this->option_name );
	80	+ if ( is_object( $settings ) ) {
	81	+ set_transient( $this->option_name, $settings );
282	82
283		- update_option( $this->option_name, $settings, 'yes' );
	83	+ return $settings;
	84	+ }
284	85
	86	+ // If unserializing didn't work
	87	+ if ( $settings ) { //workaround for W3 total cache conflict
	88	+ $settings = unserialize( serialize( $settings ) );
	89	+ } else {
	90	+ $settings = $this;
	91	+ }
	92	+
	93	+ update_option( $this->option_name, $settings );
	94	+ set_transient( $this->option_name, $settings );
	95	+
285	96	return $settings;
286	97	}
287	98
288	99	/**
		@@ -289,46 +100,36 @@
289	100	* @return array
290	101	*/
291	102	public function default_options() {
292	103	return array(
293		- 'menu' => apply_filters( 'frm_default_menu', 'Formidable' ),
294		- 'mu_menu' => 0,
295		- 'fade_form' => false,
296		- 'admin_bar' => false,
	104	+ 'menu' => apply_filters( 'frm_default_menu', 'Formidable' ),
	105	+ 'mu_menu' => 0,
	106	+ 'use_html' => true,
	107	+ 'jquery_css' => false,
	108	+ 'accordion_js' => false,
	109	+ 'fade_form' => false,
	110	+ 'old_css' => false,
	111	+ 'admin_bar' => false,
297	112
298		- 're_multi' => 1,
	113	+ 're_multi' => 1,
299	114
300		- 'success_msg' => __( 'Your responses were successfully submitted. Thank you!', 'formidable' ),
301		- // translators: %s: [field_name] shortcode.
302		- 'blank_msg' => sprintf( __( '%s cannot be blank.', 'formidable' ), '[field_name]' ),
303		- // translators: %s: [field_name] shortcode.
304		- 'unique_msg' => sprintf( __( '%s must be unique.', 'formidable' ), '[field_name]' ),
305		- 'invalid_msg' => __( 'There was a problem with your submission. Errors are marked below.', 'formidable' ),
306		- 'failed_msg' => __( 'We\'re sorry. It looks like you\'ve already submitted that.', 'formidable' ),
307		- 'submit_value' => __( 'Submit', 'formidable' ),
308		- 'login_msg' => __( 'You do not have permission to view this form.', 'formidable' ),
309		- 'admin_permission' => __( 'You do not have permission to do that', 'formidable' ),
310		- 'new_tab_msg' => __( 'The page has been opened in a new tab.', 'formidable' ),
	115	+ 'success_msg' => __( 'Your responses were successfully submitted. Thank you!', 'formidable' ),
	116	+ 'blank_msg' => __( 'This field cannot be blank.', 'formidable' ),
	117	+ 'unique_msg' => __( 'This value must be unique.', 'formidable' ),
	118	+ 'invalid_msg' => __( 'There was a problem with your submission. Errors are marked below.', 'formidable' ),
	119	+ 'failed_msg' => __( 'We\'re sorry. It looks like you\'ve already submitted that.', 'formidable' ),
	120	+ 'submit_value' => __( 'Submit', 'formidable' ),
	121	+ 'login_msg' => __( 'You do not have permission to view this form.', 'formidable' ),
	122	+ 'admin_permission' => __( 'You do not have permission to do that', 'formidable' ),
311	123
312		- 'email_to' => '[admin_email]',
313		- 'enable_gdpr' => 0,
314		- 'no_gdpr_cookies' => 0,
315		- 'no_ips' => 0,
316		- 'custom_header_ip' => 0,
317		- 'tracking' => FrmAppHelper::pro_is_installed(),
318		- // Only enable this by default for the main site.
319		- 'summary_emails' => get_current_blog_id() === get_main_site_id(),
320		- 'summary_emails_recipients' => '[admin_email]',
	124	+ 'email_to' => '[admin_email]',
	125	+ 'no_ips' => 0,
	126	+ 'custom_header_ip' => false, // Use false by default. We show a warning when this is unset. Once global settings have been saved, this gets saved
	127	+ 'tracking' => FrmAppHelper::pro_is_installed(),
321	128
322	129	// Normally custom CSS is a string. A false value is used when nothing has been set.
323	130	// When it is false, we try to use the old custom_key value from the default style's post_content array.
324		- 'custom_css' => false,
325		- 'honeypot' => 1,
326		- 'wp_spam_check' => 0,
327		- 'denylist_check' => 0,
328		- 'disallowed_words' => '',
329		- 'allowed_words' => '',
330		- 'email_style' => 'classic',
	131	+ 'custom_css' => false,
331	132	);
332	133	}
333	134
334	135	/**
		@@ -348,9 +149,8 @@
348	149	$this->fill_with_defaults();
349	150
350	151	if ( is_multisite() && is_admin() ) {
351	152	$mu_menu = get_site_option( 'frm_admin_menu_name' );
352		-
353	153	if ( $mu_menu && ! empty( $mu_menu ) ) {
354	154	$this->menu = $mu_menu;
355	155	$this->mu_menu = 1;
356	156	}
		@@ -356,27 +156,17 @@
356	156	}
357	157	}
358	158
359	159	$frm_roles = FrmAppHelper::frm_capabilities( 'pro' );
360		-
361	160	foreach ( $frm_roles as $frm_role => $frm_role_description ) {
362	161	if ( ! isset( $this->$frm_role ) ) {
363	162	$this->$frm_role = 'administrator';
364	163	}
365	164	}
366		-
367		- if ( ! isset( $this->default_email ) ) {
368		- $this->default_email = get_option( 'admin_email' );
369		- }
370		-
371		- if ( ! isset( $this->currency ) ) {
372		- $this->currency = 'USD';
373		- }
374	165	}
375	166
376	167	/**
377	168	* @param array $params
378		- *
379	169	* @return void
380	170	*/
381	171	public function fill_with_defaults( $params = array() ) {
382	172	$settings = $this->default_options();
		@@ -383,9 +173,8 @@
383	173	$filter_html = ! FrmAppHelper::allow_unfiltered_html();
384	174
385	175	if ( $filter_html ) {
386	176	$filter_keys = array( 'failed_msg', 'blank_msg', 'invalid_msg', 'admin_permission', 'unique_msg', 'success_msg', 'submit_value', 'login_msg', 'menu' );
387		-
388	177	if ( ! empty( $params['additional_filter_keys'] ) ) {
389	178	$filter_keys = array_merge( $filter_keys, $params['additional_filter_keys'] );
390	179	}
391	180	} else {
		@@ -415,9 +204,8 @@
415	204	*
416	205	* @param mixed $value The unsanitized global setting value.
417	206	* @param string $key The key of the global setting being saved.
418	207	* @param array $filter_keys These keys that are filtered with kses.
419		- *
420	208	* @return mixed
421	209	*/
422	210	private function maybe_sanitize_global_setting( $value, $key, $filter_keys ) {
423	211	if ( 'custom_css' === $key ) {
		@@ -442,28 +230,24 @@
442	230	if ( ! isset( $this->active_captcha ) ) {
443	231	$this->active_captcha = 'recaptcha';
444	232	}
445	233
446		- $privkey = '';
447		- $re_lang = '';
	234	+ $privkey = '';
	235	+ $re_lang = '';
448	236
449	237	if ( ! isset( $this->hcaptcha_privkey ) ) {
450	238	$this->hcaptcha_privkey = '';
451	239	}
452	240
453		- if ( ! isset( $this->turnstile_privkey ) ) {
454		- $this->turnstile_privkey = '';
455		- }
456		-
457	241	if ( ! isset( $this->pubkey ) ) {
458		- // Get the options from the database.
	242	+ // get the options from the database
459	243	$recaptcha_opt = is_multisite() ? get_site_option( 'recaptcha' ) : get_option( 'recaptcha' );
460		- $this->pubkey = $recaptcha_opt['pubkey'] ?? '';
461		- $privkey = $recaptcha_opt['privkey'] ?? $privkey;
462		- $re_lang = $recaptcha_opt['re_lang'] ?? $re_lang;
	244	+ $this->pubkey = isset( $recaptcha_opt['pubkey'] ) ? $recaptcha_opt['pubkey'] : '';
	245	+ $privkey = isset( $recaptcha_opt['privkey'] ) ? $recaptcha_opt['privkey'] : $privkey;
	246	+ $re_lang = isset( $recaptcha_opt['re_lang'] ) ? $recaptcha_opt['re_lang'] : $re_lang;
463	247	}
464	248
465		- if ( empty( $this->re_msg ) ) {
	249	+ if ( ! isset( $this->re_msg ) || empty( $this->re_msg ) ) {
466	250	$this->re_msg = __( 'The CAPTCHA was not entered correctly', 'formidable' );
467	251	}
468	252
469	253	if ( ! isset( $this->privkey ) ) {
		@@ -503,16 +287,13 @@
503	287	* Allow strings to be filtered when a specific form may be displaying them.
504	288	*
505	289	* @since 3.06.01
506	290	*
507		- * @param array $args
508		- *
509	291	* @return void
510	292	*/
511	293	public function maybe_filter_for_form( $args ) {
512	294	if ( isset( $args['current_form'] ) && is_numeric( $args['current_form'] ) ) {
513	295	$this->current_form = $args['current_form'];
514		-
515	296	foreach ( $this->translatable_strings() as $string ) {
516	297	$this->{$string} = apply_filters( 'frm_global_setting', $this->{$string}, $string, $this );
517	298	$this->{$string} = apply_filters( 'frm_global_' . $string, $this->{$string}, $this );
518	299	}
		@@ -521,10 +302,8 @@
521	302
522	303	/**
523	304	* @param array $params
524	305	* @param array $errors
525		- *
526		- * @return array
527	306	*/
528	307	public function validate( $params, $errors ) {
529	308	return apply_filters( 'frm_validate_settings', $errors, $params );
530	309	}
		@@ -555,45 +334,23 @@
555	334	}
556	335	}
557	336
558	337	/**
559		- * @param array $params
560		- *
561	338	* @return void
562	339	*/
563	340	private function update_settings( $params ) {
564		- $this->active_captcha = $params['frm_active_captcha'];
565		- $this->pubkey = trim( $params['frm_pubkey'] );
566		- $this->privkey = trim( $params['frm_privkey'] );
567		- $this->re_type = $params['frm_re_type'];
568		- $this->re_lang = $params['frm_re_lang'];
569		- $this->re_threshold = floatval( $params['frm_re_threshold'] );
570		- $this->hcaptcha_pubkey = trim( $params['frm_hcaptcha_pubkey'] );
571		- $this->hcaptcha_privkey = trim( $params['frm_hcaptcha_privkey'] );
572		- $this->turnstile_pubkey = trim( $params['frm_turnstile_pubkey'] );
573		- $this->turnstile_privkey = trim( $params['frm_turnstile_privkey'] );
574		- $this->load_style = $params['frm_load_style'];
575		- $this->custom_css = $params['frm_custom_css'];
576		- $this->default_email = $params['frm_default_email'];
577		- $this->from_email = $params['frm_from_email'];
578		- $this->currency = $params['frm_currency'];
	341	+ $this->active_captcha = $params['frm_active_captcha'];
	342	+ $this->hcaptcha_pubkey = trim( $params['frm_hcaptcha_pubkey'] );
	343	+ $this->hcaptcha_privkey = $params['frm_hcaptcha_privkey'];
	344	+ $this->pubkey = trim( $params['frm_pubkey'] );
	345	+ $this->privkey = $params['frm_privkey'];
	346	+ $this->re_type = $params['frm_re_type'];
	347	+ $this->re_lang = $params['frm_re_lang'];
	348	+ $this->re_threshold = floatval( $params['frm_re_threshold'] );
	349	+ $this->load_style = $params['frm_load_style'];
	350	+ $this->custom_css = $params['frm_custom_css'];
579	351
580		- $checkboxes = array(
581		- 'mu_menu',
582		- 're_multi',
583		- 'fade_form',
584		- 'no_ips',
585		- 'no_gdpr_cookies',
586		- 'enable_gdpr',
587		- 'custom_header_ip',
588		- 'tracking',
589		- 'admin_bar',
590		- 'summary_emails',
591		- 'honeypot',
592		- 'wp_spam_check',
593		- 'denylist_check',
594		- );
595		-
	352	+ $checkboxes = array( 'mu_menu', 're_multi', 'use_html', 'jquery_css', 'accordion_js', 'fade_form', 'no_ips', 'custom_header_ip', 'tracking', 'admin_bar' );
596	353	foreach ( $checkboxes as $set ) {
597	354	$this->$set = isset( $params[ 'frm_' . $set ] ) ? absint( $params[ 'frm_' . $set ] ) : 0;
598	355	}
599	356	}
		@@ -598,10 +355,8 @@
598	355	}
599	356	}
600	357
601	358	/**
602		- * @param array $params
603		- *
604	359	* @return void
605	360	*/
606	361	private function update_roles( $params ) {
607	362	global $wp_roles;
		@@ -607,14 +362,13 @@
607	362	global $wp_roles;
608	363
609	364	$frm_roles = FrmAppHelper::frm_capabilities();
610	365	$roles = get_editable_roles();
611		-
612	366	foreach ( $frm_roles as $frm_role => $frm_role_description ) {
613		- $this->$frm_role = (array) ( $params[ $frm_role ] ?? 'administrator' );
	367	+ $this->$frm_role = (array) ( isset( $params[ $frm_role ] ) ? $params[ $frm_role ] : 'administrator' );
614	368
615	369	// Make sure administrators always have permissions
616		- if ( ! in_array( 'administrator', $this->$frm_role, true ) ) {
	370	+ if ( ! in_array( 'administrator', $this->$frm_role ) ) {
617	371	array_push( $this->$frm_role, 'administrator' );
618	372	}
619	373
620	374	foreach ( $roles as $role => $details ) {
		@@ -624,32 +378,8 @@
624	378	$wp_roles->remove_cap( $role, $frm_role );
625	379	}
626	380	}
627	381	}
628		- }
629		-
630		- /**
631		- * Updates a single setting with specified sanitization.
632		- *
633		- * @since 6.9
634		- *
635		- * @param string $key The setting key to update.
636		- * @param mixed $value The new value for the setting.
637		- * @param string $sanitize The name of the sanitization function to apply to the new value.
638		- *
639		- * @return bool True on success, false on failure.
640		- */
641		- public function update_setting( $key, $value, $sanitize ) {
642		- if ( ! property_exists( $this, $key ) || ! is_callable( $sanitize ) ) {
643		- // Setting does not exist or sanitization function name is not callable.
644		- return false;
645		- }
646		-
647		- // Update the property value.
648		- FrmAppHelper::sanitize_value( $sanitize, $value );
649		- $this->{$key} = $value;
650		-
651		- return true;
652	382	}
653	383
654	384	/**
655	385	* @return void