@rithien/discord_bridge 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+## v0.3.0 - rithien fork
+
+- Forked from Hornwitser/discord_bridge v0.2.5.
+- Added `instance.discord_bridge.channel_id` for per-instance Discord channel routing.
+- The controller-level `discord_bridge.channel_id` is now the default for instances without their own channel, and the destination for host connect/disconnect notifications.
+- Migrated the controller config reactor from the deprecated `config.on("fieldChanged", ...)` to `onControllerConfigFieldChanged` and `onInstanceConfigFieldChanged` hooks (Clusterio alpha 14).
+
+## v0.2.5
+
+- Updated for Clusterio 2.0.0-alpha.14
+- Added configurable templates for how the messages appears in the game and on Discord.
+- Added templates for instance created and deleted statuses
+
+## v0.2.4
+
+- Updated for Clusterio 2.0.0-alpha.13
+
+## v0.2.3
+
+- Updated for Clusterio 2.0.0-alpha.9
+- Fixed instance stop notification not being shown.
+- Added option to notify of host connection and disconnection.
+
+## v0.2.2
+
+- Updated for Clusterio 2.0.0-alpha.5.
+- Added separate options for bridging joins, chat, shouts, kicks & bans, promotions and commands to the Discord channel.
+- Added option to notify of instance starts and stops to the Discord channel.
+
+## v0.2.1
+
+- Fixed hang on controller startup.
+
+## v0.2.0
+
+- Updated for Clusterio 2.0.0-alpha.4.

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Hornwitser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,20 @@
+Clusterio Discord Bridge
+========================
+
+Bridges chat between a Discord channel and instances, with per-instance channel routing.
+
+Forked from [Hornwitser/discord_bridge](https://github.com/Hornwitser/discord_bridge); adds support for configuring a different Discord channel per Clusterio instance, with the controller-level `channel_id` acting as the default for unconfigured instances and the destination for host connect/disconnect notifications.
+
+Installation
+------------
+
+Run the following commands in the folder Clusterio is installed to:
+
+    npm install @rithien/discord_bridge
+    npx clusteriocontroller plugin add @rithien/discord_bridge
+
+Substitute clusteriocontroller with clusteriohost or clusterioctl if this a dedicate host or ctl installation respectively.
+
+Once installed you need to set the `discord_bridge.bot_token` and `discord_bridge.channel_id` in the controller config to make the bridge operational.
+
+Note that the Message Content Intent is required to be enabled in Discords developer dashboard for the bot.

package/controller.js

@@ -0,0 +1,270 @@
+"use strict";
+const Discord = require("discord.js");
+const { BaseControllerPlugin } = require("@clusterio/controller");
+
+const { InstanceActionEvent, DiscordChatEvent } = require("./info.js");
+
+
+class ControllerPlugin extends BaseControllerPlugin {
+	async init() {
+		this.client = null;
+		this.channels = new Map();
+		this.channelByInstance = new Map();
+		this.instancesByChannel = new Map();
+		this.fallbackChannel = null;
+
+		this.controller.handle(InstanceActionEvent, this.handleInstanceAction.bind(this));
+		await this.connect();
+	}
+
+	async connect() {
+		if (this.client) {
+			this.client.destroy();
+			this.client = null;
+		}
+		this.channels = new Map();
+		this.channelByInstance = new Map();
+		this.instancesByChannel = new Map();
+		this.fallbackChannel = null;
+
+		let token = this.controller.config.get("discord_bridge.bot_token");
+		if (!token) {
+			this.logger.warn("Bot token not configured, bridge is offline");
+			return;
+		}
+
+		this.client = new Discord.Client({
+			intents: [
+				Discord.GatewayIntentBits.Guilds,
+				Discord.GatewayIntentBits.GuildMessages,
+				Discord.GatewayIntentBits.MessageContent,
+			],
+		});
+		this.client.on("messageCreate", (message) => {
+			this.discordMessage(message).catch(err => { this.logger.error(`Unexpected error:\n${err.stack}`); });
+		});
+
+		this.logger.info("Logging in to Discord");
+		try {
+			await this.client.login(token);
+		} catch (err) {
+			this.logger.error(`Error logging in to Discord, bridge is offline:\n${err.stack}`);
+			this.client.destroy();
+			this.client = null;
+			return;
+		}
+		this.logger.info("Successfully logged in");
+		await this.fetchChannels();
+	}
+
+	async fetchChannels() {
+		this.channels = new Map();
+		this.channelByInstance = new Map();
+		this.instancesByChannel = new Map();
+		this.fallbackChannel = null;
+
+		if (!this.client) {
+			return;
+		}
+
+		const fallbackId = this.controller.config.get("discord_bridge.channel_id") || null;
+		const wanted = new Set();
+		if (fallbackId) {
+			wanted.add(fallbackId);
+		}
+
+		for (const instance of this.controller.instances.values()) {
+			const overrideId = instance.config.get("discord_bridge.channel_id");
+			const effectiveId = overrideId || fallbackId;
+			if (!effectiveId) {
+				continue;
+			}
+
+			this.channelByInstance.set(instance.id, effectiveId);
+			wanted.add(effectiveId);
+
+			if (!this.instancesByChannel.has(effectiveId)) {
+				this.instancesByChannel.set(effectiveId, new Set());
+			}
+			this.instancesByChannel.get(effectiveId).add(instance.id);
+		}
+
+		for (const id of wanted) {
+			try {
+				const channel = await this.client.channels.fetch(id);
+				if (channel) {
+					this.channels.set(id, channel);
+				} else {
+					this.logger.error(`Channel ID ${id} was not found`);
+				}
+			} catch (err) {
+				if (err.code !== 10003) { // Unknown channel
+					throw err;
+				}
+				this.logger.error(`Channel ID ${id} was not found`);
+			}
+		}
+
+		if (fallbackId) {
+			this.fallbackChannel = this.channels.get(fallbackId) ?? null;
+		}
+	}
+
+	getChannelForInstance(instance) {
+		const channelId = this.channelByInstance.get(instance.id);
+		if (channelId) {
+			return this.channels.get(channelId) ?? null;
+		}
+		// Instance added after the last fetchChannels(): fall back to the global channel.
+		return this.fallbackChannel;
+	}
+
+	async onShutdown() {
+		if (this.client) {
+			this.client.destroy();
+			this.client = null;
+			this.channels = new Map();
+			this.channelByInstance = new Map();
+			this.instancesByChannel = new Map();
+			this.fallbackChannel = null;
+		}
+	}
+
+	async onControllerConfigFieldChanged(field, curr, prev) {
+		if (field === "discord_bridge.bot_token") {
+			await this.connect();
+		} else if (field === "discord_bridge.channel_id") {
+			await this.fetchChannels();
+		}
+	}
+
+	async onInstanceConfigFieldChanged(instance, field, curr, prev) {
+		if (field === "discord_bridge.channel_id") {
+			await this.fetchChannels();
+		}
+	}
+
+	/**
+	 * @param message {Discord.Message}
+	 */
+	async discordMessage(message) {
+		if (message.author.bot) {
+			return;
+		}
+
+		const targetInstanceIds = this.instancesByChannel.get(message.channel.id);
+		if (!targetInstanceIds || targetInstanceIds.size === 0) {
+			return;
+		}
+
+		const template = this.controller.config.get("discord_bridge.discord_template");
+		const content = template.replace(/(__display_name__|__username__|__content__)/g, (sub) => ({
+			"__display_name__": message.member.displayName,
+			"__username__": message.member.user.tag,
+			"__content__": message.cleanContent,
+		}[sub]));
+
+		const event = new DiscordChatEvent(content);
+		for (const instanceId of targetInstanceIds) {
+			this.controller.sendTo({ instanceId }, event);
+		}
+	}
+
+	formatMessage(template, hostName, instanceName, content) {
+		return template.replace(/(__host_name__|__instance_name__|__content__)/g, (sub) => ({
+			"__host_name__": hostName,
+			"__instance_name__": instanceName,
+			"__content__": content,
+		}[sub]));
+	}
+
+	getHostName(hostId) {
+		return this.controller.hosts.get(hostId)?.name ?? "";
+	}
+
+	async onInstanceStatusChanged(instance, prev) {
+		if (!this.controller.config.get("discord_bridge.notify_instance_status")) {
+			return;
+		}
+
+		const channel = this.getChannelForInstance(instance);
+		if (!channel) {
+			return;
+		}
+
+		let instanceName = instance.config.get("instance.name");
+		const hostName = this.getHostName(instance.config.get("instance.assigned_host"));
+
+		const template =
+			this.controller.config.get("discord_bridge.instance_status_templates")[`${prev}:${instance.status}`]
+			?? this.controller.config.get("discord_bridge.instance_status_templates")[instance.status]
+		;
+
+		if (!template) {
+			return;
+		}
+
+		await channel.send(this.formatMessage(template, hostName, instanceName, ""));
+	}
+
+	onHostConnectionEvent(hostConnection, event) {
+		if (!this.fallbackChannel || !this.controller.config.get("discord_bridge.notify_host_connections")) {
+			return;
+		}
+
+		let hostName = this.controller.hosts.get(hostConnection.id).name;
+		const template = this.controller.config.get("discord_bridge.host_templates")[event];
+		if (!template) {
+			return;
+		}
+		const message = this.formatMessage(template, hostName, "", "");
+		this.fallbackChannel.send(message).catch(
+			err => { this.logger.error(`Unexpected error:\n${err.stack}`); }
+		);
+	}
+
+	async handleInstanceAction(request, src) {
+		// Known action types at the time of writing:
+		// WARNING COMMAND SHOUT CHAT COLOR JOIN LEAVE KICK BAN UNBANNED PROMOTE DEMOTE
+		let { instanceName, action, content } = request;
+		const enabled = (
+			["JOIN", "LEAVE"].includes(action) && this.controller.config.get("discord_bridge.bridge_player_joins")
+			|| action === "CHAT" && this.controller.config.get("discord_bridge.bridge_player_chat")
+			|| action === "SHOUT" && this.controller.config.get("discord_bridge.bridge_player_shouts")
+			|| (
+				["KICK", "BAN", "UNBANNED"].includes(action)
+				&& this.controller.config.get("discord_bridge.bridge_player_kicks_and_bans")
+			)
+			|| action === "COMMAND" && this.controller.config.get("discord_bridge.bridge_player_commands")
+			|| (
+				["PROMOTE", "DEMOTE"].includes(action)
+				&& this.controller.config.get("discord_bridge.bridge_player_promotions")
+			)
+		);
+
+		if (!enabled) {
+			return;
+		}
+
+		const instance = this.controller.instances.get(src.id);
+		if (!instance) {
+			return;
+		}
+		const channel = this.getChannelForInstance(instance);
+		if (!channel) {
+			return;
+		}
+
+		const template = this.controller.config.get("discord_bridge.player_templates")[action];
+		if (!template) {
+			return;
+		}
+		const hostName = this.getHostName(instance.config.get("instance.assigned_host"));
+		const message = this.formatMessage(template, hostName, instanceName, content);
+		await channel.send(message, { allowedMentions: { parse: [] }});
+	}
+}
+
+module.exports = {
+	ControllerPlugin,
+};

package/dist/web/manifest.json

@@ -0,0 +1,6 @@
+{
+  "main.js": "static/main.75bf3c903fc16e7f86b5.js",
+  "discord_bridge.js": "static/discord_bridge.611b8899ce001451b081.js",
+  "static/info_js.js": "static/info_js.3e97e6576d2e451b2fd6.js",
+  "static/package_json.js": "static/package_json.14b21c0791a49b7b3105.js"
+}