Merge pull request #45 from CarrotsAreMediocre/development

Release 1.1.0

Author: AMorporkian

.gitignore

@@ -39,4 +39,5 @@ nosetests.xml
 *config.json
 *.db
 *.db-journal
-*.log
+*.log
+.idea/

README.md

@@ -23,7 +23,7 @@ This requires Python and pip to install, and on *nix systems the python developm
 Create a configuration file using the config.json.example. The most important things to note are owner\_uuid, which should be set to a character's UUID that you possess and have never shared; server\_address and server\_port, which should be set to the proxied server. StarryPy will default to port 21025 for normal clients to connect to. Select a good random port, or set it to 21024 and firewall it off from the outside.
 
 # Run it
-Use your terminal (cmd or powershell on windows) and `cd` to the directory you installed StarryPy into. Enter `python server.py` to start the proxy.
+After making sure the Starbound server is running, use your terminal (cmd or powershell on windows) and `cd` to the directory you installed StarryPy into. Enter `python server.py` to start the proxy.
 
 # Built-in plugins
 StarryPy is nearly entirely plugin driven (our plugin manager is a plugin!), so there are quite a few built-in plugins. The truly important plugins are in the core\_plugins folder. If you remove any of those, it's likely that most other plugins will break. We'll break them down by core plugin and normal plugin classes. If you are looking for the commands, feel free to skip the core plugins section.

config.py

@@ -1,6 +1,6 @@
 import json
 import logging
-
+import inspect
 
 class Singleton(type):
     _instances = {}
@@ -20,30 +20,46 @@ def __init__(self):
         try:
             with open("config/config.json", "r+") as config:
                 self.config = json.load(config)
+                if not "plugin_config" in self.config:
+                    self.config["plugin_config"] = {}
         except Exception as e:
-            self.logger.critical("Tried to save the configuration file, failed.\n%s", str(e))
+            self.logger.critical("Tried to read the configuration file, failed.\n%s", str(e))
             raise
         self.logger.debug("Created configuration manager.")
 
     def save(self):
         try:
             with open("config/config.json", "w") as config:
-                config.write(json.dumps(self.config, indent=4, separators=(',', ': ')))
+                config.write(json.dumps(self.config, indent=4, separators=(',', ': '), sort_keys=True))
         except Exception as e:
             self.logger.critical("Tried to save the configuration file, failed.\n%s", str(e))
             raise
 
     def __getattr__(self, item):
-        if item != "config":
+        if item == "config":
+            return super(ConfigurationManager, self).__getattribute__(item)
+
+        elif item == "plugin_config":
+            caller = inspect.stack()[1][0].f_locals["self"].__class__.name
+            if caller in self.config["plugin_config"]:
+                return self.config["plugin_config"][caller]
+            else:
+                return {}
+
+        else:
             if item in self.config:
                 return self.config[item]
             else:
+                self.logger.error("Couldn't find configuration option %s in configuration file.", item)
                 raise AttributeError
-        else:
-            return super(ConfigurationManager, self).__getattribute__(item)
 
     def __setattr__(self, key, value):
-        if key != "config":
-            self.config[key] = value
+        if key == "config":
+            super(ConfigurationManager, self).__setattr__(key, value)
+
+        elif key == "plugin_config":
+            caller = inspect.stack()[1][0].f_locals["self"].__class__.name
+            self.config["plugin_config"][caller] = value
+
         else:
-            super(ConfigurationManager, self).__setattr__(key, value)
+            self.config[key] = value

config/config.json.example

@@ -1,19 +1,37 @@
 {
-    "server_hostname": "localhost",
-    "debug_file": "debug.log",
+    "bind_port": 21025,
+    "chat_prefix": "@",
+    "colors": {
+        "admin": "^#C443F7;",
+        "default": "^#F7EB43;",
+        "guest": "^#F7EB43;",
+        "moderator": "^#4385F7;",
+        "owner": "^#F7434C;",
+        "registered": "^#A0F743;"
+    },
+    "command_prefix": "/",
     "core_plugin_path": "./core_plugins",
-    "owner_uuid": "",
+    "debug_file": "debug.log",
+    "owner_uuid": "!!! SET THIS !!!",
+    "passthrough": false,
     "player_db": "config/player.db",
-    "server_port": 21024,
+    "plugin_config": {
+        "motd_plugin": "Welcome to the server! Play nice.",
+        "new_player_greeter_plugin": {
+            "items": [
+                [
+                    "coalore",
+                    200
+                ],
+                [
+                    "alienburger",
+                    5
+                ]
+            ],
+            "message": "Welcome to the server! Here are some starter items to get you off to a good start."
+        }
+    },
     "plugin_path": "./plugins",
-    "command_prefix": "/",
-    "passthrough" : false,
-    "colors": {
-    	"default": "^#F7EB43;",
-    	"guest": "^#F7EB43;",
-    	"registered": "^#A0F743;",
-    	"moderator": "^#4385F7;",
-    	"admin": "^#C443F7;",
-    	"owner": "^#F7434C;"    
-    }
-}
+    "upstream_hostname": "localhost",
+    "upstream_port": 21024
+}

