Added projectile blacklist, closing #56.

Author: AMorporkian

config.py

@@ -2,6 +2,9 @@
 import json
 import logging
 import inspect
+import sys
+from utility_functions import recursive_dictionary_update
+
 
 class Singleton(type):
     _instances = {}
@@ -21,16 +24,25 @@ def __init__(self):
         try:
             with open("config/config.json.default", "r") as default_config:
                 self.config = json.load(default_config)
-        except:
-            self.logger.exception("Could not load the default configuration file.", exc_info=True)
-            raise
+        except IOError:
+            self.logger.critical("The configuration defaults file (config.json.default) doesn't exist! Shutting down.")
+            sys.exit()
+        except ValueError:
+            self.logger.critical("The configuration defaults file (config.json.default) contains invalid JSON. Please run it against a JSON linter, such as http://jsonlint.com. Shutting down." )
+            sys.exit()
         try:
             with open("config/config.json", "r+") as config:
-                self.config.update(json.load(config))
-        except:
-            self.logger.exception("Could not load the default configuration file.", exc_info=True)
-            raise
+                self.config = recursive_dictionary_update(self.config, json.load(config))
+        except IOError:
+            self.logger.warning("The configuration file (config.json) doesn't exist! Creating one from defaults.")
+            with open("config/config.json", "w") as f:
+                json.dump(self.config, f)
+        except ValueError:
+            self.logger.critical("The configuration file (config.json) contains invalid JSON. Please run it against a JSON linter, such as http://jsonlint.com. Shutting down.")
+            sys.exit()
+
         self.logger.debug("Created configuration manager.")
+        self.save()
 
     def save(self):
         try:

config/config.json.default

@@ -12,10 +12,10 @@
     "command_prefix": "/",
     "core_plugin_path": "core_plugins",
     "debug_file": "debug.log",
-    "logging_format_console": "%(asctime)s -  %(name)s - %(levelname)s - %(message)s",
+    "logging_format_console": "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
     "logging_format_debugfile": "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
     "logging_format_logfile": "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
-    "owner_uuid": "!!! SET THIS !!!",
+    "owner_uuid": "!!--REPLACE THIS--!!",
     "passthrough": false,
     "player_db": "config/player.db",
     "plugin_config": {
@@ -33,8 +33,88 @@
             ],
             "message": "Welcome to the server! Here are some starter items to get you off to a good start."
         },
+        "planet_protect": {
+            "blacklist": [
+                "bomb",
+                "bombblockexplosion",
+                "bouldersmashexplosion",
+                "bouncycluster",
+                "bouncyclustergrenade",
+                "cluster",
+                "clustergoo",
+                "clustergrenade",
+                "defensiveexplosion",
+                "dungeonpodexplosion",
+                "electricexplosion",
+                "electrogrenade",
+                "explosivebullet",
+                "explosivegoo",
+                "fireexplosion",
+                "friendlyboneexplosion",
+                "gas",
+                "gas2",
+                "gasgrenade",
+                "glowbomb",
+                "glowgas",
+                "gravitybomb",
+                "grenade",
+                "grenade",
+                "grenadeexplosion",
+                "icestorm",
+                "impactgrenade",
+                "invisibleprojectile",
+                "jellybossexplode",
+                "jellybossgoo",
+                "jumpbomb",
+                "jumpgas",
+                "largemeteor",
+                "lavaballoon",
+                "lavaprojectile",
+                "magicmolotov",
+                "megabeam",
+                "meteor",
+                "meteorblockprojectile",
+                "meteorblockspawner",
+                "meteorexplosion",
+                "molotov",
+                "molotovflame",
+                "nail",
+                "nailbomb",
+                "plasmabullet",
+                "plasmaexplosion2",
+                "plasmagrenade",
+                "plasmatorpedo",
+                "poisonsmoke",
+                "poisonstatusprojectile",
+                "poopbreath",
+                "pulsecannon",
+                "pulsecannonexplosion",
+                "purpleplasma",
+                "regularexplosion",
+                "regularexplosion2",
+                "regularexplosionnospark",
+                "rocket",
+                "rocketexplosion",
+                "runbomb",
+                "rungas",
+                "shockbomb",
+                "smallmeteor",
+                "smallregularexplosion",
+                "targetexplosion",
+                "vsmallregularexplosion",
+                "vsmallregularexplosionnodamage",
+                "water",
+                "zbomb",
+                "spinningrocket",
+                "stationaryrocket"
+            ],
+            "protected_planets": []
+        },
         "player_manager": {
-        "name_removal_regexes": ["[\\s]"]
+            "name_removal_regexes": [
+                "\\^#[\\w]+;",
+                "[^ \\w]+"
+            ]
         }
     },
     "plugin_path": "plugins",

