Update instances (new loader and utils)

Lodel/settings_format.py

@@ -4,17 +4,20 @@
 ## @brief List mandatory configurations keys
 MANDATORY = [
     'debug',
-    'debug_sql',
+
     'sitename',
-    'lodel2_lib_path',
     'em_file',
-    'dynamic_code_file',
-    'acl_dyn_api',
+
+    'acl_bypass',
+
+    'debug_sql',
     'ds_package',
     'datasource',
     'mh_classname',
     'migration_options',
-    'base_path'
+
+    'base_path',
+    'lodel2_lib_path',
 ]
 
 ## @brief List allowed (but not mandatory) configurations keys
@@ -23,3 +26,4 @@ ALLOWED = [
     'em_graph_format',
     'templates_base_dir'
 ]
+

install/Makefile

@@ -1,8 +1,11 @@
 all: refreshdyn dbinit dirinit
 
-refreshdyn: distclean
+refreshdyn: cleandyn dyncode
 	python -c "import utils; utils.refreshdyn()"
 
+dyncode:
+	mkdir dyncode; touch dyncode/__init__.py
+
 dbinit:
 	python -c "import utils; utils.db_init()"
 
@@ -14,11 +17,13 @@ emgraph:
 
 .PHONY: clean cleanpycache cleanpyc refreshdyn distclean
 
-distclean: clean
-	-@rm -vf dynleapi.py api.py
+distclean: clean cleandyn
 
 clean: cleanpycache
 
+cleandyn: cleanpycache
+	-@rm -vf dyncode/internal_api.py dyncode/acl_api.py dyncode/__init__.py ; rmdir dyncode
+
 cleanpyc:
 	-@rm -vf *.pyc
 

install/README.txt

@@ -1,6 +1,8 @@
 Common operations :
 ===================
 
+Configuration file : instance_settings.py
+
 Refresh leapi dynamic code (when the Editorial Model is updated) :
 	make refreshdyn
 
@@ -9,3 +11,68 @@ Update or init the database :
 
 To run an interactive python interpreter in the instance environnment run :
 	python loader.py
+
+Instance documentation
+======================
+
+loader.py
+---------
+
+This file expose all classes needed for a Lodel2 user :
+- All the dynamic code classes
+- leapidatasource
+- migrationhandler
+
+All those classes are imported/exposed given options. LeapiDataSource and the migration handler depends on the choosen datasource, and the dynamic code classes can be wrapped or not by ACL (the acl_bypass configuration variable)
+
+utils.py
+--------
+
+This file contains usefull utilities to manage an instance and import & expose the Lodel.settings.Settings class when imported.
+
+THIS FILE HAS TO BE IMPORTED IN ORDER TO BE ABLE TO ACCESS LODEL2 SETTINGS.
+
+### utility functions
+
+- utils.dyn_module_fullname  returns the module fullname for leapi or aclapi (Constant values hardcoded in the loader to be able to use from Foo import * syntax)
+- utils.dyn_code_filename : return the python code filename for leapi or aclapi (Constant values)
+- utils.refreshdyn : refresh dynamic code
+- utils.dbinit : Run full db migration
+- utils.em_graph : generate graphviz graph representing the editorial model
+- utils.dir_init : ???
+
+instance_settings.py
+--------------------
+
+Instance settings file
+
+dyncode directory
+-----------------
+
+Contains dynamically generated python code
+
+### dyncode/internal_api.py
+
+leapi dynamically generated code. Import this to be able to use the API without ACL
+
+### dyncode/acl_api.py
+
+ACL wrapper for leapi classes. Public access HAVE TO use the classes defined in this file.
+
+Makefile
+--------
+
+Defined target :
+- all : refresh dynamic code, init the database and init the directory
+- emgraph : generated graphviz graph representing the editorial model
+- refreshdyn : refresh dynamic code
+- dbinit : init the DB
+- dirinit : ???
+- clean : clean python *.pyc files and __pycache__ directories
+- distclean : call clean target and delete dynamically generated code
+
+em.json
+-------
+
+Contains the default EM for an instance
+

install/dynleapi.py

