src/product.py

   1 #!/usr/bin/env python
   2 #-*- coding:utf-8 -*-
   3 #  Copyright (C) 2010-2012  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 """\
  20 In this file are implemented the methods
  21 relative to the product notion of salomeTools
  22 """
  23
  24 import os
  25 import re
  26 import pprint as PP
  27
  28 import src
  29 import src.debug as DBG
  30 import src.versionMinorMajorPatch as VMMP
  31
  32 AVAILABLE_VCS = ['git', 'svn', 'cvs']
  33
  34 CONFIG_FILENAME = "sat-config-" # trace product depends version(s)
  35 PRODUCT_FILENAME = "sat-product-" # trace product compile config
  36 config_expression = "^config-\d+$"
  37
  38 def get_product_config(config, product_name, with_install_dir=True):
  39     """Get the specific configuration of a product from the global configuration
  40
  41     :param config Config: The global configuration
  42     :param product_name str: The name of the product
  43     :param with_install_dir boolean: If false, do not provide an install
  44                                      directory (at false only for internal use
  45                                      of the function check_config_exists)
  46     :return: the specific configuration of the product
  47     :rtype: Config
  48     """
  49
  50     # Get the version of the product from the application definition
  51     version = config.APPLICATION.products[product_name]
  52
  53     # Define debug and dev modes
  54     # Get the tag if a dictionary is given in APPLICATION.products for the
  55     # current product
  56     debug = 'no'
  57     dev = 'no'
  58     hpc = 'no'
  59     verbose = 'no'
  60     base = 'maybe'
  61     section = None
  62
  63     # if no version, then take the default one defined in the application
  64     if isinstance(version, bool) or isinstance(version, str):
  65         # in this case tag is mandatory, not debug, verbose, dev
  66         if 'debug' in config.APPLICATION:
  67             debug = config.APPLICATION.debug
  68         if 'verbose' in config.APPLICATION:
  69             verbose = config.APPLICATION.verbose
  70         if 'dev' in config.APPLICATION:
  71             dev = config.APPLICATION.dev
  72         if 'hpc' in config.APPLICATION:
  73             hpc = config.APPLICATION.hpc
  74         if 'base' in config.APPLICATION:
  75             base = config.APPLICATION.base
  76
  77     # special case for which only the product name is mentionned
  78     if isinstance(version, bool):
  79         version = config.APPLICATION.tag
  80
  81     if isinstance(version, src.pyconf.Mapping):
  82         dic_version = version
  83         # Get the version/tag
  84         if not 'tag' in dic_version:
  85             version = config.APPLICATION.tag
  86         else:
  87             version = dic_version.tag
  88
  89         # Get the debug if any
  90         if 'debug' in dic_version:
  91             debug = dic_version.debug
  92         elif 'debug' in config.APPLICATION:
  93             debug = config.APPLICATION.debug
  94
  95         # Get the verbose if any
  96         if 'verbose' in dic_version:
  97             verbose = dic_version.verbose
  98         elif 'verbose' in config.APPLICATION:
  99             verbose = config.APPLICATION.verbose
 100
 101         # Get the dev if any
 102         if 'dev' in dic_version:
 103             dev = dic_version.dev
 104         elif 'dev' in config.APPLICATION:
 105             dev = config.APPLICATION.dev
 106
 107         # Get the hpc if any
 108         if 'hpc' in dic_version:
 109             hpc = dic_version.hpc
 110         elif 'hpc' in config.APPLICATION:
 111             hpc = config.APPLICATION.hpc
 112
 113         # Get the base if any
 114         if 'base' in dic_version:
 115             base = dic_version.base
 116         elif 'base' in config.APPLICATION:
 117             base = config.APPLICATION.base
 118
 119         # Get the section if any
 120         if 'section' in dic_version:
 121             section = dic_version.section
 122
 123     # this case occur when version is overwritten, cf sat # 8897
 124     if isinstance(version, dict):
 125         dic_version = version
 126         # Get the version/tag
 127         if not 'tag' in dic_version:
 128             version = config.APPLICATION.tag
 129         else:
 130             version = dic_version["tag"]
 131
 132         # Get the debug if any
 133         if 'debug' in dic_version:
 134             debug = dic_version["debug"]
 135         elif 'debug' in config.APPLICATION:
 136             debug = config.APPLICATION.debug
 137
 138         # Get the verbose if any
 139         if 'verbose' in dic_version:
 140             verbose = dic_version["verbose"]
 141         elif 'verbose' in config.APPLICATION:
 142             verbose = config.APPLICATION.verbose
 143
 144         # Get the dev if any
 145         if 'dev' in dic_version:
 146             dev = dic_version["dev"]
 147         elif 'dev' in config.APPLICATION:
 148             dev = config.APPLICATION.dev
 149
 150         # Get the hpc if any
 151         if 'hpc' in dic_version:
 152             hpc = dic_version.hpc
 153         elif 'hpc' in config.APPLICATION:
 154             hpc = config.APPLICATION.hpc
 155
 156         # Get the base if any
 157         if 'base' in dic_version:
 158             base = dic_version["base"]
 159
 160         # Get the section if any
 161         if 'section' in dic_version:
 162             section = dic_version['section']
 163
 164     vv = version
 165     # substitute some character with _ in order to get the correct definition
 166     # in config.PRODUCTS. This is done because the pyconf tool does not handle
 167     # the . and - characters
 168     for c in ".-": vv = vv.replace(c, "_")
 169
 170     prod_info = None
 171     if product_name in config.PRODUCTS:
 172         # Search for the product description in the configuration
 173         prod_info = get_product_section(config, product_name, vv, section)
 174
 175         # get salomeTool version
 176         prod_info.sat_version = src.get_salometool_version(config)
 177
 178         # merge opt_depend in depend
 179         if prod_info is not None and 'opt_depend' in prod_info:
 180             for depend in prod_info.opt_depend:
 181                 if depend in config.APPLICATION.products:
 182                     prod_info.depend.append(depend,'')
 183
 184
 185         # In case of a product get with a vcs,
 186         # put the tag (equal to the version)
 187         if prod_info is not None and prod_info.get_source in AVAILABLE_VCS:
 188
 189             if prod_info.get_source == 'git':
 190                 prod_info.git_info.tag = version
 191
 192             if prod_info.get_source == 'svn':
 193                 prod_info.svn_info.tag = version
 194
 195             if prod_info.get_source == 'cvs':
 196                 prod_info.cvs_info.tag = version
 197
 198         # In case of a fixed product,
 199         # define the install_dir (equal to the version)
 200         if prod_info is not None and \
 201            (os.path.isdir(version) or version.startswith("/")):
 202            # we consider a (fixed) path  existing paths;
 203            # or paths starting with '/' (the objective is to print a correct
 204            # message to the user in case of non existing path.)
 205             prod_info.install_dir = version
 206             prod_info.get_source = "fixed"
 207
 208         # Check if the product is defined as native in the application
 209         if prod_info is not None:
 210             if version == "native":
 211                 prod_info.get_source = "native"
 212             elif prod_info.get_source == "native":
 213                 msg = _("The product %(prod)s has version %(ver)s but is "
 214                         "declared as native in its definition" %
 215                         { 'prod': prod_info.name, 'ver': version})
 216                 raise src.SatException(msg)
 217
 218     # If there is no definition but the product is declared as native,
 219     # construct a new definition containing only the get_source key
 220     if prod_info is None and version == "native":
 221         prod_info = src.pyconf.Config()
 222         prod_info.name = product_name
 223         prod_info.get_source = "native"
 224
 225     # If there is no definition but the product is fixed,
 226     # construct a new definition containing only the product name
 227     if prod_info is None and os.path.isdir(version):
 228         prod_info = src.pyconf.Config()
 229         prod_info.name = product_name
 230         prod_info.get_source = "fixed"
 231         prod_info.addMapping("environ", src.pyconf.Mapping(prod_info), "")
 232
 233
 234     # If prod_info is still None, it means that there is no product definition
 235     # in the config. The user has to provide it.
 236     if prod_info is None:
 237         prod_pyconf_path = src.find_file_in_lpath(product_name + ".pyconf",
 238                                                   config.PATHS.PRODUCTPATH)
 239         if not prod_pyconf_path:
 240             msg = _("""\
 241 No definition found for the product %(1)s.
 242 Please create a %(1)s.pyconf file somewhere in:
 243   %(2)s""") % {
 244   "1": product_name,
 245   "2": PP.pformat(config.PATHS.PRODUCTPATH) }
 246         else:
 247             msg = _("""\
 248 No definition corresponding to the version %(1)s was found in the file:
 249   %(2)s.
 250 Please add a section in it.""") % {"1" : vv, "2" : prod_pyconf_path}
 251         raise src.SatException(msg)
 252
 253     # Set the debug, dev and version keys
 254     prod_info.debug = debug
 255     prod_info.verbose = verbose
 256     prod_info.dev = dev
 257     prod_info.hpc = hpc
 258     prod_info.version = version
 259     if base != 'maybe':
 260         prod_info.base = base
 261
 262     # Set the archive_info if the product is get in archive mode
 263     if prod_info.get_source == "archive":
 264         if not "archive_info" in prod_info:
 265             prod_info.addMapping("archive_info",
 266                                  src.pyconf.Mapping(prod_info),
 267                                  "")
 268         if "archive_name" in prod_info.archive_info:
 269             arch_name = prod_info.archive_info.archive_name
 270         elif "archive_prefix" in prod_info.archive_info:
 271             arch_name = prod_info.archive_info.archive_prefix + "-" + version + ".tar.gz"
 272         else:
 273             # standard name
 274             arch_name = product_name + "-" + version + ".tar.gz"
 275
 276         arch_path = src.find_file_in_lpath(arch_name,
 277                                            config.PATHS.ARCHIVEPATH)
 278         if not arch_path:
 279             # arch_path is not found. It may generate an error in sat source,
 280             #                         unless the archive is found in ftp serveur
 281             prod_info.archive_info.archive_name = arch_name #without path
 282         else:
 283             prod_info.archive_info.archive_name = arch_path
 284
 285
 286     # If the product compiles with a script, check the script existence
 287     # and if it is executable
 288     if product_has_script(prod_info):
 289         # Check the compil_script key existence
 290         if "compil_script" not in prod_info:
 291             msg = _("""\
 292 No compilation script found for the product %s.
 293 Please provide a 'compil_script' key in its definition.""") % product_name
 294             raise src.SatException(msg)
 295
 296         # Get the path of the script file
 297         # if windows supposed '.bat', if linux supposed '.sh'
 298         # but user set extension script file in his pyconf as he wants, no obligation.
 299         script = prod_info.compil_script
 300         script_name = os.path.basename(script)
 301         if script == script_name:
 302             # Only a name is given. Search in the default directory
 303             script_path = src.find_file_in_lpath(script_name, config.PATHS.PRODUCTPATH, "compil_scripts")
 304             if not script_path:
 305                 msg = _("Compilation script %s not found in") % script_name
 306                 DBG.tofix(msg, config.PATHS.PRODUCTPATH, True) # say where searched
 307                 script_path = "%s_(Not_Found_by_Sat!!)" % script_name
 308             prod_info.compil_script = script_path
 309
 310
 311         # Check that the script is executable
 312         if os.path.exists(prod_info.compil_script) and not os.access(prod_info.compil_script, os.X_OK):
 313             DBG.tofix("Compilation script  file is not in 'execute mode'", prod_info.compil_script, True)
 314
 315     # Get the full paths of all the patches
 316     if product_has_patches(prod_info):
 317         patches = []
 318         try:
 319           for patch in prod_info.patches:
 320               patch_path = patch
 321               # If only a filename, then search for the patch in the PRODUCTPATH
 322               if os.path.basename(patch_path) == patch_path:
 323                   # Search in the PRODUCTPATH/patches
 324                   patch_path = src.find_file_in_lpath(patch,
 325                                                       config.PATHS.PRODUCTPATH,
 326                                                       "patches")
 327                   if not patch_path:
 328                       msg = _("Patch %(patch_name)s for %(prod_name)s not found:"
 329                               "\n" % {"patch_name" : patch,
 330                                        "prod_name" : prod_info.name})
 331                       raise src.SatException(msg)
 332               patches.append(patch_path)
 333         except:
 334           DBG.tofix("problem in prod_info.patches", prod_info)
 335         prod_info.patches = patches
 336
 337     # Get the full paths of the environment scripts
 338     if product_has_env_script(prod_info):
 339         env_script_path = prod_info.environ.env_script
 340         # If only a filename, then search for the environment script
 341         # in the PRODUCTPATH/env_scripts
 342         if os.path.basename(env_script_path) == env_script_path:
 343             # Search in the PRODUCTPATH/env_scripts
 344             env_script_path = src.find_file_in_lpath(
 345                                             prod_info.environ.env_script,
 346                                             config.PATHS.PRODUCTPATH,
 347                                             "env_scripts")
 348             if not env_script_path:
 349                 msg = _("Environment script %(env_name)s for %(prod_name)s not "
 350                         "found.\n" % {"env_name" : env_script_path,
 351                                        "prod_name" : prod_info.name})
 352                 raise src.SatException(msg)
 353
 354         prod_info.environ.env_script = env_script_path
 355
 356     if with_install_dir:
 357         # The variable with_install_dir is at false only for internal use
 358         # of the function get_install_dir
 359
 360         # Save the install_dir key if there is any
 361         if "install_dir" in prod_info and not "install_dir_save" in prod_info:
 362             prod_info.install_dir_save = prod_info.install_dir
 363
 364         # if it is not the first time the install_dir is computed, it means
 365         # that install_dir_save exists and it has to be taken into account.
 366         if "install_dir_save" in prod_info:
 367             prod_info.install_dir = prod_info.install_dir_save
 368
 369         # Set the install_dir key
 370         prod_info.install_dir = get_install_dir(config, version, prod_info)
 371
 372     return prod_info
 373
 374 def get_product_section(config, product_name, version, section=None):
 375     """Build the product description from the configuration
 376
 377     :param config Config: The global configuration
 378     :param product_name str: The product name
 379     :param version str: The version of the product as 'V8_4_0', or else.
 380     :param section str: The searched section (if not None, the section is
 381                         explicitly given
 382     :return: The product description
 383     :rtype: Config
 384     """
 385
 386
 387     #get product definition and determine if the incremental definition mode is activated
 388     aProd = config.PRODUCTS[product_name]
 389     if "default" in aProd and\
 390        "properties" in aProd.default and\
 391        "incremental" in aProd.default.properties and\
 392        aProd.default.properties.incremental == "yes":
 393         # in this (new) mode the definition of the product is given by the default section
 394         # and is incremented by others.
 395         is_incr=True
 396     else:
 397         # in this (historic) mode the definition of the product is given by a full unique section
 398         is_incr=False
 399
 400     # decode version number
 401     try:
 402       versionMMP = VMMP.MinorMajorPatch(version)
 403     except: # example setuptools raise "minor in major_minor_patch is not integer: '0_6c11'"
 404       versionMMP = None
 405
 406     # if a section is explicitely specified we select it
 407     if section:
 408         if section not in aProd:
 409             pi=None
 410         # returns specific information for the given version
 411         pi = aProd[section]
 412         pi.section = section
 413         pi.from_file = aProd.from_file
 414
 415     # If it exists, get the information of the product_version
 416     # ex: 'version_V6_6_0' as salome version classical syntax
 417     elif "version_" + version in aProd:
 418         # returns specific information for the given version
 419         pi = aProd["version_" + version]
 420         pi.section = "version_" + version
 421         pi.from_file = aProd.from_file
 422
 423     # Else, check if there is a description for multiple versions
 424     else:
 425         l_section_names = aProd.keys()
 426         l_section_ranges = []
 427         tagged = []
 428         for name in l_section_names:
 429           aRange = VMMP.getRange_majorMinorPatch(name)
 430           if aRange is not None:
 431             l_section_ranges.append((name, aRange))
 432
 433         if versionMMP is not None and len(l_section_ranges) > 0:
 434           for name, (vmin, vmax) in l_section_ranges:
 435             if versionMMP >= vmin and versionMMP <= vmax:
 436               tagged.append((name, [vmin, vmax]))
 437
 438         if len(tagged) > 1:
 439           DBG.write("multiple version ranges tagged for '%s', fix it" % version,
 440                          PP.pformat(tagged))
 441           pi=None
 442         elif len(tagged) == 1: # ok
 443           name, (vmin, vmax) = tagged[0]
 444           pi = aProd[name]
 445           pi.section = name
 446           pi.from_file = aProd.from_file
 447
 448         # Else, get the standard informations
 449         elif "default" in aProd:
 450             # returns the generic information (given version not found)
 451             pi = aProd.default
 452             pi.section = "default"
 453             pi.from_file = aProd.from_file
 454         else:
 455             pi=None
 456
 457     if is_incr:
 458         # If the definition is incremental, we take the default section
 459         # and then complete it with other sections :
 460         #   - default_win
 461         #   - the selected section (pi)
 462         #   - the selected _win section
 463         prod_info=aProd["default"]
 464         prod_info.from_file = aProd.from_file
 465         prod_info.section = "default"
 466         if src.architecture.is_windows() and "default_win" in aProd:
 467             for key in aProd["default_win"]:
 468                 prod_info[key]=aProd["default_win"][key]
 469         if pi!=None and pi.section!="default":
 470             # update prod_info with incremental definition contained in pi
 471             for key in pi:
 472                 prod_info[key]=pi[key]
 473             win_section=pi.section+"_win"
 474             if src.architecture.is_windows() and win_section in aProd:
 475                 for key in aProd[win_section]:
 476                     prod_info[key]=aProd[win_section][key]
 477     else:
 478         prod_info=pi
 479
 480     #DBG.write("product info returned for product %s with version %s and section %s" %\
 481     #          (product_name, version, section), prod_info)
 482     return prod_info
 483
 484 def get_install_dir(config, version, prod_info):
 485     """Compute the installation directory of a given product
 486
 487     :param config Config: The global configuration
 488     :param base str: This corresponds to the value given by user in its
 489                      application.pyconf for the specific product. If "yes", the
 490                      user wants the product to be in base. If "no", he wants the
 491                      product to be in the application workdir
 492     :param version str: The version of the product
 493     :param product_info Config: The configuration specific to
 494                                the product
 495
 496     :return: The path of the product installation
 497     :rtype: str
 498     """
 499     install_dir = ""
 500     in_base = False
 501     # prod_info.base : corresponds to what is specified in application pyconf (either from the global key base, or from a product dict)
 502     # prod_info.install_dir : corresponds to what is specified in product pyconf (usually "base" for prerequisites)
 503     if ( ("install_dir" in prod_info and prod_info.install_dir == "base") # product is declared as base in its own config
 504                                       or ("base" in prod_info  and prod_info.base != "no") ):  # product is declared as base in the application
 505         # a product goes in base if install_dir is set to base, or if product was declared based in application pyconf
 506         in_base = True
 507
 508     # check desactivation of base at application level
 509     if ( "base" in prod_info  and prod_info.base == "no"):
 510         in_base = False
 511
 512     if in_base:
 513         install_dir = get_base_install_dir(config, prod_info, version)
 514     else:
 515         if "install_dir" not in prod_info or prod_info.install_dir == "base":
 516             # Set it to the default value (in application directory)
 517             if ( src.appli_test_property(config,"single_install_dir", "yes") and
 518                  src.product.product_test_property(prod_info,"single_install_dir", "yes")):
 519                 # when single_install_dir mode is activated in tha application
 520                 # we use config.INTERNAL.config.single_install_dir for products
 521                 # having single_install_dir property
 522                 install_dir = os.path.join(config.APPLICATION.workdir,
 523                                            config.INTERNAL.config.install_dir,
 524                                            config.INTERNAL.config.single_install_dir)
 525             elif ( src.appli_test_property(config,"pip", "yes") and
 526                    src.product.product_test_property(prod_info,"pip", "yes") and
 527                    src.appli_test_property(config,"pip_install_dir", "python") ):
 528                 # when pip mode is activated in the application
 529                 # and product is pip, and pip_install_dir is set to python
 530                 # we assume python in installed in install_dir/Python
 531                 install_dir = os.path.join(config.APPLICATION.workdir,
 532                                            config.INTERNAL.config.install_dir,
 533                                            "Python")
 534             else:
 535                 install_dir = os.path.join(config.APPLICATION.workdir,
 536                                            config.INTERNAL.config.install_dir,
 537                                            prod_info.name)
 538         else:
 539             install_dir = prod_info.install_dir
 540
 541     return install_dir
 542
 543 def get_base_install_dir(config, prod_info, version):
 544     """Compute the installation directory of a product in base
 545
 546     :param config Config: The global configuration
 547     :param product_info Config: The configuration specific to
 548                                the product
 549     :param version str: The version of the product
 550     :param base str: This corresponds to the value given by user in its
 551                      application.pyconf for the specific product. If "yes", the
 552                      user wants the product to be in base. If "no", he wants the
 553                      product to be in the application workdir.
 554                      if it contains something else, is is interpreted as the name
 555                      of a base we build for module load.
 556     :return: The path of the product installation
 557     :rtype: str
 558     """
 559
 560     # get rid of / to avoid create subdirectories cf sat #18546
 561     version_wslash=version.replace("/", "_")
 562
 563     if ( src.appli_test_property(config,"pip", "yes") and
 564          src.product.product_test_property(prod_info,"pip", "yes") and
 565          src.appli_test_property(config,"pip_install_dir", "python") ):
 566          # when pip mode is activated in the application
 567          # and product is pip, and pip_install_dir is set to python
 568         python_info=get_product_config(config, "Python")
 569         return python_info.install_dir
 570
 571     base_path = src.get_base_path(config)
 572     if "base" in prod_info and prod_info.base != "no" and prod_info.base != "yes":
 573         # we are in the case of a named base
 574         prod_dir = os.path.join(base_path, "apps", prod_info.base, prod_info.name, version_wslash)
 575         return prod_dir
 576
 577     prod_dir = os.path.join(base_path, prod_info.name + "-" + version_wslash)
 578     if not os.path.exists(prod_dir):
 579         return os.path.join(prod_dir, "config-1")
 580
 581     exists, install_dir = check_config_exists(config, prod_dir, prod_info)
 582     if exists:
 583         return install_dir
 584
 585     # Find the first config-<i> directory that is available in the product
 586     # directory
 587     found = False
 588     label = 1
 589     while not found:
 590         install_dir = os.path.join(prod_dir, "config-%i" % label)
 591         if os.path.exists(install_dir):
 592             label+=1
 593         else:
 594             found = True
 595
 596     return install_dir
 597
 598 def add_compile_config_file(p_info, config):
 599     '''Execute the proper configuration command(s)
 600        in the product build directory.
 601
 602     :param p_info Config: The specific config of the product
 603     :param config Config: The global configuration
 604     '''
 605     # Create the compile config
 606     # DBG.write("add_compile_config_file", p_info, True)
 607     res = src.pyconf.Config()
 608     res.addMapping(p_info.name, src.pyconf.Mapping(res), "")
 609     res[p_info.name]= p_info.version
 610
 611     depprod=[]
 612     for d in p_info.depend:
 613         depprod.append(d)
 614     if "build_depend" in p_info:
 615         for d in p_info.build_depend:
 616             depprod.append(d)
 617     for prod_name in depprod:
 618       if prod_name not in res:
 619         res.addMapping(prod_name, src.pyconf.Mapping(res), "")
 620       prod_dep_info = src.product.get_product_config(config, prod_name, False)
 621       res[prod_name] = prod_dep_info.version
 622     # Write it in the install directory of the product
 623     # This file is for automatic reading/checking
 624     # see check_config_exists method
 625     afilename = CONFIG_FILENAME + p_info.name + ".pyconf"
 626     aFile = os.path.join(p_info.install_dir, afilename)
 627     with open(aFile, 'w') as f:
 628       res.__save__(f)
 629
 630     # this file is not mandatory, is for human eye reading
 631     afilename = PRODUCT_FILENAME + p_info.name + ".pyconf"
 632     aFile = os.path.join(p_info.install_dir, afilename)
 633     try:
 634       with open(aFile, 'w') as f:
 635         p_info.__save__(f, evaluated=True) # evaluated expressions mode
 636     except:
 637       # sometime some information cannot be evaluated.
 638       # for example, in the context of non VCS archives, information on git server is not available.
 639       DBG.write("Warning : sat was not able to evaluate and write down some information in file %s" % aFile)
 640
 641
 642 def check_config_exists(config, prod_dir, prod_info, verbose=False):
 643     """\
 644     Verify that the installation directory of a product in a base exists.
 645     Check all the config-<i>/sat-config.py files found for correspondence
 646     with current config and prod_info depend-version-tags
 647
 648     :param config Config: The global configuration
 649     :param prod_dir str: The product installation directory path
 650                          (without config-<i>)
 651     :param product_info Config: The configuration specific to
 652                                the product
 653     :return: True or false is the installation is found or not
 654              and if it is found, the path of the found installation
 655     :rtype: (boolean, str)
 656     """
 657     # check if the directories or files of the directory corresponds to the
 658     # directory installation of the product
 659     if os.path.isdir(prod_dir):
 660       l_dir_and_files = os.listdir(prod_dir)
 661     else:
 662       raise Exception("Inexisting directory '%s'" % prod_dir)
 663
 664     DBG.write("check_config_exists 000",  (prod_dir, l_dir_and_files), verbose)
 665     DBG.write("check_config_exists 111",  prod_info, verbose)
 666
 667     for dir_or_file in l_dir_and_files:
 668         oExpr = re.compile(config_expression)
 669         if not(oExpr.search(dir_or_file)):
 670             # in mode BASE, not config-<i>, not interesting
 671             # DBG.write("not interesting", dir_or_file, True)
 672             continue
 673         # check if there is the file sat-config.pyconf file in the installation
 674         # directory
 675         afilename = CONFIG_FILENAME + prod_info.name + ".pyconf"
 676         config_file = os.path.join(prod_dir, dir_or_file, afilename)
 677         DBG.write("check_config_exists 222", config_file, verbose)
 678         if not os.path.exists(config_file):
 679             continue
 680
 681         # check if there is the config described in the file corresponds the
 682         # dependencies of the product
 683         config_corresponds = True
 684         compile_cfg = src.pyconf.Config(config_file)
 685         for prod_dep in prod_info.depend:
 686             # if the dependency is not in the config,
 687             # the config does not correspond
 688             if prod_dep not in compile_cfg:
 689                 config_corresponds = False
 690                 break
 691             else:
 692                 prod_dep_info = get_product_config(config, prod_dep, False)
 693                 # If the version of the dependency does not correspond,
 694                 # the config does not correspond
 695                 if prod_dep_info.version != compile_cfg[prod_dep]:
 696                     config_corresponds = False
 697                     break
 698
 699         if config_corresponds:
 700           for prod_name in compile_cfg:
 701             # assume new compatibility with prod_name in sat-config.pyconf files
 702             if prod_name == prod_info.name:
 703               if prod_info.version == compile_cfg[prod_name]:
 704                 DBG.write("check_config_exists OK 333", compile_cfg, verbose)
 705                 pass
 706               else: # no correspondence with newer with prod_name sat-config.pyconf files
 707                 config_corresponds = False
 708                 break
 709             else:
 710               # as old compatibility without prod_name sat-config.pyconf files
 711               if prod_name not in prod_info.depend:
 712                 # here there is an unexpected depend in an old compilation
 713                 config_corresponds = False
 714                 break
 715
 716         if config_corresponds: # returns (and stops) at first correspondence found
 717             DBG.write("check_config_exists OK 444", dir_or_file, verbose)
 718             return True, os.path.join(prod_dir, dir_or_file)
 719
 720     # no correspondence found
 721     return False, None
 722
 723
 724
 725 def get_products_infos(lproducts, config):
 726     """Get the specific configuration of a list of products
 727
 728     :param lproducts List: The list of product names
 729     :param config Config: The global configuration
 730     :return: the list of tuples
 731              (product name, specific configuration of the product)
 732     :rtype: [(str, Config)]
 733     """
 734     products_infos = []
 735     # Loop on product names
 736     for prod in lproducts:
 737         # Get the specific configuration of the product
 738         prod_info = get_product_config(config, prod)
 739         if prod_info is not None:
 740             products_infos.append((prod, prod_info))
 741         else:
 742             msg = _("The %s product has no definition in the configuration.") % prod
 743             raise src.SatException(msg)
 744     return products_infos
 745
 746
 747 def get_products_list(options, cfg, logger):
 748     """
 749     method that gives the product list with their informations from
 750     configuration regarding the passed options.
 751
 752     :param options Options: The Options instance that stores the commands arguments
 753     :param cfg Config: The global configuration
 754     :param logger Logger: The logger instance to use for the display and logging
 755     :return: The list of (product name, product_informations).
 756     :rtype: List
 757     """
 758     # Get the products to be prepared, regarding the options
 759     if options.products is None:
 760         # No options, get all products sources
 761         products = cfg.APPLICATION.products
 762     else:
 763         # if option --products, check that all products of the command line
 764         # are present in the application.
 765         """products = options.products
 766         for p in products:
 767             if p not in cfg.APPLICATION.products:
 768                 raise src.SatException(_("Product %(product)s "
 769                             "not defined in application %(application)s") %
 770                         { 'product': p, 'application': cfg.VARS.application} )"""
 771
 772         products = src.getProductNames(cfg, options.products, logger)
 773
 774     # Construct the list of tuple containing
 775     # the products name and their definition
 776     resAll = src.product.get_products_infos(products, cfg)
 777
 778     # if the property option was passed, filter the list
 779     if options.properties: # existing properties
 780       ok = []
 781       ko = []
 782       res =[]
 783       prop, value = options.properties # for example 'is_SALOME_module', 'yes'
 784       for p_name, p_info in resAll:
 785         try:
 786           if p_info.properties[prop] == value:
 787             res.append((p_name, p_info))
 788             ok.append(p_name)
 789           else:
 790             ko.append(p_name)
 791         except:
 792           ko.append(p_name)
 793
 794       if len(ok) != len(resAll):
 795         logger.trace("on properties %s\n products accepted:\n %s\n products rejected:\n %s\n" %
 796                        (options.properties, PP.pformat(sorted(ok)), PP.pformat(sorted(ko))))
 797       else:
 798         logger.warning("properties %s\n seems useless with no products rejected" %
 799                        (options.properties))
 800     else:
 801       res = resAll # not existing properties as all accepted
 802
 803     return res
 804
 805
 806 def get_product_dependencies(config, product_info):
 807     """\
 808     Get recursively the list of products that are
 809     in the product_info dependencies
 810
 811     :param config Config: The global configuration
 812     :param product_info Config: The configuration specific to
 813                                the product
 814     :return: the list of products in dependence
 815     :rtype: list
 816     """
 817     depend_all=[]
 818     if "depend" in product_info:
 819         for d in product_info.depend:
 820             depend_all.append(d)
 821     if "build_depend" in product_info:
 822         for d in product_info.build_depend:
 823             depend_all.append(d)
 824
 825     if len(depend_all) == 0:
 826         return []
 827
 828     res = []
 829     for prod in depend_all:
 830         if prod == product_info.name:
 831             continue
 832         if prod not in res:
 833             res.append(prod)
 834         prod_info = get_product_config(config, prod)
 835         dep_prod = get_product_dependencies(config, prod_info)
 836         for prod_in_dep in dep_prod:
 837             if prod_in_dep not in res:
 838                 res.append(prod_in_dep)
 839     return res
 840
 841 def check_installation(config, product_info):
 842     """\
 843     Verify if a product is well installed. Checks install directory presence
 844     and some additional files if it is defined in the config
 845
 846     :param product_info Config: The configuration specific to
 847                                the product
 848     :return: True if it is well installed
 849     :rtype: boolean
 850     """
 851     # don't check products that are not compiled
 852     if not product_compiles(product_info):
 853         return True
 854
 855     if product_is_native(product_info):
 856         # check a system product
 857         check_cmd=src.system.get_pkg_check_cmd(config.VARS.dist_name)
 858         run_pkg,build_pkg=src.product.check_system_dep(check_cmd, product_info)
 859         build_dep_ko=[]
 860         for pkg in build_pkg:
 861             if "KO" in build_pkg[pkg]:
 862                build_dep_ko.append(pkg)
 863         if build_dep_ko:
 864               # the product is not installed : display message and return error status
 865               msg="Please install them with %s before compiling salome" % check_cmd[0]
 866               print("\nmissing compile time dependencies : ")
 867               for md in build_dep_ko:
 868                   print(md)
 869               print(msg)
 870               return False
 871         else:
 872             return True
 873
 874     install_dir = product_info.install_dir
 875     filename = CONFIG_FILENAME + product_info.name + ".pyconf"
 876     if not os.path.exists(os.path.join(install_dir, filename)):
 877         return False
 878
 879     # check extra files if specified in present_files.install section
 880     if ("present_files" in product_info and
 881         "install" in product_info.present_files):
 882         for file_relative_path in product_info.present_files.install:
 883             file_path = os.path.join(install_dir, file_relative_path)
 884             if not os.path.exists(file_path):
 885                 return False
 886     return True
 887
 888 def check_source(product_info):
 889     """Verify if a sources of product is preset. Checks source directory presence
 890
 891     :param product_info Config: The configuration specific to
 892                                the product
 893     :return: True if it is well installed
 894     :rtype: boolean
 895     """
 896     source_dir = product_info.source_dir
 897     if not os.path.exists(source_dir):
 898         return False
 899     if ("present_files" in product_info and
 900         "source" in product_info.present_files):
 901         for file_relative_path in product_info.present_files.source:
 902             file_path = os.path.join(source_dir, file_relative_path)
 903             if not os.path.exists(file_path):
 904                 return False
 905     return True
 906
 907 def product_is_salome(product_info):
 908     """Know if a product is a SALOME module
 909
 910     :param product_info Config: The configuration specific to
 911                                the product
 912     :return: True if the product is a SALOME module, else False
 913     :rtype: boolean
 914     """
 915     return ("properties" in product_info and
 916             "is_SALOME_module" in product_info.properties and
 917             product_info.properties.is_SALOME_module == "yes")
 918
 919 def product_is_fixed(product_info):
 920     """Know if a product is fixed
 921
 922     :param product_info Config: The configuration specific to
 923                                the product
 924     :return: True if the product is fixed, else False
 925     :rtype: boolean
 926     """
 927     get_src = product_info.get_source
 928     return get_src.lower() == 'fixed'
 929
 930 def product_is_native(product_info):
 931     """Know if a product is native
 932
 933     :param product_info Config: The configuration specific to
 934                                the product
 935     :return: True if the product is native, else False
 936     :rtype: boolean
 937     """
 938     get_src = product_info.get_source
 939     return get_src.lower() == 'native'
 940
 941 def product_is_dev(product_info):
 942     """Know if a product is in dev mode
 943
 944     :param product_info Config: The configuration specific to
 945                                the product
 946     :return: True if the product is in dev mode, else False
 947     :rtype: boolean
 948     """
 949     dev = product_info.dev
 950     res = (dev.lower() == 'yes')
 951     DBG.write('product_is_dev %s' % product_info.name, res)
 952     # if product_info.name == "XDATA": return True #test #10569
 953     return res
 954
 955 def product_is_hpc(product_info):
 956     """Know if a product is in hpc mode
 957
 958     :param product_info Config: The configuration specific to
 959                                the product
 960     :return: True if the product is in hpc mode, else False
 961     :rtype: boolean
 962     """
 963     hpc = product_info.hpc
 964     res = (hpc.lower() == 'yes')
 965     return res
 966
 967 def product_is_debug(product_info):
 968     """Know if a product is in debug mode
 969
 970     :param product_info Config: The configuration specific to
 971                                the product
 972     :return: True if the product is in debug mode, else False
 973     :rtype: boolean
 974     """
 975     debug = product_info.debug
 976     return debug.lower() == 'yes'
 977
 978 def product_is_verbose(product_info):
 979     """Know if a product is in verbose mode
 980
 981     :param product_info Config: The configuration specific to
 982                                the product
 983     :return: True if the product is in verbose mode, else False
 984     :rtype: boolean
 985     """
 986     verbose = product_info.verbose
 987     return verbose.lower() == 'yes'
 988
 989 def product_is_autotools(product_info):
 990     """Know if a product is compiled using the autotools
 991
 992     :param product_info Config: The configuration specific to
 993                                the product
 994     :return: True if the product is autotools, else False
 995     :rtype: boolean
 996     """
 997     build_src = product_info.build_source
 998     return build_src.lower() == 'autotools'
 999
1000 def product_is_cmake(product_info):
1001     """Know if a product is compiled using the cmake
1002
1003     :param product_info Config: The configuration specific to
1004                                the product
1005     :return: True if the product is cmake, else False
1006     :rtype: boolean
1007     """
1008     build_src = product_info.build_source
1009     return build_src.lower() == 'cmake'
1010
1011 def product_is_vcs(product_info):
1012     """Know if a product is download using git, svn or cvs (not archive)
1013
1014     :param product_info Config: The configuration specific to
1015                                the product
1016     :return: True if the product is vcs, else False
1017     :rtype: boolean
1018     """
1019     return product_info.get_source in AVAILABLE_VCS
1020
1021 def product_is_smesh_plugin(product_info):
1022     """Know if a product is a SMESH plugin
1023
1024     :param product_info Config: The configuration specific to
1025                                the product
1026     :return: True if the product is a SMESH plugin, else False
1027     :rtype: boolean
1028     """
1029     return ("properties" in product_info and
1030             "smesh_plugin" in product_info.properties and
1031             product_info.properties.smesh_plugin == "yes")
1032
1033 def product_is_cpp(product_info):
1034     """Know if a product is cpp
1035
1036     :param product_info Config: The configuration specific to
1037                                the product
1038     :return: True if the product is a cpp, else False
1039     :rtype: boolean
1040     """
1041     return ("properties" in product_info and
1042             "cpp" in product_info.properties and
1043             product_info.properties.cpp == "yes")
1044
1045 def product_compiles(product_info):
1046     """\
1047     Know if a product compiles or not
1048     (some products do not have a compilation procedure)
1049
1050     :param product_info Config: The configuration specific to
1051                                the product
1052     :return: True if the product compiles, else False
1053     :rtype: boolean
1054     """
1055     return not("properties" in product_info and
1056             "compilation" in product_info.properties and
1057             product_info.properties.compilation == "no")
1058
1059 def product_has_script(product_info):
1060     """Know if a product has a compilation script
1061
1062     :param product_info Config: The configuration specific to
1063                                the product
1064     :return: True if the product it has a compilation script, else False
1065     :rtype: boolean
1066     """
1067     if "build_source" not in product_info:
1068         # Native case
1069         return False
1070     build_src = product_info.build_source
1071     return build_src.lower() == 'script'
1072
1073 def product_has_env_script(product_info):
1074     """Know if a product has an environment script
1075
1076     :param product_info Config: The configuration specific to
1077                                the product
1078     :return: True if the product it has an environment script, else False
1079     :rtype: boolean
1080     """
1081     return "environ" in product_info and "env_script" in product_info.environ
1082
1083 def product_has_patches(product_info):
1084     """Know if a product has one or more patches
1085
1086     :param product_info Config: The configuration specific to
1087                                the product
1088     :return: True if the product has one or more patches
1089     :rtype: boolean
1090     """
1091     res = ( "patches" in product_info and len(product_info.patches) > 0 )
1092     return res
1093
1094 def product_has_logo(product_info):
1095     """Know if a product has a logo (YACSGEN generate)
1096
1097     :param product_info Config: The configuration specific to
1098                                the product
1099     :return: The path of the logo if the product has a logo, else False
1100     :rtype: Str
1101     """
1102     if ("properties" in product_info and
1103             "logo" in product_info.properties):
1104         return product_info.properties.logo
1105     else:
1106         return False
1107
1108 def product_has_licence(product_info, path):
1109     """Find out if a product has a licence
1110
1111     :param product_info Config: The configuration specific to the product
1112     :param path Str: The path where to search for the licence
1113     :return: The name of the licence file (the complete path if it is found in the path, else the name, else False
1114     :rtype: Str
1115     """
1116     if ("properties" in product_info and
1117             "licence" in product_info.properties):
1118         licence_name = product_info.properties.licence
1119         if len(path) > 0:
1120             # search for licence_name in path
1121             # a- consolidate the path into one signe string licence_path
1122             licence_path=path[0]
1123             for lpath in path[1:]:
1124                 licence_path=licence_path+":"+lpath
1125             licence_path_list=licence_path.split(":")
1126             licence_fullname = src.find_file_in_lpath(licence_name, licence_path_list)
1127             if licence_fullname:
1128                 return licence_fullname
1129
1130         # if the search of licence in path failed, we return its name (not the full path)
1131         return licence_name
1132
1133     else:
1134         return False  # product has no licence
1135
1136 def product_has_salome_gui(product_info):
1137     """Know if a product has a SALOME gui
1138
1139     :param product_info Config: The configuration specific to
1140                                the product
1141     :return: True if the product has a SALOME gui, else False
1142     :rtype: Boolean
1143     """
1144     return ("properties" in product_info and
1145             "has_salome_gui" in product_info.properties and
1146             product_info.properties.has_salome_gui == "yes")
1147
1148 def product_is_mpi(product_info):
1149     """Know if a product has openmpi in its dependencies
1150
1151     :param product_info Config: The configuration specific to
1152                                the product
1153     :return: True if the product has openmpi inits dependencies
1154     :rtype: boolean
1155     """
1156     return "openmpi" in product_info.depend
1157
1158 def product_is_generated(product_info):
1159     """Know if a product is generated (YACSGEN)
1160
1161     :param product_info Config: The configuration specific to
1162                                the product
1163     :return: True if the product is generated
1164     :rtype: boolean
1165     """
1166     return ("properties" in product_info and
1167             "generate" in product_info.properties and
1168             product_info.properties.generate == "yes")
1169
1170 def product_is_compile_time(product_info):
1171     """Know if a product is only used at compile time
1172
1173     :param product_info Config: The configuration specific to
1174                                the product
1175     :return: True if the product is only used at compile time
1176     :rtype: boolean
1177     """
1178     return ("properties" in product_info and
1179             "compile_time" in product_info.properties and
1180             product_info.properties.compile_time == "yes")
1181
1182 def product_is_compile_and_runtime(product_info):
1183     """Know if a product is only used at compile time
1184
1185     :param product_info Config: The configuration specific to
1186                                the product
1187     :return: True if the product is only used at compile time
1188     :rtype: boolean
1189     """
1190     return ("properties" in product_info and
1191             "compile_and_runtime" in product_info.properties and
1192             product_info.properties.compile_and_runtime == "yes")
1193
1194
1195
1196 def product_test_property(product_info, property_name, property_value):
1197     """Generic function to test if a product has a property set to a value
1198
1199     :param product_info Config: The configuration specific to
1200                                the product
1201     :param property_name : The name of the property to check
1202     :param property_value : The value of the property to test
1203     :return: True if the product has the property and the property is set to property_value
1204     :rtype: boolean
1205     """
1206     # first check if product has the property
1207     if not ("properties" in product_info and
1208             property_name in product_info.properties):
1209         return False
1210
1211     # then check to the property is set to property_value
1212     eval_expression = 'product_info.properties.%s == "%s"' % (property_name,property_value)
1213     result = eval(eval_expression)
1214     return result
1215
1216 def check_system_dep(check_cmd, product_info):
1217     """Search for system dependencies, check if installed
1218     :param check_cmd Config: The command to use for checking (rpm/apt)
1219     :param product_info Config: The configuration specific to the product
1220     :rtype: two dictionnaries for runtime and compile time dependencies with text status
1221     """
1222     runtime_dep={}
1223     build_dep={}
1224     if "system_info" in product_info:
1225         if check_cmd[0]=="rpm":
1226             if "rpm" in product_info.system_info:
1227                 for pkg in product_info.system_info.rpm:
1228                     runtime_dep[pkg]=src.system.check_system_pkg(check_cmd,pkg)
1229             if "rpm_dev" in product_info.system_info:
1230                 for pkg in product_info.system_info.rpm_dev:
1231                     build_dep[pkg]=src.system.check_system_pkg(check_cmd,pkg)
1232         if check_cmd[0]=="apt":
1233             if "apt" in product_info.system_info:
1234                 for pkg in product_info.system_info.apt:
1235                     runtime_dep[pkg]=src.system.check_system_pkg(check_cmd,pkg)
1236             if "apt_dev" in product_info.system_info:
1237                 for pkg in product_info.system_info.apt_dev:
1238                     build_dep[pkg]=src.system.check_system_pkg(check_cmd,pkg)
1239     return runtime_dep,build_dep
1240
1241
1242 def get_product_components(product_info):
1243     """Get the component list to generate with the product
1244
1245     :param product_info Config: The configuration specific to
1246                                the product
1247     :return: The list of names of the components
1248     :rtype: List
1249
1250     """
1251     if not product_is_generated(product_info):
1252         return []
1253
1254     compo_list = []
1255     if "component_name" in product_info:
1256         compo_list = product_info.component_name
1257
1258         if isinstance(compo_list, str):
1259             compo_list = [ compo_list ]
1260
1261     return compo_list
1262 def product_is_wheel(product_info):
1263     """ tells whether a product is a wheel
1264
1265     :param product_info Config: The configuration specific to
1266                                the product
1267     :return: True if the product has a wheel, else False
1268     :rtype: Boolean
1269     """
1270     return ("properties" in product_info and
1271             "is_wheel" in product_info.properties and
1272             product_info.properties.is_wheel == "yes")
1273