docker image support

we use python3.9 cuz the khl bot lib does not work in 3.10+ due to the `asyncio.Queue` change

Author: Fallen-Breath

.dockerignore

@@ -0,0 +1,2 @@
+*.pyc
+__pycache__

.github/workflows/image.yml

@@ -0,0 +1,49 @@
+name: Docker Image
+
+on:
+  push:
+    paths:
+      - ".github/workflows/image.yml"
+      - "chatbridge/**"
+      - "lang/**"
+      - "__main__.py"
+      - "LICENSE"
+      - "mcdreforged.plugin.json"
+      - "**/requirements.txt"
+
+jobs:
+  image:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: fallenbreath
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: |
+            fallenbreath/chatbridge
+          tags: |
+            type=ref,event=branch
+            type=semver,pattern={{version}}
+
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          platforms: linux/386,linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64
+          file: ./docker/Dockerfile
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

README.md

@@ -69,6 +69,23 @@ Enter `python ChatBridge.pyz` in command line to see possible helps
 
 At launch, if the configure file is missing, chatbridge will automatically generate a default one and exit
 
+## Docker Image
+
+[![Docker](https://img.shields.io/docker/v/fallenbreath/chatbridge/latest)](https://hub.docker.com/r/fallenbreath/chatbridge)
+
+Docker Hub image: [`fallenbreath/chatbridge`](https://hub.docker.com/r/fallenbreath/chatbridge)
+
+Image name examples:
+
+- `fallenbreath/chatbridge:latest`
+- `fallenbreath/chatbridge:v2.5.3`
+
+Working directory: `/app`
+
+Example usages: `docker run --rm fallenbreath/chatbridge:latest server`
+
+See the [./docker](docker) directory in the repository for more details and docker compose example
+
 ## Requirement
 
 Python 3.6+ required

chatbridge/impl/cli/cli_server.py

@@ -1,3 +1,4 @@
+import sys
 import threading
 import time
 import traceback
@@ -87,7 +88,12 @@ def main():
 		print('- Client #{}: name = {}, password = {}'.format(i + 1, client_info.name, client_info.password))
 		server.add_client(client_info)
 	server.start()
-	server.console_loop()
+
+	if sys.stdin.isatty():
+		server.console_loop()
+	else:
+		utils.wait_until_terminate()
+		server.stop()
 
 
 if __name__ == '__main__':

chatbridge/impl/cqhttp/entry.py

@@ -184,6 +184,7 @@ def main():
 	config = utils.load_config(ConfigFile, CqHttpConfig)
 	chatClient = CqHttpChatBridgeClient.create(config)
 	utils.start_guardian(chatClient)
+	utils.register_exit_on_termination()
 	print('Starting CQ Bot')
 	cq_bot = CQBot(config)
 	cq_bot.start()

chatbridge/impl/discord/entry.py

@@ -13,12 +13,13 @@ def main():
 	stored.client = DiscordChatClient.create(stored.config)
 	stored.bot = bot.create_bot()
 	utils.start_guardian(stored.client)
+	utils.register_exit_on_termination()
 
 	try:
 		stored.bot.start_running()
 	except (KeyboardInterrupt, SystemExit):
 		stored.client.stop()
-	except:
+	except Exception:
 		print(traceback.format_exc())
 
 	print('Bye~')

chatbridge/impl/kaiheila/entry.py

@@ -231,6 +231,7 @@ def main():
 	config = utils.load_config(ConfigFile, KaiHeiLaConfig)
 	chatClient = KhlChatBridgeClient.create(config)
 	utils.start_guardian(chatClient)
+	utils.register_exit_on_termination()
 	print('Starting KHL Bot')
 	khlBot = createKaiHeiLaBot()
 	khlBot.startRunning()

chatbridge/impl/online/entry.py

@@ -4,6 +4,7 @@
 import collections
 import functools
 import re
+import sys
 import traceback
 from concurrent.futures.thread import ThreadPoolExecutor
 from threading import Lock
@@ -135,7 +136,11 @@ def main():
 	config = utils.load_config(ClientConfigFile, OnlineConfig)
 	chatClient = OnlineChatClient.create(config)
 	utils.start_guardian(chatClient)
-	console_input_loop()
+	if sys.stdin.isatty():
+		console_input_loop()
+	else:
+		utils.wait_until_terminate()
+		chatClient.stop()
 
 
 if __name__ == '__main__':

chatbridge/impl/utils.py

@@ -1,5 +1,8 @@
 import json
 import os
+import queue
+import signal
+import sys
 import time
 from threading import Thread
 from typing import Type, TypeVar, Callable
@@ -40,3 +43,20 @@ def loop():
 	thread = Thread(name='ChatBridge Guardian', target=loop, daemon=True)
 	thread.start()
 	return thread
+
+
+def wait_until_terminate():
+	q = queue.Queue()
+	signal.signal(signal.SIGINT, lambda s, _: q.put(s))
+	signal.signal(signal.SIGTERM, lambda s, _: q.put(s))
+	sig = q.get()
+	print('Interrupted with {} ({})'.format(signal.Signals(sig).name, sig))
+
+
+def register_exit_on_termination():
+	def callback(sig, _):
+		print('Interrupted with {} ({}), exiting'.format(signal.Signals(sig).name, sig))
+		sys.exit(0)
+
+	signal.signal(signal.SIGINT, callback)
+	signal.signal(signal.SIGTERM, callback)

docker/Dockerfile

@@ -0,0 +1,26 @@
+ARG PYTHON_VERSION=3.9
+
+FROM python:${PYTHON_VERSION} as builder
+
+RUN pip3 install mcdreforged
+
+COPY chatbridge /build/chatbridge
+COPY lang /build/lang
+COPY __main__.py LICENSE mcdreforged.plugin.json requirements.txt /build/
+RUN cd /build \
+    && mcdreforged pack \
+    && find . -name "requirements.txt" -exec cat '{}' \; > requirements.all.txt
+
+FROM python:${PYTHON_VERSION}-slim
+
+COPY --from=builder /build/requirements.all.txt /app/
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends gcc build-essential libffi-dev \
+    && rm -rf /var/lib/apt/lists/* \
+    && pip3 install -r /app/requirements.all.txt  \
+    && pip3 cache purge \
+    && apt-get purge -y --auto-remove gcc build-essential libffi-dev
+
+COPY --from=builder /build/ChatBridge.pyz /app/
+WORKDIR /app
+ENTRYPOINT ["python3", "ChatBridge.pyz"]