New plugins organisation + utility methods + manage_lodel.py script

Lodel/hooks.py

@@ -1,6 +1,7 @@
 #-*- coding: utf-8 -*-
 
 import os
+import copy
 from importlib.machinery import SourceFileLoader
 
 from Lodel.settings import Settings
@@ -65,4 +66,16 @@ class LodelHook(object):
             for hook in cls._hooks[hook_name]:
                 payload = hook(hook_name, caller, payload)
         return payload
+    
+    ## @brief Fetch registered hooks
+    # @param names list | None : optionnal filter on name
+    # @return a list of functions
+    @classmethod
+    def hook_list(cls, names = None):
+        res = None
+        if names is not None:
+            res = { name: copy.copy(cls._hooks[name]) for name in cls._hooks if name in names}
+        else:
+            res = copy.copy(cls._hooks)
+        return { name: [(hook._hook, hook._priority) for hook in hooks] for name, hooks in res.items() }
 

Lodel/plugins.py

@@ -0,0 +1,87 @@
+#-*- coding: utf-8 -*-
+
+import inspect
+import os, os.path
+import warnings
+
+from Lodel.settings import Settings
+from Lodel.hooks import LodelHook
+from Lodel.user import authentication_method, identification_method
+
+
+## @brief Returns a list of human readable registered hooks
+# @param names list | None : optionnal filter on name
+# @param plugins list | None : optionnal filter on plugin name
+# @return A str representing registered hooks
+def list_hooks(names = None, plugins = None):
+    res = ""
+    # Hooks registered and handled by Lodel.usera
+    for decorator in [authentication_method, identification_method]:
+        if names is None or decorator.__name__ in names:
+            res += "%s :\n" % decorator.__name__
+            for hook in decorator.list_methods():
+                module = inspect.getmodule(hook).__name__
+                if plugins is not None: # Filter by plugin
+                    spl = module.split('.')
+                    if spl[-1] not in plugins:
+                        continue
+                res += "\t- %s.%s\n" % (module, hook.__name__)
+    # Hooks registered and handled by Lodel.hooks
+    registered_hooks = LodelHook.hook_list(names)
+    for hook_name, hooks in registered_hooks.items():
+        if names is None or hook_name in names:
+            res += "%s :\n" % hook_name
+            for hook, priority in hooks:
+                module = inspect.getmodule(hook).__name__
+                if plugins is not None: # Filter by plugin
+                    spl = module.split('.')
+                    if spl[-1] not in plugins:
+                        continue
+                res += "\t- %s.%s ( priority %d )\n" % (module, hook.__name__, priority)
+    return res
+
+## @brief Return a human readable list of plugins
+# @param activated bool | None : Optionnal filter on activated or not plugin
+# @return a str
+def list_plugins(activated = None):
+    res = ""
+    # Activated plugins
+    if activated is None or activated:
+        res += "Activated plugins :\n"
+        for plugin_name in Settings.plugins:
+            res += "\t- %s\n" % plugin_name
+    # Deactivated plugins
+    if activated is None or not activated:
+        plugin_dir = os.path.join(Settings.lodel2_lib_path, 'plugins')
+        res += "Not activated plugins :\n"
+        all_plugins = [fname for fname in os.listdir(plugin_dir) if fname != '.' and fname != '..' and fname != '__init__.py']
+        for plugin_name in all_plugins:
+            if os.path.isfile(os.path.join(plugin_dir, plugin_name)) and plugin_name.endswith('.py'):
+                plugin_name = ''.join(plugin_name.split('.')[:-1])
+            elif not os.path.isdir(os.path.join(plugin_dir, plugin_name)):
+                warnings.warn("Dropped file in plugins directory : '%s'" % (os.path.join(plugin_dir, plugin_name)))
+                continue
+            elif plugin_name == '__pycache__':
+                continue
+
+            if plugin_name not in Settings.plugins:
+                res += "\t- %s\n" % plugin_name
+    return res
+
+## @brief Utility function that generate the __all__ list of the plugins/__init__.py file
+# @return A list of module name to import
+def _all_plugins():
+    plugin_dir = os.path.join(Settings.lodel2_lib_path, 'plugins')
+    res = list()
+    for plugin_name in Settings.plugins:
+        if os.path.isdir(os.path.join(plugin_dir, plugin_name)):
+            # plugin is a module
+            res.append('%s' % plugin_name)
+            #res.append('%s.loader' % plugin_name)
+        elif os.path.isfile(os.path.join(plugin_dir, '%s.py' % plugin_name)):
+            # plugin is a simple python sourcefile
+            res.append('%s' % plugin_name)
+    return res
+            
+            
+    

Lodel/settings.py

@@ -88,6 +88,14 @@ class SettingsHandler(object):
             err_msg = "Found invalid settings in %s : %s"%(module.__name__, errors)
             raise LookupError(err_msg)
 
