commands/package.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 import os
  20 import stat
  21 import shutil
  22 import datetime
  23 import tarfile
  24 import codecs
  25 import string
  26 import glob
  27 import pprint as PP
  28 import sys
  29 import src
  30
  31 from application import get_SALOME_modules
  32 from  src.versionMinorMajorPatch import MinorMajorPatch as MMP
  33 import src.debug as DBG
  34
  35 old_python = sys.version_info[0] == 2 and sys.version_info[1] <= 6
  36
  37 BINARY = "binary"
  38 SOURCE = "Source"
  39 PROJECT = "Project"
  40 SAT = "Sat"
  41
  42 ARCHIVE_DIR = "ARCHIVES"
  43 PROJECT_DIR = "PROJECT"
  44
  45 IGNORED_DIRS = [".git", ".svn"]
  46 IGNORED_EXTENSIONS = []
  47
  48 PACKAGE_EXT=".tar.gz" # the extension we use for the packages
  49
  50 if src.architecture.is_windows():
  51     PROJECT_TEMPLATE = """#!/usr/bin/env python
  52 #-*- coding:utf-8 -*-
  53
  54 # The path to the archive root directory
  55 root_path : $PWD + "/../"
  56 # path to the PROJECT
  57 project_path : $PWD + "/"
  58
  59 # Where to search the archives of the products
  60 ARCHIVEPATH : $root_path + "ARCHIVES"
  61 # Where to search the pyconf of the applications
  62 APPLICATIONPATH : $project_path + "applications/"
  63 # Where to search the pyconf of the products
  64 PRODUCTPATH : $project_path + "products/"
  65 # Where to search the pyconf of the jobs of the project
  66 JOBPATH : $project_path + "jobs/"
  67 # Where to search the pyconf of the machines of the project
  68 MACHINEPATH : $project_path + "machines/"
  69 """
  70 else:
  71     PROJECT_TEMPLATE = """#!/usr/bin/env python
  72 #-*- coding:utf-8 -*-
  73
  74 # path to the PROJECT
  75 project_path : $PWD + "/"
  76
  77 # Where to search the archives of the products
  78 ARCHIVEPATH : $project_path + "ARCHIVES"
  79 # Where to search the pyconf of the applications
  80 APPLICATIONPATH : $project_path + "applications/"
  81 # Where to search the pyconf of the products
  82 PRODUCTPATH : $project_path + "products/"
  83 # Where to search the pyconf of the jobs of the project
  84 JOBPATH : $project_path + "jobs/"
  85 # Where to search the pyconf of the machines of the project
  86 MACHINEPATH : $project_path + "machines/"
  87 """
  88
  89
  90 LOCAL_TEMPLATE = ("""#!/usr/bin/env python
  91 #-*- coding:utf-8 -*-
  92
  93   LOCAL :
  94   {
  95     base : 'default'
  96     workdir : 'default'
  97     log_dir : 'default'
  98     archive_dir : 'default'
  99     VCS : 'unknown'
 100     tag : 'unknown'
 101   }
 102
 103 PROJECTS :
 104 {
 105   project_file_paths :
 106   [
 107 $LOCAL.workdir + $VARS.sep + \"""" + PROJECT_DIR + """\" + $VARS.sep + "project.pyconf"
 108   ]
 109 }
 110 """)
 111
 112 # Define all possible option for the package command :  sat package <options>
 113 parser = src.options.Options()
 114 parser.add_option('b', 'binaries', 'boolean', 'binaries',
 115     _('Optional: Produce a binary package.'), False)
 116 parser.add_option('f', 'force_creation', 'boolean', 'force_creation',
 117     _('Optional: Only binary package: produce the archive even if '
 118       'there are some missing products.'), False)
 119 parser.add_option('s', 'sources', 'boolean', 'sources',
 120     _('Optional: Produce a compilable archive of the sources of the '
 121       'application.'), False)
 122 parser.add_option('', 'bin_products', 'boolean', 'bin_products',
 123     _('Optional: Create binary archives for all products.'), False)
 124 parser.add_option('', 'with_vcs', 'boolean', 'with_vcs',
 125     _('Optional: Do not make archive for products in VCS mode (git, cvs, svn). '
 126       'Sat prepare will use VCS mode instead to retrieve them.'
 127       '\n          Also, when combined with "--bin_products" option, restrict the building of product archives to VCS products.'),
 128     False)
 129 parser.add_option('', 'ftp', 'boolean', 'ftp',
 130     _('Optional: Do not embed archives for products in archive mode.'
 131     'Sat prepare will use ftp instead to retrieve them'),
 132     False)
 133 parser.add_option('e', 'exe', 'string', 'exe',
 134     _('Optional: Produce an extra launcher based upon the exe given as argument.'), "")
 135 parser.add_option('p', 'project', 'string', 'project',
 136     _('Optional: Produce an archive that contains a project.'), "")
 137 parser.add_option('t', 'salometools', 'boolean', 'sat',
 138     _('Optional: Produce an archive that contains salomeTools.'), False)
 139 parser.add_option('n', 'name', 'string', 'name',
 140     _('Optional: The name or full path of the archive.'), None)
 141 parser.add_option('', 'add_files', 'list2', 'add_files',
 142     _('Optional: The list of additional files to add to the archive.'), [])
 143 parser.add_option('', 'without_properties', 'properties', 'without_properties',
 144     _('Optional: Filter the products by their properties.\n\tSyntax: '
 145       '--without_properties <property>:<value>'))
 146
 147
 148 def add_files(tar, name_archive, d_content, logger, f_exclude=None):
 149     '''Create an archive containing all directories and files that are given in
 150        the d_content argument.
 151
 152     :param tar tarfile: The tarfile instance used to make the archive.
 153     :param name_archive str: The name of the archive to make.
 154     :param d_content dict: The dictionary that contain all directories and files
 155                            to add in the archive.
 156                            d_content[label] =
 157                                         (path_on_local_machine, path_in_archive)
 158     :param logger Logger: the logging instance
 159     :param f_exclude Function: the function that filters
 160     :return: 0 if success, 1 if not.
 161     :rtype: int
 162     '''
 163     # get the max length of the messages in order to make the display
 164     max_len = len(max(d_content.keys(), key=len))
 165
 166     success = 0
 167     # loop over each directory or file stored in the d_content dictionary
 168     names = sorted(d_content.keys())
 169     DBG.write("add tar names", names)
 170
 171     # used to avoid duplications (for pip install in python, or single_install_dir cases)
 172     already_added=set()
 173     for name in names:
 174         # display information
 175         len_points = max_len - len(name) + 3
 176         local_path, archive_path = d_content[name]
 177         in_archive = os.path.join(name_archive, archive_path)
 178         logger.write(name + " " + len_points * "." + " "+ in_archive + " ", 3)
 179         # Get the local path and the path in archive
 180         # of the directory or file to add
 181         # Add it in the archive
 182         try:
 183             key=local_path+"->"+in_archive
 184             if key not in already_added:
 185                 if old_python:
 186                     tar.add(local_path,
 187                                  arcname=in_archive,
 188                                  exclude=exclude_VCS_and_extensions_26)
 189                 else:
 190                     tar.add(local_path,
 191                                  arcname=in_archive,
 192                                  filter=exclude_VCS_and_extensions)
 193                 already_added.add(key)
 194             logger.write(src.printcolors.printcSuccess(_("OK")), 3)
 195         except Exception as e:
 196             logger.write(src.printcolors.printcError(_("KO ")), 3)
 197             logger.write(str(e), 3)
 198             success = 1
 199         logger.write("\n", 3)
 200     return success
 201
 202
 203 def exclude_VCS_and_extensions_26(filename):
 204     ''' The function that is used to exclude from package the link to the
 205         VCS repositories (like .git) (only for python 2.6)
 206
 207     :param filename Str: The filname to exclude (or not).
 208     :return: True if the file has to be exclude
 209     :rtype: Boolean
 210     '''
 211     for dir_name in IGNORED_DIRS:
 212         if dir_name in filename:
 213             return True
 214     for extension in IGNORED_EXTENSIONS:
 215         if filename.endswith(extension):
 216             return True
 217     return False
 218
 219 def exclude_VCS_and_extensions(tarinfo):
 220     ''' The function that is used to exclude from package the link to the
 221         VCS repositories (like .git)
 222
 223     :param filename Str: The filname to exclude (or not).
 224     :return: None if the file has to be exclude
 225     :rtype: tarinfo or None
 226     '''
 227     filename = tarinfo.name
 228     for dir_name in IGNORED_DIRS:
 229         if dir_name in filename:
 230             return None
 231     for extension in IGNORED_EXTENSIONS:
 232         if filename.endswith(extension):
 233             return None
 234     return tarinfo
 235
 236 def produce_relative_launcher(config,
 237                               logger,
 238                               file_dir,
 239                               file_name,
 240                               binaries_dir_name):
 241     '''Create a specific SALOME launcher for the binary package. This launcher
 242        uses relative paths.
 243
 244     :param config Config: The global configuration.
 245     :param logger Logger: the logging instance
 246     :param file_dir str: the directory where to put the launcher
 247     :param file_name str: The launcher name
 248     :param binaries_dir_name str: the name of the repository where the binaries
 249                                   are, in the archive.
 250     :return: the path of the produced launcher
 251     :rtype: str
 252     '''
 253
 254     # set base mode to "no" for the archive - save current mode to restore it at the end
 255     if "base" in config.APPLICATION:
 256         base_setting=config.APPLICATION.base
 257     else:
 258         base_setting="maybe"
 259     config.APPLICATION.base="no"
 260
 261     # get KERNEL installation path
 262     kernel_info = src.product.get_product_config(config, "KERNEL")
 263     kernel_base_name=os.path.basename(kernel_info.install_dir)
 264     if kernel_info.install_mode == "base":
 265         # case of kernel installed in base. the kernel install dir name is different in the archive
 266         kernel_base_name=os.path.basename(os.path.dirname(kernel_info.install_dir))
 267
 268     kernel_root_dir = os.path.join(binaries_dir_name, kernel_base_name)
 269
 270     # set kernel bin dir (considering fhs property)
 271     kernel_cfg = src.product.get_product_config(config, "KERNEL")
 272     if src.get_property_in_product_cfg(kernel_cfg, "fhs"):
 273         bin_kernel_install_dir = os.path.join(kernel_root_dir,"bin")
 274     else:
 275         bin_kernel_install_dir = os.path.join(kernel_root_dir,"bin","salome")
 276
 277     # check if the application contains an application module
 278     # check also if the application has a distene product,
 279     # in this case get its licence file name
 280     l_product_info = src.product.get_products_infos(config.APPLICATION.products.keys(), config)
 281     salome_application_name="Not defined"
 282     distene_licence_file_name=False
 283     for prod_name, prod_info in l_product_info:
 284         # look for a "salome application" and a distene product
 285         if src.get_property_in_product_cfg(prod_info, "is_distene") == "yes":
 286             distene_licence_file_name = src.product.product_has_licence(prod_info,
 287                                             config.PATHS.LICENCEPATH)
 288         if src.get_property_in_product_cfg(prod_info, "is_salome_application") == "yes":
 289             salome_application_name=prod_info.name
 290
 291     # if the application contains an application module, we set ABSOLUTE_APPLI_PATH to it
 292     # if not we set it to KERNEL_INSTALL_DIR, which is sufficient, except for salome test
 293     if salome_application_name == "Not defined":
 294         app_root_dir=kernel_root_dir
 295     else:
 296         app_root_dir=os.path.join(binaries_dir_name, salome_application_name)
 297
 298     additional_env={}
 299     additional_env['sat_bin_kernel_install_dir'] = "out_dir_Path + " +\
 300                                                    config.VARS.sep + bin_kernel_install_dir
 301     if "python3" in config.APPLICATION and config.APPLICATION.python3 == "yes":
 302         additional_env['sat_python_version'] = 3
 303     else:
 304         additional_env['sat_python_version'] = 2
 305
 306     additional_env['ABSOLUTE_APPLI_PATH'] = "out_dir_Path" + config.VARS.sep + app_root_dir
 307     launcher_name = src.get_launcher_name(config)
 308     additional_env['APPLI'] = "out_dir_Path" + config.VARS.sep + file_name
 309
 310     # create an environment file writer
 311     writer = src.environment.FileEnvWriter(config,
 312                                            logger,
 313                                            file_dir,
 314                                            src_root=None,
 315                                            env_info=None)
 316
 317     filepath = os.path.join(file_dir, file_name)
 318     # Write
 319     writer.write_env_file(filepath,
 320                           False,  # for launch
 321                           "cfgForPy",
 322                           additional_env=additional_env,
 323                           no_path_init=False,
 324                           for_package = binaries_dir_name)
 325
 326     # Little hack to put out_dir_Path outside the strings
 327     src.replace_in_file(filepath, 'r"out_dir_Path', 'out_dir_Path + r"' )
 328     src.replace_in_file(filepath, "r'out_dir_Path + ", "out_dir_Path + r'" )
 329
 330     # A hack to put a call to a file for distene licence.
 331     # It does nothing to an application that has no distene product
 332     if distene_licence_file_name:
 333         logger.write("Application has a distene licence file! We use it in package launcher", 5)
 334         hack_for_distene_licence(filepath, distene_licence_file_name)
 335
 336     # change the rights in order to make the file executable for everybody
 337     os.chmod(filepath,
 338              stat.S_IRUSR |
 339              stat.S_IRGRP |
 340              stat.S_IROTH |
 341              stat.S_IWUSR |
 342              stat.S_IXUSR |
 343              stat.S_IXGRP |
 344              stat.S_IXOTH)
 345
 346     # restore modified setting by its initial value
 347     config.APPLICATION.base=base_setting
 348
 349     return filepath
 350
 351 def hack_for_distene_licence(filepath, licence_file):
 352     '''Replace the distene licence env variable by a call to a file.
 353
 354     :param filepath Str: The path to the launcher to modify.
 355     '''
 356     shutil.move(filepath, filepath + "_old")
 357     fileout= filepath
 358     filein = filepath + "_old"
 359     fin = open(filein, "r")
 360     fout = open(fileout, "w")
 361     text = fin.readlines()
 362     # Find the Distene section
 363     num_line = -1
 364     for i,line in enumerate(text):
 365         if "# Set DISTENE License" in line:
 366             num_line = i
 367             break
 368     if num_line == -1:
 369         # No distene product, there is nothing to do
 370         fin.close()
 371         for line in text:
 372             fout.write(line)
 373         fout.close()
 374         return
 375     del text[num_line +1]
 376     del text[num_line +1]
 377     text_to_insert ="""    try:
 378         distene_licence_file=r"%s"
 379         if sys.version_info[0] >= 3 and sys.version_info[1] >= 5:
 380             import importlib.util
 381             spec_dist = importlib.util.spec_from_file_location("distene_licence", distene_licence_file)
 382             distene=importlib.util.module_from_spec(spec_dist)
 383             spec_dist.loader.exec_module(distene)
 384         else:
 385             import imp
 386             distene = imp.load_source('distene_licence', distene_licence_file)
 387         distene.set_distene_variables(context)
 388     except Exception:
 389         pass\n"""  % licence_file
 390     text.insert(num_line + 1, text_to_insert)
 391     for line in text:
 392         fout.write(line)
 393     fin.close()
 394     fout.close()
 395     return
 396
 397 def produce_relative_env_files(config,
 398                               logger,
 399                               file_dir,
 400                               binaries_dir_name,
 401                               exe_name=None):
 402     '''Create some specific environment files for the binary package. These
 403        files use relative paths.
 404
 405     :param config Config: The global configuration.
 406     :param logger Logger: the logging instance
 407     :param file_dir str: the directory where to put the files
 408     :param binaries_dir_name str: the name of the repository where the binaries
 409                                   are, in the archive.
 410     :param exe_name str: if given generate a launcher executing exe_name
 411     :return: the list of path of the produced environment files
 412     :rtype: List
 413     '''
 414
 415     # set base mode to "no" for the archive - save current mode to restore it at the end
 416     if "base" in config.APPLICATION:
 417         base_setting=config.APPLICATION.base
 418     else:
 419         base_setting="maybe"
 420     config.APPLICATION.base="no"
 421
 422     # create an environment file writer
 423     writer = src.environment.FileEnvWriter(config,
 424                                            logger,
 425                                            file_dir,
 426                                            src_root=None)
 427
 428     if src.architecture.is_windows():
 429       shell = "bat"
 430       filename  = "env_launch.bat"
 431     else:
 432       shell = "bash"
 433       filename  = "env_launch.sh"
 434
 435     if exe_name:
 436         filename=os.path.basename(exe_name)
 437
 438     # Write
 439     filepath = writer.write_env_file(filename,
 440                           False, # for launch
 441                           shell,
 442                           for_package = binaries_dir_name)
 443
 444     # Little hack to put out_dir_Path as environment variable
 445     if src.architecture.is_windows() :
 446       src.replace_in_file(filepath, '"out_dir_Path', '"%out_dir_Path%' )
 447       src.replace_in_file(filepath, '=out_dir_Path', '=%out_dir_Path%' )
 448       src.replace_in_file(filepath, ';out_dir_Path', ';%out_dir_Path%' )
 449     else:
 450       src.replace_in_file(filepath, '"out_dir_Path', '"${out_dir_Path}' )
 451       src.replace_in_file(filepath, ':out_dir_Path', ':${out_dir_Path}' )
 452       src.replace_in_file(filepath, ';out_dir_Path', ';${out_dir_Path}' )
 453
 454     if exe_name:
 455         if src.architecture.is_windows():
 456             cmd="\n\nrem Launch exe with user arguments\n%s " % exe_name + "%*"
 457         else:
 458             cmd='\n\n# Launch exe with user arguments\n%s "$*"' % exe_name
 459         with open(filepath, "a") as exe_launcher:
 460             exe_launcher.write(cmd)
 461
 462     # change the rights in order to make the file executable for everybody
 463     os.chmod(filepath,
 464              stat.S_IRUSR |
 465              stat.S_IRGRP |
 466              stat.S_IROTH |
 467              stat.S_IWUSR |
 468              stat.S_IXUSR |
 469              stat.S_IXGRP |
 470              stat.S_IXOTH)
 471
 472     # restore modified setting by its initial value
 473     config.APPLICATION.base=base_setting
 474
 475     return filepath
 476
 477 def produce_install_bin_file(config,
 478                              logger,
 479                              file_dir,
 480                              d_sub,
 481                              file_name):
 482     '''Create a bash shell script which do substitutions in BIRARIES dir
 483        in order to use it for extra compilations.
 484
 485     :param config Config: The global configuration.
 486     :param logger Logger: the logging instance
 487     :param file_dir str: the directory where to put the files
 488     :param d_sub, dict: the dictionnary that contains the substitutions to be done
 489     :param file_name str: the name of the install script file
 490     :return: the produced file
 491     :rtype: str
 492     '''
 493     # Write
 494     filepath = os.path.join(file_dir, file_name)
 495     # open the file and write into it
 496     # use codec utf-8 as sat variables are in unicode
 497     with codecs.open(filepath, "w", 'utf-8') as installbin_file:
 498         installbin_template_path = os.path.join(config.VARS.internal_dir,
 499                                         "INSTALL_BIN.template")
 500
 501         # build the name of the directory that will contain the binaries
 502         binaries_dir_name = config.INTERNAL.config.binary_dir + config.VARS.dist
 503         # build the substitution loop
 504         loop_cmd = "for f in $(grep -RIl"
 505         for key in d_sub:
 506             loop_cmd += " -e "+ key
 507         loop_cmd += ' ' + config.INTERNAL.config.install_dir +\
 508                     '); do\n     sed -i "\n'
 509         for key in d_sub:
 510             loop_cmd += "        s?" + key + "?$(pwd)/" + d_sub[key] + "?g\n"
 511         loop_cmd += '            " $f\ndone'
 512
 513         d={}
 514         d["BINARIES_DIR"] = binaries_dir_name
 515         d["SUBSTITUTION_LOOP"]=loop_cmd
 516         d["INSTALL_DIR"]=config.INTERNAL.config.install_dir
 517
 518         # substitute the template and write it in file
 519         content=src.template.substitute(installbin_template_path, d)
 520         installbin_file.write(content)
 521         # change the rights in order to make the file executable for everybody
 522         os.chmod(filepath,
 523                  stat.S_IRUSR |
 524                  stat.S_IRGRP |
 525                  stat.S_IROTH |
 526                  stat.S_IWUSR |
 527                  stat.S_IXUSR |
 528                  stat.S_IXGRP |
 529                  stat.S_IXOTH)
 530
 531     return filepath
 532
 533 def product_appli_creation_script(config,
 534                                   logger,
 535                                   file_dir,
 536                                   binaries_dir_name):
 537     '''Create a script that can produce an application (EDF style) in the binary
 538        package.
 539
 540     :param config Config: The global configuration.
 541     :param logger Logger: the logging instance
 542     :param file_dir str: the directory where to put the file
 543     :param binaries_dir_name str: the name of the repository where the binaries
 544                                   are, in the archive.
 545     :return: the path of the produced script file
 546     :rtype: Str
 547     '''
 548     template_name = "create_appli.py.for_bin_packages.template"
 549     template_path = os.path.join(config.VARS.internal_dir, template_name)
 550     text_to_fill = open(template_path, "r").read()
 551     text_to_fill = text_to_fill.replace("TO BE FILLED 1",
 552                                         '"' + binaries_dir_name + '"')
 553
 554     text_to_add = ""
 555     for product_name in get_SALOME_modules(config):
 556         product_info = src.product.get_product_config(config, product_name)
 557
 558         if src.product.product_is_smesh_plugin(product_info):
 559             continue
 560
 561         if 'install_dir' in product_info and bool(product_info.install_dir):
 562             if src.product.product_is_cpp(product_info):
 563                 # cpp module
 564                 for cpp_name in src.product.get_product_components(product_info):
 565                     line_to_add = ("<module name=\"" +
 566                                    cpp_name +
 567                                    "\" gui=\"yes\" path=\"''' + "
 568                                    "os.path.join(dir_bin_name, \"" +
 569                                    cpp_name + "\") + '''\"/>")
 570             else:
 571                 # regular module
 572                 line_to_add = ("<module name=\"" +
 573                                product_name +
 574                                "\" gui=\"yes\" path=\"''' + "
 575                                "os.path.join(dir_bin_name, \"" +
 576                                product_name + "\") + '''\"/>")
 577             text_to_add += line_to_add + "\n"
 578
 579     filled_text = text_to_fill.replace("TO BE FILLED 2", text_to_add)
 580
 581     tmp_file_path = os.path.join(file_dir, "create_appli.py")
 582     ff = open(tmp_file_path, "w")
 583     ff.write(filled_text)
 584     ff.close()
 585
 586     # change the rights in order to make the file executable for everybody
 587     os.chmod(tmp_file_path,
 588              stat.S_IRUSR |
 589              stat.S_IRGRP |
 590              stat.S_IROTH |
 591              stat.S_IWUSR |
 592              stat.S_IXUSR |
 593              stat.S_IXGRP |
 594              stat.S_IXOTH)
 595
 596     return tmp_file_path
 597
 598 def bin_products_archives(config, logger, only_vcs):
 599     '''Prepare binary packages for all products
 600     :param config Config: The global configuration.
 601     :return: the error status
 602     :rtype: bool
 603     '''
 604
 605     logger.write("Make %s binary archives\n" % config.VARS.dist)
 606     # Get the default directory where to put the packages
 607     binpackage_path = os.path.join(config.APPLICATION.workdir, "PACKAGE", "products")
 608     src.ensure_path_exists(binpackage_path)
 609     # Get the list of product installation to add to the archive
 610     l_products_name = sorted(config.APPLICATION.products.keys())
 611     l_product_info = src.product.get_products_infos(l_products_name,
 612                                                     config)
 613     # first loop on products : filter products, analyse properties,
 614     # and store the information that will be used to create the archive in the second loop
 615     l_not_installed=[] # store not installed products for warning at the end
 616     for prod_name, prod_info in l_product_info:
 617         # ignore the native and fixed products for install directories
 618         if (src.get_property_in_product_cfg(prod_info, "not_in_package") == "yes"
 619                 or src.product.product_is_native(prod_info)
 620                 or src.product.product_is_fixed(prod_info)
 621                 or not src.product.product_compiles(prod_info)):
 622             continue
 623         if only_vcs and not src.product.product_is_vcs(prod_info):
 624             continue
 625         if not src.product.check_installation(config, prod_info):
 626             l_not_installed.append(prod_name)
 627             continue  # product is not installed, we skip it
 628         # prepare call to make_bin_archive
 629         path_targz_prod = os.path.join(binpackage_path, prod_name + '-' + prod_info.version.replace("/", "_") + "-" + config.VARS.dist + PACKAGE_EXT)
 630         targz_prod = tarfile.open(path_targz_prod, mode='w:gz')
 631         bin_path = prod_info.install_dir
 632         targz_prod.add(bin_path)
 633         targz_prod.close()
 634         # Python program to find MD5 hash value of a file
 635         import hashlib
 636         with open(path_targz_prod,"rb") as f:
 637             bytes = f.read() # read file as bytes
 638             readable_hash = hashlib.md5(bytes).hexdigest();
 639             with open(path_targz_prod+".md5", "w") as md5sum:
 640                md5sum.write("%s  %s" % (readable_hash, os.path.basename(path_targz_prod)))
 641             logger.write("   archive : %s   (md5sum = %s)\n" % (path_targz_prod, readable_hash))
 642
 643     return 0
 644
 645 def binary_package(config, logger, options, tmp_working_dir):
 646     '''Prepare a dictionary that stores all the needed directories and files to
 647        add in a binary package.
 648
 649     :param config Config: The global configuration.
 650     :param logger Logger: the logging instance
 651     :param options OptResult: the options of the launched command
 652     :param tmp_working_dir str: The temporary local directory containing some
 653                                 specific directories or files needed in the
 654                                 binary package
 655     :return: the dictionary that stores all the needed directories and files to
 656              add in a binary package.
 657              {label : (path_on_local_machine, path_in_archive)}
 658     :rtype: dict
 659     '''
 660
 661     # Get the list of product installation to add to the archive
 662     l_products_name = sorted(config.APPLICATION.products.keys())
 663     l_product_info = src.product.get_products_infos(l_products_name,
 664                                                     config)
 665
 666     # suppress compile time products for binaries-only archives
 667     if not options.sources:
 668         update_config(config, logger, "compile_time", "yes")
 669
 670     l_install_dir = []
 671     l_source_dir = []
 672     l_not_installed = []
 673     l_sources_not_present = []
 674     generate_mesa_launcher = False  # a flag to know if we generate a mesa launcher
 675     if ("APPLICATION" in config  and
 676         "properties"  in config.APPLICATION  and
 677         "mesa_launcher_in_package"    in config.APPLICATION.properties  and
 678         config.APPLICATION.properties.mesa_launcher_in_package == "yes") :
 679             generate_mesa_launcher=True
 680
 681     # first loop on products : filter products, analyse properties,
 682     # and store the information that will be used to create the archive in the second loop
 683     for prod_name, prod_info in l_product_info:
 684         # skip product with property not_in_package set to yes
 685         if src.get_property_in_product_cfg(prod_info, "not_in_package") == "yes":
 686             continue
 687
 688         # Add the sources of the products that have the property
 689         # sources_in_package : "yes"
 690         if src.get_property_in_product_cfg(prod_info,
 691                                            "sources_in_package") == "yes":
 692             if os.path.exists(prod_info.source_dir):
 693                 l_source_dir.append((prod_name, prod_info.source_dir))
 694             else:
 695                 l_sources_not_present.append(prod_name)
 696
 697         # ignore the native and fixed products for install directories
 698         if (src.product.product_is_native(prod_info)
 699                 or src.product.product_is_fixed(prod_info)
 700                 or not src.product.product_compiles(prod_info)):
 701             continue
 702         #
 703         # products with single_dir property will be installed in the PRODUCTS directory of the archive
 704         is_single_dir=(src.appli_test_property(config,"single_install_dir", "yes") and \
 705                        src.product.product_test_property(prod_info,"single_install_dir", "yes"))
 706         if src.product.check_installation(config, prod_info):
 707             l_install_dir.append((prod_name, prod_info.name, prod_info.install_dir,
 708                                   is_single_dir, prod_info.install_mode))
 709         else:
 710             l_not_installed.append(prod_name)
 711
 712         # Add also the cpp generated modules (if any)
 713         if src.product.product_is_cpp(prod_info):
 714             # cpp module
 715             for name_cpp in src.product.get_product_components(prod_info):
 716                 install_dir = os.path.join(config.APPLICATION.workdir,
 717                                            config.INTERNAL.config.install_dir,
 718                                            name_cpp)
 719                 if os.path.exists(install_dir):
 720                     l_install_dir.append((name_cpp, name_cpp, install_dir, False, "value"))
 721                 else:
 722                     l_not_installed.append(name_cpp)
 723
 724     # check the name of the directory that (could) contains the binaries
 725     # from previous detar
 726     binaries_from_detar = os.path.join(
 727                               config.APPLICATION.workdir,
 728                               config.INTERNAL.config.binary_dir + config.VARS.dist)
 729     if os.path.exists(binaries_from_detar):
 730          logger.write("""
 731 WARNING: existing binaries directory from previous detar installation:
 732          %s
 733          To make new package from this, you have to:
 734          1) install binaries in INSTALL directory with the script "install_bin.sh"
 735             see README file for more details
 736          2) or recompile everything in INSTALL with "sat compile" command
 737             this step is long, and requires some linux packages to be installed
 738             on your system\n
 739 """ % binaries_from_detar)
 740
 741     # Print warning or error if there are some missing products
 742     if len(l_not_installed) > 0:
 743         text_missing_prods = ""
 744         for p_name in l_not_installed:
 745             text_missing_prods += " - " + p_name + "\n"
 746         if not options.force_creation:
 747             msg = _("ERROR: there are missing product installations:")
 748             logger.write("%s\n%s" % (src.printcolors.printcError(msg),
 749                                      text_missing_prods),
 750                          1)
 751             raise src.SatException(msg)
 752         else:
 753             msg = _("WARNING: there are missing products installations:")
 754             logger.write("%s\n%s" % (src.printcolors.printcWarning(msg),
 755                                      text_missing_prods),
 756                          1)
 757
 758     # Do the same for sources
 759     if len(l_sources_not_present) > 0:
 760         text_missing_prods = ""
 761         for p_name in l_sources_not_present:
 762             text_missing_prods += "-" + p_name + "\n"
 763         if not options.force_creation:
 764             msg = _("ERROR: there are missing product sources:")
 765             logger.write("%s\n%s" % (src.printcolors.printcError(msg),
 766                                      text_missing_prods),
 767                          1)
 768             raise src.SatException(msg)
 769         else:
 770             msg = _("WARNING: there are missing products sources:")
 771             logger.write("%s\n%s" % (src.printcolors.printcWarning(msg),
 772                                      text_missing_prods),
 773                          1)
 774
 775     # construct the name of the directory that will contain the binaries
 776     if src.architecture.is_windows():
 777         binaries_dir_name = config.INTERNAL.config.binary_dir
 778     else:
 779         binaries_dir_name = config.INTERNAL.config.binary_dir + config.VARS.dist
 780     # construct the correlation table between the product names, there
 781     # actual install directories and there install directory in archive
 782     d_products = {}
 783     for prod_name, prod_info_name, install_dir, is_single_dir, install_mode in l_install_dir:
 784         prod_base_name=os.path.basename(install_dir)
 785         if install_mode == "base":
 786             # case of a products installed in base.
 787             # because the archive is in base:no mode, the name of the install dir is different inside archive
 788             # we set it to the product name or by PRODUCTS if single-dir
 789             if is_single_dir:
 790                 prod_base_name=config.INTERNAL.config.single_install_dir
 791             else:
 792                 prod_base_name=prod_info_name
 793         path_in_archive = os.path.join(binaries_dir_name, prod_base_name)
 794         d_products[prod_name + " (bin)"] = (install_dir, path_in_archive)
 795
 796     for prod_name, source_dir in l_source_dir:
 797         path_in_archive = os.path.join("SOURCES", prod_name)
 798         d_products[prod_name + " (sources)"] = (source_dir, path_in_archive)
 799
 800     # create an archives of compilation logs, and insert it into the tarball
 801     logpath=os.path.join(config.APPLICATION.workdir, "LOGS")
 802     path_targz_logs = os.path.join(tmp_working_dir, "logs.tgz")
 803     tar_log = tarfile.open(path_targz_logs, mode='w:gz')
 804     tar_log.add(logpath, arcname="LOGS")
 805     tar_log.close()
 806     d_products["LOGS"] = (path_targz_logs, "logs.tgz")
 807
 808     # for packages of SALOME applications including KERNEL,
 809     # we produce a salome launcher or a virtual application (depending on salome version)
 810     if 'KERNEL' in config.APPLICATION.products:
 811         VersionSalome = src.get_salome_version(config)
 812         # Case where SALOME has the launcher that uses the SalomeContext API
 813         if VersionSalome >= MMP([7,3,0]):
 814             # create the relative launcher and add it to the files to add
 815             launcher_name = src.get_launcher_name(config)
 816             launcher_package = produce_relative_launcher(config,
 817                                                  logger,
 818                                                  tmp_working_dir,
 819                                                  launcher_name,
 820                                                  binaries_dir_name)
 821             d_products["launcher"] = (launcher_package, launcher_name)
 822
 823             # if the application contains mesa products, we generate in addition to the
 824             # classical salome launcher a launcher using mesa and called mesa_salome
 825             # (the mesa launcher will be used for remote usage through ssh).
 826             if generate_mesa_launcher:
 827                 #if there is one : store the use_mesa property
 828                 restore_use_mesa_option=None
 829                 if ('properties' in config.APPLICATION and
 830                     'use_mesa' in config.APPLICATION.properties):
 831                     restore_use_mesa_option = config.APPLICATION.properties.use_mesa
 832
 833                 # activate mesa property, and generate a mesa launcher
 834                 src.activate_mesa_property(config)  #activate use_mesa property
 835                 launcher_mesa_name="mesa_"+launcher_name
 836                 launcher_package_mesa = produce_relative_launcher(config,
 837                                                      logger,
 838                                                      tmp_working_dir,
 839                                                      launcher_mesa_name,
 840                                                      binaries_dir_name)
 841                 d_products["launcher (mesa)"] = (launcher_package_mesa, launcher_mesa_name)
 842
 843                 # if there was a use_mesa value, we restore it
 844                 # else we set it to the default value "no"
 845                 if restore_use_mesa_option != None:
 846                     config.APPLICATION.properties.use_mesa=restore_use_mesa_option
 847                 else:
 848                     config.APPLICATION.properties.use_mesa="no"
 849
 850             if options.sources:
 851                 # if we mix binaries and sources, we add a copy of the launcher,
 852                 # prefixed  with "bin",in order to avoid clashes
 853                 launcher_copy_name="bin"+launcher_name
 854                 launcher_package_copy = produce_relative_launcher(config,
 855                                                      logger,
 856                                                      tmp_working_dir,
 857                                                      launcher_copy_name,
 858                                                      binaries_dir_name)
 859                 d_products["launcher (copy)"] = (launcher_package_copy, launcher_copy_name)
 860         else:
 861             # Provide a script for the creation of an application EDF style
 862             appli_script = product_appli_creation_script(config,
 863                                                         logger,
 864                                                         tmp_working_dir,
 865                                                         binaries_dir_name)
 866
 867             d_products["appli script"] = (appli_script, "create_appli.py")
 868
 869     # Put also the environment file
 870     env_file = produce_relative_env_files(config,
 871                                            logger,
 872                                            tmp_working_dir,
 873                                            binaries_dir_name)
 874
 875     if src.architecture.is_windows():
 876       filename  = "env_launch.bat"
 877     else:
 878       filename  = "env_launch.sh"
 879     d_products["environment file"] = (env_file, filename)
 880
 881     # If option exe, produce an extra launcher based on specified exe
 882     if options.exe:
 883         exe_file = produce_relative_env_files(config,
 884                                               logger,
 885                                               tmp_working_dir,
 886                                               binaries_dir_name,
 887                                               options.exe)
 888
 889         if src.architecture.is_windows():
 890           filename  = os.path.basename(options.exe) + ".bat"
 891         else:
 892           filename  = os.path.basename(options.exe) + ".sh"
 893         d_products["exe file"] = (exe_file, filename)
 894
 895
 896     return d_products
 897
 898 def source_package(sat, config, logger, options, tmp_working_dir):
 899     '''Prepare a dictionary that stores all the needed directories and files to
 900        add in a source package.
 901
 902     :param config Config: The global configuration.
 903     :param logger Logger: the logging instance
 904     :param options OptResult: the options of the launched command
 905     :param tmp_working_dir str: The temporary local directory containing some
 906                                 specific directories or files needed in the
 907                                 binary package
 908     :return: the dictionary that stores all the needed directories and files to
 909              add in a source package.
 910              {label : (path_on_local_machine, path_in_archive)}
 911     :rtype: dict
 912     '''
 913
 914     d_archives={}
 915     # Get all the products that are prepared using an archive
 916     # unless ftp mode is specified (in this case the user of the
 917     # archive will get the sources through the ftp mode of sat prepare
 918     if not options.ftp:
 919         logger.write("Find archive products ... ")
 920         d_archives, l_pinfo_vcs = get_archives(config, logger)
 921         logger.write("Done\n")
 922
 923     d_archives_vcs = {}
 924     if not options.with_vcs and len(l_pinfo_vcs) > 0:
 925         # Make archives with the products that are not prepared using an archive
 926         # (git, cvs, svn, etc)
 927         logger.write("Construct archives for vcs products ... ")
 928         d_archives_vcs = get_archives_vcs(l_pinfo_vcs,
 929                                           sat,
 930                                           config,
 931                                           logger,
 932                                           tmp_working_dir)
 933         logger.write("Done\n")
 934
 935     # Create a project
 936     logger.write("Create the project ... ")
 937     d_project = create_project_for_src_package(config,
 938                                                tmp_working_dir,
 939                                                options.with_vcs,
 940                                                options.ftp)
 941     logger.write("Done\n")
 942
 943     # Add salomeTools
 944     tmp_sat = add_salomeTools(config, tmp_working_dir)
 945     d_sat = {"salomeTools" : (tmp_sat, "sat")}
 946
 947     # Add a sat symbolic link if not win
 948     if not src.architecture.is_windows():
 949         try:
 950             t = os.getcwd()
 951         except Exception:
 952             # In the jobs, os.getcwd() can fail
 953             t = config.LOCAL.workdir
 954         os.chdir(tmp_working_dir)
 955
 956         # create a symlink, to avoid reference with "salomeTool/.."
 957         os.chdir("PROJECT")
 958         if os.path.lexists("ARCHIVES"):
 959             os.remove("ARCHIVES")
 960         os.symlink("../ARCHIVES", "ARCHIVES")
 961         os.chdir(t)
 962
 963         d_sat["sat archive link"] = (os.path.join(tmp_working_dir,"PROJECT", "ARCHIVES"),
 964                                      os.path.join("PROJECT", "ARCHIVES"))
 965
 966     d_source = src.merge_dicts(d_archives, d_archives_vcs, d_project, d_sat)
 967     return d_source
 968
 969 def get_archives(config, logger):
 970     '''Find all the products that are get using an archive and all the products
 971        that are get using a vcs (git, cvs, svn) repository.
 972
 973     :param config Config: The global configuration.
 974     :param logger Logger: the logging instance
 975     :return: the dictionary {name_product :
 976              (local path of its archive, path in the package of its archive )}
 977              and the list of specific configuration corresponding to the vcs
 978              products
 979     :rtype: (Dict, List)
 980     '''
 981     # Get the list of product informations
 982     l_products_name = config.APPLICATION.products.keys()
 983     l_product_info = src.product.get_products_infos(l_products_name,
 984                                                     config)
 985     d_archives = {}
 986     l_pinfo_vcs = []
 987     for p_name, p_info in l_product_info:
 988         # skip product with property not_in_package set to yes
 989         if src.get_property_in_product_cfg(p_info, "not_in_package") == "yes":
 990             continue
 991         # ignore the native and fixed products
 992         if (src.product.product_is_native(p_info)
 993                 or src.product.product_is_fixed(p_info)):
 994             continue
 995         if p_info.get_source == "archive":
 996             archive_path = p_info.archive_info.archive_name
 997             archive_name = os.path.basename(archive_path)
 998             d_archives[p_name] = (archive_path,
 999                                   os.path.join(ARCHIVE_DIR, archive_name))
