1 """Miscellaneous functions for the mudpy engine."""
3 # Copyright (c) 2004-2019 mudpy authors. Permission to use, copy,
4 # modify, and distribute this software is granted under terms
5 # provided in the LICENSE file distributed with this software.
25 """An element of the universe."""
27 def __init__(self, key, universe, origin=None):
28 """Set up a new element."""
30 # keep track of our key name
33 # keep track of what universe it's loading into
34 self.universe = universe
36 # set of facet keys from the universe
37 self.facethash = dict()
39 # not owned by a user by default (used for avatars)
42 # no contents in here by default
45 if self.key.find(".") > 0:
46 self.group, self.subkey = self.key.split(".")[-2:]
49 self.subkey = self.key
50 if self.group not in self.universe.groups:
51 self.universe.groups[self.group] = {}
53 # get an appropriate origin
55 self.universe.add_group(self.group)
56 origin = self.universe.files[
57 self.universe.origins[self.group]["fallback"]]
59 # record or reset a pointer to the origin file
60 self.origin = self.universe.files[origin.source]
62 # add or replace this element in the universe
63 self.universe.contents[self.key] = self
64 self.universe.groups[self.group][self.subkey] = self
67 """Create a new element and replace this one."""
68 args = (self.key, self.universe, self.origin)
73 """Remove an element from the universe and destroy it."""
74 for facet in dict(self.facethash):
75 self.remove_facet(facet)
76 del self.universe.groups[self.group][self.subkey]
77 del self.universe.contents[self.key]
81 """Return a list of non-inherited facets for this element."""
84 def has_facet(self, facet):
85 """Return whether the non-inherited facet exists."""
86 return facet in self.facets()
88 def remove_facet(self, facet):
89 """Remove a facet from the element."""
90 if ".".join((self.key, facet)) in self.origin.data:
91 del self.origin.data[".".join((self.key, facet))]
92 if facet in self.facethash:
93 del self.facethash[facet]
94 self.origin.modified = True
97 """Return a list of the element's inheritance lineage."""
98 if self.has_facet("inherit"):
99 ancestry = self.get("inherit")
102 for parent in ancestry[:]:
103 ancestors = self.universe.contents[parent].ancestry()
104 for ancestor in ancestors:
105 if ancestor not in ancestry:
106 ancestry.append(ancestor)
111 def get(self, facet, default=None):
112 """Retrieve values."""
116 return self.origin.data[".".join((self.key, facet))]
117 except (KeyError, TypeError):
119 if self.has_facet("inherit"):
120 for ancestor in self.ancestry():
121 if self.universe.contents[ancestor].has_facet(facet):
122 return self.universe.contents[ancestor].get(facet)
126 def set(self, facet, value):
128 if not self.origin.is_writeable() and not self.universe.loading:
129 # break if there is an attempt to update an element from a
130 # read-only file, unless the universe is in the midst of loading
131 # updated data from files
132 raise PermissionError("Altering elements in read-only files is "
134 # Coerce some values to appropriate data types
135 # TODO(fungi) Move these to a separate validation mechanism
136 if facet in ["loglevel"]:
138 elif facet in ["administrator"]:
141 # The canonical node for this facet within its origin
142 node = ".".join((self.key, facet))
144 if node not in self.origin.data or self.origin.data[node] != value:
145 # Be careful to only update the origin's contents when required,
146 # since that affects whether the backing file gets written
147 self.origin.data[node] = value
148 self.origin.modified = True
150 # Make sure this facet is included in the element's facets
151 self.facethash[facet] = self.origin.data[node]
153 def append(self, facet, value):
154 """Append value to a list."""
155 newlist = self.get(facet)
158 if type(newlist) is not list:
159 newlist = list(newlist)
160 newlist.append(value)
161 self.set(facet, newlist)
171 add_terminator=False,
174 """Convenience method to pass messages to an owner."""
187 def can_run(self, command):
188 """Check if the user can run this command object."""
190 # has to be in the commands group
191 if command not in self.universe.groups["command"].values():
194 # avatars of administrators can run any command
195 elif self.owner and self.owner.account.get("administrator"):
198 # everyone can run non-administrative commands
199 elif not command.get("administrative"):
202 # otherwise the command cannot be run by this actor
206 # pass back the result
209 def update_location(self):
210 """Make sure the location's contents contain this element."""
211 area = self.get("location")
212 if area in self.universe.contents:
213 self.universe.contents[area].contents[self.key] = self
215 def clean_contents(self):
216 """Make sure the element's contents aren't bogus."""
217 for element in self.contents.values():
218 if element.get("location") != self.key:
219 del self.contents[element.key]
221 def go_to(self, area):
222 """Relocate the element to a specific area."""
223 current = self.get("location")
224 if current and self.key in self.universe.contents[current].contents:
225 del universe.contents[current].contents[self.key]
226 if area in self.universe.contents:
227 self.set("location", area)
228 self.universe.contents[area].contents[self.key] = self
232 """Relocate the element to its default location."""
233 self.go_to(self.get("default_location"))
234 self.echo_to_location(
235 "You suddenly realize that " + self.get("name") + " is here."
238 def move_direction(self, direction):
239 """Relocate the element in a specified direction."""
240 motion = self.universe.contents["mudpy.movement.%s" % direction]
241 enter_term = motion.get("enter_term")
242 exit_term = motion.get("exit_term")
243 self.echo_to_location("%s exits %s." % (self.get("name"), exit_term))
244 self.send("You exit %s." % exit_term, add_prompt=False)
246 self.universe.contents[
247 self.get("location")].link_neighbor(direction)
249 self.echo_to_location("%s arrives from %s." % (
250 self.get("name"), enter_term))
252 def look_at(self, key):
253 """Show an element to another element."""
255 element = self.universe.contents[key]
257 name = element.get("name")
259 message += "$(cyn)" + name + "$(nrm)$(eol)"
260 description = element.get("description")
262 message += description + "$(eol)"
263 portal_list = list(element.portals().keys())
266 message += "$(cyn)[ Exits: " + ", ".join(
269 for element in self.universe.contents[
272 if element.get("is_actor") and element is not self:
273 message += "$(yel)" + element.get(
275 ) + " is here.$(nrm)$(eol)"
276 elif element is not self:
277 message += "$(grn)" + element.get(
283 """Map the portal directions for an area to neighbors."""
285 if re.match(r"""^area\.-?\d+,-?\d+,-?\d+$""", self.key):
286 coordinates = [(int(x))
287 for x in self.key.split(".")[-1].split(",")]
290 self.universe.contents["mudpy.movement.%s" % x].get("vector")
291 ) for x in self.universe.directions)
292 for portal in self.get("gridlinks"):
293 adjacent = map(lambda c, o: c + o,
294 coordinates, offsets[portal])
295 neighbor = "area." + ",".join(
296 [(str(x)) for x in adjacent]
298 if neighbor in self.universe.contents:
299 portals[portal] = neighbor
300 for facet in self.facets():
301 if facet.startswith("link_"):
302 neighbor = self.get(facet)
303 if neighbor in self.universe.contents:
304 portal = facet.split("_")[1]
305 portals[portal] = neighbor
308 def link_neighbor(self, direction):
309 """Return the element linked in a given direction."""
310 portals = self.portals()
311 if direction in portals:
312 return portals[direction]
314 def echo_to_location(self, message):
315 """Show a message to other elements in the current location."""
316 for element in self.universe.contents[
319 if element is not self:
320 element.send(message)
327 def __init__(self, filename="", load=False):
328 """Initialize the universe."""
331 self.directions = set()
335 self.reload_flag = False
336 self.setup_loglines = []
337 self.startdir = os.getcwd()
338 self.terminate_flag = False
342 possible_filenames = [
344 "/usr/local/mudpy/etc/mudpy.yaml",
345 "/usr/local/etc/mudpy.yaml",
346 "/etc/mudpy/mudpy.yaml",
349 for filename in possible_filenames:
350 if os.access(filename, os.R_OK):
352 if not os.path.isabs(filename):
353 filename = os.path.join(self.startdir, filename)
354 self.filename = filename
356 # make sure to preserve any accumulated log entries during load
357 self.setup_loglines += self.load()
360 """Load universe data from persistent storage."""
362 # while loading, it's safe to update elements from read-only files
365 # it's possible for this to enter before logging configuration is read
366 pending_loglines = []
368 # start populating the (re)files dict from the base config
370 mudpy.data.Data(self.filename, self)
372 # load default storage locations for groups
373 if hasattr(self, "contents") and "mudpy.filing" in self.contents:
374 self.origins.update(self.contents["mudpy.filing"].get(
377 # add some builtin groups we know we'll need
378 for group in ("account", "actor", "internal"):
379 self.add_group(group)
381 # make a list of inactive avatars
382 inactive_avatars = []
383 for account in self.groups.get("account", {}).values():
384 for avatar in account.get("avatars"):
386 inactive_avatars.append(self.contents[avatar])
388 pending_loglines.append((
389 'Missing avatar "%s", possible data corruption' %
391 for user in self.userlist:
392 if user.avatar in inactive_avatars:
393 inactive_avatars.remove(user.avatar)
395 # another pass to straighten out all the element contents
396 for element in self.contents.values():
397 element.update_location()
398 element.clean_contents()
400 # done loading, so disallow updating elements from read-only files
403 return pending_loglines
406 """Create a new, empty Universe (the Big Bang)."""
407 new_universe = Universe()
408 for attribute in vars(self).keys():
409 setattr(new_universe, attribute, getattr(self, attribute))
410 new_universe.reload_flag = False
415 """Save the universe to persistent storage."""
416 for key in self.files:
417 self.files[key].save()
419 def initialize_server_socket(self):
420 """Create and open the listening socket."""
422 # need to know the local address and port number for the listener
423 host = self.contents["mudpy.network"].get("host")
424 port = self.contents["mudpy.network"].get("port")
426 # if no host was specified, bind to all local addresses (preferring
434 # figure out if this is ipv4 or v6
435 family = socket.getaddrinfo(host, port)[0][0]
436 if family is socket.AF_INET6 and not socket.has_ipv6:
437 log("No support for IPv6 address %s (use IPv4 instead)." % host)
439 # create a new stream-type socket object
440 self.listening_socket = socket.socket(family, socket.SOCK_STREAM)
442 # set the socket options to allow existing open ones to be
443 # reused (fixes a bug where the server can't bind for a minute
444 # when restarting on linux systems)
445 self.listening_socket.setsockopt(
446 socket.SOL_SOCKET, socket.SO_REUSEADDR, 1
449 # bind the socket to to our desired server ipa and port
450 self.listening_socket.bind((host, port))
452 # disable blocking so we can proceed whether or not we can
454 self.listening_socket.setblocking(0)
456 # start listening on the socket
457 self.listening_socket.listen(1)
459 # note that we're now ready for user connections
460 log("Listening for Telnet connections on %s port %s" % (
464 """Convenience method to get the elapsed time counter."""
465 return self.groups["internal"]["counters"].get("elapsed")
467 def add_group(self, group, fallback=None):
468 """Set up group tracking/metadata."""
469 if group not in self.origins:
470 self.origins[group] = {}
472 fallback = mudpy.data.find_file(
473 ".".join((group, "yaml")), universe=self)
474 if "fallback" not in self.origins[group]:
475 self.origins[group]["fallback"] = fallback
476 flags = self.origins[group].get("flags", None)
477 if fallback not in self.files:
478 mudpy.data.Data(fallback, self, flags=flags)
483 """This is a connected user."""
486 """Default values for the in-memory user variables."""
489 self.authenticated = False
492 self.connection = None
494 self.input_queue = []
495 self.last_address = ""
496 self.last_input = universe.get_time()
497 self.menu_choices = {}
498 self.menu_seen = False
499 self.negotiation_pause = 0
500 self.output_queue = []
501 self.partial_input = b""
502 self.password_tries = 0
503 self.state = "telopt_negotiation"
505 self.universe = universe
508 """Log, close the connection and remove."""
510 name = self.account.get("name", self)
513 log("Logging out %s" % name, 2)
514 self.deactivate_avatar()
515 self.connection.close()
518 def check_idle(self):
519 """Warn or disconnect idle users as appropriate."""
520 idletime = universe.get_time() - self.last_input
521 linkdead_dict = universe.contents[
522 "mudpy.timing.idle.disconnect"].facets()
523 if self.state in linkdead_dict:
524 linkdead_state = self.state
526 linkdead_state = "default"
527 if idletime > linkdead_dict[linkdead_state]:
529 "$(eol)$(red)You've done nothing for far too long... goodbye!"
534 logline = "Disconnecting "
535 if self.account and self.account.get("name"):
536 logline += self.account.get("name")
538 logline += "an unknown user"
539 logline += (" after idling too long in the " + self.state
542 self.state = "disconnecting"
543 self.menu_seen = False
544 idle_dict = universe.contents["mudpy.timing.idle.warn"].facets()
545 if self.state in idle_dict:
546 idle_state = self.state
548 idle_state = "default"
549 if idletime == idle_dict[idle_state]:
551 "$(eol)$(red)If you continue to be unproductive, "
552 + "you'll be shown the door...$(nrm)$(eol)"
556 """Save, load a new user and relocate the connection."""
558 # copy old attributes
559 attributes = self.__dict__
561 # get out of the list
564 # get rid of the old user object
567 # create a new user object
570 # set everything equivalent
571 new_user.__dict__ = attributes
573 # the avatar needs a new owner
575 new_user.account = universe.contents[new_user.account.key]
576 new_user.avatar = universe.contents[new_user.avatar.key]
577 new_user.avatar.owner = new_user
580 universe.userlist.append(new_user)
582 def replace_old_connections(self):
583 """Disconnect active users with the same name."""
585 # the default return value
588 # iterate over each user in the list
589 for old_user in universe.userlist:
591 # the name is the same but it's not us
594 ) and old_user.account and old_user.account.get(
596 ) == self.account.get(
598 ) and old_user is not self:
602 "User " + self.account.get(
604 ) + " reconnected--closing old connection to "
605 + old_user.address + ".",
609 "$(eol)$(red)New connection from " + self.address
610 + ". Terminating old connection...$(nrm)$(eol)",
615 # close the old connection
616 old_user.connection.close()
618 # replace the old connection with this one
620 "$(eol)$(red)Taking over old connection from "
621 + old_user.address + ".$(nrm)"
623 old_user.connection = self.connection
624 old_user.last_address = old_user.address
625 old_user.address = self.address
627 # take this one out of the list and delete
633 # true if an old connection was replaced, false if not
636 def authenticate(self):
637 """Flag the user as authenticated and disconnect duplicates."""
638 if self.state != "authenticated":
639 self.authenticated = True
640 log("User %s authenticated for account %s." % (
641 self, self.account.subkey), 2)
642 if ("mudpy.limit" in universe.contents and self.account.subkey in
643 universe.contents["mudpy.limit"].get("admins")):
644 self.account.set("administrator", True)
645 log("Account %s is an administrator." % (
646 self.account.subkey), 2)
649 """Send the user their current menu."""
650 if not self.menu_seen:
651 self.menu_choices = get_menu_choices(self)
653 get_menu(self.state, self.error, self.menu_choices),
657 self.menu_seen = True
659 self.adjust_echoing()
662 """"Generate and return an input prompt."""
664 # Start with the user's preference, if one was provided
665 prompt = self.account.get("prompt")
667 # If the user has not set a prompt, then immediately return the default
668 # provided for the current state
670 return get_menu_prompt(self.state)
672 # Allow including the World clock state
673 if "$_(time)" in prompt:
674 prompt = prompt.replace(
676 str(universe.groups["internal"]["counters"].get("elapsed")))
678 # Append a single space for clear separation from user input
679 if prompt[-1] != " ":
680 prompt = "%s " % prompt
682 # Return the cooked prompt
685 def adjust_echoing(self):
686 """Adjust echoing to match state menu requirements."""
687 if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_ECHO,
689 if menu_echo_on(self.state):
690 mudpy.telnet.disable(self, mudpy.telnet.TELOPT_ECHO,
692 elif not menu_echo_on(self.state):
693 mudpy.telnet.enable(self, mudpy.telnet.TELOPT_ECHO,
697 """Remove a user from the list of connected users."""
698 log("Disconnecting account %s." % self, 0)
699 universe.userlist.remove(self)
709 add_terminator=False,
712 """Send arbitrary text to a connected user."""
714 # unless raw mode is on, clean it up all nice and pretty
717 # strip extra $(eol) off if present
718 while output.startswith("$(eol)"):
720 while output.endswith("$(eol)"):
722 extra_lines = output.find("$(eol)$(eol)$(eol)")
723 while extra_lines > -1:
724 output = output[:extra_lines] + output[extra_lines + 6:]
725 extra_lines = output.find("$(eol)$(eol)$(eol)")
727 # start with a newline, append the message, then end
728 # with the optional eol string passed to this function
729 # and the ansi escape to return to normal text
730 if not just_prompt and prepend_padding:
731 if (not self.output_queue or not
732 self.output_queue[-1].endswith(b"\r\n")):
733 output = "$(eol)" + output
734 elif not self.output_queue[-1].endswith(
736 ) and not self.output_queue[-1].endswith(
739 output = "$(eol)" + output
740 output += eol + chr(27) + "[0m"
742 # tack on a prompt if active
743 if self.state == "active":
747 output += self.prompt()
748 mode = self.avatar.get("mode")
750 output += "(" + mode + ") "
752 # find and replace macros in the output
753 output = replace_macros(self, output)
755 # wrap the text at the client's width (min 40, 0 disables)
757 if self.columns < 40:
761 output = wrap_ansi_text(output, wrap)
763 # if supported by the client, encode it utf-8
764 if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_BINARY,
766 encoded_output = output.encode("utf-8")
768 # otherwise just send ascii
770 encoded_output = output.encode("ascii", "replace")
772 # end with a terminator if requested
773 if add_prompt or add_terminator:
774 if mudpy.telnet.is_enabled(
775 self, mudpy.telnet.TELOPT_EOR, mudpy.telnet.US):
776 encoded_output += mudpy.telnet.telnet_proto(
777 mudpy.telnet.IAC, mudpy.telnet.EOR)
778 elif not mudpy.telnet.is_enabled(
779 self, mudpy.telnet.TELOPT_SGA, mudpy.telnet.US):
780 encoded_output += mudpy.telnet.telnet_proto(
781 mudpy.telnet.IAC, mudpy.telnet.GA)
783 # and tack it onto the queue
784 self.output_queue.append(encoded_output)
786 # if this is urgent, flush all pending output
790 # just dump raw bytes as requested
792 self.output_queue.append(output)
796 """All the things to do to the user per increment."""
798 # if the world is terminating, disconnect
799 if universe.terminate_flag:
800 self.state = "disconnecting"
801 self.menu_seen = False
803 # check for an idle connection and act appropriately
807 # if output is paused, decrement the counter
808 if self.state == "telopt_negotiation":
809 if self.negotiation_pause:
810 self.negotiation_pause -= 1
812 self.state = "entering_account_name"
814 # show the user a menu as needed
815 elif not self.state == "active":
818 # flush any pending output in the queue
821 # disconnect users with the appropriate state
822 if self.state == "disconnecting":
825 # check for input and add it to the queue
828 # there is input waiting in the queue
830 handle_user_input(self)
833 """Try to send the last item in the queue and remove it."""
834 if self.output_queue:
836 self.connection.send(self.output_queue[0])
837 except (BrokenPipeError, ConnectionResetError):
838 if self.account and self.account.get("name"):
839 account = self.account.get("name")
841 account = "an unknown user"
842 self.state = "disconnecting"
843 log("Disconnected while sending to %s." % account, 7)
844 del self.output_queue[0]
846 def enqueue_input(self):
847 """Process and enqueue any new input."""
849 # check for some input
851 raw_input = self.connection.recv(1024)
852 except (BlockingIOError, OSError):
858 # tack this on to any previous partial
859 self.partial_input += raw_input
861 # reply to and remove any IAC negotiation codes
862 mudpy.telnet.negotiate_telnet_options(self)
864 # separate multiple input lines
865 new_input_lines = self.partial_input.split(b"\r\0")
866 if len(new_input_lines) == 1:
867 new_input_lines = new_input_lines[0].split(b"\r\n")
869 # if input doesn't end in a newline, replace the
870 # held partial input with the last line of it
872 self.partial_input.endswith(b"\r\0") or
873 self.partial_input.endswith(b"\r\n")):
874 self.partial_input = new_input_lines.pop()
876 # otherwise, chop off the extra null input and reset
877 # the held partial input
879 new_input_lines.pop()
880 self.partial_input = b""
882 # iterate over the remaining lines
883 for line in new_input_lines:
885 # strip off extra whitespace
888 # log non-printable characters remaining
889 if not mudpy.telnet.is_enabled(
890 self, mudpy.telnet.TELOPT_BINARY, mudpy.telnet.HIM):
891 asciiline = bytes([x for x in line if 32 <= x <= 126])
892 if line != asciiline:
893 logline = "Non-ASCII characters from "
894 if self.account and self.account.get("name"):
895 logline += self.account.get("name") + ": "
897 logline += "unknown user: "
898 logline += repr(line)
903 line = line.decode("utf-8")
904 except UnicodeDecodeError:
905 logline = "Non-UTF-8 sequence from "
906 if self.account and self.account.get("name"):
907 logline += self.account.get("name") + ": "
909 logline += "unknown user: "
910 logline += repr(line)
914 line = unicodedata.normalize("NFKC", line)
916 # put on the end of the queue
917 self.input_queue.append(line)
919 def new_avatar(self):
920 """Instantiate a new, unconfigured avatar for this user."""
922 while ("avatar_%s_%s" % (self.account.get("name"), counter)
923 in universe.groups.get("actor", {}).keys()):
925 self.avatar = Element(
926 "actor.avatar_%s_%s" % (self.account.get("name"), counter),
928 self.avatar.append("inherit", "archetype.avatar")
929 self.account.append("avatars", self.avatar.key)
930 log("Created new avatar %s for user %s." % (
931 self.avatar.key, self.account.get("name")), 0)
933 def delete_avatar(self, avatar):
934 """Remove an avatar from the world and from the user's list."""
935 if self.avatar is universe.contents[avatar]:
937 log("Deleting avatar %s for user %s." % (
938 avatar, self.account.get("name")), 0)
939 universe.contents[avatar].destroy()
940 avatars = self.account.get("avatars")
941 avatars.remove(avatar)
942 self.account.set("avatars", avatars)
944 def activate_avatar_by_index(self, index):
945 """Enter the world with a particular indexed avatar."""
946 self.avatar = universe.contents[
947 self.account.get("avatars")[index]]
948 self.avatar.owner = self
949 self.state = "active"
950 log("Activated avatar %s (%s)." % (
951 self.avatar.get("name"), self.avatar.key), 0)
952 self.avatar.go_home()
954 def deactivate_avatar(self):
955 """Have the active avatar leave the world."""
957 log("Deactivating avatar %s (%s) for user %s." % (
958 self.avatar.get("name"), self.avatar.key,
959 self.account.get("name")), 0)
960 current = self.avatar.get("location")
962 self.avatar.set("default_location", current)
963 self.avatar.echo_to_location(
964 "You suddenly wonder where " + self.avatar.get(
968 del universe.contents[current].contents[self.avatar.key]
969 self.avatar.remove_facet("location")
970 self.avatar.owner = None
974 """Destroy the user and associated avatars."""
975 for avatar in self.account.get("avatars"):
976 self.delete_avatar(avatar)
977 log("Destroying account %s for user %s." % (
978 self.account.get("name"), self), 0)
979 self.account.destroy()
981 def list_avatar_names(self):
982 """List names of assigned avatars."""
984 for avatar in self.account.get("avatars"):
986 avatars.append(universe.contents[avatar].get("name"))
988 log('Missing avatar "%s", possible data corruption.' %
993 def broadcast(message, add_prompt=True):
994 """Send a message to all connected users."""
995 for each_user in universe.userlist:
996 each_user.send("$(eol)" + message, add_prompt=add_prompt)
999 def log(message, level=0):
1000 """Log a message."""
1002 # a couple references we need
1003 if "mudpy.log" in universe.contents:
1004 file_name = universe.contents["mudpy.log"].get("file", "")
1005 max_log_lines = universe.contents["mudpy.log"].get("lines", 0)
1006 syslog_name = universe.contents["mudpy.log"].get("syslog", "")
1011 timestamp = datetime.datetime.now().isoformat(' ')
1013 # turn the message into a list of nonempty lines
1014 lines = [x for x in [(x.rstrip()) for x in message.split("\n")] if x != ""]
1016 # send the timestamp and line to a file
1018 if not os.path.isabs(file_name):
1019 file_name = os.path.join(universe.startdir, file_name)
1020 os.makedirs(os.path.dirname(file_name), exist_ok=True)
1021 file_descriptor = codecs.open(file_name, "a", "utf-8")
1023 file_descriptor.write(timestamp + " " + line + "\n")
1024 file_descriptor.flush()
1025 file_descriptor.close()
1027 # send the timestamp and line to standard output
1028 if ("mudpy.log" in universe.contents and
1029 universe.contents["mudpy.log"].get("stdout")):
1031 print(timestamp + " " + line)
1033 # send the line to the system log
1036 syslog_name.encode("utf-8"),
1038 syslog.LOG_INFO | syslog.LOG_DAEMON
1044 # display to connected administrators
1045 for user in universe.userlist:
1046 if user.state == "active" and user.account.get(
1048 ) and user.account.get("loglevel", 0) <= level:
1049 # iterate over every line in the message
1053 "$(bld)$(red)" + timestamp + " "
1054 + line.replace("$(", "$_(") + "$(nrm)$(eol)")
1055 user.send(full_message, flush=True)
1057 # add to the recent log list
1059 while 0 < len(universe.loglines) >= max_log_lines:
1060 del universe.loglines[0]
1061 universe.loglines.append((level, timestamp + " " + line))
1064 def get_loglines(level, start, stop):
1065 """Return a specific range of loglines filtered by level."""
1067 # filter the log lines
1068 loglines = [x for x in universe.loglines if x[0] >= level]
1070 # we need these in several places
1071 total_count = str(len(universe.loglines))
1072 filtered_count = len(loglines)
1074 # don't proceed if there are no lines
1077 # can't start before the begining or at the end
1078 if start > filtered_count:
1079 start = filtered_count
1083 # can't stop before we start
1090 message = "There are " + str(total_count)
1091 message += " log lines in memory and " + str(filtered_count)
1092 message += " at or above level " + str(level) + "."
1093 message += " The matching lines from " + str(stop) + " to "
1094 message += str(start) + " are:$(eol)$(eol)"
1096 # add the text from the selected lines
1098 range_lines = loglines[-start:-(stop - 1)]
1100 range_lines = loglines[-start:]
1101 for line in range_lines:
1102 message += " (" + str(line[0]) + ") " + line[1].replace(
1106 # there were no lines
1108 message = "None of the " + str(total_count)
1109 message += " lines in memory matches your request."
1115 def glyph_columns(character):
1116 """Convenience function to return the column width of a glyph."""
1117 if unicodedata.east_asian_width(character) in "FW":
1123 def wrap_ansi_text(text, width):
1124 """Wrap text with arbitrary width while ignoring ANSI colors."""
1126 # the current position in the entire text string, including all
1127 # characters, printable or otherwise
1130 # the current text position relative to the begining of the line,
1131 # ignoring color escape sequences
1134 # the absolute and relative positions of the most recent whitespace
1136 last_abs_whitespace = 0
1137 last_rel_whitespace = 0
1139 # whether the current character is part of a color escape sequence
1142 # normalize any potentially composited unicode before we count it
1143 text = unicodedata.normalize("NFKC", text)
1145 # iterate over each character from the begining of the text
1146 for each_character in text:
1148 # the current character is the escape character
1149 if each_character == "\x1b" and not escape:
1153 # the current character is within an escape sequence
1156 if each_character == "m":
1157 # the current character is m, which terminates the
1161 # the current character is a space
1162 elif each_character == " ":
1163 last_abs_whitespace = abs_pos
1164 last_rel_whitespace = rel_pos
1166 # the current character is a newline, so reset the relative
1167 # position too (start a new line)
1168 elif each_character == "\n":
1170 last_abs_whitespace = abs_pos
1171 last_rel_whitespace = rel_pos
1173 # the current character meets the requested maximum line width, so we
1174 # need to wrap unless the current word is wider than the terminal (in
1175 # which case we let it do the wrapping instead)
1176 if last_rel_whitespace != 0 and (rel_pos > width or (
1177 rel_pos > width - 1 and glyph_columns(each_character) == 2)):
1179 # insert an eol in place of the last space
1180 text = (text[:last_abs_whitespace] + "\r\n" +
1181 text[last_abs_whitespace + 1:])
1183 # increase the absolute position because an eol is two
1184 # characters but the space it replaced was only one
1187 # now we're at the begining of a new line, plus the
1188 # number of characters wrapped from the previous line
1189 rel_pos -= last_rel_whitespace
1190 last_rel_whitespace = 0
1192 # as long as the character is not a carriage return and the
1193 # other above conditions haven't been met, count it as a
1194 # printable character
1195 elif each_character != "\r":
1196 rel_pos += glyph_columns(each_character)
1197 if each_character in (" ", "\n"):
1198 last_abs_whitespace = abs_pos
1199 last_rel_whitespace = rel_pos
1201 # increase the absolute position for every character
1204 # return the newly-wrapped text
1208 def weighted_choice(data):
1209 """Takes a dict weighted by value and returns a random key."""
1211 # this will hold our expanded list of keys from the data
1214 # create the expanded list of keys
1215 for key in data.keys():
1216 for _count in range(data[key]):
1217 expanded.append(key)
1219 # return one at random
1220 return random.choice(expanded)
1224 """Returns a random character name."""
1226 # the vowels and consonants needed to create romaji syllables
1255 # this dict will hold our weighted list of syllables
1258 # generate the list with an even weighting
1259 for consonant in consonants:
1260 for vowel in vowels:
1261 syllables[consonant + vowel] = 1
1263 # we'll build the name into this string
1266 # create a name of random length from the syllables
1267 for _syllable in range(random.randrange(2, 6)):
1268 name += weighted_choice(syllables)
1270 # strip any leading quotemark, capitalize and return the name
1271 return name.strip("'").capitalize()
1274 def replace_macros(user, text, is_input=False):
1275 """Replaces macros in text output."""
1277 # third person pronouns
1279 "female": {"obj": "her", "pos": "hers", "sub": "she"},
1280 "male": {"obj": "him", "pos": "his", "sub": "he"},
1281 "neuter": {"obj": "it", "pos": "its", "sub": "it"}
1284 # a dict of replacement macros
1287 "bld": chr(27) + "[1m",
1288 "nrm": chr(27) + "[0m",
1289 "blk": chr(27) + "[30m",
1290 "blu": chr(27) + "[34m",
1291 "cyn": chr(27) + "[36m",
1292 "grn": chr(27) + "[32m",
1293 "mgt": chr(27) + "[35m",
1294 "red": chr(27) + "[31m",
1295 "yel": chr(27) + "[33m",
1298 # add dynamic macros where possible
1300 account_name = user.account.get("name")
1302 macros["account"] = account_name
1304 avatar_gender = user.avatar.get("gender")
1306 macros["tpop"] = pronouns[avatar_gender]["obj"]
1307 macros["tppp"] = pronouns[avatar_gender]["pos"]
1308 macros["tpsp"] = pronouns[avatar_gender]["sub"]
1313 # find and replace per the macros dict
1314 macro_start = text.find("$(")
1315 if macro_start == -1:
1317 macro_end = text.find(")", macro_start) + 1
1318 macro = text[macro_start + 2:macro_end - 1]
1319 if macro in macros.keys():
1320 replacement = macros[macro]
1322 # this is how we handle local file inclusion (dangerous!)
1323 elif macro.startswith("inc:"):
1324 incfile = mudpy.data.find_file(macro[4:], universe=universe)
1325 if os.path.exists(incfile):
1326 incfd = codecs.open(incfile, "r", "utf-8")
1329 if line.endswith("\n") and not line.endswith("\r\n"):
1330 line = line.replace("\n", "\r\n")
1332 # lose the trailing eol
1333 replacement = replacement[:-2]
1336 log("Couldn't read included " + incfile + " file.", 7)
1338 # if we get here, log and replace it with null
1342 log("Unexpected replacement macro " +
1343 macro + " encountered.", 6)
1345 # and now we act on the replacement
1346 text = text.replace("$(" + macro + ")", replacement)
1348 # replace the look-like-a-macro sequence
1349 text = text.replace("$_(", "$(")
1354 def escape_macros(value):
1355 """Escapes replacement macros in text."""
1356 if type(value) is str:
1357 return value.replace("$(", "$_(")
1362 def first_word(text, separator=" "):
1363 """Returns a tuple of the first word and the rest."""
1365 if text.find(separator) > 0:
1366 return text.split(separator, 1)
1374 """The things which should happen on each pulse, aside from reloads."""
1376 # open the listening socket if it hasn't been already
1377 if not hasattr(universe, "listening_socket"):
1378 universe.initialize_server_socket()
1380 # assign a user if a new connection is waiting
1381 user = check_for_connection(universe.listening_socket)
1383 universe.userlist.append(user)
1385 # iterate over the connected users
1386 for user in universe.userlist:
1389 # add an element for counters if it doesn't exist
1390 if "counters" not in universe.groups.get("internal", {}):
1391 Element("internal.counters", universe)
1393 # update the log every now and then
1394 if not universe.groups["internal"]["counters"].get("mark"):
1395 log(str(len(universe.userlist)) + " connection(s)")
1396 universe.groups["internal"]["counters"].set(
1397 "mark", universe.contents["mudpy.timing"].get("status")
1400 universe.groups["internal"]["counters"].set(
1401 "mark", universe.groups["internal"]["counters"].get(
1406 # periodically save everything
1407 if not universe.groups["internal"]["counters"].get("save"):
1409 universe.groups["internal"]["counters"].set(
1410 "save", universe.contents["mudpy.timing"].get("save")
1413 universe.groups["internal"]["counters"].set(
1414 "save", universe.groups["internal"]["counters"].get(
1419 # pause for a configurable amount of time (decimal seconds)
1420 time.sleep(universe.contents["mudpy.timing"].get("increment"))
1422 # increase the elapsed increment counter
1423 universe.groups["internal"]["counters"].set(
1424 "elapsed", universe.groups["internal"]["counters"].get(
1431 """Reload all relevant objects."""
1433 old_userlist = universe.userlist[:]
1434 for element in list(universe.contents.values()):
1437 for user in old_userlist:
1441 def check_for_connection(listening_socket):
1442 """Check for a waiting connection and return a new user object."""
1444 # try to accept a new connection
1446 connection, address = listening_socket.accept()
1447 except BlockingIOError:
1450 # note that we got one
1451 log("New connection from %s." % address[0], 2)
1453 # disable blocking so we can proceed whether or not we can send/receive
1454 connection.setblocking(0)
1456 # create a new user object
1458 log("Instantiated %s for %s." % (user, address[0]), 0)
1460 # associate this connection with it
1461 user.connection = connection
1463 # set the user's ipa from the connection's ipa
1464 user.address = address[0]
1466 # let the client know we WILL EOR (RFC 885)
1467 mudpy.telnet.enable(user, mudpy.telnet.TELOPT_EOR, mudpy.telnet.US)
1468 user.negotiation_pause = 2
1470 # return the new user object
1474 def find_command(command_name):
1475 """Try to find a command by name or abbreviation."""
1477 # lowercase the command
1478 command_name = command_name.lower()
1481 if command_name in universe.groups["command"]:
1482 # the command matches a command word for which we have data
1483 command = universe.groups["command"][command_name]
1485 for candidate in sorted(universe.groups["command"]):
1486 if candidate.startswith(command_name) and not universe.groups[
1487 "command"][candidate].get("administrative"):
1488 # the command matches the start of a command word and is not
1489 # restricted to administrators
1490 command = universe.groups["command"][candidate]
1495 def get_menu(state, error=None, choices=None):
1496 """Show the correct menu text to a user."""
1498 # make sure we don't reuse a mutable sequence by default
1502 # get the description or error text
1503 message = get_menu_description(state, error)
1505 # get menu choices for the current state
1506 message += get_formatted_menu_choices(state, choices)
1508 # try to get a prompt, if it was defined
1509 message += get_menu_prompt(state)
1511 # throw in the default choice, if it exists
1512 message += get_formatted_default_menu_choice(state)
1514 # display a message indicating if echo is off
1515 message += get_echo_message(state)
1517 # return the assembly of various strings defined above
1521 def menu_echo_on(state):
1522 """True if echo is on, false if it is off."""
1523 return universe.groups["menu"][state].get("echo", True)
1526 def get_echo_message(state):
1527 """Return a message indicating that echo is off."""
1528 if menu_echo_on(state):
1531 return "(won't echo) "
1534 def get_default_menu_choice(state):
1535 """Return the default choice for a menu."""
1536 return universe.groups["menu"][state].get("default")
1539 def get_formatted_default_menu_choice(state):
1540 """Default menu choice foratted for inclusion in a prompt string."""
1541 default_choice = get_default_menu_choice(state)
1543 return "[$(red)" + default_choice + "$(nrm)] "
1548 def get_menu_description(state, error):
1549 """Get the description or error text."""
1551 # an error condition was raised by the handler
1554 # try to get an error message matching the condition
1556 description = universe.groups[
1557 "menu"][state].get("error_" + error)
1559 description = "That is not a valid choice..."
1560 description = "$(red)" + description + "$(nrm)"
1562 # there was no error condition
1565 # try to get a menu description for the current state
1566 description = universe.groups["menu"][state].get("description")
1568 # return the description or error message
1570 description += "$(eol)$(eol)"
1574 def get_menu_prompt(state):
1575 """Try to get a prompt, if it was defined."""
1576 prompt = universe.groups["menu"][state].get("prompt")
1582 def get_menu_choices(user):
1583 """Return a dict of choice:meaning."""
1584 menu = universe.groups["menu"][user.state]
1585 create_choices = menu.get("create")
1587 choices = eval(create_choices)
1593 for facet in menu.facets():
1594 if facet.startswith("demand_") and not eval(
1595 universe.groups["menu"][user.state].get(facet)
1597 ignores.append(facet.split("_", 2)[1])
1598 elif facet.startswith("create_"):
1599 creates[facet] = facet.split("_", 2)[1]
1600 elif facet.startswith("choice_"):
1601 options[facet] = facet.split("_", 2)[1]
1602 for facet in creates.keys():
1603 if not creates[facet] in ignores:
1604 choices[creates[facet]] = eval(menu.get(facet))
1605 for facet in options.keys():
1606 if not options[facet] in ignores:
1607 choices[options[facet]] = menu.get(facet)
1611 def get_formatted_menu_choices(state, choices):
1612 """Returns a formatted string of menu choices."""
1614 choice_keys = list(choices.keys())
1616 for choice in choice_keys:
1617 choice_output += " [$(red)" + choice + "$(nrm)] " + choices[
1621 choice_output += "$(eol)"
1622 return choice_output
1625 def get_menu_branches(state):
1626 """Return a dict of choice:branch."""
1628 for facet in universe.groups["menu"][state].facets():
1629 if facet.startswith("branch_"):
1631 facet.split("_", 2)[1]
1632 ] = universe.groups["menu"][state].get(facet)
1636 def get_default_branch(state):
1637 """Return the default branch."""
1638 return universe.groups["menu"][state].get("branch")
1641 def get_choice_branch(user, choice):
1642 """Returns the new state matching the given choice."""
1643 branches = get_menu_branches(user.state)
1644 if choice in branches.keys():
1645 return branches[choice]
1646 elif choice in user.menu_choices.keys():
1647 return get_default_branch(user.state)
1652 def get_menu_actions(state):
1653 """Return a dict of choice:branch."""
1655 for facet in universe.groups["menu"][state].facets():
1656 if facet.startswith("action_"):
1658 facet.split("_", 2)[1]
1659 ] = universe.groups["menu"][state].get(facet)
1663 def get_default_action(state):
1664 """Return the default action."""
1665 return universe.groups["menu"][state].get("action")
1668 def get_choice_action(user, choice):
1669 """Run any indicated script for the given choice."""
1670 actions = get_menu_actions(user.state)
1671 if choice in actions.keys():
1672 return actions[choice]
1673 elif choice in user.menu_choices.keys():
1674 return get_default_action(user.state)
1679 def handle_user_input(user):
1680 """The main handler, branches to a state-specific handler."""
1682 # if the user's client echo is off, send a blank line for aesthetics
1683 if mudpy.telnet.is_enabled(user, mudpy.telnet.TELOPT_ECHO,
1685 user.send("", add_prompt=False, prepend_padding=False)
1687 # check to make sure the state is expected, then call that handler
1689 globals()["handler_" + user.state](user)
1691 generic_menu_handler(user)
1693 # since we got input, flag that the menu/prompt needs to be redisplayed
1694 user.menu_seen = False
1696 # update the last_input timestamp while we're at it
1697 user.last_input = universe.get_time()
1700 def generic_menu_handler(user):
1701 """A generic menu choice handler."""
1703 # get a lower-case representation of the next line of input
1704 if user.input_queue:
1705 choice = user.input_queue.pop(0)
1707 choice = choice.lower()
1711 choice = get_default_menu_choice(user.state)
1712 if choice in user.menu_choices:
1713 exec(get_choice_action(user, choice))
1714 new_state = get_choice_branch(user, choice)
1716 user.state = new_state
1718 user.error = "default"
1721 def handler_entering_account_name(user):
1722 """Handle the login account name."""
1724 # get the next waiting line of input
1725 input_data = user.input_queue.pop(0)
1727 # did the user enter anything?
1730 # keep only the first word and convert to lower-case
1731 name = input_data.lower()
1733 # fail if there are non-alphanumeric characters
1734 if name != "".join(filter(
1735 lambda x: x >= "0" and x <= "9" or x >= "a" and x <= "z",
1737 user.error = "bad_name"
1739 # if that account exists, time to request a password
1740 elif name in universe.groups.get("account", {}):
1741 user.account = universe.groups["account"][name]
1742 user.state = "checking_password"
1744 # otherwise, this could be a brand new user
1746 user.account = Element("account.%s" % name, universe)
1747 user.account.set("name", name)
1748 log("New user: " + name, 2)
1749 user.state = "checking_new_account_name"
1751 # if the user entered nothing for a name, then buhbye
1753 user.state = "disconnecting"
1756 def handler_checking_password(user):
1757 """Handle the login account password."""
1759 # get the next waiting line of input
1760 input_data = user.input_queue.pop(0)
1762 if "mudpy.limit" in universe.contents:
1763 max_password_tries = universe.contents["mudpy.limit"].get(
1764 "password_tries", 3)
1766 max_password_tries = 3
1768 # does the hashed input equal the stored hash?
1769 if mudpy.password.verify(input_data, user.account.get("passhash")):
1771 # if so, set the username and load from cold storage
1772 if not user.replace_old_connections():
1774 user.state = "main_utility"
1776 # if at first your hashes don't match, try, try again
1777 elif user.password_tries < max_password_tries - 1:
1778 user.password_tries += 1
1779 user.error = "incorrect"
1781 # we've exceeded the maximum number of password failures, so disconnect
1784 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1786 user.state = "disconnecting"
1789 def handler_entering_new_password(user):
1790 """Handle a new password entry."""
1792 # get the next waiting line of input
1793 input_data = user.input_queue.pop(0)
1795 if "mudpy.limit" in universe.contents:
1796 max_password_tries = universe.contents["mudpy.limit"].get(
1797 "password_tries", 3)
1799 max_password_tries = 3
1801 # make sure the password is strong--at least one upper, one lower and
1802 # one digit, seven or more characters in length
1803 if len(input_data) > 6 and len(
1804 list(filter(lambda x: x >= "0" and x <= "9", input_data))
1806 list(filter(lambda x: x >= "A" and x <= "Z", input_data))
1808 list(filter(lambda x: x >= "a" and x <= "z", input_data))
1811 # hash and store it, then move on to verification
1812 user.account.set("passhash", mudpy.password.create(input_data))
1813 user.state = "verifying_new_password"
1815 # the password was weak, try again if you haven't tried too many times
1816 elif user.password_tries < max_password_tries - 1:
1817 user.password_tries += 1
1820 # too many tries, so adios
1823 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1825 user.account.destroy()
1826 user.state = "disconnecting"
1829 def handler_verifying_new_password(user):
1830 """Handle the re-entered new password for verification."""
1832 # get the next waiting line of input
1833 input_data = user.input_queue.pop(0)
1835 if "mudpy.limit" in universe.contents:
1836 max_password_tries = universe.contents["mudpy.limit"].get(
1837 "password_tries", 3)
1839 max_password_tries = 3
1841 # hash the input and match it to storage
1842 if mudpy.password.verify(input_data, user.account.get("passhash")):
1845 # the hashes matched, so go active
1846 if not user.replace_old_connections():
1847 user.state = "main_utility"
1849 # go back to entering the new password as long as you haven't tried
1851 elif user.password_tries < max_password_tries - 1:
1852 user.password_tries += 1
1853 user.error = "differs"
1854 user.state = "entering_new_password"
1856 # otherwise, sayonara
1859 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1861 user.account.destroy()
1862 user.state = "disconnecting"
1865 def handler_active(user):
1866 """Handle input for active users."""
1868 # get the next waiting line of input
1869 input_data = user.input_queue.pop(0)
1874 # split out the command and parameters
1876 mode = actor.get("mode")
1877 if mode and input_data.startswith("!"):
1878 command_name, parameters = first_word(input_data[1:])
1879 elif mode == "chat":
1880 command_name = "say"
1881 parameters = input_data
1883 command_name, parameters = first_word(input_data)
1885 # expand to an actual command
1886 command = find_command(command_name)
1888 # if it's allowed, do it
1890 if actor.can_run(command):
1891 # dereference the relative object path for the requested function
1893 action_fname = command.get("action", command.key)
1894 for component in action_fname.split("."):
1896 action = getattr(action, component)
1898 except AttributeError:
1899 log('Could not find action function "%s" for command "%s"'
1900 % (action_fname, command_name))
1905 action(actor, parameters)
1907 log('Command string "%s" from user %s raised an '
1908 'exception...\n%s' % (
1909 input_data, actor.owner.account.get("name"),
1910 traceback.format_exc()))
1911 mudpy.command.error(actor, input_data)
1913 # if the command was not run, give an error
1915 mudpy.command.error(actor, input_data)
1917 # if no input, just idle back with a prompt
1919 user.send("", just_prompt=True)
1922 def daemonize(universe):
1923 """Fork and disassociate from everything."""
1925 # only if this is what we're configured to do
1926 if "mudpy.process" in universe.contents and universe.contents[
1927 "mudpy.process"].get("daemon"):
1929 # log before we start forking around, so the terminal gets the message
1930 log("Disassociating from the controlling terminal.")
1932 # fork off and die, so we free up the controlling terminal
1936 # switch to a new process group
1939 # fork some more, this time to free us from the old process group
1943 # reset the working directory so we don't needlessly tie up mounts
1946 # clear the file creation mask so we can bend it to our will later
1949 # redirect stdin/stdout/stderr and close off their former descriptors
1950 for stdpipe in range(3):
1952 sys.stdin = codecs.open("/dev/null", "r", "utf-8")
1953 sys.__stdin__ = codecs.open("/dev/null", "r", "utf-8")
1954 sys.stdout = codecs.open("/dev/null", "w", "utf-8")
1955 sys.stderr = codecs.open("/dev/null", "w", "utf-8")
1956 sys.__stdout__ = codecs.open("/dev/null", "w", "utf-8")
1957 sys.__stderr__ = codecs.open("/dev/null", "w", "utf-8")
1960 def create_pidfile(universe):
1961 """Write a file containing the current process ID."""
1962 pid = str(os.getpid())
1963 log("Process ID: " + pid)
1964 if "mudpy.process" in universe.contents:
1965 file_name = universe.contents["mudpy.process"].get("pidfile", "")
1969 if not os.path.isabs(file_name):
1970 file_name = os.path.join(universe.startdir, file_name)
1971 os.makedirs(os.path.dirname(file_name), exist_ok=True)
1972 file_descriptor = codecs.open(file_name, "w", "utf-8")
1973 file_descriptor.write(pid + "\n")
1974 file_descriptor.flush()
1975 file_descriptor.close()
1978 def remove_pidfile(universe):
1979 """Remove the file containing the current process ID."""
1980 if "mudpy.process" in universe.contents:
1981 file_name = universe.contents["mudpy.process"].get("pidfile", "")
1985 if not os.path.isabs(file_name):
1986 file_name = os.path.join(universe.startdir, file_name)
1987 if os.access(file_name, os.W_OK):
1988 os.remove(file_name)
1991 def excepthook(excepttype, value, tracebackdata):
1992 """Handle uncaught exceptions."""
1994 # assemble the list of errors into a single string
1996 traceback.format_exception(excepttype, value, tracebackdata)
1999 # try to log it, if possible
2002 except Exception as e:
2003 # try to write it to stderr, if possible
2004 sys.stderr.write(message + "\nException while logging...\n%s" % e)
2007 def sighook(what, where):
2008 """Handle external signals."""
2011 message = "Caught signal: "
2013 # for a hangup signal
2014 if what == signal.SIGHUP:
2015 message += "hangup (reloading)"
2016 universe.reload_flag = True
2018 # for a terminate signal
2019 elif what == signal.SIGTERM:
2020 message += "terminate (halting)"
2021 universe.terminate_flag = True
2023 # catchall for unexpected signals
2025 message += str(what) + " (unhandled)"
2031 def override_excepthook():
2032 """Redefine sys.excepthook with our own."""
2033 sys.excepthook = excepthook
2036 def assign_sighook():
2037 """Assign a customized handler for some signals."""
2038 signal.signal(signal.SIGHUP, sighook)
2039 signal.signal(signal.SIGTERM, sighook)
2043 """This contains functions to be performed when starting the engine."""
2045 # see if a configuration file was specified
2046 if len(sys.argv) > 1:
2047 conffile = sys.argv[1]
2053 universe = Universe(conffile, True)
2055 # report any loglines which accumulated during setup
2056 for logline in universe.setup_loglines:
2058 universe.setup_loglines = []
2060 # fork and disassociate
2063 # override the default exception handler so we get logging first thing
2064 override_excepthook()
2066 # set up custom signal handlers
2070 create_pidfile(universe)
2072 # load and store diagnostic info
2073 universe.versions = mudpy.version.Versions("mudpy")
2075 # log startup diagnostic messages
2076 log("On %s at %s" % (universe.versions.python_version, sys.executable), 1)
2077 log("Import path: %s" % ", ".join(sys.path), 1)
2078 log("Installed dependencies: %s" % universe.versions.dependencies_text, 1)
2079 log("Other python packages: %s" % universe.versions.environment_text, 1)
2080 log("Running version: %s" % universe.versions.version, 1)
2081 log("Initial directory: %s" % universe.startdir, 1)
2082 log("Command line: %s" % " ".join(sys.argv), 1)
2084 # pass the initialized universe back
2089 """These are functions performed when shutting down the engine."""
2091 # the loop has terminated, so save persistent data
2094 # log a final message
2095 log("Shutting down now.")
2097 # get rid of the pidfile
2098 remove_pidfile(universe)