+    ## @brief Refresh the allowed and mandatory settings list
+    @classmethod
+    def _refresh_format(cls):
+        ## @brief Shortcut
+        cls._allowed = settings_format.ALLOWED + settings_format.MANDATORY
+        ## @brief Shortcut
+        cls._mandatory = settings_format.MANDATORY
+
     ## @brief If some settings are missings return their names
     # @return an array of string
     def _missings(self):

Lodel/user.py

@@ -6,6 +6,7 @@
 # Classes defined in this package are "helpers" for Lodel2 UI
 
 import warnings
+import copy
 from Lodel.settings import Settings
 
 ## @brief Represent a Lodel user identity
@@ -121,6 +122,12 @@ class authentication_method(object):
                 res = ret
         return res
 
+    ## @return registered identification methods
+    @classmethod
+    def list_methods(cls):
+        return list(copy.copy(cls.__methods))
+
+
 
 ## @brief Decorator class designed to register identification methods
 #
@@ -161,6 +168,11 @@ class identification_method(object):
                         return ret
                     res = ret
         return res
+    
+    ## @return registered identification methods
+    @classmethod
+    def list_methods(cls):
+        return list(copy.copy(cls.__methods))
 
 
 ## @brief Static class designed to handle user context

lodel_init.sh

@@ -33,6 +33,7 @@ mkdir -pv "$instdir"
 
 cp -v $libdir/install/* $instdir
 rm -fv $instdir/__init__.py
+cp -v $libdir/manage_lodel.py $instdir
 
 sed -i -e "s#LODEL2_LIB_ABS_PATH#$libdir#" "$settings"
 sed -i -e "s#LODEL2_INSTANCE_NAME#$name#" "$settings"

manage_lodel.py

@@ -0,0 +1,64 @@
+#-*- coding: utf-8 -*-
+
+import sys
+import argparse
+
+try:
+    from loader import *
+except ImportError: pass
+
+from plugins import *
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+                        '--list-hooks',
+                        action='store_const',
+                        const=True,
+                        default=False,
+                        help='Display the list of registered hooks'
+    )
+    parser.add_argument(
+                        '--list-plugins',
+                        action='store_const',
+                        const=True,
+                        default=False,
+                        help='Display the list of plugins'
+    )
+    parser.add_argument(
+                        '--plugin',
+                        action='store',
+                        type=str,
+                        metavar='PLUGIN_NAME',
+                        nargs='+',
+                        help='Filter on plugins name'
+    )
+    parser.add_argument(
+                        '--hookname',
+                        action='store',
+                        type=str,
+                        metavar='HOOK_NAME',
+                        nargs='+',
+                        help='Filter on hook name'
+    )
+    kwargs = parser.parse_args()
+
+    # Listing registered hooks
+    if kwargs.list_hooks:
+        import Lodel.plugins
+        list_args = {}
+        if kwargs.plugin is not None and len(kwargs.plugin) > 0:
+            list_args['plugins'] = kwargs.plugin
+        if kwargs.hookname is not None and len(kwargs.hookname) > 0:
+            list_args['names'] = kwargs.hookname
+            
+        print(Lodel.plugins.list_hooks(**list_args))
+        exit(0)
+    # Listing plugins
+    elif kwargs.list_plugins:
+        import Lodel.plugins
+        print(Lodel.plugins.list_plugins())
+        exit(0)
+
+    parser.print_help()
+    exit(1)

plugins/__init__.py

@@ -1,2 +1,2 @@
-import Lodel.settings
-__all__ = Lodel.settings.Settings.plugins
+import Lodel.plugins
+__all__ = Lodel.plugins._all_plugins()

plugins/acl/__init__.py

@@ -0,0 +1,2 @@
+__all__ = ['acl', 'conf']
+from . import *

plugins/acl.py → plugins/acl/acl.py

@@ -5,15 +5,15 @@ from Lodel.user import UserContext
 
 class PermissionDenied(Exception): pass
 
-@LodelHook('leapi_get_pre')
+@LodelHook('leapi_get_pre', 1)
 def check_anon(hook_name, caller, payload):
     if not UserContext.identity().is_identified:
         raise PermissionDenied("Anonymous user's are not allowed to get content")
     return payload
 
-@LodelHook('leapi_update_pre')
-@LodelHook('leapi_delete_pre')
-@LodelHook('leapi_insert_pre')
+@LodelHook('leapi_update_pre', 1)
+@LodelHook('leapi_delete_pre', 1)
+@LodelHook('leapi_insert_pre', 1)
 def check_auth(hook_name, caller, payload):
     if not UserContext.identity().is_authenticated:
         raise PermissionDenied("Only authenticated user's are allowed to do that !")

plugins/acl/conf.py

@@ -0,0 +1,9 @@
+#-*- coding: utf-8 -*-
+
+import Lodel.settings_format
+from Lodel.settings import Settings
+
+Lodel.settings_format.ALLOWED.append('acl_settings')
+Settings._refresh_format()
+Settings.acl_settings = { 'super': 42, 'foo': None }
+