Blame view

wave/node_modules/socket.io/lib/socket.js 8.83 KB
cf76164e6   Ting Chan   20190709
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
  
  /**
   * Module dependencies.
   */
  
  var Emitter = require('events').EventEmitter;
  var parser = require('socket.io-parser');
  var url = require('url');
  var debug = require('debug')('socket.io:socket');
  var hasBin = require('has-binary');
  
  /**
   * Module exports.
   */
  
  module.exports = exports = Socket;
  
  /**
   * Blacklisted events.
   *
   * @api public
   */
  
  exports.events = [
    'error',
    'connect',
    'disconnect',
    'newListener',
    'removeListener'
  ];
  
  /**
   * Flags.
   *
   * @api private
   */
  
  var flags = [
    'json',
    'volatile',
    'broadcast'
  ];
  
  /**
   * `EventEmitter#emit` reference.
   */
  
  var emit = Emitter.prototype.emit;
  
  /**
   * Interface to a `Client` for a given `Namespace`.
   *
   * @param {Namespace} nsp
   * @param {Client} client
   * @api public
   */
  
  function Socket(nsp, client){
    this.nsp = nsp;
    this.server = nsp.server;
    this.adapter = this.nsp.adapter;
    this.id = nsp.name + '#' + client.id;
    this.client = client;
    this.conn = client.conn;
    this.rooms = {};
    this.acks = {};
    this.connected = true;
    this.disconnected = false;
    this.handshake = this.buildHandshake();
  }
  
  /**
   * Inherits from `EventEmitter`.
   */
  
  Socket.prototype.__proto__ = Emitter.prototype;
  
  /**
   * Apply flags from `Socket`.
   */
  
  flags.forEach(function(flag){
    Socket.prototype.__defineGetter__(flag, function(){
      this.flags = this.flags || {};
      this.flags[flag] = true;
      return this;
    });
  });
  
  /**
   * `request` engine.io shortcut.
   *
   * @api public
   */
  
  Socket.prototype.__defineGetter__('request', function(){
    return this.conn.request;
  });
  
  /**
   * Builds the `handshake` BC object
   *
   * @api private
   */
  
  Socket.prototype.buildHandshake = function(){
    return {
      headers: this.request.headers,
      time: (new Date) + '',
      address: this.conn.remoteAddress,
      xdomain: !!this.request.headers.origin,
      secure: !!this.request.connection.encrypted,
      issued: +(new Date),
      url: this.request.url,
      query: url.parse(this.request.url, true).query || {}
    };
  };
  
  /**
   * Emits to this client.
   *
   * @return {Socket} self
   * @api public
   */
  
  Socket.prototype.emit = function(ev){
    if (~exports.events.indexOf(ev)) {
      emit.apply(this, arguments);
    } else {
      var args = Array.prototype.slice.call(arguments);
      var packet = {};
      packet.type = hasBin(args) ? parser.BINARY_EVENT : parser.EVENT;
      packet.data = args;
      var flags = this.flags || {};
  
      // access last argument to see if it's an ACK callback
      if ('function' == typeof args[args.length - 1]) {
        if (this._rooms || flags.broadcast) {
          throw new Error('Callbacks are not supported when broadcasting');
        }
  
        debug('emitting packet with ack id %d', this.nsp.ids);
        this.acks[this.nsp.ids] = args.pop();
        packet.id = this.nsp.ids++;
      }
  
      if (this._rooms || flags.broadcast) {
        this.adapter.broadcast(packet, {
          except: [this.id],
          rooms: this._rooms,
          flags: flags
        });
      } else {
        // dispatch packet
        this.packet(packet, {
          volatile: flags.volatile,
          compress: flags.compress
        });
      }
  
      // reset flags
      delete this._rooms;
      delete this.flags;
    }
    return this;
  };
  
  /**
   * Targets a room when broadcasting.
   *
   * @param {String} name
   * @return {Socket} self
   * @api public
   */
  
  Socket.prototype.to =
  Socket.prototype.in = function(name){
    this._rooms = this._rooms || [];
    if (!~this._rooms.indexOf(name)) this._rooms.push(name);
    return this;
  };
  
  /**
   * Sends a `message` event.
   *
   * @return {Socket} self
   * @api public
   */
  
  Socket.prototype.send =
  Socket.prototype.write = function(){
    var args = Array.prototype.slice.call(arguments);
    args.unshift('message');
    this.emit.apply(this, args);
    return this;
  };
  
  /**
   * Writes a packet.
   *
   * @param {Object} packet object
   * @param {Object} opts options
   * @api private
   */
  
  Socket.prototype.packet = function(packet, opts){
    packet.nsp = this.nsp.name;
    opts = opts || {};
    opts.compress = false !== opts.compress;
    this.client.packet(packet, opts);
  };
  
  /**
   * Joins a room.
   *
   * @param {String} room
   * @param {Function} fn optional, callback
   * @return {Socket} self
   * @api private
   */
  
  Socket.prototype.join = function(room, fn){
    debug('joining room %s', room);
    var self = this;
    if (this.rooms.hasOwnProperty(room)) {
      fn && fn(null);
      return this;
    }
    this.adapter.add(this.id, room, function(err){
      if (err) return fn && fn(err);
      debug('joined room %s', room);
      self.rooms[room] = room;
      fn && fn(null);
    });
    return this;
  };
  
  /**
   * Leaves a room.
   *
   * @param {String} room
   * @param {Function} fn optional, callback
   * @return {Socket} self
   * @api private
   */
  
  Socket.prototype.leave = function(room, fn){
    debug('leave room %s', room);
    var self = this;
    this.adapter.del(this.id, room, function(err){
      if (err) return fn && fn(err);
      debug('left room %s', room);
      delete self.rooms[room];
      fn && fn(null);
    });
    return this;
  };
  
  /**
   * Leave all rooms.
   *
   * @api private
   */
  
  Socket.prototype.leaveAll = function(){
    this.adapter.delAll(this.id);
    this.rooms = {};
  };
  
  /**
   * Called by `Namespace` upon succesful
   * middleware execution (ie: authorization).
   *
   * @api private
   */
  
  Socket.prototype.onconnect = function(){
    debug('socket connected - writing packet');
    this.nsp.connected[this.id] = this;
    this.join(this.id);
    this.packet({ type: parser.CONNECT });
  };
  
  /**
   * Called with each packet. Called by `Client`.
   *
   * @param {Object} packet
   * @api private
   */
  
  Socket.prototype.onpacket = function(packet){
    debug('got packet %j', packet);
    switch (packet.type) {
      case parser.EVENT:
        this.onevent(packet);
        break;
  
      case parser.BINARY_EVENT:
        this.onevent(packet);
        break;
  
      case parser.ACK:
        this.onack(packet);
        break;
  
      case parser.BINARY_ACK:
        this.onack(packet);
        break;
  
      case parser.DISCONNECT:
        this.ondisconnect();
        break;
  
      case parser.ERROR:
        this.emit('error', packet.data);
    }
  };
  
  /**
   * Called upon event packet.
   *
   * @param {Object} packet object
   * @api private
   */
  
  Socket.prototype.onevent = function(packet){
    var args = packet.data || [];
    debug('emitting event %j', args);
  
    if (null != packet.id) {
      debug('attaching ack callback to event');
      args.push(this.ack(packet.id));
    }
  
    emit.apply(this, args);
  };
  
  /**
   * Produces an ack callback to emit with an event.
   *
   * @param {Number} id packet id
   * @api private
   */
  
  Socket.prototype.ack = function(id){
    var self = this;
    var sent = false;
    return function(){
      // prevent double callbacks
      if (sent) return;
      var args = Array.prototype.slice.call(arguments);
      debug('sending ack %j', args);
  
      var type = hasBin(args) ? parser.BINARY_ACK : parser.ACK;
      self.packet({
        id: id,
        type: type,
        data: args
      });
  
      sent = true;
    };
  };
  
  /**
   * Called upon ack packet.
   *
   * @api private
   */
  
  Socket.prototype.onack = function(packet){
    var ack = this.acks[packet.id];
    if ('function' == typeof ack) {
      debug('calling ack %s with %j', packet.id, packet.data);
      ack.apply(this, packet.data);
      delete this.acks[packet.id];
    } else {
      debug('bad ack %s', packet.id);
    }
  };
  
  /**
   * Called upon client disconnect packet.
   *
   * @api private
   */
  
  Socket.prototype.ondisconnect = function(){
    debug('got disconnect packet');
    this.onclose('client namespace disconnect');
  };
  
  /**
   * Handles a client error.
   *
   * @api private
   */
  
  Socket.prototype.onerror = function(err){
    if (this.listeners('error').length) {
      this.emit('error', err);
    } else {
      console.error('Missing error handler on `socket`.');
      console.error(err.stack);
    }
  };
  
  /**
   * Called upon closing. Called by `Client`.
   *
   * @param {String} reason
   * @throw {Error} optional error object
   * @api private
   */
  
  Socket.prototype.onclose = function(reason){
    if (!this.connected) return this;
    debug('closing socket - reason %s', reason);
    this.leaveAll();
    this.nsp.remove(this);
    this.client.remove(this);
    this.connected = false;
    this.disconnected = true;
    delete this.nsp.connected[this.id];
    this.emit('disconnect', reason);
  };
  
  /**
   * Produces an `error` packet.
   *
   * @param {Object} err error object
   * @api private
   */
  
  Socket.prototype.error = function(err){
    this.packet({ type: parser.ERROR, data: err });
  };
  
  /**
   * Disconnects this client.
   *
   * @param {Boolean} close if `true`, closes the underlying connection
   * @return {Socket} self
   * @api public
   */
  
  Socket.prototype.disconnect = function(close){
    if (!this.connected) return this;
    if (close) {
      this.client.disconnect();
    } else {
      this.packet({ type: parser.DISCONNECT });
      this.onclose('server namespace disconnect');
    }
    return this;
  };
  
  /**
   * Sets the compress flag.
   *
   * @param {Boolean} compress if `true`, compresses the sending data
   * @return {Socket} self
   * @api public
   */
  
  Socket.prototype.compress = function(compress){
    this.flags = this.flags || {};
    this.flags.compress = compress;
    return this;
  };