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(",")]
304 self.universe.contents["mudpy.movement.%s" % x].get("vector")
305 ) for x in self.universe.directions)
306 for portal in self.get("gridlinks"):
307 adjacent = map(lambda c, o: c + o,
308 coordinates, offsets[portal])
309 neighbor = "area:" + ",".join(
310 [(str(x)) for x in adjacent]
312 if neighbor in self.universe.contents:
313 portals[portal] = neighbor
314 for facet in self.facets():
315 if facet.startswith("link_"):
316 neighbor = self.get(facet)
317 if neighbor in self.universe.contents:
318 portal = facet.split("_")[1]
319 portals[portal] = neighbor
322 def link_neighbor(self, direction):
323 """Return the element linked in a given direction."""
324 portals = self.portals()
325 if direction in portals:
326 return portals[direction]
328 def echo_to_location(self, message):
329 """Show a message to other elements in the current location."""
330 for element in self.universe.contents[
333 if element is not self:
334 element.send(message)
341 def __init__(self, filename="", load=False):
342 """Initialize the universe."""
345 self.default_origins = {}
346 self.directions = set()
348 self.private_files = []
349 self.reload_flag = False
350 self.setup_loglines = []
351 self.startdir = os.getcwd()
352 self.terminate_flag = False
355 possible_filenames = [
357 "/usr/local/mudpy/etc/mudpy.yaml",
358 "/usr/local/etc/mudpy.yaml",
359 "/etc/mudpy/mudpy.yaml",
362 for filename in possible_filenames:
363 if os.access(filename, os.R_OK):
365 if not os.path.isabs(filename):
366 filename = os.path.join(self.startdir, filename)
367 self.filename = filename
369 # make sure to preserve any accumulated log entries during load
370 self.setup_loglines += self.load()
373 """Load universe data from persistent storage."""
375 # it's possible for this to enter before logging configuration is read
376 pending_loglines = []
378 # the files dict must exist and filename needs to be read-only
382 self.filename in self.files and self.files[
387 # clear out all read-only files
388 if hasattr(self, "files"):
389 for data_filename in list(self.files.keys()):
390 if not self.files[data_filename].is_writeable():
391 del self.files[data_filename]
393 # start loading from the initial file
394 mudpy.data.DataFile(self.filename, self)
396 # make a list of inactive avatars
397 inactive_avatars = []
398 for account in self.categories["account"].values():
399 for avatar in account.get("avatars"):
401 inactive_avatars.append(self.contents[avatar])
403 pending_loglines.append((
404 "Missing avatar \"%s\", possible data corruption" %
406 for user in self.userlist:
407 if user.avatar in inactive_avatars:
408 inactive_avatars.remove(user.avatar)
410 # go through all elements to clear out inactive avatar locations
411 for element in self.contents.values():
412 area = element.get("location")
413 if element in inactive_avatars and area:
414 if area in self.contents and element.key in self.contents[
417 del self.contents[area].contents[element.key]
418 element.set("default_location", area)
419 element.remove_facet("location")
421 # another pass to straighten out all the element contents
422 for element in self.contents.values():
423 element.update_location()
424 element.clean_contents()
425 return pending_loglines
428 """Create a new, empty Universe (the Big Bang)."""
429 new_universe = Universe()
430 for attribute in vars(self).keys():
431 exec("new_universe." + attribute + " = self." + attribute)
432 new_universe.reload_flag = False
437 """Save the universe to persistent storage."""
438 for key in self.files:
439 self.files[key].save()
441 def initialize_server_socket(self):
442 """Create and open the listening socket."""
444 # need to know the local address and port number for the listener
445 host = self.contents["mudpy.network"].get("host")
446 port = self.contents["mudpy.network"].get("port")
448 # if no host was specified, bind to all local addresses (preferring
456 # figure out if this is ipv4 or v6
457 family = socket.getaddrinfo(host, port)[0][0]
458 if family is socket.AF_INET6 and not socket.has_ipv6:
459 log("No support for IPv6 address %s (use IPv4 instead)." % host)
461 # create a new stream-type socket object
462 self.listening_socket = socket.socket(family, socket.SOCK_STREAM)
464 # set the socket options to allow existing open ones to be
465 # reused (fixes a bug where the server can't bind for a minute
466 # when restarting on linux systems)
467 self.listening_socket.setsockopt(
468 socket.SOL_SOCKET, socket.SO_REUSEADDR, 1
471 # bind the socket to to our desired server ipa and port
472 self.listening_socket.bind((host, port))
474 # disable blocking so we can proceed whether or not we can
476 self.listening_socket.setblocking(0)
478 # start listening on the socket
479 self.listening_socket.listen(1)
481 # note that we're now ready for user connections
483 "Listening for Telnet connections on: " +
484 host + ":" + str(port)
488 """Convenience method to get the elapsed time counter."""
489 return self.categories["internal"]["counters"].get("elapsed")
494 """This is a connected user."""
497 """Default values for the in-memory user variables."""
500 self.authenticated = False
503 self.connection = None
505 self.input_queue = []
506 self.last_address = ""
507 self.last_input = universe.get_time()
508 self.menu_choices = {}
509 self.menu_seen = False
510 self.negotiation_pause = 0
511 self.output_queue = []
512 self.partial_input = b""
513 self.password_tries = 0
514 self.state = "initial"
518 """Log, close the connection and remove."""
520 name = self.account.get("name")
524 message = "User " + name
526 message = "An unnamed user"
527 message += " logged out."
529 self.deactivate_avatar()
530 self.connection.close()
533 def check_idle(self):
534 """Warn or disconnect idle users as appropriate."""
535 idletime = universe.get_time() - self.last_input
536 linkdead_dict = universe.categories["internal"]["time"].get(
539 if self.state in linkdead_dict:
540 linkdead_state = self.state
542 linkdead_state = "default"
543 if idletime > linkdead_dict[linkdead_state]:
545 "$(eol)$(red)You've done nothing for far too long... goodbye!"
550 logline = "Disconnecting "
551 if self.account and self.account.get("name"):
552 logline += self.account.get("name")
554 logline += "an unknown user"
555 logline += (" after idling too long in the " + self.state
558 self.state = "disconnecting"
559 self.menu_seen = False
560 idle_dict = universe.categories["internal"]["time"].get("idle")
561 if self.state in idle_dict:
562 idle_state = self.state
564 idle_state = "default"
565 if idletime == idle_dict[idle_state]:
567 "$(eol)$(red)If you continue to be unproductive, "
568 + "you'll be shown the door...$(nrm)$(eol)"
572 """Save, load a new user and relocate the connection."""
574 # get out of the list
577 # create a new user object
580 # set everything equivalent
581 for attribute in vars(self).keys():
582 exec("new_user." + attribute + " = self." + attribute)
584 # the avatar needs a new owner
586 new_user.avatar.owner = new_user
589 universe.userlist.append(new_user)
591 # get rid of the old user object
594 def replace_old_connections(self):
595 """Disconnect active users with the same name."""
597 # the default return value
600 # iterate over each user in the list
601 for old_user in universe.userlist:
603 # the name is the same but it's not us
606 ) and old_user.account and old_user.account.get(
608 ) == self.account.get(
610 ) and old_user is not self:
614 "User " + self.account.get(
616 ) + " reconnected--closing old connection to "
617 + old_user.address + ".",
621 "$(eol)$(red)New connection from " + self.address
622 + ". Terminating old connection...$(nrm)$(eol)",
627 # close the old connection
628 old_user.connection.close()
630 # replace the old connection with this one
632 "$(eol)$(red)Taking over old connection from "
633 + old_user.address + ".$(nrm)"
635 old_user.connection = self.connection
636 old_user.last_address = old_user.address
637 old_user.address = self.address
639 # take this one out of the list and delete
645 # true if an old connection was replaced, false if not
648 def authenticate(self):
649 """Flag the user as authenticated and disconnect duplicates."""
650 if self.state is not "authenticated":
651 log("User " + self.account.get("name") + " logged in.", 2)
652 self.authenticated = True
653 if self.account.subkey in universe.contents["mudpy.limit"].get(
655 self.account.set("administrator", "True")
658 """Send the user their current menu."""
659 if not self.menu_seen:
660 self.menu_choices = get_menu_choices(self)
662 get_menu(self.state, self.error, self.menu_choices),
666 self.menu_seen = True
668 self.adjust_echoing()
670 def adjust_echoing(self):
671 """Adjust echoing to match state menu requirements."""
672 if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_ECHO,
674 if menu_echo_on(self.state):
675 mudpy.telnet.disable(self, mudpy.telnet.TELOPT_ECHO,
677 elif not menu_echo_on(self.state):
678 mudpy.telnet.enable(self, mudpy.telnet.TELOPT_ECHO,
682 """Remove a user from the list of connected users."""
683 universe.userlist.remove(self)
693 add_terminator=False,
696 """Send arbitrary text to a connected user."""
698 # unless raw mode is on, clean it up all nice and pretty
701 # strip extra $(eol) off if present
702 while output.startswith("$(eol)"):
704 while output.endswith("$(eol)"):
706 extra_lines = output.find("$(eol)$(eol)$(eol)")
707 while extra_lines > -1:
708 output = output[:extra_lines] + output[extra_lines + 6:]
709 extra_lines = output.find("$(eol)$(eol)$(eol)")
711 # start with a newline, append the message, then end
712 # with the optional eol string passed to this function
713 # and the ansi escape to return to normal text
714 if not just_prompt and prepend_padding:
715 if (not self.output_queue or not
716 self.output_queue[-1].endswith(b"\r\n")):
717 output = "$(eol)" + output
718 elif not self.output_queue[-1].endswith(
720 ) and not self.output_queue[-1].endswith(
723 output = "$(eol)" + output
724 output += eol + chr(27) + "[0m"
726 # tack on a prompt if active
727 if self.state == "active":
732 mode = self.avatar.get("mode")
734 output += "(" + mode + ") "
736 # find and replace macros in the output
737 output = replace_macros(self, output)
739 # wrap the text at the client's width (min 40, 0 disables)
741 if self.columns < 40:
745 output = wrap_ansi_text(output, wrap)
747 # if supported by the client, encode it utf-8
748 if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_BINARY,
750 encoded_output = output.encode("utf-8")
752 # otherwise just send ascii
754 encoded_output = output.encode("ascii", "replace")
756 # end with a terminator if requested
757 if add_prompt or add_terminator:
758 if mudpy.telnet.is_enabled(
759 self, mudpy.telnet.TELOPT_EOR, mudpy.telnet.US):
760 encoded_output += mudpy.telnet.telnet_proto(
761 mudpy.telnet.IAC, mudpy.telnet.EOR)
762 elif not mudpy.telnet.is_enabled(
763 self, mudpy.telnet.TELOPT_SGA, mudpy.telnet.US):
764 encoded_output += mudpy.telnet.telnet_proto(
765 mudpy.telnet.IAC, mudpy.telnet.GA)
767 # and tack it onto the queue
768 self.output_queue.append(encoded_output)
770 # if this is urgent, flush all pending output
774 # just dump raw bytes as requested
776 self.output_queue.append(output)
780 """All the things to do to the user per increment."""
782 # if the world is terminating, disconnect
783 if universe.terminate_flag:
784 self.state = "disconnecting"
785 self.menu_seen = False
787 # check for an idle connection and act appropriately
791 # if output is paused, decrement the counter
792 if self.state == "initial":
793 if self.negotiation_pause:
794 self.negotiation_pause -= 1
796 self.state = "entering_account_name"
798 # show the user a menu as needed
799 elif not self.state == "active":
802 # flush any pending output in the queue
805 # disconnect users with the appropriate state
806 if self.state == "disconnecting":
809 # check for input and add it to the queue
812 # there is input waiting in the queue
814 handle_user_input(self)
817 """Try to send the last item in the queue and remove it."""
818 if self.output_queue:
820 self.connection.send(self.output_queue[0])
821 except BrokenPipeError:
822 if self.account and self.account.get("name"):
823 account = self.account.get("name")
825 account = "an unknown user"
826 self.state = "disconnecting"
827 log("Broken pipe sending to %s." % account, 7)
828 del self.output_queue[0]
830 def enqueue_input(self):
831 """Process and enqueue any new input."""
833 # check for some input
835 raw_input = self.connection.recv(1024)
836 except (BlockingIOError, OSError):
842 # tack this on to any previous partial
843 self.partial_input += raw_input
845 # reply to and remove any IAC negotiation codes
846 mudpy.telnet.negotiate_telnet_options(self)
848 # separate multiple input lines
849 new_input_lines = self.partial_input.split(b"\n")
851 # if input doesn't end in a newline, replace the
852 # held partial input with the last line of it
853 if not self.partial_input.endswith(b"\n"):
854 self.partial_input = new_input_lines.pop()
856 # otherwise, chop off the extra null input and reset
857 # the held partial input
859 new_input_lines.pop()
860 self.partial_input = b""
862 # iterate over the remaining lines
863 for line in new_input_lines:
865 # strip off extra whitespace
868 # log non-printable characters remaining
869 if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_BINARY,
871 asciiline = bytes([x for x in line if 32 <= x <= 126])
872 if line != asciiline:
873 logline = "Non-ASCII characters from "
874 if self.account and self.account.get("name"):
875 logline += self.account.get("name") + ": "
877 logline += "unknown user: "
878 logline += repr(line)
883 line = line.decode("utf-8")
884 except UnicodeDecodeError:
885 logline = "Non-UTF-8 characters from "
886 if self.account and self.account.get("name"):
887 logline += self.account.get("name") + ": "
889 logline += "unknown user: "
890 logline += repr(line)
894 line = unicodedata.normalize("NFKC", line)
896 # put on the end of the queue
897 self.input_queue.append(line)
899 def new_avatar(self):
900 """Instantiate a new, unconfigured avatar for this user."""
902 while "avatar:" + self.account.get("name") + ":" + str(
904 ) in universe.categories["actor"].keys():
906 self.avatar = Element(
907 "actor:avatar:" + self.account.get("name") + ":" + str(
910 universe, old_style=True
912 self.avatar.append("inherit", "archetype:avatar")
913 self.account.append("avatars", self.avatar.key)
915 def delete_avatar(self, avatar):
916 """Remove an avatar from the world and from the user's list."""
917 if self.avatar is universe.contents[avatar]:
919 universe.contents[avatar].destroy()
920 avatars = self.account.get("avatars")
921 avatars.remove(avatar)
922 self.account.set("avatars", avatars)
924 def activate_avatar_by_index(self, index):
925 """Enter the world with a particular indexed avatar."""
926 self.avatar = universe.contents[
927 self.account.get("avatars")[index]]
928 self.avatar.owner = self
929 self.state = "active"
930 self.avatar.go_home()
932 def deactivate_avatar(self):
933 """Have the active avatar leave the world."""
935 current = self.avatar.get("location")
937 self.avatar.set("default_location", current)
938 self.avatar.echo_to_location(
939 "You suddenly wonder where " + self.avatar.get(
943 del universe.contents[current].contents[self.avatar.key]
944 self.avatar.remove_facet("location")
945 self.avatar.owner = None
949 """Destroy the user and associated avatars."""
950 for avatar in self.account.get("avatars"):
951 self.delete_avatar(avatar)
952 self.account.destroy()
954 def list_avatar_names(self):
955 """List names of assigned avatars."""
957 for avatar in self.account.get("avatars"):
959 avatars.append(universe.contents[avatar].get("name"))
961 log("Missing avatar \"%s\", possible data corruption." %
966 def broadcast(message, add_prompt=True):
967 """Send a message to all connected users."""
968 for each_user in universe.userlist:
969 each_user.send("$(eol)" + message, add_prompt=add_prompt)
972 def log(message, level=0):
975 # a couple references we need
976 file_name = universe.contents["mudpy.log"].get("file")
977 max_log_lines = universe.contents["mudpy.log"].get("lines")
978 syslog_name = universe.contents["mudpy.log"].get("syslog")
979 timestamp = time.asctime()[4:19]
981 # turn the message into a list of nonempty lines
982 lines = [x for x in [(x.rstrip()) for x in message.split("\n")] if x != ""]
984 # send the timestamp and line to a file
986 if not os.path.isabs(file_name):
987 file_name = os.path.join(universe.startdir, file_name)
988 file_descriptor = codecs.open(file_name, "a", "utf-8")
990 file_descriptor.write(timestamp + " " + line + "\n")
991 file_descriptor.flush()
992 file_descriptor.close()
994 # send the timestamp and line to standard output
995 if universe.contents["mudpy.log"].get("stdout"):
997 print(timestamp + " " + line)
999 # send the line to the system log
1002 syslog_name.encode("utf-8"),
1004 syslog.LOG_INFO | syslog.LOG_DAEMON
1010 # display to connected administrators
1011 for user in universe.userlist:
1012 if user.state == "active" and user.account.get(
1014 ) and user.account.get("loglevel", 0) <= level:
1015 # iterate over every line in the message
1019 "$(bld)$(red)" + timestamp + " "
1020 + line.replace("$(", "$_(") + "$(nrm)$(eol)")
1021 user.send(full_message, flush=True)
1023 # add to the recent log list
1025 while 0 < len(universe.loglines) >= max_log_lines:
1026 del universe.loglines[0]
1027 universe.loglines.append((level, timestamp + " " + line))
1030 def get_loglines(level, start, stop):
1031 """Return a specific range of loglines filtered by level."""
1033 # filter the log lines
1034 loglines = [x for x in universe.loglines if x[0] >= level]
1036 # we need these in several places
1037 total_count = str(len(universe.loglines))
1038 filtered_count = len(loglines)
1040 # don't proceed if there are no lines
1043 # can't start before the begining or at the end
1044 if start > filtered_count:
1045 start = filtered_count
1049 # can't stop before we start
1056 message = "There are " + str(total_count)
1057 message += " log lines in memory and " + str(filtered_count)
1058 message += " at or above level " + str(level) + "."
1059 message += " The matching lines from " + str(stop) + " to "
1060 message += str(start) + " are:$(eol)$(eol)"
1062 # add the text from the selected lines
1064 range_lines = loglines[-start:-(stop - 1)]
1066 range_lines = loglines[-start:]
1067 for line in range_lines:
1068 message += " (" + str(line[0]) + ") " + line[1].replace(
1072 # there were no lines
1074 message = "None of the " + str(total_count)
1075 message += " lines in memory matches your request."
1081 def glyph_columns(character):
1082 """Convenience function to return the column width of a glyph."""
1083 if unicodedata.east_asian_width(character) in "FW":
1089 def wrap_ansi_text(text, width):
1090 """Wrap text with arbitrary width while ignoring ANSI colors."""
1092 # the current position in the entire text string, including all
1093 # characters, printable or otherwise
1096 # the current text position relative to the begining of the line,
1097 # ignoring color escape sequences
1100 # the absolute position of the most recent whitespace character
1103 # whether the current character is part of a color escape sequence
1106 # normalize any potentially composited unicode before we count it
1107 text = unicodedata.normalize("NFKC", text)
1109 # iterate over each character from the begining of the text
1110 for each_character in text:
1112 # the current character is the escape character
1113 if each_character == "\x1b" and not escape:
1116 # the current character is within an escape sequence
1119 # the current character is m, which terminates the
1121 if each_character == "m":
1124 # the current character is a newline, so reset the relative
1125 # position (start a new line)
1126 elif each_character == "\n":
1128 last_whitespace = abs_pos
1130 # the current character meets the requested maximum line width,
1131 # so we need to backtrack and find a space at which to wrap;
1132 # special care is taken to avoid an off-by-one in case the
1133 # current character is a double-width glyph
1134 elif each_character != "\r" and (
1135 rel_pos >= width or (
1136 rel_pos >= width - 1 and glyph_columns(
1142 # it's always possible we landed on whitespace
1143 if unicodedata.category(each_character) in ("Cc", "Zs"):
1144 last_whitespace = abs_pos
1146 # insert an eol in place of the space
1147 text = text[:last_whitespace] + "\r\n" + text[last_whitespace + 1:]
1149 # increase the absolute position because an eol is two
1150 # characters but the space it replaced was only one
1153 # now we're at the begining of a new line, plus the
1154 # number of characters wrapped from the previous line
1156 for remaining_characters in text[last_whitespace:abs_pos]:
1157 rel_pos += glyph_columns(remaining_characters)
1159 # as long as the character is not a carriage return and the
1160 # other above conditions haven't been met, count it as a
1161 # printable character
1162 elif each_character != "\r":
1163 rel_pos += glyph_columns(each_character)
1164 if unicodedata.category(each_character) in ("Cc", "Zs"):
1165 last_whitespace = abs_pos
1167 # increase the absolute position for every character
1170 # return the newly-wrapped text
1174 def weighted_choice(data):
1175 """Takes a dict weighted by value and returns a random key."""
1177 # this will hold our expanded list of keys from the data
1180 # create the expanded list of keys
1181 for key in data.keys():
1182 for count in range(data[key]):
1183 expanded.append(key)
1185 # return one at random
1186 return random.choice(expanded)
1190 """Returns a random character name."""
1192 # the vowels and consonants needed to create romaji syllables
1221 # this dict will hold our weighted list of syllables
1224 # generate the list with an even weighting
1225 for consonant in consonants:
1226 for vowel in vowels:
1227 syllables[consonant + vowel] = 1
1229 # we'll build the name into this string
1232 # create a name of random length from the syllables
1233 for syllable in range(random.randrange(2, 6)):
1234 name += weighted_choice(syllables)
1236 # strip any leading quotemark, capitalize and return the name
1237 return name.strip("'").capitalize()
1240 def replace_macros(user, text, is_input=False):
1241 """Replaces macros in text output."""
1243 # third person pronouns
1245 "female": {"obj": "her", "pos": "hers", "sub": "she"},
1246 "male": {"obj": "him", "pos": "his", "sub": "he"},
1247 "neuter": {"obj": "it", "pos": "its", "sub": "it"}
1250 # a dict of replacement macros
1253 "bld": chr(27) + "[1m",
1254 "nrm": chr(27) + "[0m",
1255 "blk": chr(27) + "[30m",
1256 "blu": chr(27) + "[34m",
1257 "cyn": chr(27) + "[36m",
1258 "grn": chr(27) + "[32m",
1259 "mgt": chr(27) + "[35m",
1260 "red": chr(27) + "[31m",
1261 "yel": chr(27) + "[33m",
1264 # add dynamic macros where possible
1266 account_name = user.account.get("name")
1268 macros["account"] = account_name
1270 avatar_gender = user.avatar.get("gender")
1272 macros["tpop"] = pronouns[avatar_gender]["obj"]
1273 macros["tppp"] = pronouns[avatar_gender]["pos"]
1274 macros["tpsp"] = pronouns[avatar_gender]["sub"]
1279 # find and replace per the macros dict
1280 macro_start = text.find("$(")
1281 if macro_start == -1:
1283 macro_end = text.find(")", macro_start) + 1
1284 macro = text[macro_start + 2:macro_end - 1]
1285 if macro in macros.keys():
1286 replacement = macros[macro]
1288 # this is how we handle local file inclusion (dangerous!)
1289 elif macro.startswith("inc:"):
1290 incfile = mudpy.data.find_file(macro[4:], universe=universe)
1291 if os.path.exists(incfile):
1292 incfd = codecs.open(incfile, "r", "utf-8")
1295 if line.endswith("\n") and not line.endswith("\r\n"):
1296 line = line.replace("\n", "\r\n")
1298 # lose the trailing eol
1299 replacement = replacement[:-2]
1302 log("Couldn't read included " + incfile + " file.", 6)
1304 # if we get here, log and replace it with null
1308 log("Unexpected replacement macro " +
1309 macro + " encountered.", 6)
1311 # and now we act on the replacement
1312 text = text.replace("$(" + macro + ")", replacement)
1314 # replace the look-like-a-macro sequence
1315 text = text.replace("$_(", "$(")
1320 def escape_macros(value):
1321 """Escapes replacement macros in text."""
1322 if type(value) is str:
1323 return value.replace("$(", "$_(")
1328 def first_word(text, separator=" "):
1329 """Returns a tuple of the first word and the rest."""
1331 if text.find(separator) > 0:
1332 return text.split(separator, 1)
1340 """The things which should happen on each pulse, aside from reloads."""
1342 # open the listening socket if it hasn't been already
1343 if not hasattr(universe, "listening_socket"):
1344 universe.initialize_server_socket()
1346 # assign a user if a new connection is waiting
1347 user = check_for_connection(universe.listening_socket)
1349 universe.userlist.append(user)
1351 # iterate over the connected users
1352 for user in universe.userlist:
1355 # add an element for counters if it doesn't exist
1356 if "counters" not in universe.categories["internal"]:
1357 universe.categories["internal"]["counters"] = Element(
1358 "internal:counters", universe, old_style=True
1361 # update the log every now and then
1362 if not universe.categories["internal"]["counters"].get("mark"):
1363 log(str(len(universe.userlist)) + " connection(s)")
1364 universe.categories["internal"]["counters"].set(
1365 "mark", universe.categories["internal"]["time"].get(
1370 universe.categories["internal"]["counters"].set(
1371 "mark", universe.categories["internal"]["counters"].get(
1376 # periodically save everything
1377 if not universe.categories["internal"]["counters"].get("save"):
1379 universe.categories["internal"]["counters"].set(
1380 "save", universe.categories["internal"]["time"].get(
1385 universe.categories["internal"]["counters"].set(
1386 "save", universe.categories["internal"]["counters"].get(
1391 # pause for a configurable amount of time (decimal seconds)
1392 time.sleep(universe.categories["internal"]
1393 ["time"].get("increment"))
1395 # increase the elapsed increment counter
1396 universe.categories["internal"]["counters"].set(
1397 "elapsed", universe.categories["internal"]["counters"].get(
1404 """Reload all relevant objects."""
1405 for user in universe.userlist[:]:
1407 for element in universe.contents.values():
1408 if element.origin.is_writeable():
1413 def check_for_connection(listening_socket):
1414 """Check for a waiting connection and return a new user object."""
1416 # try to accept a new connection
1418 connection, address = listening_socket.accept()
1419 except BlockingIOError:
1422 # note that we got one
1423 log("Connection from " + address[0], 2)
1425 # disable blocking so we can proceed whether or not we can send/receive
1426 connection.setblocking(0)
1428 # create a new user object
1431 # associate this connection with it
1432 user.connection = connection
1434 # set the user's ipa from the connection's ipa
1435 user.address = address[0]
1437 # let the client know we WILL EOR (RFC 885)
1438 mudpy.telnet.enable(user, mudpy.telnet.TELOPT_EOR, mudpy.telnet.US)
1439 user.negotiation_pause = 2
1441 # return the new user object
1445 def get_menu(state, error=None, choices=None):
1446 """Show the correct menu text to a user."""
1448 # make sure we don't reuse a mutable sequence by default
1452 # get the description or error text
1453 message = get_menu_description(state, error)
1455 # get menu choices for the current state
1456 message += get_formatted_menu_choices(state, choices)
1458 # try to get a prompt, if it was defined
1459 message += get_menu_prompt(state)
1461 # throw in the default choice, if it exists
1462 message += get_formatted_default_menu_choice(state)
1464 # display a message indicating if echo is off
1465 message += get_echo_message(state)
1467 # return the assembly of various strings defined above
1471 def menu_echo_on(state):
1472 """True if echo is on, false if it is off."""
1473 return universe.categories["menu"][state].get("echo", True)
1476 def get_echo_message(state):
1477 """Return a message indicating that echo is off."""
1478 if menu_echo_on(state):
1481 return "(won't echo) "
1484 def get_default_menu_choice(state):
1485 """Return the default choice for a menu."""
1486 return universe.categories["menu"][state].get("default")
1489 def get_formatted_default_menu_choice(state):
1490 """Default menu choice foratted for inclusion in a prompt string."""
1491 default_choice = get_default_menu_choice(state)
1493 return "[$(red)" + default_choice + "$(nrm)] "
1498 def get_menu_description(state, error):
1499 """Get the description or error text."""
1501 # an error condition was raised by the handler
1504 # try to get an error message matching the condition
1506 description = universe.categories[
1507 "menu"][state].get("error_" + error)
1509 description = "That is not a valid choice..."
1510 description = "$(red)" + description + "$(nrm)"
1512 # there was no error condition
1515 # try to get a menu description for the current state
1516 description = universe.categories["menu"][state].get("description")
1518 # return the description or error message
1520 description += "$(eol)$(eol)"
1524 def get_menu_prompt(state):
1525 """Try to get a prompt, if it was defined."""
1526 prompt = universe.categories["menu"][state].get("prompt")
1532 def get_menu_choices(user):
1533 """Return a dict of choice:meaning."""
1534 menu = universe.categories["menu"][user.state]
1535 create_choices = menu.get("create")
1537 choices = eval(create_choices)
1543 for facet in menu.facets():
1544 if facet.startswith("demand_") and not eval(
1545 universe.categories["menu"][user.state].get(facet)
1547 ignores.append(facet.split("_", 2)[1])
1548 elif facet.startswith("create_"):
1549 creates[facet] = facet.split("_", 2)[1]
1550 elif facet.startswith("choice_"):
1551 options[facet] = facet.split("_", 2)[1]
1552 for facet in creates.keys():
1553 if not creates[facet] in ignores:
1554 choices[creates[facet]] = eval(menu.get(facet))
1555 for facet in options.keys():
1556 if not options[facet] in ignores:
1557 choices[options[facet]] = menu.get(facet)
1561 def get_formatted_menu_choices(state, choices):
1562 """Returns a formatted string of menu choices."""
1564 choice_keys = list(choices.keys())
1566 for choice in choice_keys:
1567 choice_output += " [$(red)" + choice + "$(nrm)] " + choices[
1571 choice_output += "$(eol)"
1572 return choice_output
1575 def get_menu_branches(state):
1576 """Return a dict of choice:branch."""
1578 for facet in universe.categories["menu"][state].facets():
1579 if facet.startswith("branch_"):
1581 facet.split("_", 2)[1]
1582 ] = universe.categories["menu"][state].get(facet)
1586 def get_default_branch(state):
1587 """Return the default branch."""
1588 return universe.categories["menu"][state].get("branch")
1591 def get_choice_branch(user, choice):
1592 """Returns the new state matching the given choice."""
1593 branches = get_menu_branches(user.state)
1594 if choice in branches.keys():
1595 return branches[choice]
1596 elif choice in user.menu_choices.keys():
1597 return get_default_branch(user.state)
1602 def get_menu_actions(state):
1603 """Return a dict of choice:branch."""
1605 for facet in universe.categories["menu"][state].facets():
1606 if facet.startswith("action_"):
1608 facet.split("_", 2)[1]
1609 ] = universe.categories["menu"][state].get(facet)
1613 def get_default_action(state):
1614 """Return the default action."""
1615 return universe.categories["menu"][state].get("action")
1618 def get_choice_action(user, choice):
1619 """Run any indicated script for the given choice."""
1620 actions = get_menu_actions(user.state)
1621 if choice in actions.keys():
1622 return actions[choice]
1623 elif choice in user.menu_choices.keys():
1624 return get_default_action(user.state)
1629 def handle_user_input(user):
1630 """The main handler, branches to a state-specific handler."""
1632 # if the user's client echo is off, send a blank line for aesthetics
1633 if mudpy.telnet.is_enabled(user, mudpy.telnet.TELOPT_ECHO,
1635 user.send("", add_prompt=False, prepend_padding=False)
1637 # check to make sure the state is expected, then call that handler
1638 if "handler_" + user.state in globals():
1639 exec("handler_" + user.state + "(user)")
1641 generic_menu_handler(user)
1643 # since we got input, flag that the menu/prompt needs to be redisplayed
1644 user.menu_seen = False
1646 # update the last_input timestamp while we're at it
1647 user.last_input = universe.get_time()
1650 def generic_menu_handler(user):
1651 """A generic menu choice handler."""
1653 # get a lower-case representation of the next line of input
1654 if user.input_queue:
1655 choice = user.input_queue.pop(0)
1657 choice = choice.lower()
1661 choice = get_default_menu_choice(user.state)
1662 if choice in user.menu_choices:
1663 exec(get_choice_action(user, choice))
1664 new_state = get_choice_branch(user, choice)
1666 user.state = new_state
1668 user.error = "default"
1671 def handler_entering_account_name(user):
1672 """Handle the login account name."""
1674 # get the next waiting line of input
1675 input_data = user.input_queue.pop(0)
1677 # did the user enter anything?
1680 # keep only the first word and convert to lower-case
1681 name = input_data.lower()
1683 # fail if there are non-alphanumeric characters
1684 if name != "".join(filter(
1685 lambda x: x >= "0" and x <= "9" or x >= "a" and x <= "z",
1687 user.error = "bad_name"
1689 # if that account exists, time to request a password
1690 elif name in universe.categories["account"]:
1691 user.account = universe.categories["account"][name]
1692 user.state = "checking_password"
1694 # otherwise, this could be a brand new user
1696 user.account = Element("account:" + name, universe, old_style=True)
1697 user.account.set("name", name)
1698 log("New user: " + name, 2)
1699 user.state = "checking_new_account_name"
1701 # if the user entered nothing for a name, then buhbye
1703 user.state = "disconnecting"
1706 def handler_checking_password(user):
1707 """Handle the login account password."""
1709 # get the next waiting line of input
1710 input_data = user.input_queue.pop(0)
1712 # does the hashed input equal the stored hash?
1713 if mudpy.password.verify(input_data, user.account.get("passhash")):
1715 # if so, set the username and load from cold storage
1716 if not user.replace_old_connections():
1718 user.state = "main_utility"
1720 # if at first your hashes don't match, try, try again
1721 elif user.password_tries < universe.contents["mudpy.limit"].get(
1722 "password_tries") - 1:
1723 user.password_tries += 1
1724 user.error = "incorrect"
1726 # we've exceeded the maximum number of password failures, so disconnect
1729 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1731 user.state = "disconnecting"
1734 def handler_entering_new_password(user):
1735 """Handle a new password entry."""
1737 # get the next waiting line of input
1738 input_data = user.input_queue.pop(0)
1740 # make sure the password is strong--at least one upper, one lower and
1741 # one digit, seven or more characters in length
1742 if len(input_data) > 6 and len(
1743 list(filter(lambda x: x >= "0" and x <= "9", input_data))
1745 list(filter(lambda x: x >= "A" and x <= "Z", input_data))
1747 list(filter(lambda x: x >= "a" and x <= "z", input_data))
1750 # hash and store it, then move on to verification
1751 user.account.set("passhash", mudpy.password.create(input_data))
1752 user.state = "verifying_new_password"
1754 # the password was weak, try again if you haven't tried too many times
1755 elif user.password_tries < universe.contents["mudpy.limit"].get(
1756 "password_tries") - 1:
1757 user.password_tries += 1
1760 # too many tries, so adios
1763 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1765 user.account.destroy()
1766 user.state = "disconnecting"
1769 def handler_verifying_new_password(user):
1770 """Handle the re-entered new password for verification."""
1772 # get the next waiting line of input
1773 input_data = user.input_queue.pop(0)
1775 # hash the input and match it to storage
1776 if mudpy.password.verify(input_data, user.account.get("passhash")):
1779 # the hashes matched, so go active
1780 if not user.replace_old_connections():
1781 user.state = "main_utility"
1783 # go back to entering the new password as long as you haven't tried
1785 elif user.password_tries < universe.contents["mudpy.limit"].get(
1786 "password_tries") - 1:
1787 user.password_tries += 1
1788 user.error = "differs"
1789 user.state = "entering_new_password"
1791 # otherwise, sayonara
1794 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1796 user.account.destroy()
1797 user.state = "disconnecting"
1800 def handler_active(user):
1801 """Handle input for active users."""
1803 # get the next waiting line of input
1804 input_data = user.input_queue.pop(0)
1809 # split out the command and parameters
1811 mode = actor.get("mode")
1812 if mode and input_data.startswith("!"):
1813 command_name, parameters = first_word(input_data[1:])
1814 elif mode == "chat":
1815 command_name = "say"
1816 parameters = input_data
1818 command_name, parameters = first_word(input_data)
1820 # lowercase the command
1821 command_name = command_name.lower()
1823 # the command matches a command word for which we have data
1824 if command_name in universe.categories["command"]:
1825 command = universe.categories["command"][command_name]
1829 # if it's allowed, do it
1830 if actor.can_run(command):
1831 exec(command.get("action"))
1833 # otherwise, give an error
1835 command_error(actor, input_data)
1837 # if no input, just idle back with a prompt
1839 user.send("", just_prompt=True)
1842 def command_halt(actor, parameters):
1843 """Halt the world."""
1846 # see if there's a message or use a generic one
1848 message = "Halting: " + parameters
1850 message = "User " + actor.owner.account.get(
1852 ) + " halted the world."
1855 broadcast(message, add_prompt=False)
1858 # set a flag to terminate the world
1859 universe.terminate_flag = True
1862 def command_reload(actor):
1863 """Reload all code modules, configs and data."""
1866 # let the user know and log
1867 actor.send("Reloading all code modules, configs and data.")
1870 actor.owner.account.get("name") + " reloaded the world.",
1874 # set a flag to reload
1875 universe.reload_flag = True
1878 def command_quit(actor):
1879 """Leave the world and go back to the main menu."""
1881 actor.owner.state = "main_utility"
1882 actor.owner.deactivate_avatar()
1885 def command_help(actor, parameters):
1886 """List available commands and provide help for commands."""
1888 # did the user ask for help on a specific command word?
1889 if parameters and actor.owner:
1891 # is the command word one for which we have data?
1892 if parameters in universe.categories["command"]:
1893 command = universe.categories["command"][parameters]
1897 # only for allowed commands
1898 if actor.can_run(command):
1900 # add a description if provided
1901 description = command.get("description")
1903 description = "(no short description provided)"
1904 if command.get("administrative"):
1908 output += parameters + "$(nrm) - " + description + "$(eol)$(eol)"
1910 # add the help text if provided
1911 help_text = command.get("help")
1913 help_text = "No help is provided for this command."
1916 # list related commands
1917 see_also = command.get("see_also")
1919 really_see_also = ""
1920 for item in see_also:
1921 if item in universe.categories["command"]:
1922 command = universe.categories["command"][item]
1923 if actor.can_run(command):
1925 really_see_also += ", "
1926 if command.get("administrative"):
1927 really_see_also += "$(red)"
1929 really_see_also += "$(grn)"
1930 really_see_also += item + "$(nrm)"
1932 output += "$(eol)$(eol)See also: " + really_see_also
1934 # no data for the requested command word
1936 output = "That is not an available command."
1938 # no specific command word was indicated
1941 # give a sorted list of commands with descriptions if provided
1942 output = "These are the commands available to you:$(eol)$(eol)"
1943 sorted_commands = list(universe.categories["command"].keys())
1944 sorted_commands.sort()
1945 for item in sorted_commands:
1946 command = universe.categories["command"][item]
1947 if actor.can_run(command):
1948 description = command.get("description")
1950 description = "(no short description provided)"
1951 if command.get("administrative"):
1955 output += item + "$(nrm) - " + description + "$(eol)"
1956 output += ("$(eol)Enter \"help COMMAND\" for help on a command "
1957 "named \"COMMAND\".")
1959 # send the accumulated output to the user
1963 def command_move(actor, parameters):
1964 """Move the avatar in a given direction."""
1965 if parameters in universe.contents[actor.get("location")].portals():
1966 actor.move_direction(parameters)
1968 actor.send("You cannot go that way.")
1971 def command_look(actor, parameters):
1974 actor.send("You can't look at or in anything yet.")
1976 actor.look_at(actor.get("location"))
1979 def command_say(actor, parameters):
1980 """Speak to others in the same area."""
1982 # check for replacement macros and escape them
1983 parameters = escape_macros(parameters)
1985 # if the message is wrapped in quotes, remove them and leave contents
1987 if parameters.startswith("\"") and parameters.endswith("\""):
1988 message = parameters[1:-1]
1991 # otherwise, get rid of stray quote marks on the ends of the message
1993 message = parameters.strip("\"'`")
1996 # the user entered a message
1999 # match the punctuation used, if any, to an action
2000 actions = universe.contents["mudpy.linguistic"].get(
2003 default_punctuation = (
2004 universe.contents["mudpy.linguistic"].get(
2005 "default_punctuation"))
2008 # reverse sort punctuation options so the longest match wins
2009 for mark in sorted(actions.keys(), reverse=True):
2010 if not literal and message.endswith(mark):
2011 action = actions[mark]
2014 # add punctuation if needed
2016 action = actions[default_punctuation]
2017 if message and not (
2018 literal or unicodedata.category(message[-1]) == "Po"
2020 message += default_punctuation
2022 # failsafe checks to avoid unwanted reformatting and null strings
2023 if message and not literal:
2025 # decapitalize the first letter to improve matching
2026 message = message[0].lower() + message[1:]
2028 # iterate over all words in message, replacing typos
2029 typos = universe.contents["mudpy.linguistic"].get(
2032 words = message.split()
2033 for index in range(len(words)):
2035 while unicodedata.category(word[0]) == "Po":
2037 while unicodedata.category(word[-1]) == "Po":
2039 if word in typos.keys():
2040 words[index] = words[index].replace(word, typos[word])
2041 message = " ".join(words)
2043 # capitalize the first letter
2044 message = message[0].upper() + message[1:]
2048 actor.echo_to_location(
2049 actor.get("name") + " " + action + "s, \"" + message + "\""
2051 actor.send("You " + action + ", \"" + message + "\"")
2053 # there was no message
2055 actor.send("What do you want to say?")
2058 def command_chat(actor):
2059 """Toggle chat mode."""
2060 mode = actor.get("mode")
2062 actor.set("mode", "chat")
2063 actor.send("Entering chat mode (use $(grn)!chat$(nrm) to exit).")
2064 elif mode == "chat":
2065 actor.remove_facet("mode")
2066 actor.send("Exiting chat mode.")
2068 actor.send("Sorry, but you're already busy with something else!")
2071 def command_show(actor, parameters):
2072 """Show program data."""
2074 arguments = parameters.split()
2076 message = "What do you want to show?"
2077 elif arguments[0] == "time":
2078 message = universe.categories["internal"]["counters"].get(
2080 ) + " increments elapsed since the world was created."
2081 elif arguments[0] == "categories":
2082 message = "These are the element categories:$(eol)"
2083 categories = list(universe.categories.keys())
2085 for category in categories:
2086 message += "$(eol) $(grn)" + category + "$(nrm)"
2087 elif arguments[0] == "files":
2088 message = "These are the current files containing the universe:$(eol)"
2089 filenames = list(universe.files.keys())
2091 for filename in filenames:
2092 if universe.files[filename].is_writeable():
2096 message += ("$(eol) $(red)(" + status + ") $(grn)" + filename
2098 elif arguments[0] == "category":
2099 if len(arguments) != 2:
2100 message = "You must specify one category."
2101 elif arguments[1] in universe.categories:
2102 message = ("These are the elements in the \"" + arguments[1]
2103 + "\" category:$(eol)")
2106 universe.categories[arguments[1]][x].key
2107 ) for x in universe.categories[arguments[1]].keys()
2110 for element in elements:
2111 message += "$(eol) $(grn)" + element + "$(nrm)"
2113 message = "Category \"" + arguments[1] + "\" does not exist."
2114 elif arguments[0] == "file":
2115 if len(arguments) != 2:
2116 message = "You must specify one file."
2117 elif arguments[1] in universe.files:
2118 message = ("These are the elements in the \"" + arguments[1]
2120 elements = universe.files[arguments[1]].data.keys()
2122 for element in elements:
2123 message += "$(eol) $(grn)" + element + "$(nrm)"
2125 message = "Category \"" + arguments[1] + "\" does not exist."
2126 elif arguments[0] == "element":
2127 if len(arguments) != 2:
2128 message = "You must specify one element."
2129 elif arguments[1].strip(".") in universe.contents:
2130 element = universe.contents[arguments[1].strip(".")]
2131 message = ("These are the properties of the \"" + arguments[1]
2132 + "\" element (in \"" + element.origin.filename
2134 facets = element.facets()
2135 for facet in sorted(facets):
2136 if element.old_style:
2137 message += ("$(eol) $(grn)%s: $(red)%s$(nrm)" %
2138 (facet, escape_macros(element.get(facet))))
2140 message += ("$(eol) $(grn)%s: $(red)%s$(nrm)" %
2141 (facet, str(facets[facet])))
2143 message = "Element \"" + arguments[1] + "\" does not exist."
2144 elif arguments[0] == "result":
2145 if len(arguments) < 2:
2146 message = "You need to specify an expression."
2149 message = repr(eval(" ".join(arguments[1:])))
2150 except Exception as e:
2151 message = ("$(red)Your expression raised an exception...$(eol)"
2152 "$(eol)$(bld)%s$(nrm)" % e)
2153 elif arguments[0] == "log":
2154 if len(arguments) == 4:
2155 if re.match("^\d+$", arguments[3]) and int(arguments[3]) >= 0:
2156 stop = int(arguments[3])
2161 if len(arguments) >= 3:
2162 if re.match("^\d+$", arguments[2]) and int(arguments[2]) > 0:
2163 start = int(arguments[2])
2168 if len(arguments) >= 2:
2169 if (re.match("^\d+$", arguments[1])
2170 and 0 <= int(arguments[1]) <= 9):
2171 level = int(arguments[1])
2174 elif 0 <= actor.owner.account.get("loglevel", 0) <= 9:
2175 level = actor.owner.account.get("loglevel", 0)
2178 if level > -1 and start > -1 and stop > -1:
2179 message = get_loglines(level, start, stop)
2181 message = ("When specified, level must be 0-9 (default 1), "
2182 "start and stop must be >=1 (default 10 and 1).")
2184 message = "I don't know what \"" + parameters + "\" is."
2188 def command_create(actor, parameters):
2189 """Create an element if it does not exist."""
2191 message = "You must at least specify an element to create."
2192 elif not actor.owner:
2195 arguments = parameters.split()
2196 if len(arguments) == 1:
2197 arguments.append("")
2198 if len(arguments) == 2:
2199 element, filename = arguments
2200 if element in universe.contents:
2201 message = "The \"" + element + "\" element already exists."
2203 message = ("You create \"" +
2204 element + "\" within the universe.")
2205 logline = actor.owner.account.get(
2207 ) + " created an element: " + element
2209 logline += " in file " + filename
2210 if filename not in universe.files:
2212 " Warning: \"" + filename + "\" is not yet "
2213 "included in any other file and will not be read "
2214 "on startup unless this is remedied.")
2215 Element(element, universe, filename, old_style=True)
2217 elif len(arguments) > 2:
2218 message = "You can only specify an element and a filename."
2222 def command_destroy(actor, parameters):
2223 """Destroy an element if it exists."""
2226 message = "You must specify an element to destroy."
2228 if parameters not in universe.contents:
2229 message = "The \"" + parameters + "\" element does not exist."
2231 universe.contents[parameters].destroy()
2232 message = ("You destroy \"" + parameters
2233 + "\" within the universe.")
2235 actor.owner.account.get(
2237 ) + " destroyed an element: " + parameters,
2243 def command_set(actor, parameters):
2244 """Set a facet of an element."""
2246 message = "You must specify an element, a facet and a value."
2248 arguments = parameters.split(" ", 2)
2249 if len(arguments) == 1:
2250 message = ("What facet of element \"" + arguments[0]
2251 + "\" would you like to set?")
2252 elif len(arguments) == 2:
2253 message = ("What value would you like to set for the \"" +
2254 arguments[1] + "\" facet of the \"" + arguments[0]
2257 element, facet, value = arguments
2258 if element not in universe.contents:
2259 message = "The \"" + element + "\" element does not exist."
2261 universe.contents[element].set(facet, value)
2262 message = ("You have successfully (re)set the \"" + facet
2263 + "\" facet of element \"" + element
2264 + "\". Try \"show element " +
2265 element + "\" for verification.")
2269 def command_delete(actor, parameters):
2270 """Delete a facet from an element."""
2272 message = "You must specify an element and a facet."
2274 arguments = parameters.split(" ")
2275 if len(arguments) == 1:
2276 message = ("What facet of element \"" + arguments[0]
2277 + "\" would you like to delete?")
2278 elif len(arguments) != 2:
2279 message = "You may only specify an element and a facet."
2281 element, facet = arguments
2282 if element not in universe.contents:
2283 message = "The \"" + element + "\" element does not exist."
2284 elif facet not in universe.contents[element].facets():
2285 message = ("The \"" + element + "\" element has no \"" + facet
2288 universe.contents[element].remove_facet(facet)
2289 message = ("You have successfully deleted the \"" + facet
2290 + "\" facet of element \"" + element
2291 + "\". Try \"show element " +
2292 element + "\" for verification.")
2296 def command_error(actor, input_data):
2297 """Generic error for an unrecognized command word."""
2299 # 90% of the time use a generic error
2300 if random.randrange(10):
2301 message = "I'm not sure what \"" + input_data + "\" means..."
2303 # 10% of the time use the classic diku error
2305 message = "Arglebargle, glop-glyf!?!"
2307 # send the error message
2311 def daemonize(universe):
2312 """Fork and disassociate from everything."""
2314 # only if this is what we're configured to do
2315 if universe.contents["mudpy.process"].get("daemon"):
2317 # log before we start forking around, so the terminal gets the message
2318 log("Disassociating from the controlling terminal.")
2320 # fork off and die, so we free up the controlling terminal
2324 # switch to a new process group
2327 # fork some more, this time to free us from the old process group
2331 # reset the working directory so we don't needlessly tie up mounts
2334 # clear the file creation mask so we can bend it to our will later
2337 # redirect stdin/stdout/stderr and close off their former descriptors
2338 for stdpipe in range(3):
2340 sys.stdin = codecs.open("/dev/null", "r", "utf-8")
2341 sys.__stdin__ = codecs.open("/dev/null", "r", "utf-8")
2342 sys.stdout = codecs.open("/dev/null", "w", "utf-8")
2343 sys.stderr = codecs.open("/dev/null", "w", "utf-8")
2344 sys.__stdout__ = codecs.open("/dev/null", "w", "utf-8")
2345 sys.__stderr__ = codecs.open("/dev/null", "w", "utf-8")
2348 def create_pidfile(universe):
2349 """Write a file containing the current process ID."""
2350 pid = str(os.getpid())
2351 log("Process ID: " + pid)
2352 file_name = universe.contents["mudpy.process"].get("pidfile")
2354 if not os.path.isabs(file_name):
2355 file_name = os.path.join(universe.startdir, file_name)
2356 file_descriptor = codecs.open(file_name, "w", "utf-8")
2357 file_descriptor.write(pid + "\n")
2358 file_descriptor.flush()
2359 file_descriptor.close()
2362 def remove_pidfile(universe):
2363 """Remove the file containing the current process ID."""
2364 file_name = universe.contents["mudpy.process"].get("pidfile")
2366 if not os.path.isabs(file_name):
2367 file_name = os.path.join(universe.startdir, file_name)
2368 if os.access(file_name, os.W_OK):
2369 os.remove(file_name)
2372 def excepthook(excepttype, value, tracebackdata):
2373 """Handle uncaught exceptions."""
2375 # assemble the list of errors into a single string
2377 traceback.format_exception(excepttype, value, tracebackdata)
2380 # try to log it, if possible
2383 except Exception as e:
2384 # try to write it to stderr, if possible
2385 sys.stderr.write(message + "\nException while logging...\n%s" % e)
2388 def sighook(what, where):
2389 """Handle external signals."""
2392 message = "Caught signal: "
2394 # for a hangup signal
2395 if what == signal.SIGHUP:
2396 message += "hangup (reloading)"
2397 universe.reload_flag = True
2399 # for a terminate signal
2400 elif what == signal.SIGTERM:
2401 message += "terminate (halting)"
2402 universe.terminate_flag = True
2404 # catchall for unexpected signals
2406 message += str(what) + " (unhandled)"
2412 def override_excepthook():
2413 """Redefine sys.excepthook with our own."""
2414 sys.excepthook = excepthook
2417 def assign_sighook():
2418 """Assign a customized handler for some signals."""
2419 signal.signal(signal.SIGHUP, sighook)
2420 signal.signal(signal.SIGTERM, sighook)
2424 """This contains functions to be performed when starting the engine."""
2426 # see if a configuration file was specified
2427 if len(sys.argv) > 1:
2428 conffile = sys.argv[1]
2434 universe = Universe(conffile, True)
2436 # report any loglines which accumulated during setup
2437 for logline in universe.setup_loglines:
2439 universe.setup_loglines = []
2441 # log an initial message
2442 log("Started mudpy with command line: " + " ".join(sys.argv))
2444 # fork and disassociate
2447 # override the default exception handler so we get logging first thing
2448 override_excepthook()
2450 # set up custom signal handlers
2454 create_pidfile(universe)
2456 # pass the initialized universe back
2461 """These are functions performed when shutting down the engine."""
2463 # the loop has terminated, so save persistent data
2466 # log a final message
2467 log("Shutting down now.")
2469 # get rid of the pidfile
2470 remove_pidfile(universe)