Version bump

Bumps [express](https://github.com/expressjs/express) from 5.1.0 to 5.2.0.
- [Release notes](https://github.com/expressjs/express/releases)
- [Changelog](https://github.com/expressjs/express/blob/master/History.md)
- [Commits](https://github.com/expressjs/express/compare/v5.1.0...v5.2.0)

---
updated-dependencies:
- dependency-name: express
  dependency-version: 5.2.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

.dockerignore

@@ -0,0 +1,10 @@
+.git*
+
+tools*
+mysql*
+letsencrypt*
+test*
+
+.env*
+.github*
+LICENSE*

.envdev

@@ -1,6 +1,10 @@
 WEB_PORT=3300
 
-DB_HOSTNAME=database
+WEB_ORIGIN=http://localhost:3001
+
+DB_HOSTNAME=localhost
+DB_PORTNAME=3306
+
 DB_DATABASE=chat
 DB_USERNAME=chat
 DB_PASSWORD=blastoise

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+patreon: krgamestudios
+ko_fi: krgamestudios
+custom: ["https://www.paypal.com/donate/?hosted_button_id=73Q82T2ZHV8AA"]

.github/dependabot.yml

@@ -0,0 +1,10 @@
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+

.github/workflows/docker.yml

@@ -5,19 +5,21 @@ on:
   push:
     tags:
       - v1.*
+  workflow_dispatch:
+
 jobs:
   push_to_registry:
     name: Push Docker Image to Docker Hub
     runs-on: ubuntu-latest
     steps:
-      - name: Check Out The Repo
+      - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v5
 
-      - name: Set up QEMU
+      - name: Setup QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v3
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v3
 
       - name: Get Smart Tag
         id: prepare
@@ -26,13 +28,13 @@ jobs:
           docker_image: krgamestudios/chat-server
 
       - name: Login to DockerHub
-        uses: docker/login-action@v1 
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Push to Docker Hub
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v6
         with:
           push: true
           tags: ${{ steps.prepare.outputs.tag }}

Dockerfile

@@ -1,8 +1,8 @@
 
-FROM node:15
+FROM node:22-bookworm-slim
 WORKDIR "/app"
-COPY package*.json ./
+COPY package*.json /app
-RUN npm install --production
+RUN npm install --omit=dev
 COPY . /app
 EXPOSE 3300
 USER node

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2021 Kayne Ruse, KR Game Studios
+Copyright (c) 2021-2023 Kayne Ruse, KR Game Studios
 
 This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
 

README.md

@@ -2,13 +2,34 @@
 
 An API centric chat server. Uses Sequelize and mariaDB by default.
 
+This server is available via docker hub at krgamestudios/chat-server.
+
 # Setup
 
-There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker-compose up --build` - run `node configure-script.js` to generate docker-compose.yml.
+There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker compose up --build` - run `node configure-script.js` to generate docker-compose.yml and startup.sql.
+
+To generate an authorization token, use [auth-server](https://github.com/krgamestudios/auth-server). A public-facing development auth-server is available here (tokens are valid for 10 minutes):
+
+```
+POST https://dev-auth.krgamestudios.com/auth/login HTTP/1.1
+Content-Type: application/json
+
+{
+	"email": "example@example.com",
+	"password": "helloworld"
+}
+```
 
 # API
 
-This server uses socket.io for communication. Be aware that every chat message requires a valid JWT. See the [auth-server](https://github.com/krgamestudios/auth-server) for details.
+This server uses socket.io for communication. Be aware that every 'open chat', 'message' and 'report' signal requires a valid JWT, as part of the message:
+
+```js
+socket.emit('message', {
+	accessToken,
+	text: inputRef.current.value
+});
+```
 
 The event types are as follows:
 
@@ -19,6 +40,7 @@ on 'error' -> Server emits and logs an error
 on 'open chat' -> Preps the server for your messages, places you in the room 'general'
 on 'message' -> Server broadcasts to all other users in your room
 on 'disconnect' -> Server will no longer accept your messages
+on 'report' -> Report the chatlog with the index 'id'
 
 
 Chat Commands:

configure-script.js

@@ -30,10 +30,30 @@ const question = (prompt, def = null) => {
 	//project configuration
 	const appName = await question('App Name', 'chat');
 	const appWebAddress = await question('Web Addr', `${appName}.example.com`);
+	const appWebOrigin = await question('Web Origin', `https://example.com`); //TODO: clean these up properly
 	const appPort = await question('App Port', '3300');
 
+  //configure the database address
+  let dbLocation = '';
+  while (typeof dbLocation != 'string' || /^[le]/i.test(dbLocation[0]) == false) {
+    dbLocation = await question('[l]ocal or [e]xternal database?');
+  }
+
+  let appDBHost = '';
+  let appDBPort = '';
+
+  if (/^[l]/i.test(dbLocation[0])) {
+    appDBHost = 'database';
+    appDBPort = '3306';
+  }
+  else {
+    appDBHost = await question('DB Host');
+    appDBPort = await question('DB Port', '3306');
+  }
+
+  //configure the database account
 	const appDBUser = await question('DB User', appName);
-	const appDBPass = await question('DB Pass', uuid());
+	const appDBPass = await question('DB Pass', 'blastoise');
 	const dbRootPass = await question('DB Root Pass');
 
 	const appSecretAccess = await question('Access Token Secret', uuid(32));
@@ -42,37 +62,42 @@ const question = (prompt, def = null) => {
 
 	//generate the files
 	const ymlfile = `
-version: '3'
-
 services:
   ${appName}:
     build:
       context: .
     ports:
-      - "${appPort}"
+      - ${appPort}
     labels:
-      - "traefik.enable=true"
+      - traefik.enable=true
-      - "traefik.http.routers.${appName}router.rule=Host(\`${appWebAddress}\`)"
+      - traefik.http.routers.${appName}router.rule=Host(\`${appWebAddress}\`)
-      - "traefik.http.routers.${appName}router.entrypoints=websecure"
+      - traefik.http.routers.${appName}router.entrypoints=websecure
-      - "traefik.http.routers.${appName}router.tls.certresolver=myresolver"
+      - traefik.http.routers.${appName}router.tls.certresolver=myresolver
-      - "traefik.http.routers.${appName}router.service=${appName}service@docker"
+      - traefik.http.routers.${appName}router.service=${appName}service@docker
-      - "traefik.http.services.${appName}service.loadbalancer.server.port=${appPort}"
+      - traefik.http.services.${appName}service.loadbalancer.server.port=${appPort}
     environment:
       - WEB_PORT=${appPort}
-      - DB_HOSTNAME=database
+      - WEB_ORIGIN=${appWebOrigin}
+      - DB_HOSTNAME=${appDBHost}
+      - DB_PORTNAME=${appDBPort}
       - DB_DATABASE=${appName}
       - DB_USERNAME=${appDBUser}
       - DB_PASSWORD=${appDBPass}
       - DB_TIMEZONE=Australia/Sydney
       - SECRET_ACCESS=${appSecretAccess}
+    volumes:
+      - /etc/timezone:/etc/timezone:ro
+      - /etc/localtime:/etc/localtime:ro
     networks:
-      - app-network
+      - app-network${ appDBHost != 'database' ? '' : `
     depends_on:
       - database
+
   database:
     image: mariadb:latest
     environment:
       MYSQL_DATABASE: ${appName}
+      MYSQL_TCP_PORT: ${appDBPort}
       MYSQL_USER: ${appDBUser}
       MYSQL_PASSWORD: ${appDBPass}
       MYSQL_ROOT_PASSWORD: ${dbRootPass}
@@ -81,37 +106,43 @@ services:
     volumes:
       - ./mysql:/var/lib/mysql
       - ./startup.sql:/docker-entrypoint-initdb.d/startup.sql:ro
+      - /etc/timezone:/etc/timezone:ro
+      - /etc/localtime:/etc/localtime:ro`}
+
   traefik_${appName}:
     container_name: ${appName}_traefik
-    image: "traefik:v2.4"
+    image: traefik:v2.10
-    container_name: "traefik"
+    container_name: traefik
     command:
-      - "--log.level=ERROR"
+      - --log.level=ERROR
-      - "--api.insecure=false"
+      - --api.insecure=false
-      - "--providers.docker=true"
+      - --providers.docker=true
-      - "--providers.docker.exposedbydefault=false"
+      - --providers.docker.exposedbydefault=false
-      - "--entrypoints.websecure.address=:443"
+      - --entrypoints.websecure.address=:443
-      - "--certificatesresolvers.myresolver.acme.tlschallenge=true"
+      - --certificatesresolvers.myresolver.acme.tlschallenge=true
-      - "--certificatesresolvers.myresolver.acme.email=${supportEmail}"
+      - --certificatesresolvers.myresolver.acme.email=${supportEmail}
-      - "--certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json"
+      - --certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json
     ports:
-      - "80:80"
+      - 80:80
-      - "443:443"
+      - 443:443
     volumes:
-      - "./letsencrypt:/letsencrypt"
+      - ./letsencrypt:/letsencrypt
-      - "/var/run/docker.sock:/var/run/docker.sock:ro"
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+      - /etc/timezone:/etc/timezone:ro
+      - /etc/localtime:/etc/localtime:ro
     networks:
       - app-network
+
 networks:
   app-network:
     driver: bridge
 `;
 
 	const dockerfile = `
-FROM node:15
+FROM node:22-bookworm-slim
 WORKDIR "/app"
 COPY package*.json ./
-RUN npm install --production
+RUN npm install --omit=dev
 COPY . /app
 EXPOSE ${appPort}
 USER node

package.json

@@ -1,6 +1,6 @@
 {
   "name": "chat-server",
-  "version": "1.0.0",
+  "version": "1.5.5",
   "description": "An API centric chat server. Uses Sequelize and mariaDB by default.",
   "main": "server/server.js",
   "scripts": {
@@ -13,22 +13,21 @@
     "url": "git+https://github.com/krgamestudios/chat-server.git"
   },
   "author": "Kayne Ruse",
-  "license": "ISC",
+  "license": "Zlib",
   "bugs": {
     "url": "https://github.com/krgamestudios/chat-server/issues"
   },
   "homepage": "https://github.com/krgamestudios/chat-server#readme",
   "dependencies": {
-    "body-parser": "^1.19.0",
     "cors": "^2.8.5",
-    "dotenv": "^8.2.0",
+    "dotenv": "^17.2.3",
-    "express": "^4.17.1",
+    "express": "^5.2.1",
-    "jsonwebtoken": "^8.5.1",
+    "jsonwebtoken": "^9.0.3",
-    "mariadb": "^2.5.2",
+    "mariadb": "^3.4.5",
-    "sequelize": "^6.5.0",
+    "sequelize": "^6.37.7",
-    "socket.io": "^4.0.0"
+    "socket.io": "^4.8.1"
   },
   "devDependencies": {
-    "nodemon": "^2.0.7"
+    "nodemon": "^3.1.11"
   }
 }

server/admin/index.js

@@ -0,0 +1,21 @@
+const express = require('express');
+const router = express.Router();
+
+//middleware
+const tokenAuth = require('../utilities/token-auth');
+
+router.use(tokenAuth);
+router.use((req, res, next) => {
+	//check the user's admin status
+	if (!req.user.mod) {
+		return res.status(401).send('Mods only');
+	}
+
+	next();
+});
+
+//basic route management
+router.get('/reports', require('./reports'));
+router.delete('/reports', require('./reports-delete'));
+
+module.exports = router;

server/admin/reports-delete.js

@@ -0,0 +1,15 @@
+const { chatlog, reports } = require('../database/models');
+
+//admin/reports
+const route = async (req, res) => {
+	const reps = await reports.destroy({
+		where: {
+			chatlogIndex: req.body.chatlogIndex
+		}
+	});
+
+	//respond
+	res.status(200).end();
+};
+
+module.exports = route;

server/admin/reports.js

@@ -0,0 +1,31 @@
+const { chatlog, reports } = require('../database/models');
+
+//admin/reports
+const route = async (req, res) => {
+	const reps = await reports.findAll({
+		include: [{
+			model: chatlog,
+			required: true
+		}],
+		order: ['chatlogIndex']
+	});
+
+	//collate
+	const response = [];
+	for(let i = 0; i < reps.length; i++) {
+		//new chatlog
+		if (response.length == 0 || response[response.length - 1].chatlogIndex != reps[i].chatlogIndex) {
+			response.push(reps[i]);
+			response[response.length - 1].reporter = [response[response.length - 1].reporter]; //reporters in an array
+			continue;
+		}
+
+		//multiple people reported this, add to the existing array
+		response[response.length - 1].reporter.push(reps[i].reporter);
+	}
+
+	//respond
+	res.status(200).json(response);
+};
+
+module.exports = route;

server/chat/index.js

@@ -1,13 +1,13 @@
 const jwt = require('jsonwebtoken');
 const { Op } = require('sequelize');
-const { chatlog, mute } = require('../database/models');
+const { chatlog, mute, reports } = require('../database/models');
 
 const chat = io => {
 	io.on('connection', socket => {
 		//middleware
 		socket.use((request, next) => {
 			//verify request format
-			if (!['open chat', 'message'].includes(request[0])) {
+			if (!['open chat', 'message', 'report'].includes(request[0])) {
 				return next(`Invalid request to the chat server ${request[0]}`);
 			}
 			return next();
@@ -35,7 +35,7 @@ const chat = io => {
 		});
 
 		//from here, handles all normal messages
-		socket.on('open chat', message => {
+		socket.on('open chat', async message => {
 			//handle rooms - only in a room if you've opened chat
 			const newlyOpened = !socket.user.room;
 			socket.user.room = socket.user.room || 'general'; //default to general
@@ -46,11 +46,8 @@ const chat = io => {
 
 			socket.join(socket.user.room);
 
-			//broadcast to this room
-			socket.broadcast.to(socket.user.room).emit('message', { emphasis: true, text: `${socket.user.username} entered chat` });
-
 			//log
-			chatlog.create({
+			const log = await chatlog.create({
 				notification: true,
 				username: socket.user.username,
 				text: `${socket.user.username} entered chat`,
@@ -58,6 +55,9 @@ const chat = io => {
 				emphasis: true
 			});
 
+			//broadcast to this room
+			socket.broadcast.to(socket.user.room).emit('message', {timestamp: log.createdAt, emphasis: true, text: `${socket.user.username} entered chat` });
+
 			//send backlog to the user
 			chatlog.findAll({
 				where: {
@@ -72,7 +72,7 @@ const chat = io => {
 					}
 				},
 				order: [
-					['id', 'DESC']
+					['index', 'DESC']
 				],
 				limit: 50
 			})
@@ -109,18 +109,18 @@ const chat = io => {
 				return;
 			}
 
-			//broadcast to this room
-			socket.broadcast.to(socket.user.room).emit('message', { username: socket.user.username, text: message.text });
-
 			//log
-			chatlog.create({
+			const log = await chatlog.create({
 				username: socket.user.username,
 				text: message.text,
 				room: socket.user.room
 			});
+
+			//broadcast to this room (with the id)
+			socket.broadcast.to(socket.user.room).emit('message', log);
 		});
 
-		socket.on('disconnect', reason => {
+		socket.on('disconnect', async reason => {
 			//broadcast to this room
 			if (!socket.user) {
 				return;
@@ -137,6 +137,19 @@ const chat = io => {
 				emphasis: true
 			});
 		});
+
+		socket.on('report', info => {
+			//handle reports of malicious content
+			if (!info.index) {
+				return;
+			}
+
+			//report
+			reports.create({
+				reporter: socket.user.username,
+				chatlogIndex: info.index
+			});
+		});
 	});
 };
 
@@ -186,7 +199,7 @@ const executeCommand = (io, socket, command) => {
 		}
 
 		case '/mute': {//NOTE: mutes globally, broadcasts only to admin's room
-			if (socket.user.privilege != 'administrator' && socket.user.privilege != 'moderator') {
+			if (!socket.user.admin && !socket.user.mod) {
 				socket.emit('message', { emphasis: true, text: '/mute is only available to admins and mods' });
 				break;
 			}
@@ -229,7 +242,7 @@ const executeCommand = (io, socket, command) => {
 		}
 
 		case '/unmute': {
-			if (socket.user.privilege != 'administrator' && socket.user.privilege != 'moderator') {
+			if (!socket.user.admin && !socket.user.mod) {
 				socket.emit('message', { emphasis: true, text: '/unmute is only available to admins and mods' });
 				break;
 			}

server/database/index.js

@@ -2,11 +2,10 @@ const Sequelize = require('sequelize');
 
 const sequelize = new Sequelize(process.env.DB_DATABASE, process.env.DB_USERNAME, process.env.DB_PASSWORD, {
 	host: process.env.DB_HOSTNAME,
+	port: process.env.DB_PORTNAME,
 	dialect: 'mariadb',
 	timezone: process.env.DB_TIMEZONE,
 	logging: process.env.DB_LOGGING ? console.log : false
 });
 
-sequelize.sync();
-
 module.exports = sequelize;

server/database/models/chatlog.js

@@ -2,7 +2,7 @@ const Sequelize = require('sequelize');
 const sequelize = require('..');
 
 module.exports = sequelize.define('chatlog', {
-	id: {
+	index: {
 		type: Sequelize.INTEGER(11),
 		allowNull: false,
 		autoIncrement: true,

server/database/models/index.js

@@ -1,4 +1,12 @@
+const chatlog = require('./chatlog');
+const mute = require('./mute');
+const reports = require('./reports');
+
+//relationships
+reports.belongsTo(chatlog);
+
 module.exports = {
-	chatlog: require('./chatlog'),
+	chatlog,
-	mute: require('./mute')
+	mute,
+	reports,
 };

server/database/models/reports.js

@@ -0,0 +1,17 @@
+const Sequelize = require('sequelize');
+const sequelize = require('..');
+
+module.exports = sequelize.define('reports', {
+	index: {
+		type: Sequelize.INTEGER(11),
+		allowNull: false,
+		autoIncrement: true,
+		primaryKey: true,
+		unique: true
+	},
+
+	reporter: {
+		type: 'varchar(320)',
+		allowNull: false
+	},
+});

server/server.js

@@ -7,24 +7,31 @@ const app = express();
 const server = require('http').Server(app);
 const io = require('socket.io')(server, {
 	cors: {
-		origin: '*'
+		origin: process.env.WEB_ORIGIN
 	}
 });
-const bodyParser = require('body-parser');
 const cors = require('cors');
 
 //config
-app.use(bodyParser.json());
+app.use(express.json());
-app.use(cors());
+app.use(cors({
+	credentials: true,
+	origin: [`${process.env.WEB_ORIGIN}`], //because auth-server
+	allowedHeaders: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization', 'Set-Cookie'],
+	exposedHeaders: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization', 'Set-Cookie'],
+}));
 
 //database connection
 const database = require('./database');
 
+//admin stuff
+app.use('/admin', require('./admin'));
+
 //access the chat
 require('./chat')(io.of('/chat'));
 
 //error on access
-app.get('*', (req, res) => {
+app.get('/{*any}', (req, res) => {
 	res.redirect('https://github.com/krgamestudios/chat-server');
 });
 
@@ -32,4 +39,5 @@ app.get('*', (req, res) => {
 server.listen(process.env.WEB_PORT || 3300, async (err) => {
 	await database.sync();
 	console.log(`listening to localhost:${process.env.WEB_PORT || 3300}`);
+	console.log(`database located at ${process.env.DB_HOSTNAME || '<default>'}:${process.env.DB_PORTNAME || '<default>'}`);
 });

server/utilities/token-auth.js

@@ -0,0 +1,21 @@
+const jwt = require('jsonwebtoken');
+
+//middleware to authenticate the JWT token
+module.exports = (req, res, next) => {
+	const authHeader = req.headers['authorization'];
+	const token = authHeader?.split (' ')[1]; //'Bearer token'
+
+	if (!token) {
+		return res.status(401).send('No token found');
+	}
+
+	return jwt.verify(token, process.env.SECRET_ACCESS, (err, user) => {
+		if (err) {
+			return res.status(403).send(err);
+		}
+
+		req.user = user;
+
+		return next();
+	});
+};

tools/debug-startup.sql

@@ -0,0 +1,4 @@
+#use this while debugging
+CREATE DATABASE chat;
+CREATE USER 'chat'@'%' IDENTIFIED BY 'blastoise';
+GRANT ALL PRIVILEGES ON chat.* TO 'chat'@'%';