Merge branch 'lodelsites-dev' of git@git.labocleo.org:lodel2 into lodelsites-dev

Conflicts:
	lodel/buildconf.py.am.in

lodel/buildconf.py.am.in

@@ -7,8 +7,14 @@ WEBUI=@WEBUI@
 LODEL2VARDIR="[@]LODEL2_VARDIR[@]"
 LODEL2LOGDIR="[@]LODEL2_LOGDIR[@]"
 
-import os
 
+<<<<<<< HEAD
 MULTISITE_DATADIR = os.path.join(LODEL2VARDIR, 'sites_datas')
 MULTISITE_CONTEXTDIR = os.path.join(LODEL2VARDIR, '.sites_context')
-LODEL_PKG_PATH = '/usr/lib/python3/dist-package/lodel'
+LODEL_PKG_PATH = '/usr/lib/python3/dist-package/lodel'
+=======
+MULTISITE_DATADIR = 'sites_datas'
+MULTISITE_CONTEXTDIR = '.site_contexts'
+MULTISITE_DYNCODE_MODULENAME = 'leapi_dyncode'
+
+>>>>>>> branch 'lodelsites-dev' of git@git.labocleo.org:lodel2

lodel/context.py

@@ -16,11 +16,13 @@ if 'lodel' not in sys.modules:
 else:
     globals()['lodel'] = sys.modules['lodel']
 
-if 'lodelsites' not in sys.modules:
-    import lodelsites
-else:
+if 'lodelsites' in sys.modules:
+    #This should be true since LodelContext init method is called
+    #for a MULTISITE context handling
     globals()['lodelsites'] = sys.modules['lodelsites']
 
+from lodel import buildconf
+
 ##@brief Name of the package that will contains all the virtual lodel
 #packages
 CTX_PKG = "lodelsites"
@@ -60,6 +62,7 @@ def dir_for_context(site_identifier):
 #to represent the lodel package os the FS and then we make python import
 #files from the symlink.
 #
+#
 #@note Current implementation is far from perfection. In fact no deletion
 #mechanisms is written and the virtual package cannot be a subpackage of
 #the lodel package for the moment...
@@ -68,6 +71,13 @@ def dir_for_context(site_identifier):
 #lodelsites/SITENAME/ folder
 class LodelMetaPathFinder(importlib.abc.MetaPathFinder):
     
+    ##@brief implements the find_spec method of MetaPathFinder
+    #
+    #@param fullname str : module fullname
+    #@param path str : with be the value of __path__ of the parent package
+    #@param target module : is a module object that the finder may use to
+    #make a more educated guess about what spec to return
+    #@see https://docs.python.org/3/library/importlib.html#importlib.abc.MetaPathFinder
     def find_spec(fullname, path, target = None):
         if fullname.startswith(CTX_PKG):
             spl = fullname.split('.')
@@ -84,6 +94,38 @@ class LodelMetaPathFinder(importlib.abc.MetaPathFinder):
 ##@brief Class designed to handle context switching and virtual module
 #exposure
 #
+#The main entrypoint of this class is the expose_module method. A kind of
+#equivalent of the various import X [as Y], from X import Y [as Z] etc.
+#existing in Python.
+#The expose_module method add a preffix to the module fullname in order
+#to make it reconizable by the LodelMetaPathfinder::find_spec() method.
+#All module names are translated before import. The preffix is set at
+#__init__ call in __pkg_name. The resulting name is __pkg_name + fullname
+#
+#@par examples 
+#When asking for lodel.leapi.leobject :
+#- in MONOSITE resulting module will be lodel.leapi.leobject
+#- in MULTISITE resulting module name will be 
+#lodelsites.SITE_ID.lodel.leapi.leobject
+#
+#The lodelsites package will be a subdir of buildconf.MULTISITE_CONTEXTDIR
+#that will be itself added to sys.path in order to be able to import
+#lodelsites
+#
+#@par Notes about dyncode exposure
+#In MULTISITE mode the dyncode will be stored as a python module in 
+#buildconf.MULTISITE_CONTEXTDIR/SITE_ID/leapi_dyncode.py . The dyncode
+#exposale process in MULTISITE mode is simply done by asking LodelContext
+#to expose a module named leapi_dyncode. The LodelContext::_translate()
+#method is able to produce a correct name for this module.
+#In MONOSITE mode the dyncode will be stored as a python module in 
+#the site directory. In this case the _translate method will do the same
+#transformation than for the others modules. But in MONOSITE mode the 
+#module preffix is empty. Resulting in import leapi_dyncode. This will
+#work asserting that cwd in MONOSITE mode is the instance directory.
+#
+#
+#
 #@note a dedicated context named LOAD_CTX is used as context for the 
 #loading process
 class LodelContext(object):
@@ -102,7 +144,14 @@ class LodelContext(object):
 
     ##@brief Flag indicating if the classe is initialized
     __initialized = False
