Changeset 603

Timestamp:

May 3, 2017 1:47:56 PM (7 years ago)

Author:

anonymous

Message:

Add application-wide cache control setting 'http_cache_headers'

Location:

trunk

Files:

• docs/version.txt (modified) (1 diff)
• lib/App.inc.php (modified) (2 diffs)
• lib/CSS.inc.php (modified) (1 diff)
• lib/JS.inc.php (modified) (1 diff)

trunk/docs/version.txt

@@ -1 @@
-2.2.0-6
+2.2.0-7

trunk/lib/App.inc.php

@@ -100 +100 @@
         'signing_method' => 'sha512+base64',
 
+        // Content type of output sent in the Content-type: http header.
+        'content_type' => 'text/html',
+
+        // Allow HTTP caching with max-age setting. Possible values:
+        //  >= 1    Allow HTTP caching with this value set as the max-age (in seconds, i.e., 3600 = 1 hour).
+        //  0       Disallow HTTP caching.
+        //  false   Don't send any cache-related HTTP headers (if you want to control this via server config or custom headers)
+        // This should be '0' for websites that use authentication or have frequently changing dynamic content.
+        'http_cache_headers' => 0,
+
         // Character set for page output. Used in the Content-Type header and the HTML <meta content-type> tag.
         'character_set' => 'utf-8',
@@ -476 +486 @@
         if (!$this->cli) {
             if (!headers_sent($h_file, $h_line)) {
-                header(sprintf('Content-type: text/html; charset=%s', $this->getParam('character_set')));
+                header(sprintf('Content-type: %s; charset=%s', $this->getParam('content_type'), $this->getParam('character_set')));
             } else {
                 $this->logMsg(sprintf('Unable to set Content-type; headers already sent (output started in %s : %s)', $h_file, $h_line), LOG_DEBUG, __FILE__, __LINE__);
+            }
+        }
+
+        // Cache control headers.
+        if (!$this->cli && false !== $this->getParam('http_cache_headers')) {
+            if (!headers_sent($h_file, $h_line)) {
+                if ($this->getParam('http_cache_headers') > 0) {
+                    // Allow HTTP caching, for this many seconds.
+                    header(sprintf('Cache-Control: no-transform, public, max-age=%d', $this->getParam('http_cache_headers')));
+                    header('Vary: Accept-Encoding');
+                } else {
+                    // Disallow HTTP caching entirely. http://stackoverflow.com/a/2068407
+                    header('Cache-Control: no-cache, no-store, must-revalidate'); // HTTP 1.1.
+                    header('Pragma: no-cache'); // HTTP 1.0.
+                    header('Expires: 0'); // Proxies.
+                }
+            } else {
+                $this->logMsg(sprintf('Unable to set Cache-Control; headers already sent (output started in %s : %s)', $h_file, $h_line), LOG_DEBUG, __FILE__, __LINE__);
             }
         }

trunk/lib/CSS.inc.php

@@ -153 +153 @@
             header('Vary: Accept-Encoding');
         } else {
-            header('Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0');
-            header('Expires: -1');
-            header('Pragma: no-cache');
+            // Disallow HTTP caching entirely. http://stackoverflow.com/a/2068407
+            header('Cache-Control: no-cache, no-store, must-revalidate'); // HTTP 1.1.
+            header('Pragma: no-cache'); // HTTP 1.0.
+            header('Expires: 0'); // Proxies.
         }
     }

trunk/lib/JS.inc.php

@@ -153 +153 @@
             header('Vary: Accept-Encoding');
         } else {
-            header('Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0');
-            header('Expires: -1');
-            header('Pragma: no-cache');
+            // Disallow HTTP caching entirely. http://stackoverflow.com/a/2068407
+            header('Cache-Control: no-cache, no-store, must-revalidate'); // HTTP 1.1.
+            header('Pragma: no-cache'); // HTTP 1.0.
+            header('Expires: 0'); // Proxies.
         }
-
     }