From: Jack Allnutt <jack@allnutt.eu>
Date: Thu, 8 Aug 2013 23:09:32 +0000 (+0100)
Subject: Don't embded settings in HTML, serve them as a separate JSON file
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=cbcd1a23064ce607ca3247377641525a4721342e;p=KiwiIRC.git

Don't embded settings in HTML, serve them as a separate JSON file
---

diff --git a/client/assets/src/build.js b/client/assets/src/build.js
index d06089b..6aa0611 100644
--- a/client/assets/src/build.js
+++ b/client/assets/src/build.js
@@ -130,47 +130,13 @@ translation_files.forEach(function (file) {
  * Build the index.html file
  */
 
-var index_src = fs.readFileSync(__dirname + '/index.html.tmpl', FILE_ENCODING);
-var vars = {
-    base_path: config.get().http_base_path || '/kiwi',
-    cache_buster: Math.ceil(Math.random() * 9000).toString(),
-    server_settings: {},
-    client_plugins: []
-};
-
-// Any restricted server mode set?
-if (config.get().restrict_server) {
-    vars.server_settings = {
-        connection: {
-            server: config.get().restrict_server,
-            port: config.get().restrict_server_port || 6667,
-            ssl: config.get().restrict_server_ssl,
-            channel: config.get().restrict_server_channel,
-            nick: config.get().restrict_server_nick,
-            allow_change: false
-        }
-    };
-}
-
-// Any client default settings?
-if (config.get().client) {
-    vars.server_settings.client = config.get().client;
-}
-
-// Any client plugins?
-if (config.get().client_plugins && config.get().client_plugins.length > 0) {
-    vars.client_plugins = config.get().client_plugins;
-}
-
-// Translations
-vars.translations = translations;
-
-_.each(vars, function(value, key) {
-    if (typeof value === 'object') value = JSON.stringify(value);
-    index_src = index_src.replace(new RegExp('<%' + key + '%>', 'g'), value);
+var index_src = fs.readFileSync(__dirname + '/index.html.tmpl', FILE_ENCODING)
+    .replace(new RegExp('<%base_path%>', 'g'), config.get().http_base_path || '/kiwi');
+
+fs.writeFile(__dirname + '/../../index.html', index_src, { encoding: FILE_ENCODING }, function (err) {
+    if (!err) {
+        console.log('index.html built');
+    } else {
+        console.log('Error building index.html');
+    }
 });
-
-fs.writeFileSync(__dirname + '/../../index.html', index_src, FILE_ENCODING);
-
-
-console.log('index.html built');
diff --git a/client/assets/src/index.html.tmpl b/client/assets/src/index.html.tmpl
index 470814c..e5fab30 100644
--- a/client/assets/src/index.html.tmpl
+++ b/client/assets/src/index.html.tmpl
@@ -303,13 +303,12 @@
     </script>
 
 
+<script src="<%base_path%>/assets/libs/jquery-1.9.1.min.js"></script>
 <script>
 /* Script loader (https://github.com/ded/script.js) */
 (function(a,b,c){typeof c["module"]!="undefined"&&c.module.exports?c.module.exports=b():typeof c["define"]!="undefined"&&c["define"]=="function"&&c.define.amd?define(a,b):c[a]=b()})("$script",function(){function p(a,b){for(var c=0,d=a.length;c<d;++c)if(!b(a[c]))return j;return 1}function q(a,b){p(a,function(a){return!b(a)})}function r(a,b,i){function o(a){return a.call?a():d[a]}function t(){if(!--n){d[m]=1,l&&l();for(var a in f)p(a.split("|"),o)&&!q(f[a],o)&&(f[a]=[])}}a=a[k]?a:[a];var j=b&&b.call,l=j?b:i,m=j?a.join(""):b,n=a.length;return setTimeout(function(){q(a,function(a){if(h[a])return m&&(e[m]=1),h[a]==2&&t();h[a]=1,m&&(e[m]=1),s(!c.test(a)&&g?g+a+".js":a,t)})},0),r}function s(c,d){var e=a.createElement("script"),f=j;e.onload=e.onerror=e[o]=function(){if(e[m]&&!/^c|loade/.test(e[m])||f)return;e.onload=e[o]=null,f=1,h[c]=2,d()},e.async=1,e.src=c,b.insertBefore(e,b.firstChild)}var a=document,b=a.getElementsByTagName("head")[0],c=/^https?:\/\//,d={},e={},f={},g,h={},i="string",j=!1,k="push",l="DOMContentLoaded",m="readyState",n="addEventListener",o="onreadystatechange";return!a[m]&&a[n]&&(a[n](l,function t(){a.removeEventListener(l,t,j),a[m]="complete"},j),a[m]="loading"),r.get=s,r.order=function(a,b,c){(function d(e){e=a.shift(),a.length?r(e,d):r(e,b,c)})()},r.path=function(a){g=a},r.ready=function(a,b,c){a=a[k]?a:[a];var e=[];return!q(a,function(a){d[a]||e[k](a)})&&p(a,function(a){return d[a]})?b():!function(a){f[a]=f[a]||[],f[a][k](b),c&&c(e)}(a.join("|")),r},r},this)
 
 
-
-
     function getQueryVariable(variable) {
         var query = window.location.search.substring(1);
         var vars = query.split('&');
@@ -322,96 +321,18 @@
     }
 
     window.onload = function () {
-
-        // Common dependancies that are required at all times
-        var scripts = [
-            ['libs/jquery-1.9.1.min.js', 'libs/lodash.min.js'],
-            'libs/backbone.min.js', 'libs/jed.js'
-        ];
-
-        // If in debug mode, load each development script
-        if (getQueryVariable('debug')) {
-            console.log('Loading debugging scripts');
-            scripts = scripts.concat([
-                'src/app.js',
-                [
-                    'src/models/application.js',
-                    'src/models/gateway.js'
-                ],
-                [
-                    'src/models/newconnection.js',
-                    'src/models/panellist.js',
-                    'src/models/networkpanellist.js',
-                    'src/models/panel.js',
-                    'src/models/member.js',
-                    'src/models/memberlist.js',
-                    'src/models/network.js'
-                ],
-                
-                [
-                    'src/models/query.js',
-                    'src/models/channel.js',
-                    'src/models/server.js',
-                    'src/models/applet.js'
-                ],
-
-                [
-                    'src/applets/settings.js',
-                    'src/applets/chanlist.js',
-                    'src/applets/scripteditor.js'
-                ],
-
-                [
-                    'src/models/pluginmanager.js',
-                    'src/models/datastore.js',
-                    'src/helpers/utils.js'
-                ],
-
-                // Some views extend these, so make sure they're loaded beforehand
-                [
-                    'src/views/panel.js'
-                ],
-
-                [
-                    'src/views/channel.js',
-                    'src/views/applet.js',
-                    'src/views/application.js',
-                    'src/views/apptoolbar.js',
-                    'src/views/controlbox.js',
-                    'src/views/favicon.js',
-                    'src/views/mediamessage.js',
-                    'src/views/member.js',
-                    'src/views/memberlist.js',
-                    'src/views/menubox.js',
-                    'src/views/networktabs.js',
-                    'src/views/nickchangebox.js',
-                    'src/views/resizehandler.js',
-                    'src/views/serverselect.js',
-                    'src/views/statusmessage.js',
-                    'src/views/tabs.js',
-                    'src/views/topicbar.js',
-                    'src/views/userbox.js'
-                ]
-            ]);
-        } else {
-            scripts.push('kiwi.min.js?<%cache_buster%>');
-        }
-
-
-        // Run after all dependancies have been loaded
-        function startApp () {
-            var opts = {
+        var base_path = '<%base_path%>', // Entry path for the kiwi application
+            scripts = [],
+            opts = {
                 container: $('#kiwi'),
                 base_path: base_path,
 
                 // Override the kiwi_server to use. (Think: running on standalone client..)
                 //kiwi_server: 'http://kiwiirc.com:80',
-
-                server_settings: <%server_settings%>,
-                client_plugins: <%client_plugins%>,
-                translations: <%translations%>
             };
 
+        // Run after all dependancies have been loaded
+        function startApp () {
             // Start the app
             kiwi.start(opts, function() {
                 // Load any plugins
@@ -450,11 +371,17 @@
             cur_script++;
         }
 
-        // Entry path for the kiwi application
-        var base_path = '<%base_path%>';
-
-        // Start loading scripts
-        loadNextScript();
+        // Load application settings
+        $.getJSON(base_path + '/assets/settings.json', function (data) {
+            scripts = scripts.concat(data.scripts);
+            opts.server_settings = data.server_settings;
+            opts.client_plugins = data.client_plugins;
+            opts.translations = data.translations;
+            opts.locale = data.locale;
+
+            // Start loading scripts
+            loadNextScript();
+        });
     };
 </script>
 </body>
diff --git a/server/httphandler.js b/server/httphandler.js
index 045dd2f..6a25aab 100644
--- a/server/httphandler.js
+++ b/server/httphandler.js
@@ -1,7 +1,9 @@
 var url         = require('url'),
     fs          = require('fs'),
+    crypto      = require('crypto'),
     node_static = require('node-static'),
-    _           = require('lodash');
+    _           = require('lodash'),
+    config      = require('./configuration.js');
 
 
 
@@ -43,6 +45,8 @@ HttpHandler.prototype.serve = function (request, response) {
         } else {
             response.setHeader('Content-Language', request.url.substr(16, request.url.indexOf('.') - 16));
         }
+    } else if (request.url.substr(0, 21) === '/assets/settings.json') {
+        return serveSettings.call(this, request, response);
     }
 
     this.file_server.serve(request, response, function (err) {
@@ -101,3 +105,149 @@ var serveFallbackLocale = function (request, response) {
     //en-gb is our default language, so we serve this as the last possible answer for everything
     this.file_server.serveFile('/assets/locales/en-gb.json', 200, {Vary: 'Accept-Language', 'Content-Language': 'en-gb'}, request, response);
 };
+
+function serveSettings(request, response) {
+    var vars = {
+            server_settings: {},
+            client_plugins: [],
+            translations: [],
+            scripts: [
+                [
+                    'libs/lodash.min.js'
+                ],
+                'libs/backbone.min.js',
+                'libs/jed.js'
+            ]
+        },
+        referrer_url;
+
+    if (request.headers['referer']) {
+        referrer_url = url.parse(request.headers['referer'], true);
+    }
+    if (referrer_url && referrer_url.query && referrer_url.query.debug) {
+        vars.scripts = vars.scripts.concat([
+            'src/app.js',
+            [
+                'src/models/application.js',
+                'src/models/gateway.js'
+            ],
+            [
+                'src/models/newconnection.js',
+                'src/models/panellist.js',
+                'src/models/networkpanellist.js',
+                'src/models/panel.js',
+                'src/models/member.js',
+                'src/models/memberlist.js',
+                'src/models/network.js'
+            ],
+            
+            [
+                'src/models/query.js',
+                'src/models/channel.js',
+                'src/models/server.js',
+                'src/models/applet.js'
+            ],
+
+            [
+                'src/applets/settings.js',
+                'src/applets/chanlist.js',
+                'src/applets/scripteditor.js'
+            ],
+
+            [
+                'src/models/pluginmanager.js',
+                'src/models/datastore.js',
+                'src/helpers/utils.js'
+            ],
+
+            // Some views extend these, so make sure they're loaded beforehand
+            [
+                'src/views/panel.js'
+            ],
+
+            [
+                'src/views/channel.js',
+                'src/views/applet.js',
+                'src/views/application.js',
+                'src/views/apptoolbar.js',
+                'src/views/controlbox.js',
+                'src/views/favicon.js',
+                'src/views/mediamessage.js',
+                'src/views/member.js',
+                'src/views/memberlist.js',
+                'src/views/menubox.js',
+                'src/views/networktabs.js',
+                'src/views/nickchangebox.js',
+                'src/views/resizehandler.js',
+                'src/views/serverselect.js',
+                'src/views/statusmessage.js',
+                'src/views/tabs.js',
+                'src/views/topicbar.js',
+                'src/views/userbox.js'
+            ]
+        ]);
+    } else {
+        vars.scripts.push('kiwi.min.js');
+    }
+
+    // Any restricted server mode set?
+    if (config.get().restrict_server) {
+        vars.server_settings = {
+            connection: {
+                server: config.get().restrict_server,
+                port: config.get().restrict_server_port || 6667,
+                ssl: config.get().restrict_server_ssl,
+                channel: config.get().restrict_server_channel,
+                nick: config.get().restrict_server_nick,
+                allow_change: false
+            }
+        };
+    }
+
+    // Any client default settings?
+    if (config.get().client) {
+        vars.server_settings.client = config.get().client;
+    }
+
+    // Any client plugins?
+    if (config.get().client_plugins && config.get().client_plugins.length > 0) {
+        vars.client_plugins = config.get().client_plugins;
+    }
+
+    fs.readFile(__dirname + '/../client/assets/src/translations/translations.json', function (err, translations) {
+        if (err) {
+            response.statusCode = 500;
+            return response.end();
+        }
+
+        var translation_files;
+        translations = JSON.parse(translations);
+        fs.readdir(__dirname + '/../client/assets/src/translations/', function (err, pofiles) {
+            var hash;
+            if (err) {
+                response.statusCode = 500;
+                return response.end();
+            }
+
+            pofiles.forEach(function (file) {
+                var locale = file.slice(0, -3);
+                if ((file.slice(-3) === '.po') && (locale !== 'template')) {
+                    vars.translations.push({tag: locale, language: translations[locale]});
+                }
+            });
+
+            hash = crypto.createHash('md5').update(JSON.stringify(vars)).digest('hex');
+
+            if (request.headers['if-none-match'] && request.headers['if-none-match'] === hash) {
+                response.writeHead(304, 'Not Modified');
+                return response.end();
+            }
+
+            response.writeHead(200, {
+                'ETag': hash,
+                'Content-Type': 'application/json'
+            });
+            response.end(JSON.stringify(vars));
+        });
+    });
+}