peerjs-server/lib/server.js

var util = require('./util');
var express = require('express');
var http = require('http');
var EventEmitter = require('events').EventEmitter;
var WebSocketServer = require('ws').Server;
var url = require('url');



function PeerServer(options) {
  if (!(this instanceof PeerServer)) return new PeerServer(options);
  EventEmitter.call(this);

  this._app = express();
  this._httpServer = http.createServer(this._app);

  this._options = util.extend({
    port: 80,
    debug: false,
    timeout: 5000
  }, options);

  util.debug = this._options.debug;

  // Connected clients
  this._clients = {};
  
  // Messages waiting for another peer.
  this._outstanding = {};

  // Initailize WebSocket server handlers.
  this._initializeWSS();

  // Initialize HTTP routes. This is only used for the first few milliseconds
  // before a socket is opened for a Peer.
  this._initializeHTTP();
};

util.inherits(PeerServer, EventEmitter);


/** Initialize WebSocket server. */
PeerServer.prototype._initializeWSS = function() {
  var self = this;
  
  // Create WebSocket server as well.
  this._wss = new WebSocketServer({ path: '/ws', server: this._httpServer });

  
  this._wss.on('connection', function(socket) {
    var query = url.parse(socket.upgradeReq.url, true).query;
    var id = query.id || self.generateClientId();
    var token = query.token;
   
    var client = self._clients[id];
    
    if (!client) {
      // New client, save info
      client = { token: token };
      self._clients[id] = client;
      socket.send(JSON.stringify({ type: 'OPEN', id: id }));
    } 
    
    if (token === client.token) {
      // res 'close' event will delete client.res for us
      client.socket = socket;
      // Client already exists
      if (client.res) {
        client.res.end();
      }
    } else {
      // ID-taken, invalid token
      socket.send(JSON.stringify({ type: 'ID-TAKEN', payload: { msg: 'ID is taken' } }));
      socket.close();
      return;
    }

    self._processOutstanding(id);

    // Cleanup after a socket closes.
    socket.on('close', function() {
      util.log('Socket closed:', id);
      if (client.socket == socket) {
        self._removePeer(id);
      }
    });
    
    // Handle messages from peers.
    socket.on('message', function(data) {
      try {
        var message = JSON.parse(data);
        util.log(message);

        switch (message.type) {
          case 'LEAVE':
            // Clean up if a Peer sends a LEAVE.
            if (!message.dst) {
              self._removePeer(id);
              break;
            }
          // ICE candidates
          case 'CANDIDATE':
          // Offer or answer between peers.
          case 'OFFER':
          case 'ANSWER':
          // Firefoxism (connectDataConnection ports)
          // case 'PORT':
            // Use the ID we know to be correct to prevent spoofing.
            self._handleTransmission({
              type: message.type,
              src: id,
              dst: message.dst,
              payload: msg.payload
            });
            break;
          default:
            util.prettyError('Message unrecognized');
        }
      } catch(e) {
        util.log('Invalid message', data);
      }
    });
  });
};


/** Initialize HTTP server routes. */
PeerServer.prototype._initializeHTTP = function() {
  var self = this;
  
  this._app.use(express.bodyParser());
  this._app.use(util.allowCrossDomain);
  
  this._app.options('/*', function(req, res, next) {
    res.send(200);
  });

  // Server sets up HTTP streaming whether you get or post an ID.
  // Retrieve guaranteed random ID.
  this._app.get('/id', function(req, res) {
    var id = self.generateClientId();
    var token = req.query.token;
    self._startStreaming(res, id, token);
  });

  this._app.post('/id', function(req, res) {
    self._startStreaming(res, req.body.id, req.body.token);
  });

    
  var handle = function(req, res){
    var client = self._clients[req.body.id];
    // Auth the req
    if (!client || req.body.token !== client.token) {
      res.send(401);
      return;
    } else {
      self._handleTransmission({
        type: req.body.type,
        src: client.id,
        dst: req.body.dst,
        payload: req.body.payload
      });
      res.send(200);
    }
  };
  
  this._app.post('/offer', handle);

  this._app.post('/candidate', handle);

  this._app.post('/answer', handle);

  this._app.post('/leave', handle);

  this._app.post('/port', handle);
  
  // Listen on user-specified port and 
  this._httpServer.listen(this._options.port);
  
};