@@ -1,171 +0,0 @@
-## @author LeFactory
-
-import EditorialModel
-from EditorialModel import fieldtypes
-from EditorialModel.fieldtypes import naturerelation, char, integer, datetime, pk
-
-import leapi
-import leapi.lecrud
-import leapi.leobject
-import leapi.lerelation
-from leapi.leclass import _LeClass
-from leapi.letype import _LeType
-
-import DataSource.MySQL.leapidatasource
-
-
-## @brief _LeCrud concret class
-# @see leapi.lecrud._LeCrud
-class LeCrud(leapi.lecrud._LeCrud):
-    _datasource = DataSource.MySQL.leapidatasource.LeDataSourceSQL(**{})
-    _uid_fieldtype = None
-
-## @brief _LeObject concret class
-# @see leapi.leobject._LeObject
-class LeObject(LeCrud, leapi.leobject._LeObject):
-    _me_uid = {1: 'Textes', 2: 'Personnes', 19: 'Numero', 5: 'Article', 6: 'Personne', 13: 'Publication', 14: 'Rubrique'}
-    _uid_fieldtype = { 'lodel_id': EditorialModel.fieldtypes.pk.EmFieldType(**{'internal': 'automatic'}) }
-    _leo_fieldtypes = {
-	'creation_date': EditorialModel.fieldtypes.datetime.EmFieldType(**{'now_on_create': True, 'internal': 'automatic'}),
-	'string': EditorialModel.fieldtypes.char.EmFieldType(**{'max_length': 128, 'internal': 'automatic'}),
-	'modification_date': EditorialModel.fieldtypes.datetime.EmFieldType(**{'now_on_update': True, 'now_on_create': True, 'internal': 'automatic'}),
-	'type_id': EditorialModel.fieldtypes.integer.EmFieldType(**{'internal': 'automatic'}),
-	'class_id': EditorialModel.fieldtypes.integer.EmFieldType(**{'internal': 'automatic'})
-	}
-
-## @brief _LeRelation concret class
-# @see leapi.lerelation._LeRelation
-class LeRelation(LeCrud, leapi.lerelation._LeRelation):
-    _uid_fieldtype = { 'id_relation': EditorialModel.fieldtypes.pk.EmFieldType(**{'internal': 'automatic'}) }
-    _rel_fieldtypes = {
-	'rank': EditorialModel.fieldtypes.integer.EmFieldType(**{'internal': 'automatic'}),
-	'nature': EditorialModel.fieldtypes.naturerelation.EmFieldType(**{}),
-	'depth': EditorialModel.fieldtypes.integer.EmFieldType(**{'internal': 'automatic'})
-	}
-    _rel_attr_fieldtypes = dict()
-
-class LeHierarch(LeRelation, leapi.lerelation._LeHierarch):
-    _rel_attr_fieldtypes = dict()
-
-class LeRel2Type(LeRelation, leapi.lerelation._LeRel2Type):
-    pass
-
-class LeClass(LeObject, _LeClass):
-    pass
-
-class LeType(LeClass, _LeType):
-    pass
-
-## @brief EmClass Textes LeClass child class
-# @see leapi.leclass.LeClass
-class Textes(LeClass, LeObject):
-    _class_id = 1
-
-
-## @brief EmClass Personnes LeClass child class
-# @see leapi.leclass.LeClass
-class Personnes(LeClass, LeObject):
-    _class_id = 2
-
-
-## @brief EmClass Publication LeClass child class
-# @see leapi.leclass.LeClass
-class Publication(LeClass, LeObject):
-    _class_id = 13
-
-
-## @brief EmType Article LeType child class
-# @see leobject::letype::LeType
-class Article(LeType, Textes):
-    _type_id = 5
-
-
-## @brief EmType Personne LeType child class
-# @see leobject::letype::LeType
-class Personne(LeType, Personnes):
-    _type_id = 6
-
-
-## @brief EmType Rubrique LeType child class
-# @see leobject::letype::LeType
-class Rubrique(LeType, Publication):
-    _type_id = 14
-
-
-## @brief EmType Numero LeType child class
-# @see leobject::letype::LeType
-class Numero(LeType, Publication):
-    _type_id = 19
-
-
-class Rel_textes2personne(LeRel2Type):
-    _rel_attr_fieldtypes = {
-    'adresse': EditorialModel.fieldtypes.char.EmFieldType(**{'uniq': False, 'nullable': True, 'internal': False})
-}
-
-
-#Initialisation of Textes class attributes
-Textes._fieldtypes = {
-    'modification_date': EditorialModel.fieldtypes.datetime.EmFieldType(**{'nullable': False, 'uniq': False, 'now_on_update': True, 'now_on_create': True, 'internal': 'automatic'}),
-    'soustitre': EditorialModel.fieldtypes.char.EmFieldType(**{'uniq': False, 'nullable': True, 'internal': False}),
-    'string': EditorialModel.fieldtypes.char.EmFieldType(**{'nullable': True, 'uniq': False, 'max_length': 128, 'internal': 'automatic'}),
-    'titre': EditorialModel.fieldtypes.char.EmFieldType(**{'uniq': False, 'nullable': True, 'internal': False}),
-    'bleu': EditorialModel.fieldtypes.char.EmFieldType(**{'uniq': False, 'nullable': True, 'internal': False}),
-    'lodel_id': EditorialModel.fieldtypes.pk.EmFieldType(**{'uniq': False, 'nullable': False, 'internal': 'automatic'}),
-    'type_id': EditorialModel.fieldtypes.integer.EmFieldType(**{'uniq': False, 'nullable': False, 'internal': 'automatic'}),
-    'class_id': EditorialModel.fieldtypes.integer.EmFieldType(**{'uniq': False, 'nullable': False, 'internal': 'automatic'}),
-    'creation_date': EditorialModel.fieldtypes.datetime.EmFieldType(**{'uniq': False, 'nullable': False, 'now_on_create': True, 'internal': 'automatic'})
-}
-Textes._linked_types = [Personne]
-Textes._classtype = 'entity'
-
-#Initialisation of Personnes class attributes
-Personnes._fieldtypes = {
-    'nom': EditorialModel.fieldtypes.char.EmFieldType(**{'uniq': False, 'nullable': True, 'internal': False}),
-    'age': EditorialModel.fieldtypes.char.EmFieldType(**{'uniq': False, 'nullable': True, 'internal': False}),
-    'prenom': EditorialModel.fieldtypes.char.EmFieldType(**{'uniq': False, 'nullable': True, 'internal': False}),
-    'string': EditorialModel.fieldtypes.char.EmFieldType(**{'nullable': True, 'uniq': False, 'max_length': 128, 'internal': 'automatic'}),
-    'lodel_id': EditorialModel.fieldtypes.pk.EmFieldType(**{'uniq': False, 'nullable': False, 'internal': 'automatic'}),
-    'modification_date': EditorialModel.fieldtypes.datetime.EmFieldType(**{'nullable': False, 'uniq': False, 'now_on_update': True, 'now_on_create': True, 'internal': 'automatic'}),
-    'type_id': EditorialModel.fieldtypes.integer.EmFieldType(**{'uniq': False, 'nullable': False, 'internal': 'automatic'}),
-    'class_id': EditorialModel.fieldtypes.integer.EmFieldType(**{'uniq': False, 'nullable': False, 'internal': 'automatic'}),
-    'creation_date': EditorialModel.fieldtypes.datetime.EmFieldType(**{'uniq': False, 'nullable': False, 'now_on_create': True, 'internal': 'automatic'})
-}
-Personnes._linked_types = []
-Personnes._classtype = 'person'
-
-#Initialisation of Publication class attributes
-Publication._fieldtypes = {
-    'modification_date': EditorialModel.fieldtypes.datetime.EmFieldType(**{'nullable': False, 'uniq': False, 'now_on_update': True, 'now_on_create': True, 'internal': 'automatic'}),
-    'creation_date': EditorialModel.fieldtypes.datetime.EmFieldType(**{'uniq': False, 'nullable': False, 'now_on_create': True, 'internal': 'automatic'}),
-    'string': EditorialModel.fieldtypes.char.EmFieldType(**{'nullable': True, 'uniq': False, 'max_length': 128, 'internal': 'automatic'}),
-    'lodel_id': EditorialModel.fieldtypes.pk.EmFieldType(**{'uniq': False, 'nullable': False, 'internal': 'automatic'}),
-    'titre': EditorialModel.fieldtypes.char.EmFieldType(**{'uniq': False, 'nullable': True, 'internal': False}),
-    'type_id': EditorialModel.fieldtypes.integer.EmFieldType(**{'uniq': False, 'nullable': False, 'internal': 'automatic'}),
-    'class_id': EditorialModel.fieldtypes.integer.EmFieldType(**{'uniq': False, 'nullable': False, 'internal': 'automatic'})
-}
-Publication._linked_types = []
-Publication._classtype = 'entity'
-
-#Initialisation of Article class attributes
-Article._fields = ['titre', 'class_id', 'soustitre', 'string', 'type_id', 'lodel_id', 'modification_date', 'creation_date']
-Article._superiors = {'parent': [Rubrique]}
-Article._leclass = Textes
-
-#Initialisation of Personne class attributes
-Personne._fields = ['nom', 'class_id', 'prenom', 'string', 'type_id', 'lodel_id', 'modification_date', 'creation_date']
-Personne._superiors = {}
-Personne._leclass = Personnes
-
-#Initialisation of Rubrique class attributes
-Rubrique._fields = ['titre', 'class_id', 'string', 'type_id', 'lodel_id', 'modification_date', 'creation_date']
-Rubrique._superiors = {'parent': [Rubrique, Numero]}
-Rubrique._leclass = Publication
-
-#Initialisation of Numero class attributes
-Numero._fields = ['titre', 'class_id', 'string', 'type_id', 'lodel_id', 'modification_date', 'creation_date']
-Numero._superiors = {}
-Numero._leclass = Publication
-
-## @brief Dict for getting LeClass and LeType child classes given an EM uid
-LeObject._me_uid = {1: Textes, 2: Personnes, 19: Numero, 5: Article, 6: Personne, 13: Publication, 14: Rubrique}