1000             if (src.appli_test_property(config,"pip", "yes") and
1001                 src.product.product_test_property(p_info,"pip", "yes")):
1002                 # if pip mode is activated, and product is managed by pip
1003                 pip_wheels_dir=os.path.join(config.LOCAL.archive_dir,"wheels")
1004                 if "archive_prefix" in p_info.archive_info and p_info.archive_info.archive_prefix:
1005                     pip_wheel_pattern=os.path.join(pip_wheels_dir,
1006                                                    "%s-%s*" % (p_info.archive_info.archive_prefix, p_info.version))
1007                 else:
1008                     pip_wheel_pattern=os.path.join(pip_wheels_dir,
1009                                                    "%s-%s*" % (p_info.name, p_info.version))
1010                 pip_wheel_path=glob.glob(pip_wheel_pattern)
1011                 msg_pip_not_found="Error in get_archive, pip wheel for "\
1012                                   "product %s-%s was not found in %s directory"
1013                 msg_pip_two_or_more="Error in get_archive, several pip wheels for "\
1014                                   "product %s-%s were found in %s directory"
1015                 if len(pip_wheel_path)==0:
1016                     raise src.SatException(msg_pip_not_found %\
1017                         (p_info.name, p_info.version, pip_wheels_dir))
1018                 if len(pip_wheel_path)>1:
1019                     raise src.SatException(msg_pip_two_or_more %\
1020                         (p_info.name, p_info.version, pip_wheels_dir))
1021
1022                 pip_wheel_name=os.path.basename(pip_wheel_path[0])
1023                 d_archives[p_name+" (pip wheel)"]=(pip_wheel_path[0],
1024                     os.path.join(ARCHIVE_DIR, "wheels", pip_wheel_name))
1025         else:
1026             # this product is not managed by archive,
1027             # an archive of the vcs directory will be created by get_archive_vcs
1028             l_pinfo_vcs.append((p_name, p_info))
1029
1030     return d_archives, l_pinfo_vcs
1031
1032 def add_salomeTools(config, tmp_working_dir):
1033     '''Prepare a version of salomeTools that has a specific local.pyconf file
1034        configured for a source package.
1035
1036     :param config Config: The global configuration.
1037     :param tmp_working_dir str: The temporary local directory containing some
1038                                 specific directories or files needed in the
1039                                 source package
1040     :return: The path to the local salomeTools directory to add in the package
1041     :rtype: str
1042     '''
1043     # Copy sat in the temporary working directory
1044     sat_tmp_path = src.Path(os.path.join(tmp_working_dir, "salomeTools"))
1045     sat_running_path = src.Path(config.VARS.salometoolsway)
1046     sat_running_path.copy(sat_tmp_path)
1047
1048     # Update the local.pyconf file that contains the path to the project
1049     local_pyconf_name = "local.pyconf"
1050     local_pyconf_dir = os.path.join(tmp_working_dir, "salomeTools", "data")
1051     local_pyconf_file = os.path.join(local_pyconf_dir, local_pyconf_name)
1052     # Remove the .pyconf file in the root directory of salomeTools if there is
1053     # any. (For example when launching jobs, a pyconf file describing the jobs
1054     # can be here and is not useful)
1055     files_or_dir_SAT = os.listdir(os.path.join(tmp_working_dir, "salomeTools"))
1056     for file_or_dir in files_or_dir_SAT:
1057         if file_or_dir.endswith(".pyconf") or file_or_dir.endswith(".txt"):
1058             file_path = os.path.join(tmp_working_dir,
1059                                      "salomeTools",
1060                                      file_or_dir)
1061             os.remove(file_path)
1062
1063     ff = open(local_pyconf_file, "w")
1064     ff.write(LOCAL_TEMPLATE)
1065     ff.close()
1066
1067     return sat_tmp_path.path
1068
1069 def get_archives_vcs(l_pinfo_vcs, sat, config, logger, tmp_working_dir):
1070     '''For sources package that require that all products are get using an
1071        archive, one has to create some archive for the vcs products.
1072        So this method calls the clean and source command of sat and then create
1073        the archives.
1074
1075     :param l_pinfo_vcs List: The list of specific configuration corresponding to
1076                              each vcs product
1077     :param sat Sat: The Sat instance that can be called to clean and source the
1078                     products
1079     :param config Config: The global configuration.
1080     :param logger Logger: the logging instance
1081     :param tmp_working_dir str: The temporary local directory containing some
1082                                 specific directories or files needed in the
1083                                 source package
1084     :return: the dictionary that stores all the archives to add in the source
1085              package. {label : (path_on_local_machine, path_in_archive)}
1086     :rtype: dict
1087     '''
1088     # clean the source directory of all the vcs products, then use the source
1089     # command and thus construct an archive that will not contain the patches
1090     l_prod_names = [pn for pn, __ in l_pinfo_vcs]
1091     if False: # clean is dangerous in user/SOURCES, fixed in tmp_local_working_dir
1092       logger.write(_("\nclean sources\n"))
1093       args_clean = config.VARS.application
1094       args_clean += " --sources --products "
1095       args_clean += ",".join(l_prod_names)
1096       logger.write("WARNING: get_archives_vcs clean\n         '%s'\n" % args_clean, 1)
1097       sat.clean(args_clean, batch=True, verbose=0, logger_add_link = logger)
1098     if True:
1099       # source
1100       logger.write(_("get sources\n"))
1101       args_source = config.VARS.application
1102       args_source += " --products "
1103       args_source += ",".join(l_prod_names)
1104       svgDir = sat.cfg.APPLICATION.workdir
1105       tmp_local_working_dir = os.path.join(sat.cfg.APPLICATION.workdir, "tmp_package")  # to avoid too much big files in /tmp
1106       sat.cfg.APPLICATION.workdir = tmp_local_working_dir
1107       # DBG.write("SSS sat config.APPLICATION.workdir", sat.cfg.APPLICATION, True)
1108       # DBG.write("sat config id", id(sat.cfg), True)
1109       # shit as config is not same id() as for sat.source()
1110       # sat.source(args_source, batch=True, verbose=5, logger_add_link = logger)
1111       import source
1112       source.run(args_source, sat, logger) #use this mode as runner.cfg reference
1113
1114       # make the new archives
1115       d_archives_vcs = {}
1116       for pn, pinfo in l_pinfo_vcs:
1117           path_archive = make_archive(pn, pinfo, tmp_local_working_dir)
1118           logger.write("make archive vcs '%s'\n" % path_archive)
1119           d_archives_vcs[pn] = (path_archive,
1120                                 os.path.join(ARCHIVE_DIR, pn + ".tgz"))
1121       sat.cfg.APPLICATION.workdir = svgDir
1122       # DBG.write("END sat config", sat.cfg.APPLICATION, True)
1123     return d_archives_vcs
1124
1125 def make_bin_archive(prod_name, prod_info, where):
1126     '''Create an archive of a product by searching its source directory.
1127
1128     :param prod_name str: The name of the product.
1129     :param prod_info Config: The specific configuration corresponding to the
1130                              product
1131     :param where str: The path of the repository where to put the resulting
1132                       archive
1133     :return: The path of the resulting archive
1134     :rtype: str
1135     '''
1136     path_targz_prod = os.path.join(where, prod_name + PACKAGE_EXT)
1137     tar_prod = tarfile.open(path_targz_prod, mode='w:gz')
1138     bin_path = prod_info.install_dir
1139     tar_prod.add(bin_path, arcname=path_targz_prod)
1140     tar_prod.close()
1141     return path_targz_prod
1142
1143 def make_archive(prod_name, prod_info, where):
1144     '''Create an archive of a product by searching its source directory.
1145
1146     :param prod_name str: The name of the product.
1147     :param prod_info Config: The specific configuration corresponding to the
1148                              product
1149     :param where str: The path of the repository where to put the resulting
1150                       archive
1151     :return: The path of the resulting archive
1152     :rtype: str
1153     '''
1154     path_targz_prod = os.path.join(where, prod_name + PACKAGE_EXT)
1155     tar_prod = tarfile.open(path_targz_prod, mode='w:gz')
1156     local_path = prod_info.source_dir
1157     if old_python:
1158         tar_prod.add(local_path,
1159                      arcname=prod_name,
1160                      exclude=exclude_VCS_and_extensions_26)
1161     else:
1162         tar_prod.add(local_path,
1163                      arcname=prod_name,
1164                      filter=exclude_VCS_and_extensions)
1165     tar_prod.close()
1166     return path_targz_prod
1167
1168 def create_project_for_src_package(config, tmp_working_dir, with_vcs, with_ftp):
1169     '''Create a specific project for a source package.
1170
1171     :param config Config: The global configuration.
1172     :param tmp_working_dir str: The temporary local directory containing some
1173                                 specific directories or files needed in the
1174                                 source package
1175     :param with_vcs boolean: True if the package is with vcs products (not
1176                              transformed into archive products)
1177     :param with_ftp boolean: True if the package use ftp servers to get archives
1178     :return: The dictionary
1179              {"project" : (produced project, project path in the archive)}
1180     :rtype: Dict
1181     '''
1182
1183     # Create in the working temporary directory the full project tree
1184     project_tmp_dir = os.path.join(tmp_working_dir, PROJECT_DIR)
1185     products_pyconf_tmp_dir = os.path.join(project_tmp_dir,
1186                                          "products")
1187     compil_scripts_tmp_dir = os.path.join(project_tmp_dir,
1188                                          "products",
1189                                          "compil_scripts")
1190     post_scripts_tmp_dir = os.path.join(project_tmp_dir,
1191                                          "products",
1192                                          "post_scripts")
1193     env_scripts_tmp_dir = os.path.join(project_tmp_dir,
1194                                          "products",
1195                                          "env_scripts")
1196     patches_tmp_dir = os.path.join(project_tmp_dir,
1197                                          "products",
1198                                          "patches")
1199     application_tmp_dir = os.path.join(project_tmp_dir,
1200                                          "applications")
1201     for directory in [project_tmp_dir,
1202                       compil_scripts_tmp_dir,
1203                       env_scripts_tmp_dir,
1204                       post_scripts_tmp_dir,
1205                       patches_tmp_dir,
1206                       application_tmp_dir]:
1207         src.ensure_path_exists(directory)
1208
1209     # Create the pyconf that contains the information of the project
1210     project_pyconf_name = "project.pyconf"
1211     project_pyconf_file = os.path.join(project_tmp_dir, project_pyconf_name)
1212     ff = open(project_pyconf_file, "w")
1213     ff.write(PROJECT_TEMPLATE)
1214     if with_ftp and len(config.PATHS.ARCHIVEFTP) > 0:
1215         ftp_path='ARCHIVEFTP : "'+config.PATHS.ARCHIVEFTP[0]
1216         for ftpserver in config.PATHS.ARCHIVEFTP[1:]:
1217             ftp_path=ftp_path+":"+ftpserver
1218         ftp_path+='"'
1219         ff.write("# ftp servers where to search for prerequisite archives\n")
1220         ff.write(ftp_path)
1221     # add licence paths if any
1222     if len(config.PATHS.LICENCEPATH) > 0:
1223         licence_path='LICENCEPATH : "'+config.PATHS.LICENCEPATH[0]
1224         for path in config.PATHS.LICENCEPATH[1:]:
1225             licence_path=licence_path+":"+path
1226         licence_path+='"'
1227         ff.write("\n# Where to search for licences\n")
1228         ff.write(licence_path)
1229
1230
1231     ff.close()
1232
1233     # Loop over the products to get there pyconf and all the scripts
1234     # (compilation, environment, patches)
1235     # and create the pyconf file to add to the project
1236     lproducts_name = config.APPLICATION.products.keys()
1237     l_products = src.product.get_products_infos(lproducts_name, config)
1238     for p_name, p_info in l_products:
1239         # skip product with property not_in_package set to yes
1240         if src.get_property_in_product_cfg(p_info, "not_in_package") == "yes":
1241             continue
1242         find_product_scripts_and_pyconf(p_name,
1243                                         p_info,
1244                                         config,
1245                                         with_vcs,
1246                                         compil_scripts_tmp_dir,
1247                                         env_scripts_tmp_dir,
1248                                         post_scripts_tmp_dir,
1249                                         patches_tmp_dir,
1250                                         products_pyconf_tmp_dir)
1251
1252     # for the application pyconf, we write directly the config
1253     # don't search for the original pyconf file
1254     # to avoid problems with overwrite sections and rm_products key
1255     write_application_pyconf(config, application_tmp_dir)
1256
1257     d_project = {"project" : (project_tmp_dir, PROJECT_DIR )}
1258     return d_project
1259
1260 def find_product_scripts_and_pyconf(p_name,
1261                                     p_info,
1262                                     config,
1263                                     with_vcs,
1264                                     compil_scripts_tmp_dir,
1265                                     env_scripts_tmp_dir,
1266                                     post_scripts_tmp_dir,
1267                                     patches_tmp_dir,
1268                                     products_pyconf_tmp_dir):
1269     '''Create a specific pyconf file for a given product. Get its environment
1270        script, its compilation script and patches and put it in the temporary
1271        working directory. This method is used in the source package in order to
1272        construct the specific project.
1273
1274     :param p_name str: The name of the product.
1275     :param p_info Config: The specific configuration corresponding to the
1276                              product
1277     :param config Config: The global configuration.
1278     :param with_vcs boolean: True if the package is with vcs products (not
1279                              transformed into archive products)
1280     :param compil_scripts_tmp_dir str: The path to the temporary compilation
1281                                        scripts directory of the project.
1282     :param env_scripts_tmp_dir str: The path to the temporary environment script
1283                                     directory of the project.
1284     :param post_scripts_tmp_dir str: The path to the temporary post-processing script
1285                                     directory of the project.
1286     :param patches_tmp_dir str: The path to the temporary patch scripts
1287                                 directory of the project.
1288     :param products_pyconf_tmp_dir str: The path to the temporary product
1289                                         scripts directory of the project.
1290     '''
1291
1292     # read the pyconf of the product
1293     product_pyconf_cfg = src.pyconf.Config(p_info.from_file)
1294
1295     # find the compilation script if any
1296     if src.product.product_has_script(p_info):
1297         compil_script_path = src.Path(p_info.compil_script)
1298         compil_script_path.copy(compil_scripts_tmp_dir)
1299
1300     # find the environment script if any
1301     if src.product.product_has_env_script(p_info):
1302         env_script_path = src.Path(p_info.environ.env_script)
1303         env_script_path.copy(env_scripts_tmp_dir)
1304
1305     # find the post script if any
1306     if src.product.product_has_post_script(p_info):
1307         post_script_path = src.Path(p_info.post_script)
1308         post_script_path.copy(post_scripts_tmp_dir)
1309
1310     # find the patches if any
1311     if src.product.product_has_patches(p_info):
1312         patches = src.pyconf.Sequence()
1313         for patch_path in p_info.patches:
1314             p_path = src.Path(patch_path)
1315             p_path.copy(patches_tmp_dir)
1316             patches.append(os.path.basename(patch_path), "")
1317
1318     if (not with_vcs) and src.product.product_is_vcs(p_info):
1319         # in non vcs mode, if the product is not archive, then make it become archive.
1320
1321         # depending upon the incremental mode, select impacted sections
1322         if "properties" in p_info and "incremental" in p_info.properties and\
1323             p_info.properties.incremental == "yes":
1324             sections = ["default", "default_win", p_info.section, p_info.section+"_win"]
1325         else:
1326             sections = [p_info.section]
1327         for section in sections:
1328             if section in product_pyconf_cfg and "get_source" in product_pyconf_cfg[section]:
1329                 DBG.write("sat package set archive mode to archive for product %s and section %s" %\
1330                           (p_name,section))
1331                 product_pyconf_cfg[section].get_source = "archive"
1332                 if not "archive_info" in product_pyconf_cfg[section]:
1333                     product_pyconf_cfg[section].addMapping("archive_info",
1334                                         src.pyconf.Mapping(product_pyconf_cfg),
1335                                         "")
1336                     product_pyconf_cfg[section].archive_info.archive_name =\
1337                         p_info.name + ".tgz"
1338
1339     # save git repositories for vcs products, even if archive is not in VCS mode
1340     # in this case the user will be able to change get_source flag and work with git
1341     if src.product.product_is_vcs(p_info):
1342         # in vcs mode we must replace explicitely the git server url
1343         # (or it will not be found later because project files are not exported in archives)
1344         for section in product_pyconf_cfg:
1345             # replace in all sections of the product pyconf the git repo definition by its substitued value (found in p_info)
1346             if "git_info" in product_pyconf_cfg[section]:
1347                 for repo in product_pyconf_cfg[section].git_info:
1348                     if repo in p_info.git_info:
1349                         product_pyconf_cfg[section].git_info[repo] =  p_info.git_info[repo]
1350
1351     # write the pyconf file to the temporary project location
1352     product_tmp_pyconf_path = os.path.join(products_pyconf_tmp_dir,
1353                                            p_name + ".pyconf")
1354     ff = open(product_tmp_pyconf_path, 'w')
1355     ff.write("#!/usr/bin/env python\n#-*- coding:utf-8 -*-\n\n")
1356     product_pyconf_cfg.__save__(ff, 1)
1357     ff.close()
1358
1359
1360 def write_application_pyconf(config, application_tmp_dir):
1361     '''Write the application pyconf file in the specific temporary
1362        directory containing the specific project of a source package.
1363
1364     :param config Config: The global configuration.
1365     :param application_tmp_dir str: The path to the temporary application
1366                                     scripts directory of the project.
1367     '''
1368     application_name = config.VARS.application
1369     # write the pyconf file to the temporary application location
1370     application_tmp_pyconf_path = os.path.join(application_tmp_dir,
1371                                                application_name + ".pyconf")
1372     with open(application_tmp_pyconf_path, 'w') as f:
1373         f.write("#!/usr/bin/env python\n#-*- coding:utf-8 -*-\n\n")
1374         res = src.pyconf.Config()
1375         app = src.pyconf.deepCopyMapping(config.APPLICATION)
1376
1377         # set base mode to "no" for the archive
1378         app.base = "no"
1379
1380         # Change the workdir
1381         app.workdir = src.pyconf.Reference(
1382                                  app,
1383                                  src.pyconf.DOLLAR,
1384                                  'LOCAL.workdir')
1385         res.addMapping("APPLICATION", app, "")
1386         res.__save__(f, evaluated=False)
1387
1388
1389 def sat_package(config, tmp_working_dir, options, logger):
1390     '''Prepare a dictionary that stores all the needed directories and files to
1391        add in a salomeTool package.
1392
1393     :param tmp_working_dir str: The temporary local working directory
1394     :param options OptResult: the options of the launched command
1395     :return: the dictionary that stores all the needed directories and files to
1396              add in a salomeTool package.
1397              {label : (path_on_local_machine, path_in_archive)}
1398     :rtype: dict
1399     '''
1400     d_project = {}
1401
1402     # we include sat himself
1403     d_project["all_sat"]=(config.VARS.salometoolsway, "")
1404
1405     # and we overwrite local.pyconf with a clean wersion.
1406     local_pyconf_tmp_path = os.path.join(tmp_working_dir, "local.pyconf")
1407     local_file_path = os.path.join(config.VARS.datadir, "local.pyconf")
1408     local_cfg = src.pyconf.Config(local_file_path)
1409     local_cfg.PROJECTS.project_file_paths=src.pyconf.Sequence(local_cfg.PROJECTS)
1410     local_cfg.LOCAL["base"] = "default"
1411     local_cfg.LOCAL["workdir"] = "default"
1412     local_cfg.LOCAL["log_dir"] = "default"
1413     local_cfg.LOCAL["archive_dir"] = "default"
1414     local_cfg.LOCAL["VCS"] = "None"
1415     local_cfg.LOCAL["tag"] = src.get_salometool_version(config)
1416
1417     # if the archive contains a project, we write its relative path in local.pyconf
1418     if options.project:
1419         project_arch_path = os.path.join("projects", options.project,
1420                                          os.path.basename(options.project_file_path))
1421         local_cfg.PROJECTS.project_file_paths.append(project_arch_path, "")
1422
1423     ff = open(local_pyconf_tmp_path, 'w')
1424     local_cfg.__save__(ff, 1)
1425     ff.close()
1426     d_project["local.pyconf"]=(local_pyconf_tmp_path, "data/local.pyconf")
1427     return d_project
1428
1429
1430 def project_package(config, name_project, project_file_path, ftp_mode, tmp_working_dir, embedded_in_sat, logger):
1431     '''Prepare a dictionary that stores all the needed directories and files to
1432        add in a project package.
1433
1434     :param project_file_path str: The path to the local project.
1435     :param ftp_mode boolean: Do not embed archives, the archive will rely on ftp mode to retrieve them.
1436     :param tmp_working_dir str: The temporary local directory containing some
1437                                 specific directories or files needed in the
1438                                 project package
1439     :param embedded_in_sat boolean : the project package is embedded in a sat package
1440     :return: the dictionary that stores all the needed directories and files to
1441              add in a project package.
1442              {label : (path_on_local_machine, path_in_archive)}
1443     :rtype: dict
1444     '''
1445     d_project = {}
1446     # Read the project file and get the directories to add to the package
1447
1448     try:
1449       project_pyconf_cfg = config.PROJECTS.projects.__getattr__(name_project)
1450     except Exception:
1451       logger.write("""
1452 WARNING: inexisting config.PROJECTS.projects.%s, try to read now from:\n%s\n""" % (name_project, project_file_path))
1453       project_pyconf_cfg = src.pyconf.Config(project_file_path)
1454       project_pyconf_cfg.PWD = os.path.dirname(project_file_path)
1455
1456     paths = {"APPLICATIONPATH" : "applications",
1457              "PRODUCTPATH" : "products",
1458              "JOBPATH" : "jobs",
1459              "MACHINEPATH" : "machines"}
1460     if not ftp_mode:
1461         paths["ARCHIVEPATH"] = "archives"
1462
1463     # Loop over the project paths and add it
1464     project_file_name = os.path.basename(project_file_path)
1465     for path in paths:
1466         if path not in project_pyconf_cfg:
1467             continue
1468         if embedded_in_sat:
1469             dest_path = os.path.join("projects", name_project, paths[path])
1470             project_file_dest = os.path.join("projects", name_project, project_file_name)
1471         else:
1472             dest_path = paths[path]
1473             project_file_dest = project_file_name
1474
1475         # Add the directory to the files to add in the package
1476         d_project[path] = (project_pyconf_cfg[path], dest_path)
1477
1478         # Modify the value of the path in the package
1479         project_pyconf_cfg[path] = src.pyconf.Reference(
1480                                     project_pyconf_cfg,
1481                                     src.pyconf.DOLLAR,
1482                                     'project_path + "/' + paths[path] + '"')
1483
1484     # Modify some values
1485     if "project_path" not in project_pyconf_cfg:
1486         project_pyconf_cfg.addMapping("project_path",
1487                                       src.pyconf.Mapping(project_pyconf_cfg),
1488                                       "")
1489     project_pyconf_cfg.project_path = src.pyconf.Reference(project_pyconf_cfg,
1490                                                            src.pyconf.DOLLAR,
1491                                                            'PWD')
1492     # we don't want to export these two fields
1493     project_pyconf_cfg.__delitem__("file_path")
1494     project_pyconf_cfg.__delitem__("PWD")
1495     if ftp_mode:
1496         project_pyconf_cfg.__delitem__("ARCHIVEPATH")
1497
1498     # Write the project pyconf file
1499     project_pyconf_tmp_path = os.path.join(tmp_working_dir, project_file_name)
1500     ff = open(project_pyconf_tmp_path, 'w')
1501     ff.write("#!/usr/bin/env python\n#-*- coding:utf-8 -*-\n\n")
1502     project_pyconf_cfg.__save__(ff, 1)
1503     ff.close()
1504     d_project["Project hat file"] = (project_pyconf_tmp_path, project_file_dest)
1505
1506     return d_project
1507
1508 def add_readme(config, options, where):
1509     readme_path = os.path.join(where, "README")
1510     with codecs.open(readme_path, "w", 'utf-8') as f:
1511
1512     # templates for building the header
1513         readme_header="""
1514 # This package was generated with sat $version
1515 # Date: $date
1516 # User: $user
1517 # Distribution : $dist
1518
1519 In the following, $$ROOT represents the directory where you have installed
1520 SALOME (the directory where this file is located).
1521
1522 """
1523         if src.architecture.is_windows():
1524             readme_header = readme_header.replace('$$ROOT','%ROOT%')
1525         readme_compilation_with_binaries="""
1526
1527 compilation based on the binaries used as prerequisites
1528 =======================================================
1529
1530 If you fail to compile the complete application (for example because
1531 you are not root on your system and cannot install missing packages), you
1532 may try a partial compilation based on the binaries.
1533 For that it is necessary to copy the binaries from BINARIES to INSTALL,
1534 and do some substitutions on cmake and .la files (replace the build directories
1535 with local paths).
1536 The procedure to do it is:
1537  1) Remove or rename INSTALL directory if it exists
1538  2) Execute the shell script install_bin.sh:
1539  > cd $ROOT
1540  > ./install_bin.sh
1541  3) Use SalomeTool (as explained in Sources section) and compile only the
1542     modules you need to (with -p option)
1543
1544 """
1545         readme_header_tpl=string.Template(readme_header)
1546         readme_template_path_bin = os.path.join(config.VARS.internal_dir,
1547                 "README_BIN.template")
1548         readme_template_path_bin_launcher = os.path.join(config.VARS.internal_dir,
1549                 "README_LAUNCHER.template")
1550         readme_template_path_bin_virtapp = os.path.join(config.VARS.internal_dir,
1551                 "README_BIN_VIRTUAL_APP.template")
1552         readme_template_path_src = os.path.join(config.VARS.internal_dir,
1553                 "README_SRC.template")
1554         readme_template_path_pro = os.path.join(config.VARS.internal_dir,
1555                 "README_PROJECT.template")
1556         readme_template_path_sat = os.path.join(config.VARS.internal_dir,
1557                 "README_SAT.template")
1558
1559         # prepare substitution dictionary
1560         d = dict()
1561         d['user'] = config.VARS.user
1562         d['date'] = datetime.datetime.now().strftime("%Y-%m-%d %H:%M")
1563         d['version'] = src.get_salometool_version(config)
1564         d['dist'] = config.VARS.dist
1565         f.write(readme_header_tpl.substitute(d)) # write the general header (common)
1566
1567         if options.binaries or options.sources:
1568             d['application'] = config.VARS.application
1569             d['BINARIES']    = config.INTERNAL.config.binary_dir
1570             d['SEPARATOR'] = config.VARS.sep
1571             if src.architecture.is_windows():
1572                 d['operatingSystem'] = 'Windows'
1573                 d['PYTHON3'] = 'python3'
1574                 d['ROOT']    = '%ROOT%'
1575             else:
1576                 d['operatingSystem'] = 'Linux'
1577                 d['PYTHON3'] = ''
1578                 d['ROOT']    = '$ROOT'
1579             f.write("# Application: " + d['application'] + "\n")
1580             if 'KERNEL' in config.APPLICATION.products:
1581                 VersionSalome = src.get_salome_version(config)
1582                 # Case where SALOME has the launcher that uses the SalomeContext API
1583                 if VersionSalome >= MMP([7,3,0]):
1584                     d['launcher'] = config.APPLICATION.profile.launcher_name
1585                 else:
1586                     d['virtual_app'] = 'runAppli' # this info is not used now)
1587
1588         # write the specific sections
1589         if options.binaries:
1590             f.write(src.template.substitute(readme_template_path_bin, d))
1591             if "virtual_app" in d:
1592                 f.write(src.template.substitute(readme_template_path_bin_virtapp, d))
1593             if "launcher" in d:
1594                 f.write(src.template.substitute(readme_template_path_bin_launcher, d))
1595
1596         if options.sources:
1597             f.write(src.template.substitute(readme_template_path_src, d))
1598
1599         if options.binaries and options.sources and not src.architecture.is_windows():
1600             f.write(readme_compilation_with_binaries)
1601
1602         if options.project:
1603             f.write(src.template.substitute(readme_template_path_pro, d))
1604
1605         if options.sat:
1606             f.write(src.template.substitute(readme_template_path_sat, d))
1607
1608     return readme_path
1609
1610 def update_config(config, logger,  prop, value):
1611     '''Remove from config.APPLICATION.products the products that have the property given as input.
1612
1613     :param config Config: The global config.
1614     :param prop str: The property to filter
1615     :param value str: The value of the property to filter
1616     '''
1617     # if there is no APPLICATION (ex sat package -t) : nothing to do
1618     if "APPLICATION" in config:
1619         l_product_to_remove = []
1620         for product_name in config.APPLICATION.products.keys():
1621             prod_cfg = src.product.get_product_config(config, product_name)
1622             if src.get_property_in_product_cfg(prod_cfg, prop) == value:
1623                 l_product_to_remove.append(product_name)
1624         for product_name in l_product_to_remove:
1625             config.APPLICATION.products.__delitem__(product_name)
1626             logger.write("Remove product %s with property %s\n" % (product_name, prop), 5)
1627
1628 def description():
1629     '''method that is called when salomeTools is called with --help option.
1630
1631     :return: The text to display for the package command description.
1632     :rtype: str
1633     '''
1634     return _("""
1635 The package command creates a tar file archive of a product.
1636 There are four kinds of archive, which can be mixed:
1637
1638  1 - The binary archive.
1639      It contains the product installation directories plus a launcher.
1640  2 - The sources archive.
1641      It contains the product archives, a project (the application plus salomeTools).
1642  3 - The project archive.
1643      It contains a project (give the project file path as argument).
1644  4 - The salomeTools archive.
1645      It contains code utility salomeTools.
1646
1647 example:
1648  >> sat package SALOME-master --binaries --sources""")
1649
1650 def run(args, runner, logger):
1651     '''method that is called when salomeTools is called with package parameter.
1652     '''
1653
1654     # Parse the options
1655     (options, args) = parser.parse_args(args)
1656
1657
1658     # Check that a type of package is called, and only one
1659     all_option_types = (options.binaries,
1660                         options.sources,
1661                         options.project not in ["", None],
1662                         options.sat,
1663                         options.bin_products)
1664
1665     # Check if no option for package type
1666     if all_option_types.count(True) == 0:
1667         msg = _("Error: Precise a type for the package\nUse one of the "
1668                 "following options: --binaries, --sources, --project or"
1669                 " --salometools, --bin_products")
1670         logger.write(src.printcolors.printcError(msg), 1)
1671         logger.write("\n", 1)
1672         return 1
1673     do_create_package = options.binaries or options.sources or options.project or options.sat
1674
1675     if options.bin_products:
1676         ret = bin_products_archives(runner.cfg, logger, options.with_vcs)
1677         if ret!=0:
1678             return ret
1679     if not do_create_package:
1680         return 0
1681
1682     # continue to create a tar.gz package
1683
1684     # The repository where to put the package if not Binary or Source
1685     package_default_path = runner.cfg.LOCAL.workdir
1686     # if the package contains binaries or sources:
1687     if options.binaries or options.sources or options.bin_products:
1688         # Check that the command has been called with an application
1689         src.check_config_has_application(runner.cfg)
1690
1691         # Display information
1692         logger.write(_("Packaging application %s\n") % src.printcolors.printcLabel(
1693                                                     runner.cfg.VARS.application), 1)
1694
1695         # Get the default directory where to put the packages
1696         package_default_path = os.path.join(runner.cfg.APPLICATION.workdir, "PACKAGE")
1697         src.ensure_path_exists(package_default_path)
1698
1699     # if the package contains a project:
1700     if options.project:
1701         # check that the project is visible by SAT
1702         projectNameFile = options.project + ".pyconf"
1703         foundProject = None
1704         for i in runner.cfg.PROJECTS.project_file_paths:
1705             baseName = os.path.basename(i)
1706             if baseName == projectNameFile:
1707                 foundProject = i
1708                 break
1709
1710         if foundProject is None:
1711             local_path = os.path.join(runner.cfg.VARS.salometoolsway, "data", "local.pyconf")
1712             msg = _("""ERROR: the project %(1)s is not visible by salomeTools.
1713 known projects are:
1714 %(2)s
1715
1716 Please add it in file:
1717 %(3)s""" % \
1718                     {"1": options.project, "2": "\n  ".join(runner.cfg.PROJECTS.project_file_paths), "3": local_path})
1719             logger.write(src.printcolors.printcError(msg), 1)
1720             logger.write("\n", 1)
1721             return 1
1722         else:
1723             options.project_file_path = foundProject
1724             src.printcolors.print_value(logger, "Project path", options.project_file_path, 2)
1725
1726     # Remove the products that are filtered by the --without_properties option
1727     if options.without_properties:
1728         prop, value = options.without_properties
1729         update_config(runner.cfg, logger, prop, value)
1730
1731     # Remove from config the products that have the not_in_package property
1732     update_config(runner.cfg, logger, "not_in_package", "yes")
1733
1734     # get the name of the archive or build it
1735     if options.name:
1736         if os.path.basename(options.name) == options.name:
1737             # only a name (not a path)
1738             archive_name = options.name
1739             dir_name = package_default_path
1740         else:
1741             archive_name = os.path.basename(options.name)
1742             dir_name = os.path.dirname(options.name)
1743
1744         # suppress extension
1745         if archive_name[-len(".tgz"):] == ".tgz":
1746             archive_name = archive_name[:-len(".tgz")]
1747         if archive_name[-len(".tar.gz"):] == ".tar.gz":
1748             archive_name = archive_name[:-len(".tar.gz")]
1749
1750     else:
1751         archive_name=""
1752         dir_name = package_default_path
1753         if options.binaries or options.sources:
1754             archive_name = runner.cfg.APPLICATION.name
1755
1756         if options.binaries:
1757             archive_name += "-"+runner.cfg.VARS.dist
1758
1759         if options.sources:
1760             archive_name += "-SRC"
1761             if options.with_vcs:
1762                 archive_name += "-VCS"
1763
1764         if options.sat:
1765             archive_name += ("salomeTools_" + src.get_salometool_version(runner.cfg))
1766
1767         if options.project:
1768             if options.sat:
1769                 archive_name += "_"
1770             archive_name += ("satproject_" + options.project)
1771
1772         if len(archive_name)==0: # no option worked
1773             msg = _("Error: Cannot name the archive\n"
1774                     " check if at least one of the following options was "
1775                     "selected : --binaries, --sources, --project or"
1776                     " --salometools")
1777             logger.write(src.printcolors.printcError(msg), 1)
1778             logger.write("\n", 1)
1779             return 1
1780
1781     path_targz = os.path.join(dir_name, archive_name + PACKAGE_EXT)
1782
1783     src.printcolors.print_value(logger, "Package path", path_targz, 2)
1784
1785     # Create a working directory for all files that are produced during the
1786     # package creation and that will be removed at the end of the command
1787     tmp_working_dir = os.path.join(runner.cfg.VARS.tmp_root, runner.cfg.VARS.datehour)
1788     src.ensure_path_exists(tmp_working_dir)
1789     logger.write("\n", 5)
1790     logger.write(_("The temporary working directory: %s\n" % tmp_working_dir),5)
1791
1792     logger.write("\n", 3)
1793
1794     msg = _("Preparation of files to add to the archive")
1795     logger.write(src.printcolors.printcLabel(msg), 2)
1796     logger.write("\n", 2)
1797
1798     d_files_to_add={}  # content of the archive
1799
1800     # a dict to hold paths that will need to be substitute for users recompilations
1801     d_paths_to_substitute={}
1802
1803     if options.binaries:
1804         d_bin_files_to_add = binary_package(runner.cfg,
1805                                             logger,
1806                                             options,
1807                                             tmp_working_dir)
1808         # for all binaries dir, store the substitution that will be required
1809         # for extra compilations
1810         for key in d_bin_files_to_add:
1811             if key.endswith("(bin)"):
1812                 source_dir = d_bin_files_to_add[key][0]
1813                 path_in_archive = d_bin_files_to_add[key][1].replace(
1814                    runner.cfg.INTERNAL.config.binary_dir + runner.cfg.VARS.dist,
1815                    runner.cfg.INTERNAL.config.install_dir)
1816                 if os.path.basename(source_dir)==os.path.basename(path_in_archive):
1817                     # if basename is the same we will just substitute the dirname
1818                     d_paths_to_substitute[os.path.dirname(source_dir)]=\
1819                         os.path.dirname(path_in_archive)
1820                 else:
1821                     d_paths_to_substitute[source_dir]=path_in_archive
1822
1823         d_files_to_add.update(d_bin_files_to_add)
1824     if options.sources:
1825         d_files_to_add.update(source_package(runner,
1826                                         runner.cfg,
1827                                         logger,
1828                                         options,
1829                                         tmp_working_dir))
1830         if options.binaries:
1831             # for archives with bin and sources we provide a shell script able to
1832             # install binaries for compilation
1833             file_install_bin=produce_install_bin_file(runner.cfg,logger,
1834                                                       tmp_working_dir,
1835                                                       d_paths_to_substitute,
1836                                                       "install_bin.sh")
1837             d_files_to_add.update({"install_bin" : (file_install_bin, "install_bin.sh")})
1838             logger.write("substitutions that need to be done later : \n", 5)
1839             logger.write(str(d_paths_to_substitute), 5)
1840             logger.write("\n", 5)
1841     else:
1842         # --salomeTool option is not considered when --sources is selected, as this option
1843         # already brings salomeTool!
1844         if options.sat:
1845             d_files_to_add.update(sat_package(runner.cfg, tmp_working_dir,
1846                                   options, logger))
1847
1848     if options.project:
1849         DBG.write("config for package %s" % options.project, runner.cfg)
1850         d_files_to_add.update(project_package(runner.cfg, options.project, options.project_file_path, options.ftp, tmp_working_dir, options.sat, logger))
1851
1852     if not(d_files_to_add):
1853         msg = _("Error: Empty dictionnary to build the archive!\n")
1854         logger.write(src.printcolors.printcError(msg), 1)
1855         logger.write("\n", 1)
1856         return 1
1857
1858     # Add the README file in the package
1859     local_readme_tmp_path = add_readme(runner.cfg, options, tmp_working_dir)
1860     d_files_to_add["README"] = (local_readme_tmp_path, "README")
1861
1862     # Add the additional files of option add_files
1863     if options.add_files:
1864         for file_path in options.add_files:
1865             if not os.path.exists(file_path):
1866                 msg = _("WARNING: the file %s is not accessible.\n" % file_path)
1867                 continue
1868             file_name = os.path.basename(file_path)
1869             d_files_to_add[file_name] = (file_path, file_name)
1870
1871     logger.write("\n", 2)
1872     logger.write(src.printcolors.printcLabel(_("Actually do the package")), 2)
1873     logger.write("\n", 2)
1874     logger.write("\nfiles and directories to add:\n%s\n\n" % PP.pformat(d_files_to_add), 5)
1875
1876     res = 0
1877     try:
1878         # Creating the object tarfile
1879         tar = tarfile.open(path_targz, mode='w:gz')
1880
1881         # get the filtering function if needed
1882         if old_python:
1883             filter_function = exclude_VCS_and_extensions_26
1884         else:
1885             filter_function = exclude_VCS_and_extensions
1886
1887         # Add the files to the tarfile object
1888         res = add_files(tar, archive_name, d_files_to_add, logger, f_exclude=filter_function)
1889         tar.close()
1890     except KeyboardInterrupt:
1891         logger.write(src.printcolors.printcError("\nERROR: forced interruption\n"), 1)
1892         logger.write(_("Removing the temporary working directory '%s'... ") % tmp_working_dir, 1)
1893         # remove the working directory
1894         shutil.rmtree(tmp_working_dir)
1895         logger.write(_("OK"), 1)
1896         logger.write(_("\n"), 1)
1897         return 1
1898
1899     # case if no application, only package sat as 'sat package -t'
1900     try:
1901         app = runner.cfg.APPLICATION
1902     except Exception:
1903         app = None
1904
1905     # unconditionaly remove the tmp_local_working_dir
1906     if app is not None:
1907         tmp_local_working_dir = os.path.join(app.workdir, "tmp_package")
1908         if os.path.isdir(tmp_local_working_dir):
1909             shutil.rmtree(tmp_local_working_dir)
1910
1911     # remove the tmp directory, unless user has registered as developer
1912     if os.path.isdir(tmp_working_dir) and (not DBG.isDeveloper()):
1913         shutil.rmtree(tmp_working_dir)
1914
1915     # Print again the path of the package
1916     logger.write("\n", 2)
1917     src.printcolors.print_value(logger, "Package path", path_targz, 2)
1918
1919     return res