1 // Holds anything kiwi client specific (ie. front, gateway, _kiwi.plugs..)
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)
18 build_version
: '', // Kiwi IRC version this is built from (Set from index.html)
19 settings
: undefined, // Instance of _kiwi.model.DataStore
21 utils
: undefined, // TODO: Re-usable methods
22 user
: undefined, // TODO: Limited user methods
23 server
: undefined, // TODO: Limited server methods
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
28 addMediaMessageType: function(match
, buildHtml
) {
29 _kiwi
.view
.MediaMessage
.addType(match
, buildHtml
);
32 // Event managers for plugins
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
;
41 this.trigger(event_name
, event_data
);
44 // The event we are to proxy
45 proxy_event_name
= proxy_event_name
|| 'all';
48 _
.extend(this, Backbone
.Events
);
49 this._source
= event_source
;
51 // Proxy the events to this dispatcher
52 event_source
.on(proxy_event_name
, proxyEvent
, this);
54 // Clean up this object
55 this.dispose = function () {
56 event_source
.off(proxy_event_name
, proxyEvent
);
58 delete this.event_source
;
62 Network: function(connection_id
) {
65 if (typeof connection_id
!== 'undefined') {
66 connection_event
= 'connection:' + connection_id
.toString();
69 var obj
= new this.EventComponent(_kiwi
.gateway
, connection_event
);
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'
77 // Proxy each gateway method
78 _
.each(funcs
, function(gateway_fn
, func_name
) {
79 obj
[func_name
] = function() {
80 var fn_name
= gateway_fn
;
82 // Add connection_id to the argument list
83 var args
= Array
.prototype.slice
.call(arguments
, 0);
84 args
.unshift(connection_id
);
86 // Call the gateway function on behalf of this connection
87 return _kiwi
.gateway
[fn_name
].apply(_kiwi
.gateway
, args
);
94 ControlInput: function() {
95 var obj
= new this.EventComponent(_kiwi
.app
.controlbox
);
97 run
: 'processInput', addPluginIcon
: 'addPluginIcon'
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
);
111 // Entry point to start the kiwi application
112 init: function (opts
, callback
) {
113 var jobs
, locale
, localeLoaded
, textThemeLoaded
, text_theme
;
116 jobs
= new JobManager();
117 jobs
.onFinish(function(locale
, s
, xhr
) {
118 _kiwi
.app
= new _kiwi
.model
.Application(opts
);
120 // Start the client up
121 _kiwi
.app
.initializeInterfaces();
123 // Now everything has started up, load the plugin manager for third party plugins
124 _kiwi
.global
.plugins
= new _kiwi
.model
.PluginManager();
129 textThemeLoaded = function(text_theme
, s
, xhr
) {
130 opts
.text_theme
= text_theme
;
132 jobs
.finishJob('load_text_theme');
135 localeLoaded = function(locale
, s
, xhr
) {
137 _kiwi
.global
.i18n
= new Jed(locale
);
139 _kiwi
.global
.i18n
= new Jed();
142 jobs
.finishJob('load_locale');
145 // Set up the settings datastore
146 _kiwi
.global
.settings
= _kiwi
.model
.DataStore
.instance('kiwi.settings');
147 _kiwi
.global
.settings
.load();
149 // Set the window title
150 window
.document
.title
= opts
.server_settings
.client
.window_title
|| 'Kiwi IRC';
152 jobs
.registerJob('load_locale');
153 locale
= _kiwi
.global
.settings
.get('locale');
155 $.getJSON(opts
.base_path
+ '/assets/locales/magic.json', localeLoaded
);
157 $.getJSON(opts
.base_path
+ '/assets/locales/' + locale
+ '.json', localeLoaded
);
160 jobs
.registerJob('load_text_theme');
161 text_theme
= opts
.server_settings
.client
.settings
.text_theme
|| 'default';
162 $.getJSON(opts
.base_path
+ '/assets/text_themes/' + text_theme
+ '.json', textThemeLoaded
);
166 _kiwi
.app
.showStartup();
169 // Allow plugins to change the startup applet
170 registerStartupApplet: function(startup_applet_name
) {
171 _kiwi
.app
.startup_applet_name
= startup_applet_name
;
175 * Open a new IRC connection
176 * @param {Object} connection_details {nick, host, port, ssl, password, options}
177 * @param {Function} callback function(err, network){}
179 newIrcConnection: function(connection_details
, callback
) {
180 _kiwi
.gateway
.newConnection(connection_details
, callback
);
185 * Taking settings from the server and URL, extract the default server/channel/nick settings
187 defaultServerSettings: function () {
201 * Get any settings set by the server
202 * These settings may be changed in the server selection dialog or via URL parameters
204 if (_kiwi
.app
.server_settings
.client
) {
205 if (_kiwi
.app
.server_settings
.client
.nick
)
206 defaults
.nick
= _kiwi
.app
.server_settings
.client
.nick
;
208 if (_kiwi
.app
.server_settings
.client
.server
)
209 defaults
.server
= _kiwi
.app
.server_settings
.client
.server
;
211 if (_kiwi
.app
.server_settings
.client
.port
)
212 defaults
.port
= _kiwi
.app
.server_settings
.client
.port
;
214 if (_kiwi
.app
.server_settings
.client
.ssl
)
215 defaults
.ssl
= _kiwi
.app
.server_settings
.client
.ssl
;
217 if (_kiwi
.app
.server_settings
.client
.channel
)
218 defaults
.channel
= _kiwi
.app
.server_settings
.client
.channel
;
220 if (_kiwi
.app
.server_settings
.client
.channel_key
)
221 defaults
.channel_key
= _kiwi
.app
.server_settings
.client
.channel_key
;
227 * Get any settings passed in the URL
228 * These settings may be changed in the server selection dialog
231 // Any query parameters first
232 if (getQueryVariable('nick'))
233 defaults
.nick
= getQueryVariable('nick');
235 if (window
.location
.hash
)
236 defaults
.channel
= window
.location
.hash
;
239 // Process the URL part by part, extracting as we go
240 parts
= window
.location
.pathname
.toString().replace(_kiwi
.app
.get('base_path'), '').split('/');
242 if (parts
.length
> 0) {
245 if (parts
.length
> 0 && parts
[0]) {
246 // 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.
247 uricheck
= parts
[0].substr(0, 7).toLowerCase();
248 if ((uricheck
=== 'ircs%3a') || (uricheck
.substr(0,6) === 'irc%3a')) {
249 parts
[0] = decodeURIComponent(parts
[0]);
250 // irc[s]://<host>[:<port>]/[<channel>[?<password>]]
251 uricheck
= /^irc(s)?:(?:\/\/?)?([^:\/]+)(?::([0-9]+))?(?:(?:\/)([^\?]*)(?:(?:\?)(.*))?)?$/.exec(parts
[0]);
253 uricheck[1] = ssl (optional)
255 uricheck[3] = port (optional)
256 uricheck[4] = channel (optional)
257 uricheck[5] = channel key (optional, channel must also be set)
260 if (typeof uricheck
[1] !== 'undefined') {
262 if (defaults
.port
=== 6667) {
263 defaults
.port
= 6697;
266 defaults
.server
= uricheck
[2];
267 if (typeof uricheck
[3] !== 'undefined') {
268 defaults
.port
= uricheck
[3];
270 if (typeof uricheck
[4] !== 'undefined') {
271 defaults
.channel
= '#' + uricheck
[4];
272 if (typeof uricheck
[5] !== 'undefined') {
273 defaults
.channel_key
= uricheck
[5];
279 // Extract the port+ssl if we find one
280 if (parts
[0].search(/:/) > 0) {
281 defaults
.port
= parts
[0].substring(parts
[0].search(/:/) + 1);
282 defaults
.server
= parts
[0].substring(0, parts
[0].search(/:/));
283 if (defaults
.port
[0] === '+') {
284 defaults
.port
= parseInt(defaults
.port
.substring(1), 10);
287 defaults
.ssl
= false;
291 defaults
.server
= parts
[0];
298 if (parts
.length
> 0 && parts
[0]) {
299 defaults
.channel
= '#' + parts
[0];
304 // If any settings have been given by the server.. override any auto detected settings
306 * Get any server restrictions as set in the server config
307 * These settings can not be changed in the server selection dialog
309 if (_kiwi
.app
.server_settings
&& _kiwi
.app
.server_settings
.connection
) {
310 if (_kiwi
.app
.server_settings
.connection
.server
) {
311 defaults
.server
= _kiwi
.app
.server_settings
.connection
.server
;
314 if (_kiwi
.app
.server_settings
.connection
.port
) {
315 defaults
.port
= _kiwi
.app
.server_settings
.connection
.port
;
318 if (_kiwi
.app
.server_settings
.connection
.ssl
) {
319 defaults
.ssl
= _kiwi
.app
.server_settings
.connection
.ssl
;
322 if (_kiwi
.app
.server_settings
.connection
.channel
) {
323 defaults
.channel
= _kiwi
.app
.server_settings
.connection
.channel
;
326 if (_kiwi
.app
.server_settings
.connection
.channel_key
) {
327 defaults
.channel_key
= _kiwi
.app
.server_settings
.connection
.channel_key
;
330 if (_kiwi
.app
.server_settings
.connection
.nick
) {
331 defaults
.nick
= _kiwi
.app
.server_settings
.connection
.nick
;
335 // Set any random numbers if needed
336 defaults
.nick
= defaults
.nick
.replace('?', Math
.floor(Math
.random() * 100000).toString());
338 if (getQueryVariable('encoding'))
339 defaults
.encoding
= getQueryVariable('encoding');
347 // If within a closure, expose the kiwi globals
348 if (typeof global
!== 'undefined') {
349 global
.kiwi
= _kiwi
.global
;
351 // Not within a closure so set a var in the current scope
352 var kiwi
= _kiwi
.global
;