synclounge/server.js

// ABOUT
// Runs the SyncLounge Server software - handles rooms
// Defaults to 8089

// V2.0

// USER CONFIG

// END USER CONFIG
var express = require('express')
var cors = require('cors')

let SettingsHelper = require('./SettingsHelper')
let settings = new SettingsHelper()

var root = express()
root.use(cors({ credentials: false }))
root.use((req, res, next) => {
  res.setHeader('Access-Control-Allow-Credentials', false)
  next()
})
var ptserver = express()

var PORT = process.env.server_port || 8089

// Setup our PTServer

ptserver.get('/health', (req, res) => {
  res.setHeader('Content-Type', 'application/json')
  let connectedUsers = Object.keys(ptserver_io.sockets.connected).length
  let load = 'low'
  if (connectedUsers > 25) {
    load = 'medium'
  }
  if (connectedUsers > 50) {
    load = 'high'
  }
  return res.send(JSON.stringify({ load })).end()
})
ptserver.get('/', (req, res) => {
  return res.send('You\'ve connected to the SLServer, you\'re probably looking for the webapp.')
})
// Merge everything together

let serverRoot = settings.serverroot || '/'
console.log('Setting up with serverRoot of', serverRoot)
root.use(serverRoot, ptserver)
root.get('*', function (req, res) {
  return res.send('You\'ve connected to the SLServer, you\'re probably looking for the webapp.')
})

var rootserver = require('http').createServer(root)
var ptserver_io = require('socket.io')(rootserver, { path: serverRoot + '/socket.io' })