packets/packet_types.py

@@ -1,6 +1,6 @@
 from construct import *
 from enum import IntEnum
-from data_types import SignedVLQ, VLQ, Variant, star_string
+from data_types import SignedVLQ, VLQ, Variant, star_string, DictVariant
 
 
 class Direction(IntEnum):
@@ -58,6 +58,18 @@ class Packets(IntEnum):
     HEARTBEAT = 46
 
 
+class EntityType(IntEnum):
+    END = -1
+    PLAYER = 0
+    MONSTER = 1
+    OBJECT = 2
+    ITEMDROP = 3
+    PROJECTILE = 4
+    PLANT = 5
+    PLANTDROP = 6
+    EFFECT = 7
+
+
 class PacketOutOfOrder(Exception):
     pass
 
@@ -164,6 +176,7 @@ def _decode(self, obj, context):
         ),
         player=player))
 
+
 world_start = lambda name="world_start": Struct(name,
                                                 VLQ("planet_size"),
                                                 Bytes("planet", lambda ctx: ctx.planet_size),
@@ -205,4 +218,14 @@ def _decode(self, obj, context):
 update_world_properties_write = lambda dictionary: update_world_properties().build(
     Container(
         count=len(dictionary),
-        properties=[Container(key=k, value=Container(type="SVLQ", data=v)) for k, v in dictionary.items()]))
+        properties=[Container(key=k, value=Container(type="SVLQ", data=v)) for k, v in dictionary.items()]))
+
+entity_create = Struct("entity_create",
+                       GreedyRange(
+                           Struct("entity",
+                                  Byte("entity_type"),
+                                  VLQ("entity_size"),
+                                  String("entity", lambda ctx: ctx.entity_size),
+                                  SignedVLQ("entity_id")
+                       )))
+projectile = DictVariant("projectile")

plugins/planet_protect/planet_protect_plugin.py

@@ -1,5 +1,6 @@
 from base_plugin import SimpleCommandPlugin
 from core_plugins.player_manager import UserLevels, permissions
+from packets import entity_create, EntityType, star_string
 
 
 class PlanetProtectPlugin(SimpleCommandPlugin):
@@ -27,12 +28,9 @@ def activate(self):
             "MODIFY_TILE_LIST"]
         for n in ["on_" + n.lower() for n in bad_packets]:
             setattr(self, n, (lambda x: self.planet_check()))
-        if self.config.plugin_config == {}:
-            self.protected_planets = []
-        else:
-            self.protected_planets = self.config.plugin_config
-
-        self.player_manager = self.plugins['player_manager']
+        self.protected_planets = self.config.plugin_config.get("protected_planets", [])
+        self.blacklist = self.config.plugin_config.get("blacklist", [])
+        self.player_manager = self.plugins.get("player_manager", [])
 
     def planet_check(self):
         if self.protocol.player.planet in self.protected_planets and self.protocol.player.access_level < UserLevels.REGISTERED:
@@ -73,5 +71,15 @@ def unprotect(self, data):
         self.save()
 
     def save(self):
-        self.config.plugin_config = self.protected_planets
+        self.config.plugin_config['protected_planets'] = self.protected_planets
+        self.config.plugin_config['blacklist'] = self.blacklist
 
+    def on_entity_create(self, data):
+        if self.protocol.player.planet in self.protected_planets and self.protocol.player.access_level <= UserLevels.MODERATOR:
+            entities = entity_create.parse(data.data)
+            for entity in entities.entity:
+                if entity.entity_type == EntityType.PROJECTILE:
+                    p_type = star_string("").parse(entity.entity)
+                    if p_type in self.blacklist:
+                        self.logger.info("Player %s attempted to use a prohibited projectile, %s, on a protected planet.", self.protocol.player.name, p_type)
+                        return False

utility_functions.py

@@ -1,3 +1,4 @@
+import collections
 import logging
 
 from construct import Container
@@ -21,6 +22,16 @@ def give_item_to_player(player_protocol, item, count=1):
         item_count -= x
 
 
+def recursive_dictionary_update(d, u):
+    for k, v in u.iteritems():
+        if isinstance(v, collections.Mapping):
+            r = recursive_dictionary_update(d.get(k, {}), v)
+            d[k] = r
+        else:
+            d[k] = u[k]
+    return d
+
+
 def build_packet(packet_type, data):
     """
     Convenience method to build packets for sending.