core_plugins/player_manager/plugin.py

@@ -70,11 +70,12 @@ def after_connect_response(self, data):
         connection_parameters = connect_response().parse(data.data)
         if not connection_parameters.success:
             self.protocol.transport.loseConnection()
-        self.protocol.player.client_id = connection_parameters.client_id
-        self.protocol.player.logged_in = True
-        self.logger.info("Player %s (UUID: %s, IP: %s) logged in" % (
-            self.protocol.player.name, self.protocol.player.uuid,
-            self.protocol.transport.getHost().host))
+        else:
+            self.protocol.player.client_id = connection_parameters.client_id
+            self.protocol.player.logged_in = True
+            self.logger.info("Player %s (UUID: %s, IP: %s) logged in" % (
+                self.protocol.player.name, self.protocol.player.uuid,
+                self.protocol.transport.getHost().host))
 
     def after_world_start(self, data):
         world_start = packets.Variant("").parse(data.data)

plugins/admin_commands_plugin/admin_command_plugin.py

@@ -1,7 +1,8 @@
+from twisted.internet import reactor
 from base_plugin import SimpleCommandPlugin, BasePlugin
 from core_plugins.player_manager import permissions, UserLevels
 from packets import chat_sent
-from utility_functions import give_item_to_player
+from utility_functions import give_item_to_player, extract_name
 
 
 class UserCommandPlugin(SimpleCommandPlugin):
