X-Git-Url: https://mudpy.org/gitweb?a=blobdiff_plain;f=lib%2Fmudpy%2Fmisc.py;h=42d14c8a10a5e611fb9370ab4945bf15eadb14b5;hb=0a25cf895fa70fedf64131d284cfff19251b3d46;hp=1bef3f3911db912af32ba50dd67c9ba0ff7414d6;hpb=024e5dcea9411e8e0f8b5dc60c0d887259ded6c1;p=mudpy.git diff --git a/lib/mudpy/misc.py b/lib/mudpy/misc.py index 1bef3f3..42d14c8 100644 --- a/lib/mudpy/misc.py +++ b/lib/mudpy/misc.py @@ -1,10 +1,24 @@ # -*- coding: utf-8 -*- """Miscellaneous functions for the mudpy engine.""" -# Copyright (c) 2004-2012 Jeremy Stanley . Permission +# Copyright (c) 2004-2014 Jeremy Stanley . Permission # to use, copy, modify, and distribute this software is granted under # terms provided in the LICENSE file distributed with this software. +import codecs +import os +import random +import re +import signal +import socket +import sys +import syslog +import time +import traceback +import unicodedata + +import mudpy + class Element: @@ -12,8 +26,6 @@ class Element: def __init__(self, key, universe, filename=None): """Set up a new element.""" - import mudpy.data - import os.path # keep track of our key name self.key = key @@ -71,7 +83,7 @@ class Element: def reload(self): """Create a new element and replace this one.""" - new_element = Element(self.key, self.universe, self.origin.filename) + Element(self.key, self.universe, self.origin.filename) del(self) def destroy(self): @@ -142,7 +154,7 @@ class Element: return default def getint(self, facet, default=None): - """Return values as int/long type.""" + """Return values as int type.""" if default is None: default = 0 if self.origin.data.has_option(self.key, facet): @@ -169,7 +181,6 @@ class Element: def getlist(self, facet, default=None): """Return values as list type.""" - import mudpy.data if default is None: default = [] value = self.get(facet) @@ -180,7 +191,6 @@ class Element: def getdict(self, facet, default=None): """Return values as dict type.""" - import mudpy.data if default is None: default = {} value = self.get(facet) @@ -192,33 +202,19 @@ class Element: def set(self, facet, value): """Set values.""" if not self.has_facet(facet) or not self.get(facet) == value: - if type(value) is long or repr(type(value)) == "": - value = str(value) - elif not type(value) is str: + if 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: + """Append value to a list.""" + if not type(value) is str: value = repr(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, @@ -350,7 +346,7 @@ class Element: description = element.get("description") if description: message += description + "$(eol)" - portal_list = element.portals().keys() + portal_list = list(element.portals().keys()) if portal_list: portal_list.sort() message += "$(cyn)[ Exits: " + ", ".join( @@ -371,7 +367,6 @@ class Element: def portals(self): """Map the portal directions for a room to neighbors.""" - import re portals = {} if re.match("""^location:-?\d+,-?\d+,-?\d+$""", self.key): coordinates = [(int(x)) @@ -421,14 +416,10 @@ class Universe: def __init__(self, filename="", load=False): """Initialize the universe.""" - import os - import os.path self.categories = {} self.contents = {} self.default_origins = {} self.loglines = [] - self.pending_events_long = {} - self.pending_events_short = {} self.private_files = [] self.reload_flag = False self.startdir = os.getcwd() @@ -457,7 +448,6 @@ class Universe: def load(self): """Load universe data from persistent storage.""" - import mudpy.data # the files dict must exist and filename needs to be read-only if not hasattr( @@ -470,7 +460,7 @@ class Universe: # clear out all read-only files if hasattr(self, "files"): - for data_filename in self.files.keys(): + for data_filename in list(self.files.keys()): if not self.files[data_filename].is_writeable(): del self.files[data_filename] @@ -519,7 +509,6 @@ class Universe: def initialize_server_socket(self): """Create and open the listening socket.""" - import socket # need to know the local address and port number for the listener host = self.categories["internal"]["network"].get("host") @@ -575,7 +564,6 @@ class User: def __init__(self): """Default values for the in-memory user variables.""" - import mudpy.telnet self.account = None self.address = "" self.authenticated = False @@ -590,7 +578,7 @@ class User: self.menu_seen = False self.negotiation_pause = 0 self.output_queue = [] - self.partial_input = "" + self.partial_input = b"" self.password_tries = 0 self.state = "initial" self.telopts = {} @@ -633,8 +621,8 @@ class User: logline += self.account.get("name") else: logline += "an unknown user" - logline += " after idling too long in the " + \ - self.state + " state." + logline += (" after idling too long in the " + self.state + + " state.") log(logline, 2) self.state = "disconnecting" self.menu_seen = False @@ -755,7 +743,6 @@ class User: def adjust_echoing(self): """Adjust echoing to match state menu requirements.""" - import mudpy.telnet if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_ECHO, mudpy.telnet.US): if menu_echo_on(self.state): @@ -781,7 +768,6 @@ class User: prepend_padding=True ): """Send arbitrary text to a connected user.""" - import mudpy.telnet # unless raw mode is on, clean it up all nice and pretty if not raw: @@ -800,16 +786,16 @@ class User: # with the optional eol string passed to this function # and the ansi escape to return to normal text if not just_prompt and prepend_padding: - if not self.output_queue \ - or not self.output_queue[-1].endswith("\r\n"): + if (not self.output_queue or not + self.output_queue[-1].endswith(b"\r\n")): output = "$(eol)" + output elif not self.output_queue[-1].endswith( - "\r\n\x1b[0m\r\n" + b"\r\n\x1b[0m\r\n" ) and not self.output_queue[-1].endswith( - "\r\n\r\n" + b"\r\n\r\n" ): output = "$(eol)" + output - output += eol + unichr(27) + "[0m" + output += eol + chr(27) + "[0m" # tack on a prompt if active if self.state == "active": @@ -918,14 +904,12 @@ class User: def enqueue_input(self): """Process and enqueue any new input.""" - import mudpy.telnet - import unicodedata # check for some input try: raw_input = self.connection.recv(1024) except: - raw_input = "" + raw_input = b"" # we got something if raw_input: @@ -937,18 +921,18 @@ class User: mudpy.telnet.negotiate_telnet_options(self) # separate multiple input lines - new_input_lines = self.partial_input.split("\n") + new_input_lines = self.partial_input.split(b"\n") # if input doesn't end in a newline, replace the # held partial input with the last line of it - if not self.partial_input.endswith("\n"): + if not self.partial_input.endswith(b"\n"): self.partial_input = new_input_lines.pop() # otherwise, chop off the extra null input and reset # the held partial input else: new_input_lines.pop() - self.partial_input = "" + self.partial_input = b"" # iterate over the remaining lines for line in new_input_lines: @@ -959,7 +943,8 @@ class User: # log non-printable characters remaining if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_BINARY, mudpy.telnet.HIM): - asciiline = filter(lambda x: " " <= x <= "~", line) + asciiline = b"".join( + filter(lambda x: b" " <= x <= b"~", line)) if line != asciiline: logline = "Non-ASCII characters from " if self.account and self.account.get("name"): @@ -970,10 +955,22 @@ class User: log(logline, 4) line = asciiline + try: + line = line.decode("utf-8") + except UnicodeDecodeError: + logline = "Non-UTF-8 characters from " + if self.account and self.account.get("name"): + logline += self.account.get("name") + ": " + else: + logline += "unknown user: " + logline += repr(line) + log(logline, 4) + return + + line = unicodedata.normalize("NFKC", line) + # put on the end of the queue - self.input_queue.append( - unicodedata.normalize("NFKC", line.decode("utf-8")) - ) + self.input_queue.append(line) def new_avatar(self): """Instantiate a new, unconfigured avatar for this user.""" @@ -1047,10 +1044,6 @@ def broadcast(message, add_prompt=True): def log(message, level=0): """Log a message.""" - import codecs - import os.path - import syslog - import time # a couple references we need file_name = universe.categories["internal"]["logging"].get("file") @@ -1164,7 +1157,6 @@ def get_loglines(level, start, stop): def glyph_columns(character): """Convenience function to return the column width of a glyph.""" - import unicodedata if unicodedata.east_asian_width(character) in "FW": return 2 else: @@ -1173,7 +1165,6 @@ def glyph_columns(character): def wrap_ansi_text(text, width): """Wrap text with arbitrary width while ignoring ANSI colors.""" - import unicodedata # the current position in the entire text string, including all # characters, printable or otherwise @@ -1230,8 +1221,7 @@ def wrap_ansi_text(text, width): last_whitespace = abs_pos # insert an eol in place of the space - text = text[:last_whitespace] + \ - "\r\n" + text[last_whitespace + 1:] + text = text[:last_whitespace] + "\r\n" + text[last_whitespace + 1:] # increase the absolute position because an eol is two # characters but the space it replaced was only one @@ -1260,7 +1250,6 @@ def wrap_ansi_text(text, width): def weighted_choice(data): """Takes a dict weighted by value and returns a random key.""" - import random # this will hold our expanded list of keys from the data expanded = [] @@ -1276,7 +1265,6 @@ def weighted_choice(data): def random_name(): """Returns a random character name.""" - import random # the vowels and consonants needed to create romaji syllables vowels = [ @@ -1328,9 +1316,6 @@ def random_name(): def replace_macros(user, text, is_input=False): """Replaces macros in text output.""" - import codecs - import mudpy.data - import os.path # third person pronouns pronouns = { @@ -1342,15 +1327,15 @@ def replace_macros(user, text, is_input=False): # a dict of replacement macros macros = { "eol": "\r\n", - "bld": unichr(27) + "[1m", - "nrm": unichr(27) + "[0m", - "blk": unichr(27) + "[30m", - "blu": unichr(27) + "[34m", - "cyn": unichr(27) + "[36m", - "grn": unichr(27) + "[32m", - "mgt": unichr(27) + "[35m", - "red": unichr(27) + "[31m", - "yel": unichr(27) + "[33m", + "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 @@ -1427,7 +1412,6 @@ def first_word(text, separator=" "): def on_pulse(): """The things which should happen on each pulse, aside from reloads.""" - import time # open the listening socket if it hasn't been already if not hasattr(universe, "listening_socket"): @@ -1502,7 +1486,6 @@ def reload_data(): def check_for_connection(listening_socket): """Check for a waiting connection and return a new user object.""" - import mudpy.telnet # try to accept a new connection try: @@ -1652,7 +1635,7 @@ def get_menu_choices(user): def get_formatted_menu_choices(state, choices): """Returns a formatted string of menu choices.""" choice_output = "" - choice_keys = choices.keys() + choice_keys = list(choices.keys()) choice_keys.sort() for choice in choice_keys: choice_output += " [$(red)" + choice + "$(nrm)] " + choices[ @@ -1719,7 +1702,6 @@ def get_choice_action(user, choice): def handle_user_input(user): """The main handler, branches to a state-specific handler.""" - import mudpy.telnet # if the user's client echo is off, send a blank line for aesthetics if mudpy.telnet.is_enabled(user, mudpy.telnet.TELOPT_ECHO, @@ -1773,9 +1755,9 @@ def handler_entering_account_name(user): name = input_data.lower() # fail if there are non-alphanumeric characters - if name != filter( - lambda x: x >= "0" and x <= "9" or x >= "a" and x <= "z", name - ): + if name != "".join(filter( + lambda x: x >= "0" and x <= "9" or x >= "a" and x <= "z", + name)): user.error = "bad_name" # if that account exists, time to request a password @@ -1797,7 +1779,6 @@ def handler_entering_account_name(user): def handler_checking_password(user): """Handle the login account password.""" - import mudpy.password # get the next waiting line of input input_data = user.input_queue.pop(0) @@ -1831,7 +1812,6 @@ def handler_checking_password(user): def handler_entering_new_password(user): """Handle a new password entry.""" - import mudpy.password # get the next waiting line of input input_data = user.input_queue.pop(0) @@ -1839,11 +1819,11 @@ def handler_entering_new_password(user): # make sure the password is strong--at least one upper, one lower and # one digit, seven or more characters in length if len(input_data) > 6 and len( - filter(lambda x: x >= "0" and x <= "9", input_data) + list(filter(lambda x: x >= "0" and x <= "9", input_data)) ) and len( - filter(lambda x: x >= "A" and x <= "Z", input_data) + list(filter(lambda x: x >= "A" and x <= "Z", input_data)) ) and len( - filter(lambda x: x >= "a" and x <= "z", input_data) + list(filter(lambda x: x >= "a" and x <= "z", input_data)) ): # hash and store it, then move on to verification @@ -1872,7 +1852,6 @@ def handler_entering_new_password(user): def handler_verifying_new_password(user): """Handle the re-entered new password for verification.""" - import mudpy.password # get the next waiting line of input input_data = user.input_queue.pop(0) @@ -2050,7 +2029,7 @@ def command_help(actor, parameters): # give a sorted list of commands with descriptions if provided output = "These are the commands available to you:$(eol)$(eol)" - sorted_commands = universe.categories["command"].keys() + sorted_commands = list(universe.categories["command"].keys()) sorted_commands.sort() for item in sorted_commands: command = universe.categories["command"][item] @@ -2063,8 +2042,8 @@ def command_help(actor, parameters): else: output += " $(grn)" output += item + "$(nrm) - " + description + "$(eol)" - output += "$(eol)Enter \"help COMMAND\" for help on a command " \ - + "named \"COMMAND\"." + output += ("$(eol)Enter \"help COMMAND\" for help on a command " + "named \"COMMAND\".") # send the accumulated output to the user actor.send(output) @@ -2088,7 +2067,6 @@ def command_look(actor, parameters): def command_say(actor, parameters): """Speak to others in the same room.""" - import unicodedata # check for replacement macros and escape them parameters = escape_macros(parameters) @@ -2179,7 +2157,6 @@ def command_chat(actor): def command_show(actor, parameters): """Show program data.""" - import re message = "" arguments = parameters.split() if not parameters: @@ -2190,27 +2167,27 @@ def command_show(actor, parameters): ) + " increments elapsed since the world was created." elif arguments[0] == "categories": message = "These are the element categories:$(eol)" - categories = universe.categories.keys() + categories = list(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 = list(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)" + 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)" + message = ("These are the elements in the \"" + arguments[1] + + "\" category:$(eol)") elements = [ ( universe.categories[arguments[1]][x].key @@ -2225,8 +2202,8 @@ def command_show(actor, parameters): 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)" + message = ("These are the elements in the \"" + arguments[1] + + "\" file:$(eol)") elements = universe.files[arguments[1]].data.sections() elements.sort() for element in elements: @@ -2238,15 +2215,14 @@ def command_show(actor, parameters): 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)" + 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)" + message += ("$(eol) $(grn)" + facet + ": $(red)" + + escape_macros(element.get(facet)) + "$(nrm)") else: message = "Element \"" + arguments[1] + "\" does not exist." elif arguments[0] == "result": @@ -2285,8 +2261,8 @@ def command_show(actor, parameters): 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)." + 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) @@ -2307,18 +2283,18 @@ def command_create(actor, parameters): if element in universe.contents: message = "The \"" + element + "\" element already exists." else: - message = "You create \"" + \ - element + "\" within the universe." + message = ("You create \"" + + element + "\" within the universe.") 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." + 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, 6) elif len(arguments) > 2: @@ -2333,12 +2309,11 @@ def command_destroy(actor, parameters): message = "You must specify an element to destroy." else: if parameters not in universe.contents: - message = "The \"" + parameters + \ - "\" element does not exist." + message = "The \"" + parameters + "\" element does not exist." else: universe.contents[parameters].destroy() - message = "You destroy \"" + parameters \ - + "\" within the universe." + message = ("You destroy \"" + parameters + + "\" within the universe.") log( actor.owner.account.get( "name" @@ -2355,22 +2330,22 @@ def command_set(actor, parameters): else: arguments = parameters.split(" ", 2) if len(arguments) == 1: - message = "What facet of element \"" + arguments[0] \ - + "\" would you like to set?" + 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?" + 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." + message = ("You have successfully (re)set the \"" + facet + + "\" facet of element \"" + element + + "\". Try \"show element " + + element + "\" for verification.") actor.send(message) @@ -2381,8 +2356,8 @@ def command_delete(actor, parameters): else: arguments = parameters.split(" ") if len(arguments) == 1: - message = "What facet of element \"" + arguments[0] \ - + "\" would you like to delete?" + 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: @@ -2390,20 +2365,19 @@ def command_delete(actor, 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." + message = ("The \"" + element + "\" element has no \"" + facet + + "\" facet.") else: universe.contents[element].remove_facet(facet) - message = "You have successfully deleted the \"" + facet \ - + "\" facet of element \"" + element \ - + "\". Try \"show element " + \ - element + "\" for verification." + message = ("You have successfully deleted the \"" + facet + + "\" facet of element \"" + element + + "\". Try \"show element " + + element + "\" for verification.") actor.send(message) def command_error(actor, input_data): """Generic error for an unrecognized command word.""" - import random # 90% of the time use a generic error if random.randrange(10): @@ -2419,59 +2393,10 @@ def command_error(actor, input_data): def daemonize(universe): """Fork and disassociate from everything.""" - import codecs - import ctypes - import ctypes.util - import os - import os.path - import sys # only if this is what we're configured to do if universe.contents["internal:process"].getboolean("daemon"): - # if possible, we want to rename the process to the same as the script - # (these will need to be byte type during 2to3 migration) - new_argv = "\0".join(sys.argv) + "\0" - new_short_argv0 = os.path.basename(sys.argv[0]) + "\0" - - # attempt the linux way first - try: - argv_array = ctypes.POINTER(ctypes.c_char_p) - ctypes.pythonapi.Py_GetArgcArgv.argtypes = ( - ctypes.POINTER(ctypes.c_int), - ctypes.POINTER(argv_array) - ) - argc = argv_array() - ctypes.pythonapi.Py_GetArgcArgv( - ctypes.c_int(0), - ctypes.pointer(argc) - ) - old_argv0_size = len(argc.contents.value) - ctypes.memset(argc.contents, 0, len(new_argv) + old_argv0_size) - ctypes.memmove(argc.contents, new_argv, len(new_argv)) - ctypes.CDLL(ctypes.util.find_library("c")).prctl( - 15, - new_short_argv0, - 0, - 0, - 0 - ) - - except: - - # since that failed, maybe it's bsd? - try: - - # much simpler, since bsd has a libc function call for this - ctypes.CDLL(ctypes.util.find_library("c")).setproctitle( - new_argv - ) - - except: - - # that didn't work either, so just log that we couldn't - log("Failed to rename the interpreter process (cosmetic).") - # log before we start forking around, so the terminal gets the message log("Disassociating from the controlling terminal.") @@ -2505,9 +2430,6 @@ def daemonize(universe): def create_pidfile(universe): """Write a file containing the current process ID.""" - import codecs - import os - import os.path pid = str(os.getpid()) log("Process ID: " + pid) file_name = universe.contents["internal:process"].get("pidfile") @@ -2522,8 +2444,6 @@ def create_pidfile(universe): def remove_pidfile(universe): """Remove the file containing the current process ID.""" - import os - import os.path file_name = universe.contents["internal:process"].get("pidfile") if file_name: if not os.path.isabs(file_name): @@ -2534,7 +2454,6 @@ def remove_pidfile(universe): def excepthook(excepttype, value, tracebackdata): """Handle uncaught exceptions.""" - import traceback # assemble the list of errors into a single string message = "".join( @@ -2556,7 +2475,6 @@ def excepthook(excepttype, value, tracebackdata): def sighook(what, where): """Handle external signals.""" - import signal # a generic message message = "Caught signal: " @@ -2581,20 +2499,17 @@ def sighook(what, where): def override_excepthook(): """Redefine sys.excepthook with our own.""" - import sys sys.excepthook = excepthook def assign_sighook(): """Assign a customized handler for some signals.""" - import signal signal.signal(signal.SIGHUP, sighook) signal.signal(signal.SIGTERM, sighook) def setup(): """This contains functions to be performed when starting the engine.""" - import sys # see if a configuration file was specified if len(sys.argv) > 1: @@ -2626,8 +2541,7 @@ def setup(): def finish(): - """This contains functions to be performed when shutting down the - engine.""" + """These are functions performed when shutting down the engine.""" # the loop has terminated, so save persistent data universe.save()