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
  31 AVAILABLE_VCS = ['git', 'svn', 'cvs']
  32 config_expression = "^config-\d+$"
  33 VERSION_DELIMITER = "_to_"
  34
  35 def get_product_config(config, product_name, with_install_dir=True):
  36     """Get the specific configuration of a product from the global configuration
  37
  38     :param config Config: The global configuration
  39     :param product_name str: The name of the product
  40     :param with_install_dir boolean: If false, do not provide an install
  41                                      directory (at false only for internal use
  42                                      of the function check_config_exists)
  43     :return: the specific configuration of the product
  44     :rtype: Config
  45     """
  46
  47     # Get the version of the product from the application definition
  48     version = config.APPLICATION.products[product_name]
  49     # if no version, then take the default one defined in the application
  50     if isinstance(version, bool):
  51         version = config.APPLICATION.tag
  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     verbose = 'no'
  59     base = 'maybe'
  60     section = None
  61     if isinstance(version, src.pyconf.Mapping):
  62         dic_version = version
  63         # Get the version/tag
  64         if not 'tag' in dic_version:
  65             version = config.APPLICATION.tag
  66         else:
  67             version = dic_version.tag
  68
  69         # Get the debug if any
  70         if 'debug' in dic_version:
  71             debug = dic_version.debug
  72
  73         # Get the verbose if any
  74         if 'verbose' in dic_version:
  75             verbose = dic_version.verbose
  76
  77         # Get the dev if any
  78         if 'dev' in dic_version:
  79             dev = dic_version.dev
  80
  81         # Get the base if any
  82         if 'base' in dic_version:
  83             base = dic_version.base
  84
  85         # Get the section if any
  86         if 'section' in dic_version:
  87             section = dic_version.section
  88
  89     vv = version
  90     # substitute some character with _ in order to get the correct definition
  91     # in config.PRODUCTS. This is done because the pyconf tool does not handle
  92     # the . and - characters
  93     for c in ".-": vv = vv.replace(c, "_")
  94
  95     prod_info = None
  96     if product_name in config.PRODUCTS:
  97         # Search for the product description in the configuration
  98         prod_info = get_product_section(config, product_name, vv, section)
  99
 100         # merge opt_depend in depend
 101         if prod_info is not None and 'opt_depend' in prod_info:
 102             for depend in prod_info.opt_depend:
 103                 if depend in config.APPLICATION.products:
 104                     prod_info.depend.append(depend,'')
 105
 106         # In case of a product get with a vcs,
 107         # put the tag (equal to the version)
 108         if prod_info is not None and prod_info.get_source in AVAILABLE_VCS:
 109
 110             if prod_info.get_source == 'git':
 111                 prod_info.git_info.tag = version
 112
 113             if prod_info.get_source == 'svn':
 114                 prod_info.svn_info.tag = version
 115
 116             if prod_info.get_source == 'cvs':
 117                 prod_info.cvs_info.tag = version
 118
 119         # In case of a fixed product,
 120         # define the install_dir (equal to the version)
 121         if prod_info is not None and os.path.isdir(version):
 122             prod_info.install_dir = version
 123             prod_info.get_source = "fixed"
 124
 125         # Check if the product is defined as native in the application
 126         if prod_info is not None:
 127             if version == "native":
 128                 prod_info.get_source = "native"
 129             elif prod_info.get_source == "native":
 130                 msg = _("The product %(prod)s has version %(ver)s but is "
 131                         "declared as native in its definition" %
 132                         { 'prod': prod_info.name, 'ver': version})
 133                 raise src.SatException(msg)
 134
 135     # If there is no definition but the product is declared as native,
 136     # construct a new definition containing only the get_source key
 137     if prod_info is None and version == "native":
 138         prod_info = src.pyconf.Config()
 139         prod_info.name = product_name
 140         prod_info.get_source = "native"
 141
 142     # If there is no definition but the product is fixed,
 143     # construct a new definition containing only the product name
 144     if prod_info is None and os.path.isdir(version):
 145         prod_info = src.pyconf.Config()
 146         prod_info.name = product_name
 147         prod_info.get_source = "fixed"
 148         prod_info.addMapping("environ", src.pyconf.Mapping(prod_info), "")
 149
 150
 151     # If prod_info is still None, it means that there is no product definition
 152     # in the config. The user has to provide it.
 153     if prod_info is None:
 154         prod_pyconf_path = src.find_file_in_lpath(product_name + ".pyconf",
 155                                                   config.PATHS.PRODUCTPATH)
 156         if not prod_pyconf_path:
 157             msg = _("""\
 158 No definition found for the product %(1)s.
 159 Please create a %(2)s.pyconf file somewhere in:
 160 %(3)s""") % {
 161   "1": product_name,
 162   "2": product_name,
 163   "3": config.PATHS.PRODUCTPATH }
 164         else:
 165             msg = _("""\
 166 No definition corresponding to the version %(1)s was found in the file:
 167   %(2)s.
 168 Please add a section in it.""") % {"1" : vv, "2" : prod_pyconf_path}
 169         raise src.SatException(msg)
 170
 171     # Set the debug, dev and version keys
 172     prod_info.debug = debug
 173     prod_info.verbose = verbose
 174     prod_info.dev = dev
 175     prod_info.version = version
 176
 177     # Set the archive_info if the product is get in archive mode
 178     if prod_info.get_source == "archive":
 179         if not "archive_info" in prod_info:
 180             prod_info.addMapping("archive_info",
 181                                  src.pyconf.Mapping(prod_info),
 182                                  "")
 183         if "archive_name" not in prod_info.archive_info:
 184             arch_name = product_name + "-" + version + ".tar.gz"
 185             arch_path = src.find_file_in_lpath(arch_name,
 186                                                config.PATHS.ARCHIVEPATH)
 187             if not arch_path:
 188                 msg = _("Archive %(1)s for %(2)s not found in config.PATHS.ARCHIVEPATH") % \
 189                        {"1" : arch_name, "2" : prod_info.name}
 190                 DBG.tofix(msg, config.PATHS.ARCHIVEPATH)
 191                 prod_info.archive_info.archive_name = arch_name #without path
 192                 # raise src.SatException(msg) #may be a warning, continue #8646
 193             else:
 194                 prod_info.archive_info.archive_name = arch_path
 195         else:
 196             if (os.path.basename(prod_info.archive_info.archive_name) ==
 197                                         prod_info.archive_info.archive_name):
 198                 arch_name = prod_info.archive_info.archive_name
 199                 arch_path = src.find_file_in_lpath(
 200                                             arch_name,
 201                                             config.PATHS.ARCHIVEPATH)
 202                 if not arch_path:
 203                     msg = _("Archive %(1)s for %(2)s not found in config.PATHS.ARCHIVEPATH") % \
 204                            {"1" : arch_name, "2" : prod_info.name}
 205                     DBG.tofix(msg, config.PATHS.ARCHIVEPATH) #avoid 2 messages in compile
 206                     prod_info.archive_info.archive_name = arch_name #without path
 207                     # raise src.SatException(msg) #may be a warning, continue #8646
 208                 else:
 209                     prod_info.archive_info.archive_name = arch_path
 210
 211
 212     # If the product compiles with a script, check the script existence
 213     # and if it is executable
 214     if product_has_script(prod_info):
 215         # Check the compil_script key existence
 216         if "compil_script" not in prod_info:
 217             msg = _("""\
 218 No compilation script found for the product %s.
 219 Please provide a 'compil_script' key in its definition.""") % product_name
 220             raise src.SatException(msg)
 221
 222         # Get the path of the script file
 223         # if windows supposed '.bat', if linux supposed '.sh'
 224         # but user set extension script file in his pyconf as he wants, no obligation.
 225         script = prod_info.compil_script
 226         script_name = os.path.basename(script)
 227         if script == script_name:
 228             # Only a name is given. Search in the default directory
 229             script_path = src.find_file_in_lpath(script_name, config.PATHS.PRODUCTPATH, "compil_scripts")
 230             if not script_path:
 231                 msg = _("Compilation script %s not found in") % script_name
 232                 DBG.tofix(msg, config.PATHS.PRODUCTPATH, True) # say where searched
 233                 # avoid stop if sat prepare, script could be included in sources, only warning
 234                 # raise src.SatException(msg)
 235                 script_path = "*** Not Found: %s" % script_name
 236             prod_info.compil_script = script_path
 237
 238
 239         # Check that the script is executable
 240         if os.path.exists(prod_info.compil_script) and not os.access(prod_info.compil_script, os.X_OK):
 241             #raise src.SatException(
 242             #        _("Compilation script cannot be executed: %s") %
 243             #        prod_info.compil_script)
 244             # just as warning, problem later...
 245             DBG.tofix("Compilation script  file is not in 'execute mode'", prod_info.compil_script, True)
 246
 247     # Get the full paths of all the patches
 248     if product_has_patches(prod_info):
 249         patches = []
 250         try:
 251           for patch in prod_info.patches:
 252               patch_path = patch
 253               # If only a filename, then search for the patch in the PRODUCTPATH
 254               if os.path.basename(patch_path) == patch_path:
 255                   # Search in the PRODUCTPATH/patches
 256                   patch_path = src.find_file_in_lpath(patch,
 257                                                       config.PATHS.PRODUCTPATH,
 258                                                       "patches")
 259                   if not patch_path:
 260                       msg = _("Patch %(patch_name)s for %(prod_name)s not found:"
 261                               "\n" % {"patch_name" : patch,
 262                                        "prod_name" : prod_info.name})
 263                       raise src.SatException(msg)
 264               patches.append(patch_path)
 265         except:
 266           DBG.tofix("problem in prod_info.patches", prod_info)
 267         prod_info.patches = patches
 268
 269     # Get the full paths of the environment scripts
 270     if product_has_env_script(prod_info):
 271         env_script_path = prod_info.environ.env_script
 272         # If only a filename, then search for the environment script
 273         # in the PRODUCTPATH/env_scripts
 274         if os.path.basename(env_script_path) == env_script_path:
 275             # Search in the PRODUCTPATH/env_scripts
 276             env_script_path = src.find_file_in_lpath(
 277                                             prod_info.environ.env_script,
 278                                             config.PATHS.PRODUCTPATH,
 279                                             "env_scripts")
 280             if not env_script_path:
 281                 msg = _("Environment script %(env_name)s for %(prod_name)s not "
 282                         "found.\n" % {"env_name" : env_script_path,
 283                                        "prod_name" : prod_info.name})
 284                 raise src.SatException(msg)
 285
 286         prod_info.environ.env_script = env_script_path
 287
 288     if with_install_dir:
 289         # The variable with_install_dir is at false only for internal use
 290         # of the function get_install_dir
 291
 292         # Save the install_dir key if there is any
 293         if "install_dir" in prod_info and not "install_dir_save" in prod_info:
 294             prod_info.install_dir_save = prod_info.install_dir
 295
 296         # if it is not the first time the install_dir is computed, it means
 297         # that install_dir_save exists and it has to be taken into account.
 298         if "install_dir_save" in prod_info:
 299             prod_info.install_dir = prod_info.install_dir_save
 300
 301         # Set the install_dir key
 302         prod_info.install_dir = get_install_dir(config, base, version, prod_info)
 303
 304     return prod_info
 305
 306 def get_product_section(config, product_name, version, section=None):
 307     """Get the product description from the configuration
 308
 309     :param config Config: The global configuration
 310     :param product_name str: The product name
 311     :param version str: The version of the product
 312     :param section str: The searched section (if not None, the section is
 313                         explicitly given
 314     :return: The product description
 315     :rtype: Config
 316     """
 317
 318     # if section is not None, try to get the corresponding section
 319     if section:
 320         if section not in config.PRODUCTS[product_name]:
 321             return None
 322         # returns specific information for the given version
 323         prod_info = config.PRODUCTS[product_name][section]
 324         prod_info.section = section
 325         prod_info.from_file = config.PRODUCTS[product_name].from_file
 326         return prod_info
 327
 328     # If it exists, get the information of the product_version
 329     if "version_" + version in config.PRODUCTS[product_name]:
 330         # returns specific information for the given version
 331         prod_info = config.PRODUCTS[product_name]["version_" + version]
 332         prod_info.section = "version_" + version
 333         prod_info.from_file = config.PRODUCTS[product_name].from_file
 334         return prod_info
 335
 336     # Else, check if there is a description for multiple versions
 337     l_section_name = config.PRODUCTS[product_name].keys()
 338     l_section_ranges = [section_name for section_name in l_section_name
 339                         if VERSION_DELIMITER in section_name]
 340     for section_range in l_section_ranges:
 341         minimum, maximum = section_range.split(VERSION_DELIMITER)
 342         if (src.only_numbers(version) >= src.only_numbers(minimum)
 343                     and src.only_numbers(version) <= src.only_numbers(maximum)):
 344             # returns specific information for the versions
 345             prod_info = config.PRODUCTS[product_name][section_range]
 346             prod_info.section = section_range
 347             prod_info.from_file = config.PRODUCTS[product_name].from_file
 348             return prod_info
 349
 350
 351
 352     # Else, get the standard informations
 353     if "default" in config.PRODUCTS[product_name]:
 354         # returns the generic information (given version not found)
 355         prod_info = config.PRODUCTS[product_name].default
 356         prod_info.section = "default"
 357         prod_info.from_file = config.PRODUCTS[product_name].from_file
 358         return prod_info
 359
 360     # if noting was found, return None
 361     return None
 362
 363 def get_install_dir(config, base, version, prod_info):
 364     """Compute the installation directory of a given product
 365
 366     :param config Config: The global configuration
 367     :param base str: This corresponds to the value given by user in its
 368                      application.pyconf for the specific product. If "yes", the
 369                      user wants the product to be in base. If "no", he wants the
 370                      product to be in the application workdir
 371     :param version str: The version of the product
 372     :param product_info Config: The configuration specific to
 373                                the product
 374
 375     :return: The path of the product installation
 376     :rtype: str
 377     """
 378     install_dir = ""
 379     in_base = False
 380     if (("install_dir" in prod_info and prod_info.install_dir == "base")
 381                                                             or base == "yes"):
 382         in_base = True
 383     if (base == "no" or ("no_base" in config.APPLICATION
 384                          and config.APPLICATION.no_base == "yes")):
 385         in_base = False
 386
 387     if in_base:
 388         install_dir = get_base_install_dir(config, prod_info, version)
 389     else:
 390         if "install_dir" not in prod_info or prod_info.install_dir == "base":
 391             # Set it to the default value (in application directory)
 392             install_dir = os.path.join(config.APPLICATION.workdir,
 393                                                 "INSTALL",
 394                                                 prod_info.name)
 395         else:
 396             install_dir = prod_info.install_dir
 397
 398     return install_dir
 399
 400 def get_base_install_dir(config, prod_info, version):
 401     """Compute the installation directory of a product in base
 402
 403     :param config Config: The global configuration
 404     :param product_info Config: The configuration specific to
 405                                the product
 406     :param version str: The version of the product
 407     :return: The path of the product installation
 408     :rtype: str
 409     """
 410     base_path = src.get_base_path(config)
 411     prod_dir = os.path.join(base_path, prod_info.name + "-" + version)
 412     if not os.path.exists(prod_dir):
 413         return os.path.join(prod_dir, "config-1")
 414
 415     exists, install_dir = check_config_exists(config, prod_dir, prod_info)
 416     if exists:
 417         return install_dir
 418
 419     # Find the first config-<i> directory that is available in the product
 420     # directory
 421     found = False
 422     label = 1
 423     while not found:
 424         install_dir = os.path.join(prod_dir, "config-%i" % label)
 425         if os.path.exists(install_dir):
 426             label+=1
 427         else:
 428             found = True
 429
 430     return install_dir
 431
 432 def check_config_exists(config, prod_dir, prod_info):
 433     """\
 434     Verify that the installation directory of a product in a base exists
 435     Check all the config-<i> directory and verify the sat-config.pyconf file
 436     that is in it
 437
 438     :param config Config: The global configuration
 439     :param prod_dir str: The product installation directory path
 440                          (without config-<i>)
 441     :param product_info Config: The configuration specific to
 442                                the product
 443     :return: True or false is the installation is found or not
 444              and if it is found, the path of the found installation
 445     :rtype: (boolean, str)
 446     """
 447     # check if the directories or files of the directory corresponds to the
 448     # directory installation of the product
 449     l_dir_and_files = os.listdir(prod_dir)
 450     for dir_or_file in l_dir_and_files:
 451         oExpr = re.compile(config_expression)
 452         if not(oExpr.search(dir_or_file)):
 453             # not config-<i>, not interesting
 454             continue
 455         # check if there is the file sat-config.pyconf file in the installation
 456         # directory
 457         config_file = os.path.join(prod_dir, dir_or_file, src.CONFIG_FILENAME)
 458         if not os.path.exists(config_file):
 459             continue
 460
 461         # If there is no dependency, it is the right path
 462         if len(prod_info.depend)==0:
 463             compile_cfg = src.pyconf.Config(config_file)
 464             if len(compile_cfg) == 0:
 465                 return True, os.path.join(prod_dir, dir_or_file)
 466             continue
 467
 468         # check if there is the config described in the file corresponds the
 469         # dependencies of the product
 470         config_corresponds = True
 471         compile_cfg = src.pyconf.Config(config_file)
 472         for prod_dep in prod_info.depend:
 473             # if the dependency is not in the config,
 474             # the config does not correspond
 475             if prod_dep not in compile_cfg:
 476                 config_corresponds = False
 477                 break
 478             else:
 479                 prod_dep_info = get_product_config(config, prod_dep, False)
 480                 # If the version of the dependency does not correspond,
 481                 # the config does not correspond
 482                 if prod_dep_info.version != compile_cfg[prod_dep]:
 483                     config_corresponds = False
 484                     break
 485
 486         for prod_name in compile_cfg:
 487             if prod_name not in prod_info.depend:
 488                 config_corresponds = False
 489                 break
 490
 491         if config_corresponds:
 492             return True, os.path.join(prod_dir, dir_or_file)
 493
 494     return False, None
 495
 496
 497
 498 def get_products_infos(lproducts, config):
 499     """Get the specific configuration of a list of products
 500
 501     :param lproducts List: The list of product names
 502     :param config Config: The global configuration
 503     :return: the list of tuples
 504              (product name, specific configuration of the product)
 505     :rtype: [(str, Config)]
 506     """
 507     products_infos = []
 508     # Loop on product names
 509     for prod in lproducts:
 510         # Get the specific configuration of the product
 511         prod_info = get_product_config(config, prod)
 512         if prod_info is not None:
 513             products_infos.append((prod, prod_info))
 514         else:
 515             msg = _("The %s product has no definition in the configuration.") % prod
 516             raise src.SatException(msg)
 517     return products_infos
 518
 519
 520 def get_products_list(options, cfg, logger):
 521     """
 522     method that gives the product list with their informations from
 523     configuration regarding the passed options.
 524
 525     :param options Options: The Options instance that stores the commands arguments
 526     :param cfg Config: The global configuration
 527     :param logger Logger: The logger instance to use for the display and logging
 528     :return: The list of (product name, product_informations).
 529     :rtype: List
 530     """
 531     # Get the products to be prepared, regarding the options
 532     if options.products is None:
 533         # No options, get all products sources
 534         products = cfg.APPLICATION.products
 535     else:
 536         # if option --products, check that all products of the command line
 537         # are present in the application.
 538         products = options.products
 539         for p in products:
 540             if p not in cfg.APPLICATION.products:
 541                 raise src.SatException(_("Product %(product)s "
 542                             "not defined in application %(application)s") %
 543                         { 'product': p, 'application': cfg.VARS.application} )
 544
 545     # Construct the list of tuple containing
 546     # the products name and their definition
 547     resAll = src.product.get_products_infos(products, cfg)
 548
 549     # if the property option was passed, filter the list
 550     if options.properties: # existing properties
 551       ok = []
 552       ko = []
 553       res =[]
 554       prop, value = options.properties # for example 'is_SALOME_module', 'yes'
 555       for p_name, p_info in resAll:
 556         try:
 557           if p_info.properties[prop] == value:
 558             res.append((p_name, p_info))
 559             ok.append(p_name)
 560           else:
 561             ko.append(p_name)
 562         except:
 563           ok.append(p_name)
 564
 565       if len(ok) != len(resAll):
 566         logger.trace("on properties %s\n products accepted:\n %s\n products rejected:\n %s\n" %
 567                        (options.properties, PP.pformat(sorted(ok)), PP.pformat(sorted(ko))))
 568       else:
 569         logger.warning("properties %s\n seems useless with no products rejected" %
 570                        (options.properties))
 571     else:
 572       res = resAll # not existing properties as all accepted
 573
 574
 575     ok = []
 576     ko = []
 577     products_infos = []
 578     for p_name, p_info in res:
 579       try:
 580         if src.product.product_is_native(p_info) or src.product.product_is_fixed(p_info):
 581           ko.append(p_name)
 582         else:
 583           products_infos.append((p_name, p_info))
 584           ok.append(p_name)
 585       except:
 586         msg = "problem on 'is_native' or 'is_fixed' for product %s" % p_name
 587         raise Exception(msg)
 588
 589     if len(ko) > 0:
 590       logger.warning("on is_native or is_fixed\n products accepted:\n %s\n products rejected:\n %s\n" %
 591                     (PP.pformat(sorted(ok)), PP.pformat(sorted(ko))))
 592
 593     logger.debug("products selected:\n %s\n" % PP.pformat(sorted(ok)))
 594
 595     return res
 596
 597
 598 def get_product_dependencies(config, product_info):
 599     """\
 600     Get recursively the list of products that are
 601     in the product_info dependencies
 602
 603     :param config Config: The global configuration
 604     :param product_info Config: The configuration specific to
 605                                the product
 606     :return: the list of products in dependence
 607     :rtype: list
 608     """
 609     if "depend" not in product_info or product_info.depend == []:
 610         return []
 611     res = []
 612     for prod in product_info.depend:
 613         if prod == product_info.name:
 614             continue
 615         if prod not in res:
 616             res.append(prod)
 617         prod_info = get_product_config(config, prod)
 618         dep_prod = get_product_dependencies(config, prod_info)
 619         for prod_in_dep in dep_prod:
 620             if prod_in_dep not in res:
 621                 res.append(prod_in_dep)
 622     return res
 623
 624 def check_installation(product_info):
 625     """\
 626     Verify if a product is well installed. Checks install directory presence
 627     and some additional files if it is defined in the config
 628
 629     :param product_info Config: The configuration specific to
 630                                the product
 631     :return: True if it is well installed
 632     :rtype: boolean
 633     """
 634     if not product_compiles(product_info):
 635         return True
 636     install_dir = product_info.install_dir
 637     if not os.path.exists(install_dir):
 638         return False
 639     if ("present_files" in product_info and
 640         "install" in product_info.present_files):
 641         for file_relative_path in product_info.present_files.install:
 642             file_path = os.path.join(install_dir, file_relative_path)
 643             if not os.path.exists(file_path):
 644                 return False
 645     return True
 646
 647 def check_source(product_info):
 648     """Verify if a sources of product is preset. Checks source directory presence
 649
 650     :param product_info Config: The configuration specific to
 651                                the product
 652     :return: True if it is well installed
 653     :rtype: boolean
 654     """
 655     DBG.write("check_source product_info", product_info)
 656     source_dir = product_info.source_dir
 657     if not os.path.exists(source_dir):
 658         return False
 659     if ("present_files" in product_info and
 660         "source" in product_info.present_files):
 661         for file_relative_path in product_info.present_files.source:
 662             file_path = os.path.join(source_dir, file_relative_path)
 663             if not os.path.exists(file_path):
 664                 return False
 665     return True
 666
 667 def product_is_salome(product_info):
 668     """Know if a product is a SALOME module
 669
 670     :param product_info Config: The configuration specific to
 671                                the product
 672     :return: True if the product is a SALOME module, else False
 673     :rtype: boolean
 674     """
 675     return ("properties" in product_info and
 676             "is_SALOME_module" in product_info.properties and
 677             product_info.properties.is_SALOME_module == "yes")
 678
 679 def product_is_fixed(product_info):
 680     """Know if a product is fixed
 681
 682     :param product_info Config: The configuration specific to
 683                                the product
 684     :return: True if the product is fixed, else False
 685     :rtype: boolean
 686     """
 687     get_src = product_info.get_source
 688     return get_src.lower() == 'fixed'
 689
 690 def product_is_native(product_info):
 691     """Know if a product is native
 692
 693     :param product_info Config: The configuration specific to
 694                                the product
 695     :return: True if the product is native, else False
 696     :rtype: boolean
 697     """
 698     get_src = product_info.get_source
 699     return get_src.lower() == 'native'
 700
 701 def product_is_dev(product_info):
 702     """Know if a product is in dev mode
 703
 704     :param product_info Config: The configuration specific to
 705                                the product
 706     :return: True if the product is in dev mode, else False
 707     :rtype: boolean
 708     """
 709     dev = product_info.dev
 710     res = (dev.lower() == 'yes')
 711     DBG.write('product_is_dev %s' % product_info.name, res)
 712     # if product_info.name == "XDATA": return True #test #10569
 713     return res
 714
 715 def product_is_debug(product_info):
 716     """Know if a product is in debug mode
 717
 718     :param product_info Config: The configuration specific to
 719                                the product
 720     :return: True if the product is in debug mode, else False
 721     :rtype: boolean
 722     """
 723     debug = product_info.debug
 724     return debug.lower() == 'yes'
 725
 726 def product_is_verbose(product_info):
 727     """Know if a product is in verbose mode
 728
 729     :param product_info Config: The configuration specific to
 730                                the product
 731     :return: True if the product is in verbose mode, else False
 732     :rtype: boolean
 733     """
 734     verbose = product_info.verbose
 735     return verbose.lower() == 'yes'
 736
 737 def product_is_autotools(product_info):
 738     """Know if a product is compiled using the autotools
 739
 740     :param product_info Config: The configuration specific to
 741                                the product
 742     :return: True if the product is autotools, else False
 743     :rtype: boolean
 744     """
 745     build_src = product_info.build_source
 746     return build_src.lower() == 'autotools'
 747
 748 def product_is_cmake(product_info):
 749     """Know if a product is compiled using the cmake
 750
 751     :param product_info Config: The configuration specific to
 752                                the product
 753     :return: True if the product is cmake, else False
 754     :rtype: boolean
 755     """
 756     build_src = product_info.build_source
 757     return build_src.lower() == 'cmake'
 758
 759 def product_is_vcs(product_info):
 760     """Know if a product is download using git, svn or cvs (not archive)
 761
 762     :param product_info Config: The configuration specific to
 763                                the product
 764     :return: True if the product is vcs, else False
 765     :rtype: boolean
 766     """
 767     return product_info.get_source in AVAILABLE_VCS
 768
 769 def product_is_smesh_plugin(product_info):
 770     """Know if a product is a SMESH plugin
 771
 772     :param product_info Config: The configuration specific to
 773                                the product
 774     :return: True if the product is a SMESH plugin, else False
 775     :rtype: boolean
 776     """
 777     return ("properties" in product_info and
 778             "smesh_plugin" in product_info.properties and
 779             product_info.properties.smesh_plugin == "yes")
 780
 781 def product_is_cpp(product_info):
 782     """Know if a product is cpp
 783
 784     :param product_info Config: The configuration specific to
 785                                the product
 786     :return: True if the product is a cpp, else False
 787     :rtype: boolean
 788     """
 789     return ("properties" in product_info and
 790             "cpp" in product_info.properties and
 791             product_info.properties.cpp == "yes")
 792
 793 def product_compiles(product_info):
 794     """\
 795     Know if a product compiles or not
 796     (some products do not have a compilation procedure)
 797
 798     :param product_info Config: The configuration specific to
 799                                the product
 800     :return: True if the product compiles, else False
 801     :rtype: boolean
 802     """
 803     return not("properties" in product_info and
 804             "compilation" in product_info.properties and
 805             product_info.properties.compilation == "no")
 806
 807 def product_has_script(product_info):
 808     """Know if a product has a compilation script
 809
 810     :param product_info Config: The configuration specific to
 811                                the product
 812     :return: True if the product it has a compilation script, else False
 813     :rtype: boolean
 814     """
 815     if "build_source" not in product_info:
 816         # Native case
 817         return False
 818     build_src = product_info.build_source
 819     return build_src.lower() == 'script'
 820
 821 def product_has_env_script(product_info):
 822     """Know if a product has an environment script
 823
 824     :param product_info Config: The configuration specific to
 825                                the product
 826     :return: True if the product it has an environment script, else False
 827     :rtype: boolean
 828     """
 829     return "environ" in product_info and "env_script" in product_info.environ
 830
 831 def product_has_patches(product_info):
 832     """Know if a product has one or more patches
 833
 834     :param product_info Config: The configuration specific to
 835                                the product
 836     :return: True if the product has one or more patches
 837     :rtype: boolean
 838     """
 839     res = ( "patches" in product_info and len(product_info.patches) > 0 )
 840     DBG.write('product_has_patches %s' % product_info.name, res)
 841     # if product_info.name == "XDATA": return True #test #10569
 842     return res
 843
 844 def product_has_logo(product_info):
 845     """Know if a product has a logo (YACSGEN generate)
 846
 847     :param product_info Config: The configuration specific to
 848                                the product
 849     :return: The path of the logo if the product has a logo, else False
 850     :rtype: Str
 851     """
 852     if ("properties" in product_info and
 853             "logo" in product_info.properties):
 854         return product_info.properties.logo
 855     else:
 856         return False
 857
 858 def product_has_salome_gui(product_info):
 859     """Know if a product has a SALOME gui
 860
 861     :param product_info Config: The configuration specific to
 862                                the product
 863     :return: True if the product has a SALOME gui, else False
 864     :rtype: Boolean
 865     """
 866     return ("properties" in product_info and
 867             "has_salome_gui" in product_info.properties and
 868             product_info.properties.has_salome_gui == "yes")
 869
 870 def product_is_mpi(product_info):
 871     """Know if a product has openmpi in its dependencies
 872
 873     :param product_info Config: The configuration specific to
 874                                the product
 875     :return: True if the product has openmpi inits dependencies
 876     :rtype: boolean
 877     """
 878     return "openmpi" in product_info.depend
 879
 880 def product_is_generated(product_info):
 881     """Know if a product is generated (YACSGEN)
 882
 883     :param product_info Config: The configuration specific to
 884                                the product
 885     :return: True if the product is generated
 886     :rtype: boolean
 887     """
 888     return ("properties" in product_info and
 889             "generate" in product_info.properties and
 890             product_info.properties.generate == "yes")
 891
 892 def get_product_components(product_info):
 893     """Get the component list to generate with the product
 894
 895     :param product_info Config: The configuration specific to
 896                                the product
 897     :return: The list of names of the components
 898     :rtype: List
 899
 900     """
 901     if not product_is_generated(product_info):
 902         return []
 903
 904     compo_list = []
 905     if "component_name" in product_info:
 906         compo_list = product_info.component_name
 907
 908         if isinstance(compo_list, str):
 909             compo_list = [ compo_list ]
 910
 911     return compo_list