397 lines
15 KiB
Python
397 lines
15 KiB
Python
"""
|
|
Out-of-band default plugin commands available for OOB handler.
|
|
|
|
This module implements commands as defined by the MSDP standard
|
|
(http://tintin.sourceforge.net/msdp/), but is independent of the
|
|
actual transfer protocol (webclient, MSDP, GMCP etc). It also
|
|
implements several OOB commands unique to Evennia (both some
|
|
external and some for testing)
|
|
|
|
The available OOB commands can be extended by changing
|
|
|
|
`settings.OOB_PLUGIN_MODULES`
|
|
|
|
This module must contain a global dictionary CMD_MAP. This is a
|
|
dictionary that maps the call available in the OOB call to a function
|
|
in this module (this allows you to map multiple oob cmdnames to a
|
|
single actual Python function, for example).
|
|
|
|
For example, if the OOB strings received looks like this:
|
|
|
|
MDSP.LISTEN [desc, key] # GMCP (wrapping to MSDP)
|
|
LISTEN ARRAY VAL desc VAL key # MSDP
|
|
|
|
and CMD_MAP = {"LISTEN", listen} then this would result in a call to a
|
|
function "listen" in this module, with the arguments *("desc", "key").
|
|
|
|
oob functions have the following call signature:
|
|
|
|
function(session, *args, **kwargs)
|
|
|
|
where session is the active session and *args, **kwargs are extra
|
|
arguments sent with the oob command.
|
|
|
|
A function mapped to the key "oob_error" will retrieve error strings
|
|
if it is defined. It will get the error message as its 1st argument.
|
|
|
|
oob_error(session, error, *args, **kwargs)
|
|
|
|
This allows for customizing error handling.
|
|
|
|
Data is usually returned to the user via a return OOB call:
|
|
|
|
session.msg(oob=(oobcmdname, (args,), {kwargs}))
|
|
|
|
Oobcmdnames (like "MSDP.LISTEN" / "LISTEN" above) are case-sensitive.
|
|
Note that args, kwargs must be iterable. Non-iterables will be
|
|
interpreted as a new command name (you can send multiple oob commands
|
|
with one msg() call)
|
|
|
|
Evennia introduces two internal extensions to MSDP, and that is the
|
|
MSDP_ARRAY and MSDP_TABLE commands. These are never sent across the
|
|
wire to the client (so this is fully compliant with the MSDP
|
|
protocol), but tells the Evennia OOB Protocol that you want to send a
|
|
"bare" array or table to the client, without prepending any command
|
|
name.
|
|
|
|
"""
|
|
from future.utils import viewkeys
|
|
|
|
from django.conf import settings
|
|
from evennia.utils.utils import to_str
|
|
from evennia.server.oobhandler import OOB_HANDLER
|
|
|
|
_GA = object.__getattribute__
|
|
_SA = object.__setattr__
|
|
_NA = lambda o: "N/A"
|
|
|
|
|
|
#------------------------------------------------------------
|
|
# All OOB commands must be on the form
|
|
# cmdname(oobhandler, session, *args, **kwargs)
|
|
#------------------------------------------------------------
|
|
|
|
#
|
|
# General OOB commands
|
|
#
|
|
|
|
def oob_error(session, errmsg, *args, **kwargs):
|
|
"""
|
|
Error handling method. Error messages are relayed here.
|
|
|
|
Args:
|
|
session (Session): The session to receive the error
|
|
errmsg (str): The failure message
|
|
|
|
A function with this name is special and is also called by the
|
|
oobhandler when an error occurs already at the execution stage
|
|
(such as the oob function not being recognized or having the wrong
|
|
args etc). Call this from other oob functions to centralize error
|
|
management.
|
|
|
|
"""
|
|
session.msg(oob=("error", ("OOB ERROR: %s" % errmsg,)))
|
|
|
|
def oob_echo(session, *args, **kwargs):
|
|
"""
|
|
Test echo function. Echoes args, kwargs sent to it.
|
|
|
|
Args:
|
|
session (Session): The Session to receive the echo.
|
|
args (list of str): Echo text.
|
|
kwargs (dict of str, optional): Keyed echo text
|
|
|
|
"""
|
|
session.msg(oob=("echo", args, kwargs))
|
|
|
|
##OOB{"repeat":10}
|
|
def oob_repeat(session, oobfuncname, interval, *args, **kwargs):
|
|
"""
|
|
Called as REPEAT <oobfunc> <interval> <args>
|
|
Repeats a given OOB command with a certain frequency.
|
|
|
|
Args:
|
|
session (Session): Session creating the repeat
|
|
oobfuncname (str): OOB function called every interval seconds
|
|
interval (int): Interval of repeat, in seconds.
|
|
|
|
Notes:
|
|
The command checks so that it cannot repeat itself.
|
|
|
|
"""
|
|
if not oobfuncname:
|
|
oob_error(session, "Usage: REPEAT <oobfuncname>, <interval>")
|
|
return
|
|
# limit repeat actions to minimum 5 seconds interval
|
|
interval = 20 if not interval else (max(5, interval))
|
|
obj = session.get_puppet_or_player()
|
|
if obj and oobfuncname != "REPEAT":
|
|
OOB_HANDLER.add_repeater(obj, session, oobfuncname, interval, *args, **kwargs)
|
|
|
|
|
|
##OOB{"UNREPEAT":10}
|
|
def oob_unrepeat(session, oobfuncname, interval):
|
|
"""
|
|
Called with UNREPEAT <oobfunc> <interval>
|
|
Disable repeating callback.
|
|
|
|
Args:
|
|
session (Session): Session controlling the repeater
|
|
oobfuncname (str): OOB function called every interval seconds
|
|
interval (int): Interval of repeater, in seconds.
|
|
|
|
Notes:
|
|
The command checks so that it cannot repeat itself.
|
|
|
|
|
|
"""
|
|
obj = session.get_puppet_or_player()
|
|
if obj:
|
|
OOB_HANDLER.remove_repeater(obj, session, oobfuncname, interval)
|
|
|
|
|
|
#
|
|
# MSDP protocol standard commands
|
|
#
|
|
# MSDP suggests the following standard name conventions for making
|
|
# different properties available to the player
|
|
|
|
# "CHARACTER_NAME", "SERVER_ID", "SERVER_TIME", "AFFECTS", "ALIGNMENT", "EXPERIENCE", "EXPERIENCE_MAX", "EXPERIENCE_TNL",
|
|
# "HEALTH", "HEALTH_MAX", "LEVEL", "RACE", "CLASS", "MANA", "MANA_MAX", "WIMPY", "PRACTICE", "MONEY", "MOVEMENT",
|
|
# "MOVEMENT_MAX", "HITROLL", "DAMROLL", "AC", "STR", "INT", "WIS", "DEX", "CON", "OPPONENT_HEALTH", "OPPONENT_HEALTH_MAX",
|
|
# "OPPONENT_LEVEL", "OPPONENT_NAME", "AREA_NAME", "ROOM_EXITS", "ROOM_VNUM", "ROOM_NAME", "WORLD_TIME", "CLIENT_ID",
|
|
# "CLIENT_VERSION", "PLUGIN_ID", "ANSI_COLORS", "XTERM_256_COLORS", "UTF_8", "SOUND", "MXP", "BUTTON_1", "BUTTON_2",
|
|
# "BUTTON_3", "BUTTON_4", "BUTTON_5", "GAUGE_1", "GAUGE_2","GAUGE_3", "GAUGE_4", "GAUGE_5"
|
|
|
|
|
|
# mapping from MSDP standard names to Evennia variables
|
|
OOB_SENDABLE = {
|
|
"CHARACTER_NAME": lambda o: o.key,
|
|
"SERVER_ID": lambda o: settings.SERVERNAME,
|
|
"ROOM_NAME": lambda o: o.db_location.key,
|
|
"ANSI_COLORS": lambda o: True,
|
|
"XTERM_256_COLORS": lambda o: True,
|
|
"UTF_8": lambda o: True
|
|
}
|
|
|
|
|
|
##OOB{"SEND":"CHARACTER_NAME"} - from webclient
|
|
def oob_send(session, *args, **kwargs):
|
|
"""
|
|
Called with the SEND MSDP command.
|
|
This function directly returns the value of the given variable to
|
|
the session. It assumes the object on which the variable sits
|
|
belongs to the session.
|
|
|
|
Args:
|
|
session (Session): Session object
|
|
args (str): any number of properties to return. These
|
|
must belong to the OOB_SENDABLE dictionary.
|
|
Examples:
|
|
oob input: ("SEND", "CHARACTER_NAME", "SERVERNAME")
|
|
oob output: ("MSDP_TABLE", "CHARACTER_NAME", "Amanda",
|
|
"SERVERNAME", "Evennia")
|
|
|
|
"""
|
|
# mapping of MSDP name to a property
|
|
obj = session.get_puppet_or_player()
|
|
ret = {}
|
|
if obj:
|
|
for name in (a.upper() for a in args if a):
|
|
try:
|
|
value = OOB_SENDABLE.get(name, _NA)(obj)
|
|
ret[name] = value
|
|
except Exception as e:
|
|
ret[name] = str(e)
|
|
# return, make sure to use the right case
|
|
session.msg(oob=("MSDP_TABLE", (), ret))
|
|
else:
|
|
oob_error(session, "You must log in first.")
|
|
|
|
|
|
# mapping standard MSDP keys to Evennia field names
|
|
OOB_REPORTABLE = {
|
|
"CHARACTER_NAME": "db_key",
|
|
"ROOM_NAME": "db_location",
|
|
"TEST" : "test"
|
|
}
|
|
|
|
##OOB{"REPORT":"TEST"}
|
|
def oob_report(session, *args, **kwargs):
|
|
"""
|
|
Called with the `REPORT PROPNAME` MSDP command.
|
|
Monitors the changes of given property name. Assumes reporting
|
|
happens on an object controlled by the session.
|
|
|
|
Args:
|
|
session (Session): The Session doing the monitoring. The
|
|
property is assumed to sit on the entity currently
|
|
controlled by the Session. If puppeting, this is an
|
|
Object, otherwise the object will be the Player the
|
|
Session belongs to.
|
|
args (str or list): One or more property names to monitor changes in.
|
|
If a name starts with `db_`, the property is assumed to
|
|
be a field, otherwise an Attribute of the given name will
|
|
be monitored (if it exists).
|
|
|
|
Notes:
|
|
When the property updates, the monitor will send a MSDP_ARRAY
|
|
to the session of the form `(SEND, fieldname, new_value)`
|
|
|
|
Examples:
|
|
("REPORT", "CHARACTER_NAME")
|
|
("MSDP_TABLE", "CHARACTER_NAME", "Amanda")
|
|
|
|
"""
|
|
obj = session.get_puppet_or_player()
|
|
if obj:
|
|
ret = []
|
|
for name in args:
|
|
propname = OOB_REPORTABLE.get(name, None)
|
|
if not propname:
|
|
oob_error(session, "No Reportable property '%s'. Use LIST REPORTABLE_VARIABLES." % propname)
|
|
# the field_monitors require an oob function as a callback when they report a change.
|
|
elif propname.startswith("db_"):
|
|
OOB_HANDLER.add_field_monitor(obj, session, propname, "return_field_report")
|
|
ret.append(to_str(_GA(obj, propname), force_string=True))
|
|
else:
|
|
OOB_HANDLER.add_attribute_monitor(obj, session, propname, "return_attribute_report")
|
|
ret.append(_GA(obj, "db_value"))
|
|
session.msg(oob=("MSDP_ARRAY", ret))
|
|
else:
|
|
oob_error(session, "You must log in first.")
|
|
|
|
|
|
def oob_return_field_report(session, fieldname, obj, *args, **kwargs):
|
|
"""
|
|
This is a helper command called by the monitor when fieldname
|
|
changes. It is not part of the official MSDP specification but is
|
|
a callback used by the monitor to format the result before sending
|
|
it on.
|
|
|
|
Args:
|
|
session (Session): The Session object controlling this oob function.
|
|
fieldname (str): The name of the Field to report on.
|
|
|
|
"""
|
|
session.msg(oob=("MSDP_TABLE", (),
|
|
{fieldname: to_str(getattr(obj, fieldname), force_string=True)}))
|
|
|
|
|
|
def oob_return_attribute_report(session, fieldname, obj, *args, **kwargs):
|
|
"""
|
|
This is a helper command called by the monitor when an Attribute
|
|
changes. We need to handle this a little differently from fields
|
|
since we are generally not interested in the field name (it's
|
|
always db_value for Attributes) but the Attribute's name.
|
|
|
|
This command is not part of the official MSDP specification but is
|
|
a callback used by the monitor to format the result before sending
|
|
it on.
|
|
|
|
Args:
|
|
session (Session): The Session object controlling this oob function.
|
|
fieldname (str): The name of the Attribute to report on.
|
|
|
|
"""
|
|
session.msg(oob=("MSDP_TABLE", (),
|
|
{obj.db_key: to_str(getattr(obj, fieldname), force_string=True)}))
|
|
|
|
|
|
##OOB{"UNREPORT": "TEST"}
|
|
def oob_unreport(session, *args, **kwargs):
|
|
"""
|
|
This removes tracking for the given data.
|
|
|
|
Args:
|
|
session (Session): Session controling this command.
|
|
|
|
"""
|
|
obj = session.get_puppet_or_player()
|
|
if obj:
|
|
for name in (a.upper() for a in args if a):
|
|
propname = OOB_REPORTABLE.get(name, None)
|
|
if not propname:
|
|
oob_error(session, "No Un-Reportable property '%s'. Use LIST REPORTABLE_VARIABLES." % propname)
|
|
elif propname.startswith("db_"):
|
|
OOB_HANDLER.remove_field_monitor(obj, session, propname, "oob_return_field_report")
|
|
else: # assume attribute
|
|
OOB_HANDLER.remove_attribute_monitor(obj, session, propname, "oob_return_attribute_report")
|
|
else:
|
|
oob_error(session, "You must log in first.")
|
|
|
|
|
|
##OOB{"LIST":"COMMANDS"}
|
|
def oob_list(session, mode, *args, **kwargs):
|
|
"""
|
|
Called with the `LIST <MODE>` MSDP command.
|
|
|
|
Args:
|
|
session (Session): The Session asking for the information
|
|
mode (str): The available properties. One of
|
|
"COMMANDS" Request an array of commands supported
|
|
by the server.
|
|
"LISTS" Request an array of lists supported
|
|
by the server.
|
|
"CONFIGURABLE_VARIABLES" Request an array of variables the client
|
|
can configure.
|
|
"REPORTABLE_VARIABLES" Request an array of variables the server
|
|
will report.
|
|
"REPORTED_VARIABLES" Request an array of variables currently
|
|
being reported.
|
|
"SENDABLE_VARIABLES" Request an array of variables the server
|
|
will send.
|
|
Examples:
|
|
oob in: LIST COMMANDS
|
|
oob out: (COMMANDS, (SEND, REPORT, LIST, ...)
|
|
|
|
"""
|
|
mode = mode.upper()
|
|
if mode == "COMMANDS":
|
|
session.msg(oob=("COMMANDS", ("LIST",
|
|
"REPORT",
|
|
"UNREPORT",
|
|
# "RESET",
|
|
"SEND")))
|
|
elif mode == "REPORTABLE_VARIABLES":
|
|
session.msg(oob=("REPORTABLE_VARIABLES", tuple(key for key in viewkeys(OOB_REPORTABLE))))
|
|
elif mode == "REPORTED_VARIABLES":
|
|
# we need to check so as to use the right return value depending on if it is
|
|
# an Attribute (identified by tracking the db_value field) or a normal database field
|
|
# reported is a list of tuples (obj, propname, args, kwargs)
|
|
reported = OOB_HANDLER.get_all_monitors(session)
|
|
reported = [rep[0].key if rep[1] == "db_value" else rep[1] for rep in reported]
|
|
session.msg(oob=("REPORTED_VARIABLES", reported))
|
|
elif mode == "SENDABLE_VARIABLES":
|
|
session.msg(oob=("SENDABLE_VARIABLES", tuple(key for key in viewkeys(OOB_REPORTABLE))))
|
|
elif mode == "CONFIGURABLE_VARIABLES":
|
|
# Not implemented (game specific)
|
|
oob_error(session, "Not implemented (game specific)")
|
|
else:
|
|
# mode == "LISTS" or not given
|
|
session.msg(oob=("LISTS",("REPORTABLE_VARIABLES",
|
|
"REPORTED_VARIABLES",
|
|
# "CONFIGURABLE_VARIABLES",
|
|
"SENDABLE_VARIABLES")))
|
|
|
|
#
|
|
# Cmd mapping
|
|
#
|
|
|
|
# this maps the commands to the names available to use from
|
|
# the oob call. The standard MSDP commands are capitalized
|
|
# as per the protocol, Evennia's own commands are not.
|
|
CMD_MAP = {"oob_error": oob_error, # will get error messages
|
|
"return_field_report": oob_return_field_report,
|
|
"return_attribute_report": oob_return_attribute_report,
|
|
# MSDP
|
|
"REPEAT": oob_repeat,
|
|
"UNREPEAT": oob_unrepeat,
|
|
"SEND": oob_send,
|
|
"ECHO": oob_echo,
|
|
"REPORT": oob_report,
|
|
"UNREPORT": oob_unreport,
|
|
"LIST": oob_list,
|
|
# GMCP
|
|
}
|
|
|