Changeset 1260794

Timestamp:

10/07/2015 05:28:37 AM (10 years ago)

Author:

vnsavage

Message:

Bump version; Port multiple bugfixes from Github - ​https://github.com/Automattic/batcache

Location:

batcache/tags/1.2

Files:

• advanced-cache.php (modified) (18 diffs)
• batcache.php (modified) (2 diffs)
• readme.txt (modified) (1 diff)

batcache/tags/1.2/advanced-cache.php

@@ -1 +1 @@
 <?php
+if ( is_readable( dirname( __FILE__ ) . '/batcache-stats.php' ) )
+    require_once dirname( __FILE__ ) . '/batcache-stats.php';
+
+if ( !function_exists( 'batcache_stats' ) ) {
+    function batcache_stats( $name, $value, $num = 1, $today = FALSE, $hour = FALSE ) { }
+}
 
 // nananananananananananananananana BATCACHE!!!
@@ -8 +14 @@
     if ( is_object($batcache) )
         $batcache->cancel = true;
+}
+
+// Variants can be set by functions which use early-set globals like $_SERVER to run simple tests.
+// Functions defined in WordPress, plugins, and themes are not available and MUST NOT be used.
+// Example: vary_cache_on_function('return preg_match("/feedburner/i", $_SERVER["HTTP_USER_AGENT"]);');
+//          This will cause batcache to cache a variant for requests from Feedburner.
+// Tips for writing $function:
+//  X_X  DO NOT use any functions from your theme or plugins. Those files have not been included. Fatal error.
+//  X_X  DO NOT use any WordPress functions except is_admin() and is_multisite(). Fatal error.
+//  X_X  DO NOT include or require files from anywhere without consulting expensive professionals first. Fatal error.
+//  X_X  DO NOT use $wpdb, $blog_id, $current_user, etc. These have not been initialized.
+//  ^_^  DO understand how create_function works. This is how your code is used: create_function('', $function);
+//  ^_^  DO remember to return something. The return value determines the cache variant.
+function vary_cache_on_function($function) {
+    global $batcache;
+
+    if ( preg_match('/include|require|echo|print|dump|export|open|sock|unlink|`|eval/i', $function) )
+        die('Illegal word in variant determiner.');
+
+    if ( !preg_match('/\$_/', $function) )
+        die('Variant determiner should refer to at least one $_ variable.');
+
+    $batcache->add_variant($function);
 }
 
@@ -13 +42 @@
     // This is the base configuration. You can edit these variables or move them into your wp-config.php file.
     var $max_age =  300; // Expire batcache items aged this many seconds (zero to disable batcache)
-    
+
     var $remote  =    0; // Zero disables sending buffers to remote datacenters (req/sec is never sent)
-    
+
     var $times   =    2; // Only batcache a page after it is accessed this many times... (two or more)
     var $seconds =  120; // ...in this many seconds (zero to ignore this and use batcache immediately)
-    
+
     var $group   = 'batcache'; // Name of memcached group. You can simulate a cache flush by changing this.
-    
+
     var $unique  = array(); // If you conditionally serve different content, put the variable values here.
-    
-    var $headers = array(); // Add headers here. These will be sent with every response from the cache.
+
+    var $vary    = array(); // Array of functions for create_function. The return value is added to $unique above.
+
+    var $headers = array(); // Add headers here as name=>value or name=>array(values). These will be sent with every response from the cache.
 
     var $cache_redirects = false; // Set true to enable redirect caching.
@@ -37 +68 @@
     var $cancel = false; // Change this to cancel the output buffer. Use batcache_cancel();
 
-    var $genlock; // Used internally
-    var $do; // Used internally
+    var $noskip_cookies = array( 'wordpress_test_cookie' ); // Names of cookies - if they exist and the cache would normally be bypassed, don't bypass it
+
+    var $genlock = false;
+    var $do = false;
 
     function batcache( $settings ) {
@@ -57 +90 @@
     }
 
