From 263a3f79d649ea9fc6014eb193e8dfecce0f2754 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sat, 31 Mar 2018 12:40:57 +0200 Subject: [PATCH 001/187] Fix of output handling in msg() when text is None --- evennia/accounts/accounts.py | 16 +++++++++------- evennia/objects/objects.py | 16 +++++++++------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 48d03d8dc8..fe7693cce0 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -421,17 +421,19 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): kwargs["options"] = options - if not (isinstance(text, basestring) or isinstance(text, tuple)): - # sanitize text before sending across the wire - try: - text = to_str(text, force_string=True) - except Exception: - text = repr(text) + if text is not None: + if not (isinstance(text, basestring) or isinstance(text, tuple)): + # sanitize text before sending across the wire + try: + text = to_str(text, force_string=True) + except Exception: + text = repr(text) + kwargs['text'] = text # session relay sessions = make_iter(session) if session else self.sessions.all() for session in sessions: - session.data_out(text=text, **kwargs) + session.data_out(**kwargs) def execute_cmd(self, raw_string, session=None, **kwargs): """ diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index f583570707..8cdf546706 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -535,17 +535,19 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): except Exception: logger.log_trace() - if not (isinstance(text, basestring) or isinstance(text, tuple)): - # sanitize text before sending across the wire - try: - text = to_str(text, force_string=True) - except Exception: - text = repr(text) + if text is not None: + if not (isinstance(text, basestring) or isinstance(text, tuple)): + # sanitize text before sending across the wire + try: + text = to_str(text, force_string=True) + except Exception: + text = repr(text) + kwargs['text'] = text # relay to session(s) sessions = make_iter(session) if session else self.sessions.all() for session in sessions: - session.data_out(text=text, **kwargs) + session.data_out(**kwargs) def for_contents(self, func, exclude=None, **kwargs): From 1cf408e653484506114b935d16583f600d537420 Mon Sep 17 00:00:00 2001 From: CloudKeeper1 Date: Sat, 14 Apr 2018 00:23:52 +1000 Subject: [PATCH 002/187] Wrong symbol on line 499 Wrong symbol on line 499 --- evennia/commands/default/general.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/commands/default/general.py b/evennia/commands/default/general.py index 2f4c51a227..f9634ed675 100644 --- a/evennia/commands/default/general.py +++ b/evennia/commands/default/general.py @@ -496,7 +496,7 @@ class CmdWhisper(COMMAND_DEFAULT_CLASS): Usage: whisper = - whisper , = , = Talk privately to one or more characters in your current location, without others in the room being informed. From 2f1b0de92162b2cf75e519ec815d8abd391f7216 Mon Sep 17 00:00:00 2001 From: Aditya Arora Date: Mon, 16 Apr 2018 18:41:02 +0530 Subject: [PATCH 003/187] Update rpsystem.py --- evennia/contrib/rpsystem.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/evennia/contrib/rpsystem.py b/evennia/contrib/rpsystem.py index a56d2de731..efba0fe7fd 100644 --- a/evennia/contrib/rpsystem.py +++ b/evennia/contrib/rpsystem.py @@ -1088,7 +1088,7 @@ class CmdMask(RPCommand): if self.cmdstring == "mask": # wear a mask if not self.args: - caller.msg("Usage: (un)wearmask sdesc") + caller.msg("Usage: (un)mask sdesc") return if caller.db.unmasked_sdesc: caller.msg("You are already wearing a mask.") @@ -1111,7 +1111,7 @@ class CmdMask(RPCommand): del caller.db.unmasked_sdesc caller.locks.remove("enable_recog") caller.sdesc.add(old_sdesc) - caller.msg("You remove your mask and is again '%s'." % old_sdesc) + caller.msg("You remove your mask and are again '%s'." % old_sdesc) class RPSystemCmdSet(CmdSet): From f9b636676d4be64e3a5141df4c6787f2a21ff848 Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 1 Oct 2018 20:12:24 +0000 Subject: [PATCH 004/187] Extends normalize_username() function to strip excessive spaces. --- evennia/accounts/accounts.py | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 2c33e5c1f8..07fb8f318c 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -10,7 +10,7 @@ character object, so you should customize that instead for most things). """ - +import re import time from django.conf import settings from django.contrib.auth import password_validation @@ -359,6 +359,27 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): puppet = property(__get_single_puppet) # utility methods + @classmethod + def normalize_username(cls, username): + """ + Django: Applies NFKC Unicode normalization to usernames so that visually + identical characters with different Unicode code points are considered + identical. + + (This deals with the Turkish "i" problem and similar + annoyances. Only relevant if you go out of your way to allow Unicode + usernames though-- Evennia accepts ASCII by default.) + + In this case we're simply piggybacking on this feature to apply + additional normalization per Evennia's standards. + """ + username = super(DefaultAccount, cls).normalize_username(username) + + # strip excessive spaces in accountname + username = re.sub(r"\s+", " ", username).strip() + + return username + @classmethod def validate_password(cls, password, account=None): """ From c5b7577021200e8958c932a1f8a6e884f41bbd01 Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 1 Oct 2018 21:24:33 +0000 Subject: [PATCH 005/187] Adds username normalization/validation and authentication methods to Account class. --- evennia/accounts/accounts.py | 110 ++++++++++++++++++++++++++++++++++- evennia/accounts/tests.py | 29 +++++++++ evennia/server/validators.py | 35 +++++++++++ evennia/settings_default.py | 22 +++++++ 4 files changed, 194 insertions(+), 2 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 07fb8f318c..8da9a7ea9b 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -13,9 +13,10 @@ instead for most things). import re import time from django.conf import settings -from django.contrib.auth import password_validation -from django.core.exceptions import ValidationError +from django.contrib.auth import authenticate, password_validation +from django.core.exceptions import ImproperlyConfigured, ValidationError from django.utils import timezone +from django.utils.module_loading import import_string from evennia.typeclasses.models import TypeclassBase from evennia.accounts.manager import AccountManager from evennia.accounts.models import AccountDB @@ -359,6 +360,74 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): puppet = property(__get_single_puppet) # utility methods + @classmethod + def get_username_validators(cls, validator_config=getattr(settings, 'AUTH_USERNAME_VALIDATORS', [])): + """ + Retrieves and instantiates validators for usernames. + + Args: + validator_config (list): List of dicts comprising the battery of + validators to apply to a username. + + Returns: + validators (list): List of instantiated Validator objects. + """ + + objs = [] + for validator in validator_config: + try: + klass = import_string(validator['NAME']) + except ImportError: + msg = "The module in NAME could not be imported: %s. Check your AUTH_USERNAME_VALIDATORS setting." + raise ImproperlyConfigured(msg % validator['NAME']) + objs.append(klass(**validator.get('OPTIONS', {}))) + return objs + + @classmethod + def authenticate(cls, username, password, ip=None): + """ + Checks the given username/password against the database to see if the + credentials are valid. + + Note that this simply checks credentials and returns a valid reference + to the user-- it does not log them in! + + To finish the job: + After calling this from a Command, associate the account with a Session: + - session.sessionhandler.login(session, account) + + ...or after calling this from a View, associate it with an HttpRequest: + - django.contrib.auth.login(account, request) + + Args: + username (str): Username of account + password (str): Password of account + ip (str, optional): IP address of client + + Returns: + account (DefaultAccount, None): Account whose credentials were + provided if not banned. + errors (list): Error messages of any failures. + + """ + errors = [] + if ip: ip = str(ip) + + # Authenticate and get Account object + account = authenticate(username=username, password=password) + if not account: + # User-facing message + errors.append('Username and/or password is incorrect.') + + # System log message + logger.log_sec('Authentication Failure: %s (IP: %s).' % (username, ip)) + + return None, errors + + # Account successfully authenticated + logger.log_sec('Authentication Success: %s (IP: %s).' % (account, ip)) + return account, errors + @classmethod def normalize_username(cls, username): """ @@ -379,6 +448,43 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): username = re.sub(r"\s+", " ", username).strip() return username + + @classmethod + def validate_username(cls, username): + """ + Checks the given username against the username validator associated with + Account objects, and also checks the database to make sure it is unique. + + Args: + username (str): Username to validate + + Returns: + valid (bool): Whether or not the password passed validation + errors (list): Error messages of any failures + + """ + valid = [] + errors = [] + + # Make sure we're at least using the default validator + validators = cls.get_username_validators() + if not validators: + validators = [cls.username_validator] + + # Try username against all enabled validators + for validator in validators: + try: + valid.append(not validator(username)) + except ValidationError as e: + valid.append(False) + [errors.append(x) for x in e.messages] + + # Disqualify if any check failed + if False in valid: + valid = False + else: valid = True + + return valid, errors @classmethod def validate_password(cls, password, account=None): diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index 2855dd0ca2..f1a9f16c28 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -1,3 +1,5 @@ +# -*- coding: utf-8 -*- + from mock import Mock from random import randint from unittest import TestCase @@ -59,6 +61,33 @@ class TestDefaultAccount(TestCase): self.s1 = Session() self.s1.puppet = None self.s1.sessid = 0 + + self.password = "testpassword" + self.account = create.create_account("TestAccount%s" % randint(100000, 999999), email="test@test.com", password=self.password, typeclass=DefaultAccount) + + def test_authentication(self): + "Confirm Account authentication method is authenticating/denying users." + # Valid credentials + obj, errors = DefaultAccount.authenticate(self.account.name, self.password) + self.assertTrue(obj, 'Account did not authenticate given valid credentials.') + + # Invalid credentials + obj, errors = DefaultAccount.authenticate(self.account.name, 'xyzzy') + self.assertFalse(obj, 'Account authenticated using invalid credentials.') + + def test_username_validation(self): + "Check username validators deny relevant usernames" + # Should not accept Unicode by default, lest users pick names like this + result, error = DefaultAccount.validate_username('¯\_(ツ)_/¯') + self.assertFalse(result, "Validator allowed kanji in username.") + + # Should not allow duplicate username + result, error = DefaultAccount.validate_username(self.account.name) + self.assertFalse(result, "Duplicate username should not have passed validation.") + + # Should not allow username too short + result, error = DefaultAccount.validate_username('xx') + self.assertFalse(result, "2-character username passed validation.") def test_password_validation(self): "Check password validators deny bad passwords" diff --git a/evennia/server/validators.py b/evennia/server/validators.py index b10f990a8a..bccbde6b51 100644 --- a/evennia/server/validators.py +++ b/evennia/server/validators.py @@ -1,7 +1,42 @@ +from django.conf import settings from django.core.exceptions import ValidationError from django.utils.translation import gettext as _ +from evennia.accounts.models import AccountDB import re +class EvenniaUsernameAvailabilityValidator: + """ + Checks to make sure a given username is not taken or otherwise reserved. + """ + + def __call__(self, username): + """ + Validates a username to make sure it is not in use or reserved. + + Args: + username (str): Username to validate + + Returns: + None (None): None if password successfully validated, + raises ValidationError otherwise. + + """ + + # Check guest list + if settings.GUEST_LIST and username.lower() in (guest.lower() for guest in settings.GUEST_LIST): + raise ValidationError( + _('Sorry, that username is reserved.'), + code='evennia_username_reserved', + ) + + # Check database + exists = AccountDB.objects.filter(username__iexact=username).exists() + if exists: + raise ValidationError( + _('Sorry, that username is already taken.'), + code='evennia_username_taken', + ) + class EvenniaPasswordValidator: def __init__(self, regex=r"^[\w. @+\-',]+$", policy="Password should contain a mix of letters, spaces, digits and @/./+/-/_/'/, only."): diff --git a/evennia/settings_default.py b/evennia/settings_default.py index 9efbb6314b..04c928ac99 100644 --- a/evennia/settings_default.py +++ b/evennia/settings_default.py @@ -809,6 +809,28 @@ AUTH_PASSWORD_VALIDATORS = [ {'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator'}, {'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator'}, {'NAME': 'evennia.server.validators.EvenniaPasswordValidator'}] + +# Username validation plugins +AUTH_USERNAME_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.validators.ASCIIUsernameValidator', + }, + { + 'NAME': 'django.core.validators.MinLengthValidator', + 'OPTIONS': { + 'limit_value': 3, + } + }, + { + 'NAME': 'django.core.validators.MaxLengthValidator', + 'OPTIONS': { + 'limit_value': 30, + } + }, + { + 'NAME': 'evennia.server.validators.EvenniaUsernameAvailabilityValidator', + }, +] # Use a custom test runner that just tests Evennia-specific apps. TEST_RUNNER = 'evennia.server.tests.EvenniaTestSuiteRunner' From bce4d3cb4200c2bfac6ef980f7d98bee3829c8b2 Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 1 Oct 2018 23:58:12 +0000 Subject: [PATCH 006/187] Moves LOGIN and CREATION throttles from Command module to Account module. --- evennia/accounts/accounts.py | 20 ++++++++++++++++++-- evennia/commands/default/unloggedin.py | 10 ++++------ 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 8da9a7ea9b..1ce0f4d9f9 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -23,6 +23,7 @@ from evennia.accounts.models import AccountDB from evennia.objects.models import ObjectDB from evennia.comms.models import ChannelDB from evennia.commands import cmdhandler +from evennia.server.throttle import Throttle from evennia.utils import logger from evennia.utils.utils import (lazy_property, to_str, make_iter, to_unicode, is_iter, @@ -44,6 +45,9 @@ _MAX_NR_CHARACTERS = settings.MAX_NR_CHARACTERS _CMDSET_ACCOUNT = settings.CMDSET_ACCOUNT _CONNECT_CHANNEL = None +# Create throttles for too many account-creations and login attempts +CREATION_THROTTLE = Throttle(limit=2, timeout=10 * 60) +LOGIN_THROTTLE = Throttle(limit=5, timeout=5 * 60) class AccountSessionHandler(object): """ @@ -413,15 +417,27 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): errors = [] if ip: ip = str(ip) + # See if authentication is currently being throttled + if ip and LOGIN_THROTTLE.check(ip): + errors.append('Too many login failures; please try again in a few minutes.') + + # With throttle active, do not log continued hits-- it is a + # waste of storage and can be abused to make your logs harder to + # read and fill up your disk. + return None, errors + # Authenticate and get Account object account = authenticate(username=username, password=password) if not account: # User-facing message errors.append('Username and/or password is incorrect.') - # System log message + # Log auth failures while throttle is inactive logger.log_sec('Authentication Failure: %s (IP: %s).' % (username, ip)) + # Update throttle + if ip: LOGIN_THROTTLE.update(ip) + return None, errors # Account successfully authenticated @@ -543,7 +559,7 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): if error: raise error super(DefaultAccount, self).set_password(password) - logger.log_info("Password succesfully changed for %s." % self) + logger.log_sec("Password successfully changed for %s." % self) self.at_password_change() def delete(self, *args, **kwargs): diff --git a/evennia/commands/default/unloggedin.py b/evennia/commands/default/unloggedin.py index 8ae700e2c1..d77d7ee2b9 100644 --- a/evennia/commands/default/unloggedin.py +++ b/evennia/commands/default/unloggedin.py @@ -7,12 +7,13 @@ import datetime from random import getrandbits from django.conf import settings from django.contrib.auth import authenticate +from evennia.accounts.accounts import CREATION_THROTTLE, LOGIN_THROTTLE from evennia.accounts.models import AccountDB from evennia.objects.models import ObjectDB -from evennia.server.models import ServerConfig -from evennia.server.throttle import Throttle from evennia.comms.models import ChannelDB +from evennia.server.models import ServerConfig from evennia.server.sessionhandler import SESSIONS +from evennia.server.throttle import Throttle from evennia.utils import create, logger, utils, gametime from evennia.commands.cmdhandler import CMD_LOGINSTART @@ -26,11 +27,8 @@ __all__ = ("CmdUnconnectedConnect", "CmdUnconnectedCreate", MULTISESSION_MODE = settings.MULTISESSION_MODE CONNECTION_SCREEN_MODULE = settings.CONNECTION_SCREEN_MODULE -# Create throttles for too many connections, account-creations and login attempts +# Create throttles for too many connections CONNECTION_THROTTLE = Throttle(limit=5, timeout=1 * 60) -CREATION_THROTTLE = Throttle(limit=2, timeout=10 * 60) -LOGIN_THROTTLE = Throttle(limit=5, timeout=5 * 60) - def create_guest_account(session): """ From 1fe44704f709cf2801bbb18d3f9067001e34c0bf Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 2 Oct 2018 00:05:07 +0000 Subject: [PATCH 007/187] Adds logging of throttle activation and customizable message upon update. --- evennia/accounts/accounts.py | 2 +- evennia/server/throttle.py | 17 +++++++++++++++-- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 1ce0f4d9f9..a6a29fab72 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -436,7 +436,7 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): logger.log_sec('Authentication Failure: %s (IP: %s).' % (username, ip)) # Update throttle - if ip: LOGIN_THROTTLE.update(ip) + if ip: LOGIN_THROTTLE.update(ip, 'Too many authentication failures') return None, errors diff --git a/evennia/server/throttle.py b/evennia/server/throttle.py index 56c88c63f2..944b7f880e 100644 --- a/evennia/server/throttle.py +++ b/evennia/server/throttle.py @@ -1,4 +1,5 @@ from collections import defaultdict, deque +from evennia.utils import logger import time class Throttle(object): @@ -50,22 +51,34 @@ class Throttle(object): if ip: return self.storage.get(ip, deque(maxlen=self.cache_size)) else: return self.storage - def update(self, ip): + def update(self, ip, failmsg='Exceeded threshold.'): """ - Store the time of the latest failure/ + Store the time of the latest failure. Args: ip (str): IP address of requestor + failmsg (str, optional): Message to display in logs upon activation + of throttle. Returns: None """ + # Get current status + previously_throttled = self.check(ip) + # Enforce length limits if not self.storage[ip].maxlen: self.storage[ip] = deque(maxlen=self.cache_size) self.storage[ip].append(time.time()) + + # See if this update caused a change in status + currently_throttled = self.check(ip) + + # If this makes it engage, log a single activation event + if (not previously_throttled and currently_throttled): + logger.log_sec('Throttle Activated: %s (IP: %s, %i hits in %i seconds.)' % (failmsg, ip, self.limit, self.timeout)) def check(self, ip): """ From d570be49be3fa12733510c8e0df719c19e47dbf8 Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 2 Oct 2018 20:23:23 +0000 Subject: [PATCH 008/187] Moves account creation logic from Commands module to Account class. --- evennia/accounts/accounts.py | 269 ++++++++++++++++++++++++- evennia/accounts/tests.py | 37 +++- evennia/commands/default/unloggedin.py | 222 +++++--------------- evennia/server/validators.py | 2 +- 4 files changed, 354 insertions(+), 176 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index a6a29fab72..6bd812b6fa 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -23,8 +23,9 @@ from evennia.accounts.models import AccountDB from evennia.objects.models import ObjectDB from evennia.comms.models import ChannelDB from evennia.commands import cmdhandler +from evennia.server.models import ServerConfig from evennia.server.throttle import Throttle -from evennia.utils import logger +from evennia.utils import create, logger from evennia.utils.utils import (lazy_property, to_str, make_iter, to_unicode, is_iter, variable_from_module) @@ -34,6 +35,7 @@ from evennia.commands.cmdsethandler import CmdSetHandler from django.utils.translation import ugettext as _ from future.utils import with_metaclass +from random import getrandbits __all__ = ("DefaultAccount",) @@ -364,6 +366,31 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): puppet = property(__get_single_puppet) # utility methods + @classmethod + def is_banned(cls, **kwargs): + """ + Checks if a given username or IP is banned. + + Kwargs: + ip (str, optional): IP address. + username (str, optional): Username. + + Returns: + is_banned (bool): Whether either is banned or not. + + """ + + ip = kwargs.get('ip', '').strip() + username = kwargs.get('username', '').lower().strip() + + # Check IP and/or name bans + bans = ServerConfig.objects.conf("server_bans") + if bans and (any(tup[0] == username for tup in bans if username) or + any(tup[2].match(ip) for tup in bans if ip and tup[2])): + return True + + return False + @classmethod def get_username_validators(cls, validator_config=getattr(settings, 'AUTH_USERNAME_VALIDATORS', [])): """ @@ -386,9 +413,85 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): raise ImproperlyConfigured(msg % validator['NAME']) objs.append(klass(**validator.get('OPTIONS', {}))) return objs + + @classmethod + def authenticate_guest(cls, **kwargs): + """ + Gets or creates a Guest account object. + + Kwargs: + ip (str, optional): IP address of requestor; used for ban checking, + throttling and logging + + """ + errors = [] + account = None + username = None + ip = kwargs.get('ip', '').strip() + + # check if guests are enabled. + if not settings.GUEST_ENABLED: + errors.append('Guest accounts are not enabled on this server.') + return None, errors + + # See if authentication is currently being throttled + if ip and LOGIN_THROTTLE.check(ip): + errors.append('Too many login failures; please try again in a few minutes.') + + # With throttle active, do not log continued hits-- it is a + # waste of storage and can be abused to make your logs harder to + # read and/or fill up your disk. + return None, errors + + # check if IP banned + if ip and cls.is_banned(ip=ip): + errors.append("|rYou have been banned and cannot continue from here." \ + "\nIf you feel this ban is in error, please email an admin.|x") + logger.log_sec('Authentication Denied (Banned): %s (IP: %s).' % ('guest', ip)) + LOGIN_THROTTLE.update(ip, 'Too many sightings of banned IP.') + return None, errors + + try: + # Find an available guest name. + for name in settings.GUEST_LIST: + if not AccountDB.objects.filter(username__iexact=name).count(): + username = name + break + if not username: + errors.append("All guest accounts are in use. Please try again later.") + if ip: LOGIN_THROTTLE.update(ip, 'Too many requests for Guest access.') + return None, errors + else: + # build a new account with the found guest username + password = "%016x" % getrandbits(64) + home = ObjectDB.objects.get_id(settings.GUEST_HOME) + permissions = settings.PERMISSION_GUEST_DEFAULT + character_typeclass = settings.BASE_CHARACTER_TYPECLASS + account_typeclass = settings.BASE_GUEST_TYPECLASS + account, errs = cls.create( + guest=True, + username=username, + password=password, + permissions=permissions, + account_typeclass=account_typeclass, + character_typeclass=character_typeclass, + ip=ip, + ) + errors.extend(errs) + return account, errors + + except Exception: + # We are in the middle between logged in and -not, so we have + # to handle tracebacks ourselves at this point. If we don't, + # we won't see any errors at all. + errors.append("An error occurred. Please e-mail an admin if the problem persists.") + logger.log_trace() + return None, errors + + return account, errors @classmethod - def authenticate(cls, username, password, ip=None): + def authenticate(cls, username, password, ip='', **kwargs): """ Checks the given username/password against the database to see if the credentials are valid. @@ -408,6 +511,9 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): password (str): Password of account ip (str, optional): IP address of client + Kwargs: + session (Session, optional): Session requesting authentication + Returns: account (DefaultAccount, None): Account whose credentials were provided if not banned. @@ -423,7 +529,17 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): # With throttle active, do not log continued hits-- it is a # waste of storage and can be abused to make your logs harder to - # read and fill up your disk. + # read and/or fill up your disk. + return None, errors + + # Check IP and/or name bans + banned = cls.is_banned(username=username, ip=ip) + if banned: + # this is a banned IP or name! + errors.append("|rYou have been banned and cannot continue from here." \ + "\nIf you feel this ban is in error, please email an admin.|x") + logger.log_sec('Authentication Denied (Banned): %s (IP: %s).' % (username, ip)) + LOGIN_THROTTLE.update(ip, 'Too many sightings of banned artifact.') return None, errors # Authenticate and get Account object @@ -436,7 +552,14 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): logger.log_sec('Authentication Failure: %s (IP: %s).' % (username, ip)) # Update throttle - if ip: LOGIN_THROTTLE.update(ip, 'Too many authentication failures') + if ip: LOGIN_THROTTLE.update(ip, 'Too many authentication failures.') + + # Try to call post-failure hook + session = kwargs.get('session', None) + if session: + account = AccountDB.objects.get_account_from_name(username) + if account: + account.at_failed_login(session) return None, errors @@ -493,7 +616,7 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): valid.append(not validator(username)) except ValidationError as e: valid.append(False) - [errors.append(x) for x in e.messages] + errors.extend(e.messages) # Disqualify if any check failed if False in valid: @@ -561,6 +684,142 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): super(DefaultAccount, self).set_password(password) logger.log_sec("Password successfully changed for %s." % self) self.at_password_change() + + @classmethod + def create(cls, *args, **kwargs): + """ + Creates an Account (or Account/Character pair for MM<2) with default + (or overridden) permissions and having joined them to the appropriate + default channels. + + Kwargs: + username (str): Username of Account owner + password (str): Password of Account owner + email (str, optional): Email address of Account owner + ip (str, optional): IP address of requesting connection + guest (bool, optional): Whether or not this is to be a Guest account + + permissions (str, optional): Default permissions for the Account + account_typeclass (str, optional): Typeclass to use for new Account + character_typeclass (str, optional): Typeclass to use for new char + when applicable. + + Returns: + account (Account): Account if successfully created; None if not + errors (list): List of error messages in string form + + """ + + account = None + errors = [] + + username = kwargs.get('username') + password = kwargs.get('password') + email = kwargs.get('email', '').strip() + guest = kwargs.get('guest', False) + + permissions = kwargs.get('permissions', settings.PERMISSION_ACCOUNT_DEFAULT) + account_typeclass = kwargs.get('account_typeclass', settings.BASE_ACCOUNT_TYPECLASS) + character_typeclass = kwargs.get('character_typeclass', settings.BASE_CHARACTER_TYPECLASS) + + ip = kwargs.get('ip', '') + if ip and CREATION_THROTTLE.check(ip): + errors.append("You are creating too many accounts. Please log into an existing account.") + return None, errors + + # Normalize username + username = cls.normalize_username(username) + + # Validate username + if not guest: + valid, errs = cls.validate_username(username) + if not valid: + # this echoes the restrictions made by django's auth + # module (except not allowing spaces, for convenience of + # logging in). + errors.extend(errs) + return None, errors + + # Validate password + # Have to create a dummy Account object to check username similarity + valid, errs = cls.validate_password(password, account=cls(username=username)) + if not valid: + errors.extend(errs) + return None, errors + + # Check IP and/or name bans + banned = cls.is_banned(username=username, ip=ip) + if banned: + # this is a banned IP or name! + string = "|rYou have been banned and cannot continue from here." \ + "\nIf you feel this ban is in error, please email an admin.|x" + errors.append(string) + return None, errors + + # everything's ok. Create the new account account. + try: + try: + account = create.create_account(username, email, password, permissions=permissions, typeclass=account_typeclass) + logger.log_sec('Account Created: %s (IP: %s).' % (account, ip)) + + except Exception as e: + errors.append("There was an error creating the Account. If this problem persists, contact an admin.") + logger.log_trace() + return None, errors + + # This needs to be set so the engine knows this account is + # logging in for the first time. (so it knows to call the right + # hooks during login later) + account.db.FIRST_LOGIN = True + + # Record IP address of creation, if available + if ip: account.db.creator_ip = ip + + # join the new account to the public channel + pchannel = ChannelDB.objects.get_channel(settings.DEFAULT_CHANNELS[0]["key"]) + if not pchannel or not pchannel.connect(account): + string = "New account '%s' could not connect to public channel!" % account.key + errors.append(string) + logger.log_err(string) + + if account: + if settings.MULTISESSION_MODE < 2: + default_home = ObjectDB.objects.get_id(settings.DEFAULT_HOME) + + try: + character = create.create_object(character_typeclass, key=account.key, home=default_home, permissions=permissions) + + # set playable character list + account.db._playable_characters.append(character) + + # allow only the character itself and the account to puppet this character (and Developers). + character.locks.add("puppet:id(%i) or pid(%i) or perm(Developer) or pperm(Developer)" % + (character.id, account.id)) + + # If no description is set, set a default description + if not character.db.desc: + character.db.desc = "This is a character." + # We need to set this to have @ic auto-connect to this character + account.db._last_puppet = character + + # Record creator id and creation IP + if ip: character.db.creator_ip = ip + character.db.creator_id = account.id + + except Exception as e: + errors.append("There was an error creating a Character. If this problem persists, contact an admin.") + logger.log_trace() + + except Exception: + # We are in the middle between logged in and -not, so we have + # to handle tracebacks ourselves at this point. If we don't, + # we won't see any errors at all. + errors.append("An error occurred. Please e-mail an admin if the problem persists.") + logger.log_trace() + + # Update the throttle to indicate a new account was created from this IP + if ip and not guest: CREATION_THROTTLE.update(ip, 'Too many accounts being created.') + return account, errors def delete(self, *args, **kwargs): """ diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index f1a9f16c28..72f13bbb3a 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -75,6 +75,41 @@ class TestDefaultAccount(TestCase): obj, errors = DefaultAccount.authenticate(self.account.name, 'xyzzy') self.assertFalse(obj, 'Account authenticated using invalid credentials.') + def test_create(self): + "Confirm Account creation is working as expected." + # Create a normal account + account, errors = DefaultAccount.create(username='ziggy', password='stardust11') + self.assertTrue(account, 'New account should have been created.') + + # Try creating a duplicate account + account, errors = DefaultAccount.create(username='Ziggy', password='starman11') + self.assertFalse(account, 'Duplicate account name should not have been allowed.') + + # Guest account should not be permitted + account, errors = DefaultAccount.authenticate_guest() + self.assertFalse(account, 'Guest account was created despite being disabled.') + + settings.GUEST_ENABLED = True + settings.GUEST_LIST = ['bruce_wayne'] + + # Create a guest account + account, errors = DefaultAccount.authenticate_guest() + self.assertTrue(account, 'Guest account should have been created.') + + # Create a second guest account + account, errors = DefaultAccount.authenticate_guest() + self.assertFalse(account, 'Two guest accounts were created despite a single entry on the guest list!') + + settings.GUEST_ENABLED = False + + def test_throttle(self): + "Confirm throttle activates on too many failures." + for x in xrange(20): + obj, errors = DefaultAccount.authenticate(self.account.name, 'xyzzy', ip='12.24.36.48') + self.assertFalse(obj, 'Authentication was provided a bogus password; this should NOT have returned an account!') + + self.assertTrue('too many login failures' in errors[-1].lower(), 'Failed logins should have been throttled.') + def test_username_validation(self): "Check username validators deny relevant usernames" # Should not accept Unicode by default, lest users pick names like this @@ -92,7 +127,7 @@ class TestDefaultAccount(TestCase): def test_password_validation(self): "Check password validators deny bad passwords" - self.account = create.create_account("TestAccount%s" % randint(0, 9), + self.account = create.create_account("TestAccount%s" % randint(100000, 999999), email="test@test.com", password="testpassword", typeclass=DefaultAccount) for bad in ('', '123', 'password', 'TestAccount', '#', 'xyzzy'): self.assertFalse(self.account.validate_password(bad, account=self.account)[0]) diff --git a/evennia/commands/default/unloggedin.py b/evennia/commands/default/unloggedin.py index d77d7ee2b9..7cf8b40c88 100644 --- a/evennia/commands/default/unloggedin.py +++ b/evennia/commands/default/unloggedin.py @@ -4,10 +4,9 @@ Commands that are available from the connect screen. import re import time import datetime -from random import getrandbits + from django.conf import settings from django.contrib.auth import authenticate -from evennia.accounts.accounts import CREATION_THROTTLE, LOGIN_THROTTLE from evennia.accounts.models import AccountDB from evennia.objects.models import ObjectDB from evennia.comms.models import ChannelDB @@ -15,7 +14,7 @@ from evennia.server.models import ServerConfig from evennia.server.sessionhandler import SESSIONS from evennia.server.throttle import Throttle -from evennia.utils import create, logger, utils, gametime +from evennia.utils import class_from_module, create, logger, utils, gametime from evennia.commands.cmdhandler import CMD_LOGINSTART COMMAND_DEFAULT_CLASS = utils.class_from_module(settings.COMMAND_DEFAULT_CLASS) @@ -27,9 +26,6 @@ __all__ = ("CmdUnconnectedConnect", "CmdUnconnectedCreate", MULTISESSION_MODE = settings.MULTISESSION_MODE CONNECTION_SCREEN_MODULE = settings.CONNECTION_SCREEN_MODULE -# Create throttles for too many connections -CONNECTION_THROTTLE = Throttle(limit=5, timeout=1 * 60) - def create_guest_account(session): """ Creates a guest account/character for this session, if one is available. @@ -42,50 +38,20 @@ def create_guest_account(session): the boolean is whether guest accounts are enabled at all. the Account which was created from an available guest name. """ - # check if guests are enabled. - if not settings.GUEST_ENABLED: - return False, None - - # Check IP bans. - bans = ServerConfig.objects.conf("server_bans") - if bans and any(tup[2].match(session.address) for tup in bans if tup[2]): - # this is a banned IP! - string = "|rYou have been banned and cannot continue from here." \ - "\nIf you feel this ban is in error, please email an admin.|x" - session.msg(string) - session.sessionhandler.disconnect(session, "Good bye! Disconnecting.") - return True, None - - try: - # Find an available guest name. - accountname = None - for name in settings.GUEST_LIST: - if not AccountDB.objects.filter(username__iexact=accountname).count(): - accountname = name - break - if not accountname: - session.msg("All guest accounts are in use. Please try again later.") - return True, None - else: - # build a new account with the found guest accountname - password = "%016x" % getrandbits(64) - home = ObjectDB.objects.get_id(settings.GUEST_HOME) - permissions = settings.PERMISSION_GUEST_DEFAULT - typeclass = settings.BASE_CHARACTER_TYPECLASS - ptypeclass = settings.BASE_GUEST_TYPECLASS - new_account = _create_account(session, accountname, password, permissions, ptypeclass) - if new_account: - _create_character(session, new_account, typeclass, home, permissions) - return True, new_account - - except Exception: - # We are in the middle between logged in and -not, so we have - # to handle tracebacks ourselves at this point. If we don't, - # we won't see any errors at all. - session.msg("An error occurred. Please e-mail an admin if the problem persists.") - logger.log_trace() - raise - + enabled = settings.GUEST_ENABLED + address = session.address + + # Get account class + Account = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) + + # Get an available guest account + # authenticate_guest() handles its own throttling + account, errors = Account.authenticate_guest(ip=address) + if account: + return enabled, account + else: + session.msg("|R%s|n" % '\n'.join(errors)) + return enabled, None def create_normal_account(session, name, password): """ @@ -99,38 +65,17 @@ def create_normal_account(session, name, password): Returns: account (Account): the account which was created from the name and password. """ - # check for too many login errors too quick. + # Get account class + Account = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) + address = session.address - if isinstance(address, tuple): - address = address[0] - - if LOGIN_THROTTLE.check(address): - session.msg("|RYou made too many connection attempts. Try again in a few minutes.|n") - return None - + # Match account name and check password - account = authenticate(username=name, password=password) - + # authenticate() handles all its own throttling + account, errors = Account.authenticate(username=name, password=password, ip=address, session=session) if not account: # No accountname or password match - session.msg("Incorrect login information given.") - # this just updates the throttle - LOGIN_THROTTLE.update(address) - # calls account hook for a failed login if possible. - account = AccountDB.objects.get_account_from_name(name) - if account: - account.at_failed_login(session) - return None - - # Check IP and/or name bans - bans = ServerConfig.objects.conf("server_bans") - if bans and (any(tup[0] == account.name.lower() for tup in bans) or - any(tup[2].match(session.address) for tup in bans if tup[2])): - # this is a banned IP or name! - string = "|rYou have been banned and cannot continue from here." \ - "\nIf you feel this ban is in error, please email an admin.|x" - session.msg(string) - session.sessionhandler.disconnect(session, "Good bye! Disconnecting.") + session.msg("|R%s|n" % '\n'.join(errors)) return None return account @@ -162,15 +107,10 @@ class CmdUnconnectedConnect(COMMAND_DEFAULT_CLASS): there is no object yet before the account has logged in) """ session = self.caller - - # check for too many login errors too quick. address = session.address - if isinstance(address, tuple): - address = address[0] - if CONNECTION_THROTTLE.check(address): - # timeout is 5 minutes. - session.msg("|RYou made too many connection attempts. Try again in a few minutes.|n") - return + + # Get account class + Account = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) args = self.args # extract double quote parts @@ -178,23 +118,27 @@ class CmdUnconnectedConnect(COMMAND_DEFAULT_CLASS): if len(parts) == 1: # this was (hopefully) due to no double quotes being found, or a guest login parts = parts[0].split(None, 1) + # Guest login if len(parts) == 1 and parts[0].lower() == "guest": - enabled, new_account = create_guest_account(session) - if new_account: - session.sessionhandler.login(session, new_account) - if enabled: + account, errors = Account.authenticate_guest(ip=address) + if account: + session.sessionhandler.login(session, account) return - + else: + session.msg("|R%s|n" % '\n'.join(errors)) + return + if len(parts) != 2: session.msg("\n\r Usage (without <>): connect ") return - CONNECTION_THROTTLE.update(address) name, password = parts - account = create_normal_account(session, name, password) + account, errors = Account.authenticate(username=name, password=password, ip=address, session=session) if account: session.sessionhandler.login(session, account) + else: + session.msg("|R%s|n" % '\n'.join(errors)) class CmdUnconnectedCreate(COMMAND_DEFAULT_CLASS): @@ -220,14 +164,10 @@ class CmdUnconnectedCreate(COMMAND_DEFAULT_CLASS): session = self.caller args = self.args.strip() - # Rate-limit account creation. address = session.address - - if isinstance(address, tuple): - address = address[0] - if CREATION_THROTTLE.check(address): - session.msg("|RYou are creating too many accounts. Try again in a few minutes.|n") - return + + # Get account class + Account = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) # extract double quoted parts parts = [part.strip() for part in re.split(r"\"", args) if part.strip()] @@ -239,77 +179,21 @@ class CmdUnconnectedCreate(COMMAND_DEFAULT_CLASS): "\nIf or contains spaces, enclose it in double quotes." session.msg(string) return - accountname, password = parts - - # sanity checks - if not re.findall(r"^[\w. @+\-']+$", accountname) or not (0 < len(accountname) <= 30): - # this echoes the restrictions made by django's auth - # module (except not allowing spaces, for convenience of - # logging in). - string = "\n\r Accountname can max be 30 characters or fewer. Letters, spaces, digits and @/./+/-/_/' only." - session.msg(string) - return - # strip excessive spaces in accountname - accountname = re.sub(r"\s+", " ", accountname).strip() - if AccountDB.objects.filter(username__iexact=accountname): - # account already exists (we also ignore capitalization here) - session.msg("Sorry, there is already an account with the name '%s'." % accountname) - return - # Reserve accountnames found in GUEST_LIST - if settings.GUEST_LIST and accountname.lower() in (guest.lower() for guest in settings.GUEST_LIST): - string = "\n\r That name is reserved. Please choose another Accountname." - session.msg(string) - return - - # Validate password - Account = utils.class_from_module(settings.BASE_ACCOUNT_TYPECLASS) - # Have to create a dummy Account object to check username similarity - valid, error = Account.validate_password(password, account=Account(username=accountname)) - if error: - errors = [e for suberror in error.messages for e in error.messages] - string = "\n".join(errors) - session.msg(string) - return - - # Check IP and/or name bans - bans = ServerConfig.objects.conf("server_bans") - if bans and (any(tup[0] == accountname.lower() for tup in bans) or - - any(tup[2].match(session.address) for tup in bans if tup[2])): - # this is a banned IP or name! - string = "|rYou have been banned and cannot continue from here." \ - "\nIf you feel this ban is in error, please email an admin.|x" - session.msg(string) - session.sessionhandler.disconnect(session, "Good bye! Disconnecting.") - return + + username, password = parts # everything's ok. Create the new account account. - try: - permissions = settings.PERMISSION_ACCOUNT_DEFAULT - typeclass = settings.BASE_CHARACTER_TYPECLASS - new_account = _create_account(session, accountname, password, permissions) - if new_account: - if MULTISESSION_MODE < 2: - default_home = ObjectDB.objects.get_id(settings.DEFAULT_HOME) - _create_character(session, new_account, typeclass, default_home, permissions) - - # Update the throttle to indicate a new account was created from this IP - CREATION_THROTTLE.update(address) - - # tell the caller everything went well. - string = "A new account '%s' was created. Welcome!" - if " " in accountname: - string += "\n\nYou can now log in with the command 'connect \"%s\" '." - else: - string += "\n\nYou can now log with the command 'connect %s '." - session.msg(string % (accountname, accountname)) - - except Exception: - # We are in the middle between logged in and -not, so we have - # to handle tracebacks ourselves at this point. If we don't, - # we won't see any errors at all. - session.msg("An error occurred. Please e-mail an admin if the problem persists.") - logger.log_trace() + account, errors = Account.create(username=username, password=password, ip=address, session=session) + if account: + # tell the caller everything went well. + string = "A new account '%s' was created. Welcome!" + if " " in username: + string += "\n\nYou can now log in with the command 'connect \"%s\" '." + else: + string += "\n\nYou can now log with the command 'connect %s '." + session.msg(string % (username, username)) + else: + session.msg("|R%s|n" % '\n'.join(errors)) class CmdUnconnectedQuit(COMMAND_DEFAULT_CLASS): diff --git a/evennia/server/validators.py b/evennia/server/validators.py index bccbde6b51..fdadeda6e3 100644 --- a/evennia/server/validators.py +++ b/evennia/server/validators.py @@ -23,7 +23,7 @@ class EvenniaUsernameAvailabilityValidator: """ # Check guest list - if settings.GUEST_LIST and username.lower() in (guest.lower() for guest in settings.GUEST_LIST): + if (settings.GUEST_LIST and username.lower() in (guest.lower() for guest in settings.GUEST_LIST)): raise ValidationError( _('Sorry, that username is reserved.'), code='evennia_username_reserved', From 10c86f81c08b1ac590e247c3166cf3d374bda6c4 Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 4 Oct 2018 00:08:23 +0000 Subject: [PATCH 009/187] Updates Bootstrap to v4 stable. --- evennia/web/website/templates/website/base.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/evennia/web/website/templates/website/base.html b/evennia/web/website/templates/website/base.html index a2172b308f..556aad0306 100644 --- a/evennia/web/website/templates/website/base.html +++ b/evennia/web/website/templates/website/base.html @@ -12,7 +12,7 @@ - + @@ -56,7 +56,7 @@ - - + + From eb1d89d953bacc293bc3bbdd3ecb25490a7ed34b Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 4 Oct 2018 00:32:38 +0000 Subject: [PATCH 010/187] Adds template tag to override body. --- evennia/web/website/templates/website/base.html | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/evennia/web/website/templates/website/base.html b/evennia/web/website/templates/website/base.html index 556aad0306..2004425849 100644 --- a/evennia/web/website/templates/website/base.html +++ b/evennia/web/website/templates/website/base.html @@ -29,6 +29,8 @@ {{game_name}} - {% if flatpage %}{{flatpage.title}}{% else %}{% block titleblock %}{{page_title}}{% endblock %}{% endif %} + {% block body %} + {% include "website/_menu.html" %}
@@ -53,6 +55,8 @@
{% endblock %} + + {% endblock %} From cc2b9f22aa5e67780574fa5c2f1743e273478c3a Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 4 Oct 2018 00:33:32 +0000 Subject: [PATCH 011/187] Fixes failure to display error messages and display form as standalone. --- .../templates/website/registration/login.html | 73 ++++++++++--------- 1 file changed, 39 insertions(+), 34 deletions(-) diff --git a/evennia/web/website/templates/website/registration/login.html b/evennia/web/website/templates/website/registration/login.html index 8b2213a251..2aa32d5cff 100644 --- a/evennia/web/website/templates/website/registration/login.html +++ b/evennia/web/website/templates/website/registration/login.html @@ -4,44 +4,49 @@ Login {% endblock %} -{% block content %} +{% block body %} {% load addclass %} - -
-
-
-
-

Login

-
- {% if user.is_authenticated %} -

You are already logged in!

- {% else %} - {% if form.has_errors %} -

Your username and password didn't match. Please try again.

- {% endif %} - -
- {% csrf_token %} - -
- - {{ form.username | addclass:"form-control" }} -
- -
- - {{ form.password | addclass:"form-control" }} -
- -
- - -
-
+
+
+
+
+
+

Login

+
+ {% if user.is_authenticated %} + + {% else %} + {% if form.errors %} + + {% endif %} + {% endif %} + + {% if not user.is_authenticated %} +
+ {% csrf_token %} + +
+ + {{ form.username | addclass:"form-control" }} +
+ +
+ + {{ form.password | addclass:"form-control" }} +
+ +
+
+ + +
+
+ + {% endif %} +
-{% endif %} {% endblock %} From bebd621bd5437f61222dd02f3c2f78c600606441 Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 4 Oct 2018 17:19:52 +0000 Subject: [PATCH 012/187] Adds link to password reset form. --- .../web/website/templates/website/registration/login.html | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/evennia/web/website/templates/website/registration/login.html b/evennia/web/website/templates/website/registration/login.html index 2aa32d5cff..87f5d7b9f7 100644 --- a/evennia/web/website/templates/website/registration/login.html +++ b/evennia/web/website/templates/website/registration/login.html @@ -35,6 +35,12 @@ Login {{ form.password | addclass:"form-control" }}
+ +
+
+
Forgot Password?
+
Sign Up
+
From 4fc7318e4c3eeb5182d268882a4b7674d4fb0a9e Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 4 Oct 2018 18:17:32 +0000 Subject: [PATCH 013/187] Updates style of password reset forms to use Bootstrap instead of Django Admin. --- .../registration/password_reset_complete.html | 31 +++++++++++ .../registration/password_reset_confirm.html | 55 +++++++++++++++++++ .../registration/password_reset_done.html | 34 ++++++++++++ .../registration/password_reset_email.html | 15 +++++ .../registration/password_reset_form.html | 48 ++++++++++++++++ 5 files changed, 183 insertions(+) create mode 100644 evennia/web/website/templates/website/registration/password_reset_complete.html create mode 100644 evennia/web/website/templates/website/registration/password_reset_confirm.html create mode 100644 evennia/web/website/templates/website/registration/password_reset_done.html create mode 100644 evennia/web/website/templates/website/registration/password_reset_email.html create mode 100644 evennia/web/website/templates/website/registration/password_reset_form.html diff --git a/evennia/web/website/templates/website/registration/password_reset_complete.html b/evennia/web/website/templates/website/registration/password_reset_complete.html new file mode 100644 index 0000000000..697b4bc4ad --- /dev/null +++ b/evennia/web/website/templates/website/registration/password_reset_complete.html @@ -0,0 +1,31 @@ +{% extends "base.html" %} + +{% block titleblock %} +Forgot Password - Reset Successful +{% endblock %} + +{% block body %} + +{% load addclass %} +
+
+
+
+
+

Password Reset

+
+ {% if user.is_authenticated %} + + {% else %} + +

Your password has been successfully reset!

+ +

You may now log in using it here.

+ + {% endif %} +
+
+
+
+
+{% endblock %} diff --git a/evennia/web/website/templates/website/registration/password_reset_confirm.html b/evennia/web/website/templates/website/registration/password_reset_confirm.html new file mode 100644 index 0000000000..a7bdc683be --- /dev/null +++ b/evennia/web/website/templates/website/registration/password_reset_confirm.html @@ -0,0 +1,55 @@ +{% extends "base.html" %} + +{% block titleblock %} +Forgot Password - Reset +{% endblock %} + +{% block body %} + +{% load addclass %} +
+
+
+
+
+

Reset Password

+
+ {% if not validlink %} + + {% else %} + + {% if form.errors %} + {% for field in form %} + {% for error in field.errors %} + + {% endfor %} + {% endfor %} + {% endif %} + +
+ {% csrf_token %} + +
+ + {{ form.new_password1 | addclass:"form-control" }} +
+ +
+ + {{ form.new_password2 | addclass:"form-control" }} +
+ +
+
+ + +
+
+ + {% endif %} +
+
+
+
+
+{% endblock %} diff --git a/evennia/web/website/templates/website/registration/password_reset_done.html b/evennia/web/website/templates/website/registration/password_reset_done.html new file mode 100644 index 0000000000..d248c56d0f --- /dev/null +++ b/evennia/web/website/templates/website/registration/password_reset_done.html @@ -0,0 +1,34 @@ +{% extends "base.html" %} + +{% block titleblock %} +Forgot Password - Reset Link Sent +{% endblock %} + +{% block body %} + +{% load addclass %} +
+
+
+
+
+

Reset Sent

+
+ {% if user.is_authenticated %} + + {% else %} + +

Instructions for resetting your password will be emailed to the + address you provided, if that address matches the one we have on file + for your account. You should receive them shortly.

+ +

Please allow up to to a few hours for the email to transmit, and be + sure to check your spam folder if it doesn't show up in a timely manner.

+ + {% endif %} +
+
+
+
+
+{% endblock %} diff --git a/evennia/web/website/templates/website/registration/password_reset_email.html b/evennia/web/website/templates/website/registration/password_reset_email.html new file mode 100644 index 0000000000..28e5a0daa2 --- /dev/null +++ b/evennia/web/website/templates/website/registration/password_reset_email.html @@ -0,0 +1,15 @@ +{% autoescape off %} +To initiate the password reset process for your {{ user.get_username }} {{ site_name }} account, +click the link below: + +{{ protocol }}://{{ domain }}{% url 'password_reset_confirm' uidb64=uid token=token %} + +If clicking the link above doesn't work, please copy and paste the URL in a new browser +window instead. + +If you did not request a password reset, please disregard this notice. Whoever requested it +cannot follow through on resetting your password without access to this message. + +Sincerely, +{{ site_name }} Management. +{% endautoescape %} \ No newline at end of file diff --git a/evennia/web/website/templates/website/registration/password_reset_form.html b/evennia/web/website/templates/website/registration/password_reset_form.html new file mode 100644 index 0000000000..f13c532a58 --- /dev/null +++ b/evennia/web/website/templates/website/registration/password_reset_form.html @@ -0,0 +1,48 @@ +{% extends "base.html" %} + +{% block titleblock %} +Forgot Password +{% endblock %} + +{% block body %} + +{% load addclass %} +
+
+
+
+
+

Forgot Password

+
+ {% if user.is_authenticated %} + + {% else %} + {% if form.errors %} + + {% endif %} + {% endif %} + + {% if not user.is_authenticated %} +
+ {% csrf_token %} + +
+ + {{ form.email | addclass:"form-control" }} + The email address you provided at registration. If you left it blank, your password cannot be reset through this form. +
+ +
+
+ + +
+
+ + {% endif %} +
+
+
+
+
+{% endblock %} From f53fdbd681e8d8511b26a0ebe56277e7623576da Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 4 Oct 2018 20:04:37 +0000 Subject: [PATCH 014/187] Enables django.contrib.messages via INSTALLED_APPS and adds a context processor for it. --- evennia/settings_default.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/evennia/settings_default.py b/evennia/settings_default.py index 9efbb6314b..4922b08996 100644 --- a/evennia/settings_default.py +++ b/evennia/settings_default.py @@ -751,6 +751,7 @@ TEMPLATES = [{ 'django.contrib.auth.context_processors.auth', 'django.template.context_processors.media', 'django.template.context_processors.debug', + 'django.contrib.messages.context_processors.messages', 'sekizai.context_processors.sekizai', 'evennia.web.utils.general_context.general_context'], # While true, show "pretty" error messages for template syntax errors. @@ -785,6 +786,7 @@ INSTALLED_APPS = ( 'django.contrib.flatpages', 'django.contrib.sites', 'django.contrib.staticfiles', + 'django.contrib.messages', 'sekizai', 'evennia.utils.idmapper', 'evennia.server', From 82a95195672301e49bde340011d63898e82e32b2 Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 4 Oct 2018 20:05:32 +0000 Subject: [PATCH 015/187] Adds hook to retrieve messsages and an include for the actual blocks. --- evennia/web/website/templates/website/base.html | 2 ++ evennia/web/website/templates/website/messages.html | 9 +++++++++ 2 files changed, 11 insertions(+) create mode 100644 evennia/web/website/templates/website/messages.html diff --git a/evennia/web/website/templates/website/base.html b/evennia/web/website/templates/website/base.html index 2004425849..e690d61d2b 100644 --- a/evennia/web/website/templates/website/base.html +++ b/evennia/web/website/templates/website/base.html @@ -42,6 +42,8 @@
{% endif %}
+ {% include 'website/messages.html' %} + {% block content %} {% endblock %}
diff --git a/evennia/web/website/templates/website/messages.html b/evennia/web/website/templates/website/messages.html new file mode 100644 index 0000000000..7b237180eb --- /dev/null +++ b/evennia/web/website/templates/website/messages.html @@ -0,0 +1,9 @@ +{% if messages %} + +{% for message in messages %} +
+ {{ message }} +
+{% endfor %} + +{% endif %} \ No newline at end of file From 95cf405ab4f78892526b24a3d41d3dfe93ad6b93 Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 4 Oct 2018 20:05:55 +0000 Subject: [PATCH 016/187] Adds include block for messages. --- evennia/web/website/templates/website/registration/login.html | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/evennia/web/website/templates/website/registration/login.html b/evennia/web/website/templates/website/registration/login.html index 87f5d7b9f7..27339c9480 100644 --- a/evennia/web/website/templates/website/registration/login.html +++ b/evennia/web/website/templates/website/registration/login.html @@ -14,6 +14,7 @@ Login

Login

+ {% include 'website/messages.html' %} {% if user.is_authenticated %} {% else %} @@ -39,7 +40,7 @@ Login
Forgot Password?
-
Sign Up
+
Sign Up
From cc26e12e9ff90702ec0f99bf4a3f72ec66c9471a Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 4 Oct 2018 20:21:02 +0000 Subject: [PATCH 017/187] Adds account registration form. --- evennia/web/website/forms.py | 13 +++++ .../web/website/templates/website/_menu.html | 2 +- .../templates/website/registration/login.html | 2 +- .../website/registration/register.html | 56 +++++++++++++++++++ evennia/web/website/urls.py | 3 +- evennia/web/website/views.py | 42 ++++++++++++++ 6 files changed, 115 insertions(+), 3 deletions(-) create mode 100644 evennia/web/website/forms.py create mode 100644 evennia/web/website/templates/website/registration/register.html diff --git a/evennia/web/website/forms.py b/evennia/web/website/forms.py new file mode 100644 index 0000000000..cc7677926c --- /dev/null +++ b/evennia/web/website/forms.py @@ -0,0 +1,13 @@ +from django import forms +from django.conf import settings +from django.contrib.auth.forms import UserCreationForm, UsernameField +from evennia.utils import class_from_module + +class AccountCreationForm(UserCreationForm): + + class Meta: + model = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) + fields = ("username", "email") + field_classes = {'username': UsernameField} + + email = forms.EmailField(help_text="A valid email address. Optional; used for password resets.", required=False) \ No newline at end of file diff --git a/evennia/web/website/templates/website/_menu.html b/evennia/web/website/templates/website/_menu.html index 8430d0f805..6a81d04866 100644 --- a/evennia/web/website/templates/website/_menu.html +++ b/evennia/web/website/templates/website/_menu.html @@ -51,7 +51,7 @@ folder and edit it to add/remove links to the menu. Log In
  • - Register + Register
    • {% endif %} {% endblock %} diff --git a/evennia/web/website/templates/website/registration/login.html b/evennia/web/website/templates/website/registration/login.html index 27339c9480..cf798e8f76 100644 --- a/evennia/web/website/templates/website/registration/login.html +++ b/evennia/web/website/templates/website/registration/login.html @@ -40,7 +40,7 @@ Login
    Forgot Password?
    -
    Sign Up
    +
    Create Account
    diff --git a/evennia/web/website/templates/website/registration/register.html b/evennia/web/website/templates/website/registration/register.html new file mode 100644 index 0000000000..5475d922be --- /dev/null +++ b/evennia/web/website/templates/website/registration/register.html @@ -0,0 +1,56 @@ +{% extends "base.html" %} + +{% block titleblock %} +Register +{% endblock %} + +{% block body %} + +{% load addclass %} +
    +
    +
    +
    +
    +

    Register

    +
    + {% if user.is_authenticated %} + + {% else %} + {% if form.errors %} + {% for field in form %} + {% for error in field.errors %} + + {% endfor %} + {% endfor %} + {% endif %} + {% endif %} + + {% if not user.is_authenticated %} +
    + {% csrf_token %} + + {% for field in form %} +
    + {{ field.label_tag }} + {{ field | addclass:"form-control" }} + {% if field.help_text %} + {{ field.help_text|safe }} + {% endif %} +
    + {% endfor %} + +
    +
    + + +
    +
    + + {% endif %} +
    +
    +
    +
    +
    +{% endblock %} diff --git a/evennia/web/website/urls.py b/evennia/web/website/urls.py index f906b6b142..1cc7fe75d8 100644 --- a/evennia/web/website/urls.py +++ b/evennia/web/website/urls.py @@ -13,7 +13,8 @@ urlpatterns = [ url(r'^tbi/', website_views.to_be_implemented, name='to_be_implemented'), # User Authentication (makes login/logout url names available) - url(r'^authenticate/', include('django.contrib.auth.urls')), + url(r'^auth/', include('django.contrib.auth.urls')), + url(r'^auth/register', website_views.AccountCreationView.as_view(), name="register"), # Django original admin page. Make this URL is always available, whether # we've chosen to use Evennia's custom admin or not. diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index fe93b06426..e4342ebc6d 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -7,14 +7,19 @@ templates on the fly. """ from django.contrib.admin.sites import site from django.conf import settings +from django.contrib import messages from django.contrib.auth import authenticate from django.contrib.admin.views.decorators import staff_member_required +from django.http import HttpResponseRedirect from django.shortcuts import render +from django.urls import reverse, reverse_lazy +from django.views.generic import View, DetailView, ListView, FormView from evennia import SESSION_HANDLER from evennia.objects.models import ObjectDB from evennia.accounts.models import AccountDB from evennia.utils import logger +from evennia.web.website.forms import AccountCreationForm from django.contrib.auth import login @@ -134,3 +139,40 @@ def admin_wrapper(request): Wrapper that allows us to properly use the base Django admin site, if needed. """ return staff_member_required(site.index)(request) + +class AccountCreationView(FormView): + form_class = AccountCreationForm + template_name = 'website/registration/register.html' + success_url = reverse_lazy('login') + + def form_valid(self, form): + # Check to make sure basics validated + valid = super(AccountCreationView, self).form_valid(form) + if not valid: return self.form_invalid(form) + + username = form.cleaned_data['username'] + password = form.cleaned_data['password1'] + email = form.cleaned_data.get('email', '') + + # Create a fake session object to intercept calls to the terminal + from mock import Mock + session = self.request + session.address = self.request.META.get('REMOTE_ADDR', '') + session.msg = Mock() + + # Create account + from evennia.commands.default.unloggedin import _create_account + permissions = settings.PERMISSION_ACCOUNT_DEFAULT + account = _create_account(session, username, password, permissions) + + # If unsuccessful, get messages passed to session.msg + if not account: + [messages.error(self.request, call) for call in session.msg.call_args_list] + return self.form_invalid(form) + + # Append email address if given + account.email = email + account.save() + + messages.success(self.request, "Your account '%s' was successfully created! You may log in using it now." % account.name) + return HttpResponseRedirect(self.success_url) \ No newline at end of file From 2d9cbb9a20cfe225fabdbe77e7b5ef91dc970eb9 Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 4 Oct 2018 22:54:35 +0000 Subject: [PATCH 018/187] Adds authenticated dropdown with links to password change form, create/manage characters, and character quickselect. --- evennia/accounts/accounts.py | 4 ++++ .../web/website/templates/website/_menu.html | 17 +++++++++++++++-- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 2c33e5c1f8..f4711299cf 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -189,6 +189,10 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): @lazy_property def sessions(self): return AccountSessionHandler(self) + + @lazy_property + def characters(self): + return self.db._playable_characters # session-related methods diff --git a/evennia/web/website/templates/website/_menu.html b/evennia/web/website/templates/website/_menu.html index 6a81d04866..ea01404967 100644 --- a/evennia/web/website/templates/website/_menu.html +++ b/evennia/web/website/templates/website/_menu.html @@ -40,8 +40,21 @@ folder and edit it to add/remove links to the menu. {% endblock %} {% block navbar_user %} {% if user.is_authenticated %} -
  • - Logged in as {{user.username}} +
  • + +
    + Create + Manage +
    + {% for character in user.characters %} + {{ character }} + {% empty %} + No characters found! + {% endfor %} +
    + Change Password + Log Out +
  • Log Out From 2a8799acbb8e8ee5651718f18280cffa894f7413 Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 4 Oct 2018 22:54:48 +0000 Subject: [PATCH 019/187] Stylizes password_change form. --- .../registration/password_change_form.html | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 evennia/web/website/templates/website/registration/password_change_form.html diff --git a/evennia/web/website/templates/website/registration/password_change_form.html b/evennia/web/website/templates/website/registration/password_change_form.html new file mode 100644 index 0000000000..bae8c90962 --- /dev/null +++ b/evennia/web/website/templates/website/registration/password_change_form.html @@ -0,0 +1,51 @@ +{% extends "base.html" %} + +{% block titleblock %} +Password Change +{% endblock %} + +{% block content %} + +{% load addclass %} +
    +
    +
    +
    +
    +

    Password Change

    +
    + + {% if form.errors %} + {% for field in form %} + {% for error in field.errors %} + + {% endfor %} + {% endfor %} + {% endif %} + +
    + {% csrf_token %} + + {% for field in form %} +
    + {{ field.label_tag }} + {{ field | addclass:"form-control" }} + {% if field.help_text %} + {{ field.help_text|safe }} + {% endif %} +
    + {% endfor %} + +
    +
    + + +
    +
    + +
    +
    +
    +
    +
    +{% endblock %} From 3c0f02d66dd21f12194e05d193ecee3403c0b7b1 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 18:59:55 +0000 Subject: [PATCH 020/187] Implements web-based character creation. --- evennia/web/website/forms.py | 131 +++++++++++++++++- .../web/website/templates/website/_menu.html | 2 +- .../templates/website/chargen_form.html | 51 +++++++ evennia/web/website/urls.py | 3 + evennia/web/website/views.py | 61 +++++++- 5 files changed, 244 insertions(+), 4 deletions(-) create mode 100644 evennia/web/website/templates/website/chargen_form.html diff --git a/evennia/web/website/forms.py b/evennia/web/website/forms.py index cc7677926c..ca93dd2c3b 100644 --- a/evennia/web/website/forms.py +++ b/evennia/web/website/forms.py @@ -2,6 +2,7 @@ from django import forms from django.conf import settings from django.contrib.auth.forms import UserCreationForm, UsernameField from evennia.utils import class_from_module +from random import choice, randint class AccountCreationForm(UserCreationForm): @@ -10,4 +11,132 @@ class AccountCreationForm(UserCreationForm): fields = ("username", "email") field_classes = {'username': UsernameField} - email = forms.EmailField(help_text="A valid email address. Optional; used for password resets.", required=False) \ No newline at end of file + email = forms.EmailField(help_text="A valid email address. Optional; used for password resets.", required=False) + +class CharacterCreationForm(forms.Form): + name = forms.CharField(help_text="The name of your intended character.") + age = forms.IntegerField(min_value=3, max_value=99, help_text="How old your character should be once spawned.") + description = forms.CharField(widget=forms.Textarea(attrs={'rows': 3}), max_length=2048, min_length=160, required=False) + + @classmethod + def assign_attributes(cls, attribute_list, points, min_points, max_points): + """ + Randomly distributes a number of points across the given attributes, + while also ensuring each attribute gets at least a certain amount + and at most a certain amount. + + Args: + attribute_list (iterable): List or tuple of attribute names to assign + points to. + points (int): Starting number of points + min_points (int): Least amount of points each attribute should have + max_points (int): Most amount of points each attribute should have + + Returns: + spread (dict): Dict of attributes and a point assignment. + + """ + num_buckets = len(attribute_list) + point_spread = (x for x in self.random_distribution(points, num_buckets, min_points, max_points)) + + # For each field, get the point calculation for the next attribute value generated + return {attribute: next(point_spread) for k in attribute_list} + + @classmethod + def random_distribution(cls, points, num_buckets, min_points, max_points): + """ + Distributes a set number of points randomly across a number of 'buckets' + while also attempting to ensure each bucket's value finishes within a + certain range. + + If your math doesn't add up (you try to distribute 5 points across 100 + buckets and insist each bucket has at least 20 points), the algorithm + will return the best spread it could achieve but will not raise an error + (so in this case, 5 random buckets would get 1 point each and that's all). + + Args: + points (int): The number of points to distribute. + num_buckets (int): The number of 'buckets' (or stats, skills, etc) + you wish to distribute points to. + min_points (int): The least amount of points each bucket should have. + max_points (int): The most points each bucket should have. + + Returns: + buckets (list): List of random point assignments. + + """ + buckets = [0 for x in range(num_buckets)] + indices = [i for (i, value) in enumerate(buckets)] + + # Do this while we have eligible buckets, points to assign and we haven't + # maxed out all the buckets. + while indices and points and sum(buckets) <= (max_points * num_buckets): + # Pick a random bucket index + index = choice(indices) + + # Add to bucket + buckets[index] = buckets[index] + 1 + points = points - 1 + + # Get the indices of eligible buckets + indices = [i for (i, value) in enumerate(buckets) if (value < min_points) or (value < max_points)] + + return buckets + +class ExtendedCharacterCreationForm(forms.Form): + + GENDERS = ( + ('male', 'Male'), + ('female', 'Female'), + ('androgynous', 'Androgynous'), + ('special', 'Special') + ) + + RACES = ( + ('human', 'Human'), + ('elf', 'Elf'), + ('orc', 'Orc'), + ) + + CLASSES = ( + ('civilian', 'Civilian'), + ('warrior', 'Warrior'), + ('thief', 'Thief'), + ('cleric', 'Cleric') + ) + + PERKS = ( + ('strong', 'Extra strength'), + ('nimble', 'Quick on their toes'), + ('diplomatic', 'Fast talker') + ) + + name = forms.CharField(help_text="The name of your intended character.") + age = forms.IntegerField(min_value=3, max_value=99, help_text="How old your character should be once spawned.") + gender = forms.ChoiceField(choices=GENDERS, help_text="Which end of the multidimensional spectrum does your character most closely align with, in terms of gender?") + race = forms.ChoiceField(choices=RACES, help_text="What race does your character belong to?") + job = forms.ChoiceField(choices=CLASSES, help_text="What profession or role does your character fulfill or is otherwise destined to?") + + perks = forms.MultipleChoiceField(choices=PERKS, help_text="What extraordinary abilities does your character possess?") + description = forms.CharField(widget=forms.Textarea(attrs={'rows': 3}), max_length=2048, min_length=160, required=False) + + strength = forms.IntegerField(min_value=1, max_value=10) + perception = forms.IntegerField(min_value=1, max_value=10) + intelligence = forms.IntegerField(min_value=1, max_value=10) + dexterity = forms.IntegerField(min_value=1, max_value=10) + charisma = forms.IntegerField(min_value=1, max_value=10) + vitality = forms.IntegerField(min_value=1, max_value=10) + magic = forms.IntegerField(min_value=1, max_value=10) + + def __init__(self, *args, **kwargs): + # Do all the normal initizliation stuff that would otherwise be happening + super(ExtendedCharacterCreationForm, self).__init__(*args, **kwargs) + + # Given a pool of points, let's randomly distribute them across attributes. + # First get a list of attributes + attributes = ('strength', 'perception', 'intelligence', 'dexterity', 'charisma', 'vitality', 'magic') + # Distribute a random number of points across them + attrs = self.assign_attributes(attributes, 50, 1, 10) + # Initialize the form with the results of the point distribution + for field in attrs.keys(): + self.initial[field] = attrs[field] \ No newline at end of file diff --git a/evennia/web/website/templates/website/_menu.html b/evennia/web/website/templates/website/_menu.html index ea01404967..432b6e4827 100644 --- a/evennia/web/website/templates/website/_menu.html +++ b/evennia/web/website/templates/website/_menu.html @@ -43,7 +43,7 @@ folder and edit it to add/remove links to the menu.
  • - Create + Create Manage
    {% for character in user.characters %} diff --git a/evennia/web/website/templates/website/chargen_form.html b/evennia/web/website/templates/website/chargen_form.html new file mode 100644 index 0000000000..8864fb3c5d --- /dev/null +++ b/evennia/web/website/templates/website/chargen_form.html @@ -0,0 +1,51 @@ +{% extends "base.html" %} + +{% block titleblock %} +Character Creation +{% endblock %} + +{% block content %} + +{% load addclass %} +
    +
    +
    +
    +
    +

    Character Creation

    +
    + + {% if form.errors %} + {% for field in form %} + {% for error in field.errors %} + + {% endfor %} + {% endfor %} + {% endif %} + +
    + {% csrf_token %} + + {% for field in form %} +
    + {{ field.label_tag }} + {{ field | addclass:"form-control" }} + {% if field.help_text %} + {{ field.help_text|safe }} + {% endif %} +
    + {% endfor %} + +
    +
    + + +
    +
    + +
    +
    +
    +
    +
    +{% endblock %} diff --git a/evennia/web/website/urls.py b/evennia/web/website/urls.py index 1cc7fe75d8..d7b10208de 100644 --- a/evennia/web/website/urls.py +++ b/evennia/web/website/urls.py @@ -15,6 +15,9 @@ urlpatterns = [ # User Authentication (makes login/logout url names available) url(r'^auth/', include('django.contrib.auth.urls')), url(r'^auth/register', website_views.AccountCreationView.as_view(), name="register"), + + # Character management + url(r'^characters/create/', website_views.CharacterCreationView.as_view(), name="chargen"), # Django original admin page. Make this URL is always available, whether # we've chosen to use Evennia's custom admin or not. diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index e4342ebc6d..bd20add0d5 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -9,6 +9,7 @@ from django.contrib.admin.sites import site from django.conf import settings from django.contrib import messages from django.contrib.auth import authenticate +from django.contrib.auth.mixins import LoginRequiredMixin from django.contrib.admin.views.decorators import staff_member_required from django.http import HttpResponseRedirect from django.shortcuts import render @@ -19,7 +20,7 @@ from evennia import SESSION_HANDLER from evennia.objects.models import ObjectDB from evennia.accounts.models import AccountDB from evennia.utils import logger -from evennia.web.website.forms import AccountCreationForm +from evennia.web.website.forms import AccountCreationForm, CharacterCreationForm from django.contrib.auth import login @@ -175,4 +176,60 @@ class AccountCreationView(FormView): account.save() messages.success(self.request, "Your account '%s' was successfully created! You may log in using it now." % account.name) - return HttpResponseRedirect(self.success_url) \ No newline at end of file + return HttpResponseRedirect(self.success_url) + +class CharacterCreationView(LoginRequiredMixin, FormView): + form_class = CharacterCreationForm + template_name = 'website/chargen_form.html' + success_url = '/'#reverse_lazy('character-manage') + + def form_valid(self, form): + # Get account ref + account = self.request.user + character = None + + # Get attributes from the form + self.attributes = {k: form.cleaned_data[k] for k in form.cleaned_data.keys()} + charname = self.attributes.pop('name') + description = self.attributes.pop('description') + + # Create a character + permissions = settings.PERMISSION_ACCOUNT_DEFAULT + typeclass = settings.BASE_CHARACTER_TYPECLASS + default_home = ObjectDB.objects.get_id(settings.DEFAULT_HOME) + + from evennia.utils import create + try: + character = create.create_object(typeclass, key=charname, home=default_home, permissions=permissions) + # set playable character list + account.db._playable_characters.append(character) + + # allow only the character itself and the account to puppet this character (and Developers). + character.locks.add("puppet:id(%i) or pid(%i) or perm(Developer) or pperm(Developer)" % + (character.id, account.id)) + + # If no description is set, set a default description + if not description: + character.db.desc = "This is a character." + else: + character.db.desc = description + + # We need to set this to have @ic auto-connect to this character + account.db._last_puppet = character + + # Assign attributes from form + [setattr(character.db, field, self.attributes[field]) for field in self.attributes.keys()] + character.creator_id = account.id + character.save() + + except Exception as e: + messages.error(self.request, "There was an error creating your character. If this problem persists, contact an admin.") + logger.log_trace() + return self.form_invalid(form) + + if character: + messages.success(self.request, "Your character '%s' was created!" % character.name) + return HttpResponseRedirect(self.success_url) + else: + messages.error(self.request, "Your character could not be created. Please contact an admin.") + return self.form_invalid(form) \ No newline at end of file From ae84ba0ed228959309f2daab669ef9acb5ad1d57 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 19:01:05 +0000 Subject: [PATCH 021/187] Limits number of characters on quickselect to 10. --- evennia/web/website/templates/website/_menu.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/website/templates/website/_menu.html b/evennia/web/website/templates/website/_menu.html index 432b6e4827..9874b7ef4a 100644 --- a/evennia/web/website/templates/website/_menu.html +++ b/evennia/web/website/templates/website/_menu.html @@ -46,7 +46,7 @@ folder and edit it to add/remove links to the menu. Create Manage
    - {% for character in user.characters %} + {% for character in user.characters|slice:"10" %} {{ character }} {% empty %} No characters found! From dc1c8bb9a69412d6ded7714355b54d690be19cdf Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 19:01:38 +0000 Subject: [PATCH 022/187] Fixes incorrect LOGIN_URL and LOGOUT_URL by means of reverse_lazy call. --- evennia/settings_default.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/evennia/settings_default.py b/evennia/settings_default.py index 4922b08996..91a6e75dbd 100644 --- a/evennia/settings_default.py +++ b/evennia/settings_default.py @@ -13,6 +13,7 @@ always be sure of what you have changed and what is default behaviour. """ from builtins import range +from django.urls import reverse_lazy import os import sys @@ -697,9 +698,9 @@ ROOT_URLCONF = 'web.urls' # Where users are redirected after logging in via contrib.auth.login. LOGIN_REDIRECT_URL = '/' # Where to redirect users when using the @login_required decorator. -LOGIN_URL = '/accounts/login' +LOGIN_URL = reverse_lazy('login') # Where to redirect users who wish to logout. -LOGOUT_URL = '/accounts/login' +LOGOUT_URL = reverse_lazy('logout') # URL that handles the media served from MEDIA_ROOT. # Example: "http://media.lawrence.com" MEDIA_URL = '/media/' From 200b1a684221b38159ed79e6e409f55fd8db2191 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 19:22:23 +0000 Subject: [PATCH 023/187] Fixes storage of creator_id to dbhandler. --- evennia/web/website/views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index bd20add0d5..9a7d62d8c2 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -219,7 +219,7 @@ class CharacterCreationView(LoginRequiredMixin, FormView): # Assign attributes from form [setattr(character.db, field, self.attributes[field]) for field in self.attributes.keys()] - character.creator_id = account.id + character.db.creator_id = account.id character.save() except Exception as e: From 70b5746bfc7259b1de4811ebb192366c4db2314a Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 19:43:23 +0000 Subject: [PATCH 024/187] Adds a generic form to templates. --- .../templates/website/generic_form.html | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 evennia/web/website/templates/website/generic_form.html diff --git a/evennia/web/website/templates/website/generic_form.html b/evennia/web/website/templates/website/generic_form.html new file mode 100644 index 0000000000..091d5f4f20 --- /dev/null +++ b/evennia/web/website/templates/website/generic_form.html @@ -0,0 +1,51 @@ +{% extends "base.html" %} + +{% block titleblock %} +Form +{% endblock %} + +{% block body %} + +{% load addclass %} +
    +
    +
    +
    +
    +

    Form

    +
    + + {% if form.errors %} + {% for field in form %} + {% for error in field.errors %} + + {% endfor %} + {% endfor %} + {% endif %} + +
    + {% csrf_token %} + + {% for field in form %} +
    + {{ field.label_tag }} + {{ field | addclass:"form-control" }} + {% if field.help_text %} + {{ field.help_text|safe }} + {% endif %} +
    + {% endfor %} + +
    +
    + + +
    +
    + +
    +
    +
    +
    +
    +{% endblock %} From 5b536899d5991cdb4544c7fffc8edf4791c25821 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 20:16:01 +0000 Subject: [PATCH 025/187] Implements character management and update views. --- evennia/web/website/forms.py | 146 +++++++++++++++++++++++++++++++++++ evennia/web/website/urls.py | 10 ++- evennia/web/website/views.py | 119 ++++++++++++++++++++++++++++ 3 files changed, 273 insertions(+), 2 deletions(-) create mode 100644 evennia/web/website/forms.py diff --git a/evennia/web/website/forms.py b/evennia/web/website/forms.py new file mode 100644 index 0000000000..937c6be6e8 --- /dev/null +++ b/evennia/web/website/forms.py @@ -0,0 +1,146 @@ +from django import forms +from django.conf import settings +from django.contrib.auth.forms import UserCreationForm, UsernameField +from evennia.utils import class_from_module +from random import choice, randint + +class AccountForm(UserCreationForm): + + class Meta: + model = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) + fields = ("username", "email") + field_classes = {'username': UsernameField} + + email = forms.EmailField(help_text="A valid email address. Optional; used for password resets.", required=False) + +class CharacterForm(forms.Form): + name = forms.CharField(help_text="The name of your intended character.") + age = forms.IntegerField(min_value=3, max_value=99, help_text="How old your character should be once spawned.") + description = forms.CharField(widget=forms.Textarea(attrs={'rows': 3}), max_length=2048, min_length=160, required=False) + + @classmethod + def assign_attributes(cls, attribute_list, points, min_points, max_points): + """ + Randomly distributes a number of points across the given attributes, + while also ensuring each attribute gets at least a certain amount + and at most a certain amount. + + Args: + attribute_list (iterable): List or tuple of attribute names to assign + points to. + points (int): Starting number of points + min_points (int): Least amount of points each attribute should have + max_points (int): Most amount of points each attribute should have + + Returns: + spread (dict): Dict of attributes and a point assignment. + + """ + num_buckets = len(attribute_list) + point_spread = (x for x in self.random_distribution(points, num_buckets, min_points, max_points)) + + # For each field, get the point calculation for the next attribute value generated + return {attribute: next(point_spread) for k in attribute_list} + + @classmethod + def random_distribution(cls, points, num_buckets, min_points, max_points): + """ + Distributes a set number of points randomly across a number of 'buckets' + while also attempting to ensure each bucket's value finishes within a + certain range. + + If your math doesn't add up (you try to distribute 5 points across 100 + buckets and insist each bucket has at least 20 points), the algorithm + will return the best spread it could achieve but will not raise an error + (so in this case, 5 random buckets would get 1 point each and that's all). + + Args: + points (int): The number of points to distribute. + num_buckets (int): The number of 'buckets' (or stats, skills, etc) + you wish to distribute points to. + min_points (int): The least amount of points each bucket should have. + max_points (int): The most points each bucket should have. + + Returns: + buckets (list): List of random point assignments. + + """ + buckets = [0 for x in range(num_buckets)] + indices = [i for (i, value) in enumerate(buckets)] + + # Do this while we have eligible buckets, points to assign and we haven't + # maxed out all the buckets. + while indices and points and sum(buckets) <= (max_points * num_buckets): + # Pick a random bucket index + index = choice(indices) + + # Add to bucket + buckets[index] = buckets[index] + 1 + points = points - 1 + + # Get the indices of eligible buckets + indices = [i for (i, value) in enumerate(buckets) if (value < min_points) or (value < max_points)] + + return buckets + +class CharacterUpdateForm(CharacterForm): + class Meta: + fields = ('description',) + +class ExtendedCharacterForm(CharacterForm): + + GENDERS = ( + ('male', 'Male'), + ('female', 'Female'), + ('androgynous', 'Androgynous'), + ('special', 'Special') + ) + + RACES = ( + ('human', 'Human'), + ('elf', 'Elf'), + ('orc', 'Orc'), + ) + + CLASSES = ( + ('civilian', 'Civilian'), + ('warrior', 'Warrior'), + ('thief', 'Thief'), + ('cleric', 'Cleric') + ) + + PERKS = ( + ('strong', 'Extra strength'), + ('nimble', 'Quick on their toes'), + ('diplomatic', 'Fast talker') + ) + + name = forms.CharField(help_text="The name of your intended character.") + age = forms.IntegerField(min_value=3, max_value=99, help_text="How old your character should be once spawned.") + gender = forms.ChoiceField(choices=GENDERS, help_text="Which end of the multidimensional spectrum does your character most closely align with, in terms of gender?") + race = forms.ChoiceField(choices=RACES, help_text="What race does your character belong to?") + job = forms.ChoiceField(choices=CLASSES, help_text="What profession or role does your character fulfill or is otherwise destined to?") + + perks = forms.MultipleChoiceField(choices=PERKS, help_text="What extraordinary abilities does your character possess?") + description = forms.CharField(widget=forms.Textarea(attrs={'rows': 3}), max_length=2048, min_length=160, required=False) + + strength = forms.IntegerField(min_value=1, max_value=10) + perception = forms.IntegerField(min_value=1, max_value=10) + intelligence = forms.IntegerField(min_value=1, max_value=10) + dexterity = forms.IntegerField(min_value=1, max_value=10) + charisma = forms.IntegerField(min_value=1, max_value=10) + vitality = forms.IntegerField(min_value=1, max_value=10) + magic = forms.IntegerField(min_value=1, max_value=10) + + def __init__(self, *args, **kwargs): + # Do all the normal initizliation stuff that would otherwise be happening + super(ExtendedCharacterCreationForm, self).__init__(*args, **kwargs) + + # Given a pool of points, let's randomly distribute them across attributes. + # First get a list of attributes + attributes = ('strength', 'perception', 'intelligence', 'dexterity', 'charisma', 'vitality', 'magic') + # Distribute a random number of points across them + attrs = self.assign_attributes(attributes, 50, 1, 10) + # Initialize the form with the results of the point distribution + for field in attrs.keys(): + self.initial[field] = attrs[field] \ No newline at end of file diff --git a/evennia/web/website/urls.py b/evennia/web/website/urls.py index f906b6b142..d6dfc0c748 100644 --- a/evennia/web/website/urls.py +++ b/evennia/web/website/urls.py @@ -13,8 +13,14 @@ urlpatterns = [ url(r'^tbi/', website_views.to_be_implemented, name='to_be_implemented'), # User Authentication (makes login/logout url names available) - url(r'^authenticate/', include('django.contrib.auth.urls')), - + url(r'^auth/', include('django.contrib.auth.urls')), + url(r'^auth/register', website_views.AccountCreationView.as_view(), name="register"), + + # Character management + url(r'^characters/create/$', website_views.CharacterCreateView.as_view(), name="chargen"), + url(r'^characters/manage/$', website_views.CharacterManageView.as_view(), name="manage-characters"), + url(r'^characters/update/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterUpdateView.as_view(), name="update-character"), + # Django original admin page. Make this URL is always available, whether # we've chosen to use Evennia's custom admin or not. url(r'django_admin/', website_views.admin_wrapper, name="django_admin"), diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index fe93b06426..d25c3493ec 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -17,6 +17,7 @@ from evennia.accounts.models import AccountDB from evennia.utils import logger from django.contrib.auth import login +from django.utils.text import slugify _BASE_CHAR_TYPECLASS = settings.BASE_CHARACTER_TYPECLASS @@ -134,3 +135,121 @@ def admin_wrapper(request): Wrapper that allows us to properly use the base Django admin site, if needed. """ return staff_member_required(site.index)(request) + +class ObjectDetailView(DetailView): + model = ObjectDB + + def get_object(self, queryset=None): + obj = super(ObjectDetailView, self).get_object(queryset) + if not slugify(obj.name) == self.kwargs.get('slug'): + raise Http404(u"No %(verbose_name)s found matching the query" % + {'verbose_name': queryset.model._meta.verbose_name}) + return obj + +class AccountCreationView(FormView): + form_class = AccountForm + template_name = 'website/registration/register.html' + success_url = reverse_lazy('login') + + def form_valid(self, form): + # Check to make sure basics validated + valid = super(AccountCreationView, self).form_valid(form) + if not valid: return self.form_invalid(form) + + username = form.cleaned_data['username'] + password = form.cleaned_data['password1'] + email = form.cleaned_data.get('email', '') + + # Create a fake session object to intercept calls to the terminal + from mock import Mock + session = self.request + session.address = self.request.META.get('REMOTE_ADDR', '') + session.msg = Mock() + + # Create account + from evennia.commands.default.unloggedin import _create_account + permissions = settings.PERMISSION_ACCOUNT_DEFAULT + account = _create_account(session, username, password, permissions) + + # If unsuccessful, get messages passed to session.msg + if not account: + [messages.error(self.request, call) for call in session.msg.call_args_list] + return self.form_invalid(form) + + # Append email address if given + account.email = email + account.save() + + messages.success(self.request, "Your account '%s' was successfully created! You may log in using it now." % account.name) + return HttpResponseRedirect(self.success_url) + +class CharacterManageView(LoginRequiredMixin, ListView): + model = ObjectDB + + def get_queryset(self): + # Get IDs of characters owned by account + ids = [getattr(x, 'id') for x in self.request.user.db._playable_characters] + + # Return a queryset consisting of those characters + return self.model.filter(id__in=ids) + +class CharacterUpdateView(LoginRequiredMixin, FormView): + form_class = CharacterUpdateForm + template_name = 'website/generic_form.html' + success_url = '/'#reverse_lazy('character-manage') + +class CharacterCreateView(LoginRequiredMixin, FormView): + form_class = CharacterForm + template_name = 'website/chargen_form.html' + success_url = '/'#reverse_lazy('character-manage') + + def form_valid(self, form): + # Get account ref + account = self.request.user + character = None + + # Get attributes from the form + self.attributes = {k: form.cleaned_data[k] for k in form.cleaned_data.keys()} + charname = self.attributes.pop('name') + description = self.attributes.pop('description') + + # Create a character + permissions = settings.PERMISSION_ACCOUNT_DEFAULT + typeclass = settings.BASE_CHARACTER_TYPECLASS + default_home = ObjectDB.objects.get_id(settings.DEFAULT_HOME) + + from evennia.utils import create + try: + character = create.create_object(typeclass, key=charname, home=default_home, permissions=permissions) + # set playable character list + account.db._playable_characters.append(character) + + # allow only the character itself and the account to puppet this character (and Developers). + character.locks.add("puppet:id(%i) or pid(%i) or perm(Developer) or pperm(Developer)" % + (character.id, account.id)) + + # If no description is set, set a default description + if not description: + character.db.desc = "This is a character." + else: + character.db.desc = description + + # We need to set this to have @ic auto-connect to this character + account.db._last_puppet = character + + # Assign attributes from form + [setattr(character.db, field, self.attributes[field]) for field in self.attributes.keys()] + character.db.creator_id = account.id + character.save() + + except Exception as e: + messages.error(self.request, "There was an error creating your character. If this problem persists, contact an admin.") + logger.log_trace() + return self.form_invalid(form) + + if character: + messages.success(self.request, "Your character '%s' was created!" % character.name) + return HttpResponseRedirect(self.success_url) + else: + messages.error(self.request, "Your character could not be created. Please contact an admin.") + return self.form_invalid(form) From fcdff46548a641b037a97f880c0a3eed9747c96c Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 21:04:01 +0000 Subject: [PATCH 026/187] Renames chargen form. --- .../website/{chargen_form.html => character_create_form.html} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename evennia/web/website/templates/website/{chargen_form.html => character_create_form.html} (100%) diff --git a/evennia/web/website/templates/website/chargen_form.html b/evennia/web/website/templates/website/character_create_form.html similarity index 100% rename from evennia/web/website/templates/website/chargen_form.html rename to evennia/web/website/templates/website/character_create_form.html From 4633857ad7a242ed6383145c85e980baba4daa8c Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 21:06:10 +0000 Subject: [PATCH 027/187] Adds pagination and incorporates on base template where applicable. --- .../web/website/templates/website/base.html | 2 ++ .../website/templates/website/pagination.html | 34 +++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 evennia/web/website/templates/website/pagination.html diff --git a/evennia/web/website/templates/website/base.html b/evennia/web/website/templates/website/base.html index e690d61d2b..d465a17171 100644 --- a/evennia/web/website/templates/website/base.html +++ b/evennia/web/website/templates/website/base.html @@ -46,6 +46,8 @@ {% block content %} {% endblock %} + + {% include 'website/pagination.html' %}
    • diff --git a/evennia/web/website/templates/website/pagination.html b/evennia/web/website/templates/website/pagination.html new file mode 100644 index 0000000000..e2cb6bed73 --- /dev/null +++ b/evennia/web/website/templates/website/pagination.html @@ -0,0 +1,34 @@ +{% if page_obj %} + +{% endif %} \ No newline at end of file From 4ca72cc9fed119902ed11a15fff5388bf1bab497 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 21:06:42 +0000 Subject: [PATCH 028/187] Adds template for character management list view. --- .../website/character_manage_list.html | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 evennia/web/website/templates/website/character_manage_list.html diff --git a/evennia/web/website/templates/website/character_manage_list.html b/evennia/web/website/templates/website/character_manage_list.html new file mode 100644 index 0000000000..f4e112fd7a --- /dev/null +++ b/evennia/web/website/templates/website/character_manage_list.html @@ -0,0 +1,38 @@ +{% extends "base.html" %} + +{% block titleblock %} +Manage Characters +{% endblock %} + +{% block content %} + +{% load addclass %} +
    +
    +
    +
    +
    +

    Manage Characters

    +
    + + {% for object in object_list %} +
    + +
    +

    {{ object.db_date_created }} +
    Delete +
    Edit

    +
    {{ object }} {% if object.subtitle %}{{ object.subtitle }}{% endif %}
    +

    {{ object.db.desc }}

    +
    +
    + {% endfor %} + +
    +
    +
    +
    +
    +{% endblock %} + + From c31a2f079618a5c3eeb3d6dd606dfdbf04bb7dce Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 21:07:07 +0000 Subject: [PATCH 029/187] Removes character update form. --- evennia/web/website/forms.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/evennia/web/website/forms.py b/evennia/web/website/forms.py index 937c6be6e8..8759d681e8 100644 --- a/evennia/web/website/forms.py +++ b/evennia/web/website/forms.py @@ -82,10 +82,6 @@ class CharacterForm(forms.Form): indices = [i for (i, value) in enumerate(buckets) if (value < min_points) or (value < max_points)] return buckets - -class CharacterUpdateForm(CharacterForm): - class Meta: - fields = ('description',) class ExtendedCharacterForm(CharacterForm): From d972251d5c1c49bf6eba81a2187bcb75fdcf44ea Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 21:07:44 +0000 Subject: [PATCH 030/187] Adds character management/deletion views and some other changes. --- evennia/web/website/views.py | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index d25c3493ec..0ae996027c 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -8,13 +8,19 @@ templates on the fly. from django.contrib.admin.sites import site from django.conf import settings from django.contrib.auth import authenticate +from django.contrib.auth.mixins import LoginRequiredMixin from django.contrib.admin.views.decorators import staff_member_required +from django.db.models.functions import Lower from django.shortcuts import render +from django.urls import reverse_lazy +from django.views.generic import View, TemplateView, ListView, DetailView, FormView +from django.views.generic.edit import DeleteView from evennia import SESSION_HANDLER from evennia.objects.models import ObjectDB from evennia.accounts.models import AccountDB from evennia.utils import logger +from evennia.web.website.forms import AccountForm, CharacterForm from django.contrib.auth import login from django.utils.text import slugify @@ -185,23 +191,37 @@ class AccountCreationView(FormView): class CharacterManageView(LoginRequiredMixin, ListView): model = ObjectDB + paginate_by = 10 + template_name = 'website/character_manage_list.html' def get_queryset(self): # Get IDs of characters owned by account ids = [getattr(x, 'id') for x in self.request.user.db._playable_characters] # Return a queryset consisting of those characters - return self.model.filter(id__in=ids) + return self.model.objects.filter(id__in=ids).order_by(Lower('db_key')) class CharacterUpdateView(LoginRequiredMixin, FormView): - form_class = CharacterUpdateForm + form_class = CharacterForm template_name = 'website/generic_form.html' - success_url = '/'#reverse_lazy('character-manage') + success_url = reverse_lazy('manage-characters') + fields = ('description',) + +class CharacterDeleteView(LoginRequiredMixin, ObjectDetailView, DeleteView): + model = ObjectDB + + def get_queryset(self): + # Restrict characters available for deletion to those owned by + # the authenticated account + ids = [getattr(x, 'id') for x in self.request.user.db._playable_characters] + + # Return a queryset consisting of those characters + return self.model.objects.filter(id__in=ids).order_by(Lower('db_key')) class CharacterCreateView(LoginRequiredMixin, FormView): form_class = CharacterForm - template_name = 'website/chargen_form.html' - success_url = '/'#reverse_lazy('character-manage') + template_name = 'website/character_create_form.html' + success_url = reverse_lazy('manage-characters') def form_valid(self, form): # Get account ref From d52ff85a50a77faca113a60fa1b73709782623b1 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 21:08:00 +0000 Subject: [PATCH 031/187] Adds links to charman views. --- evennia/web/website/templates/website/_menu.html | 2 +- evennia/web/website/urls.py | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/evennia/web/website/templates/website/_menu.html b/evennia/web/website/templates/website/_menu.html index 9874b7ef4a..90eabba4eb 100644 --- a/evennia/web/website/templates/website/_menu.html +++ b/evennia/web/website/templates/website/_menu.html @@ -44,7 +44,7 @@ folder and edit it to add/remove links to the menu.
    Create - Manage + Manage
    {% for character in user.characters|slice:"10" %} {{ character }} diff --git a/evennia/web/website/urls.py b/evennia/web/website/urls.py index d6dfc0c748..229750bdae 100644 --- a/evennia/web/website/urls.py +++ b/evennia/web/website/urls.py @@ -20,6 +20,7 @@ urlpatterns = [ url(r'^characters/create/$', website_views.CharacterCreateView.as_view(), name="chargen"), url(r'^characters/manage/$', website_views.CharacterManageView.as_view(), name="manage-characters"), url(r'^characters/update/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterUpdateView.as_view(), name="update-character"), + url(r'^characters/delete/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterDeleteView.as_view(), name="delete-character"), # Django original admin page. Make this URL is always available, whether # we've chosen to use Evennia's custom admin or not. From 93206b04055c4a3f6326f8fd10c2e3f56d567b45 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 21:08:22 +0000 Subject: [PATCH 032/187] Adds generic listview template. --- .../templates/website/object_list.html | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 evennia/web/website/templates/website/object_list.html diff --git a/evennia/web/website/templates/website/object_list.html b/evennia/web/website/templates/website/object_list.html new file mode 100644 index 0000000000..06e513dcbb --- /dev/null +++ b/evennia/web/website/templates/website/object_list.html @@ -0,0 +1,29 @@ +{% extends "base.html" %} + +{% block titleblock %} +List +{% endblock %} + +{% block content %} + +{% load addclass %} +
    +
    +
    +
    +
    +

    List

    +
    + +
      + {% for object in object_list %} +
    • {{ object }}
      • + {% endfor %} +
    + +
    +
    +
    +
    +
    +{% endblock %} From a0bed8f2b58e3877feb5f74f4499592e5b9261c0 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 22:02:20 +0000 Subject: [PATCH 033/187] Adds get_absolute_url() and get_admin_url() methods to DefaultObject, DefaultCharacter, Account and DefaultRoom objects. --- evennia/accounts/accounts.py | 21 +++++++++++++++++ evennia/accounts/tests.py | 13 +++++++++++ evennia/objects/objects.py | 44 ++++++++++++++++++++++++++++++++++++ evennia/objects/tests.py | 11 +++++++++ 4 files changed, 89 insertions(+) create mode 100644 evennia/objects/tests.py diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 2c33e5c1f8..f90575edd2 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -14,7 +14,9 @@ instead for most things). import time from django.conf import settings from django.contrib.auth import password_validation +from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ValidationError +from django.urls import reverse_lazy from django.utils import timezone from evennia.typeclasses.models import TypeclassBase from evennia.accounts.manager import AccountManager @@ -189,6 +191,25 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): @lazy_property def sessions(self): return AccountSessionHandler(self) + + def get_absolute_url(self): + """ + Returns the canonical URL for an Account. + + To callers, this method should appear to return a string that can be + used to refer to the object over HTTP. + + https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url + """ + try: return reverse_lazy('account-detail', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: return '#' + + def get_admin_url(self): + """ + Returns a link to this object's entry within the Django Admin panel. + """ + content_type = ContentType.objects.get_for_model(self.__class__) + return reverse_lazy("admin:%s_%s_change" % (content_type.app_label, content_type.model), args=(self.id,)) # session-related methods diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index 2855dd0ca2..4d941782ad 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -59,6 +59,19 @@ class TestDefaultAccount(TestCase): self.s1 = Session() self.s1.puppet = None self.s1.sessid = 0 + + def test_absolute_url(self): + "Get URL for account detail page on website" + self.account = create.create_account("TestAccount%s" % randint(100000, 999999), + email="test@test.com", password="testpassword", typeclass=DefaultAccount) + self.assertTrue(self.account.get_absolute_url()) + + def test_admin_url(self): + "Get object's URL for access via Admin pane" + self.account = create.create_account("TestAccount%s" % randint(100000, 999999), + email="test@test.com", password="testpassword", typeclass=DefaultAccount) + self.assertTrue(self.account.get_admin_url()) + self.assertTrue(self.account.get_admin_url() != '#') def test_password_validation(self): "Check password validators deny bad passwords" diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 27d8147999..167cd60612 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -12,6 +12,9 @@ from future.utils import with_metaclass from collections import defaultdict from django.conf import settings +from django.contrib.contenttypes.models import ContentType +from django.urls import reverse +from django.utils.text import slugify from evennia.typeclasses.models import TypeclassBase from evennia.typeclasses.attributes import NickHandler @@ -324,6 +327,25 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): # look at 'an egg'. self.aliases.add(singular, category="plural_key") return singular, plural + + def get_absolute_url(self): + """ + Returns the canonical URL for an object. + + To callers, this method should appear to return a string that can be + used to refer to the object over HTTP. + + https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url + """ + try: return reverse('object-detail', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: return '#' + + def get_admin_url(self): + """ + Returns a link to this object's entry within the Django Admin panel. + """ + content_type = ContentType.objects.get_for_model(self.__class__) + return reverse("admin:%s_%s_change" % (content_type.app_label, content_type.model), args=(self.id,)) def search(self, searchdata, global_search=False, @@ -1821,6 +1843,17 @@ class DefaultCharacter(DefaultObject): a character avatar controlled by an account. """ + def get_absolute_url(self): + """ + Returns the canonical URL for a Character. + + To callers, this method should appear to return a string that can be + used to refer to the object over HTTP. + + https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url + """ + try: return reverse('character-detail', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: return super(DefaultCharacter, self).get_absolute_url() def basetype_setup(self): """ @@ -1938,6 +1971,17 @@ class DefaultRoom(DefaultObject): This is the base room object. It's just like any Object except its location is always `None`. """ + def get_absolute_url(self): + """ + Returns the canonical URL for a Room. + + To callers, this method should appear to return a string that can be + used to refer to the object over HTTP. + + https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url + """ + try: return reverse('location-detail', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: return super(DefaultRoom, self).get_absolute_url() def basetype_setup(self): """ diff --git a/evennia/objects/tests.py b/evennia/objects/tests.py new file mode 100644 index 0000000000..f317f2c39c --- /dev/null +++ b/evennia/objects/tests.py @@ -0,0 +1,11 @@ +from evennia.utils.test_resources import EvenniaTest + +class DefaultObjectTest(EvenniaTest): + + def test_urls(self): + "Make sure objects are returning URLs" + self.assertTrue(self.char1.get_absolute_url()) + self.assertTrue('admin' in self.char1.get_admin_url()) + + self.assertTrue(self.room1.get_absolute_url()) + self.assertTrue('admin' in self.room1.get_admin_url()) \ No newline at end of file From fc55f0f2a14d56cbfae673d119f08f78d107d35f Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 22:30:12 +0000 Subject: [PATCH 034/187] Adds dynamic get_*_url() fields to DefaultObject and children and static get_*_url() fields to DefaultAccount. --- evennia/accounts/accounts.py | 16 +++++++++++ evennia/objects/objects.py | 56 +++++++++++++++++++----------------- 2 files changed, 46 insertions(+), 26 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index f90575edd2..bd1fb4f573 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -204,6 +204,22 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): try: return reverse_lazy('account-detail', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) except: return '#' + def get_delete_url(self): + """ + Returns the canonical URL to the page that allows deleting an object. + + """ + try: return reverse('account-delete', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: return '#' + + def get_update_url(self): + """ + Returns the canonical URL to the page that allows updating an object. + + """ + try: return reverse('account-update', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: return '#' + def get_admin_url(self): """ Returns a link to this object's entry within the Django Admin panel. diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 167cd60612..71ccb28f77 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -7,6 +7,7 @@ entities. """ import time import inflect +import re from builtins import object from future.utils import with_metaclass from collections import defaultdict @@ -328,21 +329,48 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): self.aliases.add(singular, category="plural_key") return singular, plural + def get_url_prefix(self): + """ + Derives the object name from the class name. + + i.e. 'DefaultAccount' = 'default-account', 'Character' = 'character' + """ + klass = self.__class__.__name__ + terms = [x.lower() for x in re.split('([A-Z][a-z]+)', klass) if x] + return slugify(' '.join(terms)) + def get_absolute_url(self): """ - Returns the canonical URL for an object. + Returns the canonical URL to view an object. To callers, this method should appear to return a string that can be used to refer to the object over HTTP. https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url """ - try: return reverse('object-detail', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + try: return reverse('%s-detail' % self.get_url_prefix(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: return '#' + + def get_delete_url(self): + """ + Returns the canonical URL to the page that allows deleting an object. + + """ + try: return reverse('%s-delete' % self.get_url_prefix(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: return '#' + + def get_update_url(self): + """ + Returns the canonical URL to the page that allows updating an object. + + """ + try: return reverse('%s-update' % self.get_url_prefix(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) except: return '#' def get_admin_url(self): """ Returns a link to this object's entry within the Django Admin panel. + """ content_type = ContentType.objects.get_for_model(self.__class__) return reverse("admin:%s_%s_change" % (content_type.app_label, content_type.model), args=(self.id,)) @@ -1843,18 +1871,6 @@ class DefaultCharacter(DefaultObject): a character avatar controlled by an account. """ - def get_absolute_url(self): - """ - Returns the canonical URL for a Character. - - To callers, this method should appear to return a string that can be - used to refer to the object over HTTP. - - https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url - """ - try: return reverse('character-detail', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) - except: return super(DefaultCharacter, self).get_absolute_url() - def basetype_setup(self): """ Setup character-specific security. @@ -1971,18 +1987,6 @@ class DefaultRoom(DefaultObject): This is the base room object. It's just like any Object except its location is always `None`. """ - def get_absolute_url(self): - """ - Returns the canonical URL for a Room. - - To callers, this method should appear to return a string that can be - used to refer to the object over HTTP. - - https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url - """ - try: return reverse('location-detail', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) - except: return super(DefaultRoom, self).get_absolute_url() - def basetype_setup(self): """ Simple room setup setting locks to make sure the room From 7830f34dc360e9d90a3f2a6c1698ed92d867a413 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 5 Oct 2018 22:34:34 +0000 Subject: [PATCH 035/187] Makes lazy reversals not lazy; prevents errors from manifesting out of scope. --- evennia/accounts/accounts.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index bd1fb4f573..6631911dc8 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -16,7 +16,7 @@ from django.conf import settings from django.contrib.auth import password_validation from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ValidationError -from django.urls import reverse_lazy +from django.urls import reverse from django.utils import timezone from evennia.typeclasses.models import TypeclassBase from evennia.accounts.manager import AccountManager @@ -201,7 +201,7 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url """ - try: return reverse_lazy('account-detail', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + try: return reverse('account-detail', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) except: return '#' def get_delete_url(self): @@ -225,7 +225,7 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): Returns a link to this object's entry within the Django Admin panel. """ content_type = ContentType.objects.get_for_model(self.__class__) - return reverse_lazy("admin:%s_%s_change" % (content_type.app_label, content_type.model), args=(self.id,)) + return reverse("admin:%s_%s_change" % (content_type.app_label, content_type.model), args=(self.id,)) # session-related methods From 33727b472cf2cf2d9491a6a24cd9a0df1e6c8a49 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 7 Oct 2018 17:26:19 +0000 Subject: [PATCH 036/187] Adds CRUD views for characters. --- evennia/web/website/urls.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/evennia/web/website/urls.py b/evennia/web/website/urls.py index 229750bdae..d8a6523c53 100644 --- a/evennia/web/website/urls.py +++ b/evennia/web/website/urls.py @@ -17,10 +17,10 @@ urlpatterns = [ url(r'^auth/register', website_views.AccountCreationView.as_view(), name="register"), # Character management - url(r'^characters/create/$', website_views.CharacterCreateView.as_view(), name="chargen"), - url(r'^characters/manage/$', website_views.CharacterManageView.as_view(), name="manage-characters"), - url(r'^characters/update/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterUpdateView.as_view(), name="update-character"), - url(r'^characters/delete/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterDeleteView.as_view(), name="delete-character"), + url(r'^characters/create/$', website_views.CharacterCreateView.as_view(), name="character-create"), + url(r'^characters/manage/$', website_views.CharacterManageView.as_view(), name="character-manage"), + url(r'^characters/update/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterUpdateView.as_view(), name="character-update"), + url(r'^characters/delete/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterDeleteView.as_view(), name="character-delete"), # Django original admin page. Make this URL is always available, whether # we've chosen to use Evennia's custom admin or not. From cfd1efa2f3463b5721a2d908ef5175de5eaaf673 Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 9 Oct 2018 20:28:47 +0000 Subject: [PATCH 037/187] Updates docstring to expand MM acronym for clarity. --- evennia/accounts/accounts.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 6bd812b6fa..e7f838ecbd 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -688,9 +688,9 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): @classmethod def create(cls, *args, **kwargs): """ - Creates an Account (or Account/Character pair for MM<2) with default - (or overridden) permissions and having joined them to the appropriate - default channels. + Creates an Account (or Account/Character pair for MULTISESSION_MODE<2) + with default (or overridden) permissions and having joined them to the + appropriate default channels. Kwargs: username (str): Username of Account owner From 3d7a6a40dccdd2909f506083d8252e39ca8779a2 Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 9 Oct 2018 20:29:12 +0000 Subject: [PATCH 038/187] Implements create() method migrated from CmdCreate on DefaultObject. --- evennia/objects/objects.py | 69 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 27d8147999..6525e2f39a 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -857,6 +857,75 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): string = "This place should not exist ... contact an admin." obj.msg(_(string)) obj.move_to(home) + + @classmethod + def create(cls, key, **kwargs): + """ + Creates a basic object with default parameters, unless otherwise + specified or extended. + + Provides a friendlier interface to the utils.create_object() function. + + Args: + key (str): Name of the new object. + + Kwargs: + caller (Object): Intended owner (read: 'caller') of object. + description (str): Brief description of this object. + home (Object or str): Obj or #dbref to use as the object's + home location. + permissions (list): A list of permission strings or tuples (permstring, category). + locks (str): one or more lockstrings, separated by semicolons. + aliases (list): A list of alternative keys or tuples (aliasstring, category). + tags (list): List of tag keys or tuples (tagkey, category) or (tagkey, category, data). + destination (Object or str): Obj or #dbref to use as an Exit's + target. + report_to (Object): The object to return error messages to. + nohome (bool): This allows the creation of objects without a + default home location; only used when creating the default + location itself or during unittests. + attributes (list): Tuples on the form (key, value) or (key, value, category), + (key, value, lockstring) or (key, value, lockstring, default_access). + to set as Attributes on the new object. + nattributes (list): Non-persistent tuples on the form (key, value). Note that + adding this rarely makes sense since this data will not survive a reload. + typeclass (class or str): Class or python path to a typeclass. + + Returns: + object (Object): A newly created object of the given typeclass. + errors (list): A list of errors in string form, if any. + + """ + errors = [] + caller = kwargs.get('caller') + + # If no typeclass supplied, use this class + kwargs['typeclass'] = kwargs.pop('typeclass', cls) + + # Set the supplied key as the name of the intended object + kwargs['key'] = key + + # Create a sane lockstring if one wasn't supplied + lockstring = kwargs.get('locks') + if caller and not lockstring: + lock_template = "control:id({id}) or perm(Admin);delete:id({id}) or perm(Admin)" + lockstring = lock_template.format(id=caller.id) + kwargs['locks'] = lockstring + + # Create object + try: + obj = create.create_object(**kwargs) + except Exception as e: + errors.append("Object '%s' could not be created." % key) + logger.log_trace() + return None, errors + + # Set description if there is none, or update it if provided + if kwargs.get('description') or not obj.db.desc: + desc = kwargs.get('description', "You see nothing special.") + obj.db.desc = desc + + return obj, errors def copy(self, new_key=None): """ From 0217e4915ba8b271ced4c652b7b4c666759f93a3 Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 9 Oct 2018 22:20:06 +0000 Subject: [PATCH 039/187] Implements create() methods on DefaultObject, DefaultCharacter, DefaultRoom and DefaultExit. --- evennia/objects/objects.py | 268 ++++++++++++++++++++++++++++++++----- 1 file changed, 234 insertions(+), 34 deletions(-) diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 6525e2f39a..7d9e344936 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -191,6 +191,10 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): without `obj.save()` having to be called explicitly. """ + # lockstring of newly created objects, for easy overloading. + # Will be formatted with the appropriate attributes. + lockstring = "control:id({account_id}) or perm(Admin);delete:id({account_id}) or perm(Admin)" + objects = ObjectManager() # on-object properties @@ -859,7 +863,7 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): obj.move_to(home) @classmethod - def create(cls, key, **kwargs): + def create(cls, key, account=None, **kwargs): """ Creates a basic object with default parameters, unless otherwise specified or extended. @@ -868,28 +872,11 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): Args: key (str): Name of the new object. + account (Account): Account to attribute this object to Kwargs: - caller (Object): Intended owner (read: 'caller') of object. - description (str): Brief description of this object. - home (Object or str): Obj or #dbref to use as the object's - home location. - permissions (list): A list of permission strings or tuples (permstring, category). - locks (str): one or more lockstrings, separated by semicolons. - aliases (list): A list of alternative keys or tuples (aliasstring, category). - tags (list): List of tag keys or tuples (tagkey, category) or (tagkey, category, data). - destination (Object or str): Obj or #dbref to use as an Exit's - target. - report_to (Object): The object to return error messages to. - nohome (bool): This allows the creation of objects without a - default home location; only used when creating the default - location itself or during unittests. - attributes (list): Tuples on the form (key, value) or (key, value, category), - (key, value, lockstring) or (key, value, lockstring, default_access). - to set as Attributes on the new object. - nattributes (list): Non-persistent tuples on the form (key, value). Note that - adding this rarely makes sense since this data will not survive a reload. - typeclass (class or str): Class or python path to a typeclass. + description (str): Brief description for this object. + ip (str): IP address of creator (for object auditing). Returns: object (Object): A newly created object of the given typeclass. @@ -897,7 +884,10 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): """ errors = [] - caller = kwargs.get('caller') + obj = None + + # Get IP address of creator, if available + ip = kwargs.pop('ip') # If no typeclass supplied, use this class kwargs['typeclass'] = kwargs.pop('typeclass', cls) @@ -907,24 +897,27 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): # Create a sane lockstring if one wasn't supplied lockstring = kwargs.get('locks') - if caller and not lockstring: - lock_template = "control:id({id}) or perm(Admin);delete:id({id}) or perm(Admin)" - lockstring = lock_template.format(id=caller.id) + if account and not lockstring: + lockstring = cls.lockstring.format(account_id=account.id) kwargs['locks'] = lockstring # Create object try: obj = create.create_object(**kwargs) - except Exception as e: - errors.append("Object '%s' could not be created." % key) - logger.log_trace() - return None, errors - - # Set description if there is none, or update it if provided - if kwargs.get('description') or not obj.db.desc: - desc = kwargs.get('description', "You see nothing special.") - obj.db.desc = desc + # Record creator id and creation IP + if ip: obj.db.creator_ip = ip + if caller: obj.db.creator_id = account.id + + # Set description if there is none, or update it if provided + if kwargs.get('description') or not obj.db.desc: + desc = kwargs.get('description', "You see nothing special.") + obj.db.desc = desc + + except Exception as e: + errors.append("There was an error creating the Object '%s'. If this problem persists, contact an admin." % key) + logger.log_trace() + return obj, errors def copy(self, new_key=None): @@ -1890,7 +1883,79 @@ class DefaultCharacter(DefaultObject): a character avatar controlled by an account. """ + # lockstring of newly created rooms, for easy overloading. + # Will be formatted with the appropriate attributes. + lockstring = "puppet:id({character_id}) or pid({account_id}) or perm(Developer) or pperm(Developer)" + + @classmethod + def create(cls, key, account, **kwargs): + """ + Creates a basic Character with default parameters, unless otherwise + specified or extended. + + Provides a friendlier interface to the utils.create_character() function. + + Args: + key (str): Name of the new Character. + account (obj): Account to associate this Character with. Required as + an argument, but one can fake it out by supplying None-- it will + change the default lockset and skip creator attribution. + + Kwargs: + description (str): Brief description for this object. + ip (str): IP address of creator (for object auditing). + + Returns: + character (Object): A newly created Character of the given typeclass. + errors (list): A list of errors in string form, if any. + + """ + errors = [] + obj = None + + # Get IP address of creator, if available + ip = kwargs.pop('ip') + + # If no typeclass supplied, use this class + kwargs['typeclass'] = kwargs.pop('typeclass', cls) + + # Set the supplied key as the name of the intended object + kwargs['key'] = key + + # Get home for character + kwargs['home'] = ObjectDB.objects.get_id(kwargs.get('home', settings.DEFAULT_HOME)) + + # Get permissions + kwargs['permissions'] = kwargs.get('permissions', settings.PERMISSION_ACCOUNT_DEFAULT) + + try: + # Create the Character + obj = create.create_object(**kwargs) + + # Record creator id and creation IP + if ip: obj.db.creator_ip = ip + if account: obj.db.creator_id = account.id + + # Add locks + locks = kwargs.pop('locks') + if not locks and account: + # Allow only the character itself and the creator account to puppet this character (and Developers). + locks = cls.lockstring.format(**{'character_id': obj.id, 'account_id': account.id}) + elif not locks and not account: + locks = cls.lockstring.format(**{'character_id': obj.id, 'account_id': -1}) + + obj.locks.add(locks) + # If no description is set, set a default description + if kwargs.get('description') or not obj.db.desc: + obj.db.desc = kwargs.get('description', "This is a character.") + + except Exception as e: + errors.append("There was an error creating a Character. If this problem persists, contact an admin.") + logger.log_trace() + + return obj, errors + def basetype_setup(self): """ Setup character-specific security. @@ -2007,6 +2072,69 @@ class DefaultRoom(DefaultObject): This is the base room object. It's just like any Object except its location is always `None`. """ + # lockstring of newly created rooms, for easy overloading. + # Will be formatted with the {id} of the creating object. + lockstring = "control:id({id}) or perm(Admin); " \ + "delete:id({id}) or perm(Admin); " \ + "edit:id({id}) or perm(Admin)" + + @classmethod + def create(cls, key, account, **kwargs): + """ + Creates a basic Room with default parameters, unless otherwise + specified or extended. + + Provides a friendlier interface to the utils.create_object() function. + + Args: + key (str): Name of the new Room. + account (obj): Account to associate this Room with. + + Kwargs: + description (str): Brief description for this object. + ip (str): IP address of creator (for object auditing). + + Returns: + room (Object): A newly created Room of the given typeclass. + errors (list): A list of errors in string form, if any. + + """ + errors = [] + obj = None + + # Get IP address of creator, if available + ip = kwargs.pop('ip') + + # If no typeclass supplied, use this class + kwargs['typeclass'] = kwargs.pop('typeclass', cls) + + # Set the supplied key as the name of the intended object + kwargs['key'] = key + + # Get who to send errors to + kwargs['report_to'] = kwargs.pop('report_to', account) + + try: + # Create the Room + obj = create.create_object(**kwargs) + + # Set appropriate locks + lockstring = kwargs.get('locks', cls.lockstring.format(id=account.id)) + obj.locks.add(lockstring) + + # Record creator id and creation IP + if ip: obj.db.creator_ip = ip + if account: obj.db.creator_id = account.id + + # If no description is set, set a default description + if kwargs.get('description') or not obj.db.desc: + obj.db.desc = kwargs.get('description', "This is a room.") + + except Exception as e: + errors.append("There was an error creating a Room. If this problem persists, contact an admin.") + logger.log_trace() + + return obj, errors def basetype_setup(self): """ @@ -2085,6 +2213,13 @@ class DefaultExit(DefaultObject): exit_command = ExitCommand priority = 101 + + # lockstring of newly created exits, for easy overloading. + # Will be formatted with the {id} of the creating object. + lockstring = "control:id({id}) or perm(Admin); " \ + "delete:id({id}) or perm(Admin); " \ + "edit:id({id}) or perm(Admin)" + # Helper classes and methods to implement the Exit. These need not # be overloaded unless one want to change the foundation for how # Exits work. See the end of the class for hook methods to overload. @@ -2122,6 +2257,71 @@ class DefaultExit(DefaultObject): return exit_cmdset # Command hooks + + @classmethod + def create(cls, key, source, dest, account, **kwargs): + """ + Creates a basic Exit with default parameters, unless otherwise + specified or extended. + + Provides a friendlier interface to the utils.create_object() function. + + Args: + key (str): Name of the new Exit, as it should appear from the + source room. + source (Room): The room to create this exit in. + dest (Room): The room to which this exit should go. + account (obj): Account to associate this Exit with. + + Kwargs: + description (str): Brief description for this object. + ip (str): IP address of creator (for object auditing). + + Returns: + exit (Object): A newly created Room of the given typeclass. + errors (list): A list of errors in string form, if any. + + """ + errors = [] + obj = None + + # Get IP address of creator, if available + ip = kwargs.pop('ip') + + # If no typeclass supplied, use this class + kwargs['typeclass'] = kwargs.pop('typeclass', cls) + + # Set the supplied key as the name of the intended object + kwargs['key'] = key + + # Get who to send errors to + kwargs['report_to'] = kwargs.pop('report_to', account) + + # Set to/from rooms + kwargs['location'] = source + kwargs['destination'] = dest + + try: + # Create the Exit + obj = create.create_object(**kwargs) + + # Set appropriate locks + lockstring = kwargs.get('locks', cls.lockstring.format(id=account.id)) + obj.locks.add(lockstring) + + # Record creator id and creation IP + if ip: obj.db.creator_ip = ip + if account: obj.db.creator_id = account.id + + # If no description is set, set a default description + if kwargs.get('description') or not obj.db.desc: + obj.db.desc = kwargs.get('description', "This is an exit.") + + except Exception as e: + errors.append("There was an error creating an Exit. If this problem persists, contact an admin.") + logger.log_trace() + + return obj, errors def basetype_setup(self): """ From d9336dd7189b7e719353de3e95348123a141686f Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 9 Oct 2018 23:04:01 +0000 Subject: [PATCH 040/187] Bugfixes. --- evennia/objects/objects.py | 63 ++++++++++++++++++++++---------------- 1 file changed, 37 insertions(+), 26 deletions(-) diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 7d9e344936..83ec5fd2ff 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -21,6 +21,7 @@ from evennia.scripts.scripthandler import ScriptHandler from evennia.commands import cmdset, command from evennia.commands.cmdsethandler import CmdSetHandler from evennia.commands import cmdhandler +from evennia.utils import create from evennia.utils import search from evennia.utils import logger from evennia.utils import ansi @@ -429,7 +430,8 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): # only allow exact matching if searching the entire database # or unique #dbrefs exact = True - elif candidates is None: + else: + # TODO: write code...if candidates is None: # no custom candidates given - get them automatically if location: # location(s) were given @@ -872,7 +874,7 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): Args: key (str): Name of the new object. - account (Account): Account to attribute this object to + account (Account): Account to attribute this object to. Kwargs: description (str): Brief description for this object. @@ -887,7 +889,7 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): obj = None # Get IP address of creator, if available - ip = kwargs.pop('ip') + ip = kwargs.pop('ip', '') # If no typeclass supplied, use this class kwargs['typeclass'] = kwargs.pop('typeclass', cls) @@ -895,6 +897,9 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): # Set the supplied key as the name of the intended object kwargs['key'] = key + # Get a supplied description, if any + description = kwargs.pop('description', '') + # Create a sane lockstring if one wasn't supplied lockstring = kwargs.get('locks') if account and not lockstring: @@ -907,16 +912,15 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): # Record creator id and creation IP if ip: obj.db.creator_ip = ip - if caller: obj.db.creator_id = account.id + if account: obj.db.creator_id = account.id # Set description if there is none, or update it if provided - if kwargs.get('description') or not obj.db.desc: - desc = kwargs.get('description', "You see nothing special.") + if description or not obj.db.desc: + desc = description if description else "You see nothing special." obj.db.desc = desc except Exception as e: - errors.append("There was an error creating the Object '%s'. If this problem persists, contact an admin." % key) - logger.log_trace() + errors.append(str(e)) return obj, errors @@ -1914,7 +1918,7 @@ class DefaultCharacter(DefaultObject): obj = None # Get IP address of creator, if available - ip = kwargs.pop('ip') + ip = kwargs.pop('ip', '') # If no typeclass supplied, use this class kwargs['typeclass'] = kwargs.pop('typeclass', cls) @@ -1928,6 +1932,12 @@ class DefaultCharacter(DefaultObject): # Get permissions kwargs['permissions'] = kwargs.get('permissions', settings.PERMISSION_ACCOUNT_DEFAULT) + # Get description if provided + description = kwargs.pop('description', '') + + # Get locks if provided + locks = kwargs.pop('locks', '') + try: # Create the Character obj = create.create_object(**kwargs) @@ -1937,7 +1947,6 @@ class DefaultCharacter(DefaultObject): if account: obj.db.creator_id = account.id # Add locks - locks = kwargs.pop('locks') if not locks and account: # Allow only the character itself and the creator account to puppet this character (and Developers). locks = cls.lockstring.format(**{'character_id': obj.id, 'account_id': account.id}) @@ -1947,12 +1956,11 @@ class DefaultCharacter(DefaultObject): obj.locks.add(locks) # If no description is set, set a default description - if kwargs.get('description') or not obj.db.desc: - obj.db.desc = kwargs.get('description', "This is a character.") + if description or not obj.db.desc: + obj.db.desc = description if description else "This is a character." except Exception as e: - errors.append("There was an error creating a Character. If this problem persists, contact an admin.") - logger.log_trace() + errors.append(str(e)) return obj, errors @@ -2103,7 +2111,7 @@ class DefaultRoom(DefaultObject): obj = None # Get IP address of creator, if available - ip = kwargs.pop('ip') + ip = kwargs.pop('ip', '') # If no typeclass supplied, use this class kwargs['typeclass'] = kwargs.pop('typeclass', cls) @@ -2114,6 +2122,9 @@ class DefaultRoom(DefaultObject): # Get who to send errors to kwargs['report_to'] = kwargs.pop('report_to', account) + # Get description, if provided + description = kwargs.pop('description', '') + try: # Create the Room obj = create.create_object(**kwargs) @@ -2127,12 +2138,11 @@ class DefaultRoom(DefaultObject): if account: obj.db.creator_id = account.id # If no description is set, set a default description - if kwargs.get('description') or not obj.db.desc: - obj.db.desc = kwargs.get('description', "This is a room.") + if description or not obj.db.desc: + obj.db.desc = description if description else "This is a room." except Exception as e: - errors.append("There was an error creating a Room. If this problem persists, contact an admin.") - logger.log_trace() + errors.append(str(e)) return obj, errors @@ -2259,7 +2269,7 @@ class DefaultExit(DefaultObject): # Command hooks @classmethod - def create(cls, key, source, dest, account, **kwargs): + def create(cls, key, account, source, dest, **kwargs): """ Creates a basic Exit with default parameters, unless otherwise specified or extended. @@ -2269,9 +2279,9 @@ class DefaultExit(DefaultObject): Args: key (str): Name of the new Exit, as it should appear from the source room. + account (obj): Account to associate this Exit with. source (Room): The room to create this exit in. dest (Room): The room to which this exit should go. - account (obj): Account to associate this Exit with. Kwargs: description (str): Brief description for this object. @@ -2286,7 +2296,7 @@ class DefaultExit(DefaultObject): obj = None # Get IP address of creator, if available - ip = kwargs.pop('ip') + ip = kwargs.pop('ip', '') # If no typeclass supplied, use this class kwargs['typeclass'] = kwargs.pop('typeclass', cls) @@ -2301,6 +2311,8 @@ class DefaultExit(DefaultObject): kwargs['location'] = source kwargs['destination'] = dest + description = kwargs.pop('description', '') + try: # Create the Exit obj = create.create_object(**kwargs) @@ -2314,12 +2326,11 @@ class DefaultExit(DefaultObject): if account: obj.db.creator_id = account.id # If no description is set, set a default description - if kwargs.get('description') or not obj.db.desc: - obj.db.desc = kwargs.get('description', "This is an exit.") + if description or not obj.db.desc: + obj.db.desc = description if description else "This is an exit." except Exception as e: - errors.append("There was an error creating an Exit. If this problem persists, contact an admin.") - logger.log_trace() + errors.append(str(e)) return obj, errors From 940b8e4ff9e9363e0c5d6627f7e9ca2c70d3bac9 Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 9 Oct 2018 23:04:22 +0000 Subject: [PATCH 041/187] Adds unit tests for create() methods. --- evennia/objects/tests.py | 41 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 evennia/objects/tests.py diff --git a/evennia/objects/tests.py b/evennia/objects/tests.py new file mode 100644 index 0000000000..144ac5a678 --- /dev/null +++ b/evennia/objects/tests.py @@ -0,0 +1,41 @@ + +from evennia.utils.test_resources import EvenniaTest +from evennia import DefaultObject, DefaultCharacter, DefaultRoom, DefaultExit + +class ObjectCreationTest(EvenniaTest): + + ip = '212.216.139.14' + + def test_object_create(self): + description = 'A home for a grouch.' + obj, errors = DefaultObject.create('trashcan', self.account, description=description, ip=self.ip) + self.assertTrue(obj, errors) + self.assertFalse(errors, errors) + self.assertEqual(description, obj.db.desc) + self.assertEqual(obj.db.creator_ip, self.ip) + + def test_character_create(self): + description = 'A furry green monster, reeking of garbage.' + obj, errors = DefaultCharacter.create('oscar', self.account, description=description, ip=self.ip) + self.assertTrue(obj, errors) + self.assertFalse(errors, errors) + self.assertEqual(description, obj.db.desc) + self.assertEqual(obj.db.creator_ip, self.ip) + + def test_room_create(self): + description = 'A dimly-lit alley behind the local Chinese restaurant.' + obj, errors = DefaultRoom.create('oscar', self.account, description=description, ip=self.ip) + self.assertTrue(obj, errors) + self.assertFalse(errors, errors) + self.assertEqual(description, obj.db.desc) + self.assertEqual(obj.db.creator_ip, self.ip) + + def test_exit_create(self): + description = 'The steaming depths of the dumpster, ripe with refuse in various states of decomposition.' + obj, errors = DefaultExit.create('in', self.account, self.room1, self.room2, description=description, ip=self.ip) + self.assertTrue(obj, errors) + self.assertFalse(errors, errors) + self.assertEqual(description, obj.db.desc) + self.assertEqual(obj.db.creator_ip, self.ip) + + \ No newline at end of file From 9a7368865d83012b9d6769e11cb1d4c074136408 Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 9 Oct 2018 23:21:39 +0000 Subject: [PATCH 042/187] Modifies Account.create() to use Character.create() on lesser multisession modes. --- evennia/accounts/accounts.py | 39 ++++++++++++------------------------ 1 file changed, 13 insertions(+), 26 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index e7f838ecbd..4825891b9f 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -25,7 +25,7 @@ from evennia.comms.models import ChannelDB from evennia.commands import cmdhandler from evennia.server.models import ServerConfig from evennia.server.throttle import Throttle -from evennia.utils import create, logger +from evennia.utils import class_from_module, create, logger from evennia.utils.utils import (lazy_property, to_str, make_iter, to_unicode, is_iter, variable_from_module) @@ -782,33 +782,20 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): errors.append(string) logger.log_err(string) - if account: - if settings.MULTISESSION_MODE < 2: - default_home = ObjectDB.objects.get_id(settings.DEFAULT_HOME) - - try: - character = create.create_object(character_typeclass, key=account.key, home=default_home, permissions=permissions) - - # set playable character list - account.db._playable_characters.append(character) + if account and settings.MULTISESSION_MODE < 2: + # Load the appropriate Character class + Character = class_from_module(settings.BASE_CHARACTER_TYPECLASS) - # allow only the character itself and the account to puppet this character (and Developers). - character.locks.add("puppet:id(%i) or pid(%i) or perm(Developer) or pperm(Developer)" % - (character.id, account.id)) + # Create the character + character, errs = Character.create(account.key, account, ip=ip) + errors.extend(errs) - # If no description is set, set a default description - if not character.db.desc: - character.db.desc = "This is a character." - # We need to set this to have @ic auto-connect to this character - account.db._last_puppet = character - - # Record creator id and creation IP - if ip: character.db.creator_ip = ip - character.db.creator_id = account.id - - except Exception as e: - errors.append("There was an error creating a Character. If this problem persists, contact an admin.") - logger.log_trace() + if character: + # Update playable character list + account.db._playable_characters.append(character) + + # We need to set this to have @ic auto-connect to this character + account.db._last_puppet = character except Exception: # We are in the middle between logged in and -not, so we have From fadb6b59b718011026f29897c838077f7725cccd Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 9 Oct 2018 23:41:04 +0000 Subject: [PATCH 043/187] Adds create() method to DefaultScript and unit test for DefaultScript.create(). --- evennia/scripts/scripts.py | 28 +++++++++++++++++++++++++++- evennia/scripts/tests.py | 10 ++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/evennia/scripts/scripts.py b/evennia/scripts/scripts.py index 8bff161cf5..ba6f7edff2 100644 --- a/evennia/scripts/scripts.py +++ b/evennia/scripts/scripts.py @@ -12,7 +12,7 @@ from django.utils.translation import ugettext as _ from evennia.typeclasses.models import TypeclassBase from evennia.scripts.models import ScriptDB from evennia.scripts.manager import ScriptManager -from evennia.utils import logger +from evennia.utils import create, logger from future.utils import with_metaclass __all__ = ["DefaultScript", "DoNothing", "Store"] @@ -323,6 +323,32 @@ class DefaultScript(ScriptBase): or describe a state that changes under certain conditions. """ + + @classmethod + def create(cls, key, **kwargs): + """ + Provides a passthrough interface to the utils.create_script() function. + + Args: + key (str): Name of the new object. + + Returns: + object (Object): A newly created object of the given typeclass. + errors (list): A list of errors in string form, if any. + + """ + errors = [] + obj = None + + kwargs['key'] = key + + try: + obj = create.create_script(**kwargs) + except Exception as e: + errors.append("The script '%s' encountered errors and could not be created." % key) + logger.log_err(e) + + return obj, errors def at_script_creation(self): """ diff --git a/evennia/scripts/tests.py b/evennia/scripts/tests.py index dbd36ae956..f5120d0da5 100644 --- a/evennia/scripts/tests.py +++ b/evennia/scripts/tests.py @@ -1,10 +1,20 @@ # this is an optimized version only available in later Django versions from unittest import TestCase +from evennia import DefaultScript from evennia.scripts.models import ScriptDB, ObjectDoesNotExist from evennia.utils.create import create_script +from evennia.utils.test_resources import EvenniaTest from evennia.scripts.scripts import DoNothing +class TestScript(EvenniaTest): + + def test_create(self): + "Check the script can be created via the convenience method." + obj, errors = DefaultScript.create('useless-machine') + self.assertTrue(obj, errors) + self.assertFalse(errors, errors) + class TestScriptDB(TestCase): "Check the singleton/static ScriptDB object works correctly" From eb9fdbc7e2f2448d60dd4a8157adf392cb73deed Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 10 Oct 2018 00:41:27 +0000 Subject: [PATCH 044/187] Implements create() and authenticate() on DefaultGuest object; migrates DefaultAccount.authenticate_guest(). --- evennia/accounts/accounts.py | 164 +++++++++++++++++------------------ evennia/accounts/tests.py | 46 +++++----- 2 files changed, 108 insertions(+), 102 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 4825891b9f..845db6794e 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -413,82 +413,6 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): raise ImproperlyConfigured(msg % validator['NAME']) objs.append(klass(**validator.get('OPTIONS', {}))) return objs - - @classmethod - def authenticate_guest(cls, **kwargs): - """ - Gets or creates a Guest account object. - - Kwargs: - ip (str, optional): IP address of requestor; used for ban checking, - throttling and logging - - """ - errors = [] - account = None - username = None - ip = kwargs.get('ip', '').strip() - - # check if guests are enabled. - if not settings.GUEST_ENABLED: - errors.append('Guest accounts are not enabled on this server.') - return None, errors - - # See if authentication is currently being throttled - if ip and LOGIN_THROTTLE.check(ip): - errors.append('Too many login failures; please try again in a few minutes.') - - # With throttle active, do not log continued hits-- it is a - # waste of storage and can be abused to make your logs harder to - # read and/or fill up your disk. - return None, errors - - # check if IP banned - if ip and cls.is_banned(ip=ip): - errors.append("|rYou have been banned and cannot continue from here." \ - "\nIf you feel this ban is in error, please email an admin.|x") - logger.log_sec('Authentication Denied (Banned): %s (IP: %s).' % ('guest', ip)) - LOGIN_THROTTLE.update(ip, 'Too many sightings of banned IP.') - return None, errors - - try: - # Find an available guest name. - for name in settings.GUEST_LIST: - if not AccountDB.objects.filter(username__iexact=name).count(): - username = name - break - if not username: - errors.append("All guest accounts are in use. Please try again later.") - if ip: LOGIN_THROTTLE.update(ip, 'Too many requests for Guest access.') - return None, errors - else: - # build a new account with the found guest username - password = "%016x" % getrandbits(64) - home = ObjectDB.objects.get_id(settings.GUEST_HOME) - permissions = settings.PERMISSION_GUEST_DEFAULT - character_typeclass = settings.BASE_CHARACTER_TYPECLASS - account_typeclass = settings.BASE_GUEST_TYPECLASS - account, errs = cls.create( - guest=True, - username=username, - password=password, - permissions=permissions, - account_typeclass=account_typeclass, - character_typeclass=character_typeclass, - ip=ip, - ) - errors.extend(errs) - return account, errors - - except Exception: - # We are in the middle between logged in and -not, so we have - # to handle tracebacks ourselves at this point. If we don't, - # we won't see any errors at all. - errors.append("An error occurred. Please e-mail an admin if the problem persists.") - logger.log_trace() - return None, errors - - return account, errors @classmethod def authenticate(cls, username, password, ip='', **kwargs): @@ -700,7 +624,7 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): guest (bool, optional): Whether or not this is to be a Guest account permissions (str, optional): Default permissions for the Account - account_typeclass (str, optional): Typeclass to use for new Account + typeclass (str, optional): Typeclass to use for new Account character_typeclass (str, optional): Typeclass to use for new char when applicable. @@ -719,8 +643,7 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): guest = kwargs.get('guest', False) permissions = kwargs.get('permissions', settings.PERMISSION_ACCOUNT_DEFAULT) - account_typeclass = kwargs.get('account_typeclass', settings.BASE_ACCOUNT_TYPECLASS) - character_typeclass = kwargs.get('character_typeclass', settings.BASE_CHARACTER_TYPECLASS) + typeclass = kwargs.get('typeclass', settings.BASE_ACCOUNT_TYPECLASS) ip = kwargs.get('ip', '') if ip and CREATION_THROTTLE.check(ip): @@ -759,7 +682,7 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): # everything's ok. Create the new account account. try: try: - account = create.create_account(username, email, password, permissions=permissions, typeclass=account_typeclass) + account = create.create_account(username, email, password, permissions=permissions, typeclass=typeclass) logger.log_sec('Account Created: %s (IP: %s).' % (account, ip)) except Exception as e: @@ -784,10 +707,15 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): if account and settings.MULTISESSION_MODE < 2: # Load the appropriate Character class - Character = class_from_module(settings.BASE_CHARACTER_TYPECLASS) + character_typeclass = kwargs.get('character_typeclass', settings.BASE_CHARACTER_TYPECLASS) + character_home = kwargs.get('home') + Character = class_from_module(character_typeclass) # Create the character - character, errs = Character.create(account.key, account, ip=ip) + character, errs = Character.create( + account.key, account, ip=ip, typeclass=character_typeclass, + permissions=permissions, home=character_home + ) errors.extend(errs) if character: @@ -1453,6 +1381,78 @@ class DefaultGuest(DefaultAccount): This class is used for guest logins. Unlike Accounts, Guests and their characters are deleted after disconnection. """ + + @classmethod + def create(cls, **kwargs): + """ + Forwards request to cls.authenticate(); returns a DefaultGuest object + if one is available for use. + """ + return cls.authenticate(**kwargs) + + @classmethod + def authenticate(cls, **kwargs): + """ + Gets or creates a Guest account object. + + Kwargs: + ip (str, optional): IP address of requestor; used for ban checking, + throttling and logging + + Returns: + account (Object): Guest account object, if available + errors (list): List of error messages accrued during this request. + + """ + errors = [] + account = None + username = None + ip = kwargs.get('ip', '').strip() + + # check if guests are enabled. + if not settings.GUEST_ENABLED: + errors.append('Guest accounts are not enabled on this server.') + return None, errors + + try: + # Find an available guest name. + for name in settings.GUEST_LIST: + if not AccountDB.objects.filter(username__iexact=name).count(): + username = name + break + if not username: + errors.append("All guest accounts are in use. Please try again later.") + if ip: LOGIN_THROTTLE.update(ip, 'Too many requests for Guest access.') + return None, errors + else: + # build a new account with the found guest username + password = "%016x" % getrandbits(64) + home = settings.GUEST_HOME + permissions = settings.PERMISSION_GUEST_DEFAULT + typeclass = settings.BASE_GUEST_TYPECLASS + + # Call parent class creator + account, errs = super(DefaultGuest, cls).create( + guest=True, + username=username, + password=password, + permissions=permissions, + typeclass=typeclass, + home=home, + ip=ip, + ) + errors.extend(errs) + return account, errors + + except Exception as e: + # We are in the middle between logged in and -not, so we have + # to handle tracebacks ourselves at this point. If we don't, + # we won't see any errors at all. + errors.append("An error occurred. Please e-mail an admin if the problem persists.") + logger.log_trace() + return None, errors + + return account, errors def at_post_login(self, session=None, **kwargs): """ diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index f68d344e37..e78cf9ffd1 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -6,8 +6,9 @@ from unittest import TestCase from django.test import override_settings from evennia.accounts.accounts import AccountSessionHandler -from evennia.accounts.accounts import DefaultAccount +from evennia.accounts.accounts import DefaultAccount, DefaultGuest from evennia.server.session import Session +from evennia.utils.test_resources import EvenniaTest from evennia.utils import create from django.conf import settings @@ -59,9 +60,31 @@ class TestAccountSessionHandler(TestCase): def test_count(self): "Check count method" self.assertEqual(self.handler.count(), len(self.handler.get())) + +class TestDefaultGuest(EvenniaTest): + "Check DefaultGuest class" + + ip = '212.216.134.22' + + def test_authenticate(self): + # Guest account should not be permitted + account, errors = DefaultGuest.authenticate(ip=self.ip) + self.assertFalse(account, 'Guest account was created despite being disabled.') + + settings.GUEST_ENABLED = True + settings.GUEST_LIST = ['bruce_wayne'] + + # Create a guest account + account, errors = DefaultGuest.authenticate(ip=self.ip) + self.assertTrue(account, 'Guest account should have been created.') + + # Create a second guest account + account, errors = DefaultGuest.authenticate(ip=self.ip) + self.assertFalse(account, 'Two guest accounts were created with a single entry on the guest list!') + + settings.GUEST_ENABLED = False - -class TestDefaultAccount(TestCase): +class TestDefaultAccount(EvenniaTest): "Check DefaultAccount class" def setUp(self): @@ -92,23 +115,6 @@ class TestDefaultAccount(TestCase): account, errors = DefaultAccount.create(username='Ziggy', password='starman11') self.assertFalse(account, 'Duplicate account name should not have been allowed.') - # Guest account should not be permitted - account, errors = DefaultAccount.authenticate_guest() - self.assertFalse(account, 'Guest account was created despite being disabled.') - - settings.GUEST_ENABLED = True - settings.GUEST_LIST = ['bruce_wayne'] - - # Create a guest account - account, errors = DefaultAccount.authenticate_guest() - self.assertTrue(account, 'Guest account should have been created.') - - # Create a second guest account - account, errors = DefaultAccount.authenticate_guest() - self.assertFalse(account, 'Two guest accounts were created despite a single entry on the guest list!') - - settings.GUEST_ENABLED = False - def test_throttle(self): "Confirm throttle activates on too many failures." for x in xrange(20): From 06f2cba42b0414a7f038d0c6e91274513eff5d6e Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 10 Oct 2018 00:48:54 +0000 Subject: [PATCH 045/187] Changes method used for guest authentication. --- evennia/commands/default/unloggedin.py | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/evennia/commands/default/unloggedin.py b/evennia/commands/default/unloggedin.py index 7cf8b40c88..dc0f1ed476 100644 --- a/evennia/commands/default/unloggedin.py +++ b/evennia/commands/default/unloggedin.py @@ -109,9 +109,6 @@ class CmdUnconnectedConnect(COMMAND_DEFAULT_CLASS): session = self.caller address = session.address - # Get account class - Account = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) - args = self.args # extract double quote parts parts = [part.strip() for part in re.split(r"\"", args) if part.strip()] @@ -121,7 +118,10 @@ class CmdUnconnectedConnect(COMMAND_DEFAULT_CLASS): # Guest login if len(parts) == 1 and parts[0].lower() == "guest": - account, errors = Account.authenticate_guest(ip=address) + # Get Guest typeclass + Guest = class_from_module(settings.BASE_GUEST_TYPECLASS) + + account, errors = Guest.authenticate(ip=address) if account: session.sessionhandler.login(session, account) return @@ -133,6 +133,9 @@ class CmdUnconnectedConnect(COMMAND_DEFAULT_CLASS): session.msg("\n\r Usage (without <>): connect ") return + # Get account class + Account = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) + name, password = parts account, errors = Account.authenticate(username=name, password=password, ip=address, session=session) if account: From 7d93098176b1a9288f21c2e07183bcc7555d71fe Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 10 Oct 2018 00:57:39 +0000 Subject: [PATCH 046/187] Corrects additional incorrect guest authentication method. --- evennia/commands/default/unloggedin.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/evennia/commands/default/unloggedin.py b/evennia/commands/default/unloggedin.py index dc0f1ed476..7ff2c9a29a 100644 --- a/evennia/commands/default/unloggedin.py +++ b/evennia/commands/default/unloggedin.py @@ -42,11 +42,11 @@ def create_guest_account(session): address = session.address # Get account class - Account = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) + Guest = class_from_module(settings.BASE_GUEST_TYPECLASS) # Get an available guest account - # authenticate_guest() handles its own throttling - account, errors = Account.authenticate_guest(ip=address) + # authenticate() handles its own throttling + account, errors = Guest.authenticate(ip=address) if account: return enabled, account else: From 60c9d2c6ec13a08b520bfb9640923dd74c676c43 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 10 Oct 2018 01:15:19 +0000 Subject: [PATCH 047/187] Redirects system errors from user-facing return to error log. --- evennia/objects/objects.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 83ec5fd2ff..1b5cca6f64 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -920,7 +920,8 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): obj.db.desc = desc except Exception as e: - errors.append(str(e)) + errors.append("An error occurred while creating this '%s' object." % key) + logger.log_err(e) return obj, errors @@ -1960,7 +1961,8 @@ class DefaultCharacter(DefaultObject): obj.db.desc = description if description else "This is a character." except Exception as e: - errors.append(str(e)) + errors.append("An error occurred while creating this '%s' object." % key) + logger.log_err(e) return obj, errors @@ -2142,7 +2144,8 @@ class DefaultRoom(DefaultObject): obj.db.desc = description if description else "This is a room." except Exception as e: - errors.append(str(e)) + errors.append("An error occurred while creating this '%s' object." % key) + logger.log_err(e) return obj, errors @@ -2330,7 +2333,8 @@ class DefaultExit(DefaultObject): obj.db.desc = description if description else "This is an exit." except Exception as e: - errors.append(str(e)) + errors.append("An error occurred while creating this '%s' object." % key) + logger.log_err(e) return obj, errors From 8d3e946f2d588179ccd92ad8563d1dc6d07b332b Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sun, 14 Oct 2018 16:42:28 -0500 Subject: [PATCH 048/187] test evennia.utils.create.create_script --- evennia/utils/test_resources.py | 35 +++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/evennia/utils/test_resources.py b/evennia/utils/test_resources.py index b4124b7219..8e954592ad 100644 --- a/evennia/utils/test_resources.py +++ b/evennia/utils/test_resources.py @@ -66,3 +66,38 @@ class EvenniaTest(TestCase): self.account.delete() self.account2.delete() super(EvenniaTest, self).tearDown() + + +import unittest + +class TestScript(DefaultScript): + + # script test params + call_super = None + interval = 1 + + def at_script_creation(self): + if self.call_super: + super(TestScript, self).at_script_creation() + self.key = 'testing_script' + # self.interval = 10 + # self.repeats = 1 + self.persistent = False + +class TestCreateScript(EvenniaTest): + + def setUp(self): + super(EvenniaTest, self).setUp() + + def tearDown(self): + super(EvenniaTest, self).tearDown() + + @unittest.expectedFailure + def test_create_script(self): + TestScript.call_super = True + + script = create.create_script(TestScript, key="TestScript") + assert script is not None + assert script.interval == 1 + assert script.repeats == 0 + assert script.key == 'testing_script' From 7664065a454bed6f426688f35b561ecb7e299d5f Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sun, 14 Oct 2018 17:09:01 -0500 Subject: [PATCH 049/187] Refactoring. Test to reproduce #1663 --- evennia/utils/test_resources.py | 42 ++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/evennia/utils/test_resources.py b/evennia/utils/test_resources.py index 8e954592ad..15cf862dd7 100644 --- a/evennia/utils/test_resources.py +++ b/evennia/utils/test_resources.py @@ -70,20 +70,6 @@ class EvenniaTest(TestCase): import unittest -class TestScript(DefaultScript): - - # script test params - call_super = None - interval = 1 - - def at_script_creation(self): - if self.call_super: - super(TestScript, self).at_script_creation() - self.key = 'testing_script' - # self.interval = 10 - # self.repeats = 1 - self.persistent = False - class TestCreateScript(EvenniaTest): def setUp(self): @@ -92,12 +78,30 @@ class TestCreateScript(EvenniaTest): def tearDown(self): super(EvenniaTest, self).tearDown() - @unittest.expectedFailure def test_create_script(self): - TestScript.call_super = True + class TestScript(DefaultScript): + def at_script_creation(self): + self.key = 'testing_script' + self.interval = 10 + self.persistent = False - script = create.create_script(TestScript, key="TestScript") + script = create.create_script(TestScript) assert script is not None - assert script.interval == 1 - assert script.repeats == 0 + assert script.interval == 10 assert script.key == 'testing_script' + + # @unittest.expectedFailure + def test_create_script_w_one_repeat(self): + class TestScript(DefaultScript): + def at_script_creation(self): + self.key = 'testing_script' + self.interval = 10 + self.repeats = 1 + self.persistent = False + + with self.assertRaises(TypeError): + script = create.create_script(TestScript) + # assert script is not None + # assert script.interval == 10 + # assert script.repeats == 1 + # assert script.key == 'testing_script' From ea61719edf8ae4dddd6c73265125289119c3a598 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sun, 14 Oct 2018 19:07:46 -0500 Subject: [PATCH 050/187] Must use different classes for each test so the django RuntimeWarning doesn't occur --- evennia/utils/test_resources.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/evennia/utils/test_resources.py b/evennia/utils/test_resources.py index 15cf862dd7..a98627a67c 100644 --- a/evennia/utils/test_resources.py +++ b/evennia/utils/test_resources.py @@ -69,6 +69,7 @@ class EvenniaTest(TestCase): import unittest +import inspect class TestCreateScript(EvenniaTest): @@ -79,29 +80,29 @@ class TestCreateScript(EvenniaTest): super(EvenniaTest, self).tearDown() def test_create_script(self): - class TestScript(DefaultScript): + class TestScriptA(DefaultScript): def at_script_creation(self): - self.key = 'testing_script' + self.key = 'test_script' self.interval = 10 self.persistent = False - script = create.create_script(TestScript) + script = create.create_script(TestScriptA, key='test_script') assert script is not None assert script.interval == 10 - assert script.key == 'testing_script' + assert script.key == 'test_script' # @unittest.expectedFailure def test_create_script_w_one_repeat(self): - class TestScript(DefaultScript): + class TestScriptB(DefaultScript): def at_script_creation(self): - self.key = 'testing_script' + self.key = 'test_script' self.interval = 10 self.repeats = 1 self.persistent = False with self.assertRaises(TypeError): - script = create.create_script(TestScript) + script = create.create_script(TestScriptB, key='test_script') # assert script is not None # assert script.interval == 10 # assert script.repeats == 1 - # assert script.key == 'testing_script' + # assert script.key == 'test_script' From 246cd57243924f3c3a1793e1fc329b6cb399c605 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sun, 14 Oct 2018 19:09:38 -0500 Subject: [PATCH 051/187] Use unittest.expectFailure decoration --- evennia/utils/test_resources.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/evennia/utils/test_resources.py b/evennia/utils/test_resources.py index a98627a67c..ac26fe40aa 100644 --- a/evennia/utils/test_resources.py +++ b/evennia/utils/test_resources.py @@ -91,7 +91,7 @@ class TestCreateScript(EvenniaTest): assert script.interval == 10 assert script.key == 'test_script' - # @unittest.expectedFailure + @unittest.expectedFailure def test_create_script_w_one_repeat(self): class TestScriptB(DefaultScript): def at_script_creation(self): @@ -100,9 +100,8 @@ class TestCreateScript(EvenniaTest): self.repeats = 1 self.persistent = False - with self.assertRaises(TypeError): - script = create.create_script(TestScriptB, key='test_script') - # assert script is not None - # assert script.interval == 10 - # assert script.repeats == 1 - # assert script.key == 'test_script' + script = create.create_script(TestScriptB, key='test_script') + assert script is not None + assert script.interval == 10 + assert script.repeats == 1 + assert script.key == 'test_script' From c69675e925f960533eb7d45768a200d8c37b8289 Mon Sep 17 00:00:00 2001 From: Griatch Date: Tue, 16 Oct 2018 10:13:05 +0200 Subject: [PATCH 052/187] Add requirement changes to 0.8 changelog, for clarity --- CHANGELOG.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index afe5ad1ba7..13c450939f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ ## Evennia 0.8 (2018) +### Requirements + +- Up requirements to Django 1.11.x, Twisted 18 and pillow 5.2.0 +- Add `autobahn` dependency for Websocket support, removing very old embedded txWS library (from a + time before websocket specification was still not fixed). +- Add `inflect` dependency for automatic pluralization of object names. + ### Server/Portal - Removed `evennia_runner`, completely refactor `evennia_launcher.py` (the 'evennia' program) @@ -85,7 +92,6 @@ ### General -- Up requirements to Django 1.11.x, Twisted 18 and pillow 5.2.0 - Start structuring the `CHANGELOG` to list features in more detail. - Docker image `evennia/evennia:develop` is now auto-built, tracking the develop branch. - Inflection and grouping of multiple objects in default room (an box, three boxes) From 465b0f5b07ffa969aee9b97c70dcaf8ddac958a7 Mon Sep 17 00:00:00 2001 From: Tehom Date: Tue, 16 Oct 2018 19:51:43 -0400 Subject: [PATCH 053/187] Add stub for testing Telnet --- evennia/server/portal/tests.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/evennia/server/portal/tests.py b/evennia/server/portal/tests.py index be400144c6..b09f71ae03 100644 --- a/evennia/server/portal/tests.py +++ b/evennia/server/portal/tests.py @@ -11,6 +11,11 @@ except ImportError: import string from evennia.server.portal import irc +from twisted.test import proto_helpers +from twisted.trial.unittest import TestCase as TwistedTestCase + +from .telnet import TelnetServerFactory + class TestIRC(TestCase): @@ -73,3 +78,15 @@ class TestIRC(TestCase): s = r'|wthis|Xis|gis|Ma|C|complex|*string' self.assertEqual(irc.parse_irc_to_ansi(irc.parse_ansi_to_irc(s)), s) + + +class TestTelnet(TwistedTestCase): + def setUp(self): + super(TestTelnet, self).setUp() + factory = TelnetServerFactory() + self.proto = factory.buildProtocol(("localhost", 0)) + self.transport = proto_helpers.StringTransport() + + def test_connect(self): + self.proto.makeConnection(self.transport) + # TODO: Add rest of stuff for testing connection From fde9f1518893fd4973aaedfb964d672cc9cdf593 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Tue, 16 Oct 2018 19:31:10 -0500 Subject: [PATCH 054/187] Tests for @desc obj= --- evennia/commands/default/tests.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index a3be98984a..6010b008da 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -263,6 +263,20 @@ class TestBuilding(CommandTest): def test_desc(self): self.call(building.CmdDesc(), "Obj2=TestDesc", "The description was set on Obj2(#5).") + def test_empty_desc(self): + o2d = self.obj2.db.desc + r1d = self.room1.db.desc + self.call(building.CmdDesc(), "Obj2=", "The description was set on Obj2(#5).") + assert self.obj2.db.desc == '' + assert self.room1.db.desc == r1d + + def test_desc_default_to_room(self): + o2d = self.obj2.db.desc + r1d = self.room1.db.desc + self.call(building.CmdDesc(), "Obj2", "The description was set on Room(#1).") + assert self.obj2.db.desc == o2d + assert self.room1.db.desc == 'Obj2' + def test_wipe(self): confirm = building.CmdDestroy.confirm building.CmdDestroy.confirm = False @@ -446,4 +460,4 @@ class TestUnconnectedCommand(CommandTest): settings.SERVERNAME, datetime.datetime.fromtimestamp(gametime.SERVER_START_TIME).ctime(), SESSIONS.account_count(), utils.get_evennia_version()) - self.call(unloggedin.CmdUnconnectedInfo(), "", expected) \ No newline at end of file + self.call(unloggedin.CmdUnconnectedInfo(), "", expected) From 5b315e7ad56eda83ade2a4470de858980a0aa3f5 Mon Sep 17 00:00:00 2001 From: Tehom Date: Tue, 16 Oct 2018 20:33:12 -0400 Subject: [PATCH 055/187] Add some cleanup steps to prevent unclean reactor --- evennia/server/portal/telnet.py | 2 +- evennia/server/portal/tests.py | 16 ++++++++++++++-- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/evennia/server/portal/telnet.py b/evennia/server/portal/telnet.py index 955ea5e918..83e2fa03a2 100644 --- a/evennia/server/portal/telnet.py +++ b/evennia/server/portal/telnet.py @@ -84,7 +84,7 @@ class TelnetProtocol(Telnet, StatefulTelnetProtocol, Session): from evennia.utils.utils import delay # timeout the handshakes in case the client doesn't reply at all - delay(2, callback=self.handshake_done, timeout=True) + self._handshake_delay = delay(2, callback=self.handshake_done, timeout=True) # TCP/IP keepalive watches for dead links self.transport.setTcpKeepAlive(1) diff --git a/evennia/server/portal/tests.py b/evennia/server/portal/tests.py index b09f71ae03..53a732f121 100644 --- a/evennia/server/portal/tests.py +++ b/evennia/server/portal/tests.py @@ -8,13 +8,15 @@ try: except ImportError: import unittest +from mock import Mock import string from evennia.server.portal import irc from twisted.test import proto_helpers from twisted.trial.unittest import TestCase as TwistedTestCase -from .telnet import TelnetServerFactory +from .telnet import TelnetServerFactory, TelnetProtocol +from .portal import PORTAL_SESSIONS class TestIRC(TestCase): @@ -84,9 +86,19 @@ class TestTelnet(TwistedTestCase): def setUp(self): super(TestTelnet, self).setUp() factory = TelnetServerFactory() + factory.protocol = TelnetProtocol + factory.sessionhandler = PORTAL_SESSIONS + factory.sessionhandler.portal = Mock() self.proto = factory.buildProtocol(("localhost", 0)) self.transport = proto_helpers.StringTransport() + self.addCleanup(factory.sessionhandler.disconnect_all) def test_connect(self): - self.proto.makeConnection(self.transport) + self.transport.client = ["localhost"] + self.transport.setTcpKeepAlive = Mock() + d = self.proto.makeConnection(self.transport) # TODO: Add rest of stuff for testing connection + # clean up to prevent Unclean reactor + self.proto.nop_keep_alive.stop() + self.proto._handshake_delay.cancel() + return d From 9238a4c6340335c6c5c212476f0d4093b24c1ba8 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Tue, 16 Oct 2018 19:49:19 -0500 Subject: [PATCH 056/187] In @desc command, validate rhs based on = sign present in orig args. Default MUX parsing assigns None to rhs if there is nothing on the right of the = sign. --- evennia/commands/default/building.py | 4 ++-- evennia/commands/default/tests.py | 4 ++++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/evennia/commands/default/building.py b/evennia/commands/default/building.py index 0afeea8fe5..aaafea30ac 100644 --- a/evennia/commands/default/building.py +++ b/evennia/commands/default/building.py @@ -589,12 +589,12 @@ class CmdDesc(COMMAND_DEFAULT_CLASS): self.edit_handler() return - if self.rhs: + if '=' in self.args: # We have an = obj = caller.search(self.lhs) if not obj: return - desc = self.rhs + desc = self.rhs or '' else: obj = caller.location or self.msg("|rYou can't describe oblivion.|n") if not obj: diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index 6010b008da..6e5877608c 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -264,6 +264,9 @@ class TestBuilding(CommandTest): self.call(building.CmdDesc(), "Obj2=TestDesc", "The description was set on Obj2(#5).") def test_empty_desc(self): + """ + empty desc sets desc as '' + """ o2d = self.obj2.db.desc r1d = self.room1.db.desc self.call(building.CmdDesc(), "Obj2=", "The description was set on Obj2(#5).") @@ -271,6 +274,7 @@ class TestBuilding(CommandTest): assert self.room1.db.desc == r1d def test_desc_default_to_room(self): + """no rhs changes room's desc""" o2d = self.obj2.db.desc r1d = self.room1.db.desc self.call(building.CmdDesc(), "Obj2", "The description was set on Room(#1).") From ea55f8b782741955ce084b335044dc5bbcb5aa04 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Tue, 16 Oct 2018 20:09:17 -0500 Subject: [PATCH 057/187] Harden assertions --- evennia/commands/default/tests.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index 6e5877608c..1b97a59f9f 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -270,7 +270,7 @@ class TestBuilding(CommandTest): o2d = self.obj2.db.desc r1d = self.room1.db.desc self.call(building.CmdDesc(), "Obj2=", "The description was set on Obj2(#5).") - assert self.obj2.db.desc == '' + assert self.obj2.db.desc == '' and self.obj2.db.desc != o2d assert self.room1.db.desc == r1d def test_desc_default_to_room(self): @@ -279,7 +279,7 @@ class TestBuilding(CommandTest): r1d = self.room1.db.desc self.call(building.CmdDesc(), "Obj2", "The description was set on Room(#1).") assert self.obj2.db.desc == o2d - assert self.room1.db.desc == 'Obj2' + assert self.room1.db.desc == 'Obj2' and self.room1.db.desc != r1d def test_wipe(self): confirm = building.CmdDestroy.confirm From 4561e3f5f4aab44fd64d0f7a6f4970448119638c Mon Sep 17 00:00:00 2001 From: Tehom Date: Wed, 17 Oct 2018 01:50:57 -0400 Subject: [PATCH 058/187] Add test of NOGOAHEAD --- evennia/server/portal/tests.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/evennia/server/portal/tests.py b/evennia/server/portal/tests.py index 53a732f121..4142ca297e 100644 --- a/evennia/server/portal/tests.py +++ b/evennia/server/portal/tests.py @@ -12,11 +12,13 @@ from mock import Mock import string from evennia.server.portal import irc +from twisted.conch.telnet import IAC, NOP, LINEMODE, GA, WILL, WONT, ECHO, NULL, DONT from twisted.test import proto_helpers from twisted.trial.unittest import TestCase as TwistedTestCase from .telnet import TelnetServerFactory, TelnetProtocol from .portal import PORTAL_SESSIONS +from .suppress_ga import SUPPRESS_GA class TestIRC(TestCase): @@ -98,6 +100,10 @@ class TestTelnet(TwistedTestCase): self.transport.setTcpKeepAlive = Mock() d = self.proto.makeConnection(self.transport) # TODO: Add rest of stuff for testing connection + self.assertTrue(self.proto.protocol_flags["NOGOAHEAD"]) + self.proto.dataReceived(IAC + DONT+ SUPPRESS_GA) + self.assertFalse(self.proto.protocol_flags["NOGOAHEAD"]) + self.assertEqual(self.proto.handshakes, 7) # clean up to prevent Unclean reactor self.proto.nop_keep_alive.stop() self.proto._handshake_delay.cancel() From b69e0f8dbcda68fd3fd772a614f589a5eaf4bf75 Mon Sep 17 00:00:00 2001 From: Tehom Date: Wed, 17 Oct 2018 12:49:48 -0400 Subject: [PATCH 059/187] Add various simple tests for different handshakes --- evennia/server/portal/tests.py | 49 +++++++++++++++++++++++++++++++--- 1 file changed, 45 insertions(+), 4 deletions(-) diff --git a/evennia/server/portal/tests.py b/evennia/server/portal/tests.py index 4142ca297e..791e5172a4 100644 --- a/evennia/server/portal/tests.py +++ b/evennia/server/portal/tests.py @@ -12,13 +12,19 @@ from mock import Mock import string from evennia.server.portal import irc -from twisted.conch.telnet import IAC, NOP, LINEMODE, GA, WILL, WONT, ECHO, NULL, DONT +from twisted.conch.telnet import IAC, WILL, DONT, SB, SE, NAWS, DO from twisted.test import proto_helpers from twisted.trial.unittest import TestCase as TwistedTestCase from .telnet import TelnetServerFactory, TelnetProtocol from .portal import PORTAL_SESSIONS from .suppress_ga import SUPPRESS_GA +from .naws import DEFAULT_HEIGHT, DEFAULT_WIDTH +from .ttype import TTYPE, IS +from .mccp import MCCP +from .mssp import MSSP +from .mxp import MXP +from .telnet_oob import MSDP, MSDP_VAL, MSDP_VAR class TestIRC(TestCase): @@ -95,15 +101,50 @@ class TestTelnet(TwistedTestCase): self.transport = proto_helpers.StringTransport() self.addCleanup(factory.sessionhandler.disconnect_all) - def test_connect(self): + def test_mudlet_ttype(self): self.transport.client = ["localhost"] self.transport.setTcpKeepAlive = Mock() d = self.proto.makeConnection(self.transport) - # TODO: Add rest of stuff for testing connection + # test suppress_ga self.assertTrue(self.proto.protocol_flags["NOGOAHEAD"]) - self.proto.dataReceived(IAC + DONT+ SUPPRESS_GA) + self.proto.dataReceived(IAC + DONT + SUPPRESS_GA) self.assertFalse(self.proto.protocol_flags["NOGOAHEAD"]) self.assertEqual(self.proto.handshakes, 7) + # test naws + self.assertEqual(self.proto.protocol_flags['SCREENWIDTH'], {0: DEFAULT_WIDTH}) + self.assertEqual(self.proto.protocol_flags['SCREENHEIGHT'], {0: DEFAULT_HEIGHT}) + self.proto.dataReceived(IAC + WILL + NAWS) + self.proto.dataReceived([IAC, SB, NAWS, '', 'x', '', 'd', IAC, SE]) + self.assertEqual(self.proto.protocol_flags['SCREENWIDTH'][0], 120) + self.assertEqual(self.proto.protocol_flags['SCREENHEIGHT'][0], 100) + self.assertEqual(self.proto.handshakes, 6) + # test ttype + self.assertTrue(self.proto.protocol_flags["FORCEDENDLINE"]) + self.assertFalse(self.proto.protocol_flags["TTYPE"]) + self.assertTrue(self.proto.protocol_flags["ANSI"]) + self.proto.dataReceived(IAC + WILL + TTYPE) + self.proto.dataReceived([IAC, SB, TTYPE, IS, "MUDLET", IAC, SE]) + self.assertTrue(self.proto.protocol_flags["XTERM256"]) + self.assertEqual(self.proto.protocol_flags["CLIENTNAME"], "MUDLET") + self.proto.dataReceived([IAC, SB, TTYPE, IS, "XTERM", IAC, SE]) + self.proto.dataReceived([IAC, SB, TTYPE, IS, "MTTS 137", IAC, SE]) + self.assertEqual(self.proto.handshakes, 5) + # test mccp + self.proto.dataReceived(IAC + DONT + MCCP) + self.assertFalse(self.proto.protocol_flags['MCCP']) + self.assertEqual(self.proto.handshakes, 4) + # test mssp + self.proto.dataReceived(IAC + DONT + MSSP) + self.assertEqual(self.proto.handshakes, 3) + # test oob + self.proto.dataReceived(IAC + DO + MSDP) + self.proto.dataReceived([IAC, SB, MSDP, MSDP_VAR, "LIST", MSDP_VAL, "COMMANDS", IAC, SE]) + self.assertTrue(self.proto.protocol_flags['OOB']) + self.assertEqual(self.proto.handshakes, 2) + # test mxp + self.proto.dataReceived(IAC + DONT + MXP) + self.assertFalse(self.proto.protocol_flags['MXP']) + self.assertEqual(self.proto.handshakes, 1) # clean up to prevent Unclean reactor self.proto.nop_keep_alive.stop() self.proto._handshake_delay.cancel() From 6d0a670340b4812215626c9ff68af36c60c566b7 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 17 Oct 2018 20:25:28 +0000 Subject: [PATCH 060/187] Compacts options dict for username validators list. --- evennia/settings_default.py | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/evennia/settings_default.py b/evennia/settings_default.py index d6da94fb2f..7926ed276c 100644 --- a/evennia/settings_default.py +++ b/evennia/settings_default.py @@ -813,25 +813,12 @@ AUTH_PASSWORD_VALIDATORS = [ # Username validation plugins AUTH_USERNAME_VALIDATORS = [ - { - 'NAME': 'django.contrib.auth.validators.ASCIIUsernameValidator', - }, - { - 'NAME': 'django.core.validators.MinLengthValidator', - 'OPTIONS': { - 'limit_value': 3, - } - }, - { - 'NAME': 'django.core.validators.MaxLengthValidator', - 'OPTIONS': { - 'limit_value': 30, - } - }, - { - 'NAME': 'evennia.server.validators.EvenniaUsernameAvailabilityValidator', - }, -] + {'NAME': 'django.contrib.auth.validators.ASCIIUsernameValidator'}, + {'NAME': 'django.core.validators.MinLengthValidator', + 'OPTIONS': {'limit_value': 3}}, + {'NAME': 'django.core.validators.MaxLengthValidator', + 'OPTIONS': {'limit_value': 30}}, + {'NAME': 'evennia.server.validators.EvenniaUsernameAvailabilityValidator'}] # Use a custom test runner that just tests Evennia-specific apps. TEST_RUNNER = 'evennia.server.tests.EvenniaTestSuiteRunner' From 98bc76cd60823d63addba635246ec7194b7b3e51 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 17 Oct 2018 20:26:51 +0000 Subject: [PATCH 061/187] Adds create() method to DefaultChannel object, and unit test. --- evennia/comms/comms.py | 38 +++++++++++++++++++++++++++++++++++++- evennia/comms/tests.py | 13 +++++++++++++ 2 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 evennia/comms/tests.py diff --git a/evennia/comms/comms.py b/evennia/comms/comms.py index a7d74ae0e4..adb90c66ac 100644 --- a/evennia/comms/comms.py +++ b/evennia/comms/comms.py @@ -5,7 +5,7 @@ Base typeclass for in-game Channels. from evennia.typeclasses.models import TypeclassBase from evennia.comms.models import TempMsg, ChannelDB from evennia.comms.managers import ChannelManager -from evennia.utils import logger +from evennia.utils import create, logger from evennia.utils.utils import make_iter from future.utils import with_metaclass _CHANNEL_HANDLER = None @@ -220,6 +220,42 @@ class DefaultChannel(with_metaclass(TypeclassBase, ChannelDB)): return self.locks.check(accessing_obj, access_type=access_type, default=default, no_superuser_bypass=no_superuser_bypass) + @classmethod + def create(cls, key, *args, **kwargs): + """ + Creates a basic Channel with default parameters, unless otherwise + specified or extended. + + Provides a friendlier interface to the utils.create_channel() function. + + Args: + key (str): This must be unique. + + Kwargs: + aliases (list of str): List of alternative (likely shorter) keynames. + description (str): A description of the channel, for use in listings. + locks (str): Lockstring. + keep_log (bool): Log channel throughput. + typeclass (str or class): The typeclass of the Channel (not + often used). + + Returns: + channel (Channel): A newly created Channel. + errors (list): A list of errors in string form, if any. + + """ + errors = [] + obj = None + + try: + kwargs['desc'] = kwargs.pop('description', '') + obj = create.create_channel(key, *args, **kwargs) + except Exception as exc: + errors.append("An error occurred while creating this '%s' object." % key) + logger.log_err(exc) + + return obj, errors + def delete(self): """ Deletes channel while also cleaning up channelhandler. diff --git a/evennia/comms/tests.py b/evennia/comms/tests.py new file mode 100644 index 0000000000..d38e34544b --- /dev/null +++ b/evennia/comms/tests.py @@ -0,0 +1,13 @@ + +from evennia.utils.test_resources import EvenniaTest +from evennia import DefaultChannel + +class ObjectCreationTest(EvenniaTest): + + def test_channel_create(self): + description = "A place to talk about coffee." + + obj, errors = DefaultChannel.create('coffeetalk', description=description) + self.assertTrue(obj, errors) + self.assertFalse(errors, errors) + self.assertEqual(description, obj.db.desc) \ No newline at end of file From c1a94d0369146607688be20cb51b67fee7093183 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 17 Oct 2018 21:37:49 +0000 Subject: [PATCH 062/187] Adds object auditing options to DefaultChannel. --- evennia/comms/comms.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/evennia/comms/comms.py b/evennia/comms/comms.py index adb90c66ac..90d1b04ad5 100644 --- a/evennia/comms/comms.py +++ b/evennia/comms/comms.py @@ -221,7 +221,7 @@ class DefaultChannel(with_metaclass(TypeclassBase, ChannelDB)): default=default, no_superuser_bypass=no_superuser_bypass) @classmethod - def create(cls, key, *args, **kwargs): + def create(cls, key, account=None, *args, **kwargs): """ Creates a basic Channel with default parameters, unless otherwise specified or extended. @@ -230,6 +230,7 @@ class DefaultChannel(with_metaclass(TypeclassBase, ChannelDB)): Args: key (str): This must be unique. + account (Account): Account to attribute this object to. Kwargs: aliases (list of str): List of alternative (likely shorter) keynames. @@ -238,6 +239,7 @@ class DefaultChannel(with_metaclass(TypeclassBase, ChannelDB)): keep_log (bool): Log channel throughput. typeclass (str or class): The typeclass of the Channel (not often used). + ip (str): IP address of creator (for object auditing). Returns: channel (Channel): A newly created Channel. @@ -246,10 +248,16 @@ class DefaultChannel(with_metaclass(TypeclassBase, ChannelDB)): """ errors = [] obj = None + ip = kwargs.pop('ip', '') try: kwargs['desc'] = kwargs.pop('description', '') obj = create.create_channel(key, *args, **kwargs) + + # Record creator id and creation IP + if ip: obj.db.creator_ip = ip + if account: obj.db.creator_id = account.id + except Exception as exc: errors.append("An error occurred while creating this '%s' object." % key) logger.log_err(exc) From b37e3a8b25bee8052c5611e3312028fef4d57bdd Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 17 Oct 2018 22:52:06 +0000 Subject: [PATCH 063/187] Renames all URL methods to web_*, moves to TypedObject model. --- evennia/accounts/accounts.py | 37 --------- evennia/accounts/tests.py | 6 +- evennia/objects/objects.py | 46 ----------- evennia/typeclasses/models.py | 145 ++++++++++++++++++++++++++++++++++ 4 files changed, 148 insertions(+), 86 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 6631911dc8..2c33e5c1f8 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -14,9 +14,7 @@ instead for most things). import time from django.conf import settings from django.contrib.auth import password_validation -from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ValidationError -from django.urls import reverse from django.utils import timezone from evennia.typeclasses.models import TypeclassBase from evennia.accounts.manager import AccountManager @@ -191,41 +189,6 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): @lazy_property def sessions(self): return AccountSessionHandler(self) - - def get_absolute_url(self): - """ - Returns the canonical URL for an Account. - - To callers, this method should appear to return a string that can be - used to refer to the object over HTTP. - - https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url - """ - try: return reverse('account-detail', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) - except: return '#' - - def get_delete_url(self): - """ - Returns the canonical URL to the page that allows deleting an object. - - """ - try: return reverse('account-delete', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) - except: return '#' - - def get_update_url(self): - """ - Returns the canonical URL to the page that allows updating an object. - - """ - try: return reverse('account-update', kwargs={'pk': self.pk, 'slug': slugify(self.name)}) - except: return '#' - - def get_admin_url(self): - """ - Returns a link to this object's entry within the Django Admin panel. - """ - content_type = ContentType.objects.get_for_model(self.__class__) - return reverse("admin:%s_%s_change" % (content_type.app_label, content_type.model), args=(self.id,)) # session-related methods diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index 4d941782ad..fbf976d644 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -64,14 +64,14 @@ class TestDefaultAccount(TestCase): "Get URL for account detail page on website" self.account = create.create_account("TestAccount%s" % randint(100000, 999999), email="test@test.com", password="testpassword", typeclass=DefaultAccount) - self.assertTrue(self.account.get_absolute_url()) + self.assertTrue(self.account.web_detail_url()) def test_admin_url(self): "Get object's URL for access via Admin pane" self.account = create.create_account("TestAccount%s" % randint(100000, 999999), email="test@test.com", password="testpassword", typeclass=DefaultAccount) - self.assertTrue(self.account.get_admin_url()) - self.assertTrue(self.account.get_admin_url() != '#') + self.assertTrue(self.account.web_admin_url()) + self.assertTrue(self.account.web_admin_url() != '#') def test_password_validation(self): "Check password validators deny bad passwords" diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 71ccb28f77..027e8ff47f 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -329,52 +329,6 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): self.aliases.add(singular, category="plural_key") return singular, plural - def get_url_prefix(self): - """ - Derives the object name from the class name. - - i.e. 'DefaultAccount' = 'default-account', 'Character' = 'character' - """ - klass = self.__class__.__name__ - terms = [x.lower() for x in re.split('([A-Z][a-z]+)', klass) if x] - return slugify(' '.join(terms)) - - def get_absolute_url(self): - """ - Returns the canonical URL to view an object. - - To callers, this method should appear to return a string that can be - used to refer to the object over HTTP. - - https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url - """ - try: return reverse('%s-detail' % self.get_url_prefix(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) - except: return '#' - - def get_delete_url(self): - """ - Returns the canonical URL to the page that allows deleting an object. - - """ - try: return reverse('%s-delete' % self.get_url_prefix(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) - except: return '#' - - def get_update_url(self): - """ - Returns the canonical URL to the page that allows updating an object. - - """ - try: return reverse('%s-update' % self.get_url_prefix(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) - except: return '#' - - def get_admin_url(self): - """ - Returns a link to this object's entry within the Django Admin panel. - - """ - content_type = ContentType.objects.get_for_model(self.__class__) - return reverse("admin:%s_%s_change" % (content_type.app_label, content_type.model), args=(self.id,)) - def search(self, searchdata, global_search=False, use_nicks=True, diff --git a/evennia/typeclasses/models.py b/evennia/typeclasses/models.py index c156aa2ac6..098606b53c 100644 --- a/evennia/typeclasses/models.py +++ b/evennia/typeclasses/models.py @@ -31,9 +31,12 @@ from django.db.models import signals from django.db.models.base import ModelBase from django.db import models +from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ObjectDoesNotExist from django.conf import settings +from django.urls import reverse from django.utils.encoding import smart_str +from django.utils.text import slugify from evennia.typeclasses.attributes import Attribute, AttributeHandler, NAttributeHandler from evennia.typeclasses.tags import Tag, TagHandler, AliasHandler, PermissionHandler @@ -733,3 +736,145 @@ class TypedObject(SharedMemoryModel): """ pass + + # + # Web/Django methods + # + + def web_admin_url(self): + """ + Returns the URI path for the Django Admin page for this object. + + ex. Account#1 = '/admin/accounts/accountdb/1/change/' + + Returns: + path (str): URI path to Django Admin page for object. + + """ + content_type = ContentType.objects.get_for_model(self.__class__) + return reverse("admin:%s_%s_change" % (content_type.app_label, content_type.model), args=(self.id,)) + + @classmethod + def web_create_url(cls): + """ + Returns the URI path for a View that allows users to create new + instances of this object. + + ex. Chargen = '/characters/create/' + + For this to work, the developer must have defined a named view somewhere + in urls.py that follows the format 'modelname-action', so in this case + a named view of 'character-create' would be referenced by this method. + + ex. + url(r'characters/create/', ChargenView.as_view(), name='character-create') + + If no View has been created and defined in urls.py, returns an + HTML anchor. + + This method is naive and simply returns a path. Securing access to + the actual view and limiting who can create new objects is the + developer's responsibility. + + Returns: + path (str): URI path to object creation page, if defined. + + """ + try: return reverse('%s-create' % cls._meta.verbose_name.lower()) + except: return '#' + + def web_detail_url(self): + """ + Returns the URI path for a View that allows users to view details for + this object. + + ex. Oscar (Character) = '/characters/oscar/1/' + + For this to work, the developer must have defined a named view somewhere + in urls.py that follows the format 'modelname-action', so in this case + a named view of 'character-detail' would be referenced by this method. + + ex. + url(r'characters/(?P[\w\d\-]+)/(?P[0-9]+)/$', CharDetailView.as_view(), name='character-detail') + + If no View has been created and defined in urls.py, returns an + HTML anchor. + + This method is naive and simply returns a path. Securing access to + the actual view and limiting who can view this object is the developer's + responsibility. + + Returns: + path (str): URI path to object detail page, if defined. + + """ + try: return reverse('%s-detail' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: return '#' + + def web_update_url(self): + """ + Returns the URI path for a View that allows users to update this + object. + + ex. Oscar (Character) = '/characters/oscar/1/change/' + + For this to work, the developer must have defined a named view somewhere + in urls.py that follows the format 'modelname-action', so in this case + a named view of 'character-update' would be referenced by this method. + + ex. + url(r'characters/(?P[\w\d\-]+)/(?P[0-9]+)/change/$', CharUpdateView.as_view(), name='character-update') + + If no View has been created and defined in urls.py, returns an + HTML anchor. + + This method is naive and simply returns a path. Securing access to + the actual view and limiting who can modify objects is the developer's + responsibility. + + Returns: + path (str): URI path to object update page, if defined. + + """ + try: return reverse('%s-update' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: return '#' + + def web_delete_url(self): + """ + Returns the URI path for a View that allows users to delete this object. + + ex. Oscar (Character) = '/characters/oscar/1/delete/' + + For this to work, the developer must have defined a named view somewhere + in urls.py that follows the format 'modelname-action', so in this case + a named view of 'character-detail' would be referenced by this method. + + ex. + url(r'characters/(?P[\w\d\-]+)/(?P[0-9]+)/delete/$', CharDeleteView.as_view(), name='character-delete') + + If no View has been created and defined in urls.py, returns an + HTML anchor. + + This method is naive and simply returns a path. Securing access to + the actual view and limiting who can delete this object is the developer's + responsibility. + + Returns: + path (str): URI path to object deletion page, if defined. + + """ + try: return reverse('%s-delete' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: return '#' + + def get_absolute_url(self): + """ + Django construct; used by Django Sites framework and within the Admin + panel for reverse linking to the object detail page. + + https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url + + Returns: + path (str): URI path to object detail page, if defined. + + """ + return self.web_detail_url() \ No newline at end of file From 78213ea160f2d1742f9d4a783a81e8f113a1602a Mon Sep 17 00:00:00 2001 From: Tehom Date: Wed, 17 Oct 2018 22:43:33 -0400 Subject: [PATCH 064/187] Add tests for memplot --- evennia/server/profiling/memplot.py | 6 +++--- evennia/server/profiling/tests.py | 21 ++++++++++++++++++++- 2 files changed, 23 insertions(+), 4 deletions(-) diff --git a/evennia/server/profiling/memplot.py b/evennia/server/profiling/memplot.py index e8d7e76b12..c6a227a370 100644 --- a/evennia/server/profiling/memplot.py +++ b/evennia/server/profiling/memplot.py @@ -13,14 +13,14 @@ import time # TODO! #sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))))) #os.environ['DJANGO_SETTINGS_MODULE'] = 'game.settings' -import ev -from evennia.utils.idmapper import base as _idmapper +import evennia +from evennia.utils.idmapper import models as _idmapper LOGFILE = "logs/memoryusage.log" INTERVAL = 30 # log every 30 seconds -class Memplot(ev.Script): +class Memplot(evennia.DefaultScript): """ Describes a memory plotting action. diff --git a/evennia/server/profiling/tests.py b/evennia/server/profiling/tests.py index b3e9fba8d5..cca4e0d99b 100644 --- a/evennia/server/profiling/tests.py +++ b/evennia/server/profiling/tests.py @@ -1,7 +1,8 @@ from django.test import TestCase -from mock import Mock +from mock import Mock, patch, mock_open from .dummyrunner_settings import (c_creates_button, c_creates_obj, c_digs, c_examines, c_help, c_idles, c_login, c_login_nodig, c_logout, c_looks, c_moves, c_moves_n, c_moves_s, c_socialize) +import memplot class TestDummyrunnerSettings(TestCase): @@ -91,3 +92,21 @@ class TestDummyrunnerSettings(TestCase): def test_c_move_s(self): self.assertEqual(c_moves_s(self.client), "south") + + +class TestMemPlot(TestCase): + @patch.object(memplot, "_idmapper") + @patch.object(memplot, "os") + @patch.object(memplot, "open", new_callable=mock_open, create=True) + @patch.object(memplot, "time") + def test_memplot(self, mock_time, mocked_open, mocked_os, mocked_idmapper): + from evennia.utils.create import create_script + mocked_idmapper.cache_size.return_value = (9, 5000) + mock_time.time = Mock(return_value=6000.0) + script = create_script(memplot.Memplot) + script.db.starttime = 0.0 + mocked_os.popen.read.return_value = 5000.0 + script.at_repeat() + handle = mocked_open() + handle.write.assert_called_with('100.0, 0.001, 0.001, 9\n') + script.stop() From ec8af462010f89498e49fe8a185edf186fd422dd Mon Sep 17 00:00:00 2001 From: Tehom Date: Wed, 17 Oct 2018 23:41:19 -0400 Subject: [PATCH 065/187] Implement local-first search for @link command --- evennia/commands/default/building.py | 17 ++++++++++++----- evennia/commands/default/tests.py | 8 ++++++++ 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/evennia/commands/default/building.py b/evennia/commands/default/building.py index 19ab0f7508..ff8d56753b 100644 --- a/evennia/commands/default/building.py +++ b/evennia/commands/default/building.py @@ -10,7 +10,7 @@ from evennia.objects.models import ObjectDB from evennia.locks.lockhandler import LockException from evennia.commands.cmdhandler import get_and_merge_cmdsets from evennia.utils import create, utils, search -from evennia.utils.utils import inherits_from, class_from_module, get_all_typeclasses +from evennia.utils.utils import inherits_from, class_from_module, get_all_typeclasses, variable_from_module from evennia.utils.eveditor import EvEditor from evennia.utils.evmore import EvMore from evennia.prototypes import spawner, prototypes as protlib, menus as olc_menus @@ -1022,10 +1022,17 @@ class CmdLink(COMMAND_DEFAULT_CLASS): object_name = self.lhs - # get object - obj = caller.search(object_name, global_search=True) - if not obj: - return + # try to search locally first + results = caller.search(object_name, quiet=True) + if len(results) > 1: # local results was a multimatch. Inform them to be more specific + _AT_SEARCH_RESULT = variable_from_module(*settings.SEARCH_AT_RESULT.rsplit('.', 1)) + return _AT_SEARCH_RESULT(results, caller, query=object_name) + elif len(results) == 1: # A unique local match + obj = results[0] + else: # No matches. Search globally + obj = caller.search(object_name, global_search=True) + if not obj: + return if self.rhs: # this means a target name was given diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index 19277c168a..78e77e2b88 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -334,6 +334,14 @@ class TestBuilding(CommandTest): self.call(building.CmdOpen(), "TestExit1=Room2", "Created new Exit 'TestExit1' from Room to Room2") self.call(building.CmdLink(), "TestExit1=Room", "Link created TestExit1 -> Room (one way).") self.call(building.CmdUnLink(), "TestExit1", "Former exit TestExit1 no longer links anywhere.") + self.char1.location = self.room2 + self.call(building.CmdOpen(), "TestExit2=Room", "Created new Exit 'TestExit2' from Room2 to Room.") + # ensure it matches locally first + self.call(building.CmdLink(), "TestExit=Room2", "Link created TestExit2 -> Room2 (one way).") + # ensure can still match globally when not a local name + self.call(building.CmdLink(), "TestExit1=Room2", "Note: TestExit1(#8) did not have a destination set before. " + "Make sure you linked the right thing.\n" + "Link created TestExit1 -> Room2 (one way).") def test_set_home(self): self.call(building.CmdSetHome(), "Obj = Room2", "Obj's home location was changed from Room") From 18043125d912ba68574d336879ae75693a7ef440 Mon Sep 17 00:00:00 2001 From: Tehom Date: Thu, 18 Oct 2018 04:24:03 -0400 Subject: [PATCH 066/187] Add portal uptime to @time command. --- evennia/commands/default/system.py | 1 + evennia/server/amp_client.py | 1 + evennia/server/portal/amp_server.py | 3 ++- evennia/server/portal/portal.py | 3 +++ evennia/server/sessionhandler.py | 2 ++ evennia/utils/gametime.py | 11 +++++++++++ 6 files changed, 20 insertions(+), 1 deletion(-) diff --git a/evennia/commands/default/system.py b/evennia/commands/default/system.py index 3a14a296b4..a6cc24263d 100644 --- a/evennia/commands/default/system.py +++ b/evennia/commands/default/system.py @@ -710,6 +710,7 @@ class CmdTime(COMMAND_DEFAULT_CLASS): """Show server time data in a table.""" table1 = EvTable("|wServer time", "", align="l", width=78) table1.add_row("Current uptime", utils.time_format(gametime.uptime(), 3)) + table1.add_row("Portal uptime", utils.time_format(gametime.portal_uptime(), 3)) table1.add_row("Total runtime", utils.time_format(gametime.runtime(), 2)) table1.add_row("First start", datetime.datetime.fromtimestamp(gametime.server_epoch())) table1.add_row("Current time", datetime.datetime.now()) diff --git a/evennia/server/amp_client.py b/evennia/server/amp_client.py index a4300adf4d..816ecf2705 100644 --- a/evennia/server/amp_client.py +++ b/evennia/server/amp_client.py @@ -221,6 +221,7 @@ class AMPServerClientProtocol(amp.AMPMultiConnectionProtocol): server_restart_mode = kwargs.get("server_restart_mode", "shutdown") self.factory.server.run_init_hooks(server_restart_mode) server_sessionhandler.portal_sessions_sync(kwargs.get("sessiondata")) + server_sessionhandler.portal_start_time = kwargs.get("portal_start_time") elif operation == amp.SRELOAD: # server reload # shut down in reload mode diff --git a/evennia/server/portal/amp_server.py b/evennia/server/portal/amp_server.py index c07b5c121d..cdcd4a1552 100644 --- a/evennia/server/portal/amp_server.py +++ b/evennia/server/portal/amp_server.py @@ -428,7 +428,8 @@ class AMPServerProtocol(amp.AMPMultiConnectionProtocol): self.send_AdminPortal2Server(amp.DUMMYSESSION, amp.PSYNC, server_restart_mode=server_restart_mode, - sessiondata=sessdata) + sessiondata=sessdata, + portal_start_time=self.factory.portal.start_time) self.factory.portal.sessions.at_server_connection() if self.factory.server_connection: diff --git a/evennia/server/portal/portal.py b/evennia/server/portal/portal.py index 91b3efc7bc..bb2a7b9f07 100644 --- a/evennia/server/portal/portal.py +++ b/evennia/server/portal/portal.py @@ -11,6 +11,7 @@ from builtins import object import sys import os +import time from os.path import dirname, abspath from twisted.application import internet, service @@ -114,6 +115,8 @@ class Portal(object): self.server_restart_mode = "shutdown" self.server_info_dict = {} + self.start_time = time.time() + # in non-interactive portal mode, this gets overwritten by # cmdline sent by the evennia launcher self.server_twistd_cmd = self._get_backup_server_twistd_cmd() diff --git a/evennia/server/sessionhandler.py b/evennia/server/sessionhandler.py index 8e439b42dd..906ad1ec54 100644 --- a/evennia/server/sessionhandler.py +++ b/evennia/server/sessionhandler.py @@ -280,6 +280,8 @@ class ServerSessionHandler(SessionHandler): super(ServerSessionHandler, self).__init__(*args, **kwargs) self.server = None # set at server initialization self.server_data = {"servername": _SERVERNAME} + # will be set on psync + self.portal_start_time = 0.0 def _run_cmd_login(self, session): """ diff --git a/evennia/utils/gametime.py b/evennia/utils/gametime.py index 3736128819..48910c4bfd 100644 --- a/evennia/utils/gametime.py +++ b/evennia/utils/gametime.py @@ -107,6 +107,17 @@ def uptime(): return time.time() - SERVER_START_TIME +def portal_uptime(): + """ + Get the current uptime of the portal. + + Returns: + time (float): The uptime of the portal. + """ + from evennia.server.sessionhandler import SESSIONS + return time.time() - SESSIONS.portal_start_time + + def game_epoch(): """ Get the game epoch. From dc787dae8996a61ed2c63b3471c131f3c63b2fc5 Mon Sep 17 00:00:00 2001 From: Griatch Date: Thu, 18 Oct 2018 17:15:54 +0200 Subject: [PATCH 067/187] Some clarification in the launcher --- CHANGELOG.md | 2 -- evennia/server/evennia_launcher.py | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 13c450939f..5b56c29d85 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,8 +5,6 @@ ### Requirements - Up requirements to Django 1.11.x, Twisted 18 and pillow 5.2.0 -- Add `autobahn` dependency for Websocket support, removing very old embedded txWS library (from a - time before websocket specification was still not fixed). - Add `inflect` dependency for automatic pluralization of object names. ### Server/Portal diff --git a/evennia/server/evennia_launcher.py b/evennia/server/evennia_launcher.py index 779a1e4aa2..ef6bf61055 100644 --- a/evennia/server/evennia_launcher.py +++ b/evennia/server/evennia_launcher.py @@ -325,7 +325,7 @@ MENU = \ | 7) Kill Server only (send kill signal to process) | | 8) Kill Portal + Server | +--- Information -----------------------------------------------+ - | 9) Tail log files (quickly see errors) | + | 9) Tail log files (quickly see errors - Ctrl-C to exit) | | 10) Status | | 11) Port info | +--- Testing ---------------------------------------------------+ From 892fb3e4625092a444f032d990bae10e17eae106 Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 18 Oct 2018 19:49:05 +0000 Subject: [PATCH 068/187] Makes forms more generic and implements a set of class-based CRUD views for character objects. --- evennia/web/website/forms.py | 164 ++++------------ ...r_create_form.html => character_form.html} | 4 +- .../website/character_manage_list.html | 4 +- .../website/object_confirm_delete.html | 33 ++++ evennia/web/website/views.py | 182 ++++++++++++++---- 5 files changed, 222 insertions(+), 165 deletions(-) rename evennia/web/website/templates/website/{character_create_form.html => character_form.html} (94%) create mode 100644 evennia/web/website/templates/website/object_confirm_delete.html diff --git a/evennia/web/website/forms.py b/evennia/web/website/forms.py index 8759d681e8..0271e3d432 100644 --- a/evennia/web/website/forms.py +++ b/evennia/web/website/forms.py @@ -1,10 +1,20 @@ from django import forms from django.conf import settings from django.contrib.auth.forms import UserCreationForm, UsernameField +from django.forms import ModelForm +from django.utils.html import escape from evennia.utils import class_from_module -from random import choice, randint -class AccountForm(UserCreationForm): +class EvenniaForm(forms.Form): + + def clean(self): + cleaned = super(EvenniaForm, self).clean() + + # Escape all values provided by user + cleaned = {k:escape(v) for k,v in cleaned.items()} + return cleaned + +class AccountForm(EvenniaForm, UserCreationForm): class Meta: model = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) @@ -13,130 +23,34 @@ class AccountForm(UserCreationForm): email = forms.EmailField(help_text="A valid email address. Optional; used for password resets.", required=False) -class CharacterForm(forms.Form): - name = forms.CharField(help_text="The name of your intended character.") - age = forms.IntegerField(min_value=3, max_value=99, help_text="How old your character should be once spawned.") - description = forms.CharField(widget=forms.Textarea(attrs={'rows': 3}), max_length=2048, min_length=160, required=False) +class ObjectForm(EvenniaForm, ModelForm): - @classmethod - def assign_attributes(cls, attribute_list, points, min_points, max_points): - """ - Randomly distributes a number of points across the given attributes, - while also ensuring each attribute gets at least a certain amount - and at most a certain amount. + class Meta: + model = class_from_module(settings.BASE_OBJECT_TYPECLASS) + fields = ("db_key",) + labels = { + 'db_key': 'Name', + } + +class CharacterForm(ObjectForm): + + class Meta: + # Get the correct object model + model = class_from_module(settings.BASE_CHARACTER_TYPECLASS) + # Allow entry of the 'key' field + fields = ("db_key",) + # Rename 'key' to something more intelligible + labels = { + 'db_key': 'Name', + } - Args: - attribute_list (iterable): List or tuple of attribute names to assign - points to. - points (int): Starting number of points - min_points (int): Least amount of points each attribute should have - max_points (int): Most amount of points each attribute should have - - Returns: - spread (dict): Dict of attributes and a point assignment. - - """ - num_buckets = len(attribute_list) - point_spread = (x for x in self.random_distribution(points, num_buckets, min_points, max_points)) - - # For each field, get the point calculation for the next attribute value generated - return {attribute: next(point_spread) for k in attribute_list} + # Fields pertaining to user-configurable attributes on the Character object. + desc = forms.CharField(label='Description', widget=forms.Textarea(attrs={'rows': 3}), max_length=2048, required=False) - @classmethod - def random_distribution(cls, points, num_buckets, min_points, max_points): - """ - Distributes a set number of points randomly across a number of 'buckets' - while also attempting to ensure each bucket's value finishes within a - certain range. - - If your math doesn't add up (you try to distribute 5 points across 100 - buckets and insist each bucket has at least 20 points), the algorithm - will return the best spread it could achieve but will not raise an error - (so in this case, 5 random buckets would get 1 point each and that's all). - - Args: - points (int): The number of points to distribute. - num_buckets (int): The number of 'buckets' (or stats, skills, etc) - you wish to distribute points to. - min_points (int): The least amount of points each bucket should have. - max_points (int): The most points each bucket should have. - - Returns: - buckets (list): List of random point assignments. - - """ - buckets = [0 for x in range(num_buckets)] - indices = [i for (i, value) in enumerate(buckets)] +class CharacterUpdateForm(CharacterForm): + """ + Provides a form that only allows updating of db attributes, not model + attributes. - # Do this while we have eligible buckets, points to assign and we haven't - # maxed out all the buckets. - while indices and points and sum(buckets) <= (max_points * num_buckets): - # Pick a random bucket index - index = choice(indices) - - # Add to bucket - buckets[index] = buckets[index] + 1 - points = points - 1 - - # Get the indices of eligible buckets - indices = [i for (i, value) in enumerate(buckets) if (value < min_points) or (value < max_points)] - - return buckets - -class ExtendedCharacterForm(CharacterForm): - - GENDERS = ( - ('male', 'Male'), - ('female', 'Female'), - ('androgynous', 'Androgynous'), - ('special', 'Special') - ) - - RACES = ( - ('human', 'Human'), - ('elf', 'Elf'), - ('orc', 'Orc'), - ) - - CLASSES = ( - ('civilian', 'Civilian'), - ('warrior', 'Warrior'), - ('thief', 'Thief'), - ('cleric', 'Cleric') - ) - - PERKS = ( - ('strong', 'Extra strength'), - ('nimble', 'Quick on their toes'), - ('diplomatic', 'Fast talker') - ) - - name = forms.CharField(help_text="The name of your intended character.") - age = forms.IntegerField(min_value=3, max_value=99, help_text="How old your character should be once spawned.") - gender = forms.ChoiceField(choices=GENDERS, help_text="Which end of the multidimensional spectrum does your character most closely align with, in terms of gender?") - race = forms.ChoiceField(choices=RACES, help_text="What race does your character belong to?") - job = forms.ChoiceField(choices=CLASSES, help_text="What profession or role does your character fulfill or is otherwise destined to?") - - perks = forms.MultipleChoiceField(choices=PERKS, help_text="What extraordinary abilities does your character possess?") - description = forms.CharField(widget=forms.Textarea(attrs={'rows': 3}), max_length=2048, min_length=160, required=False) - - strength = forms.IntegerField(min_value=1, max_value=10) - perception = forms.IntegerField(min_value=1, max_value=10) - intelligence = forms.IntegerField(min_value=1, max_value=10) - dexterity = forms.IntegerField(min_value=1, max_value=10) - charisma = forms.IntegerField(min_value=1, max_value=10) - vitality = forms.IntegerField(min_value=1, max_value=10) - magic = forms.IntegerField(min_value=1, max_value=10) - - def __init__(self, *args, **kwargs): - # Do all the normal initizliation stuff that would otherwise be happening - super(ExtendedCharacterCreationForm, self).__init__(*args, **kwargs) - - # Given a pool of points, let's randomly distribute them across attributes. - # First get a list of attributes - attributes = ('strength', 'perception', 'intelligence', 'dexterity', 'charisma', 'vitality', 'magic') - # Distribute a random number of points across them - attrs = self.assign_attributes(attributes, 50, 1, 10) - # Initialize the form with the results of the point distribution - for field in attrs.keys(): - self.initial[field] = attrs[field] \ No newline at end of file + """ + pass \ No newline at end of file diff --git a/evennia/web/website/templates/website/character_create_form.html b/evennia/web/website/templates/website/character_form.html similarity index 94% rename from evennia/web/website/templates/website/character_create_form.html rename to evennia/web/website/templates/website/character_form.html index 8864fb3c5d..964f4e6aa4 100644 --- a/evennia/web/website/templates/website/character_create_form.html +++ b/evennia/web/website/templates/website/character_form.html @@ -1,7 +1,7 @@ {% extends "base.html" %} {% block titleblock %} -Character Creation +{{ view.page_title }} {% endblock %} {% block content %} @@ -12,7 +12,7 @@ Character Creation
    -

    Character Creation

    +

    {{ view.page_title }}

    {% if form.errors %} diff --git a/evennia/web/website/templates/website/character_manage_list.html b/evennia/web/website/templates/website/character_manage_list.html index f4e112fd7a..aeb10ade36 100644 --- a/evennia/web/website/templates/website/character_manage_list.html +++ b/evennia/web/website/templates/website/character_manage_list.html @@ -20,8 +20,8 @@ Manage Characters

    {{ object.db_date_created }} -
    Delete -
    Edit

    +
    Delete +
    Edit

    {{ object }} {% if object.subtitle %}{{ object.subtitle }}{% endif %}

    {{ object.db.desc }}

    diff --git a/evennia/web/website/templates/website/object_confirm_delete.html b/evennia/web/website/templates/website/object_confirm_delete.html new file mode 100644 index 0000000000..7661819aa9 --- /dev/null +++ b/evennia/web/website/templates/website/object_confirm_delete.html @@ -0,0 +1,33 @@ +{% extends "base.html" %} + +{% block titleblock %} +Confirm Delete +{% endblock %} + +{% block body %} + +{% load addclass %} +
    +
    +
    +
    +
    +

    Confirm Delete

    +
    +
    + {% csrf_token %} +

    Are you sure you want to delete "{{ object }}"?

    + +
    +
    + + +
    +
    + +
    +
    +
    +
    +
    +{% endblock %} diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index 0ae996027c..f569830a62 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -7,20 +7,23 @@ templates on the fly. """ from django.contrib.admin.sites import site from django.conf import settings +from django.contrib import messages from django.contrib.auth import authenticate from django.contrib.auth.mixins import LoginRequiredMixin from django.contrib.admin.views.decorators import staff_member_required +from django.core.exceptions import PermissionDenied from django.db.models.functions import Lower +from django.http import HttpResponseRedirect, Http404 from django.shortcuts import render from django.urls import reverse_lazy from django.views.generic import View, TemplateView, ListView, DetailView, FormView -from django.views.generic.edit import DeleteView +from django.views.generic.edit import CreateView, UpdateView, DeleteView from evennia import SESSION_HANDLER from evennia.objects.models import ObjectDB from evennia.accounts.models import AccountDB -from evennia.utils import logger -from evennia.web.website.forms import AccountForm, CharacterForm +from evennia.utils import class_from_module, logger +from evennia.web.website.forms import * from django.contrib.auth import login from django.utils.text import slugify @@ -142,25 +145,132 @@ def admin_wrapper(request): """ return staff_member_required(site.index)(request) +# +# Class-based views +# + +class EvenniaCreateView(CreateView): + + @property + def page_title(self): + return 'Create %s' % self.model._meta.verbose_name.title() + +class EvenniaUpdateView(UpdateView): + + @property + def page_title(self): + return 'Update %s' % self.model._meta.verbose_name.title() + +class EvenniaDeleteView(DeleteView): + + @property + def page_title(self): + return 'Delete %s' % self.model._meta.verbose_name.title() + +# +# Object views +# + class ObjectDetailView(DetailView): + model = ObjectDB def get_object(self, queryset=None): + """ + Override of Django hook. + + Evennia does not natively store slugs, so where a slug is provided, + calculate the same for the object and make sure it matches. + + """ obj = super(ObjectDetailView, self).get_object(queryset) - if not slugify(obj.name) == self.kwargs.get('slug'): + if slugify(obj.name) != self.kwargs.get(self.slug_url_kwarg): raise Http404(u"No %(verbose_name)s found matching the query" % {'verbose_name': queryset.model._meta.verbose_name}) return obj + +class ObjectCreateView(LoginRequiredMixin, EvenniaCreateView): + + model = ObjectDB + +class ObjectDeleteView(LoginRequiredMixin, ObjectDetailView, EvenniaDeleteView): + + model = ObjectDB + template_name = 'website/object_confirm_delete.html' + + def delete(self, request, *args, **kwargs): + """ + Calls the delete() method on the fetched object and then + redirects to the success URL. + + We extend this so we can capture the name for the sake of confirmation. + """ + obj = str(self.get_object()) + response = super(ObjectDeleteView, self).delete(request, *args, **kwargs) + messages.success(request, "Successfully deleted '%s'." % obj) + return response + +class ObjectUpdateView(LoginRequiredMixin, ObjectDetailView, EvenniaUpdateView): + + model = ObjectDB + + def get_initial(self): + """ + Override of Django hook. + + Prepopulates form field values based on object db attributes as well as + model field values. + + """ + # Get the object we want to update + obj = self.get_object() + + # Get attributes + data = {k:getattr(obj.db, k, '') for k in self.form_class.base_fields} + + # Get model fields + data.update({k:getattr(obj, k, '') for k in self.form_class.Meta.fields}) + + return data + + def form_valid(self, form): + """ + Override of Django hook. + + Updates object attributes based on values submitted. + + This method is only called if all values for the fields submitted + passed form validation, so at this point we can assume the data is + validated and sanitized. + + """ + # Get the values submitted after they've been cleaned and validated + data = {k:v for k,v in form.cleaned_data.items() if k not in self.form_class.Meta.fields} + + # Update the object attributes + for key, value in data.items(): + setattr(self.object.db, key, value) + messages.success(self.request, "Successfully updated '%s' for %s." % (key, self.object)) + + # Do not return super().form_valid; we don't want to update the model + # instance, just its attributes. + return HttpResponseRedirect(self.success_url) + +# +# Account views +# -class AccountCreationView(FormView): +class AccountMixin(object): + + model = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) form_class = AccountForm + +class AccountCreateView(AccountMixin, ObjectCreateView): + template_name = 'website/registration/register.html' success_url = reverse_lazy('login') def form_valid(self, form): - # Check to make sure basics validated - valid = super(AccountCreationView, self).form_valid(form) - if not valid: return self.form_invalid(form) username = form.cleaned_data['username'] password = form.cleaned_data['password1'] @@ -189,39 +299,39 @@ class AccountCreationView(FormView): messages.success(self.request, "Your account '%s' was successfully created! You may log in using it now." % account.name) return HttpResponseRedirect(self.success_url) -class CharacterManageView(LoginRequiredMixin, ListView): - model = ObjectDB - paginate_by = 10 - template_name = 'website/character_manage_list.html' +# +# Character views +# + +class CharacterMixin(object): + + model = class_from_module(settings.BASE_CHARACTER_TYPECLASS) + form_class = CharacterForm def get_queryset(self): # Get IDs of characters owned by account - ids = [getattr(x, 'id') for x in self.request.user.db._playable_characters] + ids = [getattr(x, 'id') for x in self.request.user.db._playable_characters if x] # Return a queryset consisting of those characters return self.model.objects.filter(id__in=ids).order_by(Lower('db_key')) -class CharacterUpdateView(LoginRequiredMixin, FormView): - form_class = CharacterForm - template_name = 'website/generic_form.html' - success_url = reverse_lazy('manage-characters') - fields = ('description',) - -class CharacterDeleteView(LoginRequiredMixin, ObjectDetailView, DeleteView): - model = ObjectDB - - def get_queryset(self): - # Restrict characters available for deletion to those owned by - # the authenticated account - ids = [getattr(x, 'id') for x in self.request.user.db._playable_characters] +class CharacterManageView(LoginRequiredMixin, CharacterMixin, ListView): + + paginate_by = 10 + template_name = 'website/character_manage_list.html' + page_title = 'Manage: Characters' - # Return a queryset consisting of those characters - return self.model.objects.filter(id__in=ids).order_by(Lower('db_key')) +class CharacterUpdateView(CharacterMixin, ObjectUpdateView): + + form_class = CharacterUpdateForm + template_name = 'website/character_form.html' + +class CharacterDeleteView(CharacterMixin, ObjectDeleteView): + pass -class CharacterCreateView(LoginRequiredMixin, FormView): - form_class = CharacterForm - template_name = 'website/character_create_form.html' - success_url = reverse_lazy('manage-characters') +class CharacterCreateView(CharacterMixin, ObjectCreateView): + + template_name = 'website/character_form.html' def form_valid(self, form): # Get account ref @@ -230,12 +340,12 @@ class CharacterCreateView(LoginRequiredMixin, FormView): # Get attributes from the form self.attributes = {k: form.cleaned_data[k] for k in form.cleaned_data.keys()} - charname = self.attributes.pop('name') - description = self.attributes.pop('description') + charname = self.attributes.pop('db_key') + description = self.attributes.pop('desc') # Create a character permissions = settings.PERMISSION_ACCOUNT_DEFAULT - typeclass = settings.BASE_CHARACTER_TYPECLASS + typeclass = self.model default_home = ObjectDB.objects.get_id(settings.DEFAULT_HOME) from evennia.utils import create @@ -258,7 +368,7 @@ class CharacterCreateView(LoginRequiredMixin, FormView): account.db._last_puppet = character # Assign attributes from form - [setattr(character.db, field, self.attributes[field]) for field in self.attributes.keys()] + [setattr(character.db, key, value) for key,value in self.attributes.items()] character.db.creator_id = account.id character.save() From 553f2e13a1ae4ee1bc3fcf3ef33dfbbd2fd4ac9c Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 18 Oct 2018 20:42:02 +0000 Subject: [PATCH 069/187] Fixes links. --- evennia/web/website/templates/website/_menu.html | 4 ++-- evennia/web/website/urls.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/evennia/web/website/templates/website/_menu.html b/evennia/web/website/templates/website/_menu.html index 90eabba4eb..f75477ecae 100644 --- a/evennia/web/website/templates/website/_menu.html +++ b/evennia/web/website/templates/website/_menu.html @@ -43,8 +43,8 @@ folder and edit it to add/remove links to the menu.
  • - Create - Manage + Create Character + Manage Characters
    {% for character in user.characters|slice:"10" %} {{ character }} diff --git a/evennia/web/website/urls.py b/evennia/web/website/urls.py index d8a6523c53..604ac1af6c 100644 --- a/evennia/web/website/urls.py +++ b/evennia/web/website/urls.py @@ -14,7 +14,7 @@ urlpatterns = [ # User Authentication (makes login/logout url names available) url(r'^auth/', include('django.contrib.auth.urls')), - url(r'^auth/register', website_views.AccountCreationView.as_view(), name="register"), + url(r'^auth/register', website_views.AccountCreateView.as_view(), name="register"), # Character management url(r'^characters/create/$', website_views.CharacterCreateView.as_view(), name="character-create"), From 779fa4b8eb22ff03d68f970e104cd8d11d7a4129 Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 18 Oct 2018 20:42:22 +0000 Subject: [PATCH 070/187] Fixes page titles. --- .../website/templates/website/character_manage_list.html | 8 ++++---- .../website/templates/website/object_confirm_delete.html | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/evennia/web/website/templates/website/character_manage_list.html b/evennia/web/website/templates/website/character_manage_list.html index aeb10ade36..c65314bc8e 100644 --- a/evennia/web/website/templates/website/character_manage_list.html +++ b/evennia/web/website/templates/website/character_manage_list.html @@ -1,7 +1,7 @@ {% extends "base.html" %} {% block titleblock %} -Manage Characters +{{ view.page_title }} {% endblock %} {% block content %} @@ -12,17 +12,17 @@ Manage Characters
    -

    Manage Characters

    +

    {{ view.page_title }}

    {% for object in object_list %}
    - +

    {{ object.db_date_created }}
    Delete
    Edit

    -
    {{ object }} {% if object.subtitle %}{{ object.subtitle }}{% endif %}
    +
    {{ object }} {% if object.subtitle %}{{ object.subtitle }}{% endif %}

    {{ object.db.desc }}

    diff --git a/evennia/web/website/templates/website/object_confirm_delete.html b/evennia/web/website/templates/website/object_confirm_delete.html index 7661819aa9..e42fb57de6 100644 --- a/evennia/web/website/templates/website/object_confirm_delete.html +++ b/evennia/web/website/templates/website/object_confirm_delete.html @@ -1,7 +1,7 @@ {% extends "base.html" %} {% block titleblock %} -Confirm Delete +{{ view.page_title }} {% endblock %} {% block body %} @@ -12,7 +12,7 @@ Confirm Delete
    -

    Confirm Delete

    +

    {{ view.page_title }}

    {% csrf_token %} From aa62c2014c5f02e347f57f152c2b5354aa4ba628 Mon Sep 17 00:00:00 2001 From: Johnny Date: Thu, 18 Oct 2018 21:30:02 +0000 Subject: [PATCH 071/187] Fixes object delete method so that deleted characters are removed from owner's playable character list. --- evennia/accounts/tests.py | 18 ++++++++++++++++++ evennia/objects/objects.py | 4 ++++ 2 files changed, 22 insertions(+) diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index 78ee87f37d..1285891d32 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -7,6 +7,7 @@ from evennia.accounts.accounts import AccountSessionHandler from evennia.accounts.accounts import DefaultAccount from evennia.server.session import Session from evennia.utils import create +from evennia.utils.test_resources import EvenniaTest from django.conf import settings @@ -199,3 +200,20 @@ class TestDefaultAccount(TestCase): account.puppet_object(self.s1, obj) self.assertTrue(self.s1.data_out.call_args[1]['text'].endswith("is already puppeted by another Account.")) self.assertIsNone(obj.at_post_puppet.call_args) + + +class TestAccountPuppetDeletion(EvenniaTest): + + @override_settings(MULTISESSION_MODE=2) + def test_puppet_deletion(self): + # Check for existing chars + self.assertFalse(self.account.db._playable_characters, 'Account should not have any chars by default.') + + # Add char1 to account's playable characters + self.account.db._playable_characters.append(self.char1) + self.assertTrue(self.account.db._playable_characters, 'Char was not added to account.') + + # See what happens when we delete char1. + self.char1.delete() + # Playable char list should be empty. + self.assertFalse(self.account.db._playable_characters, 'Playable character list is not empty! %s' % self.account.db._playable_characters) \ No newline at end of file diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 27d8147999..3d0b9e02b7 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -913,8 +913,12 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): # no need to disconnect, Account just jumps to OOC mode. # sever the connection (important!) if self.account: + # Remove the object from playable characters list + if self in self.account.db._playable_characters: + self.account.db._playable_characters = [x for x in self.account.db._playable_characters if x != self] for session in self.sessions.all(): self.account.unpuppet_object(session) + self.account = None for script in _ScriptDB.objects.get_all_scripts_on_obj(self): From d4b375d9cce1b3a1fbde10bee2c8d05e8963ce9c Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Thu, 18 Oct 2018 17:52:25 -0500 Subject: [PATCH 072/187] Tests for @spawn/edit and @spawn/examine --- evennia/commands/default/tests.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index a3be98984a..cbae47866d 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -372,6 +372,17 @@ class TestBuilding(CommandTest): self.call(building.CmdSpawn(), \ "'NO_EXIST'", "No prototype named 'NO_EXIST'") + # @span/edit + self.call( + building.CmdSpawn(), + '/edit', + 'spawn: Extra switch "/edit" ignored') + + # @span/examine + self.call( + '/examine', + building.CmdSpawn(), 'spawn: Extra switch "/examine" ignored') + class TestComms(CommandTest): @@ -446,4 +457,4 @@ class TestUnconnectedCommand(CommandTest): settings.SERVERNAME, datetime.datetime.fromtimestamp(gametime.SERVER_START_TIME).ctime(), SESSIONS.account_count(), utils.get_evennia_version()) - self.call(unloggedin.CmdUnconnectedInfo(), "", expected) \ No newline at end of file + self.call(unloggedin.CmdUnconnectedInfo(), "", expected) From 874708939cccb2fb9b28d37bb958aca53cdd3505 Mon Sep 17 00:00:00 2001 From: Tehom Date: Thu, 18 Oct 2018 23:12:22 -0400 Subject: [PATCH 073/187] Add a simple 'force' command to force objects to execute commands. --- evennia/commands/default/admin.py | 32 +++++++++++++++++++- evennia/commands/default/cmdset_character.py | 1 + evennia/commands/default/tests.py | 3 ++ 3 files changed, 35 insertions(+), 1 deletion(-) diff --git a/evennia/commands/default/admin.py b/evennia/commands/default/admin.py index 08890dfcdc..c260abaa2e 100644 --- a/evennia/commands/default/admin.py +++ b/evennia/commands/default/admin.py @@ -17,7 +17,7 @@ PERMISSION_HIERARCHY = [p.lower() for p in settings.PERMISSION_HIERARCHY] # limit members for API inclusion __all__ = ("CmdBoot", "CmdBan", "CmdUnban", - "CmdEmit", "CmdNewPassword", "CmdPerm", "CmdWall") + "CmdEmit", "CmdNewPassword", "CmdPerm", "CmdWall", "CmdForce") class CmdBoot(COMMAND_DEFAULT_CLASS): @@ -513,3 +513,33 @@ class CmdWall(COMMAND_DEFAULT_CLASS): message = "%s shouts \"%s\"" % (self.caller.name, self.args) self.msg("Announcing to all connected sessions ...") SESSIONS.announce_all(message) + + +class CmdForce(COMMAND_DEFAULT_CLASS): + """ + forces an object to execute a command + + Usage: + @force = + + Example: + @force bob=get stick + """ + key = "@force" + locks = "cmd:perm(spawn) or perm(Builder)" + help_category = "Building" + perm_used = "edit" + + def func(self): + """Implements the force command""" + if not self.lhs or not self.rhs: + self.caller.msg("You must provide a target and a command string to execute.") + return + targ = self.caller.search(self.lhs) + if not targ: + return + if not targ.access(self.caller, self.perm_used): + self.caller.msg("You don't have permission to force them to execute commands.") + return + targ.execute_cmd(self.rhs) + self.caller.msg("You have forced %s to: %s" % (targ, self.rhs)) diff --git a/evennia/commands/default/cmdset_character.py b/evennia/commands/default/cmdset_character.py index cfc8a30ca4..438996f536 100644 --- a/evennia/commands/default/cmdset_character.py +++ b/evennia/commands/default/cmdset_character.py @@ -57,6 +57,7 @@ class CharacterCmdSet(CmdSet): self.add(admin.CmdEmit()) self.add(admin.CmdPerm()) self.add(admin.CmdWall()) + self.add(admin.CmdForce()) # Building and world manipulation self.add(building.CmdTeleport()) diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index 19277c168a..b0f5211c6f 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -243,6 +243,9 @@ class TestAdmin(CommandTest): def test_ban(self): self.call(admin.CmdBan(), "Char", "Name-Ban char was added.") + def test_force(self): + self.call(admin.CmdForce(), "Char2=say test", 'Char2(#7) says, "test"|You have forced Char2 to: say test') + class TestAccount(CommandTest): From b82e18e794bb5cf92a6f7ef2b1aa204f8bc8bc5e Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Fri, 19 Oct 2018 18:44:45 -0500 Subject: [PATCH 074/187] Baseline tests: assert current behavior (disregarding requirements) --- evennia/commands/default/tests.py | 36 +++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index 691e1e63cb..be47a06aac 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -460,16 +460,44 @@ class TestBuilding(CommandTest): # Test listing commands self.call(building.CmdSpawn(), "/list", "Key ") - # @span/edit + # @span/edit (missing prototype) self.call( building.CmdSpawn(), '/edit', - 'spawn: Extra switch "/edit" ignored') + '@spawn: Extra switch "/edit" ignored.|Usage: @spawn or {key: value, ...}\n (2 existing prototypes. Use /list to inspect)') + # assert 'Prototype wizard' in msg - # @span/examine + # @spawn/edit with valid prototype + # with self.assertRaises(AttributeError): self.call( + building.CmdSpawn(), + '/edit BALL', + '@spawn: Extra switch "/edit" ignored.|Spawned Ball(#13).') + + # @spawn/edit with invalid prototype + #`with self.assertRaises(AttributeError): + self.call( + building.CmdSpawn(), + '/edit NO_EXISTS', + '@spawn: Extra switch "/edit" ignored.|No prototype named \'NO_EXISTS\'.') + + # @spawn/examine (missing prototype) + self.call( + building.CmdSpawn(), '/examine', - building.CmdSpawn(), 'spawn: Extra switch "/examine" ignored') + '@spawn: Extra switch "/examine" ignored.|Usage: @spawn or {key: value, ...}\n (2 existing prototypes. Use /list to inspect)') + + # @spawn/examine with valid prototype + self.call( + building.CmdSpawn(), + '/examine BALL', + '@spawn: Extra switch "/examine" ignored.|Spawned Ball(#14).') + + # @spawn/examine with invalid prototype + self.call( + building.CmdSpawn(), + '/examine NO_EXISTS', + '@spawn: Extra switch "/examine" ignored.|No prototype named \'NO_EXISTS\'.') class TestComms(CommandTest): From 1a6d7a22adcb6b68de154e42f9756dc7b2669eac Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Fri, 19 Oct 2018 19:01:27 -0500 Subject: [PATCH 075/187] @spawn/edit is equivalent to @spawn/olc and @olc --- evennia/commands/default/building.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/evennia/commands/default/building.py b/evennia/commands/default/building.py index f0ae108f00..ad613609ba 100644 --- a/evennia/commands/default/building.py +++ b/evennia/commands/default/building.py @@ -2856,7 +2856,7 @@ class CmdSpawn(COMMAND_DEFAULT_CLASS): key = "@spawn" aliases = ["olc"] - switch_options = ("noloc", "search", "list", "show", "save", "delete", "menu", "olc", "update") + switch_options = ("noloc", "search", "list", "show", "save", "delete", "menu", "olc", "update", "edit") locks = "cmd:perm(spawn) or perm(Builder)" help_category = "Building" @@ -2907,7 +2907,8 @@ class CmdSpawn(COMMAND_DEFAULT_CLASS): caller = self.caller - if self.cmdstring == "olc" or 'menu' in self.switches or 'olc' in self.switches: + if self.cmdstring == "olc" or 'menu' in self.switches \ + or 'olc' in self.switches or 'edit' in self.switches: # OLC menu mode prototype = None if self.lhs: From 387a2444a70adafbfa093a1b858668e1624b1b09 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Fri, 19 Oct 2018 19:16:02 -0500 Subject: [PATCH 076/187] Modify tests so they pass. Some new tests throw exceptions --- evennia/commands/default/tests.py | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index be47a06aac..0007a84e07 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -461,25 +461,25 @@ class TestBuilding(CommandTest): self.call(building.CmdSpawn(), "/list", "Key ") # @span/edit (missing prototype) - self.call( + msg = self.call( building.CmdSpawn(), - '/edit', - '@spawn: Extra switch "/edit" ignored.|Usage: @spawn or {key: value, ...}\n (2 existing prototypes. Use /list to inspect)') - # assert 'Prototype wizard' in msg + '/edit') + # '@spawn: Extra switch "/edit" ignored.|Usage: @spawn or {key: value, ...}\n (2 existing prototypes. Use /list to inspect)') + assert 'Prototype wizard' in msg # @spawn/edit with valid prototype - # with self.assertRaises(AttributeError): - self.call( - building.CmdSpawn(), - '/edit BALL', - '@spawn: Extra switch "/edit" ignored.|Spawned Ball(#13).') + with self.assertRaises(AttributeError): + self.call( + building.CmdSpawn(), + '/edit BALL', + '@spawn: Extra switch "/edit" ignored.|Spawned Ball(#13).') # @spawn/edit with invalid prototype - #`with self.assertRaises(AttributeError): - self.call( - building.CmdSpawn(), - '/edit NO_EXISTS', - '@spawn: Extra switch "/edit" ignored.|No prototype named \'NO_EXISTS\'.') + with self.assertRaises(AttributeError): + self.call( + building.CmdSpawn(), + '/edit NO_EXISTS', + '@spawn: Extra switch "/edit" ignored.|No prototype named \'NO_EXISTS\'.') # @spawn/examine (missing prototype) self.call( @@ -491,7 +491,8 @@ class TestBuilding(CommandTest): self.call( building.CmdSpawn(), '/examine BALL', - '@spawn: Extra switch "/examine" ignored.|Spawned Ball(#14).') + # '@spawn: Extra switch "/examine" ignored.|Spawned Ball(#14).') + '@spawn: Extra switch "/examine" ignored.|Spawned Ball(#13).') # @spawn/examine with invalid prototype self.call( From 15c940fba4da4af1999b2bbb781debb4a40b6891 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sat, 20 Oct 2018 20:11:41 -0500 Subject: [PATCH 077/187] Handle '@spawn/edit ' (no prototype key given) brings OLC menu. Handle '@spawn/edit testball' brings OLC menu. Handle '@spawn/edit NO_EXISTS' that returns error --- evennia/commands/default/building.py | 6 +++++- evennia/commands/default/tests.py | 27 +++++++++++++++------------ 2 files changed, 20 insertions(+), 13 deletions(-) diff --git a/evennia/commands/default/building.py b/evennia/commands/default/building.py index ed6f6d273f..65fedaf5c2 100644 --- a/evennia/commands/default/building.py +++ b/evennia/commands/default/building.py @@ -2913,7 +2913,7 @@ class CmdSpawn(COMMAND_DEFAULT_CLASS): prototype = None if self.lhs: key = self.lhs - prototype = spawner.search_prototype(key=key, return_meta=True) + prototype = protlib.search_prototype(key=key) if len(prototype) > 1: caller.msg("More than one match for {}:\n{}".format( key, "\n".join(proto.get('prototype_key', '') for proto in prototype))) @@ -2921,6 +2921,10 @@ class CmdSpawn(COMMAND_DEFAULT_CLASS): elif prototype: # one match prototype = prototype[0] + else: + # no match + caller.msg("No prototype '{}' was found.".format(key)) + return olc_menus.start_olc(caller, session=self.session, prototype=prototype) return diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index 59fdc7db69..1cbb81b090 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -479,25 +479,28 @@ class TestBuilding(CommandTest): self.call(building.CmdSpawn(), "/list", "Key ") # @span/edit (missing prototype) + # brings up olc menu msg = self.call( building.CmdSpawn(), '/edit') - # '@spawn: Extra switch "/edit" ignored.|Usage: @spawn or {key: value, ...}\n (2 existing prototypes. Use /list to inspect)') - assert 'Prototype wizard' in msg + assert msg.startswith('______________________________________________________________________________\n\n --- Prototype wizard --- \n\n') # @spawn/edit with valid prototype - with self.assertRaises(AttributeError): - self.call( - building.CmdSpawn(), - '/edit BALL', - '@spawn: Extra switch "/edit" ignored.|Spawned Ball(#13).') + self.call( + building.CmdSpawn(), + '/edit testball') + # TODO: OLC menu comes up but it gives no + # indication of testball prototype being + # edited ... Is this correct? + # On top of OCL being shown, msg is preceded + # by Room(#1)... + assert 'Prototype wizard' in msg # @spawn/edit with invalid prototype - with self.assertRaises(AttributeError): - self.call( - building.CmdSpawn(), - '/edit NO_EXISTS', - '@spawn: Extra switch "/edit" ignored.|No prototype named \'NO_EXISTS\'.') + msg = self.call( + building.CmdSpawn(), + '/edit NO_EXISTS', + "No prototype 'NO_EXISTS' was found.") # @spawn/examine (missing prototype) self.call( From 3893cfca092a37da67508f19df48b3fa6404098e Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sat, 20 Oct 2018 20:12:55 -0500 Subject: [PATCH 078/187] code cleanup --- evennia/commands/default/tests.py | 1 - 1 file changed, 1 deletion(-) diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index 1cbb81b090..d8657a7113 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -512,7 +512,6 @@ class TestBuilding(CommandTest): self.call( building.CmdSpawn(), '/examine BALL', - # '@spawn: Extra switch "/examine" ignored.|Spawned Ball(#14).') '@spawn: Extra switch "/examine" ignored.|Spawned Ball(#13).') # @spawn/examine with invalid prototype From 4c6205259b8762d864906b3643ea8cbf94132369 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sat, 20 Oct 2018 20:22:11 -0500 Subject: [PATCH 079/187] Test @spawn/edit BALL (synonym) --- evennia/commands/default/tests.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index d8657a7113..8dce5ccc46 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -486,7 +486,7 @@ class TestBuilding(CommandTest): assert msg.startswith('______________________________________________________________________________\n\n --- Prototype wizard --- \n\n') # @spawn/edit with valid prototype - self.call( + msg = self.call( building.CmdSpawn(), '/edit testball') # TODO: OLC menu comes up but it gives no @@ -496,6 +496,12 @@ class TestBuilding(CommandTest): # by Room(#1)... assert 'Prototype wizard' in msg + # @spawn/edit with valid prototype (synomym) + msg = self.call( + building.CmdSpawn(), + '/edit BALL') + assert 'Prototype wizard' in msg + # @spawn/edit with invalid prototype msg = self.call( building.CmdSpawn(), From 7c11d5a64c38a56194135b9f3b8c1727fc1719c5 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sat, 20 Oct 2018 22:39:53 -0500 Subject: [PATCH 080/187] Another control-group test (repeats = 2) - it passes --- evennia/utils/test_resources.py | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/evennia/utils/test_resources.py b/evennia/utils/test_resources.py index ac26fe40aa..a42e394b78 100644 --- a/evennia/utils/test_resources.py +++ b/evennia/utils/test_resources.py @@ -73,12 +73,6 @@ import inspect class TestCreateScript(EvenniaTest): - def setUp(self): - super(EvenniaTest, self).setUp() - - def tearDown(self): - super(EvenniaTest, self).tearDown() - def test_create_script(self): class TestScriptA(DefaultScript): def at_script_creation(self): @@ -92,7 +86,7 @@ class TestCreateScript(EvenniaTest): assert script.key == 'test_script' @unittest.expectedFailure - def test_create_script_w_one_repeat(self): + def test_create_script_w_repeats_equal_1(self): class TestScriptB(DefaultScript): def at_script_creation(self): self.key = 'test_script' @@ -100,8 +94,28 @@ class TestCreateScript(EvenniaTest): self.repeats = 1 self.persistent = False + # import ipdb + # ipdb.set_trace() + script = create.create_script(TestScriptB, key='test_script') assert script is not None assert script.interval == 10 assert script.repeats == 1 assert script.key == 'test_script' + + def test_create_script_w_repeats_equal_2(self): + class TestScriptC(DefaultScript): + def at_script_creation(self): + self.key = 'test_script' + self.interval = 10 + self.repeats = 2 + self.persistent = False + + # import ipdb + # ipdb.set_trace() + + script = create.create_script(TestScriptC, key='test_script') + assert script is not None + assert script.interval == 10 + assert script.repeats == 2 + assert script.key == 'test_script' From 17a2b9f9136118ee643653edf51dc191b2dd5ca0 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 21 Oct 2018 15:45:17 +0200 Subject: [PATCH 081/187] Update devel changelog with latest mergers --- CHANGELOG.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d00135dbf3..8a31aecb97 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,13 @@ - Removed default `@delaccount` command, incorporating as `@account/delete` instead. Added confirmation question. +- Add new `@force` command to have another object perform a command. +- Add the Portal uptime to the `@time` command. +- Make the `@link` command first make a local search before a global search. + +### Utils + +- Added more unit tests. ## Evennia 0.8 (2018) From de9546b70ac56c5f787a4659e1c00eebe1412e2d Mon Sep 17 00:00:00 2001 From: Brenden Tuck Date: Sun, 21 Oct 2018 10:03:54 -0400 Subject: [PATCH 082/187] Fix #1686 cursor placement issues --- .../web/webclient/static/webclient/js/plugins/history.js | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/evennia/web/webclient/static/webclient/js/plugins/history.js b/evennia/web/webclient/static/webclient/js/plugins/history.js index c33dbcabf9..60b1a2b163 100644 --- a/evennia/web/webclient/static/webclient/js/plugins/history.js +++ b/evennia/web/webclient/static/webclient/js/plugins/history.js @@ -69,8 +69,12 @@ let history_plugin = (function () { } if (history_entry !== null) { - // Doing a history navigation; replace the text in the input. - inputfield.val(history_entry); + // Performing a history navigation + // replace the text in the input and move the cursor to the end of the new value + inputfield.val(''); + inputfield.blur().focus().val(history_entry); + event.preventDefault(); + return true; } return false; From d408a7e8ad0488d16dd456949f9be3495d39454e Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sun, 21 Oct 2018 09:21:58 -0500 Subject: [PATCH 083/187] Add Script test with repeats=1 and start_delay=True --- evennia/utils/test_resources.py | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/evennia/utils/test_resources.py b/evennia/utils/test_resources.py index a42e394b78..c044d776fb 100644 --- a/evennia/utils/test_resources.py +++ b/evennia/utils/test_resources.py @@ -84,6 +84,7 @@ class TestCreateScript(EvenniaTest): assert script is not None assert script.interval == 10 assert script.key == 'test_script' + script.stop() @unittest.expectedFailure def test_create_script_w_repeats_equal_1(self): @@ -94,14 +95,12 @@ class TestCreateScript(EvenniaTest): self.repeats = 1 self.persistent = False - # import ipdb - # ipdb.set_trace() - script = create.create_script(TestScriptB, key='test_script') assert script is not None assert script.interval == 10 assert script.repeats == 1 assert script.key == 'test_script' + script.stop() def test_create_script_w_repeats_equal_2(self): class TestScriptC(DefaultScript): @@ -111,11 +110,25 @@ class TestCreateScript(EvenniaTest): self.repeats = 2 self.persistent = False - # import ipdb - # ipdb.set_trace() - script = create.create_script(TestScriptC, key='test_script') assert script is not None assert script.interval == 10 assert script.repeats == 2 assert script.key == 'test_script' + script.stop() + + def test_create_script_w_repeats_equal_1_and_delayed(self): + class TestScriptD(DefaultScript): + def at_script_creation(self): + self.key = 'test_script' + self.interval = 10 + self.start_delay = True + self.repeats = 1 + self.persistent = False + + script = create.create_script(TestScriptD, key='test_script') + assert script is not None + assert script.interval == 10 + assert script.repeats == 1 + assert script.key == 'test_script' + script.stop() From 9d800aae7c81b6baddb361fd7cd7b040049d97d0 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sun, 21 Oct 2018 13:43:36 -0500 Subject: [PATCH 084/187] Harden test '@spawn/edit ' by asserting that olc_menu has been loaded with valid-prototype.UX Enhancement to OLC menu. Underneath the title, display 'Editing: key(prototype_key)' of the prototype being edited. If none, show blank line --- evennia/commands/default/tests.py | 20 +++++++++++++------- evennia/prototypes/menus.py | 12 ++++++++++++ 2 files changed, 25 insertions(+), 7 deletions(-) diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index 8dce5ccc46..f285cc9614 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -478,29 +478,33 @@ class TestBuilding(CommandTest): # Test listing commands self.call(building.CmdSpawn(), "/list", "Key ") - # @span/edit (missing prototype) + # @spawn/edit (missing prototype) # brings up olc menu msg = self.call( building.CmdSpawn(), '/edit') - assert msg.startswith('______________________________________________________________________________\n\n --- Prototype wizard --- \n\n') + assert 'Prototype wizard' in msg # @spawn/edit with valid prototype + # brings up olc menu loaded with prototype msg = self.call( building.CmdSpawn(), '/edit testball') - # TODO: OLC menu comes up but it gives no - # indication of testball prototype being - # edited ... Is this correct? - # On top of OCL being shown, msg is preceded - # by Room(#1)... assert 'Prototype wizard' in msg + assert hasattr(self.char1.ndb._menutree, "olc_prototype") + assert dict == type(self.char1.ndb._menutree.olc_prototype) \ + and 'prototype_key' in self.char1.ndb._menutree.olc_prototype \ + and 'key' in self.char1.ndb._menutree.olc_prototype \ + and 'testball' == self.char1.ndb._menutree.olc_prototype['prototype_key'] \ + and 'Ball' == self.char1.ndb._menutree.olc_prototype['key'] + assert 'Ball' in msg and 'testball' in msg # @spawn/edit with valid prototype (synomym) msg = self.call( building.CmdSpawn(), '/edit BALL') assert 'Prototype wizard' in msg + assert 'Ball' in msg and 'testball' in msg # @spawn/edit with invalid prototype msg = self.call( @@ -518,6 +522,8 @@ class TestBuilding(CommandTest): self.call( building.CmdSpawn(), '/examine BALL', + # FIXME: should this print the existing prototype + # instead of spawning it? '@spawn: Extra switch "/examine" ignored.|Spawned Ball(#13).') # @spawn/examine with invalid prototype diff --git a/evennia/prototypes/menus.py b/evennia/prototypes/menus.py index 9605ea1a8f..c10f32429f 100644 --- a/evennia/prototypes/menus.py +++ b/evennia/prototypes/menus.py @@ -562,6 +562,7 @@ def node_index(caller): text = """ |c --- Prototype wizard --- |n + %s A |cprototype|n is a 'template' for |wspawning|n an in-game entity. A field of the prototype can either be hard-coded, left empty or scripted using |w$protfuncs|n - for example to @@ -599,6 +600,17 @@ def node_index(caller): {pfuncs} """.format(pfuncs=_format_protfuncs()) + # If a prototype is being edited, show its key and + # prototype_key under the title + loaded_prototype = '' + if 'prototype_key' in prototype \ + or 'key' in prototype: + loaded_prototype = ' --- Editing: |y{}({})|n --- '.format( + prototype.get('key', ''), + prototype.get('prototype_key', '') + ) + text = text % (loaded_prototype) + text = (text, helptxt) options = [] From 79a64ce3d256f7c03dfac0aa46928a007945f520 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sun, 21 Oct 2018 14:15:34 -0500 Subject: [PATCH 085/187] Add 'examine' as valid switch alias for 'show' with its corresponding tests --- evennia/commands/default/building.py | 2 +- evennia/commands/default/tests.py | 19 ++++++++++--------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/evennia/commands/default/building.py b/evennia/commands/default/building.py index 65fedaf5c2..503a9c15e9 100644 --- a/evennia/commands/default/building.py +++ b/evennia/commands/default/building.py @@ -2856,7 +2856,7 @@ class CmdSpawn(COMMAND_DEFAULT_CLASS): key = "@spawn" aliases = ["olc"] - switch_options = ("noloc", "search", "list", "show", "save", "delete", "menu", "olc", "update", "edit") + switch_options = ("noloc", "search", "list", "show", "examine", "save", "delete", "menu", "olc", "update", "edit") locks = "cmd:perm(spawn) or perm(Builder)" help_category = "Building" diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index f285cc9614..7b2c78951b 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -513,24 +513,25 @@ class TestBuilding(CommandTest): "No prototype 'NO_EXISTS' was found.") # @spawn/examine (missing prototype) - self.call( + # lists all prototypes that exist + msg = self.call( building.CmdSpawn(), - '/examine', - '@spawn: Extra switch "/examine" ignored.|Usage: @spawn or {key: value, ...}\n (2 existing prototypes. Use /list to inspect)') + '/examine') + assert 'testball' in msg and 'testprot' in msg # @spawn/examine with valid prototype - self.call( + # prints the prototype + msg = self.call( building.CmdSpawn(), - '/examine BALL', - # FIXME: should this print the existing prototype - # instead of spawning it? - '@spawn: Extra switch "/examine" ignored.|Spawned Ball(#13).') + '/examine BALL') + assert 'Ball' in msg and 'testball' in msg # @spawn/examine with invalid prototype + # shows error self.call( building.CmdSpawn(), '/examine NO_EXISTS', - '@spawn: Extra switch "/examine" ignored.|No prototype named \'NO_EXISTS\'.') + "No prototype 'NO_EXISTS' was found.") class TestComms(CommandTest): From 0a7bb5b92612f12a462360c22579fc3f7e7b710b Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sun, 21 Oct 2018 20:13:31 -0500 Subject: [PATCH 086/187] Test create_script() repeats=1 and persisted=True --- evennia/utils/test_resources.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/evennia/utils/test_resources.py b/evennia/utils/test_resources.py index c044d776fb..3981ea1476 100644 --- a/evennia/utils/test_resources.py +++ b/evennia/utils/test_resources.py @@ -102,6 +102,22 @@ class TestCreateScript(EvenniaTest): assert script.key == 'test_script' script.stop() + def test_create_script_w_repeats_equal_1_persisted(self): + class TestScriptB1(DefaultScript): + def at_script_creation(self): + self.key = 'test_script' + self.interval = 10 + self.repeats = 1 + self.persistent = True + + script = create.create_script(TestScriptB1, key='test_script') + assert script is not None + assert script.interval == 10 + assert script.repeats == 1 + assert script.key == 'test_script' + assert self.persistent == True + script.stop() + def test_create_script_w_repeats_equal_2(self): class TestScriptC(DefaultScript): def at_script_creation(self): From a5b759cff0555f55953473f06b245b6dcf5ef747 Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 22 Oct 2018 20:33:56 +0000 Subject: [PATCH 087/187] Renames methods to web_get_* and fixes tests. --- evennia/accounts/tests.py | 6 +++--- evennia/objects/tests.py | 4 ++-- evennia/typeclasses/models.py | 24 +++++++----------------- 3 files changed, 12 insertions(+), 22 deletions(-) diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index fbf976d644..be07a30cbd 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -64,14 +64,14 @@ class TestDefaultAccount(TestCase): "Get URL for account detail page on website" self.account = create.create_account("TestAccount%s" % randint(100000, 999999), email="test@test.com", password="testpassword", typeclass=DefaultAccount) - self.assertTrue(self.account.web_detail_url()) + self.assertTrue(self.account.web_get_detail_url()) def test_admin_url(self): "Get object's URL for access via Admin pane" self.account = create.create_account("TestAccount%s" % randint(100000, 999999), email="test@test.com", password="testpassword", typeclass=DefaultAccount) - self.assertTrue(self.account.web_admin_url()) - self.assertTrue(self.account.web_admin_url() != '#') + self.assertTrue(self.account.web_get_admin_url()) + self.assertTrue(self.account.web_get_admin_url() != '#') def test_password_validation(self): "Check password validators deny bad passwords" diff --git a/evennia/objects/tests.py b/evennia/objects/tests.py index f317f2c39c..824007f287 100644 --- a/evennia/objects/tests.py +++ b/evennia/objects/tests.py @@ -5,7 +5,7 @@ class DefaultObjectTest(EvenniaTest): def test_urls(self): "Make sure objects are returning URLs" self.assertTrue(self.char1.get_absolute_url()) - self.assertTrue('admin' in self.char1.get_admin_url()) + self.assertTrue('admin' in self.char1.web_get_admin_url()) self.assertTrue(self.room1.get_absolute_url()) - self.assertTrue('admin' in self.room1.get_admin_url()) \ No newline at end of file + self.assertTrue('admin' in self.room1.web_get_admin_url()) \ No newline at end of file diff --git a/evennia/typeclasses/models.py b/evennia/typeclasses/models.py index 098606b53c..d549efb8ff 100644 --- a/evennia/typeclasses/models.py +++ b/evennia/typeclasses/models.py @@ -741,7 +741,7 @@ class TypedObject(SharedMemoryModel): # Web/Django methods # - def web_admin_url(self): + def web_get_admin_url(self): """ Returns the URI path for the Django Admin page for this object. @@ -755,7 +755,7 @@ class TypedObject(SharedMemoryModel): return reverse("admin:%s_%s_change" % (content_type.app_label, content_type.model), args=(self.id,)) @classmethod - def web_create_url(cls): + def web_get_create_url(cls): """ Returns the URI path for a View that allows users to create new instances of this object. @@ -783,7 +783,7 @@ class TypedObject(SharedMemoryModel): try: return reverse('%s-create' % cls._meta.verbose_name.lower()) except: return '#' - def web_detail_url(self): + def web_get_detail_url(self): """ Returns the URI path for a View that allows users to view details for this object. @@ -811,7 +811,7 @@ class TypedObject(SharedMemoryModel): try: return reverse('%s-detail' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) except: return '#' - def web_update_url(self): + def web_get_update_url(self): """ Returns the URI path for a View that allows users to update this object. @@ -839,7 +839,7 @@ class TypedObject(SharedMemoryModel): try: return reverse('%s-update' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) except: return '#' - def web_delete_url(self): + def web_get_delete_url(self): """ Returns the URI path for a View that allows users to delete this object. @@ -866,15 +866,5 @@ class TypedObject(SharedMemoryModel): try: return reverse('%s-delete' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) except: return '#' - def get_absolute_url(self): - """ - Django construct; used by Django Sites framework and within the Admin - panel for reverse linking to the object detail page. - - https://docs.djangoproject.com/en/2.1/ref/models/instances/#get-absolute-url - - Returns: - path (str): URI path to object detail page, if defined. - - """ - return self.web_detail_url() \ No newline at end of file + # Used by Django Sites/Admin + get_absolute_url = web_get_detail_url \ No newline at end of file From 30547cb5bfbcb76165cc3a59f09f7afbb3be286f Mon Sep 17 00:00:00 2001 From: Griatch Date: Mon, 22 Oct 2018 23:32:12 +0200 Subject: [PATCH 088/187] Made some pep8 fixes --- evennia/accounts/tests.py | 14 ++- evennia/objects/objects.py | 10 +- evennia/objects/tests.py | 7 +- evennia/typeclasses/models.py | 185 ++++++++++++++++++---------------- 4 files changed, 113 insertions(+), 103 deletions(-) diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index d60db0fce5..084e8a6a66 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -5,12 +5,9 @@ from unittest import TestCase from django.test import override_settings from evennia.accounts.accounts import AccountSessionHandler from evennia.accounts.accounts import DefaultAccount -from evennia.server.session import Session from evennia.utils import create from evennia.utils.test_resources import EvenniaTest -from django.conf import settings - class TestAccountSessionHandler(TestCase): "Check AccountSessionHandler class" @@ -73,7 +70,7 @@ class TestDefaultAccount(TestCase): self.account = create.create_account("TestAccount%s" % randint(100000, 999999), email="test@test.com", password="testpassword", typeclass=DefaultAccount) self.assertTrue(self.account.web_get_detail_url()) - + def test_admin_url(self): "Get object's URL for access via Admin pane" self.account = create.create_account("TestAccount%s" % randint(100000, 999999), @@ -211,17 +208,18 @@ class TestDefaultAccount(TestCase): class TestAccountPuppetDeletion(EvenniaTest): - + @override_settings(MULTISESSION_MODE=2) def test_puppet_deletion(self): # Check for existing chars self.assertFalse(self.account.db._playable_characters, 'Account should not have any chars by default.') - + # Add char1 to account's playable characters self.account.db._playable_characters.append(self.char1) self.assertTrue(self.account.db._playable_characters, 'Char was not added to account.') - + # See what happens when we delete char1. self.char1.delete() # Playable char list should be empty. - self.assertFalse(self.account.db._playable_characters, 'Playable character list is not empty! %s' % self.account.db._playable_characters) \ No newline at end of file + self.assertFalse(self.account.db._playable_characters, + 'Playable character list is not empty! %s' % self.account.db._playable_characters) diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 7e1a13722e..919da40a7c 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -7,15 +7,11 @@ entities. """ import time import inflect -import re from builtins import object from future.utils import with_metaclass from collections import defaultdict from django.conf import settings -from django.contrib.contenttypes.models import ContentType -from django.urls import reverse -from django.utils.text import slugify from evennia.typeclasses.models import TypeclassBase from evennia.typeclasses.attributes import NickHandler @@ -218,7 +214,7 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): @property def is_connected(self): # we get an error for objects subscribed to channels without this - if self.account: # seems sane to pass on the account + if self.account: # seems sane to pass on the account return self.account.is_connected else: return False @@ -328,7 +324,7 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): # look at 'an egg'. self.aliases.add(singular, category="plural_key") return singular, plural - + def search(self, searchdata, global_search=False, use_nicks=True, @@ -922,7 +918,7 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): self.account.db._playable_characters = [x for x in self.account.db._playable_characters if x != self] for session in self.sessions.all(): self.account.unpuppet_object(session) - + self.account = None for script in _ScriptDB.objects.get_all_scripts_on_obj(self): diff --git a/evennia/objects/tests.py b/evennia/objects/tests.py index 824007f287..2c014cbe77 100644 --- a/evennia/objects/tests.py +++ b/evennia/objects/tests.py @@ -1,11 +1,12 @@ from evennia.utils.test_resources import EvenniaTest + class DefaultObjectTest(EvenniaTest): - + def test_urls(self): "Make sure objects are returning URLs" self.assertTrue(self.char1.get_absolute_url()) self.assertTrue('admin' in self.char1.web_get_admin_url()) - + self.assertTrue(self.room1.get_absolute_url()) - self.assertTrue('admin' in self.room1.web_get_admin_url()) \ No newline at end of file + self.assertTrue('admin' in self.room1.web_get_admin_url()) diff --git a/evennia/typeclasses/models.py b/evennia/typeclasses/models.py index d549efb8ff..61dddc0c80 100644 --- a/evennia/typeclasses/models.py +++ b/evennia/typeclasses/models.py @@ -740,131 +740,146 @@ class TypedObject(SharedMemoryModel): # # Web/Django methods # - + def web_get_admin_url(self): """ Returns the URI path for the Django Admin page for this object. - + ex. Account#1 = '/admin/accounts/accountdb/1/change/' - + Returns: path (str): URI path to Django Admin page for object. - + """ content_type = ContentType.objects.get_for_model(self.__class__) - return reverse("admin:%s_%s_change" % (content_type.app_label, content_type.model), args=(self.id,)) - + return reverse("admin:%s_%s_change" % (content_type.app_label, + content_type.model), args=(self.id,)) + @classmethod def web_get_create_url(cls): """ Returns the URI path for a View that allows users to create new instances of this object. - + ex. Chargen = '/characters/create/' - + For this to work, the developer must have defined a named view somewhere in urls.py that follows the format 'modelname-action', so in this case a named view of 'character-create' would be referenced by this method. - + ex. url(r'characters/create/', ChargenView.as_view(), name='character-create') - + If no View has been created and defined in urls.py, returns an HTML anchor. - + This method is naive and simply returns a path. Securing access to - the actual view and limiting who can create new objects is the + the actual view and limiting who can create new objects is the developer's responsibility. - + Returns: path (str): URI path to object creation page, if defined. - + """ - try: return reverse('%s-create' % cls._meta.verbose_name.lower()) - except: return '#' - + try: + return reverse('%s-create' % cls._meta.verbose_name.lower()) + except: + return '#' + def web_get_detail_url(self): """ - Returns the URI path for a View that allows users to view details for + Returns the URI path for a View that allows users to view details for this object. - + ex. Oscar (Character) = '/characters/oscar/1/' - - For this to work, the developer must have defined a named view somewhere - in urls.py that follows the format 'modelname-action', so in this case - a named view of 'character-detail' would be referenced by this method. - - ex. - url(r'characters/(?P[\w\d\-]+)/(?P[0-9]+)/$', CharDetailView.as_view(), name='character-detail') - - If no View has been created and defined in urls.py, returns an - HTML anchor. - - This method is naive and simply returns a path. Securing access to - the actual view and limiting who can view this object is the developer's - responsibility. - - Returns: - path (str): URI path to object detail page, if defined. - - """ - try: return reverse('%s-detail' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) - except: return '#' - - def web_get_update_url(self): - """ - Returns the URI path for a View that allows users to update this - object. - - ex. Oscar (Character) = '/characters/oscar/1/change/' - - For this to work, the developer must have defined a named view somewhere - in urls.py that follows the format 'modelname-action', so in this case - a named view of 'character-update' would be referenced by this method. - - ex. - url(r'characters/(?P[\w\d\-]+)/(?P[0-9]+)/change/$', CharUpdateView.as_view(), name='character-update') - - If no View has been created and defined in urls.py, returns an - HTML anchor. - - This method is naive and simply returns a path. Securing access to - the actual view and limiting who can modify objects is the developer's - responsibility. - - Returns: - path (str): URI path to object update page, if defined. - - """ - try: return reverse('%s-update' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) - except: return '#' - - def web_get_delete_url(self): - """ - Returns the URI path for a View that allows users to delete this object. - - ex. Oscar (Character) = '/characters/oscar/1/delete/' - + For this to work, the developer must have defined a named view somewhere in urls.py that follows the format 'modelname-action', so in this case a named view of 'character-detail' would be referenced by this method. ex. - url(r'characters/(?P[\w\d\-]+)/(?P[0-9]+)/delete/$', CharDeleteView.as_view(), name='character-delete') - + url(r'characters/(?P[\w\d\-]+)/(?P[0-9]+)/$', + CharDetailView.as_view(), name='character-detail') + If no View has been created and defined in urls.py, returns an HTML anchor. - + This method is naive and simply returns a path. Securing access to - the actual view and limiting who can delete this object is the developer's + the actual view and limiting who can view this object is the developer's responsibility. - + + Returns: + path (str): URI path to object detail page, if defined. + + """ + try: + return reverse('%s-detail' % self._meta.verbose_name.lower(), + kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: + return '#' + + def web_get_update_url(self): + """ + Returns the URI path for a View that allows users to update this + object. + + ex. Oscar (Character) = '/characters/oscar/1/change/' + + For this to work, the developer must have defined a named view somewhere + in urls.py that follows the format 'modelname-action', so in this case + a named view of 'character-update' would be referenced by this method. + + ex. + url(r'characters/(?P[\w\d\-]+)/(?P[0-9]+)/change/$', + CharUpdateView.as_view(), name='character-update') + + If no View has been created and defined in urls.py, returns an + HTML anchor. + + This method is naive and simply returns a path. Securing access to + the actual view and limiting who can modify objects is the developer's + responsibility. + + Returns: + path (str): URI path to object update page, if defined. + + """ + try: + return reverse('%s-update' % self._meta.verbose_name.lower(), + kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: + return '#' + + def web_get_delete_url(self): + """ + Returns the URI path for a View that allows users to delete this object. + + ex. Oscar (Character) = '/characters/oscar/1/delete/' + + For this to work, the developer must have defined a named view somewhere + in urls.py that follows the format 'modelname-action', so in this case + a named view of 'character-detail' would be referenced by this method. + + ex. + url(r'characters/(?P[\w\d\-]+)/(?P[0-9]+)/delete/$', + CharDeleteView.as_view(), name='character-delete') + + If no View has been created and defined in urls.py, returns an + HTML anchor. + + This method is naive and simply returns a path. Securing access to + the actual view and limiting who can delete this object is the developer's + responsibility. + Returns: path (str): URI path to object deletion page, if defined. - + """ - try: return reverse('%s-delete' % self._meta.verbose_name.lower(), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) - except: return '#' - + try: + return reverse('%s-delete' % self._meta.verbose_name.lower(), + kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: + return '#' + # Used by Django Sites/Admin - get_absolute_url = web_get_detail_url \ No newline at end of file + get_absolute_url = web_get_detail_url From dc299b1e7f2733791794f2a5cfbb5ba667bea739 Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 22 Oct 2018 21:57:38 +0000 Subject: [PATCH 089/187] Fixes failing tests. --- evennia/accounts/tests.py | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index a6f9d5bcbf..2f2d6cc7eb 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -84,16 +84,14 @@ class TestDefaultGuest(EvenniaTest): self.assertFalse(account, 'Two guest accounts were created with a single entry on the guest list!') settings.GUEST_ENABLED = False - -class TestDefaultAccount(EvenniaTest): - "Check DefaultAccount class" - + +class TestDefaultAccountAuth(EvenniaTest): + def setUp(self): - self.s1 = MagicMock() - self.s1.puppet = None - self.s1.sessid = 0 + super(TestDefaultAccountAuth, self).setUp() self.password = "testpassword" + self.account.delete() self.account = create.create_account("TestAccount%s" % randint(100000, 999999), email="test@test.com", password=self.password, typeclass=DefaultAccount) def test_authentication(self): @@ -138,10 +136,6 @@ class TestDefaultAccount(EvenniaTest): result, error = DefaultAccount.validate_username('xx') self.assertFalse(result, "2-character username passed validation.") - def tearDown(self): - if hasattr(self, "account"): - self.account.delete() - def test_password_validation(self): "Check password validators deny bad passwords" @@ -167,6 +161,14 @@ class TestDefaultAccount(EvenniaTest): # Try setting a better password (test for False; returns None on success) self.assertFalse(self.account.set_password('Mxyzptlk')) +class TestDefaultAccount(TestCase): + "Check DefaultAccount class" + + def setUp(self): + self.s1 = MagicMock() + self.s1.puppet = None + self.s1.sessid = 0 + def test_puppet_object_no_object(self): "Check puppet_object method called with no object param" From 1ddb887d7ae79b2f69a2feb74b0e9f319ffc040f Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 22 Oct 2018 22:12:54 +0000 Subject: [PATCH 090/187] Fixes failed unit tests. --- evennia/accounts/tests.py | 38 +++++++++++++------------------------- 1 file changed, 13 insertions(+), 25 deletions(-) diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index 81ac25c2a3..2cfd9350cb 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -6,12 +6,14 @@ from unittest import TestCase from django.test import override_settings from evennia.accounts.accounts import AccountSessionHandler - from evennia.accounts.accounts import DefaultAccount, DefaultGuest from evennia.server.session import Session +from evennia.utils.test_resources import EvenniaTest from evennia.utils import create from evennia.utils.test_resources import EvenniaTest +from django.conf import settings + class TestAccountSessionHandler(TestCase): "Check AccountSessionHandler class" @@ -134,43 +136,30 @@ class TestDefaultAccountAuth(EvenniaTest): result, error = DefaultAccount.validate_username('xx') self.assertFalse(result, "2-character username passed validation.") - def test_absolute_url(self): - "Get URL for account detail page on website" - self.account = create.create_account("TestAccount%s" % randint(100000, 999999), - email="test@test.com", password="testpassword", typeclass=DefaultAccount) - self.assertTrue(self.account.web_get_detail_url()) - - def test_admin_url(self): - "Get object's URL for access via Admin pane" - self.account = create.create_account("TestAccount%s" % randint(100000, 999999), - email="test@test.com", password="testpassword", typeclass=DefaultAccount) - self.assertTrue(self.account.web_get_admin_url()) - self.assertTrue(self.account.web_get_admin_url() != '#') - def test_password_validation(self): "Check password validators deny bad passwords" - self.account = create.create_account("TestAccount%s" % randint(100000, 999999), + account = create.create_account("TestAccount%s" % randint(100000, 999999), email="test@test.com", password="testpassword", typeclass=DefaultAccount) for bad in ('', '123', 'password', 'TestAccount', '#', 'xyzzy'): - self.assertFalse(self.account.validate_password(bad, account=self.account)[0]) + self.assertFalse(account.validate_password(bad, account=self.account)[0]) "Check validators allow sufficiently complex passwords" for better in ('Mxyzptlk', "j0hn, i'M 0n1y d4nc1nG"): - self.assertTrue(self.account.validate_password(better, account=self.account)[0]) + self.assertTrue(account.validate_password(better, account=self.account)[0]) def test_password_change(self): "Check password setting and validation is working as expected" - self.account = create.create_account("TestAccount%s" % randint(0, 9), + account = create.create_account("TestAccount%s" % randint(0, 9), email="test@test.com", password="testpassword", typeclass=DefaultAccount) from django.core.exceptions import ValidationError # Try setting some bad passwords for bad in ('', '#', 'TestAccount', 'password'): - self.assertRaises(ValidationError, self.account.set_password, bad) + self.assertRaises(ValidationError, account.set_password, bad) # Try setting a better password (test for False; returns None on success) - self.assertFalse(self.account.set_password('Mxyzptlk')) + self.assertFalse(account.set_password('Mxyzptlk')) class TestDefaultAccount(TestCase): "Check DefaultAccount class" @@ -285,18 +274,17 @@ class TestDefaultAccount(TestCase): class TestAccountPuppetDeletion(EvenniaTest): - + @override_settings(MULTISESSION_MODE=2) def test_puppet_deletion(self): # Check for existing chars self.assertFalse(self.account.db._playable_characters, 'Account should not have any chars by default.') - + # Add char1 to account's playable characters self.account.db._playable_characters.append(self.char1) self.assertTrue(self.account.db._playable_characters, 'Char was not added to account.') - + # See what happens when we delete char1. self.char1.delete() # Playable char list should be empty. - self.assertFalse(self.account.db._playable_characters, - 'Playable character list is not empty! %s' % self.account.db._playable_characters) + self.assertFalse(self.account.db._playable_characters, 'Playable character list is not empty! %s' % self.account.db._playable_characters) \ No newline at end of file From 52b58dbeb23a00c1143beeae3fb895f77d1fffa7 Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 22 Oct 2018 22:26:29 +0000 Subject: [PATCH 091/187] Fixes failed tests, hopefully for real this time. --- evennia/accounts/tests.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index 2cfd9350cb..5e8e58cf9f 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -111,8 +111,9 @@ class TestDefaultAccountAuth(EvenniaTest): self.assertTrue(account, 'New account should have been created.') # Try creating a duplicate account - account, errors = DefaultAccount.create(username='Ziggy', password='starman11') - self.assertFalse(account, 'Duplicate account name should not have been allowed.') + account2, errors = DefaultAccount.create(username='Ziggy', password='starman11') + self.assertFalse(account2, 'Duplicate account name should not have been allowed.') + account.delete() def test_throttle(self): "Confirm throttle activates on too many failures." @@ -147,10 +148,11 @@ class TestDefaultAccountAuth(EvenniaTest): "Check validators allow sufficiently complex passwords" for better in ('Mxyzptlk', "j0hn, i'M 0n1y d4nc1nG"): self.assertTrue(account.validate_password(better, account=self.account)[0]) + account.delete() def test_password_change(self): "Check password setting and validation is working as expected" - account = create.create_account("TestAccount%s" % randint(0, 9), + account = create.create_account("TestAccount%s" % randint(100000, 999999), email="test@test.com", password="testpassword", typeclass=DefaultAccount) from django.core.exceptions import ValidationError @@ -160,6 +162,7 @@ class TestDefaultAccountAuth(EvenniaTest): # Try setting a better password (test for False; returns None on success) self.assertFalse(account.set_password('Mxyzptlk')) + account.delete() class TestDefaultAccount(TestCase): "Check DefaultAccount class" From c03c077d73da4901da2341c73cae72af99b0eef6 Mon Sep 17 00:00:00 2001 From: Griatch Date: Tue, 23 Oct 2018 01:04:25 +0200 Subject: [PATCH 092/187] Update CHANGELOG, pep8 fixes --- CHANGELOG.md | 26 +++- evennia/accounts/accounts.py | 160 ++++++++++++------------- evennia/accounts/tests.py | 48 ++++---- evennia/commands/default/unloggedin.py | 30 ++--- evennia/objects/objects.py | 146 +++++++++++----------- evennia/objects/tests.py | 13 +- evennia/scripts/scripts.py | 14 +-- evennia/server/throttle.py | 55 +++++---- evennia/server/validators.py | 41 ++++--- evennia/settings_default.py | 21 ++-- 10 files changed, 290 insertions(+), 264 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8a31aecb97..da326f766f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,30 @@ - Add the Portal uptime to the `@time` command. - Make the `@link` command first make a local search before a global search. +### Typeclasses + +- Add new methods on all typeclasses, useful specifically for viewing the object in the web/admin: + + `web_get_admin_url()`: Returns a path that, if followed, will display the object in the Admin backend. + + `web_get_create_url()`: Returns a path for a view allowing the creation of new instances of this object. + + `web_get_absolute_url()`: Django construct; returns a path that should display the object in a DetailView. + + `web_get_update_url()`: Returns a path that should display the object in an UpdateView. + + `web_get_delete_url()`: Returns a path that should display the object in a DeleteView. +- All typeclasses has new helper class method `create`, which encompasses useful functionality + that used to be embedded for example in the respective `@create` or `@connect` commands. +- DefaultAccount now has new class methods implementing many things that used to be in unloggedin + commands (these can now be customized on the class instead): + + `is_banned()`: Checks if a given username or IP is banned. + + `get_username_validators`: Return list of validators for username validation (see + `settings.AUTH_USERNAME_VALIDATORS`) + + `authenticate`: Method to check given username/password. + + `normalize_username`: Normalizes names so you can't fake names with similar-looking Unicode + chars. + + `validate_username`: Mechanism for validating a username. + + `validate_password`: Mechanism for validating a password. + + `set_password`: Apply password to account, using validation checks. + + + ### Utils - Added more unit tests. @@ -34,7 +58,7 @@ to terminal and can be stopped with Ctrl-C. Using `evennia reload`, or reloading in-game, will return Server to normal daemon operation. - For validating passwords, use safe Django password-validation backend instead of custom Evennia one. -- Alias `evennia restart` to mean the same as `evennia reload`. +- Alias `evennia restart` to mean the same as `evennia reload`. ### Prototype changes diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 7e1ddb80e8..3fed8dc25e 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -370,40 +370,40 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): def is_banned(cls, **kwargs): """ Checks if a given username or IP is banned. - + Kwargs: ip (str, optional): IP address. username (str, optional): Username. - + Returns: is_banned (bool): Whether either is banned or not. - + """ - + ip = kwargs.get('ip', '').strip() username = kwargs.get('username', '').lower().strip() - + # Check IP and/or name bans bans = ServerConfig.objects.conf("server_bans") if bans and (any(tup[0] == username for tup in bans if username) or any(tup[2].match(ip) for tup in bans if ip and tup[2])): return True - + return False - + @classmethod def get_username_validators(cls, validator_config=getattr(settings, 'AUTH_USERNAME_VALIDATORS', [])): """ Retrieves and instantiates validators for usernames. - + Args: validator_config (list): List of dicts comprising the battery of validators to apply to a username. - + Returns: validators (list): List of instantiated Validator objects. """ - + objs = [] for validator in validator_config: try: @@ -413,49 +413,49 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): raise ImproperlyConfigured(msg % validator['NAME']) objs.append(klass(**validator.get('OPTIONS', {}))) return objs - + @classmethod def authenticate(cls, username, password, ip='', **kwargs): """ - Checks the given username/password against the database to see if the + Checks the given username/password against the database to see if the credentials are valid. - + Note that this simply checks credentials and returns a valid reference to the user-- it does not log them in! - + To finish the job: After calling this from a Command, associate the account with a Session: - session.sessionhandler.login(session, account) - + ...or after calling this from a View, associate it with an HttpRequest: - django.contrib.auth.login(account, request) - + Args: username (str): Username of account password (str): Password of account ip (str, optional): IP address of client - + Kwargs: session (Session, optional): Session requesting authentication - + Returns: account (DefaultAccount, None): Account whose credentials were provided if not banned. errors (list): Error messages of any failures. - + """ errors = [] if ip: ip = str(ip) - + # See if authentication is currently being throttled if ip and LOGIN_THROTTLE.check(ip): errors.append('Too many login failures; please try again in a few minutes.') - + # With throttle active, do not log continued hits-- it is a # waste of storage and can be abused to make your logs harder to # read and/or fill up your disk. return None, errors - + # Check IP and/or name bans banned = cls.is_banned(username=username, ip=ip) if banned: @@ -465,19 +465,19 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): logger.log_sec('Authentication Denied (Banned): %s (IP: %s).' % (username, ip)) LOGIN_THROTTLE.update(ip, 'Too many sightings of banned artifact.') return None, errors - + # Authenticate and get Account object account = authenticate(username=username, password=password) if not account: # User-facing message errors.append('Username and/or password is incorrect.') - + # Log auth failures while throttle is inactive logger.log_sec('Authentication Failure: %s (IP: %s).' % (username, ip)) - + # Update throttle if ip: LOGIN_THROTTLE.update(ip, 'Too many authentication failures.') - + # Try to call post-failure hook session = kwargs.get('session', None) if session: @@ -486,49 +486,49 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): account.at_failed_login(session) return None, errors - + # Account successfully authenticated logger.log_sec('Authentication Success: %s (IP: %s).' % (account, ip)) return account, errors - + @classmethod def normalize_username(cls, username): """ - Django: Applies NFKC Unicode normalization to usernames so that visually - identical characters with different Unicode code points are considered + Django: Applies NFKC Unicode normalization to usernames so that visually + identical characters with different Unicode code points are considered identical. - + (This deals with the Turkish "i" problem and similar - annoyances. Only relevant if you go out of your way to allow Unicode + annoyances. Only relevant if you go out of your way to allow Unicode usernames though-- Evennia accepts ASCII by default.) - + In this case we're simply piggybacking on this feature to apply additional normalization per Evennia's standards. """ username = super(DefaultAccount, cls).normalize_username(username) - + # strip excessive spaces in accountname username = re.sub(r"\s+", " ", username).strip() - + return username - + @classmethod def validate_username(cls, username): """ Checks the given username against the username validator associated with Account objects, and also checks the database to make sure it is unique. - + Args: username (str): Username to validate - + Returns: valid (bool): Whether or not the password passed validation errors (list): Error messages of any failures - + """ valid = [] errors = [] - + # Make sure we're at least using the default validator validators = cls.get_username_validators() if not validators: @@ -541,14 +541,14 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): except ValidationError as e: valid.append(False) errors.extend(e.messages) - + # Disqualify if any check failed if False in valid: valid = False else: valid = True - + return valid, errors - + @classmethod def validate_password(cls, password, account=None): """ @@ -608,48 +608,48 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): super(DefaultAccount, self).set_password(password) logger.log_sec("Password successfully changed for %s." % self) self.at_password_change() - + @classmethod def create(cls, *args, **kwargs): """ - Creates an Account (or Account/Character pair for MULTISESSION_MODE<2) - with default (or overridden) permissions and having joined them to the + Creates an Account (or Account/Character pair for MULTISESSION_MODE<2) + with default (or overridden) permissions and having joined them to the appropriate default channels. - + Kwargs: username (str): Username of Account owner password (str): Password of Account owner email (str, optional): Email address of Account owner ip (str, optional): IP address of requesting connection guest (bool, optional): Whether or not this is to be a Guest account - + permissions (str, optional): Default permissions for the Account typeclass (str, optional): Typeclass to use for new Account character_typeclass (str, optional): Typeclass to use for new char when applicable. - + Returns: account (Account): Account if successfully created; None if not errors (list): List of error messages in string form - + """ - + account = None errors = [] - + username = kwargs.get('username') password = kwargs.get('password') email = kwargs.get('email', '').strip() guest = kwargs.get('guest', False) - + permissions = kwargs.get('permissions', settings.PERMISSION_ACCOUNT_DEFAULT) typeclass = kwargs.get('typeclass', settings.BASE_ACCOUNT_TYPECLASS) - + ip = kwargs.get('ip', '') if ip and CREATION_THROTTLE.check(ip): errors.append("You are creating too many accounts. Please log into an existing account.") return None, errors - + # Normalize username username = cls.normalize_username(username) @@ -678,50 +678,50 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): "\nIf you feel this ban is in error, please email an admin.|x" errors.append(string) return None, errors - + # everything's ok. Create the new account account. try: try: account = create.create_account(username, email, password, permissions=permissions, typeclass=typeclass) logger.log_sec('Account Created: %s (IP: %s).' % (account, ip)) - + except Exception as e: errors.append("There was an error creating the Account. If this problem persists, contact an admin.") logger.log_trace() return None, errors - + # This needs to be set so the engine knows this account is # logging in for the first time. (so it knows to call the right # hooks during login later) account.db.FIRST_LOGIN = True - + # Record IP address of creation, if available if ip: account.db.creator_ip = ip - + # join the new account to the public channel pchannel = ChannelDB.objects.get_channel(settings.DEFAULT_CHANNELS[0]["key"]) if not pchannel or not pchannel.connect(account): string = "New account '%s' could not connect to public channel!" % account.key errors.append(string) logger.log_err(string) - + if account and settings.MULTISESSION_MODE < 2: # Load the appropriate Character class character_typeclass = kwargs.get('character_typeclass', settings.BASE_CHARACTER_TYPECLASS) character_home = kwargs.get('home') Character = class_from_module(character_typeclass) - + # Create the character character, errs = Character.create( - account.key, account, ip=ip, typeclass=character_typeclass, + account.key, account, ip=ip, typeclass=character_typeclass, permissions=permissions, home=character_home ) errors.extend(errs) - + if character: # Update playable character list account.db._playable_characters.append(character) - + # We need to set this to have @ic auto-connect to this character account.db._last_puppet = character @@ -731,7 +731,7 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): # we won't see any errors at all. errors.append("An error occurred. Please e-mail an admin if the problem persists.") logger.log_trace() - + # Update the throttle to indicate a new account was created from this IP if ip and not guest: CREATION_THROTTLE.update(ip, 'Too many accounts being created.') return account, errors @@ -1384,7 +1384,7 @@ class DefaultGuest(DefaultAccount): This class is used for guest logins. Unlike Accounts, Guests and their characters are deleted after disconnection. """ - + @classmethod def create(cls, **kwargs): """ @@ -1392,31 +1392,31 @@ class DefaultGuest(DefaultAccount): if one is available for use. """ return cls.authenticate(**kwargs) - + @classmethod def authenticate(cls, **kwargs): """ Gets or creates a Guest account object. - + Kwargs: ip (str, optional): IP address of requestor; used for ban checking, throttling and logging - + Returns: account (Object): Guest account object, if available errors (list): List of error messages accrued during this request. - + """ errors = [] account = None username = None ip = kwargs.get('ip', '').strip() - + # check if guests are enabled. if not settings.GUEST_ENABLED: errors.append('Guest accounts are not enabled on this server.') return None, errors - + try: # Find an available guest name. for name in settings.GUEST_LIST: @@ -1433,20 +1433,20 @@ class DefaultGuest(DefaultAccount): home = settings.GUEST_HOME permissions = settings.PERMISSION_GUEST_DEFAULT typeclass = settings.BASE_GUEST_TYPECLASS - + # Call parent class creator account, errs = super(DefaultGuest, cls).create( guest=True, - username=username, - password=password, - permissions=permissions, - typeclass=typeclass, + username=username, + password=password, + permissions=permissions, + typeclass=typeclass, home=home, ip=ip, ) errors.extend(errs) return account, errors - + except Exception as e: # We are in the middle between logged in and -not, so we have # to handle tracebacks ourselves at this point. If we don't, @@ -1454,7 +1454,7 @@ class DefaultGuest(DefaultAccount): errors.append("An error occurred. Please e-mail an admin if the problem persists.") logger.log_trace() return None, errors - + return account, errors def at_post_login(self, session=None, **kwargs): diff --git a/evennia/accounts/tests.py b/evennia/accounts/tests.py index 5e8e58cf9f..1d31e93e2c 100644 --- a/evennia/accounts/tests.py +++ b/evennia/accounts/tests.py @@ -7,10 +7,8 @@ from unittest import TestCase from django.test import override_settings from evennia.accounts.accounts import AccountSessionHandler from evennia.accounts.accounts import DefaultAccount, DefaultGuest -from evennia.server.session import Session from evennia.utils.test_resources import EvenniaTest from evennia.utils import create -from evennia.utils.test_resources import EvenniaTest from django.conf import settings @@ -61,78 +59,78 @@ class TestAccountSessionHandler(TestCase): def test_count(self): "Check count method" self.assertEqual(self.handler.count(), len(self.handler.get())) - + class TestDefaultGuest(EvenniaTest): "Check DefaultGuest class" - + ip = '212.216.134.22' - + def test_authenticate(self): # Guest account should not be permitted account, errors = DefaultGuest.authenticate(ip=self.ip) self.assertFalse(account, 'Guest account was created despite being disabled.') - + settings.GUEST_ENABLED = True settings.GUEST_LIST = ['bruce_wayne'] - + # Create a guest account account, errors = DefaultGuest.authenticate(ip=self.ip) self.assertTrue(account, 'Guest account should have been created.') - + # Create a second guest account account, errors = DefaultGuest.authenticate(ip=self.ip) self.assertFalse(account, 'Two guest accounts were created with a single entry on the guest list!') - + settings.GUEST_ENABLED = False - + class TestDefaultAccountAuth(EvenniaTest): - + def setUp(self): super(TestDefaultAccountAuth, self).setUp() - + self.password = "testpassword" self.account.delete() self.account = create.create_account("TestAccount%s" % randint(100000, 999999), email="test@test.com", password=self.password, typeclass=DefaultAccount) - + def test_authentication(self): "Confirm Account authentication method is authenticating/denying users." # Valid credentials obj, errors = DefaultAccount.authenticate(self.account.name, self.password) self.assertTrue(obj, 'Account did not authenticate given valid credentials.') - + # Invalid credentials obj, errors = DefaultAccount.authenticate(self.account.name, 'xyzzy') self.assertFalse(obj, 'Account authenticated using invalid credentials.') - + def test_create(self): "Confirm Account creation is working as expected." # Create a normal account account, errors = DefaultAccount.create(username='ziggy', password='stardust11') self.assertTrue(account, 'New account should have been created.') - + # Try creating a duplicate account account2, errors = DefaultAccount.create(username='Ziggy', password='starman11') self.assertFalse(account2, 'Duplicate account name should not have been allowed.') account.delete() - + def test_throttle(self): "Confirm throttle activates on too many failures." for x in xrange(20): obj, errors = DefaultAccount.authenticate(self.account.name, 'xyzzy', ip='12.24.36.48') self.assertFalse(obj, 'Authentication was provided a bogus password; this should NOT have returned an account!') - + self.assertTrue('too many login failures' in errors[-1].lower(), 'Failed logins should have been throttled.') - + def test_username_validation(self): "Check username validators deny relevant usernames" # Should not accept Unicode by default, lest users pick names like this result, error = DefaultAccount.validate_username('¯\_(ツ)_/¯') self.assertFalse(result, "Validator allowed kanji in username.") - + # Should not allow duplicate username result, error = DefaultAccount.validate_username(self.account.name) self.assertFalse(result, "Duplicate username should not have passed validation.") - + # Should not allow username too short result, error = DefaultAccount.validate_username('xx') self.assertFalse(result, "2-character username passed validation.") @@ -277,17 +275,17 @@ class TestDefaultAccount(TestCase): class TestAccountPuppetDeletion(EvenniaTest): - + @override_settings(MULTISESSION_MODE=2) def test_puppet_deletion(self): # Check for existing chars self.assertFalse(self.account.db._playable_characters, 'Account should not have any chars by default.') - + # Add char1 to account's playable characters self.account.db._playable_characters.append(self.char1) self.assertTrue(self.account.db._playable_characters, 'Char was not added to account.') - + # See what happens when we delete char1. self.char1.delete() # Playable char list should be empty. - self.assertFalse(self.account.db._playable_characters, 'Playable character list is not empty! %s' % self.account.db._playable_characters) \ No newline at end of file + self.assertFalse(self.account.db._playable_characters, 'Playable character list is not empty! %s' % self.account.db._playable_characters) diff --git a/evennia/commands/default/unloggedin.py b/evennia/commands/default/unloggedin.py index 7ff2c9a29a..607c95439b 100644 --- a/evennia/commands/default/unloggedin.py +++ b/evennia/commands/default/unloggedin.py @@ -2,17 +2,11 @@ Commands that are available from the connect screen. """ import re -import time import datetime from django.conf import settings -from django.contrib.auth import authenticate -from evennia.accounts.models import AccountDB -from evennia.objects.models import ObjectDB from evennia.comms.models import ChannelDB -from evennia.server.models import ServerConfig from evennia.server.sessionhandler import SESSIONS -from evennia.server.throttle import Throttle from evennia.utils import class_from_module, create, logger, utils, gametime from evennia.commands.cmdhandler import CMD_LOGINSTART @@ -26,6 +20,7 @@ __all__ = ("CmdUnconnectedConnect", "CmdUnconnectedCreate", MULTISESSION_MODE = settings.MULTISESSION_MODE CONNECTION_SCREEN_MODULE = settings.CONNECTION_SCREEN_MODULE + def create_guest_account(session): """ Creates a guest account/character for this session, if one is available. @@ -40,10 +35,10 @@ def create_guest_account(session): """ enabled = settings.GUEST_ENABLED address = session.address - + # Get account class Guest = class_from_module(settings.BASE_GUEST_TYPECLASS) - + # Get an available guest account # authenticate() handles its own throttling account, errors = Guest.authenticate(ip=address) @@ -53,6 +48,7 @@ def create_guest_account(session): session.msg("|R%s|n" % '\n'.join(errors)) return enabled, None + def create_normal_account(session, name, password): """ Creates an account with the given name and password. @@ -67,9 +63,9 @@ def create_normal_account(session, name, password): """ # Get account class Account = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) - + address = session.address - + # Match account name and check password # authenticate() handles all its own throttling account, errors = Account.authenticate(username=name, password=password, ip=address, session=session) @@ -108,19 +104,19 @@ class CmdUnconnectedConnect(COMMAND_DEFAULT_CLASS): """ session = self.caller address = session.address - + args = self.args # extract double quote parts parts = [part.strip() for part in re.split(r"\"", args) if part.strip()] if len(parts) == 1: # this was (hopefully) due to no double quotes being found, or a guest login parts = parts[0].split(None, 1) - + # Guest login if len(parts) == 1 and parts[0].lower() == "guest": # Get Guest typeclass Guest = class_from_module(settings.BASE_GUEST_TYPECLASS) - + account, errors = Guest.authenticate(ip=address) if account: session.sessionhandler.login(session, account) @@ -128,14 +124,14 @@ class CmdUnconnectedConnect(COMMAND_DEFAULT_CLASS): else: session.msg("|R%s|n" % '\n'.join(errors)) return - + if len(parts) != 2: session.msg("\n\r Usage (without <>): connect ") return # Get account class Account = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) - + name, password = parts account, errors = Account.authenticate(username=name, password=password, ip=address, session=session) if account: @@ -168,7 +164,7 @@ class CmdUnconnectedCreate(COMMAND_DEFAULT_CLASS): args = self.args.strip() address = session.address - + # Get account class Account = class_from_module(settings.BASE_ACCOUNT_TYPECLASS) @@ -182,7 +178,7 @@ class CmdUnconnectedCreate(COMMAND_DEFAULT_CLASS): "\nIf or contains spaces, enclose it in double quotes." session.msg(string) return - + username, password = parts # everything's ok. Create the new account account. diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index b829ab7165..f41dd02d02 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -195,7 +195,7 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): # lockstring of newly created objects, for easy overloading. # Will be formatted with the appropriate attributes. lockstring = "control:id({account_id}) or perm(Admin);delete:id({account_id}) or perm(Admin)" - + objects = ObjectManager() # on-object properties @@ -863,66 +863,66 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)): string = "This place should not exist ... contact an admin." obj.msg(_(string)) obj.move_to(home) - + @classmethod def create(cls, key, account=None, **kwargs): """ Creates a basic object with default parameters, unless otherwise specified or extended. - + Provides a friendlier interface to the utils.create_object() function. - + Args: key (str): Name of the new object. account (Account): Account to attribute this object to. - + Kwargs: description (str): Brief description for this object. ip (str): IP address of creator (for object auditing). - + Returns: object (Object): A newly created object of the given typeclass. errors (list): A list of errors in string form, if any. - + """ errors = [] obj = None - + # Get IP address of creator, if available ip = kwargs.pop('ip', '') - + # If no typeclass supplied, use this class kwargs['typeclass'] = kwargs.pop('typeclass', cls) - + # Set the supplied key as the name of the intended object kwargs['key'] = key - + # Get a supplied description, if any description = kwargs.pop('description', '') - + # Create a sane lockstring if one wasn't supplied lockstring = kwargs.get('locks') if account and not lockstring: lockstring = cls.lockstring.format(account_id=account.id) kwargs['locks'] = lockstring - + # Create object try: obj = create.create_object(**kwargs) - + # Record creator id and creation IP if ip: obj.db.creator_ip = ip if account: obj.db.creator_id = account.id - + # Set description if there is none, or update it if provided if description or not obj.db.desc: desc = description if description else "You see nothing special." obj.db.desc = desc - + except Exception as e: errors.append("An error occurred while creating this '%s' object." % key) logger.log_err(e) - + return obj, errors def copy(self, new_key=None): @@ -1895,81 +1895,81 @@ class DefaultCharacter(DefaultObject): # lockstring of newly created rooms, for easy overloading. # Will be formatted with the appropriate attributes. lockstring = "puppet:id({character_id}) or pid({account_id}) or perm(Developer) or pperm(Developer)" - + @classmethod def create(cls, key, account, **kwargs): """ Creates a basic Character with default parameters, unless otherwise specified or extended. - + Provides a friendlier interface to the utils.create_character() function. - + Args: key (str): Name of the new Character. account (obj): Account to associate this Character with. Required as an argument, but one can fake it out by supplying None-- it will change the default lockset and skip creator attribution. - + Kwargs: description (str): Brief description for this object. ip (str): IP address of creator (for object auditing). - + Returns: character (Object): A newly created Character of the given typeclass. errors (list): A list of errors in string form, if any. - + """ errors = [] obj = None - + # Get IP address of creator, if available ip = kwargs.pop('ip', '') - + # If no typeclass supplied, use this class kwargs['typeclass'] = kwargs.pop('typeclass', cls) - + # Set the supplied key as the name of the intended object kwargs['key'] = key - + # Get home for character kwargs['home'] = ObjectDB.objects.get_id(kwargs.get('home', settings.DEFAULT_HOME)) - + # Get permissions kwargs['permissions'] = kwargs.get('permissions', settings.PERMISSION_ACCOUNT_DEFAULT) - + # Get description if provided description = kwargs.pop('description', '') - + # Get locks if provided locks = kwargs.pop('locks', '') - + try: # Create the Character obj = create.create_object(**kwargs) - + # Record creator id and creation IP if ip: obj.db.creator_ip = ip if account: obj.db.creator_id = account.id - + # Add locks if not locks and account: # Allow only the character itself and the creator account to puppet this character (and Developers). locks = cls.lockstring.format(**{'character_id': obj.id, 'account_id': account.id}) elif not locks and not account: locks = cls.lockstring.format(**{'character_id': obj.id, 'account_id': -1}) - + obj.locks.add(locks) # If no description is set, set a default description if description or not obj.db.desc: obj.db.desc = description if description else "This is a character." - + except Exception as e: errors.append("An error occurred while creating this '%s' object." % key) logger.log_err(e) - + return obj, errors - + def basetype_setup(self): """ Setup character-specific security. @@ -2097,60 +2097,60 @@ class DefaultRoom(DefaultObject): """ Creates a basic Room with default parameters, unless otherwise specified or extended. - + Provides a friendlier interface to the utils.create_object() function. - + Args: key (str): Name of the new Room. account (obj): Account to associate this Room with. - + Kwargs: description (str): Brief description for this object. ip (str): IP address of creator (for object auditing). - + Returns: room (Object): A newly created Room of the given typeclass. errors (list): A list of errors in string form, if any. - + """ errors = [] obj = None - + # Get IP address of creator, if available ip = kwargs.pop('ip', '') - + # If no typeclass supplied, use this class kwargs['typeclass'] = kwargs.pop('typeclass', cls) - + # Set the supplied key as the name of the intended object kwargs['key'] = key - + # Get who to send errors to kwargs['report_to'] = kwargs.pop('report_to', account) - + # Get description, if provided description = kwargs.pop('description', '') - + try: # Create the Room obj = create.create_object(**kwargs) - + # Set appropriate locks lockstring = kwargs.get('locks', cls.lockstring.format(id=account.id)) obj.locks.add(lockstring) - + # Record creator id and creation IP if ip: obj.db.creator_ip = ip if account: obj.db.creator_id = account.id - + # If no description is set, set a default description if description or not obj.db.desc: obj.db.desc = description if description else "This is a room." - + except Exception as e: errors.append("An error occurred while creating this '%s' object." % key) logger.log_err(e) - + return obj, errors def basetype_setup(self): @@ -2230,13 +2230,13 @@ class DefaultExit(DefaultObject): exit_command = ExitCommand priority = 101 - + # lockstring of newly created exits, for easy overloading. # Will be formatted with the {id} of the creating object. lockstring = "control:id({id}) or perm(Admin); " \ "delete:id({id}) or perm(Admin); " \ "edit:id({id}) or perm(Admin)" - + # Helper classes and methods to implement the Exit. These need not # be overloaded unless one want to change the foundation for how # Exits work. See the end of the class for hook methods to overload. @@ -2274,72 +2274,72 @@ class DefaultExit(DefaultObject): return exit_cmdset # Command hooks - + @classmethod def create(cls, key, account, source, dest, **kwargs): """ Creates a basic Exit with default parameters, unless otherwise specified or extended. - + Provides a friendlier interface to the utils.create_object() function. - + Args: key (str): Name of the new Exit, as it should appear from the source room. account (obj): Account to associate this Exit with. source (Room): The room to create this exit in. dest (Room): The room to which this exit should go. - + Kwargs: description (str): Brief description for this object. ip (str): IP address of creator (for object auditing). - + Returns: exit (Object): A newly created Room of the given typeclass. errors (list): A list of errors in string form, if any. - + """ errors = [] obj = None - + # Get IP address of creator, if available ip = kwargs.pop('ip', '') - + # If no typeclass supplied, use this class kwargs['typeclass'] = kwargs.pop('typeclass', cls) - + # Set the supplied key as the name of the intended object kwargs['key'] = key - + # Get who to send errors to kwargs['report_to'] = kwargs.pop('report_to', account) - + # Set to/from rooms kwargs['location'] = source kwargs['destination'] = dest - + description = kwargs.pop('description', '') - + try: # Create the Exit obj = create.create_object(**kwargs) - + # Set appropriate locks lockstring = kwargs.get('locks', cls.lockstring.format(id=account.id)) obj.locks.add(lockstring) - + # Record creator id and creation IP if ip: obj.db.creator_ip = ip if account: obj.db.creator_id = account.id - + # If no description is set, set a default description if description or not obj.db.desc: obj.db.desc = description if description else "This is an exit." - + except Exception as e: errors.append("An error occurred while creating this '%s' object." % key) logger.log_err(e) - + return obj, errors def basetype_setup(self): diff --git a/evennia/objects/tests.py b/evennia/objects/tests.py index cb999bc616..6bfe34248f 100644 --- a/evennia/objects/tests.py +++ b/evennia/objects/tests.py @@ -1,10 +1,11 @@ from evennia.utils.test_resources import EvenniaTest from evennia import DefaultObject, DefaultCharacter, DefaultRoom, DefaultExit + class DefaultObjectTest(EvenniaTest): - + ip = '212.216.139.14' - + def test_object_create(self): description = 'A home for a grouch.' obj, errors = DefaultObject.create('trashcan', self.account, description=description, ip=self.ip) @@ -12,7 +13,7 @@ class DefaultObjectTest(EvenniaTest): self.assertFalse(errors, errors) self.assertEqual(description, obj.db.desc) self.assertEqual(obj.db.creator_ip, self.ip) - + def test_character_create(self): description = 'A furry green monster, reeking of garbage.' obj, errors = DefaultCharacter.create('oscar', self.account, description=description, ip=self.ip) @@ -20,7 +21,7 @@ class DefaultObjectTest(EvenniaTest): self.assertFalse(errors, errors) self.assertEqual(description, obj.db.desc) self.assertEqual(obj.db.creator_ip, self.ip) - + def test_room_create(self): description = 'A dimly-lit alley behind the local Chinese restaurant.' obj, errors = DefaultRoom.create('alley', self.account, description=description, ip=self.ip) @@ -28,7 +29,7 @@ class DefaultObjectTest(EvenniaTest): self.assertFalse(errors, errors) self.assertEqual(description, obj.db.desc) self.assertEqual(obj.db.creator_ip, self.ip) - + def test_exit_create(self): description = 'The steaming depths of the dumpster, ripe with refuse in various states of decomposition.' obj, errors = DefaultExit.create('in', self.account, self.room1, self.room2, description=description, ip=self.ip) @@ -43,4 +44,4 @@ class DefaultObjectTest(EvenniaTest): self.assertTrue('admin' in self.char1.web_get_admin_url()) self.assertTrue(self.room1.get_absolute_url()) - self.assertTrue('admin' in self.room1.web_get_admin_url()) \ No newline at end of file + self.assertTrue('admin' in self.room1.web_get_admin_url()) diff --git a/evennia/scripts/scripts.py b/evennia/scripts/scripts.py index ba6f7edff2..e611ede0e2 100644 --- a/evennia/scripts/scripts.py +++ b/evennia/scripts/scripts.py @@ -323,31 +323,31 @@ class DefaultScript(ScriptBase): or describe a state that changes under certain conditions. """ - + @classmethod def create(cls, key, **kwargs): """ Provides a passthrough interface to the utils.create_script() function. - + Args: key (str): Name of the new object. - + Returns: object (Object): A newly created object of the given typeclass. errors (list): A list of errors in string form, if any. - + """ errors = [] obj = None - + kwargs['key'] = key - + try: obj = create.create_script(**kwargs) except Exception as e: errors.append("The script '%s' encountered errors and could not be created." % key) logger.log_err(e) - + return obj, errors def at_script_creation(self): diff --git a/evennia/server/throttle.py b/evennia/server/throttle.py index 944b7f880e..a1e6092844 100644 --- a/evennia/server/throttle.py +++ b/evennia/server/throttle.py @@ -2,25 +2,26 @@ from collections import defaultdict, deque from evennia.utils import logger import time + class Throttle(object): """ - Keeps a running count of failed actions per IP address. - + Keeps a running count of failed actions per IP address. + Available methods indicate whether or not the number of failures exceeds a particular threshold. - + This version of the throttle is usable by both the terminal server as well as the web server, imposes limits on memory consumption by using deques with length limits instead of open-ended lists, and removes sparse keys when no recent failures have been recorded. """ - + error_msg = 'Too many failed attempts; you must wait a few minutes before trying again.' - + def __init__(self, **kwargs): """ Allows setting of throttle parameters. - + Kwargs: limit (int): Max number of failures before imposing limiter timeout (int): number of timeout seconds after @@ -32,67 +33,67 @@ class Throttle(object): self.storage = defaultdict(deque) self.cache_size = self.limit = kwargs.get('limit', 5) self.timeout = kwargs.get('timeout', 5 * 60) - + def get(self, ip=None): """ Convenience function that returns the storage table, or part of. - + Args: ip (str, optional): IP address of requestor - + Returns: - storage (dict): When no IP is provided, returns a dict of all - current IPs being tracked and the timestamps of their recent + storage (dict): When no IP is provided, returns a dict of all + current IPs being tracked and the timestamps of their recent failures. - timestamps (deque): When an IP is provided, returns a deque of + timestamps (deque): When an IP is provided, returns a deque of timestamps of recent failures only for that IP. - + """ if ip: return self.storage.get(ip, deque(maxlen=self.cache_size)) else: return self.storage - + def update(self, ip, failmsg='Exceeded threshold.'): """ Store the time of the latest failure. - + Args: ip (str): IP address of requestor failmsg (str, optional): Message to display in logs upon activation of throttle. - + Returns: None - + """ # Get current status previously_throttled = self.check(ip) - + # Enforce length limits if not self.storage[ip].maxlen: self.storage[ip] = deque(maxlen=self.cache_size) - + self.storage[ip].append(time.time()) - + # See if this update caused a change in status currently_throttled = self.check(ip) - + # If this makes it engage, log a single activation event if (not previously_throttled and currently_throttled): logger.log_sec('Throttle Activated: %s (IP: %s, %i hits in %i seconds.)' % (failmsg, ip, self.limit, self.timeout)) - + def check(self, ip): """ This will check the session's address against the - storage dictionary to check they haven't spammed too many + storage dictionary to check they haven't spammed too many fails recently. - + Args: ip (str): IP address of requestor - + Returns: throttled (bool): True if throttling is active, False otherwise. - + """ now = time.time() ip = str(ip) @@ -110,5 +111,3 @@ class Throttle(object): return False else: return False - - \ No newline at end of file diff --git a/evennia/server/validators.py b/evennia/server/validators.py index fdadeda6e3..faa1aa68c8 100644 --- a/evennia/server/validators.py +++ b/evennia/server/validators.py @@ -4,31 +4,32 @@ from django.utils.translation import gettext as _ from evennia.accounts.models import AccountDB import re + class EvenniaUsernameAvailabilityValidator: """ Checks to make sure a given username is not taken or otherwise reserved. """ - + def __call__(self, username): """ Validates a username to make sure it is not in use or reserved. - + Args: username (str): Username to validate - + Returns: None (None): None if password successfully validated, raises ValidationError otherwise. - + """ - + # Check guest list if (settings.GUEST_LIST and username.lower() in (guest.lower() for guest in settings.GUEST_LIST)): raise ValidationError( _('Sorry, that username is reserved.'), code='evennia_username_reserved', ) - + # Check database exists = AccountDB.objects.filter(username__iexact=username).exists() if exists: @@ -37,33 +38,36 @@ class EvenniaUsernameAvailabilityValidator: code='evennia_username_taken', ) + class EvenniaPasswordValidator: - - def __init__(self, regex=r"^[\w. @+\-',]+$", policy="Password should contain a mix of letters, spaces, digits and @/./+/-/_/'/, only."): + + def __init__(self, regex=r"^[\w. @+\-',]+$", + policy="Password should contain a mix of letters, " + "spaces, digits and @/./+/-/_/'/, only."): """ Constructs a standard Django password validator. - + Args: regex (str): Regex pattern of valid characters to allow. policy (str): Brief explanation of what the defined regex permits. - + """ self.regex = regex self.policy = policy - + def validate(self, password, user=None): """ Validates a password string to make sure it meets predefined Evennia acceptable character policy. - + Args: password (str): Password to validate user (None): Unused argument but required by Django - + Returns: None (None): None if password successfully validated, raises ValidationError otherwise. - + """ # Check complexity if not re.findall(self.regex, password): @@ -76,11 +80,12 @@ class EvenniaPasswordValidator: """ Returns a user-facing explanation of the password policy defined by this validator. - + Returns: text (str): Explanation of password policy. - + """ return _( - "%s From a terminal client, you can also use a phrase of multiple words if you enclose the password in double quotes." % self.policy - ) \ No newline at end of file + "%s From a terminal client, you can also use a phrase of multiple words if " + "you enclose the password in double quotes." % self.policy + ) diff --git a/evennia/settings_default.py b/evennia/settings_default.py index 7926ed276c..40c36e6f7e 100644 --- a/evennia/settings_default.py +++ b/evennia/settings_default.py @@ -222,7 +222,8 @@ COMMAND_RATE_WARNING = "You entered commands too fast. Wait a moment and try aga # 0 or less. MAX_CHAR_LIMIT = 6000 # The warning to echo back to users if they enter a very large string -MAX_CHAR_LIMIT_WARNING = "You entered a string that was too long. Please break it up into multiple parts." +MAX_CHAR_LIMIT_WARNING = ("You entered a string that was too long. " + "Please break it up into multiple parts.") # If this is true, errors and tracebacks from the engine will be # echoed as text in-game as well as to the log. This can speed up # debugging. OBS: Showing full tracebacks to regular users could be a @@ -410,12 +411,14 @@ CMDSET_CHARACTER = "commands.default_cmdsets.CharacterCmdSet" CMDSET_ACCOUNT = "commands.default_cmdsets.AccountCmdSet" # Location to search for cmdsets if full path not given CMDSET_PATHS = ["commands", "evennia", "contribs"] -# Fallbacks for cmdset paths that fail to load. Note that if you change the path for your default cmdsets, -# you will also need to copy CMDSET_FALLBACKS after your change in your settings file for it to detect the change. -CMDSET_FALLBACKS = {CMDSET_CHARACTER: 'evennia.commands.default.cmdset_character.CharacterCmdSet', - CMDSET_ACCOUNT: 'evennia.commands.default.cmdset_account.AccountCmdSet', - CMDSET_SESSION: 'evennia.commands.default.cmdset_session.SessionCmdSet', - CMDSET_UNLOGGEDIN: 'evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet'} +# Fallbacks for cmdset paths that fail to load. Note that if you change the path for your +# default cmdsets, you will also need to copy CMDSET_FALLBACKS after your change in your +# settings file for it to detect the change. +CMDSET_FALLBACKS = { + CMDSET_CHARACTER: 'evennia.commands.default.cmdset_character.CharacterCmdSet', + CMDSET_ACCOUNT: 'evennia.commands.default.cmdset_account.AccountCmdSet', + CMDSET_SESSION: 'evennia.commands.default.cmdset_session.SessionCmdSet', + CMDSET_UNLOGGEDIN: 'evennia.commands.default.cmdset_unloggedin.UnloggedinCmdSet'} # Parent class for all default commands. Changing this class will # modify all default commands, so do so carefully. COMMAND_DEFAULT_CLASS = "evennia.commands.default.muxcommand.MuxCommand" @@ -810,7 +813,7 @@ AUTH_PASSWORD_VALIDATORS = [ {'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator'}, {'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator'}, {'NAME': 'evennia.server.validators.EvenniaPasswordValidator'}] - + # Username validation plugins AUTH_USERNAME_VALIDATORS = [ {'NAME': 'django.contrib.auth.validators.ASCIIUsernameValidator'}, @@ -830,7 +833,7 @@ TEST_RUNNER = 'evennia.server.tests.EvenniaTestSuiteRunner' # Django extesions are useful third-party tools that are not # always included in the default django distro. try: - import django_extensions + import django_extensions # noqa INSTALLED_APPS = INSTALLED_APPS + ('django_extensions',) except ImportError: # Django extensions are not installed in all distros. From ed66563bdc01835cf46317af1928640fce2d3fe4 Mon Sep 17 00:00:00 2001 From: Griatch Date: Tue, 23 Oct 2018 15:17:59 +0200 Subject: [PATCH 093/187] Fix lagging pillow requirement for Windows. Resolves #1702. --- win_requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/win_requirements.txt b/win_requirements.txt index 5e23f6fe67..02984ec6ca 100644 --- a/win_requirements.txt +++ b/win_requirements.txt @@ -5,7 +5,7 @@ pypiwin32 django > 1.11, < 2.0 twisted >= 18.0.0, < 19.0.0 -pillow == 2.9.0 +pillow == 5.2.0 pytz future >= 0.15.2 django-sekizai From 89d6cb3db30b3ffc2256a791fa83afe44a37b60c Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 23 Oct 2018 23:42:00 +0000 Subject: [PATCH 094/187] Adds unit tests for views. --- evennia/web/website/tests.py | 167 +++++++++++++++++++++++++++++++++++ 1 file changed, 167 insertions(+) create mode 100644 evennia/web/website/tests.py diff --git a/evennia/web/website/tests.py b/evennia/web/website/tests.py new file mode 100644 index 0000000000..26a81c0ea6 --- /dev/null +++ b/evennia/web/website/tests.py @@ -0,0 +1,167 @@ +from django.conf import settings +from django.utils.text import slugify +from django.test import Client +from django.urls import reverse +from evennia.utils.test_resources import EvenniaTest + +class EvenniaWebTest(EvenniaTest): + + # Use the same classes the views are expecting + account_typeclass = settings.BASE_ACCOUNT_TYPECLASS + object_typeclass = settings.BASE_OBJECT_TYPECLASS + character_typeclass = settings.BASE_CHARACTER_TYPECLASS + exit_typeclass = settings.BASE_EXIT_TYPECLASS + room_typeclass = settings.BASE_ROOM_TYPECLASS + script_typeclass = settings.BASE_SCRIPT_TYPECLASS + + # Default named url + url_name = 'index' + + # Response to expect for unauthenticated requests + unauthenticated_response = 200 + + # Response to expect for authenticated requests + authenticated_response = 200 + + def setUp(self): + super(EvenniaWebTest, self).setUp() + + # Add chars to account rosters + self.account.db._playable_characters = [self.char1] + self.account2.db._playable_characters = [self.char2] + + for account in (self.account, self.account2): + # Demote accounts to Player permissions + account.permissions.add('Player') + account.permissions.remove('Developer') + + # Grant permissions to chars + for char in account.db._playable_characters: + char.locks.add('edit:id(%s) or perm(Admin)' % account.pk) + char.locks.add('delete:id(%s) or perm(Admin)' % account.pk) + char.locks.add('view:all()') + + def test_valid_chars(self): + "Make sure account has playable characters" + self.assertTrue(self.char1 in self.account.db._playable_characters) + self.assertTrue(self.char2 in self.account2.db._playable_characters) + + def get_kwargs(self): + return {} + + def test_get(self): + # Try accessing page while not logged in + response = self.client.get(reverse(self.url_name, kwargs=self.get_kwargs())) + self.assertEqual(response.status_code, self.unauthenticated_response) + + def login(self): + return self.client.login(username='TestAccount', password='testpassword') + + def test_get_authenticated(self): + logged_in = self.login() + self.assertTrue(logged_in, 'Account failed to log in!') + + # Try accessing page while logged in + response = self.client.get(reverse(self.url_name, kwargs=self.get_kwargs()), follow=True) + + self.assertEqual(response.status_code, self.authenticated_response) + + +# ------------------------------------------------------------------------------ + +class AdminTest(EvenniaWebTest): + url_name = 'django_admin' + unauthenticated_response = 302 + +class IndexTest(EvenniaWebTest): + url_name = 'index' + +class RegisterTest(EvenniaWebTest): + url_name = 'register' + unauthenticated_response = 302 + +class LoginTest(EvenniaWebTest): + url_name = 'login' + +class LogoutTest(EvenniaWebTest): + url_name = 'logout' + +class PasswordResetTest(EvenniaWebTest): + url_name = 'password_change' + unauthenticated_response = 302 + +class WebclientTest(EvenniaWebTest): + url_name = 'webclient:index' + +class CharacterCreateView(EvenniaWebTest): + url_name = 'character-create' + unauthenticated_response = 302 + +class CharacterManageView(EvenniaWebTest): + url_name = 'character-manage' + unauthenticated_response = 302 + +class CharacterUpdateView(EvenniaWebTest): + url_name = 'character-update' + unauthenticated_response = 302 + + def get_kwargs(self): + return { + 'pk': self.char1.pk, + 'slug': slugify(self.char1.name) + } + + def test_valid_access(self): + "Account1 should be able to update Account1:Char1" + # Login account + self.login() + + # Try to access update page for char1 + response = self.client.get(reverse(self.url_name, kwargs=self.get_kwargs()), follow=True) + self.assertEqual(response.status_code, 200) + + def test_invalid_access(self): + "Account1 should not be able to update Account2:Char2" + # Login account + self.login() + + # Try to access update page for char2 + kwargs = { + 'pk': self.char2.pk, + 'slug': slugify(self.char2.name) + } + response = self.client.get(reverse(self.url_name, kwargs=kwargs), follow=True) + self.assertEqual(response.status_code, 403) + +class CharacterDeleteView(EvenniaWebTest): + url_name = 'character-delete' + unauthenticated_response = 302 + + def get_kwargs(self): + return { + 'pk': self.char1.pk, + 'slug': slugify(self.char1.name) + } + + def test_valid_access(self): + "Account1 should be able to delete Account1:Char1" + # Login account + self.login() + + # Try to access delete page for char1 + response = self.client.get(reverse(self.url_name, kwargs=self.get_kwargs()), follow=True) + self.assertEqual(response.status_code, 200) + + def test_invalid_access(self): + "Account1 should not be able to delete Account2:Char2" + # Login account + self.login() + + # Try to access delete page for char2 + kwargs = { + 'pk': self.char2.pk, + 'slug': slugify(self.char2.name) + } + response = self.client.get(reverse(self.url_name, kwargs=kwargs), follow=True) + self.assertEqual(response.status_code, 403) + \ No newline at end of file From 683c1f12f57f9718f4d60aa61d940f21b76c90f9 Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 23 Oct 2018 23:43:40 +0000 Subject: [PATCH 095/187] Adds permissions checks for views involving objects. --- evennia/web/website/views.py | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index f569830a62..09e2705fc0 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -13,7 +13,7 @@ from django.contrib.auth.mixins import LoginRequiredMixin from django.contrib.admin.views.decorators import staff_member_required from django.core.exceptions import PermissionDenied from django.db.models.functions import Lower -from django.http import HttpResponseRedirect, Http404 +from django.http import HttpResponseBadRequest, HttpResponseRedirect, Http404 from django.shortcuts import render from django.urls import reverse_lazy from django.views.generic import View, TemplateView, ListView, DetailView, FormView @@ -173,7 +173,8 @@ class EvenniaDeleteView(DeleteView): class ObjectDetailView(DetailView): - model = ObjectDB + model = class_from_module(settings.BASE_OBJECT_TYPECLASS) + access_type = 'view' def get_object(self, queryset=None): """ @@ -183,19 +184,35 @@ class ObjectDetailView(DetailView): calculate the same for the object and make sure it matches. """ - obj = super(ObjectDetailView, self).get_object(queryset) + if not queryset: + queryset = self.get_queryset() + + # Get the object, ignoring all checks and filters + obj = self.model.objects.get(pk=self.kwargs.get('pk')) + + # Check if this object was requested in a valid manner if slugify(obj.name) != self.kwargs.get(self.slug_url_kwarg): - raise Http404(u"No %(verbose_name)s found matching the query" % - {'verbose_name': queryset.model._meta.verbose_name}) + raise HttpResponseBadRequest(u"No %(verbose_name)s found matching the query" % + {'verbose_name': queryset.model._meta.verbose_name}) + + # Check if account has permissions to access object + account = self.request.user + if not obj.access(account, self.access_type): + raise PermissionDenied(u"You are not authorized to %s this object." % self.access_type) + + # Get the object, based on the specified queryset + obj = super(ObjectDetailView, self).get_object(queryset) + return obj class ObjectCreateView(LoginRequiredMixin, EvenniaCreateView): - model = ObjectDB + model = class_from_module(settings.BASE_OBJECT_TYPECLASS) class ObjectDeleteView(LoginRequiredMixin, ObjectDetailView, EvenniaDeleteView): - model = ObjectDB + model = class_from_module(settings.BASE_OBJECT_TYPECLASS) + access_type = 'delete' template_name = 'website/object_confirm_delete.html' def delete(self, request, *args, **kwargs): @@ -212,7 +229,8 @@ class ObjectDeleteView(LoginRequiredMixin, ObjectDetailView, EvenniaDeleteView): class ObjectUpdateView(LoginRequiredMixin, ObjectDetailView, EvenniaUpdateView): - model = ObjectDB + model = class_from_module(settings.BASE_OBJECT_TYPECLASS) + access_type = 'edit' def get_initial(self): """ From 3e35a1ce5a22490399251c0ab53b00bf452c9edc Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 00:02:26 +0000 Subject: [PATCH 096/187] Adds unit tests for char create and delete, fixes bugs. --- .../website/object_confirm_delete.html | 2 +- evennia/web/website/tests.py | 25 +++++++++++++++++++ evennia/web/website/views.py | 3 ++- 3 files changed, 28 insertions(+), 2 deletions(-) diff --git a/evennia/web/website/templates/website/object_confirm_delete.html b/evennia/web/website/templates/website/object_confirm_delete.html index e42fb57de6..1073b26d0c 100644 --- a/evennia/web/website/templates/website/object_confirm_delete.html +++ b/evennia/web/website/templates/website/object_confirm_delete.html @@ -20,7 +20,7 @@
    - +
    diff --git a/evennia/web/website/tests.py b/evennia/web/website/tests.py index 26a81c0ea6..a45ec2d17a 100644 --- a/evennia/web/website/tests.py +++ b/evennia/web/website/tests.py @@ -97,6 +97,23 @@ class CharacterCreateView(EvenniaWebTest): url_name = 'character-create' unauthenticated_response = 302 + def test_valid_access(self): + "Account1 should be able to create a new character" + # Login account + self.login() + + # Post data for a new character + data = { + 'db_key': 'gannon', + 'desc': 'Some dude.' + } + + response = self.client.post(reverse(self.url_name), data=data, follow=True) + self.assertEqual(response.status_code, 200) + + # Make sure the character was actually created + self.assertTrue(len(self.account.db._playable_characters) > 1, 'Account only has the following characters attributed to it: %s' % self.account.db._playable_characters) + class CharacterManageView(EvenniaWebTest): url_name = 'character-manage' unauthenticated_response = 302 @@ -152,6 +169,14 @@ class CharacterDeleteView(EvenniaWebTest): response = self.client.get(reverse(self.url_name, kwargs=self.get_kwargs()), follow=True) self.assertEqual(response.status_code, 200) + # Proceed with deleting it + data = {'value': 'yes'} + response = self.client.post(reverse(self.url_name, kwargs=self.get_kwargs()), data=data, follow=True) + self.assertEqual(response.status_code, 200) + + # Make sure it deleted + self.assertFalse(self.char1 in self.account.db._playable_characters, 'Char1 is still in Account playable characters list.') + def test_invalid_access(self): "Account1 should not be able to delete Account2:Char2" # Login account diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index 09e2705fc0..738c445061 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -345,11 +345,12 @@ class CharacterUpdateView(CharacterMixin, ObjectUpdateView): template_name = 'website/character_form.html' class CharacterDeleteView(CharacterMixin, ObjectDeleteView): - pass + success_url = reverse_lazy('character-manage') class CharacterCreateView(CharacterMixin, ObjectCreateView): template_name = 'website/character_form.html' + success_url = reverse_lazy('character-manage') def form_valid(self, form): # Get account ref From 7a22a4c0ecf1a31e7328c6f6adc1a249bc72d1db Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 00:52:57 +0000 Subject: [PATCH 097/187] Fixes web UI dropdown failure to refresh after character creation. --- evennia/accounts/accounts.py | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index f4711299cf..6a599f8d91 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -190,9 +190,18 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): def sessions(self): return AccountSessionHandler(self) - @lazy_property + # Do not make this a lazy property; the web UI will not refresh it! + @property def characters(self): - return self.db._playable_characters + # Get playable characters list + objs = self.db._playable_characters + + # Rebuild the list if legacy code left null values after deletion + if None in objs: + objs = [x for x in self.db._playable_characters if x] + self.db._playable_characters = objs + + return objs # session-related methods From a2230e7d17c231480d8c6e6c97f776380d6a1802 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 00:55:37 +0000 Subject: [PATCH 098/187] Housekeeping. --- evennia/web/utils/general_context.py | 8 ++++++++ evennia/web/website/templates/website/_menu.html | 4 ++-- evennia/web/website/views.py | 5 +++-- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/evennia/web/utils/general_context.py b/evennia/web/utils/general_context.py index 44bc8b3cb3..57b46bf59a 100644 --- a/evennia/web/utils/general_context.py +++ b/evennia/web/utils/general_context.py @@ -67,7 +67,15 @@ def general_context(request): Returns common Evennia-related context stuff, which is automatically added to context of all views. """ + account = None + if request.user.is_authenticated(): account = request.user + + puppet = None + if request.session.get('puppet'): puppet = request.session['puppet'] + return { + 'account': account, + 'puppet': puppet, 'game_name': GAME_NAME, 'game_slogan': GAME_SLOGAN, 'evennia_userapps': ACCOUNT_RELATED, diff --git a/evennia/web/website/templates/website/_menu.html b/evennia/web/website/templates/website/_menu.html index f75477ecae..e82db1ca58 100644 --- a/evennia/web/website/templates/website/_menu.html +++ b/evennia/web/website/templates/website/_menu.html @@ -39,14 +39,14 @@ folder and edit it to add/remove links to the menu. {% block navbar_right %} {% endblock %} {% block navbar_user %} - {% if user.is_authenticated %} + {% if account %}
  • Create Character Manage Characters
    - {% for character in user.characters|slice:"10" %} + {% for character in account.characters|slice:"10" %} {{ character }} {% empty %} No characters found! diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index 738c445061..f07e7f80f0 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -328,7 +328,7 @@ class CharacterMixin(object): def get_queryset(self): # Get IDs of characters owned by account - ids = [getattr(x, 'id') for x in self.request.user.db._playable_characters if x] + ids = [getattr(x, 'id') for x in self.request.user.characters if x] # Return a queryset consisting of those characters return self.model.objects.filter(id__in=ids).order_by(Lower('db_key')) @@ -337,7 +337,7 @@ class CharacterManageView(LoginRequiredMixin, CharacterMixin, ListView): paginate_by = 10 template_name = 'website/character_manage_list.html' - page_title = 'Manage: Characters' + page_title = 'Manage Characters' class CharacterUpdateView(CharacterMixin, ObjectUpdateView): @@ -390,6 +390,7 @@ class CharacterCreateView(CharacterMixin, ObjectCreateView): [setattr(character.db, key, value) for key,value in self.attributes.items()] character.db.creator_id = account.id character.save() + account.save() except Exception as e: messages.error(self.request, "There was an error creating your character. If this problem persists, contact an admin.") From 4bacab7b9555df34f27043e368bf6a2f63a23d84 Mon Sep 17 00:00:00 2001 From: Rachel Blackman Date: Wed, 24 Oct 2018 10:41:58 -0700 Subject: [PATCH 099/187] Add new --initmissing switch to prepare game images checked out of git --- evennia/server/evennia_launcher.py | 37 +++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/evennia/server/evennia_launcher.py b/evennia/server/evennia_launcher.py index ef6bf61055..50c355dc58 100644 --- a/evennia/server/evennia_launcher.py +++ b/evennia/server/evennia_launcher.py @@ -222,6 +222,19 @@ RECREATED_SETTINGS = \ their accounts with their old passwords. """ +ERROR_INITMISSING = \ + """ + ERROR: 'evennia --initmissing' must be called from the root of + your game directory, since it tries to create any missing files + in the server/ subfolder. + """ + +RECREATED_MISSING = \ + """ + (Re)created any missing directories or files. Evennia should + be ready to run now! + """ + ERROR_DATABASE = \ """ ERROR: Your database does not seem to be set up correctly. @@ -1331,7 +1344,10 @@ def create_settings_file(init=True, secret_settings=False): else: print("Reset the settings file.") - default_settings_path = os.path.join(EVENNIA_TEMPLATE, "server", "conf", "settings.py") + if secret_settings: + default_settings_path = os.path.join(EVENNIA_TEMPLATE, "server", "conf", "secret_settings.py") + else: + default_settings_path = os.path.join(EVENNIA_TEMPLATE, "server", "conf", "settings.py") shutil.copy(default_settings_path, settings_path) with open(settings_path, 'r') as f: @@ -1914,6 +1930,10 @@ def main(): '--initsettings', action='store_true', dest="initsettings", default=False, help="create a new, empty settings file as\n gamedir/server/conf/settings.py") + parser.add_argument( + '--initmissing', action='store_true', dest="initmissing", + default=False, + help="checks for missing secret_settings or server logs\n directory, and adds them if needed") parser.add_argument( '--profiler', action='store_true', dest='profiler', default=False, help="start given server component under the Python profiler") @@ -1987,6 +2007,21 @@ def main(): print(ERROR_INITSETTINGS) sys.exit() + if args.initmissing: + try: + log_path = os.path.join(SERVERDIR, "logs") + if not os.path.exists(log_path): + os.makedirs(log_path) + + settings_path = os.path.join(CONFDIR, "secret_settings.py") + if not os.path.exists(settings_path): + create_settings_file(init=False, secret_settings=True) + + print(RECREATED_MISSING) + except IOError: + print(ERROR_INITMISSING) + sys.exit() + if args.tail_log: # set up for tailing the log files global NO_REACTOR_STOP From ecfb86072dae983c44dea2f2725c60e5c4574f9c Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 18:57:48 +0000 Subject: [PATCH 100/187] Minor fixes to handle addition of created chars to account playable characters list, and check for multisession mode compliance. --- evennia/accounts/accounts.py | 3 ++- evennia/objects/objects.py | 12 ++++++++++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/evennia/accounts/accounts.py b/evennia/accounts/accounts.py index 86573f389c..2a8915a59c 100644 --- a/evennia/accounts/accounts.py +++ b/evennia/accounts/accounts.py @@ -733,7 +733,8 @@ class DefaultAccount(with_metaclass(TypeclassBase, AccountDB)): if character: # Update playable character list - account.db._playable_characters.append(character) + if character not in account.characters: + account.db._playable_characters.append(character) # We need to set this to have @ic auto-connect to this character account.db._last_puppet = character diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index f41dd02d02..0dca98ef75 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -1944,12 +1944,20 @@ class DefaultCharacter(DefaultObject): locks = kwargs.pop('locks', '') try: + # Check to make sure account does not have too many chars + if len(account.characters) >= settings.MAX_NR_CHARACTERS: + errors.append("There are too many characters associated with this account.") + return obj, errors + # Create the Character obj = create.create_object(**kwargs) # Record creator id and creation IP if ip: obj.db.creator_ip = ip - if account: obj.db.creator_id = account.id + if account: + obj.db.creator_id = account.id + if obj not in account.characters: + account.db._playable_characters.append(obj) # Add locks if not locks and account: @@ -1963,7 +1971,7 @@ class DefaultCharacter(DefaultObject): # If no description is set, set a default description if description or not obj.db.desc: obj.db.desc = description if description else "This is a character." - + except Exception as e: errors.append("An error occurred while creating this '%s' object." % key) logger.log_err(e) From 0541ccb5bc49635e42b08e0434c2659df1f9bfe9 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 18:59:56 +0000 Subject: [PATCH 101/187] Adds account and puppet to context processor, modifies test. --- evennia/web/utils/general_context.py | 2 +- evennia/web/utils/tests.py | 22 +++++++++++++++------- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/evennia/web/utils/general_context.py b/evennia/web/utils/general_context.py index 57b46bf59a..117036e772 100644 --- a/evennia/web/utils/general_context.py +++ b/evennia/web/utils/general_context.py @@ -69,7 +69,7 @@ def general_context(request): """ account = None if request.user.is_authenticated(): account = request.user - + puppet = None if request.session.get('puppet'): puppet = request.session['puppet'] diff --git a/evennia/web/utils/tests.py b/evennia/web/utils/tests.py index e2b28c3510..093b858f4d 100644 --- a/evennia/web/utils/tests.py +++ b/evennia/web/utils/tests.py @@ -1,10 +1,8 @@ -from mock import Mock, patch - -from django.test import TestCase - +from django.contrib.auth.models import AnonymousUser +from django.test import RequestFactory, TestCase +from mock import MagicMock, patch from . import general_context - class TestGeneralContext(TestCase): maxDiff = None @@ -15,8 +13,18 @@ class TestGeneralContext(TestCase): @patch('evennia.web.utils.general_context.WEBSOCKET_PORT', "websocket_client_port_testvalue") @patch('evennia.web.utils.general_context.WEBSOCKET_URL', "websocket_client_url_testvalue") def test_general_context(self): - request = Mock() - self.assertEqual(general_context.general_context(request), { + request = RequestFactory().get('/') + request.user = AnonymousUser() + request.session = { + 'account': None, + 'puppet': None, + } + + response = general_context.general_context(request) + + self.assertEqual(response, { + 'account': None, + 'puppet': None, 'game_name': "test_name", 'game_slogan': "test_game_slogan", 'evennia_userapps': ['Accounts'], From 3c0fbe336bc9b6f510fc6bab87f2b4d303ecb718 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 19:00:47 +0000 Subject: [PATCH 102/187] Changes charcreateview to use new typeclass create() method instead. --- evennia/web/website/tests.py | 26 ++++++++++++++++++++++++-- evennia/web/website/views.py | 22 +--------------------- 2 files changed, 25 insertions(+), 23 deletions(-) diff --git a/evennia/web/website/tests.py b/evennia/web/website/tests.py index a45ec2d17a..6a6c6ae7e1 100644 --- a/evennia/web/website/tests.py +++ b/evennia/web/website/tests.py @@ -1,6 +1,6 @@ from django.conf import settings from django.utils.text import slugify -from django.test import Client +from django.test import Client, override_settings from django.urls import reverse from evennia.utils.test_resources import EvenniaTest @@ -97,7 +97,29 @@ class CharacterCreateView(EvenniaWebTest): url_name = 'character-create' unauthenticated_response = 302 - def test_valid_access(self): + @override_settings(MULTISESSION_MODE=0) + def test_valid_access_multisession_0(self): + "Account1 with no characters should be able to create a new one" + self.account.db._playable_characters = [] + + # Login account + self.login() + + # Post data for a new character + data = { + 'db_key': 'gannon', + 'desc': 'Some dude.' + } + + response = self.client.post(reverse(self.url_name), data=data, follow=True) + self.assertEqual(response.status_code, 200) + + # Make sure the character was actually created + self.assertTrue(len(self.account.db._playable_characters) == 1, 'Account only has the following characters attributed to it: %s' % self.account.db._playable_characters) + + @override_settings(MULTISESSION_MODE=2) + @override_settings(MAX_NR_CHARACTERS=10) + def test_valid_access_multisession_2(self): "Account1 should be able to create a new character" # Login account self.login() diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index f07e7f80f0..c044623e8d 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -363,28 +363,8 @@ class CharacterCreateView(CharacterMixin, ObjectCreateView): description = self.attributes.pop('desc') # Create a character - permissions = settings.PERMISSION_ACCOUNT_DEFAULT - typeclass = self.model - default_home = ObjectDB.objects.get_id(settings.DEFAULT_HOME) - - from evennia.utils import create try: - character = create.create_object(typeclass, key=charname, home=default_home, permissions=permissions) - # set playable character list - account.db._playable_characters.append(character) - - # allow only the character itself and the account to puppet this character (and Developers). - character.locks.add("puppet:id(%i) or pid(%i) or perm(Developer) or pperm(Developer)" % - (character.id, account.id)) - - # If no description is set, set a default description - if not description: - character.db.desc = "This is a character." - else: - character.db.desc = description - - # We need to set this to have @ic auto-connect to this character - account.db._last_puppet = character + character, errors = self.model.create(charname, account, description=description) # Assign attributes from form [setattr(character.db, key, value) for key,value in self.attributes.items()] From efef4ad0a35292d8a994936a44dbf3e94633caf2 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 19:55:30 +0000 Subject: [PATCH 103/187] Converts shared_login view function to a middleware class, renames deprecated MIDDLEWARE_CLASSES setting to MIDDLEWARE. --- evennia/settings_default.py | 5 +++-- evennia/web/website/views.py | 41 ------------------------------------ 2 files changed, 3 insertions(+), 43 deletions(-) diff --git a/evennia/settings_default.py b/evennia/settings_default.py index 40c36e6f7e..41da7fc653 100644 --- a/evennia/settings_default.py +++ b/evennia/settings_default.py @@ -765,14 +765,15 @@ TEMPLATES = [{ # MiddleWare are semi-transparent extensions to Django's functionality. # see http://www.djangoproject.com/documentation/middleware/ for a more detailed # explanation. -MIDDLEWARE_CLASSES = ( +MIDDLEWARE = ( 'django.middleware.common.CommonMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', # 1.4? 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.admindocs.middleware.XViewMiddleware', - 'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware',) + 'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware', + 'evennia.web.utils.middleware.SharedLoginMiddleware',) ###################################################################### # Evennia components diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index fe93b06426..344ea9d80b 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -20,43 +20,6 @@ from django.contrib.auth import login _BASE_CHAR_TYPECLASS = settings.BASE_CHARACTER_TYPECLASS - -def _shared_login(request): - """ - Handle the shared login between website and webclient. - - """ - csession = request.session - account = request.user - website_uid = csession.get("website_authenticated_uid", None) - webclient_uid = csession.get("webclient_authenticated_uid", None) - - if not csession.session_key: - # this is necessary to build the sessid key - csession.save() - - if account.is_authenticated(): - # Logged into website - if not website_uid: - # fresh website login (just from login page) - csession["website_authenticated_uid"] = account.id - if webclient_uid is None: - # auto-login web client - csession["webclient_authenticated_uid"] = account.id - - elif webclient_uid: - # Not logged into website, but logged into webclient - if not website_uid: - csession["website_authenticated_uid"] = account.id - account = AccountDB.objects.get(id=webclient_uid) - try: - # calls our custom authenticate, in web/utils/backend.py - authenticate(autologin=account) - login(request, account) - except AttributeError: - logger.log_trace() - - def _gamestats(): # Some misc. configurable stuff. # TODO: Move this to either SQL or settings.py based configuration. @@ -96,10 +59,6 @@ def page_index(request): """ Main root page. """ - - # handle webclient-website shared login - _shared_login(request) - # get game db stats pagevars = _gamestats() From c4bd521cd1db2e02e60fb32c8190eb67c2f70830 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 20:06:11 +0000 Subject: [PATCH 104/187] Adds middleware. --- evennia/web/utils/middleware.py | 60 +++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 evennia/web/utils/middleware.py diff --git a/evennia/web/utils/middleware.py b/evennia/web/utils/middleware.py new file mode 100644 index 0000000000..3a60c3ca4f --- /dev/null +++ b/evennia/web/utils/middleware.py @@ -0,0 +1,60 @@ +from django.contrib.auth import authenticate, login +from evennia.accounts.models import AccountDB +from evennia.utils import logger + +class SharedLoginMiddleware(object): + """ + Handle the shared login between website and webclient. + + """ + def __init__(self, get_response): + # One-time configuration and initialization. + self.get_response = get_response + + def __call__(self, request): + # Code to be executed for each request before + # the view (and later middleware) are called. + + # Process view + response = self.get_response(request) + + # Code to be executed for each request/response after + # the view is called. + + # Synchronize credentials + self.make_shared_login(request) + + # Return processed view + return response + + @classmethod + def make_shared_login(cls, request): + csession = request.session + account = request.user + website_uid = csession.get("website_authenticated_uid", None) + webclient_uid = csession.get("webclient_authenticated_uid", None) + + if not csession.session_key: + # this is necessary to build the sessid key + csession.save() + + if account.is_authenticated(): + # Logged into website + if not website_uid: + # fresh website login (just from login page) + csession["website_authenticated_uid"] = account.id + if webclient_uid is None: + # auto-login web client + csession["webclient_authenticated_uid"] = account.id + + elif webclient_uid: + # Not logged into website, but logged into webclient + if not website_uid: + csession["website_authenticated_uid"] = account.id + account = AccountDB.objects.get(id=webclient_uid) + try: + # calls our custom authenticate, in web/utils/backend.py + authenticate(autologin=account) + login(request, account) + except AttributeError: + logger.log_trace() \ No newline at end of file From 3269b758652c6ddee51f833888b9938518a742ff Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 20:24:41 +0000 Subject: [PATCH 105/187] Updates AccountCreateView to use typeclass create method. --- evennia/web/website/views.py | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index c044623e8d..d16383357a 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -294,26 +294,17 @@ class AccountCreateView(AccountMixin, ObjectCreateView): password = form.cleaned_data['password1'] email = form.cleaned_data.get('email', '') - # Create a fake session object to intercept calls to the terminal - from mock import Mock - session = self.request - session.address = self.request.META.get('REMOTE_ADDR', '') - session.msg = Mock() - # Create account - from evennia.commands.default.unloggedin import _create_account - permissions = settings.PERMISSION_ACCOUNT_DEFAULT - account = _create_account(session, username, password, permissions) + account, errs = self.model.create( + username=username, + password=password, + email=email,) # If unsuccessful, get messages passed to session.msg if not account: - [messages.error(self.request, call) for call in session.msg.call_args_list] + [messages.error(self.request, err) for err in errs] return self.form_invalid(form) - # Append email address if given - account.email = email - account.save() - messages.success(self.request, "Your account '%s' was successfully created! You may log in using it now." % account.name) return HttpResponseRedirect(self.success_url) From 1ad0102cd114959e7031d5a3a4accc01151b3f60 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 21:08:11 +0000 Subject: [PATCH 106/187] Adds puppet activation url method to base object typeclass. --- evennia/typeclasses/models.py | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/evennia/typeclasses/models.py b/evennia/typeclasses/models.py index 61dddc0c80..9e27885e01 100644 --- a/evennia/typeclasses/models.py +++ b/evennia/typeclasses/models.py @@ -817,6 +817,38 @@ class TypedObject(SharedMemoryModel): kwargs={'pk': self.pk, 'slug': slugify(self.name)}) except: return '#' + + def web_get_puppet_url(self): + """ + Returns the URI path for a View that allows users to puppet a specific + object. + + ex. Oscar (Character) = '/characters/oscar/1/puppet/' + + For this to work, the developer must have defined a named view somewhere + in urls.py that follows the format 'modelname-action', so in this case + a named view of 'character-puppet' would be referenced by this method. + + ex. + url(r'characters/(?P[\w\d\-]+)/(?P[0-9]+)/puppet/$', + CharPuppetView.as_view(), name='character-puppet') + + If no View has been created and defined in urls.py, returns an + HTML anchor. + + This method is naive and simply returns a path. Securing access to + the actual view and limiting who can view this object is the developer's + responsibility. + + Returns: + path (str): URI path to object puppet page, if defined. + + """ + try: + return reverse('%s-puppet' % self._meta.verbose_name.lower(), + kwargs={'pk': self.pk, 'slug': slugify(self.name)}) + except: + return '#' def web_get_update_url(self): """ From 836a1fabf5a09b51483d54165df8d47f89592891 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 21:09:22 +0000 Subject: [PATCH 107/187] Fixes serialization/deserialization issue with puppet context. --- evennia/web/utils/general_context.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/evennia/web/utils/general_context.py b/evennia/web/utils/general_context.py index 117036e772..8fd52eec2e 100644 --- a/evennia/web/utils/general_context.py +++ b/evennia/web/utils/general_context.py @@ -71,7 +71,9 @@ def general_context(request): if request.user.is_authenticated(): account = request.user puppet = None - if request.session.get('puppet'): puppet = request.session['puppet'] + if account and request.session.get('puppet'): + pk = int(request.session.get('puppet')) + puppet = next((x for x in account.characters if x.pk == pk), None) return { 'account': account, From 013299a65c22d9d2f205d1dd5ab9641a1d6bc804 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 21:11:17 +0000 Subject: [PATCH 108/187] Adds puppet quick links to dropdown menu, implements views and adds tests. Converts index view to CBV. --- .../web/website/templates/website/_menu.html | 10 +++- evennia/web/website/tests.py | 23 +++++++++ evennia/web/website/urls.py | 3 +- evennia/web/website/views.py | 47 +++++++++++++------ 4 files changed, 65 insertions(+), 18 deletions(-) diff --git a/evennia/web/website/templates/website/_menu.html b/evennia/web/website/templates/website/_menu.html index e82db1ca58..18fc6ec3a5 100644 --- a/evennia/web/website/templates/website/_menu.html +++ b/evennia/web/website/templates/website/_menu.html @@ -41,13 +41,19 @@ folder and edit it to add/remove links to the menu. {% block navbar_user %} {% if account %}
  • - +
    Create Character Manage Characters
    {% for character in account.characters|slice:"10" %} - {{ character }} + {{ character }} {% empty %} No characters found! {% endfor %} diff --git a/evennia/web/website/tests.py b/evennia/web/website/tests.py index 6a6c6ae7e1..daf8614b28 100644 --- a/evennia/web/website/tests.py +++ b/evennia/web/website/tests.py @@ -136,6 +136,29 @@ class CharacterCreateView(EvenniaWebTest): # Make sure the character was actually created self.assertTrue(len(self.account.db._playable_characters) > 1, 'Account only has the following characters attributed to it: %s' % self.account.db._playable_characters) +class CharacterPuppetView(EvenniaWebTest): + url_name = 'character-puppet' + unauthenticated_response = 302 + + def get_kwargs(self): + return { + 'pk': self.char1.pk, + 'slug': slugify(self.char1.name) + } + + def test_invalid_access(self): + "Account1 should not be able to puppet Account2:Char2" + # Login account + self.login() + + # Try to access puppet page for char2 + kwargs = { + 'pk': self.char2.pk, + 'slug': slugify(self.char2.name) + } + response = self.client.get(reverse(self.url_name, kwargs=kwargs), follow=True) + self.assertTrue(response.status_code >= 400, "Invalid access should return a 4xx code-- either obj not found or permission denied! (Returned %s)" % response.status_code) + class CharacterManageView(EvenniaWebTest): url_name = 'character-manage' unauthenticated_response = 302 diff --git a/evennia/web/website/urls.py b/evennia/web/website/urls.py index 604ac1af6c..9076046dff 100644 --- a/evennia/web/website/urls.py +++ b/evennia/web/website/urls.py @@ -9,7 +9,7 @@ from django import views as django_views from evennia.web.website import views as website_views urlpatterns = [ - url(r'^$', website_views.page_index, name="index"), + url(r'^$', website_views.EvenniaIndexView.as_view(), name="index"), url(r'^tbi/', website_views.to_be_implemented, name='to_be_implemented'), # User Authentication (makes login/logout url names available) @@ -19,6 +19,7 @@ urlpatterns = [ # Character management url(r'^characters/create/$', website_views.CharacterCreateView.as_view(), name="character-create"), url(r'^characters/manage/$', website_views.CharacterManageView.as_view(), name="character-manage"), + url(r'^characters/puppet/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterPuppetView.as_view(), name="character-puppet"), url(r'^characters/update/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterUpdateView.as_view(), name="character-update"), url(r'^characters/delete/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterDeleteView.as_view(), name="character-delete"), diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index d16383357a..cc62878d2e 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -15,8 +15,9 @@ from django.core.exceptions import PermissionDenied from django.db.models.functions import Lower from django.http import HttpResponseBadRequest, HttpResponseRedirect, Http404 from django.shortcuts import render -from django.urls import reverse_lazy +from django.urls import reverse, reverse_lazy from django.views.generic import View, TemplateView, ListView, DetailView, FormView +from django.views.generic.base import RedirectView from django.views.generic.edit import CreateView, UpdateView, DeleteView from evennia import SESSION_HANDLER @@ -102,20 +103,6 @@ def _gamestats(): return pagevars -def page_index(request): - """ - Main root page. - """ - - # handle webclient-website shared login - _shared_login(request) - - # get game db stats - pagevars = _gamestats() - - return render(request, 'index.html', pagevars) - - def to_be_implemented(request): """ A notice letting the user know that this particular feature hasn't been @@ -149,6 +136,20 @@ def admin_wrapper(request): # Class-based views # +class EvenniaIndexView(TemplateView): + # Display this HTML page + template_name = 'website/index.html' + + # Display these variables on it + def get_context_data(self, **kwargs): + # Call the base implementation first to get a context object + context = super(EvenniaIndexView, self).get_context_data(**kwargs) + + # Add game statistics and other pagevars + context.update(_gamestats()) + + return context + class EvenniaCreateView(CreateView): @property @@ -324,6 +325,22 @@ class CharacterMixin(object): # Return a queryset consisting of those characters return self.model.objects.filter(id__in=ids).order_by(Lower('db_key')) +class CharacterPuppetView(LoginRequiredMixin, CharacterMixin, RedirectView, ObjectDetailView): + + def get_redirect_url(self, *args, **kwargs): + # Get the requested character, if it belongs to the authenticated user + char = self.get_object() + next = self.kwargs.get('next', reverse('character-manage')) + + if char: + self.request.session['puppet'] = int(char.pk) + messages.success(self.request, "You become '%s'!" % char) + else: + self.request.session['puppet'] = None + messages.error(self.request, "You cannot become '%s'." % char) + + return next + class CharacterManageView(LoginRequiredMixin, CharacterMixin, ListView): paginate_by = 10 From e240b758eda4fa3cf59e6bf258ed26ce760a3bf4 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 22:52:33 +0000 Subject: [PATCH 109/187] Fixes links. --- .../website/templates/website/character_manage_list.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/evennia/web/website/templates/website/character_manage_list.html b/evennia/web/website/templates/website/character_manage_list.html index c65314bc8e..ffb401e315 100644 --- a/evennia/web/website/templates/website/character_manage_list.html +++ b/evennia/web/website/templates/website/character_manage_list.html @@ -17,12 +17,12 @@ {% for object in object_list %}
    - +

    {{ object.db_date_created }} -
    Delete -
    Edit

    -
    {{ object }} {% if object.subtitle %}{{ object.subtitle }}{% endif %}
    +
    Delete +
    Edit

    +
    {{ object }} {% if object.subtitle %}{{ object.subtitle }}{% endif %}

    {{ object.db.desc }}

    From a4757637bdbb912d41aaa39ed257e664974ae4b9 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 24 Oct 2018 22:53:04 +0000 Subject: [PATCH 110/187] Fixes redirect bug after character update, updates tests. --- evennia/web/website/tests.py | 8 ++++++++ evennia/web/website/views.py | 14 +++++++++----- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/evennia/web/website/tests.py b/evennia/web/website/tests.py index daf8614b28..f2b321b652 100644 --- a/evennia/web/website/tests.py +++ b/evennia/web/website/tests.py @@ -182,6 +182,14 @@ class CharacterUpdateView(EvenniaWebTest): response = self.client.get(reverse(self.url_name, kwargs=self.get_kwargs()), follow=True) self.assertEqual(response.status_code, 200) + # Try to update char1 desc + data = {'db_key': self.char1.db_key, 'desc': "Just a regular type of dude."} + response = self.client.post(reverse(self.url_name, kwargs=self.get_kwargs()), data=data, follow=True) + self.assertEqual(response.status_code, 200) + + # Make sure the change was made successfully + self.assertEqual(self.char1.db.desc, data['desc']) + def test_invalid_access(self): "Account1 should not be able to update Account2:Char2" # Login account diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index cc62878d2e..a993a8258e 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -233,6 +233,10 @@ class ObjectUpdateView(LoginRequiredMixin, ObjectDetailView, EvenniaUpdateView): model = class_from_module(settings.BASE_OBJECT_TYPECLASS) access_type = 'edit' + def get_success_url(self): + if self.success_url: return self.success_url + return self.object.web_get_detail_url() + def get_initial(self): """ Override of Django hook. @@ -273,7 +277,7 @@ class ObjectUpdateView(LoginRequiredMixin, ObjectDetailView, EvenniaUpdateView): # Do not return super().form_valid; we don't want to update the model # instance, just its attributes. - return HttpResponseRedirect(self.success_url) + return HttpResponseRedirect(self.get_success_url()) # # Account views @@ -317,6 +321,7 @@ class CharacterMixin(object): model = class_from_module(settings.BASE_CHARACTER_TYPECLASS) form_class = CharacterForm + success_url = reverse_lazy('character-manage') def get_queryset(self): # Get IDs of characters owned by account @@ -330,7 +335,7 @@ class CharacterPuppetView(LoginRequiredMixin, CharacterMixin, RedirectView, Obje def get_redirect_url(self, *args, **kwargs): # Get the requested character, if it belongs to the authenticated user char = self.get_object() - next = self.kwargs.get('next', reverse('character-manage')) + next = self.kwargs.get('next', self.success_url) if char: self.request.session['puppet'] = int(char.pk) @@ -353,12 +358,11 @@ class CharacterUpdateView(CharacterMixin, ObjectUpdateView): template_name = 'website/character_form.html' class CharacterDeleteView(CharacterMixin, ObjectDeleteView): - success_url = reverse_lazy('character-manage') + pass class CharacterCreateView(CharacterMixin, ObjectCreateView): - + template_name = 'website/character_form.html' - success_url = reverse_lazy('character-manage') def form_valid(self, form): # Get account ref From 2d23bda9a6a2964a608969b6fc611dbbb5ed5ae1 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 26 Oct 2018 00:15:48 +0000 Subject: [PATCH 111/187] Adds a generic object detail view. --- evennia/web/website/urls.py | 1 + evennia/web/website/views.py | 39 +++++++++++++++++++++++++++++++++++- 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/evennia/web/website/urls.py b/evennia/web/website/urls.py index 9076046dff..4a24beb472 100644 --- a/evennia/web/website/urls.py +++ b/evennia/web/website/urls.py @@ -19,6 +19,7 @@ urlpatterns = [ # Character management url(r'^characters/create/$', website_views.CharacterCreateView.as_view(), name="character-create"), url(r'^characters/manage/$', website_views.CharacterManageView.as_view(), name="character-manage"), + url(r'^characters/detail/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterDetailView.as_view(), name="character-detail"), url(r'^characters/puppet/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterPuppetView.as_view(), name="character-puppet"), url(r'^characters/update/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterUpdateView.as_view(), name="character-update"), url(r'^characters/delete/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterDeleteView.as_view(), name="character-delete"), diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index a993a8258e..43febb5a6b 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -5,6 +5,8 @@ the other applications. Views are django's way of processing e.g. html templates on the fly. """ +from collections import OrderedDict + from django.contrib.admin.sites import site from django.conf import settings from django.contrib import messages @@ -155,6 +157,12 @@ class EvenniaCreateView(CreateView): @property def page_title(self): return 'Create %s' % self.model._meta.verbose_name.title() + +class EvenniaDetailView(DetailView): + + @property + def page_title(self): + return '%s Detail' % self.model._meta.verbose_name.title() class EvenniaUpdateView(UpdateView): @@ -172,10 +180,36 @@ class EvenniaDeleteView(DeleteView): # Object views # -class ObjectDetailView(DetailView): +class ObjectDetailView(EvenniaDetailView): model = class_from_module(settings.BASE_OBJECT_TYPECLASS) access_type = 'view' + template_name = 'website/object_detail.html' + attributes = ['name', 'desc'] + + def get_context_data(self, **kwargs): + """ + Adds an 'attributes' list to the context consisting of the attributes + specified at the class level, in the order provided. + + Django views do not provide a way to reference dynamic attributes, so + we have to grab them all before we render the template. + + """ + context = super(ObjectDetailView, self).get_context_data(**kwargs) + + obj = self.get_object() + attribute_list = OrderedDict() + + for attribute in self.attributes: + if attribute in self.model._meta._property_names: + attribute_list[attribute.title()] = getattr(obj, attribute, '') + else: + attribute_list[attribute.title()] = getattr(obj.db, attribute, '') + + context['attribute_list'] = attribute_list + + return context def get_object(self, queryset=None): """ @@ -357,6 +391,9 @@ class CharacterUpdateView(CharacterMixin, ObjectUpdateView): form_class = CharacterUpdateForm template_name = 'website/character_form.html' +class CharacterDetailView(CharacterMixin, ObjectDetailView): + pass + class CharacterDeleteView(CharacterMixin, ObjectDeleteView): pass From c2e59428ac9970d70bb170b86ff84dc7129bfb2f Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 26 Oct 2018 00:19:38 +0000 Subject: [PATCH 112/187] Fixes redirect bug where character quickselect would always return browser to character management page. --- evennia/web/website/views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index a993a8258e..9a33fd0e6d 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -335,7 +335,7 @@ class CharacterPuppetView(LoginRequiredMixin, CharacterMixin, RedirectView, Obje def get_redirect_url(self, *args, **kwargs): # Get the requested character, if it belongs to the authenticated user char = self.get_object() - next = self.kwargs.get('next', self.success_url) + next = self.request.GET.get('next', self.success_url) if char: self.request.session['puppet'] = int(char.pk) From 4b3f3bf74775c3a27cfe8681d2038658c93fc6de Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 26 Oct 2018 00:26:27 +0000 Subject: [PATCH 113/187] Cosmetic fix. Adjusts margins on character management page to be consistent with index. --- .../website/character_manage_list.html | 38 +++++++++---------- 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/evennia/web/website/templates/website/character_manage_list.html b/evennia/web/website/templates/website/character_manage_list.html index ffb401e315..c8845f7165 100644 --- a/evennia/web/website/templates/website/character_manage_list.html +++ b/evennia/web/website/templates/website/character_manage_list.html @@ -7,28 +7,26 @@ {% block content %} {% load addclass %} -
    -
    -
    -
    -
    -

    {{ view.page_title }}

    -
    +
    +
    +
    +
    +

    {{ view.page_title }}

    +
    - {% for object in object_list %} -
    - -
    -

    {{ object.db_date_created }} -
    Delete -
    Edit

    -
    {{ object }} {% if object.subtitle %}{{ object.subtitle }}{% endif %}
    -

    {{ object.db.desc }}

    -
    + {% for object in object_list %} +
    + +
    +

    {{ object.db_date_created }} +
    Delete +
    Edit

    +
    {{ object }} {% if object.subtitle %}{{ object.subtitle }}{% endif %}
    +

    {{ object.db.desc }}

    - {% endfor %} - -
    +
    + {% endfor %} +
    From 3a915f3bec16be00233806267d9f05c67009b12f Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 26 Oct 2018 00:29:12 +0000 Subject: [PATCH 114/187] Adds padding to the Evennia Admin page to make layout more consistent with rest of site. --- evennia/web/website/templates/website/evennia_admin.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/website/templates/website/evennia_admin.html b/evennia/web/website/templates/website/evennia_admin.html index 8e88d9cc50..80e22e2f2a 100644 --- a/evennia/web/website/templates/website/evennia_admin.html +++ b/evennia/web/website/templates/website/evennia_admin.html @@ -6,7 +6,7 @@
    -
    +

    Admin

    Welcome to the Evennia Admin Page. Here, you can edit many facets of accounts, characters, and other parts of the game. From 8230dd75d051d3ec0e0dad8b2a122e2039896c6b Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 26 Oct 2018 00:32:13 +0000 Subject: [PATCH 115/187] Adjusts margins to make layout more consistent with rest of site. --- evennia/web/website/templates/website/character_form.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/evennia/web/website/templates/website/character_form.html b/evennia/web/website/templates/website/character_form.html index 964f4e6aa4..20ad71e261 100644 --- a/evennia/web/website/templates/website/character_form.html +++ b/evennia/web/website/templates/website/character_form.html @@ -7,10 +7,10 @@ {% block content %} {% load addclass %} -

    +
    -
    -
    +
    +

    {{ view.page_title }}

    @@ -47,5 +47,5 @@
    -
    + {% endblock %} From 13d41a3bb4af391657560a2051411f8e1331b9ea Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 26 Oct 2018 00:39:16 +0000 Subject: [PATCH 116/187] Adjusts margins and adds missing password change completion page. --- .../registration/password_change_done.html | 27 +++++++++++++++++++ .../registration/password_change_form.html | 3 +-- 2 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 evennia/web/website/templates/website/registration/password_change_done.html diff --git a/evennia/web/website/templates/website/registration/password_change_done.html b/evennia/web/website/templates/website/registration/password_change_done.html new file mode 100644 index 0000000000..8869d8d69c --- /dev/null +++ b/evennia/web/website/templates/website/registration/password_change_done.html @@ -0,0 +1,27 @@ +{% extends "base.html" %} + +{% block titleblock %} +Password Changed +{% endblock %} + +{% block body %} + +{% load addclass %} +
    +
    +
    +
    +
    +

    Password Changed

    +
    + +

    Your password was changed.

    + +

    Click here to return to the index.

    + +
    +
    +
    +
    +
    +{% endblock %} diff --git a/evennia/web/website/templates/website/registration/password_change_form.html b/evennia/web/website/templates/website/registration/password_change_form.html index bae8c90962..1911b83cf0 100644 --- a/evennia/web/website/templates/website/registration/password_change_form.html +++ b/evennia/web/website/templates/website/registration/password_change_form.html @@ -7,10 +7,9 @@ Password Change {% block content %} {% load addclass %} -
    -
    +

    Password Change

    From 70e9f4314bd48cc2a74d60e13ca61180f9c45c68 Mon Sep 17 00:00:00 2001 From: Johnny Date: Fri, 26 Oct 2018 00:43:58 +0000 Subject: [PATCH 117/187] Fixes margins on paginator to be more consistent with rest of site. --- .../website/templates/website/pagination.html | 52 +++++++++---------- 1 file changed, 25 insertions(+), 27 deletions(-) diff --git a/evennia/web/website/templates/website/pagination.html b/evennia/web/website/templates/website/pagination.html index e2cb6bed73..c89d4ee473 100644 --- a/evennia/web/website/templates/website/pagination.html +++ b/evennia/web/website/templates/website/pagination.html @@ -1,32 +1,30 @@ {% if page_obj %} -
  • Documentation
    • -
  • Admin Interface
    • + {% if user.is_staff %} +
  • Admin
    • + {% endif %} +
  • Help
    • {% if webclient_enabled %}
  • Play Online
    • {% endif %} diff --git a/evennia/web/website/templates/website/help_detail.html b/evennia/web/website/templates/website/help_detail.html new file mode 100644 index 0000000000..ea3310f352 --- /dev/null +++ b/evennia/web/website/templates/website/help_detail.html @@ -0,0 +1,86 @@ +{% extends "base.html" %} + +{% block titleblock %} +{{ view.page_title }} ({{ object|title }}) +{% endblock %} + +{% block content %} + +{% load addclass %} +
    +
    + + +
    +
    +

    {{ view.page_title }} ({{ object|title }})

    +
    +
      +
    1. Compendium
      2. +
    2. {{ object.db_help_category|title }}
      3. +
    3. {{ object.db_key|title }}
      4. +
    +
    + +
    + +
    +

    {{ entry_text|safe }}

    + + {% if topic_previous or topic_next %} +
    + + + + {% endif %} + +
    + + + +
    + + {% if request.user.is_staff %} + + Edit + +
    + {% endif %} + +
    +
    {{ object.db_help_category|title }}
    + + + +
    +
    + + +
    +
    + +
    +
    + + +
    +
    +{% endblock %} diff --git a/evennia/web/website/templates/website/help_list.html b/evennia/web/website/templates/website/help_list.html new file mode 100644 index 0000000000..00ee2f1df0 --- /dev/null +++ b/evennia/web/website/templates/website/help_list.html @@ -0,0 +1,110 @@ +{% extends "base.html" %} + +{% block titleblock %} +{{ view.page_title }} +{% endblock %} + +{% block content %} + +{% load addclass %} +
    +
    +
    +
    +

    {{ view.page_title }}

    +
    +
      +
    1. Compendium
      2. +
    +
    +
    + {% regroup object_list by help_category as category_list %} + + {% if category_list %} + +
    + + +
    +
    +

    The {{ game_name }} Compendium

    +

    This section of the site is your guide to learning all about {{ game_name }}-- its rules, its setting, its people, customs, classes, castes, conflicts, races, religions, lore and more!

    +

    It is organized first by category, then by topic. The box to the right will let you skip to particular categories.

    +
    +
    +
    + + + +
    + {% for help_category in category_list %} +
    {{ help_category.grouper|title }}
    + + {% endfor %} + +
    + +
    + + + +
    + {% if user.is_staff %} + + Create New + +
    + {% endif %} + +
    +
    Category Index
    + + + +
    +
    + + {% else %} + {% if user.is_staff %} +
    + +
    + {% endif %} + +
    + +
    + {% endif %} + +
    +
    +
    +
    +
    +
    +{% endblock %} diff --git a/evennia/web/website/urls.py b/evennia/web/website/urls.py index 4a24beb472..f254cbaaae 100644 --- a/evennia/web/website/urls.py +++ b/evennia/web/website/urls.py @@ -13,8 +13,12 @@ urlpatterns = [ url(r'^tbi/', website_views.to_be_implemented, name='to_be_implemented'), # User Authentication (makes login/logout url names available) - url(r'^auth/', include('django.contrib.auth.urls')), url(r'^auth/register', website_views.AccountCreateView.as_view(), name="register"), + url(r'^auth/', include('django.contrib.auth.urls')), + + # Help Topics + url(r'^help/$', website_views.HelpListView.as_view(), name="help"), + url(r'^help/(?P[\w\d\-]+)/(?P[\w\d\-]+)/$', website_views.HelpDetailView.as_view(), name="help-entry-detail"), # Character management url(r'^characters/create/$', website_views.CharacterCreateView.as_view(), name="character-create"), diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index 98c53e977a..d7aae357be 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -512,7 +512,7 @@ class AccountMixin(object): form_class = AccountForm -class AccountCreateView(AccountMixin, ObjectCreateView): +class AccountCreateView(AccountMixin, EvenniaCreateView): """ Account creation view. @@ -729,7 +729,7 @@ class CharacterCreateView(CharacterMixin, ObjectCreateView): # # Help views # -#from evennia.help.models import HelpEntry + class HelpMixin(object): """ This is a "mixin", a modifier of sorts. @@ -741,27 +741,36 @@ class HelpMixin(object): # -- Django constructs -- model = HelpEntry + # -- Evennia constructs -- + page_title = 'Help' + def get_queryset(self): """ Django hook; here we want to return a list of only those HelpEntries - that the current user is allowed to see. + and other documentation that the current user is allowed to see. Returns: queryset (QuerySet): List of Help entries available to the user. """ + account = self.request.user + # Get list of all HelpEntries - entries = HelpEntry.objects.all() + entries = self.model.objects.all().iterator() # Now figure out which ones the current user is allowed to see - bucket = [] - for entry in entries: - if entry.access(self.request.user, 'view'): - bucket.append(entry.id) - - # Re-query to just get those - entries = HelpEntry.objects.filter(id__in=bucket) - return entries + bucket = [entry.id for entry in entries if entry.access(account, 'view')] + + # Re-query and set a sorted list + filtered = self.model.objects.filter( + id__in=bucket + ).order_by( + Lower('db_key') + ).order_by( + Lower('db_help_category') + ) + + return filtered class HelpListView(HelpMixin, ListView): """ @@ -770,5 +779,85 @@ class HelpListView(HelpMixin, ListView): """ # -- Django constructs -- - paginate_by = 10 - template_name = 'website/object_list.html' \ No newline at end of file + paginate_by = 500 + template_name = 'website/help_list.html' + + # -- Evennia constructs -- + page_title = "Help Index" + +class HelpDetailView(HelpMixin, EvenniaDetailView): + """ + Returns the detail page for a given help entry. + + """ + # -- Django constructs -- + template_name = 'website/help_detail.html' + + def get_context_data(self, **kwargs): + """ + Adds navigational data to the template to let browsers go to the next + or previous entry in the help list. + + Returns: + context (dict): Django context object + + """ + context = super(HelpDetailView, self).get_context_data(**kwargs) + + # Get the object in question + obj = self.get_object() + + # Get queryset and filter out non-related categories + queryset = self.get_queryset().filter(db_help_category=obj.db_help_category).order_by(Lower('db_key')) + context['topic_list'] = queryset + + # Find the index position of the given obj in the queryset + objs = list(queryset) + for i, x in enumerate(objs): + if obj is x: + break + + # Find the previous and next topics, if either exist + try: + assert i+1 <= len(objs) and objs[i+1] is not obj + context['topic_next'] = objs[i+1] + except: context['topic_next'] = None + + try: + assert i-1 >= 0 and objs[i-1] is not obj + context['topic_previous'] = objs[i-1] + except: context['topic_previous'] = None + + # Format the help entry using HTML instead of newlines + text = obj.db_entrytext + text = text.replace('\r\n\r\n', '\n\n') + text = text.replace('\r\n', '\n') + text = text.replace('\n', '
    ') + context['entry_text'] = text + + return context + + def get_object(self, queryset=None): + """ + Override of Django hook that retrieves an object by category and topic + instead of pk and slug. + + Returns: + entry (HelpEntry): HelpEntry requested in the URL. + + """ + # Get the queryset for the help entries the user can access + if not queryset: + queryset = self.get_queryset() + + # Find the object in the queryset + category = slugify(self.kwargs.get('category', '')) + topic = slugify(self.kwargs.get('topic', '')) + obj = next((x for x in queryset if slugify(x.db_help_category)==category and slugify(x.db_key)==topic), None) + + # Check if this object was requested in a valid manner + if not obj: + raise HttpResponseBadRequest(u"No %(verbose_name)s found matching the query" % + {'verbose_name': queryset.model._meta.verbose_name}) + + return obj \ No newline at end of file From 7aff3ecc62f0f7e09d10ff5002a6aee7b79f8b1c Mon Sep 17 00:00:00 2001 From: Johnny Date: Sat, 27 Oct 2018 11:07:54 +0000 Subject: [PATCH 134/187] Fixes bug with register view because of improper scrubbing. --- evennia/web/website/forms.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/website/forms.py b/evennia/web/website/forms.py index 022d819cbe..66c5224914 100644 --- a/evennia/web/website/forms.py +++ b/evennia/web/website/forms.py @@ -32,7 +32,7 @@ class EvenniaForm(forms.Form): cleaned = {k:escape(v) for k,v in cleaned.items()} return cleaned -class AccountForm(EvenniaForm, UserCreationForm): +class AccountForm(UserCreationForm): """ This is a generic Django form tailored to the Account model. From 962b93127fb633d4f197633cab3900ec547dd3db Mon Sep 17 00:00:00 2001 From: Johnny Date: Sat, 27 Oct 2018 11:28:40 +0000 Subject: [PATCH 135/187] Makes web_get_*_url functions pass slugified versions of the meta.verbose_name (closes #1712). --- evennia/typeclasses/models.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/evennia/typeclasses/models.py b/evennia/typeclasses/models.py index 9e27885e01..fe8a2ba43f 100644 --- a/evennia/typeclasses/models.py +++ b/evennia/typeclasses/models.py @@ -782,7 +782,7 @@ class TypedObject(SharedMemoryModel): """ try: - return reverse('%s-create' % cls._meta.verbose_name.lower()) + return reverse('%s-create' % slugify(cls._meta.verbose_name)) except: return '#' @@ -813,7 +813,7 @@ class TypedObject(SharedMemoryModel): """ try: - return reverse('%s-detail' % self._meta.verbose_name.lower(), + return reverse('%s-detail' % slugify(self._meta.verbose_name), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) except: return '#' @@ -845,7 +845,7 @@ class TypedObject(SharedMemoryModel): """ try: - return reverse('%s-puppet' % self._meta.verbose_name.lower(), + return reverse('%s-puppet' % slugify(self._meta.verbose_name), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) except: return '#' @@ -877,7 +877,7 @@ class TypedObject(SharedMemoryModel): """ try: - return reverse('%s-update' % self._meta.verbose_name.lower(), + return reverse('%s-update' % slugify(self._meta.verbose_name), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) except: return '#' @@ -908,7 +908,7 @@ class TypedObject(SharedMemoryModel): """ try: - return reverse('%s-delete' % self._meta.verbose_name.lower(), + return reverse('%s-delete' % slugify(self._meta.verbose_name), kwargs={'pk': self.pk, 'slug': slugify(self.name)}) except: return '#' From 7b1565ee348c0074b84a0446659115519d3a5005 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sat, 27 Oct 2018 11:42:30 +0000 Subject: [PATCH 136/187] Corrects unit test check (registerview should always return 200 regardless of authentication) --- evennia/web/website/tests.py | 1 - 1 file changed, 1 deletion(-) diff --git a/evennia/web/website/tests.py b/evennia/web/website/tests.py index f2b321b652..69b570b1b7 100644 --- a/evennia/web/website/tests.py +++ b/evennia/web/website/tests.py @@ -78,7 +78,6 @@ class IndexTest(EvenniaWebTest): class RegisterTest(EvenniaWebTest): url_name = 'register' - unauthenticated_response = 302 class LoginTest(EvenniaWebTest): url_name = 'login' From 6ca5b83802bf3b230f774ea5f8e1f3af1d4519ac Mon Sep 17 00:00:00 2001 From: Griatch Date: Sat, 27 Oct 2018 19:08:31 +0200 Subject: [PATCH 137/187] Make create_script return None if script set up to immediately fire/stop. Resolves #1663. --- evennia/utils/create.py | 6 ++ evennia/utils/idmapper/models.py | 6 ++ evennia/utils/test_resources.py | 82 -------------------- evennia/utils/tests/test_create_functions.py | 79 +++++++++++++++++++ 4 files changed, 91 insertions(+), 82 deletions(-) create mode 100644 evennia/utils/tests/test_create_functions.py diff --git a/evennia/utils/create.py b/evennia/utils/create.py index 36db7e5a60..ae7e867f27 100644 --- a/evennia/utils/create.py +++ b/evennia/utils/create.py @@ -229,6 +229,12 @@ def create_script(typeclass=None, key=None, obj=None, account=None, locks=None, # at_first_save hook on the typeclass, where the _createdict # can be used. new_script.save() + + if not new_script.id: + # this happens in the case of having a repeating script with `repeats=1` and + # `start_delay=False` - the script will run once and immediately stop before save is over. + return None + return new_script diff --git a/evennia/utils/idmapper/models.py b/evennia/utils/idmapper/models.py index fcda53cdfd..54b0ac33d2 100644 --- a/evennia/utils/idmapper/models.py +++ b/evennia/utils/idmapper/models.py @@ -397,6 +397,11 @@ class SharedMemoryModel(with_metaclass(SharedMemoryModelBase, Model)): super(SharedMemoryModel, cls).save(*args, **kwargs) callFromThread(_save_callback, self, *args, **kwargs) + if not self.pk: + # this can happen if some of the startup methods immediately + # delete the object (an example are Scripts that start and die immediately) + return + # update field-update hooks and eventual OOB watchers new = False if "update_fields" in kwargs and kwargs["update_fields"]: @@ -421,6 +426,7 @@ class SharedMemoryModel(with_metaclass(SharedMemoryModelBase, Model)): # fieldtracker = "_oob_at_%s_postsave" % fieldname # if hasattr(self, fieldtracker): # _GA(self, fieldtracker)(fieldname) + pass class WeakSharedMemoryModelBase(SharedMemoryModelBase): diff --git a/evennia/utils/test_resources.py b/evennia/utils/test_resources.py index 3981ea1476..b4124b7219 100644 --- a/evennia/utils/test_resources.py +++ b/evennia/utils/test_resources.py @@ -66,85 +66,3 @@ class EvenniaTest(TestCase): self.account.delete() self.account2.delete() super(EvenniaTest, self).tearDown() - - -import unittest -import inspect - -class TestCreateScript(EvenniaTest): - - def test_create_script(self): - class TestScriptA(DefaultScript): - def at_script_creation(self): - self.key = 'test_script' - self.interval = 10 - self.persistent = False - - script = create.create_script(TestScriptA, key='test_script') - assert script is not None - assert script.interval == 10 - assert script.key == 'test_script' - script.stop() - - @unittest.expectedFailure - def test_create_script_w_repeats_equal_1(self): - class TestScriptB(DefaultScript): - def at_script_creation(self): - self.key = 'test_script' - self.interval = 10 - self.repeats = 1 - self.persistent = False - - script = create.create_script(TestScriptB, key='test_script') - assert script is not None - assert script.interval == 10 - assert script.repeats == 1 - assert script.key == 'test_script' - script.stop() - - def test_create_script_w_repeats_equal_1_persisted(self): - class TestScriptB1(DefaultScript): - def at_script_creation(self): - self.key = 'test_script' - self.interval = 10 - self.repeats = 1 - self.persistent = True - - script = create.create_script(TestScriptB1, key='test_script') - assert script is not None - assert script.interval == 10 - assert script.repeats == 1 - assert script.key == 'test_script' - assert self.persistent == True - script.stop() - - def test_create_script_w_repeats_equal_2(self): - class TestScriptC(DefaultScript): - def at_script_creation(self): - self.key = 'test_script' - self.interval = 10 - self.repeats = 2 - self.persistent = False - - script = create.create_script(TestScriptC, key='test_script') - assert script is not None - assert script.interval == 10 - assert script.repeats == 2 - assert script.key == 'test_script' - script.stop() - - def test_create_script_w_repeats_equal_1_and_delayed(self): - class TestScriptD(DefaultScript): - def at_script_creation(self): - self.key = 'test_script' - self.interval = 10 - self.start_delay = True - self.repeats = 1 - self.persistent = False - - script = create.create_script(TestScriptD, key='test_script') - assert script is not None - assert script.interval == 10 - assert script.repeats == 1 - assert script.key == 'test_script' - script.stop() diff --git a/evennia/utils/tests/test_create_functions.py b/evennia/utils/tests/test_create_functions.py new file mode 100644 index 0000000000..2d5b1eeaf0 --- /dev/null +++ b/evennia/utils/tests/test_create_functions.py @@ -0,0 +1,79 @@ +""" +Tests of create functions + +""" + +from evennia.utils.test_resources import EvenniaTest +from evennia.scripts.scripts import DefaultScript +from evennia.utils import create + + +class TestCreateScript(EvenniaTest): + + def test_create_script(self): + class TestScriptA(DefaultScript): + def at_script_creation(self): + self.key = 'test_script' + self.interval = 10 + self.persistent = False + + script = create.create_script(TestScriptA, key='test_script') + assert script is not None + assert script.interval == 10 + assert script.key == 'test_script' + script.stop() + + def test_create_script_w_repeats_equal_1(self): + class TestScriptB(DefaultScript): + def at_script_creation(self): + self.key = 'test_script' + self.interval = 10 + self.repeats = 1 + self.persistent = False + + # script is already stopped (interval=1, start_delay=False) + script = create.create_script(TestScriptB, key='test_script') + assert script is None + + def test_create_script_w_repeats_equal_1_persisted(self): + class TestScriptB1(DefaultScript): + def at_script_creation(self): + self.key = 'test_script' + self.interval = 10 + self.repeats = 1 + self.persistent = True + + # script is already stopped (interval=1, start_delay=False) + script = create.create_script(TestScriptB1, key='test_script') + assert script is None + + def test_create_script_w_repeats_equal_2(self): + class TestScriptC(DefaultScript): + def at_script_creation(self): + self.key = 'test_script' + self.interval = 10 + self.repeats = 2 + self.persistent = False + + script = create.create_script(TestScriptC, key='test_script') + assert script is not None + assert script.interval == 10 + assert script.repeats == 2 + assert script.key == 'test_script' + script.stop() + + def test_create_script_w_repeats_equal_1_and_delayed(self): + class TestScriptD(DefaultScript): + def at_script_creation(self): + self.key = 'test_script' + self.interval = 10 + self.start_delay = True + self.repeats = 1 + self.persistent = False + + script = create.create_script(TestScriptD, key='test_script') + assert script is not None + assert script.interval == 10 + assert script.repeats == 1 + assert script.key == 'test_script' + script.stop() From 881b02c9880625809afae6cf386e4b8040beda02 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sat, 27 Oct 2018 13:16:28 -0500 Subject: [PATCH 138/187] Demonstrate potential problem with --- evennia/prototypes/tests.py | 1 + 1 file changed, 1 insertion(+) diff --git a/evennia/prototypes/tests.py b/evennia/prototypes/tests.py index 411bd45c27..103a5d9404 100644 --- a/evennia/prototypes/tests.py +++ b/evennia/prototypes/tests.py @@ -313,6 +313,7 @@ class TestProtFuncs(EvenniaTest): "$eval({'test': '1', 2:3, 3: $toint(3.5)})"), {'test': '1', 2: 3, 3: 3}) self.assertEqual(protlib.protfunc_parser("$obj(#1)", session=self.session), '#1') + self.assertEqual(protlib.protfunc_parser("stone(#12345)", session=self.session), 'stone(#12345)') self.assertEqual(protlib.protfunc_parser("#1", session=self.session), '#1') self.assertEqual(protlib.protfunc_parser("$obj(Char)", session=self.session), '#6') self.assertEqual(protlib.protfunc_parser("$obj(Char)", session=self.session), '#6') From de52251d28d3c064c50592bf7c7088320b987a55 Mon Sep 17 00:00:00 2001 From: Jerry Aldrich Date: Sat, 27 Oct 2018 11:23:02 -0700 Subject: [PATCH 139/187] Add a CONTRIBUTING.md --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..fec8895136 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +# Contributing to Evennia + +Evennia utilizes GitHub for issue tracking and contributions: + + - Reporting issues/bugs or making feature requests can be done [here](https://github.com/evennia/evennia/issues) + - Evennia also has a [wiki](https://github.com/evennia/evennia/wiki) that contains a guide to contributing [here](https://github.com/evennia/evennia/wiki/Contributing) From 1fedea563b6fcca122075aadec22ea1159e967b3 Mon Sep 17 00:00:00 2001 From: Jerry Aldrich Date: Sat, 27 Oct 2018 11:59:03 -0700 Subject: [PATCH 140/187] Change loose to lose where appropriate --- evennia/server/portal/irc.py | 2 +- evennia/settings_default.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/evennia/server/portal/irc.py b/evennia/server/portal/irc.py index d74fbaa86e..2b616f2ce1 100644 --- a/evennia/server/portal/irc.py +++ b/evennia/server/portal/irc.py @@ -421,7 +421,7 @@ class IRCBotFactory(protocol.ReconnectingClientFactory): def clientConnectionLost(self, connector, reason): """ - Called when Client looses connection. + Called when Client loses connection. Args: connector (Connection): Represents the connection. diff --git a/evennia/settings_default.py b/evennia/settings_default.py index 9efbb6314b..d868898861 100644 --- a/evennia/settings_default.py +++ b/evennia/settings_default.py @@ -138,7 +138,7 @@ HTTP_LOG_FILE = os.path.join(LOG_DIR, 'http_requests.log') LOCKWARNING_LOG_FILE = os.path.join(LOG_DIR, 'lockwarnings.log') # Rotate log files when server and/or portal stops. This will keep log # file sizes down. Turn off to get ever growing log files and never -# loose log info. +# lose log info. CYCLE_LOGFILES = True # Number of lines to append to rotating channel logs when they rotate CHANNEL_LOG_NUM_TAIL_LINES = 20 From 9d31ed6190ce5be0c0a093666656d210b1ef066d Mon Sep 17 00:00:00 2001 From: Jerry Aldrich Date: Sat, 27 Oct 2018 12:18:12 -0700 Subject: [PATCH 141/187] Correct a few spelling errors in tutorial build.ev --- evennia/contrib/tutorial_world/build.ev | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/evennia/contrib/tutorial_world/build.ev b/evennia/contrib/tutorial_world/build.ev index 1184865004..ce1bbe4bcf 100644 --- a/evennia/contrib/tutorial_world/build.ev +++ b/evennia/contrib/tutorial_world/build.ev @@ -744,7 +744,7 @@ hole the remains of the castle. There is also a standing archway offering passage to a path along the old |wsouth|nern inner wall. # -@detail portoculis;fall;fallen;grating = +@detail portcullis;fall;fallen;grating = This heavy iron grating used to block off the inner part of the gate house, now it has fallen to the ground together with the stone archway that once help it up. # @@ -786,7 +786,7 @@ archway The buildings make a half-circle along the main wall, here and there broken by falling stone and rubble. At one end (the |wnorth|nern) of this half-circle is the entrance to the castle, the ruined - gatehoue. |wEast|nwards from here is some sort of open courtyard. + gatehouse. |wEast|nwards from here is some sort of open courtyard. #------------------------------------------------------------ # @@ -808,7 +808,7 @@ archway Previously one could probably continue past the obelisk and eastward into the castle keep itself, but that way is now completely blocked by fallen rubble. To the |wwest|n is the gatehouse and entrance to - the castle, whereas |wsouth|nwards the collumns make way for a wide + the castle, whereas |wsouth|nwards the columns make way for a wide open courtyard. # @set here/tutorial_info = From 672d02a0484b4134069f9d5586f6690a52bccc02 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sat, 27 Oct 2018 21:19:41 +0200 Subject: [PATCH 142/187] Minor adjustments to text --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fec8895136..0d1917c4e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,5 +2,6 @@ Evennia utilizes GitHub for issue tracking and contributions: - - Reporting issues/bugs or making feature requests can be done [here](https://github.com/evennia/evennia/issues) - - Evennia also has a [wiki](https://github.com/evennia/evennia/wiki) that contains a guide to contributing [here](https://github.com/evennia/evennia/wiki/Contributing) + - Reporting Issues issues/bugs and making feature requests can be done [in the issue tracker](https://github.com/evennia/evennia/issues). + - Evennia's documentation is a [wiki](https://github.com/evennia/evennia/wiki) that everyone can contribute to. Further + instructions and details about contributing is found [here](https://github.com/evennia/evennia/wiki/Contributing). From 22b16d281421271c60f8666abc3527fc95674b76 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sat, 27 Oct 2018 18:20:54 -0500 Subject: [PATCH 143/187] Tests for protfunc parser and _RE_DBREF --- evennia/prototypes/tests.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/evennia/prototypes/tests.py b/evennia/prototypes/tests.py index 103a5d9404..fe75ccf4ec 100644 --- a/evennia/prototypes/tests.py +++ b/evennia/prototypes/tests.py @@ -262,6 +262,25 @@ class TestProtFuncs(EvenniaTest): "prototype_desc": "testing prot", "key": "ExampleObj"} + def test_RE_DBREF(self): + def check_RE_DBREF(value, expected_value): + try: + result = ( + protlib._RE_DBREF.match(value), + protlib._RE_DBREF.search(value), + protlib._RE_DBREF.sub("$obj(\\1)", value) + ) + assert expected_value == result[2] + except Exception: + self.fail() + pass + + check_RE_DBREF('#1234', '#1234') + check_RE_DBREF('(#1234)', '(#1234)') + check_RE_DBREF('obj(#1234)', 'obj(#1234)') + check_RE_DBREF('$obj(#1234)', '$obj(#1234)') + check_RE_DBREF('obj($obj(#1234))', 'obj($obj(#1234))') + @mock.patch("evennia.prototypes.protfuncs.base_random", new=mock.MagicMock(return_value=0.5)) @mock.patch("evennia.prototypes.protfuncs.base_randint", new=mock.MagicMock(return_value=5)) def test_protfuncs(self): @@ -315,10 +334,15 @@ class TestProtFuncs(EvenniaTest): self.assertEqual(protlib.protfunc_parser("$obj(#1)", session=self.session), '#1') self.assertEqual(protlib.protfunc_parser("stone(#12345)", session=self.session), 'stone(#12345)') self.assertEqual(protlib.protfunc_parser("#1", session=self.session), '#1') + self.assertEqual(protlib.protfunc_parser("#12345", session=self.session), '#12345') + self.assertEqual(protlib.protfunc_parser("nothing(#1)", session=self.session), 'nothing(#1)') + self.assertEqual(protlib.protfunc_parser("(#12345)", session=self.session), '(#12345)') self.assertEqual(protlib.protfunc_parser("$obj(Char)", session=self.session), '#6') self.assertEqual(protlib.protfunc_parser("$obj(Char)", session=self.session), '#6') self.assertEqual(protlib.protfunc_parser("$objlist(#1)", session=self.session), ['#1']) + + self.assertEqual(protlib.value_to_obj( protlib.protfunc_parser("#6", session=self.session)), self.char1) self.assertEqual(protlib.value_to_obj_or_any( From 3d6ff3dee62305e4a730bb3d4468068526f49488 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 28 Oct 2018 06:04:58 +0000 Subject: [PATCH 144/187] Adds a TypeclassMixin to the base views and mixins. --- evennia/web/website/views.py | 56 +++++++++++++++++++++++++----------- 1 file changed, 40 insertions(+), 16 deletions(-) diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index 4e3e27f6a5..e33fdb27f2 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -195,7 +195,29 @@ class EvenniaIndexView(TemplateView): return context -class EvenniaCreateView(CreateView): +class TypeclassMixin(object): + """ + This is a "mixin", a modifier of sorts. + + Django views typically work with classes called "models." Evennia objects + are an enhancement upon these Django models and are called "typeclasses." + But Django itself has no idea what a "typeclass" is. + + For the sake of mitigating confusion, any view class with this in its + inheritance list will be modified to work with Evennia Typeclass objects or + Django models interchangeably. + + """ + @property + def typeclass(self): + return self.model + + @typeclass.setter + def typeclass(self, value): + self.model = value + + +class EvenniaCreateView(CreateView, TypeclassMixin): """ This view extends Django's default CreateView. @@ -206,10 +228,10 @@ class EvenniaCreateView(CreateView): @property def page_title(self): # Makes sure the page has a sensible title. - return 'Create %s' % self.model._meta.verbose_name.title() + return 'Create %s' % self.typeclass._meta.verbose_name.title() -class EvenniaDetailView(DetailView): +class EvenniaDetailView(DetailView, TypeclassMixin): """ This view extends Django's default DetailView. @@ -220,10 +242,10 @@ class EvenniaDetailView(DetailView): @property def page_title(self): # Makes sure the page has a sensible title. - return '%s Detail' % self.model._meta.verbose_name.title() + return '%s Detail' % self.typeclass._meta.verbose_name.title() -class EvenniaUpdateView(UpdateView): +class EvenniaUpdateView(UpdateView, TypeclassMixin): """ This view extends Django's default UpdateView. @@ -234,10 +256,10 @@ class EvenniaUpdateView(UpdateView): @property def page_title(self): # Makes sure the page has a sensible title. - return 'Update %s' % self.model._meta.verbose_name.title() + return 'Update %s' % self.typeclass._meta.verbose_name.title() -class EvenniaDeleteView(DeleteView): +class EvenniaDeleteView(DeleteView, TypeclassMixin): """ This view extends Django's default DeleteView. @@ -248,7 +270,7 @@ class EvenniaDeleteView(DeleteView): @property def page_title(self): # Makes sure the page has a sensible title. - return 'Delete %s' % self.model._meta.verbose_name.title() + return 'Delete %s' % self.typeclass._meta.verbose_name.title() # # Object views @@ -312,7 +334,7 @@ class ObjectDetailView(EvenniaDetailView): for attribute in self.attributes: # Check if the attribute is a core fieldname (name, desc) - if attribute in self.model._meta._property_names: + if attribute in self.typeclass._meta._property_names: attribute_list[attribute.title()] = getattr(obj, attribute, '') # Check if the attribute is a db attribute (char1.db.favorite_color) @@ -345,7 +367,7 @@ class ObjectDetailView(EvenniaDetailView): queryset = self.get_queryset() # Get the object, ignoring all checks and filters for now - obj = self.model.objects.get(pk=self.kwargs.get('pk')) + obj = self.typeclass.objects.get(pk=self.kwargs.get('pk')) # Check if this object was requested in a valid manner if slugify(obj.name) != self.kwargs.get(self.slug_url_kwarg): @@ -399,6 +421,7 @@ class ObjectDeleteView(LoginRequiredMixin, ObjectDetailView, EvenniaDeleteView): redirects to the success URL. We extend this so we can capture the name for the sake of confirmation. + """ # Get the object in question. ObjectDetailView.get_object() will also # check to make sure the current user (authenticated or not) has @@ -498,7 +521,7 @@ class ObjectUpdateView(LoginRequiredMixin, ObjectDetailView, EvenniaUpdateView): # Account views # -class AccountMixin(object): +class AccountMixin(TypeclassMixin): """ This is a "mixin", a modifier of sorts. @@ -536,7 +559,7 @@ class AccountCreateView(AccountMixin, ObjectCreateView): email = form.cleaned_data.get('email', '') # Create account - account, errs = self.model.create( + account, errs = self.typeclass.create( username=username, password=password, email=email,) @@ -558,7 +581,7 @@ class AccountCreateView(AccountMixin, ObjectCreateView): # Character views # -class CharacterMixin(object): +class CharacterMixin(TypeclassMixin): """ This is a "mixin", a modifier of sorts. @@ -582,10 +605,11 @@ class CharacterMixin(object): """ # Get IDs of characters owned by account - ids = [getattr(x, 'id') for x in self.request.user.characters if x] + account = self.request.user + ids = [getattr(x, 'id') for x in account.characters if x] # Return a queryset consisting of those characters - return self.model.objects.filter(id__in=ids).order_by(Lower('db_key')) + return self.typeclass.objects.filter(id__in=ids).order_by(Lower('db_key')) class CharacterPuppetView(LoginRequiredMixin, CharacterMixin, RedirectView, ObjectDetailView): @@ -705,7 +729,7 @@ class CharacterCreateView(CharacterMixin, ObjectCreateView): description = self.attributes.pop('desc') # Create a character - character, errors = self.model.create(charname, account, description=description) + character, errors = self.typeclass.create(charname, account, description=description) if errors: # Echo error messages to the user From 35e2ab6485bb47a65c3178bb4280d336d7995823 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 28 Oct 2018 08:13:51 +0000 Subject: [PATCH 145/187] Makes intro text less verbose. --- evennia/web/website/templates/website/help_list.html | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/evennia/web/website/templates/website/help_list.html b/evennia/web/website/templates/website/help_list.html index 00ee2f1df0..12751731f7 100644 --- a/evennia/web/website/templates/website/help_list.html +++ b/evennia/web/website/templates/website/help_list.html @@ -27,8 +27,7 @@
    -

    The {{ game_name }} Compendium

    -

    This section of the site is your guide to learning all about {{ game_name }}-- its rules, its setting, its people, customs, classes, castes, conflicts, races, religions, lore and more!

    +

    This section of the site is a guide to understanding the mechanics behind {{ game_name }}.

    It is organized first by category, then by topic. The box to the right will let you skip to particular categories.

    From 9d8a5c5392617089c04571b56c409653a843ab43 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 28 Oct 2018 09:28:32 +0100 Subject: [PATCH 146/187] Update changelog --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8cc1b603fa..8718fe5a4c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,6 +25,9 @@ Web/Django standard initiative (stricako) - Web-based chargen based on predefined form - Character puppeting within the context of the website +- Web views for common object types, like accounts, characters etc. +- Web views for help entries. + ### Typeclasses From c46a1e8f52376a15da10433915e4f6b5b3a10722 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 28 Oct 2018 13:10:28 +0000 Subject: [PATCH 147/187] Implements ChannelViews. --- .../web/website/templates/website/_menu.html | 10 +- .../templates/website/channel_detail.html | 94 ++++++++++ .../templates/website/channel_list.html | 80 +++++++++ evennia/web/website/urls.py | 4 + evennia/web/website/views.py | 163 ++++++++++++++++++ 5 files changed, 347 insertions(+), 4 deletions(-) create mode 100644 evennia/web/website/templates/website/channel_detail.html create mode 100644 evennia/web/website/templates/website/channel_list.html diff --git a/evennia/web/website/templates/website/_menu.html b/evennia/web/website/templates/website/_menu.html index 32c17db361..69c06009d0 100644 --- a/evennia/web/website/templates/website/_menu.html +++ b/evennia/web/website/templates/website/_menu.html @@ -23,24 +23,26 @@ folder and edit it to add/remove links to the menu.
      {% block navbar_right %} {% endblock %} + {% block navbar_user %} {% if account %}
    • diff --git a/evennia/web/website/templates/website/channel_detail.html b/evennia/web/website/templates/website/channel_detail.html new file mode 100644 index 0000000000..4af6751b3c --- /dev/null +++ b/evennia/web/website/templates/website/channel_detail.html @@ -0,0 +1,94 @@ +{% extends "base.html" %} + +{% block titleblock %} +{{ view.page_title }} ({{ object }}) +{% endblock %} + +{% block content %} + +{% load addclass %} +
      +
      +
      +
      +

      {{ view.page_title }} ({{ object }})

      +
      + +
        +
      1. Channels
        2. +
      2. {{ object.db_key|title }}
        3. +
      +
      + +
      + + +
      + + +
      +
      + {% if object.db.desc and object.db.desc != None %}{{ object.db.desc }}{% else %}No description provided.{% endif %} +
      +
      +
      + + + {% if object_list %} +
      {% for log in object_list %}
+{{ log.timestamp }}: {{ log.message }}{% endfor %}
      + {% else %} + 
      No recent log entries have been recorded for this channel.
      + {% endif %} +
      + + + +
      + + {% if request.user.is_staff %} + + Admin + +
      + {% endif %} + +
      +
      +
      + {% for attribute, value in attribute_list.items %} +
      {{ attribute }}
      +
      {{ value }}
      + {% endfor %} +
      +
      +
      Subscriptions
      +
      {{ object.subscriptions.all|length }}
      +
      +
      +
      + + {% if object_filters %} +
      +
      Date Index
      + +
        + {% for filter in object_filters %} + {{ filter }} + {% endfor %} +
      + +
      + {% endif %} + +
      + + +
      + +
      +
      +
      +
      +
      +{% endblock %} diff --git a/evennia/web/website/templates/website/channel_list.html b/evennia/web/website/templates/website/channel_list.html new file mode 100644 index 0000000000..a8c91338ae --- /dev/null +++ b/evennia/web/website/templates/website/channel_list.html @@ -0,0 +1,80 @@ +{% extends "base.html" %} + +{% block titleblock %} +{{ view.page_title }} +{% endblock %} + +{% block content %} + +{% load addclass %} +
      +
      +
      +
      +

      {{ view.page_title }}

      +
      + +
        +
      1. Channels
        2. +
      +
      + +
      + + +
      +
      + + + + + + + + + + {% for object in object_list %} + + + + + + {% endfor %} + +
      ChannelDescriptionSubscriptions
      {{ object.name }}{{ object.db.desc }}{{ object.subscriptions.all|length }}
      +
      +
      + + + +
      + + {% if request.user.is_staff %} + + Admin + +
      + {% endif %} + +
      +
      Most Popular
      + + + +
      + +
      + + +
      + + +
      +
      +
      +
      +{% endblock %} diff --git a/evennia/web/website/urls.py b/evennia/web/website/urls.py index f254cbaaae..6acff85abe 100644 --- a/evennia/web/website/urls.py +++ b/evennia/web/website/urls.py @@ -20,6 +20,10 @@ urlpatterns = [ url(r'^help/$', website_views.HelpListView.as_view(), name="help"), url(r'^help/(?P[\w\d\-]+)/(?P[\w\d\-]+)/$', website_views.HelpDetailView.as_view(), name="help-entry-detail"), + # Channels + url(r'^channels/$', website_views.ChannelListView.as_view(), name="channels"), + url(r'^channels/(?P[\w\d\-]+)/$', website_views.ChannelDetailView.as_view(), name="channel-detail"), + # Character management url(r'^characters/create/$', website_views.CharacterCreateView.as_view(), name="character-create"), url(r'^characters/manage/$', website_views.CharacterManageView.as_view(), name="character-manage"), diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index 5278cac09d..6fac7107c8 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -27,6 +27,7 @@ from evennia.help.models import HelpEntry from evennia.objects.models import ObjectDB from evennia.accounts.models import AccountDB from evennia.utils import class_from_module, logger +from evennia.utils.logger import tail_log_file from evennia.web.website.forms import * from django.contrib.auth import login @@ -689,6 +690,168 @@ class CharacterCreateView(CharacterMixin, ObjectCreateView): messages.error(self.request, "Your character could not be created.") return self.form_invalid(form) +# +# Channel views +# + +class ChannelMixin(object): + """ + This is a "mixin", a modifier of sorts. + + Any view class with this in its inheritance list will be modified to work + with HelpEntry objects instead of generic Objects or otherwise. + + """ + # -- Django constructs -- + model = class_from_module(settings.BASE_CHANNEL_TYPECLASS) + + # -- Evennia constructs -- + page_title = 'Channels' + + # What lock type to check for the requesting user, authenticated or not. + # https://github.com/evennia/evennia/wiki/Locks#valid-access_types + access_type = 'listen' + + def get_queryset(self): + """ + Django hook; here we want to return a list of only those Channels + and other documentation that the current user is allowed to see. + + Returns: + queryset (QuerySet): List of Channels available to the user. + + """ + account = self.request.user + + # Get list of all Channels + channels = self.model.objects.all().iterator() + + # Now figure out which ones the current user is allowed to see + bucket = [channel.id for channel in channels if channel.access(account, 'listen')] + + # Re-query and set a sorted list + filtered = self.model.objects.filter( + id__in=bucket + ).order_by( + Lower('db_key') + ) + + return filtered + + +class ChannelListView(ChannelMixin, ListView): + """ + Returns a list of channels that can be viewed by a user, authenticated + or not. + + """ + # -- Django constructs -- + paginate_by = 100 + template_name = 'website/channel_list.html' + + # -- Evennia constructs -- + page_title = "Channel Index" + + max_popular = 10 + + def get_context_data(self, **kwargs): + """ + Django hook; we override it to calculate the most popular channels. + + Returns: + context (dict): Django context object + + """ + context = super(ChannelListView, self).get_context_data(**kwargs) + + # Calculate which channels are most popular + context['most_popular'] = sorted( + list(self.get_queryset()), + key=lambda channel: len(channel.subscriptions.all()), + reverse=True)[:self.max_popular] + + return context + + +class ChannelDetailView(ChannelMixin, ObjectDetailView): + """ + Returns the log entries for a given channel. + + """ + # -- Django constructs -- + template_name = 'website/channel_detail.html' + + # -- Evennia constructs -- + # What attributes of the object you wish to display on the page. Model-level + # attributes will take precedence over identically-named db.attributes! + # The order you specify here will be followed. + attributes = ['name'] + + # How many log entries to read and display. + max_num_lines = 10000 + + def get_context_data(self, **kwargs): + """ + Django hook; before we can display the channel logs, we need to recall + the logfile and read its lines. + + Returns: + context (dict): Django context object + + """ + # Get the parent context object, necessary first step + context = super(ChannelDetailView, self).get_context_data(**kwargs) + + # Get the filename this Channel is recording to + filename = self.object.attributes.get("log_file", default="channel_%s.log" % self.object.key) + + # Split log entries so we can filter by time + bucket = [] + for log in (x.strip() for x in tail_log_file(filename, 0, self.max_num_lines)): + if not log: continue + time, msg = log.split(' [-] ') + time_key = time.split(':')[0] + + bucket.append({ + 'key': time_key, + 'timestamp': time, + 'message': msg + }) + + # Add the processed entries to the context + context['object_list'] = bucket + + # Get a list of unique timestamps by hour and sort them + context['object_filters'] = sorted(set([x['key'] for x in bucket])) + + return context + + + def get_object(self, queryset=None): + """ + Override of Django hook that retrieves an object by slugified channel + name. + + Returns: + channel (Channel): Channel requested in the URL. + + """ + # Get the queryset for the help entries the user can access + if not queryset: + queryset = self.get_queryset() + + # Find the object in the queryset + channel = slugify(self.kwargs.get('slug', '')) + obj = next((x for x in queryset if slugify(x.db_key) == channel), None) + + # Check if this object was requested in a valid manner + if not obj: + raise HttpResponseBadRequest(u"No %(verbose_name)s found matching the query" % + {'verbose_name': queryset.model._meta.verbose_name}) + + return obj + + # # Help views # From c9ef8c67aa893733602e9306a6882f64ea23a724 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 28 Oct 2018 13:11:23 +0000 Subject: [PATCH 148/187] Adds web_get_*_url methods to Channel typeclass. --- evennia/comms/comms.py | 152 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 152 insertions(+) diff --git a/evennia/comms/comms.py b/evennia/comms/comms.py index 90d1b04ad5..e67e5b1f8a 100644 --- a/evennia/comms/comms.py +++ b/evennia/comms/comms.py @@ -2,6 +2,10 @@ Base typeclass for in-game Channels. """ +from django.contrib.contenttypes.models import ContentType +from django.urls import reverse +from django.utils.text import slugify + from evennia.typeclasses.models import TypeclassBase from evennia.comms.models import TempMsg, ChannelDB from evennia.comms.managers import ChannelManager @@ -622,3 +626,151 @@ class DefaultChannel(with_metaclass(TypeclassBase, ChannelDB)): """ pass + + # + # Web/Django methods + # + + def web_get_admin_url(self): + """ + Returns the URI path for the Django Admin page for this object. + + ex. Account#1 = '/admin/accounts/accountdb/1/change/' + + Returns: + path (str): URI path to Django Admin page for object. + + """ + content_type = ContentType.objects.get_for_model(self.__class__) + return reverse("admin:%s_%s_change" % (content_type.app_label, + content_type.model), args=(self.id,)) + + @classmethod + def web_get_create_url(cls): + """ + Returns the URI path for a View that allows users to create new + instances of this object. + + ex. Chargen = '/characters/create/' + + For this to work, the developer must have defined a named view somewhere + in urls.py that follows the format 'modelname-action', so in this case + a named view of 'channel-create' would be referenced by this method. + + ex. + url(r'channels/create/', ChannelCreateView.as_view(), name='channel-create') + + If no View has been created and defined in urls.py, returns an + HTML anchor. + + This method is naive and simply returns a path. Securing access to + the actual view and limiting who can create new objects is the + developer's responsibility. + + Returns: + path (str): URI path to object creation page, if defined. + + """ + try: + return reverse('%s-create' % slugify(cls._meta.verbose_name)) + except: + return '#' + + def web_get_detail_url(self): + """ + Returns the URI path for a View that allows users to view details for + this object. + + ex. Oscar (Character) = '/characters/oscar/1/' + + For this to work, the developer must have defined a named view somewhere + in urls.py that follows the format 'modelname-action', so in this case + a named view of 'channel-detail' would be referenced by this method. + + ex. + url(r'channels/(?P[\w\d\-]+)/$', + ChannelDetailView.as_view(), name='channel-detail') + + If no View has been created and defined in urls.py, returns an + HTML anchor. + + This method is naive and simply returns a path. Securing access to + the actual view and limiting who can view this object is the developer's + responsibility. + + Returns: + path (str): URI path to object detail page, if defined. + + """ + try: + return reverse('%s-detail' % slugify(self._meta.verbose_name), + kwargs={'slug': slugify(self.db_key)}) + except: + return '#' + + + def web_get_update_url(self): + """ + Returns the URI path for a View that allows users to update this + object. + + ex. Oscar (Character) = '/characters/oscar/1/change/' + + For this to work, the developer must have defined a named view somewhere + in urls.py that follows the format 'modelname-action', so in this case + a named view of 'channel-update' would be referenced by this method. + + ex. + url(r'channels/(?P[\w\d\-]+)/(?P[0-9]+)/change/$', + ChannelUpdateView.as_view(), name='channel-update') + + If no View has been created and defined in urls.py, returns an + HTML anchor. + + This method is naive and simply returns a path. Securing access to + the actual view and limiting who can modify objects is the developer's + responsibility. + + Returns: + path (str): URI path to object update page, if defined. + + """ + try: + return reverse('%s-update' % slugify(self._meta.verbose_name), + kwargs={'slug': slugify(self.db_key)}) + except: + return '#' + + def web_get_delete_url(self): + """ + Returns the URI path for a View that allows users to delete this object. + + ex. Oscar (Character) = '/characters/oscar/1/delete/' + + For this to work, the developer must have defined a named view somewhere + in urls.py that follows the format 'modelname-action', so in this case + a named view of 'channel-delete' would be referenced by this method. + + ex. + url(r'channels/(?P[\w\d\-]+)/(?P[0-9]+)/delete/$', + ChannelDeleteView.as_view(), name='channel-delete') + + If no View has been created and defined in urls.py, returns an + HTML anchor. + + This method is naive and simply returns a path. Securing access to + the actual view and limiting who can delete this object is the developer's + responsibility. + + Returns: + path (str): URI path to object deletion page, if defined. + + """ + try: + return reverse('%s-delete' % slugify(self._meta.verbose_name), + kwargs={'slug': slugify(self.db_key)}) + except: + return '#' + + # Used by Django Sites/Admin + get_absolute_url = web_get_detail_url \ No newline at end of file From b910253ed2b6c93a516ac081a81fa35159bf3bef Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 28 Oct 2018 13:12:08 +0000 Subject: [PATCH 149/187] Tweaks to Admin buttons. --- evennia/web/website/templates/website/help_detail.html | 2 +- evennia/web/website/templates/website/help_list.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/evennia/web/website/templates/website/help_detail.html b/evennia/web/website/templates/website/help_detail.html index ea3310f352..44e42e0743 100644 --- a/evennia/web/website/templates/website/help_detail.html +++ b/evennia/web/website/templates/website/help_detail.html @@ -56,7 +56,7 @@ {% if request.user.is_staff %} - Edit + Admin
      {% endif %} diff --git a/evennia/web/website/templates/website/help_list.html b/evennia/web/website/templates/website/help_list.html index 12751731f7..99f1a27eef 100644 --- a/evennia/web/website/templates/website/help_list.html +++ b/evennia/web/website/templates/website/help_list.html @@ -54,7 +54,7 @@
      {% if user.is_staff %} - Create New + Admin
      {% endif %} From 11d9382bd1c6338956fbe58d70e94e126d021f9a Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 28 Oct 2018 13:12:42 +0000 Subject: [PATCH 150/187] Fixes margin. --- evennia/web/website/templates/website/object_list.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/website/templates/website/object_list.html b/evennia/web/website/templates/website/object_list.html index 1dd89c4630..4e7601d49a 100644 --- a/evennia/web/website/templates/website/object_list.html +++ b/evennia/web/website/templates/website/object_list.html @@ -9,7 +9,7 @@ {% load addclass %}
      -
      +

      {{ view.page_title }}

      From c790bb88155513aaec6a9cfa716038edc58ca054 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 28 Oct 2018 13:16:05 +0000 Subject: [PATCH 151/187] Better handling of blank lists. --- evennia/web/website/templates/website/channel_list.html | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/evennia/web/website/templates/website/channel_list.html b/evennia/web/website/templates/website/channel_list.html index a8c91338ae..3fda972479 100644 --- a/evennia/web/website/templates/website/channel_list.html +++ b/evennia/web/website/templates/website/channel_list.html @@ -39,6 +39,10 @@ {{ object.db.desc }} {{ object.subscriptions.all|length }} + {% empty %} + + No channels were found! + {% endfor %} @@ -56,6 +60,7 @@
      {% endif %} + {% if most_popular %}
      Most Popular
      @@ -66,13 +71,14 @@
    + {% endif %} - +
    From 70e64543525abfb8929a696dc9e3867944347915 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 28 Oct 2018 13:30:26 +0000 Subject: [PATCH 152/187] Adds unit test for channel views. --- evennia/web/website/tests.py | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/evennia/web/website/tests.py b/evennia/web/website/tests.py index 69b570b1b7..95f9b6217b 100644 --- a/evennia/web/website/tests.py +++ b/evennia/web/website/tests.py @@ -2,6 +2,7 @@ from django.conf import settings from django.utils.text import slugify from django.test import Client, override_settings from django.urls import reverse +from evennia.utils import class_from_module from evennia.utils.test_resources import EvenniaTest class EvenniaWebTest(EvenniaTest): @@ -13,6 +14,7 @@ class EvenniaWebTest(EvenniaTest): exit_typeclass = settings.BASE_EXIT_TYPECLASS room_typeclass = settings.BASE_ROOM_TYPECLASS script_typeclass = settings.BASE_SCRIPT_TYPECLASS + channel_typeclass = settings.BASE_CHANNEL_TYPECLASS # Default named url url_name = 'index' @@ -92,6 +94,25 @@ class PasswordResetTest(EvenniaWebTest): class WebclientTest(EvenniaWebTest): url_name = 'webclient:index' +class ChannelListTest(EvenniaWebTest): + url_name = 'channels' + +class ChannelDetailTest(EvenniaWebTest): + url_name = 'channel-detail' + + def setUp(self): + super(ChannelDetailTest, self).setUp() + + klass = class_from_module(self.channel_typeclass) + + # Create a channel + klass.create('demo') + + def get_kwargs(self): + return { + 'slug': slugify('demo') + } + class CharacterCreateView(EvenniaWebTest): url_name = 'character-create' unauthenticated_response = 302 From 4f4df628b7c3e2d8ffd8c0690f33974d189c76e7 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sun, 28 Oct 2018 09:43:01 -0500 Subject: [PATCH 153/187] #1704: Update _RE_DBREF to match '(#Number)' so that it aliases to '(#Number)' --- evennia/prototypes/prototypes.py | 4 +-- evennia/prototypes/tests.py | 52 ++++++++++++++++++++++---------- 2 files changed, 38 insertions(+), 18 deletions(-) diff --git a/evennia/prototypes/prototypes.py b/evennia/prototypes/prototypes.py index 833316cf59..020c6c84cf 100644 --- a/evennia/prototypes/prototypes.py +++ b/evennia/prototypes/prototypes.py @@ -33,7 +33,7 @@ _PROTOTYPE_TAG_CATEGORY = "from_prototype" _PROTOTYPE_TAG_META_CATEGORY = "db_prototype" PROT_FUNCS = {} -_RE_DBREF = re.compile(r"(?') self.assertEqual(protlib.protfunc_parser("stone(#12345)", session=self.session), 'stone(#12345)') self.assertEqual(protlib.protfunc_parser("#1", session=self.session), '#1') self.assertEqual(protlib.protfunc_parser("#12345", session=self.session), '#12345') self.assertEqual(protlib.protfunc_parser("nothing(#1)", session=self.session), 'nothing(#1)') self.assertEqual(protlib.protfunc_parser("(#12345)", session=self.session), '(#12345)') self.assertEqual(protlib.protfunc_parser("$obj(Char)", session=self.session), '#6') - self.assertEqual(protlib.protfunc_parser("$obj(Char)", session=self.session), '#6') + self.assertEqual(protlib.protfunc_parser("obj(Char)", session=self.session), 'obj(Char)') self.assertEqual(protlib.protfunc_parser("$objlist(#1)", session=self.session), ['#1']) + self.assertEqual(protlib.protfunc_parser("objlist(#1)", session=self.session), 'objlist(#1)') + self.assertEqual(protlib.protfunc_parser("dbref(Char)", session=self.session), 'dbref(Char)') + self.assertEqual(protlib.protfunc_parser("$dbref(Char)", session=self.session), '') From 686217375bebe9a354c6743dbab7bedb183a08e6 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 28 Oct 2018 22:12:29 +0000 Subject: [PATCH 154/187] Adds generic CharacterListView and unit test. --- .../web/website/templates/website/_menu.html | 1 + .../templates/website/character_list.html | 27 ++++++++++ evennia/web/website/tests.py | 4 ++ evennia/web/website/urls.py | 1 + evennia/web/website/views.py | 54 +++++++++++++++++++ 5 files changed, 87 insertions(+) create mode 100644 evennia/web/website/templates/website/character_list.html diff --git a/evennia/web/website/templates/website/_menu.html b/evennia/web/website/templates/website/_menu.html index 32c17db361..7bdfe82cc5 100644 --- a/evennia/web/website/templates/website/_menu.html +++ b/evennia/web/website/templates/website/_menu.html @@ -29,6 +29,7 @@ folder and edit it to add/remove links to the menu. About
  • Documentation
    • +
  • Characters
    • {% if user.is_staff %}
  • Admin
    • {% endif %} diff --git a/evennia/web/website/templates/website/character_list.html b/evennia/web/website/templates/website/character_list.html new file mode 100644 index 0000000000..4e7601d49a --- /dev/null +++ b/evennia/web/website/templates/website/character_list.html @@ -0,0 +1,27 @@ +{% extends "base.html" %} + +{% block titleblock %} +{{ view.page_title }} +{% endblock %} + +{% block content %} + +{% load addclass %} +
    +
    +
    +
    +

    {{ view.page_title }}

    +
    + +
      + {% for object in object_list %} +
    • {{ object }}
      • + {% endfor %} +
    + +
    +
    +
    +
    +{% endblock %} diff --git a/evennia/web/website/tests.py b/evennia/web/website/tests.py index 69b570b1b7..1fc775f051 100644 --- a/evennia/web/website/tests.py +++ b/evennia/web/website/tests.py @@ -158,6 +158,10 @@ class CharacterPuppetView(EvenniaWebTest): response = self.client.get(reverse(self.url_name, kwargs=kwargs), follow=True) self.assertTrue(response.status_code >= 400, "Invalid access should return a 4xx code-- either obj not found or permission denied! (Returned %s)" % response.status_code) +class CharacterListView(EvenniaWebTest): + url_name = 'characters' + unauthenticated_response = 302 + class CharacterManageView(EvenniaWebTest): url_name = 'character-manage' unauthenticated_response = 302 diff --git a/evennia/web/website/urls.py b/evennia/web/website/urls.py index f254cbaaae..fbf1c01d9c 100644 --- a/evennia/web/website/urls.py +++ b/evennia/web/website/urls.py @@ -21,6 +21,7 @@ urlpatterns = [ url(r'^help/(?P[\w\d\-]+)/(?P[\w\d\-]+)/$', website_views.HelpDetailView.as_view(), name="help-entry-detail"), # Character management + url(r'^characters/$', website_views.CharacterListView.as_view(), name="characters"), url(r'^characters/create/$', website_views.CharacterCreateView.as_view(), name="character-create"), url(r'^characters/manage/$', website_views.CharacterManageView.as_view(), name="character-manage"), url(r'^characters/detail/(?P[\w\d\-]+)/(?P[0-9]+)/$', website_views.CharacterDetailView.as_view(), name="character-detail"), diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index e1b80c415f..4f66fa5f20 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -576,6 +576,42 @@ class CharacterMixin(TypeclassMixin): return self.typeclass.objects.filter(id__in=ids).order_by(Lower('db_key')) +class CharacterListView(LoginRequiredMixin, CharacterMixin, ListView): + """ + This view provides a mechanism by which a logged-in player can view a list + of all other characters. + + This view requires authentication by default as a nominal effort to prevent + human stalkers and automated bots/scrapers from harvesting data on your users. + + """ + # -- Django constructs -- + template_name = 'website/character_list.html' + paginate_by = 100 + + # -- Evennia constructs -- + page_title = 'Character List' + access_type = 'view' + + def get_queryset(self): + """ + This method will override the Django get_queryset method to return a + list of all characters (filtered/sorted) instead of just those limited + to the account. + + Returns: + queryset (QuerySet): Django queryset for use in the given view. + + """ + account = self.request.user + + # Return a queryset consisting of characters the user is allowed to + # see. + ids = [obj.id for obj in self.model.objects.all() if obj.access(account, self.access_type)] + + return self.model.objects.filter(id__in=ids).order_by(Lower('db_key')) + + class CharacterPuppetView(LoginRequiredMixin, CharacterMixin, RedirectView, ObjectDetailView): """ This view provides a mechanism by which a logged-in player can "puppet" one @@ -653,6 +689,24 @@ class CharacterDetailView(CharacterMixin, ObjectDetailView): # -- Evennia constructs -- # What attributes to display for this object attributes = ['name', 'desc'] + access_type = 'view' + + def get_queryset(self): + """ + This method will override the Django get_queryset method to return a + list of all characters the user may access. + + Returns: + queryset (QuerySet): Django queryset for use in the given view. + + """ + account = self.request.user + + # Return a queryset consisting of characters the user is allowed to + # see. + ids = [obj.id for obj in self.model.objects.all() if obj.access(account, self.access_type)] + + return self.model.objects.filter(id__in=ids).order_by(Lower('db_key')) class CharacterDeleteView(CharacterMixin, ObjectDeleteView): From e9e7d8b9a5c7d28d736c4348689593482609a8b3 Mon Sep 17 00:00:00 2001 From: Johnny Date: Sun, 28 Oct 2018 22:57:34 +0000 Subject: [PATCH 155/187] Fixes #1723. --- evennia/web/utils/middleware.py | 7 +++--- evennia/web/webclient/views.py | 43 ++------------------------------- 2 files changed, 6 insertions(+), 44 deletions(-) diff --git a/evennia/web/utils/middleware.py b/evennia/web/utils/middleware.py index 3a60c3ca4f..16b7ee2091 100644 --- a/evennia/web/utils/middleware.py +++ b/evennia/web/utils/middleware.py @@ -15,15 +15,16 @@ class SharedLoginMiddleware(object): # Code to be executed for each request before # the view (and later middleware) are called. + # Synchronize credentials between webclient and website + # Must be performed *before* rendering the view (issue #1723) + self.make_shared_login(request) + # Process view response = self.get_response(request) # Code to be executed for each request/response after # the view is called. - # Synchronize credentials - self.make_shared_login(request) - # Return processed view return response diff --git a/evennia/web/webclient/views.py b/evennia/web/webclient/views.py index 439dd44ad2..de1bf8386b 100644 --- a/evennia/web/webclient/views.py +++ b/evennia/web/webclient/views.py @@ -12,52 +12,13 @@ from evennia.accounts.models import AccountDB from evennia.utils import logger -def _shared_login(request): - """ - Handle the shared login between website and webclient. - - """ - csession = request.session - account = request.user - # these can have 3 values: - # None - previously unused (auto-login) - # False - actively logged out (don't auto-login) - # - logged in User/Account id - website_uid = csession.get("website_authenticated_uid", None) - webclient_uid = csession.get("webclient_authenticated_uid", None) - - # check if user has authenticated to website - if not csession.session_key: - # this is necessary to build the sessid key - csession.save() - - if webclient_uid: - # The webclient has previously registered a login to this browser_session - if not account.is_authenticated() and not website_uid: - try: - account = AccountDB.objects.get(id=webclient_uid) - except AccountDB.DoesNotExist: - # this can happen e.g. for guest accounts or deletions - csession["website_authenticated_uid"] = False - csession["webclient_authenticated_uid"] = False - return - try: - # calls our custom authenticate in web/utils/backends.py - account = authenticate(autologin=account) - login(request, account) - csession["website_authenticated_uid"] = webclient_uid - except AttributeError: - logger.log_trace() - - def webclient(request): """ Webclient page template loading. """ - # handle webclient-website shared login - _shared_login(request) - + # auto-login is now handled by evennia.web.utils.middleware + # make sure to store the browser session's hash so the webclient can get to it! pagevars = {'browser_sessid': request.session.session_key} From aa0af2e5ccf41a1c094219c2acf2571b39eddef8 Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 29 Oct 2018 00:09:10 +0000 Subject: [PATCH 156/187] Fixes mispelling of my name :) / updates changelog to reflect recent web development efforts. --- CHANGELOG.md | 57 +++++++++++++++++++++++++++++++++++----------------- 1 file changed, 39 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8718fe5a4c..c730397003 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,22 +12,45 @@ ### Web -Web/Django standard initiative (stricako) -- Updates Bootstrap to v4 stable (the beta in use had some irritating bugs that have since been resolved) -- Enables the use of Django Messages framework -- Adds a web-based account registration form -- Adds links to reset password / create new account on login pane (resets require SMTP configuration to actually work, but the functionality was already enabled by account of django.contrib.auth.urls-- I just made it prettier). Uses Django's password reset workflow. -- Modifies the series of password reset forms to use Evennia's CSS instead of Django admin's. -- Adds a dropdown for authenticated users allowing them to change their password. -- Prettifies the "change password" form to use Evennia's CSS instead of Django admin's. -- Adds placeholders to dropdown menu for players to quickpuppet/manage characters on the website. -- Fixes a bug on the login pane where error messages weren't being displayed (was calling form.has_errors instead of just checking form.errors) -- Web-based chargen based on predefined form -- Character puppeting within the context of the website - -- Web views for common object types, like accounts, characters etc. -- Web views for help entries. - +Web/Django standard initiative (@strikaco) +- Features + - Adds a series of web-based forms and generic views + - Accounts + - Register - Enhances registration; allows optional collection of email address + - Form - Adds a generic Django form for creating Accounts from the web + - Characters + - Create - Authenticated users can create new characters from the website (requires associated form) + - Detail - Authenticated and authorized users can view select details about characters + - List - Authenticated and authorized users can browse a list of all characters + - Manage - Authenticated users can edit or delete owned characters from the web + - Form - Adds a generic Django form for creating characters from the web + - Channels + - Detail - Authorized users can view channel logs from the web + - List - Authorized users can browse a list of all channels + - Help Entries + - Detail - Authorized users can view help entries from the web + - List - Authorized users can browse a list of all help entries from the web + - Navbar changes + - Characters - Link to character list + - Channels - Link to channel list + - Help - Link to help entry list + - Puppeting + - Users can puppet their own characters within the context of the website + - Dropdown + - Link to create characters + - Link to manage characters + - Link to quick-select puppets + - Link to password change workflow +- Functions + - Updates Bootstrap to v4 stable + - Enables use of Django Messages framework to communicate with users in browser + - Implements webclient/website `_shared_login` functionality as Django middleware + - 'account' and 'puppet' are added to all request contexts for authenticated users +- Cosmetic + - Prettifies Django 'forgot password' workflow (requires SMTP to actually function) + - Prettifies Django 'change password' workflow +- Bugfixes + - Fixes bug on login page where error messages were not being displayed ### Typeclasses @@ -51,8 +74,6 @@ Web/Django standard initiative (stricako) + `validate_password`: Mechanism for validating a password. + `set_password`: Apply password to account, using validation checks. - - ### Utils - Added more unit tests. From e884ba72096dbbd4e8cd4809ce450fa83f449821 Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 29 Oct 2018 00:19:57 +0000 Subject: [PATCH 157/187] Update. --- CHANGELOG.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c730397003..78cdeed50b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,7 +14,7 @@ Web/Django standard initiative (@strikaco) - Features - - Adds a series of web-based forms and generic views + - Adds a series of web-based forms and generic class-based views - Accounts - Register - Enhances registration; allows optional collection of email address - Form - Adds a generic Django form for creating Accounts from the web @@ -46,6 +46,7 @@ Web/Django standard initiative (@strikaco) - Enables use of Django Messages framework to communicate with users in browser - Implements webclient/website `_shared_login` functionality as Django middleware - 'account' and 'puppet' are added to all request contexts for authenticated users + - Adds unit tests for all web views - Cosmetic - Prettifies Django 'forgot password' workflow (requires SMTP to actually function) - Prettifies Django 'change password' workflow @@ -54,13 +55,13 @@ Web/Django standard initiative (@strikaco) ### Typeclasses -- Add new methods on all typeclasses, useful specifically for viewing the object in the web/admin: - + `web_get_admin_url()`: Returns a path that, if followed, will display the object in the Admin backend. - + `web_get_create_url()`: Returns a path for a view allowing the creation of new instances of this object. - + `web_get_absolute_url()`: Django construct; returns a path that should display the object in a DetailView. - + `web_get_update_url()`: Returns a path that should display the object in an UpdateView. - + `web_get_delete_url()`: Returns a path that should display the object in a DeleteView. -- All typeclasses has new helper class method `create`, which encompasses useful functionality +- Add new methods on all typeclasses, useful specifically for object handling from the website/admin: + + `web_get_admin_url()`: Returns the path to the object detail page in the Admin backend. + + `web_get_create_url()`: Returns the path to the typeclass' creation page on the website, if implemented. + + `web_get_absolute_url()`: Returns the path to the object's detail page on the website, if implemented. + + `web_get_update_url()`: Returns the path to the object's update page on the website, if implemented. + + `web_get_delete_url()`: Returns the path to the object's delete page on the website, if implemented. +- All typeclasses have new helper class method `create`, which encompasses useful functionality that used to be embedded for example in the respective `@create` or `@connect` commands. - DefaultAccount now has new class methods implementing many things that used to be in unloggedin commands (these can now be customized on the class instead): @@ -68,10 +69,9 @@ Web/Django standard initiative (@strikaco) + `get_username_validators`: Return list of validators for username validation (see `settings.AUTH_USERNAME_VALIDATORS`) + `authenticate`: Method to check given username/password. - + `normalize_username`: Normalizes names so you can't fake names with similar-looking Unicode - chars. - + `validate_username`: Mechanism for validating a username. - + `validate_password`: Mechanism for validating a password. + + `normalize_username`: Normalizes names so (for Unicode environments) users cannot mimic existing usernames by replacing select characters with visually-similar Unicode chars. + + `validate_username`: Mechanism for validating a username based on predefined Django validators. + + `validate_password`: Mechanism for validating a password based on predefined Django validators. + `set_password`: Apply password to account, using validation checks. ### Utils From 6520f7109a20021745eff2176e5d6bb76d0c46ff Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 29 Oct 2018 00:33:42 +0000 Subject: [PATCH 158/187] Fixes spelling error. --- evennia/web/webclient/static/webclient/js/evennia.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/webclient/static/webclient/js/evennia.js b/evennia/web/webclient/static/webclient/js/evennia.js index 501a04021d..ddc6b792e4 100644 --- a/evennia/web/webclient/static/webclient/js/evennia.js +++ b/evennia/web/webclient/static/webclient/js/evennia.js @@ -102,7 +102,7 @@ An "emitter" object must have a function return; } this.connection.connect(); - log('Evenna reconnecting.') + log('Evennia reconnecting.') }, // Returns true if the connection is open. From 24643b1d3e889209f534a7c507cba27b92b16e9d Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 29 Oct 2018 00:34:12 +0000 Subject: [PATCH 159/187] Fixes alignment inconsistency in Accounts column. --- evennia/web/website/templates/website/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/website/templates/website/index.html b/evennia/web/website/templates/website/index.html index 1215e6bf08..06ece50f3c 100644 --- a/evennia/web/website/templates/website/index.html +++ b/evennia/web/website/templates/website/index.html @@ -52,7 +52,7 @@
    -

    Accounts

    +

    Accounts

    From 2eb04dcd2049a9e62923eccb57a22e6c8fba000d Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 29 Oct 2018 00:34:38 +0000 Subject: [PATCH 160/187] Fixes incorrect label on button. --- .../templates/website/registration/password_reset_form.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/website/templates/website/registration/password_reset_form.html b/evennia/web/website/templates/website/registration/password_reset_form.html index f13c532a58..eb73118856 100644 --- a/evennia/web/website/templates/website/registration/password_reset_form.html +++ b/evennia/web/website/templates/website/registration/password_reset_form.html @@ -34,7 +34,7 @@ Forgot Password

    - +
    From d6879c3ceffcae360e80d4eee98cb98b83eb2005 Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 29 Oct 2018 00:35:15 +0000 Subject: [PATCH 161/187] Adds link to return to index after forgot-password request. --- .../templates/website/registration/password_reset_done.html | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/evennia/web/website/templates/website/registration/password_reset_done.html b/evennia/web/website/templates/website/registration/password_reset_done.html index d248c56d0f..8de85a5ba3 100644 --- a/evennia/web/website/templates/website/registration/password_reset_done.html +++ b/evennia/web/website/templates/website/registration/password_reset_done.html @@ -25,6 +25,10 @@ Forgot Password - Reset Link Sent

    Please allow up to to a few hours for the email to transmit, and be sure to check your spam folder if it doesn't show up in a timely manner.

    +
    + +

    Click here to return to the main page.

    + {% endif %}
    From d70246d22f207b7fb2bbd4af54dd55eacdc451a6 Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sun, 28 Oct 2018 20:43:14 -0500 Subject: [PATCH 162/187] Assert protfuncs._obj_search is called ONLY when (), () and () are called. Group tests according to protfuncs._obj_search() calls --- evennia/prototypes/tests.py | 86 ++++++++++++++++++++++++++++++------- 1 file changed, 70 insertions(+), 16 deletions(-) diff --git a/evennia/prototypes/tests.py b/evennia/prototypes/tests.py index 6091c2a06f..ef09223cb1 100644 --- a/evennia/prototypes/tests.py +++ b/evennia/prototypes/tests.py @@ -11,6 +11,7 @@ from evennia.utils.test_resources import EvenniaTest from evennia.utils.tests.test_evmenu import TestEvMenu from evennia.prototypes import spawner, prototypes as protlib from evennia.prototypes import menus as olc_menus +from evennia.prototypes import protfuncs as protofuncs from evennia.prototypes.prototypes import _PROTOTYPE_TAG_META_CATEGORY @@ -344,23 +345,76 @@ class TestProtFuncs(EvenniaTest): self.assertEqual(protlib.protfunc_parser( "$eval({'test': '1', 2:3, 3: $toint(3.5)})"), {'test': '1', 2: 3, 3: 3}) - self.assertEqual(protlib.protfunc_parser("obj(#1)", session=self.session), 'obj(#1)') - self.assertEqual(protlib.protfunc_parser("$obj(#1)", session=self.session), '#1') - self.assertEqual(protlib.protfunc_parser("dbref(#1)", session=self.session), 'dbref(#1)') - self.assertEqual(protlib.protfunc_parser("$dbref(#1)", session=self.session), '#1') - self.assertEqual(protlib.protfunc_parser("$badfunc(#1)", session=self.session), '') - self.assertEqual(protlib.protfunc_parser("stone(#12345)", session=self.session), 'stone(#12345)') - self.assertEqual(protlib.protfunc_parser("#1", session=self.session), '#1') - self.assertEqual(protlib.protfunc_parser("#12345", session=self.session), '#12345') - self.assertEqual(protlib.protfunc_parser("nothing(#1)", session=self.session), 'nothing(#1)') - self.assertEqual(protlib.protfunc_parser("(#12345)", session=self.session), '(#12345)') - self.assertEqual(protlib.protfunc_parser("$obj(Char)", session=self.session), '#6') - self.assertEqual(protlib.protfunc_parser("obj(Char)", session=self.session), 'obj(Char)') - self.assertEqual(protlib.protfunc_parser("$objlist(#1)", session=self.session), ['#1']) - self.assertEqual(protlib.protfunc_parser("objlist(#1)", session=self.session), 'objlist(#1)') - self.assertEqual(protlib.protfunc_parser("dbref(Char)", session=self.session), 'dbref(Char)') - self.assertEqual(protlib.protfunc_parser("$dbref(Char)", session=self.session), '') + # no object search + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("obj(#1)", session=self.session), 'obj(#1)') + mocked__obj_search.assert_not_called() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("dbref(#1)", session=self.session), 'dbref(#1)') + mocked__obj_search.assert_not_called() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("stone(#12345)", session=self.session), 'stone(#12345)') + mocked__obj_search.assert_not_called() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("#1", session=self.session), '#1') + mocked__obj_search.assert_not_called() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("#12345", session=self.session), '#12345') + mocked__obj_search.assert_not_called() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("nothing(#1)", session=self.session), 'nothing(#1)') + mocked__obj_search.assert_not_called() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("(#12345)", session=self.session), '(#12345)') + mocked__obj_search.assert_not_called() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("obj(Char)", session=self.session), 'obj(Char)') + mocked__obj_search.assert_not_called() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("objlist(#1)", session=self.session), 'objlist(#1)') + mocked__obj_search.assert_not_called() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("dbref(Char)", session=self.session), 'dbref(Char)') + mocked__obj_search.assert_not_called() + + + # obj search happens + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("$objlist(#1)", session=self.session), ['#1']) + mocked__obj_search.assert_called_once() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("$obj(#1)", session=self.session), '#1') + mocked__obj_search.assert_called_once() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("$dbref(#1)", session=self.session), '#1') + mocked__obj_search.assert_called_once() + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("$obj(Char)", session=self.session), '#6') + mocked__obj_search.assert_called_once() + + + # bad invocation + + self.assertEqual(protlib.protfunc_parser("$badfunc(#1)", session=self.session), '') + + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("$dbref(Char)", session=self.session), '') + mocked__obj_search.assert_not_called() self.assertEqual(protlib.value_to_obj( From dab2e3c577614efc51ef76634b2352b31203e07e Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Sun, 28 Oct 2018 20:52:19 -0500 Subject: [PATCH 163/187] Harden mocked _obj_search() calls with passed in when applicable --- evennia/prototypes/tests.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/evennia/prototypes/tests.py b/evennia/prototypes/tests.py index ef09223cb1..38d577a408 100644 --- a/evennia/prototypes/tests.py +++ b/evennia/prototypes/tests.py @@ -394,23 +394,29 @@ class TestProtFuncs(EvenniaTest): with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: self.assertEqual(protlib.protfunc_parser("$objlist(#1)", session=self.session), ['#1']) mocked__obj_search.assert_called_once() + assert ('#1',) == mocked__obj_search.call_args[0] with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: self.assertEqual(protlib.protfunc_parser("$obj(#1)", session=self.session), '#1') mocked__obj_search.assert_called_once() + assert ('#1',) == mocked__obj_search.call_args[0] with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: self.assertEqual(protlib.protfunc_parser("$dbref(#1)", session=self.session), '#1') mocked__obj_search.assert_called_once() + assert ('#1',) == mocked__obj_search.call_args[0] with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: self.assertEqual(protlib.protfunc_parser("$obj(Char)", session=self.session), '#6') mocked__obj_search.assert_called_once() + assert ('Char',) == mocked__obj_search.call_args[0] # bad invocation - self.assertEqual(protlib.protfunc_parser("$badfunc(#1)", session=self.session), '') + with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: + self.assertEqual(protlib.protfunc_parser("$badfunc(#1)", session=self.session), '') + mocked__obj_search.assert_not_called() with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: self.assertEqual(protlib.protfunc_parser("$dbref(Char)", session=self.session), '') From de14d8621fc4d1e690d3dc26a4e67aa3b7ae6545 Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 29 Oct 2018 04:02:30 +0000 Subject: [PATCH 164/187] Modifies the login link to redirect the user to the current page after authentication. --- evennia/web/website/templates/website/_menu.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/website/templates/website/_menu.html b/evennia/web/website/templates/website/_menu.html index 69c06009d0..9f95ebb67f 100644 --- a/evennia/web/website/templates/website/_menu.html +++ b/evennia/web/website/templates/website/_menu.html @@ -72,7 +72,7 @@ folder and edit it to add/remove links to the menu. {% else %}
  • - Log In + Log In
  • Register From 77f46b54e2168095db0d6e4323d212cf781cb07c Mon Sep 17 00:00:00 2001 From: Johnny Date: Mon, 29 Oct 2018 09:12:55 +0000 Subject: [PATCH 165/187] Changes admin link. --- evennia/web/website/templates/website/help_list.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/website/templates/website/help_list.html b/evennia/web/website/templates/website/help_list.html index 99f1a27eef..d3075cd456 100644 --- a/evennia/web/website/templates/website/help_list.html +++ b/evennia/web/website/templates/website/help_list.html @@ -54,7 +54,7 @@
    {% if user.is_staff %} - Admin + Admin
    {% endif %} From 274cd7661a2cc333a667336ee03fb8334ae06733 Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 30 Oct 2018 01:38:54 +0000 Subject: [PATCH 166/187] Changes all reference from view.modelto view.typeclass. --- evennia/web/website/views.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/evennia/web/website/views.py b/evennia/web/website/views.py index 6a4274876f..4382793256 100644 --- a/evennia/web/website/views.py +++ b/evennia/web/website/views.py @@ -608,9 +608,9 @@ class CharacterListView(LoginRequiredMixin, CharacterMixin, ListView): # Return a queryset consisting of characters the user is allowed to # see. - ids = [obj.id for obj in self.model.objects.all() if obj.access(account, self.access_type)] + ids = [obj.id for obj in self.typeclass.objects.all() if obj.access(account, self.access_type)] - return self.model.objects.filter(id__in=ids).order_by(Lower('db_key')) + return self.typeclass.objects.filter(id__in=ids).order_by(Lower('db_key')) class CharacterPuppetView(LoginRequiredMixin, CharacterMixin, RedirectView, ObjectDetailView): @@ -705,9 +705,9 @@ class CharacterDetailView(CharacterMixin, ObjectDetailView): # Return a queryset consisting of characters the user is allowed to # see. - ids = [obj.id for obj in self.model.objects.all() if obj.access(account, self.access_type)] + ids = [obj.id for obj in self.typeclass.objects.all() if obj.access(account, self.access_type)] - return self.model.objects.filter(id__in=ids).order_by(Lower('db_key')) + return self.typeclass.objects.filter(id__in=ids).order_by(Lower('db_key')) class CharacterDeleteView(CharacterMixin, ObjectDeleteView): @@ -772,7 +772,7 @@ class CharacterCreateView(CharacterMixin, ObjectCreateView): # Channel views # -class ChannelMixin(object): +class ChannelMixin(TypeclassMixin): """ This is a "mixin", a modifier of sorts. @@ -802,13 +802,13 @@ class ChannelMixin(object): account = self.request.user # Get list of all Channels - channels = self.model.objects.all().iterator() + channels = self.typeclass.objects.all().iterator() # Now figure out which ones the current user is allowed to see bucket = [channel.id for channel in channels if channel.access(account, 'listen')] # Re-query and set a sorted list - filtered = self.model.objects.filter( + filtered = self.typeclass.objects.filter( id__in=bucket ).order_by( Lower('db_key') @@ -934,7 +934,7 @@ class ChannelDetailView(ChannelMixin, ObjectDetailView): # Help views # -class HelpMixin(object): +class HelpMixin(TypeclassMixin): """ This is a "mixin", a modifier of sorts. @@ -960,13 +960,13 @@ class HelpMixin(object): account = self.request.user # Get list of all HelpEntries - entries = self.model.objects.all().iterator() + entries = self.typeclass.objects.all().iterator() # Now figure out which ones the current user is allowed to see bucket = [entry.id for entry in entries if entry.access(account, 'view')] # Re-query and set a sorted list - filtered = self.model.objects.filter( + filtered = self.typeclass.objects.filter( id__in=bucket ).order_by( Lower('db_key') From 12d55df2684e8c8b5082358778056f4eec09e13c Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 30 Oct 2018 06:46:52 +0000 Subject: [PATCH 167/187] Removes 'safe' template tag from help detail page (vulnerability). --- evennia/web/website/templates/website/help_detail.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/website/templates/website/help_detail.html b/evennia/web/website/templates/website/help_detail.html index 44e42e0743..e221956c7c 100644 --- a/evennia/web/website/templates/website/help_detail.html +++ b/evennia/web/website/templates/website/help_detail.html @@ -25,7 +25,7 @@
    -

    {{ entry_text|safe }}

    +

    {{ entry_text }}

    {% if topic_previous or topic_next %}
    From cd9e3bfb10c1796251735746778905b032923c84 Mon Sep 17 00:00:00 2001 From: Johnny Date: Tue, 30 Oct 2018 20:14:58 +0000 Subject: [PATCH 168/187] Returns 404 if webclient is supposed to be disabled. --- evennia/web/webclient/views.py | 6 ++++++ evennia/web/website/tests.py | 12 ++++++++++++ 2 files changed, 18 insertions(+) diff --git a/evennia/web/webclient/views.py b/evennia/web/webclient/views.py index de1bf8386b..6bbb5b6a64 100644 --- a/evennia/web/webclient/views.py +++ b/evennia/web/webclient/views.py @@ -5,6 +5,8 @@ page and serve it eventual static content. """ from __future__ import print_function +from django.conf import settings +from django.http import Http404 from django.shortcuts import render from django.contrib.auth import login, authenticate @@ -19,6 +21,10 @@ def webclient(request): """ # auto-login is now handled by evennia.web.utils.middleware + # check if webclient should be enabled + if not settings.WEBCLIENT_ENABLED: + raise Http404 + # make sure to store the browser session's hash so the webclient can get to it! pagevars = {'browser_sessid': request.session.session_key} diff --git a/evennia/web/website/tests.py b/evennia/web/website/tests.py index 95f9b6217b..4175dc22fc 100644 --- a/evennia/web/website/tests.py +++ b/evennia/web/website/tests.py @@ -94,6 +94,18 @@ class PasswordResetTest(EvenniaWebTest): class WebclientTest(EvenniaWebTest): url_name = 'webclient:index' + @override_settings(WEBCLIENT_ENABLED=True) + def test_get(self): + self.authenticated_response = 200 + self.unauthenticated_response = 200 + super(WebclientTest, self).test_get() + + @override_settings(WEBCLIENT_ENABLED=False) + def test_get_disabled(self): + self.authenticated_response = 404 + self.unauthenticated_response = 404 + super(WebclientTest, self).test_get() + class ChannelListTest(EvenniaWebTest): url_name = 'channels' From 07364852986753ba51a3db9a0b39ea38c446016a Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Tue, 30 Oct 2018 19:50:40 -0500 Subject: [PATCH 169/187] Remove prototypes._RE_DBREF and add new dbref() to protfuncs --- evennia/prototypes/protfuncs.py | 13 ++++++++++++ evennia/prototypes/prototypes.py | 6 ------ evennia/prototypes/tests.py | 34 +------------------------------- 3 files changed, 14 insertions(+), 39 deletions(-) diff --git a/evennia/prototypes/protfuncs.py b/evennia/prototypes/protfuncs.py index a13aa7e532..1c7923c561 100644 --- a/evennia/prototypes/protfuncs.py +++ b/evennia/prototypes/protfuncs.py @@ -37,6 +37,7 @@ prototype key (this value must be possible to serialize in an Attribute). from ast import literal_eval from random import randint as base_randint, random as base_random, choice as base_choice +import re from evennia.utils import search from evennia.utils.utils import justify as base_justify, is_iter, to_str @@ -325,3 +326,15 @@ def objlist(*args, **kwargs): """ return ["#{}".format(obj.id) for obj in _obj_search(return_list=True, *args, **kwargs)] + + +def dbref(*args, **kwargs): + """ + Usage $dbref(<#dbref>) + Returns one Object searched globally by #dbref. Error if #dbref is invalid. + """ + _RE_DBREF = re.compile(r"\#[0-9]+") + if not args or len(args) < 1 or _RE_DBREF.match(args[0]) is None: + raise ValueError('$dbref requires a valid #dbref argument.') + + return obj(args[0]) diff --git a/evennia/prototypes/prototypes.py b/evennia/prototypes/prototypes.py index 020c6c84cf..a3281777e0 100644 --- a/evennia/prototypes/prototypes.py +++ b/evennia/prototypes/prototypes.py @@ -5,7 +5,6 @@ Handling storage of prototypes, both database-based ones (DBPrototypes) and thos """ -import re import hashlib import time from ast import literal_eval @@ -33,8 +32,6 @@ _PROTOTYPE_TAG_CATEGORY = "from_prototype" _PROTOTYPE_TAG_META_CATEGORY = "db_prototype" PROT_FUNCS = {} -_RE_DBREF = re.compile(r"\$dbref\((\#[0-9]+)\)") - class PermissionError(RuntimeError): pass @@ -576,9 +573,6 @@ def protfunc_parser(value, available_functions=None, testing=False, stacktrace=F available_functions = PROT_FUNCS if available_functions is None else available_functions - # $dbref(#Number) becomes $obj(#Number) - value = _RE_DBREF.sub("$obj(\\1)", value) - result = inlinefuncs.parse_inlinefunc( value, available_funcs=available_functions, stacktrace=stacktrace, testing=testing, **kwargs) diff --git a/evennia/prototypes/tests.py b/evennia/prototypes/tests.py index 38d577a408..59fb69ca3e 100644 --- a/evennia/prototypes/tests.py +++ b/evennia/prototypes/tests.py @@ -263,38 +263,6 @@ class TestProtFuncs(EvenniaTest): "prototype_desc": "testing prot", "key": "ExampleObj"} - def test_RE_DBREF(self): - def check_RE_DBREF(value, expected_value, - exp_is_match, exp_is_search): - try: - mm = protlib._RE_DBREF.match(value) - ms = protlib._RE_DBREF.search(value) - sub1 = protlib._RE_DBREF.sub("$obj(\\1)", value) - assert expected_value == sub1 - assert (exp_is_match and mm) or (not exp_is_match and mm is None) - assert (exp_is_search and ms) or (not exp_is_search and ms is None) - except Exception as e: - self.fail("%r" % ((value, mm, ms, expected_value, exp_is_match, exp_is_search, e),)) - - check_RE_DBREF('1234', '1234', False, False) - check_RE_DBREF('#1234', '#1234', False, False) - check_RE_DBREF('(#1234)', '(#1234)', False, False) - check_RE_DBREF('obj(#1234)', 'obj(#1234)', False, False) - check_RE_DBREF('dbref(#1234)', 'dbref(#1234)', False, False) - check_RE_DBREF('$obj(#1234)', '$obj(#1234)', False, False) - check_RE_DBREF('$dbref(#1234)', '$obj(#1234)', True, True) - check_RE_DBREF('obj($obj(#1234))', 'obj($obj(#1234))', False, False) - check_RE_DBREF('obj($dbref(#1234))', 'obj($obj(#1234))', False, True) - check_RE_DBREF('some #1234 value', 'some #1234 value', False, False) - check_RE_DBREF('some (#1234) value', 'some (#1234) value', False, False) - check_RE_DBREF('some obj(#1234) value', 'some obj(#1234) value', False, False) - check_RE_DBREF('some dbref(#1234) value', 'some dbref(#1234) value', False, False) - check_RE_DBREF('some $dbref(#1234) value', 'some $obj(#1234) value', False, True) - check_RE_DBREF('some obj($obj(#1234) value)', 'some obj($obj(#1234) value)', False, False) - check_RE_DBREF('some obj($dbref(#1234) value)', 'some obj($obj(#1234) value)', False, True) - check_RE_DBREF('some dbref($obj(#1234) value)', 'some dbref($obj(#1234) value)', False, False) - check_RE_DBREF('some dbref($dbref(#1234) value)', 'some dbref($obj(#1234) value)', False, True) - @mock.patch("evennia.prototypes.protfuncs.base_random", new=mock.MagicMock(return_value=0.5)) @mock.patch("evennia.prototypes.protfuncs.base_randint", new=mock.MagicMock(return_value=5)) def test_protfuncs(self): @@ -419,7 +387,7 @@ class TestProtFuncs(EvenniaTest): mocked__obj_search.assert_not_called() with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: - self.assertEqual(protlib.protfunc_parser("$dbref(Char)", session=self.session), '') + # self.assertEqual(protlib.protfunc_parser("$dbref(Char)", session=self.session), '') mocked__obj_search.assert_not_called() From 419045fef4b19c04efe740008aabf7d7e55014da Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Tue, 30 Oct 2018 20:10:36 -0500 Subject: [PATCH 170/187] Update test --- evennia/prototypes/tests.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/prototypes/tests.py b/evennia/prototypes/tests.py index 59fb69ca3e..e8ef8a4e6b 100644 --- a/evennia/prototypes/tests.py +++ b/evennia/prototypes/tests.py @@ -387,7 +387,7 @@ class TestProtFuncs(EvenniaTest): mocked__obj_search.assert_not_called() with mock.patch("evennia.prototypes.protfuncs._obj_search", wraps=protofuncs._obj_search) as mocked__obj_search: - # self.assertEqual(protlib.protfunc_parser("$dbref(Char)", session=self.session), '') + self.assertRaises(ValueError, protlib.protfunc_parser, "$dbref(Char)") mocked__obj_search.assert_not_called() From 70eeb6f6be4167e25c2a26812b9589cbbaccab6c Mon Sep 17 00:00:00 2001 From: Henddher Pedroza Date: Mon, 5 Nov 2018 18:44:12 -0600 Subject: [PATCH 171/187] Move regex out of protofunc to prevent recompilation on each call. --- evennia/prototypes/protfuncs.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/evennia/prototypes/protfuncs.py b/evennia/prototypes/protfuncs.py index 1c7923c561..e222876221 100644 --- a/evennia/prototypes/protfuncs.py +++ b/evennia/prototypes/protfuncs.py @@ -44,6 +44,8 @@ from evennia.utils.utils import justify as base_justify, is_iter, to_str _PROTLIB = None +_RE_DBREF = re.compile(r"\#[0-9]+") + # default protfuncs @@ -333,7 +335,6 @@ def dbref(*args, **kwargs): Usage $dbref(<#dbref>) Returns one Object searched globally by #dbref. Error if #dbref is invalid. """ - _RE_DBREF = re.compile(r"\#[0-9]+") if not args or len(args) < 1 or _RE_DBREF.match(args[0]) is None: raise ValueError('$dbref requires a valid #dbref argument.') From 40b8108ef5e578c3592875ba5b7155db70cba6be Mon Sep 17 00:00:00 2001 From: Nicholas Date: Tue, 6 Nov 2018 18:24:24 -0500 Subject: [PATCH 172/187] split.min.js path update --- evennia/web/webclient/templates/webclient/base.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/web/webclient/templates/webclient/base.html b/evennia/web/webclient/templates/webclient/base.html index 1b506c8cd5..176ef0d160 100644 --- a/evennia/web/webclient/templates/webclient/base.html +++ b/evennia/web/webclient/templates/webclient/base.html @@ -64,7 +64,7 @@ JQuery available. - + From 65387c59aea0425df79a975b580baba483925c2e Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 7 Nov 2018 20:44:48 +0000 Subject: [PATCH 173/187] Adds delete() lock to characters by default. --- evennia/commands/default/account.py | 10 ++++++++-- evennia/commands/default/tests.py | 26 ++++++++++++++++++++++++++ evennia/objects/objects.py | 2 +- 3 files changed, 35 insertions(+), 3 deletions(-) diff --git a/evennia/commands/default/account.py b/evennia/commands/default/account.py index 7eda54e75c..5d3b22f090 100644 --- a/evennia/commands/default/account.py +++ b/evennia/commands/default/account.py @@ -162,8 +162,8 @@ class CmdCharCreate(COMMAND_DEFAULT_CLASS): home=default_home, permissions=permissions) # only allow creator (and developers) to puppet this char - new_character.locks.add("puppet:id(%i) or pid(%i) or perm(Developer) or pperm(Developer)" % - (new_character.id, account.id)) + new_character.locks.add("puppet:id(%i) or pid(%i) or perm(Developer) or pperm(Developer);delete:id(%i) or perm(Admin)" % + (new_character.id, account.id, account.id)) account.db._playable_characters.append(new_character) if desc: new_character.db.desc = desc @@ -222,6 +222,12 @@ class CmdCharDelete(COMMAND_DEFAULT_CLASS): match = match[0] account.ndb._char_to_delete = match + + # Return if caller has no permission to delete this + if not match.access(account, 'delete'): + self.msg("You do not have permission to delete this character.") + return + prompt = "|rThis will permanently destroy '%s'. This cannot be undone.|n Continue yes/[no]?" get_input(account, prompt % match.key, _callback) diff --git a/evennia/commands/default/tests.py b/evennia/commands/default/tests.py index 5d2e67ede9..8f9de29ef1 100644 --- a/evennia/commands/default/tests.py +++ b/evennia/commands/default/tests.py @@ -283,6 +283,32 @@ class TestAccount(CommandTest): def test_char_create(self): self.call(account.CmdCharCreate(), "Test1=Test char", "Created new character Test1. Use @ic Test1 to enter the game", caller=self.account) + + def test_char_delete(self): + # Chardelete requires user input; this test is mainly to confirm + # whether permissions are being checked + + # Add char to account playable characters + self.account.db._playable_characters.append(self.char1) + + # Try deleting as Developer + self.call(account.CmdCharDelete(), "Char", "This will permanently destroy 'Char'. This cannot be undone. Continue yes/[no]?", caller=self.account) + + # Downgrade permissions on account + self.account.permissions.add('Player') + self.account.permissions.remove('Developer') + + # Set lock on character object to prevent deletion + self.char1.locks.add('delete:none()') + + # Try deleting as Player + self.call(account.CmdCharDelete(), "Char", "You do not have permission to delete this character.", caller=self.account) + + # Set lock on character object to allow self-delete + self.char1.locks.add('delete:pid(%i)' % self.account.id) + + # Try deleting as Player again + self.call(account.CmdCharDelete(), "Char", "This will permanently destroy 'Char'. This cannot be undone. Continue yes/[no]?", caller=self.account) def test_quell(self): self.call(account.CmdQuell(), "", "Quelling to current puppet's permissions (developer).", caller=self.account) diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 0dca98ef75..f44df73df8 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -1894,7 +1894,7 @@ class DefaultCharacter(DefaultObject): """ # lockstring of newly created rooms, for easy overloading. # Will be formatted with the appropriate attributes. - lockstring = "puppet:id({character_id}) or pid({account_id}) or perm(Developer) or pperm(Developer)" + lockstring = "puppet:id({character_id}) or pid({account_id}) or perm(Developer) or pperm(Developer);delete:id({account_id}) or perm(Admin)" @classmethod def create(cls, key, account, **kwargs): From 2748c94be631cd07ce796f861c5b1beffb63f849 Mon Sep 17 00:00:00 2001 From: Johnny Date: Wed, 7 Nov 2018 21:26:34 +0000 Subject: [PATCH 174/187] Adds public point of contact email to settings and unloggedin help command. --- evennia/commands/default/unloggedin.py | 3 +++ evennia/settings_default.py | 3 +++ 2 files changed, 6 insertions(+) diff --git a/evennia/commands/default/unloggedin.py b/evennia/commands/default/unloggedin.py index 607c95439b..07cf8e36f2 100644 --- a/evennia/commands/default/unloggedin.py +++ b/evennia/commands/default/unloggedin.py @@ -276,6 +276,9 @@ Next you can connect to the game: |wconnect Anna c67jHL8p|n You can use the |wlook|n command if you want to see the connect screen again. """ + + if settings.STAFF_CONTACT_EMAIL: + string += 'For support, please contact: %s' % settings.STAFF_CONTACT_EMAIL self.caller.msg(string) diff --git a/evennia/settings_default.py b/evennia/settings_default.py index d6a1d0c82e..6fb053f1a7 100644 --- a/evennia/settings_default.py +++ b/evennia/settings_default.py @@ -670,6 +670,9 @@ DEBUG = False ADMINS = () # 'Your Name', 'your_email@domain.com'),) # These guys get broken link notifications when SEND_BROKEN_LINK_EMAILS is True. MANAGERS = ADMINS +# This is a public point of contact for players or the public to contact +# a staff member or administrator of the site. It is publicly posted. +STAFF_CONTACT_EMAIL = None # Absolute path to the directory that holds file uploads from web apps. # Example: "/home/media/media.lawrence.com" MEDIA_ROOT = os.path.join(GAME_DIR, "web", "media") From 9d3938d0f5320f195aa282554e21d5cea03bc283 Mon Sep 17 00:00:00 2001 From: Vincent Le Goff Date: Wed, 21 Nov 2018 16:11:44 +0100 Subject: [PATCH 175/187] Fix slight bugs that prevent a frozen version --- evennia/__init__.py | 2 +- evennia/server/evennia_launcher.py | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/evennia/__init__.py b/evennia/__init__.py index e04ab84dba..ab23ff7abf 100644 --- a/evennia/__init__.py +++ b/evennia/__init__.py @@ -105,7 +105,7 @@ def _create_version(): print(err) try: version = "%s (rev %s)" % (version, check_output("git rev-parse --short HEAD", shell=True, cwd=root, stderr=STDOUT).strip()) - except (IOError, CalledProcessError): + except (IOError, CalledProcessError, WindowsError): # ignore if we cannot get to git pass return version diff --git a/evennia/server/evennia_launcher.py b/evennia/server/evennia_launcher.py index 50c355dc58..07bfe45e98 100644 --- a/evennia/server/evennia_launcher.py +++ b/evennia/server/evennia_launcher.py @@ -98,7 +98,10 @@ TWISTED_MIN = '18.0.0' DJANGO_MIN = '1.11' DJANGO_REC = '1.11' -sys.path[1] = EVENNIA_ROOT +try: + sys.path[1] = EVENNIA_ROOT +except IndexError: + sys.path.append(EVENNIA_ROOT) # ------------------------------------------------------------ # @@ -1214,7 +1217,7 @@ def evennia_version(): "git rev-parse --short HEAD", shell=True, cwd=EVENNIA_ROOT, stderr=STDOUT).strip() version = "%s (rev %s)" % (version, rev) - except (IOError, CalledProcessError): + except (IOError, CalledProcessError, WindowsError): # move on if git is not answering pass return version From 354b54d369e1e99b2cfc8bb13fb81e6382c9fa6c Mon Sep 17 00:00:00 2001 From: Vincent Le Goff Date: Thu, 22 Nov 2018 08:46:54 +0100 Subject: [PATCH 176/187] Allow the 'makemessages' and 'compilemessages' commands --- evennia/server/evennia_launcher.py | 23 +++++++++++++++++++---- evennia/settings_default.py | 2 +- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/evennia/server/evennia_launcher.py b/evennia/server/evennia_launcher.py index 50c355dc58..d4e1d95011 100644 --- a/evennia/server/evennia_launcher.py +++ b/evennia/server/evennia_launcher.py @@ -1641,7 +1641,7 @@ def error_check_python_modules(): # # ------------------------------------------------------------ -def init_game_directory(path, check_db=True): +def init_game_directory(path, check_db=True, need_gamedir=True): """ Try to analyze the given path to find settings.py - this defines the game directory and also sets PYTHONPATH as well as the django @@ -1650,15 +1650,17 @@ def init_game_directory(path, check_db=True): Args: path (str): Path to new game directory, including its name. check_db (bool, optional): Check if the databae exists. + need_gamedir (bool, optional): set to False if Evennia doesn't require to be run in a valid game directory. """ # set the GAMEDIR path - set_gamedir(path) + if need_gamedir: + set_gamedir(path) # Add gamedir to python path sys.path.insert(0, GAMEDIR) - if TEST_MODE: + if TEST_MODE or not need_gamedir: if ENFORCED_SETTING: print(NOTE_TEST_CUSTOM.format(settings_dotpath=SETTINGS_DOTPATH)) os.environ['DJANGO_SETTINGS_MODULE'] = SETTINGS_DOTPATH @@ -1685,6 +1687,10 @@ def init_game_directory(path, check_db=True): if check_db: check_database() + # if we don't have to check the game directory, return right away + if not need_gamedir: + return + # set up the Evennia executables and log file locations global AMP_PORT, AMP_HOST, AMP_INTERFACE global SERVER_PY_FILE, PORTAL_PY_FILE @@ -2088,6 +2094,10 @@ def main(): elif option != "noop": # pass-through to django manager check_db = False + need_gamedir = True + # some commands don't require the presence of a game directory to work + if option in ('makemessages', 'compilemessages'): + need_gamedir = False # handle special django commands if option in ('runserver', 'testserver'): @@ -2100,7 +2110,7 @@ def main(): global TEST_MODE TEST_MODE = True - init_game_directory(CURRENT_DIR, check_db=check_db) + init_game_directory(CURRENT_DIR, check_db=check_db, need_gamedir=need_gamedir) # pass on to the manager args = [option] @@ -2116,6 +2126,11 @@ def main(): kwargs[arg.lstrip("--")] = value else: args.append(arg) + + # makemessages needs a special syntax to not conflict with the -l option + if len(args) > 1 and args[0] == "makemessages": + args.insert(1, "-l") + try: django.core.management.call_command(*args, **kwargs) except django.core.management.base.CommandError as exc: diff --git a/evennia/settings_default.py b/evennia/settings_default.py index d868898861..8c172d02f0 100644 --- a/evennia/settings_default.py +++ b/evennia/settings_default.py @@ -115,7 +115,7 @@ AMP_INTERFACE = '127.0.0.1' EVENNIA_DIR = os.path.dirname(os.path.abspath(__file__)) # Path to the game directory (containing the server/conf/settings.py file) # This is dynamically created- there is generally no need to change this! -if sys.argv[1] == 'test' if len(sys.argv) > 1 else False: +if EVENNIA_DIR.lower() == os.getcwd().lower() or (sys.argv[1] == 'test' if len(sys.argv) > 1 else False): # unittesting mode GAME_DIR = os.getcwd() else: From 1ae112cbce83cf2c2e2f5a8f7f4697ca45d290a7 Mon Sep 17 00:00:00 2001 From: Vincent Le Goff Date: Thu, 22 Nov 2018 10:17:52 +0100 Subject: [PATCH 177/187] Update the fr translation --- evennia/locale/fr/LC_MESSAGES/django.mo | Bin 5447 -> 5525 bytes evennia/locale/fr/LC_MESSAGES/django.po | 599 ++++++++++++++---------- 2 files changed, 346 insertions(+), 253 deletions(-) diff --git a/evennia/locale/fr/LC_MESSAGES/django.mo b/evennia/locale/fr/LC_MESSAGES/django.mo index b2c14fb1b9f0ecca789b424fae555ff6a95c2651..b16ad24fa011131aa7c6638e1970c2d15ca70c11 100644 GIT binary patch literal 5525 zcmcha-ESOM8OBecA9R62TUx$KbJAjVmv}dJ+N5FAq!LM70yYh?Q>Y4*J0dockqwvH}6#H68Ky2dGP+*m1=+vd=R_| zehPdUJPZB~`~Z0O9rg2v!IJxv;0M9iz$4%3;CWEixiZE+ z_;K!E0*`|~1~vFc@JaA3a0Wbnmr^XLu7WM_dGM3qH^8rgKOg^o&%2a*j{7ITliAH4lEj{iU=zF!3Z>r# z7s2m?pM~o;L0P~19;Lnx-UQiN{R{jsc*lF|^Bn<&-!Fs0;}1bu|8?+Z;GaR^=Ub5X z82D3A?D;D=2j0oyPJvH=9|dzz?E3cj{&jGP``?f8Ar2+HTmu)tSHKSVcMz)81NYYJ zJp|5kzYM0}H^I~3Tj1BgWB1kZ@f}e3`V}bg^(H9sbL4)d2H+_$2Y&?0xO;H^G4L2D z=lvqs1|2AN{Q#8n{{d`){{)5KhaXVNgGWK=RnQpb2^SJykMNOemXGlKA-Ne}vY%X- z5H8_guA_WpkI5zWkq+S!8-&Mq^TCzjl6dBLA)e%na$%l=5~cabB|eZ#&PK>6+@~-( z#3~er3)h8MCZ)pJ2;C5S@=$yrdGrxJ;&;{1&6(D9yV>?l-I{6T_D1>vwEggKk#j@C*OMf8e1Q=y=q)63Rh^GN3N1tHr8w0M_KG`sZFVerX1+z zmcVwi+qhzfsfm)juQw7NteG@jHPLlOOuoJ_8LD(E8kjt{X8+?L3Y(YP%-rJq+qzZHJUDum zS+>Z0SzzpT`&_S~Wk%RS=_RwdYW1e8bY@Ln>KXr((kpDK9~szm_(&i@zID}%*9(Qq zw9(L$CAmp;lqMK48|FtQ*CzE&SKcyaI4BHX+?vj+v`mJn)f=vey-wD`aEMMF1ImGg zTJPndPI4W)YL&4sR<5+ZtIpTN;buIXyApe<9Ky~IoXloVH!Kqe6uK-nbyI9@^4w*a z$>Vxn;=@$4Zj#in`t-5y=_fOrSK~#_&1#uGnSA)uS!_$nJ!5W}BDd2qRT|e;Cu3V= z>wQ1QcFjPL9=OcvX6wXRXRv z11E;D2fZajKZ7?@l7>+;Ew_5Djdx5GS?{&PywrjE_650>dLTI`DYYg+%VY1VA_`A9 zCHH+Ng`ugjq%Y%OFATM*w;Ka0Kv!Sbf5IgRl>_8z47St&jFSLOGGZM!kk=BFks%*q zaaA~YmyEkEaqGf_XyB5FcwBOYq=JNVZgpnLh?2tWKuC)PC6{sobsL(R(YIy0*HE8# z5bdKP2`SK3&*bT*KA*+Qw)AYAYf{_9_)7dLiB>z5ZG_6BYT0b+je#kjQp;fxm<_d* zC~U>6N!<2rN#F^;kpvTrLHwl3w%YZvgip@L!>(E;lFLD;jIf|L3YYhf>gOmihC{|x zHVkBAQtrk)9}MUftmSM(mI;v&JL@GM>bG2!B^SE_rmm zt0sGkd&Uu4b22W=f#&_gq+}+g_z*k2C40dG!*TDx6r>^>Q644ASFNRpVR_*;rLsqr zFNwcB)mcJ#+*X=f^_T6Ya)sI|S;|Tm*&cVJ)R|a_oDQ#BN~5(h8L2neGpz%7OH!1U zk`1@p>T=<(k(r%KapzfEc(SXfrD?gM>@4|y5_djb^?hf>@$=C)20T`T9ia}5ayf~O;$s7JrKQ68t=Ci$5_ zI34-y)s=D_U%*P1Ol7wO+ZSx=u{P0GgQv?@&6S)hbcFY;ly^=D6<(e>A}tz4he z^X)T@FLj=-3!j*K+1WTL^?dhapx(GEHQ zqw}&D?O0q{cyc5hvmeSxxT{sjuKHM<rMQdch7Wa(~^GOr7YHuo#opSz@%)H+6wVQ;l|_M5;uESH_A(TtVBU zauFgv!BL*>OF@Osp<#wcugDCD9zrX9aP+F=Amd)F*wa!rCX0zLpdE9?xmen-l2mpt zr2{fpTv1nfEbulH?SmYu>zplu&>`Qv$8s@pqIN1-w&2H6HF3FC=vd{%12{;t|;2S4(NpGr>LM0?S`_OC|UmC2Gng=R}X z6=BcX;L4lQQACY}D5~`sElLzrh5PoTyRV&4xETG&vQ#XMc_IOB+@jX@+t45FkckBw z$nd%pK*HX<7V{6hc&H1b9g3!on{-hG)_NkleX9$OchI>g`TDsOa)T!|!QgQi_a`BxfnuWn=P;+@4CjpgrOy(oT}> zpvWWAMdr!5f(G0bd81ck_*mqjy2s~)4GA?|&aNK$C}-C&HDy9piY$@Si4yYfFc0b7 z6D1T^Dks?}j6&QhuSBAq$#|@iy=uC;dch=+N8zY95039DS`>|p(ST1YopiX=;j(?UW%Ea*@T!H z%R+rreStDY$xQc^;isft)nfB7od{{S>O@%BZEbs)prg^Q<)wQ3u8xW%es>il`=_Cl z4#GPgdN@UXRfY7UqnZvO^__op8MrA&$Y9M@;<~(&q?dH>>bIApluLM;N=+%1iFD+= zg2zj#-sB*=y&!UQZz-ZAFs~o@sjf@%vKrz%ZC0VMh6)h$XRtVLLcENp3Wr#W#LL3| zvtXG nYRmeINYQGa6#dU7>}`paM(YYyMCuoG$vM(yoe=nZpJM$tGu4O) literal 5447 zcmchbOKc=Z8OJMRfn*X$2yX~byTQy%*3*7KHeoiqWaD)bhjn7s-VJbI)ze)w(@sAo zUELl#mLnmM!U-hMiUSw8pcsh*5)v=LWx|aUH#i_74hX~ri6aMoUv-b|T`vjAf!2=y zUENh*eee4B{^`CG*A>@ke)sb$Zd2+k_`A39hwJCJE42dt0{jqo`w695;QgS?TLvEo zzX~?NSHTP5Kfr&3-rJRGfT!P~)Ca&b;Ag>A@ErIu_&)Hr_4_}9A7}i}`uV-@RO*wA zXTUk|X;6bNf}a4t2hM=M0@+Hv2A%}}3VsT_^A4pR1?Rygn1G`Hb?`y(H{e&mztzv5 zy0hBn1@Qem{{i@U@Mqvf@OF$5{hk8FUjy)7@av%Hc^wpeehJEce+I>scig4a!{A-u z)A)EvknuO~uIBv#6uoYHms0ECgEhVcE-?N*DEpsyw^HX>zXBp!ed8XbJ`8>b6gz(m zieLW@ieFnOCwiU(9{|4$N*rDSJ@7hs0elq{{onDP%73T94&zl2SE}85{55cn@lQbU z%WL2Q*tt)sMerIp4}Ker!3ik)&c9cwF1P{8{@(&u!5@Na;J-l8a~Y*Yj~<8#>Sa*; z`P~|S4T_)s0*YVnCP?DfdqCXce8H9q_qvO)9bC9feUKkZos0+TH>9?^B;M1jUEfH~ zOP-yq$GFK|ALZ{y>U&aE;RdDavE&`*I6LK$_)l_1^5GOeu}gCGG(Wk-KDj=|?*u=I ztJp@!oli(jMS8ePd@24>4c(k+J#Ti}wy9e)t<-E6*K#v5e$lpbGp#5sOupsEZ9A)H zTGb2Nwt9NkDMbano+q+ar6a#`;cL_}kTnCJnMuoPu6;JA`k&OyHEQ(QgZf-mtd#0M^ zAwfrd5x{yAHijl1&FZnA79uyuQvBR23o|Rx%JM=-)|SR<+`3uXLT_dmUknXXlcY?e zV#jM-uzD@_cTBDySa6a9Kh;4_IvDK}(6^3zaH zr(7Fnc^rDZGK$09)N5!irCY(!Pg4`OmG(SOuajWxmm6F7d0|3N=|@*hKEMIHiC`Sr zVz0h0c1C7zR*&*1BX0cNJKxp2L7C?!E%sQsOD^x}R<-i@>{(WsJh8YY9qhHwcN=#4nVlGMJ)(C5%bLC^1=CXtN!VN+z7u zVPvOL(t)QgMM*DHm$KmbuCvDFmmj5KIrnjv>Qc-Os66 zUR#PjF!F{3av@pv|+kuD|Sx+$!dA|-MCkjRNd zSJbXqvahImQq@)6Gtx*y6B}1)>p>ok$n)w1AO%}tFACeXEq@`)EtKES3nlv=H z<*~yZcR6UrBY!{xZc)*>rf}O`o=z26%QLCo&Pv$1YH~}yc6H;j>)f4HJBY&0 zUhb#1Z}QGE$D^FxUHwQeDjI8Xnfr0)3Hll#NJnmH&n=$S)$O@fs?Y0%_SwcI-?E*E ziG9u+Y@Vvv*)V>>_=}w}s8 z0ZF@&qzlSgvO|ZH{X>$oY^}dD+1D1GweX$EE0B%jBnRGLkil|}OX!XZ;+)x@><6XG z`8dmwUOLwfOd`c3liz^+h|Jep+0|?0wFnXxbVT0ku%W4*RL3zzZo!KVEvx#gkij=? z%HxqqAvh)86-O47S(=qw#xM1zDK*SUe2lS2_>!(!l6mpJ@gy7Rt&E`gTg>Sh3-xJ) zO`j8HR!`qCA?7Woo+C~shdB8oVNO&ly#Usc_2S7ZiEyY=_x(un0nQRh&(g6k0fk8U zWii?J8q1I?ArUWN%F|gXzJyabEl48KBgiNFh%Qs3U(EP}5Hjk3Vi_pbmI>YrySg>G zVrS?nlKq?=g6w4KuxYI@FfM~&xglVNs zdNNKYlOv%qkz-qH2I?XYY1eo*cXK`U4B?SC)2Boz@gpllpkiARJ#jfajKf8yv)reT zn0}vDTq21B27*7jnSh}$-zbiPNnfA?mpMnE&@jC1IGK;rHw~#!Wd?+78=qH%t*bB7 zYa9z>>zbH3H6=b5C;K#49X2@y;WAs12tiFOB>ACcvJ@;qmXJ> zNotkbSjXoa$B*!|8)gf$C%r3zM%!ZGw#!Wv$K>eE($l72#Q@H6l(q$vpNgsjzl8Bg z3p?CaOWd}ox10AqBCDU()J+pZY^i9S+kLX{Y(uLX$y}v5vvIrYZguCuz7`Z%DHNE4Dg`J#*PYN wV$uO6, YEAR. -# -msgid "" -msgstr "" -"Project-Id-Version: \n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2016-03-02 16:22-0500\n" -"PO-Revision-Date: 2016-03-04 11:51-0500\n" -"Language: fr\n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Plural-Forms: nplurals=2; plural=(n > 1);\n" -"Last-Translator: \n" -"Language-Team: \n" -"X-Generator: Poedit 1.7.6\n" - -#: commands/cmdhandler.py:485 -msgid "There were multiple matches." -msgstr "Il y a eu plusieurs correspondances." - -#: commands/cmdhandler.py:513 -#, python-format -msgid "Command '%s' is not available." -msgstr "Commande '%s' n'est pas disponible." - -#: commands/cmdhandler.py:518 -#, python-format -msgid " Maybe you meant %s?" -msgstr "Voulez-vous dire %s?" - -#: commands/cmdhandler.py:518 -msgid "or" -msgstr "ou" - -#: commands/cmdhandler.py:520 -msgid " Type \"help\" for help." -msgstr "Tapez \"help\" pour de l'aide." - -#: commands/cmdparser.py:183 -#, python-format -msgid "Could not find '%s'." -msgstr "Peut pas trouver '%s'." - -#: commands/cmdsethandler.py:130 -#, python-format -msgid "" -"\n" -"(Unsuccessfully tried '%s.' + '%s.%s')." -msgstr "" -"\n" -"(Essayé sans succès '%s.' + '%s.%s')." - -#: commands/cmdsethandler.py:151 -#, python-brace-format -msgid "" -"\n" -"Error loading cmdset {path}: \"{error}\"" -msgstr "" -"\n" -"Erreur de chargement de cmdset {path}: \"{error}\"" - -#: commands/cmdsethandler.py:155 -#, python-brace-format -msgid "" -"\n" -"Error in loading cmdset: No cmdset class '{classname}' in {path}." -msgstr "" -"\n" -"Erreur lors du chargement de cmdset: Pas de classe cmdset '{classname}' in " -"{path}." - -#: commands/cmdsethandler.py:159 -#, python-brace-format -msgid "" -"\n" -"SyntaxError encountered when loading cmdset '{path}': \"{error}\"." -msgstr "" -"\n" -"Erreur de syntaxe lors du chargement de cmdset '{path}': \"{error}\"." - -#: commands/cmdsethandler.py:163 -#, python-brace-format -msgid "" -"\n" -"Compile/Run error when loading cmdset '{path}': \"{error}\"." -msgstr "" -"\n" -"Erreur de compilation/exécution lors du chargement de cmdset '{path}': " -"\"{error}\"." - -#: commands/cmdsethandler.py:174 -msgid "" -"\n" -" (See log for details.)" -msgstr "" -"\n" -"(Voir registre pour plus de détails.)" - -#: commands/cmdsethandler.py:247 -#, python-brace-format -msgid "custom {mergetype} on cmdset '{cmdset}'" -msgstr "custom {mergetype} sur cmdset '{cmdset}'" - -#: commands/cmdsethandler.py:250 -#, python-brace-format -msgid " : {current}" -msgstr " : {current}" - -#: commands/cmdsethandler.py:258 -#, python-brace-format -msgid "" -" <{key} ({mergetype}, prio {prio}, {permstring})>:\n" -" {keylist}" -msgstr "" -" <{key} ({mergetype}, prio {prio}, {permstring})>:\n" -" {keylist}" - -#: commands/cmdsethandler.py:347 -msgid "Only CmdSets can be added to the cmdsethandler!" -msgstr "Seulement CmdSets peuvent être ajoutés au cmdsethandler!" - -#: comms/channelhandler.py:94 -msgid " (channel)" -msgstr " (channel)" - -#: locks/lockhandler.py:230 -#, python-format -msgid "Lock: lock-function '%s' is not available." -msgstr "Vérou: lock-function '%s' n'est pas disponible." - -#: locks/lockhandler.py:243 -#, python-format -msgid "Lock: definition '%s' has syntax errors." -msgstr "Vérou: définition '%s' a des erreurs de syntaxe." - -#: locks/lockhandler.py:247 -#, python-format -msgid "" -"LockHandler on %(obj)s: access type '%(access_type)s' changed from " -"'%(source)s' to '%(goal)s' " -msgstr "" -"Gestionnaire de vérrou sur %(obj)s: type d'accès '%(access_type)s' a changé " -"de '%(source)s' à '%(goal)s'" - -#: locks/lockhandler.py:304 -#, python-format -msgid "Lock: '%s' contains no colon (:)." -msgstr "Verrou: '%s' contient pas de deux points (:)." - -#: locks/lockhandler.py:308 -#, python-format -msgid "Lock: '%s' has no access_type (left-side of colon is empty)." -msgstr "" -"Verrou: '%s' n'a pas de access_type (côté gauche du deux point est vide)." - -#: locks/lockhandler.py:311 -#, python-format -msgid "Lock: '%s' has mismatched parentheses." -msgstr "Verrou: '%s' a des parenthèses dépareillées." - -#: locks/lockhandler.py:314 -#, python-format -msgid "Lock: '%s' has no valid lock functions." -msgstr "Verrou: '%s' n'a pas de fonctions verrou valides." - -#: objects/objects.py:528 -#, python-format -msgid "Couldn't perform move ('%s'). Contact an admin." -msgstr "Ne pouvait effectuer le coup ('%s'). Contactez un administrateur." - -#: objects/objects.py:538 -msgid "The destination doesn't exist." -msgstr "La destination n'existe pas." - -#: objects/objects.py:651 -#, python-format -msgid "Could not find default home '(#%d)'." -msgstr "Ne peut trouver la maison '(#%d)' par défaut." - -#: objects/objects.py:667 -msgid "Something went wrong! You are dumped into nowhere. Contact an admin." -msgstr "" -"Quelque chose a mal tourné! Vous êtes nulle part. Contactez un " -"administrateur." - -#: objects/objects.py:747 -#, python-format -msgid "Your character %s has been destroyed." -msgstr "Votre personnage %s a été détruit." - -#: players/players.py:356 -msgid "Player being deleted." -msgstr "Suppression de joueur." - -#: scripts/scripthandler.py:50 -#, python-format -msgid "" -"\n" -" '%(key)s' (%(next_repeat)s/%(interval)s, %(repeats)s repeats): %(desc)s" -msgstr "" -"\n" -" '%(key)s' (%(next_repeat)s/%(interval)s, %(repeats)s répète): %(desc)s" - -#: scripts/scripts.py:202 -#, python-format -msgid "" -"Script %(key)s(#%(dbid)s) of type '%(cname)s': at_repeat() error '%(err)s'." -msgstr "" -"Scripte %(key)s(#%(dbid)s) de type '%(cname)s': at_repeat() erreur " -"'%(err)s'." - -#: server/initial_setup.py:29 -msgid "" -"\n" -"Welcome to your new |wEvennia|n-based game! Visit http://www.evennia.com if " -"you need\n" -"help, want to contribute, report issues or just join the community.\n" -"As Player #1 you can create a demo/tutorial area with |w@batchcommand " -"tutorial_world.build|n.\n" -" " -msgstr "" -"\n" -"Bienvenue dans ton nouveau jeu basé sur |wEvennia|n ! Visitez http://www." -"evennia.com si vous avez besoin\n" -"d'aide, si vous voulez contribuer, rapporter des problèmes ou faire partie " -"de la communauté.\n" -"En tant que Joueur #1 vous pouvez créer une zone de démo/tutoriel avec " -"|w@batchcommand tutorial_world.build|n.\n" -" " - -#: server/initial_setup.py:102 -msgid "This is User #1." -msgstr "Utilisateur #1." - -#: server/initial_setup.py:111 -msgid "Limbo" -msgstr "Limbes." - -#: server/sessionhandler.py:258 -msgid " ... Server restarted." -msgstr " ... Serveur redémarré." - -#: server/sessionhandler.py:408 -msgid "Logged in from elsewhere. Disconnecting." -msgstr "Connecté d'ailleurs. Déconnexion." - -#: server/sessionhandler.py:432 -msgid "Idle timeout exceeded, disconnecting." -msgstr "Délai d'inactivité dépassé, déconnexion." +# The French translation for the Evennia server. +# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER +# This file is distributed under the same license as the Evennia package. +# FIRST AUTHOR , YEAR. +# Maintained by: vincent-lg , 2018- +# +msgid "" +msgstr "" +"Project-Id-Version: \n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2018-11-22 08:45+0100\n" +"PO-Revision-Date: 2016-03-04 11:51-0500\n" +"Last-Translator: \n" +"Language-Team: \n" +"Language: fr\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=(n > 1);\n" +"X-Generator: Poedit 1.7.6\n" + +#: .\accounts\accounts.py:440 +#, fuzzy +msgid "Account being deleted." +msgstr "Suppression du compte." + +#: .\commands\cmdhandler.py:681 +msgid "There were multiple matches." +msgstr "Il y a plusieurs correspondances possibles." + +#: .\commands\cmdhandler.py:704 +#, python-format +msgid "Command '%s' is not available." +msgstr "La commande '%s' n'est pas disponible." + +#: .\commands\cmdhandler.py:709 +#, python-format +msgid " Maybe you meant %s?" +msgstr " Vouliez-vous dire %s ?" + +#: .\commands\cmdhandler.py:709 +msgid "or" +msgstr "ou" + +#: .\commands\cmdhandler.py:711 +msgid " Type \"help\" for help." +msgstr " Tapez \"help\" pour obtenir de l'aide." + +#: .\commands\cmdsethandler.py:89 +#, python-brace-format +msgid "" +"{traceback}\n" +"Error loading cmdset '{path}'\n" +"(Traceback was logged {timestamp})" +msgstr "" +"{traceback}\n" +"Une erreur s'est produite lors du chargement du cmdset '{path}'\n" +"(Référence de l'erreur : {timestamp})" + +#: .\commands\cmdsethandler.py:94 +#, fuzzy, python-brace-format +msgid "" +"Error loading cmdset: No cmdset class '{classname}' in '{path}'.\n" +"(Traceback was logged {timestamp})" +msgstr "" +"\n" +"Une erreur s'est produite lors du chargement de cmdset : la classe cmdset '{classname}' est introuvable dans " +"{path}.\n" +"(Référence de l'erreur : {timestamp})" + +#: .\commands\cmdsethandler.py:98 +#, fuzzy, python-brace-format +msgid "" +"{traceback}\n" +"SyntaxError encountered when loading cmdset '{path}'.\n" +"(Traceback was logged {timestamp})" +msgstr "" +"\n" +"Erreur de syntaxe lors du chargement de cmdset '{path}' : \"{error}\".\n" +"(Référence de l'erreur : {timestamp})" + +#: .\commands\cmdsethandler.py:103 +#, fuzzy, python-brace-format +msgid "" +"{traceback}\n" +"Compile/Run error when loading cmdset '{path}'.\",\n" +"(Traceback was logged {timestamp})" +msgstr "" +"\n" +"Erreur de compilation/exécution lors du chargement de cmdset '{path}' : " +"\"{error}\".\n" +"(Référence de l'erreur : {timestamp})" + +#: .\commands\cmdsethandler.py:108 +#, python-brace-format +msgid "" +"\n" +"Error encountered for cmdset at path '{path}'.\n" +"Replacing with fallback '{fallback_path}'.\n" +msgstr "" +"\n" +"Une erreur a été rencontrée lors du chargement du cmdset '{path}'.\n" +"Le cmdset '{fallback_path}' est utilisé en remplacement.\n" + +#: .\commands\cmdsethandler.py:114 +#, python-brace-format +msgid "Fallback path '{fallback_path}' failed to generate a cmdset." +msgstr "Impossible de générer le cmdset de remplacement : '{fallback_path}'." + +#: .\commands\cmdsethandler.py:182 .\commands\cmdsethandler.py:192 +#, fuzzy, python-format +msgid "" +"\n" +"(Unsuccessfully tried '%s')." +msgstr "" +"\n" +"(Essayé sans succès '%s.' + '%s.%s')." + +#: .\commands\cmdsethandler.py:311 +#, python-brace-format +msgid "custom {mergetype} on cmdset '{cmdset}'" +msgstr "custom {mergetype} sur cmdset '{cmdset}'" + +#: .\commands\cmdsethandler.py:314 +#, python-brace-format +msgid " : {current}" +msgstr " : {current}" + +#: .\commands\cmdsethandler.py:322 +#, python-brace-format +msgid "" +" <{key} ({mergetype}, prio {prio}, {permstring})>:\n" +" {keylist}" +msgstr "" +" <{key} ({mergetype}, prio {prio}, {permstring})>:\n" +" {keylist}" + +#: .\commands\cmdsethandler.py:426 +msgid "Only CmdSets can be added to the cmdsethandler!" +msgstr "Seuls des CmdSets peuvent être ajoutés au cmdsethandler !" + +#: .\comms\channelhandler.py:100 +msgid "Say what?" +msgstr "Que voulez-vous dire ?" + +#: .\comms\channelhandler.py:105 +#, python-format +msgid "Channel '%s' not found." +msgstr "Le canal '%s' ne semble pas exister." + +#: .\comms\channelhandler.py:108 +#, python-format +msgid "You are not connected to channel '%s'." +msgstr "Vous n'êtes pas connecté au canal '%s'." + +#: .\comms\channelhandler.py:112 +#, python-format +msgid "You are not permitted to send to channel '%s'." +msgstr "Vous n'avez pas le droit de parler sur le canal '%s'." + +#: .\comms\channelhandler.py:155 +msgid " (channel)" +msgstr " (canal)" + +#: .\locks\lockhandler.py:236 +#, python-format +msgid "Lock: lock-function '%s' is not available." +msgstr "Verrou : lock-function '%s' n'est pas disponible." + +#: .\locks\lockhandler.py:249 +#, python-format +msgid "Lock: definition '%s' has syntax errors." +msgstr "Verrou : la définition '%s' a des erreurs de syntaxe." + +#: .\locks\lockhandler.py:253 +#, python-format +msgid "" +"LockHandler on %(obj)s: access type '%(access_type)s' changed from " +"'%(source)s' to '%(goal)s' " +msgstr "" +"Gestionnaire de verrous sur %(obj)s: type d'accès '%(access_type)s' a changé " +"de '%(source)s' à '%(goal)s'" + +#: .\locks\lockhandler.py:320 +#, fuzzy, python-brace-format +msgid "Lock: '{lockdef}' contains no colon (:)." +msgstr "Verrou : '%s' ne contient pas de deux points (:)." + +#: .\locks\lockhandler.py:328 +#, fuzzy, python-brace-format +msgid "Lock: '{lockdef}' has no access_type (left-side of colon is empty)." +msgstr "" +"Verrou : '%s' n'a pas de 'access_type' (il n'y a rien avant les deux points)." + +#: .\locks\lockhandler.py:336 +#, fuzzy, python-brace-format +msgid "Lock: '{lockdef}' has mismatched parentheses." +msgstr "Verrou : '%s' a des parenthèses déséquilibrées." + +#: .\locks\lockhandler.py:343 +#, fuzzy, python-brace-format +msgid "Lock: '{lockdef}' has no valid lock functions." +msgstr "Verrou : '%s' n'a pas de lock-function valide." + +#: .\objects\objects.py:729 +#, python-format +msgid "Couldn't perform move ('%s'). Contact an admin." +msgstr "Impossible de se déplacer vers ('%s'). Veuillez contacter un administrateur." + +#: .\objects\objects.py:739 +msgid "The destination doesn't exist." +msgstr "La destination est inconnue." + +#: .\objects\objects.py:830 +#, python-format +msgid "Could not find default home '(#%d)'." +msgstr "Impossible de trouver la salle de départ (default home) par défaut : '#%d'." + +#: .\objects\objects.py:846 +msgid "Something went wrong! You are dumped into nowhere. Contact an admin." +msgstr "" +"Quelque chose a mal tourné ! Vous vous trouvez au milieu de nulle part. " +"Veuillez contacter un administrateur." + +#: .\objects\objects.py:912 +#, python-format +msgid "Your character %s has been destroyed." +msgstr "Votre personnage %s a été détruit." + +#: .\scripts\scripthandler.py:53 +#, python-format +msgid "" +"\n" +" '%(key)s' (%(next_repeat)s/%(interval)s, %(repeats)s repeats): %(desc)s" +msgstr "" +"\n" +" '%(key)s' (%(next_repeat)s/%(interval)s, %(repeats)s répète) : %(desc)s" + +#: .\scripts\scripts.py:205 +#, python-format +msgid "" +"Script %(key)s(#%(dbid)s) of type '%(cname)s': at_repeat() error '%(err)s'." +msgstr "" +"Le script %(key)s(#%(dbid)s) de type '%(cname)s' a rencontré une erreur " +"durant at_repeat() : '%(err)s'." + +#: .\server\initial_setup.py:28 +#, fuzzy +msgid "" +"\n" +"Welcome to your new |wEvennia|n-based game! Visit http://www.evennia.com if " +"you need\n" +"help, want to contribute, report issues or just join the community.\n" +"As Account #1 you can create a demo/tutorial area with |w@batchcommand " +"tutorial_world.build|n.\n" +" " +msgstr "" +"\n" +"Bienvenue dans votre nouveau jeu basé sur |wEvennia|n ! Visitez le site Web\n" +"http://www.evennia.com si vous avez besoin d'aide, pour contribuer au projet,\n" +"afin de rapporter des bugs ou faire partie de la communauté.\n" +"En tant que premier personnage (#1), vous pouvez créer une zone de\n" +"démo/tutoriel en entrant la commande |w@batchcommand tutorial_world.build|n.\n" +" " + +#: .\server\initial_setup.py:92 +msgid "This is User #1." +msgstr "C'est l'utilisateur #1." + +#: .\server\initial_setup.py:105 +msgid "Limbo" +msgstr "Limbes" + +#: .\server\server.py:139 +#, fuzzy +msgid "idle timeout exceeded" +msgstr "Délai d'inactivité dépassé, déconnexion." + +#: .\server\sessionhandler.py:386 +msgid " ... Server restarted." +msgstr " ... Serveur redémarré." + +#: .\server\sessionhandler.py:606 +msgid "Logged in from elsewhere. Disconnecting." +msgstr "Connexion d'une autre session. Déconnexion de celle-ci." + +#: .\server\sessionhandler.py:634 +msgid "Idle timeout exceeded, disconnecting." +msgstr "Délai d'inactivité dépassé, déconnexion." + +#: .\server\validators.py:50 +#, python-format +msgid "" +"%s From a terminal client, you can also use a phrase of multiple words if " +"you enclose the password in double quotes." +msgstr "" +"%s Depuis votre client, vous pouvez également préciser une phrase contenant " +"plusieurs mots séparés par un espace, dès lors que cette phrase est entourée de guillemets." + +#: .\utils\evmenu.py:192 +#, python-brace-format +msgid "" +"Menu node '{nodename}' is either not implemented or caused an error. Make " +"another choice." +msgstr "" +"Ce choix '{nodename}' n'est pas implémenté, ou bien a créé une erreur. " +"Faies un autre choix." + +#: .\utils\evmenu.py:194 +#, python-brace-format +msgid "Error in menu node '{nodename}'." +msgstr "Une erreur s'est produite dans le choix '{nodename}'." + +#: .\utils\evmenu.py:195 +msgid "No description." +msgstr "Description non renseignée." + +#: .\utils\evmenu.py:196 +msgid "Commands: , help, quit" +msgstr "Utilisez une des commandes : , help, quit" + +#: .\utils\evmenu.py:197 +msgid "Commands: , help" +msgstr "Utilisez une des commandes : , help" + +#: .\utils\evmenu.py:198 +msgid "Commands: help, quit" +msgstr "Utilisez une des commandes : help, quit" + +#: .\utils\evmenu.py:199 +msgid "Commands: help" +msgstr "Utilisez la commande : help" + +#: .\utils\evmenu.py:200 +msgid "Choose an option or try 'help'." +msgstr "Choisissez une option ou entrez la commande 'help'." + +#: .\utils\utils.py:1866 +#, python-format +msgid "Could not find '%s'." +msgstr "Impossible de trouver '%s'." + +#: .\utils\utils.py:1873 +#, python-format +msgid "More than one match for '%s' (please narrow target):\n" +msgstr "Plus d'une possibilité pour '%s' (veuillez préciser) :\n" From 07663e6a2738cc40a877277f902431c87902869d Mon Sep 17 00:00:00 2001 From: friarzen Date: Tue, 27 Nov 2018 03:42:37 +0000 Subject: [PATCH 178/187] whitespace cleanup --- .../webclient/js/plugins/splithandler.js | 137 +++++++++--------- 1 file changed, 68 insertions(+), 69 deletions(-) diff --git a/evennia/web/webclient/static/webclient/js/plugins/splithandler.js b/evennia/web/webclient/static/webclient/js/plugins/splithandler.js index 4667065856..ec08b862a3 100644 --- a/evennia/web/webclient/static/webclient/js/plugins/splithandler.js +++ b/evennia/web/webclient/static/webclient/js/plugins/splithandler.js @@ -183,12 +183,12 @@ let splithandler_plugin = (function () { var dialog = $("#splitdialogcontent"); dialog.empty(); - var selection = ''; for ( var pane in split_panes ) { - selection = selection + ''; + selection = selection + ''; } - selection = "Pane to split: " + selection + " "; - dialog.append(selection); + selection = "Pane to split: " + selection + " "; + dialog.append(selection); dialog.append('top/bottom '); dialog.append('side-by-side
    '); @@ -203,7 +203,7 @@ let splithandler_plugin = (function () { dialog.append('replace '); dialog.append('append
    '); - dialog.append('
    Split
    '); + dialog.append('
    Split
    '); $("#splitclose").bind("click", onSplitDialogClose); @@ -251,21 +251,21 @@ let splithandler_plugin = (function () { var dialog = $("#panedialogcontent"); dialog.empty(); - var selection = ''; for ( var pane in split_panes ) { - selection = selection + ''; + selection = selection + ''; } - selection = "Assign to pane: " + selection + "
    "; - dialog.append(selection); + selection = "Assign to pane: " + selection + "
    "; + dialog.append(selection); - var multiple = ''; for ( var type in known_types ) { - multiple = multiple + ''; + multiple = multiple + ''; } - multiple = "Content types: " + multiple + "
    "; - dialog.append(multiple); + multiple = "Content types: " + multiple + "
    "; + dialog.append(multiple); - dialog.append('
    Assign
    '); + dialog.append('
    Assign
    '); $("#paneclose").bind("click", onPaneControlDialogClose); @@ -276,9 +276,9 @@ let splithandler_plugin = (function () { // Close "Pane Controls" dialog var onPaneControlDialogClose = function () { var pane = $("select[name=assign-pane]").val(); - var types = $("select[name=assign-type]").val(); + var types = $("select[name=assign-type]").val(); - // var types = new Array; + // var types = new Array; // $('#splitdialogcontent input[type=checkbox]:checked').each(function() { // types.push( $(this).attr('value') ); // }); @@ -287,24 +287,24 @@ let splithandler_plugin = (function () { plugins['popups'].closePopup("#panedialog"); } + // // helper function sending text to a pane var txtToPane = function (panekey, txt) { - var pane = split_panes[panekey]; - var text_div = $('#' + panekey + '-sub'); + var pane = split_panes[panekey]; + var text_div = $('#' + panekey + '-sub'); - if ( pane['update_method'] == 'replace' ) { - text_div.html(txt) - } else if ( pane['update_method'] == 'append' ) { - text_div.append(txt); - var scrollHeight = text_div.parent().prop("scrollHeight"); - text_div.parent().animate({ scrollTop: scrollHeight }, 0); - } else { // line feed - text_div.append("
    " + txt + "
    "); - var scrollHeight = text_div.parent().prop("scrollHeight"); - text_div.parent().animate({ scrollTop: scrollHeight }, 0); - } - + if ( pane['update_method'] == 'replace' ) { + text_div.html(txt) + } else if ( pane['update_method'] == 'append' ) { + text_div.append(txt); + var scrollHeight = text_div.parent().prop("scrollHeight"); + text_div.parent().animate({ scrollTop: scrollHeight }, 0); + } else { // line feed + text_div.append("
    " + txt + "
    "); + var scrollHeight = text_div.parent().prop("scrollHeight"); + text_div.parent().animate({ scrollTop: scrollHeight }, 0); + } } @@ -316,53 +316,52 @@ let splithandler_plugin = (function () { // // Accept plugin onText events var onText = function (args, kwargs) { - - // If the message is not itself tagged, we'll assume it - // should go into any panes with 'all' or 'rest' set + // If the message is not itself tagged, we'll assume it + // should go into any panes with 'all' or 'rest' set var msgtype = "rest"; if ( kwargs && 'type' in kwargs ) { - msgtype = kwargs['type']; + msgtype = kwargs['type']; if ( ! known_types.includes(msgtype) ) { // this is a new output type that can be mapped to panes console.log('detected new output type: ' + msgtype) known_types.push(msgtype); } - } - var target_panes = []; - var rest_panes = []; - - for (var key in split_panes) { - var pane = split_panes[key]; - // is this message type mapped to this pane (or does the pane has an 'all' type)? - if (pane['types'].length > 0) { - if (pane['types'].includes(msgtype) || pane['types'].includes('all')) { - target_panes.push(key); - } else if (pane['types'].includes('rest')) { - // store rest-panes in case we have no explicit to send to - rest_panes.push(key); - } - } else { - // unassigned panes are assumed to be rest-panes too - rest_panes.push(key); - } - } - var ntargets = target_panes.length; - var nrests = rest_panes.length; - if (ntargets > 0) { - // we have explicit target panes to send to - for (var i=0; i 0) { - // no targets, send remainder to rest-panes/unassigned - for (var i=0; i 0) { + if (pane['types'].includes(msgtype) || pane['types'].includes('all')) { + target_panes.push(key); + } else if (pane['types'].includes('rest')) { + // store rest-panes in case we have no explicit to send to + rest_panes.push(key); + } + } else { + // unassigned panes are assumed to be rest-panes too + rest_panes.push(key); + } + } + var ntargets = target_panes.length; + var nrests = rest_panes.length; + if (ntargets > 0) { + // we have explicit target panes to send to + for (var i=0; i 0) { + // no targets, send remainder to rest-panes/unassigned + for (var i=0; i Date: Tue, 27 Nov 2018 03:43:20 +0000 Subject: [PATCH 179/187] fix hotbuttons css/layout issues --- .../static/webclient/js/plugins/hotbuttons.js | 41 +++++++++---------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/evennia/web/webclient/static/webclient/js/plugins/hotbuttons.js b/evennia/web/webclient/static/webclient/js/plugins/hotbuttons.js index e3d2ea8a7a..a20a620f52 100644 --- a/evennia/web/webclient/static/webclient/js/plugins/hotbuttons.js +++ b/evennia/web/webclient/static/webclient/js/plugins/hotbuttons.js @@ -30,32 +30,31 @@ plugin_handler.add('hotbuttons', (function () { // Add Buttons var addButtonsUI = function () { var buttons = $( [ - '
    ', - '
    ', - '
    ', - ' ', - ' ', - ' ', - ' ', - ' ', - ' ', - ' ', - ' ', - ' ', - '
    ', - '
    ', - '
    ', - ].join("\n") ); + '
    ', + '
    ', + '
    ', + ' ', + ' ', + ' ', + ' ', + ' ', + ' ', + ' ', + ' ', + ' ', + '
    ', + '
    ', + '
    ', + ].join("\n") ); // Add buttons in front of the existing #inputform - buttons.insertBefore('#inputform'); - $('#inputform').addClass('split split-vertical'); + $('#input').prev().replaceWith(buttons); - Split(['#buttons','#inputform'], { + Split(['#main','#buttons','#input'], { + sizes: [85,5,10], direction: 'vertical', - sizes: [50,50], gutterSize: 4, - minSize: 150, + minSize: [150,20,50], }); } From 57551c791dd133e96aba690a8217e2f4c218fce4 Mon Sep 17 00:00:00 2001 From: friarzen Date: Tue, 27 Nov 2018 03:54:52 +0000 Subject: [PATCH 180/187] Modal dialogs should capture all keystrokes but not interfere with other onKeydowns --- .../webclient/js/plugins/splithandler.js | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/evennia/web/webclient/static/webclient/js/plugins/splithandler.js b/evennia/web/webclient/static/webclient/js/plugins/splithandler.js index ec08b862a3..c32cf32c1b 100644 --- a/evennia/web/webclient/static/webclient/js/plugins/splithandler.js +++ b/evennia/web/webclient/static/webclient/js/plugins/splithandler.js @@ -365,6 +365,30 @@ let splithandler_plugin = (function () { return false; } + // + // onKeydown check for 'ESC' key. + var onKeydown = function (event) { + var code = event.which; + + if (code === 27) { // Escape key + if ($('#splitdialogcontent').is(':visible')) { + plugins['popups'].closePopup("#splitdialogcontent"); + return true; + } + if ($('#panedialogcontent').is(':visible')) { + plugins['popups'].closePopup("#panedialogcontent"); + return true; + } + } + + // capture all keys while one of our "modal" dialogs is open + if ($('#splitdialogcontent').is(':visible') || $('#panedialogcontent').is(':visible')) { + return true; + } + + return false; + } + // // Required plugin "init" function var init = function(settings) { @@ -408,6 +432,7 @@ let splithandler_plugin = (function () { dynamic_split: dynamic_split, undo_split: undo_split, set_pane_types: set_pane_types, + onKeydown: onKeydown, } })() plugin_handler.add('splithandler', splithandler_plugin); From ce3a1da1dc1d3a8f326e648955e42cec64da94e8 Mon Sep 17 00:00:00 2001 From: friarzen Date: Tue, 27 Nov 2018 04:28:52 +0000 Subject: [PATCH 181/187] open help popup when the option is set. --- .../static/webclient/js/plugins/options.js | 24 ++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/evennia/web/webclient/static/webclient/js/plugins/options.js b/evennia/web/webclient/static/webclient/js/plugins/options.js index 114cd6cf0e..d3b6d13158 100644 --- a/evennia/web/webclient/static/webclient/js/plugins/options.js +++ b/evennia/web/webclient/static/webclient/js/plugins/options.js @@ -77,10 +77,12 @@ let options_plugin = (function () { if (code === 27) { // Escape key if ($('#helpdialog').is(':visible')) { plugins['popups'].closePopup("#helpdialog"); - } else { - plugins['popups'].closePopup("#optionsdialog"); + return true; + } + if ($('#optionsdialog').is(':visible')) { + plugins['popups'].closePopup("#optionsdialog"); + return true; } - return true; } return false; } @@ -129,6 +131,21 @@ let options_plugin = (function () { plugins['popups'].closePopup("#helpdialog"); } + // + // Make sure to close any dialogs on connection lost + var onText = function (args, kwargs) { + // is helppopup set? and if so, does this Text have type 'help'? + if ('helppopup' in options && options['helppopup'] ) { + if (kwargs && ('type' in kwargs) && (kwargs['type'] == 'help') ) { + $('#helpdialogcontent').append('
    '+ args + '
    '); + plugins['popups'].togglePopup("#helpdialog"); + return true; + } + } + + return false; + } + // // Register and init plugin var init = function () { @@ -155,6 +172,7 @@ let options_plugin = (function () { onGotOptions: onGotOptions, onPrompt: onPrompt, onConnectionClose: onConnectionClose, + onText: onText, } })() plugin_handler.add('options', options_plugin); From 0554f83b69648dd272933f49cb6af55f83a0a62e Mon Sep 17 00:00:00 2001 From: Brenden Tuck Date: Tue, 27 Nov 2018 20:35:53 -0500 Subject: [PATCH 182/187] adjust so splithandler dialogs dont get trumped by default_in --- .../webclient/static/webclient/js/plugins/splithandler.js | 8 ++++---- evennia/web/webclient/templates/webclient/base.html | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/evennia/web/webclient/static/webclient/js/plugins/splithandler.js b/evennia/web/webclient/static/webclient/js/plugins/splithandler.js index c32cf32c1b..284d74b912 100644 --- a/evennia/web/webclient/static/webclient/js/plugins/splithandler.js +++ b/evennia/web/webclient/static/webclient/js/plugins/splithandler.js @@ -371,12 +371,12 @@ let splithandler_plugin = (function () { var code = event.which; if (code === 27) { // Escape key - if ($('#splitdialogcontent').is(':visible')) { - plugins['popups'].closePopup("#splitdialogcontent"); + if ($('#splitdialog').is(':visible')) { + plugins['popups'].closePopup("#splitdialog"); return true; } - if ($('#panedialogcontent').is(':visible')) { - plugins['popups'].closePopup("#panedialogcontent"); + if ($('#panedialog').is(':visible')) { + plugins['popups'].closePopup("#panedialog"); return true; } } diff --git a/evennia/web/webclient/templates/webclient/base.html b/evennia/web/webclient/templates/webclient/base.html index 176ef0d160..0cc4302af4 100644 --- a/evennia/web/webclient/templates/webclient/base.html +++ b/evennia/web/webclient/templates/webclient/base.html @@ -73,10 +73,10 @@ JQuery available. + - {% endblock %} From 811ab0045efad2abc61e31e7c57495a10098c9d7 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 2 Dec 2018 16:28:31 +0100 Subject: [PATCH 183/187] Correct command name in doc --- evennia/server/evennia_launcher.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/server/evennia_launcher.py b/evennia/server/evennia_launcher.py index d42093b566..6387055736 100644 --- a/evennia/server/evennia_launcher.py +++ b/evennia/server/evennia_launcher.py @@ -277,7 +277,7 @@ INFO_WINDOWS_BATFILE = \ twistd.bat to point to the actual location of the Twisted executable (usually called twistd.py) on your machine. - This procedure is only done once. Run evennia.py again when you + This procedure is only done once. Run `evennia` again when you are ready to start the server. """ From b7893e731972210596c16288e91f96f282c1eb6e Mon Sep 17 00:00:00 2001 From: Vincent Le Goff Date: Tue, 11 Dec 2018 17:54:27 +0100 Subject: [PATCH 184/187] Fix #1754: WindowsError is replaced with OSError --- evennia/__init__.py | 2 +- evennia/server/evennia_launcher.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/evennia/__init__.py b/evennia/__init__.py index ab23ff7abf..163f23e04d 100644 --- a/evennia/__init__.py +++ b/evennia/__init__.py @@ -105,7 +105,7 @@ def _create_version(): print(err) try: version = "%s (rev %s)" % (version, check_output("git rev-parse --short HEAD", shell=True, cwd=root, stderr=STDOUT).strip()) - except (IOError, CalledProcessError, WindowsError): + except (IOError, CalledProcessError, OSError): # ignore if we cannot get to git pass return version diff --git a/evennia/server/evennia_launcher.py b/evennia/server/evennia_launcher.py index 6387055736..5cd3cba524 100644 --- a/evennia/server/evennia_launcher.py +++ b/evennia/server/evennia_launcher.py @@ -1217,7 +1217,7 @@ def evennia_version(): "git rev-parse --short HEAD", shell=True, cwd=EVENNIA_ROOT, stderr=STDOUT).strip() version = "%s (rev %s)" % (version, rev) - except (IOError, CalledProcessError, WindowsError): + except (IOError, CalledProcessError, OSError): # move on if git is not answering pass return version From 3afe08a1cff472135558930fb70cb45b69f87e19 Mon Sep 17 00:00:00 2001 From: Antrare Date: Tue, 18 Dec 2018 20:31:14 +1100 Subject: [PATCH 185/187] BugFix - Delete Prototypes using spawn command Spawn/delete was not actually deleting anything. This enables the command to work as expected. --- evennia/commands/default/building.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/commands/default/building.py b/evennia/commands/default/building.py index 7b77ae0faa..35a651f536 100644 --- a/evennia/commands/default/building.py +++ b/evennia/commands/default/building.py @@ -3041,7 +3041,7 @@ class CmdSpawn(COMMAND_DEFAULT_CLASS): caller.msg("|rDeletion cancelled.|n") return try: - success = protlib.delete_db_prototype(caller, self.args) + success = protlib.delete_prototype(self.args) except protlib.PermissionError as err: caller.msg("|rError deleting:|R {}|n".format(err)) caller.msg("Deletion {}.".format( From 0f3451995845d535a0a0ad647be89c9528ee256f Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 30 Dec 2018 11:14:16 +0100 Subject: [PATCH 186/187] Cleanup of contrib readme --- evennia/contrib/README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/evennia/contrib/README.md b/evennia/contrib/README.md index fad1802237..c44937808f 100644 --- a/evennia/contrib/README.md +++ b/evennia/contrib/README.md @@ -1,7 +1,7 @@ # Contrib folder -This folder contains 'contributions': extra snippets of code that are +`evennia/contrib/` contains 'contributions': extra snippets of code that are potentially very useful for the game coder but which are considered too game-specific to be a part of the main Evennia game server. These modules are not used unless you explicitly import them. See each file @@ -17,7 +17,7 @@ things you want from here into your game folder and change them there. * Barter system (Griatch 2012) - A safe and effective barter-system for any game. Allows safe trading of any goods (including coin). -* Building menu (vincent-lg 2018) - An @edit command for modifying +* Building menu (vincent-lg 2018) - An `@edit` command for modifying objects using a generated menu. Customizable for different games. * CharGen (Griatch 2011) - A simple Character creator for OOC mode. Meant as a starting point for a more fleshed-out system. @@ -60,9 +60,6 @@ things you want from here into your game folder and change them there. * Tree Select (FlutterSprite 2017) - A simple system for creating a branching EvMenu with selection options sourced from a single multi-line string. -* Turnbattle (Tim Ashley Jenkins 2017) - This is a framework for a turn-based - combat system with different levels of complexity, including versions with - equipment and magic as well as ranged combat. * Wilderness (titeuf87 2017) - Make infinitely large wilderness areas with dynamically created locations. * UnixCommand (Vincent Le Geoff 2017) - Add commands with UNIX-style syntax. @@ -75,7 +72,8 @@ things you want from here into your game folder and change them there. objects and events using Python from in-game. * Turnbattle (FlutterSprite 2017) - A turn-based combat engine meant as a start to build from. Has attack/disengage and turn timeouts, - and includes optional expansions for equipment and combat movement. + and includes optional expansions for equipment and combat movement, magic + and ranged combat. * Tutorial examples (Griatch 2011, 2015) - A folder of basic example objects, commands and scripts. * Tutorial world (Griatch 2011, 2015) - A folder containing the From 1b5da3e85d2d0c6c68d428da33f27568b18c05ca Mon Sep 17 00:00:00 2001 From: Griatch Date: Tue, 1 Jan 2019 03:29:55 +0100 Subject: [PATCH 187/187] Make help command accept use without a session --- evennia/commands/default/help.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/evennia/commands/default/help.py b/evennia/commands/default/help.py index d2011629c1..10064d06d0 100644 --- a/evennia/commands/default/help.py +++ b/evennia/commands/default/help.py @@ -66,7 +66,7 @@ class CmdHelp(Command): if type(self).help_more: usemore = True - if self.session.protocol_key in ("websocket", "ajax/comet"): + if self.session and self.session.protocol_key in ("websocket", "ajax/comet"): try: options = self.account.db._saved_webclient_options if options and options["helppopup"]: