forked from baalexander/node-xmlrpc
-
Notifications
You must be signed in to change notification settings - Fork 4
/
client.js
250 lines (206 loc) · 6.64 KB
/
client.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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
var net = require('net')
, barse = require('barse')
, Serializer = require('./serializer')
, Deserializer = require('./deserializer')
;
/**
* Creates a Client object for making XML-RPC method calls.
*
* @constructor
* @param {Object|String} options - Server options to make the HTTP request to.
* Either a URI string
* (e.g. 'http://localhost:9090') or an object
* with fields:
* - {String} host - (optional)
* - {Number} port
* @param {Boolean} isSecure - True if using https for making calls,
* otherwise false.
* @return {Client}
*/
function Client(port, host, callback) {
// Invokes with new if called without
if (false === (this instanceof Client)) {
return new Client(port, host, callback)
}
// Set the options
if (typeof host === 'function') {
callback = host;
host = 'localhost';
}
this.host = host || 'localhost';
this.port = port;
this.isConnected = false;
this.isReady = false;
this.reqhandle = 0x80000000;
this.callbacks = {};
this.connect(callback);
}
// Inherit EventEmitter
Client.prototype = Object.create(require('events').EventEmitter.prototype);
/**
* Connects to the server
*
* @param {Function} callback (optional) - function(error) { ... }
* - {Number} timeout (optional) - Timeout to connect
*/
Client.prototype.connect = function(callback, timeout) {
if (this.isConnected)
return;
var self = this
, timeout = typeof timeout === 'number' ? timeout : typeof callback === 'number' ? callback : 2000; // TODO: test
// Mess with the callback function so we never have to `if` it later
// If: no callback given, make an empty function
// Else: Untested: Only call the callback once.
// - E.g. If successfully connected to the server, and later some weird socket error occurs,
// then the callback function will be called twice. Once with success, and once with error.
// Thats what we're trying to prevent... >>> ^^^^^
if (typeof callback !== 'function') {
callback = function(){};
} else {
// Closure to hide `cb`
(function() { // TODO: test
var cb = callback;
callback = function() {
// Forward call
cb.apply(this, arguments);
// If called again, ignore
callback = function() {};
}
})();
}
// Connect to the server
this.socket = net.connect(this.port, this.host);
// TODO: Move timeout out of onConnect? (currently timeout is a handshake timeout)
this.socket.on('connect', function() {
self.isConnected = true;
// Timeout for handshake
var to = setTimeout(function() {
var err = new Error('timeout - handshake timed out');
callback(err);
self.emit('error', err);
self.terminate();
}, timeout);
self.on('connect', function() {
clearTimeout(to);
});
});
this.socket.on('error', function(err) {
self.isConnected = self.isReady = false;
callback(err);
self.emit('error', err);
});
this.socket.on('close', function(had_error) {
self.emit('close', had_error);
});
var handshakeParser = barse()
.readUInt32LE('length')
.string('handshake', 'length')
;
var dataParser = barse()
.readUInt32LE('length')
.readUInt32LE('reqhandle')
.string('xml', 'length')
;
// Pipe data to handshakeParser
this.socket.pipe(handshakeParser);
// Then switch to dataParser once handshakeParser is done
handshakeParser.once('data', function() {
self.socket.unpipe(handshakeParser);
self.socket.pipe(dataParser);
})
// HANDSHAKE
handshakeParser.once('data', function(data) {
if (data.handshake != 'GBXRemote 2') {
var err = new Error('transport error - wrong lowlevel protocol version');
callback(err);
self.emit('error', err);
return;
}
self.protocol = 2;
self.isReady = true;
callback();
self.emit('connect');
});
dataParser.on('data', function(data) {
var deserializer = new Deserializer();
// TODO: Use reqhandle to determine if its a response or callback
// Reponse
if (self.callbacks.hasOwnProperty(data.reqhandle)) {
deserializer.deserializeMethodResponse(data.xml, function(a, b) {
self.callbacks[data.reqhandle].apply(this, arguments);
delete self.callbacks[data.reqhandle];
});
}
// Callback
else {
deserializer.deserializeMethodCall(data.xml, function(err, method, res) {
if (err) {
// This should never happen....
// There is nothing we can do about this one.
// Its not a response to a request, and its not a valid callback (MethodCall)
//console.log(err);
console.warn('Not a response, nor a callback! (reqhandle: 0x%s)', data.reqhandle.toString(16));
return;
} else {
// its a callback from the server
self.emit('callback', method, res);
self.emit(method, res);
}
});
}
});
};
Client.prototype.terminate = function() {
if (this.socket) {
this.socket.end();
this.isConnected = false;
}
}
/**
* Makes an XML-RPC call to the server specified by the constructor's options.
*
* @param {String} method - The method name.
* @param {Array} params - Params to send in the call.
* @param {Function} callback - function(error, value) { ... }
* - {Object|null} error - Any errors when making the call, otherwise null.
* - {mixed} value - The value returned in the method response.
*/
Client.prototype.query = function(method, params, callback) {
if (!this.isReady) {
// Call again when ready instead of erroring?.. maybe? yes? no?
var args = arguments;
this.once('connect', function() {
this.query.apply(this, args);
});
return false;
}
// An attempt on method overloading
if (typeof params === 'function') {
callback = params;
params = [];
}
params = params || [];
// Make sure its an array
if (typeof params !== 'object')
params = [params];
// Returns JSON of the xml
var xml = Serializer.serializeMethodCall(method, params);
// Check if request (xml + header) is larger than 1024 Kbytes (limit of maniaplanet)
if (xml.length + 8 > 1024*1024) {
callback(new Error('transport error - request too large (' + xml.length + ')'));
return false;
}
this.reqhandle++;
this.callbacks[this.reqhandle] = (typeof callback === 'function') ? callback : function() {};
// $bytes = pack('VVa*', strlen($xml), $this->reqhandle, $xml);
var len = Buffer.byteLength(xml);
var buf = new Buffer(8 + len);
buf.writeInt32LE(len, 0);
buf.writeUInt32LE(this.reqhandle, 4);
buf.write(xml, 8);
this.socket.write(buf, 'utf8');
return true;
};
// DEPRECATED - Function name changed.
Client.prototype.methodCall = Client.prototype.query;
module.exports = Client;