mudpy/command.py

   1 """User command functions for the mudpy engine."""
   2
   3 # Copyright (c) 2004-2019 mudpy authors. Permission to use, copy,
   4 # modify, and distribute this software is granted under terms
   5 # provided in the LICENSE file distributed with this software.
   6
   7 import random
   8 import re
   9 import unicodedata
  10
  11 import mudpy
  12
  13
  14 def chat(actor, parameters):
  15     """Toggle chat mode."""
  16     mode = actor.get("mode")
  17     if not mode:
  18         actor.set("mode", "chat")
  19         actor.send("Entering chat mode (use $(grn)!chat$(nrm) to exit).")
  20     elif mode == "chat":
  21         actor.remove_facet("mode")
  22         actor.send("Exiting chat mode.")
  23     else:
  24         actor.send("Sorry, but you're already busy with something else!")
  25
  26
  27 def create(actor, parameters):
  28     """Create an element if it does not exist."""
  29     if not parameters:
  30         message = "You must at least specify an element to create."
  31     elif not actor.owner:
  32         message = ""
  33     else:
  34         arguments = parameters.split()
  35         if len(arguments) == 1:
  36             arguments.append("")
  37         if len(arguments) == 2:
  38             element, filename = arguments
  39             if element in actor.universe.contents:
  40                 message = 'The "' + element + '" element already exists.'
  41             else:
  42                 message = ('You create "' +
  43                            element + '" within the universe.')
  44                 logline = actor.owner.account.get(
  45                     "name"
  46                 ) + " created an element: " + element
  47                 if filename:
  48                     logline += " in file " + filename
  49                     if filename not in actor.universe.files:
  50                         message += (
  51                             ' Warning: "' + filename + '" is not yet '
  52                             "included in any other file and will not be read "
  53                             "on startup unless this is remedied.")
  54                 mudpy.misc.Element(element, actor.universe, filename)
  55                 mudpy.misc.log(logline, 6)
  56         elif len(arguments) > 2:
  57             message = "You can only specify an element and a filename."
  58     actor.send(message)
  59
  60
  61 def delete(actor, parameters):
  62     """Delete a facet from an element."""
  63     if not parameters:
  64         message = "You must specify an element and a facet."
  65     else:
  66         arguments = parameters.split(" ")
  67         if len(arguments) == 1:
  68             message = ('What facet of element "' + arguments[0]
  69                        + '" would you like to delete?')
  70         elif len(arguments) != 2:
  71             message = "You may only specify an element and a facet."
  72         else:
  73             element, facet = arguments
  74             if element not in actor.universe.contents:
  75                 message = 'The "' + element + '" element does not exist.'
  76             elif facet not in actor.universe.contents[element].facets():
  77                 message = ('The "' + element + '" element has no "' + facet
  78                            + '" facet.')
  79             else:
  80                 actor.universe.contents[element].remove_facet(facet)
  81                 message = ('You have successfully deleted the "' + facet
  82                            + '" facet of element "' + element
  83                            + '". Try "show element ' +
  84                            element + '" for verification.')
  85     actor.send(message)
  86
  87
  88 def destroy(actor, parameters):
  89     """Destroy an element if it exists."""
  90     if actor.owner:
  91         if not parameters:
  92             message = "You must specify an element to destroy."
  93         else:
  94             if parameters not in actor.universe.contents:
  95                 message = 'The "' + parameters + '" element does not exist.'
  96             else:
  97                 actor.universe.contents[parameters].destroy()
  98                 message = ('You destroy "' + parameters
  99                            + '" within the universe.')
 100                 mudpy.misc.log(
 101                     actor.owner.account.get(
 102                         "name"
 103                     ) + " destroyed an element: " + parameters,
 104                     6
 105                 )
 106         actor.send(message)
 107
 108
 109 def error(actor, input_data):
 110     """Generic error for an unrecognized command word."""
 111
 112     # 90% of the time use a generic error
 113     if random.randrange(10):
 114         message = '''I'm not sure what "''' + input_data + '''" means...'''
 115
 116     # 10% of the time use the classic diku error
 117     else:
 118         message = "Arglebargle, glop-glyf!?!"
 119
 120     # send the error message
 121     actor.send(message)
 122
 123
 124 def halt(actor, parameters):
 125     """Halt the world."""
 126     if actor.owner:
 127
 128         # see if there's a message or use a generic one
 129         if parameters:
 130             message = "Halting: " + parameters
 131         else:
 132             message = "User " + actor.owner.account.get(
 133                 "name"
 134             ) + " halted the world."
 135
 136         # let everyone know
 137         mudpy.misc.broadcast(message, add_prompt=False)
 138         mudpy.misc.log(message, 8)
 139
 140         # set a flag to terminate the world
 141         actor.universe.terminate_flag = True
 142
 143
 144 def help(actor, parameters):
 145     """List available commands and provide help for commands."""
 146
 147     # did the user ask for help on a specific command word?
 148     if parameters and actor.owner:
 149
 150         # is the command word one for which we have data?
 151         command = mudpy.misc.find_command(parameters)
 152
 153         # only for allowed commands
 154         if actor.can_run(command):
 155
 156             # add a description if provided
 157             description = command.get("description")
 158             if not description:
 159                 description = "(no short description provided)"
 160             if command.get("administrative"):
 161                 output = "$(red)"
 162             else:
 163                 output = "$(grn)"
 164             output = "%s%s$(nrm) - %s$(eol)$(eol)" % (
 165                 output, command.subkey, description)
 166
 167             # add the help text if provided
 168             help_text = command.get("help")
 169             if not help_text:
 170                 help_text = "No help is provided for this command."
 171             output += help_text
 172
 173             # list related commands
 174             see_also = command.get("see_also")
 175             if see_also:
 176                 really_see_also = ""
 177                 for item in see_also:
 178                     if item in actor.universe.groups["command"]:
 179                         command = actor.universe.groups["command"][item]
 180                         if actor.can_run(command):
 181                             if really_see_also:
 182                                 really_see_also += ", "
 183                             if command.get("administrative"):
 184                                 really_see_also += "$(red)"
 185                             else:
 186                                 really_see_also += "$(grn)"
 187                             really_see_also += item + "$(nrm)"
 188                 if really_see_also:
 189                     output += "$(eol)$(eol)See also: " + really_see_also
 190
 191         # no data for the requested command word
 192         else:
 193             output = "That is not an available command."
 194
 195     # no specific command word was indicated
 196     else:
 197
 198         # give a sorted list of commands with descriptions if provided
 199         output = "These are the commands available to you:$(eol)$(eol)"
 200         sorted_commands = list(actor.universe.groups["command"].keys())
 201         sorted_commands.sort()
 202         for item in sorted_commands:
 203             command = actor.universe.groups["command"][item]
 204             if actor.can_run(command):
 205                 description = command.get("description")
 206                 if not description:
 207                     description = "(no short description provided)"
 208                 if command.get("administrative"):
 209                     output += "   $(red)"
 210                 else:
 211                     output += "   $(grn)"
 212                 output += item + "$(nrm) - " + description + "$(eol)"
 213         output += ('$(eol)Enter "help COMMAND" for help on a command '
 214                    'named "COMMAND".')
 215
 216     # send the accumulated output to the user
 217     actor.send(output)
 218
 219
 220 def look(actor, parameters):
 221     """Look around."""
 222     if parameters:
 223         actor.send("You can't look at or in anything yet.")
 224     else:
 225         actor.look_at(actor.get("location"))
 226
 227
 228 def move(actor, parameters):
 229     """Move the avatar in a given direction."""
 230     if parameters in actor.universe.contents[actor.get("location")].portals():
 231         actor.move_direction(parameters)
 232     else:
 233         actor.send("You cannot go that way.")
 234
 235
 236 def preferences(actor, parameters):
 237     """List, view and change actor preferences."""
 238
 239     # Escape replacement macros in preferences
 240     parameters = mudpy.misc.escape_macros(parameters)
 241
 242     message = ""
 243     arguments = parameters.split()
 244     allowed_prefs = set()
 245     user_config = actor.universe.contents.get("mudpy.user")
 246     if user_config:
 247         allowed_prefs.update(user_config.get("pref_allow", []))
 248         if actor.owner.account.get("administrator"):
 249             allowed_prefs.update(user_config.get("pref_admin", []))
 250     if not arguments:
 251         message += "These are your current preferences:"
 252         for pref in allowed_prefs:
 253             message += ("$(eol)   $(red)%s $(grn)%s$(nrm)"
 254                         % (pref, actor.owner.account.get(pref)))
 255     elif arguments[0] not in allowed_prefs:
 256         message += (
 257             'Preference "%s" does not exist. Try the `preferences` command by '
 258             "itself for a list of valid preferences." % arguments[0])
 259     elif len(arguments) == 1:
 260         message += "%s" % actor.owner.account.get(arguments[0])
 261     else:
 262         pref = arguments[0]
 263         value = " ".join(arguments[1:])
 264         try:
 265             actor.owner.account.set(pref, value)
 266             message += 'Preference "%s" set to "%s".' % (pref, value)
 267         except ValueError:
 268             message = (
 269                 'Preference "%s" cannot be set to type "%s".' % (
 270                     pref, type(value)))
 271     actor.send(message)
 272
 273
 274 def quit(actor, parameters):
 275     """Leave the world and go back to the main menu."""
 276     if actor.owner:
 277         actor.owner.state = "main_utility"
 278         actor.owner.deactivate_avatar()
 279
 280
 281 def reload(actor, parameters):
 282     """Reload all code modules, configs and data."""
 283     if actor.owner:
 284
 285         # let the user know and log
 286         actor.send("Reloading all code modules, configs and data.")
 287         mudpy.misc.log(
 288             "User " +
 289             actor.owner.account.get("name") + " reloaded the world.",
 290             6
 291         )
 292
 293         # set a flag to reload
 294         actor.universe.reload_flag = True
 295
 296
 297 def say(actor, parameters):
 298     """Speak to others in the same area."""
 299
 300     # check for replacement macros and escape them
 301     parameters = mudpy.misc.escape_macros(parameters)
 302
 303     # if the message is wrapped in quotes, remove them and leave contents
 304     # intact
 305     if parameters.startswith('"') and parameters.endswith('"'):
 306         message = parameters[1:-1]
 307         literal = True
 308
 309     # otherwise, get rid of stray quote marks on the ends of the message
 310     else:
 311         message = parameters.strip('''"'`''')
 312         literal = False
 313
 314     # the user entered a message
 315     if message:
 316
 317         # match the punctuation used, if any, to an action
 318         if "mudpy.linguistic" in actor.universe.contents:
 319             actions = actor.universe.contents[
 320                 "mudpy.linguistic"].get("actions", {})
 321             default_punctuation = (actor.universe.contents[
 322                 "mudpy.linguistic"].get("default_punctuation", "."))
 323         else:
 324             actions = {}
 325             default_punctuation = "."
 326         action = ""
 327
 328         # reverse sort punctuation options so the longest match wins
 329         for mark in sorted(actions.keys(), reverse=True):
 330             if not literal and message.endswith(mark):
 331                 action = actions[mark]
 332                 break
 333
 334         # add punctuation if needed
 335         if not action:
 336             action = actions[default_punctuation]
 337             if message and not (
 338                literal or unicodedata.category(message[-1]) == "Po"
 339                ):
 340                 message += default_punctuation
 341
 342         # failsafe checks to avoid unwanted reformatting and null strings
 343         if message and not literal:
 344
 345             # decapitalize the first letter to improve matching
 346             message = message[0].lower() + message[1:]
 347
 348             # iterate over all words in message, replacing typos
 349             if "mudpy.linguistic" in actor.universe.contents:
 350                 typos = actor.universe.contents[
 351                     "mudpy.linguistic"].get("typos", {})
 352             else:
 353                 typos = {}
 354             words = message.split()
 355             for index in range(len(words)):
 356                 word = words[index]
 357                 while unicodedata.category(word[0]) == "Po":
 358                     word = word[1:]
 359                 while unicodedata.category(word[-1]) == "Po":
 360                     word = word[:-1]
 361                 if word in typos.keys():
 362                     words[index] = words[index].replace(word, typos[word])
 363             message = " ".join(words)
 364
 365             # capitalize the first letter
 366             message = message[0].upper() + message[1:]
 367
 368     # tell the area
 369     if message:
 370         actor.echo_to_location(
 371             actor.get("name") + " " + action + 's, "' + message + '"'
 372         )
 373         actor.send("You " + action + ', "' + message + '"')
 374
 375     # there was no message
 376     else:
 377         actor.send("What do you want to say?")
 378
 379
 380 def c_set(actor, parameters):
 381     """Set a facet of an element."""
 382     if not parameters:
 383         message = "You must specify an element, a facet and a value."
 384     else:
 385         arguments = parameters.split(" ", 2)
 386         if len(arguments) == 1:
 387             message = ('What facet of element "' + arguments[0]
 388                        + '" would you like to set?')
 389         elif len(arguments) == 2:
 390             message = ('What value would you like to set for the "' +
 391                        arguments[1] + '" facet of the "' + arguments[0]
 392                        + '" element?')
 393         else:
 394             element, facet, value = arguments
 395             if element not in actor.universe.contents:
 396                 message = 'The "' + element + '" element does not exist.'
 397             else:
 398                 try:
 399                     actor.universe.contents[element].set(facet, value)
 400                 except PermissionError:
 401                     message = ('The "%s" element is kept in read-only file '
 402                                '"%s" and cannot be altered.' %
 403                                (element, actor.universe.contents[
 404                                         element].origin.source))
 405                 except ValueError:
 406                     message = ('Value "%s" of type "%s" cannot be coerced '
 407                                'to the correct datatype for facet "%s".' %
 408                                (value, type(value), facet))
 409                 else:
 410                     message = ('You have successfully (re)set the "' + facet
 411                                + '" facet of element "' + element
 412                                + '". Try "show element ' +
 413                                element + '" for verification.')
 414     actor.send(message)
 415
 416
 417 def show(actor, parameters):
 418     """Show program data."""
 419     message = ""
 420     arguments = parameters.split()
 421     if not parameters:
 422         message = "What do you want to show?"
 423     elif arguments[0] == "version":
 424         message = repr(actor.universe.versions)
 425     elif arguments[0] == "time":
 426         message = actor.universe.groups["internal"]["counters"].get(
 427             "elapsed"
 428         ) + " increments elapsed since the world was created."
 429     elif arguments[0] == "groups":
 430         message = "These are the element groups:$(eol)"
 431         groups = list(actor.universe.groups.keys())
 432         groups.sort()
 433         for group in groups:
 434             message += "$(eol)   $(grn)" + group + "$(nrm)"
 435     elif arguments[0] == "files":
 436         message = "These are the current files containing the universe:$(eol)"
 437         filenames = sorted(actor.universe.files)
 438         for filename in filenames:
 439             if actor.universe.files[filename].is_writeable():
 440                 status = "rw"
 441             else:
 442                 status = "ro"
 443             message += ("$(eol)   $(red)(%s) $(grn)%s$(nrm)" %
 444                         (status, filename))
 445             if actor.universe.files[filename].flags:
 446                 message += (" $(yel)[%s]$(nrm)" %
 447                             ",".join(actor.universe.files[filename].flags))
 448     elif arguments[0] == "group":
 449         if len(arguments) != 2:
 450             message = "You must specify one group."
 451         elif arguments[1] in actor.universe.groups:
 452             message = ('These are the elements in the "' + arguments[1]
 453                        + '" group:$(eol)')
 454             elements = [
 455                 (
 456                     actor.universe.groups[arguments[1]][x].key
 457                 ) for x in actor.universe.groups[arguments[1]].keys()
 458             ]
 459             elements.sort()
 460             for element in elements:
 461                 message += "$(eol)   $(grn)" + element + "$(nrm)"
 462         else:
 463             message = 'Group "' + arguments[1] + '" does not exist.'
 464     elif arguments[0] == "file":
 465         if len(arguments) != 2:
 466             message = "You must specify one file."
 467         elif arguments[1] in actor.universe.files:
 468             message = ('These are the nodes in the "' + arguments[1]
 469                        + '" file:$(eol)')
 470             elements = sorted(actor.universe.files[arguments[1]].data)
 471             for element in elements:
 472                 message += "$(eol)   $(grn)" + element + "$(nrm)"
 473         else:
 474             message = 'File "%s" does not exist.' % arguments[1]
 475     elif arguments[0] == "element":
 476         if len(arguments) != 2:
 477             message = "You must specify one element."
 478         elif arguments[1].strip(".") in actor.universe.contents:
 479             element = actor.universe.contents[arguments[1].strip(".")]
 480             message = ('These are the properties of the "' + arguments[1]
 481                        + '" element (in "' + element.origin.source
 482                        + '"):$(eol)')
 483             facets = element.facets()
 484             for facet in sorted(facets):
 485                 message += ("$(eol)   $(grn)%s: $(red)%s$(nrm)" %
 486                             (facet, str(facets[facet])))
 487         else:
 488             message = 'Element "' + arguments[1] + '" does not exist.'
 489     elif arguments[0] == "result":
 490         if len(arguments) < 2:
 491             message = "You need to specify an expression."
 492         else:
 493             try:
 494                 message = repr(eval(" ".join(arguments[1:])))
 495             except Exception as e:
 496                 message = ("$(red)Your expression raised an exception...$(eol)"
 497                            "$(eol)$(bld)%s$(nrm)" % e)
 498     elif arguments[0] == "log":
 499         if len(arguments) == 4:
 500             if re.match(r"^\d+$", arguments[3]) and int(arguments[3]) >= 0:
 501                 stop = int(arguments[3])
 502             else:
 503                 stop = -1
 504         else:
 505             stop = 0
 506         if len(arguments) >= 3:
 507             if re.match(r"^\d+$", arguments[2]) and int(arguments[2]) > 0:
 508                 start = int(arguments[2])
 509             else:
 510                 start = -1
 511         else:
 512             start = 10
 513         if len(arguments) >= 2:
 514             if (re.match(r"^\d+$", arguments[1])
 515                     and 0 <= int(arguments[1]) <= 9):
 516                 level = int(arguments[1])
 517             else:
 518                 level = -1
 519         elif 0 <= actor.owner.account.get("loglevel", 0) <= 9:
 520             level = actor.owner.account.get("loglevel", 0)
 521         else:
 522             level = 1
 523         if level > -1 and start > -1 and stop > -1:
 524             message = mudpy.misc.get_loglines(level, start, stop)
 525         else:
 526             message = ("When specified, level must be 0-9 (default 1), "
 527                        "start and stop must be >=1 (default 10 and 1).")
 528     else:
 529         message = '''I don't know what "''' + parameters + '" is.'
 530     actor.send(message)