"""Miscellaneous functions for the mudpy engine."""
-# Copyright (c) 2004-2017 Jeremy Stanley <fungi@yuggoth.org>. Permission
+# Copyright (c) 2004-2018 Jeremy Stanley <fungi@yuggoth.org>. Permission
# to use, copy, modify, and distribute this software is granted under
# terms provided in the LICENSE file distributed with this software.
self.contents = {}
if self.key.find(".") > 0:
- self.category, self.subkey = self.key.split(".")[-2:]
+ self.group, self.subkey = self.key.split(".")[-2:]
else:
- self.category = "other"
+ self.group = "other"
self.subkey = self.key
- if self.category not in self.universe.categories:
- self.universe.categories[self.category] = {}
+ if self.group not in self.universe.groups:
+ self.universe.groups[self.group] = {}
# get an appropriate origin
if not origin:
- self.universe.add_category(self.category)
+ self.universe.add_group(self.group)
origin = self.universe.files[
- self.universe.origins[self.category]["fallback"]]
+ self.universe.origins[self.group]["fallback"]]
# record or reset a pointer to the origin file
self.origin = self.universe.files[origin.source]
# add or replace this element in the universe
self.universe.contents[self.key] = self
- self.universe.categories[self.category][self.subkey] = self
+ self.universe.groups[self.group][self.subkey] = self
def reload(self):
"""Create a new element and replace this one."""
"""Remove an element from the universe and destroy it."""
for facet in dict(self.facethash):
self.remove_facet(facet)
- del self.universe.categories[self.category][self.subkey]
+ del self.universe.groups[self.group][self.subkey]
del self.universe.contents[self.key]
del self
# updated data from files
raise PermissionError("Altering elements in read-only files is "
"disallowed")
+ # Coerce some values to appropriate data types
+ # TODO(fungi) Move these to a separate validation mechanism
if facet in ["loglevel"]:
value = int(value)
elif facet in ["administrator"]:
value = bool(value)
- if not self.has_facet(facet) or not self.get(facet) == value:
- node = ".".join((self.key, facet))
+
+ # The canonical node for this facet within its origin
+ node = ".".join((self.key, facet))
+
+ if node not in self.origin.data or self.origin.data[node] != value:
+ # Be careful to only update the origin's contents when required,
+ # since that affects whether the backing file gets written
self.origin.data[node] = value
- self.facethash[facet] = self.origin.data[node]
self.origin.modified = True
+ # Make sure this facet is included in the element's facets
+ self.facethash[facet] = self.origin.data[node]
+
def append(self, facet, value):
"""Append value to a list."""
newlist = self.get(facet)
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():
+ # has to be in the commands group
+ if command not in self.universe.groups["command"].values():
result = False
# avatars of administrators can run any command
def __init__(self, filename="", load=False):
"""Initialize the universe."""
- self.categories = {}
+ self.groups = {}
self.contents = {}
self.directions = set()
self.loading = False
self.startdir = os.getcwd()
self.terminate_flag = False
self.userlist = []
+ self.versions = None
if not filename:
possible_filenames = [
"etc/mudpy.yaml",
# start loading from the initial file
mudpy.data.Data(self.filename, self)
- # load default storage locations for categories
+ # load default storage locations for groups
if hasattr(self, "contents") and "mudpy.filing" in self.contents:
self.origins.update(self.contents["mudpy.filing"].get(
- "categories", {}))
+ "groups", {}))
- # add some builtin categories we know we'll need
- for category in ("account", "actor", "internal"):
- self.add_category(category)
+ # add some builtin groups we know we'll need
+ for group in ("account", "actor", "internal"):
+ self.add_group(group)
# make a list of inactive avatars
inactive_avatars = []
- for account in self.categories.get("account", {}).values():
+ for account in self.groups.get("account", {}).values():
for avatar in account.get("avatars"):
try:
inactive_avatars.append(self.contents[avatar])
def get_time(self):
"""Convenience method to get the elapsed time counter."""
- return self.categories["internal"]["counters"].get("elapsed")
+ return self.groups["internal"]["counters"].get("elapsed")
- def add_category(self, category, fallback=None):
- """Set up category tracking/metadata."""
- if category not in self.origins:
- self.origins[category] = {}
+ def add_group(self, group, fallback=None):
+ """Set up group tracking/metadata."""
+ if group not in self.origins:
+ self.origins[group] = {}
if not fallback:
fallback = mudpy.data.find_file(
- ".".join((category, "yaml")), universe=self)
- if "fallback" not in self.origins[category]:
- self.origins[category]["fallback"] = fallback
- flags = self.origins[category].get("flags", None)
+ ".".join((group, "yaml")), universe=self)
+ if "fallback" not in self.origins[group]:
+ self.origins[group]["fallback"] = fallback
+ flags = self.origins[group].get("flags", None)
if fallback not in self.files:
mudpy.data.Data(fallback, self, flags=flags)
self.output_queue = []
self.partial_input = b""
self.password_tries = 0
- self.state = "initial"
+ self.state = "telopt_negotiation"
self.telopts = {}
def quit(self):
self.check_idle()
# if output is paused, decrement the counter
- if self.state == "initial":
+ if self.state == "telopt_negotiation":
if self.negotiation_pause:
self.negotiation_pause -= 1
else:
if self.output_queue:
try:
self.connection.send(self.output_queue[0])
- except BrokenPipeError:
+ except (BrokenPipeError, ConnectionResetError):
if self.account and self.account.get("name"):
account = self.account.get("name")
else:
account = "an unknown user"
self.state = "disconnecting"
- log("Broken pipe sending to %s." % account, 7)
+ log("Disconnected while sending to %s." % account, 7)
del self.output_queue[0]
def enqueue_input(self):
line = line.strip()
# log non-printable characters remaining
- if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_BINARY,
- mudpy.telnet.HIM):
+ if not mudpy.telnet.is_enabled(
+ self, mudpy.telnet.TELOPT_BINARY, mudpy.telnet.HIM):
asciiline = bytes([x for x in line if 32 <= x <= 126])
if line != asciiline:
logline = "Non-ASCII characters from "
try:
line = line.decode("utf-8")
except UnicodeDecodeError:
- logline = "Non-UTF-8 characters from "
+ logline = "Non-UTF-8 sequence from "
if self.account and self.account.get("name"):
logline += self.account.get("name") + ": "
else:
"""Instantiate a new, unconfigured avatar for this user."""
counter = 0
while ("avatar_%s_%s" % (self.account.get("name"), counter)
- in universe.categories.get("actor", {}).keys()):
+ in universe.groups.get("actor", {}).keys()):
counter += 1
self.avatar = Element(
"actor.avatar_%s_%s" % (self.account.get("name"), counter),
# ignoring color escape sequences
rel_pos = 0
- # the absolute position of the most recent whitespace character
- last_whitespace = 0
+ # the absolute and relative positions of the most recent whitespace
+ # character
+ last_abs_whitespace = 0
+ last_rel_whitespace = 0
# whether the current character is part of a color escape sequence
escape = False
# the current character is the escape character
if each_character == "\x1b" and not escape:
escape = True
+ rel_pos -= 1
# the current character is within an escape sequence
elif escape:
-
- # the current character is m, which terminates the
- # escape sequence
+ rel_pos -= 1
if each_character == "m":
+ # the current character is m, which terminates the
+ # escape sequence
escape = False
+ # the current character is a space
+ elif each_character == " ":
+ last_abs_whitespace = abs_pos
+ last_rel_whitespace = rel_pos
+
# the current character is a newline, so reset the relative
- # position (start a new line)
+ # position too (start a new line)
elif each_character == "\n":
rel_pos = 0
- last_whitespace = abs_pos
-
- # the current character meets the requested maximum line width,
- # so we need to backtrack and find a space at which to wrap;
- # special care is taken to avoid an off-by-one in case the
- # current character is a double-width glyph
- elif each_character != "\r" and (
- rel_pos >= width or (
- rel_pos >= width - 1 and glyph_columns(
- each_character
- ) == 2
- )
- ):
+ last_abs_whitespace = abs_pos
+ last_rel_whitespace = rel_pos
- # it's always possible we landed on whitespace
- if unicodedata.category(each_character) in ("Cc", "Zs"):
- last_whitespace = abs_pos
+ # the current character meets the requested maximum line width, so we
+ # need to wrap unless the current word is wider than the terminal (in
+ # which case we let it do the wrapping instead)
+ if last_rel_whitespace != 0 and (rel_pos > width or (
+ rel_pos > width - 1 and glyph_columns(each_character) == 2)):
- # insert an eol in place of the space
- text = text[:last_whitespace] + "\r\n" + text[last_whitespace + 1:]
+ # insert an eol in place of the last space
+ text = (text[:last_abs_whitespace] + "\r\n" +
+ text[last_abs_whitespace + 1:])
# increase the absolute position because an eol is two
# characters but the space it replaced was only one
# now we're at the begining of a new line, plus the
# number of characters wrapped from the previous line
- rel_pos = 0
- for remaining_characters in text[last_whitespace:abs_pos]:
- rel_pos += glyph_columns(remaining_characters)
+ rel_pos -= last_rel_whitespace
+ last_rel_whitespace = 0
# as long as the character is not a carriage return and the
# other above conditions haven't been met, count it as a
# printable character
elif each_character != "\r":
rel_pos += glyph_columns(each_character)
- if unicodedata.category(each_character) in ("Cc", "Zs"):
- last_whitespace = abs_pos
+ if each_character in (" ", "\n"):
+ last_abs_whitespace = abs_pos
+ last_rel_whitespace = rel_pos
# increase the absolute position for every character
abs_pos += 1
user.pulse()
# add an element for counters if it doesn't exist
- if "counters" not in universe.categories.get("internal", {}):
+ if "counters" not in universe.groups.get("internal", {}):
Element("internal.counters", universe)
# update the log every now and then
- if not universe.categories["internal"]["counters"].get("mark"):
+ if not universe.groups["internal"]["counters"].get("mark"):
log(str(len(universe.userlist)) + " connection(s)")
- universe.categories["internal"]["counters"].set(
+ universe.groups["internal"]["counters"].set(
"mark", universe.contents["mudpy.timing"].get("status")
)
else:
- universe.categories["internal"]["counters"].set(
- "mark", universe.categories["internal"]["counters"].get(
+ universe.groups["internal"]["counters"].set(
+ "mark", universe.groups["internal"]["counters"].get(
"mark"
) - 1
)
# periodically save everything
- if not universe.categories["internal"]["counters"].get("save"):
+ if not universe.groups["internal"]["counters"].get("save"):
universe.save()
- universe.categories["internal"]["counters"].set(
+ universe.groups["internal"]["counters"].set(
"save", universe.contents["mudpy.timing"].get("save")
)
else:
- universe.categories["internal"]["counters"].set(
- "save", universe.categories["internal"]["counters"].get(
+ universe.groups["internal"]["counters"].set(
+ "save", universe.groups["internal"]["counters"].get(
"save"
) - 1
)
time.sleep(universe.contents["mudpy.timing"].get("increment"))
# increase the elapsed increment counter
- universe.categories["internal"]["counters"].set(
- "elapsed", universe.categories["internal"]["counters"].get(
+ universe.groups["internal"]["counters"].set(
+ "elapsed", universe.groups["internal"]["counters"].get(
"elapsed", 0
) + 1
)
def menu_echo_on(state):
"""True if echo is on, false if it is off."""
- return universe.categories["menu"][state].get("echo", True)
+ return universe.groups["menu"][state].get("echo", True)
def get_echo_message(state):
def get_default_menu_choice(state):
"""Return the default choice for a menu."""
- return universe.categories["menu"][state].get("default")
+ return universe.groups["menu"][state].get("default")
def get_formatted_default_menu_choice(state):
# try to get an error message matching the condition
# and current state
- description = universe.categories[
+ description = universe.groups[
"menu"][state].get("error_" + error)
if not description:
description = "That is not a valid choice..."
else:
# try to get a menu description for the current state
- description = universe.categories["menu"][state].get("description")
+ description = universe.groups["menu"][state].get("description")
# return the description or error message
if description:
def get_menu_prompt(state):
"""Try to get a prompt, if it was defined."""
- prompt = universe.categories["menu"][state].get("prompt")
+ prompt = universe.groups["menu"][state].get("prompt")
if prompt:
prompt += " "
return prompt
def get_menu_choices(user):
"""Return a dict of choice:meaning."""
- menu = universe.categories["menu"][user.state]
+ menu = universe.groups["menu"][user.state]
create_choices = menu.get("create")
if create_choices:
choices = eval(create_choices)
creates = {}
for facet in menu.facets():
if facet.startswith("demand_") and not eval(
- universe.categories["menu"][user.state].get(facet)
+ universe.groups["menu"][user.state].get(facet)
):
ignores.append(facet.split("_", 2)[1])
elif facet.startswith("create_"):
def get_menu_branches(state):
"""Return a dict of choice:branch."""
branches = {}
- for facet in universe.categories["menu"][state].facets():
+ for facet in universe.groups["menu"][state].facets():
if facet.startswith("branch_"):
branches[
facet.split("_", 2)[1]
- ] = universe.categories["menu"][state].get(facet)
+ ] = universe.groups["menu"][state].get(facet)
return branches
def get_default_branch(state):
"""Return the default branch."""
- return universe.categories["menu"][state].get("branch")
+ return universe.groups["menu"][state].get("branch")
def get_choice_branch(user, choice):
def get_menu_actions(state):
"""Return a dict of choice:branch."""
actions = {}
- for facet in universe.categories["menu"][state].facets():
+ for facet in universe.groups["menu"][state].facets():
if facet.startswith("action_"):
actions[
facet.split("_", 2)[1]
- ] = universe.categories["menu"][state].get(facet)
+ ] = universe.groups["menu"][state].get(facet)
return actions
def get_default_action(state):
"""Return the default action."""
- return universe.categories["menu"][state].get("action")
+ return universe.groups["menu"][state].get("action")
def get_choice_action(user, choice):
user.error = "bad_name"
# if that account exists, time to request a password
- elif name in universe.categories.get("account", {}):
- user.account = universe.categories["account"][name]
+ elif name in universe.groups.get("account", {}):
+ user.account = universe.groups["account"][name]
user.state = "checking_password"
# otherwise, this could be a brand new user
command_name = command_name.lower()
# the command matches a command word for which we have data
- if command_name in universe.categories["command"]:
- command = universe.categories["command"][command_name]
+ if command_name in universe.groups["command"]:
+ command = universe.groups["command"][command_name]
else:
command = None
if parameters and actor.owner:
# is the command word one for which we have data?
- if parameters in universe.categories["command"]:
- command = universe.categories["command"][parameters]
+ if parameters in universe.groups["command"]:
+ command = universe.groups["command"][parameters]
else:
command = None
if see_also:
really_see_also = ""
for item in see_also:
- if item in universe.categories["command"]:
- command = universe.categories["command"][item]
+ if item in universe.groups["command"]:
+ command = universe.groups["command"][item]
if actor.can_run(command):
if really_see_also:
really_see_also += ", "
# give a sorted list of commands with descriptions if provided
output = "These are the commands available to you:$(eol)$(eol)"
- sorted_commands = list(universe.categories["command"].keys())
+ sorted_commands = list(universe.groups["command"].keys())
sorted_commands.sort()
for item in sorted_commands:
- command = universe.categories["command"][item]
+ command = universe.groups["command"][item]
if actor.can_run(command):
description = command.get("description")
if not description:
arguments = parameters.split()
if not parameters:
message = "What do you want to show?"
+ elif arguments[0] == "version":
+ message = repr(universe.versions)
elif arguments[0] == "time":
- message = universe.categories["internal"]["counters"].get(
+ message = universe.groups["internal"]["counters"].get(
"elapsed"
) + " increments elapsed since the world was created."
- elif arguments[0] == "categories":
- message = "These are the element categories:$(eol)"
- categories = list(universe.categories.keys())
- categories.sort()
- for category in categories:
- message += "$(eol) $(grn)" + category + "$(nrm)"
+ elif arguments[0] == "groups":
+ message = "These are the element groups:$(eol)"
+ groups = list(universe.groups.keys())
+ groups.sort()
+ for group in groups:
+ message += "$(eol) $(grn)" + group + "$(nrm)"
elif arguments[0] == "files":
message = "These are the current files containing the universe:$(eol)"
filenames = sorted(universe.files)
if universe.files[filename].flags:
message += (" $(yel)[%s]$(nrm)" %
",".join(universe.files[filename].flags))
- elif arguments[0] == "category":
+ elif arguments[0] == "group":
if len(arguments) != 2:
- message = "You must specify one category."
- elif arguments[1] in universe.categories:
+ message = "You must specify one group."
+ elif arguments[1] in universe.groups:
message = ('These are the elements in the "' + arguments[1]
- + '" category:$(eol)')
+ + '" group:$(eol)')
elements = [
(
- universe.categories[arguments[1]][x].key
- ) for x in universe.categories[arguments[1]].keys()
+ universe.groups[arguments[1]][x].key
+ ) for x in universe.groups[arguments[1]].keys()
]
elements.sort()
for element in elements:
message += "$(eol) $(grn)" + element + "$(nrm)"
else:
- message = 'Category "' + arguments[1] + '" does not exist.'
+ message = 'Group "' + arguments[1] + '" does not exist.'
elif arguments[0] == "file":
if len(arguments) != 2:
message = "You must specify one file."
log(*logline)
universe.setup_loglines = []
- # log an initial message
- log("Started mudpy with command line: " + " ".join(sys.argv))
-
# fork and disassociate
daemonize(universe)
# make the pidfile
create_pidfile(universe)
+ # load and store diagnostic info
+ universe.versions = mudpy.version.Versions("mudpy")
+
+ # log startup diagnostic messages
+ log("On %s at %s" % (universe.versions.python_version, sys.executable), 1)
+ log("Import path: %s" % ", ".join(sys.path), 1)
+ log("Installed dependencies: %s" % universe.versions.dependencies_text, 1)
+ log("Other python packages: %s" % universe.versions.environment_text, 1)
+ log("Started %s with command line: %s" % (
+ universe.versions.version, " ".join(sys.argv)), 1)
+
# pass the initialized universe back
return universe
projects / mudpy.git / blobdiff