1 """Miscellaneous functions for the mudpy engine."""
3 # Copyright (c) 2004-2016 Jeremy Stanley <fungi@yuggoth.org>. Permission
4 # to use, copy, modify, and distribute this software is granted under
5 # terms provided in the LICENSE file distributed with this software.
24 """An element of the universe."""
26 def __init__(self, key, universe, filename=None, old_style=False):
27 """Set up a new element."""
29 # TODO(fungi): This can be removed after the transition is complete
30 self.old_style = old_style
32 # keep track of our key name
35 # keep track of what universe it's loading into
36 self.universe = universe
38 # clone attributes if this is replacing another element
39 if self.old_style and self.key in self.universe.contents:
40 old_element = self.universe.contents[self.key]
41 for attribute in vars(old_element).keys():
42 exec("self." + attribute + " = old_element." + attribute)
44 self.owner.avatar = self
46 # i guess this is a new element then
49 # set of facet keys from the universe
50 self.facethash = dict()
52 # not owned by a user by default (used for avatars)
55 # no contents in here by default
58 # parse out appropriate category and subkey names, add to list
59 if self.key.find(":") > 0:
60 self.category, self.subkey = self.key.split(":", 1)
62 self.category = "other"
63 self.subkey = self.key
64 if self.category not in self.universe.categories:
65 self.category = "other"
66 self.subkey = self.key
68 # get an appropriate filename for the origin
70 filename = self.universe.default_origins[self.category]
71 if not os.path.isabs(filename):
72 filename = os.path.abspath(filename)
74 # add the file if it doesn't exist yet
75 if filename not in self.universe.files:
76 mudpy.data.DataFile(filename, self.universe)
78 # record or reset a pointer to the origin file
79 self.origin = self.universe.files[filename]
81 # add a data section to the origin if necessary
82 if self.key not in self.origin.data:
83 self.origin.data[self.key] = {}
85 # add or replace this element in the universe
86 self.universe.contents[self.key] = self
87 self.universe.categories[self.category][self.subkey] = self
90 """Create a new element and replace this one."""
91 Element(self.key, self.universe, self.origin.filename,
92 old_style=self.old_style)
96 """Remove an element from the universe and destroy it."""
97 del(self.origin.data[self.key])
98 del self.universe.categories[self.category][self.subkey]
99 del self.universe.contents[self.key]
103 """Return a list of non-inherited facets for this element."""
106 return self.origin.data[self.key].keys()
107 except (AttributeError, KeyError):
110 return self.facethash
112 def has_facet(self, facet):
113 """Return whether the non-inherited facet exists."""
114 return facet in self.facets()
116 def remove_facet(self, facet):
117 """Remove a facet from the element."""
118 if self.has_facet(facet):
119 del(self.origin.data[self.key][facet])
120 self.origin.modified = True
123 """Return a list of the element's inheritance lineage."""
124 if self.has_facet("inherit"):
125 ancestry = self.get("inherit")
128 for parent in ancestry[:]:
129 ancestors = self.universe.contents[parent].ancestry()
130 for ancestor in ancestors:
131 if ancestor not in ancestry:
132 ancestry.append(ancestor)
137 def get(self, facet, default=None):
138 """Retrieve values."""
143 return self.origin.data[self.key][facet]
145 return self.origin.data[".".join((self.key, facet))]
146 except (KeyError, TypeError):
148 if self.has_facet("inherit"):
149 for ancestor in self.ancestry():
150 if self.universe.contents[ancestor].has_facet(facet):
151 return self.universe.contents[ancestor].get(facet)
155 def set(self, facet, value):
157 if not self.has_facet(facet) or not self.get(facet) == value:
159 if self.key not in self.origin.data:
160 self.origin.data[self.key] = {}
161 self.origin.data[self.key][facet] = value
163 node = ".".join((self.key, facet))
164 self.origin.data[node] = value
165 self.facethash[node] = self.origin.data[node]
166 self.origin.modified = True
168 def append(self, facet, value):
169 """Append value to a list."""
170 newlist = self.get(facet)
173 if type(newlist) is not list:
174 newlist = list(newlist)
175 newlist.append(value)
176 self.set(facet, newlist)
186 add_terminator=False,
189 """Convenience method to pass messages to an owner."""
202 def can_run(self, command):
203 """Check if the user can run this command object."""
205 # has to be in the commands category
206 if command not in self.universe.categories["command"].values():
209 # avatars of administrators can run any command
210 elif self.owner and self.owner.account.get("administrator"):
213 # everyone can run non-administrative commands
214 elif not command.get("administrative"):
217 # otherwise the command cannot be run by this actor
221 # pass back the result
224 def update_location(self):
225 """Make sure the location's contents contain this element."""
226 area = self.get("location")
227 if area in self.universe.contents:
228 self.universe.contents[area].contents[self.key] = self
230 def clean_contents(self):
231 """Make sure the element's contents aren't bogus."""
232 for element in self.contents.values():
233 if element.get("location") != self.key:
234 del self.contents[element.key]
236 def go_to(self, area):
237 """Relocate the element to a specific area."""
238 current = self.get("location")
239 if current and self.key in self.universe.contents[current].contents:
240 del universe.contents[current].contents[self.key]
241 if area in self.universe.contents:
242 self.set("location", area)
243 self.universe.contents[area].contents[self.key] = self
247 """Relocate the element to its default location."""
248 self.go_to(self.get("default_location"))
249 self.echo_to_location(
250 "You suddenly realize that " + self.get("name") + " is here."
253 def move_direction(self, direction):
254 """Relocate the element in a specified direction."""
255 motion = self.universe.contents["mudpy.movement.%s" % direction]
256 enter_term = motion.get("enter_term")
257 exit_term = motion.get("exit_term")
258 self.echo_to_location("%s exits %s." % (self.get("name"), exit_term))
259 self.send("You exit %s." % exit_term, add_prompt=False)
261 self.universe.contents[
262 self.get("location")].link_neighbor(direction)
264 self.echo_to_location("%s arrives from %s." % (
265 self.get("name"), enter_term))
267 def look_at(self, key):
268 """Show an element to another element."""
270 element = self.universe.contents[key]
272 name = element.get("name")
274 message += "$(cyn)" + name + "$(nrm)$(eol)"
275 description = element.get("description")
277 message += description + "$(eol)"
278 portal_list = list(element.portals().keys())
281 message += "$(cyn)[ Exits: " + ", ".join(
284 for element in self.universe.contents[
287 if element.get("is_actor") and element is not self:
288 message += "$(yel)" + element.get(
290 ) + " is here.$(nrm)$(eol)"
291 elif element is not self:
292 message += "$(grn)" + element.get(
298 """Map the portal directions for an area to neighbors."""
300 if re.match("""^area:-?\d+,-?\d+,-?\d+$""", self.key):
301 coordinates = [(int(x))
302 for x in self.key.split(":")[1].split(",")]
305 self.universe.contents["mudpy.movement.%s" % x].get("vector")
306 ) for x in self.universe.directions)
307 for portal in self.get("gridlinks"):
308 adjacent = map(lambda c, o: c + o,
309 coordinates, offsets[portal])
310 neighbor = "area:" + ",".join(
311 [(str(x)) for x in adjacent]
313 if neighbor in self.universe.contents:
314 portals[portal] = neighbor
315 for facet in self.facets():
316 if facet.startswith("link_"):
317 neighbor = self.get(facet)
318 if neighbor in self.universe.contents:
319 portal = facet.split("_")[1]
320 portals[portal] = neighbor
323 def link_neighbor(self, direction):
324 """Return the element linked in a given direction."""
325 portals = self.portals()
326 if direction in portals:
327 return portals[direction]
329 def echo_to_location(self, message):
330 """Show a message to other elements in the current location."""
331 for element in self.universe.contents[
334 if element is not self:
335 element.send(message)
342 def __init__(self, filename="", load=False):
343 """Initialize the universe."""
346 self.default_origins = {}
347 self.directions = set()
349 self.private_files = []
350 self.reload_flag = False
351 self.setup_loglines = []
352 self.startdir = os.getcwd()
353 self.terminate_flag = False
356 possible_filenames = [
358 "/usr/local/mudpy/etc/mudpy.yaml",
359 "/usr/local/etc/mudpy.yaml",
360 "/etc/mudpy/mudpy.yaml",
363 for filename in possible_filenames:
364 if os.access(filename, os.R_OK):
366 if not os.path.isabs(filename):
367 filename = os.path.join(self.startdir, filename)
368 self.filename = filename
370 # make sure to preserve any accumulated log entries during load
371 self.setup_loglines += self.load()
374 """Load universe data from persistent storage."""
376 # it's possible for this to enter before logging configuration is read
377 pending_loglines = []
379 # the files dict must exist and filename needs to be read-only
383 self.filename in self.files and self.files[
388 # clear out all read-only files
389 if hasattr(self, "files"):
390 for data_filename in list(self.files.keys()):
391 if not self.files[data_filename].is_writeable():
392 del self.files[data_filename]
394 # start loading from the initial file
395 mudpy.data.DataFile(self.filename, self)
397 # make a list of inactive avatars
398 inactive_avatars = []
399 for account in self.categories["account"].values():
400 for avatar in account.get("avatars"):
402 inactive_avatars.append(self.contents[avatar])
404 pending_loglines.append((
405 "Missing avatar \"%s\", possible data corruption" %
407 for user in self.userlist:
408 if user.avatar in inactive_avatars:
409 inactive_avatars.remove(user.avatar)
411 # go through all elements to clear out inactive avatar locations
412 for element in self.contents.values():
413 area = element.get("location")
414 if element in inactive_avatars and area:
415 if area in self.contents and element.key in self.contents[
418 del self.contents[area].contents[element.key]
419 element.set("default_location", area)
420 element.remove_facet("location")
422 # another pass to straighten out all the element contents
423 for element in self.contents.values():
424 element.update_location()
425 element.clean_contents()
426 return pending_loglines
429 """Create a new, empty Universe (the Big Bang)."""
430 new_universe = Universe()
431 for attribute in vars(self).keys():
432 exec("new_universe." + attribute + " = self." + attribute)
433 new_universe.reload_flag = False
438 """Save the universe to persistent storage."""
439 for key in self.files:
440 self.files[key].save()
442 def initialize_server_socket(self):
443 """Create and open the listening socket."""
445 # need to know the local address and port number for the listener
446 host = self.contents["mudpy.network"].get("host")
447 port = self.contents["mudpy.network"].get("port")
449 # if no host was specified, bind to all local addresses (preferring
457 # figure out if this is ipv4 or v6
458 family = socket.getaddrinfo(host, port)[0][0]
459 if family is socket.AF_INET6 and not socket.has_ipv6:
460 log("No support for IPv6 address %s (use IPv4 instead)." % host)
462 # create a new stream-type socket object
463 self.listening_socket = socket.socket(family, socket.SOCK_STREAM)
465 # set the socket options to allow existing open ones to be
466 # reused (fixes a bug where the server can't bind for a minute
467 # when restarting on linux systems)
468 self.listening_socket.setsockopt(
469 socket.SOL_SOCKET, socket.SO_REUSEADDR, 1
472 # bind the socket to to our desired server ipa and port
473 self.listening_socket.bind((host, port))
475 # disable blocking so we can proceed whether or not we can
477 self.listening_socket.setblocking(0)
479 # start listening on the socket
480 self.listening_socket.listen(1)
482 # note that we're now ready for user connections
484 "Listening for Telnet connections on: " +
485 host + ":" + str(port)
489 """Convenience method to get the elapsed time counter."""
490 return self.categories["internal"]["counters"].get("elapsed")
495 """This is a connected user."""
498 """Default values for the in-memory user variables."""
501 self.authenticated = False
504 self.connection = None
506 self.input_queue = []
507 self.last_address = ""
508 self.last_input = universe.get_time()
509 self.menu_choices = {}
510 self.menu_seen = False
511 self.negotiation_pause = 0
512 self.output_queue = []
513 self.partial_input = b""
514 self.password_tries = 0
515 self.state = "initial"
519 """Log, close the connection and remove."""
521 name = self.account.get("name")
525 message = "User " + name
527 message = "An unnamed user"
528 message += " logged out."
530 self.deactivate_avatar()
531 self.connection.close()
534 def check_idle(self):
535 """Warn or disconnect idle users as appropriate."""
536 idletime = universe.get_time() - self.last_input
537 linkdead_dict = universe.categories["internal"]["time"].get(
540 if self.state in linkdead_dict:
541 linkdead_state = self.state
543 linkdead_state = "default"
544 if idletime > linkdead_dict[linkdead_state]:
546 "$(eol)$(red)You've done nothing for far too long... goodbye!"
551 logline = "Disconnecting "
552 if self.account and self.account.get("name"):
553 logline += self.account.get("name")
555 logline += "an unknown user"
556 logline += (" after idling too long in the " + self.state
559 self.state = "disconnecting"
560 self.menu_seen = False
561 idle_dict = universe.categories["internal"]["time"].get("idle")
562 if self.state in idle_dict:
563 idle_state = self.state
565 idle_state = "default"
566 if idletime == idle_dict[idle_state]:
568 "$(eol)$(red)If you continue to be unproductive, "
569 + "you'll be shown the door...$(nrm)$(eol)"
573 """Save, load a new user and relocate the connection."""
575 # get out of the list
578 # create a new user object
581 # set everything equivalent
582 for attribute in vars(self).keys():
583 exec("new_user." + attribute + " = self." + attribute)
585 # the avatar needs a new owner
587 new_user.avatar.owner = new_user
590 universe.userlist.append(new_user)
592 # get rid of the old user object
595 def replace_old_connections(self):
596 """Disconnect active users with the same name."""
598 # the default return value
601 # iterate over each user in the list
602 for old_user in universe.userlist:
604 # the name is the same but it's not us
607 ) and old_user.account and old_user.account.get(
609 ) == self.account.get(
611 ) and old_user is not self:
615 "User " + self.account.get(
617 ) + " reconnected--closing old connection to "
618 + old_user.address + ".",
622 "$(eol)$(red)New connection from " + self.address
623 + ". Terminating old connection...$(nrm)$(eol)",
628 # close the old connection
629 old_user.connection.close()
631 # replace the old connection with this one
633 "$(eol)$(red)Taking over old connection from "
634 + old_user.address + ".$(nrm)"
636 old_user.connection = self.connection
637 old_user.last_address = old_user.address
638 old_user.address = self.address
640 # take this one out of the list and delete
646 # true if an old connection was replaced, false if not
649 def authenticate(self):
650 """Flag the user as authenticated and disconnect duplicates."""
651 if self.state is not "authenticated":
652 log("User " + self.account.get("name") + " logged in.", 2)
653 self.authenticated = True
654 if ("mudpy.limit" in universe.contents and self.account.subkey in
655 universe.contents["mudpy.limit"].get("admins")):
656 self.account.set("administrator", "True")
659 """Send the user their current menu."""
660 if not self.menu_seen:
661 self.menu_choices = get_menu_choices(self)
663 get_menu(self.state, self.error, self.menu_choices),
667 self.menu_seen = True
669 self.adjust_echoing()
671 def adjust_echoing(self):
672 """Adjust echoing to match state menu requirements."""
673 if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_ECHO,
675 if menu_echo_on(self.state):
676 mudpy.telnet.disable(self, mudpy.telnet.TELOPT_ECHO,
678 elif not menu_echo_on(self.state):
679 mudpy.telnet.enable(self, mudpy.telnet.TELOPT_ECHO,
683 """Remove a user from the list of connected users."""
684 universe.userlist.remove(self)
694 add_terminator=False,
697 """Send arbitrary text to a connected user."""
699 # unless raw mode is on, clean it up all nice and pretty
702 # strip extra $(eol) off if present
703 while output.startswith("$(eol)"):
705 while output.endswith("$(eol)"):
707 extra_lines = output.find("$(eol)$(eol)$(eol)")
708 while extra_lines > -1:
709 output = output[:extra_lines] + output[extra_lines + 6:]
710 extra_lines = output.find("$(eol)$(eol)$(eol)")
712 # start with a newline, append the message, then end
713 # with the optional eol string passed to this function
714 # and the ansi escape to return to normal text
715 if not just_prompt and prepend_padding:
716 if (not self.output_queue or not
717 self.output_queue[-1].endswith(b"\r\n")):
718 output = "$(eol)" + output
719 elif not self.output_queue[-1].endswith(
721 ) and not self.output_queue[-1].endswith(
724 output = "$(eol)" + output
725 output += eol + chr(27) + "[0m"
727 # tack on a prompt if active
728 if self.state == "active":
733 mode = self.avatar.get("mode")
735 output += "(" + mode + ") "
737 # find and replace macros in the output
738 output = replace_macros(self, output)
740 # wrap the text at the client's width (min 40, 0 disables)
742 if self.columns < 40:
746 output = wrap_ansi_text(output, wrap)
748 # if supported by the client, encode it utf-8
749 if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_BINARY,
751 encoded_output = output.encode("utf-8")
753 # otherwise just send ascii
755 encoded_output = output.encode("ascii", "replace")
757 # end with a terminator if requested
758 if add_prompt or add_terminator:
759 if mudpy.telnet.is_enabled(
760 self, mudpy.telnet.TELOPT_EOR, mudpy.telnet.US):
761 encoded_output += mudpy.telnet.telnet_proto(
762 mudpy.telnet.IAC, mudpy.telnet.EOR)
763 elif not mudpy.telnet.is_enabled(
764 self, mudpy.telnet.TELOPT_SGA, mudpy.telnet.US):
765 encoded_output += mudpy.telnet.telnet_proto(
766 mudpy.telnet.IAC, mudpy.telnet.GA)
768 # and tack it onto the queue
769 self.output_queue.append(encoded_output)
771 # if this is urgent, flush all pending output
775 # just dump raw bytes as requested
777 self.output_queue.append(output)
781 """All the things to do to the user per increment."""
783 # if the world is terminating, disconnect
784 if universe.terminate_flag:
785 self.state = "disconnecting"
786 self.menu_seen = False
788 # check for an idle connection and act appropriately
792 # if output is paused, decrement the counter
793 if self.state == "initial":
794 if self.negotiation_pause:
795 self.negotiation_pause -= 1
797 self.state = "entering_account_name"
799 # show the user a menu as needed
800 elif not self.state == "active":
803 # flush any pending output in the queue
806 # disconnect users with the appropriate state
807 if self.state == "disconnecting":
810 # check for input and add it to the queue
813 # there is input waiting in the queue
815 handle_user_input(self)
818 """Try to send the last item in the queue and remove it."""
819 if self.output_queue:
821 self.connection.send(self.output_queue[0])
822 except BrokenPipeError:
823 if self.account and self.account.get("name"):
824 account = self.account.get("name")
826 account = "an unknown user"
827 self.state = "disconnecting"
828 log("Broken pipe sending to %s." % account, 7)
829 del self.output_queue[0]
831 def enqueue_input(self):
832 """Process and enqueue any new input."""
834 # check for some input
836 raw_input = self.connection.recv(1024)
837 except (BlockingIOError, OSError):
843 # tack this on to any previous partial
844 self.partial_input += raw_input
846 # reply to and remove any IAC negotiation codes
847 mudpy.telnet.negotiate_telnet_options(self)
849 # separate multiple input lines
850 new_input_lines = self.partial_input.split(b"\n")
852 # if input doesn't end in a newline, replace the
853 # held partial input with the last line of it
854 if not self.partial_input.endswith(b"\n"):
855 self.partial_input = new_input_lines.pop()
857 # otherwise, chop off the extra null input and reset
858 # the held partial input
860 new_input_lines.pop()
861 self.partial_input = b""
863 # iterate over the remaining lines
864 for line in new_input_lines:
866 # strip off extra whitespace
869 # log non-printable characters remaining
870 if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_BINARY,
872 asciiline = bytes([x for x in line if 32 <= x <= 126])
873 if line != asciiline:
874 logline = "Non-ASCII characters from "
875 if self.account and self.account.get("name"):
876 logline += self.account.get("name") + ": "
878 logline += "unknown user: "
879 logline += repr(line)
884 line = line.decode("utf-8")
885 except UnicodeDecodeError:
886 logline = "Non-UTF-8 characters from "
887 if self.account and self.account.get("name"):
888 logline += self.account.get("name") + ": "
890 logline += "unknown user: "
891 logline += repr(line)
895 line = unicodedata.normalize("NFKC", line)
897 # put on the end of the queue
898 self.input_queue.append(line)
900 def new_avatar(self):
901 """Instantiate a new, unconfigured avatar for this user."""
903 while "avatar:" + self.account.get("name") + ":" + str(
905 ) in universe.categories["actor"].keys():
907 self.avatar = Element(
908 "actor:avatar:" + self.account.get("name") + ":" + str(
911 universe, old_style=True
913 self.avatar.append("inherit", "archetype:avatar")
914 self.account.append("avatars", self.avatar.key)
916 def delete_avatar(self, avatar):
917 """Remove an avatar from the world and from the user's list."""
918 if self.avatar is universe.contents[avatar]:
920 universe.contents[avatar].destroy()
921 avatars = self.account.get("avatars")
922 avatars.remove(avatar)
923 self.account.set("avatars", avatars)
925 def activate_avatar_by_index(self, index):
926 """Enter the world with a particular indexed avatar."""
927 self.avatar = universe.contents[
928 self.account.get("avatars")[index]]
929 self.avatar.owner = self
930 self.state = "active"
931 self.avatar.go_home()
933 def deactivate_avatar(self):
934 """Have the active avatar leave the world."""
936 current = self.avatar.get("location")
938 self.avatar.set("default_location", current)
939 self.avatar.echo_to_location(
940 "You suddenly wonder where " + self.avatar.get(
944 del universe.contents[current].contents[self.avatar.key]
945 self.avatar.remove_facet("location")
946 self.avatar.owner = None
950 """Destroy the user and associated avatars."""
951 for avatar in self.account.get("avatars"):
952 self.delete_avatar(avatar)
953 self.account.destroy()
955 def list_avatar_names(self):
956 """List names of assigned avatars."""
958 for avatar in self.account.get("avatars"):
960 avatars.append(universe.contents[avatar].get("name"))
962 log("Missing avatar \"%s\", possible data corruption." %
967 def broadcast(message, add_prompt=True):
968 """Send a message to all connected users."""
969 for each_user in universe.userlist:
970 each_user.send("$(eol)" + message, add_prompt=add_prompt)
973 def log(message, level=0):
976 # a couple references we need
977 if "mudpy.log" in universe.contents:
978 file_name = universe.contents["mudpy.log"].get("file", "")
979 max_log_lines = universe.contents["mudpy.log"].get("lines", 0)
980 syslog_name = universe.contents["mudpy.log"].get("syslog", "")
985 timestamp = time.asctime()[4:19]
987 # turn the message into a list of nonempty lines
988 lines = [x for x in [(x.rstrip()) for x in message.split("\n")] if x != ""]
990 # send the timestamp and line to a file
992 if not os.path.isabs(file_name):
993 file_name = os.path.join(universe.startdir, file_name)
994 file_descriptor = codecs.open(file_name, "a", "utf-8")
996 file_descriptor.write(timestamp + " " + line + "\n")
997 file_descriptor.flush()
998 file_descriptor.close()
1000 # send the timestamp and line to standard output
1001 if ("mudpy.log" in universe.contents and
1002 universe.contents["mudpy.log"].get("stdout")):
1004 print(timestamp + " " + line)
1006 # send the line to the system log
1009 syslog_name.encode("utf-8"),
1011 syslog.LOG_INFO | syslog.LOG_DAEMON
1017 # display to connected administrators
1018 for user in universe.userlist:
1019 if user.state == "active" and user.account.get(
1021 ) and user.account.get("loglevel", 0) <= level:
1022 # iterate over every line in the message
1026 "$(bld)$(red)" + timestamp + " "
1027 + line.replace("$(", "$_(") + "$(nrm)$(eol)")
1028 user.send(full_message, flush=True)
1030 # add to the recent log list
1032 while 0 < len(universe.loglines) >= max_log_lines:
1033 del universe.loglines[0]
1034 universe.loglines.append((level, timestamp + " " + line))
1037 def get_loglines(level, start, stop):
1038 """Return a specific range of loglines filtered by level."""
1040 # filter the log lines
1041 loglines = [x for x in universe.loglines if x[0] >= level]
1043 # we need these in several places
1044 total_count = str(len(universe.loglines))
1045 filtered_count = len(loglines)
1047 # don't proceed if there are no lines
1050 # can't start before the begining or at the end
1051 if start > filtered_count:
1052 start = filtered_count
1056 # can't stop before we start
1063 message = "There are " + str(total_count)
1064 message += " log lines in memory and " + str(filtered_count)
1065 message += " at or above level " + str(level) + "."
1066 message += " The matching lines from " + str(stop) + " to "
1067 message += str(start) + " are:$(eol)$(eol)"
1069 # add the text from the selected lines
1071 range_lines = loglines[-start:-(stop - 1)]
1073 range_lines = loglines[-start:]
1074 for line in range_lines:
1075 message += " (" + str(line[0]) + ") " + line[1].replace(
1079 # there were no lines
1081 message = "None of the " + str(total_count)
1082 message += " lines in memory matches your request."
1088 def glyph_columns(character):
1089 """Convenience function to return the column width of a glyph."""
1090 if unicodedata.east_asian_width(character) in "FW":
1096 def wrap_ansi_text(text, width):
1097 """Wrap text with arbitrary width while ignoring ANSI colors."""
1099 # the current position in the entire text string, including all
1100 # characters, printable or otherwise
1103 # the current text position relative to the begining of the line,
1104 # ignoring color escape sequences
1107 # the absolute position of the most recent whitespace character
1110 # whether the current character is part of a color escape sequence
1113 # normalize any potentially composited unicode before we count it
1114 text = unicodedata.normalize("NFKC", text)
1116 # iterate over each character from the begining of the text
1117 for each_character in text:
1119 # the current character is the escape character
1120 if each_character == "\x1b" and not escape:
1123 # the current character is within an escape sequence
1126 # the current character is m, which terminates the
1128 if each_character == "m":
1131 # the current character is a newline, so reset the relative
1132 # position (start a new line)
1133 elif each_character == "\n":
1135 last_whitespace = abs_pos
1137 # the current character meets the requested maximum line width,
1138 # so we need to backtrack and find a space at which to wrap;
1139 # special care is taken to avoid an off-by-one in case the
1140 # current character is a double-width glyph
1141 elif each_character != "\r" and (
1142 rel_pos >= width or (
1143 rel_pos >= width - 1 and glyph_columns(
1149 # it's always possible we landed on whitespace
1150 if unicodedata.category(each_character) in ("Cc", "Zs"):
1151 last_whitespace = abs_pos
1153 # insert an eol in place of the space
1154 text = text[:last_whitespace] + "\r\n" + text[last_whitespace + 1:]
1156 # increase the absolute position because an eol is two
1157 # characters but the space it replaced was only one
1160 # now we're at the begining of a new line, plus the
1161 # number of characters wrapped from the previous line
1163 for remaining_characters in text[last_whitespace:abs_pos]:
1164 rel_pos += glyph_columns(remaining_characters)
1166 # as long as the character is not a carriage return and the
1167 # other above conditions haven't been met, count it as a
1168 # printable character
1169 elif each_character != "\r":
1170 rel_pos += glyph_columns(each_character)
1171 if unicodedata.category(each_character) in ("Cc", "Zs"):
1172 last_whitespace = abs_pos
1174 # increase the absolute position for every character
1177 # return the newly-wrapped text
1181 def weighted_choice(data):
1182 """Takes a dict weighted by value and returns a random key."""
1184 # this will hold our expanded list of keys from the data
1187 # create the expanded list of keys
1188 for key in data.keys():
1189 for count in range(data[key]):
1190 expanded.append(key)
1192 # return one at random
1193 return random.choice(expanded)
1197 """Returns a random character name."""
1199 # the vowels and consonants needed to create romaji syllables
1228 # this dict will hold our weighted list of syllables
1231 # generate the list with an even weighting
1232 for consonant in consonants:
1233 for vowel in vowels:
1234 syllables[consonant + vowel] = 1
1236 # we'll build the name into this string
1239 # create a name of random length from the syllables
1240 for syllable in range(random.randrange(2, 6)):
1241 name += weighted_choice(syllables)
1243 # strip any leading quotemark, capitalize and return the name
1244 return name.strip("'").capitalize()
1247 def replace_macros(user, text, is_input=False):
1248 """Replaces macros in text output."""
1250 # third person pronouns
1252 "female": {"obj": "her", "pos": "hers", "sub": "she"},
1253 "male": {"obj": "him", "pos": "his", "sub": "he"},
1254 "neuter": {"obj": "it", "pos": "its", "sub": "it"}
1257 # a dict of replacement macros
1260 "bld": chr(27) + "[1m",
1261 "nrm": chr(27) + "[0m",
1262 "blk": chr(27) + "[30m",
1263 "blu": chr(27) + "[34m",
1264 "cyn": chr(27) + "[36m",
1265 "grn": chr(27) + "[32m",
1266 "mgt": chr(27) + "[35m",
1267 "red": chr(27) + "[31m",
1268 "yel": chr(27) + "[33m",
1271 # add dynamic macros where possible
1273 account_name = user.account.get("name")
1275 macros["account"] = account_name
1277 avatar_gender = user.avatar.get("gender")
1279 macros["tpop"] = pronouns[avatar_gender]["obj"]
1280 macros["tppp"] = pronouns[avatar_gender]["pos"]
1281 macros["tpsp"] = pronouns[avatar_gender]["sub"]
1286 # find and replace per the macros dict
1287 macro_start = text.find("$(")
1288 if macro_start == -1:
1290 macro_end = text.find(")", macro_start) + 1
1291 macro = text[macro_start + 2:macro_end - 1]
1292 if macro in macros.keys():
1293 replacement = macros[macro]
1295 # this is how we handle local file inclusion (dangerous!)
1296 elif macro.startswith("inc:"):
1297 incfile = mudpy.data.find_file(macro[4:], universe=universe)
1298 if os.path.exists(incfile):
1299 incfd = codecs.open(incfile, "r", "utf-8")
1302 if line.endswith("\n") and not line.endswith("\r\n"):
1303 line = line.replace("\n", "\r\n")
1305 # lose the trailing eol
1306 replacement = replacement[:-2]
1309 log("Couldn't read included " + incfile + " file.", 6)
1311 # if we get here, log and replace it with null
1315 log("Unexpected replacement macro " +
1316 macro + " encountered.", 6)
1318 # and now we act on the replacement
1319 text = text.replace("$(" + macro + ")", replacement)
1321 # replace the look-like-a-macro sequence
1322 text = text.replace("$_(", "$(")
1327 def escape_macros(value):
1328 """Escapes replacement macros in text."""
1329 if type(value) is str:
1330 return value.replace("$(", "$_(")
1335 def first_word(text, separator=" "):
1336 """Returns a tuple of the first word and the rest."""
1338 if text.find(separator) > 0:
1339 return text.split(separator, 1)
1347 """The things which should happen on each pulse, aside from reloads."""
1349 # open the listening socket if it hasn't been already
1350 if not hasattr(universe, "listening_socket"):
1351 universe.initialize_server_socket()
1353 # assign a user if a new connection is waiting
1354 user = check_for_connection(universe.listening_socket)
1356 universe.userlist.append(user)
1358 # iterate over the connected users
1359 for user in universe.userlist:
1362 # add an element for counters if it doesn't exist
1363 if "counters" not in universe.categories["internal"]:
1364 universe.categories["internal"]["counters"] = Element(
1365 "internal:counters", universe, old_style=True
1368 # update the log every now and then
1369 if not universe.categories["internal"]["counters"].get("mark"):
1370 log(str(len(universe.userlist)) + " connection(s)")
1371 universe.categories["internal"]["counters"].set(
1372 "mark", universe.categories["internal"]["time"].get(
1377 universe.categories["internal"]["counters"].set(
1378 "mark", universe.categories["internal"]["counters"].get(
1383 # periodically save everything
1384 if not universe.categories["internal"]["counters"].get("save"):
1386 universe.categories["internal"]["counters"].set(
1387 "save", universe.categories["internal"]["time"].get(
1392 universe.categories["internal"]["counters"].set(
1393 "save", universe.categories["internal"]["counters"].get(
1398 # pause for a configurable amount of time (decimal seconds)
1399 time.sleep(universe.categories["internal"]
1400 ["time"].get("increment"))
1402 # increase the elapsed increment counter
1403 universe.categories["internal"]["counters"].set(
1404 "elapsed", universe.categories["internal"]["counters"].get(
1411 """Reload all relevant objects."""
1412 for user in universe.userlist[:]:
1414 for element in universe.contents.values():
1415 if element.origin.is_writeable():
1420 def check_for_connection(listening_socket):
1421 """Check for a waiting connection and return a new user object."""
1423 # try to accept a new connection
1425 connection, address = listening_socket.accept()
1426 except BlockingIOError:
1429 # note that we got one
1430 log("Connection from " + address[0], 2)
1432 # disable blocking so we can proceed whether or not we can send/receive
1433 connection.setblocking(0)
1435 # create a new user object
1438 # associate this connection with it
1439 user.connection = connection
1441 # set the user's ipa from the connection's ipa
1442 user.address = address[0]
1444 # let the client know we WILL EOR (RFC 885)
1445 mudpy.telnet.enable(user, mudpy.telnet.TELOPT_EOR, mudpy.telnet.US)
1446 user.negotiation_pause = 2
1448 # return the new user object
1452 def get_menu(state, error=None, choices=None):
1453 """Show the correct menu text to a user."""
1455 # make sure we don't reuse a mutable sequence by default
1459 # get the description or error text
1460 message = get_menu_description(state, error)
1462 # get menu choices for the current state
1463 message += get_formatted_menu_choices(state, choices)
1465 # try to get a prompt, if it was defined
1466 message += get_menu_prompt(state)
1468 # throw in the default choice, if it exists
1469 message += get_formatted_default_menu_choice(state)
1471 # display a message indicating if echo is off
1472 message += get_echo_message(state)
1474 # return the assembly of various strings defined above
1478 def menu_echo_on(state):
1479 """True if echo is on, false if it is off."""
1480 return universe.categories["menu"][state].get("echo", True)
1483 def get_echo_message(state):
1484 """Return a message indicating that echo is off."""
1485 if menu_echo_on(state):
1488 return "(won't echo) "
1491 def get_default_menu_choice(state):
1492 """Return the default choice for a menu."""
1493 return universe.categories["menu"][state].get("default")
1496 def get_formatted_default_menu_choice(state):
1497 """Default menu choice foratted for inclusion in a prompt string."""
1498 default_choice = get_default_menu_choice(state)
1500 return "[$(red)" + default_choice + "$(nrm)] "
1505 def get_menu_description(state, error):
1506 """Get the description or error text."""
1508 # an error condition was raised by the handler
1511 # try to get an error message matching the condition
1513 description = universe.categories[
1514 "menu"][state].get("error_" + error)
1516 description = "That is not a valid choice..."
1517 description = "$(red)" + description + "$(nrm)"
1519 # there was no error condition
1522 # try to get a menu description for the current state
1523 description = universe.categories["menu"][state].get("description")
1525 # return the description or error message
1527 description += "$(eol)$(eol)"
1531 def get_menu_prompt(state):
1532 """Try to get a prompt, if it was defined."""
1533 prompt = universe.categories["menu"][state].get("prompt")
1539 def get_menu_choices(user):
1540 """Return a dict of choice:meaning."""
1541 menu = universe.categories["menu"][user.state]
1542 create_choices = menu.get("create")
1544 choices = eval(create_choices)
1550 for facet in menu.facets():
1551 if facet.startswith("demand_") and not eval(
1552 universe.categories["menu"][user.state].get(facet)
1554 ignores.append(facet.split("_", 2)[1])
1555 elif facet.startswith("create_"):
1556 creates[facet] = facet.split("_", 2)[1]
1557 elif facet.startswith("choice_"):
1558 options[facet] = facet.split("_", 2)[1]
1559 for facet in creates.keys():
1560 if not creates[facet] in ignores:
1561 choices[creates[facet]] = eval(menu.get(facet))
1562 for facet in options.keys():
1563 if not options[facet] in ignores:
1564 choices[options[facet]] = menu.get(facet)
1568 def get_formatted_menu_choices(state, choices):
1569 """Returns a formatted string of menu choices."""
1571 choice_keys = list(choices.keys())
1573 for choice in choice_keys:
1574 choice_output += " [$(red)" + choice + "$(nrm)] " + choices[
1578 choice_output += "$(eol)"
1579 return choice_output
1582 def get_menu_branches(state):
1583 """Return a dict of choice:branch."""
1585 for facet in universe.categories["menu"][state].facets():
1586 if facet.startswith("branch_"):
1588 facet.split("_", 2)[1]
1589 ] = universe.categories["menu"][state].get(facet)
1593 def get_default_branch(state):
1594 """Return the default branch."""
1595 return universe.categories["menu"][state].get("branch")
1598 def get_choice_branch(user, choice):
1599 """Returns the new state matching the given choice."""
1600 branches = get_menu_branches(user.state)
1601 if choice in branches.keys():
1602 return branches[choice]
1603 elif choice in user.menu_choices.keys():
1604 return get_default_branch(user.state)
1609 def get_menu_actions(state):
1610 """Return a dict of choice:branch."""
1612 for facet in universe.categories["menu"][state].facets():
1613 if facet.startswith("action_"):
1615 facet.split("_", 2)[1]
1616 ] = universe.categories["menu"][state].get(facet)
1620 def get_default_action(state):
1621 """Return the default action."""
1622 return universe.categories["menu"][state].get("action")
1625 def get_choice_action(user, choice):
1626 """Run any indicated script for the given choice."""
1627 actions = get_menu_actions(user.state)
1628 if choice in actions.keys():
1629 return actions[choice]
1630 elif choice in user.menu_choices.keys():
1631 return get_default_action(user.state)
1636 def handle_user_input(user):
1637 """The main handler, branches to a state-specific handler."""
1639 # if the user's client echo is off, send a blank line for aesthetics
1640 if mudpy.telnet.is_enabled(user, mudpy.telnet.TELOPT_ECHO,
1642 user.send("", add_prompt=False, prepend_padding=False)
1644 # check to make sure the state is expected, then call that handler
1645 if "handler_" + user.state in globals():
1646 exec("handler_" + user.state + "(user)")
1648 generic_menu_handler(user)
1650 # since we got input, flag that the menu/prompt needs to be redisplayed
1651 user.menu_seen = False
1653 # update the last_input timestamp while we're at it
1654 user.last_input = universe.get_time()
1657 def generic_menu_handler(user):
1658 """A generic menu choice handler."""
1660 # get a lower-case representation of the next line of input
1661 if user.input_queue:
1662 choice = user.input_queue.pop(0)
1664 choice = choice.lower()
1668 choice = get_default_menu_choice(user.state)
1669 if choice in user.menu_choices:
1670 exec(get_choice_action(user, choice))
1671 new_state = get_choice_branch(user, choice)
1673 user.state = new_state
1675 user.error = "default"
1678 def handler_entering_account_name(user):
1679 """Handle the login account name."""
1681 # get the next waiting line of input
1682 input_data = user.input_queue.pop(0)
1684 # did the user enter anything?
1687 # keep only the first word and convert to lower-case
1688 name = input_data.lower()
1690 # fail if there are non-alphanumeric characters
1691 if name != "".join(filter(
1692 lambda x: x >= "0" and x <= "9" or x >= "a" and x <= "z",
1694 user.error = "bad_name"
1696 # if that account exists, time to request a password
1697 elif name in universe.categories["account"]:
1698 user.account = universe.categories["account"][name]
1699 user.state = "checking_password"
1701 # otherwise, this could be a brand new user
1703 user.account = Element("account:" + name, universe, old_style=True)
1704 user.account.set("name", name)
1705 log("New user: " + name, 2)
1706 user.state = "checking_new_account_name"
1708 # if the user entered nothing for a name, then buhbye
1710 user.state = "disconnecting"
1713 def handler_checking_password(user):
1714 """Handle the login account password."""
1716 # get the next waiting line of input
1717 input_data = user.input_queue.pop(0)
1719 if "mudpy.limit" in universe.contents:
1720 max_password_tries = universe.contents["mudpy.limit"].get(
1721 "password_tries", 3)
1723 max_password_tries = 3
1725 # does the hashed input equal the stored hash?
1726 if mudpy.password.verify(input_data, user.account.get("passhash")):
1728 # if so, set the username and load from cold storage
1729 if not user.replace_old_connections():
1731 user.state = "main_utility"
1733 # if at first your hashes don't match, try, try again
1734 elif user.password_tries < max_password_tries - 1:
1735 user.password_tries += 1
1736 user.error = "incorrect"
1738 # we've exceeded the maximum number of password failures, so disconnect
1741 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1743 user.state = "disconnecting"
1746 def handler_entering_new_password(user):
1747 """Handle a new password entry."""
1749 # get the next waiting line of input
1750 input_data = user.input_queue.pop(0)
1752 if "mudpy.limit" in universe.contents:
1753 max_password_tries = universe.contents["mudpy.limit"].get(
1754 "password_tries", 3)
1756 max_password_tries = 3
1758 # make sure the password is strong--at least one upper, one lower and
1759 # one digit, seven or more characters in length
1760 if len(input_data) > 6 and len(
1761 list(filter(lambda x: x >= "0" and x <= "9", input_data))
1763 list(filter(lambda x: x >= "A" and x <= "Z", input_data))
1765 list(filter(lambda x: x >= "a" and x <= "z", input_data))
1768 # hash and store it, then move on to verification
1769 user.account.set("passhash", mudpy.password.create(input_data))
1770 user.state = "verifying_new_password"
1772 # the password was weak, try again if you haven't tried too many times
1773 elif user.password_tries < max_password_tries - 1:
1774 user.password_tries += 1
1777 # too many tries, so adios
1780 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1782 user.account.destroy()
1783 user.state = "disconnecting"
1786 def handler_verifying_new_password(user):
1787 """Handle the re-entered new password for verification."""
1789 # get the next waiting line of input
1790 input_data = user.input_queue.pop(0)
1792 if "mudpy.limit" in universe.contents:
1793 max_password_tries = universe.contents["mudpy.limit"].get(
1794 "password_tries", 3)
1796 max_password_tries = 3
1798 # hash the input and match it to storage
1799 if mudpy.password.verify(input_data, user.account.get("passhash")):
1802 # the hashes matched, so go active
1803 if not user.replace_old_connections():
1804 user.state = "main_utility"
1806 # go back to entering the new password as long as you haven't tried
1808 elif user.password_tries < max_password_tries - 1:
1809 user.password_tries += 1
1810 user.error = "differs"
1811 user.state = "entering_new_password"
1813 # otherwise, sayonara
1816 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1818 user.account.destroy()
1819 user.state = "disconnecting"
1822 def handler_active(user):
1823 """Handle input for active users."""
1825 # get the next waiting line of input
1826 input_data = user.input_queue.pop(0)
1831 # split out the command and parameters
1833 mode = actor.get("mode")
1834 if mode and input_data.startswith("!"):
1835 command_name, parameters = first_word(input_data[1:])
1836 elif mode == "chat":
1837 command_name = "say"
1838 parameters = input_data
1840 command_name, parameters = first_word(input_data)
1842 # lowercase the command
1843 command_name = command_name.lower()
1845 # the command matches a command word for which we have data
1846 if command_name in universe.categories["command"]:
1847 command = universe.categories["command"][command_name]
1851 # if it's allowed, do it
1852 if actor.can_run(command):
1853 exec(command.get("action"))
1855 # otherwise, give an error
1857 command_error(actor, input_data)
1859 # if no input, just idle back with a prompt
1861 user.send("", just_prompt=True)
1864 def command_halt(actor, parameters):
1865 """Halt the world."""
1868 # see if there's a message or use a generic one
1870 message = "Halting: " + parameters
1872 message = "User " + actor.owner.account.get(
1874 ) + " halted the world."
1877 broadcast(message, add_prompt=False)
1880 # set a flag to terminate the world
1881 universe.terminate_flag = True
1884 def command_reload(actor):
1885 """Reload all code modules, configs and data."""
1888 # let the user know and log
1889 actor.send("Reloading all code modules, configs and data.")
1892 actor.owner.account.get("name") + " reloaded the world.",
1896 # set a flag to reload
1897 universe.reload_flag = True
1900 def command_quit(actor):
1901 """Leave the world and go back to the main menu."""
1903 actor.owner.state = "main_utility"
1904 actor.owner.deactivate_avatar()
1907 def command_help(actor, parameters):
1908 """List available commands and provide help for commands."""
1910 # did the user ask for help on a specific command word?
1911 if parameters and actor.owner:
1913 # is the command word one for which we have data?
1914 if parameters in universe.categories["command"]:
1915 command = universe.categories["command"][parameters]
1919 # only for allowed commands
1920 if actor.can_run(command):
1922 # add a description if provided
1923 description = command.get("description")
1925 description = "(no short description provided)"
1926 if command.get("administrative"):
1930 output += parameters + "$(nrm) - " + description + "$(eol)$(eol)"
1932 # add the help text if provided
1933 help_text = command.get("help")
1935 help_text = "No help is provided for this command."
1938 # list related commands
1939 see_also = command.get("see_also")
1941 really_see_also = ""
1942 for item in see_also:
1943 if item in universe.categories["command"]:
1944 command = universe.categories["command"][item]
1945 if actor.can_run(command):
1947 really_see_also += ", "
1948 if command.get("administrative"):
1949 really_see_also += "$(red)"
1951 really_see_also += "$(grn)"
1952 really_see_also += item + "$(nrm)"
1954 output += "$(eol)$(eol)See also: " + really_see_also
1956 # no data for the requested command word
1958 output = "That is not an available command."
1960 # no specific command word was indicated
1963 # give a sorted list of commands with descriptions if provided
1964 output = "These are the commands available to you:$(eol)$(eol)"
1965 sorted_commands = list(universe.categories["command"].keys())
1966 sorted_commands.sort()
1967 for item in sorted_commands:
1968 command = universe.categories["command"][item]
1969 if actor.can_run(command):
1970 description = command.get("description")
1972 description = "(no short description provided)"
1973 if command.get("administrative"):
1977 output += item + "$(nrm) - " + description + "$(eol)"
1978 output += ("$(eol)Enter \"help COMMAND\" for help on a command "
1979 "named \"COMMAND\".")
1981 # send the accumulated output to the user
1985 def command_move(actor, parameters):
1986 """Move the avatar in a given direction."""
1987 if parameters in universe.contents[actor.get("location")].portals():
1988 actor.move_direction(parameters)
1990 actor.send("You cannot go that way.")
1993 def command_look(actor, parameters):
1996 actor.send("You can't look at or in anything yet.")
1998 actor.look_at(actor.get("location"))
2001 def command_say(actor, parameters):
2002 """Speak to others in the same area."""
2004 # check for replacement macros and escape them
2005 parameters = escape_macros(parameters)
2007 # if the message is wrapped in quotes, remove them and leave contents
2009 if parameters.startswith("\"") and parameters.endswith("\""):
2010 message = parameters[1:-1]
2013 # otherwise, get rid of stray quote marks on the ends of the message
2015 message = parameters.strip("\"'`")
2018 # the user entered a message
2021 # match the punctuation used, if any, to an action
2022 if "mudpy.linguistic" in universe.contents:
2023 actions = universe.contents["mudpy.linguistic"].get("actions", {})
2024 default_punctuation = (universe.contents["mudpy.linguistic"].get(
2025 "default_punctuation", "."))
2028 default_punctuation = "."
2031 # reverse sort punctuation options so the longest match wins
2032 for mark in sorted(actions.keys(), reverse=True):
2033 if not literal and message.endswith(mark):
2034 action = actions[mark]
2037 # add punctuation if needed
2039 action = actions[default_punctuation]
2040 if message and not (
2041 literal or unicodedata.category(message[-1]) == "Po"
2043 message += default_punctuation
2045 # failsafe checks to avoid unwanted reformatting and null strings
2046 if message and not literal:
2048 # decapitalize the first letter to improve matching
2049 message = message[0].lower() + message[1:]
2051 # iterate over all words in message, replacing typos
2052 if "mudpy.linguistic" in universe.contents:
2053 typos = universe.contents["mudpy.linguistic"].get("typos", {})
2056 words = message.split()
2057 for index in range(len(words)):
2059 while unicodedata.category(word[0]) == "Po":
2061 while unicodedata.category(word[-1]) == "Po":
2063 if word in typos.keys():
2064 words[index] = words[index].replace(word, typos[word])
2065 message = " ".join(words)
2067 # capitalize the first letter
2068 message = message[0].upper() + message[1:]
2072 actor.echo_to_location(
2073 actor.get("name") + " " + action + "s, \"" + message + "\""
2075 actor.send("You " + action + ", \"" + message + "\"")
2077 # there was no message
2079 actor.send("What do you want to say?")
2082 def command_chat(actor):
2083 """Toggle chat mode."""
2084 mode = actor.get("mode")
2086 actor.set("mode", "chat")
2087 actor.send("Entering chat mode (use $(grn)!chat$(nrm) to exit).")
2088 elif mode == "chat":
2089 actor.remove_facet("mode")
2090 actor.send("Exiting chat mode.")
2092 actor.send("Sorry, but you're already busy with something else!")
2095 def command_show(actor, parameters):
2096 """Show program data."""
2098 arguments = parameters.split()
2100 message = "What do you want to show?"
2101 elif arguments[0] == "time":
2102 message = universe.categories["internal"]["counters"].get(
2104 ) + " increments elapsed since the world was created."
2105 elif arguments[0] == "categories":
2106 message = "These are the element categories:$(eol)"
2107 categories = list(universe.categories.keys())
2109 for category in categories:
2110 message += "$(eol) $(grn)" + category + "$(nrm)"
2111 elif arguments[0] == "files":
2112 message = "These are the current files containing the universe:$(eol)"
2113 filenames = list(universe.files.keys())
2115 for filename in filenames:
2116 if universe.files[filename].is_writeable():
2120 message += ("$(eol) $(red)(" + status + ") $(grn)" + filename
2122 elif arguments[0] == "category":
2123 if len(arguments) != 2:
2124 message = "You must specify one category."
2125 elif arguments[1] in universe.categories:
2126 message = ("These are the elements in the \"" + arguments[1]
2127 + "\" category:$(eol)")
2130 universe.categories[arguments[1]][x].key
2131 ) for x in universe.categories[arguments[1]].keys()
2134 for element in elements:
2135 message += "$(eol) $(grn)" + element + "$(nrm)"
2137 message = "Category \"" + arguments[1] + "\" does not exist."
2138 elif arguments[0] == "file":
2139 if len(arguments) != 2:
2140 message = "You must specify one file."
2141 elif arguments[1] in universe.files:
2142 message = ("These are the elements in the \"" + arguments[1]
2144 elements = universe.files[arguments[1]].data.keys()
2146 for element in elements:
2147 message += "$(eol) $(grn)" + element + "$(nrm)"
2149 message = "Category \"" + arguments[1] + "\" does not exist."
2150 elif arguments[0] == "element":
2151 if len(arguments) != 2:
2152 message = "You must specify one element."
2153 elif arguments[1].strip(".") in universe.contents:
2154 element = universe.contents[arguments[1].strip(".")]
2155 message = ("These are the properties of the \"" + arguments[1]
2156 + "\" element (in \"" + element.origin.filename
2158 facets = element.facets()
2159 for facet in sorted(facets):
2160 if element.old_style:
2161 message += ("$(eol) $(grn)%s: $(red)%s$(nrm)" %
2162 (facet, escape_macros(element.get(facet))))
2164 message += ("$(eol) $(grn)%s: $(red)%s$(nrm)" %
2165 (facet, str(facets[facet])))
2167 message = "Element \"" + arguments[1] + "\" does not exist."
2168 elif arguments[0] == "result":
2169 if len(arguments) < 2:
2170 message = "You need to specify an expression."
2173 message = repr(eval(" ".join(arguments[1:])))
2174 except Exception as e:
2175 message = ("$(red)Your expression raised an exception...$(eol)"
2176 "$(eol)$(bld)%s$(nrm)" % e)
2177 elif arguments[0] == "log":
2178 if len(arguments) == 4:
2179 if re.match("^\d+$", arguments[3]) and int(arguments[3]) >= 0:
2180 stop = int(arguments[3])
2185 if len(arguments) >= 3:
2186 if re.match("^\d+$", arguments[2]) and int(arguments[2]) > 0:
2187 start = int(arguments[2])
2192 if len(arguments) >= 2:
2193 if (re.match("^\d+$", arguments[1])
2194 and 0 <= int(arguments[1]) <= 9):
2195 level = int(arguments[1])
2198 elif 0 <= actor.owner.account.get("loglevel", 0) <= 9:
2199 level = actor.owner.account.get("loglevel", 0)
2202 if level > -1 and start > -1 and stop > -1:
2203 message = get_loglines(level, start, stop)
2205 message = ("When specified, level must be 0-9 (default 1), "
2206 "start and stop must be >=1 (default 10 and 1).")
2208 message = "I don't know what \"" + parameters + "\" is."
2212 def command_create(actor, parameters):
2213 """Create an element if it does not exist."""
2215 message = "You must at least specify an element to create."
2216 elif not actor.owner:
2219 arguments = parameters.split()
2220 if len(arguments) == 1:
2221 arguments.append("")
2222 if len(arguments) == 2:
2223 element, filename = arguments
2224 if element in universe.contents:
2225 message = "The \"" + element + "\" element already exists."
2227 message = ("You create \"" +
2228 element + "\" within the universe.")
2229 logline = actor.owner.account.get(
2231 ) + " created an element: " + element
2233 logline += " in file " + filename
2234 if filename not in universe.files:
2236 " Warning: \"" + filename + "\" is not yet "
2237 "included in any other file and will not be read "
2238 "on startup unless this is remedied.")
2239 Element(element, universe, filename, old_style=True)
2241 elif len(arguments) > 2:
2242 message = "You can only specify an element and a filename."
2246 def command_destroy(actor, parameters):
2247 """Destroy an element if it exists."""
2250 message = "You must specify an element to destroy."
2252 if parameters not in universe.contents:
2253 message = "The \"" + parameters + "\" element does not exist."
2255 universe.contents[parameters].destroy()
2256 message = ("You destroy \"" + parameters
2257 + "\" within the universe.")
2259 actor.owner.account.get(
2261 ) + " destroyed an element: " + parameters,
2267 def command_set(actor, parameters):
2268 """Set a facet of an element."""
2270 message = "You must specify an element, a facet and a value."
2272 arguments = parameters.split(" ", 2)
2273 if len(arguments) == 1:
2274 message = ("What facet of element \"" + arguments[0]
2275 + "\" would you like to set?")
2276 elif len(arguments) == 2:
2277 message = ("What value would you like to set for the \"" +
2278 arguments[1] + "\" facet of the \"" + arguments[0]
2281 element, facet, value = arguments
2282 if element not in universe.contents:
2283 message = "The \"" + element + "\" element does not exist."
2285 universe.contents[element].set(facet, value)
2286 message = ("You have successfully (re)set the \"" + facet
2287 + "\" facet of element \"" + element
2288 + "\". Try \"show element " +
2289 element + "\" for verification.")
2293 def command_delete(actor, parameters):
2294 """Delete a facet from an element."""
2296 message = "You must specify an element and a facet."
2298 arguments = parameters.split(" ")
2299 if len(arguments) == 1:
2300 message = ("What facet of element \"" + arguments[0]
2301 + "\" would you like to delete?")
2302 elif len(arguments) != 2:
2303 message = "You may only specify an element and a facet."
2305 element, facet = arguments
2306 if element not in universe.contents:
2307 message = "The \"" + element + "\" element does not exist."
2308 elif facet not in universe.contents[element].facets():
2309 message = ("The \"" + element + "\" element has no \"" + facet
2312 universe.contents[element].remove_facet(facet)
2313 message = ("You have successfully deleted the \"" + facet
2314 + "\" facet of element \"" + element
2315 + "\". Try \"show element " +
2316 element + "\" for verification.")
2320 def command_error(actor, input_data):
2321 """Generic error for an unrecognized command word."""
2323 # 90% of the time use a generic error
2324 if random.randrange(10):
2325 message = "I'm not sure what \"" + input_data + "\" means..."
2327 # 10% of the time use the classic diku error
2329 message = "Arglebargle, glop-glyf!?!"
2331 # send the error message
2335 def daemonize(universe):
2336 """Fork and disassociate from everything."""
2338 # only if this is what we're configured to do
2339 if "mudpy.process" in universe.contents and universe.contents[
2340 "mudpy.process"].get("daemon"):
2342 # log before we start forking around, so the terminal gets the message
2343 log("Disassociating from the controlling terminal.")
2345 # fork off and die, so we free up the controlling terminal
2349 # switch to a new process group
2352 # fork some more, this time to free us from the old process group
2356 # reset the working directory so we don't needlessly tie up mounts
2359 # clear the file creation mask so we can bend it to our will later
2362 # redirect stdin/stdout/stderr and close off their former descriptors
2363 for stdpipe in range(3):
2365 sys.stdin = codecs.open("/dev/null", "r", "utf-8")
2366 sys.__stdin__ = codecs.open("/dev/null", "r", "utf-8")
2367 sys.stdout = codecs.open("/dev/null", "w", "utf-8")
2368 sys.stderr = codecs.open("/dev/null", "w", "utf-8")
2369 sys.__stdout__ = codecs.open("/dev/null", "w", "utf-8")
2370 sys.__stderr__ = codecs.open("/dev/null", "w", "utf-8")
2373 def create_pidfile(universe):
2374 """Write a file containing the current process ID."""
2375 pid = str(os.getpid())
2376 log("Process ID: " + pid)
2377 if "mudpy.process" in universe.contents:
2378 file_name = universe.contents["mudpy.process"].get("pidfile", "")
2382 if not os.path.isabs(file_name):
2383 file_name = os.path.join(universe.startdir, file_name)
2384 file_descriptor = codecs.open(file_name, "w", "utf-8")
2385 file_descriptor.write(pid + "\n")
2386 file_descriptor.flush()
2387 file_descriptor.close()
2390 def remove_pidfile(universe):
2391 """Remove the file containing the current process ID."""
2392 if "mudpy.process" in universe.contents:
2393 file_name = universe.contents["mudpy.process"].get("pidfile", "")
2397 if not os.path.isabs(file_name):
2398 file_name = os.path.join(universe.startdir, file_name)
2399 if os.access(file_name, os.W_OK):
2400 os.remove(file_name)
2403 def excepthook(excepttype, value, tracebackdata):
2404 """Handle uncaught exceptions."""
2406 # assemble the list of errors into a single string
2408 traceback.format_exception(excepttype, value, tracebackdata)
2411 # try to log it, if possible
2414 except Exception as e:
2415 # try to write it to stderr, if possible
2416 sys.stderr.write(message + "\nException while logging...\n%s" % e)
2419 def sighook(what, where):
2420 """Handle external signals."""
2423 message = "Caught signal: "
2425 # for a hangup signal
2426 if what == signal.SIGHUP:
2427 message += "hangup (reloading)"
2428 universe.reload_flag = True
2430 # for a terminate signal
2431 elif what == signal.SIGTERM:
2432 message += "terminate (halting)"
2433 universe.terminate_flag = True
2435 # catchall for unexpected signals
2437 message += str(what) + " (unhandled)"
2443 def override_excepthook():
2444 """Redefine sys.excepthook with our own."""
2445 sys.excepthook = excepthook
2448 def assign_sighook():
2449 """Assign a customized handler for some signals."""
2450 signal.signal(signal.SIGHUP, sighook)
2451 signal.signal(signal.SIGTERM, sighook)
2455 """This contains functions to be performed when starting the engine."""
2457 # see if a configuration file was specified
2458 if len(sys.argv) > 1:
2459 conffile = sys.argv[1]
2465 universe = Universe(conffile, True)
2467 # report any loglines which accumulated during setup
2468 for logline in universe.setup_loglines:
2470 universe.setup_loglines = []
2472 # log an initial message
2473 log("Started mudpy with command line: " + " ".join(sys.argv))
2475 # fork and disassociate
2478 # override the default exception handler so we get logging first thing
2479 override_excepthook()
2481 # set up custom signal handlers
2485 create_pidfile(universe)
2487 # pass the initialized universe back
2492 """These are functions performed when shutting down the engine."""
2494 # the loop has terminated, so save persistent data
2497 # log a final message
2498 log("Shutting down now.")
2500 # get rid of the pidfile
2501 remove_pidfile(universe)