Initial commit of the new auth API

TODO: Fill in commands and add translations for all phrases

Author: Necavi

addons/source-python/packages/source-python/__init__.py

@@ -127,17 +127,9 @@ def setup_sp_command():
 # =============================================================================
 def setup_auth():
     """Set up authentification."""
-    from core.command import _core_command
-    from core.settings import _core_settings
-
-    # Get the auth providers that should be loaded
-    auth_providers = _core_settings['AUTH_SETTINGS']['providers'].split()
-
-    # Should any providers be loaded?
-    if auth_providers:
+    from auth.manager import auth_manager
 
-        # Load the auth providers
-        _core_command['auth'].call_command(['load'] + auth_providers)
+    auth_manager.load()
 
 
 # =============================================================================

addons/source-python/packages/source-python/auth/__init__.py

@@ -11,6 +11,8 @@
 #   Translations
 from translations.strings import LangStrings
 
+from . import commands
+
 
 # =============================================================================
 # >> GLOBAL VARIABLES

addons/source-python/packages/source-python/auth/backends/flatfile.py

@@ -0,0 +1,48 @@
+import os
+import json
+
+from auth.paths import AUTH_CFG_PATH
+from auth.base import PermissionSource
+from auth.manager import auth_manager
+
+
+class FlatfilePermissionSource(PermissionSource):
+    name = "flatfile"
+    options = {
+        "admin_config_path": AUTH_CFG_PATH.joinpath("admins.json"),
+        "group_config_path": AUTH_CFG_PATH.joinpath("groups.json"),
+        "simple_config_path": AUTH_CFG_PATH.joinpath("simple.txt")
+    }
+
+    def load(self):
+        self.load_config(auth_manager.players, self.options["admin_config_path"])
+        self.load_config(auth_manager.groups, self.options["group_config_path"])
+        self.load_simple_config(auth_manager.players, self.options["simple_config_path"])
+
+    @staticmethod
+    def load_config(store, path):
+        if not os.path.exists(path):
+            with open(path, "w") as file:
+                json.dump({}, file)
+        with open(path) as file:
+            try:
+                nodes = json.load(file)
+                for nodename, node in nodes.items():
+                    nodename = nodename.strip()
+                    for permission in node.get("permissions", set()):
+                        if permission != "":
+                            store[nodename].add(permission)
+                    for group in node.get("parents", set()):
+                        store[nodename].add_parent(group)
+            except ValueError:
+                print("Malformed permissions file: {}".format(path))
+
+    @staticmethod
+    def load_simple_config(store, path):
+        if not os.path.exists(path):
+            open(path, "w").close()
+        with open(path) as file:
+            for uniqueid in file.readlines():
+                store[uniqueid.strip()].add("*")
+
+source = FlatfilePermissionSource()

addons/source-python/packages/source-python/auth/base.py

@@ -0,0 +1,11 @@
+class PermissionSource(object):
+    name = ""
+    options = {}
+
+    def load(self):
+        pass
+
+    def unload(self):
+        pass
+
+

addons/source-python/packages/source-python/auth/commands.py

@@ -1,199 +1,80 @@
-# ../auth/commands.py
+# TODO Add commands to add/remove permissions once command filters are added
 
-"""Registers the "sp auth" sub-commands."""
+from players.entity import PlayerEntity
 
-# =============================================================================
-# >> IMPORTS
-# =============================================================================
-# Python Imports
-#   Collections
-from collections import OrderedDict
+from commands.client import ClientCommand
+from commands.server import ServerCommand
+from .manager import auth_manager
 
-# Source.Python imports
-#   Auth
-from auth import auth_logger
-from auth import _auth_strings
-from auth.manager import auth_manager
+from messages import SayText2
 
+import re
 
-# =============================================================================
-# >> GLOBAL VARIABLES
-# =============================================================================
-# Get the sp.auth.commands logger
-auth_commands_logger = auth_logger.commands
 
+argument_re = re.compile("<([^>]+)>")
 
-# =============================================================================
-# >> CLASSES
-# =============================================================================
-class _AuthCommands(OrderedDict):
-    """Class used for executing "sp auth" sub-command functionality."""
 
-    manager = auth_manager
+class AuthCommand(object):
+    def __init__(self, command, permission=None):
+        self.permission = permission
+        self.command = command
+        self.arguments = []
+        for arg in command.split(" "):
+            if argument_re.match(arg):
+                self.arguments.append(None)
+            else:
+                self.arguments.append(arg)
+        self.callback = None
 
-    def call_command(self, args):
-        """Execute the given "sp auth" sub-command."""
-        # Was a command given?
-        if not args:
+    def __call__(self, callback, *args, **kwargs):
+        self.callback = callback
+        return callback
 
-            # Get a message that a sub-command is needed
-            message = '[SP Auth] ' + _auth_strings[
-                'Missing Command'].get_string() + '\n'
-
-            # Print the auth help text
-            self.print_auth_help(message)
-
-            # No need to go further
+    def test(self, index, command):
+        if command.get_arg_count() - 1 != len(self.arguments):
             return
