WordPress at a glance
class is not described

WP_Super_Cache_Rest_Update_Settings{} WPSCache 1.0

No Hooks.

Return

Null. Nothing.

Usage

$WP_Super_Cache_Rest_Update_Settings = new WP_Super_Cache_Rest_Update_Settings();
// use class methods

Methods

  1. callback( $request )
  2. new_direct_page( $value )
  3. restore_default_settings( $parameters )
  4. save_preload_settings()
  5. save_time_settings( $parameters )
  6. set_cache_acceptable_files( $value )
  7. set_cache_compression( $value )
  8. set_cache_direct_pages( $list )
  9. set_cache_enabled( $value )
  10. set_cache_rejected_uri( $value )
  11. set_cache_rejected_user_agent( $value )
  12. set_debug_settings( $parameters )
  13. set_global( $global_name, $value )
  14. set_lock_down( $value )
  15. set_ossdl_cname( $value )
  16. set_ossdl_https( $value )
  17. set_ossdl_off_blog_url( $value )
  18. set_ossdl_off_cdn_url( $value )
  19. set_ossdl_off_exclude( $value )
  20. set_ossdl_off_include_dirs( $value )
  21. set_ossdlcdn( $value )
  22. set_preload_setting( $value, $name )
  23. set_super_cache_enabled( $value )
  24. set_time_setting( $value, $name )
  25. set_value_by_key( $value, $key )
  26. set_wp_cache_location( $value )
  27. set_wp_cache_make_known_anon( $value )
  28. set_wp_cache_not_logged_in( $value )
  29. set_wp_cache_object_cache( $value )
  30. set_wp_cache_pages( $cache_pages )
  31. toggle_easy_caching( $enabled = true )

Code of WP_Super_Cache_Rest_Update_Settings{} WPSCache 1.7.1

<?php
class WP_Super_Cache_Rest_Update_Settings extends WP_REST_Controller {

	/**
	 * Update the cache settings.
	 *
	 * @param WP_REST_Request $request Full data about the request.
	 *
	 * @return WP_Error|WP_REST_Response
	 */
	public function callback( $request ) {
		$parameters = $request->get_json_params();

		// Override to force locking.
		if ( defined( 'WPSC_DISABLE_LOCKING' ) ) {
			$parameters['cache_disable_locking'] = 1;
		}

		// Set the nonce to valid, so that form sets will work later.
		global $valid_nonce;
		$valid_nonce = true;

		$errors = array();

		if ( isset( $parameters['easy'] ) ) {
			$errors = $this->toggle_easy_caching( $parameters['easy'] );

		} elseif ( isset( $parameters[ 'reset' ] ) ) {
			$errors = $this->restore_default_settings( $parameters );

		} else {

			foreach ( $parameters as $name => $value ) {
				$has_error = $this->set_value_by_key( $value, $name );

				if ( false == is_numeric( $has_error ) && false == is_bool( $has_error ) ) {
					$errors[] = $has_error;
				}
			}

			$this->save_time_settings( $parameters );
			$this->save_preload_settings();
			$this->set_debug_settings( $parameters );
		}

		if ( ! empty( $errors ) ) {
			return rest_ensure_response( $errors );

		} else {
			$get_settings = new WP_Super_Cache_Rest_Get_Settings();
			return $get_settings->callback( $request );
		}
	}

	/**
	 * Given a key and a value, set the value for that key, based on
	 * the configuration in the settings map.
	 *
	 * @param mixed $value
	 * @param string $key
	 *
	 * @return string|null
	 */
	protected function set_value_by_key( $value, $key ) {

		$settings_map = WP_Super_Cache_Settings_Map::$map;

		// If this parameter isn't in the map, then let's ignore it.
		if ( ! isset( $settings_map[ $key ] ) ) {
			return null;
		}

		$map = $settings_map[ $key ];

		if ( isset( $map['set'] ) ) {
			if ( method_exists( $this, $map['set'] ) ) {
				$has_error = call_user_func( array( $this, $map['set'] ), $value, $key );

			} elseif ( function_exists( $map['set'] ) ) {
				$has_error = call_user_func( $map['set'], $value );

			}
		} elseif ( isset( $map['global'] ) ) {

			$set_method = method_exists( $this, 'set_' . $map['global'] ) ?
				'set_' . $map['global'] : 'set_global';
			if ( $set_method == 'set_global' ) {
				$has_error  = call_user_func( array( $this, $set_method ), $key, $value );
			} else {
				$has_error  = call_user_func( array( $this, $set_method ), $value );
			}
		}

		if ( ! empty( $has_error ) ) {
			return $has_error;
		}

		return null;
	}

