add tmpfile_dest_dir option

Reviewed-on: #5

doc/README.md

@@ -9,17 +9,9 @@ Rougail est un bibliothèque python3 qui permet de charger des dictionnaires (fi
 
 ## Les dictionnaires
 
-Un dictionnaire est un fichier XML donc la structure est expliqué ci-dessous.
+  - [Les dictionnaires](dictionary/rougail.md)
-
+  - [Les dictionnaires extra](dictionary/extra.md)
-Un dictionnaire contient en ensemble de variable, utilisable à tout moment, notamment dans des templates.
+  - [Convention d'écriture d'un dictionnaire](dictionary/convention.md)
-
-Il est possible d'avoir plusieurs espace de nom pour classer les variables (appeler aussi "extra") mais il est aussi possible, à l'interieur de ce espace de nom de mettre des familles pour classer les variables.
-
-Les familles et les variables peuvent être défini dans plusieurs dictionnaires. Ces dictionnaires s'aggrège alors. Il est possible de rajouter des familles des variables, des services, des éléments à un service et des contraintes.
-
-Il est également possible de redéfinir des éléments pour changer les comportement d'une variable ou d'un service.
-
-FIXME expliquer les noms des variables dans les extras
 
 ### Les variables
 
@@ -30,7 +22,6 @@ FIXME expliquer les noms des variables dans les extras
 
   - [La gestion d'un fichier](service/file.md)
   - [La gestion d'un fichier de service systemd](service/override.md)
-  - [La gestion d'un port](service/port.md)
   - [La gestion d'une ip](service/ip.md)
 
 ### Les contraintes
@@ -38,8 +29,9 @@ FIXME expliquer les noms des variables dans les extras
   - [Les calcules automatiques](fill/README.md)
   - [Les vérifications des valeurs](check/README.md)
   - [Les conditions](condition/README.md)
-  - [Les variables meneuses ou suiveuses](variable/leadership.md)
 
 ## Les templates
 
   - Type creole
+  - Type jinja2
+FIXME ^^

doc/check/function.md

@@ -8,12 +8,12 @@ Voici un exemple simple de validation des valeurs :
 
 ```
 <variables>
-    <variable name="my_variable"/>
+  <variable name="my_variable"/>
 </variables>
 <constraints>
-    <check name="islower">
+  <check name="islower">
-        <target>my_variable</target>
+    <target>my_variable</target>
-    </check>
+  </check>
 </constraints>
 ```
 
@@ -38,16 +38,16 @@ Une fonction de vérification doit prendre en compte 2 aspects important :
 
 À partir de maintenant seule None et des valeurs en minuscule seront autorisés.
 
+Il est possible de définir des [paramètres](../param/README.md) à cette fonction.
+
 ## Vérification des valeurs avec avertissement
 
 Dans la contrainte, il est possible de spécifier le niveau d'erreur et le mettre en avertissement :
 
 ```
 <check name="islower" level="warning">
-    <target>my_variable</target>
+  <target>my_variable</target>
 </check>
 ```
 
 Dans ce cas une valeur avec une majuscule sera accepté, mais un message d'avertissement apparaitra.
-
-Il est possible de définir des [paramètres](../param/README.md) à cette fonction.

doc/check/redefine.md

@@ -6,12 +6,12 @@ Dans un premier dictionnaire déclarons notre variable et sa fonction de vérifi
 
 ```
 <variables>
-    <variable name="my_variable"/>
+  <variable name="my_variable"/>
 </variables>
 <constraints>
-    <check name="islower">
+  <check name="islower">
-        <target>my_variable</target>
+    <target>my_variable</target>
-    </check>
+  </check>
 </constraints>
 ```
 
@@ -19,12 +19,12 @@ Dans un second dictionnaire il est possible de redéfinir le calcul :
 
 ```
 <variables>
-    <variable name="my_variable" redefine="True"/>
+  <variable name="my_variable" redefine="True"/>
 </variables>
 <constraints>
-    <check name="isspace">
+  <check name="isspace">
-        <target>my_variable</target>
+    <target>my_variable</target>
-    </check>
+  </check>
 </constraints>
 ```
 
@@ -40,12 +40,12 @@ Dans un premier dictionnaire déclarons notre variable et notre fonction de vér
 
 ```
 <variables>
-    <variable name="my_variable"/>
+  <variable name="my_variable"/>
 </variables>
 <constraints>
-    <check name="islower">
+  <check name="islower">
-        <target>my_variable</target>
+    <target>my_variable</target>
-    </check>
+  </check>
 </constraints>
 ```
 
@@ -53,9 +53,9 @@ Dans un second dictionnaire supprimer cette vérification :
 
 ```
 <variables>
-    <family name="family">
+  <family name="family">
-        <variable name="my_variable" redefine="True" remove_check="True"/>
+    <variable name="my_variable" redefine="True" remove_check="True"/>
-    </family>
+  </family>
 </variables>
 ```
 

doc/condition.rst

@@ -1,13 +0,0 @@
-FIXME 
-<!ATTLIST variable remove_condition (True|False) "False">
-
-
-<!ELEMENT condition ((target | param)+ )>
-<!ATTLIST condition name (disabled_if_in|disabled_if_not_in|hidden_if_in|hidden_if_not_in|mandatory_if_in|mandatory_if_not_in) #REQUIRED>
-<!ATTLIST condition source CDATA #REQUIRED>
-<!ATTLIST condition fallback (True|False) "False">
-<!ATTLIST condition force_condition_on_fallback (True|False) "False">
-<!ATTLIST condition force_inverse_condition_on_fallback (True|False) "False">
-
-
-on peut mettre plusieurs param (oui ou maybe)

doc/condition/README.md

@@ -0,0 +1,5 @@
+# Les conditions
+
+  - [Déclaration d'une condition](condition.md)
+  - [Les différentes conditions](conditions.md)
+  - [Réfinition](redefine.md)

doc/condition/condition.md

@@ -0,0 +1,76 @@
+# Les conditions
+
+## Un condition
+
+Les conditions permettent d'ajouter ou de supprimer des propriétés à une [variable](../variable/README.md), une [famille](../family/README.md), un [service](../service/README.md), un [fichier](../service/file.md) ou une [ip](../service/ip.md) suivant le contexte.
+
+Nous allons nous concentrer ici sur la condition hidden_if_in, mais [il existe d'autre conditions](conditions.md).
+
+La condition hidden_if_in permet de cacher une variable où une famille à l'utilisateur, mais cette variable est toujours accessible dans un calcul, un vérification ou dans un template.
+
+```
+<variables>
+  <variable name="condition" type="boolean"/>
+  <variable name="my_variable"/>
+</variables>
+
+<constraints>
+  <condition name="hidden_if_in" source="condition">
+    <param>True</param>
+    <target>my_variable</target>
+  </condition>
+</constraints>
+```
+
+Le [paramètres](../param/README.md) de la condition permet de définir les valeurs que doit avoir la source pour appliquer l'action.
+
+La [cible](../target/README.md) de la condition est ici "my_variable".
+
+Donc ici la variable est caché à l'utilisateur si la variable "condition" est à True (le paramètre).
+
+## Un condition avec plusieurs paramètres
+
+Il est également possible de mettre plusieurs paramètre :
+
+```
+<variables>
+  <variable name="condition"/>
+  <variable name="my_variable"/>
+</variables>
+
+<constraints>
+  <condition name="hidden_if_in" source="condition">
+    <param>yes</param>
+    <param>maybe</param>
+    <target>my_variable</target>
+  </condition>
+</constraints>
+```
+
+## Une condition optionnelle
+
+Il est possible de définir une condition avec une variable source qui n'existe pas dans toutes les contextes.
+
+Dans ce cas, on met la condition en "optionnelle".
+
+Si la variable source existe, la condition s'applique.
+
+Si la variable source n'existe pas :
+
+- si le nom fini en _if_in (par exemple hidden_if_in), l'action est forcée sans condition (les cibles sont hidden)
+- si le nom fini en _if_not_in (par exemple hidden_if_not_in), la condition est totalement ignorée
+
+Ces deux comportements peuvent être changé à tout moment avec l'attribut "apply_on_fallback". Dans ce cas :
+
+- si la valeur de "apply_on_fallback" est "True", l'action est forcée sans condition
+- si la valeur de "apply_on_fallback" est "False", la condition est totalement ignorée 
+
+Exemple :
+
+```
+<condition name="hidden_if_in" source="condition" optional="True", apply_on_fallback="False">
+  <param>yes</param>
+  <param>maybe</param>
+  <target>my_variable</target>
+</condition>
+```

doc/condition/conditions.md

@@ -0,0 +1,29 @@
+# Les conditions
+
+## Les conditions \_if_in et \_if_not_in
+
+Il existe deux types de conditions :
+
+- les conditions dont le nom fini par \_if_in : dans ce cas si la variable source est égal à un des paramètres, l'action est effective
+- les conditions dont le nom fini par \_if_not_in : dans ce cas si la variable source est différents de tous les paramètres, l'action est effective
+
+## Désactivation
+
+Il est possible de désactiver une [variable](../variable/README.md) ou une [famille](../family/README.md) avec les conditions :
+
+- disabled_if_in
+- disabled_if_not_in
+
+## Caché
+
+Il est possible de cacher une [variable](../variable/README.md), une [famille](../family/README.md), un [service](../service/README.md), un [fichier](../service/file.md) ou une [ip](../service/ip.md) avec les conditions :
+
+- hidden_if_in
+- hidden_if_not_in
+
+## Obligatoire
+
+Il est possible de rendre obligatoire une [variable](../variable/README.md) avec les conditions :
+
+- mandatory_if_in
+- mandatory_if_not_in

doc/condition/redefine.md

@@ -0,0 +1,29 @@
+# Rédéfinition
+
+Il se peut que dans un dictionnaire on décide de définir une condition.
+
+Dans un second dictionnaire il est possible de supprimer cette condition.
+
+Dans un premier dictionnaire déclarons notre variable et notre calcule :
+
+```
+<variables>
+  <variable name="condition" type="boolean"/>
+  <variable name="my_variable"/>
+</variables>
+
+<constraints>
+  <condition name="hidden_if_in" source="condition">
+    <param>True</param>
+    <target>my_variable</target>
+  </condition>
+</constraints>
+```
+
+Dans un second dictionnaire supprimer ce calcul :
+
+```
+<variables>
+  <variable name="condition" redefine="True" remove_condition="True"/>
+</variables>
+```

doc/dev/README.md

@@ -13,11 +13,11 @@ Voici un premier dictionnaire /srv/rougail/dictionaries/00-base.xml :
 ```
 <?xml version='1.0' encoding='UTF-8'?>
 <rougail>
-    <variables>
+  <variables>
-        <variable name="my_variable">
+    <variable name="my_variable">
-            <value>my_value</value>
+      <value>my_value</value>
-        </variable>
+    </variable>
-    </variables>
+  </variables>
 </rougail>
 ```
 
@@ -39,11 +39,11 @@ En plus du dictionnaire précédent, créons un dictionnaire extra /srv/rougail/
 ```
 <?xml version='1.0' encoding='UTF-8'?>
 <rougail>
-    <variables>
+  <variables>
-        <variable name="my_variable_extra">
+    <variable name="my_variable_extra">
-            <value>my_value_extra</value>
+      <value>my_value_extra</value>
-        </variable>
+    </variable>
-    </variables>
+  </variables>
 </rougail>
 ```
 
@@ -65,11 +65,11 @@ Nous créons un dictionnaire complémentaire pour ajouter notre template /srv/ro
 ```
 <?xml version='1.0' encoding='UTF-8'?>
 <rougail>
-    <services>
+  <services>
-        <service name="example">
+    <service name="example">
-            <file name="/etc/example.conf"/>
+      <file name="/etc/example.conf"/>
-        </service>
+    </service>
-    </services>
+  </services>
 </rougail>
 ```
 
@@ -104,11 +104,11 @@ Générons le template :
 import asyncio
 from example import option_0
 from tiramisu import Config
-from rougail import RougailTemplate
+from rougail import RougailSystemdTemplate
 
 async def template():
     config = await Config(option_0)
-    engine = RougailTemplate(config)
+    engine = RougailSystemdTemplate(config)
     await engine.instance_files()
 
 loop = asyncio.get_event_loop()
@@ -163,11 +163,11 @@ Nous créons un dictionnaire complémentaire pour ajouter un calcul à la variab
 ```
 <?xml version='1.0' encoding='UTF-8'?>
 <rougail>
-    <constraints>
+  <constraints>
-        <fill name="return_no">
+    <fill name="return_no">
-            <target>my_variable</target>
+      <target>my_variable</target>
-        </fill>
+    </fill>
-    </constraints>
+  </constraints>
 </rougail>
 ```
 

doc/dev/config.md

@@ -14,7 +14,15 @@ Pour modifier il suffit de faire :
 RougailConfig[key] = value
 ```
 
-## Les répertoires des dictionnaires
+## Ajout d'une fonction de conversion
+
+Les fonctions de conversion fait parti du moteur de rougail. Il converti les informations des dictionnaires pour créer des variables Tiramisu.
+
+La clef "extra_annotators" permet d'ajouter des fonctions complémentaires.
+
+## Configuration de chargement des dictionnaires
+
+### Les répertoires des dictionnaires
 
 Il existe deux types de répertoires de dictionnaires :
 
@@ -36,7 +44,7 @@ RougailConfig['extra_dictionaries']['example'] = ['/dir1', '/dir2']
 
 Les dictionnaires sont chargés dans le même ordre que les dictionnaires principaux.
 
-## La DTD
+### La DTD
 
 Rougail a besoin du fichier de DTD pour lire les fichiers dictionnaire.
 
@@ -44,28 +52,81 @@ Par défaut le fichier de la DTD est dans le sous répertoire "data" du réperto
 
 Pour pouvez changer le répertoire de destination de la DTD et le nom du fichier avec la clef "dtdfilename".
 
-## Le fichier de fonction
+### Le fichier de fonction
 
-Le fichier qui contient les fonctions personnalisés est géré dans la clef "functions_file" et a comme valeur par défaut "/srv/rougail/functions.py".
+Le fichier qui contient les fonctions personnalisés est géré dans la clef "functions_file" et a comme valeur par défaut "/srv/rougail/functions.py". Cette clef peut contenir une liste s'il y a plusieurs fichiers.
 
-## Le répertoire des templates
+Les fonctions doivent retourner une valeur, même si la variable que l'on calcul est une variable multiple.
+Si la fonction peut retourner une valeur multiple (une liste), il faut mettre le nom de la fonction dans la clef "multi_functions".
 
-Le répertoire des templates est géré dans la clef "templates_dir" et a comme valeur par défaut : "/srv/rougail/templates".
+### La variable auto_freeze
 
-## Le répertoire des patchs
+La propriété auto_freeze n'est appliqué que une variable spécifique passe à True. Par défaut le nom de la variable est "instancied_module", mais il est possible de changer le nom de cette variable via la clef "auto_freeze_variable".
+
+### Les modes
+
+Les modes sont personnalisables dans Rougail. Par défaut les modes sont "basic", "normal" et "expert".
+Il est possible de changer cette liste via la clef "modes_level".
+
+Si vous changer ces valeurs, penser à changer les modes par défaut des familles et des variables.
+
+### Le mode par défaut pour une famille
+
+Le mode par défaut d'une famille est "basic". Il est possible de changer le mode par défaut d'une famille via la clef "default_family_mode".
+
+### Le mode par défaut pour une variable
+
+Le mode par défaut d'une variable est "normal". Il est possible de changer le mode par défaut d'une variable via la clef "default_variable_mode".
+
+### Le nom des fonctions internes
+
+Il est possible d'ajouter des fonctions interne via la clef "internal_functions".
+
+## Configuration de la templatisation
+
+### Le répertoire des templates
+
+Le répertoire des templates est géré dans la clef "templates_dir" et a comme valeur par défaut : "/srv/rougail/templates". Cette clef peut contenir une liste s'il y a plusieurs répertoires.
+
+### Le répertoire des patchs
 
 Le répertoire des patches est géré dans la clef "patches_dir" et a comme valeur par défaut : "/srv/rougail/patches".
 
-## Le répertoire temporaire
+### Le répertoire temporaire
 
 Le répertoire temporaire est utile lors de la génération de template. Il contient une copie des templates avec, éventuellement, les patches appliqués sur les templates.
 
 Le répertoire de temporaire est géré dans la clef "tmp_dir" et a comme valeur par défaut : "/srv/rougail/tmp".
 
-## Le répertoire de destination des fichiers générés
+### Le répertoire de destination des fichiers générés
 
 Le répertoire de destination des fichiers générés est géré dans la clef "destinations_dir" et a comme valeur par défaut : "/srv/rougail/destinations".
 
-## La variable auto_freeze
+### Le nom du répertoire où se trouve les fichiers pour tmpfile.d
 
-La propriété auto_freeze n'est appliqué que une variable spécifique passe à True. Par défaut le nom de la variable est "instancied_module", mais il est possible de changer le nom de cette variable via la clef "auto_freeze_variable".
+Le répertoire où se trouve les fichiers tmpfile.d sont par défaut dans "/usr/local/lib", il est possible de changer ce répertoire avec la clef "tmpfile_dest_dir".
+
+
+## La configuration par défaut des fichiers
+
+### Le moteur de templates par défaut
+
+Le moteur de template est géré dans la clef "default_files_engine" et a comme valeur par défaut : "creole". Les valeurs possible sont "none", "creole" ou "jinja2".
+
+### Les droits par défaut des fichiers
+
+Les droits des fichiers générés est géré dans la clef "default_files_mode" et a comme valeur par défaut : "0644".
+
+### Le propriétaire par défaut des fichiers
+
+Le propriétaire des fichiers générés est géré dans la clef "default_files_owner" et a comme valeur par défaut : "root".
+Le groupe propriétaire des fichiers générés est géré dans la clef "default_files_group" et a comme valeur par défaut : "root".
+
+### La méthode d'inclusion par défaut des fichiers
+
+La méthode d'inclusion des fichiers générés est géré dans la clef "default_files_included" et a comme valeur par défaut : "no". Les valeurs possible sont "no", "name" et "content".
+                 'default_files_included': 'no',
+
+## La configuration du moteur de templates
+
+Le moteur de template est géré dans la clef "default_overrides_engine" et a comme valeur par défaut : "creole". Les valeurs possible sont "none", "creole" ou "jinja2".

doc/dictionary/convention.md

@@ -0,0 +1,13 @@
+# Convention de rédaction d'un dictionnaire
+
+## Ordonnancement du dictionnaire
+
+L'ordre des informations mise dans le dictionnaire est idéalement :
+
+- services
+- variables
+- constraintes
+
+## Le nom d'espace
+
+Le nom d'espace dans un dictionnaire est de deux espaces.

doc/dictionary/extra.md

@@ -0,0 +1,12 @@
+# Les dictionnaires extra
+
+Un extra est un espace de nom différent. L'idée et de pouvoir classer les variables par thématique.
+
+Les espaces de nom extra doivent être déclaré au moment [de la configuration de Rougail](../dev/config.md).
+
+Dans cet espace de nom :
+
+- des variables et des familles peuvent avoir le même nom dans différentes familles
+- la valeur d'un cible, source, leader ou follower des contraintes doivent être avec un chemin complet
+- on ne peut pas déclarer des services dans cet espace de nom
+- dans un template il faut utiliser des chemins complet (%%my_extra.my_family.my_variable ou %%my_extra.my_family.leader.follower pour une variable suiveuse)

doc/dictionary/rougail.md

@@ -0,0 +1,22 @@
+# Les dictionnaires
+
+## Un dictionnaire ?
+
+Un dictionnaire est un fichier XML donc la structure est décrite dans cette documentation.
+
+Un dictionnaire contient en ensemble de variable chargé dans Tiramisu, utilisable à tout moment, notamment dans des templates.
+
+Les familles, les variables et les contraintes peuvent être défini dans plusieurs dictionnaires. Ces dictionnaires s'aggrège alors.
+
+Il est également possible de redéfinir des éléments pour changer les comportement d'une variable ou d'un service.
+
+## L'espace de nom par défaut
+
+L'espace de nom par défaut s'appelle "rougail" ([ce nom est personnalisable](../dev/config.md)).
+
+Cet espace de nom est un peu particulier :
+
+- le nom des variables et des familles doivent être unique pour l'ensemble de cet espace (même si ces variables ou familles sont dans des familles différentes)
+- la valeur d'un cible, source, leader ou follower des contraintes peuvent être avec nom de la variable ou de la famille ou leurs chemins complet
+- on peut déclarer des services dans cet espace de nom
+- dans un template on peut utiliser cette variable sans le chemin complet (%%my_variable) ou avec (%%rougail.my_family.my_variable)

doc/family/README.md

@@ -2,4 +2,5 @@
 
   - [Une famille](simple.md)
   - [Famille crée dynamiquement](auto.md)
+  - [Les variables meneuses ou suiveuses](leadership.md)
 

doc/family/auto.md

@@ -7,11 +7,11 @@ Par exemple :
 
 ```
 <variable name='varname' multi="True">
-    <value>val1</value>
+  <value>val1</value>
-    <value>val2</value>
+  <value>val2</value>
 </variable>
 <family name="my_dyn_family_" dynamic="varname" description="Describe ">
-    <variable name="my_dyn_var_"/>
+  <variable name="my_dyn_var_"/>
 </family>
 ```
 

doc/family/leadership.md

@@ -0,0 +1,56 @@
+# Variable meneuse ou suiveuse
+
+## Variable meneuse
+
+Une variable meneuse est une variable qui va guider la longueur d'autre variables (appelé variables suiveuse).
+
+Une variable meneuse est une [variable](../variable/README.md) qui est obligatoirement de type multiple.
+
+Une variable meneuse peut être obligatoire.
+
+Le [mode](../mode.md) par défaut correspond au plus petit mode définit par l'utilisateur des variables suiveuses.
+
+## Variable suiveuse
+
+Une variable suiveuse est une variable donc la longueur n'est pas déterminé par elle-même, mais est identique à celle de la variable meneuse dont elle dépend.
+
+Une variable suiveuse est une variable placer juste derrière une variable meneuse ou une autre variable suiveuse.
+
+L'ordre de définition des variables suiveuses est important.
+
+Cette variable peut être de type multiple. Dans ce cas, pour un index determiné, il est possible de mettre plusieurs valeurs à une même variable.
+
+Une variable suiveuse peut être obligatoire. Cela signifie que lorsqu'une variable meneuse est renseigné, il faut obligatoirement que la variable suiveuse est également une valeur à l'index considéré.
+Si aucune valeur n'est définit pour la variable meneuse, aucune valeur n'est a spécifié pour la variable suiveuse.
+
+Le [mode](../mode.md) par défaut d'une variable suiveuse correspond au [mode](../mode.md) de la variable meneuse.
+
+Si une variable meneuse est caché ou désactivé, les variables suiveuses le seront également.
+
+## Définition des variables meneuse et suiveuse
+
+Les variables meneuses et suiveuses doivent dans une famille de type "leadership".
+
+Voici un exemple de définition d'une variable meneuse et de deux variables meneuses :
+
+```
+<variables>
+  <family name="family" leadership='True'>
+    <variable name="leader" multi='True'/>
+    <variable name="follower1"/>
+    <variable name="follower2" multi='True'/>
+  </family>
+</variables>
+```
+
+## Ajout d'une nouvelle variable suiveuse
+
+Pour ajouter, dans un nouveau dictionnaire, une variable suiveuse à notre groupe, rien de plus simple, il suffit définir une ou des nouvelles variables dans la famille :
+
+```
+<variables>
+  <family name="family">
+    <variable name="follower3"/>
+  </family>
+</variables>
+```

doc/family/simple.md

@@ -12,7 +12,7 @@ Cette famille doit être placé dans une balise [variables](../variables.md) :
 
 ```
 <variables>
-    <family name="my_family"/>
+  <family name="my_family"/>
 </variables>
 ```
 
@@ -20,9 +20,9 @@ Ou dans une autre famille :
 
 ```
 <variables>
-    <family name="my_family">
+  <family name="my_family">
-        <family name="second_family"/>
+    <family name="second_family"/>
-    </family>
+  </family>
 </variables>
 ```
 
@@ -44,7 +44,7 @@ En plus de la description, il est possible de préciser une aide complémentaire
 
 ## Mode de la famille
 
-Le [mode](../mode.md) par défaut d'une famille correspond au [mode](../mode.md) le plus petite des variables ou des familles qui sont contenu dans cette famille.
+Le [mode](../mode.md) par défaut d'une famille correspond au [mode](../mode.md) du mode le plus petit entre la famille parente, les variables enfants ou des familles enfants qui sont contenu dans cette famille.
 
 Changer le [mode](../mode.md) d'une famille permet de définir le [mode](../mode.md) par défaut des variables ou des familles inclusent dans cette famille.
 

doc/fill/README.md

@@ -4,3 +4,4 @@ Une variable calculée est une variable donc sa valeur est le résultat d'une fo
 
   - [Valeur calculée de la variable](value.md)
   - [Réfinition](redefine.md)
+  - [Exemples de calcule](examples.md)

doc/fill/examples.md

@@ -0,0 +1,48 @@
+# Exemples de calcule
+
+## Calculer les noms de modèle à généré à partir d'une variable
+
+Créeons deux variables multiples, une pour accueillir la liste des éléments du nom variable (ici `zones_list`), la seconde étant le nom du fichier calculé (ici `netwokd_configurations`) :
+
+```
+<variables>
+  <variable name="zones_list" type="string" multi="True">
+    <value>zone1</value>
+    <value>zone2</value>
+    <value>zone3</value>
+  </variable>
+  <variable name="netwokd_configurations" type="filename" multi="True" hidden="True"/>
+</variables>
+```
+
+Calculons la valeur de la seconde variable à partir de la première :
+
+```
+<constraints>
+  <fill name="calc_value">
+    <param>/systemd/network/10-</param>
+    <param type="variable">zones_list</param>
+    <param>-risotto.network</param>
+    <param name="join"></param>
+    <param name="multi" type="boolean">True</param>
+    <target>netwokd_configurations</target>
+  </fill>
+</constraints>
+```
+
+Le contenu de la variable `netwokd_configurations` sera alors :
+
+- /systemd/netword/10-zone1/risotto.network
+- /systemd/netword/10-zone2/risotto.network
+- /systemd/netword/10-zone3/risotto.network
+
+Enfin déclarer une balise file en utilisant ces deux variables :
+
+```
+<services>
+  <service name="systemd-networkd">
+    <file file_type="variable" source="network" variable="zones_list">netwokd_configurations</file>
+  </service>
+</services>
+```
+

doc/fill/value.md

@@ -6,12 +6,12 @@ Créons une variable dont la valeur est retournée par la fonction "return_no" :
 
 ```
 <variables>
-    <variable name="my_calculated_variable"/>
+  <variable name="my_calculated_variable"/>
 </variables>
 <constraints>
-    <fill name="return_no">
+  <fill name="return_no">
-        <target>my_calculated_variable</target>
+    <target>my_calculated_variable</target>
-    </fill>
+  </fill>
 </constraints>
 ```
 
@@ -30,7 +30,7 @@ Attention, si une valeur par défaut est définit dans la variable "my_calculate
 
 ```
 <variable name="my_calculated_variable">
-    <value>yes</value>
+  <value>yes</value>
 </variable>
 ```
 Cette valeur par défaut sera complètement ignorée. C'est le calcul qui en définira la valeur.
@@ -49,8 +49,8 @@ Si une condition "hidden_if_in" est spécifié à la variable, la valeur sera mo
 
 ## Variable meneuse ou suiveuse avec valeur calculé
 
-Une [variable suiveuse](../variable/leadership.md) ne peut pas être calculé automatiquement.
+Une [variable suiveuse](../family/leadership.md) ne peut pas être calculé automatiquement.
-Une [variable meneuse](../variable/leadership.md) peut être calculé automatiquement.
+Une [variable meneuse](../family/leadership.md) peut être calculé automatiquement.
 Si la variable n'est pas multiple, il ne faut pas que le calcule retourne une liste.
 
 ## Variable dynamique avec une valeur calculée
@@ -59,24 +59,24 @@ Il est également possible de calculer [une variable d'une famille dynamique](..
 
 ```
 <variables>
-    <variable name='suffixes' type='string' description="Suffixes of dynamic family" multi="True">
+  <variable name='suffixes' type='string' description="Suffixes of dynamic family" multi="True">
-        <value>val1</value>
+    <value>val1</value>
-        <value>val2</value>
+    <value>val2</value>
+  </variable>
+  <variable name="my_variable" type="string" description="My variable">
+    <value>val</value>
+  </variable>
+  <family name='dyn' dynamic="suffixes">
+    <variable name="my_calculated_variable_dyn\_" type="string" description="My calculated variable"/>
+      <value>val</value>
     </variable>
-    <variable name="my_variable" type="string" description="My variable">
+  </family>
-        <value>val</value>
-    </variable>
-    <family name='dyn' dynamic="suffixes">
-        <variable name="my_calculated_variable_dyn\_" type="string" description="My calculated variable"/>
-            <value>val</value>
-        </variable>
-    </family>
 </variables>
 <constraints>
-    <fill name="return_value">
+  <fill name="return_value">
-        <param type="variable">my_variable</param>
+    <param type="variable">my_variable</param>
-        <target>my_calculated_variable_dyn_</target>
+    <target>my_calculated_variable_dyn_</target>
-    </fill>
+  </fill>
 </constraints>
 ```
 
@@ -90,11 +90,11 @@ Dans ce cas, il faut explicitement demander la valeur du suffix dans la fonction
 
 ```
 <constraints>
-    <fill name="return_value_suffix">
+  <fill name="return_value_suffix">
-        <param type="variable">my_variable</param>
+    <param type="variable">my_variable</param>
-        <param type="suffix"/>
+    <param type="suffix"/>
-        <target>my_calculated_variable_dyn_</target>
+    <target>my_calculated_variable_dyn_</target>
-    </fill>
+  </fill>
 </constraints>
 ```
 

doc/mode.md

@@ -1,8 +1,10 @@
 Mode
 ====
 
-Il existe trois "mode" dans Rougail :
+Par défault, il existe trois "mode" dans Rougail :
 
 - basic : variables indispensables à la mise en place d'un service
 - normal : variables couramment modifié par l'utilisateur
 - expert : variables a manipuler avec précausion et en toute connaissance de cause
+
+Il est possible de personnaliser les modes dans la [configuration de rougail](dev/config.md)

doc/param/information.md

@@ -1,6 +1,8 @@
 # Paramètre de type information
 
-Le paramètre peut être la valeur est issue d'une information de la configuration.
+## Les informations de la configuration
+
+Le paramètre peut être la valeur est issue d'une information de la configuration :
 
 ```
 <param type="information">server_name</param>
@@ -8,3 +10,15 @@ Le paramètre peut être la valeur est issue d'une information de la configurati
 
 Dans ce cas, l'information de la configuration "server_name" sera utilisé comme valeur du paramètre.
 Si l'information n'existe pas, la paramètre aura la valeur "None".
+
+## Les informations de la cible
+
+Le paramètre peut être la valeur est issue d'une information de la cible du calcul :
+
+```
+<param type="target_information">test</param>
+<param type="target_information">help</param>
+```
+
+Dans ce cas, l'information de la configuration "test" ou "help" sera utilisé comme valeur du paramètre.
+Si l'information n'existe pas, la paramètre aura la valeur "None".

doc/param/simple.md

@@ -42,3 +42,11 @@ Le paramètre peut être une valeur null (None en python) :
 ```
 <param type="nil"/>
 ```
+
+# Paramètre de type "space"
+
+Les paramètres sont chargés en supprimer les espaces en début ou fin de chaîne. Ce qui rend impossible d'avoir un paramètre " ". Avec le type "space", le paramètre sera donc un simple espace :
+
+```
+<param type="space"/>
+```

doc/param/variable.md

@@ -6,7 +6,7 @@ Imaginons que la variable "my_variable" pré-existe. La valeur de la variable se
 <param type="variable">my_variable</param>
 ```
 
-[Les variables meneuses ou suiveuses](../variable/leadership.md) peuvent être utilisé sans soucis comme paramètre.
+[Les variables meneuses ou suiveuses](../family/leadership.md) peuvent être utilisé sans soucis comme paramètre.
 
 ## Paramètre avec variable potentiellement non existante
 

doc/service/README.md

@@ -1,4 +1,107 @@
-# Les services
+# La gestion d'un service
 
+## La base service
 
+Un service est inclut dans un conteneur [services](../services.md).
 
+Cette balise permet de définir tous les éléments ([fichier](file.md), [IP](ip.md) et [réécriture](override.md)) liés à un service ou à démon.
+
+Il faut, à la création du service, préciser son nom :
+
+```
+<?xml version='1.0' encoding='UTF-8'?>
+<rougail>
+  <services>
+    <service name="squid"/>
+  </services>
+</rougail>
+```
+
+## Les types de service
+
+Les services peuvent être de plusieurs type :
+
+- service (valeur par défaut) : cela signifie que c'est un service systemd qui est activer au démarrage de la machine
+- mount : fichier utilisé par systemd-mount
+- swap : fichier utilisé par systemd-swap
+- timer : tâche planifié pour systemd
+
+```
+<service name="dev-disk-by\x2dpartlabel-swap" type="swap"/>
+```
+
+## Les targets de service
+
+Active le service systemd pour une target systemd déterminé. Par défaut, l'activation du service n'est pas gérer par rougail.
+
+```
+<service name="squid" target="multi-user"/>
+```
+
+## La génération du fichier service
+
+Le fichier de description du service peut être fourni directement par la distribution GNU/Linux utilisé, mais il peut également être fournit par l'administrateur.
+Dans ce cas, il est possible de créé un template, dont le nom est obligatoirement la valeur de la balise "name" + "." + la valeur de la base "type".
+
+Deux types de template sont aujourd'hui disponible :
+
+- creole
+- jinja2
+
+```
+<service name="dev-disk-by\x2dpartlabel-swap" type="swap" engine="creole"/>
+```
+
+Dans ce cas, rougail utilisera le template "dev-disk-by\x2dpartlabel-swap.swap" pour générer le fichier systemd de gestion de ce service.
+
+## Le service factice
+
+Un service peut être factice, donc non géré par le système de service du système :
+
+```
+<service name="ldap_client" manage="False"/>
+```
+
+Un service factice est généralement une service qui n'existe pas réellement (par exemple si on configure un client). Il n'est là que pour contenir des fichiers.
+
+## Désactiver le service
+
+Il est possible de désactiver un service. Pour cela il faut rajouter l'attribut "disabled" à True :
+
+```
+<services>
+  <service name="test" disabled="True"/>
+</services>
+```
+
+Dans ce cas, le service et les éléments qu'il compose ([fichier](file.md), [IP](ip.md) et [réécriture](override.md) seront désactivés.
+
+Il est possible de définir une [condition](../condition/README.md) de type "disabled_if_in" ou "disabled_if_not_in" sur une balise service :
+
+```
+<services>
+  <service name="test" servicelist="test">
+  </service>
+</services>
+<variables>
+  <variable name="condition" type="boolean"/>
+</variables>
+<constraints>
+  <condition name="disabled_if_in" source="condition">
+    <param>False</param>
+    <target type="servicelist">test</target>
+  </condition>
+</constraints>
+```
+
+Dans ce cas, tous les services et les éléments qu'il compose avec un attribut servicelist à "test" seront désactivés si la variable "condition" est False.
+
+## Ne pas désactiver le service dans systemd
+
+La désactivation du service va créé un lien symbolique vers /dev/null.
+
+Si vous ne voulez juste pas créé le fichier de service et ne pas faire de lien symbolique, il faut utiliser l'attribut undisable :
+
+```
+<service name="test" disabled="True" undisable="True"/>
+```

doc/service/file.md

@@ -2,7 +2,7 @@
 
 ## La balise file
 
-La gestion des fichiers se fait dans un conteneur de [service](service.md).
+La gestion des fichiers se fait dans un conteneur de [service](README.md).
 
 La déclaration du fichier permet de générer un fichier à partir d'un template pour le déposer à l'endroit prévu dans la déclaration de cette élément.
 
@@ -10,9 +10,9 @@ Il est nécessaire, au minimum, de spécifier le chemin complet du fichier :
 
 ```
 <services>
-    <service name="squid">
+  <service name="squid">
-        <file name="/etc/squid/squid.conf"/>
+    <file>/etc/squid/squid.conf</file>
-    </service>
+  </service>
 </services>
 ```
 
@@ -21,7 +21,7 @@ Dans ce cas, le nom du template est déduit du nom du fichier, ici cela sera "sq
 Si le template a un nom différent (par exemple si plusieurs template se retrouve avec le même nom), il est possible de changer le nom du template avec l'attribut source :
 
 ```
-<file name="/etc/squid/squid.conf" source="template-squid.conf"/>
+<file source="template-squid.conf">/etc/squid/squid.conf</file>
 ```
 
 ## Les noms de fichiers dynamique
@@ -30,32 +30,34 @@ Il est possible également de définir le nom du fichier dans une variable :
 
 ```
 <services>
-    <service name="squid">
+  <service name="squid">
-        <file name="my_variable" file_type="variable" source="squid.conf"/>
+    <file file_type="variable" source="squid.conf">my_variable</file>
-    </service>
+  </service>
 </services>
 <variables>
-    <variable name="my_variable">
+  <variable name="my_variable">
-        <value>/etc/squid/squid.conf</value>
+    <value>/etc/squid/squid.conf</value>
-    </variable>
+  </variable>
 </variables>
 ```
 
+Attention, la variable doit être de type "filename".
+
 Dans le cas des fichiers dynamique, la source est obligatoire.
 
 Il est même possible de définir une variable de type multiple, ce qui génèrera plusiers fichiers :
 
 ```
 <services>
-    <service name="squid">
+  <service name="squid">
-        <file name="my_variable" file_type="variable" source="squid.conf"/>
+    <file file_type="variable" source="squid.conf">my_variable</file>
-    </service>
+  </service>
 </services>
 <variables>
-    <variable name="my_variable" multi="True">
+  <variable name="my_variable" multi="True">
-        <value>/etc/squid1/squid.conf</value>
+    <value>/etc/squid1/squid.conf</value>
-        <value>/etc/squid2/squid.conf</value>
+    <value>/etc/squid2/squid.conf</value>
-    </variable>
+  </variable>
 </variables>
 ```
 
@@ -71,23 +73,23 @@ En effet, il est possible de passer le contenu d'une variable au template :
 
 ```
 <services>
-    <service name="squid">
+  <service name="squid">
-        <file name="my_variable1" file_type="variable" source="squid.conf" variable="my_variable2"/>
+    <file file_type="variable" source="squid.conf" variable="my_variable2">my_variable1</file>
-    </service>
+  </service>
 </services>
 <variables>
-    <variable name="my_variable1" multi="True">
+  <variable name="my_variable1" multi="True">
-        <value>/etc/squid1/squid.conf</value>
+    <value>/etc/squid1/squid.conf</value>
-        <value>/etc/squid2/squid.conf</value>
+    <value>/etc/squid2/squid.conf</value>
-    </variable>
+  </variable>
-    <variable name="my_variable2" multi="True">
+  <variable name="my_variable2" multi="True">
-        <value>squid1</value>
+    <value>squid1</value>
-        <value>squid2</value>
+    <value>squid2</value>
-    </variable>
+  </variable>
 </variables>
 ```
 
-Dans ce cas, lors de la génération du fichier /etc/squid1/squid.conf on retrouvera la variable "rougail_variable" avec la valeur "squid1" et le fichier /etc/squid2/squid.conf on retrouvera la variable "rougail_variable" avec la valeur "squid2".
+Dans ce cas, lors de la génération du fichier /etc/squid1/squid.conf on retrouvera la variable "rougail_variable" avec la valeur "squid1" et la variable "rougail_index" avec la valeur "0". Lors de la génération du fichier /etc/squid2/squid.conf on retrouvera la variable "rougail_variable" avec la valeur "squid2" et la variable "rougail_index" avec la valeur "1".
 
 Attention : les deux variables "my_variable1" et "my_variable2" doivent être multiple et de même longueur.
 
@@ -95,51 +97,153 @@ Attention : les deux variables "my_variable1" et "my_variable2" doivent être mu
 
 Par défaut les droits du fichier généré sont "0644" avec comme utilisateur "root" et groupe "root".
 
-Il est possible de définir une autre valeur à un ou plusieurs de ces attributs :
+Il est possible de définir les droits, l'utilisateur ou le groupe d'un fichier généré :
 
 ```
-<file name="/etc/squid/squid.conf" mode="0640" owner="nobody" group="squid"/>
+<file mode="0640" owner="nobody" group="squid">/etc/squid/squid.conf</file>
 ```
 
+Il est possible de personnaliser les droits par défaut dans la [configuration de rougail](../dev/config.md)
+
 ## Désactiver la génération d'un fichier
 
-Il est possible de définir une [condition](../condition/README.md) de type "disabled_if_in" ou "disabled_if_not_in" sur une balise fichier :
+Il est possible de désactiver la génération d'un fichier avec l'attribut "disabled" :
+
+```
+<file disabled="True">/etc/squid/squid.conf</file>
+```
+
+Il est aussi possible de définir une [condition](../condition/README.md) de type "disabled_if_in" ou "disabled_if_not_in" sur une balise fichier :
 
 ```
 <services>
-    <service name="test">
+  <service name="test">
-        <file name="/etc/squid/squid.conf" filelist="squid"/>
+    <file filelist="squid">/etc/squid/squid.conf</file>
-    </service>
+  </service>
 </services>
 <variables>
-    <family name="general">
+  <variable name="condition" type="boolean"/>
-        <variable name="condition" type="boolean"/>
-    </family>
 </variables>
 <constraints>
-    <condition name="disabled_if_in" source="condition">
+  <condition name="disabled_if_in" source="condition">
-        <param>False</param>
+    <param>False</param>
-        <target type="filelist">squid</target>
+    <target type="filelist">squid</target>
-    </condition>
+  </condition>
 </constraints>
 ```
 
-Dans ce cas, tous les fichiers avec un attribut filelist à "squid" seront désactivé si la variable "condition" est False.
+Dans ce cas, tous les fichiers avec un attribut filelist à "squid" seront désactivés si la variable "condition" est False.
 
 ## Redéfinir une fichier
 
 Il est possible de redéfinir les éléments d'un fichier dans un dictionnaire différent en utilisant l'attribut redefine :
 
 ```
-<file name="/etc/squid/squid.conf" source="template-squid.conf" redefine="True"/>
+<file source="template-squid.conf" redefine="True">/etc/squid/squid.conf</file>
 ```
 
 ## Choix du moteur de templating
 
 Par défaut, le moteur de templating est le moteur de templating compatible avec "creole".
 
-Aujourd'hui il est possible de désactiver la templatisation du fichier (il sera alors uniquement copié) :
+Il est possible de désactiver la templatisation du fichier (il sera alors uniquement copié) :
 
 ```
-<file name="/etc/squid/squid.conf" templating="none"/>
+<file engine="none">/etc/squid/squid.conf</file>
+```
+
+Ou d'utiliser le moteur "jinja2" :
+
+```
+<file engine="jinja2">/etc/squid/squid.conf</file>
+```
+
+Il est possible de personnaliser le moteur par défaut dans la [configuration de rougail](../dev/config.md)
+
+## Inclusion de template
+
+Un attribut "included" permet de définir la nature du fichier. Cet attribut peut avoir trois valeurs :
+
+- "no" : c'est un fichier normal
+- "name" : le répertoire de destination est listé dans un autre template, il faut que le fichier soit généré avant cet autre template
+- "content" : le contenu du fichier est copié dans un autre template, il faut que le fichier soit généré avant cet autre template et ce fichier n'a pas besoin d'être installé sur le serveur cible.
+
+Bien entendu, c'est au développeur de lister ou d'inclure le contenu de ce template dans le fichier de destination. Cet attribut permet juste de garantir que le fichier sera fait avant l'autre et de ne pas l'installer sur le serveur si ce n'est pas nécessaire.
+
+Il est possible de personnaliser les methodes d'inclusion par défaut dans la [configuration de rougail](../dev/config.md)
+
+Exemples :
+
+- créons un template qui inclut des noms de fichiers :
+
+Le contenu de ce template (squid.conf) est :
+
+```
+%import os
+%set %%confdir = 'etc/squid/squid.d/'
+%if %%os.path.exists(%%confdir)
+ %set %%files = %%os.listdir(%%confdir)
+ %%files.sort()
+ %for %%file in %%files
+  %if %%file.endswith('.cfg')
+include '/' + %%confdir + file
+  %end if
+ %end for
+%end if
+```
+
+Ajoutons un second template (squid.included.conf) qui sera copié dans ce répertoire :
+
+```
+template content
+```
+
+Et déclaront ces deux templates :
+
+```
+<file>/etc/squid/squid.conf</file>
+<file included="name" engine="none">/etc/squid/squid.d/squid.conf</file>
+```
+
+Le contenu du fichier généré (/etc/squid/squid.conf) sera donc :
+
+```
+include squid.d/squid.conf
+```
+
+- créons un template qui inclut le contenu de fichiers :
+
+Le contenu de ce template (squid.conf) est :
+
+```
+%import os
+%set %%confdir = 'squid.d/'
+%if %%os.path.exists(%%confdir)
+ %set %%files = %%os.listdir(%%confdir)
+ %%files.sort()
+ %for %%file in %%files
+  %if %%file.endswith('.cfg')
+%include raw %%confdir + file
+  %end if
+ %end for
+%end if
+```
+
+Ajoutons un second template (squid.included.conf) qui sera copié dans ce répertoire :
+
+```
+template content
+```
+
+Et déclaront ces deux templates :
+
+```
+<file>/etc/squid/squid.conf</file>
+<file included="content" engine="none">squid.d/squid.conf</file>
+```
+
+Le contenu du fichier généré (/etc/squid/squid.conf) sera donc maintenant :
+
+```
+template content
 ```

doc/service/ip.md

@@ -1,15 +1,47 @@
 # La gestion d'une IP
 
-## La balise ip
+## La balise IP
 
-La gestion des IP se fait dans un conteneur de [service](service.md).
+La gestion des IP se fait dans un conteneur de [service](README.md).
 
-FIXME
+La déclaration de l'attribut permet d'associer une IP autorisé à accéder au service.
 
-<!ELEMENT ip (#PCDATA)>
+Il est nécessaire, au minimum, de spécifier le nom d'une variable de type "IP" :
-<!ATTLIST ip iplist CDATA #IMPLIED >
+
-<!ATTLIST ip ip_type (NetworkOption|variable) "NetworkOption">
+```
-<!ATTLIST ip interface_type (UnicodeOption|variable) "UnicodeOption">
+<ip ip_type="variable">variable_ip</ip>
-<!ATTLIST ip interface CDATA #REQUIRED>
+```
-<!ATTLIST ip netmask_type (NetmaskOption|variable) "NetmaskOption">
+
-<!ATTLIST ip netmask CDATA "255.255.255.255">
+## La gestion d'un réseau
+
+L'adresse peut être de type réseau ("network") :
+
+```
+<ip netmask="variable_netmask">variable_ip</ip>
+```
+
+Attention, dans ce cas il faut préciser une variable de type "netmask" dans l'attribut netmask.
+
+## Désactiver la génération d'une IP
+
+Il est possible de définir une [condition](../condition/README.md) de type "disabled_if_in" ou "disabled_if_not_in" sur une balise IP :
+
+```
+<services>
+  <service name="test">
+    <ip iplist="test_ip">variable_ip</ip>
+  </service>
+</services>
+<variables>
+  <variable name="condition" type="boolean"/>
+  <variable name="variable_ip" type="ip"/>
+</variables>
+<constraints>
+  <condition name="disabled_if_in" source="condition">
+    <param>False</param>
+    <target type="iplist">test_ip</target>
+  </condition>
+</constraints>
+```
+
+Dans ce cas, tous les IP avec un attribut iplist à "test_ip" seront désactivé si la variable "condition" est False.

doc/service/override.md

@@ -1,8 +1,8 @@
-# Override
+# Réécriture du service
 
 ## La balise override
 
-La gestion des overrides se fait dans un conteneur de [service](service.md).
+La gestion des overrides se fait dans un conteneur de [service](README.md).
 
 La balise override permet de redéfinir facilement un service systemd.
 
@@ -10,9 +10,9 @@ Il suffit d'avoir un template dont le nom est par défaut le nom du service avec
 
 ```
 <services>
-    <service name="squid">
+  <service name="squid">
-        <override/>
+    <override/>
-    </service>
+  </service>
 </services>
 ```
 
@@ -30,8 +30,16 @@ Dans ce cas le fichier de destination aura le même nom.
 
 Par défaut, le moteur de templating est le moteur de templating compatible avec "creole".
 
-Aujourd'hui il est possible de désactiver la templatisation du fichier (il sera alors uniquement copié) :
+Il est possible de désactiver la templatisation du fichier (il sera alors uniquement copié) :
 
 ```
-<override templating="none"/>
+<override engine="none"/>
 ```
+
+Ou d'utiliser le moteur "jinja2" :
+
+```
+<override engine="jinja2"/>
+```
+
+Il est possible de personnaliser le moteur par défaut dans la [configuration de rougail](../dev/config.md)

doc/service/port.md

@@ -1,63 +0,0 @@
-# La gestion d'un port
-
-## La balise port
-
-La gestion des ports se fait dans un conteneur de [service](service.md).
-
-La balise port permet d'associer un port à service :
-
-```
-<services>
-    <service name="squid">
-        <port>3128</port>
-    </service>
-</services>
-```
-
-Il est possible de choisir le protocole TCP ou UDP (TCP par défaut) :
-
-```
-<port protocol="udp">123</port>
-```
-
-## Les numéros de port dynamique
-
-Il est possible également de définir le port dans une variable :
-
-```
-<services>
-    <service name="squid">
-        <port port_type="variable">my_variable</port>
-    </service>
-</services>
-<variables>
-    <variable name="my_variable" type="port">
-        <value>123</value>
-    </variable>
-</variables>
-```
-
-## Désactiver le port
-
-Il est possible de définir une [condition](../condition/README.md) de type "disabled_if_in" ou "disabled_if_not_in" sur une balise port :
-
-```
-<services>
-    <service name="test">
-        <port portlist="squid">3128</port>
-    </service>
-</services>
-<variables>
-    <family name="general">
-        <variable name="condition" type="boolean"/>
-    </family>
-</variables>
-<constraints>
-    <condition name="disabled_if_in" source="condition">
-        <param>False</param>
-        <target type="portlist">squid</target>
-    </condition>
-</constraints>
-```
-
-Dans ce cas, tous les ports avec un attribut portlist à "squid" seront désactivé si la variable "condition" est False.

doc/service/service.md

@@ -1,16 +0,0 @@
-# La gestion d'un service
-
-Un service est inclut dans un conteneur [services](../services.md).
-
-Cette balise permet de définir tous les éléments (fichier, port, IP, ...) lié à un service ou à démon.
-
-Il faut, à la création du service, préciser son nom :
-
-```
-<?xml version='1.0' encoding='UTF-8'?>
-<rougail>
-    <services>
-        <service name="squid"/>
-    </services>
-</rougail>
-```

doc/services.md

@@ -1,13 +1,13 @@
 # Le conteneur des services
 
-La balise "services" est le conteneur de l'ensemble des [services](service/service.md).
+La balise "services" est le conteneur de l'ensemble des [services](service/README.md).
 
 Il est placé à la racine du dictionnaire :
 
 ```
 <?xml version='1.0' encoding='UTF-8'?>
 <rougail>
-    <services/>
+  <services/>
 </rougail>
 ```
 

doc/target/README.md

@@ -0,0 +1,5 @@
+# La cible
+
+  - [De type variable](../target/variable.md)
+  - [De type famille](../target/family.md)
+  - [De type \*list](../target/list.md)

doc/target/family.md

@@ -0,0 +1,13 @@
+# Cible de type "variable"
+
+Une cible peut être de type famille :
+
+```
+<target type="family">my_family</target>
+```
+
+Mais une target peut être optionnelle. C'est à dire que si la famille n'existe pas, l'action ne sera pas associé à cette famille.
+
+```
+<target type="family" optional="True">my_family</target>
+```

doc/target/list.md

@@ -0,0 +1,35 @@
+# Cible de type \*list
+
+## Les différences cible de type \*.list
+
+### servicelist
+
+Une cible peut être de type [service](../service/README.md) :
+
+```
+<target type="servicelist">example</target>
+```
+
+### filelist
+
+Une cible peut être de type [fichier](../service/file.md) :
+
+```
+<target type="filelist">example</target>
+```
+
+### iplist
+
+Une cible peut être de type [ip](../service/ip.md) :
+
+```
+<target type="iplist">example</target>
+```
+
+## La cible optionnelle
+
+Mais une target peut être optionnelle. C'est à dire que si la \*list n'existe pas, l'action ne sera pas associé.
+
+```
+<target type="filelist" optional="True">unknown</target>
+```

doc/target/variable.md

@@ -1,4 +1,4 @@
-# Cible de la fonction de type "variable"
+# Cible de type "variable"
 
 Par défaut une cible est de type variable.
 

doc/variable/README.md

@@ -1,4 +1,275 @@
 # Variable
 
-  - [Une variable](simple.md)
+## Un variable
-  - [Variable meneuse ou suiveuse](leadership.md)
+
+Une variable est forcement dans [variables](../variables.md) ou dans une [famille](../family/README.md).
+
+Une variable est déjà un nom. C'est à dire qu'on pourra utiliser plus tard la variable via ce nom.
+
+```
+<variables>
+  <variable name="my_variable"/>
+  <family name="my_family">
+    <variable name="my_family_variable"/>
+  </variable>
+</variables>
+```
+
+## Description et aide sur la variable
+
+En plus d'un nom, il est possible de mettre une "description" à la variable. C'est une information "utilisateur" qui nous permettra d'avoir des informations complémentaires sur le contenu de cette variable :
+
+```
+<variable name="my_variable" description="This is a greate variable"/>
+```
+
+En plus de la description, il est possible de préciser une aide complémentaire :
+
+```
+<variable name="my_variable" help="This is a greate variable"/>
+```
+
+Cette aide peut être utilisé à tout moment comme valeur [d'un paramètre](../param/information.md).
+
+## Le type de la variable
+
+Une variable a un type. Ce type permet de définir les valeurs acceptées par cette variable :
+
+- string : chaine de caractère (type par défaut)
+- number : un nombre
+- float : un chiffre flottant
+- boolean : "True" ou "False", si aucune valeur n'est défini la valeur par défaut de cette variable sera "True", ces variables sont également obligatoire par défaut
+- secret (ou password mais est obsolète) : un secret (comme un mot de passe, une clef privée, ...)
+- mail : une adresse mail
+- filename : nom de fichier au sens Unix (exemple : "/etc/passwd")
+- date : une date au format "%Y-%m-%d" (exemple : "2021-01-30")
+- unix_user : nom d'utilisateur au sens Unix
+- ip : n'importe quelle adresse IPv4
+- cidr : n'importe quelle adresse IPv4 au format CIDR
+- local_ip : adresse IPv4 sur un réseau local, si l'adresse IPv4 n'est pas local, un warning sera afficher mais la valeur sera accepté tout de même
+- netmask : masque d'une adresse IPv4
+- network : adresse réseau
+- network_cidr : adresse réseau au format CIDR
+- broadcast : adresse de diffusion
+- netbios : nom netbios
+- domain : nom de domaine
+- hostname : nom d'hôte
+- web_address : adresse web (http://www.cadoles.com/)
+- port : port
+- mac : adresse MAC
+- schedule : périodicité du schedule, les valeurs possibles sont "none", "daily", "weekly" ou "monthly"
+- schedulemod : type de schedule, les valeurs possibles sont "pre" ou "post"
+
+Pour définir le type d'une variable :
+
+```
+<variable name="my_variable" type="number"/>
+```
+
+## Variable à valeur multiple
+
+Par défaut une variable ne peut acceuillir qu'une seule valeur. Il peut être utile de pouvoir spécifier plusieurs valeurs à une même variable.
+
+Pour définir une variable à valeur multiple :
+
+```
+<variable name="my_variable" multi="True"/>
+```
+
+## Variable invisible
+
+Il est possible de cacher une variable.
+
+Cacher une variable signifie qu'elle ne sera pas visible lorsqu'on modifie la configuration du service.
+Par contre cette variable sera accessibles lorsqu'on va l'utiliser.
+
+Pour cacher une variable :
+
+```
+<variable name="my_variable" hidden="True"/>
+```
+
+## Variable désactive
+
+Il est possible de désactiver une variable.
+
+Désactiver une variable signifie qu'elle ne sera pas visible lorsqu'on modifie la configuration du service mais également lorsqu'on va l'utiliser.
+
+Pour désactiver une variable :
+
+```
+<variable name="my_variable" disabled="True"/>
+```
+
+## Variable obligatoire
+
+Variable dont une valeur est requise :
+
+```
+<variable name="my_variable" mandatory="True"/>
+```
+
+Les variables booléans sont par défaut obligatoire. Pour qu'une variable booléan ne soit pas obligatoire il faut le préciser explicitement :
+
+```
+<variable name="my_variable" type="boolean" mandatory="False"/>
+```
+
+Les variables avec une valeur par défaut (non calculée) sont également automatiquement obligatoire.
+
+## Valeur par défaut d'une variable
+
+Il est possible de fixer les valeurs par défaut d'une variable :
+
+```
+<variable name="my_variable">
+  <value>value</value>
+</variable>
+```
+
+Pour une variable multiple, il est possible de préciser plusieurs valeurs :
+
+```
+<variable name="my_variable" multi="True">
+  <value>value 1</value>
+  <value>value 2</value>
+</variable>
+```
+
+Si la variable n'est pas pas une [variable meneuse](../family/leadership.md), la première valeur défini dans cette liste sera également la valeur par défaut proposé si on ajoute une nouvelle valeur à cette variable.
+
+Une valeur par défaut peut également être [une valeur calculer](../fill/README.md).
+
+## Redéfinir une variable
+
+Il est possible de définir une variable dans un dictionnaire et de changer son comportement dans une second dictionnaire.
+
+Attention trois attributs ne sont redéfinisable :
+
+- name
+- type
+- multi
+
+Créons notre variable :
+
+```
+<variable name="my_variable"/>
+```
+
+Et redéfinisons là :
+
+```
+<variable name="my_variable" redefine="True" description="New description"/>
+```
+
+## Créer une variable inexistante
+
+Il est parfois utile de créer une variable si elle n'existe pas dans un autre dictionnaire :
+
+```
+<variable name="my_variable" exists="False"/>
+```
+
+Si cette variable existe dans un autre dictionnaire, elle ne sera pas modifié ni recréé
+
+## Redéfinir une variable si elle existe
+
+Parfois on veut pouvoir redéfinir une variable mais seulement dans le cas où elle existe déjà :
+
+```
+<variable name="my_variable" redefine="True" exists="True" hidden="True"/>
+```
+
+## Variable à valeur automatiquement modifiée
+
+Une variable avec valeur automatiquement modifiée est une variable dont la valeur sera considéré comme modifié quand la propriété global "force_store_value" de Tiramisu est mise.
+
+Voici une variable a valeur automatiquement modifiée :
+
+```
+<variable name="my_variable" auto_save="True">
+  <value>my_value</value>
+</variable>
+```
+
+Dans ce cas la valeur est fixée à la valeur actuelle.
+Par exemple, si la valeur de cette variable est issue d'un calcul, la valeur ne sera plus recalculée.
+
+Ces variables sont généralement des variables obligatoires. En effet ces variable ne sont automatiquement modifiées que si elles ont une valeurs.
+
+Une [variable meneuse ou suiveuse](../family/leadership.md) ne peut pas avoir la propriété auto_save.
+
+## Variable à valeur en lecture seule automatique
+
+Une variable avec valeur en lecture seule automatique est une variable dont la valeur ne sera plus modifiable par l'utilisateur quand la [variable "server_deployed" passe à "True"](../dev/config.md).
+
+Voici un variable à valeur en lecture seule automatique :
+
+```
+<variable name="server_deployed" type="boolean">
+  <value>False</value>
+</variable>
+<variable name="my_variable" auto_freeze="True"/>
+```
+
+Dans ce cas la valeur est fixée à la valeur actuelle et elle ne sera plus modifiable par l'utilisateur.
+Par exemple, si la valeur de cette variable est issue d'un calcul, la valeur ne sera plus recalculée.
+
+Ces variables sont généralement des variables obligatoires. En effet ces variable ne sont en lecteur seul que si elles ont une valeurs.
+
+Une [variable meneuse ou suiveuse](../family/leadership.md) ne peut pas avoir la propriété auto_freeze.
+
+## Information "test"
+
+L'attribut "test" est un attribut spécial qui permet aux concepteurs d'un dictionnaire d'influancer le robot de test en précisant de valeurs utile à tester.
+
+Concrêtement, le contenu de cet attribut est enregister dans une "information" de l'option Tiramisu correspondante.
+
+Exemple :
+
+```
+<variable name="my_variable" test="yes"/>
+```
+
+Il est possible de préciser plusieurs valeurs avec le séparateur "|" :
+
+```
+<variable name="my_variable" test="yes|no"/>
+```
+
+Cette valeur peut être utilisé à tout moment comme valeur [d'un paramètre](../param/information.md).
+
+## Mode de la variable
+
+Le [mode](../mode.md) par défaut d'une variable correspond au [mode](../mode.md) de la [famille](../family/README.md).
+
+Cas particuliers :
+
+- une variable à valeur automatiquement modifiée ou une variable en lecture seule automatique est par défaut en mode "basic".
+- si la variable n'est pas dans une famille, la variable aura le mode "normal" par défaut.
+- une variable obligatoire sans valeur par défaut (calculer ou non) aura le mode "basic".
+
+Pour définir le [mode](../mode.md) :
+
+```
+<variable name="my_variable" mode="expert"/>
+```
+
+## Les variables qui fournissent des valeurs
+
+Il peut être intéressant de retrouver facilement des variables sans connaitre le chemin complet mais en utilisant le contenu du paramètre "provider".
+C'est particulièrement utile si un service peut être fournit par plusieurs services. Les variables n'auront donc pas le même nom. Utiliser ce paramètre, permet donc de retrouver facilement la variable.
+
+Pour déclarer :
+
+```
+<variable name="my_variable" provider="my_function"/>
+```
+
+Dans le code de l'application, on pourra retrouver le chemin de la variable en faisant :
+
+```
+print(await config.information.get('provider:my_function'))
+```
+
+Pour les variables inclusent dans une famille dynamique, le chemin de la variable sera un template comme ceci "rougail.family_{suffix}.my_variable_{suffix}". Il vous suffit de remplacer "{suffix}" par le suffix voulu de la famille dynamique.

doc/variable/choice.md

@@ -0,0 +1,91 @@
+# Les variables à choix
+
+## Une variable à choix
+
+Il est possible d'imposer une liste de valeur pour une variable particulière :
+
+```
+<variable name="my_variable" type="choice">
+  <choice>val1</choice>
+  <choice>val2</choice>
+  <choice>val3</choice>
+</variable>
+```
+
+Dans ce cas, seules les valeurs proposées sont possibles pour cette variable.
+Cette variable n'est pas obligatoire dont il est possible de mettre la valeur "None".
+
+Si la variable est obligatoire ou si une valeur est précisée (la variable passe obligatoire) alors la valeur "None" n'est plus autorisé :
+
+```
+<variable name="my_variable" type="choice">
+  <choice>val1</choice>
+  <choice>val2</choice>
+  <choice>val3</choice>
+  <value>val1</value>
+</variable>
+```
+
+## Un variable à choix typée
+
+Par défaut les choix sont de type "string". Il est possible de préciser des nombres, des booléens ou la valeur None :
+
+```
+<variable name="my_variable" type="choice">
+  <choice>val1</choice>
+  <choice type="string">val2</choice>
+  <choice type="number">3</choice>
+  <choice type="boolean">True</choice>
+  <choice type="nil"/>
+</variable>
+```
+
+Comme vu précédement ajouter la valeur None n'est pas utile parce qu'elle est automatiquement ajouté si la variable n'est pas obligatoire.
+
+## Ajouter une option à une variable à choix existante
+
+Pour ajouter un choix à une variable à choix existante, rien de plus simple, juste redéfinir la variable en ajoutant le choix voulu :
+
+```
+<variable name="my_variable" redefine="True">
+  <choice>val4</choice>
+</variable>
+```
+
+## Redéfinir une option à choix
+
+Si on veut supprimer un choix ou redéfinir complètement la liste, il faut redéfinir cette variable et ajouter l'attribut "remove_choice" à "True" :
+
+```
+<variable name="my_variable" redefine="True" remove_choice="True">
+  <choice>val1</choice>
+  <choice>val2</choice>
+</variable>
+```
+
+Dans ce cas toutes les anciens choix ne seront plus possible. Seuls les nouveaux le seront.
+
+## Un variable à choix provenant d'une variable
+
+Une variable à valeur multiple peut servir de source des choix :
+
+```
+<variable name="my_variable" type="choice">
+  <choice type="variable">other_variable</choice>
+</variable>
+```
+
+Dans ce cas, toutes les valeurs de la variable seront des choix utilisables par l'utilisateur.
+Seul un choice de type "variable" est possible par variable.
+
+## Un variable à choix provenant d'une fonction
+
+```
+<variable name="my_variable" type="choice">
+  <choice type="function" name="trange">
+    <param type="number">0</param>
+    <param type="number">10</param>
+  </choice>
+  <value type="number">9</value>
+</variable>
+```

doc/variable/leadership.md

@@ -8,6 +8,8 @@ Une variable meneuse est une [variable](simple.md) qui est obligatoirement de ty
 
 Une variable meneuse peut être obligatoire.
 
+Le [mode](../mode.md) par défaut correspond au plus petit mode définit par l'utilisateur des variables suiveuses.
+
 ## Variable suiveuse
 
 Une variable suiveuse est une variable donc la longueur n'est pas déterminé par elle-même, mais est identique à celle de la variable meneuse dont elle dépend.
@@ -31,17 +33,17 @@ Voici un exemple de définition d'une variable meneuse et de deux variables mene
 
 ```
 <variables>
-    <family name="family">
+  <family name="family">
-        <variable name="leader" multi='True'/>
+    <variable name="leader" multi='True'/>
-        <variable name="follower1"/>
+    <variable name="follower1"/>
-        <variable name="follower2" multi='True'/>
+    <variable name="follower2" multi='True'/>
-    </family>
+  </family>
 </variables>
 <constraints>
-    <group leader="leader">
+  <group leader="leader">
-        <follower>follower1</follower>
+    <follower>follower1</follower>
-        <follower>follower2</follower>
+    <follower>follower2</follower>
-    </group>
+  </group>
 </constraints>
 ```
 
@@ -51,26 +53,61 @@ Il est possible d'en définit d'autres :
 
 ```
 <constraints>
-    <group leader="leader" name="leadership" description="My leadership">
+  <group leader="leader" name="leadership" description="My leadership">
-        <follower>follower1</follower>
+    <follower>follower1</follower>
-        <follower>follower2</follower>
+    <follower>follower2</follower>
-    </group>
+  </group>
 </constraints>
 ```
 
+## Faire un calcul avec l'index de la variable meneuse
+
+Dans un calcul sur un variable suiveuse il est possible de récupérer l'index de la variable meneuse :
+
+```
+<fill name="calc_val">
+  <param type="index"/>
+  <target>follower</target>
+</fill>
+```
+
+## Définition des variables meneuse et suiveuse dans un dictionnaire extra
+
+Voici un exemple de définition d'une variable meneuse et de deux variables meneuses dans un espace de nom "example" :
+
+```
+<variables>
+  <family name="family">
+    <variable name="leader" multi='True'/>
+    <variable name="follower1"/>
+    <variable name="follower2" multi='True'/>
+  </family>
+</variables>
+<constraints>
+  <group leader="example.family.leader">
+    <follower>follower1</follower>
+    <follower>follower2</follower>
+  </group>
+</constraints>
+```
+
+Le chemin de la variable meneuse est traditionnel, par contre le chemin des variables suiveuses est le chemin relatif de la variable.
+
+Le chemin d'une variable suiveuse est normalement "example.family.leader.follower1" mais la variable n'est pas encore une variable suiveuse à ce moment là du traitement. C'est pour cela qu'il ne faut, uniquement dans les groupes, mettre le nom de la variable suiveuse.
+
 ## Ajout d'une nouvelle variable suiveuse
 
 Pour ajouter, dans un nouveau dictionnaire, une variable suiveuse à notre groupe, rien de plus simple, il suffit de redéfinir un groupe avec cette (ou ces) nouvelle variable :
 
 ```
 <variables>
-    <family name="family">
+  <family name="family">
-        <variable name="follower3"/>
+    <variable name="follower3"/>
-    </family>
+  </family>
 </variables>
 <constraints>
-    <group leader="leader">
+  <group leader="leader">
-        <follower>follower3</follower>
+    <follower>follower3</follower>
-    </group>
+  </group>
 </constraints>
 ```

doc/variable/simple.md

@@ -1,222 +0,0 @@
-# Variable
-
-## Un variable
-
-Une variable est forcement dans [variables](../variables.md) ou dans une [famille](../family/README.md).
-
-Une variable est déjà un nom. C'est à dire qu'on pourra utiliser plus tard la variable via ce nom.
-
-```
-<variables>
-    <variable name="my_variable"/>
-    <family name="my_family">
-        <variable name="my_family_variable"/>
-    </variable>
-</variables>
-```
-
-## Description et aide sur la variable
-
-En plus d'un nom, il est possible de mettre une "description" à la variable. C'est une information "utilisateur" qui nous permettra d'avoir des informations complémentaires sur le contenu de cette variable :
-
-```
-<variable name="my_variable" description="This is a greate variable"/>
-```
-
-En plus de la description, il est possible de préciser une aide complémentaire :
-
-```
-<variable name="my_variable" help="This is a greate variable"/>
-```
-
-## Le type de la variable
-
-Une variable a un type. Ce type permet de définir les valeurs acceptées par cette variable :
-
-- string : chaine de caractère (type par défaut)
-- number : un nombre
-- float : un chiffre flottant
-- boolean : "True" ou "False", si aucune valeur n'est défini la valeur par défaut de cette variable sera "True"
-- password : un mot de passe
-- mail : une adresse mail
-- filename : nom de fichier au sens Unix (exemple : "/etc/passwd")
-- date : une date au format "%Y-%m-%d" (exemple : "2021-01-30")
-- unix_user : nom d'utilisateur au sens Unix
-- ip : n'importe quelle adresse IPv4
-- cidr : n'importe quelle adresse IPv4 au format CIDR
-- local_ip : adresse IPv4 sur un réseau local, si l'adresse IPv4 n'est pas local, un warning sera afficher mais la valeur sera accepté tout de même
-- netmask : masque d'une adresse IPv4
-- network : adresse réseau
-- network_cidr : adresse réseau au format CIDR
-- broadcast : adresse de diffusion
-- netbios : nom netbios
-- domain : nom de domaine
-- hostname : nom d'hôte
-- web_address : adresse web (http://www.cadoles.com/)
-- port : port
-- mac : adresse MAC
-- schedule : périodicité du schedule, les valeurs possibles sont "none", "daily", "weekly" ou "monthly"
-- schedulemod : type de schedule, les valeurs possibles sont "pre" ou "post"
-
-Pour définir le type d'une variable :
-
-```
-<variable name="my_variable" type="number"/>
-```
-
-## Variable à valeur multiple
-
-Par défaut une variable ne peut acceuillir qu'une seule valeur. Il peut être utile de pouvoir spécifier plusieurs valeurs à une même variable.
-
-Pour définir une variable à valeur multiple :
-
-```
-<variable name="my_variable" multi="True"/>
-```
-
-## Mode de la variable
-
-Le [mode](../mode.md) par défaut d'une variable correspond au [mode](../mode.md) de la [famille](../family/README.md).
-
-Si la variable n'est pas dans une famille, la variable aura le mode "normal" par défaut.
-
-Pour définir le [mode](../mode.md) :
-
-```
-<variable name="my_variable" mode="expert"/>
-```
-
-## Variable invisible
-
-Il est possible de cacher une variable.
-
-Cacher une variable signifie qu'elle ne sera pas visible lorsqu'on modifie la configuration du service.
-Par contre cette variable sera accessibles lorsqu'on va l'utiliser.
-
-Pour cacher une variable :
-
-```
-<variable name="my_variable" hidden="True"/>
-```
-
-## Variable désactive
-
-Il est possible de désactiver une variable.
-
-Désactiver une variable signifie qu'elle ne sera pas visible lorsqu'on modifie la configuration du service mais également lorsqu'on va l'utiliser.
-
-Pour désactiver une variable :
-
-```
-<variable name="my_variable" disabled="True"/>
-```
-
-## Variable obligatoire
-
-Variable dont une valeur est requise :
-
-```
-<variable name="my_variable" mandatory="True"/>
-```
-
-## Valeur par défaut d'une variable
-
-Il est possible de fixer les valeurs par défaut d'une variable :
-
-```
-<variable name="my_variable">
-    <value>value</value>
-</variable>
-```
-
-Pour une variable multiple, il est possible de préciser plusieurs valeurs :
-
-```
-<variable name="my_variable" multi="True">
-    <value>value 1</value>
-    <value>value 2</value>
-</variable>
-```
-
-Si la variable n'est pas pas une [variable meneuse](leadership.md), la première valeur défini dans cette liste sera également la valeur par défaut proposé si on ajoute une nouvelle valeur à cette variable.
-
-Une valeur par défaut peut également être [une valeur calculer](../fill/README.md).
-
-## Redéfinir une variable
-
-Il est possible de définir une variable dans un dictionnaire et de changer son comportement dans une second dictionnaire.
-
-Attention trois attributs ne sont redéfinisable :
-
-- name
-- type
-- multi
-
-Créons notre variable :
-
-    <variable name="my_variable"/>
-
-Et redéfinisons là :
-
-```
-<variable name="my_variable" redefine="True" description="New description"/>
-```
-
-## Créer une variable inexistante
-
-Il est parfois utile de créer une variable si elle n'existe pas dans un autre dictionnaire :
-
-```
-<variable name="my_variable" exists="False"/>
-```
-
-Si cette variable existe dans un autre dictionnaire, elle ne sera pas modifié ni recréé
-
-## Redéfinir une variable si elle existe
-
-Parfois on veut pouvoir redéfinir une variable mais seulement dans le cas où elle existe déjà :
-
-```
-<variable name="my_variable" redefine="True" exists="True" hidden="True"/>
-```
-
-## Variable à valeur automatiquement modifiée
-
-Une variable avec valeur automatiquement modifiée est une variable dont la valeur sera considéré comme modifié quand la propriété global "force_store_value" de Tiramisu est mise.
-
-Voici une variable a valeur automatiquement modifiée :
-
-```
-<variable name="my_variable" auto_save="True">
-    <value>my_value</value>
-</variable>
-```
-
-Dans ce cas la valeur est fixée à la valeur actuelle.
-Par exemple, si la valeur de cette variable est issue d'un calcul, la valeur ne sera plus recalculée.
-
-Ces variables sont généralement des variables obligatoires. En effet ces variable ne sont automatiquement modifiées que si elles ont une valeurs.
-
-Une [variable meneuse ou suiveuse](leadership.md) ne peut pas avoir la propriété auto_save.
-
-## Variable à valeur en lecture seule automatique
-
-Une variable avec valeur en lecture seule automatique est une variable dont la valeur ne sera plus modifiable par l'utilisateur quand la [variable "instanciated_module" passe à "True"](../dev/config.md).
-
-Voici un variable à valeur en lecture seule automatique :
-
-```
-<variable name="instanciated_module" type="boolean">
-    <value>False</value>
-</variable>
-<variable name="my_variable" auto_freeze="True"/>
-```
-
-Dans ce cas la valeur est fixée à la valeur actuelle et elle ne sera plus modifiable par l'utilisateur.
-Par exemple, si la valeur de cette variable est issue d'un calcul, la valeur ne sera plus recalculée.
-
-Ces variables sont généralement des variables obligatoires. En effet ces variable ne sont en lecteur seul que si elles ont une valeurs.
-
-Une [variable meneuse ou suiveuse](leadership.md) ne peut pas avoir la propriété auto_freeze.
-
-FIXME <!ATTLIST variable test CDATA #IMPLIED>

doc/variables.md

@@ -7,6 +7,6 @@ Il est placé à la racine du dictionnaire :
 ```
 <?xml version='1.0' encoding='UTF-8'?>
 <rougail>
-    <variables/>
+  <variables/>
 </rougail>
 ```

src/rougail/__init__.py

@@ -25,8 +25,8 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
 from .convert import RougailConvert
-from .template import RougailTemplate
+from .template.systemd import RougailSystemdTemplate
 from .config import RougailConfig
-from .annotator import modes
+from rougail.update import RougailUpgrade
 
-__ALL__ = ('RougailConvert', 'RougailTemplate', 'RougailConfig', 'modes')
+__ALL__ = ('RougailConvert', 'RougailSystemdTemplate', 'RougailConfig', 'RougailUpgrade')

src/rougail/annotator/__init__.py

@@ -24,34 +24,70 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
-from .group import GroupAnnotator
+from .variable import CONVERT_OPTION
-from .service import ServiceAnnotator
+import importlib.resources
-from .variable import VariableAnnotator, CONVERT_OPTION
+from os.path import dirname, join
-from .check import CheckAnnotator
+from ..utils import load_modules
-from .value import ValueAnnotator
+
-from .condition import ConditionAnnotator
+
-from .fill import FillAnnotator
+ANNOTATORS = None
-from .family import FamilyAnnotator, modes
+
-from .property import PropertyAnnotator
+
+if not 'files' in dir(importlib.resources):
+    # old python version
+    class fake_files:
+        def __init__(self, package):
+            self.mod = []
+            dir_package = dirname(importlib.resources._get_package(package).__file__)
+            for mod in importlib.resources.contents(package):
+                self.mod.append(join(dir_package, mod))
+
+        def iterdir(self):
+            return self.mod
+    importlib.resources.files = fake_files
+
+
+def get_level(module):
+    return module.level
+
+
+def get_annotators(annotators, module_name):
+    annotators[module_name] = []
+    for pathobj in importlib.resources.files(module_name).iterdir():
+        path = str(pathobj)
+        if not path.endswith('__') and not path.endswith('__.py'):
+            module = load_modules(path)
+            if 'Annotator' in dir(module):
+                annotators[module_name].append(module.Annotator)
+
 
 class SpaceAnnotator:  # pylint: disable=R0903
-    """Transformations applied on a CreoleObjSpace instance
+    """Transformations applied on a object instance
     """
-    def __init__(self, objectspace, eosfunc_file):
+    def __init__(self,
-        self.objectspace = objectspace
+                 objectspace,
-        GroupAnnotator(objectspace)
+                 eosfunc_files,
-        ServiceAnnotator(objectspace)
+                 ):
-        VariableAnnotator(objectspace)
+        global ANNOTATORS
-        CheckAnnotator(objectspace,
+        if ANNOTATORS is None:
-                       eosfunc_file,
+            ANNOTATORS = {}
-                       )
+            get_annotators(ANNOTATORS, 'rougail.annotator')
-        ConditionAnnotator(objectspace)
+            for extra_annotator in objectspace.rougailconfig['extra_annotators']:
-        FillAnnotator(objectspace,
+                get_annotators(ANNOTATORS, extra_annotator)
-                      eosfunc_file,
+        for extra_annotator in objectspace.rougailconfig['extra_annotators']:
+            if extra_annotator not in ANNOTATORS:
+                get_annotators(ANNOTATORS, extra_annotator)
+        annotators = ANNOTATORS['rougail.annotator'].copy()
+        for extra_annotator in objectspace.rougailconfig['extra_annotators']:
+            annotators.extend(ANNOTATORS[extra_annotator])
+        annotators = sorted(annotators, key=get_level)
+        functions = []
+        for eosfunc_file in eosfunc_files:
+            functions.extend(dir(load_modules(eosfunc_file)))
+        for annotator in annotators:
+            annotator(objectspace,
+                      functions,
                       )
-        ValueAnnotator(objectspace)
-        FamilyAnnotator(objectspace)
-        PropertyAnnotator(objectspace)
 
 
-__all__ = ('SpaceAnnotator', 'CONVERT_OPTION', 'modes')
+__all__ = ('SpaceAnnotator', 'CONVERT_OPTION')

src/rougail/annotator/check.py

@@ -25,22 +25,24 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
 from typing import List, Any
+from copy import copy
 
-from .target import TargetAnnotator
+from rougail.annotator.target import TargetAnnotator
-from .param import ParamAnnotator
+from rougail.annotator.param import ParamAnnotator
 
-from ..utils import load_modules
+from rougail.i18n import _
-from ..i18n import _
+from rougail.error import DictConsistencyError, display_xmlfiles
-from ..error import DictConsistencyError, display_xmlfiles
 
-INTERNAL_FUNCTIONS = ['valid_enum', 'valid_in_network', 'valid_differ', 'valid_entier']
+INTERNAL_FUNCTIONS = ['valid_in_network', 'valid_differ', 'valid_entier']
 
-class CheckAnnotator(TargetAnnotator, ParamAnnotator):
+class Annotator(TargetAnnotator, ParamAnnotator):
     """Annotate check
     """
+    level = 40
     def __init__(self,
                  objectspace,
-                 eosfunc_file,
+                 functions,
+                 *args,
                  ):
         if not hasattr(objectspace.space, 'constraints') or \
                 not hasattr(objectspace.space.constraints, 'check'):
@@ -48,27 +50,19 @@ class CheckAnnotator(TargetAnnotator, ParamAnnotator):
         self.objectspace = objectspace
         self.let_none = True
         self.only_variable = True
-        self.functions = dir(load_modules(eosfunc_file))
+        self.functions = copy(functions)
         self.functions.extend(INTERNAL_FUNCTIONS)
+        self.functions.extend(self.objectspace.rougailconfig['internal_functions'])
         self.target_is_uniq = False
+        self.allow_function = True
         self.convert_target(self.objectspace.space.constraints.check)
         self.convert_param(self.objectspace.space.constraints.check)
         self.check_check()
-        self.check_valid_enum()
         self.check_change_warning()
         self.convert_valid_entier()
         self.convert_check()
         del objectspace.space.constraints.check
 
-    def valid_type_validation(self,
-                              obj,
-                              ) -> None:
-        variable_type = None
-        if obj.name == 'valid_enum':
-            for target in obj.target:
-                variable_type = target.name.type
-        return variable_type
-
     def check_check(self):  # pylint: disable=R0912
         """valid and manage <check>
         """
@@ -83,100 +77,6 @@ class CheckAnnotator(TargetAnnotator, ParamAnnotator):
         for idx in remove_indexes:
             del self.objectspace.space.constraints.check[idx]
 
-    def check_valid_enum(self):
-        """verify valid_enum
-        """
-        remove_indexes = []
-        for idx, check in enumerate(self.objectspace.space.constraints.check):
-            if check.name != 'valid_enum':
-                continue
-            for target in check.target:
-                if target.name.path in self.objectspace.valid_enums:
-                    check_xmlfiles = display_xmlfiles(self.objectspace.valid_enums\
-                            [target.name.path]['xmlfiles'])
-                    msg = _(f'valid_enum already set in {check_xmlfiles} '
-                            f'for "{target.name.name}", you may have forget remove_check')
-                    raise DictConsistencyError(msg, 3, check.xmlfiles)
-                if not hasattr(check, 'param'):
-                    msg = _(f'param is mandatory for a valid_enum of variable "{target.name.name}"')
-                    raise DictConsistencyError(msg, 4, check.xmlfiles)
-                variable_type = target.name.type
-                values = self._set_valid_enum(target.name,
-                                              check,
-                                              )
-                if values:
-                    if hasattr(target.name, 'value'):
-                        # check value
-                        self.check_valid_enum_value(target.name, values)
-                    else:
-                        # no value, set the first choice has default value
-                        new_value = self.objectspace.value(check.xmlfiles)
-                        new_value.name = values[0]
-                        new_value.type = variable_type
-                        target.name.value = [new_value]
-            remove_indexes.append(idx)
-        remove_indexes.sort(reverse=True)
-        for idx in remove_indexes:
-            del self.objectspace.space.constraints.check[idx]
-
-    def _set_valid_enum(self,
-                        variable,
-                        check,
-                        ) -> List[Any]:
-        # value for choice's variable is mandatory
-        variable.mandatory = True
-        # build choice
-        variable.values = []
-        variable.ori_type = variable.type
-        variable.type = 'choice'
-
-        has_variable = False
-        values = []
-        for param in check.param:
-            if has_variable:
-                msg = _(f'only one "variable" parameter is allowed for valid_enum '
-                        f'of variable "{variable.name}"')
-                raise DictConsistencyError(msg, 5, param.xmlfiles)
-            param_type = variable.ori_type
-            if param.type == 'variable':
-                has_variable = True
-                if param.optional is True:
-                    msg = _(f'optional parameter in valid_enum for variable "{variable.name}" '
-                            f'is not allowed')
-                    raise DictConsistencyError(msg, 14, param.xmlfiles)
-                if not param.text.multi:
-                    msg = _(f'only multi "variable" parameter is allowed for valid_enum '
-                            f'of variable "{variable.name}"')
-                    raise DictConsistencyError(msg, 6, param.xmlfiles)
-                param_type = 'calculation'
-            values.append(param.text)
-            choice = self.objectspace.choice(variable.xmlfiles)
-            choice.name = param.text
-            choice.type = param_type
-            variable.values.append(choice)
-
-        if has_variable:
-            return None
-
-        for target in check.target:
-            self.objectspace.valid_enums[target.name.path] = {'type': variable.ori_type,
-                                                              'values': values,
-                                                              'xmlfiles': check.xmlfiles,
-                                                              }
-        return values
-
-    @staticmethod
-    def check_valid_enum_value(variable,
-                               values,
-                               ) -> None:
-        """check that values in valid_enum are valid
-        """
-        for value in variable.value:
-            if value.name not in values:
-                msg = _(f'value "{value.name}" of variable "{variable.name}" is not in list '
-                        f'of all expected values ({values})')
-                raise DictConsistencyError(msg, 15, value.xmlfiles)
-
     def check_change_warning(self):
         """convert level to "warnings_only"
         """
@@ -199,6 +99,8 @@ class CheckAnnotator(TargetAnnotator, ParamAnnotator):
                 if param.type != 'number':
                     msg = _(f'param in "valid_entier" must be an "integer", not "{param.type}"')
                     raise DictConsistencyError(msg, 18, check.xmlfiles)
+                if not hasattr(param, 'name'):
+                    continue
                 for target in check.target:
                     if param.name == 'mini':
                         target.name.min_number = int(param.text)

src/rougail/annotator/condition.py

@@ -24,23 +24,24 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
-from typing import List, Any
+from typing import List
 
 
-from ..i18n import _
+from rougail.i18n import _
-from ..error import DictConsistencyError
+from rougail.error import DictConsistencyError
-from ..config import RougailConfig
 
-from .target import TargetAnnotator
+from rougail.annotator.target import TargetAnnotator
-from .param import ParamAnnotator
+from rougail.annotator.param import ParamAnnotator
-from .variable import Walk
+from rougail.annotator.variable import Walk
 
 
-class ConditionAnnotator(TargetAnnotator, ParamAnnotator, Walk):
+class Annotator(TargetAnnotator, ParamAnnotator, Walk):
     """Annotate condition
     """
+    level = 50
     def __init__(self,
                  objectspace,
+                 *args,
                  ):
         self.objectspace = objectspace
         self.force_service_value = {}
@@ -51,8 +52,9 @@ class ConditionAnnotator(TargetAnnotator, ParamAnnotator, Walk):
             return
         self.target_is_uniq = False
         self.only_variable = False
+        self.allow_function = False
         self.convert_target(self.objectspace.space.constraints.condition)
-        self.check_condition_fallback()
+        self.check_condition_optional()
         self.convert_condition_source()
         self.convert_param(self.objectspace.space.constraints.condition)
         self.check_source_target()
@@ -65,7 +67,7 @@ class ConditionAnnotator(TargetAnnotator, ParamAnnotator, Walk):
                               obj,
                               ) -> None:
         if obj.source.type == 'choice':
-            return obj.source.ori_type
+            return None
         return obj.source.type
 
     def convert_auto_freeze(self):
@@ -73,21 +75,24 @@ class ConditionAnnotator(TargetAnnotator, ParamAnnotator, Walk):
         only if auto_freeze_variable is True this variable is frozen
         """
         for variable in self.get_variables():
-            if not variable.auto_freeze:
+            if not variable.auto_freeze and not variable.auto_save:
+                continue
+            #if variable.namespace != self.objectspace.rougailconfig['variable_namespace']:
+            #    msg = _(f'auto_freeze is not allowed in extra "{variable.namespace}"')
+            #    raise DictConsistencyError(msg, 49, variable.xmlfiles)
+            variable.force_store_value = True
+            if variable.auto_save:
                 continue
-            if variable.namespace != RougailConfig['variable_namespace']:
-                msg = _(f'auto_freeze is not allowed in extra "{variable.namespace}"')
-                raise DictConsistencyError(msg, 49, variable.xmlfiles)
             new_condition = self.objectspace.condition(variable.xmlfiles)
-            new_condition.name = 'auto_frozen_if_not_in'
+            new_condition.name = 'auto_frozen_if_in'
             new_condition.namespace = variable.namespace
-            new_condition.source = RougailConfig['auto_freeze_variable']
+            new_condition.source = self.objectspace.rougailconfig['auto_freeze_variable']
             new_param = self.objectspace.param(variable.xmlfiles)
             new_param.text = True
             new_condition.param = [new_param]
             new_target = self.objectspace.target(variable.xmlfiles)
             new_target.type = 'variable'
-            new_target.name = variable.name
+            new_target.name = variable.path
             new_condition.target = [new_target]
             if not hasattr(self.objectspace.space, 'constraints'):
                 self.objectspace.space.constraints = self.objectspace.constraints(variable.xmlfiles)
@@ -106,21 +111,18 @@ class ConditionAnnotator(TargetAnnotator, ParamAnnotator, Walk):
                             f'{condition.source.path}')
                     raise DictConsistencyError(msg, 11, condition.xmlfiles)
 
-    def check_condition_fallback(self):
+    def check_condition_optional(self):
-        """a condition with a fallback **and** the source variable doesn't exist
+        """a condition with a optional **and** the source variable doesn't exist
         """
         remove_conditions = []
         for idx, condition in enumerate(self.objectspace.space.constraints.condition):
-            # fallback
+            if condition.optional is False or \
-            if condition.fallback is False or \
                     self.objectspace.paths.path_is_defined(condition.source):
                 continue
-            if condition.name in ['disabled_if_in', 'mandatory_if_in', 'hidden_if_in']:
-                apply_action = not condition.force_condition_on_fallback
-            else:
-                apply_action = condition.force_inverse_condition_on_fallback
             remove_conditions.append(idx)
-            if apply_action:
+            if (hasattr(condition, 'apply_on_fallback') and condition.apply_on_fallback) or \
+                    (not hasattr(condition, 'apply_on_fallback') and \
+                     condition.name.endswith('_if_in')):
                 self.force_actions_to_variable(condition)
         remove_conditions.sort(reverse=True)
         for idx in remove_conditions:
@@ -150,8 +152,8 @@ class ConditionAnnotator(TargetAnnotator, ParamAnnotator, Walk):
         """
         if condition_name.startswith('hidden_if_'):
             return ['hidden', 'frozen', 'force_default_on_freeze']
-        if condition_name == 'auto_frozen_if_not_in':
+        if condition_name == 'auto_frozen_if_in':
-            return ['auto_frozen']
+            return ['frozen']
         return [condition_name.split('_', 1)[0]]
 
     def _get_family_variables_from_target(self,
@@ -162,13 +164,12 @@ class ConditionAnnotator(TargetAnnotator, ParamAnnotator, Walk):
                 return target.name, [target.name]
             # it's a leader, so apply property to leadership
             family_name = self.objectspace.paths.get_variable_family_path(target.name.path)
-            family = self.objectspace.paths.get_family(family_name,
+            namespace = target.name.namespace
-                                                       target.name.namespace,
+        else:
-                                                       )
+            family_name = target.name.path
-            return family, family.variable
+            namespace = target.namespace
-        # it's a family
+        variable = self.objectspace.paths.get_family(family_name,
-        variable = self.objectspace.paths.get_family(target.name.path,
+                                                     namespace,
-                                                     target.namespace,
                                                      )
         if hasattr(variable, 'variable'):
             return variable, list(variable.variable.values())
@@ -190,6 +191,9 @@ class ConditionAnnotator(TargetAnnotator, ParamAnnotator, Walk):
                                                       listvars,
                                                       fills,
                                                       )
+                    elif not target.optional:
+                        msg = f'cannot found target "{target.type}" "{target.name}"'
+                        raise DictConsistencyError(_(msg), 2, target.xmlfiles)
                     remove_targets.append(target_idx)
             remove_targets.sort(reverse=True)
             for target_idx in remove_targets:
@@ -237,17 +241,23 @@ class ConditionAnnotator(TargetAnnotator, ParamAnnotator, Walk):
                 or_needed = len(condition.param) != 1
             if len(condition.param) == 1:
                 values = getattr(condition.param[0], 'text', None)
+                param_type = condition.param[0].type
             else:
                 values = tuple([getattr(param, 'text', None) for param in condition.param])
+                param_type = None
+                for param in condition.param:
+                    if param_type is None or param_type == 'nil':
+                        param_type = param.type
             param3 = self.objectspace.param(target.xmlfiles)
             param3.name = f'condition_{fill.index}'
             param3.type = 'variable'
             param3.text = condition.source.path
+            param3.propertyerror = False
             fill.param.append(param3)
             param4 = self.objectspace.param(target.xmlfiles)
             param4.name = f'expected_{fill.index}'
             param4.text = values
-            param4.type = condition.param[0].type
+            param4.type = param_type
             fill.param.append(param4)
             if condition.name != 'disabled_if_in':
                 param5 = self.objectspace.param(target.xmlfiles)

src/rougail/annotator/family.py

@@ -24,24 +24,17 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
-from ..i18n import _
+from rougail.i18n import _
-from ..error import DictConsistencyError
+from rougail.error import DictConsistencyError
-from ..utils import normalize_family
+from rougail.annotator.variable import Walk
-from .variable import Walk
-
-
-#mode order is important
-modes_level = ('basic', 'normal', 'expert')
 
 
 class Mode:  # pylint: disable=R0903
     """Class to manage mode level
     """
     def __init__(self,
-                 name: str,
                  level: int,
                  ) -> None:
-        self.name = name
         self.level = level
 
     def __gt__(self,
@@ -50,18 +43,18 @@ class Mode:  # pylint: disable=R0903
         return other.level < self.level
 
 
-modes = {name: Mode(name, idx) for idx, name in enumerate(modes_level)}
+class Annotator(Walk):
-
-
-class FamilyAnnotator(Walk):
     """Annotate family
     """
+    level = 80
     def __init__(self,
                  objectspace,
+                 *args,
                  ):
         self.objectspace = objectspace
         if not hasattr(self.objectspace.space, 'variables'):
             return
+        self.modes = {name: Mode(idx) for idx, name in enumerate(self.objectspace.rougailconfig['modes_level'])}
         self.remove_empty_families()
         self.family_names()
         self.change_modes()
@@ -83,6 +76,7 @@ class FamilyAnnotator(Walk):
     def remove_empty_families(self) -> None:
         """Remove all families without any variable
         """
+        #FIXME pas sous family
         for families in self.objectspace.space.variables.values():
             removed_families = []
             for family_name, family in families.variable.items():
@@ -99,96 +93,174 @@ class FamilyAnnotator(Walk):
                 family.description = family.name
             family.doc = family.description
             del family.description
-            family.name = normalize_family(family.name)
 
     def change_modes(self):
         """change the mode of variables
         """
-        # default is high level
+        modes_level = self.objectspace.rougailconfig['modes_level']
-        new_family_mode = modes_level[-1]
+        default_variable_mode = self.objectspace.rougailconfig['default_variable_mode']
-        for family in self.objectspace.space.variables.values():
+        if default_variable_mode not in modes_level:
-            self.change_family_mode(family,
+            msg = _(f'default variable mode "{default_variable_mode}" is not a valid mode, '
-                                    new_family_mode,
+                    f'valid modes are {modes_level}')
-                                    first=True,
+            raise DictConsistencyError(msg, 72, None)
-                                    )
+        default_family_mode = self.objectspace.rougailconfig['default_family_mode']
+        if default_family_mode not in modes_level:
+            msg = _(f'default family mode "{default_family_mode}" is not a valid mode, '
+                    f'valid modes are {modes_level}')
+            raise DictConsistencyError(msg, 73, None)
+        families = list(self.get_families())
+        for family in families:
+            self.valid_mode(family)
+            self._set_default_mode(family)
+        families.reverse()
+        for family in families:
+            self._change_family_mode(family)
 
-    def change_family_mode(self,
+    def valid_mode(self,
-                           family: 'self.objectspace.family',
+                   obj,
-                           new_family_mode: str,
+                   ) -> None:
-                           first: bool=False,
+        modes_level = self.objectspace.rougailconfig['modes_level']
-                           ) -> str:
+        if self._has_mode(obj) and obj.mode not in modes_level:
+            msg = _(f'mode "{obj.mode}" for "{obj.name}" is not a valid mode, '
+                    f'valid modes are {modes_level}')
+            raise DictConsistencyError(msg, 71, obj.xmlfiles)
+
+    def _set_default_mode(self,
+                         family: 'self.objectspace.family',
+                         ) -> None:
+        if not hasattr(family, 'variable'):
+            return
+        if self._has_mode(family):
+            family_mode = family.mode
+        else:
+            family_mode = None
+        leader = None
+        for variable in family.variable.values():
+            if leader is None and hasattr(family, 'leadership') and family.leadership:
+                leader = variable
+            if isinstance(variable, self.objectspace.family):
+                # set default mode a subfamily
+                if family_mode and not self._has_mode(variable):
+                    self._set_auto_mode(variable, family_mode)
+            else:
+                # set default mode to a variable
+                self.valid_mode(variable)
+                if leader:
+                    self._set_default_mode_leader(leader, variable)
+                self._set_default_mode_variable(variable, family_mode)
+        if leader:
+            # here because follower can change leader mode
+            self._set_auto_mode(family, leader.mode)
+
+    @staticmethod
+    def _has_mode(obj) -> bool:
+        return 'mode' in vars(obj) and not hasattr(obj, 'mode_auto')
+
+    def _set_default_mode_variable(self,
+                                   variable: 'self.objectspace.variable',
+                                   family_mode: str,
+                                   ) -> None:
+        # auto_save or auto_freeze variable is set to 'basic' mode
+        # if its mode is not defined by the user
+        if not self._has_mode(variable) and \
+                (variable.auto_save is True or variable.auto_freeze is True):
+            variable.mode = self.objectspace.rougailconfig['modes_level'][0]
+        # mandatory variable without value is a basic variable
+        elif not self._has_mode(variable) and \
+                variable.mandatory is True and \
+                not hasattr(variable, 'default') and \
+                not hasattr(variable, 'default_multi'):
+            variable.mode = self.objectspace.rougailconfig['modes_level'][0]
+        elif family_mode and not self._has_mode(variable):
+            self._set_auto_mode(variable, family_mode)
+
+    @staticmethod
+    def _set_auto_mode(obj, mode: str) -> None:
+        obj.mode = mode
+        obj.mode_auto = True
+
+    def _set_default_mode_leader(self,
+                                 leader: 'self.objectspace.variable',
+                                 follower: 'self.objectspace.variable',
+                                 ) -> None:
+        if follower.auto_save is True:
+            msg = _(f'leader/followers "{follower.name}" could not be auto_save')
+            raise DictConsistencyError(msg, 29, follower.xmlfiles)
+        if follower.auto_freeze is True:
+            msg = f'leader/followers "{follower.name}" could not be auto_freeze'
+            raise DictConsistencyError(_(msg), 30, follower.xmlfiles)
+        if leader == follower:
+            # it's a leader
+            if not hasattr(leader, 'mode'):
+                self._set_auto_mode(leader, self.objectspace.rougailconfig['default_variable_mode'])
+            return
+        if self._has_mode(follower):
+            follower_mode = follower.mode
+        else:
+            follower_mode = self.objectspace.rougailconfig['default_variable_mode']
+        if self.modes[leader.mode] > self.modes[follower_mode]:
+            if self._has_mode(follower) and not self._has_mode(leader):
+                # if follower has mode but not the leader
+                self._set_auto_mode(leader, follower_mode)
+            else:
+                # leader's mode is minimum level
+                if self._has_mode(follower):
+                    msg = _(f'the follower "{follower.name}" is in "{follower_mode}" mode '
+                            f'but leader have the higher mode "{leader.mode}"')
+                    raise DictConsistencyError(msg, 63, follower.xmlfiles)
+                self._set_auto_mode(follower, leader.mode)
+
+    def _change_family_mode(self,
+                            family: 'self.objectspace.family',
+                            ) -> None:
         if hasattr(family, 'mode'):
             family_mode = family.mode
         else:
-            family_mode = new_family_mode
+            family_mode = self.objectspace.rougailconfig['default_family_mode']
+        min_variable_mode = self.objectspace.rougailconfig['modes_level'][-1]
+        # change variable mode, but not if variables are not in a family
+        is_leadership = hasattr(family, 'leadership') and family.leadership
         if hasattr(family, 'variable'):
-            # change variable mode, but not if variables are not in a family
+            for idx, variable in enumerate(family.variable.values()):
-            for variable in family.variable.values():
                 if isinstance(variable, self.objectspace.family):
-                    new_family_mode = self.change_family_mode(variable,
+                    if not hasattr(variable, 'mode'):
-                                                              new_family_mode,
+                        variable.mode = self.objectspace.rougailconfig['default_family_mode']
-                                                              )
+                elif idx == 0 and is_leadership:
+                    variable.mode = None
                     continue
-                if first:
-                    continue
-                if isinstance(variable, self.objectspace.leadership):
-                    func = self._change_variable_mode_leader
                 else:
-                    func = self._change_variabe_mode
+                    self._change_variable_mode(variable, family_mode, is_leadership)
-                func(variable,
+                if self.modes[min_variable_mode] > self.modes[variable.mode]:
-                     family_mode,
+                    min_variable_mode = variable.mode
-                     )
+        if not isinstance(family, self.objectspace.family) or is_leadership:
-                if modes[new_family_mode] > modes[variable.mode]:
+            # it's Variable, Service, ... and leadership
-                    new_family_mode = variable.mode
+            return
-        if not first:
+        if not hasattr(family, 'mode'):
             # set the lower variable mode to family
-            family.mode = new_family_mode
+            self._set_auto_mode(family, min_variable_mode)
-        return new_family_mode
+        if family.mode != min_variable_mode:
+            msg = _(f'the family "{family.name}" is in "{family.mode}" mode but variables and '
+                    f'families inside have the higher modes "{min_variable_mode}"')
+            raise DictConsistencyError(msg, 62, family.xmlfiles)
 
-    def _change_variabe_mode(self,
+    def _change_variable_mode(self,
                              variable,
                              family_mode: str,
-                             is_follower=False,
+                             is_follower: bool,
                              ) -> None:
-        # auto_save or auto_freeze variable is set to 'basic' mode
+        if hasattr(variable, 'mode'):
-        # if its mode is not defined by the user
+            variable_mode = variable.mode
-        if 'mode' not in vars(variable) and \
+        else:
-                (variable.auto_save is True or variable.auto_freeze is True):
+            variable_mode = self.objectspace.rougailconfig['default_variable_mode']
-            variable.mode = modes_level[0]
-        # mandatory variable without value is a basic variable
-        if variable.mandatory is True and not hasattr(variable, 'default'):
-            variable.mode = modes_level[0]
         # none basic variable in high level family has to be in high level
-        if modes[variable.mode] < modes[family_mode] and \
+        if not is_follower and self.modes[variable_mode] < self.modes[family_mode]:
-                (not is_follower or variable.mode != modes_level[0]):
+            if self._has_mode(variable):
-            variable.mode = family_mode
+                msg = _(f'the variable "{variable.name}" is in "{variable_mode}" mode '
-
+                        f'but family has the higher family mode "{family_mode}"')
-    def _change_variable_mode_leader(self,
+                raise DictConsistencyError(msg, 61, variable.xmlfiles)
-                                     leadership,
+            self._set_auto_mode(variable, family_mode)
-                                     family_mode: str,
+        if not hasattr(variable, 'mode'):
-                                     ) -> None:
+            variable.mode = variable_mode
-        is_follower = False
-        leader_mode = None
-        for follower in leadership.variable:
-            if follower.auto_save is True:
-                msg = _(f'leader/followers "{follower.name}" could not be auto_save')
-                raise DictConsistencyError(msg, 29, leadership.xmlfiles)
-            if follower.auto_freeze is True:
-                msg = f'leader/followers "{follower.name}" could not be auto_freeze'
-                raise DictConsistencyError(_(msg), 30, leadership.xmlfiles)
-            self._change_variabe_mode(follower,
-                                      family_mode,
-                                      is_follower,
-                                      )
-            if leader_mode is None:
-                leader_mode = leadership.variable[0].mode
-                leadership.variable[0].mode = None
-            else:
-                # leader's mode is minimum level
-                if modes[leader_mode] > modes[follower.mode]:
-                    follower.mode = leader_mode
-            is_follower = True
-        leadership.mode = leader_mode
 
     def dynamic_families(self):
         """link dynamic families to object
@@ -196,14 +268,14 @@ class FamilyAnnotator(Walk):
         for family in self.get_families():
             if 'dynamic' not in vars(family):
                 continue
-            family.suffixes = self.objectspace.paths.get_variable(family.dynamic)
+            family.suffixes = self.objectspace.paths.get_variable(family.dynamic, family.xmlfiles)
             del family.dynamic
             if not family.suffixes.multi:
                 msg = _(f'dynamic family "{family.name}" must be linked '
                         f'to multi variable')
                 raise DictConsistencyError(msg, 16, family.xmlfiles)
             for variable in family.variable.values():
-                if isinstance(variable, self.objectspace.family):
+                if isinstance(variable, self.objectspace.family) and not variable.leadership:
                     msg = _(f'dynamic family "{family.name}" cannot contains another family')
                     raise DictConsistencyError(msg, 22, family.xmlfiles)
 

src/rougail/annotator/fill.py

@@ -24,52 +24,72 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
-from ..utils import load_modules
+from copy import copy
-from ..i18n import _
+from rougail.i18n import _
-from ..error import DictConsistencyError
+from rougail.error import DictConsistencyError
 
-from .target import TargetAnnotator
+from rougail.annotator.target import TargetAnnotator
-from .param import ParamAnnotator
+from rougail.annotator.param import ParamAnnotator
 
 
-class FillAnnotator(TargetAnnotator, ParamAnnotator):
+CALC_MULTI = ('calc_value', 'calc_list', 'get_range', 'calc_val_first_value', 'unbound_filename', 'zone_information', 'get_certificates', 'nsd_filename', 'get_linked_configuration', 'get_internal_zones', 'nsd_concat_lists', 'get_internal_info_in_zone')
+
+
+class Annotator(TargetAnnotator, ParamAnnotator):
     """Fill annotator
     """
+    level = 60
     def __init__(self,
                  objectspace,
-                 eosfunc_file,
+                 functions,
+                 *args,
                  ):
-        self.objectspace = objectspace
         if not hasattr(objectspace.space, 'constraints') or \
-                not hasattr(self.objectspace.space.constraints, 'fill'):
+                not hasattr(objectspace.space.constraints, 'fill'):
             return
-        self.functions = dir(load_modules(eosfunc_file))
+        self.objectspace = objectspace
+        self.functions = copy(functions)
+        self.functions.extend(self.objectspace.rougailconfig['internal_functions'])
+        self.calc_multi = list(CALC_MULTI)
+        self.calc_multi.extend(self.objectspace.rougailconfig['multi_functions'])
         self.target_is_uniq = True
         self.only_variable = True
+        self.allow_function = False
         self.convert_target(self.objectspace.space.constraints.fill)
         self.convert_param(self.objectspace.space.constraints.fill)
         self.fill_to_value()
         del self.objectspace.space.constraints.fill
 
+    def calc_is_multi(self, variable: 'self.objectspace.variable') -> bool:
+        multi = variable.multi
+        if multi is False:
+            return multi
+        if multi == 'submulti':
+            return True
+        return not self.objectspace.paths.is_follower(variable.path)
+
     def fill_to_value(self) -> None:
         """valid and manage <fill>
         """
         for fill in self.objectspace.space.constraints.fill:
+            # test if the function exists
+            if fill.name not in self.functions:
+                msg = _(f'cannot find fill function "{fill.name}"')
+                raise DictConsistencyError(msg, 25, fill.xmlfiles)
             for target in fill.target:
-                # test if the function exists
-                if fill.name not in self.functions:
-                    msg = _(f'cannot find fill function "{fill.name}"')
-                    raise DictConsistencyError(msg, 25, fill.xmlfiles)
-
                 # create an object value
                 value = self.objectspace.value(fill.xmlfiles)
                 value.type = 'calculation'
                 value.name = fill.name
+                if fill.name not in self.calc_multi:
+                    is_calc_multi = self.calc_is_multi(target.name)
+                else:
+                    is_calc_multi = False
+                value.calc_multi = is_calc_multi
                 if target.name.namespace == 'services':
                     target.name.default = value
                 else:
                     target.name.value = [value]
-
                 # manage params
                 if hasattr(fill, 'param') and fill.param:
                     value.param = fill.param

src/rougail/annotator/group.py

@@ -24,133 +24,54 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
-from ..i18n import _
+from rougail.i18n import _
-from ..error import DictConsistencyError
+from rougail.error import DictConsistencyError
+from rougail.utils import normalize_family
+from rougail.annotator.variable import Walk
 
 
-class GroupAnnotator:
+class Annotator(Walk):
     """Annotate group
     """
+    level = 10
     def __init__(self,
                  objectspace,
+                 *args,
                  ):
-        self.objectspace = objectspace
+        if not hasattr(objectspace.space, 'variables'):
-        if not hasattr(self.objectspace.space, 'constraints') or \
-                not hasattr(self.objectspace.space.constraints, 'group'):
             return
+        self.objectspace = objectspace
         self.convert_groups()
 
     def convert_groups(self):  # pylint: disable=C0111
         """convert groups
         """
         # store old leaders family name
-        cache_paths = {}
+        for family in self.get_families():
-        for group in self.objectspace.space.constraints.group:
+            if not isinstance(family, self.objectspace.family):
-            if group.leader in cache_paths:
+                continue
-                leader_fam_path = cache_paths[group.leader]
+            if not family.leadership:
-            else:
+                continue
-                leader_fam_path = self.objectspace.paths.get_variable_family_path(group.leader)
+            if hasattr(family, 'dynamic'):
-                cache_paths[group.leader] = leader_fam_path
+                msg = _(f'the family "{family.name}" cannot be leadership and dynamic together')
-            follower_names = list(group.follower.keys())
+                raise DictConsistencyError(msg, 31, family.xmlfiles)
-            leader = self.objectspace.paths.get_variable(group.leader)
+            for idx, variable in enumerate(family.variable.values()):
-            ori_leader_family = self.objectspace.paths.get_family(leader_fam_path,
+                if idx == 0:
-                                                                  leader.namespace,
-                                                                  )
-            has_a_leader = False
-            for variable in list(ori_leader_family.variable.values()):
-                if isinstance(variable, self.objectspace.leadership) and \
-                        variable.variable[0].name == leader.name:
-                    # append follower to an existed leadership
-                    leader_space = variable
-                    has_a_leader = True
-                elif variable.name == leader.name:
                     # it's a leader
-                    leader_space = self.manage_leader(variable,
+                    if variable.multi is not True:
-                                                      group,
+                        msg = _(f'the variable "{variable.name}" in a leadership must be multi')
-                                                      ori_leader_family,
+                        raise DictConsistencyError(msg, 32, variable.xmlfiles)
-                                                      )
+                    family.hidden = variable.hidden
-                    has_a_leader = True
+                    if variable.hidden:
-                elif has_a_leader:
+                        variable.frozen = True
-                    # it's should be a follower
+                        variable.force_default_on_freeze = True
-                    self.manage_follower(follower_names.pop(0),
+                    variable.hidden = None
-                                         leader_fam_path,
+                else:
-                                         variable,
+                    # it's a follower
-                                         leader_space,
+                    if family.hidden:
-                                         )
+                        variable.frozen = True
-                    # this variable is not more in ori_leader_family
+                        variable.force_default_on_freeze = True
-                    ori_leader_family.variable.pop(variable.name)
+                    if variable.multi is True:
-                    if follower_names == []:
+                        variable.multi = 'submulti'
-                        # no more follower
+                    else:
-                        break
+                        variable.multi = True
-            else:
-                joined = '", "'.join(follower_names)
-                msg = _(f'when parsing leadership, we espect to find those followers "{joined}"')
-                raise DictConsistencyError(msg, 31, variable.xmlfiles)
-        del self.objectspace.space.constraints.group
-
-    def manage_leader(self,
-                      variable: 'Variable',
-                      group: 'Group',
-                      ori_leader_family,
-                      ) -> 'Leadership':
-        """manage leader's variable
-        """
-        if variable.multi is not True:
-            msg = _(f'the variable "{variable.name}" in a group must be multi')
-            raise DictConsistencyError(msg, 32, variable.xmlfiles)
-        if hasattr(group, 'name'):
-            leadership_name = group.name
-        else:
-            leadership_name = variable.name
-        leader_space = self.objectspace.leadership(variable.xmlfiles)
-        leader_space.variable = []
-        leader_space.name = leadership_name
-        leader_space.hidden = variable.hidden
-        if variable.hidden:
-            variable.frozen = True
-            variable.force_default_on_freeze = True
-        variable.hidden = None
-        if hasattr(group, 'description'):
-            leader_space.doc = group.description
-        elif variable.name == leadership_name and hasattr(variable, 'description'):
-            leader_space.doc = variable.description
-        else:
-            leader_space.doc = leadership_name
-        leadership_path = ori_leader_family.path + '.' + leadership_name
-        self.objectspace.paths.add_leadership(variable.namespace,
-                                              leadership_path,
-                                              leader_space,
-                                              )
-        leader_family = self.objectspace.paths.get_family(ori_leader_family.path,
-                                                          ori_leader_family.namespace,
-                                                          )
-        leader_family.variable[variable.name] = leader_space
-        leader_space.variable.append(variable)
-        self.objectspace.paths.set_leader(variable.namespace,
-                                          ori_leader_family.path,
-                                          leadership_name,
-                                          variable.name,
-                                          )
-        return leader_space
-
-    def manage_follower(self,
-                        follower_name: str,
-                        leader_family_name: str,
-                        variable: 'Variable',
-                        leader_space: 'Leadership',
-                        ) -> None:
-        """manage follower
-        """
-        if variable.name != follower_name:
-            msg = _('when parsing leadership, we expect to find the follower '
-                    f'"{follower_name}" but we found "{variable.name}"')
-            raise DictConsistencyError(msg, 33, variable.xmlfiles)
-        self.objectspace.paths.set_leader(variable.namespace,
-                                          leader_family_name,
-                                          leader_space.name,
-                                          variable.name,
-                                          )
-        if leader_space.hidden:
-            variable.frozen = True
-            variable.force_default_on_freeze = True
-        leader_space.variable.append(variable)

src/rougail/annotator/param.py

@@ -24,16 +24,26 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
-from .variable import CONVERT_OPTION
+try:
+    import tiramisu3 as tiramisu
+except ModuleNotFoundError:
+    import tiramisu
 
-from ..i18n import _
+from rougail.annotator.variable import CONVERT_OPTION
-from ..error import DictConsistencyError
+
+from rougail.i18n import _
+from rougail.error import DictConsistencyError
 
 
 class ParamAnnotator:
-    def valid_type_validation(self,
+    """Param annotator
-                              obj,
+    """
-                              ) -> None:
+    objectspace = None
+
+    @staticmethod
+    def valid_type_validation(obj) -> None:
+        """Function to valid type (redefine in fill/condition/check classes)
+        """
         return None
 
     def convert_param(self, objects) -> None:
@@ -45,54 +55,100 @@ class ParamAnnotator:
             param_to_delete = []
             variable_type = self.valid_type_validation(obj)
             for param_idx, param in enumerate(obj.param):
-                if param.type == 'suffix':
+                if hasattr(param, 'text'):
-                    if hasattr(param, 'text'):
+                    if param.type in ['suffix', 'index']:
                         msg = _(f'"{param.type}" parameter must not have a value')
                         raise DictConsistencyError(msg, 28, obj.xmlfiles)
+                    if param.type in ['nil', 'space']:
+                        if param.text is not None:
+                            msg = _(f'"{param.type}" parameter must not have a value')
+                            raise DictConsistencyError(msg, 40, obj.xmlfiles)
+                    elif param.type == 'variable':
+                        try:
+                            path, suffix = self.objectspace.paths.get_variable_path(param.text,
+                                                                                    obj.namespace,
+                                                                                    param.xmlfiles,
+                                                                                    )
+                            param.text = self.objectspace.paths.get_variable(path)
+                            if variable_type and param.text.type != variable_type:
+                                msg = _(f'"{obj.name}" has type "{variable_type}" but param '
+                                        f'has type "{param.text.type}"')
+                                raise DictConsistencyError(msg, 26, param.xmlfiles)
+                            if suffix:
+                                param.suffix = suffix
+                                family_path = self.objectspace.paths.get_variable_family_path(path)
+                                namespace = param.text.namespace
+                                param.family = self.objectspace.paths.get_family(family_path,
+                                                                                 namespace,
+                                                                                 )
+                        except DictConsistencyError as err:
+                            if err.errno != 42 or not param.optional:
+                                raise err
+                            param_to_delete.append(param_idx)
+                    elif param.type == 'function':
+                        if not self.allow_function:
+                            msg = _(f'cannot use "function" type')
+                            raise DictConsistencyError(msg, 74, param.xmlfiles)
+                        if not param.text in self.functions:
+                            msg = _(f'cannot find function "{param.text}"')
+                            raise DictConsistencyError(msg, 67, param.xmlfiles)
+                        if param_idx != 0:
+                            msg = _(f'function "{param.text}" must only set has first parameter')
+                            raise DictConsistencyError(msg, 75, param.xmlfiles)
+                    elif variable_type:
+                        self._convert_with_variable_type(variable_type, param)
+                    continue
+                # no param.text
+                if param.type == 'suffix':
                     for target in obj.target:
                         if not self.objectspace.paths.variable_is_dynamic(target.name.path):
-                            msg = _(f'"suffix" parameter cannot be set with target "{target.name}"'
+                            target_name = target.name
-                                    f' which is not a dynamic variable')
+                            if isinstance(target_name, self.objectspace.variable):
+                                target_name = target_name.name
+                            msg = _(f'"{param.type}" parameter cannot be set with target '
+                                    f'"{target_name}" which is not a dynamic variable')
                             raise DictConsistencyError(msg, 53, obj.xmlfiles)
-                elif not hasattr(param, 'text'):
+                elif param.type == 'index':
-                    if not param.type == 'nil':
+                    for target in obj.target:
-                        msg = _(f'"{param.type}" parameter must have a value')
+                        if not self.objectspace.paths.is_follower(target.name.path):
-                        raise DictConsistencyError(msg, 27, obj.xmlfiles)
+                            msg = _(f'"{param.type}" parameter cannot be set with target '
-                    param.text = None
+                                    f'"{target.name.name}" which is not a follower variable')
+                            raise DictConsistencyError(msg, 60, obj.xmlfiles)
                 elif param.type == 'nil':
-                    msg = _(f'"{param.type}" parameter must not have a value')
+                    param.text = None
-                    raise DictConsistencyError(msg, 40, obj.xmlfiles)
+                elif param.type == 'space':
-                elif param.type == 'variable':
+                    param.type = 'string'
-                    try:
+                    param.text = ' '
-                        path, suffix = self.objectspace.paths.get_variable_path(param.text,
+                elif param.type == 'string':
-                                                                                obj.namespace,
+                    param.text = ''
-                                                                                )
+                    if variable_type:
-                        param.text = self.objectspace.paths.get_variable(path)
+                        self._convert_with_variable_type(variable_type, param)
-                        if variable_type and param.text.type != variable_type:
+                else:
-                            msg = _(f'"{obj.name}" has type "{variable_type}" but param has type "{param.text.type}"')
+                    msg = _(f'"{param.type}" parameter must have a value')
-                            raise DictConsistencyError(msg, 26, param.xmlfiles)
+                    raise DictConsistencyError(msg, 27, obj.xmlfiles)
-                        if suffix:
-                            param.suffix = suffix
-                            family_path = self.objectspace.paths.get_variable_family_path(path)
-                            param.family = self.objectspace.paths.get_family(family_path,
-                                                                             param.text.namespace,
-                                                                             )
-                    except DictConsistencyError as err:
-                        if err.errno != 42 or not param.optional:
-                            raise err
-                        param_to_delete.append(param_idx)
-                elif variable_type:
-                    if 'type' in vars(param) and variable_type != param.type:
-                        msg = _(f'parameter has incompatible type "{param.type}" '
-                                f'with type "{variable_type}"')
-                        raise DictConsistencyError(msg, 7, param.xmlfiles)
-                    try:
-                        param.text = CONVERT_OPTION[variable_type].get('func', str)(param.text)
-                    except ValueError as err:
-                        msg = _(f'unable to change type of "{param.text}" '
-                                f'is not a valid "{variable_type}"')
-                        raise DictConsistencyError(msg, 13, param.xmlfiles) from err
-                    param.type = variable_type
             param_to_delete.sort(reverse=True)
             for param_idx in param_to_delete:
                 obj.param.pop(param_idx)
+
+    @staticmethod
+    def _convert_with_variable_type(variable_type: str,
+                                    param: 'self.objectspace.param',
+                                    ) -> None:
+        if 'type' in vars(param) and variable_type != param.type:
+            msg = _(f'parameter has incompatible type "{param.type}" '
+                    f'with type "{variable_type}"')
+            raise DictConsistencyError(msg, 7, param.xmlfiles)
+        if variable_type != 'choice':
+            try:
+                option = CONVERT_OPTION[variable_type]
+                param.text = option.get('func', str)(param.text)
+                getattr(tiramisu, option['opttype'])('test',
+                                                     'Object to valid value',
+                                                     param.text,
+                                                     **option.get('initkwargs', {}),
+                                                     )
+            except ValueError as err:
+                msg = _(f'unable to change type of value "{param.text}" '
+                        f'is not a valid "{variable_type}"')
+                raise DictConsistencyError(msg, 13, param.xmlfiles) from err
+        param.type = variable_type

src/rougail/annotator/property.py

@@ -24,22 +24,23 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
-from ..i18n import _
+from rougail.i18n import _
-from ..error import DictConsistencyError
+from rougail.error import DictConsistencyError
-from .variable import Walk
+from rougail.annotator.variable import Walk
 
 
-PROPERTIES = ('hidden', 'frozen', 'auto_freeze', 'auto_save', 'force_default_on_freeze',
+PROPERTIES = ('hidden', 'frozen', 'force_default_on_freeze',
               'force_store_value', 'disabled', 'mandatory')
-CONVERT_PROPERTIES = {'auto_save': ['force_store_value'],
-                      'auto_freeze': ['force_store_value', 'auto_freeze'],
-                      }
 
 
-class PropertyAnnotator(Walk):
+class Annotator(Walk):
     """Annotate properties
     """
-    def __init__(self, objectspace):
+    level = 90
+    def __init__(self,
+                 objectspace,
+                 *args
+                 ) -> None:
         self.objectspace = objectspace
         if hasattr(self.objectspace.space, 'services'):
             self.convert_services()
@@ -53,19 +54,23 @@ class PropertyAnnotator(Walk):
         """convert properties
         """
         # hidden variable is also frozen
-        if isinstance(variable, self.objectspace.variable) and variable.hidden is True:
+        if isinstance(variable, self.objectspace.variable) and variable.hidden is True and \
-            variable.frozen = True
+                variable.name != self.objectspace.rougailconfig['auto_freeze_variable']:
+            if not variable.auto_freeze and \
+                    not hasattr(variable, 'provider'):
+                variable.frozen = True
             if not variable.auto_save and \
                     not variable.auto_freeze and \
-                    'force_default_on_freeze' not in vars(variable):
+                    'force_default_on_freeze' not in vars(variable) and \
+                    not hasattr(variable, 'provider'):
                 variable.force_default_on_freeze = True
         if not hasattr(variable, 'properties'):
             variable.properties = []
         for prop in PROPERTIES:
             if hasattr(variable, prop):
                 if getattr(variable, prop) is True:
-                    for subprop in CONVERT_PROPERTIES.get(prop, [prop]):
+#                    for subprop in CONVERT_PROPERTIES.get(prop, [prop]):
-                        variable.properties.append(subprop)
+                    variable.properties.append(prop)
                 setattr(variable, prop, None)
         if hasattr(variable, 'mode') and variable.mode:
             variable.properties.append(variable.mode)
@@ -73,7 +78,7 @@ class PropertyAnnotator(Walk):
         if 'force_store_value' in variable.properties and \
                 'force_default_on_freeze' in variable.properties:  # pragma: no cover
             # should not appened
-            msg = _('cannot have auto_freeze or auto_store with the hidden '
+            msg = _('cannot have auto_freeze or auto_save with the hidden '
                     f'variable "{variable.name}"')
             raise DictConsistencyError(msg, 50, variable.xmlfiles)
         if not variable.properties:
@@ -95,14 +100,13 @@ class PropertyAnnotator(Walk):
                         self.convert_property(variable)
 
     def convert_family(self) -> None:
-        """convert variables
+        """convert families
         """
         for family in self.get_families():
             self.convert_property(family)
 
     def convert_variable(self) -> None:
-        for variable in self.get_variables(with_leadership=True):
+        """convert variables
-            if isinstance(variable, self.objectspace.leadership):
+        """
-                for follower in variable.variable:
+        for variable in self.get_variables():
-                    self.convert_property(follower)
             self.convert_property(variable)

src/rougail/annotator/service.py

@@ -27,40 +27,35 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 from os.path import basename
 from typing import Tuple
 
-from ..i18n import _
+from rougail.i18n import _
-from ..utils import normalize_family
+from rougail.utils import normalize_family
-from ..error import DictConsistencyError
+from rougail.error import DictConsistencyError
-# a CreoleObjSpace's attribute has some annotations
+# a object's attribute has some annotations
 # that shall not be present in the exported (flatened) XML
-ERASED_ATTRIBUTES = ('redefine', 'exists', 'fallback', 'optional', 'remove_check', 'namespace',
+ERASED_ATTRIBUTES = ('redefine', 'namespace', 'xmlfiles', 'disabled', 'name', 'manage')
-                     'remove_condition', 'path', 'instance_mode', 'index',
+ERASED_ATTRIBUTES2 = ('redefine', 'namespace', 'xmlfiles', 'disabled')
-                     'level', 'remove_fill', 'xmlfiles', 'type', 'reflector_name',
+ALLOW_ATTRIBUT_NOT_MANAGE = ['file', 'engine', 'target']
-                     'reflector_object',)
 
 
-KEY_TYPE = {'variable': 'symlink',
+class Annotator:
-            'PortOption': 'port',
-            'UnicodeOption': 'string',
-            'NetworkOption': 'network',
-            'NetmaskOption': 'netmask',
-            'URLOption': 'web_address',
-            'FilenameOption': 'filename',
-            }
-
-
-class ServiceAnnotator:
     """Manage service's object
     for example::
         <services>
             <service name="test">
                 <service_access service='ntp'>
-                    <port protocol='udp' service_accesslist='ntp_udp'>123</port>
                 </service_access>
             </service>
         </services>
     """
-    def __init__(self, objectspace):
+    level = 20
+    def __init__(self,
+                 objectspace,
+                 *args,
+                 ) -> None:
         self.objectspace = objectspace
+        self.uniq_overrides = []
+        if 'network_type' not in self.objectspace.types:
+            self.objectspace.types['network_type'] = self.objectspace.types['ip_type']
         if hasattr(self.objectspace.space, 'services'):
             if not hasattr(self.objectspace.space.services, 'service'):
                 del self.objectspace.space.services
@@ -75,25 +70,62 @@ class ServiceAnnotator:
         self.objectspace.space.services.doc = 'services'
         self.objectspace.space.services.path = 'services'
         for service_name, service in self.objectspace.space.services.service.items():
-            service.information = self.objectspace.information(service.xmlfiles)
+            service.name = normalize_family(service_name)
+            activate_obj = self._generate_element('boolean',
+                                                  None,
+                                                  None,
+                                                  'activate',
+                                                  not service.disabled,
+                                                  service,
+                                                  '.'.join(['services', service.name, 'activate']),
+                                                  )
+            service.disabled = None
             for elttype, values in dict(vars(service)).items():
-                if not isinstance(values, (dict, list)) or elttype in ERASED_ATTRIBUTES:
+                if elttype == 'servicelist':
+                    self.objectspace.list_conditions.setdefault('servicelist',
+                                                                {}).setdefault(
+                                                                    values,
+                                                                    []).append(activate_obj)
                     continue
-                eltname = elttype + 's'
+                if elttype in ERASED_ATTRIBUTES:
-                path = '.'.join(['services', normalize_family(service_name), eltname])
+                    continue
-                family = self._gen_family(eltname,
+                if not service.manage and elttype not in ALLOW_ATTRIBUT_NOT_MANAGE:
-                                          path,
+                    msg = _(f'unmanage service cannot have "{elttype}"')
-                                          service.xmlfiles,
+                    raise DictConsistencyError(msg, 66, service.xmlfiles)
-                                          )
+                if isinstance(values, (dict, list)):
-                if isinstance(values, dict):
+                    if elttype != 'ip':
-                    values = list(values.values())
+                        eltname = elttype + 's'
-                family.family = self.make_group_from_elts(service_name,
+                    else:
-                                                          elttype,
+                        eltname = elttype
-                                                          values,
+                    path = '.'.join(['services', service.name, eltname])
-                                                          path,
+                    family = self._gen_family(eltname,
-                                                          )
+                                              path,
-                setattr(service, elttype, family)
+                                              service.xmlfiles,
-            service.doc = service.name
+                                              with_informations=False,
+                                              )
+                    if isinstance(values, dict):
+                        values = list(values.values())
+                    family.family = self.make_group_from_elts(service_name,
+                                                              elttype,
+                                                              values,
+                                                              path,
+                                                              )
+                    setattr(service, elttype, family)
+                else:
+                    if not hasattr(service, 'information'):
+                        service.information = self.objectspace.information(service.xmlfiles)
+                    setattr(service.information, elttype, values)
+            service.path = '.'.join(['services', service.name])
+            manage = self._generate_element('boolean',
+                                            None,
+                                            None,
+                                            'manage',
+                                            service.manage,
+                                            service,
+                                            '.'.join(['services', service.name, 'manage']),
+                                                  )
+            service.variable = [activate_obj, manage]
+            service.doc = service_name
 
     def make_group_from_elts(self,
                              service_name,
@@ -121,14 +153,20 @@ class ServiceAnnotator:
                                       elt.xmlfiles,
                                       )
             family.variable = []
+            if hasattr(elt, 'disabled'):
+                disabled = elt.disabled
+            else:
+                disabled = False
             activate_obj = self._generate_element('boolean',
+                                                  None,
+                                                  None,
                                                   'activate',
-                                                  True,
+                                                  not disabled,
-                                                  elt.xmlfiles,
+                                                  elt,
                                                   '.'.join([subpath, 'activate']),
                                                   )
             for key in dir(elt):
-                if key.startswith('_') or key.endswith('_type') or key in ERASED_ATTRIBUTES:
+                if key.startswith('_') or key.endswith('_type') or key in ERASED_ATTRIBUTES2:
                     continue
                 value = getattr(elt, key)
                 if key == listname:
@@ -137,15 +175,25 @@ class ServiceAnnotator:
                                                                     value,
                                                                     []).append(activate_obj)
                     continue
-                family.variable.append(self._generate_element(self._get_type(key,
+                if key == 'name':
-                                                                             elttype,
+                    dtd_key_type = elttype + '_type'
-                                                                             elt,
+                else:
-                                                                             ),
+                    dtd_key_type = key + '_type'
-                                                              key,
+                elt_type = getattr(elt, dtd_key_type, None)
-                                                              value,
+                if elt_type:
-                                                              elt.xmlfiles,
+                    if elt_type == 'variable':
-                                                              f'{subpath}.{key}'
+                        elt_type = 'symlink'
-                                                              ))
+                    family.variable.append(self._generate_element(elt_type,
+                                                                  dtd_key_type,
+                                                                  elttype,
+                                                                  key,
+                                                                  value,
+                                                                  elt,
+                                                                  f'{subpath}.{key}'
+                                                                  ))
+                else:
+                    setattr(family.information, key, value)
+
             family.variable.append(activate_obj)
             families.append(family)
         return families
@@ -155,7 +203,7 @@ class ServiceAnnotator:
                        path: str,
                        ) -> Tuple[str, str]:
         # create element name, if already exists, add _xx to be uniq
-        if hasattr(elt, 'source'):
+        if hasattr(elt, 'source') and elt.source:
             name = elt.source
         else:
             name = elt.name
@@ -175,7 +223,8 @@ class ServiceAnnotator:
     def _gen_family(self,
                     name,
                     path,
-                    xmlfiles
+                    xmlfiles,
+                    with_informations=True,
                     ):
         family = self.objectspace.family(xmlfiles)
         family.name = normalize_family(name)
@@ -186,22 +235,32 @@ class ServiceAnnotator:
                                           family,
                                           None,
                                           )
+        if with_informations:
+            family.information = self.objectspace.information(xmlfiles)
         return family
 
     def _generate_element(self,
                           type_,
+                          dtd_key_type,
+                          elttype,
                           key,
                           value,
-                          xmlfiles,
+                          elt,
                           path,
                           ):  # pylint: disable=R0913
-        variable = self.objectspace.variable(xmlfiles)
+        variable = self.objectspace.variable(elt.xmlfiles)
         variable.name = normalize_family(key)
         variable.mode = None
         variable.type = type_
         if type_ == 'symlink':
-            variable.opt = self.objectspace.paths.get_variable(value)
+            variable.opt = self.objectspace.paths.get_variable(value, xmlfiles=elt.xmlfiles)
             variable.multi = None
+            needed_type = self.objectspace.types[dtd_key_type]
+            if needed_type not in ('variable', variable.opt.type):
+                msg = _(f'"{value}" in "{elttype}" must be a variable with type '
+                        f'"{needed_type}" not "{variable.opt.type}"')
+                raise DictConsistencyError(msg, 58, elt.xmlfiles)
+
         else:
             variable.doc = key
             variable.default = value
@@ -214,43 +273,48 @@ class ServiceAnnotator:
                                             )
         return variable
 
-    def _get_type(self,
-                  key: str,
-                  elt_name: str,
-                  elt,
-                  ) -> str:
-        if key == 'name':
-            dtd_key_type = elt_name + '_type'
-        else:
-            dtd_key_type = key + '_type'
-        if key in self.objectspace.booleans_attributs:
-            return 'boolean'
-        if hasattr(elt, dtd_key_type):
-            return KEY_TYPE[getattr(elt, dtd_key_type)]
-        return 'string'
-
     def _update_override(self,
-                         file_,
+                         override,
                          service_name,
                          ):
-        file_.name = f'/systemd/system/{service_name}.service.d/rougail.conf'
-        # retrieve default value from File object
-        for attr in ['owner', 'group', 'mode']:
-            setattr(file_, attr, getattr(self.objectspace.file, attr))
-        if not hasattr(file_, 'source'):
-            file_.source = f'{service_name}.service'
-        self._update_file(file_,
-                          service_name,
-                          )
 
-    def _update_file(self,
+        if service_name in self.uniq_overrides:
-                     file_,
+            msg = _('only one override is allowed by service, '
+                    'please use a variable multiple if you want have more than one IP')
+            raise DictConsistencyError(msg, 69, override.xmlfiles)
+        self.uniq_overrides.append(service_name)
+        override.name = service_name
+        if not hasattr(override, 'source'):
+            override.source = service_name
+
+    @staticmethod
+    def _update_file(file_,
                      service_name,
                      ):
-        if not hasattr(file_, 'file_type') or file_.file_type == "UnicodeOption":
+        if not hasattr(file_, 'file_type') or file_.file_type == "filename":
             if not hasattr(file_, 'source'):
                 file_.source = basename(file_.name)
         elif not hasattr(file_, 'source'):
             msg = _(f'attribute "source" is mandatory for the file "{file_.name}" '
                     f'"({service_name})"')
             raise DictConsistencyError(msg, 34, file_.xmlfiles)
+
+    def _update_ip(self,
+                   ip,
+                   service_name,
+                   ) -> None:
+        variable = self.objectspace.paths.get_variable(ip.name, ip.xmlfiles)
+        if variable.type not in ['ip', 'network', 'network_cidr']:
+            msg = _(f'ip cannot be linked to "{variable.type}" variable "{ip.name}"')
+            raise DictConsistencyError(msg, 70, ip.xmlfiles)
+        if variable.type in ['ip', 'network_cidr'] and hasattr(ip, 'netmask'):
+            msg = _(f'ip with ip_type "{variable.type}" must not have netmask')
+            raise DictConsistencyError(msg, 59, ip.xmlfiles)
+        if variable.type == 'network' and not hasattr(ip, 'netmask'):
+            msg = _(f'ip with ip_type "{variable.type}" must have netmask')
+            raise DictConsistencyError(msg, 64, ip.xmlfiles)
+        if hasattr(ip, 'netmask'):
+            netmask = self.objectspace.paths.get_variable(ip.netmask, ip.xmlfiles)
+            if netmask.type != 'netmask':
+                msg = _(f'netmask in ip must have type "netmask", not "{netmask.type}"')
+                raise DictConsistencyError(msg, 65, ip.xmlfiles)

src/rougail/annotator/target.py

@@ -24,11 +24,13 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
-from ..i18n import _
+from rougail.i18n import _
-from ..error import DictConsistencyError
+from rougail.error import DictConsistencyError
 
 
 class TargetAnnotator:
+    """Target annotator
+    """
     def convert_target(self,
                        objects,
                        ) -> None:
@@ -62,19 +64,26 @@ class TargetAnnotator:
                                 f'is not allowed')
                         raise DictConsistencyError(msg, 8, obj.xmlfiles)
                     if target.type == 'family':
+                        if obj.name not in ['disabled_if_in',
+                                            'disabled_if_not_in',
+                                            'hidden_if_in',
+                                            'hidden_if_not_in',
+                                            ]:
+                            msg = _(f'target "{target.type}" not allow with "{obj.name}"')
+                            raise DictConsistencyError(msg, 51, target.xmlfiles)
                         target.name = self.objectspace.paths.get_family(target.name,
                                                                         obj.namespace,
                                                                         )
                     elif target.type.endswith('list') and \
                             obj.name not in ['disabled_if_in', 'disabled_if_not_in']:
-                        msg = _(f'target "{target.type}" not allow')
+                        msg = _(f'target "{target.type}" not allow with "{obj.name}"')
                         raise DictConsistencyError(msg, 10, target.xmlfiles)
                 except DictConsistencyError as err:
                     if err.errno != 42:
                         raise err
                     # for optional variable
                     if not target.optional:
-                        msg = f'cannot found target "{target.name}"'
+                        msg = f'cannot found target "{target.type}" "{target.name}"'
                         raise DictConsistencyError(_(msg), 12, target.xmlfiles) from err
                     remove_targets.append(index)
             remove_targets.sort(reverse=True)

src/rougail/annotator/value.py

@@ -24,36 +24,33 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
-from .variable import Walk
+from rougail.annotator.variable import Walk
 
-class ValueAnnotator(Walk):  # pylint: disable=R0903
+from rougail.i18n import _
+from rougail.error import DictConsistencyError
+
+class Annotator(Walk):  # pylint: disable=R0903
     """Annotate value
     """
+    level = 70
     def __init__(self,
                  objectspace,
+                 *args,
                  ) -> None:
         if not hasattr(objectspace.space, 'variables'):
             return
         self.objectspace = objectspace
         self.convert_value()
+        self.add_choice_nil()
 
     def convert_value(self) -> None:
         """convert value
         """
-        for variable in self.get_variables(with_leadership=True):
+        for variable in self.get_variables():
-            if isinstance(variable, self.objectspace.leadership):
+            self._convert_value(variable)
-                variable_type = 'leader'
-                for follower in variable.variable:
-                    self._convert_value(follower,
-                                        variable_type,
-                                        )
-                    variable_type = 'follower'
-            else:
-                self._convert_value(variable)
 
     def _convert_value(self,
                        variable,
-                       variable_type: str=None,
                        ) -> None:
         # a boolean must have value, the default value is "True"
         if not hasattr(variable, 'value') and variable.type == 'boolean':
@@ -61,9 +58,8 @@ class ValueAnnotator(Walk):  # pylint: disable=R0903
             new_value.name = True
             new_value.type = 'boolean'
             variable.value = [new_value]
-        """if the variable is mandatory and doesn't have any value
+        # if the variable is mandatory and doesn't have any value
-        then the variable's mode is set to 'basic'
+        # then the variable's mode is set to 'basic'
-        """
         # variable with default value is mandatory
         if hasattr(variable, 'value') and variable.value:
             has_value = True
@@ -71,22 +67,39 @@ class ValueAnnotator(Walk):  # pylint: disable=R0903
                 if value.type == 'calculation':
                     has_value = False
                     break
-            if has_value:
+            if has_value and 'mandatory' not in vars(variable):
                 # if has value without any calculation
                 variable.mandatory = True
         if not hasattr(variable, 'value'):
             return
         if variable.value[0].type == 'calculation':
             variable.default = variable.value[0]
+        elif variable.multi:
+            if not self.objectspace.paths.is_follower(variable.path):
+                variable.default = [value.name for value in variable.value]
+            if not self.objectspace.paths.is_leader(variable.path):
+                if variable.multi == 'submulti':
+                    variable.default_multi = [value.name for value in variable.value]
+                else:
+                    variable.default_multi = variable.value[0].name
         else:
-            if variable.multi:
+            if len(variable.value) > 1:
-                if variable_type != 'follower':
+                msg = _(f'the none multi variable "{variable.name}" cannot have '
-                    variable.default = [value.name for value in variable.value]
+                        'more than one value')
-                if variable_type != 'leader':
+                raise DictConsistencyError(msg, 68, variable.xmlfiles)
-                    if variable.multi == 'submulti':
+            variable.default = variable.value[0].name
-                        variable.default_multi = [value.name for value in variable.value]
-                    else:
-                        variable.default_multi = variable.value[0].name
-            else:
-                variable.default = variable.value[0].name
         del variable.value
+
+    def add_choice_nil(self) -> None:
+        for variable in self.get_variables():
+            if variable.type != 'choice':
+                continue
+            is_none = False
+            for choice in variable.choice:
+                if choice.type == 'nil':
+                    is_none = True
+            if not variable.mandatory and not is_none:
+                choice = self.objectspace.choice(variable.xmlfiles)
+                choice.name = None
+                choice.type = 'nil'
+                variable.choice.append(choice)

src/rougail/annotator/variable.py

@@ -25,7 +25,9 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
 
-from ..objspace import convert_boolean
+from rougail.i18n import _
+from rougail.error import DictConsistencyError
+from rougail.objspace import convert_boolean
 
 
 CONVERT_OPTION = {'number': dict(opttype="IntOption", func=int),
@@ -33,6 +35,7 @@ CONVERT_OPTION = {'number': dict(opttype="IntOption", func=int),
                   'choice': dict(opttype="ChoiceOption"),
                   'string': dict(opttype="StrOption"),
                   'password': dict(opttype="PasswordOption"),
+                  'secret': dict(opttype="PasswordOption"),
                   'mail': dict(opttype="EmailOption"),
                   'boolean': dict(opttype="BoolOption", func=convert_boolean),
                   'symlink': dict(opttype="SymLinkOption"),
@@ -47,7 +50,7 @@ CONVERT_OPTION = {'number': dict(opttype="IntOption", func=int),
                   'broadcast': dict(opttype="BroadcastOption"),
                   'netbios': dict(opttype="DomainnameOption", initkwargs={'type': 'netbios',
                                   'warnings_only': True}),
-                  'domain': dict(opttype="DomainnameOption", initkwargs={'type': 'domainname',
+                  'domainname': dict(opttype="DomainnameOption", initkwargs={'type': 'domainname',
                                  'allow_ip': False}),
                   'hostname': dict(opttype="DomainnameOption", initkwargs={'type': 'hostname',
                                    'allow_ip': False}),
@@ -60,35 +63,26 @@ CONVERT_OPTION = {'number': dict(opttype="IntOption", func=int),
                   }
 
 
-FORCE_CHOICE = {'schedule': ['none', 'daily', 'weekly', 'monthly'],
-                'schedulemod': ['pre', 'post'],
-                }
-
-
 class Walk:
     """Walk to objectspace to find variable or family
     """
-    def get_variables(self,
+    objectspace = None
-                      with_leadership: bool=False,
+
-                      ):
+    def get_variables(self):
         """Iter all variables from the objectspace
         """
         for family in self.objectspace.space.variables.values():
-            yield from self._get_variables(family, with_leadership)
+            yield from self._get_variables(family)
 
     def _get_variables(self,
                        family: 'self.objectspace.family',
-                       with_leadership: bool
                        ):
-        if hasattr(family, 'variable'):
+        if not hasattr(family, 'variable'):
-            for variable in family.variable.values():
+            return
-                if isinstance(variable, self.objectspace.family):
+        for variable in family.variable.values():
-                    yield from self._get_variables(variable, with_leadership)
+            if isinstance(variable, self.objectspace.family):
-                    continue
+                yield from self._get_variables(variable)
-                if not with_leadership and isinstance(variable, self.objectspace.leadership):
+            else:
-                    for follower in variable.variable:
-                        yield follower
-                    continue
                 yield variable
 
     def get_families(self):
@@ -101,21 +95,27 @@ class Walk:
                       family: 'self.objectspace.family',
                       ):
         yield family
-        if hasattr(family, 'variable'):
+        if not hasattr(family, 'variable'):
-            for fam in family.variable.values():
+            return
-                if isinstance(fam, self.objectspace.family):
+        for fam in family.variable.values():
-                    yield from self._get_families(fam)
+            if isinstance(fam, self.objectspace.family):
+                yield from self._get_families(fam)
 
 
-class VariableAnnotator(Walk):  # pylint: disable=R0903
+class Annotator(Walk):  # pylint: disable=R0903
     """Annotate variable
     """
+    level = 30
     def __init__(self,
                  objectspace,
+                 *args,
                  ):
         if not hasattr(objectspace.space, 'variables'):
             return
         self.objectspace = objectspace
+        self.forbidden_name = ['services', self.objectspace.rougailconfig['variable_namespace']]
+        for extra in self.objectspace.rougailconfig['extra_dictionaries']:
+            self.forbidden_name.append(extra)
         self.convert_variable()
         self.convert_test()
         self.convert_help()
@@ -123,24 +123,17 @@ class VariableAnnotator(Walk):  # pylint: disable=R0903
     def convert_variable(self):
         """convert variable
         """
-        for variable in self.get_variables(with_leadership=True):
+        for variable in self.get_variables():
-            if isinstance(variable, self.objectspace.leadership):
+            self._convert_variable(variable)
-                # first variable is a leader, others are follower
-                variable_type = 'leader'
-                for follower in variable.variable:
-                    self._convert_variable(follower,
-                                           variable_type,
-                                           )
-                    variable_type = 'follower'
-            else:
-                self._convert_variable(variable,
-                                       'variable',
-                                       )
 
     def _convert_variable(self,
                           variable,
-                          variable_type: str,
                           ) -> None:
+        if variable.namespace == self.objectspace.rougailconfig['variable_namespace'] and \
+                variable.name in self.forbidden_name:
+            msg = _(f'the name of the variable "{variable.name}" cannot be the same as the name'
+                    ' of a namespace')
+            raise DictConsistencyError(msg, 54, variable.xmlfiles)
         if variable.type != 'symlink' and not hasattr(variable, 'description'):
             variable.description = variable.name
         if hasattr(variable, 'value'):
@@ -157,74 +150,77 @@ class VariableAnnotator(Walk):  # pylint: disable=R0903
                 del variable.value[idx]
             if not variable.value:
                 del variable.value
+        if hasattr(variable, 'choice'):
+            if variable.type != 'choice':
+                msg = _(f'choice for the variable "{variable.name}" not allowed with "{variable.type}" type')
+                raise DictConsistencyError(msg, 3, variable.xmlfiles)
+            values = []
+            choice_type = None
+            for choice in variable.choice:
+                if choice_type == 'variable':
+                    msg = _(f'only one "variable" choice is allowed '
+                            f'the variable "{variable.name}"')
+                    raise DictConsistencyError(msg, 5, choice.xmlfiles)
+                if choice.type == 'nil':
+                    choice.name = None
+                elif choice.type == 'space':
+                    choice.name = ' '
+                elif choice.type == 'variable':
+                    choice.name = self.objectspace.paths.get_variable(choice.name)
+                    if not choice.name.multi:
+                        msg = _(f'only multi "variable" is allowed for a choice '
+                                f'of variable "{variable.name}"')
+                        raise DictConsistencyError(msg, 6, choice.xmlfiles)
+                else:
+                    if not hasattr(choice, 'name'):
+                        msg = _(f'choice for variable "{variable.name}" must have a value')
+                        raise DictConsistencyError(msg, 14, choice.xmlfiles)
+                    choice.name = CONVERT_OPTION.get(choice.type, {}).get('func', str)(choice.name)
+                if choice_type is None:
+                    choice_type = choice.type
+                values.append(choice.name)
+            if choice_type not in ['function', 'variable'] and hasattr(variable, 'value'):
+                for value in variable.value:
+                    if value.name not in values:
+                        msg = _(f'value "{value.name}" of variable "{variable.name}" is not in list '
+                                f'of all expected values ({values})')
+                        raise DictConsistencyError(msg, 15, value.xmlfiles)
+            ref_choice = variable.choice[0]
+            self.objectspace.valid_enums[variable.path] = {'type': ref_choice.type,
+                                                           'values': values,
+                                                           'xmlfiles': ref_choice.xmlfiles,
+                                                           }
+        elif variable.type == 'choice':
+            msg = _(f'choice is mandatory for the variable "{variable.name}" with choice type')
+            raise DictConsistencyError(msg, 4, variable.xmlfiles)
         variable.doc = variable.description
         del variable.description
-        if variable_type == 'follower':
-            if variable.multi is True:
-                variable.multi = 'submulti'
-            else:
-                variable.multi = True
-        self._convert_valid_enum(variable)
-
-    def _convert_valid_enum(self,
-                            variable,
-                            ):
-        """some types are, in fact, choices
-        convert this kind of variables into choice
-        """
-        if variable.type in FORCE_CHOICE:
-            if not hasattr(self.objectspace.space, 'constraints'):
-                xmlfiles = variable.xmlfiles
-                self.objectspace.space.constraints = self.objectspace.constraints(xmlfiles)
-                self.objectspace.space.constraints.namespace = variable.namespace
-            if not hasattr(self.objectspace.space.constraints, 'check'):
-                self.objectspace.space.constraints.check = []
-            check = self.objectspace.check(variable.xmlfiles)
-            check.name = 'valid_enum'
-            target = self.objectspace.target(variable.xmlfiles)
-            target.name = variable.path
-            check.target = [target]
-            check.namespace = variable.namespace
-            check.param = []
-            for value in FORCE_CHOICE[variable.type]:
-                param = self.objectspace.param(variable.xmlfiles)
-                param.text = value
-                check.param.append(param)
-            self.objectspace.space.constraints.check.append(check)
-            variable.type = 'string'
 
     def convert_test(self):
         """Convert variable tests value
         """
         for variable in self.get_variables():
-            self._convert_test(variable)
+            if not hasattr(variable, 'test') or not variable.test:
-
+                # with we want remove test, we set "" has test value
-    def _convert_test(self,
+                continue
-                      variable,
+            new_values = []
-                      ) -> None:
+            for value in variable.test.split('|'):
-        if not hasattr(variable, 'information'):
+                if value == '':
-            variable.information = self.objectspace.information(variable.xmlfiles)
+                    value = None
-        if hasattr(variable, 'test'):
+                else:
-            if variable.test:
+                    value = CONVERT_OPTION.get(variable.type, {}).get('func', str)(value)
-                values = variable.test.split('|')
+                new_values.append(value)
-                new_values = []
+            if not hasattr(variable, 'information'):
-                for value in values:
+                variable.information = self.objectspace.information(variable.xmlfiles)
-                    if value == '':
+            variable.information.test = tuple(new_values)
-                        value = None
-                    else:
-                        value = CONVERT_OPTION.get(variable.type, {}).get('func', str)(value)
-                    new_values.append(value)
-                variable.information.test = tuple(new_values)
-            del variable.test
 
     def convert_help(self):
         """Convert variable help
         """
         for variable in self.get_variables():
-            self._convert_help(variable)
+            if not hasattr(variable, 'help'):
-
+                continue
-    @staticmethod
+            if not hasattr(variable, 'information'):
-    def _convert_help(variable) -> None:
+                variable.information = self.objectspace.information(variable.xmlfiles)
-        if hasattr(variable, 'help'):
             variable.information.help = variable.help
             del variable.help

src/rougail/config.py

@@ -40,6 +40,19 @@ RougailConfig = {'dictionaries_dir': [join(ROUGAILROOT, 'dictionaries')],
                  'tmp_dir': join(ROUGAILROOT, 'tmp'),
                  'dtdfilename': join(DTDDIR, 'rougail.dtd'),
                  'functions_file': join(ROUGAILROOT, 'functions.py'),
+                 'tmpfile_dest_dir': '/usr/local/lib',
                  'variable_namespace': 'rougail',
-                 'auto_freeze_variable': 'instanciated_module',
+                 'auto_freeze_variable': 'server_deployed',
+                 'internal_functions': [],
+                 'multi_functions': [],
+                 'extra_annotators': [],
+                 'modes_level': ['basic', 'normal', 'expert'],
+                 'default_family_mode': 'basic',
+                 'default_variable_mode': 'normal',
+                 'default_files_engine': 'creole',
+                 'default_files_mode': '0644',
+                 'default_files_owner': 'root',
+                 'default_files_group': 'root',
+                 'default_files_included': 'no',
+                 'default_overrides_engine': 'creole',
                  }

src/rougail/convert.py

@@ -27,12 +27,9 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 Sample usage::
 
-    >>> from rougail import Rougail
+    >>> from rougail import RougailConvert
-    >>> rougail = Rougail()
+    >>> rougail = RougailConvert()
-    >>> rougail.load_dictionaries(['/usr/share/rougail/dicos'])
+    >>> tiramisu = rougail.save('tiramisu.py')
-    >>> rougail.load_extra_dictionaries('extra1', ['/usr/share/rougail/extra1'])
-    >>> rougail.space_visitor('/usr/share/rougail/funcs.py')
-    >>> tiramisu = rougail.save()
 
 The Rougail
 
@@ -58,16 +55,22 @@ from .error import DictConsistencyError
 class RougailConvert:
     """Rougail object
     """
-    def __init__(self) -> None:
+    def __init__(self,
-        xmlreflector = XMLReflector()
+                 rougailconfig: RougailConfig=None,
-        rougailobjspace = RougailObjSpace(xmlreflector)
+                 ) -> None:
+        if rougailconfig is None:
+            rougailconfig = RougailConfig
+        xmlreflector = XMLReflector(rougailconfig)
+        rougailobjspace = RougailObjSpace(xmlreflector,
+                                          rougailconfig,
+                                          )
         self._load_dictionaries(xmlreflector,
                                 rougailobjspace,
-                                RougailConfig['variable_namespace'],
+                                rougailconfig['variable_namespace'],
-                                RougailConfig['dictionaries_dir'],
+                                rougailconfig['dictionaries_dir'],
                                 )
-        for namespace, extra_dir in RougailConfig['extra_dictionaries'].items():
+        for namespace, extra_dir in rougailconfig['extra_dictionaries'].items():
-            if namespace in ['services', RougailConfig['variable_namespace']]:
+            if namespace in ['services', rougailconfig['variable_namespace']]:
                 msg = _(f'Namespace name "{namespace}" is not allowed')
                 raise DictConsistencyError(msg, 21, None)
             self._load_dictionaries(xmlreflector,
@@ -75,16 +78,19 @@ class RougailConvert:
                                     namespace,
                                     extra_dir,
                                     )
-        functions_file = RougailConfig['functions_file']
+        functions_file = rougailconfig['functions_file']
+        if not isinstance(functions_file, list):
+            functions_file = [functions_file]
         SpaceAnnotator(rougailobjspace,
                        functions_file,
                        )
         self.output = TiramisuReflector(rougailobjspace,
                                         functions_file,
+                                        rougailconfig['internal_functions'],
                                         ).get_text() + '\n'
 
-    def _load_dictionaries(self,
+    @staticmethod
-                           xmlreflector: XMLReflector,
+    def _load_dictionaries(xmlreflector: XMLReflector,
                            rougailobjspace: RougailObjSpace,
                            namespace: str,
                            xmlfolders: List[str],

src/rougail/data/rougail.dtd

@@ -37,7 +37,8 @@
 <!-- root element    -->
 <!-- =============== -->
 
-<!ELEMENT rougail (services|variables|constraints|help)*>
+<!ELEMENT rougail (services|variables|constraints)*>
+<!ATTLIST rougail version (0.10) #REQUIRED>
 
 <!-- ============== -->
 <!-- files element  -->
@@ -45,38 +46,41 @@
 
 <!ELEMENT services (service*)>
 
-<!ELEMENT service ((port*|ip*|file*|override*)*)>
+<!ELEMENT service ((ip*|file*|override*)*)>
 <!ATTLIST service name CDATA #REQUIRED>
-
+<!ATTLIST service manage (True|False) "True">
-<!ELEMENT port (#PCDATA)>
+<!ATTLIST service servicelist CDATA #IMPLIED>
-<!ATTLIST port port_type (PortOption|variable) "PortOption">
+<!ATTLIST service disabled (True|False) "False">
-<!ATTLIST port portlist CDATA #IMPLIED>
+<!ATTLIST service engine (none|creole|jinja2) #IMPLIED>
-<!ATTLIST port protocol (tcp|udp) "tcp">
+<!ATTLIST service target CDATA #IMPLIED>
+<!ATTLIST service type (service|mount|swap|timer) "service">
+<!ATTLIST service undisable (True|False) "False">
 
 <!ELEMENT ip (#PCDATA)>
 <!ATTLIST ip iplist CDATA #IMPLIED>
-<!ATTLIST ip ip_type (NetworkOption|variable) "NetworkOption">
+<!ATTLIST ip ip_type (variable) "variable">
-<!ATTLIST ip interface_type (UnicodeOption|variable) "UnicodeOption">
+<!ATTLIST ip netmask_type (variable) "variable">
-<!ATTLIST ip interface CDATA #REQUIRED>
+<!ATTLIST ip netmask CDATA #IMPLIED>
-<!ATTLIST ip netmask_type (NetmaskOption|variable) "NetmaskOption">
-<!ATTLIST ip netmask CDATA "255.255.255.255">
 
-<!ELEMENT file EMPTY>
+<!ELEMENT file (#PCDATA)>
-<!ATTLIST file name CDATA #REQUIRED>
+<!ATTLIST file file_type (filename|variable) "filename">
-<!ATTLIST file file_type (UnicodeOption|variable) "UnicodeOption">
 <!ATTLIST file variable CDATA #IMPLIED>
 <!ATTLIST file variable_type (variable) "variable">
 <!ATTLIST file source CDATA #IMPLIED>
-<!ATTLIST file mode CDATA "0644">
+<!ATTLIST file mode CDATA #IMPLIED>
-<!ATTLIST file owner CDATA "root">
+<!ATTLIST file owner CDATA #IMPLIED>
-<!ATTLIST file group CDATA "root">
+<!ATTLIST file owner_type (unix_user|variable) "unix_user">
+<!ATTLIST file group CDATA #IMPLIED>
+<!ATTLIST file group_type (unix_user|variable) "unix_user">
 <!ATTLIST file filelist CDATA #IMPLIED>
 <!ATTLIST file redefine (True|False) "False">
-<!ATTLIST file templating (creole|none) "creole">
+<!ATTLIST file engine (none|creole|jinja2|creole_legacy) #IMPLIED>
+<!ATTLIST file included (no|name|content) #IMPLIED>
+<!ATTLIST file disabled (True|False) "False">
 
 <!ELEMENT override EMPTY>
 <!ATTLIST override source CDATA #IMPLIED>
-<!ATTLIST override templating (creole|none) "creole">
+<!ATTLIST override engine (none|creole|jinja2) #IMPLIED>
 
 <!ELEMENT variables ((variable*|family*)*)>
 
@@ -84,13 +88,14 @@
 <!ATTLIST family name CDATA #REQUIRED>
 <!ATTLIST family description CDATA #IMPLIED>
 <!ATTLIST family help CDATA #IMPLIED>
-<!ATTLIST family mode (basic|normal|expert) "basic">
+<!ATTLIST family mode CDATA #IMPLIED>
 <!ATTLIST family hidden (True|False) "False">
 <!ATTLIST family dynamic CDATA #IMPLIED>
+<!ATTLIST family leadership (True|False) "False">
 
-<!ELEMENT variable (value*)>
+<!ELEMENT variable ((choice*|value*)*)>
 <!ATTLIST variable name CDATA #REQUIRED>
-<!ATTLIST variable type (number|float|string|password|mail|boolean|filename|date|unix_user|ip|local_ip|netmask|network|broadcast|netbios|domain|hostname|web_address|port|mac|cidr|network_cidr|schedule|schedulemod) "string">
+<!ATTLIST variable type (number|float|string|password|secret|mail|boolean|filename|date|unix_user|ip|local_ip|netmask|network|broadcast|netbios|domainname|hostname|web_address|port|mac|cidr|network_cidr|choice) "string">
 <!ATTLIST variable description CDATA #IMPLIED>
 <!ATTLIST variable help CDATA #IMPLIED>
 <!ATTLIST variable hidden (True|False) "False">
@@ -101,15 +106,22 @@
 <!ATTLIST variable mandatory (True|False) "False">
 <!ATTLIST variable auto_freeze (True|False) "False">
 <!ATTLIST variable auto_save (True|False) "False">
-<!ATTLIST variable mode (basic|normal|expert) "normal">
+<!ATTLIST variable mode CDATA #IMPLIED>
+<!ATTLIST variable remove_choice (True|False) "False">
 <!ATTLIST variable remove_check (True|False) "False">
 <!ATTLIST variable remove_condition (True|False) "False">
 <!ATTLIST variable remove_fill (True|False) "False">
+<!ATTLIST variable provider CDATA #IMPLIED>
 <!ATTLIST variable test CDATA #IMPLIED>
 
 <!ELEMENT value (#PCDATA)>
+<!ATTLIST value type (string|number|nil|space|boolean) #IMPLIED>
 
-<!ELEMENT constraints ((fill*|check*|condition*|group*)*)>
+<!ELEMENT choice (#PCDATA | param)*>
+<!ATTLIST choice type (string|number|nil|space|boolean|function|variable) "string">
+<!ATTLIST choice name CDATA #IMPLIED>
+
+<!ELEMENT constraints ((fill*|check*|condition*)*)>
 
 <!ELEMENT fill ((target|param)+)>
 <!ATTLIST fill name CDATA #REQUIRED>
@@ -121,23 +133,15 @@
 <!ELEMENT condition ((target|param)+)>
 <!ATTLIST condition name (disabled_if_in|disabled_if_not_in|hidden_if_in|hidden_if_not_in|mandatory_if_in|mandatory_if_not_in) #REQUIRED>
 <!ATTLIST condition source CDATA #REQUIRED>
-<!ATTLIST condition fallback (True|False) "False">
+<!ATTLIST condition optional (True|False) "False">
-<!ATTLIST condition force_condition_on_fallback (True|False) "False">
+<!ATTLIST condition apply_on_fallback (True|False) #IMPLIED>
-<!ATTLIST condition force_inverse_condition_on_fallback (True|False) "False">
 
 <!ELEMENT param (#PCDATA)>
-<!ATTLIST param type (string|number|nil|boolean|variable|information|suffix) "string">
+<!ATTLIST param type (string|number|nil|space|boolean|variable|function|information|target_information|suffix|index) "string">
 <!ATTLIST param name CDATA #IMPLIED>
 <!ATTLIST param propertyerror (True|False) "True">
 <!ATTLIST param optional (True|False) "False">
 
 <!ELEMENT target (#PCDATA)>
-<!ATTLIST target type (family|variable|filelist|iplist|portlist) "variable">
+<!ATTLIST target type (variable|family|servicelist|filelist|iplist) "variable">
 <!ATTLIST target optional (True|False) "False">
-
-<!ELEMENT group (follower+)>
-<!ATTLIST group leader CDATA #REQUIRED>
-<!ATTLIST group name CDATA #IMPLIED>
-<!ATTLIST group description CDATA #IMPLIED>
-
-<!ELEMENT follower (#PCDATA)>

src/rougail/error.py

@@ -70,3 +70,8 @@ class DictConsistencyError(Exception):
             msg = _(f'{msg} in {display_xmlfiles(xmlfiles)}')
         super().__init__(msg)
         self.errno = errno
+
+
+class UpgradeError(Exception):
+    """Error during XML upgrade
+    """

src/rougail/objspace.py

@@ -29,19 +29,18 @@ from typing import Optional
 
 from .i18n import _
 from .xmlreflector import XMLReflector
-from .utils import normalize_family
+from .utils import valid_variable_family_name
 from .error import SpaceObjShallNotBeUpdated, DictConsistencyError
 from .path import Path
-from .config import RougailConfig
 
 # RougailObjSpace's elements that shall be forced to the Redefinable type
 FORCE_REDEFINABLES = ('family', 'follower', 'service', 'disknod', 'variables')
 # RougailObjSpace's elements that shall be forced to the UnRedefinable type
 FORCE_UNREDEFINABLES = ('value',)
 # RougailObjSpace's elements that shall not be modify
-UNREDEFINABLE = ('multi', 'type')
+UNREDEFINABLE = ('multi', 'type',)
 # RougailObjSpace's elements that did not created automaticly
-FORCE_ELEMENTS = ('choice', 'property_', 'leadership', 'information')
+FORCE_ELEMENTS = ('property_', 'information')
 # XML text are convert has name
 FORCED_TEXT_ELTS_AS_NAME = ('choice', 'property', 'value',)
 
@@ -101,17 +100,20 @@ class RougailObjSpace:
 
     def __init__(self,
                  xmlreflector: XMLReflector,
+                 rougailconfig: 'RougailConfig',
                  ) -> None:
         self.space = ObjSpace()
-        self.paths = Path()
+        self.paths = Path(rougailconfig)
 
         self.forced_text_elts_as_name = set(FORCED_TEXT_ELTS_AS_NAME)
         self.list_conditions = {}
         self.valid_enums = {}
         self.booleans_attributs = []
         self.has_dyn_option = False
+        self.types = {}
 
         self.make_object_space_classes(xmlreflector)
+        self.rougailconfig = rougailconfig
 
     def make_object_space_classes(self,
                                   xmlreflector: XMLReflector,
@@ -140,6 +142,8 @@ class RougailObjSpace:
                     if dtd_attr.name in self.booleans_attributs:
                         default_value = convert_boolean(default_value)
                     attrs[dtd_attr.name] = default_value
+                    if dtd_attr.name.endswith('_type'):
+                        self.types[dtd_attr.name] = default_value
                 if dtd_attr.name == 'redefine':
                     # has a redefine attribute, so it's a Redefinable object
                     clstype = Redefinable
@@ -175,6 +179,7 @@ class RougailObjSpace:
                         self.space,
                         namespace,
                         redefine_variables,
+                        False,
                         )
 
     def _xml_parse(self,  # pylint: disable=R0913
@@ -183,26 +188,31 @@ class RougailObjSpace:
                    space,
                    namespace,
                    redefine_variables,
+                   is_dynamic,
                    ) -> None:
         # var to check unique family name in a XML file
         family_names = []
         for child in document:
+            if is_dynamic:
+                is_sub_dynamic = True
+            else:
+                is_sub_dynamic = document.attrib.get('dynamic') is not None
             if not isinstance(child.tag, str):
                 # doesn't proceed the XML commentaries
                 continue
             if child.tag == 'family':
                 if child.attrib['name'] in family_names:
                     msg = _(f'Family "{child.attrib["name"]}" is set several times')
-                    raise DictConsistencyError(msg, 44, xmlfile)
+                    raise DictConsistencyError(msg, 44, [xmlfile])
                 family_names.append(child.attrib['name'])
             try:
                 # variable objects creation
-                variableobj = self.get_variableobj(xmlfile,
+                exists, variableobj = self.get_variableobj(xmlfile,
-                                                   child,
+                                                           child,
-                                                   space,
+                                                           space,
-                                                   namespace,
+                                                           namespace,
-                                                   redefine_variables,
+                                                           redefine_variables,
-                                                   )
+                                                           )
             except SpaceObjShallNotBeUpdated:
                 continue
             self.set_text(child,
@@ -216,11 +226,13 @@ class RougailObjSpace:
                         variableobj,
                         redefine_variables,
                         )
-            self.set_path(namespace,
+            if not exists:
-                          document,
+                self.set_path(namespace,
-                          variableobj,
+                              document,
-                          space,
+                              variableobj,
-                          )
+                              space,
+                              is_sub_dynamic,
+                              )
             self.add_to_tree_structure(variableobj,
                                        space,
                                        child,
@@ -232,6 +244,7 @@ class RougailObjSpace:
                                 variableobj,
                                 namespace,
                                 redefine_variables,
+                                is_sub_dynamic,
                                 )
 
     def get_variableobj(self,
@@ -260,11 +273,12 @@ class RougailObjSpace:
             if child.tag in vars(space):
                 # Atom instance has to be a singleton here
                 # we do not re-create it, we reuse it
-                return getattr(space, child.tag)
+                return False, getattr(space, child.tag)
-            return obj(xmlfile, name)
+            return False, obj(xmlfile, name)
+        # UnRedefinable object
         if child.tag not in vars(space):
             setattr(space, child.tag, [])
-        return obj(xmlfile, name)
+        return False, obj(xmlfile, name)
 
     def _get_name(self,
                   child,
@@ -272,6 +286,8 @@ class RougailObjSpace:
                   ) -> Optional[str]:
         if child.tag == 'variables':
             return namespace
+        if child.tag == 'service':
+            return child.attrib['name'] + '.' + child.attrib.get('type', 'service')
         if 'name' in child.attrib:
             return child.attrib['name']
         if child.text and child.tag in self.forced_text_elts_as_name:
@@ -290,6 +306,7 @@ class RougailObjSpace:
         """A redefinable object could be created or updated
         """
         existed_var = self.get_existed_obj(name,
+                                           xmlfile,
                                            space,
                                            child,
                                            namespace,
@@ -301,12 +318,12 @@ class RougailObjSpace:
             redefine = convert_boolean(subspace.get('redefine', default_redefine))
             if redefine is True:
                 if isinstance(existed_var, self.variable):  # pylint: disable=E1101
-                    if namespace == RougailConfig['variable_namespace']:
+                    if namespace == self.rougailconfig['variable_namespace']:
                         redefine_variables.append(name)
                     else:
                         redefine_variables.append(space.path + '.' + name)
                 existed_var.xmlfiles.append(xmlfile)
-                return existed_var
+                return True, existed_var
             exists = convert_boolean(subspace.get('exists', True))
             if exists is False:
                 raise SpaceObjShallNotBeUpdated()
@@ -322,15 +339,16 @@ class RougailObjSpace:
         if redefine is True:
             # cannot redefine an inexistant object
             msg = _(f'Redefined object: "{name}" does not exist yet')
-            raise DictConsistencyError(msg, 46, xmlfile)
+            raise DictConsistencyError(msg, 46, [xmlfile])
         tag = FORCE_TAG.get(child.tag, child.tag)
         if tag not in vars(space):
             setattr(space, tag, {})
         obj = getattr(self, child.tag)(xmlfile, name)
-        return obj
+        return False, obj
 
     def get_existed_obj(self,
                         name: str,
+                        xmlfile: str,
                         space: str,
                         child,
                         namespace: str,
@@ -338,22 +356,22 @@ class RougailObjSpace:
         """if an object exists, return it
         """
         if child.tag in ['variable', 'family']:
-            name = normalize_family(name)
+            valid_variable_family_name(name, [xmlfile])
         if child.tag == 'variable':  # pylint: disable=E1101
-            if namespace != RougailConfig['variable_namespace']:
+            if namespace != self.rougailconfig['variable_namespace']:
                 name = space.path + '.' + name
             if not self.paths.path_is_defined(name):
                 return None
             old_family_name = self.paths.get_variable_family_path(name)
             if space.path != old_family_name:
-                msg = _(f'Variable was previously create in family "{old_family_name}", '
+                msg = _(f'Variable "{name}" was previously create in family "{old_family_name}", '
                         f'now it is in "{space.path}"')
                 raise DictConsistencyError(msg, 47, space.xmlfiles)
             return self.paths.get_variable(name)
         # it's not a family
         tag = FORCE_TAG.get(child.tag, child.tag)
         children = getattr(space, tag, {})
-        if name in children:
+        if name in children and isinstance(children[name], getattr(self, child.tag)):
             return children[name]
         return None
 
@@ -385,7 +403,7 @@ class RougailObjSpace:
         for attr, val in child.attrib.items():
             if redefine and attr in UNREDEFINABLE:
                 msg = _(f'cannot redefine attribute "{attr}" for variable "{child.attrib["name"]}"'
-                        f' in "{xmlfile}", already defined')
+                        f' already defined')
                 raise DictConsistencyError(msg, 48, variableobj.xmlfiles[:-1])
             if attr in self.booleans_attributs:
                 val = convert_boolean(val)
@@ -402,6 +420,12 @@ class RougailObjSpace:
         """Rougail object tree manipulations
         """
         if child.tag == 'variable':
+            if child.attrib.get('remove_choice', False):
+                if variableobj.type != 'choice':
+                    msg = _(f'cannot remove choices for variable "{variableobj.path}"'
+                            f' the variable has type "{variableobj.type}"')
+                    raise DictConsistencyError(msg, 33, variableobj.xmlfiles)
+                variableobj.choice = []
             if child.attrib.get('remove_check', False):
                 self.remove_check(variableobj.name)
             if child.attrib.get('remove_condition', False):
@@ -416,14 +440,15 @@ class RougailObjSpace:
     def remove_check(self, name):
         """Remove a check with a specified target
         """
-        remove_checks = []
+        if hasattr(self.space.constraints, 'check'):
-        for idx, check in enumerate(self.space.constraints.check):  # pylint: disable=E1101
+            remove_checks = []
-            for target in check.target:
+            for idx, check in enumerate(self.space.constraints.check):  # pylint: disable=E1101
-                if target.name == name:
+                for target in check.target:
-                    remove_checks.append(idx)
+                    if target.name == name:
-        remove_checks.sort(reverse=True)
+                        remove_checks.append(idx)
-        for idx in remove_checks:
+            remove_checks.sort(reverse=True)
-            self.space.constraints.check.pop(idx)  # pylint: disable=E1101
+            for idx in remove_checks:
+                self.space.constraints.check.pop(idx)  # pylint: disable=E1101
 
     def remove_condition(self,
                          name: str,
@@ -457,25 +482,31 @@ class RougailObjSpace:
                  document,
                  variableobj,
                  space,
+                 is_dynamic,
                  ):
         """Fill self.paths attributes
         """
         if isinstance(variableobj, self.variable):  # pylint: disable=E1101
             if 'name' in document.attrib:
-                family_name = normalize_family(document.attrib['name'])
+                family_name = document.attrib['name']
             else:
                 family_name = namespace
 
+            if isinstance(space, self.family) and space.leadership:
+                leader = space.path
+            else:
+                leader = None
             self.paths.add_variable(namespace,
-                                    normalize_family(variableobj.name),
+                                    variableobj.name,
                                     space.path,
-                                    document.attrib.get('dynamic') is not None,
+                                    is_dynamic,
                                     variableobj,
+                                    leader,
                                     )
         elif isinstance(variableobj, self.family):  # pylint: disable=E1101
-            family_name = normalize_family(variableobj.name)
+            family_name = variableobj.name
-            if namespace != RougailConfig['variable_namespace']:
+            if namespace != self.rougailconfig['variable_namespace']:
-                family_name = namespace + '.' + family_name
+                family_name = space.path + '.' + family_name
             self.paths.add_family(namespace,
                                   family_name,
                                   variableobj,
@@ -496,8 +527,6 @@ class RougailObjSpace:
         if isinstance(variableobj, Redefinable):
             name = variableobj.name
             tag = FORCE_TAG.get(child.tag, child.tag)
-            if child.tag in ['family', 'variable']:
-                name = normalize_family(name)
             getattr(space, tag)[name] = variableobj
         elif isinstance(variableobj, UnRedefinable):
             getattr(space, child.tag).append(variableobj)

src/rougail/path.py

@@ -24,23 +24,25 @@ You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
+from typing import List
 from .i18n import _
 from .error import DictConsistencyError
-from .config import RougailConfig
 from .utils import normalize_family
 
 
 class Path:
-    """Helper class to handle the `path` attribute of a CreoleObjSpace
+    """Helper class to handle the `path` attribute.
-    instance.
 
     sample: path="creole.general.condition"
     """
-    def __init__(self):
+    def __init__(self,
+                 rougailconfig: 'RougailConfig',
+                 ) -> None:
         self.variables = {}
         self.families = {}
         self.full_paths_families = {}
         self.full_paths_variables = {}
+        self.variable_namespace = rougailconfig['variable_namespace']
 
     # Family
     def add_family(self,
@@ -51,8 +53,11 @@ class Path:
                    ) -> str:  # pylint: disable=C0111
         """Add a new family
         """
-        if namespace == RougailConfig['variable_namespace']:
+        if namespace == self.variable_namespace:
             full_name = '.'.join([subpath, name])
+            if name in self.full_paths_families:
+                msg = _(f'Duplicate family name "{name}"')
+                raise DictConsistencyError(msg, 55, variableobj.xmlfiles)
             self.full_paths_families[name] = full_name
         else:
             if '.' not in name:  # pragma: no cover
@@ -61,26 +66,17 @@ class Path:
             full_name = name
         if full_name in self.families and \
                 self.families[full_name]['variableobj'] != variableobj:  # pragma: no cover
-            raise DictConsistencyError(_(f'Duplicate family name "{name}"'), 37, variableobj.xmlfiles)
+            msg = _(f'Duplicate family name "{name}"')
+            raise DictConsistencyError(msg, 37, variableobj.xmlfiles)
+        if full_name in self.variables:
+            msg = _(f'A variable and a family has the same path "{full_name}"')
+            raise DictConsistencyError(msg, 56, variableobj.xmlfiles)
         self.families[full_name] = dict(name=name,
                                         namespace=namespace,
                                         variableobj=variableobj,
                                         )
         variableobj.path = full_name
 
-    def add_leadership(self,
-                       namespace: str,
-                       path: str,
-                       variableobj: str,
-                       ) -> str:  # pylint: disable=C0111
-        """add a new leadership
-        """
-        self.families[path] = dict(name=path,
-                                   namespace=namespace,
-                                   variableobj=variableobj,
-                                   )
-        variableobj.path = path
-
     def get_family(self,
                    name: str,
                    current_namespace: str,
@@ -93,33 +89,13 @@ class Path:
         if name not in self.families:
             raise DictConsistencyError(_(f'unknown option {name}'), 42, [])
         dico = self.families[name]
-        if current_namespace not in [RougailConfig['variable_namespace'], 'services'] and \
+        if current_namespace not in [self.variable_namespace, 'services'] and \
                 current_namespace != dico['namespace']:
             msg = _(f'A family located in the "{dico["namespace"]}" namespace '
                     f'shall not be used in the "{current_namespace}" namespace')
             raise DictConsistencyError(msg, 38, [])
         return dico['variableobj']
 
-    # Leadership
-    def set_leader(self,
-                   namespace: str,
-                   leader_family_name: str,
-                   leadership_name: str,
-                   name: str,
-                   ) -> None:  # pylint: disable=C0111
-        """set a variable a leadership member
-        """
-        # need rebuild path and move object in new path
-        old_path = leader_family_name + '.' + name
-        leadership_path = leader_family_name + '.' + leadership_name
-        new_path = leadership_path + '.' + name
-        self.variables[new_path] = self.variables.pop(old_path)
-        self.variables[new_path]['leader'] = leadership_path
-        self.variables[new_path]['variableobj'].path = new_path
-        self.variables[new_path]['family'] = leadership_path
-        if namespace == RougailConfig['variable_namespace']:
-            self.full_paths_variables[name] = new_path
-
     def is_leader(self, path):  # pylint: disable=C0111
         """Is the variable is a leader
         """
@@ -127,7 +103,16 @@ class Path:
         if not variable['leader']:
             return False
         leadership = self.get_family(variable['leader'], variable['variableobj'].namespace)
-        return leadership.variable[0].path == path
+        return next(iter(leadership.variable.values())).path == path
+
+    def is_follower(self, path):
+        """Is the variable is a follower
+        """
+        variable = self._get_variable(path)
+        if not variable['leader']:
+            return False
+        leadership = self.get_family(variable['leader'], variable['variableobj'].namespace)
+        return next(iter(leadership.variable.values())).path != path
 
     # Variable
     def add_variable(self,  # pylint: disable=R0913
@@ -136,55 +121,66 @@ class Path:
                      family: str,
                      is_dynamic: bool,
                      variableobj,
+                     leader: 'self.objectspace.family'=None,
                      ) -> str:  # pylint: disable=C0111
         """Add a new variable (with path)
         """
+        if name == 'hostname_' and not is_dynamic:
+            raise Exception('pffff')
         if '.' not in name:
             full_path = '.'.join([family, name])
-            if namespace == RougailConfig['variable_namespace']:
+            if namespace == self.variable_namespace:
                 self.full_paths_variables[name] = full_path
         else:
             full_path = name
         variableobj.path = full_path
+        if full_path in self.families:
+            msg = _(f'A family and a variable has the same path "{full_path}"')
+            raise DictConsistencyError(msg, 57, variableobj.xmlfiles)
         self.variables[full_path] = dict(name=name,
                                          family=family,
-                                         leader=None,
+                                         leader=leader,
                                          is_dynamic=is_dynamic,
                                          variableobj=variableobj,
                                          )
 
     def get_variable(self,
                      name: str,
+                     xmlfiles: List[str]=[],
                      ) -> 'Variable':  # pylint: disable=C0111
         """Get variable object from a path
         """
-        variable, suffix = self._get_variable(name, with_suffix=True)
+        variable, suffix = self._get_variable(name, with_suffix=True, xmlfiles=xmlfiles)
         if suffix:
             raise DictConsistencyError(_(f"{name} is a dynamic variable"), 36, [])
         return variable['variableobj']
 
     def get_variable_family_path(self,
                                  name: str,
+                                 xmlfiles: List[str]=False,
                                  ) -> str:  # pylint: disable=C0111
         """Get the full path of a family
         """
-        return self._get_variable(name)['family']
+        return self._get_variable(name, xmlfiles=xmlfiles)['family']
 
     def get_variable_path(self,
                           name: str,
                           current_namespace: str,
+                          xmlfiles: List[str]=[],
                           ) -> str:  # pylint: disable=C0111
         """get full path of a variable
         """
         dico, suffix = self._get_variable(name,
                                           with_suffix=True,
+                                          xmlfiles=xmlfiles,
                                           )
         namespace = dico['variableobj'].namespace
-        if namespace not in [RougailConfig['variable_namespace'], 'services'] and \
+        if namespace not in [self.variable_namespace, 'services'] and \
+                current_namespace != 'services' and \
                 current_namespace != namespace:
             msg = _(f'A variable located in the "{namespace}" namespace shall not be used '
                     f'in the "{current_namespace}" namespace')
-            raise DictConsistencyError(msg, 41, [])
+            raise DictConsistencyError(msg, 41, xmlfiles)
         return dico['variableobj'].path, suffix
 
     def path_is_defined(self,
@@ -206,6 +202,7 @@ class Path:
     def _get_variable(self,
                       name: str,
                       with_suffix: bool=False,
+                      xmlfiles: List[str]=[],
                       ) -> str:
         name = '.'.join([normalize_family(subname) for subname in name.split('.')])
         if name not in self.variables:
@@ -218,7 +215,7 @@ class Path:
                         if variable['is_dynamic']:
                             return variable, name[len(var_name):]
         if name not in self.variables:
-            raise DictConsistencyError(_(f'unknown option {name}'), 42, [])
+            raise DictConsistencyError(_(f'unknown option "{name}"'), 42, xmlfiles)
         if with_suffix:
             return self.variables[name], None
         return self.variables[name]

src/rougail/template.py

@@ -1,397 +0,0 @@
-"""Template langage for Rougail
-
-Created by:
-EOLE (http://eole.orion.education.fr)
-Copyright (C) 2005-2018
-
-Forked by:
-Cadoles (http://www.cadoles.com)
-Copyright (C) 2019-2021
-
-distribued with GPL-2 or later license
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-"""
-
-from shutil import copy
-import logging
-from typing import Dict, Any
-from subprocess import call
-from os import listdir, makedirs, getcwd, chdir
-from os.path import dirname, join, isfile, abspath, normpath, isdir
-
-from Cheetah.Template import Template as ChtTemplate
-from Cheetah.NameMapper import NotFound as CheetahNotFound
-
-try:
-    from tiramisu3 import Config
-    from tiramisu3.error import PropertiesOptionError  # pragma: no cover
-except ModuleNotFoundError:  # pragma: no cover
-    from tiramisu import Config
-    from tiramisu.error import PropertiesOptionError
-
-from .config import RougailConfig
-from .error import FileNotFound, TemplateError
-from .i18n import _
-from .utils import normalize_family, load_modules
-
-
-log = logging.getLogger(__name__)
-log.addHandler(logging.NullHandler())
-
-
-@classmethod
-def cl_compile(kls, *args, **kwargs):
-    """Rewrite compile methode to force some settings
-    """
-    kwargs['compilerSettings'] = {'directiveStartToken' : '%',
-                                  'cheetahVarStartToken' : '%%',
-                                  'EOLSlurpToken' : '%',
-                                  'PSPStartToken' : 'µ' * 10,
-                                  'PSPEndToken' : 'µ' * 10,
-                                  'commentStartToken' : 'µ' * 10,
-                                  'commentEndToken' : 'µ' * 10,
-                                  'multiLineCommentStartToken' : 'µ' * 10,
-                                  'multiLineCommentEndToken' : 'µ' * 10}
-    return kls.old_compile(*args, **kwargs)  # pylint: disable=E1101
-ChtTemplate.old_compile = ChtTemplate.compile
-ChtTemplate.compile = cl_compile
-
-
-class CheetahTemplate(ChtTemplate):  # pylint: disable=W0223
-    """Construct a cheetah templating object
-    """
-    def __init__(self,
-                 filename: str,
-                 context,
-                 eosfunc: Dict,
-                 extra_context: Dict,
-                 ):
-        """Initialize Creole CheetahTemplate
-        """
-        ChtTemplate.__init__(self,
-                             file=filename,
-                             searchList=[context, eosfunc, extra_context])
-
-    # FORK of Cheetah function, do not replace '\\' by '/'
-    def serverSidePath(self,
-                       path=None,
-                       normpath=normpath,
-                       abspath=abspath
-                       ):  # pylint: disable=W0621
-
-        # strange...
-        if path is None and isinstance(self, str):
-            path = self
-        if path:  # pylint: disable=R1705
-            return normpath(abspath(path))
-#           original code return normpath(abspath(path.replace("\\", '/')))
-        elif hasattr(self, '_filePath') and self._filePath:  # pragma: no cover
-            return normpath(abspath(self._filePath))
-        else:  # pragma: no cover
-            return None
-
-
-class RougailLeaderIndex:
-    """This object is create when access to a specified Index of the variable
-    """
-    def __init__(self,
-                 value,
-                 follower,
-                 index,
-                 ) -> None:
-        self._value = value
-        self._follower = follower
-        self._index = index
-
-    def __getattr__(self, name):
-        if name not in self._follower:
-            raise AttributeError()
-        value = self._follower[name]
-        if isinstance(value, PropertiesOptionError):
-            raise AttributeError()
-        return value
-
-    def __str__(self):
-        return str(self._value)
-
-    def __lt__(self, value):
-        return self._value.__lt__(value)
-
-    def __le__(self, value):
-        return self._value.__le__(value)
-
-    def __eq__(self, value):
-        return self._value.__eq__(value)
-
-    def __ne__(self, value):
-        return self._value.__ne__(value)
-
-    def __gt__(self, value):
-        return self._value.__gt__(value)
-
-    def __ge__(self, value):
-        return self._value >= value
-
-    def __add__(self, value):
-        return self._value.__add__(value)
-
-    def __radd__(self, value):
-        return value + self._value
-
-
-class RougailLeader:
-    """Implement access to leader and follower variable
-    For examples: %%leader, %%leader[0].follower1
-    """
-    def __init__(self,
-                 value,
-                 ) -> None:
-        self._value = value
-        self._follower = {}
-
-    def __getitem__(self, index):
-        """Get a leader.follower at requested index.
-        """
-        followers = {key: values[index] for key, values in self._follower.items()}
-        return RougailLeaderIndex(self._value[index],
-                                 followers,
-                                 index,
-                                 )
-
-    def __iter__(self):
-        """Iterate over leader.follower.
-
-        Return synchronised value of leader.follower.
-        """
-        for index in range(len(self._value)):
-            yield self.__getitem__(index)
-
-    def __len__(self):
-        return len(self._value)
-
-    def __contains__(self, value):
-        return self._value.__contains__(value)
-
-    async def add_follower(self,
-                           config,
-                           name: str,
-                           path: str,
-                           ):
-        """Add a new follower
-        """
-        self._follower[name] = []
-        for index in range(len(self._value)):
-            try:
-                value = await config.option(path, index).value.get()
-            except PropertiesOptionError as err:
-                value = err
-            self._follower[name].append(value)
-
-
-class RougailExtra:
-    """Object that implement access to extra variable
-    For example %%extra1.family.variable
-    """
-    def __init__(self,
-                 suboption: Dict) -> None:
-        self.suboption = suboption
-
-    def __getattr__(self,
-                    key: str,
-                    ) -> Any:
-        return self.suboption[key]
-
-    def __iter__(self):
-        return iter(self.suboption.values())
-
-
-class RougailTemplate:
-    """Engine to process Creole cheetah template
-    """
-    def __init__(self,  # pylint: disable=R0913
-                 config: Config,
-                 ) -> None:
-        self.config = config
-        self.destinations_dir = abspath(RougailConfig['destinations_dir'])
-        self.tmp_dir = abspath(RougailConfig['tmp_dir'])
-        self.templates_dir = abspath(RougailConfig['templates_dir'])
-        self.patches_dir = abspath(RougailConfig['patches_dir'])
-        eos = {}
-        functions_file = RougailConfig['functions_file']
-        if isfile(functions_file):
-            eosfunc = load_modules(functions_file)
-            for func in dir(eosfunc):
-                if not func.startswith('_'):
-                    eos[func] = getattr(eosfunc, func)
-        self.eosfunc = eos
-        self.rougail_variables_dict = {}
-
-    def patch_template(self,
-                       filename: str,
-                       ) -> None:
-        """Apply patch to a template
-        """
-        patch_cmd = ['patch', '-d', self.tmp_dir, '-N', '-p1', '-f']
-        patch_no_debug = ['-s', '-r', '-', '--backup-if-mismatch']
-
-        patch_file = join(self.patches_dir, f'{filename}.patch')
-        if isfile(patch_file):
-            log.info(_("Patching template '{filename}' with '{patch_file}'"))
-            ret = call(patch_cmd + patch_no_debug + ['-i', patch_file])
-            if ret:  # pragma: no cover
-                patch_cmd_err = ' '.join(patch_cmd + ['-i', patch_file])
-                msg = _(f"Error applying patch: '{patch_file}'\n"
-                        f"To reproduce and fix this error {patch_cmd_err}")
-                log.error(_(msg))
-                copy(join(self.templates_dir, filename), self.tmp_dir)
-
-    def prepare_template(self,
-                         filename: str,
-                         ) -> None:
-        """Prepare template source file
-        """
-        log.info(_("Copy template: '{filename}' -> '{self.tmp_dir}'"))
-        if not isdir(self.tmp_dir):
-            raise TemplateError(_(f'cannot find tmp_dir {self.tmp_dir}'))
-        copy(filename, self.tmp_dir)
-        self.patch_template(filename)
-
-    def process(self,
-                source: str,
-                true_destfilename: str,
-                destfilename: str,
-                variable: Any,
-                ):
-        """Process a cheetah template
-        """
-        # full path of the destination file
-        log.info(_(f"Cheetah processing: '{destfilename}'"))
-        try:
-            extra_context = {'normalize_family': normalize_family,
-                             'rougail_filename': true_destfilename
-                             }
-            if variable:
-                extra_context['rougail_variable'] = variable
-            cheetah_template = CheetahTemplate(source,
-                                               self.rougail_variables_dict,
-                                               self.eosfunc,
-                                               extra_context,
-                                               )
-            data = str(cheetah_template)
-        except CheetahNotFound as err:  # pragma: no cover
-            varname = err.args[0][13:-1]
-            msg = f"Error: unknown variable used in template {source} to {destfilename}: {varname}"
-            raise TemplateError(_(msg)) from err
-        except Exception as err:  # pragma: no cover
-            msg = _(f"Error while instantiating template {source} to {destfilename}: {err}")
-            raise TemplateError(msg) from err
-
-        with open(destfilename, 'w') as file_h:
-            file_h.write(data)
-
-    def instance_file(self,
-                      filevar: Dict,
-                      ) -> None:
-        """Run templatisation on one file
-        """
-        log.info(_("Instantiating file '{filename}'"))
-        if 'variable' in filevar:
-            variable = filevar['variable']
-        else:
-            variable = None
-        filenames = filevar['name']
-        if not isinstance(filenames, list):
-            filenames = [filenames]
-            if variable:
-                variable = [variable]
-        if not isdir(self.destinations_dir):
-            raise TemplateError(_(f'cannot find destinations_dir {self.destinations_dir}'))
-        for idx, filename in enumerate(filenames):
-            destfilename = join(self.destinations_dir, filename[1:])
-            makedirs(dirname(destfilename), exist_ok=True)
-            if variable:
-                var = variable[idx]
-            else:
-                var = None
-            source = join(self.tmp_dir, filevar['source'])
-            if filevar['templating'] == 'creole':
-                self.process(source,
-                             filename,
-                             destfilename,
-                             var,
-                             )
-            else:
-                copy(source, destfilename)
-
-    async def instance_files(self) -> None:
-        """Run templatisation on all files
-        """
-        ori_dir = getcwd()
-        chdir(self.templates_dir)
-        for option in await self.config.option.list(type='all'):
-            namespace = await option.option.name()
-            is_variable_namespace = namespace == RougailConfig['variable_namespace']
-            self.rougail_variables_dict[namespace] = await self.load_variables(option,
-                                                                               is_variable_namespace,
-                                                                               )
-        for template in listdir('.'):
-            self.prepare_template(template)
-        for service_obj in await self.config.option('services').list('all'):
-            for fills in await service_obj.list('all'):
-                if await fills.option.name() in ['files', 'overrides']:
-                    for fill_obj in await fills.list('all'):
-                        fill = await fill_obj.value.dict()
-                        filename = fill['source']
-                        if not isfile(filename):  # pragma: no cover
-                            raise FileNotFound(_(f"File {filename} does not exist."))
-                        if fill['activate']:
-                            self.instance_file(fill)
-                        else:
-                            log.debug(_("Instantiation of file '{filename}' disabled"))
-        chdir(ori_dir)
-
-    async def load_variables(self,
-                             optiondescription,
-                             is_variable_namespace,
-                             ) -> RougailExtra:
-        """Load all variables and set it in RougailExtra objects
-        """
-        variables = {}
-        for option in await optiondescription.list('all'):
-            if await option.option.isoptiondescription():
-                if await option.option.isleadership():
-                    for idx, suboption in enumerate(await option.list('all')):
-                        if idx == 0:
-                            leader = RougailLeader(await suboption.value.get())
-                            leader_name = await suboption.option.name()
-                            if is_variable_namespace:
-                                self.rougail_variables_dict[await suboption.option.name()] = leader
-                        else:
-                            await leader.add_follower(self.config,
-                                                      await suboption.option.name(),
-                                                      await suboption.option.path(),
-                                                      )
-                    variables[leader_name] = leader
-                else:
-                    subfamilies = await self.load_variables(option,
-                                                            is_variable_namespace,
-                                                            )
-                    variables[await option.option.name()] = subfamilies
-            else:
-                if is_variable_namespace:
-                    self.rougail_variables_dict[await option.option.name()] = await option.value.get()
-                variables[await option.option.name()] = await option.value.get()
-        return RougailExtra(variables)

src/rougail/template/base.py

@@ -0,0 +1,541 @@
+"""Template langage for Rougail
+
+Created by:
+EOLE (http://eole.orion.education.fr)
+Copyright (C) 2005-2018
+
+Forked by:
+Cadoles (http://www.cadoles.com)
+Copyright (C) 2019-2021
+
+distribued with GPL-2 or later license
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""
+
+from shutil import copy
+import logging
+from typing import Dict, Any
+from subprocess import call
+from os import listdir, makedirs, getcwd, chdir, unlink, rmdir
+from os.path import dirname, join, isfile, isdir, abspath
+
+
+try:
+    from tiramisu3 import Config, undefined
+    from tiramisu3.error import PropertiesOptionError  # pragma: no cover
+except ModuleNotFoundError:  # pragma: no cover
+    from tiramisu import Config, undefined
+    from tiramisu.error import PropertiesOptionError
+
+from ..config import RougailConfig
+from ..error import FileNotFound, TemplateError
+from ..i18n import _
+from ..utils import load_modules
+
+from . import engine as engines
+ENGINES = {}
+for engine in engines.__all__:
+    ENGINES[engine] = getattr(engines, engine)
+
+
+log = logging.getLogger(__name__)
+log.addHandler(logging.NullHandler())
+
+
+INFORMATIONS = {'files': ['source', 'mode', 'engine', 'included'],
+                'overrides': ['name', 'source', 'engine'],
+                }
+DEFAULT = {'files': ['owner', 'group'],
+           'overrides': [],
+           }
+
+
+class RougailLeaderIndex:
+    """This object is create when access to a specified Index of the variable
+    """
+    def __init__(self,
+                 value,
+                 follower,
+                 index,
+                 ) -> None:
+        self._value = value
+        self._follower = follower
+        self._index = index
+
+    def __getattr__(self, name):
+        if name not in self._follower:
+            raise AttributeError(f'unable to find follower "{name}"')
+        value = self._follower[name]
+        if isinstance(value, PropertiesOptionError):
+            raise AttributeError(f'unable to access to follower "{name}": {value}')
+        return value
+
+    def __getitem__(self, name):
+        return self.__getattr__(name)
+
+    def __contains__(self, name):
+        if self._follower.__contains__(name):
+            value = self._follower[name]
+            return not isinstance(value, PropertiesOptionError)
+        return False
+
+    def __str__(self):
+        return str(self._value)
+
+    def __lt__(self, value):
+        return self._value.__lt__(value)
+
+    def __le__(self, value):
+        return self._value.__le__(value)
+
+    def __eq__(self, value):
+        return self._value.__eq__(value)
+
+    def __ne__(self, value):
+        return self._value.__ne__(value)
+
+    def __gt__(self, value):
+        return self._value.__gt__(value)
+
+    def __ge__(self, value):
+        return self._value >= value
+
+    def __add__(self, value):
+        return self._value.__add__(value)
+
+    def __radd__(self, value):
+        return value + self._value
+
+
+class RougailLeader:
+    """Implement access to leader and follower variable
+    For examples: %%leader, %%leader[0].follower1
+    """
+    def __init__(self,
+                 leader_name,
+                 value,
+                 ) -> None:
+        self._value = value
+        self._follower = {leader_name: value}
+
+    def __getitem__(self, index):
+        """Get a leader.follower at requested index.
+        """
+        followers = {key: values[index] for key, values in self._follower.items()}
+        return RougailLeaderIndex(self._value[index],
+                                 followers,
+                                 index,
+                                 )
+
+    def __iter__(self):
+        """Iterate over leader.follower.
+
+        Return synchronised value of leader.follower.
+        """
+        for index in range(len(self._value)):
+            yield self.__getitem__(index)
+
+    def __len__(self):
+        return len(self._value)
+
+    def __contains__(self, value):
+        return self._value.__contains__(value)
+
+    async def _add_follower(self,
+                            config,
+                            name: str,
+                            path: str,
+                            ):
+        """Add a new follower
+        """
+        self._follower[name] = []
+        for index in range(len(self._value)):
+            try:
+                value = await config.option(path, index).value.get()
+            except PropertiesOptionError as err:
+                value = err
+            self._follower[name].append(value)
+
+
+class RougailExtra:
+    """Object that implement access to extra variable
+    For example %%extra1.family.variable
+    """
+    def __init__(self,
+                 suboption: Dict,
+                 ) -> None:
+        self._suboption = suboption
+
+    def __getattr__(self,
+                    key: str,
+                    ) -> Any:
+        try:
+            return self._suboption[key]
+        except KeyError:
+            raise AttributeError(f'unable to find extra "{key}"')
+
+    def __getitem__(self,
+                    key: str,
+                    ) -> Any:
+        return self.__getattr__(key)
+
+    def __iter__(self):
+        return iter(self._suboption.values())
+
+    def items(self):
+        return self._suboption.items()
+
+    def __str__(self):
+        suboptions = {}
+        for key, value in self._suboption.items():
+            suboptions[key] = str(value)
+        return f'<extra object with: {suboptions}>'
+
+
+class RougailBaseTemplate:
+    """Engine to process Creole cheetah template
+    """
+    def __init__(self,  # pylint: disable=R0913
+                 config: Config,
+                 rougailconfig: RougailConfig=None,
+                 ) -> None:
+        if rougailconfig is None:
+            rougailconfig = RougailConfig
+        self.config = config
+        self.destinations_dir = abspath(rougailconfig['destinations_dir'])
+        self.tmp_dir = abspath(rougailconfig['tmp_dir'])
+        self.templates_dir = []
+        templates_dir = rougailconfig['templates_dir']
+        if not isinstance(templates_dir, list):
+            templates_dir = [templates_dir]
+        for templ_dir in templates_dir:
+            self.templates_dir.append(abspath(templ_dir))
+        self.patches_dir = abspath(rougailconfig['patches_dir'])
+        eos = {}
+        functions_file = rougailconfig['functions_file']
+        if not isinstance(functions_file, list):
+            functions_file = [functions_file]
+        for function in functions_file:
+            if isfile(function):
+                eosfunc = load_modules(function)
+                for func in dir(eosfunc):
+                    if not func.startswith('_'):
+                        eos[func] = getattr(eosfunc, func)
+        self.eosfunc = eos
+        self.rougail_variables_dict = {}
+        self.rougailconfig = rougailconfig
+        self.log = log
+        self.engines = ENGINES
+
+    def patch_template(self,
+                       filename: str,
+                       templates_dir: str,
+                       ) -> None:
+        """Apply patch to a template
+        """
+        patch_cmd = ['patch', '-d', self.tmp_dir, '-N', '-p1', '-f']
+        patch_no_debug = ['-s', '-r', '-', '--backup-if-mismatch']
+
+        patch_file = join(self.patches_dir, f'{filename}.patch')
+        if isfile(patch_file):
+            self.log.info(_("Patching template '{filename}' with '{patch_file}'"))
+            ret = call(patch_cmd + patch_no_debug + ['-i', patch_file])
+            if ret:  # pragma: no cover
+                patch_cmd_err = ' '.join(patch_cmd + ['-i', patch_file])
+                msg = _(f"Error applying patch: '{patch_file}'\n"
+                        f"To reproduce and fix this error {patch_cmd_err}")
+                self.log.error(_(msg))
+                copy(join(templates_dir, filename), self.tmp_dir)
+
+    def prepare_template(self,
+                         filename: str,
+                         templates_dir: str,
+                         ) -> None:
+        """Prepare template source file
+        """
+        self.log.info(_("Copy template: '{filename}' -> '{self.tmp_dir}'"))
+        if not isdir(self.tmp_dir):
+            raise TemplateError(_(f'cannot find tmp_dir {self.tmp_dir}'))
+        copy(join(templates_dir, filename), self.tmp_dir)
+        self.patch_template(filename, templates_dir)
+
+    def instance_file(self,
+                      filevar: Dict,
+                      type_: str,
+                      service_name: str,
+                      ) -> str:
+        """Run templatisation on one file
+        """
+        self.log.info(_("Instantiating file '{filename}'"))
+        if 'variable' in filevar:
+            variable = filevar['variable']
+        else:
+            variable = None
+        filenames = filevar.get('name')
+        if not isinstance(filenames, list):
+            filenames = [filenames]
+            if variable and not isinstance(variable, list):
+                variable = [variable]
+        if not isdir(self.destinations_dir):
+            raise TemplateError(_(f'cannot find destinations_dir {self.destinations_dir}'))
+        destfilenames = []
+        for idx, filename, in enumerate(filenames):
+            if variable:
+                var = variable[idx]
+            else:
+                var = None
+            func = f'get_data_{type_}'
+            data = getattr(self, func)(filevar,
+                                       filename,
+                                       service_name,
+                                       variable,
+                                       idx,
+                                       )
+            if data is None:
+                continue
+            filename, source, true_destfilename, var = data
+            destfilename = join(self.destinations_dir, true_destfilename[1:])
+            makedirs(dirname(destfilename), exist_ok=True)
+            self.log.info(_(f"{filevar['engine']} processing: '{destfilename}'"))
+            self.engines[filevar['engine']].process(filename=filename,
+                                                    source=source,
+                                                    true_destfilename=true_destfilename,
+                                                    destfilename=destfilename,
+                                                    destdir=self.destinations_dir,
+                                                    variable=var,
+                                                    index=idx,
+                                                    rougail_variables_dict=self.rougail_variables_dict,
+                                                    eosfunc=self.eosfunc,
+                                                    )
+            self.process(true_destfilename,
+                         destfilename,
+                         filevar.get('mode'),
+                         filevar.get('owner'),
+                         filevar.get('group'),
+                         )
+            destfilenames.append(destfilename)
+        return destfilenames
+
+    async def instance_files(self) -> None:
+        """Run templatisation on all files
+        """
+        try:
+            ori_dir = getcwd()
+        except FileNotFoundError:
+            ori_dir = None
+        chdir(self.tmp_dir)
+        for option in await self.config.option.list(type='all'):
+            namespace = await option.option.name()
+            is_variable_namespace = namespace == self.rougailconfig['variable_namespace']
+            if namespace == 'services':
+                is_service_namespace = 'root'
+            else:
+                is_service_namespace = False
+            self.rougail_variables_dict[namespace] = await self.load_variables(option,
+                                                                               is_variable_namespace,
+                                                                               is_service_namespace,
+                                                                               )
+        for templates_dir in self.templates_dir:
+            for template in listdir(templates_dir):
+                self.prepare_template(template,
+                                      templates_dir,
+                                      )
+        files_to_delete = []
+        for included in (True, False):
+            for service_obj in await self.config.option('services').list('all'):
+                service_name = await service_obj.option.description()
+                if await service_obj.option('activate').value.get() is False:
+                    if included is False and not await service_obj.information.get('undisable', False):
+                        self.desactive_service(service_name)
+                    continue
+                if not included:
+                    engine = await service_obj.information.get('engine', None)
+                    if engine:
+                        self.instance_file({'engine': engine},
+                                           'service',
+                                           service_name,
+                                           )
+                    target_name = await service_obj.information.get('target', None)
+                    if target_name:
+                        self.target_service(service_name,
+                                            target_name,
+                                            engine is None,
+                                            )
+                for fills in await service_obj.list('optiondescription'):
+                    type_ = await fills.option.name()
+                    for fill_obj in await fills.list('all'):
+                        fill = await fill_obj.value.dict()
+                        self.get_default(type_, fill, fill_obj)
+                        await self.get_informations(type_, fill, fill_obj)
+                        if 'included' in fill:
+                            if (fill['included'] == 'no' and included is True) or \
+                                    (fill['included'] != 'no' and included is False):
+                                continue
+                        elif included is True:
+                            continue
+                        if fill['activate']:
+                            destfilenames = self.instance_file(fill,
+                                                               type_,
+                                                               service_name,
+                                                               )
+                            if included and fill.get('included', 'no') == 'content':
+                                files_to_delete.extend(destfilenames)
+                        else:
+                            self.log.debug(_(f"Instantiation of file '{fill['name']}' disabled"))
+                self.post_instance_service(service_name)
+        for filename in files_to_delete:
+            unlink(filename)
+            parent = filename
+            while True:
+                parent = dirname(parent)
+                if listdir(parent):
+                    break
+                rmdir(parent)
+        self.post_instance()
+        if ori_dir is not None:
+            chdir(ori_dir)
+
+    def get_default(self,
+                    type_: str,
+                    dico: dict,
+                    obj: 'Option',
+                    ) -> None:
+        for key in DEFAULT.get(type_, []):
+            default_key = f'default_{type_}_{key}'
+            if default_key in RougailConfig:
+                default_value = RougailConfig[default_key]
+            else:
+                default_value = undefined
+            dico[key] = dico.get(key, default_value)
+
+    async def get_informations(self,
+                               type_: str,
+                               dico: dict,
+                               obj: 'Option',
+                               ) -> None:
+        for key in INFORMATIONS.get(type_, []):
+            default_key = f'default_{type_}_{key}'
+            if default_key in RougailConfig:
+                default_value = RougailConfig[default_key]
+            else:
+                default_value = undefined
+            dico[key] = await obj.information.get(key, default_value)
+
+    def desactive_service(self,
+                          *args,
+                          ):
+        raise NotImplementedError(_('cannot desactivate a service'))
+
+    def target_service(self,
+                       service_name: str,
+                       *args,
+                       ):
+        raise NotImplementedError(_('cannot use target for the service {service_name}'))
+
+    def post_instance_service(self,
+                              *args,
+                              ):  # pragma: no cover
+        pass
+
+    def process(self,
+                *args,
+                ):  # pragma: no cover
+        raise NotImplementedError(_('cannot processed'))
+
+    def post_instance(self):  # pragma: no cover
+        pass
+
+    def get_data_ip(self,
+                    *args,
+                    ) -> None:  # pragma: no cover
+        raise NotImplementedError(_('cannot instanciate this service type ip'))
+
+    def get_data_files(self,
+                       *args,
+                       ) -> None:  # pragma: no cover
+        raise NotImplementedError(_('cannot instanciate this service type file'))
+
+    def get_data_service(self,
+                         *args,
+                          ) -> None:  # pragma: no cover
+        raise NotImplementedError(_('cannot instanciate this service'))
+
+    def get_data_overrides(self,
+                           *args,
+                           ) -> None:  # pragma: no cover
+        raise NotImplementedError(_('cannot instanciate this service type override'))
+
+    async def load_variables(self,
+                             optiondescription,
+                             is_variable_namespace: str,
+                             is_service_namespace: str,
+                             ) -> RougailExtra:
+        """Load all variables and set it in RougailExtra objects
+        """
+        variables = {}
+        for option in await optiondescription.list('all'):
+            if await option.option.isoptiondescription():
+                if await option.option.isleadership():
+                    for idx, suboption in enumerate(await option.list('all')):
+                        if idx == 0:
+                            leader_name = await suboption.option.name()
+                            leader = RougailLeader(leader_name, await suboption.value.get())
+                            leadership_name = await option.option.name()
+                            if is_variable_namespace:
+                                self.rougail_variables_dict[await suboption.option.name()] = leader
+                        else:
+                            await leader._add_follower(self.config,
+                                                       await suboption.option.name(),
+                                                       await suboption.option.path(),
+                                                       )
+                    variables[leadership_name] = RougailExtra({leader_name: leader})
+                else:
+                    if is_service_namespace == 'root':
+                        new_is_service_namespace = 'service_name'
+                    elif is_service_namespace == 'service_name':
+                        new_is_service_namespace = await option.option.name()
+                    elif is_service_namespace in INFORMATIONS:
+                        # remove 's'
+                        new_is_service_namespace = is_service_namespace[:-1]
+                    else:
+                        new_is_service_namespace = is_service_namespace
+                    subfamilies = await self.load_variables(option,
+                                                            is_variable_namespace,
+                                                            new_is_service_namespace,
+                                                            )
+                    variables[await option.option.name()] = subfamilies
+            else:
+                if is_variable_namespace:
+                    value = await option.value.get()
+                    self.rougail_variables_dict[await option.option.name()] = value
+                if await option.option.issymlinkoption() and await option.option.isfollower():
+                    value = []
+                    path = await option.option.path()
+                    for index in range(await option.value.len()):
+                        value.append(await self.config.option(path, index).value.get())
+                else:
+                    value = await option.value.get()
+                variables[await option.option.name()] = value
+        if isinstance(is_service_namespace, str) and is_service_namespace + 's' in INFORMATIONS:
+            self.get_default(is_service_namespace + 's',
+                             variables,
+                             optiondescription,
+                             )
+            await self.get_informations(is_service_namespace + 's',
+                                        variables,
+                                        optiondescription,
+                                        )
+        return RougailExtra(variables)

src/rougail/template/engine/__init__.py

@@ -0,0 +1,4 @@
+from . import none, creole, jinja2, creole_legacy
+
+
+__all__ = ('none', 'creole', 'jinja2', 'creole_legacy')

src/rougail/template/engine/creole.py

@@ -0,0 +1,138 @@
+"""Creole engine
+
+Created by:
+EOLE (http://eole.orion.education.fr)
+Copyright (C) 2005-2018
+
+Forked by:
+Cadoles (http://www.cadoles.com)
+Copyright (C) 2021
+
+distribued with GPL-2 or later license
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""
+from os.path import abspath, normpath
+from Cheetah.Template import Template
+from Cheetah.NameMapper import NotFound
+from typing import Dict, Any
+
+from ...i18n import _
+from ...utils import normalize_family
+from ...error import TemplateError
+
+
+@classmethod
+def cl_compile(kls, *args, **kwargs):
+    """Rewrite compile methode to force some settings
+    """
+    kwargs['compilerSettings'] = {'directiveStartToken': '%',
+                                  'cheetahVarStartToken': '%%',
+                                  'EOLSlurpToken': '%',
+                                  'commentStartToken': '#',
+                                  'multiLineCommentStartToken': '#*',
+                                  'multiLineCommentEndToken': '*#',
+                                  }
+    return kls.old_compile(*args, **kwargs)  # pylint: disable=E1101
+Template.old_compile = Template.compile
+Template.compile = cl_compile
+
+
+class CheetahTemplate(Template):  # pylint: disable=W0223
+    """Construct a cheetah templating object
+    """
+    def __init__(self,
+                 filename: str,
+                 source: str,
+                 context,
+                 eosfunc: Dict,
+                 extra_context: Dict,
+                 ):
+        """Initialize Creole CheetahTemplate
+        """
+        if filename is not None:
+            super().__init__(file=filename,
+                             searchList=[context, eosfunc, extra_context],
+                             )
+        else:
+            super().__init__(source=source,
+                             searchList=[context, eosfunc, extra_context],
+                             )
+
+    # FORK of Cheetah function, do not replace '\\' by '/'
+    def serverSidePath(self,
+                       path=None,
+                       normpath=normpath,
+                       abspath=abspath
+                       ):  # pylint: disable=W0621
+
+        # strange...
+        if path is None and isinstance(self, str):
+            path = self
+        if path:  # pylint: disable=R1705
+            return normpath(abspath(path))
+#           original code return normpath(abspath(path.replace("\\", '/')))
+        elif hasattr(self, '_filePath') and self._filePath:  # pragma: no cover
+            return normpath(abspath(self._filePath))
+        else:  # pragma: no cover
+            return None
+
+
+# Sync to creole_legacy.py
+def process(filename: str,
+            source: str,
+            true_destfilename: str,
+            destfilename: str,
+            destdir: str,
+            variable: Any,
+            index: int,
+            rougail_variables_dict: Dict,
+            eosfunc: Dict,
+            ):
+    """Process a cheetah template
+    """
+    # full path of the destination file
+    try:
+        extra_context = {'normalize_family': normalize_family,
+                         'rougail_filename': true_destfilename,
+                         'rougail_destination_dir': destdir,
+                         }
+        if variable is not None:
+            extra_context['rougail_variable'] = variable
+        if index is not None:
+            extra_context['rougail_index'] = index
+        cheetah_template = CheetahTemplate(filename,
+                                           source,
+                                           rougail_variables_dict,
+                                           eosfunc,
+                                           extra_context,
+                                           )
+        data = str(cheetah_template)
+    except NotFound as err:  # pragma: no cover
+        varname = err.args[0][13:].split(' ', 1)[0][:-1]
+        if filename:
+            msg = f"Error: unknown variable used in template {filename} to {destfilename}: {varname}"
+        else:
+            msg = f"Error: unknown variable used in file {destfilename}: {varname}"
+        raise TemplateError(_(msg)) from err
+    except Exception as err:  # pragma: no cover
+        if filename:
+            msg = _(f"Error while instantiating template {filename} to {destfilename}: {err}")
+        else:
+            msg = _(f"Error while instantiating filename {destfilename}: {err}")
+        raise TemplateError(msg) from err
+
+    with open(destfilename, 'w') as file_h:
+        file_h.write(data)

src/rougail/template/engine/creole_legacy.py

@@ -0,0 +1,164 @@
+"""Legacy Creole engine
+
+Created by:
+EOLE (http://eole.orion.education.fr)
+Copyright (C) 2005-2018
+
+Forked by:
+Cadoles (http://www.cadoles.com)
+Copyright (C) 2021
+
+distribued with GPL-2 or later license
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""
+
+
+from typing import Dict, Any
+from Cheetah.NameMapper import NotFound
+
+from .creole import CheetahTemplate as oriCheetahTemplate
+from ...i18n import _
+from ...utils import normalize_family
+from ...error import TemplateError
+
+
+@classmethod
+def cl_compile(kls, *args, **kwargs):
+    """Rewrite compile methode to force some settings
+    """
+    kwargs['compilerSettings'] = {'directiveStartToken' : u'%',
+                   'cheetahVarStartToken' : u'%%',
+                   'EOLSlurpToken' : u'%',
+                   'PSPStartToken' : u'µ' * 10,
+                   'PSPEndToken' : u'µ' * 10,
+                   'commentStartToken' : u'µ' * 10,
+                   'commentEndToken' : u'µ' * 10,
+                   'multiLineCommentStartToken' : u'µ' * 10,
+                   'multiLineCommentEndToken' : u'µ' * 10}
+    return kls.old_compile(*args, **kwargs)  # pylint: disable=E1101
+
+
+class IsDefined:
+    """
+    filtre permettant de ne pas lever d'exception au cas où
+    la variable Creole n'est pas définie
+     """
+    def __init__(self, context):
+        self.context = context
+
+    def __call__(self, varname):
+        if '.' in varname:
+            splitted_var = varname.split('.')
+            if len(splitted_var) != 2:
+                msg = u"Group variables must be of type master.slave"
+                raise KeyError(msg)
+            master, slave = splitted_var
+            if master in self.context:
+                return slave in self.context[master].slave.keys()
+            return False   
+        else:
+            return varname in self.context
+
+
+class CreoleClient():
+    def get(self, path):
+        path = path.replace('/', '.')
+        if path.startswith('.'):
+            path = path[1:]
+        if '.' not in path:
+            return self.context[path]
+        else:
+            root, path = path.split('.', 1)
+            obj = self.context[root]
+            for var in path.split('.'):
+                obj = getattr(obj, var)
+            return obj
+
+
+def is_empty(data):
+    if str(data) in ['', '""', "''", "[]", "['']", '[""]', "None"]:
+        return True
+    return False
+
+
+class CheetahTemplate(oriCheetahTemplate):
+    def __init__(self,
+                 filename: str,
+                 source: str,
+                 context,
+                 eosfunc: Dict,
+                 extra_context: Dict,
+                 ):
+        creole_client = CreoleClient()
+        creole_client.context=context
+        extra_context['is_defined'] = IsDefined(context)
+        extra_context['creole_client'] = creole_client
+        extra_context['is_empty'] = is_empty
+        extra_context['_creole_filename'] = extra_context['rougail_filename']
+        super().__init__(filename, source, context, eosfunc, extra_context)
+
+
+# Sync to creole.py
+def process(filename: str,
+            source: str,
+            true_destfilename: str,
+            destfilename: str,
+            destdir: str,
+            variable: Any,
+            index: int,
+            rougail_variables_dict: Dict,
+            eosfunc: Dict,
+            ):
+    """Process a cheetah template
+    """
+    # full path of the destination file
+    ori_compile = oriCheetahTemplate.compile
+    oriCheetahTemplate.compile = cl_compile
+    try:
+        extra_context = {'normalize_family': normalize_family,
+                         'rougail_filename': true_destfilename,
+                         'rougail_destination_dir': destdir,
+                         }
+        if variable is not None:
+            extra_context['rougail_variable'] = variable
+        if index is not None:
+            extra_context['rougail_index'] = index
+        cheetah_template = CheetahTemplate(filename,
+                                           source,
+                                           rougail_variables_dict,
+                                           eosfunc,
+                                           extra_context,
+                                           )
+        data = str(cheetah_template)
+    except NotFound as err:  # pragma: no cover
+        varname = err.args[0][13:-1]
+        if filename:
+            msg = f"Error: unknown variable used in template {filename} to {destfilename}: {varname}"
+        else:
+            msg = f"Error: unknown variable used in file {destfilename}: {varname}"
+        oriCheetahTemplate.compile = ori_compile
+        raise TemplateError(_(msg)) from err
+    except Exception as err:  # pragma: no cover
+        if filename:
+            msg = _(f"Error while instantiating template {filename} to {destfilename}: {err}")
+        else:
+            msg = _(f"Error while instantiating filename {destfilename}: {err}")
+        oriCheetahTemplate.compile = ori_compile
+        raise TemplateError(msg) from err
+
+    with open(destfilename, 'w') as file_h:
+        file_h.write(data)
+    oriCheetahTemplate.compile = ori_compile

src/rougail/template/engine/jinja2.py

@@ -0,0 +1,75 @@
+"""Jinja2 engine
+
+Created by:
+EOLE (http://eole.orion.education.fr)
+Copyright (C) 2005-2018
+
+Forked by:
+Cadoles (http://www.cadoles.com)
+Copyright (C) 2021
+
+distribued with GPL-2 or later license
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""
+from typing import Any, Dict
+from jinja2 import Environment, FileSystemLoader
+from jinja2.exceptions import UndefinedError
+
+from ...i18n import _
+from ...utils import normalize_family
+from ...error import TemplateError
+
+
+def process(filename: str,
+            source: str,
+            true_destfilename: str,
+            destfilename: str,
+            destdir: str,
+            variable: Any,
+            index: int,
+            rougail_variables_dict: Dict,
+            eosfunc: Dict,
+            ):
+    """Process a cheetah template
+    """
+    # full path of the destination file
+    dir_name, template_name = filename.rsplit('/', 1)
+    if source is not None:  # pragma: no cover
+        raise TemplateError(_('source is not supported for jinja2'))
+    var = {}
+    if variable is not None:
+        var['rougail_variable'] = variable
+    if index is not None:
+        var['rougail_index'] = index
+    try:
+        # extra_context = {'normalize_family': normalize_family,
+        # eosfunc
+        env = Environment(loader=FileSystemLoader([dir_name, destdir]))
+        template = env.get_template(template_name)
+        data = template.render(**rougail_variables_dict,
+                               rougail_filename=true_destfilename,
+                               rougail_destination_dir=destdir,
+                               **var,
+                               )
+    except UndefinedError as err:  # pragma: no cover
+        varname = err
+        msg = f"Error: unknown variable used in template {filename} to {destfilename}: {varname}"
+        raise TemplateError(_(msg)) from err
+
+    if not data.endswith('\n'):
+        data = data + '\n'
+    with open(destfilename, 'w') as file_h:
+        file_h.write(data)

src/rougail/template/engine/none.py

@@ -0,0 +1,35 @@
+"""None engine
+
+Created by:
+EOLE (http://eole.orion.education.fr)
+Copyright (C) 2005-2018
+
+Forked by:
+Cadoles (http://www.cadoles.com)
+Copyright (C) 2021
+
+distribued with GPL-2 or later license
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""
+from typing import Any
+from shutil import copy
+
+
+def process(filename: str,
+            destfilename: str,
+            **kwargs
+            ):
+    copy(filename, destfilename)

src/rougail/template/systemd.py

@@ -0,0 +1,212 @@
+"""Template langage for Rougail to create file and systemd file
+
+Cadoles (http://www.cadoles.com)
+Copyright (C) 2021
+
+distribued with GPL-2 or later license
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""
+
+from typing import Dict, Any
+from os import makedirs, symlink, chmod
+from os.path import dirname, isfile, join
+from ipaddress import ip_network
+
+from .base import RougailBaseTemplate
+from ..i18n import _
+from ..error import FileNotFound, TemplateError
+
+
+ROUGAIL_IP_TEMPLATE = """[Service]
+%for %%ip in %%rougail_variable
+IPAddressAllow=%%ip
+%end for
+IPAddressDeny=any
+"""
+
+
+ROUGAIL_GLOBAL_SYSTEMD_FILE = '/usr/lib/systemd/system'
+ROUGAIL_DEST_FILE = '/tmpfiles.d/0rougail.conf'
+LOCAL_DIR = ('/etc/', '/var/', '/srv/')
+
+
+class RougailSystemdTemplate(RougailBaseTemplate):
+    def __init__(self,  # pylint: disable=R0913
+                 config: 'Config',
+                 rougailconfig: 'RougailConfig'=None,
+                 ) -> None:
+        self.ip_per_service = None
+        super().__init__(config, rougailconfig)
+        self.rougail_tmpl_template = f"""%def display(%%file, %%filename)
+"""
+        tmp_local_dir = (f"%%filename.startswith('{local_dir}')" for local_dir in LOCAL_DIR)
+        self.rougail_tmpl_template += '%if ' + ' or '.join(tmp_local_dir)
+        self.rougail_tmpl_template += f"""
+C %%filename %%file.mode %%file.owner %%file.group - {self.rougailconfig['tmpfile_dest_dir']}%%filename
+%end if
+%end def
+%for %%service in %%services
+  %if %%service.activate is True and %%hasattr(%%service, 'files')
+    %for %%file in %%service.files
+      %if %%file.activate is True and %%file.included != 'content'
+        %if %%isinstance(%%file.name, list)
+          %for %%filename in %%file.name
+%%display(%%file, %%filename)%slurp
+          %end for
+        %else
+%%display(%%file, %%file.name)%slurp
+        %end if
+      %end if
+    %end for
+  %end if
+%end for
+"""
+
+    def get_data_files(self,
+                       filevar: Dict,
+                       destfile: str,
+                       service_name: str,
+                       variable,
+                       idx: int,
+                       ) -> tuple:
+        source = filevar['source']
+        if not isfile(source):  # pragma: no cover
+            raise FileNotFound(_(f'Source file "{source}" does not exist in {", ".join(self.templates_dir)}'))
+        tmp_file = join(self.tmp_dir, source)
+        #self.instance_file(fill, 'files')
+        if variable:
+            var = variable[idx]
+        else:
+            var = None
+        return tmp_file, None, destfile, var
+
+    def get_data_overrides(self,
+                           filevar: Dict,
+                           destfile,
+                           service_name: str,
+                           *args,
+                           ) -> tuple:
+        source = filevar['source']
+        if not isfile(source):  # pragma: no cover
+            raise FileNotFound(_(f'Override source file "{source}" does not exist in {", ".join(self.templates_dir)}'))
+        tmp_file = join(self.tmp_dir, source)
+        service_name = filevar['name']
+        destfile = f'/systemd/system/{service_name}.d/rougail.conf'
+        return tmp_file, None, destfile, None
+
+    def get_data_ip(self,
+                    filevar: Dict,
+                    ip,
+                    service_name: str,
+                    var: Any,
+                    idx: int,
+                    *args,
+                    ) -> tuple:
+        if self.ip_per_service is None:
+            self.ip_per_service = []
+        if 'netmask' in filevar:
+            if isinstance(filevar["netmask"], list):
+                netmask = filevar['netmask'][idx]
+            else:
+                netmask = filevar['netmask']
+            self.ip_per_service.append(str(ip_network(f'{ip}/{netmask}')))
+        elif ip:
+            self.ip_per_service.append(ip)
+
+    def get_data_service(self,
+                         servicevar: Dict,
+                         info,
+                         service_name: str,
+                         *args,
+                         ):
+        tmp_file = join(self.tmp_dir, service_name)
+        var = None
+        destfile = f'/systemd/system/{service_name}'
+        return tmp_file, None, destfile, var
+
+
+    def desactive_service(self,
+                          service_name: str,
+                          ):
+        filename = f'{self.destinations_dir}/systemd/system/{service_name}'
+        makedirs(dirname(filename), exist_ok=True)
+        symlink('/dev/null', filename)
+
+    def target_service(self,
+                       service_name: str,
+                       target_name: str,
+                       global_service: str,
+                       ):
+        filename = f'{self.destinations_dir}/systemd/system/{target_name}.target.wants/{service_name}'
+        makedirs(dirname(filename), exist_ok=True)
+        if global_service:
+            source_filename = f'{ROUGAIL_GLOBAL_SYSTEMD_FILE}/{service_name}'
+        else:
+            source_filename = f"{self.rougailconfig['tmpfile_dest_dir']}/systemd/system/{service_name}"
+        symlink(source_filename, filename)
+
+    def post_instance_service(self,
+                              service_name: str,
+                              ) -> None:  # pragma: no cover
+        if self.ip_per_service is None:
+            return
+        destfile = f'/systemd/system/{service_name}.d/rougail_ip.conf'
+        destfilename = join(self.destinations_dir, destfile[1:])
+        makedirs(dirname(destfilename), exist_ok=True)
+        self.log.info(_(f"creole processing: '{destfilename}'"))
+        self.engines['creole'].process(filename=None,
+                                       source=ROUGAIL_IP_TEMPLATE,
+                                       true_destfilename=destfile,
+                                       destfilename=destfilename,
+                                       destdir=self.destinations_dir,
+                                       variable=self.ip_per_service,
+                                       index=None,
+                                       rougail_variables_dict=self.rougail_variables_dict,
+                                       eosfunc=self.eosfunc,
+                                       )
+        self.ip_per_service = None
+
+    def process(self,
+                filename: str,
+                destfilename: str,
+                mode: str,
+                owner: str,
+                group: str,
+                ) -> None:
+        for local_dir in LOCAL_DIR:
+            if filename.startswith(local_dir):
+                return
+        if owner not in [None, self.rougailconfig['default_files_owner']]:
+            raise TemplateError(_(f'cannot change owner of file {destfilename}'))
+        if group not in [None, self.rougailconfig['default_files_group']]:
+            raise TemplateError(_(f'cannot change group of file {destfilename}'))
+        if mode not in [None, self.rougailconfig['default_files_mode']]:
+            chmod(destfilename, eval(f'0o{mode}'))
+
+    def post_instance(self):
+        destfilename = join(self.destinations_dir, ROUGAIL_DEST_FILE[1:])
+        makedirs(dirname(destfilename), exist_ok=True)
+        self.log.info(_(f"creole processing: '{destfilename}'"))
+        self.engines['creole'].process(filename=None,
+                                       source=self.rougail_tmpl_template,
+                                       true_destfilename=ROUGAIL_DEST_FILE,
+                                       destfilename=destfilename,
+                                       destdir=self.destinations_dir,
+                                       variable=None,
+                                       index=None,
+                                       rougail_variables_dict=self.rougail_variables_dict,
+                                       eosfunc=self.eosfunc,
+                                       )

src/rougail/tiramisu.py

@@ -36,6 +36,8 @@ class ConvertDynOptionDescription(DynOptionDescription):
     Suffix could also contain invalid character, so we should "normalize" it
     """
     def convert_suffix_to_path(self, suffix):
+        if suffix is None:
+            return suffix
         if not isinstance(suffix, str):
             suffix = str(suffix)
         return normalize_family(suffix)

src/rougail/tiramisureflector.py

@@ -28,15 +28,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 from json import dumps
 from os.path import isfile
 
-from .config import RougailConfig
+from .i18n import _
 from .annotator import CONVERT_OPTION
 from .objspace import RootRougailObject
-
+from .error import DictConsistencyError
-
-class Root():  # pylint: disable=R0903
-    """Root classes
-    """
-    path = '.'
 
 
 class BaseElt:  # pylint: disable=R0903
@@ -52,20 +47,32 @@ class TiramisuReflector:
     """
     def __init__(self,
                  objectspace,
-                 funcs_path,
+                 funcs_paths,
+                 internal_functions,
                  ):
         self.index = 0
         self.text = []
-        if isfile(funcs_path):
+        if funcs_paths:
-            self.text.extend(["from importlib.machinery import SourceFileLoader",
+            self.text.extend(["from importlib.machinery import SourceFileLoader as _SourceFileLoader",
-                              "from importlib.util import spec_from_loader, module_from_spec",
+                              "from importlib.util import spec_from_loader as _spec_from_loader, module_from_spec as _module_from_spec",
-                              f"loader = SourceFileLoader('func', '{funcs_path}')",
+                              "class func:",
-                              "spec = spec_from_loader(loader.name, loader)",
+                              "    pass",
-                              "func = module_from_spec(spec)",
+                              ])
-                              "loader.exec_module(func)",
+            for funcs_path in funcs_paths:
-                              "for key, value in dict(locals()).items():",
+                if not isfile(funcs_path):
-                              "    if key != ['SourceFileLoader', 'func']:",
+                    continue
-                              "        setattr(func, key, value)"])
+                self.text.extend([f"_loader = _SourceFileLoader('func', '{funcs_path}')",
+                                  "_spec = _spec_from_loader(_loader.name, _loader)",
+                                  "_func = _module_from_spec(_spec)",
+                                  "_loader.exec_module(_func)",
+                                  "for function in dir(_func):",
+                                  "    if function.startswith('_'):",
+                                  "        continue",
+                                  "    setattr(func, function, getattr(_func, function))",
+                                  ])
+        if internal_functions:
+            for func in internal_functions:
+                self.text.append(f"setattr(func, '{func}', {func})")
         self.text.extend(["try:",
                           "    from tiramisu3 import *",
                           "except:",
@@ -73,14 +80,17 @@ class TiramisuReflector:
                           ])
         self.objectspace = objectspace
         self.make_tiramisu_objects()
-        if self.objectspace.has_dyn_option == True:
+        if self.objectspace.has_dyn_option is True:
             self.text.append("from rougail.tiramisu import ConvertDynOptionDescription")
 
     def make_tiramisu_objects(self) -> None:
         """make tiramisu objects
         """
+        providers = {}
         baseelt = BaseElt()
         self.set_name(baseelt)
+        dynamic_path = ''
+        dynamic = False
         basefamily = Family(baseelt,
                             self.text,
                             self.objectspace,
@@ -88,7 +98,12 @@ class TiramisuReflector:
         for elt in self.reorder_family():
             self.populate_family(basefamily,
                                  elt,
+                                 providers,
+                                 dynamic,
+                                 dynamic_path,
                                  )
+        basefamily.elt.information = providers
+        basefamily.populate_informations()
         self.baseelt = baseelt
 
     def reorder_family(self):
@@ -96,10 +111,11 @@ class TiramisuReflector:
         because `extra` family could use `variable_namespace` variables.
         """
         if hasattr(self.objectspace.space, 'variables'):
-            if RougailConfig['variable_namespace'] in self.objectspace.space.variables:
+            variable_namespace = self.objectspace.rougailconfig['variable_namespace']
-                yield self.objectspace.space.variables[RougailConfig['variable_namespace']]
+            if variable_namespace in self.objectspace.space.variables:
+                yield self.objectspace.space.variables[variable_namespace]
             for elt, value in self.objectspace.space.variables.items():
-                if elt != RougailConfig['variable_namespace']:
+                if elt != self.objectspace.rougailconfig['variable_namespace']:
                     yield value
         if hasattr(self.objectspace.space, 'services'):
             yield self.objectspace.space.services
@@ -107,6 +123,9 @@ class TiramisuReflector:
     def populate_family(self,
                         parent_family,
                         elt,
+                        providers,
+                        dynamic,
+                        dynamic_path,
                         ):
         """Populate family
         """
@@ -115,11 +134,21 @@ class TiramisuReflector:
                         self.text,
                         self.objectspace,
                         )
+        if not dynamic_path:
+            dynamic_path = elt.name
+        else:
+            dynamic_path = dynamic_path + '.' + elt.name
+        if dynamic or hasattr(elt, 'suffixes'):
+            dynamic_path += '{suffix}'
+            dynamic = True
         parent_family.add(family)
         for children in vars(elt).values():
             if isinstance(children, self.objectspace.family):
                 self.populate_family(family,
                                      children,
+                                     providers,
+                                     dynamic,
+                                     dynamic_path,
                                      )
                 continue
             if isinstance(children, dict):
@@ -131,13 +160,21 @@ class TiramisuReflector:
                         continue
                     if isinstance(child, self.objectspace.variable):
                         self.set_name(child)
+                        sub_dynamic_path = dynamic_path + '.' + child.name
+                        if dynamic:
+                            sub_dynamic_path += '{suffix}'
                         family.add(Variable(child,
                                             self.text,
                                             self.objectspace,
+                                            providers,
+                                            sub_dynamic_path,
                                             ))
                     else:
                         self.populate_family(family,
                                              child,
+                                             providers,
+                                             dynamic,
+                                             dynamic_path,
                                              )
 
     def set_name(self,
@@ -151,7 +188,7 @@ class TiramisuReflector:
     def get_text(self):
         """Get text
         """
-        self.baseelt.reflector_object.get()  # pylint: disable=E1101
+        self.baseelt.reflector_object.get([])  # pylint: disable=E1101
         return '\n'.join(self.text)
 
 
@@ -170,13 +207,25 @@ class Common:
         self.elt.reflector_object = self
         self.object_type = None
 
-    def get(self):
+    def get(self, calls):
         """Get tiramisu's object
         """
+        self_calls = calls.copy()
+        if self.elt.path in self_calls:
+            msg = f'"{self.elt.path}" will make an infinite loop'
+            raise DictConsistencyError(msg, 80, self.elt.xmlfiles)
+        self_calls.append(self.elt.path)
+        self.calls = self_calls
         if self.option_name is None:
             self.option_name = self.elt.reflector_name
             self.populate_attrib()
             self.populate_informations()
+            if hasattr(self.elt, 'provider'):
+                name = 'provider:' + self.elt.provider
+                if name in self.providers:
+                    msg = f'provider {name} declare multiple time'
+                    raise DictConsistencyError(msg, 79, self.elt.xmlfiles)
+                self.providers[name] = self.dynamic_path
         return self.option_name
 
     def populate_attrib(self):
@@ -218,8 +267,8 @@ class Common:
                         ) -> str:
         """Populate properties
         """
-        option_name = child.source.reflector_object.get()
+        option_name = child.source.reflector_object.get(self.calls)
-        kwargs = (f"'condition': ParamOption({option_name}, todict=True), "
+        kwargs = (f"'condition': ParamOption({option_name}, todict=True, notraisepropertyerror=True), "
                   f"'expected': {self.populate_param(child.expected)}")
         if child.inverse:
             kwargs += ", 'reverse_condition': ParamValue(True)"
@@ -231,7 +280,11 @@ class Common:
         """
         if not hasattr(self.elt, 'information'):
             return
-        for key, value in vars(self.elt.information).items():
+        if isinstance(self.elt.information, dict):
+            informations = self.elt.information
+        else:
+            informations = vars(self.elt.information)
+        for key, value in informations.items():
             if key == 'xmlfiles':
                 continue
             if isinstance(value, str):
@@ -243,7 +296,7 @@ class Common:
                        ):
         """Populate variable parameters
         """
-        if param.type in ['number', 'boolean', 'nil', 'string']:
+        if param.type in ['number', 'boolean', 'nil', 'string', 'port', 'choice', 'space']:
             value = param.text
             if param.type == 'string' and value is not None:
                 value = self.convert_str(value)
@@ -251,21 +304,30 @@ class Common:
         if param.type == 'variable':
             return self.build_option_param(param)
         if param.type == 'information':
-            return f'ParamInformation("{param.text}", None)'
+            if hasattr(self.elt, 'multi') and self.elt.multi:
+                default = []
+            else:
+                default = None
+            return f'ParamInformation("{param.text}", {default})'
+        if param.type == 'target_information':
+            return f'ParamSelfInformation("{param.text}", None)'
         if param.type == 'suffix':
             return 'ParamSuffix()'
-        raise Exception(f'unknown type {param.type}')  # pragma: no cover
+        if param.type == 'index':
+            return 'ParamIndex()'
+        raise Exception(_(f'unknown type {param.type}'))  # pragma: no cover
 
-    @staticmethod
+    def build_option_param(self,
-    def build_option_param(param,
+                           param,
                            ) -> str:
         """build variable parameters
         """
-        option_name = param.text.reflector_object.get()
+        option_name = param.text.reflector_object.get(self.calls)
         params = [f'{option_name}']
         if hasattr(param, 'suffix'):
             param_type = 'ParamDynOption'
-            params.extend([f"'{param.suffix}'", f'{param.family.reflector_name}'])
+            family = param.family.reflector_object.get(self.calls)
+            params.extend([f"'{param.suffix}'", f'{family}'])
         else:
             param_type = 'ParamOption'
         if not param.propertyerror:
@@ -280,7 +342,11 @@ class Variable(Common):
                  elt,
                  text,
                  objectspace,
+                 providers,
+                 dynamic_path,
                  ):
+        self.providers = providers
+        self.dynamic_path = dynamic_path
         super().__init__(elt, text, objectspace)
         self.object_type = CONVERT_OPTION[elt.type]['opttype']
 
@@ -288,12 +354,14 @@ class Variable(Common):
                          keys: dict,
                          ):
         if hasattr(self.elt, 'opt'):
-            keys['opt'] = self.elt.opt.reflector_object.get()
+            keys['opt'] = self.elt.opt.reflector_object.get(self.calls)
-        if hasattr(self.elt, 'values'):
+        if hasattr(self.elt, 'choice'):
-            values = self.elt.values
+            values = self.elt.choice
-            if values[0].type == 'calculation':
+            if values[0].type == 'variable':
-                value = values[0].name.reflector_object.get()
+                value = values[0].name.reflector_object.get(self.calls)
                 keys['values'] = f"Calculation(func.calc_value, Params((ParamOption({value}))))"
+            elif values[0].type == 'function':
+                keys['values'] = self.calculation_value(values[0], [])
             else:
                 keys['values'] = str(tuple([val.name for val in values]))
         if hasattr(self.elt, 'multi') and self.elt.multi:
@@ -304,11 +372,11 @@ class Variable(Common):
                 if isinstance(value, str):
                     value = self.convert_str(value)
                 elif isinstance(value, self.objectspace.value):
-                    value = self.calculation_value(value, [])
+                    value = self.calculation_value(value, [], calc_multi=value.calc_multi)
                 keys[key] = value
         if hasattr(self.elt, 'validators'):
             keys['validators'] = '[' + ', '.join([self.calculation_value(val,
-                                    ['ParamSelfOption()']) for val in self.elt.validators]) + ']'
+                                    ['ParamSelfOption(whole=False)']) for val in self.elt.validators]) + ']'
         for key in ['min_number', 'max_number']:
             if hasattr(self.elt, key):
                 keys[key] = getattr(self.elt, key)
@@ -320,26 +388,36 @@ class Variable(Common):
     def calculation_value(self,
                           child,
                           args,
+                          calc_multi=False,
                           ) -> str:
         """Generate calculated value
         """
         kwargs = []
         # has parameters
         function = child.name
+        new_args = []
         if hasattr(child, 'param'):
             for param in child.param:
                 value = self.populate_param(param)
                 if not hasattr(param, 'name'):
-                    args.append(str(value))
+                    new_args.append(str(value))
                 else:
                     kwargs.append(f"'{param.name}': " + value)
-        ret = f'Calculation(func.{function}, Params((' + ', '.join(args) + ')'
+        if function == 'valid_network_netmask':
+            new_args.extend(args)
+        else:
+            args.extend(new_args)
+            new_args = args
+        ret = f'Calculation(func.{function}, Params((' + ', '.join(new_args) + ')'
         if kwargs:
             ret += ', kwargs={' + ', '.join(kwargs) + '}'
         ret += ')'
         if hasattr(child, 'warnings_only'):
             ret += f', warnings_only={child.warnings_only}'
-        return ret + ')'
+        ret = ret + ')'
+        if calc_multi:
+            ret = '[' + ret + ']'
+        return ret
 
 
 class Family(Common):
@@ -354,7 +432,7 @@ class Family(Common):
         if hasattr(self.elt, 'suffixes'):
             self.objectspace.has_dyn_option = True
             self.object_type = 'ConvertDynOptionDescription'
-        elif isinstance(self.elt, self.objectspace.leadership):
+        elif hasattr(self.elt, 'leadership') and self.elt.leadership:
             self.object_type = 'Leadership'
         else:
             self.object_type = 'OptionDescription'
@@ -369,6 +447,6 @@ class Family(Common):
                          keys: list,
                          ) -> None:
         if hasattr(self.elt, 'suffixes'):
-            dyn = self.elt.suffixes.reflector_object.get()
+            dyn = self.elt.suffixes.reflector_object.get(self.calls)
-            keys['suffixes'] = f"Calculation(func.calc_value, Params((ParamOption({dyn}))))"
+            keys['suffixes'] = f"Calculation(func.calc_value, Params((ParamOption({dyn}, notraisepropertyerror=True))))"
-        keys['children'] = '[' + ', '.join([child.get() for child in self.children]) + ']'
+        keys['children'] = '[' + ', '.join([child.get(self.calls) for child in self.children]) + ']'

src/rougail/update.py

@@ -0,0 +1,761 @@
+"""Update Rougail XML file to new version
+
+Cadoles (http://www.cadoles.com)
+Copyright (C) 2021
+
+distribued with GPL-2 or later license
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+"""
+
+from typing import List
+from os.path import join, isfile, basename
+from os import listdir
+from lxml.etree import DTD, parse, XMLParser, XMLSyntaxError  # pylint: disable=E0611
+from lxml.etree import Element, SubElement, tostring
+from ast import parse as ast_parse
+
+from .i18n import _
+from .error import UpgradeError
+
+from .utils import normalize_family
+from .config import RougailConfig
+
+
+VERSIONS = {'creole': ['1'],
+            'rougail': ['0.9', '0.10'],
+            }
+
+
+def get_function_name(root, version):
+    version = version.replace('.', '_')
+    return f'update_{root}_{version}'
+
+
+FUNCTION_VERSIONS = [(root, version, get_function_name(root, version)) for root, versions in VERSIONS.items() for version in versions]
+
+
+class RougailUpgrade:
+    def __init__(self,
+                 test=False,
+                 upgrade_help=None,
+                 rougailconfig: RougailConfig=None,
+                 ) -> None:
+        self.test = test
+        if upgrade_help is None:
+            upgrade_help = {}
+        self.upgrade_help = upgrade_help
+        if rougailconfig is None:
+            rougailconfig = RougailConfig
+        self.rougailconfig = rougailconfig
+
+    def load_xml_from_folders(self,
+                              srcfolder: str,
+                              dstfolder: str,
+                              namespace: str,
+                              display: bool=True,
+                              ):
+        """Loads all the XML files located in the xmlfolders' list
+
+        :param xmlfolders: list of full folder's name
+        """
+        filenames = [filename for filename in listdir(srcfolder) if filename.endswith('.xml')]
+        filenames.sort()
+        for filename in filenames:
+            xmlsrc = join(srcfolder, filename)
+            xmldst = join(dstfolder, filename)
+            if isfile(xmldst):
+                raise Exception(f'cannot update "{xmlsrc}" destination file "{xmldst}" already exists')
+            try:
+                parser = XMLParser(remove_blank_text=True)
+                document = parse(xmlsrc, parser)
+            except XMLSyntaxError as err:
+                raise Exception(_(f'not a XML file: {err}')) from err
+            root = document.getroot()
+            search_function_name = get_function_name(root.tag, root.attrib.get('version', '1'))
+            function_found = False
+            for root_name, version, function_version in FUNCTION_VERSIONS:
+                if function_found and hasattr(self, function_version):
+                    if display:
+                        print(f'  - convert {filename} to version {version}')
+                    upgrade_help = self.upgrade_help.get(function_version, {}).get(filename, {})
+                    if upgrade_help.get('remove') is True:
+                        continue
+                    root = getattr(self, function_version)(root, upgrade_help, namespace)
+                if function_version == search_function_name:
+                    function_found = True
+                root.attrib['version'] = version
+            with open(xmldst, 'wb') as xmlfh:
+                xmlfh.write(tostring(root, pretty_print=True, encoding="UTF-8", xml_declaration=True))
+    #            if
+    #            if not self.dtd.validate(document):
+    #                dtd_error = self.dtd.error_log.filter_from_errors()[0]
+    #                msg = _(f'not a valid XML file: {dtd_error}')
+    #                raise DictConsistencyError(msg, 43, [xmlfile])
+    #            yield xmlfile, document.getroot()
+
+
+    def update_rougail_0_10(self,
+                           root: 'Element',
+                           upgrade_help: dict,
+                           namespace: str,
+                           ) -> 'Element':
+        variables = root.find('variables')
+        if variables is None:
+            return root
+        paths = self._get_path_variables(variables,
+                                         namespace == 'configuration',
+                                         namespace,
+                                         )
+        constraints = root.find('constraints')
+        # convert schedule and schedulemod
+        for variable in paths.values():
+            variable = variable['variable']
+            if variable.tag != 'variable':
+                continue
+            if 'type' in variable.attrib and variable.attrib['type'] in ['schedule', 'schedulemod']:
+                if variable.attrib['type'] == 'schedule':
+                    choices = ('none', 'daily', 'weekly', 'monthly')
+                else:
+                    choices = ('pre', 'post')
+                variable.attrib['type'] = 'choice'
+                has_value = False
+                for value in variable:
+                    if value.tag == 'value':
+                        has_value = True
+                        break
+                for name in choices:
+                    choice = SubElement(variable, 'choice')
+                    choice.text = name
+                if not has_value:
+                    value = SubElement(variable, 'value')
+                    value.text = choices[0]
+                variable.attrib['mandatory'] = 'True'
+
+        # convert group to leadership
+        groups = []
+        if constraints is not None:
+            for constraint in constraints:
+                if constraint.tag == 'group':
+                    constraints.remove(constraint)
+                    groups.append(constraint)
+        for group in groups:
+            if group.attrib['leader'] in paths:
+                leader_obj = paths[group.attrib['leader']]
+                #FIXME name peut avoir "." il faut le virer
+                #FIXME si extra c'est un follower !
+                if 'name' in group.attrib:
+                    grpname = group.attrib['name']
+                    if 'description' in group.attrib:
+                        description = group.attrib['description']
+                    else:
+                        description = grpname
+                else:
+                    grpname = leader_obj['variable'].attrib['name']
+                    if '.' in grpname:
+                        grpname = grpname.rsplit('.', 1)[-1]
+                    if 'description' in group.attrib:
+                        description = group.attrib['description']
+                    elif 'description' in leader_obj['variable'].attrib:
+                        description = leader_obj['variable'].attrib['description']
+                    else:
+                        description = grpname
+                family = SubElement(leader_obj['parent'], 'family', name=grpname, description=description, leadership="True")
+                leader_obj['parent'].remove(leader_obj['variable'])
+                family.append(leader_obj['variable'])
+            else:
+                # append in group
+                follower = next(iter(group))
+                leader_name = group.attrib['leader']
+                if '.' in leader_name:
+                    leader_path = leader_name.rsplit('.', 1)[0]
+                    follower_path = leader_path + '.' + follower.text
+                else:
+                    follower_path = follower.text
+                obj = paths[follower_path]
+                family = SubElement(obj['parent'], 'family', name=leader_name, leadership="True")
+                grpname = leader_name
+            for follower in group:
+                leader_name = group.attrib['leader']
+                if '.' in leader_name:
+                    leader_path = leader_name.rsplit('.', 1)[0]
+                    follower_path = leader_path + '.' + follower.text
+                else:
+                    follower_path = follower.text
+                follower_obj = paths[follower_path]
+                follower_obj['parent'].remove(follower_obj['variable'])
+                family.append(follower_obj['variable'])
+                if '.' in follower_path:
+                    new_path = follower_path.rsplit('.', 1)[0] + '.' + grpname + '.' + follower_path.rsplit('.', 1)[1]
+                    paths[new_path] = paths[follower_path]
+
+        # convert choice option
+        valid_enums = []
+        if constraints is not None:
+            for constraint in constraints:
+                if constraint.tag == 'check' and constraint.attrib['name'] == 'valid_enum':
+                    constraints.remove(constraint)
+                    valid_enums.append(constraint)
+        for valid_enum in valid_enums:
+            targets = []
+            for target in valid_enum:
+                if target.tag != 'target':
+                    continue
+                if target.text in paths:
+                    # not in paths if it's optional
+                    # but not check it
+                    targets.append(paths[target.text]['variable'])
+            params = []
+            function_param = None
+            for param in valid_enum:
+                if param.tag != 'param':
+                    continue
+                if 'type' in param.attrib and param.attrib['type'] == 'function':
+                    function_param = param.text
+                    continue
+                params.append(param)
+            first_choice = None
+            for target in targets:
+                if function_param is not None:
+                    function = SubElement(target, 'choice', type='function', name=function_param)
+                for param in params:
+                    if function_param is not None:
+                        function.append(param)
+                    else:
+                        choice = SubElement(target, 'choice')
+                        if first_choice is None and ('type' not in param.attrib or param.attrib['type'] != 'variable'):
+                            first_choice = choice
+                        choice.text = param.text
+                        if 'type' not in param.attrib and param.text is None:
+                            choice_type = 'nil'
+                        elif 'type' in param.attrib:
+                            choice_type = param.attrib['type']
+                        elif 'type' in target.attrib:
+                            choice_type = target.attrib['type']
+                        else:
+                            choice_type = 'string'
+                        choice.attrib['type'] = choice_type
+            has_value = False
+            for target in targets:
+                if 'remove_check' in target.attrib:
+                    target.attrib['remove_choice'] = target.attrib['remove_check']
+            for target in targets:
+                for value in target:
+                    if value.tag == 'value':
+                        has_value = True
+                        if 'type' in target.attrib:
+                            value.attrib['type'] = target.attrib['type']
+            if first_choice is not None and not has_value:
+                value = SubElement(target, 'value')
+                value.attrib['type'] = first_choice.attrib['type']
+                value.text = first_choice.text
+            for target in targets:
+                if 'remove_choice' not in target.attrib or target.attrib['remove_choice'] != 'True':
+                    target.attrib['type'] = 'choice'
+        return root
+
+    def _get_path_variables(self, variables, is_variable_namespace, path, dico=None):
+        if dico is None:
+            dico = {}
+        for variable in variables:
+            if not is_variable_namespace and path:
+                subpath = path + '.'
+            else:
+                subpath = ''
+            if variable.tag not in ['variable', 'family']:
+                continue
+            subpath += variable.attrib['name']
+            if variable.tag == 'family':
+                self._get_path_variables(variable, is_variable_namespace, subpath, dico)
+            elif variable.tag == 'variable':
+                dico[subpath] = {'variable': variable, 'parent': variables}
+        return dico
+
+    def update_rougail_0_9(self,
+                           root: 'Element',
+                           upgrade_help: dict,
+                           namespace: str,
+                           ) -> 'Element':
+        # rename root
+        root.tag = 'rougail'
+        variables_auto_valid_enum = {}
+        variables_help = {}
+        families_help = {}
+        variables = {}
+        families = {}
+        valid_enums = {}
+        current_service = upgrade_help.get('services', {}).get('default', 'unknown')
+        files = {current_service: {}}
+        ips = {current_service: []}
+        servicelists = {}
+        test_unknowns_variables = set()
+        autos = []
+        constraints_obj = None
+        for subelement in root:
+            if not isinstance(subelement.tag, str):
+                # XML comment
+                continue
+            if subelement.tag == 'family_action':
+                root.remove(subelement)
+                continue
+            for subsubelement in subelement:
+                if not isinstance(subsubelement.tag, str):
+                    # XML comment
+                    continue
+                for subsubsubelement in subsubelement:
+                    if not isinstance(subsubsubelement.tag, str):
+                        # XML comment
+                        continue
+                    if subsubsubelement.tag == 'variable':
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('remove', []):
+                            subsubelement.remove(subsubsubelement)
+                            continue
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('type', {}):
+                            subsubsubelement.attrib['type'] = upgrade_help['variables']['type'][subsubsubelement.attrib['name']]
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('hidden', {}).get('add', []):
+                            subsubsubelement.attrib['hidden'] = 'True'
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('hidden', {}).get('remove', []):
+                            self.remove(subsubsubelement, 'hidden', optional=True)
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('mandatory', {}).get('remove', []):
+                            self.remove(subsubsubelement, 'mandatory')
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('mandatory', {}).get('add', []):
+                            subsubsubelement.attrib['mandatory'] = 'True'
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('type', {}):
+                            subsubsubelement.attrib['type'] = upgrade_help.get('variables', {}).get('type', {})[subsubsubelement.attrib['name']]
+                        if namespace == 'configuration':
+                            path = subsubsubelement.attrib['name']
+                            npath = normalize_family(subsubsubelement.attrib['name'])
+                        else:
+                            path = namespace + '.' + subsubelement.attrib['name'] + '.' + subsubsubelement.attrib['name']
+                            npath = normalize_family(namespace) + '.' + normalize_family(subsubelement.attrib['name']) + '.' + normalize_family(subsubsubelement.attrib['name'])
+                        variables[path] = subsubsubelement
+                        variables[npath] = subsubsubelement
+                        type = subsubsubelement.attrib.get('type')
+                        if type in ['oui/non', 'yes/no', 'on/off']:
+                            variables_auto_valid_enum.setdefault(subsubsubelement.attrib['type'], []).append(path)
+                            del subsubsubelement.attrib['type']
+                        elif type == 'hostname_strict':
+                            subsubsubelement.attrib['type'] = 'hostname'
+                        elif type in ['domain', 'domain_strict']:
+                            subsubsubelement.attrib['type'] = 'domainname'
+                        elif type == 'string':
+                            del subsubsubelement.attrib['type']
+                        if self.test and subsubsubelement.attrib.get('auto_freeze') == 'True':
+                            del subsubsubelement.attrib['auto_freeze']
+                        #if self.test and subsubsubelement.attrib.get('redefine') == 'True':
+                        #    subsubsubelement.attrib['exists'] = 'False'
+                        #    del subsubsubelement.attrib['redefine']
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('redefine', {}).get('remove', {}):
+                            del subsubsubelement.attrib['redefine']
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('remove_check', []):
+                            subsubsubelement.attrib['remove_check'] = 'True'
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('mode', {}).get('modify', {}):
+                            subsubsubelement.attrib['mode'] = upgrade_help.get('variables', {}).get('mode', {}).get('modify', {})[subsubsubelement.attrib['name']]
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('type', {}).get('modify', {}):
+                            subsubsubelement.attrib['type'] = upgrade_help.get('variables', {}).get('type', {}).get('modify', {})[subsubsubelement.attrib['name']]
+                            type = subsubsubelement.attrib['type']
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('test', {}):
+                            subsubsubelement.attrib['test'] = upgrade_help.get('variables', {}).get('test', {})[subsubsubelement.attrib['name']]
+                        if subsubsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('remove_value', []):
+                            for value in subsubsubelement:
+                                subsubsubelement.remove(value)
+                        if subsubsubelement.attrib['name'] != normalize_family(subsubsubelement.attrib['name']):
+                            if "description" not in subsubsubelement.attrib:
+                                subsubsubelement.attrib['description'] = subsubsubelement.attrib['name']
+                            subsubsubelement.attrib['name'] = normalize_family(subsubsubelement.attrib['name'])
+                    elif subsubsubelement.tag == 'param':
+                        if subsubelement.tag == 'check' and subsubelement.attrib['target'] in upgrade_help.get('check', {}).get('remove', []):
+                            continue
+                        type = subsubsubelement.attrib.get('type')
+                        if type == 'eole':
+                            subsubsubelement.attrib['type'] = 'variable'
+                            type = 'variable'
+                        if type == 'python':
+                            subsubsubelement.attrib['type'] = 'function'
+                            if subsubsubelement.text.startswith('range('):
+                                func_ast = ast_parse(subsubsubelement.text)
+                                subsubsubelement.text = 'range'
+                                for arg in func_ast.body[0].value.args:
+                                    SubElement(subsubelement, 'param', type='number').text = str(arg.value)
+                            else:
+                                raise Exception(f'{subsubsubelement.text} is not a supported function')
+                            type = 'function'
+                        elif type in ('container', 'context'):
+                            raise UpgradeError(_(f'cannot convert param with type "{type}"'))
+                        if subsubelement.attrib['name'] == 'valid_entier' and not 'type' in subsubsubelement.attrib:
+                            subsubsubelement.attrib['type'] = 'number'
+                        if (not type or type == 'variable') and subsubsubelement.text in upgrade_help.get('variables', {}).get('remove', []):
+                            subsubelement.remove(subsubsubelement)
+                            continue
+                        if subsubelement.attrib['name'] == 'valid_enum' and not type:
+                            if subsubsubelement.attrib.get('name') == 'checkval':
+                                if subsubelement.attrib['target'] in upgrade_help.get('check', {}).get('valid_enums', {}).get('checkval', {}).get('remove', []):
+                                    subsubelement.remove(subsubsubelement)
+                                    continue
+                                raise UpgradeError(_('checkval in valid_enum is no more supported'))
+                            if subsubsubelement.text.startswith('['):
+                                for val in eval(subsubsubelement.text):
+                                    SubElement(subsubelement, 'param').text = str(val)
+                                subsubelement.remove(subsubsubelement)
+                        self.move(subsubsubelement, 'hidden', 'propertyerror', optional=True)
+                        if type == 'variable' and subsubsubelement.text in upgrade_help.get('variables', {}).get('rename', []):
+                            subsubsubelement.text = upgrade_help.get('variables', {}).get('rename', [])[subsubsubelement.text]
+                        up = upgrade_help.get('params', {}).get(subsubsubelement.text)
+                        if up:
+                            if 'text' in up:
+                                subsubsubelement.text = up['text']
+                            if 'type' in up:
+                                subsubsubelement.attrib['type'] = up['type']
+                    elif subsubsubelement.tag == 'target':
+                        type = subsubsubelement.attrib.get('type')
+                        if type in ['service_accesslist', 'service_restrictionlist', 'interfacelist', 'hostlist']:
+                            subsubelement.remove(subsubsubelement)
+                        elif (not type or type == 'variable') and subsubsubelement.text in upgrade_help.get('variables', {}).get('remove', []):
+                            subsubelement.remove(subsubsubelement)
+                        elif type == 'family' and subsubsubelement.text in upgrade_help.get('families', {}).get('remove', []):
+                            subsubelement.remove(subsubsubelement)
+                        elif type == 'actionlist':
+#                            for family in root.find('variables'):
+#                                family_list = SubElement(subsubelement, 'target')
+#                                family_list.attrib['type'] = 'family'
+#                                family_list.text = namespace + '.' + family.attrib['name']
+                            subsubelement.remove(subsubsubelement)
+                        if upgrade_help.get('targets', {}).get(subsubsubelement.text, {}).get('optional'):
+                            subsubsubelement.attrib['optional'] = upgrade_help.get('targets', {}).get(subsubsubelement.text, {}).get('optional')
+                        has_target = False
+                        for target in subsubelement:
+                            if target.tag == 'target':
+                                has_target = True
+                                break
+                        if not has_target:
+                            subelement.remove(subsubelement)
+                        continue
+                    elif subsubsubelement.tag == 'slave':
+                        if subsubsubelement.text in upgrade_help.get('variables', {}).get('remove', []):
+                            subsubelement.remove(subsubsubelement)
+                            continue
+                        subsubsubelement.tag = 'follower'
+                        subsubsubelement.text = normalize_family(subsubsubelement.text)
+                    if subelement.tag == 'containers':
+                        current_service = self.upgrade_container(subsubsubelement, current_service, files, ips, servicelists, upgrade_help)
+                        subsubelement.remove(subsubsubelement)
+                if subelement.tag == 'help':
+                    if subsubelement.tag == 'variable':
+                        if not subsubelement.attrib['name'] in upgrade_help.get('variables', {}).get('remove', []):
+                            variables_help[subsubelement.attrib['name']] = subsubelement.text
+                    elif subsubelement.tag == 'family':
+                        if subsubelement.attrib['name'] not in upgrade_help.get('families', {}).get('remove', []):
+                            families_help[subsubelement.attrib['name']] = subsubelement.text
+                    else:
+                        raise Exception(f'unknown help tag {subsubelement.tag}')
+                    subelement.remove(subsubelement)
+                    continue
+                if subsubelement.tag == 'auto':
+                    if subsubelement.attrib['target'] in upgrade_help.get('variables', {}).get('remove', []):
+                        subelement.remove(subsubelement)
+                        continue
+                    autos.append(subsubelement.attrib['target'])
+                    subsubelement.tag = 'fill'
+                if subsubelement.tag in ['fill', 'check']:
+                    if subsubelement.tag == 'check' and subsubelement.attrib['name'] == 'valid_enum':
+                        if subsubelement.attrib['target'] in upgrade_help.get('variables', {}).get('remove', []):
+                            subelement.remove(subsubelement)
+                            continue
+                        params = []
+                        for param in subsubelement:
+                            if param.tag == 'param':
+                                params.append(param.text)
+                        key = '~'.join(params)
+                        if key in valid_enums:
+                            SubElement(valid_enums[key], 'target').text = subsubelement.attrib['target']
+                            subelement.remove(subsubelement)
+                            continue
+                        valid_enums['~'.join(params)] = subsubelement
+                    if subsubelement.tag == 'fill' and subsubelement.attrib['target'] in upgrade_help.get('fills', {}).get('remove', []):
+                        subelement.remove(subsubelement)
+                        continue
+                    if subsubelement.tag == 'check' and subsubelement.attrib['target'] in upgrade_help.get('check', {}).get('remove', []):
+                        subelement.remove(subsubelement)
+                        continue
+                    if subsubelement.attrib['target'] in upgrade_help.get('variables', {}).get('remove', []):
+                        subelement.remove(subsubelement)
+                        continue
+                    if subsubelement.attrib['name'] == 'valid_networknetmask':
+                        subsubelement.attrib['name'] = 'valid_network_netmask'
+                    target = SubElement(subsubelement, 'target')
+                    target.text = subsubelement.attrib['target']
+                    if self.test:
+                        target.attrib['optional'] = 'True'
+                    del subsubelement.attrib['target']
+                elif subsubelement.tag == 'separators':
+                    subelement.remove(subsubelement)
+                elif subsubelement.tag == 'condition':
+                    if subsubelement.attrib['source'] in upgrade_help.get('variables', {}).get('remove', []):
+                        try:
+                            subelement.remove(subsubelement)
+                        except:
+                            pass
+                    else:
+                        if subsubelement.attrib['name'] == 'hidden_if_not_in':
+                            subsubelement.attrib['name'] = 'disabled_if_not_in'
+                        if subsubelement.attrib['name'] == 'hidden_if_in':
+                            subsubelement.attrib['name'] = 'disabled_if_in'
+                        if subsubelement.attrib['name'] == 'frozen_if_in':
+                            subsubelement.attrib['name'] = 'hidden_if_in'
+                        self.move(subsubelement, 'fallback', 'optional', optional='True')
+                    if subsubelement.attrib['source'] in upgrade_help.get('variables', {}).get('rename', []):
+                        subsubelement.attrib['source'] = upgrade_help.get('variables', {}).get('rename', [])[subsubelement.attrib['source']]
+                elif subsubelement.tag == 'group':
+                    if subsubelement.attrib['master'] in upgrade_help.get('groups', {}).get('remove', []):
+                        subelement.remove(subsubelement)
+                    else:
+                        self.move(subsubelement, 'master', 'leader')
+                        for follower in subsubelement:
+                            if '.' in subsubelement.attrib['leader']:
+                                path = subsubelement.attrib['leader'].rsplit('.', 1)[0] + '.' + follower.text
+                            else:
+                                path = follower.text
+                            self.remove(variables[path], 'multi', optional=True)
+                        if subsubelement.attrib['leader'] in upgrade_help.get('groups', {}).get('reorder', {}):
+                            for follower in subsubelement:
+                                subsubelement.remove(follower)
+                            for follower in upgrade_help.get('groups', {}).get('reorder', {})[subsubelement.attrib['leader']]:
+                                SubElement(subsubelement, 'follower').text = follower
+                if subelement.tag == 'files':
+                    current_service = self.upgrade_container(subsubelement, current_service, files, ips, servicelists, upgrade_help)
+                    subelement.remove(subsubelement)
+                if subsubelement.tag == 'family':
+                    self.remove(subsubelement, 'icon', optional=True)
+                    if subsubelement.attrib['name'] in upgrade_help.get('families', {}).get('mode', {}).get('remove', []) and 'mode' in subsubelement.attrib:
+                        del subsubelement.attrib['mode']
+                    if subsubelement.attrib['name'] in upgrade_help.get('families', {}).get('rename', {}):
+                        subsubelement.attrib['name'] = upgrade_help.get('families', {}).get('rename', {})[subsubelement.attrib['name']]
+                    if subsubelement.attrib['name'] in upgrade_help.get('families', {}).get('remove', []):
+                        subelement.remove(subsubelement)
+                        continue
+                    if subsubelement.attrib['name'] in upgrade_help.get('families', {}).get('hidden', {}).get('add', []):
+                        subsubelement.attrib['hidden'] = 'True'
+                    if subsubelement.attrib['name'] != normalize_family(subsubelement.attrib['name']):
+                        if "description" not in subsubelement.attrib:
+                            subsubelement.attrib['description'] = subsubelement.attrib['name']
+                        subsubelement.attrib['name'] = normalize_family(subsubelement.attrib['name'])
+                    families[subsubelement.attrib['name']] = subsubelement
+            # if empty, remove
+            if is_empty(subelement) or subelement.tag in ['containers', 'files', 'help']:
+                root.remove(subelement)
+                continue
+            # copy subelement
+            if subelement.tag == 'constraints':
+                constraints_obj = subelement
+        services = None
+        service_elt = {}
+        for variable, obj in upgrade_help.get('variables', {}).get('add', {}).items():
+            family = next(iter(families.values()))
+            variables[variable] = SubElement(family, 'variable', name=variable)
+            if 'value' in obj:
+                SubElement(variables[variable], 'value').text = obj['value']
+            for name in ['hidden', 'exists']:
+                if name in obj:
+                    variables[variable].attrib[name] = obj[name]
+        files_is_empty = True
+        for lst in files.values():
+            if len(lst):
+                files_is_empty = False
+                break
+        if not files_is_empty:
+            services = Element('services')
+            root.insert(0, services)
+            for service_name, lst in files.items():
+                service = self.create_service(services, service_name, service_elt, servicelists, upgrade_help)
+                for file_ in lst.values():
+                    self.move(file_, 'name_type', 'file_type', optional=True)
+                    if 'file_type' in file_.attrib and file_.attrib['file_type'] == 'SymLinkOption':
+                        file_.attrib['file_type'] = 'variable'
+                        if variables[file_.text].attrib['type'] == 'string':
+                            variables[file_.text].attrib['type'] = 'filename'
+                    self.remove(file_, 'rm', optional=True)
+                    self.remove(file_, 'mkdir', optional=True)
+                    service.append(file_)
+        ips_is_empty = True
+        for lst in ips.values():
+            if len(lst):
+                ips_is_empty = False
+                break
+        if not ips_is_empty:
+            if services is None:
+                services = Element('services')
+                root.insert(0, services)
+            for service_name, lst in ips.items():
+                service = self.create_service(services, service_name, service_elt, servicelists, upgrade_help)
+                for ip in lst:
+                    if ip.text in upgrade_help.get('ips', {}).get('remove', []):
+                        continue
+                    for type in ['ip_type', 'netmask_type']:
+                        if type in ip.attrib and ip.attrib[type] == 'SymLinkOption':
+                            ip.attrib[type] = 'variable'
+                    if 'netmask' in ip.attrib:
+                        if ip.attrib['netmask'] == '255.255.255.255':
+                            del ip.attrib['netmask']
+                            if ip.text in variables and 'type' not in variables[ip.text].attrib:
+                                variables[ip.text].attrib['type'] = 'ip'
+                        else:
+                            if ip.text in variables and 'type' not in variables[ip.text].attrib:
+                                variables[ip.text].attrib['type'] = 'network'
+                            if ip.attrib['netmask'] in variables and 'type' not in variables[ip.attrib['netmask']].attrib:
+                                variables[ip.attrib['netmask']].attrib['type'] = 'netmask'
+                    elif ip.text in variables and 'type' not in variables[ip.text].attrib:
+                        variables[ip.text].attrib['type'] = 'ip'
+                    self.remove(ip, 'interface')
+                    self.remove(ip, 'interface_type', optional=True)
+                    self.remove(ip, 'service_restrictionlist', optional=True)
+                    service.append(ip)
+        if ips_is_empty and files_is_empty:
+            for service_name in files:
+                if services is None:
+                    services = Element('services')
+                    root.insert(0, services)
+                if service_name != 'unknown':
+                    self.create_service(services, service_name, service_elt, servicelists, upgrade_help)
+        if constraints_obj is None:
+            constraints_obj = SubElement(root, 'constraints')
+        if variables_auto_valid_enum:
+            for type, variables_valid_enum in variables_auto_valid_enum.items():
+                valid_enum = SubElement(constraints_obj, 'check')
+                valid_enum.attrib['name'] = 'valid_enum'
+                for val in type.split('/'):
+                    param = SubElement(valid_enum, 'param')
+                    param.text = val
+                for variable in variables_valid_enum:
+                    target = SubElement(valid_enum, 'target')
+                    target.text = variable
+        for name, text in variables_help.items():
+            variables[name].attrib['help'] = text
+        for name, text in families_help.items():
+            if name in upgrade_help.get('families', {}).get('rename', {}):
+                name = upgrade_help.get('families', {}).get('rename', {})[name]
+            families[normalize_family(name)].attrib['help'] = text
+        for auto in autos:
+            if auto in variables:
+                variables[auto].attrib['hidden'] = 'True'
+            else:
+                # redefine value in first family
+                family = next(iter(families.values()))
+                variable = SubElement(family, 'variable', name=auto, redefine="True", hidden="True")
+                if self.test:
+                    del variable.attrib['redefine']
+        return root
+
+    @staticmethod
+    def move(elt, src, dst, optional=False):
+        if src == 'text':
+            value = elt.text
+            elt.text = None
+        else:
+            if optional and src not in elt.attrib:
+                return
+            value = elt.attrib[src]
+            del elt.attrib[src]
+        #
+        if dst == 'text':
+            elt.text = value
+        else:
+            elt.attrib[dst] = value
+
+    @staticmethod
+    def remove(elt, src, optional=False):
+        if optional and src not in elt.attrib:
+            return
+        del elt.attrib[src]
+
+    @staticmethod
+    def create_service(services, service_name, service_elt, servicelists, upgrade_help):
+        if service_name in service_elt:
+            return service_elt[service_name]
+        service = SubElement(services, 'service')
+        service.attrib['name'] = service_name
+        if service_name == 'unknown':
+            service.attrib['manage'] = 'False'
+        if service_name in upgrade_help.get('services', {}).get('unmanage', []):
+            service.attrib['manage'] = 'False'
+        service_elt[service_name] = service
+        if upgrade_help.get('servicelists', {}).get(service_name):
+            service.attrib['servicelist'] = upgrade_help.get('servicelists', {}).get(service_name)
+        elif service_name in servicelists:
+            service.attrib['servicelist'] = servicelists[service_name]
+        return service
+
+    def upgrade_container(self, elt, current_service, files, ips, servicelists, upgrade_help):
+        if elt.tag == 'file':
+            self.move(elt, 'name', 'text')
+            self.remove(elt, 'del_comment', optional=True)
+            elt.attrib['engine'] = 'creole_legacy'
+            if (not 'instance_mode' in elt.attrib or elt.attrib['instance_mode'] != 'when_container') and \
+                    elt.text not in upgrade_help.get('files', {}).get('remove', {}):
+                if elt.attrib.get('filelist') in upgrade_help.get('services', {}).get('filelist_service', {}):
+                    elt_service = upgrade_help.get('services', {}).get('filelist_service', {})[elt.attrib['filelist']]
+                    if elt_service in files:
+                        service = elt_service
+                    else:
+                        service = current_service
+                else:
+                    service = current_service
+                files[service][elt.text] = elt
+        elif elt.tag in ['host', 'disknod', 'fstab', 'interface', 'package', 'service_access']:
+            pass
+        elif elt.tag == 'service_restriction':
+            for restriction in elt:
+                if restriction.tag == 'ip' and restriction.text != '0.0.0.0':
+                    self.remove(restriction, 'ip_type', optional=True)
+                    self.remove(restriction, 'netmask_type', optional=True)
+                    if elt.attrib['service'] in upgrade_help.get('services', {}).get('rename', {}):
+                        elt_service = upgrade_help.get('services', {}).get('rename', {})[elt.attrib['service']]
+                    else:
+                        elt_service = elt.attrib['service']
+                    if elt_service in ips:
+                        service = elt_service
+                    else:
+                        service = current_service
+                    ips[service].append(restriction)
+        elif elt.tag == 'service':
+            new_name = elt.text
+            if current_service == 'unknown':
+                if new_name in files:
+                    raise Exception('hu?')
+                files[new_name] = files[current_service]
+                del files[current_service]
+                ips[new_name] = ips[current_service]
+                del ips[current_service]
+            elif new_name not in files:
+                files[new_name] = {}
+                ips[new_name] = []
+            current_service = new_name
+            if 'servicelist' in elt.attrib:
+                servicelists[current_service] = elt.attrib['servicelist']
+        else:
+            raise Exception(f'unknown containers tag {elt.tag}')
+        return current_service
+
+
+def is_empty(elt, not_check_attrib=False):
+    if not not_check_attrib and elt.attrib:
+        return False
+    empty = True
+    for file_ in elt:
+        empty = False
+    return empty
+
+
+def update_creole_1():
+    print('pfff')

src/rougail/utils.py

@@ -26,10 +26,26 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 """
 from typing import List
 from unicodedata import normalize, combining
+import re
 
 from importlib.machinery import SourceFileLoader
 from importlib.util import spec_from_loader, module_from_spec
 
+from .i18n import _
+from .error import DictConsistencyError
+
+NAME_REGEXP = re.compile(r"^[a-z0-9_]*$")
+
+
+def valid_variable_family_name(name: str,
+                               xmlfiles: List[str],
+                               ) -> None:
+    match = NAME_REGEXP.search(name)
+    if not match:
+        msg = _(f'invalid variable or family name "{name}" must only contains '
+                'lowercase ascii character, number or _')
+        raise DictConsistencyError(msg, 76, xmlfiles)
+
 
 def normalize_family(family_name: str) -> str:
     """replace space, accent, uppercase, ... by valid character

src/rougail/xmlreflector.py

@@ -32,7 +32,6 @@ from lxml.etree import DTD, parse, XMLSyntaxError  # pylint: disable=E0611
 
 from .i18n import _
 from .error import DictConsistencyError
-from .config import RougailConfig
 
 
 class XMLReflector:
@@ -40,14 +39,16 @@ class XMLReflector:
     parsing it, validating against the Creole DTD,
     writing the xml result on the disk
     """
-    def __init__(self):
+    def __init__(self,
+                 rougailconfig: 'RougailConfig',
+                 ) -> None:
         """Loads the Creole DTD
 
         :raises IOError: if the DTD is not found
 
         :param dtdfilename: the full filename of the Creole DTD
         """
-        dtdfilename = RougailConfig['dtdfilename']
+        dtdfilename = rougailconfig['dtdfilename']
         if not isfile(dtdfilename):
             raise IOError(_("no such DTD file: {}").format(dtdfilename))
         with open(dtdfilename, 'r') as dtdfd:
@@ -60,17 +61,26 @@ class XMLReflector:
 
         :param xmlfolders: list of full folder's name
         """
+        filenames = {}
         for xmlfolder in xmlfolders:
-            filenames = [join(xmlfolder, filename) for filename in listdir(xmlfolder) if \
+            for filename in listdir(xmlfolder):
-                         filename.endswith('.xml')]
+                if not filename.endswith('.xml'):
-            filenames.sort()
+                    continue
-            for xmlfile in filenames:
+                if filename in filenames:
-                try:
+                    raise DictConsistencyError(_(f'duplicate xml file name {filename}'), 78, [xmlfolder])
-                    document = parse(xmlfile)
+                filenames[filename] = join(xmlfolder, filename)
-                except XMLSyntaxError as err:
+        if not filenames:
-                    raise DictConsistencyError(_(f'not a XML file: {err}'), 52, [xmlfile]) from err
+            raise DictConsistencyError(_('there is no XML file'), 77, [xmlfolder])
-                if not self.dtd.validate(document):
+        file_names = list(filenames.keys())
-                    dtd_error = self.dtd.error_log.filter_from_errors()[0]
+        file_names.sort()
-                    msg = _(f'not a valid XML file: {dtd_error}')
+        for filename in file_names:
-                    raise DictConsistencyError(msg, 43, [xmlfile])
+            xmlfile = filenames[filename]
-                yield xmlfile, document.getroot()
+            try:
+                document = parse(xmlfile)
+            except XMLSyntaxError as err:
+                raise DictConsistencyError(_(f'not a XML file: {err}'), 52, [xmlfile]) from err
+            if not self.dtd.validate(document):
+                dtd_error = self.dtd.error_log.filter_from_errors()[0]
+                msg = _(f'not a valid XML file: {dtd_error}')
+                raise DictConsistencyError(msg, 43, [xmlfile])
+            yield xmlfile, document.getroot()

tests/dictionaries/00empty/00_base.xml

@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<rougail>
+<rougail version="0.10">
-    <services>
+  <services>
-        <service name="tata">
+    <service name="tata">
         </service>
-    </services>
+  </services>
 </rougail>

tests/dictionaries/00empty/makedict/after.json

@@ -0,0 +1,10 @@
+{
+    "services.tata_service.activate": {
+        "owner": "default",
+        "value": true
+    },
+    "services.tata_service.manage": {
+        "owner": "default",
+        "value": true
+    }
+}

tests/dictionaries/00empty/makedict/base.json

@@ -0,0 +1,4 @@
+{
+    "services.tata_service.activate": true,
+    "services.tata_service.manage": true
+}

tests/dictionaries/00empty/makedict/before.json

@@ -0,0 +1,10 @@
+{
+    "services.tata_service.activate": {
+        "owner": "default",
+        "value": true
+    },
+    "services.tata_service.manage": {
+        "owner": "default",
+        "value": true
+    }
+}

tests/dictionaries/00empty/tiramisu/base.py

@@ -1,16 +1,21 @@
-from importlib.machinery import SourceFileLoader
+from importlib.machinery import SourceFileLoader as _SourceFileLoader
-from importlib.util import spec_from_loader, module_from_spec
+from importlib.util import spec_from_loader as _spec_from_loader, module_from_spec as _module_from_spec
-loader = SourceFileLoader('func', 'tests/dictionaries/../eosfunc/test.py')
+class func:
-spec = spec_from_loader(loader.name, loader)
+    pass
-func = module_from_spec(spec)
+_loader = _SourceFileLoader('func', 'tests/dictionaries/../eosfunc/test.py')
-loader.exec_module(func)
+_spec = _spec_from_loader(_loader.name, _loader)
-for key, value in dict(locals()).items():
+_func = _module_from_spec(_spec)
-    if key != ['SourceFileLoader', 'func']:
+_loader.exec_module(_func)
-        setattr(func, key, value)
+for function in dir(_func):
+    if function.startswith('_'):
+        continue
+    setattr(func, function, getattr(_func, function))
 try:
     from tiramisu3 import *
 except:
     from tiramisu import *
-option_2 = OptionDescription(name="tata", doc="tata", children=[])
+option_3 = BoolOption(name="activate", doc="activate", default=True)
+option_4 = BoolOption(name="manage", doc="manage", default=True)
+option_2 = OptionDescription(name="tata_service", doc="tata.service", children=[option_3, option_4])
 option_1 = OptionDescription(name="services", doc="services", children=[option_2], properties=frozenset({"hidden"}))
 option_0 = OptionDescription(name="baseoption", doc="baseoption", children=[option_1])

tests/dictionaries/00load_autofreeze/00-base.xml

@@ -1,13 +1,11 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<rougail>
+<rougail version="0.10">
-    <variables>
+  <variables>
-        <variable name="myvar" auto_freeze="True">
+    <variable name="myvar" auto_freeze="True">
-            <value>no</value>
+      <value>no</value>
-        </variable>
+    </variable>
-        <variable name="instanciated_module" type="boolean">
+    <variable name="server_deployed" type="boolean">
-            <value>False</value>
+      <value>False</value>
-        </variable>
+    </variable>
-    </variables>
+  </variables>
 </rougail>
-<!-- vim: ts=4 sw=4 expandtab
--->

tests/dictionaries/00load_autofreeze/makedict/after.json

@@ -0,0 +1,10 @@
+{
+    "rougail.myvar": {
+        "owner": "forced",
+        "value": "no"
+    },
+    "rougail.server_deployed": {
+        "owner": "default",
+        "value": false
+    }
+}

tests/dictionaries/00load_autofreeze/makedict/base.json

@@ -1 +1,4 @@
-{"rougail.myvar": "no", "rougail.instanciated_module": false}
+{
+    "rougail.myvar": "no",
+    "rougail.server_deployed": false
+}

tests/dictionaries/00load_autofreeze/makedict/before.json

@@ -0,0 +1,10 @@
+{
+    "rougail.myvar": {
+        "owner": "default",
+        "value": "no"
+    },
+    "rougail.server_deployed": {
+        "owner": "default",
+        "value": false
+    }
+}

tests/dictionaries/00load_autofreeze/tiramisu/base.py

@@ -1,17 +1,20 @@
-from importlib.machinery import SourceFileLoader
+from importlib.machinery import SourceFileLoader as _SourceFileLoader
-from importlib.util import spec_from_loader, module_from_spec
+from importlib.util import spec_from_loader as _spec_from_loader, module_from_spec as _module_from_spec
-loader = SourceFileLoader('func', 'tests/dictionaries/../eosfunc/test.py')
+class func:
-spec = spec_from_loader(loader.name, loader)
+    pass
-func = module_from_spec(spec)
+_loader = _SourceFileLoader('func', 'tests/dictionaries/../eosfunc/test.py')
-loader.exec_module(func)
+_spec = _spec_from_loader(_loader.name, _loader)
-for key, value in dict(locals()).items():
+_func = _module_from_spec(_spec)
-    if key != ['SourceFileLoader', 'func']:
+_loader.exec_module(_func)
-        setattr(func, key, value)
+for function in dir(_func):
+    if function.startswith('_'):
+        continue
+    setattr(func, function, getattr(_func, function))
 try:
     from tiramisu3 import *
 except:
     from tiramisu import *
-option_3 = BoolOption(name="instanciated_module", doc="instanciated_module", default=False, properties=frozenset({"mandatory", "normal"}))
+option_3 = BoolOption(name="server_deployed", doc="server_deployed", default=False, properties=frozenset({"mandatory", "normal"}))
-option_2 = StrOption(name="myvar", doc="myvar", default="no", properties=frozenset({"auto_freeze", "force_store_value", "mandatory", "normal", Calculation(func.calc_value, Params(ParamValue('auto_frozen'), kwargs={'condition': ParamOption(option_3, todict=True), 'expected': ParamValue(True), 'reverse_condition': ParamValue(True)}))}))
+option_2 = StrOption(name="myvar", doc="myvar", default="no", properties=frozenset({"basic", "force_store_value", "mandatory", Calculation(func.calc_value, Params(ParamValue('frozen'), kwargs={'condition': ParamOption(option_3, todict=True, notraisepropertyerror=True), 'expected': ParamValue(True)}))}))
 option_1 = OptionDescription(name="rougail", doc="rougail", children=[option_2, option_3])
 option_0 = OptionDescription(name="baseoption", doc="baseoption", children=[option_1])

tests/dictionaries/00load_autofreezeexpert/00-base.xml

@@ -1,13 +1,11 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<rougail>
+<rougail version="0.10">
-    <variables>
+  <variables>
-        <variable name="my_var" auto_freeze="True" mode="expert">
+    <variable name="my_var" auto_freeze="True" mode="expert">
-            <value>no</value>
+      <value>no</value>
-        </variable>
+    </variable>
-        <variable name="instanciated_module" type="boolean">
+    <variable name="server_deployed" type="boolean">
-            <value>False</value>
+      <value>False</value>
-        </variable>
+    </variable>
-    </variables>
+  </variables>
 </rougail>
-<!-- vim: ts=4 sw=4 expandtab
--->

tests/dictionaries/00load_autofreezeexpert/makedict/after.json

@@ -0,0 +1,10 @@
+{
+    "rougail.my_var": {
+        "owner": "forced",
+        "value": "no"
+    },
+    "rougail.server_deployed": {
+        "owner": "default",
+        "value": false
+    }
+}

tests/dictionaries/00load_autofreezeexpert/makedict/base.json

@@ -1 +1,4 @@
-{"rougail.my_var": "no", "rougail.instanciated_module": false}
+{
+    "rougail.my_var": "no",
+    "rougail.server_deployed": false
+}

tests/dictionaries/00load_autofreezeexpert/makedict/before.json

@@ -0,0 +1,10 @@
+{
+    "rougail.my_var": {
+        "owner": "default",
+        "value": "no"
+    },
+    "rougail.server_deployed": {
+        "owner": "default",
+        "value": false
+    }
+}

tests/dictionaries/00load_autofreezeexpert/tiramisu/base.py

@@ -1,17 +1,20 @@
-from importlib.machinery import SourceFileLoader
+from importlib.machinery import SourceFileLoader as _SourceFileLoader
-from importlib.util import spec_from_loader, module_from_spec
+from importlib.util import spec_from_loader as _spec_from_loader, module_from_spec as _module_from_spec
-loader = SourceFileLoader('func', 'tests/dictionaries/../eosfunc/test.py')
+class func:
-spec = spec_from_loader(loader.name, loader)
+    pass
-func = module_from_spec(spec)
+_loader = _SourceFileLoader('func', 'tests/dictionaries/../eosfunc/test.py')
-loader.exec_module(func)
+_spec = _spec_from_loader(_loader.name, _loader)
-for key, value in dict(locals()).items():
+_func = _module_from_spec(_spec)
-    if key != ['SourceFileLoader', 'func']:
+_loader.exec_module(_func)
-        setattr(func, key, value)
+for function in dir(_func):
+    if function.startswith('_'):
+        continue
+    setattr(func, function, getattr(_func, function))
 try:
     from tiramisu3 import *
 except:
     from tiramisu import *
-option_3 = BoolOption(name="instanciated_module", doc="instanciated_module", default=False, properties=frozenset({"mandatory", "normal"}))
+option_3 = BoolOption(name="server_deployed", doc="server_deployed", default=False, properties=frozenset({"mandatory", "normal"}))
-option_2 = StrOption(name="my_var", doc="my_var", default="no", properties=frozenset({"auto_freeze", "expert", "force_store_value", "mandatory", Calculation(func.calc_value, Params(ParamValue('auto_frozen'), kwargs={'condition': ParamOption(option_3, todict=True), 'expected': ParamValue(True), 'reverse_condition': ParamValue(True)}))}))
+option_2 = StrOption(name="my_var", doc="my_var", default="no", properties=frozenset({"expert", "force_store_value", "mandatory", Calculation(func.calc_value, Params(ParamValue('frozen'), kwargs={'condition': ParamOption(option_3, todict=True, notraisepropertyerror=True), 'expected': ParamValue(True)}))}))
 option_1 = OptionDescription(name="rougail", doc="rougail", children=[option_2, option_3])
 option_0 = OptionDescription(name="baseoption", doc="baseoption", children=[option_1])

tests/dictionaries/00load_autosave/00-base.xml

@@ -1,12 +1,11 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<rougail>
+<rougail version="0.10">
-    <variables>
+  <variables>
-        <family name="général">
+    <variable name="server_deployed" type="boolean"/>
-            <variable name="mode_conteneur_actif" type="string" description="No change" auto_save="True">
+    <family name="general" description="général">
-                <value>non</value>
+      <variable name="mode_conteneur_actif" type="string" description="No change" auto_save="True">
-            </variable>
+        <value>non</value>
-        </family>
+      </variable>
-    </variables>
+    </family>
+  </variables>
 </rougail>
-<!-- vim: ts=4 sw=4 expandtab
--->

tests/dictionaries/00load_autosave/makedict/after.json

@@ -0,0 +1,10 @@
+{
+    "rougail.server_deployed": {
+        "owner": "default",
+        "value": true
+    },
+    "rougail.general.mode_conteneur_actif": {
+        "owner": "forced",
+        "value": "non"
+    }
+}

tests/dictionaries/00load_autosave/makedict/base.json

@@ -1 +1,4 @@
-{"rougail.general.mode_conteneur_actif": "non"}
+{
+    "rougail.server_deployed": true,
+    "rougail.general.mode_conteneur_actif": "non"
+}

tests/dictionaries/00load_autosave/makedict/before.json

@@ -0,0 +1,10 @@
+{
+    "rougail.server_deployed": {
+        "owner": "default",
+        "value": true
+    },
+    "rougail.general.mode_conteneur_actif": {
+        "owner": "default",
+        "value": "non"
+    }
+}

tests/dictionaries/00load_autosave/tiramisu/base.py

@@ -1,17 +1,21 @@
-from importlib.machinery import SourceFileLoader
+from importlib.machinery import SourceFileLoader as _SourceFileLoader
-from importlib.util import spec_from_loader, module_from_spec
+from importlib.util import spec_from_loader as _spec_from_loader, module_from_spec as _module_from_spec
-loader = SourceFileLoader('func', 'tests/dictionaries/../eosfunc/test.py')
+class func:
-spec = spec_from_loader(loader.name, loader)
+    pass
-func = module_from_spec(spec)
+_loader = _SourceFileLoader('func', 'tests/dictionaries/../eosfunc/test.py')
-loader.exec_module(func)
+_spec = _spec_from_loader(_loader.name, _loader)
-for key, value in dict(locals()).items():
+_func = _module_from_spec(_spec)
-    if key != ['SourceFileLoader', 'func']:
+_loader.exec_module(_func)
-        setattr(func, key, value)
+for function in dir(_func):
+    if function.startswith('_'):
+        continue
+    setattr(func, function, getattr(_func, function))
 try:
     from tiramisu3 import *
 except:
     from tiramisu import *
-option_3 = StrOption(name="mode_conteneur_actif", doc="No change", default="non", properties=frozenset({"basic", "force_store_value", "mandatory"}))
+option_2 = BoolOption(name="server_deployed", doc="server_deployed", default=True, properties=frozenset({"mandatory", "normal"}))
-option_2 = OptionDescription(name="general", doc="général", children=[option_3], properties=frozenset({"basic"}))
+option_4 = StrOption(name="mode_conteneur_actif", doc="No change", default="non", properties=frozenset({"basic", "force_store_value", "mandatory"}))
-option_1 = OptionDescription(name="rougail", doc="rougail", children=[option_2])
+option_3 = OptionDescription(name="general", doc="général", children=[option_4], properties=frozenset({"basic"}))
+option_1 = OptionDescription(name="rougail", doc="rougail", children=[option_2, option_3])
 option_0 = OptionDescription(name="baseoption", doc="baseoption", children=[option_1])

tests/dictionaries/00load_autosaveexpert/00-base.xml

@@ -1,12 +1,11 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<rougail>
+<rougail version="0.10">
-    <variables>
+  <variables>
-        <family name="général">
+    <variable name="server_deployed" type="boolean"/>
-            <variable name="mode_conteneur_actif" type="string" description="No change" auto_save="True" mode="expert">
+    <family name="general" description="général">
-                <value>non</value>
+      <variable name="mode_conteneur_actif" type="string" description="No change" auto_save="True" mode="expert">
-            </variable>
+        <value>non</value>
-        </family>
+      </variable>
-    </variables>
+    </family>
+  </variables>
 </rougail>
-<!-- vim: ts=4 sw=4 expandtab
--->

tests/dictionaries/00load_autosaveexpert/makedict/after.json

@@ -0,0 +1,10 @@
+{
+    "rougail.server_deployed": {
+        "owner": "default",
+        "value": true
+    },
+    "rougail.general.mode_conteneur_actif": {
+        "owner": "forced",
+        "value": "non"
+    }
+}

tests/dictionaries/00load_autosaveexpert/makedict/base.json

@@ -1 +1,4 @@
-{"rougail.general.mode_conteneur_actif": "non"}
+{
+    "rougail.server_deployed": true,
+    "rougail.general.mode_conteneur_actif": "non"
+}

tests/dictionaries/00load_autosaveexpert/makedict/before.json

@@ -0,0 +1,10 @@
+{
+    "rougail.server_deployed": {
+        "owner": "default",
+        "value": true
+    },
+    "rougail.general.mode_conteneur_actif": {
+        "owner": "default",
+        "value": "non"
+    }
+}

tests/dictionaries/00load_autosaveexpert/tiramisu/base.py

@@ -1,17 +1,21 @@
-from importlib.machinery import SourceFileLoader
+from importlib.machinery import SourceFileLoader as _SourceFileLoader
-from importlib.util import spec_from_loader, module_from_spec
+from importlib.util import spec_from_loader as _spec_from_loader, module_from_spec as _module_from_spec
-loader = SourceFileLoader('func', 'tests/dictionaries/../eosfunc/test.py')
+class func:
-spec = spec_from_loader(loader.name, loader)
+    pass
-func = module_from_spec(spec)
+_loader = _SourceFileLoader('func', 'tests/dictionaries/../eosfunc/test.py')
-loader.exec_module(func)
+_spec = _spec_from_loader(_loader.name, _loader)
-for key, value in dict(locals()).items():
+_func = _module_from_spec(_spec)
-    if key != ['SourceFileLoader', 'func']:
+_loader.exec_module(_func)
-        setattr(func, key, value)
+for function in dir(_func):
+    if function.startswith('_'):
+        continue
+    setattr(func, function, getattr(_func, function))
 try:
     from tiramisu3 import *
 except:
     from tiramisu import *
-option_3 = StrOption(name="mode_conteneur_actif", doc="No change", default="non", properties=frozenset({"expert", "force_store_value", "mandatory"}))
+option_2 = BoolOption(name="server_deployed", doc="server_deployed", default=True, properties=frozenset({"mandatory", "normal"}))
-option_2 = OptionDescription(name="general", doc="général", children=[option_3], properties=frozenset({"expert"}))
+option_4 = StrOption(name="mode_conteneur_actif", doc="No change", default="non", properties=frozenset({"expert", "force_store_value", "mandatory"}))
-option_1 = OptionDescription(name="rougail", doc="rougail", children=[option_2])
+option_3 = OptionDescription(name="general", doc="général", children=[option_4], properties=frozenset({"expert"}))
+option_1 = OptionDescription(name="rougail", doc="rougail", children=[option_2, option_3])
 option_0 = OptionDescription(name="baseoption", doc="baseoption", children=[option_1])

tests/dictionaries/00load_comment/00-base.xml

@@ -1,13 +1,11 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<rougail>
+<rougail version="0.10">
-    <variables>
+  <variables>
-        <family name="général">
+    <family name="general" description="général">
-            <!-- this is a comment -->
+      <!-- this is a comment -->
-            <variable name="mode_conteneur_actif" type="string" description="No change" hidden="True">
+      <variable name="mode_conteneur_actif" type="string" description="No change" hidden="True">
-                <value>non</value>
+        <value>non</value>
-            </variable>
+      </variable>
-        </family>
+    </family>
-    </variables>
+  </variables>
 </rougail>
-<!-- vim: ts=4 sw=4 expandtab
--->

tests/dictionaries/00load_comment/makedict/after.json

@@ -0,0 +1,6 @@
+{
+    "rougail.general.mode_conteneur_actif": {
+        "owner": "default",
+        "value": "non"
+    }
+}