Imported from archive.
[mudpy.git] / mudpy.py
index 006b6a8..936d3ba 100644 (file)
--- a/mudpy.py
+++ b/mudpy.py
@@ -34,12 +34,17 @@ class Element:
                        DataFile(self.origin, universe)
                if not universe.files[self.origin].data.has_section(self.key):
                        universe.files[self.origin].data.add_section(self.key)
-       def delete(self):
-               log("Deleting: " + self.key + ".")
+       def destroy(self):
+               """Remove an element from the universe and destroy it."""
+               log("Destroying: " + self.key + ".")
                universe.files[self.origin].data.remove_section(self.key)
                del universe.categories[self.category][self.subkey]
                del universe.contents[self.key]
                del self
+       def delete(self, facet):
+               """Delete a facet from the element."""
+               if universe.files[self.origin].data.has_option(self.key, facet):
+                       universe.files[self.origin].data.remove_option(self.key, facet)
        def facets(self):
                """Return a list of facets for this element."""
                return universe.files[self.origin].data.options(self.key)
@@ -118,7 +123,7 @@ class DataFile:
                        DataFile(include_file, universe)
        def save(self):
                if ( self.data.sections() or exists(self.filename) ) and not ( self.data.has_option("control", "read_only") and self.data.getboolean("control", "read_only") ):
-                       if not exists(dirname(self.filename)): makedirs(dirname)
+                       if not exists(dirname(self.filename)): makedirs(dirname(self.filename))
                        file_descriptor = file(self.filename, "w")
                        if self.filename in universe.private_files and oct(S_IMODE(stat(self.filename)[ST_MODE])) != 0600:
                                chmod(self.filename, 0600)
@@ -404,6 +409,24 @@ class User:
                                # put on the end of the queue
                                self.input_queue.append(line)
 
+       def can_run(self, command):
+               """Check if the user can run this command object."""
+
+               # has to be in the commands category
+               if command not in universe.categories["command"].values(): result = False
+
+               # administrators can run any command
+               elif self.account.getboolean("administrator"): result = True
+
+               # everyone can run non-administrative commands
+               elif not command.getboolean("administrative"): result = True
+
+               # otherwise the command cannot be run by this user
+               else: result = False
+
+               # pass back the result
+               return result
+
        def new_avatar(self):
                """Instantiate a new, unconfigured avatar for this user."""
                counter = 0
@@ -416,15 +439,15 @@ class User:
        def delete_avatar(self, avatar):
                """Remove an avatar from the world and from the user's list."""
                if self.avatar is universe.contents[avatar]: self.avatar = None
-               universe.contents[avatar].delete()
+               universe.contents[avatar].destroy()
                avatars = self.account.getlist("avatars")
                avatars.remove(avatar)
                self.account.set("avatars", avatars)
 
-       def delete(self):
-               """Delete the user and associated avatars."""
+       def destroy(self):
+               """Destroy the user and associated avatars."""
                for avatar in self.account.getlist("avatars"): self.delete_avatar(avatar)
-               self.account.delete()
+               self.account.destroy()
 
        def list_avatar_names(self):
                """List names of assigned avatars."""
@@ -616,6 +639,10 @@ def replace_macros(user, text, is_input=False):
 
        return text
 
+def escape_macros(text):
+       """Escapes replacement macros in text."""
+       return text.replace("$(", "$_(")
+
 def check_time(frequency):
        """Check for a factor of the current increment count."""
        if type(frequency) is str:
@@ -948,7 +975,7 @@ def handler_entering_new_password(user):
        # too many tries, so adios
        else:
                user.send("$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)")
-               user.account.delete()
+               user.account.destroy()
                user.state = "disconnecting"
 
 def handler_verifying_new_password(user):
@@ -974,7 +1001,7 @@ def handler_verifying_new_password(user):
        # otherwise, sayonara
        else:
                user.send("$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)")
-               user.account.delete()
+               user.account.destroy()
                user.state = "disconnecting"
 
 def handler_active(user):
@@ -985,22 +1012,26 @@ def handler_active(user):
 
        # split out the command (first word) and parameters (everything else)
        if input_data.find(" ") > 0:
-               command, parameters = input_data.split(" ", 1)
+               command_name, parameters = input_data.split(" ", 1)
        else:
-               command = input_data
+               command_name = input_data
                parameters = ""
 
        # lowercase the command
-       command = command.lower()
+       command_name = command_name.lower()
 
        # the command matches a command word for which we have data
-       if command in universe.categories["command"]:
-               exec(universe.categories["command"][command].get("action"))
+       if command_name in universe.categories["command"]:
+               command = universe.categories["command"][command_name]
+       else: command = None
 
-       # no data matching the entered command word
-       elif command: command_error(user, command, parameters)
+       # if it's allowed, do it
+       if user.can_run(command): exec(command.get("action"))
 