	/**
	 * A generic method for setting globals.
	 *
	 * The setting must be added to the whitelist in order to be set this way.
	 *
	 * @param string $global_name
	 * @param mixed $value
	 */
	protected function set_global( $global_name, $value ) {
		$whitelist = array(
			'wp_super_cache_late_init',
			'wp_cache_disable_utf8',
			'wp_cache_no_cache_for_get',
			'wp_supercache_304',
			'wp_cache_mfunc_enabled',
			'wp_cache_mobile_enabled',
			'wp_cache_front_page_checks',
			'wp_supercache_cache_list',
			'wp_cache_hello_world',
			'wp_cache_clear_on_post_edit',
			'cache_rebuild_files',
			'wp_cache_refresh_single_only',
			'wp_cache_mutex_disabled',
			'wpsc_save_headers',
		);

		if ( ! in_array( $global_name, $whitelist ) ) {
			return false;
		}

		wp_cache_setting( $global_name, (int)$value );

	}

	/**
	 * @param mixed $value
	 */
	protected function set_wp_cache_location( $value ) {
		global $cache_path;

		if ( $value != '' && ( ! isset( $cache_path ) || $value != $cache_path ) ) {
			$dir = realpath( trailingslashit( dirname( $value ) ) );
			if ( $dir == false ) {
				$dir = WP_CONTENT_DIR . '/cache/';

			} else {
				$dir = trailingslashit( $dir ) . trailingslashit( wpsc_deep_replace( array(
						'..',
						'\\'
					), basename( $value ) ) );
			}

			$new_cache_path = $dir;

		} else {
			$new_cache_path = WP_CONTENT_DIR . '/cache/';
		}

		if ( $new_cache_path != $cache_path ) {
			if ( file_exists( $new_cache_path ) == false ) {
				rename( $cache_path, $new_cache_path );
			}

			$cache_path = $new_cache_path;
			wp_cache_setting( 'cache_path', $cache_path );
		}
	}

	/**
	 * @param mixed $value
	 */
	protected function set_cache_enabled( $value ) {
		if ( $value != 1 ) {
			wp_cache_disable();

			return;
		}

		wp_cache_enable();
	}

	/**
	 * @param mixed $value
	 */
	protected function set_lock_down( $value ) {
		$_POST[ 'wp_lock_down' ] = (int)$value;
		wp_update_lock_down();
	}

	/**
	 * @param mixed $value
	 */
	protected function set_super_cache_enabled( $value ) {
		global $wp_cache_mod_rewrite;

		if ( is_numeric( $value ) == false ) {
			$types = array( 'wpcache' => 0, 'mod_rewrite' => 1, 'PHP' => 2 );
			if ( isset( $types[ $value ] ) ) {
				$value = $types[ $value ];
			} else {
				return false;
			}
		}

		if ( $value === 0 ) { // WPCache
			wp_super_cache_disable();

		} else {
			wp_super_cache_enable();
			$wp_cache_mod_rewrite = 0; // PHP recommended

			if ( $value == 1 ) { // mod_rewrite
				$wp_cache_mod_rewrite = 1;
				add_mod_rewrite_rules();

			} elseif( $value == 2 ) { // PHP
				$wp_cache_mod_rewrite = 0;
				remove_mod_rewrite_rules();

			}

			wp_cache_setting( 'wp_cache_mod_rewrite', $wp_cache_mod_rewrite );
		}
		return true;
	}

	/**
	 * @param mixed $value
	 */
	protected function set_wp_cache_not_logged_in( $value ) {
		global $wp_cache_not_logged_in, $cache_path;

		if ( 0 != $value ) {
			if ( 0 == $wp_cache_not_logged_in && function_exists( 'prune_super_cache' ) ) {
				prune_super_cache( $cache_path, true );
			}

			$wp_cache_not_logged_in = (int) $value;

		} else {
			$wp_cache_not_logged_in = 0;
		}

		wp_cache_setting( 'wp_cache_not_logged_in', $wp_cache_not_logged_in );
	}