@@ -10,44 +11,25 @@ class UserCommandPlugin(SimpleCommandPlugin):
     """
     name = "user_management_commands"
     depends = ['command_dispatcher', 'player_manager']
-    commands = ["who", "whois", "promote", "kick", "ban", "give_item", "planet", "mute", "unmute", "passthrough"]
+    commands = ["who", "whois", "promote", "kick", "ban", "give_item", "planet", "mute", "unmute", "passthrough", "shutdown"]
     auto_activate = True
 
     def activate(self):
         super(UserCommandPlugin, self).activate()
         self.player_manager = self.plugins['player_manager'].player_manager
         self.godmode = {}
 
-    @staticmethod
-    def extract_name(l):
-        name = []
-        if l[0][0] not in ["'", '"']:
-            return l[0], l[1:]
-        name.append(l[0][1:])
-        terminator = l[0][0]
-        for idx, s in enumerate(l[1:]):
-            if s[-1] == terminator:
-                name.append(s[:-1])
-                if idx + 2 != len(l):
-                    return " ".join(name), l[idx + 2:]
-                else:
-                    return " ".join(name), None
-            else:
-                name.append(s)
-        raise ValueError("Final terminator character of <%s> not found" %
-                         terminator)
-
     def who(self, data):
         """Returns all current users on the server. Syntax: /who"""
         who = [w.colored_name(self.config.colors) for w in self.player_manager.who()]
-        self.protocol.send_chat_message("Players online: %s" % " ".join(who))
+        self.protocol.send_chat_message("%d players online: %s" % (len(who), ", ".join(who)))
         return False
 
     def planet(self, data):
         """Displays who is on your current planet."""
         who = [w.colored_name(self.config.colors) for w in self.player_manager.who() if
                w.planet == self.protocol.player.planet and not w.on_ship]
-        self.protocol.send_chat_message("Players on your current planet: %s" % " ".join(who))
+        self.protocol.send_chat_message("%d players on your current planet: %s" % (len(who), ", ".join(who)))
 
     @permissions(UserLevels.ADMIN)
     def whois(self, data):
@@ -122,7 +104,7 @@ def make_admin(self, player):
     @permissions(UserLevels.MODERATOR)
     def kick(self, data):
         """Kicks a user from the server. Usage: /kick [username] [reason]"""
-        name, reason = self.extract_name(data)
+        name, reason = extract_name(data)
         if reason is None:
             reason = "no reason given"
         info = self.player_manager.whois(name)
@@ -169,7 +151,7 @@ def unban(self, data):
     def give_item(self, data):
         """Gives an item to a player. Syntax: /give [target player] [item name] [optional: item count]"""
         if len(data) >= 2:
-            name, item = self.extract_name(data)
+            name, item = extract_name(data)
             target_player = self.player_manager.get_logged_in_by_name(name)
             target_protocol = self.protocol.factory.protocols[target_player.protocol]
             if target_player is not None:
@@ -220,11 +202,18 @@ def unmute(self, data):
         target_protocol.send_chat_message("You have been unmuted.")
         self.protocol.send_chat_message("%s has been unmuted." % name)
 
-    @permissions(UserLevels.OWNER)
+    @permissions(UserLevels.ADMIN)
     def passthrough(self, data):
         """Sets the server to passthrough mode. *This is irreversible without restart.* Syntax: /passthrough"""
         self.config.passthrough = True
 
+    @permissions(UserLevels.ADMIN)
+    def shutdown(self, data):
+        """Shutdown the server in n seconds. Syntax: /shutdown [number of seconds] (>0)"""
+        x = float(data[0])
+        self.protocol.factory.broadcast("SERVER ANNOUNCEMENT: Server is shutting down in %s seconds!" % data[0])
+        reactor.callLater(x, reactor.stop)
+
 class MuteManager(BasePlugin):
     name = "mute_manager"
     def on_chat_sent(self, data):

plugins/admin_messenger.py

@@ -1,5 +1,5 @@
 from base_plugin import BasePlugin
-from core_plugins.player_manager import UserLevels
+from core_plugins.player_manager import permissions, UserLevels
 import packets
 
 
@@ -9,9 +9,16 @@ class AdminMessenger(BasePlugin):
     depends = ['player_manager']
     auto_activate = True
 
+    def activate(self):
+        super(AdminMessenger, self).activate()
+        self.prefix = self.config.chat_prefix
+
     def on_chat_sent(self, data):
         data = packets.chat_sent().parse(data.data)
-        if data.message[:2] == "##":
+        if data.message[:3] == self.prefix*3:
+            self.broadcast_message(data)
+            return False
+        if data.message[:2] == self.prefix*2:
             self.message_admins(data)
             return False
         return True
@@ -24,3 +31,10 @@ def message_admins(self, message):
                                                                 message.message[2:]))
                 self.logger.info("Received an admin message from %s. Message: %s", self.protocol.player.name,
                                  message.message[2:])
+
+    @permissions(UserLevels.ADMIN)
+    def broadcast_message(self, message):
+        for protocol in self.protocol.factory.protocols.itervalues():
+            protocol.send_chat_message("%sSERVER BROADCAST: %s%s" % (self.config.colors["admin"], message.message[3:], self.config.colors["default"]))
+            self.logger.info("Broadcast from %s. Message: %s", self.protocol.player.name,
+                                 message.message[3:])

plugins/motd_plugin/motd.txt

@@ -15,10 +15,9 @@ class MOTDPlugin(SimpleCommandPlugin):
     def activate(self):
         super(MOTDPlugin, self).activate()
         try:
-            with open("plugins/motd_plugin/motd.txt") as motd:
-                self._motd = motd.read()
+            self._motd = self.config.plugin_config
         except:
-            self.logger.error("Couldn't read message of the day from file.")
+            self.logger.error("Couldn't read message of the day from config.")
             raise
 
     def after_connect_response(self, data):
@@ -39,8 +38,7 @@ def set_motd(self, motd):
         """Sets the message of the day to a new value. Usage: /set_motd [New message of the day]"""
         try:
             self._motd = " ".join(motd)
-            with open("plugins/motd_plugin/motd.txt", "w") as f:
-                f.write(self._motd.encode("utf-8"))
+            self.config.plugin_config = self._motd
             self.logger.info("MOTD changed to: %s", self._motd)
             self.send_motd()
         except:

plugins/motd_plugin/motd_plugin.py

@@ -11,10 +11,6 @@ class NewPlayerGreeter(BasePlugin):
 
     def activate(self):
         super(NewPlayerGreeter, self).activate()
-        self.starter_items = []
-        with open("plugins/new_player_greeter_plugin/starter_items.txt") as f:
-            for item, count in [x.split(" ") for x in f]:
-                self.starter_items.append((item, count))
 
     def after_connect_response(self, data):
         try:
@@ -30,9 +26,8 @@ def after_connect_response(self, data):
             self.logger.info("Gave starter items to %s.", self.protocol.player.name)
 
     def give_items(self):
-        for item in self.starter_items:
+        for item in self.config.plugin_config["items"]:
             give_item_to_player(self.protocol, item[0], item[1])
 
     def send_greetings(self):
-        with open("plugins/new_player_greeter_plugin/new_player_message.txt") as f:
-            self.protocol.send_chat_message(f.read())
+        self.protocol.send_chat_message(self.config.plugin_config["message"])