ptserver_io.on('connection', (socket) => {
  console.log('Someone connected to the ptserver socket')

  socket.on('join', function (data) {
    // A user is attempting to join a room
    if (data == null) {
      return
    }
    if (!data || !data.username || !data.room) {
      console.log('Invalid join attempt', data)
      return socket.emit('join-result', false, {}, 'Invalid data', [])
    }
    var tempUser = new User()
    var result = true
    var _data = {}
    var details = 'Successfully connected to ' + data.room

    if (socket.selfUser != null || socket.selfUser !== undefined) {
      // Already in a room! Leave the room we're in
      handleDisconnect(false)
    }
    var room = ptserver_io.sockets.adapter.rooms[data.room]
    if (room === undefined || room.users === undefined || room.users === null) {
      socket.join(data.room)
      room = ptserver_io.sockets.adapter.rooms[data.room]
      room.users = []
      room.password = data.password
      tempUser.role = 'host'
      tempUser.username = getValidUsername([], data.username)
    } else {
      tempUser.username = getValidUsername(room.users, data.username)
      if (room.password === null || room.password === '') {
        // Check if we've already got a Host
        if (room.hostUsername == null) {
          // We dont have a host user yet.
          // This should never happen..
          room.hostUsername = tempUser.username
          tempUser.role = 'host'
          socket.join(data.room)
        } else {
          tempUser.role = 'guest'
          socket.join(data.room)
        }
      } else {
        // This room has a password
        if (room.password === data.password) {
          // Good password!
          if (room.hostUsername == null) {
            // We dont have a host user yet.
            console.log('We dont have a host user')
            room.hostUsername = tempUser.username
            tempUser.role = 'host'
            socket.join(data.room)
          } else {
            tempUser.role = 'guest'
            socket.join(data.room)
          }
        } else {
          result = false
          details = 'wrong password'
        }
      }
    }

    tempUser.avatarUrl = data.avatarUrl

    // We've sorted out where the user should go, lets send back
    var currentUsers = null
    if (result) {
      tempUser.room = data.room
      console.log('User ' + tempUser.username + ' joined ' + tempUser.room)
      if (tempUser.role === 'host') {
        room.hostUsername = tempUser.username
      }
      room.users.push(tempUser)
      console.log('they joined OK and were given the username ' + tempUser.username)

      socket.broadcast.to(data.room).emit('user-joined', room.users, tempUser)
      // Set some objects on the socket for ease of use down the road
      socket.ourRoom = data.room
      socket.selfUser = tempUser
      currentUsers = room.users
    } else {
      console.log('User failed to join a room')
    }
    _data = tempUser
    socket.emit('join-result', result, _data, details, currentUsers)
  })
  socket.on('poll', (data) => {
    if (socket.ourRoom == null) {
      // console.log('This user should join a room first')
      socket.emit('flowerror', 'You aren\' connected to a room! Use join')
      socket.emit('rejoin')
      return
    }
    // Recieved an update from a user
    updateUserData(socket.selfUser.username, data, socket.selfUser.room)

    socket.emit('poll-result', ptserver_io.sockets.adapter.rooms[socket.selfUser.room].users, socket.selfUser, data.commandId)
    if (socket.selfUser.role === 'host') {
      // We're the host, broadcast to all clients our data
      var temp = {}
      temp.time = data.time
      temp.maxTime = data.maxTime
      temp.title = data.title
      temp.rawTitle = data.rawTitle
      temp.lastHeartbeat = new Date().getTime()
      temp.playerState = data.playerState
      temp.clientResponseTime = data.clientResponseTime
      temp.machineIdentifier = data.machineIdentifier
      temp.type = data.type
      temp.showName = data.showName
      temp.key = data.key
      temp.latency = data.latency
      temp.showName = data.showName
      temp.status = data.status
      temp.playerProduct = data.playerProduct
      socket.broadcast.to(socket.selfUser.room).emit('host-update', temp)
    }
  })
  socket.on('send_message', function (msg) {
    // console.log(msg)
    if (socket.ourRoom == null) {
      // console.log('This user should join a room first')
      socket.emit('flowerror', 'You aren\' connected to a room! Use join')
      socket.emit('rejoin')
      return
    }
    // console.log('New message in channel ' + socket.selfUser.room + ' from ' + socket.selfUser.username + ' saying ' + msg)
    socket.broadcast.to(socket.selfUser.room).emit('new_message', {
      msg: msg.msg,
      user: {
        username: socket.selfUser.username,
        thumb: socket.selfUser.avatarUrl
      },
      type: msg.type
    })
  })
  socket.on('transfer_host', function (data) {
    if (socket.ourRoom == null) {
      // console.log('This user should join a room first')
      socket.emit('flowerror', 'You aren\' connected to a room! Use join')
      socket.emit('rejoin')
      return
    }
    console.log('Hi there', data)
    transferHost(socket.selfUser, function (user) { return user.username === data.username })
  })
  socket.on('connect_timeout', function () {
    // console.log('timeout')
    handleDisconnect(true)
  })
  socket.on('disconnect', function () {
    handleDisconnect(true)
  })
  function handleDisconnect (disconnect) {
    if (socket.selfUser === undefined || socket.selfUser === null) {
      return
    }
    // console.log('User left: ' + socket.selfUser.username)
    transferHost(socket.selfUser, function (user) { return user !== socket.selfUser })
    removeUser(socket.selfUser.room, socket.selfUser.username)
    if (ptserver_io.sockets.adapter.rooms[socket.selfUser.room]) {
      socket.broadcast.to(socket.selfUser.room).emit('user-left', ptserver_io.sockets.adapter.rooms[socket.selfUser.room].users, socket.selfUser)
    }
    socket.disconnect(disconnect)
  }
  function updateUserData (username, userData, room) {
    if (!room === undefined || room === undefined || room === null) {
      console.log('Tried to update a user who isnt in a room', username, userData, room)
      return false
    }
    try {
      for (var i in ptserver_io.sockets.adapter.rooms[room].users) {
        var user = ptserver_io.sockets.adapter.rooms[room].users[i]
        if (user.username === username) {
          // This is our user
          user.time = userData.time
          user.maxTime = userData.maxTime
          user.title = userData.title
          user.lastHeartbeat = (new Date()).getTime()
          user.playerState = userData.playerState
          user.rawTitle = userData.rawTitle
          user.clientResponseTime = userData.clientResponseTime
          user.type = userData.type
          user.showName = userData.showName || ''
          user.playerProduct = userData.playerProduct || ''
          user.status = userData.status || 'unknown'
          user.machineIdentifier = userData.machineIdentifier || ''
          user.key = userData.key
          user.uuid = userData.uuid
          return
        }
      }
    } catch (e) {
      console.log('Failed to update a user', username, userData, room)
    }
  }
  function transferHost (user, newHostPredicate) {
    if (user.role !== 'host') {
      console.log('Not transfering host in room', user.room, 'from', user.username, 'because its role is', user.role)
      return
    }
    var room = ptserver_io.sockets.adapter.rooms[user.room]
    if (!room) {
      console.log('Not transfering the host in the room', user.room, 'because the room was already destroyed')
      return
    }
    var newHost = room.users.find(newHostPredicate)
    if (!newHost) {
      console.log('Not transfering host in room', user.room, 'from', user.username, 'because suitable user found')
      return
    }
    console.log('Transfering host in room', user.room, 'from', user.username, 'to', newHost.username)
    user.role = 'guest'
    newHost.role = 'host'
    room.hostUser = newHost
    room.hostUsername = newHost.username
    socket.broadcast.to(user.room).emit('host-swap', newHost)
  }
  function removeUser (roomname, username) {
    var room = ptserver_io.sockets.adapter.rooms[roomname]
    if (room === undefined) {
      return
    }
    for (var i in room.users) {
      if (room.users[i].username === username) {
        // This is the user that we need to remove
        room.users.splice(i, 1)
      }
    }
  }
  function getValidUsername (usersarray, wantedname) {
    var tempname = wantedname
    while (true) {
      // We need to loop through the users list until we create a valid name
      var found = false
      for (var i in usersarray) {
        if (usersarray[i].username === tempname) {
          // console.log(usersarray[i].username + ' == ' + tempname)
          found = true
        }
      }
      if (found) {
        // Looks like that username is taken
        // Check if we've already appended '(x)'
        if (tempname.indexOf('(') > -1) {
          // we have
          var value = parseInt(tempname.substring(
            tempname.indexOf('(') + 1, tempname.indexOf(')')))
          var newvalue = value + 1
          tempname = tempname.replace('(' + value + ')', '(' + newvalue + ')')
        } else {
          // we haven't
          tempname = tempname + '(1)'
        }
      } else {
        // This is a valid name!
        return tempname
      }
    }
  }

  var User = function () {
    this.username = null
    this.role = null
    this.room = null
    this.title = null
    this.time = null
    this.avatarUrl = null
  }
})
rootserver.listen(PORT)
console.log('SyncLounge Server successfully started on port ' + PORT)

setInterval(function () {
  console.log('Connected users: ' + Object.keys(ptserver_io.sockets.connected).length)
}, 5000)