/** Saves a streaming response and takes care of timeouts and headers. */
PeerServer.prototype._startStreaming = function(res, id, token) {
  res.writeHead(200, {'Content-Type': 'application/octet-stream'});

  var client = this._clients[id];
  
  // Save res so we can write to it.
  if (!client) {
    // New client, save info
    client = { token: token };
    this._clients[id] = client;
    res.write(JSON.stringify({ type: 'OPEN', id: id }) + '\n');
  }
    
  var pad = '00';
  for (var i = 0; i < 10; i++) {
    pad += pad;
  }
  res.write(pad + '\n');

  if (token === client.token) {
    // Client already exists
    res.on('close', function(){
      if (client.res === res) {
        if (!client.socket) {
          // No new request yet, peer dead
          self._remotePeer(id);
          return;
        }
        delete client.res;
      }
    });
    client.res = res;
    this._processOutstanding(id);
  } else {
    // ID-taken, invalid token
    res.end(JSON.stringify({ type: 'HTTP-ERROR' }));
  }
};

PeerServer.prototype._pruneOutstanding = function() {
  var dsts = Object.keys(this._outstanding);
  for (var i = 0, ii = dsts.length; i < ii; i++) {
    var offers = this._outstanding[dsts[i]];
    var seen = {};
    for (var j = 0, jj = offers.length; j < jj; j++) {
      var message = offers[j];
      if (!seen[message.src]) {
        this._handleTransmission({ type: 'EXPIRE', src: message.dst, dst: message.src });
        seen[message.src] = true;
      }
    }
  }
  this._outstanding = [];
}

/** Process outstanding peer offers. */
PeerServer.prototype._processOutstanding = function(id) {
  var offers = this._outstanding[id];
  if (!offers) {
    return;
  }
  for (var j = 0, jj = offers.length; j < jj; j += 1) {
    this._handleTransmission(offers[j]);
  }
  delete this._outstanding[id];
};

PeerServer.prototype._removePeer = function(id) {
  delete this._clients[id];
};

/** Handles passing on a message. */
PeerServer.prototype._handleTransmission = function(message) {
  var type = message.type;
  var src = message.src;
  var dst = message.dst;
  var data = JSON.stringify(message);

  var destination = this._clients[dst];

  // User is connected!
  if (destination) {
    try {
      if (destination.socket) {
        destination.socket.send(data);
      } else if (destination.res) {
        data += '\n';
        destination.res.write(data);
      } else {
        // Neither socket no res available. Peer dead?
        throw "Peer dead"
      }
    } catch (e) {
      // This happens when a peer disconnects without closing connections and
      // the associated WebSocket has not closed.
      util.prettyError(e);
      // Tell other side to stop trying.
      this._removePeer(dst);
      this._handleTransmission({
        type: 'LEAVE',
        src: dst,
        dst: src
      });
    }
  } else {
    // Wait for this client to connect/reconnect (XHR) for important
    // messages.
    if (type !== 'LEAVE' && type !== 'EXPIRE' && !!dst) {
      var self = this;
      if (!this._outstanding[dst]) {
        this._outstanding[dst] = [];
      }
      this._outstanding[dst].push(message);
    } else if (type === 'LEAVE' && !dst) {
      this._removePeer(src);
    } else {
      // Unavailable destination specified with message LEAVE or EXPIRE
      // Ignore
    }
  }
};

PeerServer.prototype._generateClientId = function() {
  var clientId = util.randomId();
  while (!!this._clients[clientId]) {
    clientId = util.randomId();
  }
  return clientId;
};

exports.PeerServer = PeerServer;