Changeset 2788227 for gdpr-cache-scripts-styles

Timestamp:

09/21/2022 03:04:24 PM (4 years ago)

Author:

stracker.phil

Message:

1.0.1

Location:

gdpr-cache-scripts-styles

Files:

• tags/1.0.1 (added)
• tags/1.0.1/LICENSE (added)
• tags/1.0.1/constants.php (added)
• tags/1.0.1/includes (added)
• tags/1.0.1/includes/admin (added)
• tags/1.0.1/includes/admin/actions.php (added)
• tags/1.0.1/includes/admin/options.php (added)
• tags/1.0.1/includes/libs (added)
• tags/1.0.1/includes/libs/cache.php (added)
• tags/1.0.1/includes/libs/scanner.php (added)
• tags/1.0.1/includes/libs/utils.php (added)
• tags/1.0.1/includes/libs/worker.php (added)
• tags/1.0.1/plugin.php (added)
• tags/1.0.1/readme.txt (added)
• tags/1.0.1/start.php (added)
• tags/1.0.1/templates (added)
• tags/1.0.1/templates/admin-options.php (added)
• trunk/constants.php (modified) (1 diff)
• trunk/includes/admin/actions.php (modified) (4 diffs)
• trunk/includes/admin/options.php (modified) (2 diffs)
• trunk/includes/libs/cache.php (modified) (2 diffs)
• trunk/includes/libs/scanner.php (modified) (1 diff)
• trunk/includes/libs/utils.php (modified) (3 diffs)
• trunk/plugin.php (modified) (2 diffs)
• trunk/readme.txt (modified) (7 diffs)
• trunk/templates/admin-options.php (modified) (3 diffs)

gdpr-cache-scripts-styles/trunk/constants.php

@@ -38 +38 @@
  */
 const GDPR_CACHE_WORKER_LOCK = 'gdpr_lock';
+
+if ( ! defined( 'GDPR_CACHE_DEFAULT_UA' ) ) {
+    /**
+     * Defines the default user-agent that is sent to remote servers when
+     * downloading a file to the local cache.
+     *
+     * Set this to false or an empty string to not include a default
+     * user-agent with remote requests.
+     *
+     * Effect: The default UA below will instruct Google Fonts to use WOFF2
+     * files. If you need to support IE, define an empty UA, which results
+     * in TTF fonts being used.
+     *
+     * @see https://developers.google.com/fonts/docs/technical_considerations
+     *
+     * @since 1.0.1
+     * @var string
+     */
+    define( 'GDPR_CACHE_DEFAULT_UA', 'Mozilla/5.0 AppleWebKit/537 Chrome/105' );
+}

gdpr-cache-scripts-styles/trunk/includes/admin/actions.php

@@ -16 +16 @@
 add_action( 'admin_init', __NAMESPACE__ . '\process_actions' );
 
-add_action( 'gdpr_cache_do_flush', __NAMESPACE__ . '\action_flush_cache' );
+add_action( 'gdpr_cache_do_refresh', __NAMESPACE__ . '\action_refresh_cache' );
+
+add_action( 'gdpr_cache_do_purge', __NAMESPACE__ . '\action_purge_cache' );
 
 register_deactivation_hook( GDPR_CACHE_PLUGIN_FILE, __NAMESPACE__ . '\action_deactivate' );
