client/src/app.js

   1 // Holds anything kiwi client specific (ie. front, gateway, _kiwi.plugs..)
   2 /**
   3 *   @namespace
   4 */
   5 var _kiwi = {};
   6
   7 _kiwi.model = {};
   8 _kiwi.view = {};
   9 _kiwi.applets = {};
  10
  11
  12 /**
  13  * A global container for third party access
  14  * Will be used to access a limited subset of kiwi functionality
  15  * and data (think: plugins)
  16  */
  17 _kiwi.global = {
  18     build_version: '',  // Kiwi IRC version this is built from (Set from index.html)
  19     settings: undefined, // Instance of _kiwi.model.DataStore
  20     plugins: undefined,
  21     utils: undefined, // TODO: Re-usable methods
  22     user: undefined, // TODO: Limited user methods
  23     server: undefined, // TODO: Limited server methods
  24
  25     // TODO: think of a better term for this as it will also refer to queries
  26     channels: undefined, // TODO: Limited access to panels list
  27
  28     addMediaMessageType: function(match, buildHtml) {
  29         _kiwi.view.MediaMessage.addType(match, buildHtml);
  30     },
  31
  32     // Event managers for plugins
  33     components: {
  34         EventComponent: function(event_source, proxy_event_name) {
  35             function proxyEvent(event_name, event_data) {
  36                 if (proxy_event_name !== 'all') {
  37                     event_data = event_name.event_data;
  38                     event_name = event_name.event_name;
  39                 }
  40
  41                 this.trigger(event_name, event_data);
  42             }
  43
  44             // The event we are to proxy
  45             proxy_event_name = proxy_event_name || 'all';
  46
  47
  48             _.extend(this, Backbone.Events);
  49             this._source = event_source;
  50
  51             // Proxy the events to this dispatcher
  52             event_source.on(proxy_event_name, proxyEvent, this);
  53
  54             // Clean up this object
  55             this.dispose = function () {
  56                 event_source.off(proxy_event_name, proxyEvent);
  57                 this.off();
  58                 delete this.event_source;
  59             };
  60         },
  61
  62         Network: function(connection_id) {
  63             var connection_event;
  64
  65             if (typeof connection_id !== 'undefined') {
  66                 connection_event = 'connection:' + connection_id.toString();
  67             }
  68
  69             var obj = new this.EventComponent(_kiwi.gateway, connection_event);
  70             var funcs = {
  71                 kiwi: 'kiwi', raw: 'raw', kick: 'kick', topic: 'topic',
  72                 part: 'part', join: 'join', action: 'action', ctcp: 'ctcp',
  73                 notice: 'notice', msg: 'privmsg', changeNick: 'changeNick',
  74                 channelInfo: 'channelInfo', mode: 'mode'
  75             };
  76
  77             // Proxy each gateway method
  78             _.each(funcs, function(gateway_fn, func_name) {
  79                 obj[func_name] = function() {
  80                     var fn_name = gateway_fn;
  81
  82                     // Add connection_id to the argument list
  83                     var args = Array.prototype.slice.call(arguments, 0);
  84                     args.unshift(connection_id);
  85
  86                     // Call the gateway function on behalf of this connection
  87                     return _kiwi.gateway[fn_name].apply(_kiwi.gateway, args);
  88                 };
  89             });
  90
  91             return obj;
  92         },
  93
  94         ControlInput: function() {
  95             var obj = new this.EventComponent(_kiwi.app.controlbox);
  96             var funcs = {
  97                 run: 'processInput', addPluginIcon: 'addPluginIcon'
  98             };
  99
 100             _.each(funcs, function(controlbox_fn, func_name) {
 101                 obj[func_name] = function() {
 102                     var fn_name = controlbox_fn;
 103                     return _kiwi.app.controlbox[fn_name].apply(_kiwi.app.controlbox, arguments);
 104                 };
 105             });
 106
 107             return obj;
 108         }
 109     },
 110
 111     // Entry point to start the kiwi application
 112     init: function (opts, callback) {
 113         var jobs, locale, localeLoaded, textThemeLoaded, text_theme;
 114         opts = opts || {};
 115
 116         jobs = new JobManager();
 117         jobs.onFinish(function(locale, s, xhr) {
 118             _kiwi.app = new _kiwi.model.Application(opts);
 119
 120             // Start the client up
 121             _kiwi.app.initializeInterfaces();
 122
 123             // Now everything has started up, load the plugin manager for third party plugins
 124             _kiwi.global.plugins = new _kiwi.model.PluginManager();
 125
 126             callback();
 127         });
 128
 129         textThemeLoaded = function(text_theme, s, xhr) {
 130             opts.text_theme = text_theme;
 131
 132             jobs.finishJob('load_text_theme');
 133         };
 134
 135         localeLoaded = function(locale, s, xhr) {
 136             if (locale) {
 137                 _kiwi.global.i18n = new Jed(locale);
 138             } else {
 139                 _kiwi.global.i18n = new Jed();
 140             }
 141
 142             jobs.finishJob('load_locale');
 143         };
 144
 145         // Set up the settings datastore
 146         _kiwi.global.settings = _kiwi.model.DataStore.instance('kiwi.settings');
 147         _kiwi.global.settings.load();
 148
 149         // Set the window title
 150         window.document.title = opts.server_settings.client.window_title || 'Kiwi IRC';
 151
 152         jobs.registerJob('load_locale');
 153         locale = _kiwi.global.settings.get('locale');
 154         if (!locale) {
 155             $.getJSON(opts.base_path + '/assets/locales/magic.json', localeLoaded);
 156         } else {
 157             $.getJSON(opts.base_path + '/assets/locales/' + locale + '.json', localeLoaded);
 158         }
 159
 160         jobs.registerJob('load_text_theme');
 161         text_theme = opts.text_theme;
 162         if (!text_theme) {
 163             $.getJSON(opts.base_path + '/assets/text_themes/default.json', textThemeLoaded);
 164         } else {
 165             $.getJSON(opts.base_path + '/assets/text_themes/' + text_theme + '.json', textThemeLoaded);
 166         }
 167     },
 168
 169     start: function() {
 170         _kiwi.app.showStartup();
 171     },
 172
 173     // Allow plugins to change the startup applet
 174     registerStartupApplet: function(startup_applet_name) {
 175         _kiwi.app.startup_applet_name = startup_applet_name;
 176     },
 177
 178     /**
 179      * Open a new IRC connection
 180      * @param {Object} connection_details {nick, host, port, ssl, password, options}
 181      * @param {Function} callback function(err, network){}
 182      */
 183     newIrcConnection: function(connection_details, callback) {
 184         _kiwi.gateway.newConnection(connection_details, callback);
 185     },
 186
 187
 188     /**
 189      * Taking settings from the server and URL, extract the default server/channel/nick settings
 190      */
 191     defaultServerSettings: function () {
 192         var parts;
 193         var defaults = {
 194             nick: '',
 195             server: '',
 196             port: 6667,
 197             ssl: false,
 198             channel: '',
 199             channel_key: ''
 200         };
 201         var uricheck;
 202
 203
 204         /**
 205          * Get any settings set by the server
 206          * These settings may be changed in the server selection dialog or via URL parameters
 207          */
 208         if (_kiwi.app.server_settings.client) {
 209             if (_kiwi.app.server_settings.client.nick)
 210                 defaults.nick = _kiwi.app.server_settings.client.nick;
 211
 212             if (_kiwi.app.server_settings.client.server)
 213                 defaults.server = _kiwi.app.server_settings.client.server;
 214
 215             if (_kiwi.app.server_settings.client.port)
 216                 defaults.port = _kiwi.app.server_settings.client.port;
 217
 218             if (_kiwi.app.server_settings.client.ssl)
 219                 defaults.ssl = _kiwi.app.server_settings.client.ssl;
 220
 221             if (_kiwi.app.server_settings.client.channel)
 222                 defaults.channel = _kiwi.app.server_settings.client.channel;
 223
 224             if (_kiwi.app.server_settings.client.channel_key)
 225                 defaults.channel_key = _kiwi.app.server_settings.client.channel_key;
 226         }
 227
 228
 229
 230         /**
 231          * Get any settings passed in the URL
 232          * These settings may be changed in the server selection dialog
 233          */
 234
 235         // Any query parameters first
 236         if (getQueryVariable('nick'))
 237             defaults.nick = getQueryVariable('nick');
 238
 239         if (window.location.hash)
 240             defaults.channel = window.location.hash;
 241
 242
 243         // Process the URL part by part, extracting as we go
 244         parts = window.location.pathname.toString().replace(_kiwi.app.get('base_path'), '').split('/');
 245
 246         if (parts.length > 0) {
 247             parts.shift();
 248
 249             if (parts.length > 0 && parts[0]) {
 250                 // Check to see if we're dealing with an irc: uri, or whether we need to extract the server/channel info from the HTTP URL path.
 251                 uricheck = parts[0].substr(0, 7).toLowerCase();
 252                 if ((uricheck === 'ircs%3a') || (uricheck.substr(0,6) === 'irc%3a')) {
 253                     parts[0] = decodeURIComponent(parts[0]);
 254                     // irc[s]://<host>[:<port>]/[<channel>[?<password>]]
 255                     uricheck = /^irc(s)?:(?:\/\/?)?([^:\/]+)(?::([0-9]+))?(?:(?:\/)([^\?]*)(?:(?:\?)(.*))?)?$/.exec(parts[0]);
 256                     /*
 257                         uricheck[1] = ssl (optional)
 258                         uricheck[2] = host
 259                         uricheck[3] = port (optional)
 260                         uricheck[4] = channel (optional)
 261                         uricheck[5] = channel key (optional, channel must also be set)
 262                     */
 263                     if (uricheck) {
 264                         if (typeof uricheck[1] !== 'undefined') {
 265                             defaults.ssl = true;
 266                             if (defaults.port === 6667) {
 267                                 defaults.port = 6697;
 268                             }
 269                         }
 270                         defaults.server = uricheck[2];
 271                         if (typeof uricheck[3] !== 'undefined') {
 272                             defaults.port = uricheck[3];
 273                         }
 274                         if (typeof uricheck[4] !== 'undefined') {
 275                             defaults.channel = '#' + uricheck[4];
 276                             if (typeof uricheck[5] !== 'undefined') {
 277                                 defaults.channel_key = uricheck[5];
 278                             }
 279                         }
 280                     }
 281                     parts = [];
 282                 } else {
 283                     // Extract the port+ssl if we find one
 284                     if (parts[0].search(/:/) > 0) {
 285                         defaults.port = parts[0].substring(parts[0].search(/:/) + 1);
 286                         defaults.server = parts[0].substring(0, parts[0].search(/:/));
 287                         if (defaults.port[0] === '+') {
 288                             defaults.port = parseInt(defaults.port.substring(1), 10);
 289                             defaults.ssl = true;
 290                         } else {
 291                             defaults.ssl = false;
 292                         }
 293
 294                     } else {
 295                         defaults.server = parts[0];
 296                     }
 297
 298                     parts.shift();
 299                 }
 300             }
 301
 302             if (parts.length > 0 && parts[0]) {
 303                 defaults.channel = '#' + parts[0];
 304                 parts.shift();
 305             }
 306         }
 307
 308         // If any settings have been given by the server.. override any auto detected settings
 309         /**
 310          * Get any server restrictions as set in the server config
 311          * These settings can not be changed in the server selection dialog
 312          */
 313         if (_kiwi.app.server_settings && _kiwi.app.server_settings.connection) {
 314             if (_kiwi.app.server_settings.connection.server) {
 315                 defaults.server = _kiwi.app.server_settings.connection.server;
 316             }
 317
 318             if (_kiwi.app.server_settings.connection.port) {
 319                 defaults.port = _kiwi.app.server_settings.connection.port;
 320             }
 321
 322             if (_kiwi.app.server_settings.connection.ssl) {
 323                 defaults.ssl = _kiwi.app.server_settings.connection.ssl;
 324             }
 325
 326             if (_kiwi.app.server_settings.connection.channel) {
 327                 defaults.channel = _kiwi.app.server_settings.connection.channel;
 328             }
 329
 330             if (_kiwi.app.server_settings.connection.channel_key) {
 331                 defaults.channel_key = _kiwi.app.server_settings.connection.channel_key;
 332             }
 333
 334             if (_kiwi.app.server_settings.connection.nick) {
 335                 defaults.nick = _kiwi.app.server_settings.connection.nick;
 336             }
 337         }
 338
 339         // Set any random numbers if needed
 340         defaults.nick = defaults.nick.replace('?', Math.floor(Math.random() * 100000).toString());
 341
 342         if (getQueryVariable('encoding'))
 343             defaults.encoding = getQueryVariable('encoding');
 344
 345         return defaults;
 346     },
 347 };
 348
 349
 350
 351 // If within a closure, expose the kiwi globals
 352 if (typeof global !== 'undefined') {
 353     global.kiwi = _kiwi.global;
 354 } else {
 355     // Not within a closure so set a var in the current scope
 356     var kiwi = _kiwi.global;
 357 }