Merge pull request #136 from evonzee/develop

Docker config, discord error recovery

Author: kharidiron

.dockerignore

@@ -0,0 +1,2 @@
+.dockerignore
+Dockerfile

.gitignore

@@ -34,12 +34,15 @@ nosetests.xml
 .mr.developer.cfg
 .project
 .pydevproject
+.vscode
 
 # Project specific
 /config/player.dat
 /config/player.bak
 /config/player.dir
+/config/player
 /config/config.json
+/config/permissions.json
 *config.json
 *.db
 *.db-journal

Dockerfile

@@ -0,0 +1,13 @@
+FROM python:3.5-stretch
+
+RUN pip install discord irc3
+
+RUN mkdir /app /app/defaults
+COPY . /app/
+COPY config/*.default /app/defaults/
+WORKDIR /app
+COPY config/permissions.json.default config/permissions.json
+
+VOLUME /app/config
+
+CMD [ "./docker-start.sh" ]

README.md

@@ -160,6 +160,50 @@ once you have finised editing `config/config.json` and `config/permissions
 .json`.  To terminate the proxy, either press `^C` in an interactive 
 terminal session, or send it an `INT` signal.
 
+### Running under Docker
+StarryPy now includes a basic Docker configuration.  To run this image, 
+all you need to do is run:
+
+```bash
+  docker run -p 21025:21025 starrypy/starrypy:1.0.0
+```
+
+StarryPy exports a volume at /app/config which stores your configuration file and 
+the various databases.  You can create your own data container for this volume to persist
+your configuration and data even if you rebuild or upgrade StarryPy, or use volume 
+mount points to share a directory from your host server into the container.
+
+To use a storage volume, create a volume with:
+
+```bash
+docker volume create --name sb-data
+```
+
+Then provide it as part of your startup command:
+
+```bash
+docker run -d --name starry -p 20125:21025 -v sb-data:/app/config starrypy/starrypy:1.0.0
+```
+
+You can edit the config by mounting the volume into another container with your favorite text editor:
+```bash
+docker run --rm -v sb-data:/app/config -ti thinca/vim /app/config/config.json
+```
+
+If you'd rather map a directory on your host, just provide that as an argument to -v instead:
+
+```bash
+docker run -d --name starry -p 20125:21025 -v /opt/wherever/you/want/it:/app/config starrypy/starrypy:1.0.0
+```
+
+You can also run as a low-privileges user, with starry only having access to write to its config volume:
+```bash 
+docker run -d --name starry -p 20125:21025 -v /opt/wherever/you/want/it:/app/config --user 1002 starrypy/starrypy:1.0.0
+```
+
+
+Please note that this is a Linux-based docker container, so it won't work properly on Docker
+for Windows in Windows Container mode.
 
 ## Contributing
 Contributions are highly encouraged and always welcome. Please feel free to

config/config.json.default

@@ -27,6 +27,7 @@
             "command_prefix": "/"
         },
         "discord_bot": {
+            "enabled": false,
             "channel": "-- channel id --",
             "staff_channel": "-- channel id --",
             "client_id": "-- client_id --",
@@ -43,6 +44,7 @@
         },
         "help_plugin": {},
         "irc_bot": {
+            "enabled": false,
             "announce_join_leave": true,
             "channel": "#YourChannel",
             "command_prefix": "!",

docker-start.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# If we run in docker, and the user chose a file share volume, these files won't exist. Starry will complain.
+# Rather than change the way starry does its default files, let's just ensure they are present with this shell script.
+if [ ! -f config/config.json.default ]; then
+    cp defaults/config.json.default config
+fi
+
+if [ ! -f config/permissions.json.default ]; then
+    cp defaults/permissions.json.default config
+fi
+
+exec python3 ./server.py

plugins/discord_bot.py

@@ -72,6 +72,7 @@ class DiscordPlugin(BasePlugin, discord.Client):
     name = "discord_bot"
     depends = ['command_dispatcher']
     default_config = {
+        "enabled": True,
         "token": "-- token --",
         "client_id": "-- client_id --",
         "channel": "-- channel id --",
@@ -87,8 +88,11 @@ class DiscordPlugin(BasePlugin, discord.Client):
     def __init__(self):
         BasePlugin.__init__(self)
         discord.Client.__init__(self)
+        self.enabled = True
         self.token = None
+        self.channel_id = None
         self.channel = None
+        self.staff_channel_id = None
         self.staff_channel = None
         self.token = None
         self.client_id = None
@@ -111,6 +115,9 @@ def __init__(self):
                                  'shutdown', 'save')
 
     def activate(self):
+        self.enabled = self.config.get_plugin_config(self.name)["enabled"]
+        if not self.enabled:
+            return;
         BasePlugin.activate(self)
         self.dispatcher = self.plugins.command_dispatcher
         self.irc_bot_exists = link_plugin_if_available(self, 'irc_bot')
@@ -122,11 +129,11 @@ def activate(self):
             "command_prefix"]
         self.token = self.config.get_plugin_config(self.name)["token"]
         self.client_id = self.config.get_plugin_config(self.name)["client_id"]
-        self.channel = self.config.get_plugin_config(self.name)["channel"]
-        self.staff_channel = self.config.get_plugin_config(self.name)[
+        self.channel_id = self.config.get_plugin_config(self.name)["channel"]
+        self.staff_channel_id = self.config.get_plugin_config(self.name)[
             "staff_channel"]
         self.sc = self.config.get_plugin_config(self.name)["strip_colors"]
-        asyncio.ensure_future(self.start_bot())
+        asyncio.ensure_future(self.start_bot()).add_done_callback(self.error_handler)
         self.update_id(self.client_id)
         self.mock_connection = MockConnection(self)
         self.rank_roles = self.config.get_plugin_config(self.name)[
@@ -151,7 +158,9 @@ def on_connect_success(self, data, connection):
         :param connection:
         :return: Boolean: True. Must be true, so packet moves on.
         """
-        asyncio.ensure_future(self.make_announce(connection, "joined"))
+        if not self.enabled:
+            return True;
+        asyncio.ensure_future(self.make_announce(connection, "joined")).add_done_callback(self.error_handler)
         return True
 
     def on_client_disconnect_request(self, data, connection):
@@ -162,7 +171,9 @@ def on_client_disconnect_request(self, data, connection):
         :param connection:
         :return: Boolean: True. Must be true, so packet moves on.
         """
-        asyncio.ensure_future(self.make_announce(connection, "left"))
+        if not self.enabled:
+            return True;
+        asyncio.ensure_future(self.make_announce(connection, "left")).add_done_callback(self.error_handler)
         return True
 
     def on_chat_sent(self, data, connection):
@@ -177,6 +188,8 @@ def on_chat_sent(self, data, connection):
         :param connection:
         :return: Boolean: True. Must be true, so packet moves on.
         """
+        if not self.enabled:
+            return True;
         if not data["parsed"]["message"].startswith(self.prefix):
             msg = data["parsed"]["message"]
             if self.sc:
@@ -207,13 +220,14 @@ def start_bot(self):
         except Exception as e:
             self.logger.exception(e)
 
+
     def update_id(self, client_id):
         self.client_id = client_id
 
     @asyncio.coroutine
     def on_ready(self):
-        self.channel = self.get_channel(self.channel)
-        self.staff_channel = self.get_channel(self.staff_channel)
+        self.channel = self.get_channel(self.channel_id)
+        self.staff_channel = self.get_channel(self.staff_channel_id)
         if not self.channel:
             self.logger.error("Couldn't get channel! Messages can't be "
                               "sent! Ensure the channel ID is correct.")
@@ -305,4 +319,12 @@ def bot_write(self, msg, target=None):
             target = self.channel
         if target is None:
             return
-        asyncio.ensure_future(self.send_message(target, msg))
+        asyncio.ensure_future(self.send_message(target, msg)).add_done_callback(self.error_handler)
+
+    def error_handler(self, future):
+        try:
+            future.result()
+        except Exception as e:
+            self.logger.error("Caught an unhandled exception in Discord bot.  Will restart.")
+            self.logger.exception(e)
+            asyncio.ensure_future(self.start_bot())

plugins/irc_bot.py

@@ -109,6 +109,7 @@ class IRCPlugin(BasePlugin):
     name = "irc_bot"
     depends = ['command_dispatcher']
     default_config = {
+        "enabled": True,
         "server": "irc.freenode.net",
         "channel": "#starrypy",
         "username": "starrypy3k_bot",
@@ -122,6 +123,7 @@ class IRCPlugin(BasePlugin):
 
     def __init__(self):
         super().__init__()
+        self.enabled = True
         self.server = None
         self.channel = None
         self.username = None
@@ -142,6 +144,9 @@ def __init__(self):
                                  'user', 'del_player', 'maintenance_mode',
                                  'shutdown', 'save')
     def activate(self):
+        self.enabled = self.config.get_plugin_config(self.name)["enabled"]
+        if not self.enabled:
+            return
         super().activate()
         self.dispatcher = self.plugins.command_dispatcher
         self.prefix = self.config.get_plugin_config("command_dispatcher")[
@@ -193,6 +198,8 @@ def on_connect_success(self, data, connection):
         :param connection:
         :return: Boolean: True. Must be true, so packet moves on.
         """
+        if not self.enabled:
+            return True
         asyncio.ensure_future(self.announce_join(connection))
         return True
 
@@ -204,6 +211,8 @@ def on_client_disconnect_request(self, data, connection):
         :param connection:
         :return: Boolean: True. Must be true, so packet moves on.
         """
+        if not self.enabled:
+            return True
         asyncio.ensure_future(self.announce_leave(connection.player))
         return True
 
@@ -219,6 +228,8 @@ def on_chat_sent(self, data, connection):
         :param connection:
         :return: Boolean: True. Must be true, so packet moves on.
         """
+        if not self.enabled:
+            return True
         if not data["parsed"]["message"].startswith(self.prefix):
             msg = data["parsed"]["message"]
             if self.sc:

server.py

@@ -301,7 +301,7 @@ def start_server():
     logger = logging.getLogger('starrypy')
     logger.setLevel(loglevel)
     if DEBUG:
-        fh_d = logging.FileHandler("debug.log")
+        fh_d = logging.FileHandler("config/debug.log")
         fh_d.setLevel(loglevel)
         fh_d.setFormatter(formatter)
         aiologger.addHandler(fh_d)
@@ -313,6 +313,7 @@ def start_server():
     logger.addHandler(ch)
 
     signal.signal(signal.SIGINT, signal.default_int_handler)
+    signal.signal(signal.SIGTERM, signal.default_int_handler)
 
     loop = asyncio.get_event_loop()
     loop.set_debug(False)  # Removed in commit to avoid errors.