1 var net
= require('net'),
3 util
= require('util'),
6 EventBinder
= require('./eventbinder.js'),
7 IrcServer
= require('./server.js'),
8 IrcCommands
= require('./commands.js'),
9 IrcChannel
= require('./channel.js'),
10 IrcUser
= require('./user.js'),
11 EE
= require('../ee.js'),
12 iconv
= require('iconv-lite'),
16 // Break the Node.js version down into usable parts
17 var version_values
= process
.version
.substr(1).split('.').map(function (item
) {
18 return parseInt(item
, 10);
21 // If we have a suitable Nodejs version, bring int he socks functionality
22 if (version_values
[1] >= 10) {
23 Socks
= require('socksjs');
26 var IrcConnection = function (hostname
, port
, ssl
, nick
, user
, pass
, state
, con_num
) {
33 this.setMaxListeners(0);
35 // Set the first configured encoding as the default encoding
36 this.encoding
= global
.config
.default_encoding
;
39 this.connected
= false;
41 // IRCd write buffers (flood controll)
42 this.write_buffer
= [];
44 // In process of writing the buffer?
45 this.writing_buffer
= false;
47 // Max number of lines to write a second
48 this.write_buffer_lines_second
= 2;
50 // If registeration with the IRCd has completed
51 this.registered
= false;
53 // If we are in the CAP negotiation stage
54 this.cap_negotiation
= true;
58 this.user
= user
; // Contains users real hostname and address
59 this.username
= this.nick
.replace(/[^0-9a-zA-Z\-_.\/]/, '');
65 // Connection ID in the state
66 this.con_num
= con_num
;
68 // IRC protocol handling
69 this.irc_commands
= new IrcCommands(this);
72 this.server
= new IrcServer(this, hostname
, port
);
75 this.irc_users
= Object
.create(null);
77 // TODO: use `this.nick` instead of `'*'` when using an IrcUser per nick
78 this.irc_users
[this.nick
] = new IrcUser(this, '*');
81 this.irc_channels
= Object
.create(null);
83 // IRC connection information
84 this.irc_host
= {hostname
: hostname
, port
: port
};
87 // SOCKS proxy details
88 // TODO: Wildcard matching of hostnames and/or CIDR ranges of IP addresses
89 if ((global
.config
.socks_proxy
&& global
.config
.socks_proxy
.enabled
) && ((global
.config
.socks_proxy
.all
) || (_
.contains(global
.config
.socks_proxy
.proxy_hosts
, this.irc_host
.hostname
)))) {
91 host
: global
.config
.socks_proxy
.address
,
92 port
: global
.config
.socks_proxy
.port
,
93 user
: global
.config
.socks_proxy
.user
,
94 pass
: global
.config
.socks_proxy
.pass
100 // Options sent by the IRCd
101 this.options
= Object
.create(null);
102 this.cap
= {requested
: [], enabled
: []};
104 // Is SASL supported on the IRCd
107 // Buffers for data sent from the IRCd
108 this.hold_last
= false;
111 this.applyIrcEvents();
113 util
.inherits(IrcConnection
, EE
);
115 module
.exports
.IrcConnection
= IrcConnection
;
119 IrcConnection
.prototype.applyIrcEvents = function () {
120 // Listen for events on the IRC connection
122 'server * connect': onServerConnect
,
123 'channel * join': onChannelJoin
,
125 // TODO: uncomment when using an IrcUser per nick
126 //'user:*:privmsg': onUserPrivmsg,
127 'user * nick': onUserNick
,
128 'channel * part': onUserParts
,
129 'channel * quit': onUserParts
,
130 'channel * kick': onUserKick
133 EventBinder
.bindIrcEvents('', this.irc_events
, this, this);
138 * Start the connection to the IRCd
140 IrcConnection
.prototype.connect = function () {
143 // The socket connect event to listener for
144 var socket_connect_event_name
= 'connect';
146 // The destination address
147 var dest_addr
= this.socks
?
149 this.irc_host
.hostname
;
151 // Make sure we don't already have an open connection
152 this.disposeSocket();
154 // Get the IP family for the dest_addr (either socks or IRCd destination)
155 getConnectionFamily(dest_addr
, function getConnectionFamilyCb(err
, family
, host
) {
158 // Decide which net. interface to make the connection through
159 if (global
.config
.outgoing_address
) {
160 if ((family
=== 'IPv6') && (global
.config
.outgoing_address
.IPv6
)) {
161 outgoing
= global
.config
.outgoing_address
.IPv6
;
163 outgoing
= global
.config
.outgoing_address
.IPv4
|| '0.0.0.0';
165 // We don't have an IPv6 interface but dest_addr may still resolve to
166 // an IPv4 address. Reset `host` and try connecting anyway, letting it
167 // fail if an IPv4 resolved address is not found
171 // If we have an array of interfaces, select a random one
172 if (typeof outgoing
!== 'string' && outgoing
.length
) {
173 outgoing
= outgoing
[Math
.floor(Math
.random() * outgoing
.length
)];
176 // Make sure we have a valid interface address
177 if (typeof outgoing
!== 'string')
178 outgoing
= '0.0.0.0';
181 // No config was found so use the default
182 outgoing
= '0.0.0.0';
185 // Are we connecting through a SOCKS proxy?
187 that
.socket
= Socks
.connect({
189 port
: that
.irc_host
.port
,
191 rejectUnauthorized
: global
.config
.reject_unauthorised_certificates
192 }, {host
: that
.socks
.host
,
193 port
: that
.socks
.port
,
194 user
: that
.socks
.user
,
195 pass
: that
.socks
.pass
,
196 localAddress
: outgoing
200 // No socks connection, connect directly to the IRCd
203 that
.socket
= tls
.connect({
205 port
: that
.irc_host
.port
,
206 rejectUnauthorized
: global
.config
.reject_unauthorised_certificates
,
207 localAddress
: outgoing
210 socket_connect_event_name
= 'secureConnect';
213 that
.socket
= net
.connect({
215 port
: that
.irc_host
.port
,
216 localAddress
: outgoing
221 // Apply the socket listeners
222 that
.socket
.on(socket_connect_event_name
, function socketConnectCb() {
224 // SSL connections have the actual socket as a property
225 var socket
= (typeof this.socket
!== 'undefined') ?
229 that
.connected
= true;
231 // Make note of the port numbers for any identd lookups
232 // Nodejs < 0.9.6 has no socket.localPort so check this first
233 if (socket
.localPort
) {
234 that
.identd_port_pair
= socket
.localPort
.toString() + '_' + socket
.remotePort
.toString();
235 global
.clients
.port_pairs
[that
.identd_port_pair
] = that
;
238 socketConnectHandler
.call(that
);
241 that
.socket
.on('error', function socketErrorCb(event
) {
242 that
.emit('error', event
);
245 that
.socket
.on('data', function () {
246 parse
.apply(that
, arguments
);
249 that
.socket
.on('close', function socketCloseCb(had_error
) {
250 that
.connected
= false;
252 // Remove this socket form the identd lookup
253 if (that
.identd_port_pair
) {
254 delete global
.clients
.port_pairs
[that
.identd_port_pair
];
259 // Close the whole socket down
260 that
.disposeSocket();
266 * Send an event to the client
268 IrcConnection
.prototype.clientEvent = function (event_name
, data
, callback
) {
269 data
.server
= this.con_num
;
270 this.state
.sendIrcCommand(event_name
, data
, callback
);
274 * Write a line of data to the IRCd
275 * @param data The line of data to be sent
276 * @param force Write the data now, ignoring any write queue
278 IrcConnection
.prototype.write = function (data
, force
) {
279 //ENCODE string to encoding of the server
280 encoded_buffer
= iconv
.encode(data
+ '\r\n', this.encoding
);
283 this.socket
.write(encoded_buffer
);
287 this.write_buffer
.push(encoded_buffer
);
289 // Only flush if we're not writing already
290 if (!this.writing_buffer
)
291 this.flushWriteBuffer();
297 * Flush the write buffer to the server in a throttled fashion
299 IrcConnection
.prototype.flushWriteBuffer = function () {
301 // In case the socket closed between writing our queue.. clean up
302 if (!this.connected
) {
303 this.write_buffer
= [];
304 this.writing_buffer
= false;
308 this.writing_buffer
= true;
310 // Disabled write buffer? Send everything we have
311 if (!this.write_buffer_lines_second
) {
312 this.write_buffer
.forEach(function(buffer
, idx
) {
313 this.socket
.write(buffer
);
314 this.write_buffer
= null;
317 this.write_buffer
= [];
318 this.writing_buffer
= false;
323 // Nothing to write? Stop writing and leave
324 if (this.write_buffer
.length
=== 0) {
325 this.writing_buffer
= false;
329 this.socket
.write(this.write_buffer
[0]);
330 this.write_buffer
= this.write_buffer
.slice(1);
332 // Call this function again at some point if we still have data to write
333 if (this.write_buffer
.length
> 0) {
334 setTimeout(this.flushWriteBuffer
.bind(this), 1000 / this.write_buffer_lines_second
);
336 // No more buffers to write.. so we've finished
337 this.writing_buffer
= false;
344 * Close the connection to the IRCd after forcing one last line
346 IrcConnection
.prototype.end = function (data
, callback
) {
351 this.write(data
, true);
359 * Clean up this IrcConnection instance and any sockets
361 IrcConnection
.prototype.dispose = function () {
362 // If we're still connected, wait until the socket is closed before disposing
363 // so that all the events are still correctly triggered
364 if (this.socket
&& this.connected
) {
370 this.disposeSocket();
373 _
.each(this.irc_users
, function (user
) {
376 _
.each(this.irc_channels
, function (chan
) {
379 this.irc_users
= undefined;
380 this.irc_channels
= undefined;
382 this.server
.dispose();
383 this.server
= undefined;
385 this.irc_commands
= undefined;
387 EventBinder
.unbindIrcEvents('', this.irc_events
, this);
389 this.removeAllListeners();
395 * Clean up any sockets for this IrcConnection
397 IrcConnection
.prototype.disposeSocket = function () {
400 this.socket
.removeAllListeners();
406 * Set a new encoding for this connection
407 * Return true in case of success
410 IrcConnection
.prototype.setEncoding = function (encoding
) {
414 encoded_test
= iconv
.encode("TEST", encoding
);
415 //This test is done to check if this encoding also supports
416 //the ASCII charset required by the IRC protocols
417 //(Avoid the use of base64 or incompatible encodings)
418 if (encoded_test
== "TEST") {
419 this.encoding
= encoding
;
428 function getConnectionFamily(host
, callback
) {
429 if (net
.isIP(host
)) {
430 if (net
.isIPv4(host
)) {
431 callback(null, 'IPv4', host
);
433 callback(null, 'IPv6', host
);
436 dns
.resolve6(host
, function resolve6Cb(err
, addresses
) {
438 callback(null, 'IPv6', addresses
[0]);
440 dns
.resolve4(host
, function resolve4Cb(err
, addresses
) {
442 callback(null, 'IPv4',addresses
[0]);
453 function onChannelJoin(event
) {
456 // Only deal with ourselves joining a channel
457 if (event
.nick
!== this.nick
)
460 // We should only ever get a JOIN command for a channel
461 // we're not already a member of.. but check we don't
462 // have this channel in case something went wrong somewhere
463 // at an earlier point
464 if (!this.irc_channels
[event
.channel
]) {
465 chan
= new IrcChannel(this, event
.channel
);
466 this.irc_channels
[event
.channel
] = chan
;
467 chan
.irc_events
.join
.call(chan
, event
);
472 function onServerConnect(event
) {
473 this.nick
= event
.nick
;
477 function onUserPrivmsg(event
) {
480 // Only deal with messages targetted to us
481 if (event
.channel
!== this.nick
)
484 if (!this.irc_users
[event
.nick
]) {
485 user
= new IrcUser(this, event
.nick
);
486 this.irc_users
[event
.nick
] = user
;
487 user
.irc_events
.privmsg
.call(user
, event
);
492 function onUserNick(event
) {
495 // Only deal with messages targetted to us
496 if (event
.nick
!== this.nick
)
499 this.nick
= event
.newnick
;
503 function onUserParts(event
) {
504 // Only deal with ourselves leaving a channel
505 if (event
.nick
!== this.nick
)
508 if (this.irc_channels
[event
.channel
]) {
509 this.irc_channels
[event
.channel
].dispose();
510 delete this.irc_channels
[event
.channel
];
514 function onUserKick(event
){
515 // Only deal with ourselves being kicked from a channel
516 if (event
.kicked
!== this.nick
)
519 if (this.irc_channels
[event
.channel
]) {
520 this.irc_channels
[event
.channel
].dispose();
521 delete this.irc_channels
[event
.channel
];
530 * Handle the socket connect event, starting the IRCd registration
532 var socketConnectHandler = function () {
536 // Build up data to be used for webirc/etc detection
540 // Array of lines to be sent to the IRCd before anything else
544 // Let the webirc/etc detection modify any required parameters
545 connect_data
= findWebIrc
.call(this, connect_data
);
547 global
.modules
.emit('irc authorize', connect_data
).done(function ircAuthorizeCb() {
548 // Send any initial data for webirc/etc
549 if (connect_data
.prepend_data
) {
550 _
.each(connect_data
.prepend_data
, function(data
) {
555 that
.write('CAP LS');
558 that
.write('PASS ' + that
.password
);
560 that
.write('NICK ' + that
.nick
);
561 that
.write('USER ' + that
.username
+ ' 0 0 :' + '[www.kiwiirc.com] ' + that
.nick
);
563 that
.emit('connected');
570 * Load any WEBIRC or alternative settings for this connection
571 * Called in scope of the IrcConnection instance
573 function findWebIrc(connect_data
) {
574 var webirc_pass
= global
.config
.webirc_pass
,
575 ip_as_username
= global
.config
.ip_as_username
,
579 // Do we have a WEBIRC password for this?
580 if (webirc_pass
&& webirc_pass
[this.irc_host
.hostname
]) {
581 // Build the WEBIRC line to be sent before IRC registration
582 tmp
= 'WEBIRC ' + webirc_pass
[this.irc_host
.hostname
] + ' KiwiIRC ';
583 tmp
+= this.user
.hostname
+ ' ' + this.user
.address
;
585 connect_data
.prepend_data
= [tmp
];
589 // Check if we need to pass the users IP as its username/ident
590 if (ip_as_username
&& ip_as_username
.indexOf(this.irc_host
.hostname
) > -1) {
591 // Get a hex value of the clients IP
592 this.username
= this.user
.address
.split('.').map(function ipSplitMapCb(i
, idx
){
593 var hex
= parseInt(i
, 10).toString(16);
595 // Pad out the hex value if it's a single char
596 if (hex
.length
=== 1)
610 * The regex that parses a line of data from the IRCd
611 * Deviates from the RFC a little to support the '/' character now used in some
614 var parse_regex
= /^(?:(?:(?:(@[^ ]+) )?):(?:([a-z0-9\x5B-\x60\x7B-\x7D\.\-*]+)|([a-z0-9\x5B-\x60\x7B-\x7D\.\-*]+)!([^\x00\r\n\ ]+?)@?([a-z0-9\.\-:\/_]+)?) )?(\S+)(?: (?!:)(.+?))?(?: :(.+))?$/i;
616 var parse = function (data
) {
625 //DECODE server encoding
626 data
= iconv
.decode(data
, this.encoding
);
628 if (this.hold_last
&& this.held_data
!== '') {
629 data
= this.held_data
+ data
;
630 this.hold_last
= false;
634 // If the last line is incomplete, hold it until we have more data
635 if (data
.substr(-1) !== '\n') {
636 this.hold_last
= true;
639 // Process our data line by line
640 data
= data
.split("\n");
641 for (i
= 0; i
< data
.length
; i
++) {
644 // If flagged to hold the last line, store it and move on
645 if (this.hold_last
&& (i
=== data
.length
- 1)) {
646 this.held_data
= data
[i
];
650 // Parse the complete line, removing any carriage returns
651 msg
= parse_regex
.exec(data
[i
].replace(/^\r+|\r+$/, ''));
655 tags
= msg
[1].split(';');
656 for (j
= 0; j
< tags
.length
; j
++) {
657 tag
= tags
[j
].split('=');
658 tags
[j
] = {tag
: tag
[0], value
: tag
[1]};
666 hostname
: msg
[5] || '',
668 params
: msg
[7] || '',
669 trailing
: (msg
[8]) ? msg
[8].trim() : ''
671 msg
.params
= msg
.params
.split(' ');
672 this.irc_commands
.dispatch(msg
.command
.toUpperCase(), msg
);
674 // The line was not parsed correctly, must be malformed
675 console
.log("Malformed IRC line: " + data
[i
].replace(/^\r+|\r+$/, ''));