solenv/bin/modules/installer/scriptitems.pm

   1 #
   2 # This file is part of the LibreOffice project.
   3 #
   4 # This Source Code Form is subject to the terms of the Mozilla Public
   5 # License, v. 2.0. If a copy of the MPL was not distributed with this
   6 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7 #
   8 # This file incorporates work covered by the following license notice:
   9 #
  10 #   Licensed to the Apache Software Foundation (ASF) under one or more
  11 #   contributor license agreements. See the NOTICE file distributed
  12 #   with this work for additional information regarding copyright
  13 #   ownership. The ASF licenses this file to you under the Apache
  14 #   License, Version 2.0 (the "License"); you may not use this file
  15 #   except in compliance with the License. You may obtain a copy of
  16 #   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17 #
  18
  19 package installer::scriptitems;
  20
  21 use strict;
  22 no strict 'refs';
  23 use warnings;
  24
  25 use installer::converter;
  26 use installer::exiter;
  27 use installer::globals;
  28 use installer::languages;
  29 use installer::logger;
  30 use installer::pathanalyzer;
  31 use installer::remover;
  32 use installer::systemactions;
  33
  34 ################################################################
  35 # Resolving the GID for the directories defined in setup script
  36 ################################################################
  37
  38 sub resolve_all_directory_names
  39 {
  40     my ($directoryarrayref) = @_;
  41
  42     # After this procedure the hash shall contain the complete language
  43     # dependent path, not only the language dependent HostName.
  44
  45     my ($key, $value, $parentvalue, $parentgid, $parentdirectoryhashref);
  46
  47     for ( my $i = 0; $i <= $#{$directoryarrayref}; $i++ )
  48     {
  49         my $directoryhashref = ${$directoryarrayref}[$i];
  50         my $gid = $directoryhashref-> {'gid'};
  51         my $parentid = $directoryhashref-> {'ParentID'};
  52
  53         if ( $parentid ne "PREDEFINED_PROGDIR" )
  54         {
  55             # find the array of the parentid, which has to be defined before in setup script
  56             # and is therefore listed before in this array
  57
  58             for ( my $j = 0; $j <= $i; $j++ )
  59             {
  60                 $parentdirectoryhashref = ${$directoryarrayref}[$j];
  61                 $parentgid = $parentdirectoryhashref->{'gid'};
  62
  63                 if ( $parentid eq $parentgid)
  64                 {
  65                     last;
  66                 }
  67             }
  68
  69             # and now we can put the path together
  70             # But take care of the languages!
  71
  72             my $dirismultilingual = $directoryhashref->{'ismultilingual'};
  73             my $parentismultilingual = $parentdirectoryhashref->{'ismultilingual'};
  74
  75             # First: Both directories are language independent or both directories are language dependent
  76
  77             if ((( ! $dirismultilingual ) && ( ! $parentismultilingual )) ||
  78                 (( $dirismultilingual ) && ( $parentismultilingual )))
  79             {
  80                 foreach $key (keys %{$directoryhashref})
  81                 {
  82                     # the key ("HostName (en-US)") must be usable for both hashes
  83
  84                     if ( $key =~ /\bHostName\b/ )
  85                     {
  86                         $parentvalue = "";
  87                         $value = $directoryhashref->{$key};
  88                         if ( $parentdirectoryhashref->{$key} ) { $parentvalue = $parentdirectoryhashref->{$key}; }
  89
  90                         # It is possible, that in scp project, a directory is defined in more languages than
  91                         # the directory parent (happened after automatic generation of macros.inc).
  92                         # Therefore this is checked now and written with a warning into the logfile.
  93                         # This is no error, because (in most cases) the concerned language is not build.
  94
  95                         if ($parentvalue eq "")
  96                         {
  97                             $directoryhashref->{$key} = "FAILURE";
  98                             my $infoline = "WARNING: No hostname for $parentid with \"$key\". Needed by child directory $gid !\n";
  99                             push( @installer::globals::globallogfileinfo, $infoline);
 100                         }
 101                         else
 102                         {
 103                             $directoryhashref->{$key} = $parentvalue . $installer::globals::separator . $value;
 104                         }
 105                     }
 106                 }
 107             }
 108
 109             # Second: The directory is language dependent, the parent not
 110
 111             if (( $dirismultilingual ) && ( ! $parentismultilingual ))
 112             {
 113                 $parentvalue = $parentdirectoryhashref->{'HostName'};       # there is only one
 114
 115                 foreach $key (keys %{$directoryhashref})        # the current directory
 116                 {
 117                     if ( $key =~ /\bHostName\b/ )
 118                     {
 119                         $value = $directoryhashref->{$key};
 120                         $directoryhashref->{$key} = $parentvalue . $installer::globals::separator . $value;
 121                     }
 122                 }
 123             }
 124
 125             # Third: The directory is not language dependent, the parent is language dependent
 126
 127             if (( ! $dirismultilingual ) && ( $parentismultilingual ))
 128             {
 129                 $value = $directoryhashref->{'HostName'};       # there is only one
 130                 delete($directoryhashref->{'HostName'});
 131
 132                 foreach $key (keys %{$parentdirectoryhashref})      # the parent directory
 133                 {
 134                     if ( $key =~ /\bHostName\b/ )
 135                     {
 136                         $parentvalue = $parentdirectoryhashref->{$key};     # there is only one
 137                         $directoryhashref->{$key} = $parentvalue . $installer::globals::separator . $value;
 138                     }
 139                 }
 140
 141                 $directoryhashref->{'ismultilingual'} = 1;  # now this directory is also language dependent
 142             }
 143         }
 144     }
 145 }
 146
 147 #############################################################################
 148 # Files with flag NOT_IN_SUITE do not need to be packed into
 149 # Suite installation sets
 150 #############################################################################
 151
 152 sub remove_office_start_language_files
 153 {
 154     my ($productarrayref) = @_;
 155
 156     my @newitems = ();
 157
 158     for ( my $i = 0; $i <= $#{$productarrayref}; $i++ )
 159     {
 160         my $oneitem = ${$productarrayref}[$i];
 161         my $styles = "";
 162
 163         if ( $oneitem->{'Styles'} ) { $styles = $oneitem->{'Styles'}; }
 164
 165         if (!($styles =~ /\bSET_OFFICE_LANGUAGE\b/))
 166         {
 167             push(@newitems, $oneitem);
 168         }
 169         else
 170         {
 171             my $infoline = "INFO: Flag SET_OFFICE_LANGUAGE \-\> Removing $oneitem->{'gid'} from file list.\n";
 172             push( @installer::globals::logfileinfo, $infoline);
 173         }
 174     }
 175
 176     return \@newitems;
 177 }
 178
 179 #############################################################################
 180 # Registryitems for Uninstall have to be removed
 181 #############################################################################
 182
 183 sub remove_uninstall_regitems_from_script
 184 {
 185     my ($registryarrayref) = @_;
 186
 187     my @newitems = ();
 188
 189     for ( my $i = 0; $i <= $#{$registryarrayref}; $i++ )
 190     {
 191         my $oneitem = ${$registryarrayref}[$i];
 192         my $subkey = "";
 193
 194         if ( $oneitem->{'Subkey'} ) { $subkey = $oneitem->{'Subkey'}; }
 195
 196         if ( $subkey =~ /Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall/ ) { next; }
 197
 198         push(@newitems, $oneitem);
 199     }
 200
 201     return \@newitems;
 202 }
 203
 204 ##############################################################################
 205 # Searching the language module for a specified language
 206 ##############################################################################
 207
 208 sub get_languagespecific_module
 209 {
 210     my ( $lang, $modulestring ) = @_;
 211
 212     my $langmodulestring = "";
 213
 214     my $module;
 215     foreach $module ( keys %installer::globals::alllangmodules )
 216     {
 217         if (( $installer::globals::alllangmodules{$module} eq $lang ) && ( $modulestring =~ /\b$module\b/ ))
 218         {
 219             $langmodulestring = "$langmodulestring,$module";
 220         }
 221     }
 222
 223     $langmodulestring =~ s/^\s*,//;
 224
 225     if ( $langmodulestring eq "" ) { installer::exiter::exit_program("ERROR: No language pack module found for language $lang in string \"$modulestring\"!", "get_languagespecific_module");  }
 226
 227     return $langmodulestring;
 228 }
 229
 230 ##############################################################################
 231 # Removing all items in product lists which do not have the correct languages
 232 ##############################################################################
 233
 234 sub resolving_all_languages_in_productlists
 235 {
 236     my ($productarrayref, $languagesarrayref) = @_;
 237
 238     my @itemsinalllanguages = ();
 239
 240     my ($key, $value);
 241
 242     for ( my $i = 0; $i <= $#{$productarrayref}; $i++ )
 243     {
 244         my $oneitem = ${$productarrayref}[$i];
 245
 246         my $ismultilingual = $oneitem->{'ismultilingual'};
 247
 248         if (!($ismultilingual)) # nothing to do with single language items
 249         {
 250             $oneitem->{'specificlanguage'} = "";
 251             push(@itemsinalllanguages, $oneitem);
 252         }
 253         else    #all language dependent files
 254         {
 255             for ( my $j = 0; $j <= $#{$languagesarrayref}; $j++ )   # iterating over all languages
 256             {
 257                 my $onelanguage = ${$languagesarrayref}[$j];
 258
 259                 my %oneitemhash = ();
 260
 261                 foreach $key (keys %{$oneitem})
 262                 {
 263                     if ( $key =~ /\(\S+\)/ )    # this are the language dependent keys
 264                     {
 265                         if ( $key =~ /\(\Q$onelanguage\E\)/ )
 266                         {
 267                             $value = $oneitem->{$key};
 268                             $oneitemhash{$key} = $value;
 269                         }
 270                     }
 271                     else
 272                     {
 273                         $value = $oneitem->{$key};
 274                         $oneitemhash{$key} = $value;
 275                     }
 276                 }
 277
 278                 $oneitemhash{'specificlanguage'} = $onelanguage;
 279
 280                 if ( $oneitemhash{'haslanguagemodule'} )
 281                 {
 282                     my $langmodulestring = get_languagespecific_module($onelanguage, $oneitemhash{'modules'});
 283                     $oneitemhash{'modules'} = $langmodulestring;
 284                 }
 285
 286                 push(@itemsinalllanguages, \%oneitemhash);
 287             }
 288         }
 289     }
 290
 291     return \@itemsinalllanguages;
 292 }
 293
 294 ################################################################################
 295 # Removing all modules, that have the flag LANGUAGEMODULE, but do not
 296 # have the correct language
 297 ################################################################################
 298
 299 sub remove_not_required_language_modules
 300 {
 301     my ($modulesarrayref, $languagesarrayref) = @_;
 302
 303     my @allmodules = ();
 304
 305     for ( my $i = 0; $i <= $#{$modulesarrayref}; $i++ )
 306     {
 307         my $module = ${$modulesarrayref}[$i];
 308         my $styles = "";
 309         if ( $module->{'Styles'} ) { $styles = $module->{'Styles'}; }
 310
 311         if ( $styles =~ /\bLANGUAGEMODULE\b/ )
 312         {
 313             if ( ! exists($module->{'Language'}) ) { installer::exiter::exit_program("ERROR: \"$module->{'gid'}\" has flag LANGUAGEMODULE, but does not know its language!", "remove_not_required_language_modules"); }
 314             my $modulelanguage = $module->{'Language'};
 315             # checking, if language is required
 316             my $doinclude = 0;
 317             for ( my $j = 0; $j <= $#{$languagesarrayref}; $j++ )
 318             {
 319                 my $onelanguage = ${$languagesarrayref}[$j];
 320                 if ( $onelanguage eq $modulelanguage )
 321                 {
 322                     $doinclude = 1;
 323                     last;
 324                 }
 325             }
 326
 327             if ( $doinclude ) { push(@allmodules, $module); }
 328         }
 329         else
 330         {
 331             push(@allmodules, $module);
 332         }
 333     }
 334
 335     return \@allmodules;
 336 }
 337
 338 ################################################################################
 339 # Removing all modules, that have a spellchecker language that is not
 340 # required for this product (spellchecker selection).
 341 # All required spellchecker languages are stored in
 342 # %installer::globals::spellcheckerlanguagehash
 343 ################################################################################
 344
 345 sub remove_not_required_spellcheckerlanguage_modules
 346 {
 347     my ($modulesarrayref) = @_;
 348
 349     my $infoline = "";
 350     my @allmodules = ();
 351
 352     for ( my $i = 0; $i <= $#{$modulesarrayref}; $i++ )
 353     {
 354         my $module = ${$modulesarrayref}[$i];
 355         if ( $module->{'Spellcheckerlanguage'} )    # selecting modules with Spellcheckerlanguage
 356         {
 357             if ( exists($installer::globals::spellcheckerlanguagehash{$module->{'Spellcheckerlanguage'}}) )
 358             {
 359                 push(@allmodules, $module);
 360             }
 361             else
 362             {
 363                 $infoline = "Spellchecker selection: Removing module $module->{'gid'}\n";
 364                 push( @installer::globals::logfileinfo, $infoline);
 365
 366                 # Collecting all files at modules that are removed
 367
 368                 if ( $module->{'Files'} )
 369                 {
 370                     if ( $module->{'Files'} =~ /^\s*\((.*?)\)\s*$/ )
 371                     {
 372                         my $filelist = $1;
 373
 374                         my $filelisthash = installer::converter::convert_stringlist_into_hash(\$filelist, ",");
 375                         foreach my $onefile ( keys %{$filelisthash} ) { $installer::globals::spellcheckerfilehash{$onefile} = 1; }
 376                     }
 377                 }
 378             }
 379         }
 380         else
 381         {
 382             push(@allmodules, $module);
 383         }
 384     }
 385
 386     return \@allmodules;
 387 }
 388
 389 ################################################################################
 390 # Removing all modules, that belong to a module that was removed
 391 # in "remove_not_required_spellcheckerlanguage_modules" because of the
 392 # spellchecker language. The files belonging to the modules are collected
 393 # in %installer::globals::spellcheckerfilehash.
 394 ################################################################################
 395
 396 sub remove_not_required_spellcheckerlanguage_files
 397 {
 398     my ($filesarrayref) = @_;
 399
 400     my @filesarray = ();
 401     my $infoline = "";
 402
 403     for ( my $i = 0; $i <= $#{$filesarrayref}; $i++ )
 404     {
 405         my $onefile = ${$filesarrayref}[$i];
 406         # FIXME: some items don't have 'gid'
 407         if ( (defined $onefile->{'gid'}) && exists($installer::globals::spellcheckerfilehash{$onefile->{'gid'}}) )
 408         {
 409             $infoline = "Spellchecker selection: Removing file $onefile->{'gid'}\n";
 410             push( @installer::globals::logfileinfo, $infoline);
 411             next;
 412         }
 413         push(@filesarray, $onefile);
 414     }
 415
 416     return \@filesarray;
 417 }
 418
 419 ################################################################################
 420 # Looking for directories without correct HostName
 421 ################################################################################
 422
 423 sub checking_directories_with_corrupt_hostname
 424 {
 425     my ($dirsref, $languagesarrayref) = @_;
 426
 427     for ( my $i = 0; $i <= $#{$dirsref}; $i++ )
 428     {
 429         my $onedir = ${$dirsref}[$i];
 430
 431         my $hostname = "";
 432
 433         if ( $onedir->{'HostName'} ) { $hostname = $onedir->{'HostName'}; }
 434
 435         if ( $hostname eq "" )
 436         {
 437             my $langstring = "";
 438             for ( my $j = 0; $j <= $#{$languagesarrayref}; $j++ ) { $langstring .= ${$languagesarrayref}[$j] . " "; }
 439             installer::exiter::exit_program("ERROR: HostName not defined for $onedir->{'gid'} for specified language. Probably you wanted to create an installation set, in a language not defined in scp2 project. You selected the following language(s): $langstring", "checking_directories_with_corrupt_hostname");
 440         }
 441
 442         if ( $hostname eq "FAILURE" )
 443         {
 444             installer::exiter::exit_program("ERROR: Could not create HostName for $onedir->{'gid'} (missing language at parent). See logfile warning for more info!", "checking_directories_with_corrupt_hostname");
 445         }
 446     }
 447 }
 448
 449 ################################################################################
 450 # Setting global properties
 451 ################################################################################
 452
 453 sub set_global_directory_hostnames
 454 {
 455     my ($dirsref, $allvariables) = @_;
 456
 457     for ( my $i = 0; $i <= $#{$dirsref}; $i++ )
 458     {
 459         my $onedir = ${$dirsref}[$i];
 460         my $styles = "";
 461         if ( $onedir->{'Styles'} ) { $styles = $onedir->{'Styles'}; }
 462
 463         if ( $styles =~ /\bOFFICEDIRECTORY\b/ )
 464         {
 465             $installer::globals::officedirhostname = $onedir->{'HostName'};
 466             $installer::globals::officedirgid = $onedir->{'gid'};
 467             $allvariables->{'OFFICEDIRECTORYHOSTNAME'} = $installer::globals::officedirhostname;
 468         }
 469     }
 470 }
 471
 472 ########################################################
 473 # Recursively defined procedure to order
 474 # modules and directories
 475 ########################################################
 476
 477 sub get_children
 478 {
 479     my ($allitems, $startparent, $newitemorder) = @_;
 480
 481     for ( my $i = 0; $i <= $#{$allitems}; $i++ )
 482     {
 483         my $gid = ${$allitems}[$i]->{'gid'};
 484         my $parent = "";
 485         if ( ${$allitems}[$i]->{'ParentID'} ) { $parent = ${$allitems}[$i]->{'ParentID'}; }
 486
 487         if ( $parent eq $startparent )
 488         {
 489             push(@{$newitemorder}, ${$allitems}[$i]);
 490             my $parent = $gid;
 491             get_children($allitems, $parent, $newitemorder);    # recursive!
 492         }
 493     }
 494 }
 495
 496 ################################################################################
 497 # Using langpack copy action for language packs
 498 ################################################################################
 499
 500 sub use_langpack_copy_scpaction
 501 {
 502     my ($scpactionsref) = @_;
 503
 504     for ( my $i = 0; $i <= $#{$scpactionsref}; $i++ )
 505     {
 506         my $onescpaction = ${$scpactionsref}[$i];
 507         if (( $onescpaction->{'LangPackCopy'} ) && ( $onescpaction->{'LangPackCopy'} ne "" )) { $onescpaction->{'Copy'} = $onescpaction->{'LangPackCopy'}; }
 508     }
 509 }
 510
 511 ################################################################################
 512 # Using dev copy patch action for developer snapshot builds
 513 ################################################################################
 514
 515 sub use_devversion_copy_scpaction
 516 {
 517     my ($scpactionsref) = @_;
 518
 519     for ( my $i = 0; $i <= $#{$scpactionsref}; $i++ )
 520     {
 521         my $onescpaction = ${$scpactionsref}[$i];
 522         if (( $onescpaction->{'DevVersionCopy'} ) && ( $onescpaction->{'DevVersionCopy'} ne "" )) { $onescpaction->{'Copy'} = $onescpaction->{'DevVersionCopy'}; }
 523     }
 524 }
 525
 526 ################################################################################
 527 # Shifting parent directories of URE and Basis layer, so that
 528 # these directories are located below the Brand layer.
 529 # Style: SHIFT_BASIS_INTO_BRAND_LAYER
 530 ################################################################################
 531
 532 sub shift_basis_directory_parents
 533 {
 534     my ($dirsref) = @_;
 535
 536     my @alldirs = ();
 537
 538     my $officedirgid = "";
 539
 540     for ( my $i = 0; $i <= $#{$dirsref}; $i++ )
 541     {
 542         my $onedir = ${$dirsref}[$i];
 543         my $styles = "";
 544         if ( $onedir->{'Styles'} ) { $styles = $onedir->{'Styles'}; }
 545
 546         if ( $styles =~ /\bOFFICEDIRECTORY\b/ ) { $officedirgid = $onedir->{'gid'}; }
 547     }
 548
 549     if ( $officedirgid ne "" )
 550     {
 551         for ( my $i = 0; $i <= $#{$dirsref}; $i++ )
 552         {
 553             my $onedir = ${$dirsref}[$i];
 554             my $styles = "";
 555             if ( $onedir->{'Styles'} ) { $styles = $onedir->{'Styles'}; }
 556
 557             if (( $styles =~ /\bBASISDIRECTORY\b/ ) || ( $styles =~ /\bUREDIRECTORY\b/ ))
 558             {
 559                 $onedir->{'ParentID'} = $officedirgid;
 560             }
 561         }
 562
 563         # Sorting directories
 564         my $startgid = "PREDEFINED_PROGDIR";
 565         get_children($dirsref, $startgid, \@alldirs);
 566     }
 567
 568     return \@alldirs;
 569 }
 570
 571 ################################################################################
 572 # Setting the name of the directory with style OFFICEDIRECTORY.
 573 # The name can be defined in property OFFICEDIRECTORYNAME.
 574 ################################################################################
 575
 576 sub set_officedirectory_name
 577 {
 578     my ($dirsref, $officedirname) = @_;
 579
 580     for ( my $i = 0; $i <= $#{$dirsref}; $i++ )
 581     {
 582         my $onedir = ${$dirsref}[$i];
 583         my $styles = "";
 584         if ( $onedir->{'Styles'} ) { $styles = $onedir->{'Styles'}; }
 585         if ( $styles =~ /\bOFFICEDIRECTORY\b/ )
 586         {
 587             $onedir->{'HostName'} = $officedirname;
 588             last;
 589         }
 590     }
 591 }
 592
 593 ################################################################################
 594 # Simplifying the name for language dependent items from "Name (xy)" to "Name"
 595 ################################################################################
 596
 597 sub changing_name_of_language_dependent_keys
 598 {
 599     my ($itemsarrayref) = @_;
 600
 601     # Changing key for multilingual items from "Name ( )" to "Name" or "HostName ( )" to "HostName"
 602
 603     for ( my $i = 0; $i <= $#{$itemsarrayref}; $i++ )
 604     {
 605         my $oneitem = ${$itemsarrayref}[$i];
 606         my $onelanguage = $oneitem->{'specificlanguage'};
 607
 608         if (!($onelanguage eq "" ))                 # language dependent item
 609         {
 610             my $itemkey;
 611
 612             foreach $itemkey (keys %{$oneitem})
 613             {
 614                 if ( $itemkey =~ /^\s*(\S+?)\s+\(\S+\)\s*$/ )
 615                 {
 616                     my $newitemkey = $1;
 617                     my $itemvalue = $oneitem->{$itemkey};
 618                     $oneitem->{$newitemkey} = $itemvalue;
 619                     delete($oneitem->{$itemkey});
 620                 }
 621             }
 622         }
 623     }
 624 }
 625
 626 ################################################################################
 627 # Replacement of setup variables in ConfigurationItems and ProfileItems
 628 # <productkey>, <buildid>, <sequence_languages>, <productcode>, <upgradecode>, <productupdate>
 629 ################################################################################
 630
 631 sub replace_setup_variables
 632 {
 633     my ($itemsarrayref, $languagestringref, $hashref) = @_;
 634
 635     my $languagesstring = $$languagestringref;
 636     $languagesstring =~ s/\_/ /g;   # replacing underscore with whitespace
 637
 638     my $productname = $hashref->{'PRODUCTNAME'};
 639     my $productversion = $hashref->{'PRODUCTVERSION'};
 640     my $libo_version_major = "";
 641     if ( $hashref->{'LIBO_VERSION_MAJOR'} ) { $libo_version_major = $hashref->{'LIBO_VERSION_MAJOR'}; }
 642     my $productkey = $productname . " " . $productversion;
 643
 644     # string $buildid, which is used to replace the setup variable <buildid>
 645
 646     my $localbuild = $installer::globals::build;
 647
 648     if ( $localbuild =~ /^\s*(\w+?)(\d+)\s*$/ ) { $localbuild = $2; }   # using "680" instead of "src680"
 649
 650     my $buildidstring = `cd $ENV{'SRCDIR'} 2>&1 >/dev/null && git log -n 1 --pretty=format:"%H"`;
 651     if ($? || !$buildidstring) {
 652         $buildidstring = $localbuild . "(Build:" . $installer::globals::buildid . ")";
 653     }
 654
 655     my $updateid = $productname . "_" . $libo_version_major . "_" . $$languagestringref;
 656     $updateid =~ s/ /_/g;
 657
 658     my $updatechannel = "";
 659     if ( $ENV{'UPDATE_CONFIG'} && $ENV{'UPDATE_CONFIG'} ne "")
 660     {
 661         open(CONFIG, glob($ENV{'UPDATE_CONFIG'}));
 662         while (<CONFIG>)
 663         {
 664             chomp;
 665             if (/^s*(\S+)=(\S+)$/)
 666             {
 667                 my $key = $1;
 668                 my $val = $2;
 669                 if ($key eq "channel")
 670                 {
 671                     $updatechannel = $val;
 672                 }
 673             }
 674         }
 675         close(CONFIG);
 676     }
 677
 678     for ( my $i = 0; $i <= $#{$itemsarrayref}; $i++ )
 679     {
 680         my $oneitem = ${$itemsarrayref}[$i];
 681         my $value = $oneitem->{'Value'};
 682
 683         $value =~ s/\<buildid\>/$buildidstring/;
 684         $value =~ s/\<sequence_languages\>/$languagesstring/;
 685         $value =~ s/\<productkey\>/$productkey/;
 686         $value =~ s/\<productcode\>/$installer::globals::productcode/;
 687         $value =~ s/\<upgradecode\>/$installer::globals::upgradecode/;
 688         $value =~ s/\<alllanguages\>/$languagesstring/;
 689         $value =~ s/\<sourceid\>/$installer::globals::build/;
 690         $value =~ s/\<updateid\>/$updateid/;
 691         $value =~ s/\<updatechannel\>/$updatechannel/;
 692         $value =~ s/\<pkgformat\>/$installer::globals::packageformat/;
 693         $ENV{'OOO_VENDOR'} = "" if !defined $ENV{'OOO_VENDOR'};
 694         $value =~ s/\<vendor\>/$ENV{'OOO_VENDOR'}/;
 695
 696         $oneitem->{'Value'} = $value;
 697     }
 698 }
 699
 700 ################################################################################
 701 # By defining variable LOCALUSERDIR in *.lst it is possible to change
 702 # the standard destination of user directory defined in scp2 ($SYSUSERCONFIG).
 703 ################################################################################
 704
 705 sub replace_userdir_variable
 706 {
 707     my ($itemsarrayref, $allvariableshashref) = @_;
 708
 709     my $userdir = "";
 710     if ( $allvariableshashref->{'LOCALUSERDIR'} ) { $userdir = $allvariableshashref->{'LOCALUSERDIR'}; }
 711     else { $userdir = $installer::globals::simpledefaultuserdir; }
 712
 713     if ( $userdir ne "" )
 714     {
 715         for ( my $i = 0; $i <= $#{$itemsarrayref}; $i++ )
 716         {
 717             my $oneitem = ${$itemsarrayref}[$i];
 718             $oneitem->{'Value'} =~ s/\$SYSUSERCONFIG/$userdir/;
 719         }
 720     }
 721 }
 722
 723 #####################################################################################
 724 # Files and ConfigurationItems are not included for all languages.
 725 # For instance asian fonts. These can be removed, if no "Name" is found.
 726 # ConfigurationItems are not always defined in the linguistic configuration file.
 727 # The "Key" cannot be found for them.
 728 #####################################################################################
 729
 730 sub remove_non_existent_languages_in_productlists
 731 {
 732     my ($itemsarrayref, $languagestringref, $searchkey, $itemtype) = @_;
 733
 734     # Removing of all non existent files, for instance asian fonts
 735
 736     installer::logger::include_header_into_logfile("Removing for this language $$languagestringref:");
 737
 738     my @allexistentitems = ();
 739
 740     my $infoline;
 741
 742     for ( my $i = 0; $i <= $#{$itemsarrayref}; $i++ )
 743     {
 744         my $oneitem = ${$itemsarrayref}[$i];
 745         my $oneitemname = "";       # $searchkey is "Name" for files and "Key" for ConfigurationItems
 746
 747         if ( $oneitem->{$searchkey} ) { $oneitemname = $oneitem->{$searchkey} }
 748
 749         my $itemtoberemoved = 0;
 750
 751         if ($oneitemname eq "")                     # for instance asian font in english installation set
 752         {
 753             $itemtoberemoved = 1;
 754         }
 755
 756         if ($itemtoberemoved)
 757         {
 758             $infoline = "WARNING: Language $$languagestringref: No $itemtype packed for $oneitem->{'gid'}!\n";
 759             push( @installer::globals::logfileinfo, $infoline);
 760         }
 761         else
 762         {
 763             push(@allexistentitems, $oneitem);
 764         }
 765     }
 766
 767     $infoline = "\n";
 768     push( @installer::globals::logfileinfo, $infoline);
 769
 770     return \@allexistentitems;
 771 }
 772
 773 ########################################################################
 774 # Input is the directory gid, output the "HostName" of the directory
 775 ########################################################################
 776
 777 sub get_Directoryname_From_Directorygid
 778 {
 779     my ($dirsarrayref ,$searchgid, $onelanguage, $oneitemgid) = @_;
 780
 781     my $directoryname = "";
 782     my $onedirectory;
 783     my $foundgid = 0;
 784
 785     for ( my $i = 0; $i <= $#{$dirsarrayref}; $i++ )
 786     {
 787         $onedirectory = ${$dirsarrayref}[$i];
 788         my $directorygid = $onedirectory->{'gid'};
 789
 790         if ($directorygid eq $searchgid)
 791         {
 792             $foundgid = 1;
 793             last;
 794         }
 795     }
 796
 797     if (!($foundgid))
 798     {
 799         installer::exiter::exit_program("ERROR: Gid $searchgid not defined in $installer::globals::setupscriptname", "get_Directoryname_From_Directorygid");
 800     }
 801
 802     if ( ! ( $onedirectory->{'ismultilingual'} ))   # the directory is not language dependent
 803     {
 804          $directoryname = $onedirectory->{'HostName'};
 805     }
 806     else
 807     {
 808         $directoryname = $onedirectory->{"HostName ($onelanguage)"};
 809     }
 810
 811     # gid_Dir_Template_Wizard_Letter is defined as language dependent directory, but the file gid_Dir_Template_Wizard_Letter
 812     # is not language dependent. Therefore $onelanguage is not defined. But which language is the correct language for the
 813     # directory?
 814     # Perhaps better solution: In scp it must be forbidden to have a language independent file in a language dependent directory.
 815
 816     if (( ! $directoryname ) && ( $onelanguage eq "" ))
 817     {
 818         installer::exiter::exit_program("ERROR (in scp): Directory $searchgid is language dependent, but not $oneitemgid inside this directory", "get_Directoryname_From_Directorygid");
 819     }
 820
 821     return \$directoryname;
 822 }
 823
 824 ##################################################################
 825 # Getting destination directory for links, files and profiles
 826 ##################################################################
 827
 828 sub get_Destination_Directory_For_Item_From_Directorylist       # this is used for Files, Profiles and Links
 829 {
 830     my ($itemarrayref, $dirsarrayref) = @_;
 831
 832     for ( my $i = 0; $i <= $#{$itemarrayref}; $i++ )
 833     {
 834         my $oneitem = ${$itemarrayref}[$i];
 835         my $oneitemgid = $oneitem->{'gid'};
 836         my $directorygid = $oneitem->{'Dir'};       # for instance gid_Dir_Program
 837         my $netdirectorygid = "";
 838         my $onelanguage = $oneitem->{'specificlanguage'};
 839         my $ispredefinedprogdir = 0;
 840         my $ispredefinedconfigdir = 0;
 841
 842         my $oneitemname = $oneitem->{'Name'};
 843
 844         if ( $oneitem->{'NetDir'} ) { $netdirectorygid = $oneitem->{'NetDir'}; }
 845
 846         installer::pathanalyzer::make_absolute_filename_to_relative_filename(\$oneitemname);    # making /registry/schema/org/openoffice/VCL.xcs to VCL.xcs
 847
 848         my $searchdirgid;
 849
 850         if ( $netdirectorygid eq "" )   # if NetDir is defined, it is privileged
 851         {
 852             $searchdirgid = $directorygid
 853         }
 854         else
 855         {
 856             $searchdirgid = $netdirectorygid
 857         }
 858
 859         if ($searchdirgid =~ /PREDEFINED_PROGDIR/)  # the root directory is not defined in setup script
 860         {
 861             $ispredefinedprogdir = 1;
 862         }
 863
 864         if ($searchdirgid =~ /PREDEFINED_CONFIGDIR/)    # the root directory is not defined in setup script
 865         {
 866             $ispredefinedconfigdir = 1;
 867         }
 868
 869         my $destfilename;
 870
 871         if ($oneitem->{'DoNotMessWithSymlinks'})
 872         {
 873             $destfilename = $oneitem->{'Name'};
 874         }
 875         elsif ((!( $ispredefinedprogdir )) && (!( $ispredefinedconfigdir )))
 876         {
 877             my $directorynameref = get_Directoryname_From_Directorygid($dirsarrayref, $searchdirgid, $onelanguage, $oneitemgid);
 878             my $styles = "";
 879             if ($oneitem->{'Styles'}) { $styles = $oneitem->{'Styles'}; }
 880             if ($styles =~ /\bFILELIST\b/)
 881             {
 882                 $destfilename = $$directorynameref . $installer::globals::separator . $oneitemname;
 883             }
 884             else
 885             {
 886                 $destfilename = $$directorynameref . $installer::globals::separator . $oneitem->{'Name'};
 887             }
 888         }
 889         else
 890         {
 891             $destfilename = $oneitemname;
 892         }
 893
 894         $oneitem->{'destination'} = $destfilename;
 895     }
 896 }
 897
 898 ##########################################################################
 899 # Searching a file in a list of paths
 900 ##########################################################################
 901
 902 sub get_sourcepath_from_filename_and_includepath_classic
 903 {
 904     my ($searchfilenameref, $includepatharrayref, $write_logfile) = @_;
 905
 906     my ($onefile, $includepath, $infoline);
 907
 908     my $foundsourcefile = 0;
 909
 910     for ( my $j = 0; $j <= $#{$includepatharrayref}; $j++ )
 911     {
 912         $includepath = ${$includepatharrayref}[$j];
 913         installer::remover::remove_leading_and_ending_whitespaces(\$includepath);
 914
 915         $onefile = $includepath . $installer::globals::separator . $$searchfilenameref;
 916
 917         if ( -f $onefile )
 918         {
 919             $foundsourcefile = 1;
 920             last;
 921         }
 922     }
 923
 924     if (!($foundsourcefile))
 925     {
 926         $onefile = "";  # the sourcepath has to be empty
 927         if ( $write_logfile)
 928         {
 929             $infoline = "ERROR: Source for $$searchfilenameref not found (classic)!\n";    # Important message in log file
 930             push( @installer::globals::logfileinfo, $infoline);
 931         }
 932     }
 933     else
 934     {
 935         if ( $write_logfile)
 936         {
 937             $infoline = "SUCCESS: Source for $$searchfilenameref: $onefile\n";
 938             push( @installer::globals::logfileinfo, $infoline);
 939         }
 940     }
 941
 942     return \$onefile;
 943 }
 944
 945 ##########################################################################
 946 # Input is one file name, output the complete absolute path of this file
 947 ##########################################################################
 948
 949 sub get_sourcepath_from_filename_and_includepath
 950 {
 951     my ($searchfilenameref, $unused, $write_logfile) = @_;
 952
 953     my ($onefile, $includepath, $infoline);
 954
 955     my $foundsourcefile = 0;
 956     my $foundnewname = 0;
 957
 958     for ( my $j = 0; $j <= $#installer::globals::allincludepaths; $j++ )
 959     {
 960         my $allfiles = $installer::globals::allincludepaths[$j];
 961
 962         if ( exists( $allfiles->{$$searchfilenameref} ))
 963         {
 964             $onefile = $allfiles->{'includepath'} . $installer::globals::separator . $$searchfilenameref;
 965             $foundsourcefile = 1;
 966             last;
 967         }
 968     }
 969
 970     if (!($foundsourcefile))    # testing with lowercase filename
 971     {
 972         # Attention: README01.html is copied for Windows to readme01.html, not case sensitive
 973
 974         for ( my $j = 0; $j <= $#installer::globals::allincludepaths; $j++ )
 975         {
 976             my $allfiles = $installer::globals::allincludepaths[$j];
 977
 978             my $newfilename = $$searchfilenameref;
 979             $newfilename =~ s/readme/README/;       # special handling for readme files
 980             $newfilename =~ s/license/LICENSE/;     # special handling for license files
 981
 982             if ( exists( $allfiles->{$newfilename} ))
 983             {
 984                 $onefile = $allfiles->{'includepath'} . $installer::globals::separator . $newfilename;
 985                 $foundsourcefile = 1;
 986                 $foundnewname = 1;
 987                 last;
 988             }
 989         }
 990     }
 991
 992     if (!($foundsourcefile))
 993     {
 994         $onefile = "";  # the sourcepath has to be empty
 995         if ( $write_logfile)
 996         {
 997             $infoline = "ERROR: Source for $$searchfilenameref not found!\n";    # Important message in log file
 998             push( @installer::globals::logfileinfo, $infoline);
 999         }
1000     }
1001     else
1002     {
1003         if ( $write_logfile)
1004         {
1005             if (!($foundnewname))
1006             {
1007                 $infoline = "SUCCESS: Source for $$searchfilenameref: $onefile\n";
1008             }
1009             else
1010             {
1011                 $infoline = "SUCCESS/WARNING: Special handling for $$searchfilenameref: $onefile\n";
1012             }
1013             push( @installer::globals::logfileinfo, $infoline);
1014         }
1015     }
1016
1017     return \$onefile;
1018 }
1019
1020 ##############################################################
1021 # Getting all source paths for all files to be packed
1022 # $item can be "Files" or "ScpActions"
1023 ##############################################################
1024
1025 sub get_Source_Directory_For_Files_From_Includepathlist
1026 {
1027     my ($filesarrayref, $includepatharrayref, $dirsref, $item, $allvariables) = @_;
1028
1029     installer::logger::include_header_into_logfile("$item:");
1030
1031     my ($foundit, $dontcare, $extrarootdir) =
1032         get_office_directory_gid_and_hostname($dirsref);
1033     my $infoline = "";
1034
1035     for ( my $i = 0; $i <= $#{$filesarrayref}; $i++ )
1036     {
1037         my $onefile = ${$filesarrayref}[$i];
1038         my $onelanguage = $onefile->{'specificlanguage'};
1039
1040         if ( ! $onefile->{'Name'} ) { installer::exiter::exit_program("ERROR: $item without name ! GID: $onefile->{'gid'} ! Language: $onelanguage", "get_Source_Directory_For_Files_From_Includepathlist"); }
1041
1042         my $onefilename = $onefile->{'Name'};
1043         if ( $item eq "ScpActions" ) { $onefilename =~ s/\//$installer::globals::separator/g; }
1044         $onefilename =~ s/^\s*\Q$installer::globals::separator\E//;     # filename begins with a slash, for instance /registry/schema/org/openoffice/VCL.xcs
1045
1046         my $styles = "";
1047         my $file_can_miss = 0;
1048         if ( $onefile->{'Styles'} ) { $styles = $onefile->{'Styles'}; }
1049
1050         if (( $installer::globals::languagepack ) && ( ! $onefile->{'ismultilingual'} ) && ( ! ( $styles =~ /\bFORCELANGUAGEPACK\b/ ))) { $file_can_miss = 1; }
1051         if (( $installer::globals::helppack ) && ( ! $onefile->{'ismultilingual'} ) && ( ! ( $styles =~ /\bFORCEHELPPACK\b/ ))) { $file_can_miss = 1; }
1052
1053         my $sourcepathref = "";
1054
1055         my $destination = $onefile->{'destination'};
1056         my $instdirdestination;
1057         if ($destination)
1058         {
1059             if (($installer::globals::iswindowsbuild) && $foundit && $extrarootdir)
1060             {
1061                 $destination =~ s,$extrarootdir/,,; # remove it from path
1062             }
1063             if (($installer::globals::languagepack) && ($installer::globals::ismacbuild))
1064             {   # source files are in $(PRODUCTNAME).app where they will
1065                 # actually copied by the user executing the Language Pack.app
1066                 $destination =~ s, Language Pack.app/,.app/,;
1067             }
1068             $instdirdestination = $ENV{'INSTDIR'} . $installer::globals::separator . $destination;
1069         }
1070         if ($instdirdestination && -f $instdirdestination)
1071         {
1072             $infoline = "SUCCESS: INSTDIR Source for $onefilename: $instdirdestination\n";
1073             push( @installer::globals::logfileinfo, $infoline);
1074             $$sourcepathref = $instdirdestination;
1075         }
1076         else
1077         {
1078         if ( $file_can_miss ) { $sourcepathref = get_sourcepath_from_filename_and_includepath(\$onefilename, $includepatharrayref, 0); }
1079         else { $sourcepathref = get_sourcepath_from_filename_and_includepath(\$onefilename, $includepatharrayref, 1); }
1080         }
1081
1082         $onefile->{'sourcepath'} = $$sourcepathref; # This $$sourcepathref is empty, if no source was found
1083     }
1084
1085     $infoline = "\n";   # empty line after listing of all files
1086     push( @installer::globals::logfileinfo, $infoline);
1087 }
1088
1089 #################################################################################
1090 # Removing files, that shall not be included into languagepacks
1091 # (because of rpm conflicts)
1092 #################################################################################
1093
1094 sub remove_Files_For_Languagepacks
1095 {
1096     my ($itemsarrayref) = @_;
1097
1098     my $infoline;
1099
1100     my @newitemsarray = ();
1101
1102     for ( my $i = 0; $i <= $#{$itemsarrayref}; $i++ )
1103     {
1104         my $oneitem = ${$itemsarrayref}[$i];
1105         my $gid = $oneitem->{'gid'};
1106
1107         # scp Todo: Remove asap after removal of old setup
1108
1109         if (( $gid eq "gid_File_Extra_Fontunxpsprint" ) ||
1110             ( $gid eq "gid_File_Extra_Migration_Lang" ))
1111         {
1112             $infoline = "ATTENTION: Removing item $oneitem->{'gid'} from the installation set.\n";
1113             push( @installer::globals::logfileinfo, $infoline);
1114
1115             next;
1116         }
1117
1118         push(@newitemsarray, $oneitem);
1119     }
1120
1121     return \@newitemsarray;
1122 }
1123
1124 #################################################################################
1125 # Files, whose source directory is not found, are removed now (this is an ERROR)
1126 #################################################################################
1127
1128 sub remove_Files_Without_Sourcedirectory
1129 {
1130     my ($filesarrayref) = @_;
1131
1132     my $infoline;
1133
1134     my $error_occurred = 0;
1135     my @missingfiles = ();
1136     push(@missingfiles, "ERROR: The following files could not be found: \n");
1137
1138     my @newfilesarray = ();
1139
1140     for ( my $i = 0; $i <= $#{$filesarrayref}; $i++ )
1141     {
1142         my $onefile = ${$filesarrayref}[$i];
1143         my $sourcepath = $onefile->{'sourcepath'};
1144
1145         if ($sourcepath eq "")
1146         {
1147             my $styles = $onefile->{'Styles'};
1148             my $filename = $onefile->{'Name'};
1149
1150             if ( ! $installer::globals::languagepack && !$installer::globals::helppack)
1151             {
1152                 $infoline = "ERROR: Removing file $filename from file list.\n";
1153                 push( @installer::globals::logfileinfo, $infoline);
1154
1155                 push(@missingfiles, "ERROR: File not found: $filename\n");
1156                 $error_occurred = 1;
1157
1158                 next;   # removing this file from list, if sourcepath is empty
1159             }
1160             elsif ( $installer::globals::languagepack ) # special case for language packs
1161             {
1162                 if (( $onefile->{'ismultilingual'} ) || ( $styles =~ /\bFORCELANGUAGEPACK\b/ ))
1163                 {
1164                     $infoline = "ERROR: Removing file $filename from file list.\n";
1165                     push( @installer::globals::logfileinfo, $infoline);
1166
1167                     push(@missingfiles, "ERROR: File not found: $filename\n");
1168                     $error_occurred = 1;
1169
1170                     next;   # removing this file from list, if sourcepath is empty
1171                 }
1172                 else
1173                 {
1174                     $infoline = "INFO: Removing file $filename from file list. It is not language dependent.\n";
1175                     push( @installer::globals::logfileinfo, $infoline);
1176                     $infoline = "INFO: It is not language dependent and can be ignored in language packs.\n";
1177                     push( @installer::globals::logfileinfo, $infoline);
1178
1179                     next;   # removing this file from list, if sourcepath is empty
1180                 }
1181             }
1182             else # special case for help packs
1183             {
1184                 if (( $onefile->{'ismultilingual'} ) || ( $styles =~ /\bFORCEHELPPACK\b/ ))
1185                 {
1186                     $infoline = "ERROR: Removing file $filename from file list.\n";
1187                     push( @installer::globals::logfileinfo, $infoline);
1188
1189                     push(@missingfiles, "ERROR: File not found: $filename\n");
1190                     $error_occurred = 1;
1191
1192                     next;   # removing this file from list, if sourcepath is empty
1193                 }
1194                 else
1195                 {
1196                     $infoline = "INFO: Removing file $filename from file list. It is not language dependent.\n";
1197                     push( @installer::globals::logfileinfo, $infoline);
1198                     $infoline = "INFO: It is not language dependent and can be ignored in help packs.\n";
1199                     push( @installer::globals::logfileinfo, $infoline);
1200
1201                     next;   # removing this file from list, if sourcepath is empty
1202                 }
1203            }
1204         }
1205
1206         push(@newfilesarray, $onefile);
1207     }
1208
1209     $infoline = "\n";
1210     push( @installer::globals::logfileinfo, $infoline);
1211
1212     if ( $error_occurred )
1213     {
1214         for ( my $i = 0; $i <= $#missingfiles; $i++ ) { print "$missingfiles[$i]"; }
1215         installer::exiter::exit_program("ERROR: Missing files", "remove_Files_Without_Sourcedirectory");
1216     }
1217
1218     return \@newfilesarray;
1219 }
1220
1221 ############################################################################
1222 # License and Readme files in the default language have to be installed
1223 # in the directory with flag OFFICEDIRECTORY. If this is not defined
1224 # they have to be installed in the installation root.
1225 ############################################################################
1226
1227 sub get_office_directory_gid_and_hostname
1228 {
1229     my ($dirsarrayref) = @_;
1230
1231     my $foundofficedir = 0;
1232     my $gid = "";
1233     my $hostname = "";
1234
1235     for ( my $i = 0; $i <= $#{$dirsarrayref}; $i++ )
1236     {
1237         my $onedir = ${$dirsarrayref}[$i];
1238         if ( $onedir->{'Styles'} )
1239         {
1240             my $styles = $onedir->{'Styles'};
1241
1242             if ( $styles =~ /\bOFFICEDIRECTORY\b/ )
1243             {
1244                 $foundofficedir = 1;
1245                 $gid = $onedir->{'gid'};
1246                 $hostname = $onedir->{'HostName'};
1247                 last;
1248             }
1249         }
1250     }
1251
1252     return ($foundofficedir, $gid, $hostname);
1253 }
1254
1255 ############################################################################
1256 # License and Readme files in the default language have to be installed
1257 # in the installation root (next to the program dir). This is in scp
1258 # project done by a post install basic script
1259 ############################################################################
1260
1261 sub add_License_Files_into_Installdir
1262 {
1263     my ($filesarrayref, $dirsarrayref, $languagesarrayref) = @_;
1264
1265     my $infoline;
1266
1267     my @newfilesarray = ();
1268
1269     my $defaultlanguage = installer::languages::get_default_language($languagesarrayref);
1270
1271     my ($foundofficedir, $officedirectorygid, $officedirectoryhostname) = get_office_directory_gid_and_hostname($dirsarrayref);
1272
1273     # copy all files from directory share/readme, that contain the default language in their name
1274     # without default language into the installation root. This makes the settings of the correct
1275     # file names superfluous. On the other hand this requires a dependency to the directory
1276     # share/readme
1277
1278     for ( my $i = 0; $i <= $#{$filesarrayref}; $i++ )
1279     {
1280         my $onefile = ${$filesarrayref}[$i];
1281         my $destination = $onefile->{'destination'};
1282         my $styles = "";
1283         if ( $onefile->{'Styles'} ) { $styles = $onefile->{'Styles'}; }
1284
1285         if ( ( $destination =~ /share\Q$installer::globals::separator\Ereadme\Q$installer::globals::separator\E(\w+?)_?$defaultlanguage\.?(\w*)\s*/ )
1286             || (( $styles =~ /\bROOTLICENSEFILE\b/ ) && ( $destination =~ /\Q$installer::globals::separator\E?(\w+?)_?$defaultlanguage\.?(\w*?)\s*$/ )) )
1287         {
1288             my $filename = $1;
1289             my $extension = $2;
1290
1291             my $newfilename;
1292
1293             if ( $extension eq "" ) { $newfilename = $filename; }
1294             else { $newfilename = $filename . "\." . $extension; }
1295
1296             my %newfile = ();
1297             my $newfile = \%newfile;
1298
1299             installer::converter::copy_item_object($onefile, $newfile);
1300
1301             $newfile->{'gid'} = $onefile->{'gid'} . "_Copy";
1302             $newfile->{'Name'} = $newfilename;
1303             $newfile->{'ismultilingual'} = "0";
1304             $newfile->{'specificlanguage'} = "";
1305             $newfile->{'haslanguagemodule'} = "0";
1306
1307             if ( defined $newfile->{'InstallName'} )
1308             {
1309                 if ( $newfile->{'InstallName'} =~ /^\s*(.*?)_$defaultlanguage\.?(\w*?)\s*$/ )
1310                 {
1311                     my $localfilename = $1;
1312                     my $localextension = $2;
1313
1314                     if ( $localextension eq "" ) { $newfile->{'InstallName'} = $localfilename; }
1315                     else { $newfile->{'InstallName'} = $localfilename . "\." . $localextension; }
1316                 }
1317             }
1318
1319             $newfile->{'removelangfromfile'} = "1"; # Important for files with an InstallName, because language also has to be removed there.
1320
1321             if ( $foundofficedir )
1322             {
1323                 $newfile->{'Dir'} = $officedirectorygid;
1324                 $newfile->{'destination'} = $officedirectoryhostname . $installer::globals::separator . $newfilename;
1325             }
1326             else
1327             {
1328                 $newfile->{'Dir'} = "PREDEFINED_PROGDIR";
1329                 $newfile->{'destination'} = $newfilename;
1330             }
1331
1332             # Also setting "modules=gid_Module_Root_Brand" (module with style: ROOT_BRAND_PACKAGE)
1333             if ( $installer::globals::rootbrandpackageset )
1334             {
1335                 $newfile->{'modules'} = $installer::globals::rootbrandpackage;
1336             }
1337
1338             push(@newfilesarray, $newfile);
1339
1340             $infoline = "New files: Adding file $newfilename for the installation root to the file list. Language: $defaultlanguage\n";
1341             push( @installer::globals::logfileinfo, $infoline);
1342
1343             if ( defined $newfile->{'InstallName'} )
1344             {
1345                 $infoline = "New files: Using installation name: $newfile->{'InstallName'}\n";
1346                 push( @installer::globals::logfileinfo, $infoline);
1347             }
1348         }
1349
1350         push(@newfilesarray, $onefile);
1351     }
1352
1353     return \@newfilesarray;
1354 }
1355
1356 ############################################################################
1357 # Some files are included for more than one language and have the same
1358 # name and the same destination directory for all languages. This would
1359 # lead to conflicts, if the filenames are not changed.
1360 # In scp project this files must have the flag MAKE_LANG_SPECIFIC
1361 # For this files, the language is included into the filename.
1362 ############################################################################
1363
1364 sub make_filename_language_specific
1365 {
1366     my ($filesarrayref) = @_;
1367
1368     my $infoline = "";
1369
1370     for ( my $i = 0; $i <= $#{$filesarrayref}; $i++ )
1371     {
1372         my $onefile = ${$filesarrayref}[$i];
1373
1374         if ( $onefile->{'ismultilingual'} )
1375         {
1376             my $styles = "";
1377             if ( $onefile->{'Styles'} ) { $styles = $onefile->{'Styles'}; }
1378             if ( $styles =~ /\bMAKE_LANG_SPECIFIC\b/ )
1379             {
1380                 my $language = $onefile->{'specificlanguage'};
1381                 my $olddestination = $onefile->{'destination'};
1382                 my $oldname = $onefile->{'Name'};
1383
1384                 # Including the language into the file name.
1385                 # But be sure, to include the language before the file extension.
1386
1387                 my $fileextension = "";
1388
1389                 if ( $onefile->{'Name'} =~ /(\.\w+?)\s*$/ ) { $fileextension = $1; }
1390                 if ( $fileextension ne "" )
1391                 {
1392                     $onefile->{'Name'} =~ s/\Q$fileextension\E\s*$/_$language$fileextension/;
1393                     $onefile->{'destination'} =~ s/\Q$fileextension\E\s*$/_$language$fileextension/;
1394                 }
1395
1396                 $infoline = "Flag MAKE_LANG_SPECIFIC:\n";
1397                 push( @installer::globals::logfileinfo, $infoline);
1398                 $infoline = "Changing name from $oldname to $onefile->{'Name'} !\n";
1399                 push( @installer::globals::logfileinfo, $infoline);
1400                 $infoline = "Changing destination from $olddestination to $onefile->{'destination'} !\n";
1401                 push( @installer::globals::logfileinfo, $infoline);
1402             }
1403         }
1404     }
1405 }
1406
1407 ############################################################################
1408 # Because of the item "File" the source name must be "Name". Therefore
1409 # "Copy" is changed to "Name" and "Name" is changed to "DestinationName".
1410 ############################################################################
1411
1412 sub change_keys_of_scpactions
1413 {
1414     my ($itemsarrayref) = @_;
1415
1416     for ( my $i = 0; $i <= $#{$itemsarrayref}; $i++ )
1417     {
1418         my $oneitem = ${$itemsarrayref}[$i];
1419
1420         my $key;
1421
1422         # First Name to DestinationName, then deleting Name
1423         foreach $key (keys %{$oneitem})
1424         {
1425             if ( $key =~ /\bName\b/ )
1426             {
1427                 my $value = $oneitem->{$key};
1428                 my $oldkey = $key;
1429                 $key =~ s/Name/DestinationName/;
1430                 $oneitem->{$key} = $value;
1431                 delete($oneitem->{$oldkey});
1432             }
1433         }
1434
1435         # Second Copy to Name, then deleting Copy
1436         foreach $key (keys %{$oneitem})
1437         {
1438             if ( $key =~ /\bCopy\b/ )
1439             {
1440                 my $value = $oneitem->{$key};
1441                 my $oldkey = $key;
1442                 $key =~ s/Copy/Name/;
1443                 $oneitem->{$key} = $value;
1444                 delete($oneitem->{$oldkey});
1445             }
1446         }
1447     }
1448 }
1449
1450 ############################################################################
1451 # Removing all language pack files from installation set (files with
1452 # the style LANGUAGEPACK), except this is a language pack.
1453 ############################################################################
1454
1455 sub remove_Languagepacklibraries_from_Installset
1456 {
1457     my ($itemsarrayref) = @_;
1458
1459     my $infoline;
1460
1461     my @newitemsarray = ();
1462
1463     for ( my $i = 0; $i <= $#{$itemsarrayref}; $i++ )
1464     {
1465         my $oneitem = ${$itemsarrayref}[$i];
1466         my $styles = "";
1467         if ( $oneitem->{'Styles'} ) { $styles = $oneitem->{'Styles'}; }
1468
1469         if ( $styles =~ /\bLANGUAGEPACK\b/ )
1470         {
1471             $infoline = "Removing language pack file $oneitem->{'gid'} from the installation set.\n";
1472             push( @installer::globals::globallogfileinfo, $infoline);
1473
1474             next;
1475         }
1476
1477         push(@newitemsarray, $oneitem);
1478     }
1479
1480     $infoline = "\n";
1481     push( @installer::globals::globallogfileinfo, $infoline);
1482
1483     return \@newitemsarray;
1484 }
1485
1486 ############################################################################
1487 # Removing all help pack files from installation set (files with
1488 # the style HELPPACK), except this is a help pack.
1489 ############################################################################
1490
1491 sub remove_Helppacklibraries_from_Installset
1492 {
1493     my ($itemsarrayref) = @_;
1494
1495     my $infoline;
1496
1497     my @newitemsarray = ();
1498
1499     for ( my $i = 0; $i <= $#{$itemsarrayref}; $i++ )
1500     {
1501         my $oneitem = ${$itemsarrayref}[$i];
1502         my $styles = "";
1503         if ( $oneitem->{'Styles'} ) { $styles = $oneitem->{'Styles'}; }
1504
1505         if ( $styles =~ /\bHELPPACK\b/ )
1506         {
1507             $infoline = "Removing help pack file $oneitem->{'gid'} from the installation set.\n";
1508             push( @installer::globals::globallogfileinfo, $infoline);
1509
1510             next;
1511         }
1512
1513         push(@newitemsarray, $oneitem);
1514     }
1515
1516     $infoline = "\n";
1517     push( @installer::globals::globallogfileinfo, $infoline);
1518
1519     return \@newitemsarray;
1520 }
1521
1522 ############################################################################
1523 # Some files contain a $ in their name. epm conflicts with such files.
1524 # Solution: Renaming this files, converting "$" to "$$"
1525 ############################################################################
1526
1527 sub quoting_illegal_filenames
1528 {
1529     my ($filesarrayref) = @_;
1530
1531     # This function has to be removed as soon as possible!
1532
1533     installer::logger::include_header_into_logfile("Renaming illegal filenames:");
1534
1535     for ( my $i = 0; $i <= $#{$filesarrayref}; $i++ )
1536     {
1537         my $onefile = ${$filesarrayref}[$i];
1538         my $filename = $onefile->{'Name'};
1539
1540         if ( $filename =~ /\$/ )
1541         {
1542             my $sourcepath = $onefile->{'sourcepath'};
1543             my $destpath = $onefile->{'destination'};
1544
1545             # sourcepath and destination have to be quoted for epm list file
1546
1547             $destpath =~ s/\$/\$\$/g;
1548             $sourcepath =~ s/\$/\$\$/g;
1549
1550             my $infoline = "ATTENTION: Files: Quoting sourcepath $onefile->{'sourcepath'} to $sourcepath\n";
1551             push( @installer::globals::logfileinfo, $infoline);
1552             $infoline = "ATTENTION: Files: Quoting destination path $onefile->{'destination'} to $destpath\n";
1553             push( @installer::globals::logfileinfo, $infoline);
1554
1555             $onefile->{'sourcepath'} = $sourcepath;
1556             $onefile->{'destination'} = $destpath;
1557         }
1558     }
1559 }
1560
1561 ############################################################################
1562 # Removing multiple occurrences of same module.
1563 ############################################################################
1564
1565 sub optimize_list
1566 {
1567     my ( $longlist ) = @_;
1568     my %tmpHash;
1569
1570     $longlist =~ s/^\s+//;
1571     $longlist =~ s/\s+$//;
1572     $longlist =~ s/\s*,\s*/,/g;
1573
1574     @tmpHash{split /,/, $longlist} = ();
1575     return join(",", sort keys %tmpHash);
1576 }
1577
1578 ###############################################################################
1579 # Add a directory with CREATE flag; save styles for already added directories
1580 ###############################################################################
1581
1582 sub add_directory_with_create_flag_hash
1583 {
1584     my ($alldirectoryhash, $directoryname, $specificlanguage, $gid, $styles, $modules) = @_;
1585     if ( ! $directoryname ) { installer::exiter::exit_program("No directory name (HostName) set for specified language in gid $gid", "add_directory_with_create_flag_hash"); }
1586     my $origdirectoryname = $directoryname;
1587     my $newdirincluded = 0;
1588     if ( $styles =~ /\bCREATE\b/ )
1589     {
1590         if ( ! $modules ) { installer::exiter::exit_program("No assigned modules found for directory $directoryname", "add_directory_with_create_flag_hash"); }
1591         if (!(exists($alldirectoryhash->{$directoryname})))
1592         {
1593             my %directoryhash = ();
1594             $directoryhash{'HostName'} = $directoryname;
1595             $directoryhash{'specificlanguage'} = $specificlanguage;
1596             $directoryhash{'Dir'} = $gid;
1597             $directoryhash{'Styles'} = $styles;
1598
1599             # saving also the modules
1600             $directoryhash{'modules'} = $modules;
1601
1602             $alldirectoryhash->{$directoryname} = \%directoryhash;
1603             $newdirincluded = 1;
1604
1605             # Problem: The $destinationpath can be share/registry/schema/org/openoffice
1606             # but not all directories contain files and will be added to this list.
1607             # Therefore the path has to be analyzed.
1608
1609             while ( $directoryname =~ /(^.*\S)\Q$installer::globals::separator\E(\S.*?)\s*$/ )  # as long as the path contains slashes
1610             {
1611                 $directoryname = $1;
1612
1613                 if (!(exists($alldirectoryhash->{$directoryname})))
1614                 {
1615                     my %directoryhash = ();
1616
1617                     $directoryhash{'HostName'} = $directoryname;
1618                     $directoryhash{'specificlanguage'} = $specificlanguage;
1619                     $directoryhash{'Dir'} = $gid;
1620                     if ( ! $installer::globals::iswindowsbuild ) { $directoryhash{'Styles'} = "(CREATE)"; } # Exception for Windows?
1621
1622                     # saving also the modules
1623                     $directoryhash{'modules'} = $modules;
1624
1625                     $alldirectoryhash->{$directoryname} = \%directoryhash;
1626                 }
1627                 else
1628                 {
1629                     # Adding the modules to the module list!
1630                     $alldirectoryhash->{$directoryname}->{'modules'} = $alldirectoryhash->{$directoryname}->{'modules'} . "," . $modules;
1631                 }
1632             }
1633         }
1634         else
1635         {
1636             # Adding the modules to the module list!
1637             $alldirectoryhash->{$directoryname}->{'modules'} = $alldirectoryhash->{$directoryname}->{'modules'} . "," . $modules;
1638
1639             while ( $directoryname =~ /(^.*\S)\Q$installer::globals::separator\E(\S.*?)\s*$/ )  # as long as the path contains slashes
1640             {
1641                 $directoryname = $1;
1642                 # Adding the modules to the module list!
1643                 $alldirectoryhash->{$directoryname}->{'modules'} = $alldirectoryhash->{$directoryname}->{'modules'} . "," . $modules;
1644             }
1645         }
1646     }
1647
1648     # Saving the styles for already added directories in function collect_directories_from_filesarray
1649
1650     if (( ! $newdirincluded ) && ( $styles ne "" ))
1651     {
1652         $styles =~ s/\bWORKSTATION\b//;
1653         $styles =~ s/\bCREATE\b//;
1654
1655         if (( ! ( $styles =~ /^\s*\(\s*\)\s*$/ )) && ( ! ( $styles =~ /^\s*\(\s*\,\s*\)\s*$/ )) && ( ! ( $styles =~ /^\s*$/ ))) # checking, if there are styles left
1656         {
1657             $directoryname = $origdirectoryname;
1658
1659             if ( exists($alldirectoryhash->{$directoryname}) )
1660             {
1661                 $alldirectoryhash->{$directoryname}->{'Styles'} = $styles;
1662             }
1663         }
1664     }
1665
1666     return $alldirectoryhash;
1667 }
1668
1669 #######################################################################
1670 # Collecting all directories needed for the epm list
1671 # 1. Looking for all destination paths in the files array
1672 # 2. Looking for directories with CREATE flag in the directory array
1673 #######################################################################
1674
1675 ##################################
1676 # Collecting directories: Part 1
1677 ##################################
1678
1679 sub collect_directories_from_filesarray
1680 {
1681     my ($filesarrayref, $unixlinksarrayref) = @_;
1682
1683     my %alldirectoryhash = ();
1684     my @filteredfilesarray = (); # without empty directories
1685     foreach my $onefile (@{$filesarrayref})
1686     {
1687         # The "file" can actually be an empty directory added e.g. by gb_Package_add_empty_directory.
1688         # TODO/LATER: it would be better if gb_Package_add_empty_directory added empty directories to
1689         # "directories with CREATE flag" instead of a filelist.
1690         if (-d $onefile->{'sourcepath'})
1691         {
1692             # Do the same as collect_directories_with_create_flag_from_directoryarray does
1693             %alldirectoryhash = %{add_directory_with_create_flag_hash(\%alldirectoryhash, $onefile->{'destination'}, $onefile->{'specificlanguage'}, $onefile->{'gid'}, "(CREATE)", $onefile->{'modules'})};
1694         }
1695         else { push(@filteredfilesarray, $onefile); }
1696     }
1697
1698     # Preparing this already as hash, although the only needed value at the moment is the HostName
1699     # But also adding: "specificlanguage" and "Dir" (for instance gid_Dir_Program)
1700
1701     foreach my $onefile (@filteredfilesarray, @{$unixlinksarrayref})
1702     {
1703         my $destinationpath = $onefile->{'destination'};
1704
1705         installer::pathanalyzer::get_path_from_fullqualifiedname(\$destinationpath);
1706         $destinationpath =~ s/\Q$installer::globals::separator\E\s*$//;     # removing ending slashes or backslashes
1707
1708         do
1709         {
1710             if (!exists($alldirectoryhash{$destinationpath}))
1711             {
1712                 my %directoryhash = ();
1713                 $directoryhash{'HostName'} = $destinationpath;
1714                 $directoryhash{'specificlanguage'} = $onefile->{'specificlanguage'};
1715                 $directoryhash{'Dir'} = $onefile->{'Dir'};
1716                 $directoryhash{'modules'} = $onefile->{'modules'}; # NEW, saving modules
1717                 $directoryhash{'gid'} = $onefile->{'gid'};
1718
1719                 $alldirectoryhash{$destinationpath} = \%directoryhash;
1720             }
1721             else
1722             {
1723                 # Adding the modules to the module list!
1724                 $alldirectoryhash{$destinationpath}->{'modules'} .= "," . $onefile->{'modules'};
1725                 # Save file's gid iff this directory appears in only a single
1726                 # file's FILELIST (so that unused directories will be filtered
1727                 # out in remove_not_required_spellcheckerlanguage_files, based
1728                 # on gid):
1729                 if ($alldirectoryhash{$destinationpath}->{'gid'}
1730                     ne $onefile->{'gid'})
1731                 {
1732                     $alldirectoryhash{$destinationpath}->{'gid'} = '';
1733                 }
1734             }
1735         } while ($destinationpath =~ s/(^.*\S)\Q$installer::globals::separator\E(\S.*?)\s*$/$1/);  # as long as the path contains slashes
1736     }
1737
1738     # Creating directory array
1739     foreach my $destdir ( keys %alldirectoryhash )
1740     {
1741         $alldirectoryhash{$destdir}->{'modules'} = optimize_list($alldirectoryhash{$destdir}->{'modules'});
1742     }
1743
1744     @_[0] = \@filteredfilesarray; # out argument
1745     return \%alldirectoryhash;
1746 }
1747
1748 ##################################
1749 # Collecting directories: Part 2
1750 ##################################
1751
1752 sub collect_directories_with_create_flag_from_directoryarray
1753 {
1754     my ($directoryarrayref, $alldirectoryhash) = @_;
1755
1756     my @alldirectories = ();
1757
1758     foreach my $onedir (@{$directoryarrayref})
1759     {
1760         $alldirectoryhash = add_directory_with_create_flag_hash($alldirectoryhash, $onedir->{'HostName'}, $onedir->{'specificlanguage'}, $onedir->{'gid'}, $onedir->{'Styles'}, $onedir->{'modules'});
1761     }
1762
1763     # Creating directory array
1764     foreach my $destdir ( sort keys %{$alldirectoryhash} )
1765     {
1766         $alldirectoryhash->{$destdir}->{'modules'} = optimize_list($alldirectoryhash->{$destdir}->{'modules'});
1767         push(@alldirectories, $alldirectoryhash->{$destdir});
1768     }
1769
1770     return \@alldirectories;
1771 }
1772
1773 #################################################
1774 # Determining the destination file of a link
1775 #################################################
1776
1777 sub get_destination_file_path_for_links
1778 {
1779     my ($linksarrayref, $filesarrayref) = @_;
1780
1781     my $infoline;
1782
1783     for ( my $i = 0; $i <= $#{$linksarrayref}; $i++ )
1784     {
1785         my $fileid = "";
1786         my $onelink = ${$linksarrayref}[$i];
1787         if ( $onelink->{'FileID'} ) { $fileid = $onelink->{'FileID'}; }
1788
1789         if (!( $fileid eq "" ))
1790         {
1791             my $foundfile = 0;
1792
1793             for ( my $j = 0; $j <= $#{$filesarrayref}; $j++ )
1794             {
1795                 my $onefile = ${$filesarrayref}[$j];
1796                 my $filegid = $onefile->{'gid'};
1797
1798                 if ( $filegid eq $fileid )
1799                 {
1800                     $foundfile = 1;
1801                     $onelink->{'destinationfile'} = $onefile->{'destination'};
1802                     last;
1803                 }
1804             }
1805
1806             if (!($foundfile))
1807             {
1808                 $infoline = "Warning: FileID $fileid for Link $onelink->{'gid'} not found!\n";
1809                 push( @installer::globals::logfileinfo, $infoline);
1810             }
1811         }
1812     }
1813
1814     $infoline = "\n";
1815     push( @installer::globals::logfileinfo, $infoline);
1816 }
1817
1818 #################################################
1819 # Determining the destination link of a link
1820 #################################################
1821
1822 sub get_destination_link_path_for_links
1823 {
1824     my ($linksarrayref) = @_;
1825
1826     my $infoline;
1827
1828     for ( my $i = 0; $i <= $#{$linksarrayref}; $i++ )
1829     {
1830         my $shortcutid = "";
1831         my $onelink = ${$linksarrayref}[$i];
1832         if ( $onelink->{'ShortcutID'} ) { $shortcutid = $onelink->{'ShortcutID'}; }
1833
1834         if (!( $shortcutid eq "" ))
1835         {
1836             my $foundlink = 0;
1837
1838             for ( my $j = 0; $j <= $#{$linksarrayref}; $j++ )
1839             {
1840                 my $destlink = ${$linksarrayref}[$j];
1841                 my $shortcutgid = $destlink->{'gid'};
1842
1843                 if ( $shortcutgid eq $shortcutid )
1844                 {
1845                     $foundlink = 1;
1846                     $onelink->{'destinationfile'} = $destlink->{'destination'};     # making key 'destinationfile'
1847                     last;
1848                 }
1849             }
1850
1851             if (!($foundlink))
1852             {
1853                 $infoline = "Warning: ShortcutID $shortcutid for Link $onelink->{'gid'} not found!\n";
1854                 push( @installer::globals::logfileinfo, $infoline);
1855             }
1856         }
1857     }
1858
1859     $infoline = "\n";
1860     push( @installer::globals::logfileinfo, $infoline);
1861 }
1862
1863 ###################################################################################
1864 # Items with flag WORKSTATION are not needed (here: links and configurationitems)
1865 ###################################################################################
1866
1867 sub remove_workstation_only_items
1868 {
1869     my ($itemarrayref) = @_;
1870
1871     my @newitemarray = ();
1872
1873     for ( my $i = 0; $i <= $#{$itemarrayref}; $i++ )
1874     {
1875         my $oneitem = ${$itemarrayref}[$i];
1876         my $styles = $oneitem->{'Styles'};
1877
1878         if (( $styles =~ /\bWORKSTATION\b/ ) &&
1879             (!( $styles =~ /\bNETWORK\b/ )) &&
1880             (!( $styles =~ /\bSTANDALONE\b/ )))
1881         {
1882             next;   # removing this link, it is only needed for a workstation installation
1883         }
1884
1885         push(@newitemarray, $oneitem);
1886     }
1887
1888     return \@newitemarray;
1889 }
1890
1891 ################################################
1892 # Resolving relative path in links
1893 ################################################
1894
1895 sub resolve_links_with_flag_relative
1896 {
1897     my ($linksarrayref) = @_;
1898
1899     # Before this step is:
1900     # destination=program/libsalhelperC52.so.3, this will be the name of the link
1901     # destinationfile=program/libsalhelperC52.so.3, this will be the linked file or name
1902     # If the flag RELATIVE is set, the paths have to be analyzed. If the flag is not set
1903     # (this will not occur in the future?) destinationfile has to be an absolute path name
1904
1905     for ( my $i = 0; $i <= $#{$linksarrayref}; $i++ )
1906     {
1907         my $onelink = ${$linksarrayref}[$i];
1908         my $styles = $onelink->{'Styles'};
1909
1910         if ( $styles =~ /\bRELATIVE\b/ )
1911         {
1912             # ToDo: This is only a simple not sufficient mechanism
1913
1914             my $destination = $onelink->{'destination'};
1915             my $destinationfile = $onelink->{'destinationfile'};
1916
1917             my $destinationpath = $destination;
1918
1919             installer::pathanalyzer::get_path_from_fullqualifiedname(\$destinationpath);
1920
1921             my $destinationfilepath = $destinationfile;
1922
1923             # it is possible, that the destinationfile is no longer part of the files collector
1924             if ($destinationfilepath) { installer::pathanalyzer::get_path_from_fullqualifiedname(\$destinationfilepath); }
1925             else { $destinationfilepath = ""; }
1926
1927             if ( $destinationpath eq $destinationfilepath )
1928             {
1929                 # link and file are in the same directory
1930                 # Therefore the path of the file can be removed
1931
1932                 my $newdestinationfile = $destinationfile;
1933                 installer::pathanalyzer::make_absolute_filename_to_relative_filename(\$newdestinationfile);
1934
1935                 $onelink->{'destinationfile'} = $newdestinationfile;
1936             }
1937         }
1938     }
1939 }
1940
1941 ########################################################################
1942 # This function is a helper of function "assigning_modules_to_items"
1943 ########################################################################
1944
1945 sub insert_for_item ($$$)
1946 {
1947     my ($hash, $item, $id) = @_;
1948
1949     if (!defined $hash->{$item})
1950     {
1951         my @gids = ();
1952         $hash->{$item} = \@gids;
1953     }
1954     my $gid_list = $hash->{$item};
1955     push @{$gid_list}, $id;
1956     $hash->{$item} = $gid_list;
1957 }
1958
1959 sub build_modulegids_table
1960 {
1961     my ($modulesref, $itemname) = @_;
1962
1963     my %module_lookup_table = ();
1964
1965     # build map of item names to list of respective module gids
1966     # containing these items
1967     for my $onemodule (@{$modulesref})
1968     {
1969         next if ( ! defined $onemodule->{$itemname} );
1970         # these are the items contained in this module
1971         # eg. Files = (gid_a_b_c,gid_d_e_f)
1972         my $module_gids = $onemodule->{$itemname};
1973
1974         # prune outer brackets
1975         $module_gids =~ s|^\s*\(||g;
1976         $module_gids =~ s|\)\s*$||g;
1977         for my $id (split (/,/, $module_gids))
1978         {
1979             chomp $id;
1980             insert_for_item(\%module_lookup_table, lc ($id), $onemodule->{'gid'});
1981         }
1982     }
1983
1984     return \%module_lookup_table;
1985 }
1986
1987 ########################################################################
1988 # Items like files do not know their modules
1989 # This function is a helper of function "assigning_modules_to_items"
1990 ########################################################################
1991
1992 sub get_string_of_modulegids_for_itemgid
1993 {
1994     my ($module_lookup_table, $modulesref, $itemgid, $itemname) = @_;
1995
1996     my $allmodules = "";
1997     my $haslanguagemodule = 0;
1998     my %foundmodules = ();
1999
2000     my $gid_list = $module_lookup_table->{lc($itemgid)};
2001
2002     for my $gid (@{$gid_list})
2003     {
2004         $foundmodules{$gid} = 1;
2005         $allmodules = $allmodules . "," . $gid;
2006         # Is this module a language module? This info should be stored at the file.
2007         if ( exists($installer::globals::alllangmodules{$gid}) ) { $haslanguagemodule = 1; }
2008      }
2009
2010     $allmodules =~ s/^\s*\,//;  # removing leading comma
2011
2012     # Check: All modules or no module must have flag LANGUAGEMODULE
2013     if ( $haslanguagemodule )
2014     {
2015         my $isreallylanguagemodule = _key_in_a_is_also_key_in_b(\%foundmodules, \%installer::globals::alllangmodules);
2016         if ( ! $isreallylanguagemodule ) { installer::exiter::exit_program("ERROR: \"$itemgid\" is assigned to modules with flag \"LANGUAGEMODULE\" and also to modules without this flag! Modules: $allmodules", "get_string_of_modulegids_for_itemgid");  }
2017     }
2018
2019     return ($allmodules, $haslanguagemodule);
2020 }
2021
2022 ########################################################
2023 # Items like files do not know their modules
2024 # This function add the {'modules'} to these items
2025 ########################################################
2026
2027 sub assigning_modules_to_items
2028 {
2029     my ($modulesref, $itemsref, $itemname) = @_;
2030
2031     my $infoline = "";
2032     my $languageassignmenterror = 0;
2033     my @languageassignmenterrors = ();
2034
2035     my $module_lookup_table = build_modulegids_table($modulesref, $itemname);
2036
2037     for my $oneitem (@{$itemsref})
2038     {
2039         my $itemgid = $oneitem->{'gid'};
2040
2041         my $styles = "";
2042         if ( $oneitem->{'Styles'} ) { $styles = $oneitem->{'Styles'}; }
2043         if (( $itemname eq "Dirs" ) && ( ! ( $styles =~ /\bCREATE\b/ ))) { next; }
2044
2045         if ( $itemgid eq "" )
2046         {
2047             installer::exiter::exit_program("ERROR in item collection: No gid for item $oneitem->{'Name'}", "assigning_modules_to_items");
2048         }
2049
2050         # every item can belong to many modules
2051
2052         my ($modulegids, $haslanguagemodule) = get_string_of_modulegids_for_itemgid($module_lookup_table, $modulesref, $itemgid, $itemname);
2053
2054         if ($modulegids eq "")
2055         {
2056             installer::exiter::exit_program("ERROR in file collection: No module found for $itemname $itemgid", "assigning_modules_to_items");
2057         }
2058
2059         $oneitem->{'modules'} = $modulegids;
2060         $oneitem->{'haslanguagemodule'} = $haslanguagemodule;
2061
2062         # Important check: "ismultilingual" and "haslanguagemodule" must have the same value !
2063         if (( $oneitem->{'ismultilingual'} ) && ( ! $oneitem->{'haslanguagemodule'} ))
2064         {
2065             $infoline = "Error: \"$oneitem->{'gid'}\" is multi lingual, but not in language pack (Assigned module: $modulegids)!\n";
2066             push( @installer::globals::globallogfileinfo, $infoline);
2067             push( @languageassignmenterrors, $infoline );
2068             $languageassignmenterror = 1;
2069         }
2070         if (( $oneitem->{'haslanguagemodule'} ) && ( ! $oneitem->{'ismultilingual'} ))
2071         {
2072             $infoline = "Error: \"$oneitem->{'gid'}\" is in language pack, but not multi lingual (Assigned module: $modulegids)!\n";
2073             push( @installer::globals::globallogfileinfo, $infoline);
2074             push( @languageassignmenterrors, $infoline );
2075             $languageassignmenterror = 1;
2076         }
2077     }
2078
2079     if ($languageassignmenterror)
2080     {
2081         for ( my $i = 0; $i <= $#languageassignmenterrors; $i++ ) { print "$languageassignmenterrors[$i]"; }
2082         installer::exiter::exit_program("ERROR: Incorrect assignments for language packs.", "assigning_modules_to_items");
2083     }
2084
2085 }
2086
2087 #################################################################################################
2088 # Root path (for instance /opt/openofficeorg20) needs to be added to directories, files and links
2089 #################################################################################################
2090
2091 sub add_rootpath_to_directories
2092 {
2093     my ($dirsref, $rootpath) = @_;
2094
2095     for ( my $i = 0; $i <= $#{$dirsref}; $i++ )
2096     {
2097         my $onedir = ${$dirsref}[$i];
2098         my $dir = "";
2099
2100         if ( $onedir->{'Dir'} ) { $dir = $onedir->{'Dir'}; }
2101
2102         if (!($dir =~ /\bPREDEFINED_/ ))
2103         {
2104             my $hostname = $onedir->{'HostName'};
2105             $hostname = $rootpath . $installer::globals::separator . $hostname;
2106             $onedir->{'HostName'} = $hostname;
2107         }
2108
2109         # added
2110
2111         if ( $dir =~ /\bPREDEFINED_PROGDIR\b/ )
2112         {
2113             my $hostname = $onedir->{'HostName'};
2114             if ( $hostname eq "" ) { $onedir->{'HostName'} = $rootpath; }
2115             else { $onedir->{'HostName'} = $rootpath . $installer::globals::separator . $hostname; }
2116         }
2117     }
2118 }
2119
2120 sub add_rootpath_to_files
2121 {
2122     my ($filesref, $rootpath) = @_;
2123
2124     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
2125     {
2126         my $onefile = ${$filesref}[$i];
2127         my $destination = $onefile->{'destination'};
2128         $destination = $rootpath . $installer::globals::separator . $destination;
2129         $onefile->{'destination'} = $destination;
2130     }
2131 }
2132
2133 sub add_rootpath_to_links
2134 {
2135     my ($linksref, $rootpath) = @_;
2136
2137     for ( my $i = 0; $i <= $#{$linksref}; $i++ )
2138     {
2139         my $onelink = ${$linksref}[$i];
2140         my $styles = $onelink->{'Styles'};
2141
2142         my $destination = $onelink->{'destination'};
2143         $destination = $rootpath . $installer::globals::separator . $destination;
2144         $onelink->{'destination'} = $destination;
2145
2146         if (!($styles =~ /\bRELATIVE\b/ )) # for absolute links
2147         {
2148             my $destinationfile = $onelink->{'destinationfile'};
2149             $destinationfile = $rootpath . $installer::globals::separator . $destinationfile;
2150             $onelink->{'destinationfile'} = $destinationfile;
2151         }
2152     }
2153 }
2154
2155 #################################################################################
2156 # Collecting all parent gids
2157 #################################################################################
2158
2159 sub collect_all_parent_feature
2160 {
2161     my ($modulesref) = @_;
2162
2163     my @allparents = ();
2164
2165     my $found_root_module = 0;
2166
2167     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
2168     {
2169         my $onefeature = ${$modulesref}[$i];
2170
2171         my $parentgid = "";
2172         if ( $onefeature->{'ParentID'} )
2173         {
2174             $parentgid = $onefeature->{'ParentID'};
2175         }
2176
2177         if ( $parentgid ne "" )
2178         {
2179             if (! grep {$_ eq $parentgid} @allparents)
2180             {
2181                 push(@allparents, $parentgid);
2182             }
2183         }
2184
2185         # Setting the global root module
2186
2187         if ( $parentgid eq "" )
2188         {
2189             if ( $found_root_module ) { installer::exiter::exit_program("ERROR: Only one module without ParentID or with empty ParentID allowed ($installer::globals::rootmodulegid, $onefeature->{'gid'}).", "collect_all_parent_feature"); }
2190             $installer::globals::rootmodulegid = $onefeature->{'gid'};
2191             $found_root_module = 1;
2192             my $infoline = "Setting Root Module: $installer::globals::rootmodulegid\n";
2193             push( @installer::globals::globallogfileinfo, $infoline);
2194         }
2195
2196         if ( ! $found_root_module ) { installer::exiter::exit_program("ERROR: Could not define root module. No module without ParentID or with empty ParentID exists.", "collect_all_parent_feature"); }
2197
2198     }
2199
2200     return \@allparents;
2201 }
2202
2203 #################################################################################
2204 # Checking for every feature, whether it has children
2205 #################################################################################
2206
2207 sub set_children_flag
2208 {
2209     my ($modulesref) = @_;
2210
2211     my $allparents = collect_all_parent_feature($modulesref);
2212
2213     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
2214     {
2215         my $onefeature = ${$modulesref}[$i];
2216         my $gid = $onefeature->{'gid'};
2217
2218         # is this gid a parent?
2219
2220         if ( grep {$_ eq $gid} @{$allparents} )
2221         {
2222             $onefeature->{'has_children'} = 1;
2223         }
2224         else
2225         {
2226             $onefeature->{'has_children'} = 0;
2227         }
2228     }
2229 }
2230
2231 #################################################################################
2232 # All modules, that use a template module, do now get the assignments of
2233 # the template module.
2234 #################################################################################
2235
2236 sub resolve_assigned_modules
2237 {
2238     my ($modulesref) = @_;
2239
2240     # collecting all template modules
2241
2242     my %directaccess = ();
2243
2244     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
2245     {
2246         my $onefeature = ${$modulesref}[$i];
2247         my $styles = "";
2248         if ( $onefeature->{'Styles'} ) { $styles = $onefeature->{'Styles'}; }
2249         if ( $styles =~ /\bTEMPLATEMODULE\b/ ) { $directaccess{$onefeature->{'gid'}} = $onefeature; }
2250
2251         # also looking for module with flag ROOT_BRAND_PACKAGE, to save is for further usage
2252         if ( $styles =~ /\bROOT_BRAND_PACKAGE\b/ )
2253         {
2254             $installer::globals::rootbrandpackage = $onefeature->{'gid'};
2255             $installer::globals::rootbrandpackageset = 1;
2256         }
2257     }
2258
2259     # looking, where template modules are assigned
2260
2261     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
2262     {
2263         my $onefeature = ${$modulesref}[$i];
2264         if ( $onefeature->{'Assigns'} )
2265         {
2266             my $templategid = $onefeature->{'Assigns'};
2267
2268             if ( ! exists($directaccess{$templategid}) )
2269             {
2270                 installer::exiter::exit_program("ERROR: Did not find definition of assigned template module \"$templategid\"", "resolve_assigned_modules");
2271             }
2272
2273             # Currently no merging of Files, Dirs, ...
2274             # This has to be included here, if it is required
2275             my @items_at_modules = ("Files", "Dirs", "Unixlinks");
2276             for my $item (@items_at_modules)
2277             {
2278                 if ( exists($directaccess{$templategid}->{$item}) ) { $onefeature->{$item} = $directaccess{$templategid}->{$item}; }
2279             }
2280         }
2281     }
2282 }
2283
2284 #################################################################################
2285 # Removing the template modules from the list, after all
2286 # assignments are transferred to the "real" modules.
2287 #################################################################################
2288
2289 sub remove_template_modules
2290 {
2291     my ($modulesref) = @_;
2292
2293     my @modules = ();
2294
2295     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
2296     {
2297         my $onefeature = ${$modulesref}[$i];
2298         my $styles = "";
2299         if ( $onefeature->{'Styles'} ) { $styles = $onefeature->{'Styles'}; }
2300         if ( $styles =~ /\bTEMPLATEMODULE\b/ ) { next; }
2301
2302         push(@modules, $onefeature);
2303     }
2304
2305     return \@modules;
2306 }
2307
2308 #################################################################################
2309 # Collecting all modules with flag LANGUAGEMODULE in a global
2310 # collector.
2311 #################################################################################
2312
2313 sub collect_all_languagemodules
2314 {
2315     my ($modulesref) = @_;
2316
2317     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
2318     {
2319         my $onefeature = ${$modulesref}[$i];
2320         my $styles = "";
2321         if ( $onefeature->{'Styles'} ) { $styles = $onefeature->{'Styles'}; }
2322         if ( $styles =~ /\bLANGUAGEMODULE\b/ )
2323         {
2324             if ( ! exists($onefeature->{'Language'}) ) { installer::exiter::exit_program("ERROR: \"$onefeature->{'gid'}\" has flag LANGUAGEMODULE, but does not know its language!", "collect_all_languagemodules"); }
2325             $installer::globals::alllangmodules{$onefeature->{'gid'}} = $onefeature->{'Language'};
2326             # Collecting also the english names, that are used for nsis unpack directory for language packs
2327             my $lang = $onefeature->{'Language'};
2328             my $name = "";
2329             foreach my $localkey ( keys %{$onefeature} )
2330             {
2331                 if ( $localkey =~ /^\s*Name\s*\(\s*en-US\s*\)\s*$/ )
2332                 {
2333                     $installer::globals::all_english_languagestrings{$lang} = $onefeature->{$localkey};
2334                 }
2335             }
2336         }
2337     }
2338 }
2339
2340 #################################################################################
2341 # Selecting from all collected english language strings those, that are really
2342 # required in this installation set.
2343 #################################################################################
2344
2345 sub select_required_language_strings
2346 {
2347     my ($modulesref) = @_;
2348
2349     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
2350     {
2351         my $onefeature = ${$modulesref}[$i];
2352         my $styles = "";
2353         if ( $onefeature->{'Styles'} ) { $styles = $onefeature->{'Styles'}; }
2354         if ( $styles =~ /\bLANGUAGEMODULE\b/ )
2355         {
2356             if ( ! exists($onefeature->{'Language'}) ) { installer::exiter::exit_program("ERROR: \"$onefeature->{'gid'}\" has flag LANGUAGEMODULE, but does not know its language!", "select_required_language_strings"); }
2357             my $lang = $onefeature->{'Language'};
2358
2359             if (( exists($installer::globals::all_english_languagestrings{$lang}) ) && ( ! exists($installer::globals::all_required_english_languagestrings{$lang}) ))
2360             {
2361                 $installer::globals::all_required_english_languagestrings{$lang} = $installer::globals::all_english_languagestrings{$lang};
2362             }
2363         }
2364     }
2365 }
2366
2367 ################################################
2368 # Controlling that all keys in hash A are
2369 # also key in hash B.
2370 ################################################
2371
2372 sub _key_in_a_is_also_key_in_b
2373 {
2374     my ( $hashref_a, $hashref_b) = @_;
2375
2376     my $returnvalue = 1;
2377
2378     my $key;
2379     foreach $key ( keys %{$hashref_a} )
2380     {
2381         if ( ! exists($hashref_b->{$key}) )
2382         {
2383             print "*****\n";
2384             foreach my $keyb ( keys %{$hashref_b} ) { print "$keyb : $hashref_b->{$keyb}\n"; }
2385             print "*****\n";
2386             $returnvalue = 0;
2387         }
2388     }
2389
2390     return $returnvalue;
2391 }
2392
2393 1;