1 const express = require("express");
2 const cors = require("cors");
3 const body_parser = require("body-parser");
4 const session = require("express-session");
5 const bcrypt = require("bcrypt");
6 const path = require("path");
7 const nunjucks = require("nunjucks");
10 var lmno_config = require("./lmno-config.json");
16 function config_usage() {
17 console.log(`Error: Refusing to run without configuration.
19 Please create a file named lmno-config.json that looks as follows:
22 "session_secret": "<this should be a long string of true-random characters>",
24 "username": "<username>",
25 "password_hash_bcrypt": "<password_hash_made_by_bcrypt>"
29 Note: Of course, change all of <these-parts> to actual values desired.
31 The "node lmno-passwd.js" command can help generate password hashes.`);
34 const app = express();
36 app.use(body_parser.urlencoded({ extended: false }));
37 app.use(body_parser.json());
39 secret: lmno_config.session_secret,
41 saveUninitialized: false
44 nunjucks.configure("templates", {
49 /* Load each of our game mini-apps. */
51 empires: require("./empires"),
52 tictactoe: require("./tictactoe")
61 return Array(4).fill(null).map(() => LMNO.letters.charAt(Math.floor(Math.random() * LMNO.letters.length))).join('');
64 create_game(engine_name) {
66 var id = this.generate_id();
67 } while (id in this.games);
69 const engine = engines[engine_name];
71 const game = new engine.Game(id);
73 this.games[id] = game;
79 /* Some letters we don't use in our IDs:
81 * 1. Vowels (AEIOU) to avoid accidentally spelling an unfortunate word
82 * 2. Lowercase letters (replace with corresponding capital on input)
83 * 3. N (replace with M on input)
84 * 4. P (replace with B on input)
85 * 5. S (replace with F on input)
87 LMNO.letters = "BCDFGHJKLMQRTVWXYZ";
89 const lmno = new LMNO();
91 /* Force a game ID into a canonical form as described above. */
92 function lmno_canonize(id) {
94 id = id.toUpperCase();
96 /* Replace unused letters with nearest phonetic match. */
97 id = id.replace(/N/g, 'M');
98 id = id.replace(/P/g, 'B');
99 id = id.replace(/S/g, 'F');
101 /* Replace unused numbers nearest visual match. */
102 id = id.replace(/0/g, 'O');
103 id = id.replace(/1/g, 'I');
104 id = id.replace(/5/g, 'S');
109 app.post('/new/:game_engine', (request, response) => {
110 const game_engine = request.params.game_engine;
111 const game = lmno.create_game(game_engine);
112 response.send(JSON.stringify(game.id));
115 /* Redirect any requests to a game ID at the top-level.
117 * Specifically, after obtaining the game ID (from the path) we simply
118 * lookup the game engine for the corresponding game and then redirect
119 * to the engine- and game-specific path.
121 app.get('/[a-zA-Z0-9]{4}', (request, response) => {
122 const game_id = request.path.replace(/\//g, "");
123 const canon_id = lmno_canonize(game_id);
125 /* Redirect user to page with the canonical ID in it. */
126 if (game_id !== canon_id) {
127 response.redirect(301, `/${canon_id}/`);
131 const game = lmno.games[game_id];
132 if (game === undefined) {
133 response.sendStatus(404);
136 response.redirect(301, `/${game.meta.identifier}/${game.id}/`);
139 /* LMNO middleware to lookup the game. */
140 app.use('/:engine([^/]+)/:game_id([a-zA-Z0-9]{4})', (request, response, next) => {
141 const engine = request.params.engine;
142 const game_id = request.params.game_id;
143 const canon_id = lmno_canonize(game_id);
145 /* Redirect user to page with the canonical ID in it, also ensuring
146 * that the game ID is _always_ followed by a slash. */
147 const has_slash = new RegExp(`^/${engine}/${game_id}/`);
148 if (game_id !== canon_id ||
149 ! has_slash.test(request.originalUrl))
151 const old_path = new RegExp(`/${engine}/${game_id}/?`);
152 const new_path = `/${engine}/${canon_id}/`;
153 const new_url = request.originalUrl.replace(old_path, new_path);
154 response.redirect(301, new_url);
158 /* See if there is any game with this ID. */
159 const game = lmno.games[game_id];
160 if (game === undefined) {
161 response.sendStatus(404);
165 /* Stash the game onto the request to be used by the game-specific code. */
170 function auth_admin(request, response, next) {
171 /* If there is no user associated with this session, redirect to the login
172 * page (and set a "next" query parameter so we can come back here).
174 if (! request.session.user) {
175 response.redirect(302, "/login?next=" + request.path);
179 /* If the user is logged in but not authorized to view the page then
180 * we return that error. */
181 if (request.session.user.role !== "admin") {
182 response.status(401).send("Unauthorized");
188 app.get('/logout', (request, response) => {
189 request.session.user = undefined;
190 request.session.destroy();
192 response.send("You are now logged out.");
195 app.get('/login', (request, response) => {
196 if (request.session.user) {
197 response.send("Welcome, " + request.session.user + ".");
201 response.render('login.html');
204 app.post('/login', async (request, response) => {
205 const username = request.body.username;
206 const password = request.body.password;
207 const user = lmno_config.users[username];
209 response.sendStatus(404);
212 const match = await bcrypt.compare(password, user.password_hash_bcrypt);
214 response.sendStatus(404);
217 request.session.user = { username: user.username, role: user.role };
218 response.sendStatus(200);
222 /* API to set uer profile information */
223 app.put('/profile', (request, response) => {
224 const nickname = request.body.nickname;
226 request.session.nickname = nickname;
227 request.session.save();
232 /* An admin page (only available to admin users, of course) */
233 app.get('/admin/', auth_admin, (request, response) => {
237 for (let id in lmno.games) {
238 if (lmno.games[id].clients.length)
239 active.push(lmno.games[id]);
241 idle.push(lmno.games[id]);
243 response.render('admin.html', { test: "foobar", games: { active: active, idle: idle}});
247 /* Mount sub apps. only _after_ we have done all the middleware we need. */
248 for (let key in engines) {
249 const engine = engines[key];
251 /* Add routes that are common to all games. */
252 engine.router.get('/', (request, response) => {
253 const game = request.game;
255 if (! request.session.nickname)
256 response.render('choose-nickname.html', { game_name: game.meta.name });
258 response.render(`${game.meta.identifier}-game.html`);
261 engine.router.get('/events', (request, response) => {
262 const game = request.game;
264 game.handle_events(request, response);
267 /* And mount the whole router at the path for the game. */
268 app.use(`/${engine.Game.meta.identifier}/[a-zA-Z0-9]{4}/`, engine.router);
271 app.listen(4000, function () {
272 console.log('LMNO server listening on localhost:4000');