mudpy/misc.py

   1 """Miscellaneous functions for the mudpy engine."""
   2
   3 # Copyright (c) 2004-2020 mudpy authors. Permission to use, copy,
   4 # modify, and distribute this software is granted under terms
   5 # provided in the LICENSE file distributed with this software.
   6
   7 import codecs
   8 import datetime
   9 import os
  10 import random
  11 import re
  12 import signal
  13 import socket
  14 import sys
  15 import syslog
  16 import time
  17 import traceback
  18 import unicodedata
  19
  20 import mudpy
  21
  22
  23 class Element:
  24
  25     """An element of the universe."""
  26
  27     def __init__(self, key, universe, origin=None):
  28         """Set up a new element."""
  29
  30         # keep track of our key name
  31         self.key = key
  32
  33         # keep track of what universe it's loading into
  34         self.universe = universe
  35
  36         # set of facet keys from the universe
  37         self.facethash = dict()
  38
  39         # not owned by a user by default (used for avatars)
  40         self.owner = None
  41
  42         # no contents in here by default
  43         self.contents = {}
  44
  45         if self.key.find(".") > 0:
  46             self.group, self.subkey = self.key.split(".")[-2:]
  47         else:
  48             self.group = "other"
  49             self.subkey = self.key
  50         if self.group not in self.universe.groups:
  51             self.universe.groups[self.group] = {}
  52
  53         # get an appropriate origin
  54         if not origin:
  55             self.universe.add_group(self.group)
  56             origin = self.universe.files[
  57                     self.universe.origins[self.group]["fallback"]]
  58
  59         # record or reset a pointer to the origin file
  60         self.origin = self.universe.files[origin.source]
  61
  62         # add or replace this element in the universe
  63         self.universe.contents[self.key] = self
  64         self.universe.groups[self.group][self.subkey] = self
  65
  66     def reload(self):
  67         """Create a new element and replace this one."""
  68         args = (self.key, self.universe, self.origin)
  69         self.destroy()
  70         Element(*args)
  71
  72     def destroy(self):
  73         """Remove an element from the universe and destroy it."""
  74         for facet in dict(self.facethash):
  75             self.remove_facet(facet)
  76         del self.universe.groups[self.group][self.subkey]
  77         del self.universe.contents[self.key]
  78         del self
  79
  80     def facets(self):
  81         """Return a list of non-inherited facets for this element."""
  82         return self.facethash
  83
  84     def has_facet(self, facet):
  85         """Return whether the non-inherited facet exists."""
  86         return facet in self.facets()
  87
  88     def remove_facet(self, facet):
  89         """Remove a facet from the element."""
  90         if ".".join((self.key, facet)) in self.origin.data:
  91             del self.origin.data[".".join((self.key, facet))]
  92         if facet in self.facethash:
  93             del self.facethash[facet]
  94         self.origin.modified = True
  95
  96     def ancestry(self):
  97         """Return a list of the element's inheritance lineage."""
  98         if self.has_facet("inherit"):
  99             ancestry = self.get("inherit")
 100             if not ancestry:
 101                 ancestry = []
 102             for parent in ancestry[:]:
 103                 ancestors = self.universe.contents[parent].ancestry()
 104                 for ancestor in ancestors:
 105                     if ancestor not in ancestry:
 106                         ancestry.append(ancestor)
 107             return ancestry
 108         else:
 109             return []
 110
 111     def get(self, facet, default=None):
 112         """Retrieve values."""
 113         if default is None:
 114             default = ""
 115         try:
 116             return self.origin.data[".".join((self.key, facet))]
 117         except (KeyError, TypeError):
 118             pass
 119         if self.has_facet("inherit"):
 120             for ancestor in self.ancestry():
 121                 if self.universe.contents[ancestor].has_facet(facet):
 122                     return self.universe.contents[ancestor].get(facet)
 123         else:
 124             return default
 125
 126     def set(self, facet, value):
 127         """Set values."""
 128         if not self.origin.is_writeable() and not self.universe.loading:
 129             # break if there is an attempt to update an element from a
 130             # read-only file, unless the universe is in the midst of loading
 131             # updated data from files
 132             raise PermissionError("Altering elements in read-only files is "
 133                                   "disallowed")
 134         # Coerce some values to appropriate data types
 135         # TODO(fungi) Move these to a separate validation mechanism
 136         if facet in ["loglevel"]:
 137             value = int(value)
 138         elif facet in ["administrator"]:
 139             value = bool(value)
 140
 141         # The canonical node for this facet within its origin
 142         node = ".".join((self.key, facet))
 143
 144         if node not in self.origin.data or self.origin.data[node] != value:
 145             # Be careful to only update the origin's contents when required,
 146             # since that affects whether the backing file gets written
 147             self.origin.data[node] = value
 148             self.origin.modified = True
 149
 150         # Make sure this facet is included in the element's facets
 151         self.facethash[facet] = self.origin.data[node]
 152
 153     def append(self, facet, value):
 154         """Append value to a list."""
 155         newlist = self.get(facet)
 156         if not newlist:
 157             newlist = []
 158         if type(newlist) is not list:
 159             newlist = list(newlist)
 160         newlist.append(value)
 161         self.set(facet, newlist)
 162
 163     def send(
 164         self,
 165         message,
 166         eol="$(eol)",
 167         raw=False,
 168         flush=False,
 169         add_prompt=True,
 170         just_prompt=False,
 171         add_terminator=False,
 172         prepend_padding=True
 173     ):
 174         """Convenience method to pass messages to an owner."""
 175         if self.owner:
 176             self.owner.send(
 177                 message,
 178                 eol,
 179                 raw,
 180                 flush,
 181                 add_prompt,
 182                 just_prompt,
 183                 add_terminator,
 184                 prepend_padding
 185             )
 186
 187     def can_run(self, command):
 188         """Check if the user can run this command object."""
 189
 190         # has to be in the commands group
 191         if command not in self.universe.groups["command"].values():
 192             result = False
 193
 194         # avatars of administrators can run any command
 195         elif self.owner and self.owner.account.get("administrator"):
 196             result = True
 197
 198         # everyone can run non-administrative commands
 199         elif not command.get("administrative"):
 200             result = True
 201
 202         # otherwise the command cannot be run by this actor
 203         else:
 204             result = False
 205
 206         # pass back the result
 207         return result
 208
 209     def update_location(self):
 210         """Make sure the location's contents contain this element."""
 211         area = self.get("location")
 212         if area in self.universe.contents:
 213             self.universe.contents[area].contents[self.key] = self
 214
 215     def clean_contents(self):
 216         """Make sure the element's contents aren't bogus."""
 217         for element in self.contents.values():
 218             if element.get("location") != self.key:
 219                 del self.contents[element.key]
 220
 221     def go_to(self, area):
 222         """Relocate the element to a specific area."""
 223         current = self.get("location")
 224         if current and self.key in self.universe.contents[current].contents:
 225             del universe.contents[current].contents[self.key]
 226         if area in self.universe.contents:
 227             self.set("location", area)
 228         self.universe.contents[area].contents[self.key] = self
 229         self.look_at(area)
 230
 231     def go_home(self):
 232         """Relocate the element to its default location."""
 233         self.go_to(self.get("default_location"))
 234         self.echo_to_location(
 235             "You suddenly realize that " + self.get("name") + " is here."
 236         )
 237
 238     def move_direction(self, direction):
 239         """Relocate the element in a specified direction."""
 240         motion = self.universe.contents["mudpy.movement.%s" % direction]
 241         enter_term = motion.get("enter_term")
 242         exit_term = motion.get("exit_term")
 243         self.echo_to_location("%s exits %s." % (self.get("name"), exit_term))
 244         self.send("You exit %s." % exit_term, add_prompt=False)
 245         self.go_to(
 246             self.universe.contents[
 247                 self.get("location")].link_neighbor(direction)
 248         )
 249         self.echo_to_location("%s arrives from %s." % (
 250             self.get("name"), enter_term))
 251
 252     def look_at(self, key):
 253         """Show an element to another element."""
 254         if self.owner:
 255             element = self.universe.contents[key]
 256             message = ""
 257             name = element.get("name")
 258             if name:
 259                 message += "$(cyn)" + name + "$(nrm)$(eol)"
 260             description = element.get("description")
 261             if description:
 262                 message += description + "$(eol)"
 263             portal_list = list(element.portals().keys())
 264             if portal_list:
 265                 portal_list.sort()
 266                 message += "$(cyn)[ Exits: " + ", ".join(
 267                     portal_list
 268                 ) + " ]$(nrm)$(eol)"
 269             for element in self.universe.contents[
 270                 self.get("location")
 271             ].contents.values():
 272                 if element.get("is_actor") and element is not self:
 273                     message += "$(yel)" + element.get(
 274                         "name"
 275                     ) + " is here.$(nrm)$(eol)"
 276                 elif element is not self:
 277                     message += "$(grn)" + element.get(
 278                         "impression"
 279                     ) + "$(nrm)$(eol)"
 280             self.send(message)
 281
 282     def portals(self):
 283         """Map the portal directions for an area to neighbors."""
 284         portals = {}
 285         if re.match(r"""^area\.-?\d+,-?\d+,-?\d+$""", self.key):
 286             coordinates = [(int(x))
 287                            for x in self.key.split(".")[-1].split(",")]
 288             offsets = dict(
 289                 (x,
 290                  self.universe.contents["mudpy.movement.%s" % x].get("vector")
 291                  ) for x in self.universe.directions)
 292             for portal in self.get("gridlinks"):
 293                 adjacent = map(lambda c, o: c + o,
 294                                coordinates, offsets[portal])
 295                 neighbor = "area." + ",".join(
 296                     [(str(x)) for x in adjacent]
 297                 )
 298                 if neighbor in self.universe.contents:
 299                     portals[portal] = neighbor
 300         for facet in self.facets():
 301             if facet.startswith("link_"):
 302                 neighbor = self.get(facet)
 303                 if neighbor in self.universe.contents:
 304                     portal = facet.split("_")[1]
 305                     portals[portal] = neighbor
 306         return portals
 307
 308     def link_neighbor(self, direction):
 309         """Return the element linked in a given direction."""
 310         portals = self.portals()
 311         if direction in portals:
 312             return portals[direction]
 313
 314     def echo_to_location(self, message):
 315         """Show a message to other elements in the current location."""
 316         for element in self.universe.contents[
 317             self.get("location")
 318         ].contents.values():
 319             if element is not self:
 320                 element.send(message)
 321
 322
 323 class Universe:
 324
 325     """The universe."""
 326
 327     def __init__(self, filename="", load=False):
 328         """Initialize the universe."""
 329         self.groups = {}
 330         self.contents = {}
 331         self.directions = set()
 332         self.loading = False
 333         self.loglines = []
 334         self.origins = {}
 335         self.reload_flag = False
 336         self.setup_loglines = []
 337         self.startdir = os.getcwd()
 338         self.terminate_flag = False
 339         self.userlist = []
 340         self.versions = None
 341         if not filename:
 342             possible_filenames = [
 343                 "etc/mudpy.yaml",
 344                 "/usr/local/mudpy/etc/mudpy.yaml",
 345                 "/usr/local/etc/mudpy.yaml",
 346                 "/etc/mudpy/mudpy.yaml",
 347                 "/etc/mudpy.yaml"
 348             ]
 349             for filename in possible_filenames:
 350                 if os.access(filename, os.R_OK):
 351                     break
 352         if not os.path.isabs(filename):
 353             filename = os.path.join(self.startdir, filename)
 354         self.filename = filename
 355         if load:
 356             # make sure to preserve any accumulated log entries during load
 357             self.setup_loglines += self.load()
 358
 359     def load(self):
 360         """Load universe data from persistent storage."""
 361
 362         # while loading, it's safe to update elements from read-only files
 363         self.loading = True
 364
 365         # it's possible for this to enter before logging configuration is read
 366         pending_loglines = []
 367
 368         # start populating the (re)files dict from the base config
 369         self.files = {}
 370         mudpy.data.Data(self.filename, self)
 371
 372         # load default storage locations for groups
 373         if hasattr(self, "contents") and "mudpy.filing" in self.contents:
 374             self.origins.update(self.contents["mudpy.filing"].get(
 375                 "groups", {}))
 376
 377         # add some builtin groups we know we'll need
 378         for group in ("account", "actor", "internal"):
 379             self.add_group(group)
 380
 381         # make a list of inactive avatars
 382         inactive_avatars = []
 383         for account in self.groups.get("account", {}).values():
 384             for avatar in account.get("avatars"):
 385                 try:
 386                     inactive_avatars.append(self.contents[avatar])
 387                 except KeyError:
 388                     pending_loglines.append((
 389                         'Missing avatar "%s", possible data corruption' %
 390                         avatar, 6))
 391         for user in self.userlist:
 392             if user.avatar in inactive_avatars:
 393                 inactive_avatars.remove(user.avatar)
 394
 395         # another pass to straighten out all the element contents
 396         for element in self.contents.values():
 397             element.update_location()
 398             element.clean_contents()
 399
 400         # done loading, so disallow updating elements from read-only files
 401         self.loading = False
 402
 403         return pending_loglines
 404
 405     def new(self):
 406         """Create a new, empty Universe (the Big Bang)."""
 407         new_universe = Universe()
 408         for attribute in vars(self).keys():
 409             setattr(new_universe, attribute, getattr(self, attribute))
 410         new_universe.reload_flag = False
 411         del self
 412         return new_universe
 413
 414     def save(self):
 415         """Save the universe to persistent storage."""
 416         for key in self.files:
 417             self.files[key].save()
 418
 419     def initialize_server_socket(self):
 420         """Create and open the listening socket."""
 421
 422         # need to know the local address and port number for the listener
 423         host = self.contents["mudpy.network"].get("host")
 424         port = self.contents["mudpy.network"].get("port")
 425
 426         # if no host was specified, bind to all local addresses (preferring
 427         # ipv6)
 428         if not host:
 429             if socket.has_ipv6:
 430                 host = "::"
 431             else:
 432                 host = "0.0.0.0"
 433
 434         # figure out if this is ipv4 or v6
 435         family = socket.getaddrinfo(host, port)[0][0]
 436         if family is socket.AF_INET6 and not socket.has_ipv6:
 437             log("No support for IPv6 address %s (use IPv4 instead)." % host)
 438
 439         # create a new stream-type socket object
 440         self.listening_socket = socket.socket(family, socket.SOCK_STREAM)
 441
 442         # set the socket options to allow existing open ones to be
 443         # reused (fixes a bug where the server can't bind for a minute
 444         # when restarting on linux systems)
 445         self.listening_socket.setsockopt(
 446             socket.SOL_SOCKET, socket.SO_REUSEADDR, 1
 447         )
 448
 449         # bind the socket to to our desired server ipa and port
 450         self.listening_socket.bind((host, port))
 451
 452         # disable blocking so we can proceed whether or not we can
 453         # send/receive
 454         self.listening_socket.setblocking(0)
 455
 456         # start listening on the socket
 457         self.listening_socket.listen(1)
 458
 459         # note that we're now ready for user connections
 460         log("Listening for Telnet connections on %s port %s" % (
 461                 host, str(port)))
 462
 463     def get_time(self):
 464         """Convenience method to get the elapsed time counter."""
 465         return self.groups["internal"]["counters"].get("elapsed")
 466
 467     def add_group(self, group, fallback=None):
 468         """Set up group tracking/metadata."""
 469         if group not in self.origins:
 470             self.origins[group] = {}
 471         if not fallback:
 472             fallback = mudpy.data.find_file(
 473                     ".".join((group, "yaml")), universe=self)
 474         if "fallback" not in self.origins[group]:
 475             self.origins[group]["fallback"] = fallback
 476         flags = self.origins[group].get("flags", None)
 477         if fallback not in self.files:
 478             mudpy.data.Data(fallback, self, flags=flags)
 479
 480
 481 class User:
 482
 483     """This is a connected user."""
 484
 485     def __init__(self):
 486         """Default values for the in-memory user variables."""
 487         self.account = None
 488         self.address = ""
 489         self.authenticated = False
 490         self.avatar = None
 491         self.choice = ""
 492         self.columns = 79
 493         self.connection = None
 494         self.error = ""
 495         self.input_queue = []
 496         self.last_address = ""
 497         self.last_input = universe.get_time()
 498         self.menu_choices = {}
 499         self.menu_seen = False
 500         self.negotiation_pause = 0
 501         self.output_queue = []
 502         self.partial_input = b""
 503         self.password_tries = 0
 504         self.rows = 23
 505         self.state = "telopt_negotiation"
 506         self.telopts = {}
 507         self.ttype = None
 508         self.universe = universe
 509
 510     def quit(self):
 511         """Log, close the connection and remove."""
 512         if self.account:
 513             name = self.account.get("name", self)
 514         else:
 515             name = self
 516         log("Logging out %s" % name, 2)
 517         self.deactivate_avatar()
 518         self.connection.close()
 519         self.remove()
 520
 521     def check_idle(self):
 522         """Warn or disconnect idle users as appropriate."""
 523         idletime = universe.get_time() - self.last_input
 524         linkdead_dict = universe.contents[
 525             "mudpy.timing.idle.disconnect"].facets()
 526         if self.state in linkdead_dict:
 527             linkdead_state = self.state
 528         else:
 529             linkdead_state = "default"
 530         if idletime > linkdead_dict[linkdead_state]:
 531             self.send(
 532                 "$(eol)$(red)You've done nothing for far too long... goodbye!"
 533                 + "$(nrm)$(eol)",
 534                 flush=True,
 535                 add_prompt=False
 536             )
 537             logline = "Disconnecting "
 538             if self.account and self.account.get("name"):
 539                 logline += self.account.get("name")
 540             else:
 541                 logline += "an unknown user"
 542             logline += (" after idling too long in the " + self.state
 543                         + " state.")
 544             log(logline, 2)
 545             self.state = "disconnecting"
 546             self.menu_seen = False
 547         idle_dict = universe.contents["mudpy.timing.idle.warn"].facets()
 548         if self.state in idle_dict:
 549             idle_state = self.state
 550         else:
 551             idle_state = "default"
 552         if idletime == idle_dict[idle_state]:
 553             self.send(
 554                 "$(eol)$(red)If you continue to be unproductive, "
 555                 + "you'll be shown the door...$(nrm)$(eol)"
 556             )
 557
 558     def reload(self):
 559         """Save, load a new user and relocate the connection."""
 560
 561         # copy old attributes
 562         attributes = self.__dict__
 563
 564         # get out of the list
 565         self.remove()
 566
 567         # get rid of the old user object
 568         del(self)
 569
 570         # create a new user object
 571         new_user = User()
 572
 573         # set everything equivalent
 574         new_user.__dict__ = attributes
 575
 576         # the avatar needs a new owner
 577         if new_user.avatar:
 578             new_user.account = universe.contents[new_user.account.key]
 579             new_user.avatar = universe.contents[new_user.avatar.key]
 580             new_user.avatar.owner = new_user
 581
 582         # add it to the list
 583         universe.userlist.append(new_user)
 584
 585     def replace_old_connections(self):
 586         """Disconnect active users with the same name."""
 587
 588         # the default return value
 589         return_value = False
 590
 591         # iterate over each user in the list
 592         for old_user in universe.userlist:
 593
 594             # the name is the same but it's not us
 595             if hasattr(
 596                old_user, "account"
 597                ) and old_user.account and old_user.account.get(
 598                 "name"
 599             ) == self.account.get(
 600                 "name"
 601             ) and old_user is not self:
 602
 603                 # make a note of it
 604                 log(
 605                     "User " + self.account.get(
 606                         "name"
 607                     ) + " reconnected--closing old connection to "
 608                     + old_user.address + ".",
 609                     2
 610                 )
 611                 old_user.send(
 612                     "$(eol)$(red)New connection from " + self.address
 613                     + ". Terminating old connection...$(nrm)$(eol)",
 614                     flush=True,
 615                     add_prompt=False
 616                 )
 617
 618                 # close the old connection
 619                 old_user.connection.close()
 620
 621                 # replace the old connection with this one
 622                 old_user.send(
 623                     "$(eol)$(red)Taking over old connection from "
 624                     + old_user.address + ".$(nrm)"
 625                 )
 626                 old_user.connection = self.connection
 627                 old_user.last_address = old_user.address
 628                 old_user.address = self.address
 629
 630                 # take this one out of the list and delete
 631                 self.remove()
 632                 del(self)
 633                 return_value = True
 634                 break
 635
 636         # true if an old connection was replaced, false if not
 637         return return_value
 638
 639     def authenticate(self):
 640         """Flag the user as authenticated and disconnect duplicates."""
 641         if self.state != "authenticated":
 642             self.authenticated = True
 643             log("User %s authenticated for account %s." % (
 644                     self, self.account.subkey), 2)
 645             if ("mudpy.limit" in universe.contents and self.account.subkey in
 646                     universe.contents["mudpy.limit"].get("admins")):
 647                 self.account.set("administrator", True)
 648                 log("Account %s is an administrator." % (
 649                         self.account.subkey), 2)
 650
 651     def show_menu(self):
 652         """Send the user their current menu."""
 653         if not self.menu_seen:
 654             self.menu_choices = get_menu_choices(self)
 655             self.send(
 656                 get_menu(self.state, self.error, self.menu_choices),
 657                 "",
 658                 add_terminator=True
 659             )
 660             self.menu_seen = True
 661             self.error = False
 662             self.adjust_echoing()
 663
 664     def prompt(self):
 665         """"Generate and return an input prompt."""
 666
 667         # Start with the user's preference, if one was provided
 668         prompt = self.account.get("prompt")
 669
 670         # If the user has not set a prompt, then immediately return the default
 671         # provided for the current state
 672         if not prompt:
 673             return get_menu_prompt(self.state)
 674
 675         # Allow including the World clock state
 676         if "$_(time)" in prompt:
 677             prompt = prompt.replace(
 678                 "$_(time)",
 679                 str(universe.groups["internal"]["counters"].get("elapsed")))
 680
 681         # Append a single space for clear separation from user input
 682         if prompt[-1] != " ":
 683             prompt = "%s " % prompt
 684
 685         # Return the cooked prompt
 686         return prompt
 687
 688     def adjust_echoing(self):
 689         """Adjust echoing to match state menu requirements."""
 690         if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_ECHO,
 691                                    mudpy.telnet.US):
 692             if menu_echo_on(self.state):
 693                 mudpy.telnet.disable(self, mudpy.telnet.TELOPT_ECHO,
 694                                      mudpy.telnet.US)
 695         elif not menu_echo_on(self.state):
 696             mudpy.telnet.enable(self, mudpy.telnet.TELOPT_ECHO,
 697                                 mudpy.telnet.US)
 698
 699     def remove(self):
 700         """Remove a user from the list of connected users."""
 701         log("Disconnecting account %s." % self, 0)
 702         universe.userlist.remove(self)
 703
 704     def send(
 705         self,
 706         output,
 707         eol="$(eol)",
 708         raw=False,
 709         flush=False,
 710         add_prompt=True,
 711         just_prompt=False,
 712         add_terminator=False,
 713         prepend_padding=True
 714     ):
 715         """Send arbitrary text to a connected user."""
 716
 717         # unless raw mode is on, clean it up all nice and pretty
 718         if not raw:
 719
 720             # strip extra $(eol) off if present
 721             while output.startswith("$(eol)"):
 722                 output = output[6:]
 723             while output.endswith("$(eol)"):
 724                 output = output[:-6]
 725             extra_lines = output.find("$(eol)$(eol)$(eol)")
 726             while extra_lines > -1:
 727                 output = output[:extra_lines] + output[extra_lines + 6:]
 728                 extra_lines = output.find("$(eol)$(eol)$(eol)")
 729
 730             # start with a newline, append the message, then end
 731             # with the optional eol string passed to this function
 732             # and the ansi escape to return to normal text
 733             if not just_prompt and prepend_padding:
 734                 if (not self.output_queue or not
 735                         self.output_queue[-1].endswith(b"\r\n")):
 736                     output = "$(eol)" + output
 737                 elif not self.output_queue[-1].endswith(
 738                     b"\r\n\x1b[0m\r\n"
 739                 ) and not self.output_queue[-1].endswith(
 740                     b"\r\n\r\n"
 741                 ):
 742                     output = "$(eol)" + output
 743             output += eol + chr(27) + "[0m"
 744
 745             # tack on a prompt if active
 746             if self.state == "active":
 747                 if not just_prompt:
 748                     output += "$(eol)"
 749                 if add_prompt:
 750                     output += self.prompt()
 751                     mode = self.avatar.get("mode")
 752                     if mode:
 753                         output += "(" + mode + ") "
 754
 755             # find and replace macros in the output
 756             output = replace_macros(self, output)
 757
 758             # wrap the text at the client's width (min 40, 0 disables)
 759             if self.columns:
 760                 if self.columns < 40:
 761                     wrap = 40
 762                 else:
 763                     wrap = self.columns
 764                 output = wrap_ansi_text(output, wrap)
 765
 766             # if supported by the client, encode it utf-8
 767             if mudpy.telnet.is_enabled(self, mudpy.telnet.TELOPT_BINARY,
 768                                        mudpy.telnet.US):
 769                 encoded_output = output.encode("utf-8")
 770
 771             # otherwise just send ascii
 772             else:
 773                 encoded_output = output.encode("ascii", "replace")
 774
 775             # end with a terminator if requested
 776             if add_prompt or add_terminator:
 777                 if mudpy.telnet.is_enabled(
 778                         self, mudpy.telnet.TELOPT_EOR, mudpy.telnet.US):
 779                     encoded_output += mudpy.telnet.telnet_proto(
 780                         mudpy.telnet.IAC, mudpy.telnet.EOR)
 781                 elif not mudpy.telnet.is_enabled(
 782                         self, mudpy.telnet.TELOPT_SGA, mudpy.telnet.US):
 783                     encoded_output += mudpy.telnet.telnet_proto(
 784                         mudpy.telnet.IAC, mudpy.telnet.GA)
 785
 786             # and tack it onto the queue
 787             self.output_queue.append(encoded_output)
 788
 789             # if this is urgent, flush all pending output
 790             if flush:
 791                 self.flush()
 792
 793         # just dump raw bytes as requested
 794         else:
 795             self.output_queue.append(output)
 796             self.flush()
 797
 798     def pulse(self):
 799         """All the things to do to the user per increment."""
 800
 801         # if the world is terminating, disconnect
 802         if universe.terminate_flag:
 803             self.state = "disconnecting"
 804             self.menu_seen = False
 805
 806         # check for an idle connection and act appropriately
 807         else:
 808             self.check_idle()
 809
 810         # ask the client for their current terminal type (RFC 1091); it's None
 811         # if it's not been initialized, the empty string if it has but the
 812         # output was indeterminate, "UNKNOWN" if the client specified it has no
 813         # terminal types to supply
 814         if self.ttype is None:
 815             mudpy.telnet.request_ttype(self)
 816
 817         # if output is paused, decrement the counter
 818         if self.state == "telopt_negotiation":
 819             if self.negotiation_pause:
 820                 self.negotiation_pause -= 1
 821             else:
 822                 self.state = "entering_account_name"
 823
 824         # show the user a menu as needed
 825         elif not self.state == "active":
 826             self.show_menu()
 827
 828         # flush any pending output in the queue
 829         self.flush()
 830
 831         # disconnect users with the appropriate state
 832         if self.state == "disconnecting":
 833             self.quit()
 834
 835         # check for input and add it to the queue
 836         self.enqueue_input()
 837
 838         # there is input waiting in the queue
 839         if self.input_queue:
 840             handle_user_input(self)
 841
 842     def flush(self):
 843         """Try to send the last item in the queue and remove it."""
 844         if self.output_queue:
 845             try:
 846                 self.connection.send(self.output_queue[0])
 847             except (BrokenPipeError, ConnectionResetError):
 848                 if self.account and self.account.get("name"):
 849                     account = self.account.get("name")
 850                 else:
 851                     account = "an unknown user"
 852                 self.state = "disconnecting"
 853                 log("Disconnected while sending to %s." % account, 7)
 854             del self.output_queue[0]
 855
 856     def enqueue_input(self):
 857         """Process and enqueue any new input."""
 858
 859         # check for some input
 860         try:
 861             raw_input = self.connection.recv(1024)
 862         except OSError:
 863             raw_input = b""
 864
 865         # we got something
 866         if raw_input:
 867
 868             # tack this on to any previous partial
 869             self.partial_input += raw_input
 870
 871             # reply to and remove any IAC negotiation codes
 872             mudpy.telnet.negotiate_telnet_options(self)
 873
 874             # separate multiple input lines
 875             new_input_lines = self.partial_input.split(b"\r\0")
 876             if len(new_input_lines) == 1:
 877                 new_input_lines = new_input_lines[0].split(b"\r\n")
 878
 879             # if input doesn't end in a newline, replace the
 880             # held partial input with the last line of it
 881             if not (
 882                     self.partial_input.endswith(b"\r\0") or
 883                     self.partial_input.endswith(b"\r\n")):
 884                 self.partial_input = new_input_lines.pop()
 885
 886             # otherwise, chop off the extra null input and reset
 887             # the held partial input
 888             else:
 889                 new_input_lines.pop()
 890                 self.partial_input = b""
 891
 892             # iterate over the remaining lines
 893             for line in new_input_lines:
 894
 895                 # strip off extra whitespace
 896                 line = line.strip()
 897
 898                 # log non-printable characters remaining
 899                 if not mudpy.telnet.is_enabled(
 900                         self, mudpy.telnet.TELOPT_BINARY, mudpy.telnet.HIM):
 901                     asciiline = bytes([x for x in line if 32 <= x <= 126])
 902                     if line != asciiline:
 903                         logline = "Non-ASCII characters from "
 904                         if self.account and self.account.get("name"):
 905                             logline += self.account.get("name") + ": "
 906                         else:
 907                             logline += "unknown user: "
 908                         logline += repr(line)
 909                         log(logline, 4)
 910                         line = asciiline
 911
 912                 try:
 913                     line = line.decode("utf-8")
 914                 except UnicodeDecodeError:
 915                     logline = "Non-UTF-8 sequence from "
 916                     if self.account and self.account.get("name"):
 917                         logline += self.account.get("name") + ": "
 918                     else:
 919                         logline += "unknown user: "
 920                     logline += repr(line)
 921                     log(logline, 4)
 922                     return
 923
 924                 line = unicodedata.normalize("NFKC", line)
 925
 926                 # put on the end of the queue
 927                 self.input_queue.append(line)
 928
 929     def new_avatar(self):
 930         """Instantiate a new, unconfigured avatar for this user."""
 931         counter = 0
 932         while ("avatar_%s_%s" % (self.account.get("name"), counter)
 933                 in universe.groups.get("actor", {}).keys()):
 934             counter += 1
 935         self.avatar = Element(
 936             "actor.avatar_%s_%s" % (self.account.get("name"), counter),
 937             universe)
 938         self.avatar.append("inherit", "archetype.avatar")
 939         self.account.append("avatars", self.avatar.key)
 940         log("Created new avatar %s for user %s." % (
 941                 self.avatar.key, self.account.get("name")), 0)
 942
 943     def delete_avatar(self, avatar):
 944         """Remove an avatar from the world and from the user's list."""
 945         if self.avatar is universe.contents[avatar]:
 946             self.avatar = None
 947         log("Deleting avatar %s for user %s." % (
 948                 avatar, self.account.get("name")), 0)
 949         universe.contents[avatar].destroy()
 950         avatars = self.account.get("avatars")
 951         avatars.remove(avatar)
 952         self.account.set("avatars", avatars)
 953
 954     def activate_avatar_by_index(self, index):
 955         """Enter the world with a particular indexed avatar."""
 956         self.avatar = universe.contents[
 957             self.account.get("avatars")[index]]
 958         self.avatar.owner = self
 959         self.state = "active"
 960         log("Activated avatar %s (%s)." % (
 961                 self.avatar.get("name"), self.avatar.key), 0)
 962         self.avatar.go_home()
 963
 964     def deactivate_avatar(self):
 965         """Have the active avatar leave the world."""
 966         if self.avatar:
 967             log("Deactivating avatar %s (%s) for user %s." % (
 968                     self.avatar.get("name"), self.avatar.key,
 969                     self.account.get("name")), 0)
 970             current = self.avatar.get("location")
 971             if current:
 972                 self.avatar.set("default_location", current)
 973                 self.avatar.echo_to_location(
 974                     "You suddenly wonder where " + self.avatar.get(
 975                         "name"
 976                     ) + " went."
 977                 )
 978                 del universe.contents[current].contents[self.avatar.key]
 979                 self.avatar.remove_facet("location")
 980             self.avatar.owner = None
 981             self.avatar = None
 982
 983     def destroy(self):
 984         """Destroy the user and associated avatars."""
 985         for avatar in self.account.get("avatars"):
 986             self.delete_avatar(avatar)
 987         log("Destroying account %s for user %s." % (
 988                 self.account.get("name"), self), 0)
 989         self.account.destroy()
 990
 991     def list_avatar_names(self):
 992         """List names of assigned avatars."""
 993         avatars = []
 994         for avatar in self.account.get("avatars"):
 995             try:
 996                 avatars.append(universe.contents[avatar].get("name"))
 997             except KeyError:
 998                 log('Missing avatar "%s", possible data corruption.' %
 999                     avatar, 6)
