src/fileEnviron.py

   1 #!/usr/bin/env python
   2 #-*- coding:utf-8 -*-
   3 #  Copyright (C) 2010-2013  CEA/DEN
   4 #
   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 import os
  20 import pprint as PP
  21 import src.debug as DBG
  22 import src.architecture
  23 import src.environment
  24
  25 def get_file_environ(output, shell, environ=None):
  26     """Instantiate correct FileEnvironment sub-class.
  27
  28     :param output file: the output file stream.
  29     :param shell str: the type of shell syntax to use.
  30     :param environ dict: a potential additional environment.
  31     """
  32     if environ == None:
  33         environ=src.environment.Environ({})
  34     if shell == "bash":
  35         return BashFileEnviron(output, environ)
  36     if shell == "tcl":
  37         return TclFileEnviron(output, environ)
  38     if shell == "bat":
  39         return BatFileEnviron(output, environ)
  40     if shell == "cfgForPy":
  41         return LauncherFileEnviron(output, environ)
  42     if shell == "cfg":
  43         return ContextFileEnviron(output, environ)
  44     raise Exception("FileEnviron: Unknown shell = %s" % shell)
  45
  46 class FileEnviron(object):
  47     """\
  48     Base class for shell environment
  49     """
  50     def __init__(self, output, environ=None):
  51         """\
  52         Initialization
  53
  54         :param output file: the output file stream.
  55         :param environ dict: SalomeEnviron.
  56         """
  57         self._do_init(output, environ)
  58
  59     def __repr__(self):
  60         """\
  61         easy non exhaustive quick resume for debug print"""
  62         res = {
  63           "output" : self.output,
  64           "environ" : self.environ,
  65         }
  66         return "%s(\n%s\n)" % (self.__class__.__name__, PP.pformat(res))
  67
  68
  69     def _do_init(self, output, environ=None):
  70         """\
  71         Initialization
  72
  73         :param output file: the output file stream.
  74         :param environ dict: a potential additional environment.
  75         """
  76         self.output = output
  77         self.init_path=True # by default we initialise all paths, except PATH
  78         if environ is not None:
  79             self.environ = environ
  80         else:
  81             self.environ = src.environment.Environ({})
  82
  83     def add_line(self, number):
  84         """\
  85         Add some empty lines in the shell file
  86
  87         :param number int: the number of lines to add
  88         """
  89         self.output.write("\n" * number)
  90
  91     def add_comment(self, comment):
  92         """\
  93         Add a comment in the shell file
  94
  95         :param comment str: the comment to add
  96         """
  97         self.output.write("# %s\n" % comment)
  98
  99     def add_echo(self, text):
 100         """\
 101         Add a "echo" in the shell file
 102
 103         :param text str: the text to echo
 104         """
 105         self.output.write('echo %s"\n' % text)
 106
 107     def add_warning(self, warning):
 108         """\
 109         Add a warning "echo" in the shell file
 110
 111         :param warning str: the text to echo
 112         """
 113         self.output.write('echo "WARNING %s"\n' % warning)
 114
 115     def append_value(self, key, value, sep=os.pathsep):
 116         """\
 117         append value to key using sep,
 118         if value contains ":" or ";" then raise error
 119
 120         :param key str: the environment variable to append
 121         :param value str: the value to append to key
 122         :param sep str: the separator string
 123         """
 124         # check that value so no contain the system separator
 125         separator=os.pathsep
 126         if separator in value:
 127             raise Exception("FileEnviron append key '%s' value '%s' contains forbidden character '%s'" % (key, value, separator))
 128         do_append=True
 129         if self.environ.is_defined(key):
 130             value_list = self.environ.get(key).split(sep)
 131             if self.environ._expandvars(value) in value_list:
 132                 do_append=False  # value is already in key path : we don't append it again
 133
 134         if do_append:
 135             self.environ.append_value(key, value,sep)
 136             self.set(key, self.get(key) + sep + value)
 137
 138     def append(self, key, value, sep=os.pathsep):
 139         """\
 140         Same as append_value but the value argument can be a list
 141
 142         :param key str: the environment variable to append
 143         :param value str or list: the value(s) to append to key
 144         :param sep str: the separator string
 145         """
 146         if isinstance(value, list):
 147             for v in value:
 148                 self.append_value(key, v, sep)
 149         else:
 150             self.append_value(key, value, sep)
 151
 152     def prepend_value(self, key, value, sep=os.pathsep):
 153         """\
 154         prepend value to key using sep,
 155         if value contains ":" or ";" then raise error
 156
 157         :param key str: the environment variable to prepend
 158         :param value str: the value to prepend to key
 159         :param sep str: the separator string
 160         """
 161         # check that value so no contain the system separator
 162         separator=os.pathsep
 163         if separator in value:
 164             raise Exception("FileEnviron append key '%s' value '%s' contains forbidden character '%s'" % (key, value, separator))
 165
 166         do_not_prepend=False
 167         if self.environ.is_defined(key):
 168             value_list = self.environ.get(key).split(sep)
 169             exp_val=self.environ._expandvars(value)
 170             if exp_val in value_list:
 171                 do_not_prepend=True
 172         if not do_not_prepend:
 173             self.environ.prepend_value(key, value,sep)
 174             self.set(key, value + sep + self.get(key))
 175
 176     def prepend(self, key, value, sep=os.pathsep):
 177         """\
 178         Same as prepend_value but the value argument can be a list
 179
 180         :param key str: the environment variable to prepend
 181         :param value str or list: the value(s) to prepend to key
 182         :param sep str: the separator string
 183         """
 184         if isinstance(value, list):
 185             for v in reversed(value): # prepend list, first item at last to stay first
 186                 self.prepend_value(key, v, sep)
 187         else:
 188             self.prepend_value(key, value, sep)
 189
 190     def is_defined(self, key):
 191         """\
 192         Check if the key exists in the environment
 193
 194         :param key str: the environment variable to check
 195         """
 196         return self.environ.is_defined(key)
 197
 198     def set(self, key, value):
 199         """\
 200         Set the environment variable 'key' to value 'value'
 201
 202         :param key str: the environment variable to set
 203         :param value str: the value
 204         """
 205         raise NotImplementedError("set is not implement for this shell!")
 206
 207     def get(self, key):
 208         """\
 209         Get the value of the environment variable "key"
 210
 211         :param key str: the environment variable
 212         """
 213         if src.architecture.is_windows():
 214             return '%' + key + '%'
 215         else:
 216             return '${%s}' % key
 217
 218     def get_value(self, key):
 219         """Get the real value of the environment variable "key"
 220         It can help env scripts
 221         :param key str: the environment variable
 222         """
 223         return self.environ.get_value(key)
 224
 225     def finish(self):
 226         """Add a final instruction in the out file (in case of file generation)
 227
 228         :param required bool: Do nothing if required is False
 229         """
 230         return
 231
 232     def set_no_init_path(self):
 233         """Set the no initialisation mode for all paths.
 234            By default only PATH is not reinitialised. All others paths are
 235            (LD_LIBRARY_PATH, PYTHONPATH, ...)
 236            After the call to these function ALL PATHS ARE NOT REINITIALISED.
 237            There initial value is inherited from the environment
 238         """
 239         self.init_path=False
 240
 241     def value_filter(self, value):
 242         res=value
 243         return res
 244
 245
 246 class TclFileEnviron(FileEnviron):
 247     """\
 248     Class for tcl shell.
 249     """
 250     def __init__(self, output, environ=None):
 251         """Initialization
 252
 253         :param output file: the output file stream.
 254         :param environ dict: a potential additional environment.
 255         """
 256         self._do_init(output, environ)
 257         self.output.write(tcl_header.replace("<module_name>",
 258                                              self.environ.get("sat_product_name")))
 259         self.output.write("\nset software %s\n" % self.environ.get("sat_product_name") )
 260         self.output.write("set version %s\n" % self.environ.get("sat_product_version") )
 261         root=os.path.join(self.environ.get("sat_product_base_path"),
 262                                   "apps",
 263                                   self.environ.get("sat_product_base_name"),
 264                                   "$software",
 265                                   "$version")
 266         self.output.write("set root %s\n" % root)
 267         modules_to_load=self.environ.get("sat_product_load_depend")
 268         if len(modules_to_load)>0:
 269             # write module load commands for product dependencies
 270             self.output.write("\n")
 271             for module_to_load in modules_to_load.split(";"):
 272                 self.output.write(module_to_load+"\n")
 273
 274     def set(self, key, value):
 275         """Set the environment variable "key" to value "value"
 276
 277         :param key str: the environment variable to set
 278         :param value str: the value
 279         """
 280         self.output.write('setenv  %s "%s"\n' % (key, value))
 281         self.environ.set(key, value)
 282
 283     def get(self, key):
 284         """\
 285         Get the value of the environment variable "key"
 286
 287         :param key str: the environment variable
 288         """
 289         return self.environ.get(key)
 290
 291     def append_value(self, key, value, sep=os.pathsep):
 292         """append value to key using sep
 293
 294         :param key str: the environment variable to append
 295         :param value str: the value to append to key
 296         :param sep str: the separator string
 297         """
 298         if sep==os.pathsep:
 299             self.output.write('append-path  %s   %s\n' % (key, value))
 300         else:
 301             self.output.write('append-path --delim=\%c %s   %s\n' % (sep, key, value))
 302
 303     def prepend_value(self, key, value, sep=os.pathsep):
 304         """prepend value to key using sep
 305
 306         :param key str: the environment variable to prepend
 307         :param value str: the value to prepend to key
 308         :param sep str: the separator string
 309         """
 310         if sep==os.pathsep:
 311             self.output.write('prepend-path  %s   %s\n' % (key, value))
 312         else:
 313             self.output.write('prepend-path --delim=\%c %s   %s\n' % (sep, key, value))
 314
 315
 316 class BashFileEnviron(FileEnviron):
 317     """\
 318     Class for bash shell.
 319     """
 320     def __init__(self, output, environ=None):
 321         """Initialization
 322
 323         :param output file: the output file stream.
 324         :param environ dict: a potential additional environment.
 325         """
 326         self._do_init(output, environ)
 327         self.output.write(bash_header)
 328
 329     def set(self, key, value):
 330         """Set the environment variable "key" to value "value"
 331
 332         :param key str: the environment variable to set
 333         :param value str: the value
 334         """
 335         self.output.write('export %s="%s"\n' % (key, value))
 336         self.environ.set(key, value)
 337
 338
 339
 340 class BatFileEnviron(FileEnviron):
 341     """\
 342     for Windows batch shell.
 343     """
 344     def __init__(self, output, environ=None):
 345         """Initialization
 346
 347         :param output file: the output file stream.
 348         :param environ dict: a potential additional environment.
 349         """
 350         self._do_init(output, environ)
 351         self.output.write(bat_header)
 352
 353     def add_comment(self, comment):
 354         """Add a comment in the shell file
 355
 356         :param comment str: the comment to add
 357         """
 358         self.output.write("rem %s\n" % comment)
 359
 360     def get(self, key):
 361         """Get the value of the environment variable "key"
 362
 363         :param key str: the environment variable
 364         """
 365         return '%%%s%%' % key
 366
 367     def set(self, key, value):
 368         """Set the environment variable "key" to value "value"
 369
 370         :param key str: the environment variable to set
 371         :param value str: the value
 372         """
 373         self.output.write('set %s=%s\n' % (key, self.value_filter(value)))
 374         self.environ.set(key, value)
 375
 376
 377 class ContextFileEnviron(FileEnviron):
 378     """Class for a salome context configuration file.
 379     """
 380     def __init__(self, output, environ=None):
 381         """Initialization
 382
 383         :param output file: the output file stream.
 384         :param environ dict: a potential additional environment.
 385         """
 386         self._do_init(output, environ)
 387         self.output.write(cfg_header)
 388
 389     def set(self, key, value):
 390         """Set the environment variable "key" to value "value"
 391
 392         :param key str: the environment variable to set
 393         :param value str: the value
 394         """
 395         self.output.write('%s="%s"\n' % (key, value))
 396         self.environ.set(key, value)
 397
 398     def get(self, key):
 399         """Get the value of the environment variable "key"
 400
 401         :param key str: the environment variable
 402         """
 403         return '%({0})s'.format(key)
 404
 405     def add_echo(self, text):
 406         """Add a comment
 407
 408         :param text str: the comment to add
 409         """
 410         self.add_comment(text)
 411
 412     def add_warning(self, warning):
 413         """Add a warning
 414
 415         :param text str: the warning to add
 416         """
 417         self.add_comment("WARNING %s"  % warning)
 418
 419     def prepend_value(self, key, value, sep=os.pathsep):
 420         """prepend value to key using sep
 421
 422         :param key str: the environment variable to prepend
 423         :param value str: the value to prepend to key
 424         :param sep str: the separator string
 425         """
 426         do_append=True
 427         if self.environ.is_defined(key):
 428             value_list = self.environ.get(key).split(sep)
 429             #value cannot be expanded (unlike bash/bat case) - but it doesn't matter.
 430             if value in value_list:
 431                 do_append=False  # value is already in key path : we don't append it again
 432
 433         if do_append:
 434             self.environ.append_value(key, value,sep)
 435             self.output.write('ADD_TO_%s: %s\n' % (key, value))
 436
 437     def append_value(self, key, value, sep=os.pathsep):
 438         """append value to key using sep
 439
 440         :param key str: the environment variable to append
 441         :param value str: the value to append to key
 442         :param sep str: the separator string
 443         """
 444         self.prepend_value(key, value)
 445
 446
 447 class LauncherFileEnviron(FileEnviron):
 448     """\
 449     Class to generate a launcher file script
 450     (in python syntax) SalomeContext API
 451     """
 452     def __init__(self, output, environ=None):
 453         """Initialization
 454
 455         :param output file: the output file stream.
 456         :param environ dict: a potential additional environment.
 457         """
 458         self._do_init(output, environ)
 459         self.python_version=self.environ.get("sat_python_version")
 460         self.bin_kernel_root_dir=self.environ.get("sat_bin_kernel_install_dir")
 461
 462         # four whitespaces for first indentation in a python script
 463         self.indent="    "
 464         self.prefix="context."
 465         self.setVarEnv="setVariable"
 466         self.begin=self.indent+self.prefix
 467
 468         # write the begining of launcher file.
 469         # choose the template version corresponding to python version
 470         # and substitute BIN_KERNEL_INSTALL_DIR (the path to salomeContext.py)
 471         if self.python_version == 2:
 472             launcher_header=launcher_header2
 473         else:
 474             launcher_header=launcher_header3
 475         # in case of Windows OS, Python scripts are not executable.  PyExe ?
 476         if src.architecture.is_windows():
 477             launcher_header = launcher_header.replace("#! /usr/bin/env python3",'')
 478         self.output.write(launcher_header\
 479                           .replace("BIN_KERNEL_INSTALL_DIR", self.bin_kernel_root_dir))
 480
 481         # for these path, we use specialired functions in salomeContext api
 482         self.specialKeys={"PATH": "Path",
 483                           "LD_LIBRARY_PATH": "LdLibraryPath",
 484                           "PYTHONPATH": "PythonPath"}
 485
 486         # we do not want to reinitialise PATH.
 487         # for that we make sure PATH is in self.environ
 488         # and therefore we will not use setVariable for PATH
 489         if not self.environ.is_defined("PATH"):
 490             self.environ.set("PATH","")
 491
 492
 493     def add_echo(self, text):
 494         """Add a comment
 495
 496         :param text str: the comment to add
 497         """
 498         self.output.write('# %s"\n' % text)
 499
 500     def add_warning(self, warning):
 501         """Add a warning
 502
 503         :param text str: the warning to add
 504         """
 505         self.output.write('# "WARNING %s"\n' % warning)
 506
 507     def append_value(self, key, value, sep=os.pathsep):
 508         """append value to key using sep,
 509         if value contains ":" or ";" then raise error
 510
 511         :param key str: the environment variable to prepend
 512         :param value str: the value to prepend to key
 513         :param sep str: the separator string
 514         """
 515         # check that value so no contain the system separator
 516         separator=os.pathsep
 517         msg="LauncherFileEnviron append key '%s' value '%s' contains forbidden character '%s'"
 518         if separator in value:
 519             raise Exception(msg % (key, value, separator))
 520
 521         if (self.init_path and (not self.environ.is_defined(key))):
 522             # reinitialisation mode set to true (the default)
 523             # for the first occurrence of key, we set it.
 524             # therefore key will not be inherited from environment
 525             self.set(key, value)
 526             return
 527
 528         # in all other cases we use append (except if value is already the key
 529         do_append=True
 530         if self.environ.is_defined(key):
 531             value_list = self.environ.get(key).split(sep)
 532             # rem : value cannot be expanded (unlike bash/bat case) - but it doesn't matter.
 533             if value in value_list:
 534                 do_append=False  # value is already in key path : we don't append it again
 535
 536         if do_append:
 537             self.environ.append_value(key, value,sep) # register value in self.environ
 538             if key in self.specialKeys.keys():
 539                 #for these special keys we use the specific salomeContext function
 540                 self.output.write(self.begin+'addTo%s(r"%s")\n' %
 541                                   (self.specialKeys[key], self.value_filter(value)))
 542             else:
 543                 # else we use the general salomeContext addToVariable function
 544                 self.output.write(self.indent+'appendPath(r"%s", r"%s",separator="%s")\n'
 545                                   % (key, self.value_filter(value), sep))
 546
 547     def append(self, key, value, sep=":"):
 548         """Same as append_value but the value argument can be a list
 549
 550         :param key str: the environment variable to append
 551         :param value str or list: the value(s) to append to key
 552         :param sep str: the separator string
 553         """
 554         if isinstance(value, list):
 555             for v in value:
 556                 self.append_value(key, v, sep)
 557         else:
 558             self.append_value(key, value, sep)
 559
 560     def prepend_value(self, key, value, sep=os.pathsep):
 561         """prepend value to key using sep,
 562         if value contains ":" or ";" then raise error
 563
 564         :param key str: the environment variable to prepend
 565         :param value str: the value to prepend to key
 566         :param sep str: the separator string
 567         """
 568         # check that value so no contain the system separator
 569         separator=os.pathsep
 570         msg="LauncherFileEnviron append key '%s' value '%s' contains forbidden character '%s'"
 571         if separator in value:
 572             raise Exception(msg % (key, value, separator))
 573
 574         if (self.init_path and (not self.environ.is_defined(key))):
 575             # reinitialisation mode set to true (the default)
 576             # for the first occurrence of key, we set it.
 577             # therefore key will not be inherited from environment
 578             self.set(key, value)
 579             return
 580         # in all other cases we use append (except if value is already the key
 581         do_append=True
 582         if self.environ.is_defined(key):
 583             value_list = self.environ.get(key).split(sep)
 584             # rem : value cannot be expanded (unlike bash/bat case) - but it doesn't matter.
 585             if value in value_list:
 586                 do_append=False  # value is already in key path : we don't append it again
 587
 588         if do_append:
 589             self.environ.append_value(key, value,sep) # register value in self.environ
 590             if key in self.specialKeys.keys():
 591                 #for these special keys we use the specific salomeContext function
 592                 self.output.write(self.begin+'addTo%s(r"%s")\n' %
 593                                   (self.specialKeys[key], self.value_filter(value)))
 594             else:
 595                 # else we use the general salomeContext addToVariable function
 596                 self.output.write(self.begin+'addToVariable(r"%s", r"%s",separator="%s")\n'
 597                                   % (key, self.value_filter(value), sep))
 598
 599
 600     def prepend(self, key, value, sep=":"):
 601         """Same as prepend_value but the value argument can be a list
 602
 603         :param key str: the environment variable to prepend
 604         :param value str or list: the value(s) to prepend to key
 605         :param sep str: the separator string
 606         """
 607         if isinstance(value, list):
 608             for v in value:
 609                 self.prepend_value(key, v, sep)
 610         else:
 611             self.prepend_value(key, value, sep)
 612
 613
 614     def set(self, key, value):
 615         """Set the environment variable "key" to value "value"
 616
 617         :param key str: the environment variable to set
 618         :param value str: the value
 619         """
 620         self.output.write(self.begin+self.setVarEnv+
 621                           '(r"%s", r"%s", overwrite=True)\n' %
 622                           (key, self.value_filter(value)))
 623         self.environ.set(key,value)
 624
 625
 626     def add_comment(self, comment):
 627         # Special comment in case of the DISTENE licence
 628         if comment=="DISTENE license":
 629             self.output.write(self.indent+
 630                               "#"+
 631                               self.prefix+
 632                               self.setVarEnv+
 633                               '(r"%s", r"%s", overwrite=True)\n' %
 634                               ('DISTENE_LICENSE_FILE', 'Use global envvar: DLIM8VAR'))
 635             self.output.write(self.indent+
 636                               "#"+
 637                               self.prefix+
 638                               self.setVarEnv+
 639                               '(r"%s", r"%s", overwrite=True)\n' %
 640                               ('DLIM8VAR', '<your licence>'))
 641             return
 642         if "setting environ for" in comment:
 643             self.output.write(self.indent+"#[%s]\n" %
 644                               comment.split("setting environ for ")[1])
 645             return
 646
 647         self.output.write(self.indent+"# %s\n" % comment)
 648
 649     def finish(self):
 650         """\
 651         Add a final instruction in the out file (in case of file generation)
 652         In the particular launcher case, do nothing
 653
 654         :param required bool: Do nothing if required is False
 655         """
 656         if self.python_version == 2:
 657             launcher_tail=launcher_tail_py2
 658         else:
 659             launcher_tail=launcher_tail_py3
 660         self.output.write(launcher_tail)
 661         return
 662
 663 class ScreenEnviron(FileEnviron):
 664     def __init__(self, output, environ=None):
 665         self._do_init(output, environ)
 666         self.defined = {}
 667
 668     def add_line(self, number):
 669         pass
 670
 671     def add_comment(self, comment):
 672         pass
 673
 674     def add_echo(self, text):
 675         pass
 676
 677     def add_warning(self, warning):
 678         pass
 679
 680     def write(self, command, name, value, sign="="):
 681         import src
 682         self.output.write("  %s%s %s %s %s\n" % \
 683             (src.printcolors.printcLabel(command),
 684              " " * (12 - len(command)),
 685              src.printcolors.printcInfo(name), sign, value))
 686
 687     def is_defined(self, name):
 688         return name in self.defined
 689
 690     def get(self, name):
 691         return "${%s}" % name
 692
 693     def set(self, name, value):
 694         self.write("set", name, value)
 695         self.defined[name] = value
 696
 697     def prepend(self, name, value, sep=":"):
 698         if isinstance(value, list):
 699             value = sep.join(value)
 700         value = value + sep + self.get(name)
 701         self.write("prepend", name, value)
 702
 703     def append(self, name, value, sep=":"):
 704         if isinstance(value, list):
 705             value = sep.join(value)
 706         value = self.get(name) + sep + value
 707         self.write("append", name, value)
 708
 709     def run_env_script(self, module, script):
 710         self.write("load", script, "", sign="")
 711
 712
 713 #
 714 #  Headers
 715 #
 716 bat_header="""\
 717 @echo off
 718
 719 rem The following variables are used only in case of a sat package
 720 set out_dir_Path=%~dp0
 721 """
 722
 723 tcl_header="""\
 724 #%Module -*- tcl -*-
 725 #
 726 # <module_name> module for use with 'environment-modules' package
 727 #
 728 """
 729
 730 bash_header="""\
 731 #!/bin/bash
 732 if [ "$BASH" = "" ]
 733 then
 734   # check that the user is not using another shell
 735   echo
 736   echo "Warning! SALOME environment not initialized"
 737   echo "You must run this script in a bash shell."
 738   echo "As you are using another shell. Please first run: bash"
 739   echo
 740 fi
 741 ##########################################################################
 742 #
 743 # This line is used only in case of a sat package
 744 export out_dir_Path=$(cd $(dirname ${BASH_SOURCE[0]});pwd)
 745
 746 ###########################################################################
 747 """
 748
 749 cfg_header="""\
 750 [SALOME Configuration]
 751 """
 752
 753 launcher_header2="""\
 754 #! /usr/bin/env python
 755
 756 ################################################################
 757 # WARNING: this file is automatically generated by SalomeTools #
 758 # WARNING: and so could be overwritten at any time.            #
 759 ################################################################
 760
 761 import os
 762 import sys
 763 import subprocess
 764 import os.path
 765 import imp
 766
 767 # Add the pwdPath to able to run the launcher after unpacking a package
 768 # Used only in case of a salomeTools package
 769 out_dir_Path=os.path.dirname(os.path.realpath(__file__))
 770
 771 # Preliminary work to initialize path to SALOME Python modules
 772 def __initialize():
 773
 774   sys.path[:0] = [ r'BIN_KERNEL_INSTALL_DIR' ]  # to get salomeContext
 775
 776   # define folder to store omniorb config (initially in virtual application folder)
 777   try:
 778     from salomeContextUtils import setOmniOrbUserPath
 779     setOmniOrbUserPath()
 780   except Exception as e:
 781     print(e)
 782     sys.exit(1)
 783 # End of preliminary work
 784
 785 # salome doc only works for virtual applications. Therefore we overwrite it with this function
 786 def _showDoc(modules):
 787     for module in modules:
 788       modulePath = os.getenv(module+"_ROOT_DIR")
 789       if modulePath != None:
 790         baseDir = os.path.join(modulePath, "share", "doc", "salome")
 791         docfile = os.path.join(baseDir, "gui", module.upper(), "index.html")
 792         if not os.path.isfile(docfile):
 793           docfile = os.path.join(baseDir, "tui", module.upper(), "index.html")
 794         if not os.path.isfile(docfile):
 795           docfile = os.path.join(baseDir, "dev", module.upper(), "index.html")
 796         if os.path.isfile(docfile):
 797           out, err = subprocess.Popen(["xdg-open", docfile]).communicate()
 798         else:
 799           print ("Online documentation is not accessible for module:", module)
 800       else:
 801         print (module+"_ROOT_DIR not found!")
 802
 803 def main(args):
 804   # Identify application path then locate configuration files
 805   __initialize()
 806
 807   if args == ['--help']:
 808     from salomeContext import usage
 809     usage()
 810     sys.exit(0)
 811
 812
 813   # Create a SalomeContext which parses configFileNames to initialize environment
 814   try:
 815     from salomeContext import SalomeContext, SalomeContextException
 816     context = SalomeContext(None)
 817
 818     # Here set specific variables, if needed
 819     # context.addToPath('mypath')
 820     # context.addToLdLibraryPath('myldlibrarypath')
 821     # context.addToPythonPath('mypythonpath')
 822     # context.setVariable('myvarname', 'value')
 823
 824     # Logger level error
 825     context.getLogger().setLevel(40)
 826 """
 827
 828 launcher_header3="""\
 829 #! /usr/bin/env python3
 830
 831 ################################################################
 832 # WARNING: this file is automatically generated by SalomeTools #
 833 # WARNING: and so could be overwritten at any time.            #
 834 ################################################################
 835
 836 import os
 837 import sys
 838 import subprocess
 839 import os.path
 840 import imp
 841
 842 # Add the pwdPath to able to run the launcher after unpacking a package
 843 # Used only in case of a salomeTools package
 844 out_dir_Path=os.path.dirname(os.path.realpath(__file__))
 845
 846 # Preliminary work to initialize path to SALOME Python modules
 847 def __initialize():
 848
 849   sys.path[:0] = [ r'BIN_KERNEL_INSTALL_DIR' ]
 850
 851   # define folder to store omniorb config (initially in virtual application folder)
 852   try:
 853     from salomeContextUtils import setOmniOrbUserPath
 854     setOmniOrbUserPath()
 855   except Exception as e:
 856     print(e)
 857     sys.exit(1)
 858 # End of preliminary work
 859
 860 # salome doc only works for virtual applications. Therefore we overwrite it with this function
 861 def _showDoc(modules):
 862     for module in modules:
 863       modulePath = os.getenv(module+"_ROOT_DIR")
 864       if modulePath != None:
 865         baseDir = os.path.join(modulePath, "share", "doc", "salome")
 866         docfile = os.path.join(baseDir, "gui", module.upper(), "index.html")
 867         if not os.path.isfile(docfile):
 868           docfile = os.path.join(baseDir, "tui", module.upper(), "index.html")
 869         if not os.path.isfile(docfile):
 870           docfile = os.path.join(baseDir, "dev", module.upper(), "index.html")
 871         if os.path.isfile(docfile):
 872           out, err = subprocess.Popen(["xdg-open", docfile]).communicate()
 873         else:
 874           print("Online documentation is not accessible for module:", module)
 875       else:
 876         print(module+"_ROOT_DIR not found!")
 877
 878 def main(args):
 879   # Identify application path then locate configuration files
 880   __initialize()
 881
 882   if args == ['--help']:
 883     from salomeContext import usage
 884     usage()
 885     sys.exit(0)
 886
 887   #from salomeContextUtils import getConfigFileNames
 888   #configFileNames, args, unexisting = getConfigFileNames( args, checkExistence=True )
 889   #if len(unexisting) > 0:
 890   #  print("ERROR: unexisting configuration file(s): " + ', '.join(unexisting))
 891   #  sys.exit(1)
 892
 893   # Create a SalomeContext which parses configFileNames to initialize environment
 894   try:
 895     from salomeContext import SalomeContext, SalomeContextException
 896     context = SalomeContext(None)
 897
 898     # Here set specific variables, if needed
 899     # context.addToPath('mypath')
 900     # context.addToLdLibraryPath('myldlibrarypath')
 901     # context.addToPythonPath('mypythonpath')
 902     # context.setVariable('myvarname', 'value')
 903
 904     # Logger level error
 905     context.getLogger().setLevel(40)
 906 """
 907
 908 launcher_tail_py2="""\
 909     #[hook to integrate in launcher additionnal user modules]
 910
 911     # Load all files extra.env.d/*.py and call the module's init routine]
 912
 913     extradir=out_dir_Path + r"/extra.env.d"
 914
 915     if os.path.exists(extradir):
 916         sys.path.insert(0, os.path.join(os.getcwd(), extradir))
 917         for filename in sorted(
 918             filter(lambda x: os.path.isfile(os.path.join(extradir, x)),
 919                    os.listdir(extradir))):
 920
 921             if filename.endswith(".py"):
 922                 f = os.path.join(extradir, filename)
 923                 module_name = os.path.splitext(os.path.basename(f))[0]
 924                 fp, path, desc = imp.find_module(module_name)
 925                 module = imp.load_module(module_name, fp, path, desc)
 926                 module.init(context, out_dir_Path)
 927
 928     #[manage salome doc command]
 929     if len(args) >1 and args[0]=='doc':
 930         _showDoc(args[1:])
 931         return
 932
 933     # Start SALOME, parsing command line arguments
 934     out, err, status = context.runSalome(args)
 935     sys.exit(status)
 936
 937   except SalomeContextException, e:
 938     import logging
 939     logging.getLogger("salome").error(e)
 940     sys.exit(1)
 941 #
 942 # salomeContext only prepend variables, we use our own appendPath when required
 943 def appendPath(name, value, separator=os.pathsep):
 944     if value == '':
 945       return
 946
 947     value = os.path.expandvars(value) # expand environment variables
 948     env = os.getenv(name, None)
 949     if env is None:
 950       os.environ[name] = value
 951     else:
 952       os.environ[name] = env + separator + value
 953
 954
 955 if __name__ == "__main__":
 956   args = sys.argv[1:]
 957   main(args)
 958 #
 959 """
 960
 961 launcher_tail_py3="""\
 962     #[hook to integrate in launcher additionnal user modules]
 963
 964     # Load all files extra.env.d/*.py and call the module's init routine]
 965
 966     extradir=out_dir_Path + r"/extra.env.d"
 967
 968     if os.path.exists(extradir):
 969         sys.path.insert(0, os.path.join(os.getcwd(), extradir))
 970         for filename in sorted(
 971             filter(lambda x: os.path.isfile(os.path.join(extradir, x)),
 972                    os.listdir(extradir))):
 973
 974             if filename.endswith(".py"):
 975                 f = os.path.join(extradir, filename)
 976                 module_name = os.path.splitext(os.path.basename(f))[0]
 977                 fp, path, desc = imp.find_module(module_name)
 978                 module = imp.load_module(module_name, fp, path, desc)
 979                 module.init(context, out_dir_Path)
 980
 981     #[manage salome doc command]
 982     if len(args) >1 and args[0]=='doc':
 983         _showDoc(args[1:])
 984         return
 985
 986     # Start SALOME, parsing command line arguments
 987     out, err, status = context.runSalome(args)
 988     sys.exit(status)
 989
 990   except SalomeContextException as e:
 991     import logging
 992     logging.getLogger("salome").error(e)
 993     sys.exit(1)
 994
 995 # salomeContext only prepend variables, we use our own appendPath when required
 996 def appendPath(name, value, separator=os.pathsep):
 997     if value == '':
 998       return
 999
1000     value = os.path.expandvars(value) # expand environment variables
1001     env = os.getenv(name, None)
1002     if env is None:
1003       os.environ[name] = value
1004     else:
1005       os.environ[name] = env + separator + value
1006
1007
1008 if __name__ == "__main__":
1009   args = sys.argv[1:]
1010   main(args)
1011 #
1012 """
1013
1014