we don't gzip, the web server does it. * False => we do it ourselves. * * @var bool */ private $nogzip; /** * Ctor. * * @param string $md5 Hash. * @param string $ext Extension. */ public function __construct( $md5, $ext = 'php' ) { $_min_ext = ''; if ( apply_filters( 'autoptimize_filter_cache_url_add_min_ext', false ) ) { $_min_ext = '.min'; } $this->cachedir = AUTOPTIMIZE_CACHE_DIR; $this->nogzip = AUTOPTIMIZE_CACHE_NOGZIP; if ( ! $this->nogzip ) { $this->filename = AUTOPTIMIZE_CACHEFILE_PREFIX . $md5 . $_min_ext . '.php'; } else { if ( in_array( $ext, array( 'js', 'css' ) ) ) { $this->filename = $ext . '/' . AUTOPTIMIZE_CACHEFILE_PREFIX . $md5 . $_min_ext . '.' . $ext; } else { $this->filename = AUTOPTIMIZE_CACHEFILE_PREFIX . $md5 . $_min_ext . '.' . $ext; } } } /** * Returns true if the cached file exists on disk. * * @return bool */ public function check() { return file_exists( $this->cachedir . $this->filename ); } /** * Returns cache contents if they exist, false otherwise. * * @return string|false */ public function retrieve() { if ( $this->check() ) { if ( false == $this->nogzip ) { return file_get_contents( $this->cachedir . $this->filename . '.none' ); } else { return file_get_contents( $this->cachedir . $this->filename ); } } return false; } /** * Stores given $data in cache. * * @param string $data Data to cache. * @param string $mime Mimetype. * * @return void */ public function cache( $data, $mime ) { // readonly FS explicitly OK'ed by developer, so just pretend all is OK. if ( defined( 'AUTOPTIMIZE_CACHE_READONLY' ) ) { return true; } // off by default; check if cachedirs exist every time before caching // // to be activated for users that experience these ugly errors; // PHP Warning: file_put_contents failed to open stream: No such file or directory. if ( apply_filters( 'autoptimize_filter_cache_checkdirs_on_write', false ) ) { $this->check_and_create_dirs(); } if ( false === $this->nogzip ) { // We handle gzipping ourselves. $file = 'default.php'; $phpcode = file_get_contents( AUTOPTIMIZE_PLUGIN_DIR . 'config/' . $file ); $phpcode = str_replace( array( '%%CONTENT%%', 'exit;' ), array( $mime, '' ), $phpcode ); file_put_contents( $this->cachedir . $this->filename, $phpcode ); file_put_contents( $this->cachedir . $this->filename . '.none', $data ); } else { // Write code to cache without doing anything else. file_put_contents( $this->cachedir . $this->filename, $data ); // save fallback .js or .css file if filter true (to be false by default) but not if snippet or single. if ( self::do_fallback() && strpos( $this->filename, '_snippet_' ) === false && strpos( $this->filename, '_single_' ) === false ) { $_extension = pathinfo( $this->filename, PATHINFO_EXTENSION ); $_fallback_file = AUTOPTIMIZE_CACHEFILE_PREFIX . 'fallback.' . $_extension; if ( ( 'css' === $_extension || 'js' === $_extension ) && ! file_exists( $this->cachedir . $_extension . '/' . $_fallback_file ) ) { file_put_contents( $this->cachedir . $_extension . '/' . $_fallback_file, $data ); } } if ( apply_filters( 'autoptimize_filter_cache_create_static_gzip', false ) ) { // Create an additional cached gzip file. file_put_contents( $this->cachedir . $this->filename . '.gz', gzencode( $data, 9, FORCE_GZIP ) ); // If PHP Brotli extension is installed, create an additional cached Brotli file. if ( function_exists( 'brotli_compress' ) ) { file_put_contents( $this->cachedir . $this->filename . '.br', brotli_compress( $data, 11, BROTLI_GENERIC ) ); } } } // Provide 3rd party action hook for every cache file that is created. // This hook can for example be used to inject a copy of the created cache file to a other domain. do_action( 'autoptimize_action_cache_file_created', $this->cachedir . $this->filename ); } /** * Get cache filename. * * @return string */ public function getname() { // NOTE: This could've maybe been a do_action() instead, however, // that ship has sailed. // The original idea here was to provide 3rd party code a hook so that // it can "listen" to all the complete autoptimized-urls that the page // will emit... Or something to that effect I think? apply_filters( 'autoptimize_filter_cache_getname', AUTOPTIMIZE_CACHE_URL . $this->filename ); return $this->filename; } /** * Returns true if given `$file` is considered a valid Autoptimize cache file, * false otherwise. * * @param string $dir Directory name (with a trailing slash). * @param string $file Filename. * @return bool */ protected static function is_valid_cache_file( $dir, $file ) { if ( '.' !== $file && '..' !== $file && false !== strpos( $file, AUTOPTIMIZE_CACHEFILE_PREFIX ) && is_file( $dir . $file ) ) { // It's a valid file! return true; } // Everything else is considered invalid! return false; } /** * Clears contents of AUTOPTIMIZE_CACHE_DIR. * * @return void */ protected static function clear_cache_classic() { $contents = self::get_cache_contents(); foreach ( $contents as $name => $files ) { $dir = rtrim( AUTOPTIMIZE_CACHE_DIR . $name, '/' ) . '/'; foreach ( $files as $file ) { if ( self::is_valid_cache_file( $dir, $file ) ) { @unlink( $dir . $file ); // @codingStandardsIgnoreLine } } } @unlink( AUTOPTIMIZE_CACHE_DIR . '/.htaccess' ); // @codingStandardsIgnoreLine } /** * Recursively deletes the specified pathname (file/directory) if possible. * Returns true on success, false otherwise. * * @param string $pathname Pathname to remove. * * @return bool */ protected static function rmdir( $pathname ) { $files = self::get_dir_contents( $pathname ); foreach ( $files as $file ) { $path = $pathname . '/' . $file; if ( is_dir( $path ) ) { self::rmdir( $path ); } else { unlink( $path ); } } return rmdir( $pathname ); } /** * Clears contents of AUTOPTIMIZE_CACHE_DIR by renaming the current * cache directory into a new one with a unique name and then * re-creating the default (empty) cache directory. * * Important/ Fixme: this does not take multisite into account, so * if advanced_cache_clear_enabled is true (it is not by default) * then the content for all subsites is zapped! * * @return bool Returns true when everything is done successfully, false otherwise. */ protected static function clear_cache_via_rename() { $ok = false; $dir = self::get_pathname_base(); $new_name = self::get_unique_name(); // Makes sure the new pathname is on the same level... $new_pathname = dirname( $dir ) . '/' . $new_name; $renamed = @rename( $dir, $new_pathname ); // @codingStandardsIgnoreLine // When renamed, re-create the default cache directory back so it's // available again... if ( $renamed ) { $ok = self::cacheavail(); } return $ok; } /** * Returns true when advanced cache clearing is enabled. * * @return bool */ public static function advanced_cache_clear_enabled() { return apply_filters( 'autoptimize_filter_cache_clear_advanced', false ); } /** * Returns a (hopefully) unique new cache folder name for renaming purposes. * * @return string */ protected static function get_unique_name() { $prefix = self::get_advanced_cache_clear_prefix(); $new_name = uniqid( $prefix, true ); return $new_name; } /** * Get cache prefix name used in advanced cache clearing mode. * * @return string */ protected static function get_advanced_cache_clear_prefix() { $pathname = self::get_pathname_base(); $basename = basename( $pathname ); $prefix = $basename . '-artifact-'; return $prefix; } /** * Returns an array of file and directory names found within * the given $pathname without '.' and '..' elements. * * @param string $pathname Pathname. * * @return array */ protected static function get_dir_contents( $pathname ) { return array_slice( scandir( $pathname ), 2 ); } /** * Wipes directories which were created as part of the fast cache clearing * routine (which renames the current cache directory into a new one with * a custom-prefixed unique name). * * @return bool */ public static function delete_advanced_cache_clear_artifacts() { // Don't go through these motions (called from the cachechecker) if advanced cache clear isn't even active. if ( ! self::advanced_cache_clear_enabled() ) { return false; } $dir = self::get_pathname_base(); $prefix = self::get_advanced_cache_clear_prefix(); $parent = dirname( $dir ); $ok = false; // Returns the list of files without '.' and '..' elements. $files = self::get_dir_contents( $parent ); if ( is_array( $files ) && ! empty( $files ) ) { foreach ( $files as $file ) { $path = $parent . '/' . $file; $prefixed = ( false !== strpos( $path, $prefix ) ); // Removing only our own (prefixed) directories... if ( is_dir( $path ) && $prefixed ) { $ok = self::rmdir( $path ); } } } return $ok; } /** * Returns the cache directory pathname used. * Done as a function so we canSlightly different * if multisite is used and `autoptimize_separate_blog_caches` filter * is used. * * @return string */ public static function get_pathname() { $pathname = self::get_pathname_base(); if ( is_multisite() && apply_filters( 'autoptimize_separate_blog_caches', true ) ) { $blog_id = get_current_blog_id(); $pathname .= $blog_id . '/'; } return $pathname; } /** * Returns the base path of our cache directory. * * @return string */ protected static function get_pathname_base() { $pathname = WP_CONTENT_DIR . AUTOPTIMIZE_CACHE_CHILD_DIR; return $pathname; } /** * Deletes everything from the cache directories. * * @param bool $propagate Whether to trigger additional actions when cache is purged. * * @return bool */ public static function clearall( $propagate = true ) { if ( ! self::cacheavail() ) { return false; } // TODO/FIXME: If cache is big, switch to advanced/new cache clearing automatically? if ( self::advanced_cache_clear_enabled() ) { self::clear_cache_via_rename(); } else { self::clear_cache_classic(); } // Remove 404 handler if required. if ( self::do_fallback() ) { $_fallback_php = trailingslashit( WP_CONTENT_DIR ) . 'autoptimize_404_handler.php'; @unlink( $_fallback_php ); // @codingStandardsIgnoreLine } // Remove the transient so it gets regenerated... delete_transient( 'autoptimize_stats' ); // Cache was just purged, clear page cache and allow others to hook into our purging... if ( true === $propagate ) { if ( ! function_exists( 'autoptimize_do_cachepurged_action' ) ) { function autoptimize_do_cachepurged_action() { do_action( 'autoptimize_action_cachepurged' ); } } add_action( 'shutdown', 'autoptimize_do_cachepurged_action', 11 ); add_action( 'autoptimize_action_cachepurged', array( 'autoptimizeCache', 'flushPageCache' ), 10, 0 ); } // Warm cache (part of speedupper)! if ( apply_filters( 'autoptimize_filter_speedupper', true ) && false == get_transient( 'autoptimize_cache_warmer_protector' ) ) { set_transient( 'autoptimize_cache_warmer_protector', 'I shall not warm cache for another 10 minutes.', 60 * 10 ); $url = site_url() . '/?ao_speedup_cachebuster=' . rand( 1, 100000 ); $url = apply_filters( 'autoptimize_filter_cache_warmer_url', $url ); $cache = @wp_remote_get( $url ); // @codingStandardsIgnoreLine unset( $cache ); } return true; } /** * Wrapper for clearall but with false param * to ensure the event is not propagated to others * through our own hooks (to avoid infinite loops). * * @return bool */ public static function clearall_actionless() { return self::clearall( false ); } /** * Returns the contents of our cache dirs. * * @return array */ protected static function get_cache_contents() { $contents = array(); foreach ( array( '', 'js', 'css' ) as $dir ) { $contents[ $dir ] = scandir( AUTOPTIMIZE_CACHE_DIR . $dir ); } return $contents; } /** * Returns stats about cached contents. * * @return array */ public static function stats() { $stats = get_transient( 'autoptimize_stats' ); // If no transient, do the actual scan! if ( ! is_array( $stats ) ) { if ( ! self::cacheavail() ) { return 0; } $stats = self::stats_scan(); $count = $stats[0]; if ( $count > 100 ) { // Store results in transient. set_transient( 'autoptimize_stats', $stats, apply_filters( 'autoptimize_filter_cache_statsexpiry', HOUR_IN_SECONDS ) ); } } return $stats; } /** * Performs a scan of cache directory contents and returns an array * with 3 values: count, size, timestamp. * count = total number of found files * size = total filesize (in bytes) of found files * timestamp = unix timestamp when the scan was last performed/finished. * * @return array */ protected static function stats_scan() { $count = 0; $size = 0; // Scan everything in our cache directories. foreach ( self::get_cache_contents() as $name => $files ) { $dir = rtrim( AUTOPTIMIZE_CACHE_DIR . $name, '/' ) . '/'; foreach ( $files as $file ) { if ( self::is_valid_cache_file( $dir, $file ) ) { if ( AUTOPTIMIZE_CACHE_NOGZIP && ( false !== strpos( $file, '.js' ) || false !== strpos( $file, '.css' ) || false !== strpos( $file, '.img' ) || false !== strpos( $file, '.txt' ) ) ) { // Web server is gzipping, we count .js|.css|.img|.txt files. $count++; } elseif ( ! AUTOPTIMIZE_CACHE_NOGZIP && false !== strpos( $file, '.none' ) ) { // We are gzipping ourselves via php, counting only .none files. $count++; } $size += filesize( $dir . $file ); } } } $stats = array( $count, $size, time() ); return $stats; } /** * Ensures the cache directory exists, is writeable and contains the * required .htaccess files. * Returns false in case it fails to ensure any of those things. * * @return bool */ public static function cacheavail() { // readonly FS explicitly OK'ed by dev, let's assume the cache dirs are there! if ( defined( 'AUTOPTIMIZE_CACHE_READONLY' ) ) { return true; } if ( false === autoptimizeCache::check_and_create_dirs() ) { return false; } // Using .htaccess inside our cache folder to overrule wp-super-cache. $htaccess = AUTOPTIMIZE_CACHE_DIR . '/.htaccess'; if ( ! is_file( $htaccess ) ) { /** * Create `wp-content/AO_htaccess_tmpl` file with * whatever htaccess rules you might need * if you want to override default AO htaccess */ $htaccess_tmpl = WP_CONTENT_DIR . '/AO_htaccess_tmpl'; if ( is_file( $htaccess_tmpl ) ) { $content = file_get_contents( $htaccess_tmpl ); } elseif ( is_multisite() || ! AUTOPTIMIZE_CACHE_NOGZIP ) { $content = ' ExpiresActive On ExpiresByType text/css A30672000 ExpiresByType text/javascript A30672000 ExpiresByType application/javascript A30672000 Header append Cache-Control "public, immutable" SetOutputFilter DEFLATE Require all granted Order allow,deny Allow from all '; } else { $content = ' ExpiresActive On ExpiresByType text/css A30672000 ExpiresByType text/javascript A30672000 ExpiresByType application/javascript A30672000 Header append Cache-Control "public, immutable" SetOutputFilter DEFLATE Require all denied Order deny,allow Deny from all '; } if ( self::do_fallback() === true ) { $content .= "\nErrorDocument 404 " . trailingslashit( parse_url( content_url(), PHP_URL_PATH ) ) . 'autoptimize_404_handler.php'; } @file_put_contents( $htaccess, $content ); // @codingStandardsIgnoreLine } if ( self::do_fallback() ) { self::check_fallback_php(); } // All OK! return true; } /** * Checks if fallback-php file exists and create it if not. * * Return bool */ public static function check_fallback_php() { $_fallback_filename = 'autoptimize_404_handler.php'; $_fallback_php = trailingslashit( WP_CONTENT_DIR ) . $_fallback_filename; $_fallback_status = true; if ( ! file_exists( $_fallback_php ) && is_writable( WP_CONTENT_DIR ) ) { $_fallback_php_contents = file_get_contents( AUTOPTIMIZE_PLUGIN_DIR . 'config/' . $_fallback_filename ); $_fallback_php_contents = str_replace( '', AUTOPTIMIZE_CACHE_DIR, $_fallback_php_contents ); if ( apply_filters( 'autoptimize_filter_cache_fallback_log_errors', false ) ) { $_fallback_php_contents = str_replace( '// error_log', 'error_log', $_fallback_php_contents ); } $_fallback_status = file_put_contents( $_fallback_php, $_fallback_php_contents ); } return $_fallback_status; } /** * Tells if AO should try to avoid 404's by creating fallback filesize * and create a php 404 handler and tell .htaccess to redirect to said handler * and hook into WordPress to redirect 404 to said handler as well. NGINX users * are smart enough to get this working, no? ;-) * * Return bool */ public static function do_fallback() { static $_do_fallback = null; if ( null === $_do_fallback ) { $_do_fallback = (bool) apply_filters( 'autoptimize_filter_cache_do_fallback', autoptimizeOptionWrapper::get_option( 'autoptimize_cache_fallback', '1' ) ); } return $_do_fallback; } /** * Hooks into template_redirect, will act on 404-ing requests for * Autoptimized files and redirects to the fallback CSS/ JS if available * and 410'ing ("Gone") if fallback not available. */ public static function wordpress_notfound_fallback() { $original_request = strtok( $_SERVER['REQUEST_URI'], '?' ); if ( strpos( $original_request, wp_basename( WP_CONTENT_DIR ) . AUTOPTIMIZE_CACHE_CHILD_DIR ) !== false && is_404() ) { // make sure this is not considered a 404. global $wp_query; $wp_query->is_404 = false; // set fallback path. $js_or_css = pathinfo( $original_request, PATHINFO_EXTENSION ); $fallback_path = AUTOPTIMIZE_CACHE_DIR . $js_or_css . '/autoptimize_fallback.' . $js_or_css; // prepare for Shakeeb's Unused CSS files to be 404-handled as well. if ( strpos( $original_request, 'uucss/uucss-' ) !== false ) { $original_request = preg_replace( '/uucss\/uucss-[a-z0-9]{32}-/', 'css/', $original_request ); } // set fallback URL. $fallback_target = preg_replace( '/(.*)_(?:[a-z0-9]{32})\.(js|css)$/', '${1}_fallback.${2}', $original_request ); // redirect to fallback if possible. if ( $original_request !== $fallback_target && file_exists( $fallback_path ) ) { // redirect to fallback. wp_redirect( $fallback_target, 302 ); } else { // return HTTP 410 (gone) reponse. status_header( 410 ); } } } /** * Checks if cache dirs exist and create if not. * Returns false if not succesful. * * @return bool */ public static function check_and_create_dirs() { if ( ! defined( 'AUTOPTIMIZE_CACHE_DIR' ) ) { // We didn't set a cache. return false; } foreach ( array( '', 'js', 'css' ) as $dir ) { if ( ! self::check_cache_dir( AUTOPTIMIZE_CACHE_DIR . $dir ) ) { return false; } } return true; } /** * Ensures the specified `$dir` exists and is writeable. * Returns false if that's not the case. * * @param string $dir Directory to check/create. * * @return bool */ protected static function check_cache_dir( $dir ) { // Try creating the dir if it doesn't exist. if ( ! file_exists( $dir ) ) { @mkdir( $dir, 0775, true ); // @codingStandardsIgnoreLine if ( ! file_exists( $dir ) ) { return false; } } // If we still cannot write, bail. if ( ! is_writable( $dir ) ) { return false; } // Create an index.html in there to avoid prying eyes! $idx_file = rtrim( $dir, '/\\' ) . '/index.html'; if ( ! is_file( $idx_file ) ) { @file_put_contents( $idx_file, 'Generated by Autoptimize' ); // @codingStandardsIgnoreLine } return true; } /** * Flushes as many page cache plugin's caches as possible. * * @return void */ // @codingStandardsIgnoreStart public static function flushPageCache() { if ( function_exists( 'wp_cache_clear_cache' ) ) { if ( is_multisite() ) { $blog_id = get_current_blog_id(); wp_cache_clear_cache( $blog_id ); } else { wp_cache_clear_cache(); } } elseif ( has_action( 'cachify_flush_cache' ) ) { do_action( 'cachify_flush_cache' ); } elseif ( function_exists( 'w3tc_pgcache_flush' ) ) { w3tc_pgcache_flush(); } elseif ( function_exists( 'wp_fast_cache_bulk_delete_all' ) ) { wp_fast_cache_bulk_delete_all(); } elseif ( function_exists( 'rapidcache_clear_cache' ) ) { rapidcache_clear_cache(); } elseif ( class_exists( 'Swift_Performance_Cache' ) ) { Swift_Performance_Cache::clear_all_cache(); } elseif ( class_exists( 'WpFastestCache' ) ) { $wpfc = new WpFastestCache(); $wpfc->deleteCache(); } elseif ( class_exists( 'c_ws_plugin__qcache_purging_routines' ) ) { c_ws_plugin__qcache_purging_routines::purge_cache_dir(); // quick cache } elseif ( class_exists( 'zencache' ) ) { zencache::clear(); } elseif ( class_exists( 'comet_cache' ) ) { comet_cache::clear(); } elseif ( class_exists( 'WpeCommon' ) ) { // WPEngine cache purge/flush methods to call by default $wpe_methods = array( 'purge_varnish_cache', ); // More agressive clear/flush/purge behind a filter if ( apply_filters( 'autoptimize_flush_wpengine_aggressive', false ) ) { $wpe_methods = array_merge( $wpe_methods, array( 'purge_memcached', 'clear_maxcdn_cache' ) ); } // Filtering the entire list of WpeCommon methods to be called (for advanced usage + easier testing) $wpe_methods = apply_filters( 'autoptimize_flush_wpengine_methods', $wpe_methods ); foreach ( $wpe_methods as $wpe_method ) { if ( method_exists( 'WpeCommon', $wpe_method ) ) { WpeCommon::$wpe_method(); } } } elseif ( function_exists( 'sg_cachepress_purge_cache' ) ) { sg_cachepress_purge_cache(); } elseif ( array_key_exists( 'KINSTA_CACHE_ZONE', $_SERVER ) ) { $_kinsta_clear_cache_url = 'https://localhost/kinsta-clear-cache-all'; $_kinsta_response = wp_remote_get( $_kinsta_clear_cache_url, array( 'sslverify' => false, 'timeout' => 5, ) ); } elseif ( defined('NGINX_HELPER_BASENAME') ) { do_action( 'rt_nginx_helper_purge_all' ); } elseif ( file_exists( WP_CONTENT_DIR . '/wp-cache-config.php' ) && function_exists( 'prune_super_cache' ) ) { // fallback for WP-Super-Cache global $cache_path; if ( is_multisite() ) { $blog_id = get_current_blog_id(); prune_super_cache( get_supercache_dir( $blog_id ), true ); prune_super_cache( $cache_path . 'blogs/', true ); } else { prune_super_cache( $cache_path . 'supercache/', true ); prune_super_cache( $cache_path, true ); } } } // @codingStandardsIgnoreEnd }