-    
+
+    ##@brief Stores path used by MULTISITE instance
+    #
+    #This variable is a tuple with 2 elements (in this order):
+    #- lodelsites datadir (ex: /var/lodel2/MULTISITE_NAME/datadir/)
+    #- lodelsites contextdir (ex: /varL/lodel2/MULTISITE_NAME/.ctx/lodelsites)
+    __lodelsites_paths = None
+
     ##@brief Create a new context
     #@see LodelContext.new()
     def __init__(self, site_id, instance_path = None):
@@ -121,7 +170,7 @@ site_id set to None when we are in MULTISITE beahavior")
             else:
                 #More verification can be done here (singleton specs ? )
                 self.__class__._current = self.__class__._contexts = self
-                self.__pkg_name = 'lodel'
+                self.__pkg_name = ''
                 self.__package = lodel
                 self.__instance_path = os.getcwd()
                 return
@@ -137,7 +186,7 @@ site_id when we are in MONOSITE beahvior")
                 raise ContextError(
                     "A context named '%s' allready exists." % site_id)
             self.__id = site_id
-            self.__pkg_name = '%s.%s' % (CTX_PKG, site_id)
+            self.__pkg_name = '%s.%s.' % (CTX_PKG, site_id)
 
             if instance_path is None:
                 """
@@ -194,6 +243,11 @@ site_id set to None when we are in MULTISITE beahavior")
                 raise ContextError("Cannot have a context with \
     site_id set when we are in MONOSITE beahavior")
     
+    ##@return identifier for current context
+    @classmethod
+    def current_id(cls):
+        return cls._current.__id
+
     ##@return True if the class is in MULTISITE mode
     @classmethod
     def multisite(cls):
@@ -208,20 +262,38 @@ site_id set to None when we are in MULTISITE beahavior")
         return cls.get(target_ctx_id)
 
     ##@brief Set a context as active
+    #
+    #This method handle the context switching operations. Some static 
+    #attributes are set at this step.
+    #@note if not in LOAD_CTX a sys.path update is done
+    #@warning Inconsistency with lodelsites_datasource, we build again the
+    #site context dir path using site_id. This information should come
+    #from only one source
     #@param site_id str : site identifier (identify a context)
+    #@todo unify the generation of the site specific context dir path
     @classmethod
     def set(cls, site_id):
         if cls._type == cls.MONOSITE:
             raise ContextError("Context cannot be set in MONOSITE beahvior")
+
         site_id = LOAD_CTX if site_id is None else site_id
         if not cls.validate_identifier(site_id):
             raise ContextError("Given context name is not a valide identifier \
 : '%s'" % site_id)
         if site_id not in cls._contexts:
             raise ContextError("No context named '%s' found." % site_id)
+        if cls.current_id != LOAD_CTX and site_id != LOAD_CTX:
+            raise ContextError("Not allowed to switch into a site context \
+from another site context. You have to switch back to LOAD_CTX before")
+        if site_id != LOAD_CTX and cls.__lodelsites_paths is None:
+            #The paths are not set yet. That mean that we switch into another
+            #context for the first time. We should be able to access the 
+            #LOAD_CTX settings (containing the sites_handler_name)
+            cls._generate_lodelsites_path()
+
         wanted_ctx = cls._contexts[site_id]
         if hasattr(wanted_ctx, '__instance_path'):
-            os.chdir(self.__instance_path) #May cause problems
+            os.chdir(self.__instance_path) #May cause problems and may be obsolete
         cls._current = wanted_ctx
         return cls._current
     
@@ -285,6 +357,9 @@ site_id set to None when we are in MULTISITE beahavior")
     
     ##@brief Return a module from current context
     #@param fullname str : module fullname
+    #@todo check if not globals are set when getting a module ! (if so
+    #checks all calls to this method to check that this assertion was not 
+    #made)
     @classmethod
     def module(cls, fullname):
         return cls.get().get_module(fullname)
@@ -292,12 +367,13 @@ site_id set to None when we are in MULTISITE beahavior")
     ##@brief Expose leapi_dyncode module
     @classmethod
     def expose_dyncode(cls, globs, alias = 'leapi_dyncode'):
-        cls.get()._expose_dyncode(globs, alias)
+        cls.get().expose_module(globs, 'leapi_dyncode')
 
     ##@brief Initialize the context manager
     #
     #@note Add the LodelMetaPathFinder class to sys.metapath if type is
     #LodelContext.MULTISITE
+    #@note lodelsites package name is hardcoded and has to be
     #@param type FLAG : takes value in LodelContext.MONOSITE or
     #LodelContext.MULTISITE
     @classmethod
@@ -315,6 +391,7 @@ initialize it anymore")
             #Create and set __loader__ context
             cls.new(LOAD_CTX)
             cls.set(LOAD_CTX)
+            
         else:
             #Add a single context with no site_id
             cls._contexts = cls._current = cls(None)
@@ -386,8 +463,39 @@ MONOSITE mode")
                 "Unable to create a context named '%s'" % site_id)
         cls.new(site_id, path)
         return site_id
+    
+    ##@brief Return a tuple containing lodelsites datadir & contextdir (
+    #in this order)
+    @classmethod
+    def lodelsites_paths(cls):
+        return copy.copy(cls.__lodelsites_paths)
 
-
+    ##@brief Generate lodelsites paths from LOAD_CTX configuration
+    #
+    #@warning Handles import of the lodelsites package
+    #
+    #Called when the first context switch outside LOAD_CTX is done
+    @classmethod
+    def _generate_lodelsites_path(cls):
+        if cls.__current.__id != LOAD_CTX:
+            raise ContextError("Not allowed when not in LOAD_CTX !!!")
+        if cls.__lodelsites_paths is not None:
+            raise ContextError("Allready done !!!")
+        load_ctx_settings = cls.module('lodel.settings.setting.SettingsRO')
+        lodesites_name = load_ctx_settings.lodelsites.name
+        del(globals()['lodel.settings.setting.SettingsRO']) #Not sure !
+        lodelsites_path = os.path.join(
+            buildconf.LODEL2VARDIR, lodelsites_name)
+        cls.__lodelsites_paths = (
+            os.path.join(lodelsites_path, buildconf.MULTISITE_DATADIR),
+            os.path.join(lodelsites_path, os.path.join(
+                buildconf.MULTISITE_CONTEXTDIR, 'lodelsites')))
+        #Now we are able to import lodelsites package
+        sys.path.append(cls.__lodelsites_paths[1])
+        if 'lodelsites' not in sys.modules:
+            import lodelsites
+        else:
+            globals()['lodelsites'] = sys.modules['lodelsites']
 
     ##@brief Utility method to expose a module with an alias name in globals
     #@param globs globals() : concerned globals dict
@@ -420,27 +528,22 @@ MONOSITE mode")
             msg = "Module %s does not have any of [%s] as attribute" % (
                 fullname, ','.join(errors))
             raise ImportError(msg)
-    
-    ##@brief Implements LodelContext::expose_dyncode()
-    #@todo change hardcoded leapi_dyncode.py filename
-    def _expose_dyncode(self, globs, alias = 'leapi_dyncode'):
-        fullname = '%s.%s.dyncode' % (CTX_PKG, self.__id)
-        if fullname in sys.modules:
-            dyncode = sys.modules[fullname]
-        else:
-            path = os.path.join(self.__instance_path, 'leapi_dyncode.py')
-            sfl = importlib.machinery.SourceFileLoader(fullname, path)
-            dyncode = sfl.load_module()
-        self.safe_exposure(globs, dyncode, alias)
-    
+
     ##@brief Translate a module fullname to the context equivalent
+    #
+    #Two transformation are possible :
+    #- we are importing a submodule of the lodel package : resulting module
+    #name will be : self.__pkg_name + module_fullname
+    #- we are importing the dyncode : resulting module name is :
+    #self.__pkg_name + dyncode_modulename
     #@param module_fullname str : a module fullname
     #@return The module name in the current context
     def _translate(self, module_fullname):
-        if not module_fullname.startswith('lodel'):
-            raise ContextModuleError("Given module is not lodel or any \
-submodule : '%s'" % module_fullname)
-        return module_fullname.replace('lodel', self.__pkg_name)
+        if not module_fullname.startswith('lodel') and \
+                not module_fullname.startswith('leapi_dyncode'):
+            raise ContextModuleError("Given module is not lodel nor dyncode \
+or any submodule : '%s'" % module_fullname)
+        return self.__pkg_name+module_fullname
 
     ##@brief Implements the with statement behavior
     #@see https://www.python.org/dev/peps/pep-0343/

lodel/plugins/multisite/confspecs.py

@@ -6,8 +6,18 @@ LodelContext.expose_modules(globals(), {
 LODEL2_CONFSPECS = {
     'lodel2': {
         'debug': (True, SettingValidator('bool')),
-        'sites_handler_name': (None,
-            SettingValidator('string', none_is_valid = False)),
+    },
+    'lodel2.lodelsites': {
+        'name': (None,
+            SettingValidator('string', none_is_valid = False)), #Bad validator
+        'lodelsites_emfile': (None,
+            SettingValidator('string', none_is_valid = False)), #Bad validator
+        'lodelsites_emtranslator': ('picklefile',
+            SettingValidator('strip', none_is_valid = False)), #Bad validator
+        'sites_emfile': (None,
+            SettingValidator('string', none_is_valid = False)), #Bad validator
+        'site_emtranslator': ('picklefile',
+            SettingValidator('string', none_is_valid = False)), #Bad validator
     },
     'lodel2.server': {
         'listen_address': ('127.0.0.1', SettingValidator('dummy')),

plugins

@@ -1 +1 @@
-lodel/plugins/
+lodel/plugins