-def command_halt(user, command="", parameters=""):
+       # otherwise, give an error
+       elif command_name: command_error(user, input_data)
+
+def command_halt(user, parameters):
        """Halt the world."""
 
        # see if there's a message or use a generic one
@@ -1014,7 +1045,7 @@ def command_halt(user, command="", parameters=""):
        # set a flag to terminate the world
        universe.terminate_world = True
 
-def command_reload(user, command="", parameters=""):
+def command_reload(user):
        """Reload all code modules, configs and data."""
 
        # let the user know and log
@@ -1024,11 +1055,7 @@ def command_reload(user, command="", parameters=""):
        # set a flag to reload
        universe.reload_modules = True
 
-def command_quit(user, command="", parameters=""):
-       """Quit the world."""
-       user.state = "main_utility"
-
-def command_help(user, command="", parameters=""):
+def command_help(user, parameters):
        """List available commands and provide help for commands."""
 
        # did the user ask for help on a specific command word?
@@ -1036,15 +1063,22 @@ def command_help(user, command="", parameters=""):
 
                # is the command word one for which we have data?
                if parameters in universe.categories["command"]:
+                       command = universe.categories["command"][parameters]
+               else: command = None
+
+               # only for allowed commands
+               if user.can_run(command):
 
                        # add a description if provided
-                       description = universe.categories["command"][parameters].get("description")
+                       description = command.get("description")
                        if not description:
                                description = "(no short description provided)"
-                       output = "$(grn)" + parameters + "$(nrm) - " + description + "$(eol)$(eol)"
+                       if command.getboolean("administrative"): output = "$(red)"
+                       else: output = "$(grn)"
+                       output += parameters + "$(nrm) - " + description + "$(eol)$(eol)"
 
                        # add the help text if provided
-                       help_text = universe.categories["command"][parameters].get("help")
+                       help_text = command.get("help")
                        if not help_text:
                                help_text = "No help is provided for this command."
                        output += help_text
@@ -1061,16 +1095,20 @@ def command_help(user, command="", parameters=""):
                sorted_commands = universe.categories["command"].keys()
                sorted_commands.sort()
                for item in sorted_commands:
-                       description = universe.categories["command"][item].get("description")
-                       if not description:
-                               description = "(no short description provided)"
-                       output += "   $(grn)" + item + "$(nrm) - " + description + "$(eol)"
+                       command = universe.categories["command"][item]
+                       if user.can_run(command):
+                               description = command.get("description")
+                               if not description:
+                                       description = "(no short description provided)"
+                               if command.getboolean("administrative"): output += "   $(red)"
+                               else: output += "   $(grn)"
+                               output += item + "$(nrm) - " + description + "$(eol)"
                output += "$(eol)Enter \"help COMMAND\" for help on a command named \"COMMAND\"."
 
        # send the accumulated output to the user
        user.send(output)
 
-def command_say(user, command="", parameters=""):
+def command_say(user, parameters):
        """Speak to others in the same room."""
 
        # check for replacement macros
@@ -1111,44 +1149,120 @@ def command_say(user, command="", parameters=""):
 
                # tell the room
                # TODO: we won't be using broadcast once there are actual rooms
-               broadcast(user.account.get("name") + " " + action + "s, \"" + message + "\"")
+               broadcast(user.avatar.get("name") + " " + action + "s, \"" + message + "\"")
 
        # there was no message
        else:
                user.send("What do you want to say?")
 
-def command_show(user, command="", parameters=""):
+def command_show(user, parameters):
        """Show program data."""
