8889841chome/clixcotz/cbo.clix.co.tz/wp-content/plugins/wp-store-locator/admin/class-settings.php 0000644 00000167511 15052654265 0025661 0 ustar 00 manually_clear_transient();
add_action( 'wp_ajax_validate_server_key', array( $this, 'ajax_validate_server_key' ) );
add_action( 'wp_ajax_nopriv_validate_server_key', array( $this, 'ajax_validate_server_key' ) );
add_action( 'admin_init', array( $this, 'register_settings' ) );
add_action( 'admin_init', array( $this, 'maybe_flush_rewrite_and_transient' ) );
}
/**
* Determine if we need to clear the autoload transient.
*
* User can do this manually from the 'Tools' section on the settings page.
*
* @since 2.0.0
* @return void
*/
public function manually_clear_transient() {
global $wpsl_admin;
if ( isset( $_GET['action'] ) && $_GET['action'] == 'clear_wpsl_transients' && isset( $_REQUEST['_wpnonce'] ) && wp_verify_nonce( $_REQUEST['_wpnonce'], 'clear_transients' ) ) {
$wpsl_admin->delete_autoload_transient();
$msg = __( 'WP Store Locator Transients Cleared', 'wpsl' );
$wpsl_admin->notices->save( 'update', $msg );
/*
* Make sure the &action=clear_wpsl_transients param is removed from the url.
*
* Otherwise if the user later clicks the 'Save Changes' button,
* and the &action=clear_wpsl_transients param is still there it
* will show two notices 'WP Store Locator Transients Cleared' and 'Settings Saved'.
*/
wp_redirect( admin_url( 'edit.php?post_type=wpsl_stores&page=wpsl_settings' ) );
exit;
}
}
/**
* Register the settings.
*
* @since 2.0.0
* @return void
*/
public function register_settings() {
register_setting( 'wpsl_settings', 'wpsl_settings', array( $this, 'sanitize_settings' ) );
}
/**
* Sanitize the submitted plugin settings.
*
* @since 1.0.0
* @return array $output The setting values
*/
public function sanitize_settings() {
global $wpsl_settings, $wpsl_admin;
$ux_absints = array(
'height',
'infowindow_width',
'search_width',
'label_width'
);
$marker_effects = array(
'bounce',
'info_window',
'ignore'
);
$ux_checkboxes = array(
'new_window',
'reset_map',
'listing_below_no_scroll',
'direction_redirect',
'more_info',
'store_url',
'phone_url',
'marker_streetview',
'marker_zoom_to',
'mouse_focus',
'reset_map',
'show_contact_details',
'clickable_contact_details',
'hide_country',
'hide_distance'
);
/*
* If the provided server key is different then the existing value,
* then we test if it's valid by making a call to the Geocode API.
*/
if ( $_POST['wpsl_api']['server_key'] && $wpsl_settings['api_server_key'] != $_POST['wpsl_api']['server_key'] || !get_option( 'wpsl_valid_server_key' ) ) {
$server_key = sanitize_text_field( $_POST['wpsl_api']['server_key'] );
$this->validate_server_key( $server_key );
}
$output['api_server_key'] = sanitize_text_field( $_POST['wpsl_api']['server_key'] );
$output['api_browser_key'] = sanitize_text_field( $_POST['wpsl_api']['browser_key'] );
$output['api_language'] = wp_filter_nohtml_kses( $_POST['wpsl_api']['language'] );
$output['api_region'] = wp_filter_nohtml_kses( $_POST['wpsl_api']['region'] );
$output['api_geocode_component'] = isset( $_POST['wpsl_api']['geocode_component'] ) ? 1 : 0;
// Check the search filter.
$output['autocomplete'] = isset( $_POST['wpsl_search']['autocomplete'] ) ? 1 : 0;
$output['results_dropdown'] = isset( $_POST['wpsl_search']['results_dropdown'] ) ? 1 : 0;
$output['radius_dropdown'] = isset( $_POST['wpsl_search']['radius_dropdown'] ) ? 1 : 0;
$output['category_filter'] = isset( $_POST['wpsl_search']['category_filter'] ) ? 1 : 0;
$output['category_filter_type'] = ( $_POST['wpsl_search']['category_filter_type'] == 'dropdown' ) ? 'dropdown' : 'checkboxes';
$output['distance_unit'] = ( $_POST['wpsl_search']['distance_unit'] == 'km' ) ? 'km' : 'mi';
// Check for a valid max results value, otherwise we use the default.
if ( !empty( $_POST['wpsl_search']['max_results'] ) ) {
$output['max_results'] = sanitize_text_field( $_POST['wpsl_search']['max_results'] );
} else {
$this->settings_error( 'max_results' );
$output['max_results'] = wpsl_get_default_setting( 'max_results' );
}
// See if a search radius value exist, otherwise we use the default.
if ( !empty( $_POST['wpsl_search']['radius'] ) ) {
$output['search_radius'] = sanitize_text_field( $_POST['wpsl_search']['radius'] );
} else {
$this->settings_error( 'search_radius' );
$output['search_radius'] = wpsl_get_default_setting( 'search_radius' );
}
$output['force_postalcode'] = isset( $_POST['wpsl_search']['force_postalcode'] ) ? 1 : 0;
// Check if we have a valid zoom level, it has to be between 1 or 12. If not set it to the default of 3.
$output['zoom_level'] = wpsl_valid_zoom_level( $_POST['wpsl_map']['zoom_level'] );
// Check for a valid max auto zoom level.
$max_zoom_levels = wpsl_get_max_zoom_levels();
if ( in_array( absint( $_POST['wpsl_map']['max_auto_zoom'] ), $max_zoom_levels ) ) {
$output['auto_zoom_level'] = $_POST['wpsl_map']['max_auto_zoom'];
} else {
$output['auto_zoom_level'] = wpsl_get_default_setting( 'auto_zoom_level' );
}
if ( isset( $_POST['wpsl_map']['start_name'] ) ) {
$output['start_name'] = sanitize_text_field( $_POST['wpsl_map']['start_name'] );
} else {
$output['start_name'] = '';
}
// If no location name is then we also empty the latlng values from the hidden input field.
if ( empty( $output['start_name'] ) ) {
$this->settings_error( 'start_point' );
$output['start_latlng'] = '';
} else {
/*
* If the start latlng is empty, but a start location name is provided,
* then make a request to the Geocode API to get it.
*
* This can only happen if there is a JS error in the admin area that breaks the
* Google Maps Autocomplete. So this code is only used as fallback to make sure
* the provided start location is always geocoded.
*/
if ( $wpsl_settings['start_name'] != $_POST['wpsl_map']['start_name']
&& $wpsl_settings['start_latlng'] == $_POST['wpsl_map']['start_latlng']
|| empty( $_POST['wpsl_map']['start_latlng'] ) ) {
$start_latlng = wpsl_get_address_latlng( $_POST['wpsl_map']['start_name'] );
} else {
$start_latlng = sanitize_text_field( $_POST['wpsl_map']['start_latlng'] );
}
$output['start_latlng'] = $start_latlng;
}
// Do we need to run the fitBounds function make the markers fit in the viewport?
$output['run_fitbounds'] = isset( $_POST['wpsl_map']['run_fitbounds'] ) ? 1 : 0;
// Check if we have a valid map type.
$output['map_type'] = wpsl_valid_map_type( $_POST['wpsl_map']['type'] );
$output['auto_locate'] = isset( $_POST['wpsl_map']['auto_locate'] ) ? 1 : 0;
$output['autoload'] = isset( $_POST['wpsl_map']['autoload'] ) ? 1 : 0;
// Make sure the auto load limit is either empty or an int.
if ( empty( $_POST['wpsl_map']['autoload_limit'] ) ) {
$output['autoload_limit'] = '';
} else {
$output['autoload_limit'] = absint( $_POST['wpsl_map']['autoload_limit'] );
}
$output['streetview'] = isset( $_POST['wpsl_map']['streetview'] ) ? 1 : 0;
$output['type_control'] = isset( $_POST['wpsl_map']['type_control'] ) ? 1 : 0;
$output['scrollwheel'] = isset( $_POST['wpsl_map']['scrollwheel'] ) ? 1 : 0;
$output['control_position'] = ( $_POST['wpsl_map']['control_position'] == 'left' ) ? 'left' : 'right';
$output['map_style'] = json_encode( strip_tags( trim( $_POST['wpsl_map']['map_style'] ) ) );
// Make sure we have a valid template ID.
if ( isset( $_POST['wpsl_ux']['template_id'] ) && ( $_POST['wpsl_ux']['template_id'] ) ) {
$output['template_id'] = sanitize_text_field( $_POST['wpsl_ux']['template_id'] );
} else {
$output['template_id'] = wpsl_get_default_setting( 'template_id' );
}
$output['marker_clusters'] = isset( $_POST['wpsl_map']['marker_clusters'] ) ? 1 : 0;
// Check for a valid cluster zoom value.
if ( in_array( $_POST['wpsl_map']['cluster_zoom'], $this->get_default_cluster_option( 'cluster_zoom' ) ) ) {
$output['cluster_zoom'] = $_POST['wpsl_map']['cluster_zoom'];
} else {
$output['cluster_zoom'] = wpsl_get_default_setting( 'cluster_zoom' );
}
// Check for a valid cluster size value.
if ( in_array( $_POST['wpsl_map']['cluster_size'], $this->get_default_cluster_option( 'cluster_size' ) ) ) {
$output['cluster_size'] = $_POST['wpsl_map']['cluster_size'];
} else {
$output['cluster_size'] = wpsl_get_default_setting( 'cluster_size' );
}
/*
* Make sure all the ux related fields that should contain an int, actually are an int.
* Otherwise we use the default value.
*/
foreach ( $ux_absints as $ux_key ) {
if ( absint( $_POST['wpsl_ux'][$ux_key] ) ) {
$output[$ux_key] = $_POST['wpsl_ux'][$ux_key];
} else {
$output[$ux_key] = wpsl_get_default_setting( $ux_key );
}
}
// Check if the ux checkboxes are checked.
foreach ( $ux_checkboxes as $ux_key ) {
$output[$ux_key] = isset( $_POST['wpsl_ux'][$ux_key] ) ? 1 : 0;
}
// Check if we have a valid marker effect.
if ( in_array( $_POST['wpsl_ux']['marker_effect'], $marker_effects ) ) {
$output['marker_effect'] = $_POST['wpsl_ux']['marker_effect'];
} else {
$output['marker_effect'] = wpsl_get_default_setting( 'marker_effect' );
}
// Check if we have a valid address format.
if ( array_key_exists( $_POST['wpsl_ux']['address_format'], wpsl_get_address_formats() ) ) {
$output['address_format'] = $_POST['wpsl_ux']['address_format'];
} else {
$output['address_format'] = wpsl_get_default_setting( 'address_format' );
}
$output['more_info_location'] = ( $_POST['wpsl_ux']['more_info_location'] == 'store listings' ) ? 'store listings' : 'info window';
$output['infowindow_style'] = isset( $_POST['wpsl_ux']['infowindow_style'] ) ? 'default' : 'infobox';
$output['start_marker'] = wp_filter_nohtml_kses( $_POST['wpsl_map']['start_marker'] );
$output['store_marker'] = wp_filter_nohtml_kses( $_POST['wpsl_map']['store_marker'] );
$output['editor_country'] = sanitize_text_field( $_POST['wpsl_editor']['default_country'] );
$output['editor_map_type'] = wpsl_valid_map_type( $_POST['wpsl_editor']['map_type'] );
$output['hide_hours'] = isset( $_POST['wpsl_editor']['hide_hours'] ) ? 1 : 0;
if ( isset( $_POST['wpsl_editor']['hour_input'] ) ) {
$output['editor_hour_input'] = ( $_POST['wpsl_editor']['hour_input'] == 'textarea' ) ? 'textarea' : 'dropdown';
} else {
$output['editor_hour_input'] = 'dropdown';
}
$output['editor_hour_format'] = ( $_POST['wpsl_editor']['hour_format'] == 12 ) ? 12 : 24;
// The default opening hours.
if ( isset( $_POST['wpsl_editor']['textarea'] ) ) {
$output['editor_hours']['textarea'] = wp_kses_post( trim( stripslashes( $_POST['wpsl_editor']['textarea'] ) ) );
}
$output['editor_hours']['dropdown'] = $wpsl_admin->metaboxes->format_opening_hours();
array_walk_recursive( $output['editor_hours']['dropdown'], 'wpsl_sanitize_multi_array' );
// Permalink and taxonomy slug.
$output['permalinks'] = isset( $_POST['wpsl_permalinks']['active'] ) ? 1 : 0;
$output['permalink_remove_front'] = isset( $_POST['wpsl_permalinks']['remove_front'] ) ? 1 : 0;
if ( !empty( $_POST['wpsl_permalinks']['slug'] ) ) {
$output['permalink_slug'] = sanitize_text_field( $_POST['wpsl_permalinks']['slug'] );
} else {
$output['permalink_slug'] = wpsl_get_default_setting( 'permalink_slug' );
}
if ( !empty( $_POST['wpsl_permalinks']['category_slug'] ) ) {
$output['category_slug'] = sanitize_text_field( $_POST['wpsl_permalinks']['category_slug'] );
} else {
$output['category_slug'] = wpsl_get_default_setting( 'category_slug' );
}
$required_labels = wpsl_labels();
// Sanitize the labels.
foreach ( $required_labels as $label ) {
$output[$label.'_label'] = sanitize_text_field( $_POST['wpsl_label'][$label] );
}
$output['show_credits'] = isset( $_POST['wpsl_credits'] ) ? 1 : 0;
$output['debug'] = isset( $_POST['wpsl_tools']['debug'] ) ? 1 : 0;
$output['deregister_gmaps'] = isset( $_POST['wpsl_tools']['deregister_gmaps'] ) ? 1 : 0;
$output['delay_loading'] = isset( $_POST['wpsl_tools']['delay_loading'] ) ? 1 : 0;
// Check if we need to flush the permalinks.
$this->set_flush_rewrite_option( $output );
// Check if there is a reason to delete the autoload transient.
if ( $wpsl_settings['autoload'] ) {
$this->set_delete_transient_option( $output );
}
return $output;
}
/**
* Handle the AJAX call to validate the provided
* server key for the Google Maps API.
*
* @since 2.2.10
* @return void
*/
public function ajax_validate_server_key() {
if ( ( current_user_can( 'manage_wpsl_settings' ) ) && is_admin() && defined( 'DOING_AJAX' ) && DOING_AJAX ) {
$server_key = sanitize_text_field( $_GET['server_key'] );
if ( $server_key ) {
$this->validate_server_key( $server_key );
}
}
}
/**
* Check if the provided server key for
* the Google Maps API is valid.
*
* @since 2.2.10
* @param string $server_key The server key to validate
* @return json|void If the validation failed and AJAX is used, then json
*/
public function validate_server_key( $server_key ) {
global $wpsl_admin;
// Test the server key by making a request to the Geocode API.
$address = 'Manhattan, NY 10036, USA';
$url = 'https://maps.googleapis.com/maps/api/geocode/json?address=' . urlencode( $address ) .'&key=' . $server_key;
$response = wp_remote_get( $url );
if ( !is_wp_error( $response ) ) {
$response = json_decode( $response['body'], true );
// If the state is not OK, then there's a problem with the key.
if ( $response['status'] !== 'OK' ) {
$geocode_errors = $wpsl_admin->geocode->check_geocode_error_msg( $response, true );
$error_msg = sprintf( __( 'There\'s a problem with the provided %sserver key%s. %s' ), '', '', $geocode_errors );
update_option( 'wpsl_valid_server_key', 0 );
// If the server key input field has 'wpsl-validate-me' class on it, then it's validated with AJAX in the background.
if ( defined('DOING_AJAX' ) && DOING_AJAX ) {
$key_status = array(
'valid' => 0,
'msg' => $error_msg
);
wp_send_json( $key_status );
exit();
} else {
add_settings_error( 'setting-errors', esc_attr( 'server-key' ), $error_msg, 'error' );
}
} else {
update_option( 'wpsl_valid_server_key', 1 );
if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
$key_status = array(
'valid' => 1,
'msg' => __( 'No problems found with the server key.', 'wpsl' )
);
wp_send_json( $key_status );
exit();
}
}
}
}
/**
* Check if we need set the option that will be used to determine
* if we need to flush the permalinks once the setting page reloads.
*
* @since 2.0.0
* @param array $new_settings The submitted plugin settings
* @return void
*/
public function set_flush_rewrite_option( $new_settings ) {
global $wpsl_settings;
// The settings fields to check.
$fields = array( 'permalinks', 'permalink_slug', 'permalink_remove_front', 'category_slug' );
foreach ( $fields as $k => $field ) {
if ( $wpsl_settings[$field] != $new_settings[$field] ) {
update_option( 'wpsl_flush_rewrite', 1 );
break;
}
}
}
/**
* Check if we need set the option that is used to determine
* if we need to delete the autoload transient once the settings page reloads.
*
* @since 2.0.0
* @param array $new_settings The submitted plugin settings
* @return void
*/
public function set_delete_transient_option( $new_settings ) {
global $wpsl_settings;
// The options we need to check for changes.
$options = array(
'start_name',
'debug',
'autoload',
'autoload_limit',
'more_info',
'more_info_location',
'hide_hours',
'hide_distance',
'hide_country',
'show_contact_details'
);
foreach ( $options as $option_name ) {
if ( $wpsl_settings[$option_name] != $new_settings[$option_name] ) {
update_option( 'wpsl_delete_transient', 1 );
break;
}
}
}
/**
* Check if the permalinks settings changed.
*
* @since 2.0.0
* @return void
*/
public function maybe_flush_rewrite_and_transient() {
global $wpsl_admin;
if ( isset( $_GET['page'] ) && ( $_GET['page'] == 'wpsl_settings' ) ) {
$flush_rewrite = get_option( 'wpsl_flush_rewrite' );
$delete_transient = get_option( 'wpsl_delete_transient' );
if ( $flush_rewrite ) {
flush_rewrite_rules();
update_option( 'wpsl_flush_rewrite', 0 );
}
if ( $delete_transient ) {
update_option( 'wpsl_delete_transient', 0 );
}
if ( $flush_rewrite || $delete_transient ) {
$wpsl_admin->delete_autoload_transient();
}
}
}
/**
* Handle the different validation errors for the plugin settings.
*
* @since 1.0.0
* @param string $error_type Contains the type of validation error that occured
* @return void
*/
private function settings_error( $error_type ) {
switch ( $error_type ) {
case 'max_results':
$error_msg = __( 'The max results field cannot be empty, the default value has been restored.', 'wpsl' );
break;
case 'search_radius':
$error_msg = __( 'The search radius field cannot be empty, the default value has been restored.', 'wpsl' );
break;
case 'start_point':
$error_msg = sprintf( __( 'Please provide the name of a city or country that can be used as a starting point under "Map Settings". %s This will only be used if auto-locating the user fails, or the option itself is disabled.', 'wpsl' ), '