runInstall

   1 #!/usr/bin/env python
   2
   3 """
   4 Installation Wizard launching script.
   5
   6 This script is the part of the SALOME installation procedure.
   7 Author    : Vadim SANDLER, Open CASCADE SAS (vadim.sandler@opencascade.com)
   8 Created   : Thu Dec 18 12:01:00 2002
   9 Copyright : 2002-2014 CEA
  10
  11 """
  12
  13 __version__ = "1.1.5"
  14
  15 # --- imports --- #
  16 import sys
  17 try:
  18     import xml.sax, xml.dom.minidom
  19     import os, re
  20     import types
  21     import random
  22     import warnings
  23 except Exception, an_exc:
  24     sys.exit("Error: %s! Please check the installed Python package." % str(an_exc))
  25     pass
  26
  27 # --- avoid "deprecation" warnings --- #
  28 warnings.filterwarnings("ignore", "", DeprecationWarning)
  29
  30 # --- global variables --- #
  31 opt_parser = None
  32 root_path  = None
  33
  34 # --- actions definition --- #
  35 __BINARIES__   = "install_binary"
  36 __BUILDSRC__   = "install_source_and_build"
  37 __PREINSTALL__ = "try_preinstalled"
  38
  39 # --- product type definition --- #
  40 __CTX__COMPONENT__    = "component"
  41 __CTX__PREREQUISITE__ = "prerequisite"
  42
  43 #------------------------------------------------------------------#
  44 #                                                                  #
  45 #                 COMMAND LINE ARGUMENTS PARSER                    #
  46 #                                                                  #
  47 #------------------------------------------------------------------#
  48
  49 #===================================================================
  50 # class OptBaseError : base parse error
  51 #===================================================================
  52 class OptBaseError(Exception):
  53     """
  54     Base option parsing exception class
  55     """
  56     def __init__(self, msg):
  57         self.msg = msg
  58     def __str__ (self):
  59         return self.msg
  60
  61 #===================================================================
  62 # class OptError : bad option error
  63 #===================================================================
  64 class OptError(OptBaseError):
  65     """
  66     Bad option exception class
  67     """
  68     def __init__ (self, msg, option):
  69         self.msg = msg
  70         self.option = option
  71     def __str__ (self):
  72         if self.option:
  73             opt_prs = "<unknown>"
  74             if self.option.short_opt and self.option.long_opt:
  75                 opt_prs = "%s/%s"%(self.option.short_opt,self.option.long_opt)
  76             elif self.option.short_opt:
  77                 opt_prs = "%s"%(self.option.short_opt)
  78             elif self.option.long_opt:
  79                 opt_prs = "%s"%(self.option.long_opt)
  80             return "option %s: %s"%(opt_prs, self.msg)
  81         return self.msg
  82
  83 #===================================================================
  84 # class ArgError : bad option argument error
  85 #===================================================================
  86 class ArgError(OptBaseError):
  87     """
  88     Bad argument exception class
  89     """
  90     pass
  91
  92 #===================================================================
  93 # class ValError : bad command line parameter error
  94 #===================================================================
  95 class ValError(OptBaseError):
  96     """
  97     Bad parameter exception class
  98     """
  99     pass
 100
 101 #===================================================================
 102 # class ArgOption : command line option
 103 #===================================================================
 104 class ArgOption:
 105     """
 106     Option class
 107     """
 108     attrs   = ["short_opt", "long_opt", "dest", "action", "type", "default", "metavar", "help"]
 109     actions = ["store", "store_true", "store_false"]
 110     types   = ["string", "int", "float", "bool"]
 111     def __init__(self, *args, **kwargs):
 112         # set defaults
 113         for attr in self.attrs: setattr(self, attr, None)
 114         # parse arguments
 115         for i in range(len(args)):
 116             if i > len(self.attrs)-1:
 117                 msg = "Wrong number of parameters is given (maximum is %d)" % len(self.attrs)
 118                 raise OptBaseError(msg)
 119             setattr(self, self.attrs[i], args[i])
 120         for arg in kwargs:
 121             if arg not in self.attrs:
 122                 msg = "Invalid argument: %s" % arg
 123                 raise OptBaseError(msg)
 124             setattr(self, arg, kwargs[arg])
 125         # check short option key
 126         if self.short_opt and \
 127                not re.match("^-[a-zA-Z]$",self.short_opt):
 128             msg  = "invalid short option key; "
 129             msg += "should be of the form -x (x is letter)"
 130             raise OptError(msg, self)
 131         # check long option key
 132         if self.long_opt and \
 133                not re.match("^--[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$",self.long_opt):
 134             msg  = "invalid long option key; "
 135             msg += "should be of the form --word[[-word]...] "
 136             msg += "(word is letters and digits sequence)"
 137             raise OptError(msg, self)
 138         # check that at least one option key is defined
 139         if not self.short_opt and not self.long_opt:
 140             msg  = "invalid option; neither short nor long option key is defined"
 141             raise OptError(msg, self)
 142         # destination
 143         if not self.dest and self.long_opt:
 144             self.dest = self.long_opt[2:].replace('-','_')
 145         if not self.dest and self.short_opt:
 146             self.dest = self.short_opt[1:]
 147         # action
 148         if not self.action:
 149             self.action = "store"
 150         if self.action not in self.actions:
 151             msg  = "invalid action: %s" % self.action
 152             raise OptError(msg, self)
 153         # type
 154         if not self.type:
 155             if self.action in ["store_true","store_false"]: self.type = "bool"
 156             else: self.type = "string"
 157         if self.type not in self.types:
 158             msg  = "invalid type: %s" % self.type
 159             raise OptError(msg, self)
 160         if self.action in ["store_true","store_false"] and self.type != "bool":
 161             msg  = "invalid type: %s : should be 'bool' or None" % self.type
 162             raise OptError(msg, self)
 163         # default
 164         if self.default is not None:
 165             try:
 166                 if self.type == "string": self.default = str(self.default)
 167                 if self.type == "int":    self.default = int(self.default)
 168                 if self.type == "float":  self.default = float(self.default)
 169                 if self.type == "bool":   self.default = boolean(self.default)
 170             except :
 171                 msg  = "invalid default value type: should be %s" % self.type
 172                 raise OptError(msg, self)
 173             pass
 174         # metavar
 175         if not self.metavar:
 176             self.metavar = self.dest.upper()
 177         # help
 178         if not self.help:
 179             self.help = ""
 180         pass
 181
 182     def to_string(self):
 183         """
 184         Returns string representation of the option
 185         """
 186         opts = []
 187         opt = self.short_opt
 188         if opt and self.action == "store" and self.metavar: opt += " %s" % self.metavar
 189         if opt: opts.append(opt)
 190         opt = self.long_opt
 191         if opt and self.action == "store" and self.metavar: opt += "=%s" % self.metavar
 192         if opt: opts.append(opt)
 193         return (", ").join(opts)
 194
 195 #===================================================================
 196 # class Values : resulting option values
 197 #===================================================================
 198 class Values:
 199     """
 200     Values class
 201     """
 202     def __init__(self):
 203         pass
 204
 205 #===================================================================
 206 # class ArgParser : command line arguments parser
 207 #===================================================================
 208 class ArgParser:
 209     """
 210     Arguments parser class
 211     """
 212     def __init__(self):
 213         self.options = []
 214         pass
 215
 216     def add_option(self, *args, **kwargs):
 217         """Register an option"""
 218         o = ArgOption(*args, **kwargs)
 219         self._check_option(o)
 220         self.options.append(o)
 221         pass
 222
 223     def parse_args(self, args = None):
 224         """Parse an arguments"""
 225         if not args: args = sys.argv[1:]
 226         values = Values()
 227         for o in self.options:
 228             if o.default is not None:
 229                 setattr(values, o.dest, o.default)
 230             elif not hasattr(values,o.dest):
 231                 setattr(values, o.dest, None)
 232         try:
 233             (values, args) = self._process_args(values, args)
 234         except (ArgError, ValError), e:
 235             self._error(e.msg)
 236
 237         return (values, args)
 238
 239     def print_usage(self):
 240         """Print usage"""
 241         print "usage: %s [options]" % os.path.basename(sys.argv[0])
 242         pass
 243
 244     def print_help(self):
 245         """Print help"""
 246         self.print_usage()
 247         print ""
 248         olen = 0
 249         _maxwidth, _indent = 79, 2
 250         if len(self.options):
 251             for option in self.options:
 252                 if olen < len(option.to_string()): olen = len(option.to_string())
 253             print "options:"
 254             for option in self.options:
 255                 strings = []
 256                 for hs in option.help.split("\n"):
 257                     s = ""
 258                     for w in hs.split():
 259                         if len("%s %s" % (s,w)) > _maxwidth:
 260                             strings.append(s.strip()); s = ""
 261                         s = "%s %s" % (s,w)
 262                     if s.strip(): strings.append(s.strip())
 263                 if not strings: strings[:0] = [""]
 264                 print "%s%s%s" % (option.to_string(), " "*(_indent+olen-len(option.to_string())), strings[0])
 265                 for i in range(1, len(strings)):
 266                     print "%s%s" % (" "*(olen+_indent), strings[i])
 267         pass
 268
 269     def _check_option(self, option):
 270         o = self._get_option(option.short_opt)
 271         if not o: o = self._get_option(option.long_opt)
 272         if o:
 273             msg = "option conflicts with previously defined option(s)"
 274             raise OptError(msg, option)
 275         pass
 276
 277     def _get_option(self, opt_key):
 278         if opt_key:
 279             for o in self.options:
 280                 if opt_key in [o.short_opt, o.long_opt]: return o
 281         return None
 282
 283     def _error(self, msg):
 284         self.print_usage()
 285         sys.exit("\n%s: error: %s\n" % (os.path.basename(sys.argv[0]), msg))
 286         pass
 287
 288     def _check_value(self, option, value):
 289         o = self._get_option(option)
 290         try:
 291             if o.type == "string": return str(value)
 292             if o.type == "int":    return int(value)
 293             if o.type == "float":  return float(value)
 294             if o.type == "bool":   return boolean(value)
 295         except:
 296             msg  = "invalid value type for option %s: %s; " % (option, value)
 297             msg += "should be %s" % o.type
 298             raise ValError(msg)
 299         raise OptBaseError("unknown error")
 300
 301     def _process_args(self, values, args):
 302         res_args = []
 303         cur_opt = None
 304         rargs   = []
 305         for index in range(len(args)):
 306             a = args[index]
 307             if cur_opt and cur_opt[1].action == "store":
 308                 setattr(values, cur_opt[1].dest, self._check_value(cur_opt[0], a))
 309                 cur_opt = None
 310                 continue
 311             if a == "-":
 312                 rargs = args[index+1:]
 313                 break
 314             elif re.match("^-[a-zA-Z].*", a):
 315                 for i in range(1,len(a)):
 316                     if cur_opt and cur_opt[1].action == "store":
 317                         setattr(values, cur_opt[1].dest, self._check_value(cur_opt[0], a[i:]))
 318                         cur_opt = None
 319                         break
 320                     o = self._get_option("-%s"%a[i])
 321                     if not o:
 322                         raise ArgError("no such option: -%s"%a[i])
 323                     if o.action == "store_true":
 324                         setattr(values, o.dest, True)
 325                     elif o.action == "store_false":
 326                         setattr(values, o.dest, False)
 327                     else:
 328                         cur_opt = ("-%s"%a[i], o)
 329                 pass
 330             elif re.match("^--[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*", a):
 331                 oname  = ("%s="%a).split("=")[0]
 332                 ovalue = ("%s="%a).split("=")[1]
 333                 o = self._get_option(oname)
 334                 if not o:
 335                     raise ArgError("no such option: %s" % oname)
 336                 if o.action == "store_true":
 337                     if ovalue:
 338                         raise ValError("option %s does not take a value" % oname)
 339                     setattr(values, o.dest, True)
 340                 elif o.action == "store_false":
 341                     if ovalue:
 342                         raise ValError("option %s does not take a value" % oname)
 343                     setattr(values, o.dest, False)
 344                 else:
 345                     if ovalue:
 346                         setattr(values, o.dest, self._check_value(oname, ovalue))
 347                     else:
 348                         cur_opt = (oname, o)
 349                 pass
 350             elif a.startswith("-"):
 351                 raise ArgError("bad formatted option: %s" % a)
 352             else:
 353                 rargs = args[index:]
 354                 break
 355         if cur_opt and cur_opt[1].action == "store":
 356             raise ValError("option %s requires value" % cur_opt[0])
 357         return (values, rargs)
 358
 359 #------------------------------------------------------------------#
 360 #                                                                  #
 361 #                 XML CONFIGURATION FILES PARSER                   #
 362 #                                                                  #
 363 #------------------------------------------------------------------#
 364
 365 #===================================================================
 366 # class Config : general configuration options : version, target and
 367 #                temporary directories, etc...
 368 #===================================================================
 369 class Config :
 370     """
 371     General configuration file options:
 372     - Install Wizard window caption
 373     - SALOME platform version
 374     - Copyright and license info
 375     - Default target and temporary directories
 376     - List of optional libraries for Salome
 377     """
 378     def __init__(self,
 379                  theVersion   = None,
 380                  theCaption   = None,
 381                  theCopyright = None,
 382                  theLicense   = None,
 383                  thePlatforms = None,
 384                  theTargetdir = None,
 385                  theTmpdir    = None,
 386                  theOptLibs   = None):
 387         self.version   = strip(theVersion)
 388         self.caption   = strip(theCaption)
 389         self.copyright = strip(theCopyright)
 390         self.license   = strip(theLicense)
 391         self.platforms = strip(thePlatforms)
 392         self.targetdir = strip(theTargetdir)
 393         self.tmpdir    = strip(theTmpdir)
 394         self.optlibs   = strip(theOptLibs)
 395
 396 #==============================================================
 397 # class Product : pre-requisite product options
 398 #==============================================================
 399 class Product :
 400     """
 401     Product options:
 402     - name, version
 403     - target Linux OS version
 404     - dependencies
 405     - required disk space
 406     - installation script
 407     - etc...
 408     """
 409     def __init__(self,
 410                  theName,
 411                  theType               = None,
 412                  theOS                 = None,
 413                  theVersion            = None,
 414                  theDependencies       = None,
 415                  theWoGuiInstallation  = None,
 416                  theInstalldiskspace   = None,
 417                  theScript             = None,
 418                  thePickUpEnvironment  = None):
 419         self.name               = strip(theName)
 420         self.type               = strip(theType)
 421         self.os                 = strip(theOS)
 422         self.version            = strip(theVersion)
 423         self.dependencies       = strip(theDependencies)
 424         self.woguiinst          = strip(theWoGuiInstallation)
 425         self.installdiskspace   = strip(theInstalldiskspace)
 426         self.script             = strip(theScript)
 427         self.pickupEnv          = strip(thePickUpEnvironment)
 428         self.whattodo           = __BINARIES__
 429
 430     def setMode(self, mode):
 431         if mode not in [__BINARIES__, __BUILDSRC__, __PREINSTALL__]:
 432             return
 433         self.whattodo = mode
 434         return
 435
 436 #===================================================================
 437 # class ConfigParser : XML files parser implementation
 438 #===================================================================
 439 class ConfigParser:
 440     """
 441     XML configuration files parser
 442     """
 443     def __init__(self, is_force_src=False, pltname=None):
 444         self.docElem = None
 445         self.products = []
 446         self.full_prods_list = []
 447         self.config = None
 448         self.is_force_src = is_force_src
 449         self.pltname = pltname
 450         pass
 451
 452     def parse_config(self):
 453         # Parse 'config' part of the XML file
 454         configElem = self.docElem.getElementsByTagName('config')[0]
 455
 456         self.config = Config(configElem.getAttribute('version').strip(),
 457                              configElem.getAttribute('caption').strip(),
 458                              configElem.getAttribute('copyright').strip(),
 459                              configElem.getAttribute('license').strip(),
 460                              configElem.getAttribute('platforms').strip(),
 461                              configElem.getAttribute('targetdir').strip(),
 462                              configElem.getAttribute('tempdir').strip(),
 463                              configElem.getAttribute('optionallibs').strip())
 464         if not self.pltname and self.config.platforms:
 465             self.pltname = self.config.platforms.split(",")[0].strip()
 466         pass
 467
 468     def parse_dependencies(self):
 469         # Parse 'dependencies' part of the XML file
 470         depsMap = {}
 471         depsElem = self.docElem.getElementsByTagName('dependencies')[0]
 472         for prodElem in depsElem.getElementsByTagName('product'):
 473             prodName = prodElem.getAttribute('name').strip()
 474             if not prodName: continue
 475             depsList = []
 476             for depElem in prodElem.getElementsByTagName('dep'):
 477                 depsList.append(depElem.firstChild.data)
 478                 pass
 479             depsMap[prodName] = depsList
 480             pass
 481         return depsMap
 482
 483     def parse_product(self):
 484         # Parse 'products' part of the XML file
 485         depsMap = self.parse_dependencies()
 486         prodsElem = self.docElem.getElementsByTagName('products')[0]
 487         sal_prods_list = []; req_prods_list = []
 488         modules_list = []; prereqs_list = []
 489         for prodElem in prodsElem.getElementsByTagName('product'):
 490             prodName = prodElem.getAttribute('name').strip()
 491             if not prodName: continue
 492             instElems = prodElem.getElementsByTagName('installation')
 493             instElem = None
 494             for node in instElems:
 495                 if not self.pltname or self.pltname == node.getAttribute('os').strip():
 496                     instElem = node
 497                     break
 498                 pass
 499             if not instElem: continue
 500             if check_bool(str(instElem.getAttribute('disable').strip())): continue
 501             depsList = []
 502             if prodName in depsMap: depsList = depsMap[prodName]
 503             aProduct = Product(prodName,
 504                                prodElem.getAttribute('type').strip(),
 505                                instElem.getAttribute('os').strip(),
 506                                instElem.getAttribute('version').strip(),
 507                                depsList,
 508                                instElem.getAttribute('woguimode').strip(),
 509                                instElem.getAttribute('installdiskspace').strip(),
 510                                instElem.getAttribute('script').strip(),
 511                                instElem.getAttribute('pickupenv').strip())
 512             if self.is_force_src:
 513                 aProduct.setMode(__BUILDSRC__)
 514                 pass
 515             if prodElem.getAttribute('type').strip() == "component":
 516                 sal_prods_list.append(aProduct)
 517                 # fill an ordered modules list -----------
 518                 modules_list.append(prodName)
 519                 modules_list.append(prodName + "_src")
 520                 pass
 521             else: #prerequisite
 522                 req_prods_list.append(aProduct)
 523                 # fill an ordered prerequisites list -----------
 524                 prereqs_list.append(prodName)
 525                 #AKL: prerequisite sources and temp files are removed, by default.
 526                 #     So, there is no need to make sources environment
 527                 #if aProduct.whattodo == __BUILDSRC__: prereqs_list.append(prodName + "_src")
 528                 pass
 529             pass
 530         self.products.extend( req_prods_list )
 531         self.products.extend( sal_prods_list )
 532         self.full_prods_list.extend( prereqs_list )
 533         self.full_prods_list.extend( modules_list )
 534         pass
 535
 536     def parse(self, xml_file):
 537         filehandle = open(xml_file)
 538         sax_parser = xml.sax.make_parser()
 539         doc = xml.dom.minidom.parse(filehandle, sax_parser)
 540         filehandle.close()
 541
 542         self.docElem = doc.documentElement
 543         self.parse_config()
 544         self.parse_product()
 545         pass
 546
 547     def getProduct(self, prod):
 548         for product in self.products:
 549             if product.name == prod:
 550                 return product
 551         return None
 552
 553
 554 #------------------------------------------------------------------#
 555 #                                                                  #
 556 #                         SERVICE FUNCTIONS                        #
 557 #                                                                  #
 558 #------------------------------------------------------------------#
 559
 560 #==============================================================
 561 # message: prints diagnostic information
 562 #==============================================================
 563 def message(msg):
 564     """
 565     Prints diagnostic information.
 566     """
 567     if msg.strip():
 568         print ">>>", msg
 569     pass
 570
 571 #==============================================================
 572 # warning: prints warning
 573 #==============================================================
 574 def warning(msg):
 575     """
 576     Prints warning.
 577     """
 578     if msg.strip():
 579         print ""
 580         print msg
 581         print ""
 582     pass
 583
 584 #==============================================================
 585 # error_exit : prints (optionally) error string, then prints
 586 #              help information and quits
 587 #==============================================================
 588 def error_exit(msg = "", print_help = True):
 589     """
 590     Prints (optionally) error string,
 591     then prints help information and quits.
 592     """
 593     # print error message
 594     if len(msg.strip()):
 595         print ""
 596         print msg
 597         print ""
 598     # print help information
 599     if print_help:
 600         global opt_parser
 601         if opt_parser:
 602             opt_parser.print_help()
 603             print ""
 604     # cleaning
 605     clean_all()
 606     # quit
 607     sys.exit(1);
 608     pass
 609
 610 #==============================================================
 611 # boolean : Converts string to boolean value.
 612 #==============================================================
 613 def boolean(val):
 614     """
 615     Converts string to boolean value if possible.
 616     Raises exception if wrong string is used.
 617     """
 618     if isinstance(val, types.StringType):
 619         if val.strip().lower()   in ["true",  "yes", "ok"]     : return True
 620         elif val.strip().lower() in ["false", "no",  "cancel"] : return False
 621         else: raise TypeError("invalid boolean value")
 622     return bool(val)
 623
 624 #=================================================================
 625 # check_bool : checks boolean value: yes/no, true/false, 1/0
 626 #=================================================================
 627 def check_bool(val):
 628     """
 629     Checks boolean value.
 630     """
 631     try:
 632         return boolean(val)
 633     except:
 634         pass
 635     return False
 636
 637 #==============================================================
 638 # clean_all : performs system cleaning before exiting
 639 #==============================================================
 640 def clean_all():
 641     """
 642     Performs system cleaning before exiting.
 643     """
 644     global root_path
 645     remove_dir(root_path)
 646     pass
 647
 648 #==============================================================
 649 # parse_parameters : parses command line arguments
 650 #==============================================================
 651 def parse_parameters():
 652     """
 653     Parses command line arguments.
 654     """
 655     global opt_parser
 656     opt_parser = ArgParser()
 657
 658     help_str  = "Runs the Installation Wizard in the GUI mode [default].\n"
 659     opt_parser.add_option("-g",
 660                           "--gui",
 661                           action="store_true",
 662                           dest="gui",
 663                           default=True,
 664                           help=help_str)
 665     help_str  = "Runs the Installation Wizard in the TUI mode."
 666     opt_parser.add_option("-b",
 667                           "--batch",
 668                           action="store_false",
 669                           dest="gui",
 670                           help=help_str)
 671     help_str  = "The configuration xml file.\n"
 672     help_str += "If this parameter is missing, then the program tries to define the "
 673     help_str += "Linux platform and use the corresponding xml file. For example, "
 674     help_str += "for Red Hat 8.0 config_RedHat_8.0.xml file is used in this case. "
 675     opt_parser.add_option("-f",
 676                           "--file",
 677                           action="store",
 678                           dest="xmlfile",
 679                           metavar="FILE",
 680                           help=help_str)
 681     help_str  = "The platform specification.\n"
 682     help_str += "This option can be used in conjunction with --file option in order"
 683     help_str += "to specify Linux platform name when XML file contains installation"
 684     help_str += "options for several platforms."
 685     opt_parser.add_option("-p",
 686                           "--platform",
 687                           action="store",
 688                           dest="platform",
 689                           metavar="PLT",
 690                           help=help_str)
 691     help_str  = "The target directory the products to be installed to.\n"
 692     help_str += "When used this parameter overrides the default target directory "
 693     help_str += "defined in the configuration xml file."
 694     opt_parser.add_option("-d",
 695                           "--target",
 696                           action="store",
 697                           dest="target_dir",
 698                           metavar="DIR",
 699                           help=help_str)
 700     help_str  = "The directory to be used for temporary files.\n"
 701     help_str += "When used this parameter overrides the default temporary directory "
 702     help_str += "defined in the configuration xml file."
 703     opt_parser.add_option("-t",
 704                           "--tmp",
 705                           action="store",
 706                           dest="tmp_dir",
 707                           metavar="DIR",
 708                           help=help_str)
 709     help_str  = "Force all products to be installed from sources \n"
 710     help_str += "including SALOME modules.\n"
 711     help_str += "If this option is used all the default installation modes are ignored."
 712     opt_parser.add_option("-a",
 713                           "--all-from-sources",
 714                           action="store_true",
 715                           dest="force_sources",
 716                           default=False,
 717                           help=help_str)
 718     help_str  = "Install all SALOME binaries packages to one directory.\n"
 719     help_str += "This option is ignored when --all-from-sources (-a) option is used."
 720     opt_parser.add_option("-s",
 721                           "--single-directory",
 722                           action="store_true",
 723                           dest="single_dir",
 724                           default=False,
 725                           help=help_str)
 726     help_str  = "Prints version information and quits."
 727     opt_parser.add_option("-v",
 728                           "--version",
 729                           action="store_true",
 730                           help=help_str)
 731     help_str  = "Prints this help and quits."
 732     opt_parser.add_option("-h",
 733                           "--help",
 734                           action="store_true",
 735                           help=help_str)
 736     (options, args) = opt_parser.parse_args()
 737     if options.help:
 738         # print help info and quit
 739         print "\nSALOME Installation Wizard (running on %s)\n" % get_os_name()
 740         opt_parser.print_help()
 741         print ""
 742         sys.exit(0)
 743     if options.version:
 744         # print version info and quit
 745         print ""
 746         cmd = "./bin/SALOME_InstallWizard --version"
 747         os.system(cmd)
 748         print ""
 749         sys.exit(0)
 750     return [options.xmlfile, options.target_dir, options.tmp_dir, options.gui, options.force_sources, options.single_dir, options.platform]
 751
 752 #=================================================================
 753 # strip : removes spaces at the beginning and at the end of the
 754 #         <param> if it is of string type
 755 #=================================================================
 756 def strip(param):
 757     """
 758     Removes spaces at the beginning and at the end
 759     of the given parameter.
 760     """
 761     if type(param) == types.StringType:
 762         return param.strip()
 763     return param
 764
 765 #=================================================================
 766 # get_dependencies : extract products dependencies
 767 #=================================================================
 768 def get_dependencies(prods):
 769     """
 770     Gets a list of installed and required products.
 771     """
 772     prods_list = []
 773     for product in prods:
 774         for dep in product.dependencies:
 775             if dep and dep not in prods_list:
 776                 prods_list.append( dep )
 777                 dep_name = dep
 778                 if product.whattodo == __BUILDSRC__:
 779                     dep_name = dep + "_src"
 780                 if dep_name not in parser.full_prods_list:
 781                     msg = "Prerequisite '%s' is required for '%s' product,\n"%(dep, product.name)
 782                     msg += "but the first one is absent in the list of products to be installed!\n"
 783                     msg += "Please check your XML file."
 784                     warning(msg)
 785
 786         if product.name and product.name not in prods_list:
 787             prods_list.append( product.name )
 788
 789     return " ".join( prods_list )
 790
 791 #==============================================================
 792 # create_dir : creates a directory with (optional) permissions,
 793 #              returns the part of path that existed before
 794 #              directory creation; exits with error if access
 795 #              is denied
 796 #==============================================================
 797 def create_dir(directory, access = 0777):
 798     """
 799     Creates a directory with (optional) permissions,
 800     returns the part of path that existed before
 801     directory creation; exits with error if access
 802     is denied.
 803     """
 804     dirs = directory.split("/")
 805     existing = "";
 806     dir = ""
 807     root = ""
 808     for subdir in dirs:
 809         if len(subdir) == 0:  continue
 810         dir = "%s/%s"%(dir, subdir)
 811         if os.path.exists(dir):
 812             existing = dir
 813         else:
 814             try:
 815                 os.mkdir(dir, access)
 816             except:
 817                 error_exit("Can't create directory: %s.\nAccess is denied."%directory)
 818             if dir == "%s/%s"%(existing, subdir):
 819                 root = dir
 820     return root
 821
 822 #==============================================================
 823 # substituteVars : performes environment variables substistution
 824 #                  the given string; if varibale is not defined
 825 #                  it is substituted by the empty string
 826 #==============================================================
 827 def substituteVars(str):
 828     """
 829     Performes environment variables substistution.
 830     """
 831     str = os.path.expanduser(str)
 832     str = os.path.expandvars(str)
 833     return str
 834
 835 #================================================================
 836 # get_program_path : gets program's directory path
 837 #                    (and performs 'cd' command there)
 838 #================================================================
 839 def get_program_path():
 840     """
 841     Returns the program directory path
 842     (and make this directory current).
 843     """
 844     path = os.path.dirname(sys.argv[0])
 845     if path:
 846         os.chdir(path)
 847     return os.getcwd()
 848
 849 #================================================================
 850 # check_dir : checks directory existence
 851 #================================================================
 852 def check_dir(dir):
 853     """
 854     Checks directory existence.
 855     """
 856     if (os.path.islink(dir)):
 857         realpath = os.path.realpath(dir)
 858         if not os.path.exists(realpath):
 859             msg = "Invalid link %s.\nThe directory %s a link points to does not exist. Stopped..."%(dir,realpath)
 860             error_exit(msg, False)
 861     else:
 862         if not os.path.exists(dir):
 863             msg = "Directory %s does not exist. Stopped..."%dir
 864             error_exit(msg, False)
 865     pass
 866
 867 #===============================================================
 868 # check_disk_space : checks the disk space;
 869 #                    quits if there is no enough disk space
 870 #===============================================================
 871 def check_disk_space(products, scripts_dir, target_dir, tmp_dir, is_force_src=False):
 872     """
 873     Checks if there is enough disk space to install products.
 874     Quits with error if there is no enough disk space.
 875     """
 876     install_space = 0
 877     temporary_space = 0
 878     for product in products:
 879         prod_space = 0
 880         try:
 881             spaces = product.installdiskspace.split(',')
 882             prod_space = int( spaces[0] )
 883             if product.whattodo == __BINARIES__:
 884                 prod_space = int( spaces[0] )
 885                 if product.type == __CTX__COMPONENT__:
 886                     prod_space += int( spaces[1] )
 887             else:
 888                 if product.type == __CTX__PREREQUISITE__:
 889                     prod_space = int( spaces[0] )
 890                 else:
 891                     prod_space = int( spaces[2] )
 892         except:
 893             pass
 894         install_space = install_space + prod_space
 895         pass
 896
 897     res = os.system("%s/%s %s %d"%(scripts_dir, "checkSize.sh", target_dir, install_space))
 898     if res:
 899         msg = "There is no enough space to install the products. Stopped..."
 900         error_exit(msg, False)
 901     pass
 902
 903 #===============================================================
 904 # remove_dir : removes temporary directory
 905 #===============================================================
 906 def remove_dir(path):
 907     """
 908     Removes temporary directory.
 909     """
 910     if path and os.path.exists(path):
 911         os.system("rm -rf " + path)
 912     pass
 913
 914 #==============================================================
 915 # has_binaries : returns True if some product is installed from
 916 #                binaries
 917 #===============================================================
 918 def has_binaries(products):
 919     """
 920     Returns True if some product is installed in 'binaries' mode.
 921     """
 922     for product in products:
 923         if product.whattodo == __BINARIES__:
 924             return True
 925     return False
 926
 927 #==============================================================
 928 # has_sources : returns True if some product is installed from
 929 #               sources
 930 #===============================================================
 931 def has_sources(products):
 932     """
 933     Returns True if some product is installed in 'sources' mode.
 934     """
 935     for product in products:
 936         if product.whattodo == __BUILDSRC__:
 937             return True
 938     return False
 939
 940 #==============================================================
 941 # get_tmp_dir : gets temporary directory name
 942 #===============================================================
 943 def get_tmp_dir(dir):
 944     """
 945     Gets temporary directory path.
 946     """
 947     max_attempts = 100
 948     dir_prefix="INSTALLWORK"
 949     range_bottom = 0; range_top = 999999
 950     for i in xrange(max_attempts):
 951         tmp_dir = "%s/%s%d"%(dir, dir_prefix, random.randint(range_bottom,range_top))
 952         if not os.path.exists( tmp_dir ):
 953             return tmp_dir
 954     return "%s/%s%d"%(dir, dir_prefix, random.randint(range_bottom,range_top))
 955
 956 #==============================================================
 957 # get_os_release : gets OS release; the OS name, version and
 958 #                  architecture
 959 #                  For example:
 960 #                  RedHat, 8.0; Mandriva, 2006.0, 64
 961 #===============================================================
 962 def get_os_release():
 963     filename = "/etc/issue"
 964     # ---
 965     plt_name = "unknown"
 966     plt_ver  = ""
 967     plt_arch = ""
 968     if os.path.exists(filename):
 969         # ---
 970         f = open(filename)
 971         lines = f.readlines()
 972         f.close()
 973         # ---
 974         regvar  = re.compile("(.*)\s+[^\s]*[R|r]elease[^\s]*\s+([\d.]*)")
 975         regvar1 = re.compile("(.*)\s+[^\s]*[L|l][I|i][N|n][U|u][X|x][^\s]*(.*)\s+([\d.]*)\s+")
 976         regvar2 = re.compile("([A-Za-z]+)\s+([0-9.]+)\s+.*")
 977         for l in lines:
 978             res = re.search(regvar, l)
 979             if not res:
 980                 res = re.search(regvar1, l)
 981             if not res:
 982                 res = re.search(regvar2, l)
 983             if res:
 984                 plt_name = " ".join(" ".join(res.groups()[:len(res.groups())-1]).split())
 985                 # workaround for Mandrake and other platforms
 986                 plt_name = plt_name.replace("Linux", "").replace("linux", "").replace("LINUX", "").strip()
 987                 # workaround for SuSe
 988                 plt_name = plt_name.replace("Welcome to", "").strip()
 989                 # ---
 990                 plt_name = " ".join(plt_name.split())
 991                 plt_ver  = res.group(len(res.groups()))
 992                 if re.search(r'x86_64', l):
 993                     plt_arch = "64bit"
 994                     pass
 995                 # workaround for Red Hat Enterprise
 996                 if not plt_arch:
 997                     try:
 998                         import platform
 999                         if platform.machine() == "x86_64":
