X-Git-Url: https://mudpy.org/gitweb?p=mudpy.git;a=blobdiff_plain;f=mudpy.py;h=8b91054cee92b0984c491a725976d6979f0b17b4;hp=61330b9df9a1383e60ad882e836a4e33008d44a1;hb=74d37bfacdd2d7c13192fe2cd5e34f03cc2e399f;hpb=98c1ce3a29f1cb35df7da79c95ac9fcb8a4a8e1f diff --git a/mudpy.py b/mudpy.py index 61330b9..8b91054 100644 --- a/mudpy.py +++ b/mudpy.py @@ -1,78 +1,195 @@ """Core objects for the mudpy engine.""" -# Copyright (c) 2005 mudpy, Jeremy Stanley , all rights reserved. +# Copyright (c) 2006 mudpy, Jeremy Stanley , all rights reserved. # Licensed per terms in the LICENSE file distributed with this software. # import some things we need from ConfigParser import RawConfigParser from md5 import new as new_md5 -from os import R_OK, access, chmod, makedirs, stat +from os import _exit, R_OK, W_OK, access, chmod, close, fork, getpid, makedirs, remove, setsid, stat from os.path import abspath, dirname, exists, isabs, join as path_join from random import choice, randrange +from re import match +from signal import SIGHUP, SIGTERM, signal from socket import AF_INET, SO_REUSEADDR, SOCK_STREAM, SOL_SOCKET, socket from stat import S_IMODE, ST_MODE +from sys import stderr from syslog import LOG_PID, LOG_INFO, LOG_DAEMON, closelog, openlog, syslog from telnetlib import DO, DONT, ECHO, EOR, GA, IAC, LINEMODE, SB, SE, SGA, WILL, WONT from time import asctime, sleep +from traceback import format_exception + +def excepthook(excepttype, value, traceback): + """Handle uncaught exceptions.""" + + # assemble the list of errors into a single string + message = "".join(format_exception(excepttype, value, traceback)) + + # try to log it, if possible + try: log(message, 9) + except: pass + + # try to write it to stderr, if possible + try: stderr.write(message) + except: pass + +# redefine sys.excepthook with ours +import sys +sys.excepthook = excepthook + +def sighook(what, where): + """Handle external signals.""" + + # a generic message + message = "Caught signal: " + + # for a hangup signal + if what == SIGHUP: + message += "hangup (reloading)" + universe.reload_modules = True + + # for a terminate signal + elif what == SIGTERM: + message += "terminate (halting)" + universe.terminate_world = True + + # catchall for unexpected signals + else: message += str(what) + " (unhandled)" + + # log what happened + log(message, 8) + +# assign the sgnal handlers +signal(SIGHUP, sighook) +signal(SIGTERM, sighook) class Element: """An element of the universe.""" - def __init__(self, key, universe, origin=""): - """Default values for the in-memory element variables.""" + def __init__(self, key, universe, filename=None): + """Set up a new element.""" + + # keep track of our key name self.key = key - if self.key.find(":") > 0: - self.category, self.subkey = self.key.split(":", 1) + + # keep track of what universe it's loading` into + self.universe = universe + + # clone attributes if this is replacing another element + if self.key in self.universe.contents: + old_element = self.universe.contents[self.key] + for attribute in vars(old_element).keys(): + exec("self." + attribute + " = old_element." + attribute) + if self.owner: self.owner.avatar = self + + # i guess this is a new element then else: - self.category = "other" - self.subkey = self.key - if not self.category in universe.categories: self.category = "other" - universe.categories[self.category][self.subkey] = self - self.origin = origin - if not self.origin: self.origin = universe.default_origins[self.category] - if not isabs(self.origin): - self.origin = abspath(self.origin) - universe.contents[self.key] = self - if not self.origin in universe.files: - DataFile(self.origin, universe) - if not universe.files[self.origin].data.has_section(self.key): - universe.files[self.origin].data.add_section(self.key) + + # not owned by a user by default (used for avatars) + self.owner = None + + # no contents in here by default + self.contents = {} + + # parse out appropriate category and subkey names, add to list + if self.key.find(":") > 0: + self.category, self.subkey = self.key.split(":", 1) + else: + self.category = "other" + self.subkey = self.key + if not self.category in self.universe.categories: + self.category = "other" + self.subkey = self.key + + # get an appropriate filename for the origin + if not filename: filename = self.universe.default_origins[self.category] + if not isabs(filename): filename = abspath(filename) + + # add the file if it doesn't exist yet + if not filename in self.universe.files: DataFile(filename, self.universe) + + # record or reset a pointer to the origin file + self.origin = self.universe.files[filename] + + # add a data section to the origin if necessary + if not self.origin.data.has_section(self.key): + self.origin.data.add_section(self.key) + + # add or replace this element in the universe + self.universe.contents[self.key] = self + self.universe.categories[self.category][self.subkey] = self + + def reload(self): + """Create a new element and replace this one.""" + new_element = Element(self.key, self.universe, self.origin.filename) + del(self) 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] + self.origin.data.remove_section(self.key) + del self.universe.categories[self.category][self.subkey] + del self.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) + """Return a list of non-inherited facets for this element.""" + if self.key in self.origin.data.sections(): + return self.origin.data.options(self.key) + else: return [] + def has_facet(self, facet): + """Return whether the non-inherited facet exists.""" + return facet in self.facets() + def remove_facet(self, facet): + """Remove a facet from the element.""" + if self.has_facet(facet): + self.origin.data.remove_option(self.key, facet) + self.origin.modified = True + def ancestry(self): + """Return a list of the element's inheritance lineage.""" + if self.has_facet("inherit"): + ancestry = self.getlist("inherit") + for parent in ancestry[:]: + ancestors = self.universe.contents[parent].ancestry() + for ancestor in ancestors: + if ancestor not in ancestry: ancestry.append(ancestor) + return ancestry + else: return [] def get(self, facet, default=None): """Retrieve values.""" if default is None: default = "" - if universe.files[self.origin].data.has_option(self.key, facet): - return universe.files[self.origin].data.get(self.key, facet) + if self.origin.data.has_option(self.key, facet): + return self.origin.data.get(self.key, facet) + elif self.has_facet("inherit"): + for ancestor in self.ancestry(): + if self.universe.contents[ancestor].has_facet(facet): + return self.universe.contents[ancestor].get(facet) else: return default def getboolean(self, facet, default=None): """Retrieve values as boolean type.""" if default is None: default=False - if universe.files[self.origin].data.has_option(self.key, facet): - return universe.files[self.origin].data.getboolean(self.key, facet) + if self.origin.data.has_option(self.key, facet): + return self.origin.data.getboolean(self.key, facet) + elif self.has_facet("inherit"): + for ancestor in self.ancestry(): + if self.universe.contents[ancestor].has_facet(facet): + return self.universe.contents[ancestor].getboolean(facet) else: return default def getint(self, facet, default=None): """Return values as int/long type.""" if default is None: default = 0 - if universe.files[self.origin].data.has_option(self.key, facet): - return universe.files[self.origin].data.getint(self.key, facet) + if self.origin.data.has_option(self.key, facet): + return self.origin.data.getint(self.key, facet) + elif self.has_facet("inherit"): + for ancestor in self.ancestry(): + if self.universe.contents[ancestor].has_facet(facet): + return self.universe.contents[ancestor].getint(facet) else: return default def getfloat(self, facet, default=None): """Return values as float type.""" if default is None: default = 0.0 - if universe.files[self.origin].data.has_option(self.key, facet): - return universe.files[self.origin].data.getfloat(self.key, facet) + if self.origin.data.has_option(self.key, facet): + return self.origin.data.getfloat(self.key, facet) + elif self.has_facet("inherit"): + for ancestor in self.ancestry(): + if self.universe.contents[ancestor].has_facet(facet): + return self.universe.contents[ancestor].getfloat(facet) else: return default def getlist(self, facet, default=None): """Return values as list type.""" @@ -88,60 +205,212 @@ class Element: else: return default def set(self, facet, value): """Set values.""" + if not self.has_facet(facet) or not self.get(facet) == value: + if type(value) is long: value = str(value) + elif not type(value) is str: value = repr(value) + self.origin.data.set(self.key, facet, value) + self.origin.modified = True + def append(self, facet, value): + """Append value tp a list.""" if type(value) is long: value = str(value) elif not type(value) is str: value = repr(value) - universe.files[self.origin].data.set(self.key, facet, value) + newlist = self.getlist(facet) + newlist.append(value) + self.set(facet, newlist) + + def new_event(self, action, when=None): + """Create, attach and enqueue an event element.""" + + # if when isn't specified, that means now + if not when: when = self.universe.get_time() + + # events are elements themselves + event = Element("event:" + self.key + ":" + counter) + + def send(self, message, eol="$(eol)"): + """Convenience method to pass messages to an owner.""" + if self.owner: self.owner.send(message, eol) + + 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 self.universe.categories["command"].values(): result = False + + # avatars of administrators can run any command + elif self.owner and self.owner.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 actor + else: result = False + + # pass back the result + return result + + def update_location(self): + """Make sure the location's contents contain this element.""" + location = self.get("location") + if location in self.universe.contents: + self.universe.contents[location].contents[self.key] = self + def clean_contents(self): + """Make sure the element's contents aren't bogus.""" + for element in self.contents.values(): + if element.get("location") != self.key: + del self.contents[element.key] + def go_to(self, location): + """Relocate the element to a specific location.""" + current = self.get("location") + if current and self.key in self.universe.contents[current].contents: + del universe.contents[current].contents[self.key] + if location in self.universe.contents: self.set("location", location) + self.universe.contents[location].contents[self.key] = self + self.look_at(location) + def go_home(self): + """Relocate the element to its default location.""" + self.go_to(self.get("default_location")) + self.echo_to_location("You suddenly realize that " + self.get("name") + " is here.") + def move_direction(self, direction): + """Relocate the element in a specified direction.""" + self.echo_to_location(self.get("name") + " exits " + self.universe.categories["internal"]["directions"].getdict(direction)["exit"] + ".") + self.send("You exit " + self.universe.categories["internal"]["directions"].getdict(direction)["exit"] + ".") + self.go_to(self.universe.contents[self.get("location")].link_neighbor(direction)) + self.echo_to_location(self.get("name") + " arrives from " + self.universe.categories["internal"]["directions"].getdict(direction)["enter"] + ".") + def look_at(self, key): + """Show an element to another element.""" + if self.owner: + element = self.universe.contents[key] + message = "" + name = element.get("name") + if name: message += "$(cyn)" + name + "$(nrm)$(eol)" + description = element.get("description") + if description: message += description + "$(eol)" + portal_list = element.portals().keys() + if portal_list: + portal_list.sort() + message += "$(cyn)[ Exits: " + ", ".join(portal_list) + " ]$(nrm)$(eol)" + for element in self.universe.contents[self.get("location")].contents.values(): + if element.getboolean("is_actor") and element is not self: + message += "$(yel)" + element.get("name") + " is here.$(nrm)$(eol)" + elif element is not self: + message += "$(grn)" + element.get("impression") + "$(nrm)$(eol)" + self.send(message) + def portals(self): + """Map the portal directions for a room to neighbors.""" + portals = {} + if match("""^location:-?\d+,-?\d+,-?\d+$""", self.key): + coordinates = [(int(x)) for x in self.key.split(":")[1].split(",")] + directions = self.universe.categories["internal"]["directions"] + offsets = dict([(x, directions.getdict(x)["vector"]) for x in directions.facets()]) + for portal in self.getlist("gridlinks"): + adjacent = map(lambda c,o: c+o, coordinates, offsets[portal]) + neighbor = "location:" + ",".join([(str(x)) for x in adjacent]) + if neighbor in self.universe.contents: portals[portal] = neighbor + for facet in self.facets(): + if facet.startswith("link_"): + neighbor = self.get(facet) + if neighbor in self.universe.contents: + portal = facet.split("_")[1] + portals[portal] = neighbor + return portals + def link_neighbor(self, direction): + """Return the element linked in a given direction.""" + portals = self.portals() + if direction in portals: return portals[direction] + def echo_to_location(self, message): + """Show a message to other elements in the current location.""" + for element in self.universe.contents[self.get("location")].contents.values(): + if element is not self: element.send(message) class DataFile: """A file containing universe elements.""" def __init__(self, filename, universe): - self.data = RawConfigParser() - if access(filename, R_OK): self.data.read(filename) self.filename = filename - universe.files[filename] = self - if self.data.has_option("control", "include_files"): - includes = makelist(self.data.get("control", "include_files")) + self.universe = universe + self.load() + def load(self): + """Read a file and create elements accordingly.""" + self.modified = False + self.data = RawConfigParser() + if access(self.filename, R_OK): self.data.read(self.filename) + if not hasattr(self.universe, "files"): self.universe.files = {} + self.universe.files[self.filename] = self + if self.data.has_option("__control__", "include_files"): + includes = makelist(self.data.get("__control__", "include_files")) else: includes = [] - if self.data.has_option("control", "default_files"): - origins = makedict(self.data.get("control", "default_files")) + if self.data.has_option("__control__", "default_files"): + origins = makedict(self.data.get("__control__", "default_files")) for key in origins.keys(): if not key in includes: includes.append(key) - universe.default_origins[key] = origins[key] - if not key in universe.categories: - universe.categories[key] = {} - if self.data.has_option("control", "private_files"): - for item in makelist(self.data.get("control", "private_files")): + self.universe.default_origins[key] = origins[key] + if not key in self.universe.categories: + self.universe.categories[key] = {} + if self.data.has_option("__control__", "private_files"): + for item in makelist(self.data.get("__control__", "private_files")): if not item in includes: includes.append(item) - if not item in universe.private_files: + if not item in self.universe.private_files: if not isabs(item): - item = path_join(dirname(filename), item) - universe.private_files.append(item) + item = path_join(dirname(self.filename), item) + self.universe.private_files.append(item) for section in self.data.sections(): - if section != "control": - Element(section, universe, filename) + if section != "__control__": + Element(section, self.universe, self.filename) for include_file in includes: if not isabs(include_file): - include_file = path_join(dirname(filename), include_file) - DataFile(include_file, universe) + include_file = path_join(dirname(self.filename), include_file) + if include_file not in self.universe.files or not self.universe.files[include_file].is_writeable(): + DataFile(include_file, self.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(self.filename)) + """Write the data, if necessary.""" + + # when modified, writeable and has content or the file exists + if self.modified and self.is_writeable() and ( self.data.sections() or exists(self.filename) ): + + # make parent directories if necessary + if not exists(dirname(self.filename)): + makedirs(dirname(self.filename)) + + # our data file file_descriptor = file(self.filename, "w") - if self.filename in universe.private_files and oct(S_IMODE(stat(self.filename)[ST_MODE])) != 0600: + + # if it's marked private, chmod it appropriately + if self.filename in self.universe.private_files and oct(S_IMODE(stat(self.filename)[ST_MODE])) != 0600: chmod(self.filename, 0600) - self.data.write(file_descriptor) + + # write it back sorted, instead of using ConfigParser + sections = self.data.sections() + sections.sort() + for section in sections: + file_descriptor.write("[" + section + "]\n") + options = self.data.options(section) + options.sort() + for option in options: + file_descriptor.write(option + " = " + self.data.get(section, option) + "\n") + file_descriptor.write("\n") + + # flush and close the file file_descriptor.flush() file_descriptor.close() + # unset the modified flag + self.modified = False + def is_writeable(self): + """Returns True if the __control__ read_only is False.""" + return not self.data.has_option("__control__", "read_only") or not self.data.getboolean("__control__", "read_only") + class Universe: """The universe.""" + def __init__(self, filename=""): """Initialize the universe.""" self.categories = {} self.contents = {} self.default_origins = {} - self.files = {} self.private_files = [] + self.loglines = [] + self.pending_events_long = {} + self.pending_events_short = {} self.userlist = [] self.terminate_world = False self.reload_modules = False @@ -161,7 +430,46 @@ class Universe: if access(filename, R_OK): break if not isabs(filename): filename = abspath(filename) - DataFile(filename, self) + self.filename = filename + self.load() + + def load(self): + """Load universe data from persistent storage.""" + + # the files dict must exist and filename needs to be read-only + if not hasattr(self, "files") or not ( self.filename in self.files and self.files[self.filename].is_writeable() ): + + # clear out all read-only files + if hasattr(self, "files"): + for data_filename in self.files.keys(): + if not self.files[data_filename].is_writeable(): + del self.files[data_filename] + + # start loading from the initial file + DataFile(self.filename, self) + + # make a list of inactive avatars + inactive_avatars = [] + for account in self.categories["account"].values(): + inactive_avatars += [ (self.contents[x]) for x in account.getlist("avatars") ] + for user in self.userlist: + if user.avatar in inactive_avatars: + inactive_avatars.remove(user.avatar) + + # go through all elements to clear out inactive avatar locations + for element in self.contents.values(): + location = element.get("location") + if element in inactive_avatars and location: + if location in self.contents and element.key in self.contents[location].contents: + del self.contents[location].contents[element.key] + element.set("default_location", location) + element.remove_facet("location") + + # another pass to straighten out all the element contents + for element in self.contents.values(): + element.update_location() + element.clean_contents() + def save(self): """Save the universe to persistent storage.""" for key in self.files: self.files[key].save() @@ -178,7 +486,9 @@ class Universe: self.listening_socket.setsockopt(SOL_SOCKET, SO_REUSEADDR, 1) # bind the socket to to our desired server ipa and port - self.listening_socket.bind((self.categories["internal"]["network"].get("host"), self.categories["internal"]["network"].getint("port"))) + host = self.categories["internal"]["network"].get("host") + port = self.categories["internal"]["network"].getint("port") + self.listening_socket.bind((host, port)) # disable blocking so we can proceed whether or not we can # send/receive @@ -188,29 +498,36 @@ class Universe: self.listening_socket.listen(1) # note that we're now ready for user connections - log("Waiting for connection(s)...") + if not host: host = "0.0.0.0" + log("Listening for Telnet connections on: " + host + ":" + str(port)) + + def get_time(self): + """Convenience method to get the elapsed time counter.""" + return self.categories["internal"]["counters"].getint("elapsed") class User: """This is a connected user.""" def __init__(self): """Default values for the in-memory user variables.""" + self.account = None self.address = "" - self.last_address = "" - self.connection = None self.authenticated = False - self.password_tries = 0 - self.state = "initial" - self.menu_seen = False + self.avatar = None + self.connection = None + self.echoing = True self.error = "" self.input_queue = [] + self.last_address = "" + self.menu_choices = {} + self.menu_seen = False + self.negotiation_pause = 0 self.output_queue = [] self.partial_input = "" - self.echoing = True + self.password_tries = 0 + self.received_newline = True + self.state = "initial" self.terminator = IAC+GA - self.negotiation_pause = 0 - self.avatar = None - self.account = None def quit(self): """Log, close the connection and remove.""" @@ -219,7 +536,8 @@ class User: if name: message = "User " + name else: message = "An unnamed user" message += " logged out." - log(message) + log(message, 2) + self.deactivate_avatar() self.connection.close() self.remove() @@ -232,25 +550,13 @@ class User: # create a new user object new_user = User() - # set everything else equivalent - for attribute in [ - "address", - "last_address", - "connection", - "authenticated", - "password_tries", - "state", - "menu_seen", - "error", - "input_queue", - "output_queue", - "partial_input", - "echoing", - "avatar", - "account" - ]: + # set everything equivalent + for attribute in vars(self).keys(): exec("new_user." + attribute + " = self." + attribute) + # the avatar needs a new owner + if new_user.avatar: new_user.avatar.owner = new_user + # add it to the list universe.userlist.append(new_user) @@ -270,18 +576,21 @@ class User: if old_user.account.get("name") == self.account.get("name") and old_user is not self: # make a note of it - log("User " + self.account.get("name") + " reconnected--closing old connection to " + old_user.address + ".") - old_user.send("$(eol)$(red)New connection from " + self.address + ". Terminating old connection...$(nrm)$(eol)") - self.send("$(eol)$(red)Taking over old connection from " + old_user.address + ".$(nrm)") + log("User " + self.account.get("name") + " reconnected--closing old connection to " + old_user.address + ".", 2) + old_user.send("$(eol)$(red)New connection from " + self.address + ". Terminating old connection...$(nrm)$(eol)", flush=True, add_prompt=False) # close the old connection old_user.connection.close() # replace the old connection with this one + old_user.send("$(eol)$(red)Taking over old connection from " + old_user.address + ".$(nrm)") old_user.connection = self.connection old_user.last_address = old_user.address old_user.address = self.address - old_user.echoing = self.echoing + + # may need to tell the new connection to echo + if old_user.echoing: + old_user.send(get_echo_sequence(old_user.state, self.echoing), raw=True) # take this one out of the list and delete self.remove() @@ -295,8 +604,10 @@ class User: def authenticate(self): """Flag the user as authenticated and disconnect duplicates.""" if not self.state is "authenticated": - log("User " + self.account.get("name") + " logged in.") + log("User " + self.account.get("name") + " logged in.", 2) self.authenticated = True + if self.account.subkey in universe.categories["internal"]["limits"].getlist("default_admins"): + self.account.set("administrator", "True") def show_menu(self): """Send the user their current menu.""" @@ -316,12 +627,16 @@ class User: """Remove a user from the list of connected users.""" universe.userlist.remove(self) - def send(self, output, eol="$(eol)", raw=False): + def send(self, output, eol="$(eol)", raw=False, flush=False, add_prompt=True, just_prompt=False): """Send arbitrary text to a connected user.""" # unless raw mode is on, clean it up all nice and pretty if not raw: + # strip extra $(eol) off if present + while output.startswith("$(eol)"): output = output[6:] + while output.endswith("$(eol)"): output = output[:-6] + # we'll take out GA or EOR and add them back on the end if output.endswith(IAC+GA) or output.endswith(IAC+EOR): terminate = True @@ -331,7 +646,13 @@ class User: # start with a newline, append the message, then end # with the optional eol string passed to this function # and the ansi escape to return to normal text - output = "\r\n" + output + eol + chr(27) + "[0m" + if not just_prompt: output = "$(eol)$(eol)" + output + output += eol + chr(27) + "[0m" + + # tack on a prompt if active + if self.state == "active": + if not just_prompt: output += "$(eol)" + if add_prompt: output += "> " # find and replace macros in the output output = replace_macros(self, output) @@ -345,6 +666,9 @@ class User: # drop the output into the user's output queue self.output_queue.append(output) + # if this is urgent, flush all pending output + if flush: self.flush() + def pulse(self): """All the things to do to the user per increment.""" @@ -359,29 +683,33 @@ class User: else: self.state = "entering_account_name" # show the user a menu as needed - else: self.show_menu() + elif not self.state == "active": self.show_menu() + + # flush any pending output in teh queue + self.flush() # disconnect users with the appropriate state if self.state == "disconnecting": self.quit() - # the user is unique and not flagged to disconnect - else: - - # try to send the last item in the queue and remove it - if self.output_queue: - try: - self.connection.send(self.output_queue[0]) - del self.output_queue[0] + # check for input and add it to the queue + self.enqueue_input() - # but if we can't, that's okay too - except: - pass + # there is input waiting in the queue + if self.input_queue: handle_user_input(self) - # check for input and add it to the queue - self.enqueue_input() + def flush(self): + """Try to send the last item in the queue and remove it.""" + if self.output_queue: + if self.received_newline: + self.received_newline = False + if self.output_queue[0].startswith("\r\n"): + self.output_queue[0] = self.output_queue[0][2:] + try: + self.connection.send(self.output_queue[0]) + del self.output_queue[0] + except: + pass - # there is input waiting in the queue - if self.input_queue: handle_user_input(self) def enqueue_input(self): """Process and enqueue any new input.""" @@ -428,7 +756,7 @@ class User: if self.account and self.account.get("name"): logline += self.account.get("name") + ": " else: logline += "unknown user: " logline += repr(removed) - log(logline) + log(logline, 4) # filter out non-printables line = filter(lambda x: " " <= x <= "~", line) @@ -506,32 +834,13 @@ class User: # replace the input with our cleaned-up text self.partial_input = text - 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 while "avatar:" + self.account.get("name") + ":" + str(counter) in universe.categories["actor"].keys(): counter += 1 self.avatar = Element("actor:avatar:" + self.account.get("name") + ":" + str(counter), universe) - avatars = self.account.getlist("avatars") - avatars.append(self.avatar.key) - self.account.set("avatars", avatars) + self.avatar.append("inherit", "archetype:avatar") + self.account.append("avatars", self.avatar.key) def delete_avatar(self, avatar): """Remove an avatar from the world and from the user's list.""" @@ -541,6 +850,24 @@ class User: avatars.remove(avatar) self.account.set("avatars", avatars) + def activate_avatar_by_index(self, index): + """Enter the world with a particular indexed avatar.""" + self.avatar = universe.contents[self.account.getlist("avatars")[index]] + self.avatar.owner = self + self.state = "active" + self.avatar.go_home() + + def deactivate_avatar(self): + """Have the active avatar leave the world.""" + if self.avatar: + current = self.avatar.get("location") + self.avatar.set("default_location", current) + self.avatar.echo_to_location("You suddenly wonder where " + self.avatar.get("name") + " went.") + del universe.contents[current].contents[self.avatar.key] + self.avatar.remove_facet("location") + self.avatar.owner = None + self.avatar = None + def destroy(self): """Destroy the user and associated avatars.""" for avatar in self.account.getlist("avatars"): self.delete_avatar(avatar) @@ -550,6 +877,22 @@ class User: """List names of assigned avatars.""" return [ universe.contents[avatar].get("name") for avatar in self.account.getlist("avatars") ] +def create_pidfile(universe): + """Write a file containing the current process ID.""" + pid = str(getpid()) + log("Process ID: " + pid) + file_name = universe.contents["internal:process"].get("pidfile") + if file_name: + file_descriptor = file(file_name, 'w') + file_descriptor.write(pid + "\n") + file_descriptor.flush() + file_descriptor.close() + +def remove_pidfile(universe): + """Remove the file containing the current process ID.""" + file_name = universe.contents["internal:process"].get("pidfile") + if file_name and access(file_name, W_OK): remove(file_name) + def makelist(value): """Turn string into list type.""" if value[0] + value[-1] == "[]": return eval(value) @@ -561,23 +904,94 @@ def makedict(value): elif value.find(":") > 0: return eval("{" + value + "}") else: return { value: None } -def broadcast(message): +def broadcast(message, add_prompt=True): """Send a message to all connected users.""" - for each_user in universe.userlist: each_user.send("$(eol)" + message) + for each_user in universe.userlist: each_user.send("$(eol)" + message, add_prompt=add_prompt) -def log(message): +def log(message, level=0): """Log a message.""" - # the time in posix log timestamp format + # a couple references we need + file_name = universe.categories["internal"]["logging"].get("file") + max_log_lines = universe.categories["internal"]["logging"].getint("max_log_lines") + syslog_name = universe.categories["internal"]["logging"].get("syslog") timestamp = asctime()[4:19] - # send the timestamp and message to standard output - print(timestamp + " " + message) + # turn the message into a list of lines + lines = filter(lambda x: x!="", [(x.rstrip()) for x in message.split("\n")]) + + # send the timestamp and line to a file + if file_name: + file_descriptor = file(file_name, "a") + for line in lines: file_descriptor.write(timestamp + " " + line + "\n") + file_descriptor.flush() + file_descriptor.close() + + # send the timestamp and line to standard output + if universe.categories["internal"]["logging"].getboolean("stdout"): + for line in lines: print(timestamp + " " + line) + + # send the line to the system log + if syslog_name: + openlog(syslog_name, LOG_PID, LOG_INFO | LOG_DAEMON) + for line in lines: syslog(line) + closelog() + + # display to connected administrators + for user in universe.userlist: + if user.state == "active" and user.account.getboolean("administrator") and user.account.getint("loglevel") <= level: + # iterate over every line in the message + full_message = "" + for line in lines: + full_message += "$(bld)$(red)" + timestamp + " " + line + "$(nrm)$(eol)" + user.send(full_message, flush=True) + + # add to the recent log list + for line in lines: + while 0 < len(universe.loglines) >= max_log_lines: del universe.loglines[0] + universe.loglines.append((level, timestamp + " " + line)) + +def get_loglines(level, start, stop): + """Return a specific range of loglines filtered by level.""" + + # filter the log lines + loglines = filter(lambda x: x[0]>=level, universe.loglines) + + # we need these in several places + total_count = str(len(universe.loglines)) + filtered_count = len(loglines) + + # don't proceed if there are no lines + if filtered_count: + + # can't start before the begining or at the end + if start > filtered_count: start = filtered_count + if start < 1: start = 1 + + # can't stop before we start + if stop > start: stop = start + elif stop < 1: stop = 1 + + # some preamble + message = "There are " + str(total_count) + message += " log lines in memory and " + str(filtered_count) + message += " at or above level " + str(level) + "." + message += " The lines from " + str(stop) + " to " + str(start) + message += " are:$(eol)$(eol)" + + # add the text from the selected lines + if stop > 1: range_lines = loglines[-start:-(stop-1)] + else: range_lines = loglines[-start:] + for line in range_lines: + message += " (" + str(line[0]) + ") " + line[1] + "$(eol)" + + # there were no lines + else: + message = "None of the " + str(total_count) + message += " lines in memory matches your request." - # send the message to the system log - openlog("mudpy", LOG_PID, LOG_INFO | LOG_DAEMON) - syslog(message) - closelog() + # pass it back + return message def wrap_ansi_text(text, width): """Wrap text with arbitrary width while ignoring ANSI colors.""" @@ -706,8 +1120,12 @@ def replace_macros(user, text, is_input=False): "$(bld)": chr(27) + "[1m", "$(nrm)": chr(27) + "[0m", "$(blk)": chr(27) + "[30m", + "$(blu)": chr(27) + "[34m", + "$(cyn)": chr(27) + "[36m", "$(grn)": chr(27) + "[32m", + "$(mgt)": chr(27) + "[35m", "$(red)": chr(27) + "[31m", + "$(yel)": chr(27) + "[33m", } # add dynamic macros where possible @@ -734,7 +1152,7 @@ def replace_macros(user, text, is_input=False): else: text = text.replace(macro, "") if not is_input: - log("Unexpected replacement macro " + macro + " encountered.") + log("Unexpected replacement macro " + macro + " encountered.", 6) # replace the look-like-a-macro sequence text = text.replace("$_(", "$(") @@ -778,12 +1196,15 @@ def on_pulse(): # pause for a configurable amount of time (decimal seconds) sleep(universe.categories["internal"]["time"].getfloat("increment")) - # increment the elapsed increment counter + # increase the elapsed increment counter universe.categories["internal"]["counters"].set("elapsed", universe.categories["internal"]["counters"].getint("elapsed") + 1) def reload_data(): - """Reload data into new persistent objects.""" + """Reload all relevant objects.""" for user in universe.userlist[:]: user.reload() + for element in universe.contents.values(): + if element.origin.is_writeable(): element.reload() + universe.load() def check_for_connection(listening_socket): """Check for a waiting connection and return a new user object.""" @@ -795,7 +1216,7 @@ def check_for_connection(listening_socket): return None # note that we got one - log("Connection from " + address[0]) + log("Connection from " + address[0], 2) # disable blocking so we can proceed whether or not we can send/receive connection.setblocking(0) @@ -992,7 +1413,7 @@ def handle_user_input(user): user.menu_seen = False # if the user's client echo is off, send a blank line for aesthetics - if not user.echoing: user.send("", "") + if user.echoing: user.received_newline = True def generic_menu_handler(user): """A generic menu choice handler.""" @@ -1034,7 +1455,7 @@ def handler_entering_account_name(user): else: user.account = Element("account:" + name, universe) user.account.set("name", name) - log("New user: " + name) + log("New user: " + name, 2) user.state = "checking_new_account_name" # if the user entered nothing for a name, then buhbye @@ -1122,56 +1543,71 @@ def handler_active(user): # get the next waiting line of input input_data = user.input_queue.pop(0) - # split out the command (first word) and parameters (everything else) - if input_data.find(" ") > 0: - command_name, parameters = input_data.split(" ", 1) - else: - command_name = input_data - parameters = "" + # is there input? + if input_data: - # lowercase the command - command_name = command_name.lower() + # split out the command (first word) and parameters (everything else) + if input_data.find(" ") > 0: + command_name, parameters = input_data.split(" ", 1) + else: + command_name = input_data + parameters = "" - # the command matches a command word for which we have data - if command_name in universe.categories["command"]: - command = universe.categories["command"][command_name] - else: command = None + # lowercase the command + command_name = command_name.lower() - # if it's allowed, do it - if user.can_run(command): exec(command.get("action")) + # the command matches a command word for which we have data + if command_name in universe.categories["command"]: + command = universe.categories["command"][command_name] + else: command = None + + # if it's allowed, do it + actor = user.avatar + if actor.can_run(command): exec(command.get("action")) - # otherwise, give an error - elif command_name: command_error(user, input_data) + # otherwise, give an error + elif command_name: command_error(actor, input_data) -def command_halt(user, parameters): + # if no input, just idle back with a prompt + else: user.send("", just_prompt=True) + +def command_halt(actor, parameters): """Halt the world.""" + if actor.owner: - # see if there's a message or use a generic one - if parameters: message = "Halting: " + parameters - else: message = "User " + user.account.get("name") + " halted the world." + # see if there's a message or use a generic one + if parameters: message = "Halting: " + parameters + else: message = "User " + actor.owner.account.get("name") + " halted the world." - # let everyone know - broadcast(message) - log(message) + # let everyone know + broadcast(message, add_prompt=False) + log(message, 8) - # set a flag to terminate the world - universe.terminate_world = True + # set a flag to terminate the world + universe.terminate_world = True -def command_reload(user): +def command_reload(actor): """Reload all code modules, configs and data.""" + if actor.owner: + + # let the user know and log + actor.send("Reloading all code modules, configs and data.") + log("User " + actor.owner.account.get("name") + " reloaded the world.", 8) - # let the user know and log - user.send("Reloading all code modules, configs and data.") - log("User " + user.account.get("name") + " reloaded the world.") + # set a flag to reload + universe.reload_modules = True - # set a flag to reload - universe.reload_modules = True +def command_quit(actor): + """Leave the world and go back to the main menu.""" + if actor.owner: + actor.owner.state = "main_utility" + actor.owner.deactivate_avatar() -def command_help(user, parameters): +def command_help(actor, parameters): """List available commands and provide help for commands.""" # did the user ask for help on a specific command word? - if parameters: + if parameters and actor.owner: # is the command word one for which we have data? if parameters in universe.categories["command"]: @@ -1179,7 +1615,7 @@ def command_help(user, parameters): else: command = None # only for allowed commands - if user.can_run(command): + if actor.can_run(command): # add a description if provided description = command.get("description") @@ -1208,7 +1644,7 @@ def command_help(user, parameters): sorted_commands.sort() for item in sorted_commands: command = universe.categories["command"][item] - if user.can_run(command): + if actor.can_run(command): description = command.get("description") if not description: description = "(no short description provided)" @@ -1218,21 +1654,33 @@ def command_help(user, parameters): output += "$(eol)Enter \"help COMMAND\" for help on a command named \"COMMAND\"." # send the accumulated output to the user - user.send(output) + actor.send(output) -def command_say(user, parameters): +def command_move(actor, parameters): + """Move the avatar in a given direction.""" + if parameters in universe.contents[actor.get("location")].portals(): + actor.move_direction(parameters) + else: actor.send("You cannot go that way.") + +def command_look(actor, parameters): + """Look around.""" + if parameters: actor.send("You can't look at or in anything yet.") + else: actor.look_at(actor.get("location")) + +def command_say(actor, parameters): """Speak to others in the same room.""" # check for replacement macros - if replace_macros(user, parameters, True) != parameters: - user.send("You cannot speak $_(replacement macros).") + if replace_macros(actor.owner, parameters, True) != parameters: + actor.send("You cannot speak $_(replacement macros).") # the user entered a message elif parameters: # get rid of quote marks on the ends of the message and # capitalize the first letter - message = parameters.strip("\"'`").capitalize() + message = parameters.strip("\"'`") + message = message[0].capitalize() + message[1:] # a dictionary of punctuation:action pairs actions = {} @@ -1260,55 +1708,94 @@ def command_say(user, parameters): message = message.replace(" " + word + " ", " " + word.capitalize() + " ") # tell the room - # TODO: we won't be using broadcast once there are actual rooms - broadcast(user.avatar.get("name") + " " + action + "s, \"" + message + "\"") + actor.echo_to_location(actor.get("name") + " " + action + "s, \"" + message + "\"") + actor.send("You " + action + ", \"" + message + "\"") # there was no message else: - user.send("What do you want to say?") + actor.send("What do you want to say?") -def command_show(user, parameters): +def command_show(actor, parameters): """Show program data.""" 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): + arguments = parameters.split() + if not parameters: message = "What do you want to show?" + elif arguments[0] == "time": + message = universe.categories["internal"]["counters"].get("elapsed") + " increments elapsed since the world was created." + elif arguments[0] == "categories": + message = "These are the element categories:$(eol)" + categories = universe.categories.keys() + categories.sort() + for category in categories: message += "$(eol) $(grn)" + category + "$(nrm)" + elif arguments[0] == "files": + message = "These are the current files containing the universe:$(eol)" + filenames = universe.files.keys() + filenames.sort() + for filename in filenames: + if universe.files[filename].is_writeable(): status = "rw" + else: status = "ro" + message += "$(eol) $(red)(" + status + ") $(grn)" + filename + "$(nrm)" + elif arguments[0] == "category": + if len(arguments) != 2: message = "You must specify one category." + elif arguments[1] in universe.categories: + message = "These are the elements in the \"" + arguments[1] + "\" category:$(eol)" + elements = [(universe.categories[arguments[1]][x].key) for x in universe.categories[arguments[1]].keys()] + elements.sort() + for element in elements: + message += "$(eol) $(grn)" + element + "$(nrm)" + else: message = "Category \"" + arguments[1] + "\" does not exist." + elif arguments[0] == "file": + if len(arguments) != 2: message = "You must specify one file." + elif arguments[1] in universe.files: + message = "These are the elements in the \"" + arguments[1] + "\" file:$(eol)" + elements = universe.files[arguments[1]].data.sections() + elements.sort() + for element in elements: + message += "$(eol) $(grn)" + element + "$(nrm)" + else: message = "Category \"" + arguments[1] + "\" does not exist." + elif arguments[0] == "element": + if len(arguments) != 2: message = "You must specify one element." + elif arguments[1] in universe.contents: + element = universe.contents[arguments[1]] + message = "These are the properties of the \"" + arguments[1] + "\" element (in \"" + element.origin.filename + "\"):$(eol)" + facets = element.facets() + facets.sort() + for facet in facets: + message += "$(eol) $(grn)" + facet + ": $(red)" + escape_macros(element.get(facet)) + "$(nrm)" + else: message = "Element \"" + arguments[1] + "\" does not exist." + elif arguments[0] == "result": + if len(arguments) < 2: message = "You need to specify an expression." + else: + try: + message = repr(eval(" ".join(arguments[1:]))) + except: + message = "Your expression raised an exception!" + elif arguments[0] == "log": + if len(arguments) == 4: + if match("^\d+$", arguments[3]) and int(arguments[3]) >= 0: + stop = int(arguments[3]) + else: stop = -1 + else: stop = 0 + if len(arguments) >= 3: + if match("^\d+$", arguments[2]) and int(arguments[2]) > 0: + start = int(arguments[2]) + else: start = -1 + else: start = 10 + if len(arguments) >= 2: + if match("^\d+$", arguments[1]) and 0 <= int(arguments[1]) <= 9: + level = int(arguments[1]) + else: level = -1 + else: level = 1 + if level > -1 and start > -1 and stop > -1: + message = get_loglines(level, start, stop) + else: message = "When specified, level must be 0-9 (default 1), start and stop must be >=1 (default 10 and 1)." + else: message = "I don't know what \"" + parameters + "\" is." + actor.send(message) + +def command_create(actor, parameters): """Create an element if it does not exist.""" if not parameters: message = "You must at least specify an element to create." + elif not actor.owner: message = "" else: arguments = parameters.split() if len(arguments) == 1: arguments.append("") @@ -1317,28 +1804,29 @@ def command_create(user, parameters): 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 + logline = actor.owner.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) + log(logline, 6) elif len(arguments) > 2: message = "You can only specify an element and a filename." - user.send(message) + actor.send(message) -def command_destroy(user, parameters): +def command_destroy(actor, 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." + if actor.owner: + if not parameters: message = "You must specify an element to destroy." else: - universe.contents[parameters].destroy() - message = "You destroy \"" + parameters + "\" within the universe." - log(user.account.get("name") + " destroyed an element: " + parameters) - user.send(message) + 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(actor.owner.account.get("name") + " destroyed an element: " + parameters, 6) + actor.send(message) -def command_set(user, parameters): +def command_set(actor, parameters): """Set a facet of an element.""" if not parameters: message = "You must specify an element, a facet and a value." else: @@ -1351,9 +1839,9 @@ def command_set(user, parameters): 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) + actor.send(message) -def command_delete(user, parameters): +def command_delete(actor, parameters): """Delete a facet from an element.""" if not parameters: message = "You must specify an element and a facet." else: @@ -1365,11 +1853,11 @@ def command_delete(user, parameters): 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) + universe.contents[element].remove_facet(facet) message = "You have successfully deleted the \"" + facet + "\" facet of element \"" + element + "\". Try \"show element " + element + "\" for verification." - user.send(message) + actor.send(message) -def command_error(user, input_data): +def command_error(actor, input_data): """Generic error for an unrecognized command word.""" # 90% of the time use a generic error @@ -1381,7 +1869,18 @@ def command_error(user, input_data): message = "Arglebargle, glop-glyf!?!" # send the error message - user.send(message) + actor.send(message) + +def daemonize(): + """Fork and disassociate from everything.""" + if universe.contents["internal:process"].getboolean("daemon"): + import sys + log("Disassociating from the controlling terminal.") + if fork(): _exit(0) + setsid() + for stdpipe in range(3): close(stdpipe) + sys.stdin = sys.__stdin__ = file("/dev/null", "r") + sys.stdout = sys.stderr = sys.__stdout__ = sys.__stderr__ = file("/dev/null", "w") # if there is no universe, create an empty one if not "universe" in locals(): universe = Universe()