🎨 add cache control configurations into the default config

refs #7488

- cache control can be overridden if needed

core/server/apps/private-blogging/lib/middleware.js

@@ -60,11 +60,13 @@ privateBlogging = {
                 if (err) {
                     return next(err);
                 }
+
                 res.writeHead(200, {
                     'Content-Type': 'text/plain',
                     'Content-Length': buf.length,
-                    'Cache-Control': 'public, max-age=' + utils.ONE_HOUR_MS
+                    'Cache-Control': 'public, max-age=' + config.get('caching:robotstxt:maxAge')
                 });
+
                 res.end(buf);
             });
         } else {

core/server/config/defaults.json

@@ -53,5 +53,25 @@
             "lifetime": 3600,
             "freeRetries":99
         }
+    },
+    "caching": {
+        "frontend": {
+            "maxAge": 0
+        },
+        "301": {
+            "maxAge": 31536000
+        },
+        "customRedirects": {
+            "maxAge": 31536000
+        },
+        "favicon": {
+            "maxAge": 86400
+        },
+        "sitemap": {
+            "maxAge": 3600
+        },
+        "robotstxt": {
+            "maxAge": 3600000
+        }
     }
 }

core/server/data/xml/sitemap/handler.js

@@ -1,5 +1,5 @@
 var _       = require('lodash'),
-    utils   = require('../../../utils'),
+    config  = require('../../../config'),
     sitemap = require('./index');
 
 // Responsible for handling requests for sitemap files
@@ -20,7 +20,7 @@ module.exports = function handler(blogApp) {
         var siteMapXml = sitemap.getIndexXml();
 
         res.set({
-            'Cache-Control': 'public, max-age=' + utils.ONE_HOUR_S,
+            'Cache-Control': 'public, max-age=' + config.get('caching:sitemap:maxAge'),
             'Content-Type': 'text/xml'
         });
 
@@ -45,7 +45,7 @@ module.exports = function handler(blogApp) {
             siteMapXml = getResourceSiteMapXml(type, page);
 
         res.set({
-            'Cache-Control': 'public, max-age=' + utils.ONE_HOUR_S,
+            'Cache-Control': 'public, max-age=' + config.get('caching:sitemap:maxAge'),
             'Content-Type': 'text/xml'
         });
 

core/server/middleware/cache-control.js

@@ -7,12 +7,13 @@
 // Allows each app to declare its own default caching rules
 
 var _   = require('lodash'),
+    config = require('../config'),
     cacheControl;
 
 cacheControl = function cacheControl(options) {
     /*jslint unparam:true*/
     var profiles = {
-            public: 'public, max-age=0',
+            public: 'public, max-age=' + config.get('caching:frontend:maxAge'),
             private: 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0'
         },
         output;

core/server/middleware/custom-redirects.js

@@ -2,8 +2,7 @@ var fs = require('fs-extra'),
     _ = require('lodash'),
     config = require('../config'),
     errors = require('../errors'),
-    logging = require('../logging'),
-    utils = require('../utils');
+    logging = require('../logging');
 
 /**
  * you can extend Ghost with a custom redirects file
@@ -42,7 +41,7 @@ module.exports = function redirects(blogApp) {
             }
 
             blogApp.get(new RegExp(redirect.from), function (req, res) {
-                var maxAge = redirect.permanent ? utils.ONE_YEAR_S : 0;
+                var maxAge = redirect.permanent ? config.get('caching:customRedirects:maxAge') : 0;
 
                 res.set({
                     'Cache-Control': 'public, max-age=' + maxAge

core/server/middleware/serve-favicon.js

@@ -3,6 +3,7 @@ var fs = require('fs'),
     crypto = require('crypto'),
     storage = require('../adapters/storage'),
     utils  = require('../utils'),
+    config  = require('../config'),
     settingsCache = require('../settings/cache'),
     blogIconUtils = require('../utils/blog-icon'),
     buildContentResponse,
@@ -14,7 +15,7 @@ buildContentResponse = function buildContentResponse(ext, buf) {
             'Content-Type': 'image/' + ext,
             'Content-Length': buf.length,
             ETag: '"' + crypto.createHash('md5').update(buf, 'utf8').digest('hex') + '"',
-            'Cache-Control': 'public, max-age=' + utils.ONE_DAY_S
+            'Cache-Control': 'public, max-age=' + config.get('caching:favicon:maxAge')
         },
         body: buf
     };

core/server/utils/index.js

@@ -1,5 +1,6 @@
 var unidecode  = require('unidecode'),
     _          = require('lodash'),
+    config = require('../config'),
     utils,
     getRandomInt;
 
@@ -54,6 +55,7 @@ utils = {
 
         return buf.join('');
     },
+
     safeString: function (string, options) {
         options = options || {};
 
@@ -89,11 +91,13 @@ utils = {
 
         return string;
     },
+
     // The token is encoded URL safe by replacing '+' with '-', '\' with '_' and removing '='
     // NOTE: the token is not encoded using valid base64 anymore
     encodeBase64URLsafe: function (base64String) {
         return base64String.replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, '');
     },
+
     // Decode url safe base64 encoding and add padding ('=')
     decodeBase64URLsafe: function (base64String) {
         base64String = base64String.replace(/-/g, '+').replace(/_/g, '/');
@@ -102,9 +106,10 @@ utils = {
         }
         return base64String;
     },
+
     redirect301: function redirect301(res, path) {
         /*jslint unparam:true*/
-        res.set({'Cache-Control': 'public, max-age=' + utils.ONE_YEAR_S});
+        res.set({'Cache-Control': 'public, max-age=' + config.get('caching:301:maxAge')});
         res.redirect(301, path);
     },