1000                             plt_arch = "64bit"
1001                             pass
1002                         pass
1003                     except:
1004                         pass
1005                     pass
1006                 break
1007             pass
1008         pass
1009
1010     return plt_name, plt_ver, plt_arch
1011
1012 #==============================================================
1013 # get_os_name : gets qualified OS name
1014 #               For example:
1015 #               Mandriva 2010.0 64bit
1016 #===============================================================
1017 def get_os_name():
1018     plt_name, plt_ver, plt_arch = get_os_release()
1019     data = []
1020     for i in plt_name, plt_ver, plt_arch:
1021         if i: data.append(i)
1022     return " ".join(data)
1023
1024 #==============================================================
1025 # check_xml_file : checks XML file existence and readability
1026 #===============================================================
1027 def check_xml_file(xml_file):
1028     """
1029     Checks XML file existence and readability.
1030     """
1031     if not os.path.isfile(xml_file):
1032         msg = "Configuration file %s is not found!"%xml_file
1033         error_exit(msg, False)
1034
1035     if not os.access(xml_file, os.R_OK):
1036         msg = "There is no read access for %s file!"%xml_file
1037         error_exit(msg, False)
1038     pass
1039
1040 #==============================================================
1041 # get_supported_plts : gets map of supported Linux platforms and
1042 #                      corresponding configuration files
1043 #===============================================================
1044 def get_supported_platforms(xml_file=None):
1045     """
1046     Gets map of supported Linux platforms and
1047     corresponding configuration files.
1048     """
1049     platforms_map = {}
1050     if xml_file:
1051         xml_file_list = [xml_file]
1052         pass
1053     else:
1054         xml_file_list = filter(lambda i: i.endswith(".xml"), os.listdir(get_program_path()))
1055         while 'config.xml' in xml_file_list: xml_file_list.remove('config.xml')
1056         if os.path.exists(os.path.join(get_program_path(), 'config.xml')):
1057             xml_file_list.append('config.xml')
1058         xml_file_list = [os.path.abspath(i) for i in xml_file_list]
1059         pass
1060     for an_xml_file in xml_file_list: # XML files parsing
1061         check_xml_file(an_xml_file)
1062         parser = ConfigParser()
1063         parser.parse(an_xml_file)
1064         if parser.config.platforms is not None:
1065             for plt in parser.config.platforms.split(","):
1066                 if not plt or plt in platforms_map.keys(): continue
1067                 platforms_map[strip(plt)] = an_xml_file
1068                 pass
1069             pass
1070         pass
1071     return platforms_map
1072
1073 #==============================================================
1074 # Print menu with list of supported platform
1075 # and return user choice
1076 #===============================================================
1077 def select_platform(all_platforms):
1078     platforms = all_platforms.keys()
1079     platforms.sort()
1080     pltname = None
1081     while not pltname:
1082         print "Please, select any platform from the list below."
1083         print "--------------------------"
1084         for idx in range(len(platforms)):
1085             print " %2d. %s" % (idx+1, " ".join(platforms[idx].split("_")))
1086         print "  0. Exit"
1087         print "--------------------------"
1088         print "Type your choice (%d-%d) and press <Enter>:" % (0, len(platforms)),
1089         try:
1090             idx = raw_input()
1091         except:
1092             sys.exit(1)
1093         try:
1094             idx = int(idx)
1095         except:
1096             warning("Invalid input!")
1097             pass
1098         if idx == 0: sys.exit(0)
1099         if idx > 0 and idx <= len(platforms):
1100             pltname = platforms[idx-1]
1101         else:
1102             warning("Invalid input!")
1103         pass
1104     return pltname, all_platforms[pltname]
1105
1106 #==============================================================
1107 # Check existence of required libraries in system and
1108 # warn user if some ones are absent
1109 #===============================================================
1110 def check_not_found_libs(filepath, optlibs):
1111     a_file = open(filepath, 'r')
1112     nf_mand_libs = list()
1113     nf_opt_libs = list()
1114     pref_opt_libs = optlibs.split(",")
1115     for line in a_file:
1116         line = line.strip()
1117         if not line:
1118             continue
1119         line = line.split(" ")[0]
1120         if line in nf_mand_libs or line in nf_opt_libs:
1121             continue
1122         is_optional = False;
1123         for opt_lib in pref_opt_libs:
1124             if line.lower().startswith(opt_lib.lower().strip()):
1125                 is_optional = True
1126                 break
1127         if is_optional:
1128             nf_opt_libs.append(line)
1129         else:
1130             nf_mand_libs.append(line)
1131         pass
1132
1133     msg = "=== WARNING: Some libraries are absent! ===\n"
1134     if nf_mand_libs:
1135         msg += "One or several MANDATORY libraries listed below are not found. SALOME may not work properly.\n\t"
1136         msg += "\n\t".join(nf_mand_libs)
1137         msg += "\n"
1138     if nf_opt_libs:
1139         msg += "One or several OPTIONAL libraries listed below are not found. This does not affect on the correct work of SALOME platform.\n\t"
1140         msg += "\n\t".join(nf_opt_libs)
1141     if nf_mand_libs or nf_opt_libs:
1142         print msg
1143     a_file.close()
1144     pass
1145
1146 #------------------------------------------------------------------#
1147 #                                                                  #
1148 #                    EXECUTION STARTS HERE                         #
1149 #                                                                  #
1150 #------------------------------------------------------------------#
1151
1152 if __name__ == "__main__":
1153     # get program dir
1154     cur_dir = get_program_path()
1155     # parse command line
1156     [xml_file, target_dir, tmp_dir, is_gui, is_force_src, is_single_dir, pltname] = parse_parameters()
1157     if xml_file:   xml_file   = os.path.abspath(xml_file)
1158     if target_dir: target_dir = os.path.abspath(target_dir)
1159     if tmp_dir:    tmp_dir    = os.path.abspath(tmp_dir)
1160
1161     #---- GUI ----------------
1162
1163     if is_gui :
1164         env = os.environ
1165         if not env.has_key("PATH") :
1166             env["PATH"] = ""
1167         if not env.has_key("LD_LIBRARY_PATH") :
1168             env["LD_LIBRARY_PATH"] = ""
1169
1170         env["LD_LIBRARY_PATH"] =  "./bin/lib:" + ".:" + env["LD_LIBRARY_PATH"]
1171         env["PATH"] = ".:" + env["PATH"]
1172
1173         cmd = "./bin/SALOME_InstallWizard"
1174         if xml_file is not None:
1175             cmd += " --file %s"%xml_file
1176         if pltname is not None:
1177             cmd += " --platform %s"%pltname
1178         if target_dir is not None:
1179             cmd += " --target %s"%target_dir
1180         if tmp_dir is not None:
1181             cmd += " --tmp %s"%tmp_dir
1182         if is_force_src:
1183             cmd += " --all-from-sources"
1184         if is_single_dir:
1185             cmd += " --single-directory"
1186         cmd += "&"
1187         sys.exit(os.system(cmd))
1188
1189     #-----  TUI ---------------------
1190     #
1191     # define xml file to be used
1192     #
1193     # get current Linux platform
1194     plt_name, plt_ver, plt_arch = get_os_release()
1195     data = []
1196     for i in plt_name, plt_ver, plt_arch:
1197         if i: data.append(i)
1198     full_plt_name = " ".join(data)
1199     # get all supported platforms
1200     all_platforms = get_supported_platforms(xml_file)
1201     if all_platforms:
1202         if pltname:
1203             # platform name is specified in the command line
1204             if pltname in all_platforms:
1205                 # if specified platform is supported, choose the corresponding XML file for use
1206                 xml_file = all_platforms[pltname]
1207             else:
1208                 # if specified platform is NOT supported, print warning message
1209                 # and prompt user to choose another platform
1210                 msg = "Specified platform is not supported: %s" % (pltname)
1211                 warning(msg)
1212                 pltname, xml_file = select_platform(all_platforms)
1213                 pass
1214             pass
1215         elif full_plt_name in all_platforms:
1216             # if current platform is supported, choose the corresponding XML file for use
1217             pltname  = full_plt_name
1218             xml_file = all_platforms[pltname]
1219         else:
1220             if xml_file and len(all_platforms) == 1:
1221                 # XML file is specified and contains only one platform definition
1222                 xml_file = all_platforms.values()[0]
1223                 pltname  = all_platforms.keys()[0]
1224             else:
1225                 # current Linux platform is not supported, print warning message
1226                 # and prompt user to choose platform from the list
1227                 warning("Not supported Linux platform: %s."%" ".join(data))
1228                 pltname, xml_file = select_platform(all_platforms)
1229             pass
1230         pass
1231     else:
1232         # current Linux platform is not supported, exit
1233         if pltname:
1234             msg = "Not supported Linux platform: %s."%pltname
1235         else:
1236             msg = "Not supported Linux platform: %s."%" ".join(data)
1237         error_exit(msg, False)
1238         pass
1239
1240     # parse XML file -----------
1241     message("Parsing XML configuration file: %s"%xml_file)
1242     parser = ConfigParser(is_force_src, pltname)
1243     parser.parse(xml_file)
1244
1245     # source directory map
1246     bin_dir = ""
1247     if parser.config.platforms:
1248         bin_dir += "/%s"%"_".join( parser.pltname.split() )
1249     subdir = { __BINARIES__   : "BINARIES" + bin_dir,
1250                __BUILDSRC__   : "SOURCES",
1251                __PREINSTALL__ : ""}
1252
1253     # check scripts directory -----------
1254     scripts_dir = "%s/%s"%(cur_dir, "config_files")
1255     check_dir(scripts_dir)
1256
1257     # check products archives directories -----------
1258     has_bin = has_binaries(parser.products)
1259     has_src = has_sources(parser.products)
1260     source_dir = "%s/%s"%(cur_dir, "Products")
1261
1262     if has_src or has_bin:
1263         check_dir(source_dir)
1264
1265     if has_src:
1266         check_dir("%s/%s"%(source_dir,subdir[__BUILDSRC__]))
1267
1268     if has_bin:
1269         check_dir("%s/%s"%(source_dir,subdir[__BINARIES__]))
1270
1271     # check/create target dir -----------
1272     if target_dir is None:
1273         target_dir = parser.config.targetdir
1274     target_dir = substituteVars(target_dir)
1275
1276     message("Creating target directory: " + target_dir)
1277     create_dir(target_dir, 0755)
1278
1279     if not os.path.exists(target_dir):
1280         error_exit("Invalid target directory: " + target_dir)
1281
1282     if not os.access(target_dir, os.W_OK) :
1283         error_exit("There is no write permissions for the directory: " + target_dir)
1284
1285     # check/create temporary dir -----------
1286     if tmp_dir is None:
1287         tmp_dir = parser.config.tmpdir
1288     if not tmp_dir:
1289         tmp_dir = "/tmp"
1290     tmp_dir = substituteVars(tmp_dir)
1291     tmp_dir = get_tmp_dir(tmp_dir)
1292
1293     message("Creating temporary directory: " + tmp_dir)
1294     root_path = create_dir(tmp_dir, 0755)
1295
1296     if not os.path.exists(tmp_dir):
1297         error_exit("Invalid temporary directory: " + tmp_dir)
1298
1299     if not os.access(tmp_dir, os.W_OK) :
1300         error_exit("There is no write permissions for the directory: " + tmp_dir)
1301
1302     # check available disk space -----------
1303     message("Checking available disk space")
1304     check_disk_space(parser.products, scripts_dir, target_dir, tmp_dir, is_force_src)
1305
1306     # change current directory -----------
1307     os.chdir(scripts_dir)
1308
1309     # get dependencies list -----------
1310     list_of_dep = get_dependencies(parser.products)
1311     products_string = " ".join(parser.full_prods_list)
1312
1313     # don't remove sources and tmp files, by default -----------
1314     rm_src_tmp = "FALSE"
1315
1316     # starting -----------
1317     message("Starting ...")
1318
1319     # install products -----------
1320     for product in parser.products:
1321         # remove only prerequisites temporary files
1322         if product.type == __CTX__PREREQUISITE__ or \
1323            (product.type == __CTX__COMPONENT__ and product.whattodo == __BUILDSRC__):
1324             rm_src_tmp = "TRUE"
1325         message("... processing %s ..."%product.name)
1326         cmd = '%s/%s %s %s %s/%s %s "%s" %s "%s" %s/%s %s %s/%s' % (
1327             scripts_dir, product.script,
1328             product.whattodo,
1329             tmp_dir,
1330             source_dir, subdir[product.whattodo],
1331             target_dir,
1332             products_string,
1333             product.name,
1334             products_string,
1335             source_dir, subdir[__BUILDSRC__],
1336             rm_src_tmp,
1337             source_dir, subdir[__BINARIES__]
1338             )
1339         # install all modules with GUI
1340         if product.woguiinst is not None and product.woguiinst != "":
1341             cmd += ' TRUE'
1342         # use single directory or not
1343         if product.whattodo == __BINARIES__ and product.type == __CTX__COMPONENT__ and is_single_dir:
1344             cmd += ' TRUE'
1345         res = os.system(cmd)
1346         rm_src_tmp = "FALSE"
1347         pass
1348
1349     # pickup environment -----------
1350     message("Creating environment files")
1351     for product in parser.products :
1352         if check_bool(product.pickupEnv):
1353             cmd = '%s/%s pickup_env %s %s/%s %s "%s" %s "%s" %s/%s %s %s/%s' % (
1354                 scripts_dir, product.script,
1355                 tmp_dir,
1356                 source_dir, subdir[product.whattodo],
1357                 target_dir,
1358                 products_string,
1359                 product.name,
1360                 products_string,
1361                 source_dir, subdir[__BUILDSRC__],
1362                 rm_src_tmp,
1363                 source_dir, subdir[__BINARIES__]
1364                 )
1365             # install all modules with GUI
1366             if product.woguiinst is not None and product.woguiinst != "":
1367                 cmd += ' TRUE'
1368             # use single directory or not
1369             if product.whattodo == __BINARIES__ and product.type == __CTX__COMPONENT__ and is_single_dir:
1370                 cmd += ' TRUE'
1371             res = os.system(cmd)
1372             pass
1373         pass
1374
1375     if not is_force_src:
1376         if is_single_dir:
1377             # modify *.la files, if --single-directory option was pointed -----------
1378             message("Modifying of *.la files of SALOME modules...")
1379             cmd = '%s/modifyLaFiles.sh modify_la_files %s' % (scripts_dir, target_dir)
1380             res = os.system(cmd)
1381         else:
1382             # check that all required libraries are in system
1383             message("Check existence of Fortran and other required libraries...")
1384             cmd = '%s/checkFortran.sh find_libraries %s > %s/not_found_libs.txt' % (scripts_dir, target_dir, tmp_dir)
1385             if os.system(cmd):
1386                 check_not_found_libs("%s/not_found_libs.txt" % (tmp_dir), parser.config.optlibs)
1387
1388     # clean temporary directory -----------
1389     message("Cleaning temporary directory")
1390     clean_all()
1391
1392     # finishing -----------
1393     message("Finished!")
1394     pass