server/httphandler.js

   1 var url         = require('url'),
   2     fs          = require('fs'),
   3     crypto      = require('crypto'),
   4     node_static = require('node-static'),
   5     _           = require('lodash'),
   6     config      = require('./configuration.js');
   7
   8
   9 // Cache for settings.json
  10 var cached_settings = {
  11     debug: {
  12         hash: '',
  13         settings: ''
  14     },
  15     production: {
  16         hash: '',
  17         settings: ''
  18     }
  19 };
  20
  21 // Clear the settings cache when the settings change
  22 config.on('loaded', function () {
  23     cached_settings.debug.settings = cached_settings.production.settings = '';
  24     cached_settings.debug.hash = cached_settings.production.hash = '';
  25 });
  26
  27
  28
  29
  30 var HttpHandler = function (config) {
  31     var public_html = config.public_html || 'client/';
  32     this.file_server = new node_static.Server(public_html);
  33 };
  34
  35 module.exports.HttpHandler = HttpHandler;
  36
  37
  38
  39 HttpHandler.prototype.serve = function (request, response) {
  40     // The incoming requests base path (ie. /kiwiclient)
  41     var base_path = global.config.http_base_path || '/kiwi',
  42         base_path_regex;
  43
  44     // Trim of any trailing slashes
  45     if (base_path.substr(base_path.length - 1) === '/') {
  46         base_path = base_path.substr(0, base_path.length - 1);
  47     }
  48
  49     // Build the regex to match the base_path
  50     base_path_regex = base_path.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&');
  51
  52     // Any asset request to head into the asset dir
  53     request.url = request.url.replace(base_path + '/assets/', '/assets/');
  54
  55     // Any src request to head into the src dir
  56     request.url = request.url.replace(base_path + '/src/', '/src/');
  57
  58     // Any requests for /client to load the index file
  59     if (request.url.match(new RegExp('^' + base_path_regex + '([/$]|$)', 'i'))) {
  60         request.url = '/assets/index.html';
  61     }
  62
  63     // If the 'magic' translation is requested, figure out the best language to use from
  64     // the Accept-Language HTTP header. If nothing is suitible, fallback to our en-gb default translation
  65     if (request.url.substr(0, 16) === '/assets/locales/') {
  66         if (request.url === '/assets/locales/magic.json') {
  67             return serveMagicLocale.call(this, request, response);
  68         } else {
  69             response.setHeader('Content-Language', request.url.substr(16, request.url.indexOf('.') - 16));
  70         }
  71     } else if (request.url.substr(0, 21) === '/assets/settings.json') {
  72         return serveSettings.call(this, request, response);
  73     }
  74
  75     this.file_server.serve(request, response, function (err) {
  76         if (err) {
  77             response.writeHead(err.status, err.headers);
  78             response.end();
  79         }
  80     });
  81 };
  82
  83
  84 /**
  85  * Handle the /assets/locales/magic.json request
  86  * Find the closest translation we have for the language
  87  * set in the browser.
  88  **/
  89 var serveMagicLocale = function (request, response) {
  90     var that = this,
  91         default_locale_id = 'en-gb';
  92
  93     if (request.headers['accept-language']) {
  94         fs.readdir('client/assets/locales', function (err, files) {
  95             var available = [],
  96                 i = 0,
  97                 langs = request.headers['accept-language'].split(','), // Example: en-gb,en;q=0.5
  98                 found_locale = default_locale_id;
  99
 100             // Get a list of the available translations we have
 101             files.forEach(function (file) {
 102                 if (file.substr(-5) === '.json') {
 103                     available.push(file.slice(0, -5));
 104                 }
 105             });
 106
 107             // Sanitise the browsers accepted languages and the qualities
 108             for (i = 0; i < langs.length; i++) {
 109                 langs[i]= langs[i].split(';q=');
 110                 langs[i][0] = langs[i][0].toLowerCase();
 111                 langs[i][1] = (typeof langs[i][1] === 'string') ? parseFloat(langs[i][1]) : 1.0;
 112             }
 113
 114             // Sort the accepted languages by quality
 115             langs.sort(function (a, b) {
 116                 return b[1] - a[1];
 117             });
 118
 119             // Serve the first language we have a translation for
 120             for (i = 0; i < langs.length; i++) {
 121                 if (langs[i][0] === '*') {
 122                     break;
 123                 } else if (_.contains(available, langs[i][0])) {
 124                     found_locale = langs[i][0];
 125                     break;
 126                 }
 127             }
 128
 129             return serveLocale.call(that, request, response, found_locale);
 130         });
 131     } else {
 132
 133         // No accept-language specified in the request so send the default
 134         return serveLocale.call(this, request, response, default_locale_id);
 135     }
 136
 137 };
 138
 139
 140 /**
 141  * Send a locale to the browser
 142  */
 143 var serveLocale = function (request, response, locale_id) {
 144     this.file_server.serveFile('/assets/locales/' + locale_id + '.json', 200, {
 145         Vary: 'Accept-Language',
 146         'Content-Language': locale_id
 147     }, request, response);
 148 };
 149
 150
 151 /**
 152  * Handle the settings.json request
 153  */
 154 function serveSettings(request, response) {
 155     var referrer_url,
 156         debug = false,
 157         settings;
 158
 159     // Check the referrer for a debug option
 160     if (request.headers['referer']) {
 161         referrer_url = url.parse(request.headers['referer'], true);
 162         if (referrer_url.query && referrer_url.query.debug) {
 163             debug = true;
 164         }
 165     }
 166
 167     settings = cached_settings[debug ? 'debug' : 'production'];
 168
 169     // Generate the settings if we don't have them cached as yet
 170     if (settings.settings === '') {
 171         generateSettings(request, debug, function (err, settings) {
 172             if (err) {
 173                 response.statusCode = 500;
 174                 response.end();
 175             } else {
 176                 sendSettings.call(this, request, response, settings);
 177             }
 178         });
 179
 180     } else {
 181         sendSettings.call(this, request, response, settings);
 182     }
 183 }
 184
 185
 186 /**
 187  * Send the the settings to the browser
 188  */
 189 function sendSettings(request, response, settings) {
 190     if (request.headers['if-none-match'] && request.headers['if-none-match'] === settings.hash) {
 191         response.writeHead(304, 'Not Modified');
 192         return response.end();
 193     }
 194
 195     response.writeHead(200, {
 196         'ETag': settings.hash,
 197         'Content-Type': 'application/json'
 198     });
 199     response.end(settings.settings);
 200 }
 201
 202
 203 /**
 204  * Generate a settings object for the client.
 205  * Settings include available translations, default client config, etc
 206  */
 207 function generateSettings(request, debug, callback) {
 208     var vars = {
 209             server_settings: {},
 210             client_plugins: [],
 211             translations: [],
 212             scripts: [
 213                 [
 214                     'assets/libs/lodash.min.js'
 215                 ],
 216                 ['assets/libs/backbone.min.js', 'assets/libs/jed.js']
 217             ]
 218         };
 219
 220     if (debug) {
 221         vars.scripts = vars.scripts.concat([
 222             [
 223                 'src/app.js',
 224                 'assets/libs/engine.io.js',
 225                 'assets/libs/engine.io.tools.js'
 226             ],
 227             [
 228                 'src/models/application.js',
 229                 'src/models/gateway.js'
 230             ],
 231             [
 232                 'src/models/newconnection.js',
 233                 'src/models/panellist.js',
 234                 'src/models/networkpanellist.js',
 235                 'src/models/panel.js',
 236                 'src/models/member.js',
 237                 'src/models/memberlist.js',
 238                 'src/models/network.js'
 239             ],
 240
 241             [
 242                 'src/models/channel.js',
 243                 'src/models/applet.js'
 244             ],
 245
 246             [
 247                 'src/models/query.js',
 248                 'src/models/server.js',     // Depends on models/channel.js
 249                 'src/applets/settings.js',
 250                 'src/applets/chanlist.js',
 251                 'src/applets/scripteditor.js'
 252             ],
 253
 254             [
 255                 'src/models/pluginmanager.js',
 256                 'src/models/datastore.js',
 257                 'src/helpers/utils.js'
 258             ],
 259
 260             // Some views extend these, so make sure they're loaded beforehand
 261             [
 262                 'src/views/panel.js'
 263             ],
 264
 265             [
 266                 'src/views/channel.js',
 267                 'src/views/applet.js',
 268                 'src/views/application.js',
 269                 'src/views/apptoolbar.js',
 270                 'src/views/controlbox.js',
 271                 'src/views/favicon.js',
 272                 'src/views/mediamessage.js',
 273                 'src/views/member.js',
 274                 'src/views/memberlist.js',
 275                 'src/views/menubox.js',
 276                 'src/views/networktabs.js',
 277                 'src/views/nickchangebox.js',
 278                 'src/views/resizehandler.js',
 279                 'src/views/serverselect.js',
 280                 'src/views/statusmessage.js',
 281                 'src/views/tabs.js',
 282                 'src/views/topicbar.js',
 283                 'src/views/userbox.js'
 284             ]
 285         ]);
 286     } else {
 287         vars.scripts.push(['assets/kiwi.min.js', 'assets/libs/engine.io.bundle.min.js']);
 288     }
 289
 290     // Any restricted server mode set?
 291     if (config.get().restrict_server) {
 292         vars.server_settings = {
 293             connection: {
 294                 server: config.get().restrict_server,
 295                 port: config.get().restrict_server_port || 6667,
 296                 ssl: config.get().restrict_server_ssl,
 297                 channel: config.get().restrict_server_channel,
 298                 nick: config.get().restrict_server_nick,
 299                 allow_change: false
 300             }
 301         };
 302     }
 303
 304     // Any client default settings?
 305     if (config.get().client) {
 306         vars.server_settings.client = config.get().client;
 307     }
 308
 309     // Any client plugins?
 310     if (config.get().client_plugins && config.get().client_plugins.length > 0) {
 311         vars.client_plugins = config.get().client_plugins;
 312     }
 313
 314     // Get a list of available translations
 315     fs.readFile(__dirname + '/../client/src/translations/translations.json', function (err, translations) {
 316         if (err) {
 317             return callback(err);
 318         }
 319
 320         var translation_files;
 321         translations = JSON.parse(translations);
 322         fs.readdir(__dirname + '/../client/src/translations/', function (err, pofiles) {
 323             var hash, settings;
 324             if (err) {
 325                 return callback(err);
 326             }
 327
 328             pofiles.forEach(function (file) {
 329                 var locale = file.slice(0, -3);
 330                 if ((file.slice(-3) === '.po') && (locale !== 'template')) {
 331                     vars.translations.push({tag: locale, language: translations[locale]});
 332                 }
 333             });
 334
 335             settings = cached_settings[debug?'debug':'production'];
 336             settings.settings = JSON.stringify(vars);
 337             settings.hash = crypto.createHash('md5').update(settings.settings).digest('hex');
 338
 339             return callback(null, settings);
 340         });
 341     });
 342 }
 343