The del and return statements aren't functions
[mudpy.git] / mudpy / misc.py
index 0543aa1..7051ac9 100644 (file)
@@ -184,27 +184,36 @@ class Element:
                 prepend_padding
             )
 
+    def is_restricted(self):
+        """Boolean check whether command is administrative or debugging."""
+        return self.get(
+            "administrative", False) or self.get("debugging", False)
+
+    def is_admin(self):
+        """Boolean check whether an actor is controlled by an admin owner."""
+        return self.owner and self.owner.is_admin()
+
     def can_run(self, command):
         """Check if the user can run this command object."""
 
         # has to be in the commands group
         if command not in self.universe.groups["command"].values():
-            result = False
+            return False
+
+        # debugging commands are not allowed outside debug mode
+        if command.get("debugging") and not self.universe.debug_mode():
+            return False
 
         # avatars of administrators can run any command
-        elif self.owner and self.owner.account.get("administrator"):
-            result = True
+        if self.is_admin():
+            return True
 
         # everyone can run non-administrative commands
-        elif not command.get("administrative"):
-            result = True
+        if not command.is_restricted():
+            return True
 
         # otherwise the command cannot be run by this actor
-        else:
-            result = False
-
-        # pass back the result
-        return result
+        return False
 
     def update_location(self):
         """Make sure the location's contents contain this element."""
@@ -477,6 +486,10 @@ class Universe:
         if fallback not in self.files:
             mudpy.data.Data(fallback, self, flags=flags)
 
+    def debug_mode(self):
+        """Boolean method to indicate whether unsafe debugging is enabled."""
+        return self.groups["mudpy"]["limit"].get("debug", False)
+
 
 class User:
 
@@ -501,6 +514,7 @@ class User:
         self.output_queue = []
         self.partial_input = b""
         self.password_tries = 0
+        self.rows = 23
         self.state = "telopt_negotiation"
         self.telopts = {}
         self.ttype = None
@@ -564,7 +578,7 @@ class User:
         self.remove()
 
         # get rid of the old user object
-        del(self)
+        del self
 
         # create a new user object
         new_user = User()
@@ -628,7 +642,7 @@ class User:
 
                 # take this one out of the list and delete
                 self.remove()
-                del(self)
+                del self
                 return_value = True
                 break
 
@@ -998,6 +1012,10 @@ class User:
                     avatar, 6)
         return avatars
 
+    def is_admin(self):
+        """Boolean check whether user's account is an admin."""
+        return self.account.get("administrator", False)
+
 
 def broadcast(message, add_prompt=True):
     """Send a message to all connected users."""
@@ -1052,9 +1070,10 @@ def log(message, level=0):
 
     # display to connected administrators
     for user in universe.userlist:
-        if user.state == "active" and user.account.get(
-           "administrator"
-           ) and user.account.get("loglevel", 0) <= level:
+        if (
+                user.state == "active"
+                and user.is_admin()
+                and user.account.get("loglevel", 0) <= level):
             # iterate over every line in the message
             full_message = ""
             for line in lines:
@@ -1083,7 +1102,7 @@ def get_loglines(level, start, stop):
     # don't proceed if there are no lines
     if filtered_count:
 
-        # can't start before the begining or at the end
+        # can't start before the beginning or at the end
         if start > filtered_count:
             start = filtered_count
         if start < 1:
@@ -1136,7 +1155,7 @@ def wrap_ansi_text(text, width):
     # characters, printable or otherwise
     abs_pos = 0
 
-    # the current text position relative to the begining of the line,
+    # the current text position relative to the beginning of the line,
     # ignoring color escape sequences
     rel_pos = 0
 
@@ -1151,7 +1170,7 @@ def wrap_ansi_text(text, width):
     # normalize any potentially composited unicode before we count it
     text = unicodedata.normalize("NFKC", text)
 
-    # iterate over each character from the begining of the text
+    # iterate over each character from the beginning of the text
     for each_character in text:
 
         # the current character is the escape character
@@ -1193,7 +1212,7 @@ def wrap_ansi_text(text, width):
             # characters but the space it replaced was only one
             abs_pos += 1
 
-            # now we're at the begining of a new line, plus the
+            # now we're at the beginning of a new line, plus the
             # number of characters wrapped from the previous line
             rel_pos -= last_rel_whitespace
             last_rel_whitespace = 0
@@ -1226,7 +1245,7 @@ def weighted_choice(data):
             expanded.append(key)
 
     # return one at random
-    # Whitelist the random.randrange() call in bandit since it's not used for
+    # Allow the random.randrange() call in bandit since it's not used for
     # security/cryptographic purposes
     return random.choice(expanded)  # nosec
 
@@ -1275,7 +1294,7 @@ def random_name():
     name = ""
 
     # create a name of random length from the syllables
-    # Whitelist the random.randrange() call in bandit since it's not used for
+    # Allow the random.randrange() call in bandit since it's not used for
     # security/cryptographic purposes
     for _syllable in range(random.randrange(2, 6)):  # nosec
         name += weighted_choice(syllables)
@@ -1500,7 +1519,7 @@ def find_command(command_name):
     else:
         for candidate in sorted(universe.groups["command"]):
             if candidate.startswith(command_name) and not universe.groups[
-                    "command"][candidate].get("administrative"):
+                    "command"][candidate].is_restricted():
                 # the command matches the start of a command word and is not
                 # restricted to administrators
                 command = universe.groups["command"][candidate]
@@ -2102,6 +2121,8 @@ def setup():
     log("Running version: %s" % universe.versions.version, 1)
     log("Initial directory: %s" % universe.startdir, 1)
     log("Command line: %s" % " ".join(sys.argv), 1)
+    if universe.debug_mode():
+        log("WARNING: Unsafe debugging mode is enabled!", 6)
 
     # pass the initialized universe back
     return universe