install/instance_settings.py

@@ -11,8 +11,6 @@ templates_base_dir = 'LODEL2_INSTANCE_TEMPLATES_BASE_DIR'
 debug = False
 
 em_file = 'em.json'
-dynamic_code_file = 'dynleapi.py' #Warning hardcoded module name in utils.py and loader.py
-acl_dyn_api = 'api.py' #Warning hardcoded module name in utils.py and loader.py
 
 ds_package = 'MySQL'
 mh_classname = 'MysqlMigrationHandler'
@@ -25,3 +23,5 @@ datasource = {
         'db': 'DBNAME'
     }
 }
+
+acl_bypass = False

install/loader.py

@@ -1,19 +1,13 @@
-import instance_settings
-import importlib
-import sys
 import os
-
-sys.path.append(instance_settings.lodel2_lib_path)
-
+import importlib
+from utils import dyn_code_filename
 from Lodel.settings import Settings
 
-# Settings initialisation
-Settings.load_module(instance_settings)
-globals()['Settings'] = Settings
-
 # Import dynamic code
-if os.path.isfile(Settings.dynamic_code_file):
-    from api import *
+if Settings.acl_bypass:
+    from dyncode.internal_api import *
+else:
+    from dyncode.acl_api import *
 
 # Import wanted datasource objects
 for db_modname in ['leapidatasource', 'migrationhandler']:

