bin/setenv.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (C) 2005  OPEN CASCADE, CEA, EDF R&D, LEG
   4 #           PRINCIPIA R&D, EADS CCR, Lip6, BV, CEDRAT
   5 # This library is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU Lesser General Public
   7 # License as published by the Free Software Foundation; either
   8 # version 2.1 of the License.
   9 #
  10 # This library is distributed in the hope that it will be useful
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # Lesser General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Lesser General Public
  16 # License along with this library; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18 #
  19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  20 #
  21
  22 import sys, os, string, glob, time, pickle
  23 import orbmodule
  24 from launchConfigureParser import verbose
  25
  26 # this file is extraction of set_env from runSalome.py
  27 # for reusage in automated tests
  28
  29 # salome_subdir variable is used for composing paths like $KERNEL_ROOT_DIR/share/salome/resources, etc.
  30 # before moving to SUIT-based gui, instead of salome_subdir there was args['appname'] used.
  31 # but after - 'appname'  = "SalomeApp", so using it in making the subdirectory is an error.
  32 salome_subdir = "salome"
  33
  34
  35 # -----------------------------------------------------------------------------
  36
  37 def add_path(directory, variable_name):
  38     """Function helper to add environment variables"""
  39     if sys.platform == "win32":
  40       splitsym = ";"
  41     else:
  42       splitsym = ":"
  43     if not os.environ.has_key(variable_name):
  44         os.environ[variable_name] = ""
  45         pass
  46     if os.path.exists(directory):
  47         newpath=[]
  48         for _dir in os.environ[variable_name].split(splitsym):
  49             if os.path.exists(_dir):
  50                 if sys.platform != "win32":
  51                     if not os.path.samefile(_dir, directory):
  52                         newpath.append(_dir)
  53                 else:
  54                     newpath.append(_dir)
  55             else:
  56                 if os.path.abspath(_dir) != os.path.abspath(directory):
  57                   newpath.append(_dir)
  58             pass
  59         import string
  60         newpath[:0] = [ directory ]
  61         newpath = string.join(newpath, splitsym)
  62         os.environ[variable_name] = newpath
  63         if variable_name == "PYTHONPATH":
  64             sys.path[:0] = [directory]
  65
  66 # -----------------------------------------------------------------------------
  67
  68 __lib__dir__ = None
  69 def get_lib_dir():
  70     global __lib__dir__
  71     if __lib__dir__: return __lib__dir__
  72     import platform
  73     __lib__dir__ = "lib"
  74     return __lib__dir__
  75
  76 # -----------------------------------------------------------------------------
  77
  78 def get_config():
  79     """
  80     Get list of modules, paths.
  81
  82     Read args from launch configure xml file and command line options.
  83     Check variables <module>_ROOT_DIR and set list of used modules.
  84     Return args, modules_list, modules_root_dir
  85     """
  86
  87     # read args from launch configure xml file and command line options
  88
  89     #*** Test additional option
  90     #*** import optparse
  91     #*** help_str = "Test options addition."
  92     #*** o_j = optparse.Option("-j", "--join", action="store_true", dest="join", help=help_str)
  93
  94     import launchConfigureParser
  95     args = launchConfigureParser.get_env()
  96
  97     #*** Test additional option
  98     #*** args = launchConfigureParser.get_env([o_j])
  99     #*** if args.has_key("join"): print args["join"]
 100
 101     # Check variables <module>_ROOT_DIR
 102     # and set list of used modules (without KERNEL)
 103
 104     modules_list = []
 105     if args.has_key("modules"):
 106         modules_list += args["modules"]
 107     # KERNEL must be last in the list to locate it at the first place in PATH
 108     if args["gui"] :
 109         modules_list[:0] = ["GUI"]
 110     modules_list[:0] = ["KERNEL"]
 111     modules_list.reverse()
 112
 113     modules_root_dir = {}
 114
 115     to_remove_list=[]
 116     for module in modules_list :
 117         module_variable=module+"_ROOT_DIR"
 118         if not os.environ.has_key(module_variable):
 119             print "*******************************************************"
 120             print "*"
 121             print "* Environment variable",module_variable,"must be set"
 122             print "* Module", module, "will be not available"
 123             print "*"
 124             print "********************************************************"
 125             to_remove_list.append(module)
 126             continue
 127             pass
 128         module_root_dir = os.environ[module_variable]
 129         modules_root_dir[module]=module_root_dir
 130
 131     for to_remove in to_remove_list:
 132         modules_list.remove(to_remove)
 133
 134     while "KERNEL" in modules_list:
 135         modules_list.remove("KERNEL")
 136         pass
 137
 138     while "GUI" in modules_list:
 139         modules_list.remove("GUI")
 140         pass
 141
 142     if "SUPERV" in modules_list and not 'supervContainer' in args['standalone']:
 143         args['standalone'].append("supervContainer")
 144         pass
 145
 146     return args, modules_list, modules_root_dir
 147
 148 # -----------------------------------------------------------------------------
 149
 150 def set_env(args, modules_list, modules_root_dir):
 151     """Add to the PATH-variables modules specific paths"""
 152
 153     python_version="python%d.%d" % sys.version_info[0:2]
 154     modules_root_dir_list = []
 155     if os.getenv('SALOME_BATCH') == None:
 156       os.putenv('SALOME_BATCH','0')
 157     if args["gui"] :
 158         modules_list = modules_list[:] + ["GUI"]
 159     modules_list = modules_list[:] + ["KERNEL"]
 160     for module in modules_list :
 161         if modules_root_dir.has_key(module):
 162             module_root_dir = modules_root_dir[module]
 163             modules_root_dir_list[:0] = [module_root_dir]
 164             if sys.platform == "win32":
 165               add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
 166                      "PATH")
 167             else:
 168               add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
 169                      "LD_LIBRARY_PATH")
 170             add_path(os.path.join(module_root_dir,"bin",salome_subdir),
 171                      "PATH")
 172             if os.path.exists(module_root_dir + "/examples") :
 173                 add_path(os.path.join(module_root_dir,"examples"),
 174                          "PYTHONPATH")
 175                 pass
 176             add_path(os.path.join(module_root_dir,"bin",salome_subdir),
 177                      "PYTHONPATH")
 178             # add lib before site-packages to load script instead of dll if any (win32 platform)
 179             add_path(os.path.join(module_root_dir,get_lib_dir(),salome_subdir),
 180                      "PYTHONPATH")
 181             add_path(os.path.join(module_root_dir,get_lib_dir(),
 182                                   python_version,"site-packages",
 183                                   salome_subdir),
 184                      "PYTHONPATH")
 185             add_path(os.path.join(module_root_dir,get_lib_dir(),
 186                                   python_version,"site-packages",
 187                                   salome_subdir,
 188                                   "shared_modules"),
 189                      "PYTHONPATH")
 190             pass
 191         pass
 192
 193     if sys.platform == 'win32':
 194         os.environ["SALOMEPATH"]=";".join(modules_root_dir_list)
 195     else:
 196         os.environ["SALOMEPATH"]=":".join(modules_root_dir_list)
 197
 198     # set trace environment variable
 199
 200     if not os.environ.has_key("SALOME_trace"):
 201         os.environ["SALOME_trace"]="local"
 202     if args['file']:
 203         os.environ["SALOME_trace"]="file:"+args['file'][0]
 204     if args['logger']:
 205         os.environ["SALOME_trace"]="with_logger"
 206
 207     # set environment for SMESH plugins
 208
 209     if "SMESH" in modules_list:
 210         os.environ["SMESH_MeshersList"]="StdMeshers"
 211         if not os.environ.has_key("SALOME_StdMeshersResources"):
 212             os.environ["SALOME_StdMeshersResources"] \
 213             = modules_root_dir["SMESH"]+"/share/"+salome_subdir+"/resources/smesh"
 214             pass
 215         if args.has_key("SMESH_plugins"):
 216             for plugin in args["SMESH_plugins"]:
 217                 plugin_root = ""
 218                 if os.environ.has_key(plugin+"_ROOT_DIR"):
 219                     plugin_root = os.environ[plugin+"_ROOT_DIR"]
 220                 else:
 221                     # workaround to avoid modifications of existing environment
 222                     if os.environ.has_key(plugin.upper()+"_ROOT_DIR"):
 223                         plugin_root = os.environ[plugin.upper()+"_ROOT_DIR"]
 224                         pass
 225                     pass
 226                 if plugin_root != "":
 227                     os.environ["SMESH_MeshersList"] \
 228                     = os.environ["SMESH_MeshersList"]+":"+plugin
 229                     if not os.environ.has_key("SALOME_"+plugin+"Resources"):
 230                         os.environ["SALOME_"+plugin+"Resources"] \
 231                         = plugin_root+"/share/"+salome_subdir+"/resources/"+plugin.lower()
 232                     add_path(os.path.join(plugin_root,get_lib_dir(),python_version,
 233                                           "site-packages",salome_subdir),
 234                              "PYTHONPATH")
 235                     add_path(os.path.join(plugin_root,get_lib_dir(),salome_subdir),
 236                              "PYTHONPATH")
 237
 238
 239                     if sys.platform == "win32":
 240                       add_path(os.path.join(plugin_root,get_lib_dir(),salome_subdir),
 241                           "PATH")
 242                     else:
 243                       add_path(os.path.join(plugin_root,get_lib_dir(),salome_subdir),
 244                                "LD_LIBRARY_PATH")
 245                     add_path(os.path.join(plugin_root,"bin",salome_subdir),
 246                              "PYTHONPATH")
 247                     add_path(os.path.join(plugin_root,"bin",salome_subdir),
 248                              "PATH")
 249             pass
 250         pass
 251
 252     # set environment for SUPERV module
 253     os.environ["ENABLE_MACRO_NODE"]="1"
 254     # set resources variables if not yet set
 255     # Done now by launchConfigureParser.py
 256     #if os.getenv("GUI_ROOT_DIR"):
 257         #if not os.getenv("SalomeAppConfig"): os.environ["SalomeAppConfig"] =  os.getenv("GUI_ROOT_DIR") + "/share/salome/resources/gui"
 258
 259     os.environ["CSF_SALOMEDS_ResourcesDefaults"] \
 260     = os.path.join(modules_root_dir["KERNEL"],"share",
 261                    salome_subdir,"resources","kernel")
 262
 263     if "GEOM" in modules_list:
 264         if verbose(): print "GEOM OCAF Resources"
 265
 266         # set CSF_PluginDefaults variable only if it is not customized
 267         # by the user
 268
 269         if not os.getenv("CSF_PluginDefaults"):
 270             os.environ["CSF_PluginDefaults"] \
 271             = os.path.join(modules_root_dir["GEOM"],"share",
 272                            salome_subdir,"resources","geom")
 273         os.environ["CSF_GEOMDS_ResourcesDefaults"] \
 274         = os.path.join(modules_root_dir["GEOM"],"share",
 275                        salome_subdir,"resources","geom")
 276         if verbose(): print "GEOM Shape Healing Resources"
 277         os.environ["CSF_ShHealingDefaults"] \
 278         = os.path.join(modules_root_dir["GEOM"],"share",
 279                        salome_subdir,"resources","geom")
 280
 281 # -----------------------------------------------------------------------------
 282
 283 def main():
 284     args, modules_list, modules_root_dir = get_config()
 285     set_env(args, modules_list, modules_root_dir)
 286     return args
 287
 288 # -----------------------------------------------------------------------------
 289
 290 if __name__ == "__main__":
 291    import user
 292    args = main()