-
Notifications
You must be signed in to change notification settings - Fork 14
/
socket.js
201 lines (175 loc) · 5.13 KB
/
socket.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/**
* @author havvy
* IRC Socket - handles communication between an IRC server and a Node.js script.
*
* This socket exposes the connect and end methods of the socket Interface.
*
* A network configuration object needs the following properties:
* server - IRC server to connect to. _Example:_ _irc.mibbit.net_
* nick - Nickname the bot will use.
* user - Username the bot will use.
* realname - Realname for the bot.
* port - Port to connect to. Defaults to 6667.
*
* Note that the only default value from the perspective of the socket is
* the port. This class is reusable outside of the framework, should you want
* to create your own framework.
*
* To send messages to the server, use socket.raw(). It accepts either a
* string or an array which it will convert into a string by joining with
* a space. The message must follow the IRC protocol. For example, to send a
* message to the channel #evilbiscuits, you would send one of the following:
*
* socket.raw("PRIVMSG #evilbiscuits :The message!");
* socket.raw(["PRIVMSG", "#evilbiscuits", ":The message!"]);
*
* <Documentation TODO: 'data event' & handled nuisances>
*
* Public methods
* - new(network: Object[, opt: Object]): IRCSocket
* - connect(): undefined
* - end(): undefined
* - raw(message: List[String]): undefined
* - raw(message: String): undefined
* - isConnected(): boolean
* - getRealName(): String
* - onConnect(callback: function): undefined
* - onDisconnect(callback: function): undefined
* + (from events.EventEmitter)
* - on
* - once
*
* Events
* - ready(): Once the first 001 message has been acknowledged.
* - data(message: String): Every message (including the 001) from the
* sender (inclusive) the the newline (exclusive).
*/
var net = require('net');
var events = require('events');
var util = require('util');
/**
* @constructor
* @param {Object} network Network information. See above for info.
* @param {Object} opt Optional parameters: socket
*/
var Socket = function (network, opt) {
that = this;
events.EventEmitter.call(this);
this.port = network.port || 6667;
this.netname = network.server;
this.server = (opt && opt.socket) ? opt.socket : new net.Socket();
this.log = (opt && opt.logger) || {};
this.connected = false;
/**
* @TODO Do not send last message if not finished
* @TODO Refactor this to be less confusing.
*/
var onData = function (data) {
data = data.split('\r\n');
// Filter-Filter-Map pattern.
for (var ix = 0; ix < data.length; ix++) {
var line = data[ix];
// Filter empty lines.
if (line === '') {
continue;
}
// Filter pings.
if (line.indexOf('PING') === 0) {
var reply = line.slice(line.indexOf(':'));
that.raw(["PONG", reply]);
continue;
}
// Map event emitting.
// Log.input(that.log, line);
that.emit('data', line);
}
};
var determineWhenReady = function (data) {
data = data.split('\r\n');
// Filter-Filter-Map pattern.
for (var ix = 0; ix < data.length; ix++) {
var line = data[ix];
// Filter empty lines.
if (line.length === 0) {
continue;
}
line = line.split(" ");
if (line[1] === "001") {
that.emit("ready");
that.server.removeListener('data', determineWhenReady);
break;
}
}
};
this.server.once('connect', function () {
that.connected = true;
that.raw(["NICK", network.nick]);
that.raw(["USER", network.user || "user", "8 * :" + network.realname]);
});
this.once('ready', function () {
// RAWR! I'm a <s>monster</s> Bot!
that.raw(["MODE", network.nick, ":+B"]);
});
this.server.once('close', function () {
that.connected = false;
});
this.server.on('data', onData);
this.server.on('data', determineWhenReady);
this.server.setEncoding('ascii');
this.server.setNoDelay();
};
Socket.prototype = new events.EventEmitter();
/**
* Connect to the IRC server.
*/
Socket.prototype.connect = function () {
if (this.isConnected()) {
return;
}
this.server.connect(this.port, this.netname);
};
/**
* Disconnect from the server without a reason.
*/
Socket.prototype.end = function () {
if (!this.isConnected()) {
return;
}
this.server.end();
};
/**
* Communicate with the network.
*
* @param message Message to send to network.
*/
Socket.prototype.raw = function (message) {
if (util.isArray(message)) {
message = message.join(" ");
}
this.server.write(message + '\n', 'ascii');
};
/**
* @return Whether socket connected to a network.
*/
Socket.prototype.isConnected = function () {
return this.connected;
};
/**
* @return Real name of the bot.
*/
Socket.prototype.getRealName = function () {
return this._realname;
};
/**
* Event handler for what to do after connected to the server.
*/
Socket.prototype.onConnect = function (handler) {
this.server.on('connect', handler.bind(this));
};
/**
* Event handler for what to do after disconnected from the server.
*/
Socket.prototype.onDisconnect = function (handler) {
this.server.on('close', handler.bind(this));
};
module.exports = Socket;