client/assets/dev/model_network.js

   1 (function () {
   2
   3     _kiwi.model.Network = Backbone.Model.extend({
   4         defaults: {
   5             connection_id: 0,
   6             /**
   7             *   The name of the network
   8             *   @type    String
   9             */
  10             name: 'Network',
  11
  12             /**
  13             *   The address (URL) of the network
  14             *   @type    String
  15             */
  16             address: '',
  17
  18             /**
  19             *   The current nickname
  20             *   @type   String
  21             */
  22             nick: '',
  23
  24             /**
  25             *   The channel prefix for this network
  26             *   @type    String
  27             */
  28             channel_prefix: '#',
  29
  30             /**
  31             *   The user prefixes for channel owner/admin/op/voice etc. on this network
  32             *   @type   Array
  33             */
  34             user_prefixes: ['~', '&', '@', '+']
  35         },
  36
  37
  38         initialize: function () {
  39             this.gateway = _kiwi.global.components.Network(this.get('connection_id'));
  40             this.bindGatewayEvents();
  41
  42             // Create our panel list (tabs)
  43             this.panels = new _kiwi.model.PanelList([], this);
  44             //this.panels.network = this;
  45
  46             // Automatically create a server tab
  47             var server_panel = new _kiwi.model.Server({name: 'Server'});
  48             this.panels.add(server_panel);
  49             this.panels.server = this.panels.active = server_panel;
  50         },
  51
  52
  53         bindGatewayEvents: function () {
  54             //this.gateway.on('all', function() {console.log('ALL', this.get('connection_id'), arguments);});
  55
  56             this.gateway.on('connect', onConnect, this);
  57             this.gateway.on('disconnect', onDisconnect, this);
  58
  59             this.gateway.on('nick', function(event) {
  60                 if (event.nick === this.get('nick')) {
  61                     this.set('nick', event.newnick);
  62                 }
  63             }, this);
  64
  65             this.gateway.on('options', onOptions, this);
  66             this.gateway.on('motd', onMotd, this);
  67             this.gateway.on('join', onJoin, this);
  68             this.gateway.on('part', onPart, this);
  69             this.gateway.on('quit', onQuit, this);
  70             this.gateway.on('kick', onKick, this);
  71             this.gateway.on('msg', onMsg, this);
  72             this.gateway.on('nick', onNick, this);
  73             this.gateway.on('ctcp_request', onCtcpRequest, this);
  74             this.gateway.on('ctcp_response', onCtcpResponse, this);
  75             this.gateway.on('notice', onNotice, this);
  76             this.gateway.on('action', onAction, this);
  77             this.gateway.on('topic', onTopic, this);
  78             this.gateway.on('topicsetby', onTopicSetBy, this);
  79             this.gateway.on('userlist', onUserlist, this);
  80             this.gateway.on('userlist_end', onUserlistEnd, this);
  81             this.gateway.on('mode', onMode, this);
  82             this.gateway.on('whois', onWhois, this);
  83             this.gateway.on('away', onAway, this);
  84             this.gateway.on('list_start', onListStart, this);
  85         },
  86
  87
  88         /**
  89          * Create panels and join the channel
  90          * This will not wait for the join event to create a panel. This
  91          * increases responsiveness in case of network lag
  92          */
  93         createAndJoinChannels: function (channels) {
  94             var that = this,
  95                 panels = [];
  96
  97             // Multiple channels may come as comma-delimited
  98             if (typeof channels === 'string') {
  99                 channels = channels.split(',');
 100             }
 101
 102             $.each(channels, function (index, channel_name_key) {
 103                 // We may have a channel key so split it off
 104                 var spli = channel_name_key.trim().split(' '),
 105                     channel_name = spli[0],
 106                     channel_key = spli[1] || '';
 107
 108                 // Trim any whitespace off the name
 109                 channel_name = channel_name.trim();
 110
 111                 // If not a valid channel name, display a warning
 112                 if (!_kiwi.app.isChannelName(channel_name)) {
 113                     that.panels.server.addMsg('', channel_name + ' is not a valid channel name');
 114                     _kiwi.app.message.text(channel_name + ' is not a valid channel name', {timeout: 5000});
 115                     return;
 116                 }
 117
 118                 // Check if we have the panel already. If not, create it
 119                 channel = that.panels.getByName(channel_name);
 120                 if (!channel) {
 121                     channel = new _kiwi.model.Channel({name: channel_name});
 122                     that.panels.add(channel);
 123                 }
 124
 125                 panels.push(channel);
 126
 127                 that.gateway.join(channel_name, channel_key);
 128             });
 129
 130             return panels;
 131         }
 132     });
 133
 134
 135
 136     function onDisconnect(event) {
 137         $.each(this.panels.models, function (index, panel) {
 138             panel.addMsg('', 'Disconnected from the IRC network', 'action quit');
 139         });
 140     }
 141
 142
 143
 144     function onConnect(event) {
 145         var panels, channel_names;
 146
 147         // Update our nick with what the network gave us
 148         this.set('nick', event.nick);
 149
 150         // Auto joining channels
 151         if (this.auto_join && this.auto_join.channel) {
 152             panels = this.createAndJoinChannels(this.auto_join.channel + ' ' + (this.auto_join.channel_key || ''));
 153
 154             // Show the last channel if we have one
 155             if (panels)
 156                 panels[panels.length - 1].view.show();
 157         }
 158     }
 159
 160
 161
 162     function onOptions(event) {
 163         var that = this;
 164
 165         $.each(event.options, function (name, value) {
 166             switch (name) {
 167             case 'CHANTYPES':
 168                 that.set('channel_prefix', value.join(''));
 169                 break;
 170             case 'NETWORK':
 171                 that.set('name', value);
 172                 break;
 173             case 'PREFIX':
 174                 that.set('user_prefixes', value);
 175                 break;
 176             }
 177         });
 178
 179         this.set('cap', event.cap);
 180     }
 181
 182
 183
 184     function onMotd(event) {
 185         this.panels.server.addMsg(this.get('name'), event.msg, 'motd');
 186     }
 187
 188
 189
 190     function onJoin(event) {
 191         var c, members, user;
 192         c = this.panels.getByName(event.channel);
 193         if (!c) {
 194             c = new _kiwi.model.Channel({name: event.channel});
 195             this.panels.add(c);
 196         }
 197
 198         members = c.get('members');
 199         if (!members) return;
 200
 201         user = new _kiwi.model.Member({nick: event.nick, ident: event.ident, hostname: event.hostname});
 202         members.add(user);
 203     }
 204
 205
 206
 207     function onPart(event) {
 208         var channel, members, user,
 209             part_options = {};
 210
 211         part_options.type = 'part';
 212         part_options.message = event.message || '';
 213
 214         channel = this.panels.getByName(event.channel);
 215         if (!channel) return;
 216
 217         // If this is us, close the panel
 218         if (event.nick === this.get('nick')) {
 219             channel.close();
 220             return;
 221         }
 222
 223         members = channel.get('members');
 224         if (!members) return;
 225
 226         user = members.getByNick(event.nick);
 227         if (!user) return;
 228
 229         members.remove(user, part_options);
 230     }
 231
 232
 233
 234     function onQuit(event) {
 235         var member, members,
 236             quit_options = {};
 237
 238         quit_options.type = 'quit';
 239         quit_options.message = event.message || '';
 240
 241         $.each(this.panels.models, function (index, panel) {
 242             if (!panel.isChannel()) return;
 243
 244             member = panel.get('members').getByNick(event.nick);
 245             if (member) {
 246                 panel.get('members').remove(member, quit_options);
 247             }
 248         });
 249     }
 250
 251
 252
 253     function onKick(event) {
 254         var channel, members, user,
 255             part_options = {};
 256
 257         part_options.type = 'kick';
 258         part_options.by = event.nick;
 259         part_options.message = event.message || '';
 260
 261         channel = this.panels.getByName(event.channel);
 262         if (!channel) return;
 263
 264         members = channel.get('members');
 265         if (!members) return;
 266
 267         user = members.getByNick(event.kicked);
 268         if (!user) return;
 269
 270         members.remove(user, part_options);
 271
 272         if (event.kicked === this.get('nick')) {
 273             members.reset([]);
 274         }
 275     }
 276
 277
 278
 279     function onMsg(event) {
 280         var panel,
 281             is_pm = (event.channel == this.get('nick'));
 282
 283         // An ignored user? don't do anything with it
 284         if (_kiwi.gateway.isNickIgnored(event.nick)) {
 285             return;
 286         }
 287
 288         if (is_pm) {
 289             // If a panel isn't found for this PM, create one
 290             panel = this.panels.getByName(event.nick);
 291             if (!panel) {
 292                 panel = new _kiwi.model.Query({name: event.nick});
 293                 this.panels.add(panel);
 294             }
 295
 296         } else {
 297             // If a panel isn't found for this channel, reroute to the
 298             // server panel
 299             panel = this.panels.getByName(event.channel);
 300             if (!panel) {
 301                 panel = this.panels.server;
 302             }
 303         }
 304
 305         panel.addMsg(event.nick, event.msg);
 306     }
 307
 308
 309
 310     function onNick(event) {
 311         var member;
 312
 313         $.each(this.panels.models, function (index, panel) {
 314             if (panel.get('name') == event.nick)
 315                 panel.set('name', event.newnick);
 316
 317             if (!panel.isChannel()) return;
 318
 319             member = panel.get('members').getByNick(event.nick);
 320             if (member) {
 321                 member.set('nick', event.newnick);
 322                 panel.addMsg('', '== ' + event.nick + ' is now known as ' + event.newnick, 'action nick');
 323             }
 324         });
 325     }
 326
 327
 328
 329     function onCtcpRequest(event) {
 330         // An ignored user? don't do anything with it
 331         if (_kiwi.gateway.isNickIgnored(event.nick)) {
 332             return;
 333         }
 334
 335         // Reply to a TIME ctcp
 336         if (event.msg.toUpperCase() === 'TIME') {
 337             this.gateway.ctcp(null, false, event.type, event.nick, (new Date()).toString());
 338         }
 339     }
 340
 341
 342
 343     function onCtcpResponse(event) {
 344         // An ignored user? don't do anything with it
 345         if (_kiwi.gateway.isNickIgnored(event.nick)) {
 346             return;
 347         }
 348
 349         this.panels.server.addMsg('[' + event.nick + ']', 'CTCP ' + event.msg);
 350     }
 351
 352
 353
 354     function onNotice(event) {
 355         var panel;
 356
 357         // An ignored user? don't do anything with it
 358         if (event.nick && _kiwi.gateway.isNickIgnored(event.nick)) {
 359             return;
 360         }
 361
 362         // Find a panel for the destination(channel) or who its from
 363         panel = this.panels.getByName(event.target) || this.panels.getByName(event.nick);
 364         if (!panel) {
 365             panel = this.panels.server;
 366         }
 367
 368         panel.addMsg('[' + (event.nick||'') + ']', event.msg);
 369
 370         // Show this notice to the active panel if it didn't have a set target
 371         if (panel === this.panels.server)
 372             _kiwi.app.panels().active.addMsg('[' + (event.nick||'') + ']', event.msg);
 373     }
 374
 375
 376
 377     function onAction(event) {
 378         var panel,
 379             is_pm = (event.channel == this.get('nick'));
 380
 381         // An ignored user? don't do anything with it
 382         if (_kiwi.gateway.isNickIgnored(event.nick)) {
 383             return;
 384         }
 385
 386         if (is_pm) {
 387             // If a panel isn't found for this PM, create one
 388             panel = this.panels.getByName(event.nick);
 389             if (!panel) {
 390                 panel = new _kiwi.model.Channel({name: event.nick});
 391                 this.panels.add(panel);
 392             }
 393
 394         } else {
 395             // If a panel isn't found for this channel, reroute to the
 396             // server panel
 397             panel = this.panels.getByName(event.channel);
 398             if (!panel) {
 399                 panel = this.panels.server;
 400             }
 401         }
 402
 403         panel.addMsg('', '* ' + event.nick + ' ' + event.msg, 'action');
 404     }
 405
 406
 407
 408     function onTopic(event) {
 409         var c;
 410         c = this.panels.getByName(event.channel);
 411         if (!c) return;
 412
 413         // Set the channels topic
 414         c.set('topic', event.topic);
 415
 416         // If this is the active channel, update the topic bar too
 417         if (c.get('name') === this.panels.active.get('name')) {
 418             _kiwi.app.topicbar.setCurrentTopic(event.topic);
 419         }
 420     }
 421
 422
 423
 424     function onTopicSetBy(event) {
 425         var c, when;
 426         c = this.panels.getByName(event.channel);
 427         if (!c) return;
 428
 429         when = formatDate(new Date(event.when * 1000));
 430         c.addMsg('', 'Topic set by ' + event.nick + ' at ' + when, 'topic');
 431     }
 432
 433
 434
 435     function onUserlist(event) {
 436         var channel;
 437         channel = this.panels.getByName(event.channel);
 438
 439         // If we didn't find a channel for this, may aswell leave
 440         if (!channel) return;
 441
 442         channel.temp_userlist = channel.temp_userlist || [];
 443         _.each(event.users, function (item) {
 444             var user = new _kiwi.model.Member({nick: item.nick, modes: item.modes});
 445             channel.temp_userlist.push(user);
 446         });
 447     }
 448
 449
 450
 451     function onUserlistEnd(event) {
 452         var channel;
 453         channel = this.panels.getByName(event.channel);
 454
 455         // If we didn't find a channel for this, may aswell leave
 456         if (!channel) return;
 457
 458         // Update the members list with the new list
 459         channel.get('members').reset(channel.temp_userlist || []);
 460
 461         // Clear the temporary userlist
 462         delete channel.temp_userlist;
 463     }
 464
 465
 466
 467     function onMode(event) {
 468         var channel, i, prefixes, members, member, find_prefix;
 469
 470         // Build a nicely formatted string to be displayed to a regular human
 471         function friendlyModeString (event_modes, alt_target) {
 472             var modes = {}, return_string;
 473
 474             // If no default given, use the main event info
 475             if (!event_modes) {
 476                 event_modes = event.modes;
 477                 alt_target = event.target;
 478             }
 479
 480             // Reformat the mode object to make it easier to work with
 481             _.each(event_modes, function (mode){
 482                 var param = mode.param || alt_target || '';
 483
 484                 // Make sure we have some modes for this param
 485                 if (!modes[param]) {
 486                     modes[param] = {'+':'', '-':''};
 487                 }
 488
 489                 modes[param][mode.mode[0]] += mode.mode.substr(1);
 490             });
 491
 492             // Put the string together from each mode
 493             return_string = [];
 494             _.each(modes, function (modeset, param) {
 495                 var str = '';
 496                 if (modeset['+']) str += '+' + modeset['+'];
 497                 if (modeset['-']) str += '-' + modeset['-'];
 498                 return_string.push(str + ' ' + param);
 499             });
 500             return_string = return_string.join(', ');
 501
 502             return return_string;
 503         }
 504
 505
 506         channel = this.panels.getByName(event.target);
 507         if (channel) {
 508             prefixes = this.get('user_prefixes');
 509             find_prefix = function (p) {
 510                 return event.modes[i].mode[1] === p.mode;
 511             };
 512             for (i = 0; i < event.modes.length; i++) {
 513                 if (_.any(prefixes, find_prefix)) {
 514                     if (!members) {
 515                         members = channel.get('members');
 516                     }
 517                     member = members.getByNick(event.modes[i].param);
 518                     if (!member) {
 519                         console.log('MODE command recieved for unknown member %s on channel %s', event.modes[i].param, event.target);
 520                         return;
 521                     } else {
 522                         if (event.modes[i].mode[0] === '+') {
 523                             member.addMode(event.modes[i].mode[1]);
 524                         } else if (event.modes[i].mode[0] === '-') {
 525                             member.removeMode(event.modes[i].mode[1]);
 526                         }
 527                         members.sort();
 528                         //channel.addMsg('', '== ' + event.nick + ' set mode ' + event.modes[i].mode + ' ' + event.modes[i].param, 'action mode');
 529                     }
 530                 } else {
 531                     // Channel mode being set
 532                     // TODO: Store this somewhere?
 533                     //channel.addMsg('', 'CHANNEL === ' + event.nick + ' set mode ' + event.modes[i].mode + ' on ' + event.target, 'action mode');
 534                 }
 535             }
 536
 537             channel.addMsg('', '== ' + event.nick + ' sets mode ' + friendlyModeString(), 'action mode');
 538         } else {
 539             // This is probably a mode being set on us.
 540             if (event.target.toLowerCase() === this.get("nick").toLowerCase()) {
 541                 this.panels.server.addMsg('', '== ' + event.nick + ' set mode ' + friendlyModeString(), 'action mode');
 542             } else {
 543                console.log('MODE command recieved for unknown target %s: ', event.target, event);
 544             }
 545         }
 546     }
 547
 548
 549
 550     function onWhois(event) {
 551         var logon_date, idle_time = '', panel;
 552
 553         if (event.end)
 554             return;
 555
 556         if (typeof event.idle !== 'undefined') {
 557             idle_time = secondsToTime(parseInt(event.idle, 10));
 558             idle_time = idle_time.h.toString().lpad(2, "0") + ':' + idle_time.m.toString().lpad(2, "0") + ':' + idle_time.s.toString().lpad(2, "0");
 559         }
 560
 561         panel = _kiwi.app.panels().active;
 562         if (event.ident) {
 563             panel.addMsg(event.nick, event.nick + ' [' + event.nick + '!' + event.ident + '@' + event.host + '] * ' + event.msg, 'whois');
 564         } else if (event.chans) {
 565             panel.addMsg(event.nick, 'Channels: ' + event.chans, 'whois');
 566         } else if (event.irc_server) {
 567             panel.addMsg(event.nick, 'Connected to server: ' + event.irc_server, 'whois');
 568         } else if (event.msg) {
 569             panel.addMsg(event.nick, event.msg, 'whois');
 570         } else if (event.logon) {
 571             logon_date = new Date();
 572             logon_date.setTime(event.logon * 1000);
 573             logon_date = formatDate(logon_date);
 574
 575             panel.addMsg(event.nick, 'idle for ' + idle_time + ', signed on ' + logon_date, 'whois');
 576         } else if (event.away_reason) {
 577             panel.addMsg(event.nick, 'Away: ' + event.away_reason, 'whois');
 578         } else {
 579             panel.addMsg(event.nick, 'idle for ' + idle_time, 'whois');
 580         }
 581     }
 582
 583
 584
 585     function onAway(event) {
 586         $.each(this.panels.models, function (index, panel) {
 587             if (!panel.isChannel()) return;
 588
 589             member = panel.get('members').getByNick(event.nick);
 590             if (member) {
 591                 member.set('away', !(!event.trailing));
 592             }
 593         });
 594     }
 595
 596
 597
 598     function onListStart(event) {
 599         var chanlist = _kiwi.model.Applet.loadOnce('kiwi_chanlist');
 600         chanlist.view.show();
 601     }
 602
 603
 604
 605     function onIrcError(event) {
 606         var panel, tmp;
 607
 608         if (event.channel !== undefined && !(panel = _kiwi.app.panels.getByName(event.channel))) {
 609             panel = this.panels.server;
 610         }
 611
 612         switch (event.error) {
 613         case 'banned_from_channel':
 614             panel.addMsg(' ', '== You are banned from ' + event.channel + '. ' + event.reason, 'status');
 615             _kiwi.app.message.text('You are banned from ' + event.channel + '. ' + event.reason);
 616             break;
 617         case 'bad_channel_key':
 618             panel.addMsg(' ', '== Bad channel key for ' + event.channel, 'status');
 619             _kiwi.app.message.text('Bad channel key or password for ' + event.channel);
 620             break;
 621         case 'invite_only_channel':
 622             panel.addMsg(' ', '== ' + event.channel + ' is invite only.', 'status');
 623             _kiwi.app.message.text(event.channel + ' is invite only');
 624             break;
 625         case 'channel_is_full':
 626             panel.addMsg(' ', '== ' + event.channel + ' is full.', 'status');
 627             _kiwi.app.message.text(event.channel + ' is full');
 628             break;
 629         case 'chanop_privs_needed':
 630             panel.addMsg(' ', '== ' + event.reason, 'status');
 631             _kiwi.app.message.text(event.reason + ' (' + event.channel + ')');
 632             break;
 633         case 'no_such_nick':
 634             tmp = this.panels.getByName(event.nick);
 635             if (tmp) {
 636                 tmp.addMsg(' ', '== ' + event.nick + ': ' + event.reason, 'status');
 637             } else {
 638                 this.panels.server.addMsg(' ', '== ' + event.nick + ': ' + event.reason, 'status');
 639             }
 640             break;
 641         case 'nickname_in_use':
 642             this.panels.server.addMsg(' ', '== The nickname ' + event.nick + ' is already in use. Please select a new nickname', 'status');
 643             if (this.panels.server !== thia.panels.active) {
 644                 _kiwi.app.message.text('The nickname "' + event.nick + '" is already in use. Please select a new nickname');
 645             }
 646
 647             // Only show the nickchange component if the controlbox is open
 648             if (that.controlbox.$el.css('display') !== 'none') {
 649                 (new _kiwi.view.NickChangeBox()).render();
 650             }
 651
 652             break;
 653
 654         case 'password_mismatch':
 655             this.panels.server.addMsg(' ', '== Incorrect password given', 'status');
 656             break;
 657         default:
 658             // We don't know what data contains, so don't do anything with it.
 659             //_kiwi.front.tabviews.server.addMsg(null, ' ', '== ' + data, 'status');
 660         }
 661     }
 662 }
 663
 664 )();