install/utils.py

@@ -1,30 +1,63 @@
 # -*- coding: utf-8 -*-
 
-from loader import *
 import warnings
+import sys
 
+# Startup
+#
+# Loading instance config to fetch lodel2 lib path
+# @TODO migrate this portion of code in a bootstrap.py file
+import instance_settings
+sys.path.append(instance_settings.lodel2_lib_path)
+# Load Lodel2 settings module
+from Lodel.settings import Settings
+# Settings initialisation
+Settings.load_module(instance_settings)
+globals()['Settings'] = Settings
 
+
+## @brief fetch full module name of dynamic code
+# @warning hardcoded names are used in loader.py and in Makefile
+# @param name str : can be 'leapi' or 'aclapi'
+def dyn_module_fullname(name):
+    if name == 'leapi':
+        return 'dyncode.internal_api'
+    else:
+        return 'dyncode.acl_api'
+
+## @brief fetch dynamic codefile path
+# @warning hardcoded names are used in loader.py and in Makefile
+# @param name str : can be 'leapi' or 'aclapi'
+def dyn_code_filename(name):
+    if name == 'leapi':
+        return 'dyncode/internal_api.py'
+    else:
+        return 'dyncode/acl_api.py'
+
+## @brief Refresh dynamic code
 def refreshdyn():
     import sys
+    import os, os.path
     from EditorialModel.model import Model
     from leapi.lefactory import LeFactory
     from EditorialModel.backend.json_backend import EmBackendJson
     from DataSource.MySQL.leapidatasource import LeDataSourceSQL
-    OUTPUT = Settings.dynamic_code_file
+    from acl.factory import AclFactory
+
     EMJSON = Settings.em_file
     # Load editorial model
     em = Model(EmBackendJson(EMJSON))
     # Generate dynamic code
-    fact = LeFactory(OUTPUT)
+    fact = LeFactory(dyn_code_filename('leapi'))
     # Create the python file
     fact.create_pyfile(em, LeDataSourceSQL, {})
     # Generate wrapped API
-    from acl.factory import AclFactory
-    fact = AclFactory(Settings.acl_dyn_api)
-    fact.create_pyfile(em, 'dynleapi')
-
+    fact = AclFactory(dyn_code_filename('aclapi'))
+    fact.create_pyfile(em, dyn_module_fullname('leapi'))
 
 def db_init():
+    import loader
+    from loader import migrationhandler
     from EditorialModel.backend.json_backend import EmBackendJson
     from EditorialModel.model import Model
     mh = getattr(migrationhandler,Settings.mh_classname)()
@@ -33,6 +66,7 @@ def db_init():
 
 
 def em_graph(output_file = None, image_format = None):
+    import loader
     from EditorialModel.model import Model
     from EditorialModel.backend.json_backend import EmBackendJson
     from EditorialModel.backend.graphviz import EmBackendGraphviz

lodel_init.sh

@@ -1,5 +1,18 @@
 #!/bin/bash
 
+#
+# Create a Lodel2 instance
+#-------------------------
+#
+# Usage : ./lodel_init.sh instance_name instance_path [lodel2_lib_path]
+#
+# This script creates a new Lodel2 instance.
+#
+# It make a copy of install/ directory + some substitution in the instance_settings.py file
+# and then it generates dynamic code
+#
+
+
 usage() {
 	echo "Usage : $0 instance_name instance_dir [lodel_libdir]" 1>&2
 	exit 1