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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
/**
* This implements a UDP mulitcast device discovery protocol that:
* * Is optimized for mobile devices
* * Doesn't require any special schema for service info
*
* To ensure it works well on mobile devices, there is no heartbeat or other
* recurring transmission.
*
* Devices are typically in one of two groups: scanning for services or
* providing services (though they may be in both groups as well).
*
* Scanning devices listen on UPDATE_PORT for UDP multicast traffic. When the
* scanning device wants to force an update of the services available, it sends
* a status packet to SCAN_PORT.
*
* Service provider devices listen on SCAN_PORT for any packets from scanning
* devices. If one is recevied, the provider device sends a status packet
* (listing the services it offers) to UPDATE_PORT.
*
* Scanning devices purge any previously known devices after REPLY_TIMEOUT ms
* from that start of a scan if no reply is received during the most recent
* scan.
*
* When a service is registered, is supplies a regular object with any details
* about itself (a port number, for example) in a service-defined format, which
* is then available to scanning devices.
*/
const { Cu, CC, Cc, Ci } = require("chrome");
const EventEmitter = require("devtools/shared/event-emitter");
const Services = require("Services");
const UDPSocket = CC(
"@mozilla.org/network/udp-socket;1",
"nsIUDPSocket",
"init"
);
const SCAN_PORT = 50624;
const UPDATE_PORT = 50625;
const ADDRESS = "224.0.0.115";
const REPLY_TIMEOUT = 5000;
const { XPCOMUtils } = require("resource://gre/modules/XPCOMUtils.jsm");
XPCOMUtils.defineLazyGetter(this, "converter", () => {
const conv = Cc[
"@mozilla.org/intl/scriptableunicodeconverter"
].createInstance(Ci.nsIScriptableUnicodeConverter);
conv.charset = "utf8";
return conv;
});
var logging = Services.prefs.getBoolPref("devtools.discovery.log");
function log(msg) {
if (logging) {
console.log("DISCOVERY: " + msg);
}
}
/**
* Each Transport instance owns a single UDPSocket.
* @param port integer
* The port to listen on for incoming UDP multicast packets.
*/
function Transport(port) {
EventEmitter.decorate(this);
try {
this.socket = new UDPSocket(
port,
false,
Services.scriptSecurityManager.getSystemPrincipal()
);
this.socket.joinMulticast(ADDRESS);
this.socket.asyncListen(this);
} catch (e) {
log("Failed to start new socket: " + e);
}
}
Transport.prototype = {
/**
* Send a object to some UDP port.
* @param object object
* Object which is the message to send
* @param port integer
* UDP port to send the message to
*/
send: function(object, port) {
if (logging) {
log("Send to " + port + ":\n" + JSON.stringify(object, null, 2));
}
const message = JSON.stringify(object);
const rawMessage = converter.convertToByteArray(message);
try {
this.socket.send(ADDRESS, port, rawMessage, rawMessage.length);
} catch (e) {
log("Failed to send message: " + e);
}
},
destroy: function() {
this.socket.close();
},
// nsIUDPSocketListener
onPacketReceived: function(socket, message) {
const messageData = message.data;
const object = JSON.parse(messageData);
object.from = message.fromAddr.address;
const port = message.fromAddr.port;
if (port == this.socket.port) {
log("Ignoring looped message");
return;
}
if (logging) {
log(
"Recv on " + this.socket.port + ":\n" + JSON.stringify(object, null, 2)
);
}
this.emit("message", object);
},
onStopListening: function() {},
};
/**
* Manages the local device's name. The name can be generated in serveral
* platform-specific ways (see |_generate|). The aim is for each device on the
* same local network to have a unique name.
*/
function LocalDevice() {
this._name = LocalDevice.UNKNOWN;
// Trigger |_get| to load name eagerly
this._get();
}
LocalDevice.UNKNOWN = "unknown";
LocalDevice.prototype = {
_get: function() {
// Without Settings API, just generate a name and stop, since the value
// can't be persisted.
this._generate();
},
/**
* Generate a new device name from various platform-specific properties.
* Triggers the |name| setter to persist if needed.
*/
_generate: function() {
if (Services.appinfo.widgetToolkit == "android") {
// For Firefox for Android, use the device's model name.
// TODO: Bug 1180997: Find the right way to expose an editable name
this.name = Services.sysinfo.get("device");
} else {
this.name = Cc["@mozilla.org/network/dns-service;1"].getService(
Ci.nsIDNSService
).myHostName;
}
},
get name() {
return this._name;
},
set name(name) {
this._name = name;
log("Device: " + this._name);
},
};
function Discovery() {
EventEmitter.decorate(this);
this.localServices = {};
this.remoteServices = {};
this.device = new LocalDevice();
this.replyTimeout = REPLY_TIMEOUT;
// Defaulted to Transport, but can be altered by tests
this._factories = { Transport: Transport };
this._transports = {
scan: null,
update: null,
};
this._expectingReplies = {
from: new Set(),
};
this._onRemoteScan = this._onRemoteScan.bind(this);
this._onRemoteUpdate = this._onRemoteUpdate.bind(this);
this._purgeMissingDevices = this._purgeMissingDevices.bind(this);
}
Discovery.prototype = {
/**
* Add a new service offered by this device.
* @param service string
* Name of the service
* @param info object
* Arbitrary data about the service to announce to scanning devices
*/
addService: function(service, info) {
log("ADDING LOCAL SERVICE");
if (Object.keys(this.localServices).length === 0) {
this._startListeningForScan();
}
this.localServices[service] = info;
},
/**
* Remove a service offered by this device.
* @param service string
* Name of the service
*/
removeService: function(service) {
delete this.localServices[service];
if (Object.keys(this.localServices).length === 0) {
this._stopListeningForScan();
}
},
/**
* Scan for service updates from other devices.
*/
scan: function() {
this._startListeningForUpdate();
this._waitForReplies();
// TODO Bug 1027457: Use timer to debounce
this._sendStatusTo(SCAN_PORT);
},
/**
* Get a list of all remote devices currently offering some service.:w
*/
getRemoteDevices: function() {
const devices = new Set();
for (const service in this.remoteServices) {
for (const device in this.remoteServices[service]) {
devices.add(device);
}
}
return [...devices];
},
/**
* Get a list of all remote devices currently offering a particular service.
*/
getRemoteDevicesWithService: function(service) {
const devicesWithService = this.remoteServices[service] || {};
return Object.keys(devicesWithService);
},
/**
* Get service info (any details registered by the remote device) for a given
* service on a device.
*/
getRemoteService: function(service, device) {
const devicesWithService = this.remoteServices[service] || {};
return devicesWithService[device];
},
_waitForReplies: function() {
clearTimeout(this._expectingReplies.timer);
this._expectingReplies.from = new Set(this.getRemoteDevices());
this._expectingReplies.timer = setTimeout(
this._purgeMissingDevices,
this.replyTimeout
);
},
get Transport() {
return this._factories.Transport;
},
_startListeningForScan: function() {
if (this._transports.scan) {
// Already listening
return;
}
log("LISTEN FOR SCAN");
this._transports.scan = new this.Transport(SCAN_PORT);
this._transports.scan.on("message", this._onRemoteScan);
},
_stopListeningForScan: function() {
if (!this._transports.scan) {
// Not listening
return;
}
this._transports.scan.off("message", this._onRemoteScan);
this._transports.scan.destroy();
this._transports.scan = null;
},
_startListeningForUpdate: function() {
if (this._transports.update) {
// Already listening
return;
}
log("LISTEN FOR UPDATE");
this._transports.update = new this.Transport(UPDATE_PORT);
this._transports.update.on("message", this._onRemoteUpdate);
},
_stopListeningForUpdate: function() {
if (!this._transports.update) {
// Not listening
return;
}
this._transports.update.off("message", this._onRemoteUpdate);
this._transports.update.destroy();
this._transports.update = null;
},
_restartListening: function() {
if (this._transports.scan) {
this._stopListeningForScan();
this._startListeningForScan();
}
if (this._transports.update) {
this._stopListeningForUpdate();
this._startListeningForUpdate();
}
},
/**
* When sending message, we can use either transport, so just pick the first
* one currently alive.
*/
get _outgoingTransport() {
if (this._transports.scan) {
return this._transports.scan;
}
if (this._transports.update) {
return this._transports.update;
}
return null;
},
_sendStatusTo: function(port) {
const status = {
device: this.device.name,
services: this.localServices,
};
this._outgoingTransport.send(status, port);
},
_onRemoteScan: function() {
// Send my own status in response
log("GOT SCAN REQUEST");
this._sendStatusTo(UPDATE_PORT);
},
_onRemoteUpdate: function(update) {
log("GOT REMOTE UPDATE");
const remoteDevice = update.device;
const remoteHost = update.from;
// Record the reply as received so it won't be purged as missing
this._expectingReplies.from.delete(remoteDevice);
// First, loop over the known services
for (const service in this.remoteServices) {
const devicesWithService = this.remoteServices[service];
const hadServiceForDevice = !!devicesWithService[remoteDevice];
const haveServiceForDevice = service in update.services;
// If the remote device used to have service, but doesn't any longer, then
// it was deleted, so we remove it here.
if (hadServiceForDevice && !haveServiceForDevice) {
delete devicesWithService[remoteDevice];
log("REMOVED " + service + ", DEVICE " + remoteDevice);
this.emit(service + "-device-removed", remoteDevice);
}
}
// Second, loop over the services in the received update
for (const service in update.services) {
// Detect if this is a new device for this service
const newDevice =
!this.remoteServices[service] ||
!this.remoteServices[service][remoteDevice];
// Look up the service info we may have received previously from the same
// remote device
const devicesWithService = this.remoteServices[service] || {};
const oldDeviceInfo = devicesWithService[remoteDevice];
// Store the service info from the remote device
const newDeviceInfo = Cu.cloneInto(update.services[service], {});
newDeviceInfo.host = remoteHost;
devicesWithService[remoteDevice] = newDeviceInfo;
this.remoteServices[service] = devicesWithService;
// If this is a new service for the remote device, announce the addition
if (newDevice) {
log("ADDED " + service + ", DEVICE " + remoteDevice);
this.emit(service + "-device-added", remoteDevice, newDeviceInfo);
}
// If we've seen this service from the remote device, but the details have
// changed, announce the update
if (
!newDevice &&
JSON.stringify(oldDeviceInfo) != JSON.stringify(newDeviceInfo)
) {
log("UPDATED " + service + ", DEVICE " + remoteDevice);
this.emit(service + "-device-updated", remoteDevice, newDeviceInfo);
}
}
},
_purgeMissingDevices: function() {
log("PURGING MISSING DEVICES");
for (const service in this.remoteServices) {
const devicesWithService = this.remoteServices[service];
for (const remoteDevice in devicesWithService) {
// If we're still expecting a reply from a remote device when it's time
// to purge, then the service is removed.
if (this._expectingReplies.from.has(remoteDevice)) {
delete devicesWithService[remoteDevice];
log("REMOVED " + service + ", DEVICE " + remoteDevice);
this.emit(service + "-device-removed", remoteDevice);
}
}
}
},
};
var discovery = new Discovery();
module.exports = discovery;
|