git.cworth.org Git - empires-server/blob - game.js

   1 const no_team = { name: "" };
   2
   3 /* A single player can have multiple connections, (think, multiple
   4  * browser windows with a common session cookie). */
   5 class Player {
   6   constructor(id, session_id, name, connection) {
   7     this.id = id;
   8     this.session_id = session_id;
   9     this.name = name;
  10     this.connections = [connection];
  11     this.team = no_team;
  12     this.active = true;
  13   }
  14
  15   add_connection(connection) {
  16     /* Don't add a duplicate connection if this player already has it. */
  17     for (let c of this.connections) {
  18       if (c === connection)
  19         return;
  20     }
  21
  22     this.connections.push(connection);
  23   }
  24
  25   /* Returns the number of remaining connections after this one is removed. */
  26   remove_connection(connection) {
  27     this.connections = this.connections.filter(c => c !== connection);
  28     return this.connections.length;
  29   }
  30
  31   /* Send a string to all connections for this player. */
  32   send(data) {
  33     this.connections.forEach(connection => connection.write(data));
  34   }
  35
  36   info_json() {
  37     return JSON.stringify({
  38       id: this.id,
  39       name: this.name,
  40       team: this.team.name,
  41       score: this.score
  42     });
  43   }
  44 }
  45
  46 /* This replacer function allows for JSON.stringify to give results
  47  * for objects of various types that are used in game state.
  48  */
  49 function stringify_replacer(key, value) {
  50   if (typeof value === 'object' && value instanceof Set) {
  51     return [...value];
  52   }
  53   return value;
  54 }
  55
  56 /* Base class providing common code for game engine implementations. */
  57 class Game {
  58   constructor(id) {
  59     this.id = id;
  60     this.players = [];
  61     this.players_by_session = {};
  62     this.next_player_id = 1;
  63     this.teams = [];
  64     this.state = {
  65       team_to_play: no_team
  66     };
  67     this.first_move = true;
  68
  69     /* Send a comment to every connected client every 15 seconds. */
  70     setInterval(() => {this.broadcast_string(":");}, 15000);
  71   }
  72
  73   /* Suport for game meta-data.
  74    *
  75    * What we want here is an effectively static field that is
  76    * accessible through either the class name (SomeGame.meta) or an
  77    * instance (some_game.meta). To pull this off we do keep two copies
  78    * of the data. But the game classes can just set SomeGame.meta once
  79    * and then reference it either way.
  80    */
  81   static set meta(data) {
  82     /* This allows class access (SomeGame.meta) via the get method below. */
  83     this._meta = data;
  84
  85     /* While this allows access via an instance (some_game.meta). */
  86     this.prototype.meta = data;
  87   }
  88
  89   static get meta() {
  90     return this._meta;
  91   }
  92
  93   /* Just performs some checks for whether a move is definitely not
  94    * legal (such as not the player's turn). A child class is expected
  95    * to override this (and call super.add_move early!) to implement
  96    * the actual logic for a move. */
  97   add_move(player, move) {
  98
  99     /* The checks here don't apply on the first move. */
 100     if (! this.first_move) {
 101
 102       /* Discard any move asserting to be the first move if it's no
 103        * longer the first move. This resolves the race condition if
 104        * multiple players attempt to make the first move. */
 105       if (move.assert_first_move) {
 106         return { legal: false,
 107                  message: "Your opponent beat you to the first move" };
 108       }
 109
 110       /* Cannot move if you are not on a team. */
 111       if (player.team === no_team)
 112       {
 113         return { legal: false,
 114                  message: "You must be on a team to take a turn" };
 115       }
 116
 117       /* Cannot move if it's not this player's team's turn. */
 118       if (player.team !== this.state.team_to_play)
 119       {
 120         return { legal: false,
 121                  message: "It's not your turn to move" };
 122       }
 123     }
 124
 125     return { legal: true };
 126   }
 127
 128   /* Assign team only if player is unassigned.
 129    * Return true if assignment made, false otherwise. */
 130   assign_player_to_team_perhaps(player, team)
 131   {
 132     if (player.team !== no_team)
 133       return false;
 134
 135     player.team = team;
 136     this.broadcast_event("player-update", player.info_json());
 137
 138     return true;
 139   }
 140
 141   /* This function is called after the child add_move has returned
 142    * 'result' so that any generic processing can happen.
 143    *
 144    * In particular, we assign teams for a two-player game where a
 145    * player assumed a team by making the first move. */
 146   post_move(player, result)
 147   {
 148     if (this.first_move && result.legal) {
 149       this.first_move = false;
 150
 151       this.assign_player_to_team_perhaps(player, this.teams[0]);
 152
 153       /* Yes, start at 1 to skip teams[0] which we just assigned. */
 154       for (let i = 1; i < this.teams.length; i++) {
 155         const other = this.players.find(p => (p !== player) && (p.team === no_team));
 156         if (!other)
 157           return;
 158         this.assign_player_to_team_perhaps(other, this.teams[i]);
 159       }
 160     }
 161   }
 162
 163   add_player(session, connection) {
 164     /* First see if we already have a player object for this session. */
 165     const existing = this.players_by_session[session.id];
 166     if (existing) {
 167       existing.add_connection(connection);
 168       return existing;
 169     }
 170
 171     /* No existing player. Add a new one. */
 172     const id = this.next_player_id;
 173     let nickname = session.nickname;
 174     if (nickname === "")
 175       nickname = "Guest";
 176     const nickname_orig = nickname;
 177
 178     /* Ensure we don't have a name collision with a previous player. */
 179     let unique_suffix = 1;
 180     while (this.players.find(player => player.name === nickname))
 181     {
 182       nickname = `${nickname_orig}${unique_suffix.toString().padStart(2, '0')}`;
 183       unique_suffix++;
 184     }
 185
 186     const player = new Player(id, session.id, nickname, connection);
 187
 188     /* Broadcast before adding player to list (to avoid announcing the
 189      * new player to itself). */
 190     const player_data = JSON.stringify({ id: player.id, name: player.name });
 191     this.broadcast_event("player-enter", player_data);
 192
 193     this.players.push(player);
 194     this.players_by_session[session.id] = player;
 195     this.next_player_id++;
 196
 197     /* After adding the player to the list, and if we are already past
 198      * the first move, assign this player to the first team that
 199      * doesn't already have a player assigned (if any). */
 200     if (! this.first_move) {
 201       const have_players = Array(this.teams.length).fill(false);
 202       this.players.forEach(p => {
 203         if (p.team.id !== undefined)
 204           have_players[p.team.id] = true;
 205       });
 206       const first_empty = have_players.findIndex(i => i === false);
 207       this.assign_player_to_team_perhaps(player, this.teams[first_empty]);
 208     }
 209
 210     return player;
 211   }
 212
 213   /* Drop a connection object from a player, and if it's the last one,
 214    * then drop that player from the game's list of players. */
 215   remove_player_connection(player, connection) {
 216     const remaining = player.remove_connection(connection);
 217     if (remaining === 0) {
 218       player.active = false;
 219       const player_data = JSON.stringify({ id: player.id });
 220       this.broadcast_event("player-exit", player_data);
 221     }
 222   }
 223
 224   /* Send a string to all players */
 225   broadcast_string(str) {
 226     this.players.forEach(player => player.send(str + '\n'));
 227   }
 228
 229   /* Send an event to all players.
 230    *
 231    * An event has both a declared type and a separate data block.
 232    * It also ends with two newlines (to mark the end of the event).
 233    */
 234   broadcast_event(type, data) {
 235     this.broadcast_string(`event: ${type}\ndata: ${data}\n`);
 236   }
 237
 238   broadcast_event_object(type, obj) {
 239     this.broadcast_event(type, JSON.stringify(obj));
 240   }
 241
 242   handle_events(request, response) {
 243     /* These headers will keep the connection open so we can stream events. */
 244     const headers = {
 245       "Content-type": "text/event-stream",
 246       "Connection": "keep-alive",
 247       "Cache-Control": "no-cache"
 248     };
 249     response.writeHead(200, headers);
 250
 251     /* Add this new player. */
 252     const player = this.add_player(request.session, response);
 253
 254     /* And queue up cleanup to be triggered on client close. */
 255     request.on('close', () => {
 256       this.remove_player_connection(player, response);
 257     });
 258
 259     /* Give the client the game-info event. */
 260     const game_info_json = JSON.stringify({
 261       id: this.id,
 262       url: `${request.protocol}://${request.hostname}/${this.id}`
 263     });
 264     response.write(`event: game-info\ndata: ${game_info_json}\n\n`);
 265
 266     /* And the player-info event. */
 267     response.write(`event: player-info\ndata: ${player.info_json()}\n\n`);
 268
 269     /* As well as player-enter events for all existing, active players. */
 270     this.players.filter(p => p !== player && p.active).forEach(p => {
 271       response.write(`event: player-enter\ndata: ${p.info_json()}\n\n`);
 272     });
 273
 274     /* Finally, if this game class has a "state" property, stream that
 275      * current state to the client. */
 276     if (this.state) {
 277       const state_json = JSON.stringify(this.state, stringify_replacer);
 278       response.write(`event: game-state\ndata: ${state_json}\n\n`);
 279     }
 280   }
 281
 282   handle_player(request, response) {
 283     const player = this.players_by_session[request.session.id];
 284     const name = request.body.name;
 285     const team_name = request.body.team;
 286     var updated = false;
 287     if (! player) {
 288       response.sendStatus(404);
 289       return;
 290     }
 291
 292     if (name && (player.name !== name)) {
 293       player.name = name;
 294
 295       /* In addition to setting the name within this game's player
 296        * object, also set the name in the session. */
 297       request.session.nickname = name;
 298       request.session.save();
 299
 300       updated = true;
 301     }
 302
 303     if (team_name !== null && (player.team.name !== team_name))
 304     {
 305       if (team_name === "") {
 306         player.team = no_team;
 307         updated = true;
 308       } else {
 309         const index = this.teams.findIndex(t => t.name === team_name);
 310         if (index >= 0) {
 311           player.team = this.teams[index];
 312           updated = true;
 313         }
 314       }
 315     }
 316
 317     if (updated)
 318       this.broadcast_event("player-update", player.info_json());
 319
 320     response.send("");
 321   }
 322
 323   broadcast_move(move) {
 324     this.broadcast_event("move", JSON.stringify(move));
 325   }
 326
 327 }
 328
 329 module.exports = Game;