-    function status_header( $status_header ) {
+    function status_header( $status_header, $status_code ) {
         $this->status_header = $status_header;
+        $this->status_code = $status_code;
 
         return $status_header;
@@ -70 +104 @@
 
         return $status;
+    }
+
+    function do_headers( $headers1, $headers2 = array() ) {
+        // Merge the arrays of headers into one
+        $headers = array();
+        $keys = array_unique( array_merge( array_keys( $headers1 ), array_keys( $headers2 ) ) );
+        foreach ( $keys as $k ) {
+            $headers[$k] = array();
+            if ( isset( $headers1[$k] ) && isset( $headers2[$k] ) )
+                $headers[$k] = array_merge( (array) $headers2[$k], (array) $headers1[$k] );
+            elseif ( isset( $headers2[$k] ) )
+                $headers[$k] = (array) $headers2[$k];
+            else
+                $headers[$k] = (array) $headers1[$k];
+            $headers[$k] = array_unique( $headers[$k] );
+        }
+        // These headers take precedence over any previously sent with the same names
+        foreach ( $headers as $k => $values ) {
+            $clobber = true;
+            foreach ( $values as $v ) {
+                header( "$k: $v", $clobber );
+                $clobber = false;
+            }
+        }
     }
 
@@ -110 +168 @@
             return;
 
+        // Do not cache 5xx responses
+        if ( isset( $this->status_code ) && intval($this->status_code / 100) == 5 )
+            return $output;
+
+        $this->do_variants($this->vary);
+        $this->generate_keys();
+
         // Construct and save the batcache
-        $cache = array(
+        $this->cache = array(
             'output' => $output,
             'time' => time(),
             'timer' => $this->timer_stop(false, 3),
+            'headers' => array(),
             'status_header' => $this->status_header,
             'redirect_status' => $this->redirect_status,
@@ -121 +187 @@
         );
 
-        if ( function_exists( 'headers_list' ) ) {
-            foreach ( headers_list() as $header ) {
-                list($k, $v) = array_map('trim', explode(':', $header, 2));
-                $cache['headers'][$k] = $v;
-            }
-        } elseif ( function_exists( 'apache_response_headers' ) ) {
-            $cache['headers'] = apache_response_headers();
-        }
-
-        if ( $cache['headers'] && !empty( $this->uncached_headers ) ) {
-            foreach ( $cache['headers'] as $header => $value ) {
-                if ( in_array( strtolower( $header ), $this->uncached_headers ) )
-                    unset( $cache['headers'][$header] );
-            }
-        }
-
-        wp_cache_set($this->key, $cache, $this->group, $this->max_age + $this->seconds + 30);
+        foreach ( headers_list() as $header ) {
+            list($k, $v) = array_map('trim', explode(':', $header, 2));
+            $this->cache['headers'][$k][] = $v;
+        }
+
+        if ( !empty( $this->cache['headers'] ) && !empty( $this->uncached_headers ) ) {
+            foreach ( $this->uncached_headers as $header )
+                unset( $this->cache['headers'][$header] );
+        }
+
+        foreach ( $this->cache['headers'] as $header => $values ) {
+            // Do not cache if cookies were set
+            if ( strtolower( $header ) === 'set-cookie' )
+                return $output;
+
+            foreach ( (array) $values as $value )
+                if ( preg_match('/^Cache-Control:.*max-?age=(\d+)/i', "$header: $value", $matches) )
+                    $this->max_age = intval($matches[1]);
+        }
+
+        $this->cache['max_age'] = $this->max_age;
+
+        wp_cache_set($this->key, $this->cache, $this->group, $this->max_age + $this->seconds + 30);
 
         // Unlock regeneration
@@ -143 +215 @@
 
         if ( $this->cache_control ) {
-            header( 'Last-Modified: ' . gmdate( 'D, d M Y H:i:s', $cache['time'] ) . ' GMT', true );
-            header("Cache-Control: max-age=$this->max_age, must-revalidate", false);
-        }
-
-        if ( !empty($this->headers) ) foreach ( $this->headers as $k => $v ) {
-            if ( is_array( $v ) )
-                header("{$v[0]}: {$v[1]}", false);
-            else
-                header("$k: $v", true);
-        }
-
-        // Add some debug info just before </head>
+            // Don't clobber Last-Modified header if already set, e.g. by WP::send_headers()
+            if ( !isset($this->cache['headers']['Last-Modified']) )
+                header( 'Last-Modified: ' . gmdate( 'D, d M Y H:i:s', $this->cache['time'] ) . ' GMT', true );
+            if ( !isset($this->cache['headers']['Cache-Control']) )
+                header("Cache-Control: max-age=$this->max_age, must-revalidate", false);
+        }
+
+        $this->do_headers( $this->headers );
+
+        // Add some debug info just before <head
         if ( $this->debug ) {
-            $tag = "<!--\n\tgenerated in " . $cache['timer'] . " seconds\n\t" . strlen(serialize($cache)) . " bytes batcached for " . $this->max_age . " seconds\n-->\n";
-            if ( false !== $tag_position = strpos($output, '</head>') ) {
-                $tag = "<!--\n\tgenerated in " . $cache['timer'] . " seconds\n\t" . strlen(serialize($cache)) . " bytes batcached for " . $this->max_age . " seconds\n-->\n";
-                $output = substr($output, 0, $tag_position) . $tag . substr($output, $tag_position);
+            $this->add_debug_just_cached();
+        }
+
+        // Pass output to next ob handler
+        batcache_stats( 'batcache', 'total_page_views' );
+        return $this->cache['output'];
+    }
+
+    function add_variant($function) {
+        $key = md5($function);
+        $this->vary[$key] = $function;
+    }
+
+    function do_variants($dimensions = false) {
+        // This function is called without arguments early in the page load, then with arguments during the OB handler.
+        if ( $dimensions === false )
+            $dimensions = wp_cache_get("{$this->url_key}_vary", $this->group);
+        else
+            wp_cache_set("{$this->url_key}_vary", $dimensions, $this->group, $this->max_age + 10);
+
+        if ( is_array($dimensions) ) {
+            ksort($dimensions);
+            foreach ( $dimensions as $key => $function ) {
+                $fun = create_function('', $function);
+                $value = $fun();
+                $this->keys[$key] = $value;
             }
         }
-
-        // Pass output to next ob handler
-        return $output;
-    }
-}
+    }
+
+    function generate_keys() {
+        // ksort($this->keys); // uncomment this when traffic is slow
+        $this->key = md5(serialize($this->keys));
+        $this->req_key = $this->key . '_req';
+    }
+
+    function add_debug_just_cached() {
+        $generation = $this->cache['timer'];
+        $bytes = strlen( serialize( $this->cache ) );
+        $html = <<<HTML
+<!--
+    generated in $generation seconds
+    $bytes bytes batcached for {$this->max_age} seconds
+-->
+
+HTML;
+        $this->add_debug_html_to_output( $html );
+    }
+
+    function add_debug_from_cache() {
+        $seconds_ago = time() - $this->cache['time'];
+        $generation = $this->cache['timer'];
+        $serving = $this->timer_stop( false, 3 );
+        $expires = $this->cache['max_age'] - time() + $this->cache['time'];
+        $html = <<<HTML
+<!--
+    generated $seconds_ago seconds ago
+    generated in $generation seconds
+    served from batcache in $serving seconds
+    expires in $expires seconds
+-->
+
+HTML;
+        $this->add_debug_html_to_output( $html );
+    }
+
+    function add_debug_html_to_output( $debug_html ) {
+        // Casing on the Content-Type header is inconsistent
+        foreach ( array( 'Content-Type', 'Content-type' ) as $key ) {
+            if ( isset( $this->cache['headers'][ $key ][0] ) && 0 !== strpos( $this->cache['headers'][ $key ][0], 'text/html' ) )
+                return;
+        }
+
+        $head_position = strpos( $this->cache['output'], '<head' );
+        if ( false === $head_position ) {
+            return;
+        }
+        $this->cache['output'] .= "\n$debug_html";
+    }
+}
+
 global $batcache;
 // Pass in the global variable which may be an array of settings to override defaults.
