Commit | Line | Data |
---|---|---|
eaaf73b0 | 1 | // Holds anything kiwi client specific (ie. front, gateway, _kiwi.plugs..)\r |
9df70c63 D |
2 | /**\r |
3 | * @namespace\r | |
4 | */\r | |
eaaf73b0 | 5 | var _kiwi = {};\r |
9df70c63 | 6 | \r |
41cba2fd | 7 | _kiwi.misc = {};\r |
eaaf73b0 D |
8 | _kiwi.model = {};\r |
9 | _kiwi.view = {};\r | |
10 | _kiwi.applets = {};\r | |
b62c8381 D |
11 | \r |
12 | \r | |
13 | /**\r | |
14 | * A global container for third party access\r | |
15 | * Will be used to access a limited subset of kiwi functionality\r | |
16 | * and data (think: plugins)\r | |
17 | */\r | |
eaaf73b0 | 18 | _kiwi.global = {\r |
4c424593 | 19 | build_version: '', // Kiwi IRC version this is built from (Set from index.html)\r |
161b5673 | 20 | settings: undefined, // Instance of _kiwi.model.DataStore\r |
2a89ba11 D |
21 | plugins: undefined, // Instance of _kiwi.model.PluginManager\r |
22 | events: undefined, // Instance of PluginInterface\r | |
1e9f97d6 D |
23 | utils: {}, // References to misc. re-usable helpers / functions\r |
24 | \r | |
25 | initUtils: function() {\r | |
26 | this.utils.randomString = randomString;\r | |
27 | this.utils.secondsToTime = secondsToTime;\r | |
28 | this.utils.parseISO8601 = parseISO8601;\r | |
29 | this.utils.escapeRegex = escapeRegex;\r | |
30 | this.utils.formatIRCMsg = formatIRCMsg;\r | |
31 | this.utils.styleText = styleText;\r | |
32 | this.utils.hsl2rgb = hsl2rgb;\r | |
33 | },\r | |
34 | \r | |
ed8b91d6 D |
35 | rpc: function() {\r |
36 | _kiwi.gateway.rpc.call.call(_kiwi.gateway.rpc, arguments);\r | |
37 | },\r | |
161b5673 | 38 | \r |
f1452889 D |
39 | addMediaMessageType: function(match, buildHtml) {\r |
40 | _kiwi.view.MediaMessage.addType(match, buildHtml);\r | |
41 | },\r | |
42 | \r | |
161b5673 D |
43 | // Event managers for plugins\r |
44 | components: {\r | |
45 | EventComponent: function(event_source, proxy_event_name) {\r | |
9b609554 D |
46 | /*\r |
47 | * proxyEvent() listens for events then re-triggers them on its own\r | |
48 | * event emitter. Why? So we can .off() on this emitter without\r | |
49 | * effecting the source of events. Handy for plugins that we don't\r | |
50 | * trust meddling with the core events.\r | |
51 | *\r | |
52 | * If listening for 'all' events the arguments are as follows:\r | |
53 | * 1. Name of the triggered event\r | |
54 | * 2. The event data\r | |
55 | * For all other events, we only have one argument:\r | |
56 | * 1. The event data\r | |
57 | *\r | |
58 | * When this is used via `new kiwi.components.Network()`, this listens\r | |
59 | * for 'all' events so the first argument is the event name which is\r | |
60 | * the connection ID. We don't want to re-trigger this event name so\r | |
61 | * we need to juggle the arguments to find the real event name we want\r | |
62 | * to emit.\r | |
63 | */\r | |
161b5673 | 64 | function proxyEvent(event_name, event_data) {\r |
9b609554 | 65 | if (proxy_event_name == 'all') {\r |
9b609554 | 66 | } else {\r |
161b5673 | 67 | event_data = event_name.event_data;\r |
f1452889 | 68 | event_name = event_name.event_name;\r |
161b5673 | 69 | }\r |
f1452889 | 70 | \r |
161b5673 D |
71 | this.trigger(event_name, event_data);\r |
72 | }\r | |
73 | \r | |
74 | // The event we are to proxy\r | |
75 | proxy_event_name = proxy_event_name || 'all';\r | |
76 | \r | |
161b5673 D |
77 | _.extend(this, Backbone.Events);\r |
78 | this._source = event_source;\r | |
79 | \r | |
80 | // Proxy the events to this dispatcher\r | |
81 | event_source.on(proxy_event_name, proxyEvent, this);\r | |
82 | \r | |
83 | // Clean up this object\r | |
84 | this.dispose = function () {\r | |
85 | event_source.off(proxy_event_name, proxyEvent);\r | |
86 | this.off();\r | |
87 | delete this.event_source;\r | |
88 | };\r | |
89 | },\r | |
90 | \r | |
91 | Network: function(connection_id) {\r | |
92 | var connection_event;\r | |
93 | \r | |
a9b1c5d6 | 94 | // If no connection id given, use all connections\r |
161b5673 D |
95 | if (typeof connection_id !== 'undefined') {\r |
96 | connection_event = 'connection:' + connection_id.toString();\r | |
18ae1a72 D |
97 | } else {\r |
98 | connection_event = 'connection';\r | |
161b5673 D |
99 | }\r |
100 | \r | |
a9b1c5d6 D |
101 | // Helper to get the network object\r |
102 | var getNetwork = function() {\r | |
103 | var network = typeof connection_id === 'undefined' ?\r | |
104 | _kiwi.app.connections.active_connection :\r | |
105 | _kiwi.app.connections.getByConnectionId(connection_id);\r | |
106 | \r | |
107 | return network ?\r | |
108 | network :\r | |
109 | undefined;\r | |
110 | };\r | |
111 | \r | |
112 | // Create the return object (events proxy from the gateway)\r | |
161b5673 | 113 | var obj = new this.EventComponent(_kiwi.gateway, connection_event);\r |
a9b1c5d6 D |
114 | \r |
115 | // Proxy several gateway functions onto the return object\r | |
161b5673 D |
116 | var funcs = {\r |
117 | kiwi: 'kiwi', raw: 'raw', kick: 'kick', topic: 'topic',\r | |
118 | part: 'part', join: 'join', action: 'action', ctcp: 'ctcp',\r | |
9de52d29 | 119 | ctcpRequest: 'ctcpRequest', ctcpResponse: 'ctcpResponse',\r |
72db27e4 | 120 | notice: 'notice', msg: 'privmsg', changeNick: 'changeNick',\r |
1fd5ab11 | 121 | channelInfo: 'channelInfo', mode: 'mode', quit: 'quit'\r |
161b5673 D |
122 | };\r |
123 | \r | |
161b5673 D |
124 | _.each(funcs, function(gateway_fn, func_name) {\r |
125 | obj[func_name] = function() {\r | |
126 | var fn_name = gateway_fn;\r | |
127 | \r | |
128 | // Add connection_id to the argument list\r | |
129 | var args = Array.prototype.slice.call(arguments, 0);\r | |
130 | args.unshift(connection_id);\r | |
131 | \r | |
132 | // Call the gateway function on behalf of this connection\r | |
133 | return _kiwi.gateway[fn_name].apply(_kiwi.gateway, args);\r | |
134 | };\r | |
135 | });\r | |
136 | \r | |
a9b1c5d6 | 137 | // Add the networks getters/setters\r |
15221ec7 D |
138 | obj.get = function(name) {\r |
139 | var network, restricted_keys;\r | |
140 | \r | |
141 | network = getNetwork();\r | |
a9b1c5d6 D |
142 | if (!network) {\r |
143 | return;\r | |
144 | }\r | |
145 | \r | |
15221ec7 D |
146 | restricted_keys = [\r |
147 | 'password'\r | |
148 | ];\r | |
149 | if (restricted_keys.indexOf(name) > -1) {\r | |
150 | return undefined;\r | |
151 | }\r | |
152 | \r | |
153 | return network.get(name);\r | |
a9b1c5d6 D |
154 | };\r |
155 | \r | |
156 | obj.set = function() {\r | |
157 | var network = getNetwork();\r | |
158 | if (!network) {\r | |
159 | return;\r | |
160 | }\r | |
161 | \r | |
162 | return network.set.apply(network, arguments);\r | |
163 | };\r | |
164 | \r | |
161b5673 D |
165 | return obj;\r |
166 | },\r | |
167 | \r | |
168 | ControlInput: function() {\r | |
169 | var obj = new this.EventComponent(_kiwi.app.controlbox);\r | |
170 | var funcs = {\r | |
d63a5832 | 171 | run: 'processInput', addPluginIcon: 'addPluginIcon'\r |
161b5673 D |
172 | };\r |
173 | \r | |
174 | _.each(funcs, function(controlbox_fn, func_name) {\r | |
175 | obj[func_name] = function() {\r | |
176 | var fn_name = controlbox_fn;\r | |
177 | return _kiwi.app.controlbox[fn_name].apply(_kiwi.app.controlbox, arguments);\r | |
178 | };\r | |
179 | });\r | |
180 | \r | |
181 | return obj;\r | |
182 | }\r | |
183 | },\r | |
184 | \r | |
185 | // Entry point to start the kiwi application\r | |
6b8fbed0 | 186 | init: function (opts, callback) {\r |
c3d988bc | 187 | var jobs, locale, localeLoaded, textThemeLoaded, text_theme;\r |
161b5673 | 188 | opts = opts || {};\r |
b62c8381 | 189 | \r |
1e9f97d6 D |
190 | this.initUtils();\r |
191 | \r | |
28990b2a | 192 | jobs = new JobManager();\r |
c3d988bc | 193 | jobs.onFinish(function(locale, s, xhr) {\r |
161b5673 | 194 | _kiwi.app = new _kiwi.model.Application(opts);\r |
0fa2ca42 | 195 | \r |
161b5673 | 196 | // Start the client up\r |
6b8fbed0 | 197 | _kiwi.app.initializeInterfaces();\r |
62c18d2d | 198 | \r |
2a89ba11 D |
199 | // Event emitter to let plugins interface with parts of kiwi\r |
200 | _kiwi.global.events = new PluginInterface();\r | |
201 | \r | |
f66c4823 D |
202 | // Now everything has started up, load the plugin manager for third party plugins\r |
203 | _kiwi.global.plugins = new _kiwi.model.PluginManager();\r | |
204 | \r | |
c3d988bc D |
205 | callback();\r |
206 | });\r | |
28990b2a | 207 | \r |
c3d988bc D |
208 | textThemeLoaded = function(text_theme, s, xhr) {\r |
209 | opts.text_theme = text_theme;\r | |
28990b2a D |
210 | \r |
211 | jobs.finishJob('load_text_theme');\r | |
212 | };\r | |
0fa2ca42 | 213 | \r |
c3d988bc D |
214 | localeLoaded = function(locale, s, xhr) {\r |
215 | if (locale) {\r | |
216 | _kiwi.global.i18n = new Jed(locale);\r | |
217 | } else {\r | |
218 | _kiwi.global.i18n = new Jed();\r | |
219 | }\r | |
220 | \r | |
221 | jobs.finishJob('load_locale');\r | |
222 | };\r | |
223 | \r | |
f66c4823 D |
224 | // Set up the settings datastore\r |
225 | _kiwi.global.settings = _kiwi.model.DataStore.instance('kiwi.settings');\r | |
226 | _kiwi.global.settings.load();\r | |
227 | \r | |
d26a40c6 | 228 | // Set the window title\r |
2df39a5c | 229 | window.document.title = opts.server_settings.client.window_title || 'Kiwi IRC';\r |
d26a40c6 | 230 | \r |
28990b2a | 231 | jobs.registerJob('load_locale');\r |
19c790f1 | 232 | locale = _kiwi.global.settings.get('locale');\r |
0fa2ca42 | 233 | if (!locale) {\r |
c3d988bc | 234 | $.getJSON(opts.base_path + '/assets/locales/magic.json', localeLoaded);\r |
0fa2ca42 | 235 | } else {\r |
c3d988bc | 236 | $.getJSON(opts.base_path + '/assets/locales/' + locale + '.json', localeLoaded);\r |
0fa2ca42 | 237 | }\r |
d2cf53f5 | 238 | \r |
28990b2a | 239 | jobs.registerJob('load_text_theme');\r |
3a146f27 D |
240 | text_theme = opts.server_settings.client.settings.text_theme || 'default';\r |
241 | $.getJSON(opts.base_path + '/assets/text_themes/' + text_theme + '.json', textThemeLoaded);\r | |
6b8fbed0 D |
242 | },\r |
243 | \r | |
244 | start: function() {\r | |
314fcba8 D |
245 | _kiwi.global.events.emit('loaded')\r |
246 | .done(function() {\r | |
247 | _kiwi.app.showStartup();\r | |
248 | });\r | |
6b8fbed0 D |
249 | },\r |
250 | \r | |
251 | // Allow plugins to change the startup applet\r | |
252 | registerStartupApplet: function(startup_applet_name) {\r | |
253 | _kiwi.app.startup_applet_name = startup_applet_name;\r | |
e537d683 D |
254 | },\r |
255 | \r | |
256 | /**\r | |
257 | * Open a new IRC connection\r | |
258 | * @param {Object} connection_details {nick, host, port, ssl, password, options}\r | |
259 | * @param {Function} callback function(err, network){}\r | |
260 | */\r | |
261 | newIrcConnection: function(connection_details, callback) {\r | |
262 | _kiwi.gateway.newConnection(connection_details, callback);\r | |
d0734219 D |
263 | },\r |
264 | \r | |
265 | \r | |
266 | /**\r | |
267 | * Taking settings from the server and URL, extract the default server/channel/nick settings\r | |
268 | */\r | |
269 | defaultServerSettings: function () {\r | |
270 | var parts;\r | |
271 | var defaults = {\r | |
272 | nick: '',\r | |
273 | server: '',\r | |
274 | port: 6667,\r | |
275 | ssl: false,\r | |
276 | channel: '',\r | |
277 | channel_key: ''\r | |
278 | };\r | |
279 | var uricheck;\r | |
280 | \r | |
281 | \r | |
282 | /**\r | |
283 | * Get any settings set by the server\r | |
284 | * These settings may be changed in the server selection dialog or via URL parameters\r | |
285 | */\r | |
286 | if (_kiwi.app.server_settings.client) {\r | |
287 | if (_kiwi.app.server_settings.client.nick)\r | |
288 | defaults.nick = _kiwi.app.server_settings.client.nick;\r | |
289 | \r | |
290 | if (_kiwi.app.server_settings.client.server)\r | |
291 | defaults.server = _kiwi.app.server_settings.client.server;\r | |
292 | \r | |
293 | if (_kiwi.app.server_settings.client.port)\r | |
294 | defaults.port = _kiwi.app.server_settings.client.port;\r | |
295 | \r | |
296 | if (_kiwi.app.server_settings.client.ssl)\r | |
297 | defaults.ssl = _kiwi.app.server_settings.client.ssl;\r | |
298 | \r | |
299 | if (_kiwi.app.server_settings.client.channel)\r | |
300 | defaults.channel = _kiwi.app.server_settings.client.channel;\r | |
301 | \r | |
302 | if (_kiwi.app.server_settings.client.channel_key)\r | |
303 | defaults.channel_key = _kiwi.app.server_settings.client.channel_key;\r | |
304 | }\r | |
305 | \r | |
306 | \r | |
307 | \r | |
308 | /**\r | |
309 | * Get any settings passed in the URL\r | |
310 | * These settings may be changed in the server selection dialog\r | |
311 | */\r | |
312 | \r | |
313 | // Any query parameters first\r | |
314 | if (getQueryVariable('nick'))\r | |
315 | defaults.nick = getQueryVariable('nick');\r | |
316 | \r | |
317 | if (window.location.hash)\r | |
318 | defaults.channel = window.location.hash;\r | |
319 | \r | |
320 | \r | |
321 | // Process the URL part by part, extracting as we go\r | |
322 | parts = window.location.pathname.toString().replace(_kiwi.app.get('base_path'), '').split('/');\r | |
323 | \r | |
324 | if (parts.length > 0) {\r | |
325 | parts.shift();\r | |
326 | \r | |
327 | if (parts.length > 0 && parts[0]) {\r | |
328 | // 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.\r | |
329 | uricheck = parts[0].substr(0, 7).toLowerCase();\r | |
330 | if ((uricheck === 'ircs%3a') || (uricheck.substr(0,6) === 'irc%3a')) {\r | |
331 | parts[0] = decodeURIComponent(parts[0]);\r | |
332 | // irc[s]://<host>[:<port>]/[<channel>[?<password>]]\r | |
333 | uricheck = /^irc(s)?:(?:\/\/?)?([^:\/]+)(?::([0-9]+))?(?:(?:\/)([^\?]*)(?:(?:\?)(.*))?)?$/.exec(parts[0]);\r | |
334 | /*\r | |
335 | uricheck[1] = ssl (optional)\r | |
336 | uricheck[2] = host\r | |
337 | uricheck[3] = port (optional)\r | |
338 | uricheck[4] = channel (optional)\r | |
339 | uricheck[5] = channel key (optional, channel must also be set)\r | |
340 | */\r | |
341 | if (uricheck) {\r | |
342 | if (typeof uricheck[1] !== 'undefined') {\r | |
343 | defaults.ssl = true;\r | |
344 | if (defaults.port === 6667) {\r | |
345 | defaults.port = 6697;\r | |
346 | }\r | |
347 | }\r | |
348 | defaults.server = uricheck[2];\r | |
349 | if (typeof uricheck[3] !== 'undefined') {\r | |
350 | defaults.port = uricheck[3];\r | |
351 | }\r | |
352 | if (typeof uricheck[4] !== 'undefined') {\r | |
353 | defaults.channel = '#' + uricheck[4];\r | |
354 | if (typeof uricheck[5] !== 'undefined') {\r | |
355 | defaults.channel_key = uricheck[5];\r | |
356 | }\r | |
357 | }\r | |
358 | }\r | |
359 | parts = [];\r | |
360 | } else {\r | |
361 | // Extract the port+ssl if we find one\r | |
362 | if (parts[0].search(/:/) > 0) {\r | |
363 | defaults.port = parts[0].substring(parts[0].search(/:/) + 1);\r | |
364 | defaults.server = parts[0].substring(0, parts[0].search(/:/));\r | |
365 | if (defaults.port[0] === '+') {\r | |
366 | defaults.port = parseInt(defaults.port.substring(1), 10);\r | |
367 | defaults.ssl = true;\r | |
368 | } else {\r | |
369 | defaults.ssl = false;\r | |
370 | }\r | |
371 | \r | |
372 | } else {\r | |
373 | defaults.server = parts[0];\r | |
374 | }\r | |
375 | \r | |
376 | parts.shift();\r | |
377 | }\r | |
378 | }\r | |
379 | \r | |
380 | if (parts.length > 0 && parts[0]) {\r | |
381 | defaults.channel = '#' + parts[0];\r | |
382 | parts.shift();\r | |
383 | }\r | |
384 | }\r | |
385 | \r | |
386 | // If any settings have been given by the server.. override any auto detected settings\r | |
387 | /**\r | |
388 | * Get any server restrictions as set in the server config\r | |
389 | * These settings can not be changed in the server selection dialog\r | |
390 | */\r | |
391 | if (_kiwi.app.server_settings && _kiwi.app.server_settings.connection) {\r | |
392 | if (_kiwi.app.server_settings.connection.server) {\r | |
393 | defaults.server = _kiwi.app.server_settings.connection.server;\r | |
394 | }\r | |
395 | \r | |
396 | if (_kiwi.app.server_settings.connection.port) {\r | |
397 | defaults.port = _kiwi.app.server_settings.connection.port;\r | |
398 | }\r | |
399 | \r | |
400 | if (_kiwi.app.server_settings.connection.ssl) {\r | |
401 | defaults.ssl = _kiwi.app.server_settings.connection.ssl;\r | |
402 | }\r | |
403 | \r | |
404 | if (_kiwi.app.server_settings.connection.channel) {\r | |
405 | defaults.channel = _kiwi.app.server_settings.connection.channel;\r | |
406 | }\r | |
407 | \r | |
408 | if (_kiwi.app.server_settings.connection.channel_key) {\r | |
409 | defaults.channel_key = _kiwi.app.server_settings.connection.channel_key;\r | |
410 | }\r | |
411 | \r | |
412 | if (_kiwi.app.server_settings.connection.nick) {\r | |
413 | defaults.nick = _kiwi.app.server_settings.connection.nick;\r | |
414 | }\r | |
415 | }\r | |
416 | \r | |
417 | // Set any random numbers if needed\r | |
418 | defaults.nick = defaults.nick.replace('?', Math.floor(Math.random() * 100000).toString());\r | |
419 | \r | |
420 | if (getQueryVariable('encoding'))\r | |
421 | defaults.encoding = getQueryVariable('encoding');\r | |
422 | \r | |
423 | return defaults;\r | |
424 | },\r | |
b62c8381 D |
425 | };\r |
426 | \r | |
427 | \r | |
428 | \r | |
429 | // If within a closure, expose the kiwi globals\r | |
430 | if (typeof global !== 'undefined') {\r | |
161b5673 | 431 | global.kiwi = _kiwi.global;\r |
eaaf73b0 | 432 | } else {\r |
161b5673 D |
433 | // Not within a closure so set a var in the current scope\r |
434 | var kiwi = _kiwi.global;\r | |
6636cc9e | 435 | }\r |