	/**
	 * @param mixed $value
	 */
	protected function set_wp_cache_make_known_anon( $value ) {
		global $wp_cache_make_known_anon, $cache_path;

		if ( 1 == $value ) {
			if ( $wp_cache_make_known_anon == 0 && function_exists( 'prune_super_cache' ) ) {
				prune_super_cache( $cache_path, true );
			}

			$wp_cache_make_known_anon = 1;

		} else {
			$wp_cache_make_known_anon = 0;
		}

		wp_cache_setting( 'wp_cache_make_known_anon', $wp_cache_make_known_anon );
	}

	/**
	 * @param mixed $value
	 */
	protected function set_wp_cache_object_cache( $value ) {
		global $_wp_using_ext_object_cache, $wp_cache_object_cache, $cache_path;

		if ( ! $_wp_using_ext_object_cache ) {
			return;
		}

		if ( $value == 0 ) {
			if ( function_exists( 'prune_super_cache' ) ) {
				prune_super_cache( $cache_path, true );
			}

			$wp_cache_object_cache = 1;

		} else {
			$wp_cache_object_cache = 0;
		}

		wp_cache_setting( 'wp_cache_object_cache', $wp_cache_object_cache );
	}

	/**
	 * @param mixed $value
	 *
	 * @return null|string
	 */
	protected function set_cache_compression( $value ) {
		global $cache_compression, $cache_path;

		$new_cache_compression = 0;
		if ( defined( 'WPSC_DISABLE_COMPRESSION' ) ) {
			$cache_compression = 0;
			wp_cache_setting( 'cache_compression', $cache_compression );

		} else {
			if ( 1 == $value ) {
				$new_cache_compression = 1;
			}

			if ( 1 == ini_get( 'zlib.output_compression' ) || "on" == strtolower( ini_get( 'zlib.output_compression' ) ) ) {
				return __( "You attempted to enable compression but `zlib.output_compression` is enabled. See #21 in the Troubleshooting section of the readme file.", 'wp-super-cache' );
			}

			if ( $new_cache_compression != $cache_compression ) {
				$cache_compression = $new_cache_compression;
				wp_cache_setting( 'cache_compression', $cache_compression );
				if ( function_exists( 'prune_super_cache' ) ) {
					prune_super_cache( $cache_path, true );
				}

				delete_option( 'super_cache_meta' );
			}
		}

		return null;
	}

	/**
	 * @param array $cache_pages
	 */
	protected function set_wp_cache_pages( $cache_pages ) {
		if ( ! is_array( $cache_pages ) ) {
			return;
		}

		$_POST['wp_edit_rejected_pages'] = 1;

		foreach ( $cache_pages as $page => $value ) {
			if ( $value ) {
				$_POST['wp_cache_pages'][ $page ] = 1;
			}
		}

		wp_cache_update_rejected_pages();
	}

	/**
	 * @param mixed $value
	 */
	protected function set_cache_rejected_uri( $value ) {
		$_REQUEST['wp_rejected_uri'] = implode( "\n", $value );
		wp_cache_update_rejected_strings();
	}

	/**
	 * @param mixed $value
	 */
	protected function set_cache_acceptable_files( $value ) {
		$_REQUEST['wp_accepted_files'] = implode( "\n", $value );
		wp_cache_update_accepted_strings();
	}

	/**
	 * @param mixed $value
	 */
	protected function set_cache_rejected_user_agent( $value ) {
		$_POST['wp_rejected_user_agent'] = implode( "\n", $value );
		wp_cache_update_rejected_ua();
	}

	/**
	 * @param mixed $value
	 */
	protected function set_ossdl_cname( $value ) {
		update_option( 'ossdl_cname', $value );
	}

	/**
	 * @param mixed $value
	 */
	protected function set_ossdl_off_blog_url( $value ) {
		update_option( 'ossdl_off_blog_url', untrailingslashit( $value ) );
	}

	/**
	 * @param mixed $value
	 */
	protected function set_ossdl_off_cdn_url( $value ) {
		update_option( 'ossdl_off_cdn_url', $value );
	}