1000         return avatars
1001
1002
1003 def broadcast(message, add_prompt=True):
1004     """Send a message to all connected users."""
1005     for each_user in universe.userlist:
1006         each_user.send("$(eol)" + message, add_prompt=add_prompt)
1007
1008
1009 def log(message, level=0):
1010     """Log a message."""
1011
1012     # a couple references we need
1013     if "mudpy.log" in universe.contents:
1014         file_name = universe.contents["mudpy.log"].get("file", "")
1015         max_log_lines = universe.contents["mudpy.log"].get("lines", 0)
1016         syslog_name = universe.contents["mudpy.log"].get("syslog", "")
1017     else:
1018         file_name = ""
1019         max_log_lines = 0
1020         syslog_name = ""
1021     timestamp = datetime.datetime.now().isoformat(' ')
1022
1023     # turn the message into a list of nonempty lines
1024     lines = [x for x in [(x.rstrip()) for x in message.split("\n")] if x != ""]
1025
1026     # send the timestamp and line to a file
1027     if file_name:
1028         if not os.path.isabs(file_name):
1029             file_name = os.path.join(universe.startdir, file_name)
1030         os.makedirs(os.path.dirname(file_name), exist_ok=True)
1031         file_descriptor = codecs.open(file_name, "a", "utf-8")
1032         for line in lines:
1033             file_descriptor.write(timestamp + " " + line + "\n")
1034         file_descriptor.flush()
1035         file_descriptor.close()
1036
1037     # send the timestamp and line to standard output
1038     if ("mudpy.log" in universe.contents and
1039             universe.contents["mudpy.log"].get("stdout")):
1040         for line in lines:
1041             print(timestamp + " " + line)
1042
1043     # send the line to the system log
1044     if syslog_name:
1045         syslog.openlog(
1046             syslog_name.encode("utf-8"),
1047             syslog.LOG_PID,
1048             syslog.LOG_INFO | syslog.LOG_DAEMON
1049         )
1050         for line in lines:
1051             syslog.syslog(line)
1052         syslog.closelog()
1053
1054     # display to connected administrators
1055     for user in universe.userlist:
1056         if user.state == "active" and user.account.get(
1057            "administrator"
1058            ) and user.account.get("loglevel", 0) <= level:
1059             # iterate over every line in the message
1060             full_message = ""
1061             for line in lines:
1062                 full_message += (
1063                     "$(bld)$(red)" + timestamp + " "
1064                     + line.replace("$(", "$_(") + "$(nrm)$(eol)")
1065             user.send(full_message, flush=True)
1066
1067     # add to the recent log list
1068     for line in lines:
1069         while 0 < len(universe.loglines) >= max_log_lines:
1070             del universe.loglines[0]
1071         universe.loglines.append((level, timestamp + " " + line))
1072
1073
1074 def get_loglines(level, start, stop):
1075     """Return a specific range of loglines filtered by level."""
1076
1077     # filter the log lines
1078     loglines = [x for x in universe.loglines if x[0] >= level]
1079
1080     # we need these in several places
1081     total_count = str(len(universe.loglines))
1082     filtered_count = len(loglines)
1083
1084     # don't proceed if there are no lines
1085     if filtered_count:
1086
1087         # can't start before the beginning or at the end
1088         if start > filtered_count:
1089             start = filtered_count
1090         if start < 1:
1091             start = 1
1092
1093         # can't stop before we start
1094         if stop > start:
1095             stop = start
1096         elif stop < 1:
1097             stop = 1
1098
1099         # some preamble
1100         message = "There are " + str(total_count)
1101         message += " log lines in memory and " + str(filtered_count)
1102         message += " at or above level " + str(level) + "."
1103         message += " The matching lines from " + str(stop) + " to "
1104         message += str(start) + " are:$(eol)$(eol)"
1105
1106         # add the text from the selected lines
1107         if stop > 1:
1108             range_lines = loglines[-start:-(stop - 1)]
1109         else:
1110             range_lines = loglines[-start:]
1111         for line in range_lines:
1112             message += "   (" + str(line[0]) + ") " + line[1].replace(
1113                 "$(", "$_("
1114             ) + "$(eol)"
1115
1116     # there were no lines
1117     else:
1118         message = "None of the " + str(total_count)
1119         message += " lines in memory matches your request."
1120
1121     # pass it back
1122     return message
1123
1124
1125 def glyph_columns(character):
1126     """Convenience function to return the column width of a glyph."""
1127     if unicodedata.east_asian_width(character) in "FW":
1128         return 2
1129     else:
1130         return 1
1131
1132
1133 def wrap_ansi_text(text, width):
1134     """Wrap text with arbitrary width while ignoring ANSI colors."""
1135
1136     # the current position in the entire text string, including all
1137     # characters, printable or otherwise
1138     abs_pos = 0
1139
1140     # the current text position relative to the beginning of the line,
1141     # ignoring color escape sequences
1142     rel_pos = 0
1143
1144     # the absolute and relative positions of the most recent whitespace
1145     # character
1146     last_abs_whitespace = 0
1147     last_rel_whitespace = 0
1148
1149     # whether the current character is part of a color escape sequence
1150     escape = False
1151
1152     # normalize any potentially composited unicode before we count it
1153     text = unicodedata.normalize("NFKC", text)
1154
1155     # iterate over each character from the beginning of the text
1156     for each_character in text:
1157
1158         # the current character is the escape character
1159         if each_character == "\x1b" and not escape:
1160             escape = True
1161             rel_pos -= 1
1162
1163         # the current character is within an escape sequence
1164         elif escape:
1165             rel_pos -= 1
1166             if each_character == "m":
1167                 # the current character is m, which terminates the
1168                 # escape sequence
1169                 escape = False
1170
1171         # the current character is a space
1172         elif each_character == " ":
1173             last_abs_whitespace = abs_pos
1174             last_rel_whitespace = rel_pos
1175
1176         # the current character is a newline, so reset the relative
1177         # position too (start a new line)
1178         elif each_character == "\n":
1179             rel_pos = 0
1180             last_abs_whitespace = abs_pos
1181             last_rel_whitespace = rel_pos
1182
1183         # the current character meets the requested maximum line width, so we
1184         # need to wrap unless the current word is wider than the terminal (in
1185         # which case we let it do the wrapping instead)
1186         if last_rel_whitespace != 0 and (rel_pos > width or (
1187                 rel_pos > width - 1 and glyph_columns(each_character) == 2)):
1188
1189             # insert an eol in place of the last space
1190             text = (text[:last_abs_whitespace] + "\r\n" +
1191                     text[last_abs_whitespace + 1:])
1192
1193             # increase the absolute position because an eol is two
1194             # characters but the space it replaced was only one
1195             abs_pos += 1
1196
1197             # now we're at the beginning of a new line, plus the
1198             # number of characters wrapped from the previous line
1199             rel_pos -= last_rel_whitespace
1200             last_rel_whitespace = 0
1201
1202         # as long as the character is not a carriage return and the
1203         # other above conditions haven't been met, count it as a
1204         # printable character
1205         elif each_character != "\r":
1206             rel_pos += glyph_columns(each_character)
1207             if each_character in (" ", "\n"):
1208                 last_abs_whitespace = abs_pos
1209                 last_rel_whitespace = rel_pos
1210
1211         # increase the absolute position for every character
1212         abs_pos += 1
1213
1214     # return the newly-wrapped text
1215     return text
1216
1217
1218 def weighted_choice(data):
1219     """Takes a dict weighted by value and returns a random key."""
1220
1221     # this will hold our expanded list of keys from the data
1222     expanded = []
1223
1224     # create the expanded list of keys
1225     for key in data.keys():
1226         for _count in range(data[key]):
1227             expanded.append(key)
1228
1229     # return one at random
1230     # Whitelist the random.randrange() call in bandit since it's not used for
1231     # security/cryptographic purposes
1232     return random.choice(expanded)  # nosec
1233
1234
1235 def random_name():
1236     """Returns a random character name."""
1237
1238     # the vowels and consonants needed to create romaji syllables
1239     vowels = [
1240         "a",
1241         "i",
1242         "u",
1243         "e",
1244         "o"
1245     ]
1246     consonants = [
1247         "'",
1248         "k",
1249         "z",
1250         "s",
1251         "sh",
1252         "z",
1253         "j",
1254         "t",
1255         "ch",
1256         "ts",
1257         "d",
1258         "n",
1259         "h",
1260         "f",
1261         "m",
1262         "y",
1263         "r",
1264         "w"
1265     ]
1266
1267     # this dict will hold our weighted list of syllables
1268     syllables = {}
1269
1270     # generate the list with an even weighting
1271     for consonant in consonants:
1272         for vowel in vowels:
1273             syllables[consonant + vowel] = 1
1274
1275     # we'll build the name into this string
1276     name = ""
1277
1278     # create a name of random length from the syllables
1279     # Whitelist the random.randrange() call in bandit since it's not used for
1280     # security/cryptographic purposes
1281     for _syllable in range(random.randrange(2, 6)):  # nosec
1282         name += weighted_choice(syllables)
1283
1284     # strip any leading quotemark, capitalize and return the name
1285     return name.strip("'").capitalize()
1286
1287
1288 def replace_macros(user, text, is_input=False):
1289     """Replaces macros in text output."""
1290
1291     # third person pronouns
1292     pronouns = {
1293         "female": {"obj": "her", "pos": "hers", "sub": "she"},
1294         "male": {"obj": "him", "pos": "his", "sub": "he"},
1295         "neuter": {"obj": "it", "pos": "its", "sub": "it"}
1296     }
1297
1298     # a dict of replacement macros
1299     macros = {
1300         "eol": "\r\n",
1301         "bld": chr(27) + "[1m",
1302         "nrm": chr(27) + "[0m",
1303         "blk": chr(27) + "[30m",
1304         "blu": chr(27) + "[34m",
1305         "cyn": chr(27) + "[36m",
1306         "grn": chr(27) + "[32m",
1307         "mgt": chr(27) + "[35m",
1308         "red": chr(27) + "[31m",
1309         "yel": chr(27) + "[33m",
1310     }
1311
1312     # add dynamic macros where possible
1313     if user.account:
1314         account_name = user.account.get("name")
1315         if account_name:
1316             macros["account"] = account_name
1317     if user.avatar:
1318         avatar_gender = user.avatar.get("gender")
1319         if avatar_gender:
1320             macros["tpop"] = pronouns[avatar_gender]["obj"]
1321             macros["tppp"] = pronouns[avatar_gender]["pos"]
1322             macros["tpsp"] = pronouns[avatar_gender]["sub"]
1323
1324     # loop until broken
1325     while True:
1326
1327         # find and replace per the macros dict
1328         macro_start = text.find("$(")
1329         if macro_start == -1:
1330             break
1331         macro_end = text.find(")", macro_start) + 1
1332         macro = text[macro_start + 2:macro_end - 1]
1333         if macro in macros.keys():
1334             replacement = macros[macro]
1335
1336         # this is how we handle local file inclusion (dangerous!)
1337         elif macro.startswith("inc:"):
1338             incfile = mudpy.data.find_file(macro[4:], universe=universe)
1339             if os.path.exists(incfile):
1340                 incfd = codecs.open(incfile, "r", "utf-8")
1341                 replacement = ""
1342                 for line in incfd:
1343                     if line.endswith("\n") and not line.endswith("\r\n"):
1344                         line = line.replace("\n", "\r\n")
1345                     replacement += line
1346                 # lose the trailing eol
1347                 replacement = replacement[:-2]
1348             else:
1349                 replacement = ""
1350                 log("Couldn't read included " + incfile + " file.", 7)
1351
1352         # if we get here, log and replace it with null
1353         else:
1354             replacement = ""
1355             if not is_input:
1356                 log("Unexpected replacement macro " +
1357                     macro + " encountered.", 6)
1358
1359         # and now we act on the replacement
1360         text = text.replace("$(" + macro + ")", replacement)
1361
1362     # replace the look-like-a-macro sequence
1363     text = text.replace("$_(", "$(")
1364
1365     return text
1366
1367
1368 def escape_macros(value):
1369     """Escapes replacement macros in text."""
1370     if type(value) is str:
1371         return value.replace("$(", "$_(")
1372     else:
1373         return value
1374
1375
1376 def first_word(text, separator=" "):
1377     """Returns a tuple of the first word and the rest."""
1378     if text:
1379         if text.find(separator) > 0:
1380             return text.split(separator, 1)
1381         else:
1382             return text, ""
1383     else:
1384         return "", ""
1385
1386
1387 def on_pulse():
1388     """The things which should happen on each pulse, aside from reloads."""
1389
1390     # open the listening socket if it hasn't been already
1391     if not hasattr(universe, "listening_socket"):
1392         universe.initialize_server_socket()
1393
1394     # assign a user if a new connection is waiting
1395     user = check_for_connection(universe.listening_socket)
1396     if user:
1397         universe.userlist.append(user)
1398
1399     # iterate over the connected users
1400     for user in universe.userlist:
1401         user.pulse()
1402
1403     # add an element for counters if it doesn't exist
1404     if "counters" not in universe.groups.get("internal", {}):
1405         Element("internal.counters", universe)
1406
1407     # update the log every now and then
1408     if not universe.groups["internal"]["counters"].get("mark"):
1409         log(str(len(universe.userlist)) + " connection(s)")
1410         universe.groups["internal"]["counters"].set(
1411             "mark", universe.contents["mudpy.timing"].get("status")
1412         )
1413     else:
1414         universe.groups["internal"]["counters"].set(
1415             "mark", universe.groups["internal"]["counters"].get(
1416                 "mark"
1417             ) - 1
1418         )
1419
1420     # periodically save everything
1421     if not universe.groups["internal"]["counters"].get("save"):
1422         universe.save()
1423         universe.groups["internal"]["counters"].set(
1424             "save", universe.contents["mudpy.timing"].get("save")
1425         )
1426     else:
1427         universe.groups["internal"]["counters"].set(
1428             "save", universe.groups["internal"]["counters"].get(
1429                 "save"
1430             ) - 1
1431         )
1432
1433     # pause for a configurable amount of time (decimal seconds)
1434     time.sleep(universe.contents["mudpy.timing"].get("increment"))
1435
1436     # increase the elapsed increment counter
1437     universe.groups["internal"]["counters"].set(
1438         "elapsed", universe.groups["internal"]["counters"].get(
1439             "elapsed", 0
1440         ) + 1
1441     )
1442
1443
1444 def reload_data():
1445     """Reload all relevant objects."""
1446     universe.save()
1447     old_userlist = universe.userlist[:]
1448     old_loglines = universe.loglines[:]
1449     for element in list(universe.contents.values()):
1450         element.destroy()
1451     universe.load()
1452     new_loglines = universe.loglines[:]
1453     universe.loglines = old_loglines + new_loglines
1454     for user in old_userlist:
1455         user.reload()
1456
1457
1458 def check_for_connection(listening_socket):
1459     """Check for a waiting connection and return a new user object."""
1460
1461     # try to accept a new connection
1462     try:
1463         connection, address = listening_socket.accept()
1464     except BlockingIOError:
1465         return None
1466
1467     # note that we got one
1468     log("New connection from %s." % address[0], 2)
1469
1470     # disable blocking so we can proceed whether or not we can send/receive
1471     connection.setblocking(0)
1472
1473     # create a new user object
1474     user = User()
1475     log("Instantiated %s for %s." % (user, address[0]), 0)
1476
1477     # associate this connection with it
1478     user.connection = connection
1479
1480     # set the user's ipa from the connection's ipa
1481     user.address = address[0]
1482
1483     # let the client know we WILL EOR (RFC 885)
1484     mudpy.telnet.enable(user, mudpy.telnet.TELOPT_EOR, mudpy.telnet.US)
1485     user.negotiation_pause = 2
1486
1487     # return the new user object
1488     return user
1489
1490
1491 def find_command(command_name):
1492     """Try to find a command by name or abbreviation."""
1493
1494     # lowercase the command
1495     command_name = command_name.lower()
1496
1497     command = None
1498     if command_name in universe.groups["command"]:
1499         # the command matches a command word for which we have data
1500         command = universe.groups["command"][command_name]
1501     else:
1502         for candidate in sorted(universe.groups["command"]):
1503             if candidate.startswith(command_name) and not universe.groups[
1504                     "command"][candidate].get("administrative"):
1505                 # the command matches the start of a command word and is not
1506                 # restricted to administrators
1507                 command = universe.groups["command"][candidate]
1508                 break
1509     return command
1510
1511
1512 def get_menu(state, error=None, choices=None):
1513     """Show the correct menu text to a user."""
1514
1515     # make sure we don't reuse a mutable sequence by default
1516     if choices is None:
1517         choices = {}
1518
1519     # get the description or error text
1520     message = get_menu_description(state, error)
1521
1522     # get menu choices for the current state
1523     message += get_formatted_menu_choices(state, choices)
1524
1525     # try to get a prompt, if it was defined
1526     message += get_menu_prompt(state)
1527
1528     # throw in the default choice, if it exists
1529     message += get_formatted_default_menu_choice(state)
1530
1531     # display a message indicating if echo is off
1532     message += get_echo_message(state)
1533
1534     # return the assembly of various strings defined above
1535     return message
1536
1537
1538 def menu_echo_on(state):
1539     """True if echo is on, false if it is off."""
1540     return universe.groups["menu"][state].get("echo", True)
1541
1542
1543 def get_echo_message(state):
1544     """Return a message indicating that echo is off."""
1545     if menu_echo_on(state):
1546         return ""
1547     else:
1548         return "(won't echo) "
1549
1550
1551 def get_default_menu_choice(state):
1552     """Return the default choice for a menu."""
1553     return universe.groups["menu"][state].get("default")
1554
1555
1556 def get_formatted_default_menu_choice(state):
1557     """Default menu choice foratted for inclusion in a prompt string."""
1558     default_choice = get_default_menu_choice(state)
1559     if default_choice:
1560         return "[$(red)" + default_choice + "$(nrm)] "
1561     else:
1562         return ""
1563
1564
1565 def get_menu_description(state, error):
1566     """Get the description or error text."""
1567
1568     # an error condition was raised by the handler
1569     if error:
1570
1571         # try to get an error message matching the condition
1572         # and current state
1573         description = universe.groups[
1574             "menu"][state].get("error_" + error)
1575         if not description:
1576             description = "That is not a valid choice..."
1577         description = "$(red)" + description + "$(nrm)"
1578
1579     # there was no error condition
1580     else:
1581
1582         # try to get a menu description for the current state
1583         description = universe.groups["menu"][state].get("description")
1584
1585     # return the description or error message
1586     if description:
1587         description += "$(eol)$(eol)"
1588     return description
1589
1590
1591 def get_menu_prompt(state):
1592     """Try to get a prompt, if it was defined."""
1593     prompt = universe.groups["menu"][state].get("prompt")
1594     if prompt:
1595         prompt += " "
1596     return prompt
1597
1598
1599 def get_menu_choices(user):
1600     """Return a dict of choice:meaning."""
1601     state = universe.groups["menu"][user.state]
1602     create_choices = state.get("create")
1603     if create_choices:
1604         choices = call_hook_function(create_choices, (user,))
1605     else:
1606         choices = {}
1607     ignores = []
1608     options = {}
1609     creates = {}
1610     for facet in state.facets():
1611         if facet.startswith("demand_") and not call_hook_function(
1612                 universe.groups["menu"][user.state].get(facet), (user,)):
1613             ignores.append(facet.split("_", 2)[1])
1614         elif facet.startswith("create_"):
1615             creates[facet] = facet.split("_", 2)[1]
1616         elif facet.startswith("choice_"):
1617             options[facet] = facet.split("_", 2)[1]
1618     for facet in creates.keys():
1619         if not creates[facet] in ignores:
1620             choices[creates[facet]] = call_hook_function(
1621                 state.get(facet), (user,))
1622     for facet in options.keys():
1623         if not options[facet] in ignores:
1624             choices[options[facet]] = state.get(facet)
1625     return choices
1626
1627
1628 def get_formatted_menu_choices(state, choices):
1629     """Returns a formatted string of menu choices."""
1630     choice_output = ""
1631     choice_keys = list(choices.keys())
1632     choice_keys.sort()
1633     for choice in choice_keys:
1634         choice_output += "   [$(red)" + choice + "$(nrm)]  " + choices[
1635             choice
1636         ] + "$(eol)"
1637     if choice_output:
1638         choice_output += "$(eol)"
1639     return choice_output
1640
1641
1642 def get_menu_branches(state):
1643     """Return a dict of choice:branch."""
1644     branches = {}
1645     for facet in universe.groups["menu"][state].facets():
1646         if facet.startswith("branch_"):
1647             branches[
1648                 facet.split("_", 2)[1]
1649             ] = universe.groups["menu"][state].get(facet)
1650     return branches
1651
1652
1653 def get_default_branch(state):
1654     """Return the default branch."""
1655     return universe.groups["menu"][state].get("branch")
1656
1657
1658 def get_choice_branch(user):
1659     """Returns the new state matching the given choice."""
1660     branches = get_menu_branches(user.state)
1661     if user.choice in branches.keys():
1662         return branches[user.choice]
1663     elif user.choice in user.menu_choices.keys():
1664         return get_default_branch(user.state)
1665     else:
1666         return ""
1667
1668
1669 def get_menu_actions(state):
1670     """Return a dict of choice:branch."""
1671     actions = {}
1672     for facet in universe.groups["menu"][state].facets():
1673         if facet.startswith("action_"):
1674             actions[
1675                 facet.split("_", 2)[1]
1676             ] = universe.groups["menu"][state].get(facet)
1677     return actions
1678
1679
1680 def get_default_action(state):
1681     """Return the default action."""
1682     return universe.groups["menu"][state].get("action")
1683
1684
1685 def get_choice_action(user):
1686     """Run any indicated script for the given choice."""
1687     actions = get_menu_actions(user.state)
1688     if user.choice in actions.keys():
1689         return actions[user.choice]
1690     elif user.choice in user.menu_choices.keys():
1691         return get_default_action(user.state)
1692     else:
1693         return ""
1694
1695
1696 def call_hook_function(fname, arglist):
1697     """Safely execute named function with supplied arguments, return result."""
1698
1699     # all functions relative to mudpy package
1700     function = mudpy
1701
1702     for component in fname.split("."):
1703         try:
1704             function = getattr(function, component)
1705         except AttributeError:
1706             log('Could not find mudpy.%s() for arguments "%s"'
1707                 % (fname, arglist), 7)
1708             function = None
1709             break
1710     if function:
1711         try:
1712             return function(*arglist)
1713         except Exception:
1714             log('Calling mudpy.%s(%s) raised an exception...\n%s'
1715                 % (fname, (*arglist,), traceback.format_exc()), 7)
1716
1717
1718 def handle_user_input(user):
1719     """The main handler, branches to a state-specific handler."""
1720
1721     # if the user's client echo is off, send a blank line for aesthetics
1722     if mudpy.telnet.is_enabled(user, mudpy.telnet.TELOPT_ECHO,
1723                                mudpy.telnet.US):
1724         user.send("", add_prompt=False, prepend_padding=False)
1725
1726     # check to make sure the state is expected, then call that handler
1727     try:
1728         globals()["handler_" + user.state](user)
1729     except KeyError:
1730         generic_menu_handler(user)
1731
1732     # since we got input, flag that the menu/prompt needs to be redisplayed
1733     user.menu_seen = False
1734
1735     # update the last_input timestamp while we're at it
1736     user.last_input = universe.get_time()
1737
1738
1739 def generic_menu_handler(user):
1740     """A generic menu choice handler."""
1741
1742     # get a lower-case representation of the next line of input
1743     if user.input_queue:
1744         user.choice = user.input_queue.pop(0)
1745         if user.choice:
1746             user.choice = user.choice.lower()
1747     else:
1748         user.choice = ""
1749     if not user.choice:
1750         user.choice = get_default_menu_choice(user.state)
1751     if user.choice in user.menu_choices:
1752         action = get_choice_action(user)
1753         if action:
1754             call_hook_function(action, (user,))
1755         new_state = get_choice_branch(user)
1756         if new_state:
1757             user.state = new_state
1758     else:
1759         user.error = "default"
1760
1761
1762 def handler_entering_account_name(user):
1763     """Handle the login account name."""
1764
1765     # get the next waiting line of input
1766     input_data = user.input_queue.pop(0)
1767
1768     # did the user enter anything?
1769     if input_data:
1770
1771         # keep only the first word and convert to lower-case
1772         name = input_data.lower()
1773
1774         # fail if there are non-alphanumeric characters
1775         if name != "".join(filter(
1776                 lambda x: x >= "0" and x <= "9" or x >= "a" and x <= "z",
1777                 name)):
1778             user.error = "bad_name"
1779
1780         # if that account exists, time to request a password
1781         elif name in universe.groups.get("account", {}):
1782             user.account = universe.groups["account"][name]
1783             user.state = "checking_password"
1784
1785         # otherwise, this could be a brand new user
1786         else:
1787             user.account = Element("account.%s" % name, universe)
1788             user.account.set("name", name)
1789             log("New user: " + name, 2)
1790             user.state = "checking_new_account_name"
1791
1792     # if the user entered nothing for a name, then buhbye
1793     else:
1794         user.state = "disconnecting"
1795
1796
1797 def handler_checking_password(user):
1798     """Handle the login account password."""
1799
1800     # get the next waiting line of input
1801     input_data = user.input_queue.pop(0)
1802
1803     if "mudpy.limit" in universe.contents:
1804         max_password_tries = universe.contents["mudpy.limit"].get(
1805             "password_tries", 3)
1806     else:
1807         max_password_tries = 3
1808
1809     # does the hashed input equal the stored hash?
1810     if mudpy.password.verify(input_data, user.account.get("passhash")):
1811
1812         # if so, set the username and load from cold storage
1813         if not user.replace_old_connections():
1814             user.authenticate()
1815             user.state = "main_utility"
1816
1817     # if at first your hashes don't match, try, try again
1818     elif user.password_tries < max_password_tries - 1:
1819         user.password_tries += 1
1820         user.error = "incorrect"
1821
1822     # we've exceeded the maximum number of password failures, so disconnect
1823     else:
1824         user.send(
1825             "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1826         )
1827         user.state = "disconnecting"
1828
1829
1830 def handler_entering_new_password(user):
1831     """Handle a new password entry."""
1832
1833     # get the next waiting line of input
1834     input_data = user.input_queue.pop(0)
1835
1836     if "mudpy.limit" in universe.contents:
1837         max_password_tries = universe.contents["mudpy.limit"].get(
1838             "password_tries", 3)
1839     else:
1840         max_password_tries = 3
1841
1842     # make sure the password is strong--at least one upper, one lower and
1843     # one digit, seven or more characters in length
1844     if len(input_data) > 6 and len(
1845        list(filter(lambda x: x >= "0" and x <= "9", input_data))
1846        ) and len(
1847         list(filter(lambda x: x >= "A" and x <= "Z", input_data))
1848     ) and len(
1849         list(filter(lambda x: x >= "a" and x <= "z", input_data))
1850     ):
1851
1852         # hash and store it, then move on to verification
1853         user.account.set("passhash", mudpy.password.create(input_data))
1854         user.state = "verifying_new_password"
1855
1856     # the password was weak, try again if you haven't tried too many times
1857     elif user.password_tries < max_password_tries - 1:
1858         user.password_tries += 1
1859         user.error = "weak"
1860
1861     # too many tries, so adios
1862     else:
1863         user.send(
1864             "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1865         )
1866         user.account.destroy()
1867         user.state = "disconnecting"
1868
1869
1870 def handler_verifying_new_password(user):
1871     """Handle the re-entered new password for verification."""
1872
1873     # get the next waiting line of input
1874     input_data = user.input_queue.pop(0)
1875
1876     if "mudpy.limit" in universe.contents:
1877         max_password_tries = universe.contents["mudpy.limit"].get(
1878             "password_tries", 3)
1879     else:
1880         max_password_tries = 3
1881
1882     # hash the input and match it to storage
1883     if mudpy.password.verify(input_data, user.account.get("passhash")):
1884         user.authenticate()
1885
1886         # the hashes matched, so go active
1887         if not user.replace_old_connections():
1888             user.state = "main_utility"
1889
1890     # go back to entering the new password as long as you haven't tried
1891     # too many times
1892     elif user.password_tries < max_password_tries - 1:
1893         user.password_tries += 1
1894         user.error = "differs"
1895         user.state = "entering_new_password"
1896
1897     # otherwise, sayonara
1898     else:
1899         user.send(
1900             "$(eol)$(red)Too many failed password attempts...$(nrm)$(eol)"
1901         )
1902         user.account.destroy()
1903         user.state = "disconnecting"
1904
1905
1906 def handler_active(user):
1907     """Handle input for active users."""
1908
1909     # get the next waiting line of input
1910     input_data = user.input_queue.pop(0)
1911
1912     # is there input?
1913     if input_data:
1914
1915         # split out the command and parameters
1916         actor = user.avatar
1917         mode = actor.get("mode")
1918         if mode and input_data.startswith("!"):
1919             command_name, parameters = first_word(input_data[1:])
1920         elif mode == "chat":
1921             command_name = "say"
1922             parameters = input_data
1923         else:
1924             command_name, parameters = first_word(input_data)
1925
1926         # expand to an actual command
1927         command = find_command(command_name)
1928
1929         # if it's allowed, do it
1930         result = None
1931         if actor.can_run(command):
1932             action_fname = command.get("action", command.key)
1933             if action_fname:
1934                 result = call_hook_function(action_fname, (actor, parameters))
1935
1936         # if the command was not run, give an error
1937         if not result:
1938             mudpy.command.error(actor, input_data)
1939
1940     # if no input, just idle back with a prompt
1941     else:
1942         user.send("", just_prompt=True)
1943
1944
1945 def daemonize(universe):
1946     """Fork and disassociate from everything."""
1947
1948     # only if this is what we're configured to do
1949     if "mudpy.process" in universe.contents and universe.contents[
1950             "mudpy.process"].get("daemon"):
1951
1952         # log before we start forking around, so the terminal gets the message
1953         log("Disassociating from the controlling terminal.")
1954
1955         # fork off and die, so we free up the controlling terminal
1956         if os.fork():
1957             os._exit(0)
1958
1959         # switch to a new process group
1960         os.setsid()
1961
1962         # fork some more, this time to free us from the old process group
1963         if os.fork():
1964             os._exit(0)
1965
1966         # reset the working directory so we don't needlessly tie up mounts
1967         os.chdir("/")
1968
1969         # clear the file creation mask so we can bend it to our will later
1970         os.umask(0)
1971
1972         # redirect stdin/stdout/stderr and close off their former descriptors
1973         for stdpipe in range(3):
1974             os.close(stdpipe)
1975         sys.stdin = codecs.open("/dev/null", "r", "utf-8")
1976         sys.__stdin__ = codecs.open("/dev/null", "r", "utf-8")
1977         sys.stdout = codecs.open("/dev/null", "w", "utf-8")
1978         sys.stderr = codecs.open("/dev/null", "w", "utf-8")
1979         sys.__stdout__ = codecs.open("/dev/null", "w", "utf-8")
1980         sys.__stderr__ = codecs.open("/dev/null", "w", "utf-8")
1981
1982
1983 def create_pidfile(universe):
1984     """Write a file containing the current process ID."""
1985     pid = str(os.getpid())
1986     log("Process ID: " + pid)
1987     if "mudpy.process" in universe.contents:
1988         file_name = universe.contents["mudpy.process"].get("pidfile", "")
1989     else:
1990         file_name = ""
1991     if file_name:
1992         if not os.path.isabs(file_name):
1993             file_name = os.path.join(universe.startdir, file_name)
1994         os.makedirs(os.path.dirname(file_name), exist_ok=True)
1995         file_descriptor = codecs.open(file_name, "w", "utf-8")
1996         file_descriptor.write(pid + "\n")
1997         file_descriptor.flush()
1998         file_descriptor.close()
1999
2000
2001 def remove_pidfile(universe):
2002     """Remove the file containing the current process ID."""
2003     if "mudpy.process" in universe.contents:
2004         file_name = universe.contents["mudpy.process"].get("pidfile", "")
2005     else:
2006         file_name = ""
2007     if file_name:
2008         if not os.path.isabs(file_name):
2009             file_name = os.path.join(universe.startdir, file_name)
2010         if os.access(file_name, os.W_OK):
2011             os.remove(file_name)
2012
2013
2014 def excepthook(excepttype, value, tracebackdata):
2015     """Handle uncaught exceptions."""
2016
2017     # assemble the list of errors into a single string
2018     message = "".join(
2019         traceback.format_exception(excepttype, value, tracebackdata)
2020     )
2021
2022     # try to log it, if possible
2023     try:
2024         log(message, 9)
2025     except Exception as e:
2026         # try to write it to stderr, if possible
2027         sys.stderr.write(message + "\nException while logging...\n%s" % e)
2028
2029
2030 def sighook(what, where):
2031     """Handle external signals."""
2032
2033     # a generic message
2034     message = "Caught signal: "
2035
2036     # for a hangup signal
2037     if what == signal.SIGHUP:
2038         message += "hangup (reloading)"
2039         universe.reload_flag = True
2040
2041     # for a terminate signal
2042     elif what == signal.SIGTERM:
2043         message += "terminate (halting)"
2044         universe.terminate_flag = True
2045
2046     # catchall for unexpected signals
2047     else:
2048         message += str(what) + " (unhandled)"
2049
2050     # log what happened
2051     log(message, 8)
2052
2053
2054 def override_excepthook():
2055     """Redefine sys.excepthook with our own."""
2056     sys.excepthook = excepthook
2057
2058
2059 def assign_sighook():
2060     """Assign a customized handler for some signals."""
2061     signal.signal(signal.SIGHUP, sighook)
2062     signal.signal(signal.SIGTERM, sighook)
2063
2064
2065 def setup():
2066     """This contains functions to be performed when starting the engine."""
2067
2068     # see if a configuration file was specified
2069     if len(sys.argv) > 1:
2070         conffile = sys.argv[1]
2071     else:
2072         conffile = ""
2073
2074     # the big bang
2075     global universe
2076     universe = Universe(conffile, True)
2077
2078     # report any loglines which accumulated during setup
2079     for logline in universe.setup_loglines:
2080         log(*logline)
2081     universe.setup_loglines = []
2082
2083     # fork and disassociate
2084     daemonize(universe)
2085
2086     # override the default exception handler so we get logging first thing
2087     override_excepthook()
2088
2089     # set up custom signal handlers
2090     assign_sighook()
2091
2092     # make the pidfile
2093     create_pidfile(universe)
2094
2095     # load and store diagnostic info
2096     universe.versions = mudpy.version.Versions("mudpy")
2097
2098     # log startup diagnostic messages
2099     log("On %s at %s" % (universe.versions.python_version, sys.executable), 1)
2100     log("Import path: %s" % ", ".join(sys.path), 1)
2101     log("Installed dependencies: %s" % universe.versions.dependencies_text, 1)
2102     log("Other python packages: %s" % universe.versions.environment_text, 1)
2103     log("Running version: %s" % universe.versions.version, 1)
2104     log("Initial directory: %s" % universe.startdir, 1)
2105     log("Command line: %s" % " ".join(sys.argv), 1)
2106
2107     # pass the initialized universe back
2108     return universe
2109
2110
2111 def finish():
2112     """These are functions performed when shutting down the engine."""
2113
2114     # the loop has terminated, so save persistent data
2115     universe.save()
2116
2117     # log a final message
2118     log("Shutting down now.")
2119
2120     # get rid of the pidfile
2121     remove_pidfile(universe)