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