	/**
	 * @param mixed $value
	 */
	protected function set_ossdl_off_include_dirs( $value ) {
		update_option( 'ossdl_off_include_dirs', $value == '' ? 'wp-content,wp-includes' : $value );
	}

	/**
	 * @param mixed $value
	 */
	protected function set_ossdl_off_exclude( $value ) {
		update_option( 'ossdl_off_exclude', $value );
	}

	/**
	 * @param mixed $value
	 */
	protected function set_ossdl_https( $value ) {
		update_option( 'ossdl_https', $value ? 1 : 0 );
	}

	/**
	 * @param mixed $value
	 */
	protected function set_ossdlcdn( $value ) {
		global $wp_cache_config_file;

		$ossdlcdn = $value ? 1 : 0;
		wp_cache_replace_line( '^ *\$ossdlcdn', "\$ossdlcdn = $ossdlcdn;", $wp_cache_config_file );
	}

	/**
	 * @param mixed $value
	 * @param string $name
	 */
	protected function set_time_setting( $value, $name ) {
		$_POST[ $name ]         = $value;
		$_POST['_time_setting'] = true;
	}

	/**
	 * @param mixed $value
	 * @param string $name
	 */
	protected function set_preload_setting( $value, $name ) {
		$_POST[ $name ]            = $value;
		$_POST['_preload_setting'] = true;
	}

	/**
	 * Easy caching is a mode that allows the user to press one button and
	 * enable a sensible default of settings.
	 *
	 * @param bool $enabled
	 */
	protected function toggle_easy_caching( $enabled = true ) {
		global $cache_path, $wp_cache_shutdown_gc, $cache_schedule_type;
		if ( $enabled ) {
			$settings = array(
				'wp_cache_mobile_enabled' => 1,
				'is_cache_enabled'        => 1,
				'cache_rebuild_files'     => 1,
				'cache_compression'       => 0,
				'wp_cache_not_logged_in'  => 2,
			);
			wp_cache_enable();
			if ( ! defined( 'DISABLE_SUPERCACHE' ) ) {
				wp_cache_debug( 'DISABLE_SUPERCACHE is not set, super_cache enabled.' );
				wp_super_cache_enable();
			}
			wpsc_set_default_gc();

		} else {
			wp_cache_disable();
			$settings = array( 'is_cache_enabled' => 0 );
			wp_clear_scheduled_hook( 'wp_cache_check_site_hook' );
			wp_clear_scheduled_hook( 'wp_cache_gc' );
			wp_clear_scheduled_hook( 'wp_cache_gc_watcher' );
		}

		foreach ( $settings as $key => $value ) {
			$this->set_value_by_key( $value, $key );
		}

		if ( $cache_path != WP_CONTENT_DIR . '/cache/' ) {
			$this->set_value_by_key( $cache_path, 'wp_cache_location' );
		}

		$advanced_settings = array(
			'wp_super_cache_late_init',
			'wp_cache_disable_utf8',
			'wp_cache_no_cache_for_get',
			'wp_supercache_304',
			'wp_cache_mfunc_enabled',
			'wp_cache_mobile_enabled',
			'wp_cache_front_page_checks',
			'wp_supercache_cache_list',
			'wp_cache_hello_world',
			'wp_cache_clear_on_post_edit',
			'wp_cache_make_known_anon',
			'wp_cache_object_cache',
			'wp_cache_refresh_single_only',
			'cache_compression',
			'wp_cache_mutex_disabled'
		);

		foreach ( $advanced_settings as $setting ) {
			$value = ( isset( $GLOBALS[ $setting ] ) && $GLOBALS[ $setting ] == 1 ) ? 1 : 0;
			$this->set_value_by_key( $value, $setting );
		}
	}

	/**
	 * Runs at the end and saves the time settings.
	 */
	protected function save_time_settings( $parameters ) {
		if ( ! isset( $_POST['_time_setting'] ) || true !== $_POST['_time_setting'] ) {
			return;
		}

		$_POST['action'] = 'expirytime';

		$all_time_settings = array(
			'cache_max_time',
			'cache_schedule_type',
			'cache_scheduled_time',
			'cache_schedule_interval',
			'cache_time_interval',
			'cache_gc_email_me'
		);

		foreach ( $all_time_settings as $time_setting ) {
			if ( false == isset( $_POST[ $time_setting ] ) || $GLOBALS[ $time_setting ] == $_POST[ $time_setting ] ) {
				$_POST[ $time_setting ] = $GLOBALS[ $time_setting ]; // fill in the potentially missing fields before updating GC settings.
			}
		}

		if ( isset( $parameters['cache_gc_email_me'] ) && $parameters['cache_gc_email_me'] == 0 ) {
			unset( $_POST['cache_gc_email_me'] );
		}
		$_POST[ 'wp_max_time' ] = $_POST[ 'cache_max_time' ];

		wp_cache_time_update();
	}


	/**
	 * set the cached direct pages list.
	 */
	protected function set_cache_direct_pages( $list ) {
		if ( is_array( $list ) == false ) {
			return false;
		}

		$_POST[ 'direct_pages' ] = $list;
		wpsc_update_direct_pages();
	}

	/**
	 * add an entry to the cached direct pages list.
	 */
	protected function new_direct_page( $value ) {
		global $cached_direct_pages;

		if ( isset( $_POST[ 'direct_pages' ] ) == false ) {
			$_POST[ 'direct_pages' ] = $cached_direct_pages;
		}

		$_POST[ 'new_direct_page' ] = $value;
		wpsc_update_direct_pages();
	}

	/**
	 * Runs at the end and saves the preload settings.
	 */
	protected function save_preload_settings() {
		if ( ! isset( $_POST['_preload_setting'] ) || true !== $_POST['_preload_setting'] ) {
			return;
		}

		$_POST['action'] = 'preload';

		$all_preload_settings = array(
			'preload_interval'     => 'wp_cache_preload_interval',
			'preload_on'           => 'wp_cache_preload_on',
			'preload_taxonomies'   => 'wp_cache_preload_taxonomies',
			'preload_email_volume' => 'wp_cache_preload_email_volume',
			'preload_posts'        => 'wp_cache_preload_posts',
		);

		foreach ( $all_preload_settings as $key => $original ) {
			if ( ! isset( $_POST[ $key ] ) ) {
				$_POST[ $original ] = $GLOBALS[ $original ];
			} else {
				$_POST[ $original ] = $_POST[ $key ];
				if ( $key !== 'preload_interval' && ( $_POST[ $key ] === 0 || $_POST[ $key ] === false ) ) {
					unset( $_POST[ $original ] );
				}

			}
		}

		wpsc_preload_settings();
	}

	/*
	 * Delete the plugin configuration file and restore the sample one.
	 */
	protected function restore_default_settings( $parameters ) {
		global $wp_cache_config_file, $wp_cache_config_file_sample;

		if ( file_exists( $wp_cache_config_file_sample ) ) {
			copy( $wp_cache_config_file_sample, $wp_cache_config_file );
			$cache_page_secret = md5( date( 'H:i:s' ) . mt_rand() );
			wp_cache_setting( 'cache_page_secret', $cache_page_secret );

			if ( function_exists( "opcache_invalidate" ) ) {
				@opcache_invalidate( $wp_cache_config_file );
			}
		}
		wpsc_set_default_gc( true );

	}

	/**
	 * Update the debug settings.
	 *
	 * @param WP_REST_Request $request Full data about the request.
	 * @return WP_Error|WP_REST_Response
	 */
	public function set_debug_settings( $parameters ) {

		$settings = array (
			'wp_super_cache_debug',
			'wp_cache_debug_ip',
			'wp_super_cache_comments',
			'wp_super_cache_front_page_check',
			'wp_super_cache_front_page_clear',
			'wp_super_cache_front_page_text',
			'wp_super_cache_front_page_notification',
			'wpsc_delete_log',
		);

		foreach( $settings as $setting ) {
			if ( isset( $parameters[ $setting ] ) ) {
				if ( $parameters[ $setting ] != false ) {
					$_POST[ $setting ] = $parameters[ $setting ];
				}
				$_POST[ 'wp_cache_debug' ] = 1;
			} else {
				if ( ! isset( $GLOBALS[ $setting ] ) ) {
					$GLOBALS[ $setting ] = 0;
				}
				$_POST[ $setting ] = $GLOBALS[ $setting ];
			}
		}
		global $valid_nonce;
		$valid_nonce = true;

		$settings = wpsc_update_debug_settings();
	}
}