feat: game activity tracker

.eslintrc.json

@@ -11,6 +11,7 @@
 	},
 	"plugins": ["@typescript-eslint"],
 	"rules": {
+		"@typescript-eslint/no-non-null-assertion": "off",
 		"sort-imports": [
 			"error",
 			{

package.json

@@ -10,7 +10,7 @@
 		"build": "tsc -p tsconfig.json",
 		"run": "node --experimental-specifier-resolution=node .",
 		"start": "npm run build && npm run run",
-		"prepare:": "husky install"
+		"prepare": "husky install"
 	},
 	"repository": {
 		"type": "git",

src/codeSamples/sampleAutocompleter.ts

@@ -9,12 +9,27 @@ class CountryAutocompleter extends Autocompleter {
 	async execute(interaction: AutocompleteInteraction): Promise<void> {
 		// your options
 		const country = ["Finland", "Sweden", "Norway"];
-		// for example return all options which start with the user input
-		await interaction.respond(
-			country
-				.filter((c) => c.startsWith(interaction.options.getFocused() as string))
-				.map((c) => ({ name: c, value: c }))
+
+		// for example filter for options which start with the user input
+		let filterdoptions = country.filter((c) =>
+			c
+				// to make sure capitalisaion doesnt matter, make every option to lower case
+				.toLowerCase()
+				.startsWith(
+					// the same with the user input
+					interaction.options.getFocused().toLowerCase() as string
+				)
 		);
+
+		// if the filterd options are more than 25 remove everything after the 25th option
+		// because discord only allows 25 autocomplete results
+		if (filterdoptions.length > 25) filterdoptions = filterdoptions.slice(0, 25);
+
+		// map filtered options
+		const map = filterdoptions.map((c) => ({ name: c, value: c }));
+
+		// send map back to the user
+		await interaction.respond(map);
 	}
 }
 

src/commands/TrackerCommand.ts

@@ -0,0 +1,220 @@
+import {
+	ChatInputCommandInteraction,
+	SlashCommandBuilder,
+	SlashCommandSubcommandsOnlyBuilder,
+} from "discord.js";
+import { Command } from "../interactions/interactionClasses";
+import { config } from "../config";
+import { blacklistAdd, blacklistRemove, blacklistShow } from "../util/game-activity-tracker/blacklist";
+import {
+	statisticsAllStats,
+	statisticsGameStats,
+	statisticsMyStats,
+} from "../util/game-activity-tracker/statistics";
+import {
+	adminBlacklistGame,
+	adminLook,
+	adminReset,
+	adminShow,
+	adminWhitelistGame,
+} from "../util/game-activity-tracker/admin";
+import { list } from "../util/game-activity-tracker/list";
+
+class TrackerCommand extends Command {
+	constructor() {
+		super("game-activity-tracker");
+	}
+
+	async execute(interaction: ChatInputCommandInteraction): Promise<void> {
+		const group: string | null = interaction.options.getSubcommandGroup();
+		const sub: string | null = interaction.options.getSubcommand();
+
+		if (group === "blacklist") {
+			if (sub === "add") {
+				await blacklistAdd(interaction);
+			} else if (sub === "remove") {
+				await blacklistRemove(interaction);
+			} else if (sub === "show") {
+				await blacklistShow(interaction);
+			}
+		} else if (group === "statistics") {
+			if (sub === "my-stats") {
+				await statisticsMyStats(interaction);
+			} else if (sub === "game-stats") {
+				await statisticsGameStats(interaction);
+			} else if (sub === "all-stats") {
+				await statisticsAllStats(interaction);
+			}
+		} else if (group === "admin") {
+			if (interaction.memberPermissions?.bitfield == config.activityTrackerAdminCommandPermission) {
+				return;
+			} else if (sub === "reset") {
+				await adminReset(interaction);
+			} else if (sub === "blacklist") {
+				await adminBlacklistGame(interaction);
+			} else if (sub === "whitelist") {
+				await adminWhitelistGame(interaction);
+			} else if (sub === "look") {
+				await adminLook(interaction);
+			} else if (sub == "show") {
+				await adminShow(interaction);
+			}
+		} else if (sub == "list") {
+			await list(interaction);
+		}
+	}
+
+	register():
+		| SlashCommandBuilder
+		| SlashCommandSubcommandsOnlyBuilder
+		| Omit<SlashCommandBuilder, "addSubcommandGroup" | "addSubcommand">
+		| boolean {
+		if (!config.logActivity) {
+			return false;
+		}
+		return new SlashCommandBuilder()
+			.setName("game-activity-tracker")
+			.setDescription("All commands associated with the Game Activity Tracker!")
+			.addSubcommand((sub) =>
+				sub
+					.setName("list")
+					.setDescription("Returns a list of the played games based on a selected sorting method.")
+					.addStringOption((opt) =>
+						opt
+							.setName("sort")
+							.setDescription("Sort by the ...")
+							.addChoices(
+								{ name: "logs chronolocially and per person", value: "log-history" },
+								{ name: "playtime per game", value: "playtime-per-game" },
+								{ name: "number of logs per game", value: "logs-per-game" },
+								{ name: "last log date per game", value: "log-date-per-game" }
+							)
+					)
+					.addStringOption((opt) =>
+						opt
+							.setName("order")
+							.setDescription("Order the list ...")
+							.addChoices(
+								{ name: "decreasing", value: "decreasing" },
+								{ name: "increasing", value: "increasing" }
+							)
+					)
+			)
+			.addSubcommandGroup((group) =>
+				group
+					.setName("statistics")
+					.setDescription("Gives you statistics based on the game activity.")
+					.addSubcommand((sub) =>
+						sub
+							.setName("my-stats")
+							.setDescription("Show statistics about your own logs.")
+							.addStringOption((opt) =>
+								opt.setName("game").setDescription("Filter stats for the given name.").setAutocomplete(true)
+							)
+					)
+					.addSubcommand((sub) =>
+						sub
+							.setName("game-stats")
+							.setDescription("Show statistics about a given game across all logs.")
+							.addStringOption((opt) =>
+								opt
+									.setName("game")
+									.setDescription("Filter stats for the given game.")
+									.setAutocomplete(true)
+									.setRequired(true)
+							)
+					)
+					.addSubcommand((sub) => sub.setName("all-stats").setDescription("Show statistics across all logs."))
+			)
+			.addSubcommandGroup((group) =>
+				group
+					.setName("blacklist")
+					.setDescription("Manage your blacklist - if a game is on blacklist no activity will be tracked.")
+					.addSubcommand((sub) =>
+						sub
+							.setName("add")
+							.setDescription("Add a game to your blacklist.")
+							.addStringOption((opt) =>
+								opt
+									.setName("game")
+									.setDescription("The game to blacklist - (capitalization doesnt matter)")
+									.setAutocomplete(true)
+									.setRequired(true)
+							)
+					)
+					.addSubcommand((sub) =>
+						sub
+							.setName("remove")
+							.setDescription("Remove a game from your blacklist.")
+							.addStringOption((opt) =>
+								opt
+									.setName("game")
+									.setDescription("The game to whitelist - (capitalization doesnt matter)")
+									.setAutocomplete(true)
+									.setRequired(true)
+							)
+					)
+					.addSubcommand((sub) => sub.setName("show").setDescription("See what is on your blacklist."))
+			)
+			.addSubcommandGroup((group) =>
+				group
+					.setName("admin")
+					.setDescription("Commands which only users with higher permissions can use.")
+					.addSubcommand((sub) =>
+						sub
+							.setName("reset")
+							.setDescription("Reset every log and blacklist entry.")
+							.addBooleanOption((opt) =>
+								opt.setName("sure").setDescription("Are you really sure?").setRequired(true)
+							)
+							.addStringOption((opt) =>
+								opt
+									.setName("really")
+									.setDescription("Are you really sure you want to delete every entry?")
+									.addChoices(
+										{ name: "No. I dont want to delete every log and blacklist entry!", value: "no" },
+										{ name: "Yes I am sure. I want to delete every log and blacklist entry!", value: "yes" }
+									)
+									.setRequired(true)
+							)
+					)
+					.addSubcommand((sub) =>
+						sub
+							.setName("blacklist")
+							.setDescription("Add a game on the global blacklist - don't log anything for this game.")
+							.addStringOption((opt) =>
+								opt
+									.setName("game")
+									.setDescription("Enter game which should get blacklisted. (Capitalization doesnt matter)")
+									.setRequired(true)
+									.setAutocomplete(true)
+							)
+					)
+					.addSubcommand((sub) =>
+						sub
+							.setName("whitelist")
+							.setDescription("Remove a game from the global blacklist - log this game again.")
+							.addStringOption((opt) =>
+								opt
+									.setName("game")
+									.setDescription(
+										"Enter game which should get removed from the blacklisted . (Capitalization doesnt matter)"
+									)
+									.setRequired(true)
+									.setAutocomplete(true)
+							)
+					)
+					.addSubcommand((sub) => sub.setName("show").setDescription("Show the global blacklist."))
+					.addSubcommand((sub) =>
+						sub
+							.setName("look")
+							.setDescription("Look into a users blacklist.")
+							.addUserOption((opt) =>
+								opt.setName("user").setDescription("Take a look into this users blacklist.").setRequired(true)
+							)
+					)
+			);
+	}
+}
+
+export default new TrackerCommand();

src/config.ts

@@ -1,4 +1,4 @@
-import { ColorResolvable, ComponentEmojiResolvable } from "discord.js";
+import { ColorResolvable, ComponentEmojiResolvable, PermissionFlagsBits } from "discord.js";
 
 // Configure your bot here.
 export const config: BotConfig = {
@@ -60,6 +60,8 @@ export const config: BotConfig = {
 	serverDescription:
 		"We're a group of young and mostly queer people having a game jam/hackathon server together. We're a very friendly and welcoming community and are happy to have you join us! \nCheck out <#1022874504525008997> for more information!",
 	logLevel: "debug",
+	logActivity: true,
+	activityTrackerAdminCommandPermission: PermissionFlagsBits.Administrator,
 };
 
 interface BotConfig {
@@ -81,4 +83,8 @@ interface BotConfig {
 	serverDescription: string;
 	// Also available: error, warn, info, http, verbose, debug, silly.
 	logLevel: "debug" | "info" | "warn" | "error" | "verbose";
+	// If User Game Activity should get logged
+	logActivity: boolean;
+	// Which permissions are needed to user game-activity-tracker commands
+	activityTrackerAdminCommandPermission: bigint;
 }

src/db.ts

@@ -10,3 +10,12 @@ interface Reminder {
 export const reminderTimeoutCache = new Map<number, NodeJS.Timeout>();
 export const reminderDb = new Enmap<number, Reminder>("reminder");
 export const latexDb = new Enmap<string, string>("latex");
+
+interface ActivityLogEntry {
+	t: number;
+	w: number;
+}
+export const activityTrackerLogDb = new Enmap<string, ActivityLogEntry[]>("TrackerLog");
+export const activityTrackerBlacklistDb = new Enmap<string, string[]>("TrackerBlacklist");
+activityTrackerBlacklistDb.ensure("general-user", []);
+activityTrackerBlacklistDb.ensure("general-game", []);

src/events/presenceUpdate.ts

@@ -0,0 +1,22 @@
+import { Presence } from "discord.js";
+import { config } from "../config";
+import { blacklistCheck, getStopedActivities, logTime } from "../util/game-activity-tracker/presence";
+
+export default async function presenceUpdate(oldPresence: Presence | null, newPresence: Presence) {
+	if (!config.logActivity) return;
+
+	const stopedActivities = await getStopedActivities(oldPresence, newPresence);
+	if (stopedActivities.length == 0) return;
+
+	const userid = newPresence.userId;
+
+	stopedActivities.forEach(async (element) => {
+		const start = element.createdTimestamp;
+		const timePlayed = Date.now() - start;
+		if (timePlayed < 20000) return;
+
+		if (await blacklistCheck(userid, element.name.toLowerCase())) return;
+		if (oldPresence?.user?.bot) return;
+		await logTime(userid, element.name.toLowerCase(), timePlayed);
+	});
+}

src/events/ready.ts

@@ -34,12 +34,14 @@ async function updateRegisteredCommands(client: Client) {
 		ctx.commands.map(async (cmd) => {
 			const cmdBuilder = cmd.register();
 			const existingCmd = registeredCommands.find((c) => c.name === cmd.name);
-			if (!existingCmd) {
-				logger.debug(`Creating new command: ${cmdBuilder.name}`);
-				return client.application?.commands.create(cmdBuilder.toJSON(), ctx.defaultGuild);
-			} else if (!commandsEqual(existingCmd, cmdBuilder)) {
-				logger.debug(`Updating command: ${cmdBuilder.name}`);
-				return client.application?.commands.edit(existingCmd.id, cmdBuilder.toJSON(), ctx.defaultGuild);
+			if (typeof cmdBuilder != "boolean") {
+				if (!existingCmd) {
+					logger.debug(`Creating new command: ${cmdBuilder.name}`);
+					return client.application?.commands.create(cmdBuilder.toJSON(), ctx.defaultGuild);
+				} else if (!commandsEqual(existingCmd, cmdBuilder)) {
+					logger.debug(`Updating command: ${cmdBuilder.name}`);
+					return client.application?.commands.edit(existingCmd.id, cmdBuilder.toJSON(), ctx.defaultGuild);
+				}
 			}
 		})
 	);

src/interactions/autocompleters/ReminderAutocomplete.ts

@@ -1,7 +1,7 @@
 import { Autocompleter } from "../interactionClasses";
 import { AutocompleteInteraction } from "discord.js";
 import { reminderDb } from "../../db";
-import { timestampToReadable } from "../../util/reminderCommand/reminderUtil";
+import { msToReadable } from "../../util/misc/time";
 
 class ReminderAutocompleter extends Autocompleter {
 	constructor() {
@@ -16,7 +16,7 @@ class ReminderAutocompleter extends Autocompleter {
 				const id = value.pings[1].replace(/\D/g, "");
 				const role = await interaction.guild?.roles.fetch(id);
 				const member = await interaction.guild?.members.fetch(id).catch(() => null);
-				let name = `ID: ${key} - ${timestampToReadable(value.timestamp, true)} ${
+				let name = `ID: ${key} - ${msToReadable(value.timestamp, true)} ${
 					role || member ? `- @${role ? role.name : member?.displayName} -` : "-"
 				} ${value.message == "" ? "No message." : `${value.message}`}`;