-
-        # Get the command
-        command = args[0]
-
-        # Is the command registered?
-        if command not in self:
-
-            # Get a message about the invalid command
-            message = '[SP Auth] ' + _auth_strings[
-                'Invalid Sub-Command'].get_string(command=command) + '\n'
-
-            # Print the auth help text
-            self.print_auth_help(message)
-
-            # No need to go further
-            return
-
-        # Does the given command use arguments?
-        if hasattr(self[command], 'args'):
-
-            # Execute the command with the given arguments
-            self[command](args[1:])
-
-            # Go no further
-            return
-
-        # Execute the command
-        self[command]()
-
-    def _load_auth_providers(self, providers):
-        """Load the given auth providers."""
-        # Were any providers given?
-        if not providers:
-
-            # Send a message about the required argument
-            auth_commands_logger.log_message(
-                '[SP Auth] ' + _auth_strings['Missing Load'].get_string())
-
-            # No need to go further
-            return
-
-        # Loop through all of the given providers
-        for provider in providers:
-
-            # Load the current provider
-            self.manager.load_auth(provider)
-
-    _load_auth_providers.args = ['<provider>', '[provider]', '...']
-
-    def _unload_auth_providers(self, providers):
-        """Unload the given auth providers."""
-        # Were any providers given?
-        if not providers:
-
-            # Send a message about the required argument
-            auth_commands_logger.log_message(
-                '[SP Auth] ' + _auth_strings['Missing Unload'].get_string())
-
-            # No need to go further
-            return
-
-        # Loop through all of the given providers
-        for provider in providers:
-
-            # Unload the current provider
-            self.manager.unload_auth(provider)
-
-    _unload_auth_providers.args = ['<provider>', '[provider]', '...']
-
-    def _reload_auth_providers(self, providers=None):
-        """Reload the given auth providers."""
-        # Were any providers given?
-        if not providers:
-
-            # Set providers to all currently loaded providers
-            providers = list(self.manager)
-
-        # Loop through the providers
-        for provider in providers:
-
-            # Reload the given provider
-            self.manager.reload_auth(provider)
-
-    _reload_auth_providers.args = ['[provider]', '[provider]', '...']
-
-    def _print_auth_providers(self):
-        """List all currently loaded auth providers."""
-        # Get header messages
-        message = '[SP Auth] ' + _auth_strings[
-            'Providers'].get_string() + '\n' + '=' * 61 + '\n'
-
-        # Loop through all loaded auth providers
-        for provider in self.manager:
-
-            # Add the current provider to the message
-            message += provider + '\n'
-
-        # Print ending messages
-        auth_commands_logger.log_message(message + '=' * 61)
-
-    def print_auth_help(self, message=''):
-        """Print all "sp auth" sub-commands."""
-        # Get header messages
-        header = message + '[SP Auth] ' + _auth_strings[
-            'Help'].get_string() + 'sp auth <command> [arguments]\n' + '=' * 78
-
-        # Print all "sp auth" sub-commands
-        self.print_help(header, '=' * 78)
-
-    def print_help(self, pretext='', posttext=''):
-        """Print all "sp auth" sub-commands."""
-        auth_commands_logger.log_message(
-            pretext + '\n' + self.get_help_text() + '\n' + posttext)
-
-    def get_help_text(self):
-        """Return the help text for auth commands."""
-        # Store the base message
-        message = ''
-
-        # Loop through all registered sub-commands
-        for item in self:
-
-            # Add the base text
-            text = 'auth {0}'.format(item)
-
-            # Does the current item use arguments?
-            if hasattr(self[item], 'args'):
-
-                # Add the arguments to the text
-                text += ' ' + ' '.join(self[item].args)
-
-            # Add the doc strings
-            message += text + self[item].__doc__.rjust(78 - len(text)) + '\n'
-
-        # Return the message
-        return message.rstrip('\n')
-
-
-# =============================================================================
-# >> FUNCTIONS
-# =============================================================================
-# Get the _AuthCommands instance
-_auth_commands = _AuthCommands()
-
-# Add all auth loading/unloading commands to the dictionary
-_auth_commands['load'] = _auth_commands._load_auth_providers
-_auth_commands['unload'] = _auth_commands._unload_auth_providers
-_auth_commands['reload'] = _auth_commands._reload_auth_providers
-
-# Add all printing commands to the dictionary
-_auth_commands['list'] = _auth_commands._print_auth_providers
-_auth_commands['help'] = _auth_commands.print_auth_help
+        if self.permission is not None:
+            if index is not None and not PlayerEntity(index).has_permission(self.permission):
+                return
+        args = []
+        for i in range(0, len(self.arguments)):
+            if self.arguments[i] is not None and self.arguments[i] != command[i + 1]:
+                return
+            elif self.arguments[i] is None:
+                args.append(command[i + 1])
+        if self.callback is not None:
+            self.callback(index, *args)
+
+
+class AuthCommandManager(list):
+    def register_command(self, command, permission=None):
+        authcommand = AuthCommand(command, permission)
+        self.append(authcommand)
+        return authcommand
+
+
+auth_commands = AuthCommandManager()
+
+
+@ClientCommand("auth")
+def auth_client_command(command, index):
+    for authcommand in auth_commands:
+        authcommand.test(index, command)
+
+
+@ServerCommand("auth")
+def auth_server_command(command):
+    for auth_command in auth_commands:
+        auth_command.test(None, command)
+
+
+@auth_commands.register_command("load <backend>", "sp.auth.commands.load")
+def load_backend_command(index, backend):
+    if auth_manager.load_backend(backend):
+        message = "[Auth] Loaded backend {} succesfully.".format(backend)
+    else:
+        message = "[Auth] Failed to load backend {}.".format(backend)
+    if index is None:
+        print(message)
+    else:
+        SayText2(message=message).send(index)