Salome HOME
Add a default value for the jobs timeout
[tools/sat.git] / commands / config.py
index fbb4cb90cf5c0274b39551df7e56a4b3fedf3cd7..0f3777cc284b37a6760623fdbe1aa2ce2e685692 100644 (file)
@@ -40,7 +40,7 @@ parser.add_option('i', 'info', 'string', 'info',
 parser.add_option('l', 'list', 'boolean', 'list',
     _("list all available applications."))
 parser.add_option('c', 'copy', 'boolean', 'copy',
-    _("""copy a config file to the personnal config files directory.
+    _("""copy a config file to the personal config files directory.
 \tWARNING the included files are not copied.
 \tIf a name is given the new config file takes the given name."""))
 parser.add_option('n', 'no_label', 'boolean', 'no_label',
@@ -55,7 +55,7 @@ class ConfigOpener:
     def __init__(self, pathList):
         '''Initialization
         
-        :param pathList list: The list of paths where to serach a pyconf.
+        :param pathList list: The list of paths where to search a pyconf.
         '''
         self.pathList = pathList
 
@@ -98,6 +98,7 @@ class ConfigManager:
         var['salometoolsway'] = os.path.dirname(
                                     os.path.dirname(os.path.abspath(__file__)))
         var['srcDir'] = os.path.join(var['salometoolsway'], 'src')
+        var['internal_dir'] = os.path.join(var['srcDir'], 'internal_config')
         var['sep']= os.path.sep
         
         # datadir has a default location
@@ -107,6 +108,27 @@ class ConfigManager:
 
         var['personalDir'] = os.path.join(os.path.expanduser('~'),
                                            '.salomeTools')
+        src.ensure_path_exists(var['personalDir'])
+
+        var['personal_applications_dir'] = os.path.join(var['personalDir'],
+                                                        "Applications")
+        src.ensure_path_exists(var['personal_applications_dir'])
+        
+        var['personal_products_dir'] = os.path.join(var['personalDir'],
+                                                    "products")
+        src.ensure_path_exists(var['personal_products_dir'])
+        
+        var['personal_archives_dir'] = os.path.join(var['personalDir'],
+                                                    "Archives")
+        src.ensure_path_exists(var['personal_archives_dir'])
+
+        var['personal_jobs_dir'] = os.path.join(var['personalDir'],
+                                                "Jobs")
+        src.ensure_path_exists(var['personal_jobs_dir'])
+
+        var['personal_machines_dir'] = os.path.join(var['personalDir'],
+                                                    "Machines")
+        src.ensure_path_exists(var['personal_machines_dir'])
 
         # read linux distributions dictionary
         distrib_cfg = src.pyconf.Config(os.path.join(var['srcDir'],
@@ -219,14 +241,15 @@ class ConfigManager:
         # apply overwrite from command line if needed
         for rule in self.get_command_line_overrides(options, ["INTERNAL"]):
             exec('cfg.' + rule) # this cannot be factorized because of the exec        
-        
+               
         # =====================================================================
         # Load SITE config file
         # search only in the data directory
         src.pyconf.streamOpener = ConfigOpener([cfg.VARS.datadir])
         try:
             site_cfg = src.pyconf.Config(open(os.path.join(cfg.VARS.datadir, 
-                                                           'site.pyconf')))
+                                                           'site.pyconf')),
+                                         PWD = ('SITE', cfg.VARS.datadir) )
         except src.pyconf.ConfigError as e:
             raise src.SatException(_("Error in configuration file: "
                                      "site.pyconf\n  %(error)s") % \
@@ -240,24 +263,127 @@ class ConfigManager:
                   + cfg.VARS.sep 
                   + "site.pyconf and edit the file")
             raise src.SatException( e );
-        
-        # add user local path for configPath
-        site_cfg.SITE.config.config_path.append(
-                        os.path.join(cfg.VARS.personalDir, 'Applications'), 
-                        "User applications path")
-        
         merger.merge(cfg, site_cfg)
 
         # apply overwrite from command line if needed
         for rule in self.get_command_line_overrides(options, ["SITE"]):
             exec('cfg.' + rule) # this cannot be factorized because of the exec
-  
         
+        # =====================================================================
+        # Load the PROJECTS
+        projects_cfg = src.pyconf.Config()
+        projects_cfg.addMapping("PROJECTS",
+                                src.pyconf.Mapping(projects_cfg),
+                                "The projects\n")
+        projects_cfg.PROJECTS.addMapping("projects",
+                                src.pyconf.Mapping(cfg.PROJECTS),
+                                "The projects definition\n")
+        
+        for project_pyconf_path in cfg.PROJECTS.project_file_paths:
+            if not os.path.exists(project_pyconf_path):
+                msg = _("WARNING: The project file %s cannot be found. "
+                        "It will be ignored\n" % project_pyconf_path)
+                sys.stdout.write(src.printcolors.printcWarning(msg))
+                continue
+            project_name = os.path.basename(
+                                    project_pyconf_path)[:-len(".pyconf")]
+            try:
+                project_pyconf_dir = os.path.dirname(project_pyconf_path)
+                project_cfg = src.pyconf.Config(open(project_pyconf_path),
+                                                PWD=("", project_pyconf_dir))
+            except Exception as e:
+                raise src.SatException(_("Error in configuration file: "
+                                 "%(file_path)s\n  %(error)s") % \
+                            {'file_path' : project_pyconf_path, 'error': str(e) })
+            projects_cfg.PROJECTS.projects.addMapping(project_name,
+                             src.pyconf.Mapping(projects_cfg.PROJECTS.projects),
+                             "The %s project\n" % project_name)
+            projects_cfg.PROJECTS.projects[project_name]=project_cfg
+            projects_cfg.PROJECTS.projects[project_name]["file_path"] = \
+                                                        project_pyconf_path
+                   
+        merger.merge(cfg, projects_cfg)
+
+        # apply overwrite from command line if needed
+        for rule in self.get_command_line_overrides(options, ["PROJECTS"]):
+            exec('cfg.' + rule) # this cannot be factorized because of the exec
+        
+        # =====================================================================
+        # Create the paths where to search the application configurations, 
+        # the product configurations, the products archives, 
+        # the jobs configurations and the machines configurations
+        cfg.addMapping("PATHS", src.pyconf.Mapping(cfg), "The paths\n")
+        cfg.PATHS["APPLICATIONPATH"] = src.pyconf.Sequence(cfg.PATHS)
+        cfg.PATHS.APPLICATIONPATH.append(cfg.VARS.personal_applications_dir, "")
+        
+        cfg.PATHS["PRODUCTPATH"] = src.pyconf.Sequence(cfg.PATHS)
+        cfg.PATHS.PRODUCTPATH.append(cfg.VARS.personal_products_dir, "")
+        cfg.PATHS["ARCHIVEPATH"] = src.pyconf.Sequence(cfg.PATHS)
+        cfg.PATHS.ARCHIVEPATH.append(cfg.VARS.personal_archives_dir, "")
+        cfg.PATHS["JOBPATH"] = src.pyconf.Sequence(cfg.PATHS)
+        cfg.PATHS.JOBPATH.append(cfg.VARS.personal_jobs_dir, "")
+        cfg.PATHS["MACHINEPATH"] = src.pyconf.Sequence(cfg.PATHS)
+        cfg.PATHS.MACHINEPATH.append(cfg.VARS.personal_machines_dir, "")
+        # Loop over the projects in order to complete the PATHS variables
+        for project in cfg.PROJECTS.projects:
+            for PATH in ["APPLICATIONPATH",
+                         "PRODUCTPATH",
+                         "ARCHIVEPATH",
+                         "JOBPATH",
+                         "MACHINEPATH"]:
+                if PATH not in cfg.PROJECTS.projects[project]:
+                    continue
+                cfg.PATHS[PATH].append(cfg.PROJECTS.projects[project][PATH], "")
+        
+        # apply overwrite from command line if needed
+        for rule in self.get_command_line_overrides(options, ["PATHS"]):
+            exec('cfg.' + rule) # this cannot be factorized because of the exec
+
+        # =====================================================================
+        # Load product config files in PRODUCTS section
+        products_cfg = src.pyconf.Config()
+        products_cfg.addMapping("PRODUCTS",
+                                src.pyconf.Mapping(products_cfg),
+                                "The products\n")
+        src.pyconf.streamOpener = ConfigOpener(cfg.PATHS.PRODUCTPATH)
+        for products_dir in cfg.PATHS.PRODUCTPATH:
+            # Loop on all files that are in softsDir directory
+            # and read their config
+            for fName in os.listdir(products_dir):
+                if fName.endswith(".pyconf"):
+                    pName = fName[:-len(".pyconf")]
+                    if pName in products_cfg.PRODUCTS:
+                        continue
+                    try:
+                        prod_cfg = src.pyconf.Config(open(
+                                                    os.path.join(products_dir,
+                                                                 fName)),
+                                                     PWD=("", products_dir))
+                    except src.pyconf.ConfigError as e:
+                        raise src.SatException(_(
+                            "Error in configuration file: %(prod)s\n  %(error)s") % \
+                            {'prod' :  fName, 'error': str(e) })
+                    except IOError as error:
+                        e = str(error)
+                        raise src.SatException( e );
+                    except Exception as e:
+                        raise src.SatException(_(
+                            "Error in configuration file: %(prod)s\n  %(error)s") % \
+                            {'prod' :  fName, 'error': str(e) })
+                    
+                    products_cfg.PRODUCTS[pName] = prod_cfg
+        
+        merger.merge(cfg, products_cfg)
+        
+        # apply overwrite from command line if needed
+        for rule in self.get_command_line_overrides(options, ["PRODUCTS"]):
+            exec('cfg.' + rule) # this cannot be factorized because of the exec
+
         # =====================================================================
         # Load APPLICATION config file
         if application is not None:
             # search APPLICATION file in all directories in configPath
-            cp = cfg.SITE.config.config_path
+            cp = cfg.PATHS.APPLICATIONPATH
             src.pyconf.streamOpener = ConfigOpener(cp)
             try:
                 application_cfg = src.pyconf.Config(application + '.pyconf')
@@ -282,39 +408,6 @@ class ConfigManager:
                 'launcher_name' not in cfg.APPLICATION.profile):
                 cfg.APPLICATION.profile.launcher_name = 'salome'
         
-        # =====================================================================
-        # Load product config files in PRODUCTS section
-       
-        # The directory containing the softwares definition
-        products_dir = os.path.join(cfg.VARS.datadir, 'products')
-        
-        # Loop on all files that are in softsDir directory
-        # and read their config
-        for fName in os.listdir(products_dir):
-            if fName.endswith(".pyconf"):
-                src.pyconf.streamOpener = ConfigOpener([products_dir])
-                try:
-                    prod_cfg = src.pyconf.Config(open(
-                                                os.path.join(products_dir, fName)))
-                except src.pyconf.ConfigError as e:
-                    raise src.SatException(_(
-                        "Error in configuration file: %(prod)s\n  %(error)s") % \
-                        {'prod' :  fName, 'error': str(e) })
-                except IOError as error:
-                    e = str(error)
-                    raise src.SatException( e );
-                except Exception as e:
-                    raise src.SatException(_(
-                        "Error in configuration file: %(prod)s\n  %(error)s") % \
-                        {'prod' :  fName, 'error': str(e) })
-                
-                merger.merge(cfg.PRODUCTS, prod_cfg)
-
-        # apply overwrite from command line if needed
-        for rule in self.get_command_line_overrides(options, ["PRODUCTS"]):
-            exec('cfg.' + rule) # this cannot be factorized because of the exec
-
-        
         # =====================================================================
         # load USER config
         self.set_user_config_file(cfg)
@@ -387,14 +480,22 @@ class ConfigManager:
                                  'evince', 
                                  "This is the pdf_viewer used "
                                  "to read pdf documentation\n")
-        user_cfg.USER.addMapping("bases",
-                                 src.pyconf.Mapping(user_cfg.USER),
-                                 "The products installation base(s)\n")
+        user_cfg.USER.addMapping("base",
+                                 src.pyconf.Reference(
+                                            user_cfg,
+                                            src.pyconf.DOLLAR,
+                                            'workdir  + $VARS.sep + "BASE"'),
+                                 "The products installation base (could be "
+                                 "ignored if this key exists in the site.pyconf"
+                                 " file of salomTools).\n")
         
-        user_cfg.USER.bases.base = src.pyconf.Reference(
+        user_cfg.USER.addMapping("log_dir",
+                                 src.pyconf.Reference(
                                             user_cfg,
                                             src.pyconf.DOLLAR,
-                                            'workdir  + $VARS.sep + "BASE"')
+                                            'workdir  + $VARS.sep + "LOGS"'),
+                                 "The log repository\n")
+        
         # 
         src.ensure_path_exists(config.VARS.personalDir)
         src.ensure_path_exists(os.path.join(config.VARS.personalDir, 
@@ -403,8 +504,6 @@ class ConfigManager:
         f = open(cfg_name, 'w')
         user_cfg.__save__(f)
         f.close()
-        print(_("You can edit it to configure salomeTools "
-                "(use: sat config --edit).\n"))
 
         return user_cfg   
 
@@ -456,7 +555,7 @@ def show_product_info(config, name, logger):
     # Type of the product
     ptype = src.get_cfg_param(pinfo, "type", "")
     src.printcolors.print_value(logger, "type", ptype, 2)
-    if "opt_depend" in pinfo:
+    if "depend" in pinfo:
         src.printcolors.print_value(logger, 
                                     "depends on", 
                                     ', '.join(pinfo.depend), 2)
@@ -689,13 +788,15 @@ def run(args, runner, logger):
         if 'APPLICATION' not in runner.cfg: # edit user pyconf
             usercfg = os.path.join(runner.cfg.VARS.personalDir, 
                                    'salomeTools.pyconf')
+            logger.write(_("Openning %s\n" % usercfg), 3)
             src.system.show_in_editor(editor, usercfg, logger)
         else:
             # search for file <application>.pyconf and open it
-            for path in runner.cfg.SITE.config.config_path:
+            for path in runner.cfg.PATHS.APPLICATIONPATH:
                 pyconf_path = os.path.join(path, 
                                     runner.cfg.VARS.application + ".pyconf")
                 if os.path.exists(pyconf_path):
+                    logger.write(_("Openning %s\n" % pyconf_path), 3)
                     src.system.show_in_editor(editor, pyconf_path, logger)
                     break
     
@@ -720,7 +821,7 @@ def run(args, runner, logger):
         # get application file path 
         source = runner.cfg.VARS.application + '.pyconf'
         source_full_path = ""
-        for path in runner.cfg.SITE.config.config_path:
+        for path in runner.cfg.PATHS.APPLICATIONPATH:
             # ignore personal directory
             if path == runner.cfg.VARS.personalDir:
                 continue
@@ -737,9 +838,9 @@ def run(args, runner, logger):
             if len(args) > 0:
                 # a name is given as parameter, use it
                 dest = args[0]
-            elif 'copy_prefix' in runner.cfg.SITE.config:
+            elif 'copy_prefix' in runner.cfg.INTERNAL.config:
                 # use prefix
-                dest = (runner.cfg.SITE.config.copy_prefix 
+                dest = (runner.cfg.INTERNAL.config.copy_prefix 
                         + runner.cfg.VARS.application)
             else:
                 # use same name as source
@@ -760,7 +861,7 @@ def run(args, runner, logger):
     elif options.list:
         lproduct = list()
         # search in all directories that can have pyconf applications
-        for path in runner.cfg.SITE.config.config_path:
+        for path in runner.cfg.PATHS.APPLICATIONPATH:
             # print a header
             if not options.no_label:
                 logger.write("------ %s\n" % src.printcolors.printcHeader(path))