Adapting plugins to implements a multisite web interface

lodel/plugins/multisite/loader_utils.py

@@ -36,6 +36,7 @@ import lodel.buildconf
 #@todo get rid of hardcoded stuff (like shortname fieldname)
 #@todo use the dyncode getter when it will be available (replaced by
 #the string SUPERDYNCODE_ACCESSOR.Lodelsite for the moment)
+#@return lodelsites instance name
 def main():
     #Set current context to reserved loader context
     from lodel import bootstrap
@@ -69,7 +70,6 @@ def main():
     Plugin.load_all()
     LodelHook.call_hook('lodel2_bootstraped', '__main__', None)
 
-
     lodelsite_leo = leapi_dyncode.Lodelsite #hardcoded leo name
     LodelContext.expose_modules(globals(), {
         'lodel.leapi.query': ['LeGetQuery'],
@@ -91,7 +91,7 @@ def main():
     else:
         logger.warning("No handled sites !")
     LodelContext.set(None)
-        
+    return lodelsites_name
     
 
 ##@brief Load a site
@@ -130,7 +130,6 @@ sux !')
     #Immediately switching to the context
     LodelContext.new(ctx_name)
     LodelContext.set(ctx_name)
-    print(LodelContext.get())
     os.chdir(data_path) #Now the confdir is ./$condir_basename
     #Loading settings for current site
     LodelContext.expose_modules(globals(), {

lodel/plugins/multisite/run.py

@@ -12,8 +12,18 @@ import lodel.buildconf #safe even outside contexts
 """
 
 from lodel.plugins.multisite.loader_utils import main, site_load, FAST_APP_EXPOSAL_CACHE
+from lodel.context import LodelContext
 
-main() #multisite bootstraping
+lodelsites_name = main() #multisite bootstraping
+
+#Switching back to lodelsites context in order to trigger hooks
+LodelContext.set(lodelsites_name)
+LodelContext.expose_modules(globals(), {
+    'lodel.plugin.hooks': ['LodelHook']})
+LodelHook.call_hook('lodel2_loader_main', '__main__', None)
+LodelContext.set(None)
+#If a hook is registered in lodelsites context for lodel2_loader_main
+#this function never returns
 
 import code
 print("""

lodel/plugins/multisite_web/__init__.py

@@ -0,0 +1,55 @@
+##@brief
+#
+#Lodel2 multisite uwsgi plugin
+
+from lodel.context import LodelContext, ContextError
+try:
+    LodelContext.expose_modules(globals(), {
+        'lodel.validator.validator': ['Validator']})
+
+    __plugin_type__ = 'ui' #Warning !!! It's a MULTISITE interface
+    __plugin_name__ = 'multisite_web'
+    __version__ = '0.0.1'
+    __loader__ = 'main.py'
+    #__plugin_deps__ = ['multisite']
+
+    CONFSPEC = {
+        'lodel2.server': {
+                'listen_address': ('127.0.0.1', Validator('dummy')),
+                #'listen_address': ('', Validator('ip')), #<-- not implemented
+                'listen_port': ( 1337, Validator('int')),
+                'uwsgi_workers': (8, Validator('int')),
+                'uwsgicmd': ('/usr/bin/uwsgi', Validator('dummy')),
+                'virtualenv': (None, Validator('path', none_is_valid = True)),
+            },
+        #A copy from webui confspec
+        ##@todo automatic merging of webuig confspecs
+        'lodel2.webui': {
+            'standalone': ( 'False',
+                            Validator('string')),
+            'listen_address': ( '127.0.0.1',
+                                Validator('dummy')),
+            'listen_port': (    '9090',
+                                Validator('int')),
+            'static_url': (     'http://127.0.0.1/static/',
+                                Validator('regex', pattern =  r'^https?://[^/].*$')),
+            'virtualenv': (None,
+                           Validator('path', none_is_valid=True)),
+            'uwsgicmd': ('/usr/bin/uwsgi', Validator('dummy')),
+            'cookie_secret_key': ('ConfigureYourOwnCookieSecretKey', Validator('dummy')),
+            'cookie_session_id': ('lodel', Validator('dummy')),
+            'uwsgi_workers': (2, Validator('int'))
+        },
+        'lodel2.webui.sessions': {
+            'directory': (  '/tmp',
+                            Validator('path')),
+            'expiration': ( 900,
+                            Validator('int')),
+            'file_template': (  'lodel2_%s.sess',
+                                Validator('dummy')),
+        }
+    }
+
+except ContextError:
+    #This case append when uwsgi call the run.py directly
+    pass

lodel/plugins/multisite_web/loader_utils.py

@@ -0,0 +1 @@
+../multisite/loader_utils.py

lodel/plugins/multisite_web/main.py

@@ -0,0 +1,50 @@
+import os
+import shlex
+from lodel.context import LodelContext
+import lodel.buildconf
+
+LodelContext.expose_modules(globals(), {
+    'lodel.plugin.hooks': ['LodelHook'],
+})
+
+##@brief Starts uwsgi in background using settings
+@LodelHook('lodel2_loader_main')
+def uwsgi_fork(hook_name, caller, payload):
+    
+    sockfile = os.path.join(lodel.buildconf.LODEL2VARDIR, 'uwsgi_sockets/')
+    if not os.path.isdir(sockfile):
+        os.mkdir(sockfile)
+    sockfile = os.path.join(sockfile, 'uwsgi_lodel2_multisite.sock')
+    logfile = os.path.join(
+        lodel.buildconf.LODEL2LOGDIR, 'uwsgi_lodel2_multisite.log')
+    
+    #Switching to __loader__ context
+    print("PASS1")
+    LodelContext.set(None)
+    print("PASS2")
+    LodelContext.expose_modules(globals(), {
+        'lodel.settings': ['Settings']})
+    print("PASS3")
+
+    cmd='{uwsgi} --plugin python3 --http-socket {addr}:{port} --module \
+lodel.plugins.multisite_web.run --socket {sockfile} --logto {logfile} -p {uwsgiworkers}'
+    cmd = cmd.format(
+                addr = Settings.server.listen_address,
+                port = Settings.server.listen_port,
+                uwsgi= Settings.server.uwsgicmd,
+                sockfile=sockfile,
+                logfile = logfile,
+                uwsgiworkers = Settings.server.uwsgi_workers)
+    if Settings.server.virtualenv is not None:
+        cmd += " --virtualenv %s" % Settings.webui.virtualenv
+
+    print("PASS4")
+    try:
+        args = shlex.split(cmd)
+        print("Running %s" % cmd)
+        exit(os.execl(args[0], *args))
+    except Exception as e:
+        print("Webui plugin uwsgi execl fails cmd was '%s' error : " % cmd,
+            e, file=sys.stderr)
+        exit(1)
+

lodel/plugins/multisite_web/run.py

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+import os
+import os.path
+import warnings
+
+##@brief File designed to be executed by an UWSGI process in order to
+#run a multisite instance process
+#
+#@warning In this module we have to be VERY carrefull about module exposure !
+#in fact here we will go through every context at least once and the globals
+#will be shared all among the module. So ANY exposed module will be accessible
+#for a short time outside its context !! A good way be protected about that
+#is to del(globals()[exposed_module_name]) after use. But it's really not
+#sure that this way of doing is a real safe protection !
+#
+#@par Expected context when called
+#- cwd has to be the lodelsites directory (the directory containing the 
+#conf.d folder)
+#
+#This file is divided in two blocks :
+#
+#@par Run at load
+#The main function will be called at import.
+#This piece of code handles :
+#- loading the lodelsites site (the site that handles sites ;) )
+#- fetch the list of handled lodel sites
+#- loading the whole list of lodel sites
+#
+#@par WSGI processing
+#The other functions are here to handles WSGI request. The entry function
+#is application(), following the PEP 3333 specifications
+
+try:
+    from lodel.context import LodelContext
+except ImportError:
+    LODEL_BASE_DIR = os.path.dirname(
+        os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+    from lodel.context import LodelContext, ContextError
+
+import lodel.buildconf #safe even outside contexts
+from lodel.plugins.multisite.loader_utils import main, site_load, FAST_APP_EXPOSAL_CACHE #UNSAFE ??!!
+lodelsites_name = main()
+LodelContext.set(lodelsites_name)
+FAST_APP_EXPOSAL_CACHE[lodelsites_name] = LodelContext.module(
+    'lodel.plugins.webui.run')
+LodelContext.set(None)
+
+##@brief Utility function to return quickly an error
+def http_error(env, start_response, status = '500 internal server error', \
+        extra = None):
+    headers = [('Content-type', 'text/plain; charset=utf-8')]
+    start_response(status, headers)
+    msg = status
+    if extra is not None:
+        msg = extra
+    return [msg.encode('utf-8')]
+
+
+##@brief utility function to extract site id from an url
+#@param url str : 
+def site_id_from_url(url):
+    res = ''
+    for c in url[1:]:
+        if c == '/':
+            break
+        res += c
+    if len(res) == 0:
+        return None
+    return res
+
+##@brief This method is run in a child process by the handler
+def application(env, start_response):
+    LodelContext.set(None) #Ensure context switching
+    #Attempt to load a context
+    site_id = site_id_from_url(env['PATH_INFO'])
+    if site_id is None:
+        #It can be nice to provide a list of instances here
+        return http_error(env, start_response, '404 Not Found')
+    try:
+        LodelContext.set(site_id)
+        #We are in the good context
+
+    except ContextError as e:
+        print(e)
+        return http_error(env, start_response, '404 Not found',
+            "No site named '%s'" % site_id)
+    #Calling webui
+    return FAST_APP_EXPOSAL_CACHE[site_id].application(env, start_response)
+    #LodelContext.expose_modules(globals(), {
+    #    'lodel.plugins.webui.run': ['application']})
+    #return application(env, start_response)
+

progs/slim/multisite_install_model/lodelsites.conf.d/lodel2.ini

@@ -3,6 +3,7 @@ debug = False
 sitename = @@@INSTANCE_NAME@@@
 datasource_connectors = dummy_datasource lodelsite_datasource
 session_handler = filesystem_session
+interface = multisite_web
 
 [lodel2.auth]
 login_classfield = lodelsite.shortname
@@ -30,15 +31,24 @@ identifier = dummy_datasource.default
 [lodel2.datasource.dummy_datasource.default]
 dummy =
 
-#[lodel2.datasources.default]
-#identifier = lodelsite_datasource.default
+#Example using a real datasource
+#
+#[lodel2.lodelsites]
+#sites_emfile = sites_em.pickle
+#lodelsites_emfile = editorial_model.pickle
+#
+#[lodel2.datasource.lodelsite_datasource.default]
+#db_datasource = mongodb.datasource.default
 #
-#[lodel2.datasources.mongo]
+#[lodel2.datasources.default]
 #identifier = mongodb_datasource.default
 #
 #[lodel2.datasources.dummy2]
 #identifier = mongodb_datasource.default
 #
+#[lodel2.datasource.dummy_datasource.default]
+#dummy =
+#
 #[lodel2.datasource.mongodb_datasource.default]
 #host = HOSTNAME
 #username = USERNAME