@@ -180 +320 @@
             'wp-app.php',
             'xmlrpc.php',
-            'ms-files.php',
         ) ) )
     return;
@@ -193 +332 @@
 
 // Never batcache when cookies indicate a cache-exempt visitor.
-if ( is_array( $_COOKIE) && ! empty( $_COOKIE ) )
-    foreach ( array_keys( $_COOKIE ) as $batcache->cookie )
-        if ( $batcache->cookie != 'wordpress_test_cookie' && ( substr( $batcache->cookie, 0, 2 ) == 'wp' || substr( $batcache->cookie, 0, 9 ) == 'wordpress' || substr( $batcache->cookie, 0, 14 ) == 'comment_author' ) )
+if ( is_array( $_COOKIE) && ! empty( $_COOKIE ) ) {
+    foreach ( array_keys( $_COOKIE ) as $batcache->cookie ) {
+        if ( ! in_array( $batcache->cookie, $batcache->noskip_cookies ) && ( substr( $batcache->cookie, 0, 2 ) == 'wp' || substr( $batcache->cookie, 0, 9 ) == 'wordpress' || substr( $batcache->cookie, 0, 14 ) == 'comment_author' ) ) {
+            batcache_stats( 'batcache', 'cookie_skip' );
             return;
+        }
+    }
+}
 
 if ( ! include_once( WP_CONTENT_DIR . '/object-cache.php' ) )
@@ -218 +361 @@
 
 /* Example: batcache everything on this host regardless of traffic level
-if ( $_SERVER['HTTP_HOST'] == 'always-batcache-me.com' ) {
-    $batcache->max_age = 600; // Cache for 10 minutes
-    $batcache->seconds = $batcache->times = 0; // No need to wait till n number of people have accessed the page, cache instantly
-}
+if ( $_SERVER['HTTP_HOST'] == 'always-batcache-me.com' )
+    return;
 */
 
@@ -243 +384 @@
 if ( isset( $_SERVER['QUERY_STRING'] ) )
     parse_str($_SERVER['QUERY_STRING'], $batcache->query);
+
 $batcache->keys = array(
     'host' => $_SERVER['HTTP_HOST'],
@@ -254 +396 @@
     $batcache->keys['ssl'] = true;
 
+// Recreate the permalink from the URL
+$batcache->permalink = 'http://' . $batcache->keys['host'] . $batcache->keys['path'] . ( isset($batcache->keys['query']['p']) ? "?p=" . $batcache->keys['query']['p'] : '' );
+$batcache->url_key = md5($batcache->permalink);
 $batcache->configure_groups();
-
-// Generate the batcache key
-$batcache->key = md5(serialize($batcache->keys));
-
-// Generate the traffic threshold measurement key
-$batcache->req_key = $batcache->key . '_req';
+$batcache->url_version = (int) wp_cache_get("{$batcache->url_key}_version", $batcache->group);
+$batcache->do_variants();
+$batcache->generate_keys();
 
 // Get the batcache
 $batcache->cache = wp_cache_get($batcache->key, $batcache->group);
 
-// Are we only caching frequently-requested pages?
-if ( $batcache->seconds < 1 || $batcache->times < 2 ) {
+if ( isset($batcache->cache['version']) && $batcache->cache['version'] < $batcache->url_version ) {
+    // Always refresh the cache if a newer version is available.
+    $batcache->do = true;
+} else if ( $batcache->seconds < 1 || $batcache->times < 2 ) {
+    // Are we only caching frequently-requested pages?
     $batcache->do = true;
 } else {
@@ -281 +426 @@
 }
 
-// Recreate the permalink from the URL
-$batcache->permalink = 'http://' . $batcache->keys['host'] . $batcache->keys['path'] . ( isset($batcache->keys['query']['p']) ? "?p=" . $batcache->keys['query']['p'] : '' );
-$batcache->url_key = md5($batcache->permalink);
-$batcache->url_version = (int) wp_cache_get("{$batcache->url_key}_version", $batcache->group);
-
 // If the document has been updated and we are the first to notice, regenerate it.
-if ( $batcache->do !== false && isset($batcache->cache['version']) && $batcache->cache['version'] < $batcache->url_version )
-    $batcache->genlock = wp_cache_add("{$batcache->url_key}_genlock", 1, $batcache->group);
+if ( $batcache->do )
+    $batcache->genlock = wp_cache_add("{$batcache->url_key}_genlock", 1, $batcache->group, 10);
+
+// Temporary: remove after 2010-11-12. I added max_age to the cache. This upgrades older caches on the fly.
+if ( !isset($batcache->cache['max_age']) )
+    $batcache->cache['max_age'] = $batcache->max_age;
+
 
 // Did we find a batcached page that hasn't expired?
-if ( isset($batcache->cache['time']) && ! $batcache->genlock && time() < $batcache->cache['time'] + $batcache->max_age ) {
+if ( isset($batcache->cache['time']) && ! $batcache->genlock && time() < $batcache->cache['time'] + $batcache->cache['max_age'] ) {
     // Issue redirect if cached and enabled
     if ( $batcache->cache['redirect_status'] && $batcache->cache['redirect_location'] && $batcache->cache_redirects ) {
@@ -298 +443 @@
         // From vars.php
         $is_IIS = (strpos($_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS') !== false || strpos($_SERVER['SERVER_SOFTWARE'], 'ExpressionDevServer') !== false);
+
+        $batcache->do_headers( $batcache->headers );
         if ( $is_IIS ) {
             header("Refresh: 0;url=$location");
@@ -325 +472 @@
     }
 
-    // Issue "304 Not Modified" only if the dates match exactly.
-    if ( $batcache->cache_control && isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) ) {
-        $since = strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']);
-        if ( isset($batcache->cache['headers']['Last-Modified']) )
-            $batcache->cache['time'] = strtotime( $batcache->cache['headers']['Last-Modified'] );
-        if ( $batcache->cache['time'] == $since ) {
-            header('Last-Modified: ' . $_SERVER['HTTP_IF_MODIFIED_SINCE'], true, 304);
-            exit;
-        }
-    }
-
-    // Use the batcache save time for Last-Modified so we can issue "304 Not Modified"
-    if ( $batcache->cache_control ) {
+    // Respect ETags served with feeds.
+    $three04 = false;
+    if ( isset( $SERVER['HTTP_IF_NONE_MATCH'] ) && isset( $batcache->cache['headers']['ETag'][0] ) && $_SERVER['HTTP_IF_NONE_MATCH'] == $batcache->cache['headers']['ETag'][0] )
+        $three04 = true;
+
+    // Respect If-Modified-Since.
+    elseif ( $batcache->cache_control && isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) ) {
+        $client_time = strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']);
+        if ( isset($batcache->cache['headers']['Last-Modified'][0]) )
+            $cache_time = strtotime($batcache->cache['headers']['Last-Modified'][0]);
+        else
+            $cache_time = $batcache->cache['time'];
+
+        if ( $client_time >= $cache_time )
+            $three04 = true;
+    }
+
+    // Use the batcache save time for Last-Modified so we can issue "304 Not Modified" but don't clobber a cached Last-Modified header.
+    if ( $batcache->cache_control && !isset($batcache->cache['headers']['Last-Modified'][0]) ) {
         header( 'Last-Modified: ' . gmdate( 'D, d M Y H:i:s', $batcache->cache['time'] ) . ' GMT', true );
-        header('Cache-Control: max-age=' . ($batcache->max_age - time() + $batcache->cache['time']) . ', must-revalidate', true);
+        header('Cache-Control: max-age=' . ($batcache->cache['max_age'] - time() + $batcache->cache['time']) . ', must-revalidate', true);
     }
 
     // Add some debug info just before </head>
     if ( $batcache->debug ) {
-        if ( false !== $tag_position = strpos($batcache->cache['output'], '</head>') ) {
-            $tag = "<!--\n\tgenerated " . (time() - $batcache->cache['time']) . " seconds ago\n\tgenerated in " . $batcache->cache['timer'] . " seconds\n\tserved from batcache in " . $batcache->timer_stop(false, 3) . " seconds\n\texpires in " . ($batcache->max_age - time() + $batcache->cache['time']) . " seconds\n-->\n";
-            $batcache->cache['output'] = substr($batcache->cache['output'], 0, $tag_position) . $tag . substr($batcache->cache['output'], $tag_position);
-        }
-    }
-
-    if ( !empty($batcache->cache['headers']) ) foreach ( $batcache->cache['headers'] as $k => $v )
-        header("$k: $v", true);
-
-    if ( !empty($batcache->headers) ) foreach ( $batcache->headers as $k => $v ) {
-        if ( is_array( $v ) )
-            header("{$v[0]}: {$v[1]}", false);
-        else
-            header("$k: $v", true);
+        $batcache->add_debug_from_cache();
+    }
+
+    $batcache->do_headers( $batcache->headers, $batcache->cache['headers'] );
+
+    if ( $three04 ) {
+        header("HTTP/1.1 304 Not Modified", true, 304);
+        die;
     }
 
@@ -371 +518 @@
     return;
 
-$wp_filter['status_header'][10]['batcache'] = array( 'function' => array(&$batcache, 'status_header'), 'accepted_args' => 1 );
+$wp_filter['status_header'][10]['batcache'] = array( 'function' => array(&$batcache, 'status_header'), 'accepted_args' => 2 );
 $wp_filter['wp_redirect_status'][10]['batcache'] = array( 'function' => array(&$batcache, 'redirect_status'), 'accepted_args' => 2 );
 

batcache/tags/1.2/batcache.php

@@ -10 +10 @@
 
 // Do not load if our advanced-cache.php isn't loaded
-if ( ! is_object($batcache) || ! method_exists( $wp_object_cache, 'incr' ) )
+if ( ! isset( $batcache ) || ! is_object($batcache) || ! method_exists( $wp_object_cache, 'incr' ) )
     return;
 
@@ -27 +27 @@
 
     $post = get_post($post_id);
-    if ( $post->post_type == 'revision' || get_post_status($post_id) != 'publish' )
+    if ( empty( $post ) || $post->post_type == 'revision' || get_post_status($post_id) != 'publish' )
         return;
 

batcache/tags/1.2/readme.txt

@@ -3 +3 @@
 Tags: cache, memcache, memcached, speed, performance, load, server
 Requires at least: 3.2
-Tested up to: 3.5
+Tested up to: 4.3.1
 Stable tag: 1.2