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 '''In this file are implemented the methods
  19    relative to the product notion of salomeTools
  20 '''
  21
  22 import os
  23 import re
  24
  25 import src
  26
  27 AVAILABLE_VCS = ['git', 'svn', 'cvs']
  28 config_expression = "^config-\d+$"
  29 VERSION_DELIMITER = "_to_"
  30
  31 def get_product_config(config, product_name, with_install_dir=True):
  32     '''Get the specific configuration of a product from the global configuration
  33
  34     :param config Config: The global configuration
  35     :param product_name str: The name of the product
  36     :param with_install_dir boolean: If false, do not provide an install
  37                                      directory (at false only for internal use
  38                                      of the function check_config_exists)
  39     :return: the specific configuration of the product
  40     :rtype: Config
  41     '''
  42
  43     # Get the version of the product from the application definition
  44     version = config.APPLICATION.products[product_name]
  45     # if no version, then take the default one defined in the application
  46     if isinstance(version, bool):
  47         version = config.APPLICATION.tag
  48
  49     # Define debug and dev modes
  50     # Get the tag if a dictionary is given in APPLICATION.products for the
  51     # current product
  52     debug = 'no'
  53     dev = 'no'
  54     base = 'maybe'
  55     section = None
  56     if isinstance(version, src.pyconf.Mapping):
  57         dic_version = version
  58         # Get the version/tag
  59         if not 'tag' in dic_version:
  60             version = config.APPLICATION.tag
  61         else:
  62             version = dic_version.tag
  63
  64         # Get the debug if any
  65         if 'debug' in dic_version:
  66             debug = dic_version.debug
  67
  68         # Get the dev if any
  69         if 'dev' in dic_version:
  70             dev = dic_version.dev
  71
  72         # Get the base if any
  73         if 'base' in dic_version:
  74             base = dic_version.base
  75
  76         # Get the section if any
  77         if 'section' in dic_version:
  78             section = dic_version.section
  79
  80     vv = version
  81     # substitute some character with _ in order to get the correct definition
  82     # in config.PRODUCTS. This is done because the pyconf tool does not handle
  83     # the . and - characters
  84     for c in ".-": vv = vv.replace(c, "_")
  85
  86     prod_info = None
  87     if product_name in config.PRODUCTS:
  88         # Search for the product description in the configuration
  89         prod_info = get_product_section(config, product_name, vv, section)
  90
  91         # merge opt_depend in depend
  92         if prod_info is not None and 'opt_depend' in prod_info:
  93             for depend in prod_info.opt_depend:
  94                 if depend in config.APPLICATION.products:
  95                     prod_info.depend.append(depend,'')
  96
  97         # In case of a product get with a vcs,
  98         # put the tag (equal to the version)
  99         if prod_info is not None and prod_info.get_source in AVAILABLE_VCS:
 100
 101             if prod_info.get_source == 'git':
 102                 prod_info.git_info.tag = version
 103
 104             if prod_info.get_source == 'svn':
 105                 prod_info.svn_info.tag = version
 106
 107             if prod_info.get_source == 'cvs':
 108                 prod_info.cvs_info.tag = version
 109
 110         # In case of a fixed product,
 111         # define the install_dir (equal to the version)
 112         if prod_info is not None and os.path.isdir(version):
 113             prod_info.install_dir = version
 114             prod_info.get_source = "fixed"
 115
 116         # Check if the product is defined as native in the application
 117         if prod_info is not None:
 118             if version == "native":
 119                 prod_info.get_source = "native"
 120             elif prod_info.get_source == "native":
 121                 msg = _("The product %(prod)s has version %(ver)s but is "
 122                         "declared as native in its definition" %
 123                         { 'prod': prod_info.name, 'ver': version})
 124                 raise src.SatException(msg)
 125
 126     # If there is no definition but the product is declared as native,
 127     # construct a new definition containing only the get_source key
 128     if prod_info is None and version == "native":
 129         prod_info = src.pyconf.Config()
 130         prod_info.name = product_name
 131         prod_info.get_source = "native"
 132
 133     # If there is no definition but the product is fixed,
 134     # construct a new definition containing only the product name
 135     if prod_info is None and os.path.isdir(version):
 136         prod_info = src.pyconf.Config()
 137         prod_info.name = product_name
 138         prod_info.get_source = "fixed"
 139         prod_info.addMapping("environ", src.pyconf.Mapping(prod_info), "")
 140
 141
 142     # If prod_info is still None, it means that there is no product definition
 143     # in the config. The user has to provide it.
 144     if prod_info is None:
 145         prod_pyconf_path = src.find_file_in_lpath(product_name + ".pyconf",
 146                                                   config.PATHS.PRODUCTPATH)
 147         if not prod_pyconf_path:
 148             msg = _("No definition found for the product %s\n"
 149                "Please create a %s.pyconf file." % (product_name, product_name))
 150         else:
 151             msg = _("No definition corresponding to the version %(version)s was"
 152                     " found in the file %(prod_file_path)s.\nPlease add a "
 153                     "section in it." % {"version" : vv,
 154                                         "prod_file_path" : prod_pyconf_path} )
 155         raise src.SatException(msg)
 156
 157     # Set the debug, dev and version keys
 158     prod_info.debug = debug
 159     prod_info.dev = dev
 160     prod_info.version = version
 161
 162     # Set the archive_info if the product is get in archive mode
 163     if prod_info.get_source == "archive":
 164         if not "archive_info" in prod_info:
 165             prod_info.addMapping("archive_info",
 166                                  src.pyconf.Mapping(prod_info),
 167                                  "")
 168         if "archive_name" not in prod_info.archive_info:
 169             arch_name = product_name + "-" + version + ".tar.gz"
 170             arch_path = src.find_file_in_lpath(arch_name,
 171                                                config.PATHS.ARCHIVEPATH)
 172             if not arch_path:
 173                 msg = _("Archive %(arch_name)s for %(prod_name)s not found:"
 174                             "\n" % {"arch_name" : arch_name,
 175                                      "prod_name" : prod_info.name})
 176                 raise src.SatException(msg)
 177             prod_info.archive_info.archive_name = arch_path
 178         else:
 179             if (os.path.basename(prod_info.archive_info.archive_name) ==
 180                                         prod_info.archive_info.archive_name):
 181                 arch_name = prod_info.archive_info.archive_name
 182                 arch_path = src.find_file_in_lpath(
 183                                             arch_name,
 184                                             config.PATHS.ARCHIVEPATH)
 185                 if not arch_path:
 186                     msg = _("Archive %(arch_name)s for %(prod_name)s not found:"
 187                                 "\n" % {"arch_name" : arch_name,
 188                                          "prod_name" : prod_info.name})
 189                     raise src.SatException(msg)
 190                 prod_info.archive_info.archive_name = arch_path
 191
 192     # If the product compiles with a script, check the script existence
 193     # and if it is executable
 194     if product_has_script(prod_info):
 195         # Check the compil_script key existence
 196         if "compil_script" not in prod_info:
 197             msg = _("No compilation script found for the product %s\n"
 198                 "Please provide a \"compil_script\" key in its definition."
 199                 % (product_name))
 200             raise src.SatException(msg)
 201
 202         # Get the path of the script
 203         script = prod_info.compil_script
 204         script_name = os.path.basename(script)
 205         if script == script_name:
 206             # Only a name is given. Search in the default directory
 207             script_path = src.find_file_in_lpath(script_name,
 208                                                  config.PATHS.PRODUCTPATH,
 209                                                  "compil_scripts")
 210             if not script_path:
 211                 raise src.SatException(_("Compilation script not found: %s") %
 212                                    script_name)
 213             prod_info.compil_script = script_path
 214
 215         # Check that the script is executable
 216         if not os.access(prod_info.compil_script, os.X_OK):
 217             raise src.SatException(
 218                     _("Compilation script cannot be executed: %s") %
 219                     prod_info.compil_script)
 220
 221     # Get the full paths of all the patches
 222     if product_has_patches(prod_info):
 223         patches = []
 224         for patch in prod_info.patches:
 225             patch_path = patch
 226             # If only a filename, then search for the patch in the PRODUCTPATH
 227             if os.path.basename(patch_path) == patch_path:
 228                 # Search in the PRODUCTPATH/patches
 229                 patch_path = src.find_file_in_lpath(patch,
 230                                                     config.PATHS.PRODUCTPATH,
 231                                                     "patches")
 232                 if not patch_path:
 233                     msg = _("Patch %(patch_name)s for %(prod_name)s not found:"
 234                             "\n" % {"patch_name" : patch,
 235                                      "prod_name" : prod_info.name})
 236                     raise src.SatException(msg)
 237             patches.append(patch_path)
 238         prod_info.patches = patches
 239
 240     # Get the full paths of the environment scripts
 241     if product_has_env_script(prod_info):
 242         env_script_path = prod_info.environ.env_script
 243         # If only a filename, then search for the environment script
 244         # in the PRODUCTPATH/env_scripts
 245         if os.path.basename(env_script_path) == env_script_path:
 246             # Search in the PRODUCTPATH/env_scripts
 247             env_script_path = src.find_file_in_lpath(
 248                                             prod_info.environ.env_script,
 249                                             config.PATHS.PRODUCTPATH,
 250                                             "env_scripts")
 251             if not env_script_path:
 252                 msg = _("Environment script %(env_name)s for %(prod_name)s not "
 253                         "found.\n" % {"env_name" : env_script_path,
 254                                        "prod_name" : prod_info.name})
 255                 raise src.SatException(msg)
 256
 257         prod_info.environ.env_script = env_script_path
 258
 259     if with_install_dir:
 260         # The variable with_install_dir is at false only for internal use
 261         # of the function get_install_dir
 262
 263         # Set the install_dir key
 264         prod_info.install_dir = get_install_dir(config, base, version, prod_info)
 265
 266     return prod_info
 267
 268 def get_product_section(config, product_name, version, section=None):
 269     '''Get the product description from the configuration
 270
 271     :param config Config: The global configuration
 272     :param product_name str: The product name
 273     :param version str: The version of the product
 274     :param section str: The searched section (if not None, the section is
 275                         explicitly given
 276     :return: The product description
 277     :rtype: Config
 278     '''
 279
 280     # if section is not None, try to get the corresponding section
 281     if section:
 282         if section not in config.PRODUCTS[product_name]:
 283             return None
 284         # returns specific information for the given version
 285         prod_info = config.PRODUCTS[product_name][section]
 286         prod_info.section = section
 287         return prod_info
 288
 289     # If it exists, get the information of the product_version
 290     if "version_" + version in config.PRODUCTS[product_name]:
 291         # returns specific information for the given version
 292         prod_info = config.PRODUCTS[product_name]["version_" + version]
 293         prod_info.section = "version_" + version
 294         return prod_info
 295
 296     # Else, check if there is a description for multiple versions
 297     l_section_name = config.PRODUCTS[product_name].keys()
 298     l_section_ranges = [section_name for section_name in l_section_name
 299                         if VERSION_DELIMITER in section_name]
 300     for section_range in l_section_ranges:
 301         minimum, maximum = section_range.split(VERSION_DELIMITER)
 302         if (src.only_numbers(version) >= src.only_numbers(minimum)
 303                     and src.only_numbers(version) <= src.only_numbers(maximum)):
 304             # returns specific information for the versions
 305             prod_info = config.PRODUCTS[product_name][section_range]
 306             prod_info.section = section_range
 307             return prod_info
 308
 309     # Else, get the standard informations
 310     if "default" in config.PRODUCTS[product_name]:
 311         # returns the generic information (given version not found)
 312         prod_info = config.PRODUCTS[product_name].default
 313         prod_info.section = "default"
 314         return prod_info
 315
 316     # if noting was found, return None
 317     return None
 318
 319 def get_install_dir(config, base, version, prod_info):
 320     '''Compute the installation directory of a given product
 321
 322     :param config Config: The global configuration
 323     :param base str: This corresponds to the value given by user in its
 324                      application.pyconf for the specific product. If "yes", the
 325                     user wants the product to be in base. If "no", he wants the
 326                     product to be in the application workdir
 327     :param version str: The version of the product
 328     :param product_info Config: The configuration specific to
 329                                the product
 330
 331     :return: The path of the product installation
 332     :rtype: str
 333     '''
 334     install_dir = ""
 335     in_base = False
 336     if (("install_dir" in prod_info and prod_info.install_dir == "base")
 337                                                             or base == "yes"):
 338         in_base = True
 339     if (base == "no" or ("no_base" in config.APPLICATION
 340                          and config.APPLICATION.no_base == "yes")):
 341         in_base = False
 342
 343     if in_base:
 344         install_dir = get_base_install_dir(config, prod_info, version)
 345     else:
 346         if "install_dir" not in prod_info or prod_info.install_dir == "base":
 347             # Set it to the default value (in application directory)
 348             install_dir = os.path.join(config.APPLICATION.workdir,
 349                                                 "INSTALL",
 350                                                 prod_info.name)
 351         else:
 352             install_dir = prod_info.install_dir
 353
 354     return install_dir
 355
 356 def get_base_install_dir(config, prod_info, version):
 357     '''Compute the installation directory of a product in base
 358
 359     :param config Config: The global configuration
 360     :param product_info Config: The configuration specific to
 361                                the product
 362     :param version str: The version of the product
 363     :return: The path of the product installation
 364     :rtype: str
 365     '''
 366     base_path = src.get_base_path(config)
 367     prod_dir = os.path.join(base_path, prod_info.name + "-" + version)
 368     if not os.path.exists(prod_dir):
 369         return os.path.join(prod_dir, "config-1")
 370
 371     exists, install_dir = check_config_exists(config, prod_dir, prod_info)
 372     if exists:
 373         return install_dir
 374
 375     # Find the first config-<i> directory that is available in the product
 376     # directory
 377     found = False
 378     label = 1
 379     while not found:
 380         install_dir = os.path.join(prod_dir, "config-%i" % label)
 381         if os.path.exists(install_dir):
 382             label+=1
 383         else:
 384             found = True
 385
 386     return install_dir
 387
 388 def check_config_exists(config, prod_dir, prod_info):
 389     '''Verify that the installation directory of a product in a base exists
 390        Check all the config-<i> directory and verify the sat-config.pyconf file
 391        that is in it
 392
 393     :param config Config: The global configuration
 394     :param prod_dir str: The product installation directory path
 395                          (without config-<i>)
 396     :param product_info Config: The configuration specific to
 397                                the product
 398     :return: True or false is the installation is found or not
 399              and if it is found, the path of the found installation
 400     :rtype: (boolean, str)
 401     '''
 402     # check if the directories or files of the directory corresponds to the
 403     # directory installation of the product
 404     l_dir_and_files = os.listdir(prod_dir)
 405     for dir_or_file in l_dir_and_files:
 406         oExpr = re.compile(config_expression)
 407         if not(oExpr.search(dir_or_file)):
 408             # not config-<i>, not interesting
 409             continue
 410         # check if there is the file sat-config.pyconf file in the installation
 411         # directory
 412         config_file = os.path.join(prod_dir, dir_or_file, src.CONFIG_FILENAME)
 413         if not os.path.exists(config_file):
 414             continue
 415
 416         # If there is no dependency, it is the right path
 417         if len(prod_info.depend)==0:
 418             return True, os.path.join(prod_dir, dir_or_file)
 419
 420         # check if there is the config described in the file corresponds the
 421         # dependencies of the product
 422         config_corresponds = True
 423         compile_cfg = src.pyconf.Config(config_file)
 424         for prod_dep in prod_info.depend:
 425             # if the dependency is not in the config,
 426             # the config does not correspond
 427             if prod_dep not in compile_cfg:
 428                 config_corresponds = False
 429                 break
 430             else:
 431                 prod_dep_info = get_product_config(config, prod_dep, False)
 432                 # If the version of the dependency does not correspond,
 433                 # the config does not correspond
 434                 if prod_dep_info.version != compile_cfg[prod_dep]:
 435                     config_corresponds = False
 436                     break
 437         if config_corresponds:
 438             return True, os.path.join(prod_dir, dir_or_file)
 439
 440     return False, None
 441
 442
 443
 444 def get_products_infos(lproducts, config):
 445     '''Get the specific configuration of a list of products
 446
 447     :param lproducts List: The list of product names
 448     :param config Config: The global configuration
 449     :return: the list of tuples
 450              (product name, specific configuration of the product)
 451     :rtype: [(str, Config)]
 452     '''
 453     products_infos = []
 454     # Loop on product names
 455     for prod in lproducts:
 456         # Get the specific configuration of the product
 457         prod_info = get_product_config(config, prod)
 458         if prod_info is not None:
 459             products_infos.append((prod, prod_info))
 460         else:
 461             msg = _("The %s product has no definition "
 462                     "in the configuration.") % prod
 463             raise src.SatException(msg)
 464     return products_infos
 465
 466 def get_product_dependencies(config, product_info):
 467     '''Get recursively the list of products that are
 468        in the product_info dependencies
 469
 470     :param config Config: The global configuration
 471     :param product_info Config: The configuration specific to
 472                                the product
 473     :return: the list of products in dependence
 474     :rtype: list
 475     '''
 476     if "depend" not in product_info or product_info.depend == []:
 477         return []
 478     res = []
 479     for prod in product_info.depend:
 480         if prod == product_info.name:
 481             continue
 482         if prod not in res:
 483             res.append(prod)
 484         prod_info = get_product_config(config, prod)
 485         dep_prod = get_product_dependencies(config, prod_info)
 486         for prod_in_dep in dep_prod:
 487             if prod_in_dep not in res:
 488                 res.append(prod_in_dep)
 489     return res
 490
 491 def check_installation(product_info):
 492     '''Verify if a product is well installed. Checks install directory presence
 493        and some additional files if it is defined in the config
 494
 495     :param product_info Config: The configuration specific to
 496                                the product
 497     :return: True if it is well installed
 498     :rtype: boolean
 499     '''
 500     if not product_compiles(product_info):
 501         return True
 502     install_dir = product_info.install_dir
 503     if not os.path.exists(install_dir):
 504         return False
 505     if ("present_files" in product_info and
 506         "install" in product_info.present_files):
 507         for file_relative_path in product_info.present_files.install:
 508             file_path = os.path.join(install_dir, file_relative_path)
 509             if not os.path.exists(file_path):
 510                 return False
 511     return True
 512
 513 def product_is_sample(product_info):
 514     '''Know if a product has the sample type
 515
 516     :param product_info Config: The configuration specific to
 517                                the product
 518     :return: True if the product has the sample type, else False
 519     :rtype: boolean
 520     '''
 521     if 'type' in product_info:
 522         ptype = product_info.type
 523         return ptype.lower() == 'sample'
 524     else:
 525         return False
 526
 527 def product_is_salome(product_info):
 528     '''Know if a product is of type salome
 529
 530     :param product_info Config: The configuration specific to
 531                                the product
 532     :return: True if the product is salome, else False
 533     :rtype: boolean
 534     '''
 535     if 'type' in product_info:
 536         ptype = product_info.type
 537         return ptype.lower() == 'salome'
 538     else:
 539         return False
 540
 541 def product_is_fixed(product_info):
 542     '''Know if a product is fixed
 543
 544     :param product_info Config: The configuration specific to
 545                                the product
 546     :return: True if the product is fixed, else False
 547     :rtype: boolean
 548     '''
 549     get_src = product_info.get_source
 550     return get_src.lower() == 'fixed'
 551
 552 def product_is_native(product_info):
 553     '''Know if a product is native
 554
 555     :param product_info Config: The configuration specific to
 556                                the product
 557     :return: True if the product is native, else False
 558     :rtype: boolean
 559     '''
 560     get_src = product_info.get_source
 561     return get_src.lower() == 'native'
 562
 563 def product_is_dev(product_info):
 564     '''Know if a product is in dev mode
 565
 566     :param product_info Config: The configuration specific to
 567                                the product
 568     :return: True if the product is in dev mode, else False
 569     :rtype: boolean
 570     '''
 571     dev = product_info.dev
 572     return dev.lower() == 'yes'
 573
 574 def product_is_debug(product_info):
 575     '''Know if a product is in debug mode
 576
 577     :param product_info Config: The configuration specific to
 578                                the product
 579     :return: True if the product is in debug mode, else False
 580     :rtype: boolean
 581     '''
 582     debug = product_info.debug
 583     return debug.lower() == 'yes'
 584
 585 def product_is_autotools(product_info):
 586     '''Know if a product is compiled using the autotools
 587
 588     :param product_info Config: The configuration specific to
 589                                the product
 590     :return: True if the product is autotools, else False
 591     :rtype: boolean
 592     '''
 593     build_src = product_info.build_source
 594     return build_src.lower() == 'autotools'
 595
 596 def product_is_cmake(product_info):
 597     '''Know if a product is compiled using the cmake
 598
 599     :param product_info Config: The configuration specific to
 600                                the product
 601     :return: True if the product is cmake, else False
 602     :rtype: boolean
 603     '''
 604     build_src = product_info.build_source
 605     return build_src.lower() == 'cmake'
 606
 607 def product_is_vcs(product_info):
 608     '''Know if a product is download using git, svn or cvs (not archive)
 609
 610     :param product_info Config: The configuration specific to
 611                                the product
 612     :return: True if the product is vcs, else False
 613     :rtype: boolean
 614     '''
 615     return product_info.get_source in AVAILABLE_VCS
 616
 617 def product_is_SALOME(product_info):
 618     '''Know if a product is a SALOME module
 619
 620     :param product_info Config: The configuration specific to
 621                                the product
 622     :return: True if the product is a SALOME module, else False
 623     :rtype: boolean
 624     '''
 625     return ("properties" in product_info and
 626             "is_SALOME_module" in product_info.properties and
 627             product_info.properties.is_SALOME_module == "yes")
 628
 629 def product_is_smesh_plugin(product_info):
 630     '''Know if a product is a SMESH plugin
 631
 632     :param product_info Config: The configuration specific to
 633                                the product
 634     :return: True if the product is a SMESH plugin, else False
 635     :rtype: boolean
 636     '''
 637     return ("properties" in product_info and
 638             "smesh_plugin" in product_info.properties and
 639             product_info.properties.smesh_plugin == "yes")
 640
 641 def product_is_cpp(product_info):
 642     '''Know if a product is cpp
 643
 644     :param product_info Config: The configuration specific to
 645                                the product
 646     :return: True if the product is a cpp, else False
 647     :rtype: boolean
 648     '''
 649     return ("properties" in product_info and
 650             "cpp" in product_info.properties and
 651             product_info.properties.cpp == "yes")
 652
 653 def product_compiles(product_info):
 654     '''Know if a product compiles or not (some products do not have a
 655        compilation procedure)
 656
 657     :param product_info Config: The configuration specific to
 658                                the product
 659     :return: True if the product compiles, else False
 660     :rtype: boolean
 661     '''
 662     return not("properties" in product_info and
 663             "compilation" in product_info.properties and
 664             product_info.properties.compilation == "no")
 665
 666 def product_has_script(product_info):
 667     '''Know if a product has a compilation script
 668
 669     :param product_info Config: The configuration specific to
 670                                the product
 671     :return: True if the product it has a compilation script, else False
 672     :rtype: boolean
 673     '''
 674     if "build_source" not in product_info:
 675         # Native case
 676         return False
 677     build_src = product_info.build_source
 678     return build_src.lower() == 'script'
 679
 680 def product_has_env_script(product_info):
 681     '''Know if a product has an environment script
 682
 683     :param product_info Config: The configuration specific to
 684                                the product
 685     :return: True if the product it has an environment script, else False
 686     :rtype: boolean
 687     '''
 688     return "environ" in product_info and "env_script" in product_info.environ
 689
 690 def product_has_patches(product_info):
 691     '''Know if a product has one or more patches
 692
 693     :param product_info Config: The configuration specific to
 694                                the product
 695     :return: True if the product has one or more patches
 696     :rtype: boolean
 697     '''
 698     return "patches" in product_info and len(product_info.patches) > 0
 699
 700 def product_has_logo(product_info):
 701     '''Know if a product has a logo (YACSGEN generate)
 702
 703     :param product_info Config: The configuration specific to
 704                                the product
 705     :return: The path of the logo if the product has a logo, else False
 706     :rtype: Str
 707     '''
 708     if ("properties" in product_info and
 709             "logo" in product_info.properties):
 710         return product_info.properties.logo
 711     else:
 712         return False
 713
 714 def product_has_salome_gui(product_info):
 715     '''Know if a product has a SALOME gui
 716
 717     :param product_info Config: The configuration specific to
 718                                the product
 719     :return: True if the product has a SALOME gui, else False
 720     :rtype: Boolean
 721     '''
 722     return ("properties" in product_info and
 723             "has_salome_gui" in product_info.properties and
 724             product_info.properties.has_salome_gui == "yes")
 725
 726 def product_is_mpi(product_info):
 727     '''Know if a product has openmpi in its dependencies
 728
 729     :param product_info Config: The configuration specific to
 730                                the product
 731     :return: True if the product has openmpi inits dependencies
 732     :rtype: boolean
 733     '''
 734     return "openmpi" in product_info.depend
 735
 736 def product_is_generated(product_info):
 737     '''Know if a product is generated (YACSGEN)
 738
 739     :param product_info Config: The configuration specific to
 740                                the product
 741     :return: True if the product is generated
 742     :rtype: boolean
 743     '''
 744     return ("properties" in product_info and
 745             "generate" in product_info.properties and
 746             product_info.properties.generate == "yes")
 747
 748 def get_product_components(product_info):
 749     '''Get the component list to generate with the product
 750
 751     :param product_info Config: The configuration specific to
 752                                the product
 753     :return: The list of names of the components
 754     :rtype: List
 755
 756     '''
 757     if not product_is_generated(product_info):
 758         return []
 759
 760     compo_list = []
 761     if "component_name" in product_info:
 762         compo_list = product_info.component_name
 763
 764         if isinstance(compo_list, str):
 765             compo_list = [ compo_list ]
 766
 767     return compo_list