1 # -*- coding: utf-8 -*-
2 """Miscellaneous functions for the mudpy engine."""
4 # Copyright (c) 2004-2011 Jeremy Stanley <fungi@yuggoth.org>. Permission
5 # to use, copy, modify, and distribute this software is granted under
6 # terms provided in the LICENSE file distributed with this software.
11 """An element of the universe."""
13 def __init__(self, key, universe, filename=None):
14 """Set up a new element."""
18 # keep track of our key name
21 # keep track of what universe it's loading into
22 self.universe = universe
24 # clone attributes if this is replacing another element
25 if self.key in self.universe.contents:
26 old_element = self.universe.contents[self.key]
27 for attribute in vars(old_element).keys():
28 exec("self." + attribute + " = old_element." + attribute)
30 self.owner.avatar = self
32 # i guess this is a new element then
35 # not owned by a user by default (used for avatars)
38 # no contents in here by default
41 # parse out appropriate category and subkey names, add to list
42 if self.key.find(":") > 0:
43 self.category, self.subkey = self.key.split(":", 1)
45 self.category = "other"
46 self.subkey = self.key
47 if self.category not in self.universe.categories:
48 self.category = "other"
49 self.subkey = self.key
51 # get an appropriate filename for the origin
53 filename = self.universe.default_origins[self.category]
54 if not os.path.isabs(filename):
55 filename = os.path.abspath(filename)
57 # add the file if it doesn't exist yet
58 if filename not in self.universe.files:
59 data.DataFile(filename, self.universe)
61 # record or reset a pointer to the origin file
62 self.origin = self.universe.files[filename]
64 # add a data section to the origin if necessary
65 if not self.origin.data.has_section(self.key):
66 self.origin.data.add_section(self.key)
68 # add or replace this element in the universe
69 self.universe.contents[self.key] = self
70 self.universe.categories[self.category][self.subkey] = self
73 """Create a new element and replace this one."""
74 new_element = Element(self.key, self.universe, self.origin.filename)
78 """Remove an element from the universe and destroy it."""
79 self.origin.data.remove_section(self.key)
80 del self.universe.categories[self.category][self.subkey]
81 del self.universe.contents[self.key]
85 """Return a list of non-inherited facets for this element."""
86 if self.key in self.origin.data.sections():
87 return self.origin.data.options(self.key)
91 def has_facet(self, facet):
92 """Return whether the non-inherited facet exists."""
93 return facet in self.facets()
95 def remove_facet(self, facet):
96 """Remove a facet from the element."""
97 if self.has_facet(facet):
98 self.origin.data.remove_option(self.key, facet)
99 self.origin.modified = True
102 """Return a list of the element's inheritance lineage."""
103 if self.has_facet("inherit"):
104 ancestry = self.getlist("inherit")
105 for parent in ancestry[:]:
106 ancestors = self.universe.contents[parent].ancestry()
107 for ancestor in ancestors:
108 if ancestor not in ancestry:
109 ancestry.append(ancestor)
114 def get(self, facet, default=None):
115 """Retrieve values."""
118 if self.origin.data.has_option(self.key, facet):
119 raw_data = self.origin.data.get(self.key, facet)
120 if raw_data.startswith("u\"") or raw_data.startswith("u'"):
121 raw_data = raw_data[1:]
122 raw_data.strip("\"'")
124 elif self.has_facet("inherit"):
125 for ancestor in self.ancestry():
126 if self.universe.contents[ancestor].has_facet(facet):
127 return self.universe.contents[ancestor].get(facet)
131 def getboolean(self, facet, default=None):
132 """Retrieve values as boolean type."""
135 if self.origin.data.has_option(self.key, facet):
136 return self.origin.data.getboolean(self.key, facet)
137 elif self.has_facet("inherit"):
138 for ancestor in self.ancestry():
139 if self.universe.contents[ancestor].has_facet(facet):
140 return self.universe.contents[ancestor].getboolean(facet)
144 def getint(self, facet, default=None):
145 """Return values as int/long type."""
148 if self.origin.data.has_option(self.key, facet):
149 return self.origin.data.getint(self.key, facet)
150 elif self.has_facet("inherit"):
151 for ancestor in self.ancestry():
152 if self.universe.contents[ancestor].has_facet(facet):
153 return self.universe.contents[ancestor].getint(facet)
157 def getfloat(self, facet, default=None):
158 """Return values as float type."""
161 if self.origin.data.has_option(self.key, facet):
162 return self.origin.data.getfloat(self.key, facet)
163 elif self.has_facet("inherit"):
164 for ancestor in self.ancestry():
165 if self.universe.contents[ancestor].has_facet(facet):
166 return self.universe.contents[ancestor].getfloat(facet)
170 def getlist(self, facet, default=None):
171 """Return values as list type."""
175 value = self.get(facet)
177 return data.makelist(value)
181 def getdict(self, facet, default=None):
182 """Return values as dict type."""
186 value = self.get(facet)
188 return data.makedict(value)
192 def set(self, facet, value):
194 if not self.has_facet(facet) or not self.get(facet) == value:
195 if type(value) is long or repr(type(value)) == "<type 'unicode'>":
197 elif not type(value) is str:
199 self.origin.data.set(self.key, facet, value)
200 self.origin.modified = True
202 def append(self, facet, value):
203 """Append value tp a list."""
204 if type(value) is long:
206 elif not type(value) is str:
208 newlist = self.getlist(facet)
209 newlist.append(value)
210 self.set(facet, newlist)
212 def new_event(self, action, when=None):
213 """Create, attach and enqueue an event element."""
215 # if when isn't specified, that means now
217 when = self.universe.get_time()
219 # events are elements themselves
220 event = Element("event:" + self.key + ":" + counter)
230 add_terminator=False,
233 """Convenience method to pass messages to an owner."""
246 def can_run(self, command):
247 """Check if the user can run this command object."""
249 # has to be in the commands category
250 if command not in self.universe.categories["command"].values():
253 # avatars of administrators can run any command
254 elif self.owner and self.owner.account.getboolean("administrator"):
257 # everyone can run non-administrative commands
258 elif not command.getboolean("administrative"):
261 # otherwise the command cannot be run by this actor
265 # pass back the result
268 def update_location(self):
269 """Make sure the location's contents contain this element."""
270 location = self.get("location")
271 if location in self.universe.contents:
272 self.universe.contents[location].contents[self.key] = self
274 def clean_contents(self):
275 """Make sure the element's contents aren't bogus."""
276 for element in self.contents.values():
277 if element.get("location") != self.key:
278 del self.contents[element.key]
280 def go_to(self, location):
281 """Relocate the element to a specific location."""
282 current = self.get("location")
283 if current and self.key in self.universe.contents[current].contents:
284 del universe.contents[current].contents[self.key]
285 if location in self.universe.contents:
286 self.set("location", location)
287 self.universe.contents[location].contents[self.key] = self
288 self.look_at(location)
291 """Relocate the element to its default location."""
292 self.go_to(self.get("default_location"))
293 self.echo_to_location(
294 "You suddenly realize that " + self.get("name") + " is here."
297 def move_direction(self, direction):
298 """Relocate the element in a specified direction."""
299 self.echo_to_location(
302 ) + " exits " + self.universe.categories[
313 "You exit " + self.universe.categories[
325 self.universe.contents[
326 self.get("location")].link_neighbor(direction)
328 self.echo_to_location(
331 ) + " arrives from " + self.universe.categories[
342 def look_at(self, key):
343 """Show an element to another element."""
345 element = self.universe.contents[key]
347 name = element.get("name")
349 message += "$(cyn)" + name + "$(nrm)$(eol)"
350 description = element.get("description")
352 message += description + "$(eol)"
353 portal_list = element.portals().keys()
356 message += "$(cyn)[ Exits: " + ", ".join(
359 for element in self.universe.contents[
362 if element.getboolean("is_actor") and element is not self:
363 message += "$(yel)" + element.get(
365 ) + " is here.$(nrm)$(eol)"
366 elif element is not self:
367 message += "$(grn)" + element.get(
373 """Map the portal directions for a room to neighbors."""
376 if re.match("""^location:-?\d+,-?\d+,-?\d+$""", self.key):
377 coordinates = [(int(x))
378 for x in self.key.split(":")[1].split(",")]
379 directions = self.universe.categories["internal"]["directions"]
383 x, directions.getdict(x)["vector"]
384 ) for x in directions.facets()
387 for portal in self.getlist("gridlinks"):
388 adjacent = map(lambda c, o: c + o,
389 coordinates, offsets[portal])
390 neighbor = "location:" + ",".join(
391 [(str(x)) for x in adjacent]
393 if neighbor in self.universe.contents:
394 portals[portal] = neighbor
395 for facet in self.facets():
396 if facet.startswith("link_"):
397 neighbor = self.get(facet)
398 if neighbor in self.universe.contents:
399 portal = facet.split("_")[1]
400 portals[portal] = neighbor
403 def link_neighbor(self, direction):
404 """Return the element linked in a given direction."""
405 portals = self.portals()
406 if direction in portals:
407 return portals[direction]
409 def echo_to_location(self, message):
410 """Show a message to other elements in the current location."""
411 for element in self.universe.contents[
414 if element is not self:
415 element.send(message)
422 def __init__(self, filename="", load=False):
423 """Initialize the universe."""
428 self.default_origins = {}
430 self.pending_events_long = {}
431 self.pending_events_short = {}
432 self.private_files = []
433 self.reload_flag = False
434 self.startdir = os.getcwd()
435 self.terminate_flag = False
438 possible_filenames = [
444 "/usr/local/mudpy/mudpy.conf",
445 "/usr/local/mudpy/etc/mudpy.conf",
446 "/etc/mudpy/mudpy.conf",
449 for filename in possible_filenames:
450 if os.access(filename, os.R_OK):
452 if not os.path.isabs(filename):
453 filename = os.path.join(self.startdir, filename)
454 self.filename = filename
459 """Load universe data from persistent storage."""
462 # the files dict must exist and filename needs to be read-only
466 self.filename in self.files and self.files[
471 # clear out all read-only files
472 if hasattr(self, "files"):
473 for data_filename in self.files.keys():
474 if not self.files[data_filename].is_writeable():
475 del self.files[data_filename]
477 # start loading from the initial file
478 data.DataFile(self.filename, self)
480 # make a list of inactive avatars
481 inactive_avatars = []
482 for account in self.categories["account"].values():
483 inactive_avatars += [
484 (self.contents[x]) for x in account.getlist("avatars")
486 for user in self.userlist:
487 if user.avatar in inactive_avatars:
488 inactive_avatars.remove(user.avatar)
490 # go through all elements to clear out inactive avatar locations
491 for element in self.contents.values():
492 location = element.get("location")
493 if element in inactive_avatars and location:
494 if location in self.contents and element.key in self.contents[
497 del self.contents[location].contents[element.key]
498 element.set("default_location", location)
499 element.remove_facet("location")
501 # another pass to straighten out all the element contents
502 for element in self.contents.values():
503 element.update_location()
504 element.clean_contents()
507 """Create a new, empty Universe (the Big Bang)."""
508 new_universe = Universe()
509 for attribute in vars(self).keys():
510 exec("new_universe." + attribute + " = self." + attribute)
511 new_universe.reload_flag = False
516 """Save the universe to persistent storage."""
517 for key in self.files:
518 self.files[key].save()
520 def initialize_server_socket(self):
521 """Create and open the listening socket."""
524 # need to know the local address and port number for the listener
525 host = self.categories["internal"]["network"].get("host")
526 port = self.categories["internal"]["network"].getint("port")
528 # if no host was specified, bind to all local addresses (preferring
536 # figure out if this is ipv4 or v6
537 family = socket.getaddrinfo(host, port)[0][0]
538 if family is socket.AF_INET6 and not socket.has_ipv6:
539 log("No support for IPv6 address %s (use IPv4 instead)." % host)
541 # create a new stream-type socket object
542 self.listening_socket = socket.socket(family, socket.SOCK_STREAM)
544 # set the socket options to allow existing open ones to be
545 # reused (fixes a bug where the server can't bind for a minute
546 # when restarting on linux systems)
547 self.listening_socket.setsockopt(
548 socket.SOL_SOCKET, socket.SO_REUSEADDR, 1
551 # bind the socket to to our desired server ipa and port
552 self.listening_socket.bind((host, port))
554 # disable blocking so we can proceed whether or not we can
556 self.listening_socket.setblocking(0)
558 # start listening on the socket
559 self.listening_socket.listen(1)
561 # note that we're now ready for user connections
563 "Listening for Telnet connections on: " +
564 host + ":" + str(port)
568 """Convenience method to get the elapsed time counter."""
569 return self.categories["internal"]["counters"].getint("elapsed")
574 """This is a connected user."""
577 """Default values for the in-memory user variables."""
581 self.authenticated = False
584 self.connection = None
586 self.input_queue = []
587 self.last_address = ""
588 self.last_input = universe.get_time()
589 self.menu_choices = {}
590 self.menu_seen = False
591 self.negotiation_pause = 0
592 self.output_queue = []
593 self.partial_input = ""
594 self.password_tries = 0
595 self.state = "initial"
599 """Log, close the connection and remove."""
601 name = self.account.get("name")
605 message = "User " + name
607 message = "An unnamed user"
608 message += " logged out."
610 self.deactivate_avatar()
611 self.connection.close()
614 def check_idle(self):
615 """Warn or disconnect idle users as appropriate."""
616 idletime = universe.get_time() - self.last_input
617 linkdead_dict = universe.categories["internal"]["time"].getdict(
620 if self.state in linkdead_dict:
621 linkdead_state = self.state
623 linkdead_state = "default"
624 if idletime > linkdead_dict[linkdead_state]:
626 "$(eol)$(red)You've done nothing for far too long... goodbye!"
631 logline = "Disconnecting "
632 if self.account and self.account.get("name"):
633 logline += self.account.get("name")
635 logline += "an unknown user"
636 logline += " after idling too long in the " + \
637 self.state + " state."
639 self.state = "disconnecting"
640 self.menu_seen = False
641 idle_dict = universe.categories["internal"]["time"].getdict("idle")
642 if self.state in idle_dict:
643 idle_state = self.state
645 idle_state = "default"
646 if idletime == idle_dict[idle_state]:
648 "$(eol)$(red)If you continue to be unproductive, "
649 + "you'll be shown the door...$(nrm)$(eol)"
653 """Save, load a new user and relocate the connection."""
655 # get out of the list
658 # create a new user object
661 # set everything equivalent
662 for attribute in vars(self).keys():
663 exec("new_user." + attribute + " = self." + attribute)
665 # the avatar needs a new owner
667 new_user.avatar.owner = new_user
670 universe.userlist.append(new_user)
672 # get rid of the old user object
675 def replace_old_connections(self):
676 """Disconnect active users with the same name."""
678 # the default return value
681 # iterate over each user in the list
682 for old_user in universe.userlist:
684 # the name is the same but it's not us
687 ) and old_user.account and old_user.account.get(
689 ) == self.account.get(
691 ) and old_user is not self:
695 "User " + self.account.get(
697 ) + " reconnected--closing old connection to "
698 + old_user.address + ".",
702 "$(eol)$(red)New connection from " + self.address
703 + ". Terminating old connection...$(nrm)$(eol)",
708 # close the old connection
709 old_user.connection.close()
711 # replace the old connection with this one
713 "$(eol)$(red)Taking over old connection from "
714 + old_user.address + ".$(nrm)"
716 old_user.connection = self.connection
717 old_user.last_address = old_user.address
718 old_user.address = self.address
720 # take this one out of the list and delete
726 # true if an old connection was replaced, false if not
729 def authenticate(self):
730 """Flag the user as authenticated and disconnect duplicates."""
731 if self.state is not "authenticated":
732 log("User " + self.account.get("name") + " logged in.", 2)
733 self.authenticated = True
734 if self.account.subkey in universe.categories[
741 self.account.set("administrator", "True")
744 """Send the user their current menu."""
745 if not self.menu_seen:
746 self.menu_choices = get_menu_choices(self)
748 get_menu(self.state, self.error, self.menu_choices),
752 self.menu_seen = True
754 self.adjust_echoing()
756 def adjust_echoing(self):
757 """Adjust echoing to match state menu requirements."""
759 if telnet.is_enabled(self, telnet.TELOPT_ECHO, telnet.US):
760 if menu_echo_on(self.state):
761 telnet.disable(self, telnet.TELOPT_ECHO, telnet.US)
762 elif not menu_echo_on(self.state):
763 telnet.enable(self, telnet.TELOPT_ECHO, telnet.US)
766 """Remove a user from the list of connected users."""
767 universe.userlist.remove(self)
777 add_terminator=False,
780 """Send arbitrary text to a connected user."""
783 # unless raw mode is on, clean it up all nice and pretty
786 # strip extra $(eol) off if present
787 while output.startswith("$(eol)"):
789 while output.endswith("$(eol)"):
791 extra_lines = output.find("$(eol)$(eol)$(eol)")
792 while extra_lines > -1:
793 output = output[:extra_lines] + output[extra_lines + 6:]
794 extra_lines = output.find("$(eol)$(eol)$(eol)")
796 # start with a newline, append the message, then end
797 # with the optional eol string passed to this function
798 # and the ansi escape to return to normal text
799 if not just_prompt and prepend_padding:
800 if not self.output_queue \
801 or not self.output_queue[-1].endswith("\r\n"):
802 output = "$(eol)" + output
803 elif not self.output_queue[-1].endswith(
805 ) and not self.output_queue[-1].endswith(
808 output = "$(eol)" + output
809 output += eol + unichr(27) + "[0m"
811 # tack on a prompt if active
812 if self.state == "active":
817 mode = self.avatar.get("mode")
819 output += "(" + mode + ") "
821 # find and replace macros in the output
822 output = replace_macros(self, output)
824 # wrap the text at the client's width (min 40, 0 disables)
826 if self.columns < 40:
830 output = wrap_ansi_text(output, wrap)
832 # if supported by the client, encode it utf-8
833 if telnet.is_enabled(self, telnet.TELOPT_BINARY, telnet.US):
834 encoded_output = output.encode("utf-8")
836 # otherwise just send ascii
838 encoded_output = output.encode("ascii", "replace")
840 # end with a terminator if requested
841 if add_prompt or add_terminator:
842 if telnet.is_enabled(self, telnet.TELOPT_EOR, telnet.US):
843 encoded_output += telnet.telnet_proto(telnet.IAC,
845 elif not telnet.is_enabled(self, telnet.TELOPT_SGA, telnet.US):
846 encoded_output += telnet.telnet_proto(telnet.IAC,
849 # and tack it onto the queue
850 self.output_queue.append(encoded_output)
852 # if this is urgent, flush all pending output
856 # just dump raw bytes as requested
858 self.output_queue.append(output)
862 """All the things to do to the user per increment."""
864 # if the world is terminating, disconnect
865 if universe.terminate_flag:
866 self.state = "disconnecting"
867 self.menu_seen = False
869 # check for an idle connection and act appropriately
873 # if output is paused, decrement the counter
874 if self.state == "initial":
875 if self.negotiation_pause:
876 self.negotiation_pause -= 1
878 self.state = "entering_account_name"
880 # show the user a menu as needed
881 elif not self.state == "active":
884 # flush any pending output in the queue
887 # disconnect users with the appropriate state
888 if self.state == "disconnecting":
891 # check for input and add it to the queue
894 # there is input waiting in the queue
896 handle_user_input(self)
899 """Try to send the last item in the queue and remove it."""
900 if self.output_queue:
902 self.connection.send(self.output_queue[0])
903 del self.output_queue[0]
905 if self.account and self.account.get("name"):
906 account = self.account.get("name")
908 account = "an unknown user"
909 log("Sending to %s raised an exception (broken pipe?)."
913 def enqueue_input(self):
914 """Process and enqueue any new input."""
918 # check for some input
920 raw_input = self.connection.recv(1024)
927 # tack this on to any previous partial
928 self.partial_input += raw_input
930 # reply to and remove any IAC negotiation codes
931 telnet.negotiate_telnet_options(self)
933 # separate multiple input lines
934 new_input_lines = self.partial_input.split("\n")
936 # if input doesn't end in a newline, replace the
937 # held partial input with the last line of it
938 if not self.partial_input.endswith("\n"):
939 self.partial_input = new_input_lines.pop()
941 # otherwise, chop off the extra null input and reset
942 # the held partial input
944 new_input_lines.pop()
945 self.partial_input = ""
947 # iterate over the remaining lines
948 for line in new_input_lines:
950 # strip off extra whitespace
953 # log non-printable characters remaining
954 if telnet.is_enabled(self, telnet.TELOPT_BINARY, telnet.HIM):
955 asciiline = filter(lambda x: " " <= x <= "~", line)
956 if line != asciiline:
957 logline = "Non-ASCII characters from "
958 if self.account and self.account.get("name"):
959 logline += self.account.get("name") + ": "
961 logline += "unknown user: "
962 logline += repr(line)
966 # put on the end of the queue
967 self.input_queue.append(
968 unicodedata.normalize("NFKC", line.decode("utf-8"))
971 def new_avatar(self):
972 """Instantiate a new, unconfigured avatar for this user."""
974 while "avatar:" + self.account.get("name") + ":" + str(
976 ) in universe.categories["actor"].keys():
978 self.avatar = Element(
979 "actor:avatar:" + self.account.get("name") + ":" + str(
984 self.avatar.append("inherit", "archetype:avatar")
985 self.account.append("avatars", self.avatar.key)
987 def delete_avatar(self, avatar):
988 """Remove an avatar from the world and from the user's list."""
989 if self.avatar is universe.contents[avatar]:
991 universe.contents[avatar].destroy()
992 avatars = self.account.getlist("avatars")
993 avatars.remove(avatar)
994 self.account.set("avatars", avatars)
996 def activate_avatar_by_index(self, index):
997 """Enter the world with a particular indexed avatar."""
998 self.avatar = universe.contents[
999 self.account.getlist("avatars")[index]]
1000 self.avatar.owner = self
1001 self.state = "active"
1002 self.avatar.go_home()
1004 def deactivate_avatar(self):
1005 """Have the active avatar leave the world."""
1007 current = self.avatar.get("location")
1009 self.avatar.set("default_location", current)
1010 self.avatar.echo_to_location(
1011 "You suddenly wonder where " + self.avatar.get(
1015 del universe.contents[current].contents[self.avatar.key]
1016 self.avatar.remove_facet("location")
1017 self.avatar.owner = None
1021 """Destroy the user and associated avatars."""
1022 for avatar in self.account.getlist("avatars"):
1023 self.delete_avatar(avatar)
1024 self.account.destroy()
1026 def list_avatar_names(self):
1027 """List names of assigned avatars."""
1029 universe.contents[avatar].get(
1031 ) for avatar in self.account.getlist("avatars")
1035 def broadcast(message, add_prompt=True):
1036 """Send a message to all connected users."""
1037 for each_user in universe.userlist:
1038 each_user.send("$(eol)" + message, add_prompt=add_prompt)
1041 def log(message, level=0):
1042 """Log a message."""
1048 # a couple references we need
1049 file_name = universe.categories["internal"]["logging"].get("file")
1050 max_log_lines = universe.categories["internal"]["logging"].getint(
1053 syslog_name = universe.categories["internal"]["logging"].get("syslog")
1054 timestamp = time.asctime()[4:19]
1056 # turn the message into a list of lines
1058 lambda x: x != "", [(x.rstrip()) for x in message.split("\n")]
1061 # send the timestamp and line to a file
1063 if not os.path.isabs(file_name):
1064 file_name = os.path.join(universe.startdir, file_name)
1065 file_descriptor = codecs.open(file_name, "a", "utf-8")
1067 file_descriptor.write(timestamp + " " + line + "\n")
1068 file_descriptor.flush()
1069 file_descriptor.close()
1071 # send the timestamp and line to standard output
1072 if universe.categories["internal"]["logging"].getboolean("stdout"):
1074 print(timestamp + " " + line)
1076 # send the line to the system log
1079 syslog_name.encode("utf-8"),
1081 syslog.LOG_INFO | syslog.LOG_DAEMON
1087 # display to connected administrators
1088 for user in universe.userlist:
1089 if user.state == "active" and user.account.getboolean(
1091 ) and user.account.getint("loglevel") <= level:
1092 # iterate over every line in the message
1096 "$(bld)$(red)" + timestamp + " "
1097 + line.replace("$(", "$_(") + "$(nrm)$(eol)")
1098 user.send(full_message, flush=True)
1100 # add to the recent log list
1102 while 0 < len(universe.loglines) >= max_log_lines:
1103 del universe.loglines[0]
1104 universe.loglines.append((level, timestamp + " " + line))
1107 def get_loglines(level, start, stop):
1108 """Return a specific range of loglines filtered by level."""
1110 # filter the log lines
1111 loglines = filter(lambda x: x[0] >= level, universe.loglines)
1113 # we need these in several places
1114 total_count = str(len(universe.loglines))
1115 filtered_count = len(loglines)
1117 # don't proceed if there are no lines
1120 # can't start before the begining or at the end
1121 if start > filtered_count:
1122 start = filtered_count
1126 # can't stop before we start
1133 message = "There are " + str(total_count)
1134 message += " log lines in memory and " + str(filtered_count)
1135 message += " at or above level " + str(level) + "."
1136 message += " The matching lines from " + str(stop) + " to "
1137 message += str(start) + " are:$(eol)$(eol)"
1139 # add the text from the selected lines
1141 range_lines = loglines[-start:-(stop - 1)]
1143 range_lines = loglines[-start:]
1144 for line in range_lines:
1145 message += " (" + str(line[0]) + ") " + line[1].replace(
1149 # there were no lines
1151 message = "None of the " + str(total_count)
1152 message += " lines in memory matches your request."
1158 def glyph_columns(character):
1159 """Convenience function to return the column width of a glyph."""
1161 if unicodedata.east_asian_width(character) in "FW":
1167 def wrap_ansi_text(text, width):
1168 """Wrap text with arbitrary width while ignoring ANSI colors."""
1171 # the current position in the entire text string, including all
1172 # characters, printable or otherwise
1175 # the current text position relative to the begining of the line,
1176 # ignoring color escape sequences
1179 # the absolute position of the most recent whitespace character
1182 # whether the current character is part of a color escape sequence
1185 # normalize any potentially composited unicode before we count it
1186 text = unicodedata.normalize("NFKC", text)
1188 # iterate over each character from the begining of the text
1189 for each_character in text:
1191 # the current character is the escape character
1192 if each_character == "\x1b" and not escape:
1195 # the current character is within an escape sequence
1198 # the current character is m, which terminates the
1200 if each_character == "m":
1203 # the current character is a newline, so reset the relative
1204 # position (start a new line)
1205 elif each_character == "\n":
1207 last_whitespace = abs_pos
1209 # the current character meets the requested maximum line width,
1210 # so we need to backtrack and find a space at which to wrap;
1211 # special care is taken to avoid an off-by-one in case the
1212 # current character is a double-width glyph
1213 elif each_character != "\r" and (
1214 rel_pos >= width or (
1215 rel_pos >= width - 1 and glyph_columns(
1221 # it's always possible we landed on whitespace
1222 if unicodedata.category(each_character) in ("Cc", "Zs"):
1223 last_whitespace = abs_pos
1225 # insert an eol in place of the space
1226 text = text[:last_whitespace] + \
1227 "\r\n" + text[last_whitespace + 1:]
1229 # increase the absolute position because an eol is two
1230 # characters but the space it replaced was only one
1233 # now we're at the begining of a new line, plus the
1234 # number of characters wrapped from the previous line
1236 for remaining_characters in text[last_whitespace:abs_pos]:
1237 rel_pos += glyph_columns(remaining_characters)
1239 # as long as the character is not a carriage return and the
1240 # other above conditions haven't been met, count it as a
1241 # printable character
1242 elif each_character != "\r":
1243 rel_pos += glyph_columns(each_character)
1244 if unicodedata.category(each_character) in ("Cc", "Zs"):
1245 last_whitespace = abs_pos
1247 # increase the absolute position for every character
1250 # return the newly-wrapped text
1254 def weighted_choice(data):
1255 """Takes a dict weighted by value and returns a random key."""
1258 # this will hold our expanded list of keys from the data
1261 # create the expanded list of keys
1262 for key in data.keys():
1263 for count in range(data[key]):
1264 expanded.append(key)
1266 # return one at random
1267 return random.choice(expanded)
1271 """Returns a random character name."""
1274 # the vowels and consonants needed to create romaji syllables
1303 # this dict will hold our weighted list of syllables
1306 # generate the list with an even weighting
1307 for consonant in consonants:
1308 for vowel in vowels:
1309 syllables[consonant + vowel] = 1
1311 # we'll build the name into this string
1314 # create a name of random length from the syllables
1315 for syllable in range(random.randrange(2, 6)):
1316 name += weighted_choice(syllables)
1318 # strip any leading quotemark, capitalize and return the name
1319 return name.strip("'").capitalize()
1322 def replace_macros(user, text, is_input=False):
1323 """Replaces macros in text output."""
1328 # third person pronouns
1330 "female": {"obj": "her", "pos": "hers", "sub": "she"},
1331 "male": {"obj": "him", "pos": "his", "sub": "he"},
1332 "neuter": {"obj": "it", "pos": "its", "sub": "it"}
1335 # a dict of replacement macros
1338 "bld": unichr(27) + "[1m",
1339 "nrm": unichr(27) + "[0m",
1340 "blk": unichr(27) + "[30m",
1341 "blu": unichr(27) + "[34m",
1342 "cyn": unichr(27) + "[36m",
1343 "grn": unichr(27) + "[32m",
1344 "mgt": unichr(27) + "[35m",
1345 "red": unichr(27) + "[31m",
1346 "yel": unichr(27) + "[33m",
1349 # add dynamic macros where possible
1351 account_name = user.account.get("name")
1353 macros["account"] = account_name
1355 avatar_gender = user.avatar.get("gender")
1357 macros["tpop"] = pronouns[avatar_gender]["obj"]
1358 macros["tppp"] = pronouns[avatar_gender]["pos"]
1359 macros["tpsp"] = pronouns[avatar_gender]["sub"]
1364 # find and replace per the macros dict
1365 macro_start = text.find("$(")
1366 if macro_start == -1:
1368 macro_end = text.find(")", macro_start) + 1
1369 macro = text[macro_start + 2:macro_end - 1]
1370 if macro in macros.keys():
1371 replacement = macros[macro]
1373 # this is how we handle local file inclusion (dangerous!)
1374 elif macro.startswith("inc:"):
1375 incfile = data.find_file(macro[4:], universe=universe)
1376 if os.path.exists(incfile):
1377 incfd = codecs.open(incfile, "r", "utf-8")
1380 if line.endswith("\n") and not line.endswith("\r\n"):
1381 line = line.replace("\n", "\r\n")
1383 # lose the trailing eol
1384 replacement = replacement[:-2]
1387 log("Couldn't read included " + incfile + " file.", 6)
1389 # if we get here, log and replace it with null
1393 log("Unexpected replacement macro " +
1394 macro + " encountered.", 6)
1396 # and now we act on the replacement
1397 text = text.replace("$(" + macro + ")", replacement)
1399 # replace the look-like-a-macro sequence
1400 text = text.replace("$_(", "$(")
1405 def escape_macros(text):
1406 """Escapes replacement macros in text."""
1407 return text.replace("$(", "$_(")
1410 def first_word(text, separator=" "):
1411 """Returns a tuple of the first word and the rest."""
1413 if text.find(separator) > 0:
1414 return text.split(separator, 1)
1422 """The things which should happen on each pulse, aside from reloads."""
1425 # open the listening socket if it hasn't been already
1426 if not hasattr(universe, "listening_socket"):
1427 universe.initialize_server_socket()
1429 # assign a user if a new connection is waiting
1430 user = check_for_connection(universe.listening_socket)
1432 universe.userlist.append(user)
1434 # iterate over the connected users
1435 for user in universe.userlist:
1438 # add an element for counters if it doesn't exist
1439 if "counters" not in universe.categories["internal"]:
1440 universe.categories["internal"]["counters"] = Element(
1441 "internal:counters", universe
1444 # update the log every now and then
1445 if not universe.categories["internal"]["counters"].getint("mark"):
1446 log(str(len(universe.userlist)) + " connection(s)")
1447 universe.categories["internal"]["counters"].set(
1448 "mark", universe.categories["internal"]["time"].getint(
1453 universe.categories["internal"]["counters"].set(
1454 "mark", universe.categories["internal"]["counters"].getint(
1459 # periodically save everything
1460 if not universe.categories["internal"]["counters"].getint("save"):
1462 universe.categories["internal"]["counters"].set(
1463 "save", universe.categories["internal"]["time"].getint(
1468 universe.categories["internal"]["counters"].set(
1469 "save", universe.categories["internal"]["counters"].getint(
1474 # pause for a configurable amount of time (decimal seconds)
1475 time.sleep(universe.categories["internal"]
1476 ["time"].getfloat("increment"))
1478 # increase the elapsed increment counter
1479 universe.categories["internal"]["counters"].set(
1480 "elapsed", universe.categories["internal"]["counters"].getint(
1487 """Reload all relevant objects."""
1488 for user in universe.userlist[:]:
1490 for element in universe.contents.values():
1491 if element.origin.is_writeable():
1496 def check_for_connection(listening_socket):
1497 """Check for a waiting connection and return a new user object."""
1500 # try to accept a new connection
1502 connection, address = listening_socket.accept()
1506 # note that we got one
1507 log("Connection from " + address[0], 2)
1509 # disable blocking so we can proceed whether or not we can send/receive
1510 connection.setblocking(0)
1512 # create a new user object
1515 # associate this connection with it
1516 user.connection = connection
1518 # set the user's ipa from the connection's ipa
1519 user.address = address[0]
1521 # let the client know we WILL EOR (RFC 885)
1522 telnet.enable(user, telnet.TELOPT_EOR, telnet.US)
1523 user.negotiation_pause = 2
1525 # return the new user object
1529 def get_menu(state, error=None, choices=None):
1530 """Show the correct menu text to a user."""
1532 # make sure we don't reuse a mutable sequence by default
1536 # get the description or error text
1537 message = get_menu_description(state, error)
1539 # get menu choices for the current state
1540 message += get_formatted_menu_choices(state, choices)
1542 # try to get a prompt, if it was defined
1543 message += get_menu_prompt(state)
1545 # throw in the default choice, if it exists
1546 message += get_formatted_default_menu_choice(state)
1548 # display a message indicating if echo is off
1549 message += get_echo_message(state)
1551 # return the assembly of various strings defined above
1555 def menu_echo_on(state):
1556 """True if echo is on, false if it is off."""
1557 return universe.categories["menu"][state].getboolean("echo", True)
1560 def get_echo_message(state):
1561 """Return a message indicating that echo is off."""
1562 if menu_echo_on(state):
1565 return "(won't echo) "
1568 def get_default_menu_choice(state):
1569 """Return the default choice for a menu."""
1570 return universe.categories["menu"][state].get("default")
1573 def get_formatted_default_menu_choice(state):
1574 """Default menu choice foratted for inclusion in a prompt string."""
1575 default_choice = get_default_menu_choice(state)
1577 return "[$(red)" + default_choice + "$(nrm)] "
1582 def get_menu_description(state, error):
1583 """Get the description or error text."""
1585 # an error condition was raised by the handler
1588 # try to get an error message matching the condition
1590 description = universe.categories[
1591 "menu"][state].get("error_" + error)
1593 description = "That is not a valid choice..."
1594 description = "$(red)" + description + "$(nrm)"
1596 # there was no error condition
1599 # try to get a menu description for the current state
1600 description = universe.categories["menu"][state].get("description")
1602 # return the description or error message
1604 description += "$(eol)$(eol)"
1608 def get_menu_prompt(state):
1609 """Try to get a prompt, if it was defined."""
1610 prompt = universe.categories["menu"][state].get("prompt")
1616 def get_menu_choices(user):
1617 """Return a dict of choice:meaning."""
1618 menu = universe.categories["menu"][user.state]
1619 create_choices = menu.get("create")
1621 choices = eval(create_choices)
1627 for facet in menu.facets():
1628 if facet.startswith("demand_") and not eval(
1629 universe.categories["menu"][user.state].get(facet)
1631 ignores.append(facet.split("_", 2)[1])
1632 elif facet.startswith("create_"):
1633 creates[facet] = facet.split("_", 2)[1]
1634 elif facet.startswith("choice_"):
1635 options[facet] = facet.split("_", 2)[1]
1636 for facet in creates.keys():
1637 if not creates[facet] in ignores:
1638 choices[creates[facet]] = eval(menu.get(facet))
1639 for facet in options.keys():
1640 if not options[facet] in ignores:
1641 choices[options[facet]] = menu.get(facet)
1645 def get_formatted_menu_choices(state, choices):
1646 """Returns a formatted string of menu choices."""
1648 choice_keys = choices.keys()
1650 for choice in choice_keys:
1651 choice_output += " [$(red)" + choice + "$(nrm)] " + choices[
1655 choice_output += "$(eol)"
1656 return choice_output
1659 def get_menu_branches(state):
1660 """Return a dict of choice:branch."""
1662 for facet in universe.categories["menu"][state].facets():
1663 if facet.startswith("branch_"):
1665 facet.split("_", 2)[1]
1666 ] = universe.categories["menu"][state].get(facet)
1670 def get_default_branch(state):
1671 """Return the default branch."""
1672 return universe.categories["menu"][state].get("branch")
1675 def get_choice_branch(user, choice):
1676 """Returns the new state matching the given choice."""
1677 branches = get_menu_branches(user.state)
1678 if choice in branches.keys():
1679 return branches[choice]
1680 elif choice in user.menu_choices.keys():
1681 return get_default_branch(user.state)
1686 def get_menu_actions(state):
1687 """Return a dict of choice:branch."""
1689 for facet in universe.categories["menu"][state].facets():
1690 if facet.startswith("action_"):
1692 facet.split("_", 2)[1]
1693 ] = universe.categories["menu"][state].get(facet)
1697 def get_default_action(state):
1698 """Return the default action."""
1699 return universe.categories["menu"][state].get("action")
1702 def get_choice_action(user, choice):
1703 """Run any indicated script for the given choice."""
1704 actions = get_menu_actions(user.state)
1705 if choice in actions.keys():
1706 return actions[choice]
1707 elif choice in user.menu_choices.keys():
1708 return get_default_action(user.state)
1713 def handle_user_input(user):
1714 """The main handler, branches to a state-specific handler."""
1717 # if the user's client echo is off, send a blank line for aesthetics
1718 if telnet.is_enabled(user, telnet.TELOPT_ECHO, telnet.US):
1719 user.send("", add_prompt=False, prepend_padding=False)
1721 # check to make sure the state is expected, then call that handler
1722 if "handler_" + user.state in globals():
1723 exec("handler_" + user.state + "(user)")
1725 generic_menu_handler(user)
1727 # since we got input, flag that the menu/prompt needs to be redisplayed
1728 user.menu_seen = False
1730 # update the last_input timestamp while we're at it
1731 user.last_input = universe.get_time()
1734 def generic_menu_handler(user):
1735 """A generic menu choice handler."""
1737 # get a lower-case representation of the next line of input
1738 if user.input_queue:
1739 choice = user.input_queue.pop(0)
1741 choice = choice.lower()
1745 choice = get_default_menu_choice(user.state)
1746 if choice in user.menu_choices:
1747 exec(get_choice_action(user, choice))
1748 new_state = get_choice_branch(user, choice)
1750 user.state = new_state
1752 user.error = "default"
1755 def handler_entering_account_name(user):
1756 """Handle the login account name."""
1758 # get the next waiting line of input
1759 input_data = user.input_queue.pop(0)
1761 # did the user enter anything?
1764 # keep only the first word and convert to lower-case
1765 name = input_data.lower()
1767 # fail if there are non-alphanumeric characters
1769 lambda x: x >= "0" and x <= "9" or x >= "a" and x <= "z", name
1771 user.error = "bad_name"
1773 # if that account exists, time to request a password
1774 elif name in universe.categories["account"]:
1775 user.account = universe.categories["account"][name]
1776 user.state = "checking_password"
1778 # otherwise, this could be a brand new user
1780 user.account = Element("account:" + name, universe)
1781 user.account.set("name", name)
1782 log("New user: " + name, 2)
1783 user.state = "checking_new_account_name"
1785 # if the user entered nothing for a name, then buhbye
1787 user.state = "disconnecting"
1790 def handler_checking_password(user):
1791 """Handle the login account password."""
1794 # get the next waiting line of input
1795 input_data = user.input_queue.pop(0)
1797 # does the hashed input equal the stored hash?
1798 if password.verify(input_data, user.account.get("passhash")):
1800 # if so, set the username and load from cold storage
1801 if not user.replace_old_connections():
1803 user.state = "main_utility"
1805 # if at first your hashes don't match, try, try again
1806 elif user.password_tries < universe.categories[
1813 user.password_tries += 1
1814 user.error = "incorrect"
1816 # we've exceeded the maximum number of password failures, so disconnect
1819 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1821 user.state = "disconnecting"
1824 def handler_entering_new_password(user):
1825 """Handle a new password entry."""
1828 # get the next waiting line of input
1829 input_data = user.input_queue.pop(0)
1831 # make sure the password is strong--at least one upper, one lower and
1832 # one digit, seven or more characters in length
1833 if len(input_data) > 6 and len(
1834 filter(lambda x: x >= "0" and x <= "9", input_data)
1836 filter(lambda x: x >= "A" and x <= "Z", input_data)
1838 filter(lambda x: x >= "a" and x <= "z", input_data)
1841 # hash and store it, then move on to verification
1842 user.account.set("passhash", password.create(input_data))
1843 user.state = "verifying_new_password"
1845 # the password was weak, try again if you haven't tried too many times
1846 elif user.password_tries < universe.categories[
1853 user.password_tries += 1
1856 # too many tries, so adios
1859 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1861 user.account.destroy()
1862 user.state = "disconnecting"
1865 def handler_verifying_new_password(user):
1866 """Handle the re-entered new password for verification."""
1869 # get the next waiting line of input
1870 input_data = user.input_queue.pop(0)
1872 # hash the input and match it to storage
1873 if password.verify(input_data, user.account.get("passhash")):
1876 # the hashes matched, so go active
1877 if not user.replace_old_connections():
1878 user.state = "main_utility"
1880 # go back to entering the new password as long as you haven't tried
1882 elif user.password_tries < universe.categories[
1889 user.password_tries += 1
1890 user.error = "differs"
1891 user.state = "entering_new_password"
1893 # otherwise, sayonara
1896 "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1898 user.account.destroy()
1899 user.state = "disconnecting"
1902 def handler_active(user):
1903 """Handle input for active users."""
1905 # get the next waiting line of input
1906 input_data = user.input_queue.pop(0)
1911 # split out the command and parameters
1913 mode = actor.get("mode")
1914 if mode and input_data.startswith("!"):
1915 command_name, parameters = first_word(input_data[1:])
1916 elif mode == "chat":
1917 command_name = "say"
1918 parameters = input_data
1920 command_name, parameters = first_word(input_data)
1922 # lowercase the command
1923 command_name = command_name.lower()
1925 # the command matches a command word for which we have data
1926 if command_name in universe.categories["command"]:
1927 command = universe.categories["command"][command_name]
1931 # if it's allowed, do it
1932 if actor.can_run(command):
1933 exec(command.get("action"))
1935 # otherwise, give an error
1937 command_error(actor, input_data)
1939 # if no input, just idle back with a prompt
1941 user.send("", just_prompt=True)
1944 def command_halt(actor, parameters):
1945 """Halt the world."""
1948 # see if there's a message or use a generic one
1950 message = "Halting: " + parameters
1952 message = "User " + actor.owner.account.get(
1954 ) + " halted the world."
1957 broadcast(message, add_prompt=False)
1960 # set a flag to terminate the world
1961 universe.terminate_flag = True
1964 def command_reload(actor):
1965 """Reload all code modules, configs and data."""
1968 # let the user know and log
1969 actor.send("Reloading all code modules, configs and data.")
1972 actor.owner.account.get("name") + " reloaded the world.",
1976 # set a flag to reload
1977 universe.reload_flag = True
1980 def command_quit(actor):
1981 """Leave the world and go back to the main menu."""
1983 actor.owner.state = "main_utility"
1984 actor.owner.deactivate_avatar()
1987 def command_help(actor, parameters):
1988 """List available commands and provide help for commands."""
1990 # did the user ask for help on a specific command word?
1991 if parameters and actor.owner:
1993 # is the command word one for which we have data?
1994 if parameters in universe.categories["command"]:
1995 command = universe.categories["command"][parameters]
1999 # only for allowed commands
2000 if actor.can_run(command):
2002 # add a description if provided
2003 description = command.get("description")
2005 description = "(no short description provided)"
2006 if command.getboolean("administrative"):
2010 output += parameters + "$(nrm) - " + description + "$(eol)$(eol)"
2012 # add the help text if provided
2013 help_text = command.get("help")
2015 help_text = "No help is provided for this command."
2018 # list related commands
2019 see_also = command.getlist("see_also")
2021 really_see_also = ""
2022 for item in see_also:
2023 if item in universe.categories["command"]:
2024 command = universe.categories["command"][item]
2025 if actor.can_run(command):
2027 really_see_also += ", "
2028 if command.getboolean("administrative"):
2029 really_see_also += "$(red)"
2031 really_see_also += "$(grn)"
2032 really_see_also += item + "$(nrm)"
2034 output += "$(eol)$(eol)See also: " + really_see_also
2036 # no data for the requested command word
2038 output = "That is not an available command."
2040 # no specific command word was indicated
2043 # give a sorted list of commands with descriptions if provided
2044 output = "These are the commands available to you:$(eol)$(eol)"
2045 sorted_commands = universe.categories["command"].keys()
2046 sorted_commands.sort()
2047 for item in sorted_commands:
2048 command = universe.categories["command"][item]
2049 if actor.can_run(command):
2050 description = command.get("description")
2052 description = "(no short description provided)"
2053 if command.getboolean("administrative"):
2057 output += item + "$(nrm) - " + description + "$(eol)"
2058 output += "$(eol)Enter \"help COMMAND\" for help on a command " \
2059 + "named \"COMMAND\"."
2061 # send the accumulated output to the user
2065 def command_move(actor, parameters):
2066 """Move the avatar in a given direction."""
2067 if parameters in universe.contents[actor.get("location")].portals():
2068 actor.move_direction(parameters)
2070 actor.send("You cannot go that way.")
2073 def command_look(actor, parameters):
2076 actor.send("You can't look at or in anything yet.")
2078 actor.look_at(actor.get("location"))
2081 def command_say(actor, parameters):
2082 """Speak to others in the same room."""
2085 # check for replacement macros and escape them
2086 parameters = escape_macros(parameters)
2088 # if the message is wrapped in quotes, remove them and leave contents
2090 if parameters.startswith("\"") and parameters.endswith("\""):
2091 message = parameters[1:-1]
2094 # otherwise, get rid of stray quote marks on the ends of the message
2096 message = parameters.strip("\"'`")
2099 # the user entered a message
2102 # match the punctuation used, if any, to an action
2103 actions = universe.categories["internal"]["language"].getdict(
2106 default_punctuation = (
2107 universe.categories["internal"]["language"].get(
2108 "default_punctuation"))
2110 for mark in actions.keys():
2111 if not literal and message.endswith(mark):
2112 action = actions[mark]
2115 # add punctuation if needed
2117 action = actions[default_punctuation]
2118 if message and not (
2119 literal or unicodedata.category(message[-1]) == "Po"
2121 message += default_punctuation
2123 # failsafe checks to avoid unwanted reformatting and null strings
2124 if message and not literal:
2126 # decapitalize the first letter to improve matching
2127 message = message[0].lower() + message[1:]
2129 # iterate over all words in message, replacing typos
2130 typos = universe.categories["internal"]["language"].getdict(
2133 words = message.split()
2134 for index in range(len(words)):
2136 while unicodedata.category(word[0]) == "Po":
2138 while unicodedata.category(word[-1]) == "Po":
2140 if word in typos.keys():
2141 words[index] = words[index].replace(word, typos[word])
2142 message = " ".join(words)
2144 # capitalize the first letter
2145 message = message[0].upper() + message[1:]
2149 actor.echo_to_location(
2150 actor.get("name") + " " + action + "s, \"" + message + "\""
2152 actor.send("You " + action + ", \"" + message + "\"")
2154 # there was no message
2156 actor.send("What do you want to say?")
2159 def command_chat(actor):
2160 """Toggle chat mode."""
2161 mode = actor.get("mode")
2163 actor.set("mode", "chat")
2164 actor.send("Entering chat mode (use $(grn)!chat$(nrm) to exit).")
2165 elif mode == "chat":
2166 actor.remove_facet("mode")
2167 actor.send("Exiting chat mode.")
2169 actor.send("Sorry, but you're already busy with something else!")
2172 def command_show(actor, parameters):
2173 """Show program data."""
2176 arguments = parameters.split()
2178 message = "What do you want to show?"
2179 elif arguments[0] == "time":
2180 message = universe.categories["internal"]["counters"].get(
2182 ) + " increments elapsed since the world was created."
2183 elif arguments[0] == "categories":
2184 message = "These are the element categories:$(eol)"
2185 categories = universe.categories.keys()
2187 for category in categories:
2188 message += "$(eol) $(grn)" + category + "$(nrm)"
2189 elif arguments[0] == "files":
2190 message = "These are the current files containing the universe:$(eol)"
2191 filenames = universe.files.keys()
2193 for filename in filenames:
2194 if universe.files[filename].is_writeable():
2198 message += "$(eol) $(red)(" + status + ") $(grn)" + filename \
2200 elif arguments[0] == "category":
2201 if len(arguments) != 2:
2202 message = "You must specify one category."
2203 elif arguments[1] in universe.categories:
2204 message = "These are the elements in the \"" + arguments[1] \
2205 + "\" category:$(eol)"
2208 universe.categories[arguments[1]][x].key
2209 ) for x in universe.categories[arguments[1]].keys()
2212 for element in elements:
2213 message += "$(eol) $(grn)" + element + "$(nrm)"
2215 message = "Category \"" + arguments[1] + "\" does not exist."
2216 elif arguments[0] == "file":
2217 if len(arguments) != 2:
2218 message = "You must specify one file."
2219 elif arguments[1] in universe.files:
2220 message = "These are the elements in the \"" + arguments[1] \
2222 elements = universe.files[arguments[1]].data.sections()
2224 for element in elements:
2225 message += "$(eol) $(grn)" + element + "$(nrm)"
2227 message = "Category \"" + arguments[1] + "\" does not exist."
2228 elif arguments[0] == "element":
2229 if len(arguments) != 2:
2230 message = "You must specify one element."
2231 elif arguments[1] in universe.contents:
2232 element = universe.contents[arguments[1]]
2233 message = "These are the properties of the \"" + arguments[1] \
2235 "\" element (in \"" + \
2236 element.origin.filename + "\"):$(eol)"
2237 facets = element.facets()
2239 for facet in facets:
2240 message += "$(eol) $(grn)" + facet + ": $(red)" \
2241 + escape_macros(element.get(facet)) + "$(nrm)"
2243 message = "Element \"" + arguments[1] + "\" does not exist."
2244 elif arguments[0] == "result":
2245 if len(arguments) < 2:
2246 message = "You need to specify an expression."
2249 message = repr(eval(" ".join(arguments[1:])))
2251 message = "Your expression raised an exception!"
2252 elif arguments[0] == "log":
2253 if len(arguments) == 4:
2254 if re.match("^\d+$", arguments[3]) and int(arguments[3]) >= 0:
2255 stop = int(arguments[3])
2260 if len(arguments) >= 3:
2261 if re.match("^\d+$", arguments[2]) and int(arguments[2]) > 0:
2262 start = int(arguments[2])
2267 if len(arguments) >= 2:
2268 if (re.match("^\d+$", arguments[1])
2269 and 0 <= int(arguments[1]) <= 9):
2270 level = int(arguments[1])
2273 elif 0 <= actor.owner.account.getint("loglevel") <= 9:
2274 level = actor.owner.account.getint("loglevel")
2277 if level > -1 and start > -1 and stop > -1:
2278 message = get_loglines(level, start, stop)
2280 message = "When specified, level must be 0-9 (default 1), " \
2281 + "start and stop must be >=1 (default 10 and 1)."
2283 message = "I don't know what \"" + parameters + "\" is."
2287 def command_create(actor, parameters):
2288 """Create an element if it does not exist."""
2290 message = "You must at least specify an element to create."
2291 elif not actor.owner:
2294 arguments = parameters.split()
2295 if len(arguments) == 1:
2296 arguments.append("")
2297 if len(arguments) == 2:
2298 element, filename = arguments
2299 if element in universe.contents:
2300 message = "The \"" + element + "\" element already exists."
2302 message = "You create \"" + \
2303 element + "\" within the universe."
2304 logline = actor.owner.account.get(
2306 ) + " created an element: " + element
2308 logline += " in file " + filename
2309 if filename not in universe.files:
2310 message += " Warning: \"" + filename \
2311 + "\" is not yet included in any other file and will " \
2313 "not be read on startup unless this is remedied."
2314 Element(element, universe, filename)
2316 elif len(arguments) > 2:
2317 message = "You can only specify an element and a filename."
2321 def command_destroy(actor, parameters):
2322 """Destroy an element if it exists."""
2325 message = "You must specify an element to destroy."
2327 if parameters not in universe.contents:
2328 message = "The \"" + parameters + \
2329 "\" element does not exist."
2331 universe.contents[parameters].destroy()
2332 message = "You destroy \"" + parameters \
2333 + "\" within the universe."
2335 actor.owner.account.get(
2337 ) + " destroyed an element: " + parameters,
2343 def command_set(actor, parameters):
2344 """Set a facet of an element."""
2346 message = "You must specify an element, a facet and a value."
2348 arguments = parameters.split(" ", 2)
2349 if len(arguments) == 1:
2350 message = "What facet of element \"" + arguments[0] \
2351 + "\" would you like to set?"
2352 elif len(arguments) == 2:
2353 message = "What value would you like to set for the \"" \
2354 + arguments[1] + "\" facet of the \"" + arguments[0] \
2357 element, facet, value = arguments
2358 if element not in universe.contents:
2359 message = "The \"" + element + "\" element does not exist."
2361 universe.contents[element].set(facet, value)
2362 message = "You have successfully (re)set the \"" + facet \
2363 + "\" facet of element \"" + element \
2364 + "\". Try \"show element " + \
2365 element + "\" for verification."
2369 def command_delete(actor, parameters):
2370 """Delete a facet from an element."""
2372 message = "You must specify an element and a facet."
2374 arguments = parameters.split(" ")
2375 if len(arguments) == 1:
2376 message = "What facet of element \"" + arguments[0] \
2377 + "\" would you like to delete?"
2378 elif len(arguments) != 2:
2379 message = "You may only specify an element and a facet."
2381 element, facet = arguments
2382 if element not in universe.contents:
2383 message = "The \"" + element + "\" element does not exist."
2384 elif facet not in universe.contents[element].facets():
2385 message = "The \"" + element + "\" element has no \"" + facet \
2388 universe.contents[element].remove_facet(facet)
2389 message = "You have successfully deleted the \"" + facet \
2390 + "\" facet of element \"" + element \
2391 + "\". Try \"show element " + \
2392 element + "\" for verification."
2396 def command_error(actor, input_data):
2397 """Generic error for an unrecognized command word."""
2400 # 90% of the time use a generic error
2401 if random.randrange(10):
2402 message = "I'm not sure what \"" + input_data + "\" means..."
2404 # 10% of the time use the classic diku error
2406 message = "Arglebargle, glop-glyf!?!"
2408 # send the error message
2412 def daemonize(universe):
2413 """Fork and disassociate from everything."""
2421 # only if this is what we're configured to do
2422 if universe.contents["internal:process"].getboolean("daemon"):
2424 # if possible, we want to rename the process to the same as the script
2425 # (these will need to be byte type during 2to3 migration)
2426 new_argv = "\0".join(sys.argv) + "\0"
2427 new_short_argv0 = os.path.basename(sys.argv[0]) + "\0"
2429 # attempt the linux way first
2431 argv_array = ctypes.POINTER(ctypes.c_char_p)
2432 ctypes.pythonapi.Py_GetArgcArgv.argtypes = (
2433 ctypes.POINTER(ctypes.c_int),
2434 ctypes.POINTER(argv_array)
2437 ctypes.pythonapi.Py_GetArgcArgv(
2439 ctypes.pointer(argc)
2441 old_argv0_size = len(argc.contents.value)
2442 ctypes.memset(argc.contents, 0, len(new_argv) + old_argv0_size)
2443 ctypes.memmove(argc.contents, new_argv, len(new_argv))
2444 ctypes.CDLL(ctypes.util.find_library("c")).prctl(
2454 # since that failed, maybe it's bsd?
2457 # much simpler, since bsd has a libc function call for this
2458 ctypes.CDLL(ctypes.util.find_library("c")).setproctitle(
2464 # that didn't work either, so just log that we couldn't
2465 log("Failed to rename the interpreter process (cosmetic).")
2467 # log before we start forking around, so the terminal gets the message
2468 log("Disassociating from the controlling terminal.")
2470 # fork off and die, so we free up the controlling terminal
2474 # switch to a new process group
2477 # fork some more, this time to free us from the old process group
2481 # reset the working directory so we don't needlessly tie up mounts
2484 # clear the file creation mask so we can bend it to our will later
2487 # redirect stdin/stdout/stderr and close off their former descriptors
2488 for stdpipe in range(3):
2490 sys.stdin = codecs.open("/dev/null", "r", "utf-8")
2491 sys.__stdin__ = codecs.open("/dev/null", "r", "utf-8")
2492 sys.stdout = codecs.open("/dev/null", "w", "utf-8")
2493 sys.stderr = codecs.open("/dev/null", "w", "utf-8")
2494 sys.__stdout__ = codecs.open("/dev/null", "w", "utf-8")
2495 sys.__stderr__ = codecs.open("/dev/null", "w", "utf-8")
2498 def create_pidfile(universe):
2499 """Write a file containing the current process ID."""
2503 pid = str(os.getpid())
2504 log("Process ID: " + pid)
2505 file_name = universe.contents["internal:process"].get("pidfile")
2507 if not os.path.isabs(file_name):
2508 file_name = os.path.join(universe.startdir, file_name)
2509 file_descriptor = codecs.open(file_name, "w", "utf-8")
2510 file_descriptor.write(pid + "\n")
2511 file_descriptor.flush()
2512 file_descriptor.close()
2515 def remove_pidfile(universe):
2516 """Remove the file containing the current process ID."""
2519 file_name = universe.contents["internal:process"].get("pidfile")
2521 if not os.path.isabs(file_name):
2522 file_name = os.path.join(universe.startdir, file_name)
2523 if os.access(file_name, os.W_OK):
2524 os.remove(file_name)
2527 def excepthook(excepttype, value, tracebackdata):
2528 """Handle uncaught exceptions."""
2531 # assemble the list of errors into a single string
2533 traceback.format_exception(excepttype, value, tracebackdata)
2536 # try to log it, if possible
2542 # try to write it to stderr, if possible
2544 sys.stderr.write(message)
2549 def sighook(what, where):
2550 """Handle external signals."""
2554 message = "Caught signal: "
2556 # for a hangup signal
2557 if what == signal.SIGHUP:
2558 message += "hangup (reloading)"
2559 universe.reload_flag = True
2561 # for a terminate signal
2562 elif what == signal.SIGTERM:
2563 message += "terminate (halting)"
2564 universe.terminate_flag = True
2566 # catchall for unexpected signals
2568 message += str(what) + " (unhandled)"
2574 def override_excepthook():
2575 """Redefine sys.excepthook with our own."""
2577 sys.excepthook = excepthook
2580 def assign_sighook():
2581 """Assign a customized handler for some signals."""
2583 signal.signal(signal.SIGHUP, sighook)
2584 signal.signal(signal.SIGTERM, sighook)
2588 """This contains functions to be performed when starting the engine."""
2591 # see if a configuration file was specified
2592 if len(sys.argv) > 1:
2593 conffile = sys.argv[1]
2599 universe = Universe(conffile, True)
2601 # log an initial message
2602 log("Started mudpy with command line: " + " ".join(sys.argv))
2604 # fork and disassociate
2607 # override the default exception handler so we get logging first thing
2608 override_excepthook()
2610 # set up custom signal handlers
2614 create_pidfile(universe)
2616 # pass the initialized universe back
2621 """This contains functions to be performed when shutting down the
2624 # the loop has terminated, so save persistent data
2627 # log a final message
2628 log("Shutting down now.")
2630 # get rid of the pidfile
2631 remove_pidfile(universe)