Refactor containers for inheritance and delayed loading

evennia/utils/validatorfuncs.py

@@ -0,0 +1,207 @@
+"""
+Contains all the validation functions.
+
+All validation functions must have a checker (probably a session) and entry arg.
+
+They can employ more paramters at your leisure.
+
+
+"""
+
+import re as _re
+import pytz as _pytz
+import datetime as _dt
+from django.core.exceptions import ValidationError as _error
+from django.core.validators import validate_email as _val_email
+from evennia.utils.ansi import strip_ansi
+from evennia.utils.utils import string_partial_matching as _partial
+
+_TZ_DICT = {str(tz): _pytz.timezone(tz) for tz in _pytz.common_timezones}
+
+
+def color(entry, thing_name='Color', **kwargs):
+    """
+    The color should be just a color character, so 'r' if red color is desired.
+    """
+    if not entry:
+        raise ValueError(f"Nothing entered for a {thing_name}!")
+    test_str = strip_ansi(f'|{entry}|n')
+    if test_str:
+        raise ValueError(f"'{entry}' is not a valid {thing_name}.")
+    return entry
+
+
+def datetime(entry, thing_name='Datetime', account=None, from_tz=None, **kwargs):
+    """
+    Process a datetime string in standard forms while accounting for the inputter's timezone.
+
+    Args:
+        entry (str): A date string from a user.
+        thing_name (str): Name to display this datetime as.
+        account (AccountDB): The Account performing this lookup. Unless from_tz is provided,
+            account's timezone will be used (if found) for local time and convert the results
+            to UTC.
+        from_tz (pytz): An instance of pytz from the user. If not provided, defaults to whatever
+            the Account uses. If neither one is provided, defaults to UTC.
+
+    Returns:
+        datetime in utc.
+    """
+    if not entry:
+        raise ValueError(f"No {thing_name} entered!")
+    if not from_tz:
+        from_tz = _pytz.UTC
+    utc = _pytz.UTC
+    now = _dt.datetime.utcnow().replace(tzinfo=utc)
+    cur_year = now.strftime('%Y')
+    split_time = entry.split(' ')
+    if len(split_time) == 3:
+        entry = f"{split_time[0]} {split_time[1]} {split_time[2]} {cur_year}"
+    elif len(split_time) == 4:
+        entry = f"{split_time[0]} {split_time[1]} {split_time[2]} {split_time[3]}"
+    else:
+        raise ValueError(f"{thing_name} must be entered in a 24-hour format such as: {now.strftime('%b %d %H:%H')}")
+    try:
+        local = _dt.datetime.strptime(input, '%b %d %H:%M %Y')
+    except ValueError:
+        raise ValueError(f"{thing_name} must be entered in a 24-hour format such as: {now.strftime('%b %d %H:%H')}")
+    local_tz = from_tz.localize(local)
+    return local_tz.astimezone(utc)
+
+
+def duration(entry, thing_name='Duration', **kwargs):
+    """
+    Take a string and derive a datetime timedelta from it.
+
+    Args:
+        entry (string): This is a string from user-input. The intended format is, for example: "5d 2w 90s" for
+                            'five days, two weeks, and ninety seconds.' Invalid sections are ignored.
+        thing_name (str): Name to display this query as.
+
+    Returns:
+        timedelta
+
+    """
+    time_string = entry.split(" ")
+    seconds = 0
+    minutes = 0
+    hours = 0
+    days = 0
+    weeks = 0
+
+    for interval in time_string:
+        if _re.match(r'^[\d]+s$', interval.lower()):
+            seconds =+ int(interval.lower().rstrip("s"))
+        elif _re.match(r'^[\d]+m$', interval):
+            minutes =+ int(interval.lower().rstrip("m"))
+        elif _re.match(r'^[\d]+h$', interval):
+            hours =+ int(interval.lower().rstrip("h"))
+        elif _re.match(r'^[\d]+d$', interval):
+            days =+ int(interval.lower().rstrip("d"))
+        elif _re.match(r'^[\d]+w$', interval):
+            weeks =+ int(interval.lower().rstrip("w"))
+        elif _re.match(r'^[\d]+y$', interval):
+            days =+ int(interval.lower().rstrip("y")) * 365
+        else:
+            raise ValueError(f"Could not convert section '{interval}' to a {thing_name}.")
+
+    return _dt.timedelta(days, seconds, 0, 0, minutes, hours, weeks)
+
+
+def future(entry, thing_name="Future Datetime", from_tz=None, **kwargs):
+    time = datetime(entry, thing_name)
+    if time < _dt.datetime.utcnow():
+        raise ValueError(f"That {thing_name} is in the past! Must give a Future datetime!")
+    return time
+
+
+def signed_integer(entry, thing_name="Signed Integer", **kwargs):
+    if not entry:
+        raise ValueError(f"Must enter a whole number for {thing_name}!")
+    try:
+        num = int(entry)
+    except ValueError:
+        raise ValueError(f"Could not convert '{entry}' to a whole number for {thing_name}!")
+    return num
+
+
+def positive_integer(entry, thing_name="Positive Integer", **kwargs):
+    num = signed_integer(entry, thing_name)
+    if not num >= 1:
+        raise ValueError(f"Must enter a whole number greater than 0 for {thing_name}!")
+    return num
+
+
+def unsigned_integer(entry, thing_name="Unsigned Integer", **kwargs):
+    num = signed_integer(entry, thing_name)
+    if not num >= 0:
+        raise ValueError(f"{thing_name} must be a whole number greater than or equal to 0!")
+    return num
+
+
+def boolean(entry, thing_name="True/False", **kwargs):
+    """
+    Simplest check in computer logic, right? This will take user input to flick the switch on or off
+    Args:
+        entry (str): A value such as True, On, Enabled, Disabled, False, 0, or 1.
+        thing_name (str): What kind of Boolean we are setting. What Option is this for?
+
+    Returns:
+        Boolean
+    """
+    entry = entry.upper()
+    error = f"Must enter 0 (false) or 1 (true) for {thing_name}. Also accepts True, False, On, Off, Yes, No, Enabled, and Disabled"
+    if not entry:
+        raise ValueError(error)
+    if entry in ('1', 'TRUE', 'ON', 'ENABLED', 'ENABLE', 'YES'):
+        return True
+    if entry in ('0', 'FALSE', 'OFF', 'DISABLED', 'DISABLE', 'NO'):
+        return False
+    raise ValueError(error)
+
+
+def timezone(entry, thing_name="Timezone", **kwargs):
+    """
+    Takes user input as string, and partial matches a Timezone.
+
+    Args:
+        entry (str): The name of the Timezone.
+        thing_name (str): What this Timezone is used for.
+
+    Returns:
+        A PYTZ timezone.
+    """
+    if not entry:
+        raise ValueError(f"No {thing_name} entered!")
+    found = _partial(list(_TZ_DICT.keys()), entry, ret_index=False)
+    if len(found) > 1:
+        raise ValueError(f"That matched: {', '.join(str(t) for t in found)}. Please be more specific!")
+    if found:
+        return _TZ_DICT[found[0]]
+    raise ValueError(f"Could not find timezone '{entry}' for {thing_name}!")
+
+
+def email(entry, thing_name="Email Address", **kwargs):
+    if not entry:
+        raise ValueError("Email address field empty!")
+    try:
+        _val_email(entry)  # offloading the hard work to Django!
+    except _error:
+        raise ValueError(f"That isn't a valid {thing_name}!")
+    return entry
+
+
+def lock(entry, thing_name='locks', access_options=None, **kwargs):
+    entry = entry.strip()
+    if not entry:
+        raise ValueError(f"No {thing_name} entered to set!")
+    for locksetting in entry.split(';'):
+        access_type, lockfunc = locksetting.split(':', 1)
+        if not access_type:
+            raise ValueError("Must enter an access type!")
+        if access_options:
+            if access_type not in access_options:
+                raise ValueError(f"Access type must be one of: {', '.join(access_options)}")
+        if not lockfunc:
+            raise ValueError("Lock func not entered.")
+    return entry