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'),
13 Proxy
= require('../proxy.js'),
17 // Break the Node.js version down into usable parts
18 var version_values
= process
.version
.substr(1).split('.').map(function (item
) {
19 return parseInt(item
, 10);
22 // If we have a suitable Nodejs version, bring int he socks functionality
23 if (version_values
[1] >= 10) {
24 Socks
= require('socksjs');
27 var IrcConnection = function (hostname
, port
, ssl
, nick
, user
, options
, state
, con_num
) {
34 this.setMaxListeners(0);
36 options
= options
|| {};
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\-_.\/]/, '');
60 this.password
= options
.password
|| '';
62 // Set the passed encoding. or the default if none giving or it fails
63 if (!options
.encoding
|| !this.setEncoding(options
.encoding
)) {
64 this.setEncoding(global
.config
.default_encoding
);
70 // Connection ID in the state
71 this.con_num
= con_num
;
73 // IRC protocol handling
74 this.irc_commands
= new IrcCommands(this);
77 this.server
= new IrcServer(this, hostname
, port
);
80 this.irc_users
= Object
.create(null);
82 // TODO: use `this.nick` instead of `'*'` when using an IrcUser per nick
83 this.irc_users
[this.nick
] = new IrcUser(this, '*');
86 this.irc_channels
= Object
.create(null);
88 // IRC connection information
89 this.irc_host
= {hostname
: hostname
, port
: port
};
92 // SOCKS proxy details
93 // TODO: Wildcard matching of hostnames and/or CIDR ranges of IP addresses
94 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
)))) {
96 host
: global
.config
.socks_proxy
.address
,
97 port
: global
.config
.socks_proxy
.port
,
98 user
: global
.config
.socks_proxy
.user
,
99 pass
: global
.config
.socks_proxy
.pass
105 // Kiwi proxy info may be set within a server module. {port: 7779, host: 'kiwi.proxy.com', ssl: false}
108 // Net. interface this connection should be made through
109 this.outgoing_interface
= false;
111 // Options sent by the IRCd
112 this.options
= Object
.create(null);
113 this.cap
= {requested
: [], enabled
: []};
115 // Is SASL supported on the IRCd
118 // Buffers for data sent from the IRCd
119 this.hold_last
= false;
120 this.held_data
= null;
122 this.applyIrcEvents();
124 util
.inherits(IrcConnection
, EE
);
126 module
.exports
.IrcConnection
= IrcConnection
;
130 IrcConnection
.prototype.applyIrcEvents = function () {
131 // Listen for events on the IRC connection
133 'server * connect': onServerConnect
,
134 'channel * join': onChannelJoin
,
136 // TODO: uncomment when using an IrcUser per nick
137 //'user:*:privmsg': onUserPrivmsg,
138 'user * nick': onUserNick
,
139 'channel * part': onUserParts
,
140 'channel * quit': onUserParts
,
141 'channel * kick': onUserKick
144 EventBinder
.bindIrcEvents('', this.irc_events
, this, this);
149 * Start the connection to the IRCd
151 IrcConnection
.prototype.connect = function () {
154 // The socket connect event to listener for
155 var socket_connect_event_name
= 'connect';
157 // The destination address
160 dest_addr
= this.socks
.host
;
161 } else if (this.proxy
) {
162 dest_addr
= this.proxy
.host
;
164 dest_addr
= this.irc_host
.hostname
;
167 // Make sure we don't already have an open connection
168 this.disposeSocket();
170 // Get the IP family for the dest_addr (either socks or IRCd destination)
171 getConnectionFamily(dest_addr
, function getConnectionFamilyCb(err
, family
, host
) {
174 // Decide which net. interface to make the connection through
175 if (that
.outgoing_interface
) {
176 // An specific interface has been given for this connection
177 outgoing
= this.outgoing_interface
;
179 } else if (global
.config
.outgoing_address
) {
180 // Pick an interface from the config
181 if ((family
=== 'IPv6') && (global
.config
.outgoing_address
.IPv6
)) {
182 outgoing
= global
.config
.outgoing_address
.IPv6
;
184 outgoing
= global
.config
.outgoing_address
.IPv4
|| '0.0.0.0';
186 // We don't have an IPv6 interface but dest_addr may still resolve to
187 // an IPv4 address. Reset `host` and try connecting anyway, letting it
188 // fail if an IPv4 resolved address is not found
192 // If we have an array of interfaces, select a random one
193 if (typeof outgoing
!== 'string' && outgoing
.length
) {
194 outgoing
= outgoing
[Math
.floor(Math
.random() * outgoing
.length
)];
197 // Make sure we have a valid interface address
198 if (typeof outgoing
!== 'string')
199 outgoing
= '0.0.0.0';
202 // No config was found so use the default
203 outgoing
= '0.0.0.0';
206 // Are we connecting through a SOCKS proxy?
208 that
.socket
= Socks
.connect({
209 host
: that
.irc_host
.host
,
210 port
: that
.irc_host
.port
,
212 rejectUnauthorized
: global
.config
.reject_unauthorised_certificates
214 port
: that
.socks
.port
,
215 user
: that
.socks
.user
,
216 pass
: that
.socks
.pass
,
217 localAddress
: outgoing
220 } else if (that
.proxy
) {
221 that
.socket
= new Proxy
.ProxySocket(that
.proxy
.port
, host
, {
222 username
: that
.username
,
224 that
.socket
.connect(that
.irc_host
.port
, that
.irc_host
.hostname
);
227 // No socks connection, connect directly to the IRCd
230 that
.socket
= tls
.connect({
232 port
: that
.irc_host
.port
,
233 rejectUnauthorized
: global
.config
.reject_unauthorised_certificates
,
234 localAddress
: outgoing
237 // We need the raw socket connect event
238 that
.socket
.socket
.on('connect', function() { rawSocketConnect
.call(that
, this); });
240 socket_connect_event_name
= 'secureConnect';
243 that
.socket
= net
.connect({
245 port
: that
.irc_host
.port
,
246 localAddress
: outgoing
251 // Apply the socket listeners
252 that
.socket
.on(socket_connect_event_name
, function socketConnectCb() {
254 // TLS connections have the actual socket as a property
255 var is_tls
= (typeof this.socket
!== 'undefined') ?
259 // TLS sockets have already called this
261 rawSocketConnect
.call(that
, this);
263 that
.connected
= true;
265 socketConnectHandler
.call(that
);
268 that
.socket
.on('error', function socketErrorCb(event
) {
269 that
.emit('error', event
);
272 that
.socket
.on('data', function () {
273 socketOnData
.apply(that
, arguments
);
276 that
.socket
.on('close', function socketCloseCb(had_error
) {
277 that
.connected
= false;
279 // Remove this socket form the identd lookup
280 if (that
.identd_port_pair
) {
281 delete global
.clients
.port_pairs
[that
.identd_port_pair
];
286 // Close the whole socket down
287 that
.disposeSocket();
293 * Send an event to the client
295 IrcConnection
.prototype.clientEvent = function (event_name
, data
, callback
) {
296 data
.server
= this.con_num
;
297 this.state
.sendIrcCommand(event_name
, data
, callback
);
301 * Write a line of data to the IRCd
302 * @param data The line of data to be sent
303 * @param force Write the data now, ignoring any write queue
305 IrcConnection
.prototype.write = function (data
, force
) {
306 //ENCODE string to encoding of the server
307 encoded_buffer
= iconv
.encode(data
+ '\r\n', this.encoding
);
310 this.socket
.write(encoded_buffer
);
314 this.write_buffer
.push(encoded_buffer
);
316 // Only flush if we're not writing already
317 if (!this.writing_buffer
)
318 this.flushWriteBuffer();
324 * Flush the write buffer to the server in a throttled fashion
326 IrcConnection
.prototype.flushWriteBuffer = function () {
328 // In case the socket closed between writing our queue.. clean up
329 if (!this.connected
) {
330 this.write_buffer
= [];
331 this.writing_buffer
= false;
335 this.writing_buffer
= true;
337 // Disabled write buffer? Send everything we have
338 if (!this.write_buffer_lines_second
) {
339 this.write_buffer
.forEach(function(buffer
, idx
) {
340 this.socket
.write(buffer
);
341 this.write_buffer
= null;
344 this.write_buffer
= [];
345 this.writing_buffer
= false;
350 // Nothing to write? Stop writing and leave
351 if (this.write_buffer
.length
=== 0) {
352 this.writing_buffer
= false;
356 this.socket
.write(this.write_buffer
[0]);
357 this.write_buffer
= this.write_buffer
.slice(1);
359 // Call this function again at some point if we still have data to write
360 if (this.write_buffer
.length
> 0) {
361 setTimeout(this.flushWriteBuffer
.bind(this), 1000 / this.write_buffer_lines_second
);
363 // No more buffers to write.. so we've finished
364 this.writing_buffer
= false;
371 * Close the connection to the IRCd after forcing one last line
373 IrcConnection
.prototype.end = function (data
, callback
) {
378 this.write(data
, true);
386 * Clean up this IrcConnection instance and any sockets
388 IrcConnection
.prototype.dispose = function () {
389 // If we're still connected, wait until the socket is closed before disposing
390 // so that all the events are still correctly triggered
391 if (this.socket
&& this.connected
) {
397 this.disposeSocket();
400 _
.each(this.irc_users
, function (user
) {
403 _
.each(this.irc_channels
, function (chan
) {
406 this.irc_users
= undefined;
407 this.irc_channels
= undefined;
409 this.server
.dispose();
410 this.server
= undefined;
412 this.irc_commands
= undefined;
414 EventBinder
.unbindIrcEvents('', this.irc_events
, this);
416 this.removeAllListeners();
422 * Clean up any sockets for this IrcConnection
424 IrcConnection
.prototype.disposeSocket = function () {
427 this.socket
.removeAllListeners();
433 * Set a new encoding for this connection
434 * Return true in case of success
437 IrcConnection
.prototype.setEncoding = function (encoding
) {
441 encoded_test
= iconv
.encode("TEST", encoding
);
442 //This test is done to check if this encoding also supports
443 //the ASCII charset required by the IRC protocols
444 //(Avoid the use of base64 or incompatible encodings)
445 if (encoded_test
== "TEST") {
446 this.encoding
= encoding
;
455 function getConnectionFamily(host
, callback
) {
456 if (net
.isIP(host
)) {
457 if (net
.isIPv4(host
)) {
458 callback(null, 'IPv4', host
);
460 callback(null, 'IPv6', host
);
463 dns
.resolve6(host
, function resolve6Cb(err
, addresses
) {
465 callback(null, 'IPv6', addresses
[0]);
467 dns
.resolve4(host
, function resolve4Cb(err
, addresses
) {
469 callback(null, 'IPv4',addresses
[0]);
480 function onChannelJoin(event
) {
483 // Only deal with ourselves joining a channel
484 if (event
.nick
!== this.nick
)
487 // We should only ever get a JOIN command for a channel
488 // we're not already a member of.. but check we don't
489 // have this channel in case something went wrong somewhere
490 // at an earlier point
491 if (!this.irc_channels
[event
.channel
]) {
492 chan
= new IrcChannel(this, event
.channel
);
493 this.irc_channels
[event
.channel
] = chan
;
494 chan
.irc_events
.join
.call(chan
, event
);
499 function onServerConnect(event
) {
500 this.nick
= event
.nick
;
504 function onUserPrivmsg(event
) {
507 // Only deal with messages targetted to us
508 if (event
.channel
!== this.nick
)
511 if (!this.irc_users
[event
.nick
]) {
512 user
= new IrcUser(this, event
.nick
);
513 this.irc_users
[event
.nick
] = user
;
514 user
.irc_events
.privmsg
.call(user
, event
);
519 function onUserNick(event
) {
522 // Only deal with messages targetted to us
523 if (event
.nick
!== this.nick
)
526 this.nick
= event
.newnick
;
530 function onUserParts(event
) {
531 // Only deal with ourselves leaving a channel
532 if (event
.nick
!== this.nick
)
535 if (this.irc_channels
[event
.channel
]) {
536 this.irc_channels
[event
.channel
].dispose();
537 delete this.irc_channels
[event
.channel
];
541 function onUserKick(event
){
542 // Only deal with ourselves being kicked from a channel
543 if (event
.kicked
!== this.nick
)
546 if (this.irc_channels
[event
.channel
]) {
547 this.irc_channels
[event
.channel
].dispose();
548 delete this.irc_channels
[event
.channel
];
556 * When a socket connects to an IRCd
557 * May be called before any socket handshake are complete (eg. TLS)
559 var rawSocketConnect = function(socket
) {
560 // Make note of the port numbers for any identd lookups
561 // Nodejs < 0.9.6 has no socket.localPort so check this first
562 if (typeof socket
.localPort
!= 'undefined') {
563 this.identd_port_pair
= socket
.localPort
.toString() + '_' + socket
.remotePort
.toString();
564 global
.clients
.port_pairs
[this.identd_port_pair
] = this;
570 * Handle the socket connect event, starting the IRCd registration
572 var socketConnectHandler = function () {
576 // Build up data to be used for webirc/etc detection
580 // Array of lines to be sent to the IRCd before anything else
584 // Let the webirc/etc detection modify any required parameters
585 connect_data
= findWebIrc
.call(this, connect_data
);
587 global
.modules
.emit('irc authorize', connect_data
).done(function ircAuthorizeCb() {
588 var gecos
= '[www.kiwiirc.com] ' + that
.nick
;
590 if (global
.config
.default_gecos
) {
591 gecos
= global
.config
.default_gecos
.toString().replace('%n', that
.nick
);
592 gecos
= gecos
.toString().replace('%h', that
.user
.hostname
);
595 // Send any initial data for webirc/etc
596 if (connect_data
.prepend_data
) {
597 _
.each(connect_data
.prepend_data
, function(data
) {
602 that
.write('CAP LS');
605 that
.write('PASS ' + that
.password
);
607 that
.write('NICK ' + that
.nick
);
608 that
.write('USER ' + that
.username
+ ' 0 0 :' + gecos
);
610 that
.emit('connected');
617 * Load any WEBIRC or alternative settings for this connection
618 * Called in scope of the IrcConnection instance
620 function findWebIrc(connect_data
) {
621 var webirc_pass
= global
.config
.webirc_pass
,
622 ip_as_username
= global
.config
.ip_as_username
,
626 // Do we have a WEBIRC password for this?
627 if (webirc_pass
&& webirc_pass
[this.irc_host
.hostname
]) {
628 // Build the WEBIRC line to be sent before IRC registration
629 tmp
= 'WEBIRC ' + webirc_pass
[this.irc_host
.hostname
] + ' KiwiIRC ';
630 tmp
+= this.user
.hostname
+ ' ' + this.user
.address
;
632 connect_data
.prepend_data
= [tmp
];
636 // Check if we need to pass the users IP as its username/ident
637 if (ip_as_username
&& ip_as_username
.indexOf(this.irc_host
.hostname
) > -1) {
638 // Get a hex value of the clients IP
639 this.username
= this.user
.address
.split('.').map(function ipSplitMapCb(i
, idx
){
640 var hex
= parseInt(i
, 10).toString(16);
642 // Pad out the hex value if it's a single char
643 if (hex
.length
=== 1)
656 * Buffer any data we get from the IRCd until we have complete lines.
658 function socketOnData(data
) {
659 var data_pos
, // Current position within the data Buffer
663 max_buffer_size
= 1024; // 1024 bytes is the maximum length of two RFC1459 IRC messages.
664 // May need tweaking when IRCv3 message tags are more widespread
666 // Split data chunk into individual lines
667 for (data_pos
= 0; data_pos
< data
.length
; data_pos
++) {
668 if (data
[data_pos
] === 0x0A) { // Check if byte is a line feed
669 lines
.push(data
.slice(line_start
, data_pos
));
670 line_start
= data_pos
+ 1;
674 // No complete lines of data? Check to see if buffering the data would exceed the max buffer size
676 if ((this.held_data
? this.held_data
.length
: 0 ) + data
.length
> max_buffer_size
) {
677 // Buffering this data would exeed our max buffer size
678 this.emit('error', 'Message buffer too large');
679 this.socket
.destroy();
683 // Append the incomplete line to our held_data and wait for more
684 if (this.held_data
) {
685 this.held_data
= Buffer
.concat([this.held_data
, data
], this.held_data
.length
+ data
.length
);
687 this.held_data
= data
;
691 // No complete lines to process..
695 // If we have an incomplete line held from the previous chunk of data
696 // merge it with the first line from this chunk of data
697 if (this.hold_last
&& this.held_data
!== null) {
698 lines
[0] = Buffer
.concat([this.held_data
, lines
[0]], this.held_data
.length
+ lines
[0].length
);
699 this.hold_last
= false;
700 this.held_data
= null;
703 // If the last line of data in this chunk is not complete, hold it so
704 // it can be merged with the first line from the next chunk
705 if (line_start
< data_pos
) {
706 if ((data
.length
- line_start
) > max_buffer_size
) {
707 // Buffering this data would exeed our max buffer size
708 this.emit('error', 'Message buffer too large');
709 this.socket
.destroy();
713 this.hold_last
= true;
714 this.held_data
= new Buffer(data
.length
- line_start
);
715 data
.copy(this.held_data
, 0, line_start
);
718 // Process our data line by line
719 for (i
= 0; i
< lines
.length
; i
++)
720 parseIrcLine
.call(this, lines
[i
]);
727 * The regex that parses a line of data from the IRCd
728 * Deviates from the RFC a little to support the '/' character now used in some
731 var parse_regex
= /^(?:(?:(?:@([^ ]+) )?):(?:([^\s!]+)|([^\s!]+)!([^\s@]+)@?([^\s]+)?) )?(\S+)(?: (?!:)(.+?))?(?: :(.*))?$/i;
733 function parseIrcLine(buffer_line
) {
740 // Decode server encoding
741 line
= iconv
.decode(buffer_line
, this.encoding
);
744 // Parse the complete line, removing any carriage returns
745 msg
= parse_regex
.exec(line
.replace(/^\r+|\r+$/, ''));
748 // The line was not parsed correctly, must be malformed
749 console
.log("Malformed IRC line: " + line
.replace(/^\r+|\r+$/, ''));
753 // Extract any tags (msg[1])
755 tags
= msg
[1].split(';');
757 for (j
= 0; j
< tags
.length
; j
++) {
758 tag
= tags
[j
].split('=');
759 tags
[j
] = {tag
: tag
[0], value
: tag
[1]};
768 hostname
: msg
[5] || '',
770 params
: msg
[7] || '',
771 trailing
: (msg
[8]) ? msg
[8].trim() : ''
774 msg
.params
= msg
.params
.split(/ +/);
775 this.irc_commands
.dispatch(msg
.command
.toUpperCase(), msg
);