-       if parameters == "avatars":
-               message = "These are the avatars managed by your account:$(eol)"
-               avatars = user.list_avatar_names()
-               avatars.sort()
-               for avatar in avatars: message += "$(eol)   $(grn)" + avatar + "$(nrm)"
-       elif parameters == "files":
-               message = "These are the current files containing the universe:$(eol)"
-               keys = universe.files.keys()
-               keys.sort()
-               for key in keys: message += "$(eol)   $(grn)" + key + "$(nrm)"
-       elif parameters == "universe":
-               message = "These are the current elements in the universe:$(eol)"
-               keys = universe.contents.keys()
-               keys.sort()
-               for key in keys: message += "$(eol)   $(grn)" + key + "$(nrm)"
-       elif parameters == "time":
-               message = universe.categories["internal"]["counters"].get("elapsed") + " increments elapsed since the world was created."
-       elif parameters: message = "I don't know what \"" + parameters + "\" is."
-       else: message = "What do you want to show?"
+       message = ""
+       if parameters.find(" ") < 1:
+               if parameters == "time":
+                       message = universe.categories["internal"]["counters"].get("elapsed") + " increments elapsed since the world was created."
+               elif parameters == "categories":
+                       message = "These are the element categories:$(eol)"
+                       categories = universe.categories.keys()
+                       categories.sort()
+                       for category in categories: message += "$(eol)   $(grn)" + category + "$(nrm)"
+               elif parameters == "files":
+                       message = "These are the current files containing the universe:$(eol)"
+                       filenames = universe.files.keys()
+                       filenames.sort()
+                       for filename in filenames: message += "$(eol)   $(grn)" + filename + "$(nrm)"
+               else: message = ""
+       else:
+               arguments = parameters.split()
+               if arguments[0] == "category":
+                       if arguments[1] in universe.categories:
+                               message = "These are the elements in the \"" + arguments[1] + "\" category:$(eol)"
+                               elements = universe.categories[arguments[1]].keys()
+                               elements.sort()
+                               for element in elements:
+                                       message += "$(eol)   $(grn)" + universe.categories[arguments[1]][element].key + "$(nrm)"
+               elif arguments[0] == "element":
+                       if arguments[1] in universe.contents:
+                               message = "These are the properties of the \"" + arguments[1] + "\" element:$(eol)"
+                               element = universe.contents[arguments[1]]
+                               facets = element.facets()
+                               facets.sort()
+                               for facet in facets:
+                                       message += "$(eol)   $(grn)" + facet + ": $(red)" + escape_macros(element.get(facet)) + "$(nrm)"
+       if not message:
+               if parameters: message = "I don't know what \"" + parameters + "\" is."
+               else: message = "What do you want to show?"
+       user.send(message)
+
+def command_create(user, parameters):
+       """Create an element if it does not exist."""
+       if not parameters: message = "You must at least specify an element to create."
+       else:
+               arguments = parameters.split()
+               if len(arguments) == 1: arguments.append("")
+               if len(arguments) == 2:
+                       element, filename = arguments
+                       if element in universe.contents: message = "The \"" + element + "\" element already exists."
+                       else:
+                               message = "You create \"" + element + "\" within the universe."
+                               logline = user.account.get("name") + " created an element: " + element
+                               if filename:
+                                       logline += " in file " + filename
+                                       if filename not in universe.files:
+                                               message += " Warning: \"" + filename + "\" is not yet included in any other file and will not be read on startup unless this is remedied."
+                               Element(element, universe, filename)
+                               log(logline)
+               elif len(arguments) > 2: message = "You can only specify an element and a filename."
+       user.send(message)
+
+def command_destroy(user, parameters):
+       """Destroy an element if it exists."""
+       if not parameters: message = "You must specify an element to destroy."
+       else:
+               if parameters not in universe.contents: message = "The \"" + parameters + "\" element does not exist."
+               else:
+                       universe.contents[parameters].destroy()
+                       message = "You destroy \"" + parameters + "\" within the universe."
+                       log(user.account.get("name") + " destroyed an element: " + parameters)
+       user.send(message)
+
+def command_set(user, parameters):
+       """Set a facet of an element."""
+       if not parameters: message = "You must specify an element, a facet and a value."
+       else:
+               arguments = parameters.split(" ", 2)
+               if len(arguments) == 1: message = "What facet of element \"" + arguments[0] + "\" would you like to set?"
+               elif len(arguments) == 2: message = "What value would you like to set for the \"" + arguments[1] + "\" facet of the \"" + arguments[0] + "\" element?"
+               else:
+                       element, facet, value = arguments
+                       if element not in universe.contents: message = "The \"" + element + "\" element does not exist."
+                       else:
+                               universe.contents[element].set(facet, value)
+                               message = "You have successfully (re)set the \"" + facet + "\" facet of element \"" + element + "\". Try \"show element " + element + "\" for verification."
+       user.send(message)
+
+def command_delete(user, parameters):
+       """Delete a facet from an element."""
+       if not parameters: message = "You must specify an element and a facet."
+       else:
+               arguments = parameters.split(" ")
+               if len(arguments) == 1: message = "What facet of element \"" + arguments[0] + "\" would you like to delete?"
+               elif len(arguments) != 2: message = "You may only specify an element and a facet."
+               else:
+                       element, facet = arguments
+                       if element not in universe.contents: message = "The \"" + element + "\" element does not exist."
+                       elif facet not in universe.contents[element].facets(): message = "The \"" + element + "\" element has no \"" + facet + "\" facet."
+                       else:
+                               universe.contents[element].delete(facet)
+                               message = "You have successfully deleted the \"" + facet + "\" facet of element \"" + element + "\". Try \"show element " + element + "\" for verification."
        user.send(message)
 
-def command_error(user, command="", parameters=""):
+def command_error(user, input_data):
        """Generic error for an unrecognized command word."""
 
        # 90% of the time use a generic error
        if randrange(10):
-               message = "I'm not sure what \"" + command
-               if parameters:
-                       message += " " + parameters
-               message += "\" means..."
+               message = "I'm not sure what \"" + input_data + "\" means..."
 
        # 10% of the time use the classic diku error
        else: