Root_Environment.php

<?php
/**
 * File: Root_Environment.php
 *
 * @package W3TC
 */

namespace W3TC;

/**
 * Class Root_Environment
 *
 * phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter
 */
class Root_Environment {
	/**
	 * Fixes the environment configuration in the WordPress admin panel.
	 *
	 * @param Config $config           W3TC Config containing relevant settings.
	 * @param bool   $force_all_checks Whether to force all environment checks.
	 *
	 * @return void
	 *
	 * @throws Util_Environment_Exceptions If one or more handlers fail during the fix process.
	 */
	public function fix_in_wpadmin( $config, $force_all_checks = false ) {
		$exs          = new Util_Environment_Exceptions();
		$fix_on_event = false;
		if ( Util_Environment::is_wpmu() && Util_Environment::blog_id() !== 0 ) {
			$md5_string = $config->get_md5();
			if ( get_transient( 'w3tc_config_changes' ) !== $md5_string ) {
				$fix_on_event = true;
				set_transient( 'w3tc_config_changes', $md5_string, 3600 );
			}
		}

		// call plugin-related handlers.
		foreach ( $this->get_handlers() as $h ) {
			try {
				$h->fix_on_wpadmin_request( $config, $force_all_checks );
				if ( $fix_on_event ) {
					$this->fix_on_event( $config, 'admin_request' );
				}
			} catch ( Util_Environment_Exceptions $ex ) {
				$exs->push( $ex );
			}
		}

		try {
			do_action( 'w3tc_environment_fix_on_wpadmin_request', $config, $force_all_checks );
		} catch ( Util_Environment_Exceptions $ex ) {
			$exs->push( $ex );
		}

		if ( count( $exs->exceptions() ) > 0 ) {
			throw $exs;
		}
	}

	/**
	 * Fixes the environment configuration based on specific events.
	 *
	 * @param Config      $config     W3TC Config containing relevant settings.
	 * @param string      $event      Name of the triggering event.
	 * @param Config|null $old_config Optional old W3TC Config object for comparison.
	 *
	 * @return void
	 *
	 * @throws Util_Environment_Exceptions If one or more handlers fail during the fix process.
	 */
	public function fix_on_event( $config, $event, $old_config = null ) {
		$exs = new Util_Environment_Exceptions();

		// call plugin-related handlers.
		foreach ( $this->get_handlers() as $h ) {
			try {
				$h->fix_on_event( $config, $event );
			} catch ( Util_Environment_Exceptions $ex ) {
				$exs->push( $ex );
			}
		}

		try {
			do_action( 'w3tc_environment_fix_on_event', $config, $event );
		} catch ( Util_Environment_Exceptions $ex ) {
			$exs->push( $ex );
		}

		if ( count( $exs->exceptions() ) > 0 ) {
			throw $exs;
		}
	}

	/**
	 * Fixes the environment configuration after deactivation.
	 *
	 * @return void
	 *
	 * @throws Util_Environment_Exceptions If one or more handlers fail during the fix process.
	 */
	public function fix_after_deactivation() {
		$exs = new Util_Environment_Exceptions();

		// call plugin-related handlers.
		foreach ( $this->get_handlers() as $h ) {
			try {
				$h->fix_after_deactivation();
			} catch ( Util_Environment_Exceptions $ex ) {
				$exs->push( $ex );
			}
		}

		try {
			do_action( 'w3tc_environment_fix_after_deactivation' );
		} catch ( Util_Environment_Exceptions $ex ) {
			$exs->push( $ex );
		}

		if ( count( $exs->exceptions() ) > 0 ) {
			throw $exs;
		}
	}

	/**
	 * Retrieves the rules required for the environment configuration.
	 *
	 * @param Config $config W3TC Config containing relevant settings.
	 *
	 * @return array Array of descriptors for required rewrite rules.
	 */
	public function get_required_rules( $config ) {
		$required_rules = array();
		foreach ( $this->get_handlers() as $h ) {
			if ( method_exists( $h, 'get_required_rules' ) ) {
				$required_rules_current = $h->get_required_rules( $config );

				if ( ! is_null( $required_rules_current ) ) {
					$required_rules = array_merge( $required_rules, $required_rules_current );
				}
			}
		}

		$required_rules = apply_filters( 'w3tc_environment_get_required_rules', $required_rules, $config );

		$rewrite_rules_descriptors = array();

		foreach ( $required_rules as $descriptor ) {
			$filename = $descriptor['filename'];

			if ( isset( $rewrite_rules_descriptors[ $filename ] ) ) {
				$content = $rewrite_rules_descriptors[ $filename ]['content'];
			} else {
				$content = array();
			}

			if ( ! isset( $descriptor['position'] ) ) {
				$content[] = $descriptor['content'];
			} else {
				$position = $descriptor['position'];

				if ( isset( $content[ $position ] ) ) {
					$content[ $position ] .= $descriptor['content'];
				} else {
					$content[ $position ] = $descriptor['content'];
				}
			}

			$rewrite_rules_descriptors[ $filename ] = array(
				'filename' => $filename,
				'content'  => $content,
			);
		}

		$rewrite_rules_descriptors_out = array();
		foreach ( $rewrite_rules_descriptors as $filename => $descriptor ) {
			$rewrite_rules_descriptors_out[ $filename ] = array(
				'filename' => $filename,
				'content'  => implode( '', $descriptor['content'] ),
			);
		}

		ksort( $rewrite_rules_descriptors_out );

		return $rewrite_rules_descriptors_out;
	}

	/**
	 * Retrieves the list of environment handlers.
	 *
	 * @return array Array of handler objects for managing environment configurations.
	 */
	private function get_handlers() {
		$a = array(
			new Generic_Environment(),
			new Minify_Environment(),
			new PgCache_Environment(),
			new BrowserCache_Environment(),
			new ObjectCache_Environment(),
			new DbCache_Environment(),
			new Cdn_Environment(),
			new Extension_ImageService_Environment(),
			new Extension_AlwaysCached_Environment(),
		);

		return $a;
	}

	/**
	 * Retrieves additional instructions for the environment configuration.
	 *
	 * @param Config $config W3TC Config containing relevant settings.
	 *
	 * @return array Array of descriptors for additional instructions, grouped by area.
	 */
	public function get_other_instructions( $config ) {
		$instructions_descriptors = array();

		foreach ( $this->get_handlers() as $h ) {
			if ( method_exists( $h, 'get_instructions' ) ) {
				$instructions = $h->get_instructions( $config );
				if ( ! is_null( $instructions ) ) {
					foreach ( $instructions as $descriptor ) {
						$area                                = $descriptor['area'];
						$instructions_descriptors[ $area ][] = array(
							'title'   => $descriptor['title'],
							'content' => $descriptor['content'],
						);
					}
				}
			}
		}

		return $instructions_descriptors;
	}

	/**
	 * Deletes all W3 Total Cache data from the database.
	 *
	 * phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery
	 * phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching
	 * phpcs:disable WordPress.PHP.DevelopmentFunctions.error_log_error_log
	 *
	 * @since 2.8.3
	 *
	 * @param Config $config W3TC Config containing relevant settings.
	 *
	 * @return void
	 */
	public static function delete_plugin_data( $config ) {
		global $wpdb;

		$license_key = $config->get_string( 'plugin.license_key' );
		if ( ! empty( $license_key ) ) {
			Licensing_Core::deactivate_license( $license_key );
		}

		// Define prefixes for options and transients.
		$prefixes = array(
			'w3tc_',                    // General options prefix.
			'w3tcps_',                  // Additional options prefix.
			'_transient_w3tc_',         // Transient prefix.
			'_transient_timeout_w3tc_', // Transient timeout prefix.
		);

		// Delete options and transients with defined prefixes.
		foreach ( $prefixes as $prefix ) {
			$query        = 'SELECT `option_name` FROM ' . $wpdb->options . ' WHERE `option_name` LIKE "' . $prefix . '%";';
			$option_names = $wpdb->get_col( $query ); // phpcs:ignore WordPress.DB.PreparedSQL

			foreach ( $option_names as $option_name ) {
				delete_option( $option_name );
			}
		}

		// Remove plugin-created directories.
		$directories = array(
			defined( 'W3TC_CACHE_DIR' ) ? W3TC_CACHE_DIR : WP_CONTENT_DIR . '/cache',
			defined( 'W3TC_CONFIG_DIR' ) ? W3TC_CONFIG_DIR : WP_CONTENT_DIR . '/w3tc-config',
		);

		foreach ( $directories as $dir ) {
			Util_File::rmdir( $dir );
		}
	}
}