@@ -30 +32 @@
  */
 function process_actions() {
-    if ( empty( $_POST['action'] ) || empty( $_POST['_wpnonce'] ) ) {
+    if ( empty( $_REQUEST['action'] ) || empty( $_REQUEST['_wpnonce'] ) ) {
         return;
     }
 
-    $action = sanitize_key( wp_unslash( $_POST['action'] ) );
+    $action = sanitize_key( wp_unslash( $_REQUEST['action'] ) );
 
     if ( 0 !== strpos( $action, 'gdpr-cache-' ) ) {
@@ -43 +45 @@
     $gdpr_action = substr( $action, 11 );
 
-    if ( ! wp_verify_nonce( sanitize_key( wp_unslash( $_POST['_wpnonce'] ) ), $gdpr_action ) ) {
+    if ( ! wp_verify_nonce( sanitize_key( wp_unslash( $_REQUEST['_wpnonce'] ) ), $gdpr_action ) ) {
         return;
     }
@@ -58 +60 @@
 
 /**
- * Renders the admin option-page of our plugin.
+ * Initiates a cache-refresh and display a success message on the admin page.
  *
  * @since 1.0.0
  * @return void
  */
-function action_flush_cache() {
+function action_refresh_cache() {
     flush_cache( true );
 
     $redirect_to = add_query_arg( [
-        'update'   => 'flushed',
+        'update'   => 'refreshed',
+        '_wpnonce' => wp_create_nonce( 'gdpr-cache' ),
+    ] );
+
+    wp_safe_redirect( $redirect_to );
+
+    exit;
+}
+
+
+/**
+ * Purges the cache and display a success message on the admin page.
+ *
+ * @since 1.0.1
+ * @return void
+ */
+function action_purge_cache() {
+    flush_cache();
+
+    $redirect_to = add_query_arg( [
+        'update'   => 'purged',
         '_wpnonce' => wp_create_nonce( 'gdpr-cache' ),
     ] );

gdpr-cache-scripts-styles/trunk/includes/admin/options.php

@@ -62 +62 @@
     }
 
-    if ( 'flushed' === $notice ) {
-        add_action( 'admin_notices', __NAMESPACE__ . '\admin_notice_flushed' );
+    if ( 'refreshed' === $notice ) {
+        add_action( 'admin_notices', __NAMESPACE__ . '\admin_notice_refreshed' );
+    } elseif ( 'purged' === $notice ) {
+        add_action( 'admin_notices', __NAMESPACE__ . '\admin_notice_purged' );
     }
 }
@@ -80 +82 @@
 
 /**
- * Outputs an admin notice: Cache flushed.
+ * Outputs an admin notice: Cache refreshed.
  *
  * @since 1.0.0
  * @return void
  */
-function admin_notice_flushed() {
+function admin_notice_refreshed() {
     printf(
         '<div class="notice-%s notice is-dismissible"><p>%s</p></div>',
         'success',
-        esc_html__( 'Cache flushed', 'gdpr-cache' )
+        esc_html__( 'Refreshing the cache in the background', 'gdpr-cache' )
     );
 }
+
+
+/**
+ * Outputs an admin notice: Cache purged.
+ *
+ * @since 1.0.1
+ * @return void
+ */
+function admin_notice_purged() {
+    printf(
+        '<div class="notice-%s notice is-dismissible"><p>%s</p></div>',
+        'success',
+        esc_html__( 'Cache purged', 'gdpr-cache' )
+    );
+}

gdpr-cache-scripts-styles/trunk/includes/libs/cache.php

@@ -240 +240 @@
     $timeout = 300;
 
-    $headers = [];
-
-    /**
-     * Some assets return different content based on user-agent, so this
-     * filter allows us to inject those details.
-     */
-    // $headers = apply_filters(
-    //     'gdpr_cache_download_asset_headers',
-    //     $headers,
-    //     $url
-    // );
-    //
-    // $key        = md5( json_encode( $headers ) );
-
-    $domain     = wp_parse_url( $url, PHP_URL_HOST );
-    $parts      = [ $domain, md5( $url ), $type ];
-    $filename   = implode( '.', $parts );
+    // Get HTTP request headers for requesting the remote file.
+    $headers = get_remote_request_headers( $url, $type );
+
+    // Add a CRC32 key to generate a unique filename based on URL and headers.
+    $key = implode( ' ', [ $url, wp_json_encode( $headers ) ] );
+
+    $extension = implode( '.', [ '', crc32( $key ), $type ] );
+
+    // Create a normalized base-name that reflects the remote asset URI.
+    $base_name = substr( $url, strpos( $url, '//' ) + 2 );
+    $base_name = preg_replace( '/\W+/', '.', $base_name );
+    $base_name = substr( $base_name, 0, 250 - strlen( $extension ) );
+    $base_name = strtolower( trim( $base_name, '.' ) );
+
+    $filename   = $base_name . $extension;
     $cache_path = build_cache_file_path( $filename );
 
@@ -298 +296 @@
     return set_local_item( $url, $filename, $expires );
 }
+
+/**
+ * Returns an array with HTTP headers that should be used to request the
+ * specified asset from the remote server.
+ *
+ * @since 1.0.1
+ *
+ * @param string $url  The external URL that will be requested.
+ * @param string $type File-type extension of the remote file.
+ *
+ * @return string[] List of headers that are passed to `wp_remote_get()`.
+ */
+function get_remote_request_headers( $url, $type ) {
+    $headers = [];
+
+    // Insert the default user agent, if it's not empty.
+    if ( GDPR_CACHE_DEFAULT_UA ) {
+        $headers['User-agent'] = GDPR_CACHE_DEFAULT_UA;
+    }
+
+    /**
+     * Some assets return different content based on user-agent, so this
+     * filter allows us to inject those details.
+     *
+     * @since 1.0.1
+     *
+     * @param array  $headers The request headers.
+     * @param string $url     The URL that's requested.
+     * @param string $type    File type extension of the requested file.
+     */
+    return (array) apply_filters(
+        'gdpr_cache_remote_request_headers',
+        $headers,
+        $url,
+        $type
+    );
+}

gdpr-cache-scripts-styles/trunk/includes/libs/scanner.php

@@ -151 +151 @@
         $uri = trim( $matches[2], '"\'' );
 
-        $type = get_url_type( $uri );
-
         // Try to cache the external dependency.
-        $local_uri = swap_to_local_asset( $uri, $type );
+        $local_uri = swap_to_local_asset( $uri );
 
         if ( $local_uri ) {

gdpr-cache-scripts-styles/trunk/includes/libs/utils.php

@@ -116 +116 @@
         'image/gif'       => 'gif',
     ];
-
-    // First, analyze the URI and see if it ends with a valid type.
+    $sub_types     = [
+        'css'        => 'css',
+        'javascript' => 'js',
+        'ecmascript' => 'js',
+        'ttf'        => 'ttf',
+        'otf'        => 'otf',
+        'woff'       => 'woff',
+        'woff2'      => 'woff2',
+        'jpeg'       => 'jpg',
+        'jpg'        => 'jpg',
+        'png'        => 'png',
+        'gif'        => 'gif',
+    ];
+
+    /**
+     * First, analyze the URI and see if it ends with a valid type.
+     *
+     * Example: https://c0.wp.com/p/jetpack/11.3.1/css/jetpack.css
+     * Will return "css"
+     */
     $path = wp_parse_url( $uri, PHP_URL_PATH );
     if ( preg_match( '/\w+$/', $path, $matches ) ) {
         $type = strtolower( $matches[0] );
-        if ( array_key_exists( $type, $types ) ) {
+        if ( in_array( $type, $types ) ) {
             return $type;
         }
     }
 
-    // If the URI is not unique, then we'll ask for the content-type.
+    /**
+     * If the URI is not unique, then we'll ask for the content-type.
+     *
+     * Send a HEAD request to the remote site to find out the content-type
+     * which is used by the server. The HEAD request is very fast, because it
+     * does not send any body-details, only the response headers.
+     *
+     * Example: "content-type: text/css; charset=utf-8" condenses to "text/css"
+     * Will return "css"
+     */
     $resp         = wp_remote_head( $uri );
     $content_type = wp_remote_retrieve_header( $resp, 'content-type' );
@@ -132 +159 @@
     $content_type = strtolower( trim( array_shift( $content_type ) ) );
 
-    if ( array_key_exists( $content_type, $content_types ) ) {
-        return $content_types[ $content_type ];
+    if ( $content_type ) {
+        if ( array_key_exists( $content_type, $content_types ) ) {
+            return $content_types[ $content_type ];
+        }
+
+        /**
+         * No exact match, inspect only second part of the content-type.
+         *
+         * Now we'll split the content-type into two parts and investigate the
+         * second part.
+         *
+         * Some subtypes exist in multiple types, like "text/javascript" and
+         * "application/javascript".
+         *
+         * Example "application/javascript" is reduced to "javascript"
+         * Will return "js"
+         */
+        $sub_type = explode( '/', $content_type );
+        $sub_type = array_pop( $sub_type );
+
+        if ( array_key_exists( $sub_type, $sub_types ) ) {
+            return $sub_types[ $sub_type ];
+        }
     }
 
@@ -166 +214 @@
     return $gdpr_cache_fs;
 }
-

gdpr-cache-scripts-styles/trunk/plugin.php

@@ -12 +12 @@
  * Plugin URI:  https://github.com/divimode/gdpr-cache-script-styles
  * Description: Caches external scripts and styles and serves them from your local website to make it more compliant with GDPR regulations
- * Version:     1.0.0
+ * Version:     1.0.1
  * Author:      Divimode
  * Author URI:  https://divimode.com/
@@ -46 +46 @@
  * @var string
  */
-const GDPR_CACHE_VERSION = '1.0.0';
+const GDPR_CACHE_VERSION = '1.0.1';
 
 /**

gdpr-cache-scripts-styles/trunk/readme.txt

@@ -1 +1 @@
 === GDPR Cache Scripts & Styles ===
-Tags: gdpr, ccpa, privacy, asset cache
+Tags: gdpr, ccpa, privacy, asset cache, script cache, style cache, embed google fonts, local google fonts
 Requires at least: 5.8
 Tested up to: 6.0.2
 Requires PHP: 7.4
-Stable tag: 1.0.0
+Stable tag: 1.0.1
 License: GPL v2 or later
 License URI: http://www.gnu.org/licenses/gpl-2.0.txt
 
-Cache external scripts and styles, and serve them from your local website.
+Greatly enhances privacy of your website by embedding external scripts and styles.
 
 == Description ==
@@ -22 +22 @@
 ## How it works
 
+> **Short**: External files are downloaded to your WordPress installation (into the uploads-folder) and then served from there.
+
+**More details**:
+
 The plugin scans every URL that is enqueued via `wp_enqueue_script()` and `wp_enqueue_style()`. When detecting external URL, that file is saved to your uploads-folder and served from there.
 
@@ -27 +31 @@
 
 Heads-up: For technical reasons, we cannot scan the contents of JS files for such dependencies - JS files can always inject external assets
+
+## No Output Buffer
+
+This plugin does not add any "output buffering" but scans the URLs which are enqueued via recommended WordPress functions.
+
+As a result, *GDPR Cache Scripts & Styles* has practically no performance impact on your response time, no matter how big your website is.
 
 ## Background worker
@@ -44 +54 @@
 Automatic WordPress installer:
 
-1. Install the plugin from wordpress.org
+1. Install [the plugin from wordpress.org](https://wordpress.org/plugins/gdpr-cache-scripts-styles/)
 2. Activate it.
 3. Done! No configuration needed.
@@ -50 +60 @@
 From GitHub:
 
-1. Visit https://github.com/divimode/gdpr-cache-script-styles and download the repository zip file.
+1. Visit [github.com/divimode/gdpr-cache-script-styles](https://github.com/divimode/gdpr-cache-script-styles/) and download the repository zip file.
 2. Open your wp-admin > Plugins > Add New page and upload that zip file
 3. Activate the plugin.
@@ -67 +77 @@
 Unfortunately, no. Some scripts (such as Google Maps scripts) will load external assets that cannot be detected or cached by this plugin.
 
+= I still see some requests to Google's Servers =
+Common reasons are:
+
+* Some scripts (like Google Maps) can dynamically load Google Fonts or other external resources. This cannot be prevented by this plugin.
+* A browser plugin loads external assets on every request. Test the page in an Incognito/Private window
+
+Also, some themes or performance plugins can embed the external resources in a way that our plugin cannot detect. If this is the case for you, please let us know. We might be able to adjust this plugin, or provide you with instructions on how to configure the plugin/theme to be compatible with *GDPR Cache Scripts & Styles*.
+
 == Screenshots ==
 
@@ -75 +93 @@
 == Changelog ==
 
+= 1.0.1 =
+
+* New: A "Purge Cache" button to the plugin options page
+* New: Include a User-Agent when requesting remote files, to fetch WOFF2 fonts from Google instead of large TTF files
+* Fix: Correctly determine asset type from file extension to avoid "tmp" types
+* Improve: Color coding of the cache-status on the plugin options page
+* Improve: Local cache 1files reflect the entire remote URL, to add transparency over the file contents
+* Improve: Fix some typos and remove unused code
+
 = 1.0.0 =
 

gdpr-cache-scripts-styles/trunk/templates/admin-options.php

@@ -74 +74 @@
 }
 
+$action_refresh = wp_nonce_url(
+    add_query_arg( [ 'action' => 'gdpr-cache-refresh' ] ),
+    'refresh'
+);
+$action_purge   = wp_nonce_url(
+    add_query_arg( [ 'action' => 'gdpr-cache-purge' ] ),
+    'purge'
+);
+
 ?>
 <div class="wrap">
@@ -79 +88 @@
 
     <p>
-        <?php esc_html_e( 'Overview and manage your locally cached assets', 'gdpr-cache' ); ?>
+        <?php esc_html_e( 'View and manage your locally cached assets', 'gdpr-cache' ); ?>
     </p>
 
-    <form method="post">
-        <h2><?php esc_html_e( 'Cache Control', 'gdpr-cache' ); ?></h2>
-        <p>
-            <?php esc_html_e( 'Invalidating the cache will expire all cached files. The plugin will start to download the latest version of all files on the next request. While the cache is regenerated, the expired files are served.', 'gdpr-cache' ); ?>
+    <h2><?php esc_html_e( 'Cache Control', 'gdpr-cache' ); ?></h2>
+    <p>
+        <?php esc_html_e( 'Refreshing the cache will start to download all external files in the background. While the cache is regenerated, the expired files are served.', 'gdpr-cache' ); ?>
+    </p>
+    <p>
+        <?php esc_html_e( 'Purging the cache will instantly delete all cached files, and begin to build a new cache. Until the initialization is finished, assets are loaded from the external sites.', 'gdpr-cache' ); ?>
+    </p>
+    <div class="gdpr-cache-reset">
+        <p class="submit">
+            <a href="<?php echo esc_url_raw( $action_refresh ) ?>" class="button-primary">
+                <?php esc_html_e( 'Refresh Cache', 'gdpr-cache' ) ?>
+            </a>
+            <a href="<?php echo esc_url_raw( $action_purge ) ?>" class="button">
+                <?php esc_html_e( 'Purge Cache', 'gdpr-cache' ) ?>
+            </a>
         </p>
-        <p>
-            <?php esc_html_e( 'To complete delete the entire cache, you need to disable the plugin.', 'gdpr-cache' ); ?>
-        </p>
-        <div class="gdpr-cache-reset">
-            <p class="submit">
-                <input
-                        type="submit"
-                        name="submit"
-                        id="submit"
-                        class="button"
-                        value="<?php esc_attr_e( 'Invalidate Cache', 'gdpr-cache' ) ?>"
-                >
-            </p>
-        </div>
-        <?php wp_nonce_field( 'flush' ); ?>
-        <input type="hidden" name="action" value="gdpr-cache-flush"/>
-    </form>
+    </div>
+    <?php wp_nonce_field( 'flush' ); ?>
+    <input type="hidden" name="action" value="gdpr-cache-flush"/>
 
     <h2><?php esc_html_e( 'Cached Assets', 'gdpr-cache' ); ?></h2>
@@ -167 +173 @@
         font-weight: bold;
     }
+
+    .widefat .asset-status {
+        vertical-align: middle;
+        text-align: center;
+    }
+
+    .status-valid .asset-status {
+        background: #c8e6c940;
+        color: #005005;
+    }
+
+    .status-expired .asset-status {
+        background: #ffecb340;
+        color: #c56000;
+    }
+
+    .status-missing .asset-status {
+        background: #ffccbc40;
+        color: #9f0000;
+    }
+
+    .status-enqueued .asset-status {
+        background: #e1bee740;
+        color: #38006b;
+    }
 </style>