FileMaster
Search
Toggle Dark Mode
Home
/
.
/
wp-content
/
plugins
/
sureforms
/
inc
/
global-settings
Edit File: global-settings.php
<?php /** * Sureforms Global Settings. * * @package sureforms. * @since 0.0.1 */ namespace SRFM\Inc\Global_Settings; use SRFM\Inc\Events_Scheduler; use SRFM\Inc\Helper; use SRFM\Inc\Payments\Payment_Helper; use SRFM\Inc\Traits\Get_Instance; use WP_Error; use WP_REST_Request; use WP_REST_Response; use WP_REST_Server; /** * Sureforms Global Settings. * * @since 0.0.1 */ class Global_Settings { use Get_Instance; /** * Namespace. * * @var string */ protected $namespace = 'sureforms/v1'; /** * Constructor * * @since 0.0.1 */ public function __construct() { add_action( 'rest_api_init', [ $this, 'register_custom_endpoint' ] ); } /** * Add custom API Route submit-form * * @return void * @since 0.0.1 */ public function register_custom_endpoint() { register_rest_route( $this->namespace, '/srfm-global-settings', [ 'methods' => WP_REST_Server::EDITABLE, 'callback' => [ $this, 'srfm_save_global_settings' ], 'permission_callback' => [ Helper::class, 'get_items_permissions_check' ], ] ); register_rest_route( $this->namespace, '/srfm-global-settings', [ 'methods' => WP_REST_Server::READABLE, 'callback' => [ $this, 'srfm_get_general_settings' ], 'permission_callback' => [ Helper::class, 'get_items_permissions_check' ], ] ); } /** * Save global settings options. * * @param WP_REST_Request $request Request object. * @return WP_REST_Response|WP_Error * * @since 0.0.1 */ public static function srfm_save_global_settings( $request ) { $nonce = Helper::get_string_value( $request->get_header( 'X-WP-Nonce' ) ); if ( ! wp_verify_nonce( sanitize_text_field( $nonce ), 'wp_rest' ) ) { wp_send_json_error( [ 'data' => __( 'Nonce verification failed.', 'sureforms' ), ] ); } $setting_options = $request->get_params(); $tab = $setting_options['srfm_tab']; unset( $setting_options['srfm_tab'] ); switch ( $tab ) { case 'general-settings': $is_option_saved = self::srfm_save_general_settings( $setting_options ); break; case 'general-settings-dynamic-opt': $is_option_saved = self::srfm_save_general_settings_dynamic_opt( $setting_options ); break; case 'email-settings': $is_option_saved = self::srfm_save_email_summary_settings( $setting_options ); break; case 'security-settings': $is_option_saved = self::srfm_save_security_settings( $setting_options ); break; case 'payments-settings': $is_option_saved = self::srfm_save_payments_settings( $setting_options ); break; case 'mcp-settings': $is_option_saved = self::srfm_save_mcp_settings( $setting_options ); break; default: $is_option_saved = false; break; } if ( ! $is_option_saved ) { return new WP_Error( __( 'Error Saving Settings!', 'sureforms' ), __( 'Global Settings', 'sureforms' ) ); } return new WP_REST_Response( [ 'data' => __( 'Settings Saved Successfully.', 'sureforms' ), ] ); } /** * Save General Settings * * @param array<mixed> $setting_options Setting options. * @return bool * @since 0.0.1 */ public static function srfm_save_general_settings( $setting_options ) { $srfm_ip_log = $setting_options['srfm_ip_log'] ?? false; $srfm_form_analytics = $setting_options['srfm_form_analytics'] ?? false; $srfm_bsf_analytics = $setting_options['srfm_bsf_analytics'] ?? false; $srfm_admin_notification = isset( $setting_options['srfm_admin_notification'] ) ? (bool) $setting_options['srfm_admin_notification'] : true; $settings = [ 'srfm_ip_log' => $srfm_ip_log, 'srfm_form_analytics' => $srfm_form_analytics, 'srfm_admin_notification' => $srfm_admin_notification, ]; /** * We are updating sureforms_analytics_optin option from the general settings as it has been introduced * as part of general settings. Since the option sureforms_analytics_optin is already available from BSF analytics library * We are updating this independently. * * @since 1.7.0 * * @since 2.5.1 - Renamed sureforms_analytics_optin to sureforms_usage_optin. */ $analytics_result = self::update_bsf_analytics( $srfm_bsf_analytics ); $general_result = update_option( 'srfm_general_settings_options', $settings ); /** * Returns the output of update_bsf_analytics or srfm_general_settings_options option. * * @since 1.7.0 */ return $analytics_result || $general_result; } /** * Toggle BSF analytics usage tracking in WP general settings. * * @param array<mixed> $settings general settings array. * @return bool * @since 1.7.0 */ public static function update_bsf_analytics( $settings ) { if ( true === $settings ) { $enable_tracking = 'yes'; } else { $enable_tracking = ''; } return update_option( 'sureforms_usage_optin', $enable_tracking ); } /** * Save General Settings Dynamic Options * * @param array<mixed> $setting_options Setting options. * @return bool * @since 0.0.1 */ public static function srfm_save_general_settings_dynamic_opt( $setting_options ) { $options_keys = [ 'srfm_url_block_required_text', 'srfm_input_block_required_text', 'srfm_input_block_unique_text', 'srfm_address_block_required_text', 'srfm_phone_block_required_text', 'srfm_phone_block_unique_text', 'srfm_number_block_required_text', 'srfm_textarea_block_required_text', 'srfm_multi_choice_block_required_text', 'srfm_checkbox_block_required_text', 'srfm_gdpr_block_required_text', 'srfm_email_block_required_text', 'srfm_email_block_unique_text', 'srfm_dropdown_block_required_text', 'srfm_valid_phone_number', 'srfm_valid_url', 'srfm_confirm_email_same', 'srfm_valid_email', 'srfm_input_min_value', 'srfm_input_max_value', 'srfm_dropdown_min_selections', 'srfm_dropdown_max_selections', 'srfm_multi_choice_min_selections', 'srfm_multi_choice_max_selections', ]; $options_names = []; foreach ( $options_keys as $key ) { if ( isset( $setting_options[ $key ] ) ) { $value = $setting_options[ $key ]; $options_names[ $key ] = sanitize_text_field( is_scalar( $value ) ? (string) $value : '' ); } } // Re-sanitize after filter so Pro-injected keys are also covered. $options_to_save = apply_filters( 'srfm_general_dynamic_options_to_save', $options_names, $setting_options ); $options_to_save = array_map( 'sanitize_text_field', $options_to_save ); return update_option( 'srfm_default_dynamic_block_option', $options_to_save ); } /** * Save Email Summary Settings * * @param array<mixed> $setting_options Setting options. * @return bool * @since 0.0.1 */ public static function srfm_save_email_summary_settings( $setting_options ) { $srfm_email_summary = $setting_options['srfm_email_summary'] ?? false; $srfm_email_sent_to = sanitize_email( $setting_options['srfm_email_sent_to'] ?? get_option( 'admin_email' ) ); $srfm_schedule_report = $setting_options['srfm_schedule_report'] ?? __( 'Monday', 'sureforms' ); Events_Scheduler::unschedule_events( 'srfm_weekly_scheduled_events' ); if ( $srfm_email_summary ) { Email_Summary::schedule_weekly_entries_email(); } return update_option( 'srfm_email_summary_settings_options', [ 'srfm_email_summary' => $srfm_email_summary, 'srfm_email_sent_to' => $srfm_email_sent_to, 'srfm_schedule_report' => $srfm_schedule_report, ] ); } /** * Save Security Settings * * @param array<mixed> $setting_options Setting options. * @return bool * @since 0.0.1 */ public static function srfm_save_security_settings( $setting_options ) { $srfm_v2_checkbox_site_key = $setting_options['srfm_v2_checkbox_site_key'] ?? ''; $srfm_v2_checkbox_secret_key = $setting_options['srfm_v2_checkbox_secret_key'] ?? ''; $srfm_v2_invisible_site_key = $setting_options['srfm_v2_invisible_site_key'] ?? ''; $srfm_v2_invisible_secret_key = $setting_options['srfm_v2_invisible_secret_key'] ?? ''; $srfm_v3_site_key = $setting_options['srfm_v3_site_key'] ?? ''; $srfm_v3_secret_key = $setting_options['srfm_v3_secret_key'] ?? ''; $srfm_cf_appearance_mode = $setting_options['srfm_cf_appearance_mode'] ?? 'auto'; $srfm_cf_turnstile_site_key = $setting_options['srfm_cf_turnstile_site_key'] ?? ''; $srfm_cf_turnstile_secret_key = $setting_options['srfm_cf_turnstile_secret_key'] ?? ''; $srfm_hcaptcha_site_key = ! empty( $setting_options['srfm_hcaptcha_site_key'] ) ? $setting_options['srfm_hcaptcha_site_key'] : ''; $srfm_hcaptcha_secret_key = ! empty( $setting_options['srfm_hcaptcha_secret_key'] ) ? $setting_options['srfm_hcaptcha_secret_key'] : ''; $srfm_honeypot = $setting_options['srfm_honeypot'] ?? false; return update_option( 'srfm_security_settings_options', [ 'srfm_v2_checkbox_site_key' => $srfm_v2_checkbox_site_key, 'srfm_v2_checkbox_secret_key' => $srfm_v2_checkbox_secret_key, 'srfm_v2_invisible_site_key' => $srfm_v2_invisible_site_key, 'srfm_v2_invisible_secret_key' => $srfm_v2_invisible_secret_key, 'srfm_v3_site_key' => $srfm_v3_site_key, 'srfm_v3_secret_key' => $srfm_v3_secret_key, 'srfm_cf_appearance_mode' => $srfm_cf_appearance_mode, 'srfm_cf_turnstile_site_key' => $srfm_cf_turnstile_site_key, 'srfm_cf_turnstile_secret_key' => $srfm_cf_turnstile_secret_key, 'srfm_hcaptcha_site_key' => $srfm_hcaptcha_site_key, 'srfm_hcaptcha_secret_key' => $srfm_hcaptcha_secret_key, 'srfm_honeypot' => $srfm_honeypot, ] ); } /** * Save Payments Settings * * Handles saving of both global payment settings (currency, payment_mode) and * gateway-specific settings based on the gateway parameter. * * @param array<mixed> $setting_options Setting options. * @return bool * @since 2.0.0 */ public static function srfm_save_payments_settings( $setting_options ) { $gateway = isset( $setting_options['gateway'] ) && is_string( $setting_options['gateway'] ) ? sanitize_text_field( $setting_options['gateway'] ) : 'stripe'; // Handle global settings (currency, payment_mode). if ( isset( $setting_options['currency'] ) && ! empty( $setting_options['currency'] ) && is_string( $setting_options['currency'] ) ) { $currency = sanitize_text_field( $setting_options['currency'] ); Payment_Helper::update_global_setting( 'currency', $currency ); } $payment_mode = null; if ( isset( $setting_options['payment_mode'] ) && ! empty( $setting_options['payment_mode'] ) && is_string( $setting_options['payment_mode'] ) ) { $payment_mode = sanitize_text_field( $setting_options['payment_mode'] ); Payment_Helper::update_global_setting( 'payment_mode', $payment_mode ); } // Save currency sign position. if ( isset( $setting_options['currency_sign_position'] ) && ! empty( $setting_options['currency_sign_position'] ) && is_string( $setting_options['currency_sign_position'] ) ) { $currency_sign_position = sanitize_text_field( $setting_options['currency_sign_position'] ); Payment_Helper::update_global_setting( 'currency_sign_position', $currency_sign_position ); } // Handle gateway-specific settings. if ( 'stripe' === $gateway ) { $current_stripe_settings = Payment_Helper::get_gateway_settings( 'stripe' ); // Update payment_mode in stripe settings as well (if provided). if ( null !== $payment_mode ) { $current_stripe_settings['payment_mode'] = $payment_mode; } // Connection data (keys, account info) is managed separately via OAuth. return Payment_Helper::update_gateway_settings( 'stripe', $current_stripe_settings ); } return true; } /** * Save MCP Settings * * @param array<mixed> $setting_options Setting options. * @return bool * @since 2.6.0 */ public static function srfm_save_mcp_settings( $setting_options ) { $srfm_abilities_api = ! empty( $setting_options['srfm_abilities_api'] ); $srfm_abilities_api_edit = ! empty( $setting_options['srfm_abilities_api_edit'] ); $srfm_abilities_api_delete = ! empty( $setting_options['srfm_abilities_api_delete'] ); $srfm_mcp_server = ! empty( $setting_options['srfm_mcp_server'] ); // Save as individual options for the Abilities API permission_callback. update_option( 'srfm_abilities_api', $srfm_abilities_api ); update_option( 'srfm_abilities_api_edit', $srfm_abilities_api_edit ); update_option( 'srfm_abilities_api_delete', $srfm_abilities_api_delete ); update_option( 'srfm_mcp_server', $srfm_mcp_server ); // Save grouped option for the settings UI fetch. return update_option( 'srfm_mcp_settings_options', [ 'srfm_abilities_api' => $srfm_abilities_api, 'srfm_abilities_api_edit' => $srfm_abilities_api_edit, 'srfm_abilities_api_delete' => $srfm_abilities_api_delete, 'srfm_mcp_server' => $srfm_mcp_server, ] ); } /** * Get Settings Form Data * * @param \WP_REST_Request $request Request object or array containing form data. * @return void * @since 0.0.1 */ public static function srfm_get_general_settings( $request ) { $nonce = Helper::get_string_value( $request->get_header( 'X-WP-Nonce' ) ); if ( ! wp_verify_nonce( sanitize_text_field( $nonce ), 'wp_rest' ) ) { wp_send_json_error( [ 'data' => __( 'Nonce verification failed.', 'sureforms' ), ] ); } $options_to_get = $request->get_param( 'options_to_fetch' ); $options_to_get = Helper::get_string_value( $options_to_get ); $options_to_get = explode( ',', $options_to_get ); // Restrict to known SureForms options to prevent arbitrary option disclosure. $allowed_options = [ 'srfm_general_settings_options', 'srfm_email_summary_settings_options', 'srfm_security_settings_options', 'srfm_default_dynamic_block_option', ]; $options_to_get = array_values( array_intersect( array_map( 'sanitize_text_field', $options_to_get ), $allowed_options ) ); $global_setting_options = get_options( $options_to_get ); if ( empty( $global_setting_options['srfm_general_settings_options'] ) ) { $global_setting_options['srfm_general_settings_options'] = [ 'srfm_ip_log' => false, 'srfm_form_analytics' => false, 'srfm_admin_notification' => true, ]; } if ( ! isset( $global_setting_options['srfm_general_settings_options']['srfm_admin_notification'] ) ) { $global_setting_options['srfm_general_settings_options']['srfm_admin_notification'] = true; } /** * We have introduced toggle for analytics optin in the general settings. * Hence retrieving the option sureforms_analytics_optin to get current status. * * @since 1.7.0 * * @since 2.5.1 - Renamed sureforms_analytics_optin to sureforms_usage_optin. */ $srfm_bsf_analytics = get_option( 'sureforms_usage_optin', false ) === 'yes' ? true : false; $global_setting_options['srfm_general_settings_options']['srfm_bsf_analytics'] = $srfm_bsf_analytics; if ( empty( $global_setting_options['srfm_default_dynamic_block_option'] ) ) { $global_setting_options['srfm_default_dynamic_block_option'] = Helper::default_dynamic_block_option(); } if ( empty( $global_setting_options['srfm_email_summary_settings_options'] ) ) { $global_setting_options['srfm_email_summary_settings_options'] = [ 'srfm_email_summary' => false, 'srfm_email_sent_to' => get_option( 'admin_email' ), 'srfm_schedule_report' => __( 'Monday', 'sureforms' ), ]; } if ( empty( $global_setting_options['srfm_security_settings_options'] ) ) { $global_setting_options['srfm_security_settings_options'] = [ 'srfm_v2_checkbox_site_key' => '', 'srfm_v2_checkbox_secret_key' => '', 'srfm_v2_invisible_site_key' => '', 'srfm_v2_invisible_secret_key' => '', 'srfm_v3_site_key' => '', 'srfm_v3_secret_key' => '', 'srfm_cf_appearance_mode' => 'auto', 'srfm_cf_turnstile_site_key' => '', 'srfm_cf_turnstile_secret_key' => '', 'srfm_hcaptcha_site_key' => '', 'srfm_hcaptcha_secret_key' => '', 'srfm_honeypot' => false, ]; } if ( empty( $global_setting_options['srfm_mcp_settings_options'] ) ) { $global_setting_options['srfm_mcp_settings_options'] = [ 'srfm_abilities_api' => (bool) get_option( 'srfm_abilities_api', false ), 'srfm_abilities_api_edit' => (bool) get_option( 'srfm_abilities_api_edit', false ), 'srfm_abilities_api_delete' => (bool) get_option( 'srfm_abilities_api_delete', false ), 'srfm_mcp_server' => (bool) get_option( 'srfm_mcp_server', false ), ]; } // Apply filter to allow other modules to add their settings. $global_setting_options = apply_filters( 'srfm_global_settings_data', $global_setting_options ); wp_send_json( $global_setting_options ); } }
Save
Back