1 // Holds anything kiwi client specific (ie. front, gateway, _kiwi.plugs..)
14 * A global container for third party access
15 * Will be used to access a limited subset of kiwi functionality
16 * and data (think: plugins)
19 build_version
: '', // Kiwi IRC version this is built from (Set from index.html)
20 settings
: undefined, // Instance of _kiwi.model.DataStore
21 plugins
: undefined, // Instance of _kiwi.model.PluginManager
22 events
: undefined, // Instance of PluginInterface
23 rpc
: undefined, // Instance of WebsocketRpc
24 utils
: {}, // References to misc. re-usable helpers / functions
26 initUtils: function() {
27 this.utils
.randomString
= randomString
;
28 this.utils
.secondsToTime
= secondsToTime
;
29 this.utils
.parseISO8601
= parseISO8601
;
30 this.utils
.escapeRegex
= escapeRegex
;
31 this.utils
.formatIRCMsg
= formatIRCMsg
;
32 this.utils
.styleText
= styleText
;
33 this.utils
.hsl2rgb
= hsl2rgb
;
36 addMediaMessageType: function(match
, buildHtml
) {
37 _kiwi
.view
.MediaMessage
.addType(match
, buildHtml
);
40 // Event managers for plugins
42 EventComponent: function(event_source
, proxy_event_name
) {
44 * proxyEvent() listens for events then re-triggers them on its own
45 * event emitter. Why? So we can .off() on this emitter without
46 * effecting the source of events. Handy for plugins that we don't
47 * trust meddling with the core events.
49 * If listening for 'all' events the arguments are as follows:
50 * 1. Name of the triggered event
52 * For all other events, we only have one argument:
55 * When this is used via `new kiwi.components.Network()`, this listens
56 * for 'all' events so the first argument is the event name which is
57 * the connection ID. We don't want to re-trigger this event name so
58 * we need to juggle the arguments to find the real event name we want
61 function proxyEvent(event_name
, event_data
) {
62 if (proxy_event_name
== 'all') {
64 event_data
= event_name
.event_data
;
65 event_name
= event_name
.event_name
;
68 this.trigger(event_name
, event_data
);
71 // The event we are to proxy
72 proxy_event_name
= proxy_event_name
|| 'all';
74 _
.extend(this, Backbone
.Events
);
75 this._source
= event_source
;
77 // Proxy the events to this dispatcher
78 event_source
.on(proxy_event_name
, proxyEvent
, this);
80 // Clean up this object
81 this.dispose = function () {
82 event_source
.off(proxy_event_name
, proxyEvent
);
84 delete this.event_source
;
88 Network: function(connection_id
) {
91 // If no connection id given, use all connections
92 if (typeof connection_id
!== 'undefined') {
93 connection_event
= 'connection:' + connection_id
.toString();
95 connection_event
= 'connection';
98 // Helper to get the network object
99 var getNetwork = function() {
100 var network
= typeof connection_id
=== 'undefined' ?
101 _kiwi
.app
.connections
.active_connection
:
102 _kiwi
.app
.connections
.getByConnectionId(connection_id
);
109 // Create the return object (events proxy from the gateway)
110 var obj
= new this.EventComponent(_kiwi
.gateway
, connection_event
);
112 // Proxy several gateway functions onto the return object
114 kiwi
: 'kiwi', raw
: 'raw', kick
: 'kick', topic
: 'topic',
115 part
: 'part', join
: 'join', action
: 'action', ctcp
: 'ctcp',
116 ctcpRequest
: 'ctcpRequest', ctcpResponse
: 'ctcpResponse',
117 notice
: 'notice', msg
: 'privmsg', changeNick
: 'changeNick',
118 channelInfo
: 'channelInfo', mode
: 'mode', quit
: 'quit'
121 _
.each(funcs
, function(gateway_fn
, func_name
) {
122 obj
[func_name
] = function() {
123 var fn_name
= gateway_fn
;
125 // Add connection_id to the argument list
126 var args
= Array
.prototype.slice
.call(arguments
, 0);
127 args
.unshift(connection_id
);
129 // Call the gateway function on behalf of this connection
130 return _kiwi
.gateway
[fn_name
].apply(_kiwi
.gateway
, args
);
134 // Add the networks getters/setters
135 obj
.get = function(name
) {
136 var network
, restricted_keys
;
138 network
= getNetwork();
146 if (restricted_keys
.indexOf(name
) > -1) {
150 return network
.get(name
);
153 obj
.set = function() {
154 var network
= getNetwork();
159 return network
.set.apply(network
, arguments
);
165 ControlInput: function() {
166 var obj
= new this.EventComponent(_kiwi
.app
.controlbox
);
168 run
: 'processInput', addPluginIcon
: 'addPluginIcon'
171 _
.each(funcs
, function(controlbox_fn
, func_name
) {
172 obj
[func_name
] = function() {
173 var fn_name
= controlbox_fn
;
174 return _kiwi
.app
.controlbox
[fn_name
].apply(_kiwi
.app
.controlbox
, arguments
);
182 // Entry point to start the kiwi application
183 init: function (opts
, callback
) {
184 var localePromise
, themePromise
,
190 // Set up the settings datastore
191 _kiwi
.global
.settings
= _kiwi
.model
.DataStore
.instance('kiwi.settings');
192 _kiwi
.global
.settings
.load();
194 // Set the window title
195 window
.document
.title
= opts
.server_settings
.client
.window_title
|| 'Kiwi IRC';
197 localePromise
= new Promise(function (resolve
) {
198 var locale
= _kiwi
.global
.settings
.get('locale') || 'magic';
199 $.getJSON(opts
.base_path
+ '/assets/locales/' + locale
+ '.json', function (locale
) {
201 that
.i18n
= new Jed(locale
);
203 that
.i18n
= new Jed();
209 themePromise
= new Promise(function (resolve
) {
210 var text_theme
= opts
.server_settings
.client
.settings
.text_theme
|| 'default';
211 $.getJSON(opts
.base_path
+ '/assets/text_themes/' + text_theme
+ '.json', function(text_theme
) {
212 opts
.text_theme
= text_theme
;
218 Promise
.all([localePromise
, themePromise
]).then(function () {
219 _kiwi
.app
= new _kiwi
.model
.Application(opts
);
221 // Start the client up
222 _kiwi
.app
.initializeInterfaces();
224 // Event emitter to let plugins interface with parts of kiwi
225 _kiwi
.global
.events
= new PluginInterface();
227 // Now everything has started up, load the plugin manager for third party plugins
228 _kiwi
.global
.plugins
= new _kiwi
.model
.PluginManager();
235 _kiwi
.app
.showStartup();
238 // Allow plugins to change the startup applet
239 registerStartupApplet: function(startup_applet_name
) {
240 _kiwi
.app
.startup_applet_name
= startup_applet_name
;
244 * Open a new IRC connection
245 * @param {Object} connection_details {nick, host, port, ssl, password, options}
246 * @param {Function} callback function(err, network){}
248 newIrcConnection: function(connection_details
, callback
) {
249 _kiwi
.gateway
.newConnection(connection_details
, callback
);
254 * Taking settings from the server and URL, extract the default server/channel/nick settings
256 defaultServerSettings: function () {
270 * Get any settings set by the server
271 * These settings may be changed in the server selection dialog or via URL parameters
273 if (_kiwi
.app
.server_settings
.client
) {
274 if (_kiwi
.app
.server_settings
.client
.nick
)
275 defaults
.nick
= _kiwi
.app
.server_settings
.client
.nick
;
277 if (_kiwi
.app
.server_settings
.client
.server
)
278 defaults
.server
= _kiwi
.app
.server_settings
.client
.server
;
280 if (_kiwi
.app
.server_settings
.client
.port
)
281 defaults
.port
= _kiwi
.app
.server_settings
.client
.port
;
283 if (_kiwi
.app
.server_settings
.client
.ssl
)
284 defaults
.ssl
= _kiwi
.app
.server_settings
.client
.ssl
;
286 if (_kiwi
.app
.server_settings
.client
.channel
)
287 defaults
.channel
= _kiwi
.app
.server_settings
.client
.channel
;
289 if (_kiwi
.app
.server_settings
.client
.channel_key
)
290 defaults
.channel_key
= _kiwi
.app
.server_settings
.client
.channel_key
;
296 * Get any settings passed in the URL
297 * These settings may be changed in the server selection dialog
300 // Any query parameters first
301 if (getQueryVariable('nick'))
302 defaults
.nick
= getQueryVariable('nick');
304 if (window
.location
.hash
)
305 defaults
.channel
= window
.location
.hash
;
308 // Process the URL part by part, extracting as we go
309 parts
= window
.location
.pathname
.toString().replace(_kiwi
.app
.get('base_path'), '').split('/');
311 if (parts
.length
> 0) {
314 if (parts
.length
> 0 && parts
[0]) {
315 // 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.
316 uricheck
= parts
[0].substr(0, 7).toLowerCase();
317 if ((uricheck
=== 'ircs%3a') || (uricheck
.substr(0,6) === 'irc%3a')) {
318 parts
[0] = decodeURIComponent(parts
[0]);
319 // irc[s]://<host>[:<port>]/[<channel>[?<password>]]
320 uricheck
= /^irc(s)?:(?:\/\/?)?([^:\/]+)(?::([0-9]+))?(?:(?:\/)([^\?]*)(?:(?:\?)(.*))?)?$/.exec(parts
[0]);
322 uricheck[1] = ssl (optional)
324 uricheck[3] = port (optional)
325 uricheck[4] = channel (optional)
326 uricheck[5] = channel key (optional, channel must also be set)
329 if (typeof uricheck
[1] !== 'undefined') {
331 if (defaults
.port
=== 6667) {
332 defaults
.port
= 6697;
335 defaults
.server
= uricheck
[2];
336 if (typeof uricheck
[3] !== 'undefined') {
337 defaults
.port
= uricheck
[3];
339 if (typeof uricheck
[4] !== 'undefined') {
340 defaults
.channel
= '#' + uricheck
[4];
341 if (typeof uricheck
[5] !== 'undefined') {
342 defaults
.channel_key
= uricheck
[5];
348 // Extract the port+ssl if we find one
349 if (parts
[0].search(/:/) > 0) {
350 defaults
.port
= parts
[0].substring(parts
[0].search(/:/) + 1);
351 defaults
.server
= parts
[0].substring(0, parts
[0].search(/:/));
352 if (defaults
.port
[0] === '+') {
353 defaults
.port
= parseInt(defaults
.port
.substring(1), 10);
356 defaults
.ssl
= false;
360 defaults
.server
= parts
[0];
367 if (parts
.length
> 0 && parts
[0]) {
368 defaults
.channel
= '#' + parts
[0];
373 // If any settings have been given by the server.. override any auto detected settings
375 * Get any server restrictions as set in the server config
376 * These settings can not be changed in the server selection dialog
378 if (_kiwi
.app
.server_settings
&& _kiwi
.app
.server_settings
.connection
) {
379 if (_kiwi
.app
.server_settings
.connection
.server
) {
380 defaults
.server
= _kiwi
.app
.server_settings
.connection
.server
;
383 if (_kiwi
.app
.server_settings
.connection
.port
) {
384 defaults
.port
= _kiwi
.app
.server_settings
.connection
.port
;
387 if (_kiwi
.app
.server_settings
.connection
.ssl
) {
388 defaults
.ssl
= _kiwi
.app
.server_settings
.connection
.ssl
;
391 if (_kiwi
.app
.server_settings
.connection
.channel
) {
392 defaults
.channel
= _kiwi
.app
.server_settings
.connection
.channel
;
395 if (_kiwi
.app
.server_settings
.connection
.channel_key
) {
396 defaults
.channel_key
= _kiwi
.app
.server_settings
.connection
.channel_key
;
399 if (_kiwi
.app
.server_settings
.connection
.nick
) {
400 defaults
.nick
= _kiwi
.app
.server_settings
.connection
.nick
;
404 // Set any random numbers if needed
405 defaults
.nick
= defaults
.nick
.replace('?', Math
.floor(Math
.random() * 100000).toString());
407 if (getQueryVariable('encoding'))
408 defaults
.encoding
= getQueryVariable('encoding');
416 // If within a closure, expose the kiwi globals
417 if (typeof global
!== 'undefined') {
418 global
.kiwi
= _kiwi
.global
;
420 // Not within a closure so set a var in the current scope
421 var kiwi
= _kiwi
.global
;