solenv/bin/modules/installer/worker.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::worker;
  20
  21 use Cwd;
  22 use File::Copy;
  23 use File::stat;
  24 use File::Temp qw(tmpnam);
  25 use File::Path;
  26 use File::Basename;
  27 use installer::control;
  28 use installer::converter;
  29 use installer::exiter;
  30 use installer::files;
  31 use installer::globals;
  32 use installer::logger;
  33 use installer::pathanalyzer;
  34 use installer::scpzipfiles;
  35 use installer::scriptitems;
  36 use installer::systemactions;
  37 use installer::windows::language;
  38
  39 #########################################
  40 # Saving the patchlist file
  41 #########################################
  42
  43 sub _save_patchlist_file
  44 {
  45     my ($installlogdir, $patchlistfilename) = @_;
  46
  47     my $installpatchlistdir = installer::systemactions::create_directory_next_to_directory($installlogdir, "patchlist");
  48     $patchlistfilename =~ s/log\_/patchfiles\_/;
  49     $patchlistfilename =~ s/\.log/\.txt/;
  50     installer::files::save_file($installpatchlistdir . $installer::globals::separator . $patchlistfilename, \@installer::globals::patchfilecollector);
  51     installer::logger::print_message( "... creating patchlist file $patchlistfilename \n" );
  52
  53 }
  54
  55 ###############################################################
  56 # Removing all directories of a special language
  57 # in the directory $basedir
  58 ###############################################################
  59
  60 sub remove_old_installation_sets
  61 {
  62     my ($basedir) = @_;
  63
  64     installer::logger::print_message( "... removing old installation directories ...\n" );
  65
  66     my $removedir = $basedir;
  67
  68     if ( -d $removedir ) { installer::systemactions::remove_complete_directory($removedir, 1); }
  69
  70     # looking for non successful old installation sets
  71
  72     $removedir = $basedir . "_witherror";
  73     if ( -d $removedir ) { installer::systemactions::remove_complete_directory($removedir, 1); }
  74
  75     $removedir = $basedir . "_inprogress";
  76     if ( -d $removedir ) { installer::systemactions::remove_complete_directory($removedir, 1); }
  77
  78     # finally the $basedir can be created empty
  79
  80     if ( $installer::globals::localinstalldirset ) { installer::systemactions::create_directory_structure($basedir); }
  81
  82     installer::systemactions::create_directory($basedir);
  83 }
  84
  85 ###############################################################
  86 # Creating the installation directory structure
  87 ###############################################################
  88
  89 sub create_installation_directory
  90 {
  91     my ($shipinstalldir, $languagestringref, $current_install_number_ref) = @_;
  92
  93     my $installdir = "";
  94
  95     my $languageref = $languagestringref;
  96
  97     $installdir = installer::systemactions::create_directories("install", $languageref);
  98     installer::logger::print_message( "... creating installation set in $installdir ...\n" );
  99     remove_old_installation_sets($installdir);
 100     my $inprogressinstalldir = $installdir . "_inprogress";
 101     installer::systemactions::rename_directory($installdir, $inprogressinstalldir);
 102     $installdir = $inprogressinstalldir;
 103
 104     $installer::globals::saveinstalldir = $installdir;  # saving directory globally, in case of exiting
 105
 106     return $installdir;
 107 }
 108
 109 ###############################################################
 110 # Analyzing and creating the log file
 111 ###############################################################
 112
 113 sub analyze_and_save_logfile
 114 {
 115     my ($loggingdir, $installdir, $installlogdir, $allsettingsarrayref, $languagestringref, $current_install_number) = @_;
 116
 117     my $is_success = 1;
 118     my $finalinstalldir = "";
 119
 120     installer::logger::print_message( "... checking log file " . $loggingdir . $installer::globals::logfilename . "\n" );
 121
 122     my $contains_error = installer::control::check_logfile(\@installer::globals::logfileinfo);
 123
 124     # Dependent from the success, the installation directory can be renamed.
 125
 126     if ( $contains_error )
 127     {
 128         my $errordir = installer::systemactions::rename_string_in_directory($installdir, "_inprogress", "_witherror");
 129         # Error output to STDERR
 130         for ( my $j = 0; $j <= $#installer::globals::errorlogfileinfo; $j++ )
 131         {
 132             my $line = $installer::globals::errorlogfileinfo[$j];
 133             $line =~ s/\s*$//g;
 134             installer::logger::print_error( $line );
 135         }
 136         $is_success = 0;
 137
 138         $finalinstalldir = $errordir;
 139     }
 140     else
 141     {
 142         my $destdir = "";
 143
 144         $destdir = installer::systemactions::rename_string_in_directory($installdir, "_inprogress", "");
 145
 146         $finalinstalldir = $destdir;
 147     }
 148
 149     # Saving the logfile in the log file directory and additionally in a log directory in the install directory
 150
 151     my $numberedlogfilename = $installer::globals::logfilename;
 152     installer::logger::print_message( "... creating log file $numberedlogfilename \n" );
 153     installer::files::save_file($loggingdir . $numberedlogfilename, \@installer::globals::logfileinfo);
 154     installer::files::save_file($installlogdir . $installer::globals::separator . $numberedlogfilename, \@installer::globals::logfileinfo);
 155
 156     # Saving the list of patchfiles in a patchlist directory in the install directory
 157     if ( $installer::globals::creating_windows_installer_patch ) { _save_patchlist_file($installlogdir, $numberedlogfilename); }
 158
 159     if ( $installer::globals::creating_windows_installer_patch ) { $installer::globals::creating_windows_installer_patch = 0; }
 160
 161     # Exiting the packaging process, if an error occurred.
 162     # This is important, to get an error code "-1", if an error was found in the log file,
 163     # that did not break the packaging process
 164
 165     if ( ! $is_success) { installer::exiter::exit_program("ERROR: Found an error in the logfile. Packaging failed.", "analyze_and_save_logfile"); }
 166
 167     return ($is_success, $finalinstalldir);
 168 }
 169
 170 ###############################################################
 171 # Removing all directories that are saved in the
 172 # global directory @installer::globals::removedirs
 173 ###############################################################
 174
 175 sub clean_output_tree
 176 {
 177     installer::logger::print_message( "... cleaning the output tree ...\n" );
 178
 179     for ( my $i = 0; $i <= $#installer::globals::removedirs; $i++ )
 180     {
 181         if ( -d $installer::globals::removedirs[$i] )
 182         {
 183             installer::logger::print_message( "... removing directory $installer::globals::removedirs[$i] ...\n" );
 184             installer::systemactions::remove_complete_directory($installer::globals::removedirs[$i], 1);
 185         }
 186     }
 187
 188     # Last try to remove the ship test directory
 189
 190     if ( $installer::globals::shiptestdirectory )
 191     {
 192         if ( -d $installer::globals::shiptestdirectory )
 193         {
 194             my $infoline = "Last try to remove $installer::globals::shiptestdirectory . \n";
 195             push(@installer::globals::logfileinfo, $infoline);
 196             my $systemcall = "rmdir $installer::globals::shiptestdirectory";
 197             my $returnvalue = system($systemcall);
 198         }
 199     }
 200 }
 201
 202 ###########################################################
 203 # Setting one language in the language independent
 204 # array of include paths with $(LANG)
 205 ###########################################################
 206
 207 sub get_language_specific_include_paths
 208 {
 209     my ( $patharrayref, $onelanguage ) = @_;
 210
 211     my @patharray = ();
 212
 213     for ( my $i = 0; $i <= $#{$patharrayref}; $i++ )
 214     {
 215         my $line = ${$patharrayref}[$i];
 216         $line =~ s/\$\(LANG\)/$onelanguage/g;
 217         push(@patharray ,$line);
 218     }
 219
 220     return \@patharray;
 221 }
 222
 223 ##############################################################
 224 # Collecting all items with a defined flag
 225 ##############################################################
 226
 227 sub collect_all_items_with_special_flag
 228 {
 229     my ($itemsref, $flag) = @_;
 230
 231     my @allitems = ();
 232
 233     for ( my $i = 0; $i <= $#{$itemsref}; $i++ )
 234     {
 235         my $oneitem = ${$itemsref}[$i];
 236         my $styles = "";
 237         if ( $oneitem->{'Styles'} ) { $styles = $oneitem->{'Styles'} };
 238
 239         if ( $styles =~ /\b$flag\b/ )
 240         {
 241             push( @allitems, $oneitem );
 242         }
 243     }
 244
 245     return \@allitems;
 246 }
 247
 248 ##############################################################
 249 # Removing all items with a defined flag from collector
 250 ##############################################################
 251
 252 sub remove_all_items_with_special_flag
 253 {
 254     my ($itemsref, $flag) = @_;
 255
 256     my @allitems = ();
 257
 258     for ( my $i = 0; $i <= $#{$itemsref}; $i++ )
 259     {
 260         my $oneitem = ${$itemsref}[$i];
 261         my $styles = "";
 262         if ( $oneitem->{'Styles'} ) { $styles = $oneitem->{'Styles'} };
 263         if ( $styles =~ /\b$flag\b/ )
 264         {
 265             my $infoline = "Attention: Removing from collector: $oneitem->{'Name'} !\n";
 266             push( @installer::globals::logfileinfo, $infoline);
 267             if ( $flag eq "BINARYTABLE_ONLY" ) { push(@installer::globals::binarytableonlyfiles, $oneitem); }
 268             next;
 269         }
 270         push( @allitems, $oneitem );
 271     }
 272
 273     return \@allitems;
 274 }
 275
 276 ###########################################################
 277 # Mechanism for simple installation without packing
 278 ###########################################################
 279
 280 sub install_simple ($$$$$$)
 281 {
 282     my ($packagename, $languagestring, $directoriesarray, $filesarray, $linksarray, $unixlinksarray) = @_;
 283
 284     installer::logger::print_message( "... installing module $packagename ...\n" );
 285
 286     my $destdir = $installer::globals::destdir;
 287     my @lines = ();
 288
 289     installer::logger::print_message( "DestDir: $destdir \n" );
 290     installer::logger::print_message( "Rootpath: $installer::globals::rootpath \n" );
 291
 292     `mkdir -p $destdir` if $destdir ne "";
 293     `mkdir -p $destdir$installer::globals::rootpath`;
 294
 295     # Create Directories
 296     for ( my $i = 0; $i <= $#{$directoriesarray}; $i++ )
 297     {
 298         my $onedir = ${$directoriesarray}[$i];
 299         my $dir = "";
 300
 301         if ( $onedir->{'Dir'} ) { $dir = $onedir->{'Dir'}; }
 302
 303         if ((!($dir =~ /\bPREDEFINED_/ )) || ( $dir =~ /\bPREDEFINED_PROGDIR\b/ ))
 304         {
 305             my $hostname = $onedir->{'HostName'};
 306
 307             # ignore '.' subdirectories
 308             next if ( $hostname =~ m/\.$/ );
 309             # remove './' from the path
 310             $hostname =~ s/\.\///g;
 311
 312             # printf "mkdir $destdir$hostname\n";
 313             mkdir $destdir . $hostname;
 314             push @lines, "%dir " . $hostname . "\n";
 315         }
 316     }
 317
 318     for ( my $i = 0; $i <= $#{$filesarray}; $i++ )
 319     {
 320         my $onefile = ${$filesarray}[$i];
 321         my $unixrights = $onefile->{'UnixRights'};
 322         my $destination = $onefile->{'destination'};
 323         my $sourcepath = $onefile->{'sourcepath'};
 324
 325         # This is necessary to install SDK that includes files with $ in its name
 326         # Otherwise, the following shell commands does not work and the file list
 327         # is not correct
 328         $destination =~ s/\$\$/\$/;
 329         $sourcepath =~ s/\$\$/\$/;
 330
 331         # remove './' from the path
 332         $sourcepath =~ s/\.\///g;
 333         $destination =~ s/\.\///g;
 334
 335         push @lines, "$destination\n";
 336         if(-d  "$destdir$destination"){
 337             rmtree("$destdir$destination");
 338         }
 339         if(-e "$destdir$destination") {
 340             unlink "$destdir$destination";
 341         }
 342
 343         if ( -l "$sourcepath" ) {
 344             symlink (readlink ("$sourcepath"), "$destdir$destination") || die "Can't symlink $destdir$destination -> " . readlink ("$sourcepath") . "$!";
 345         }
 346         else {
 347             copy ("$sourcepath", "$destdir$destination") || die "Can't copy file: $sourcepath -> $destdir$destination $!";
 348             my $sourcestat = stat($sourcepath);
 349             utime ($sourcestat->atime, $sourcestat->mtime, "$destdir$destination");
 350             chmod (oct($unixrights), "$destdir$destination") || die "Can't change permissions: $!";
 351         }
 352         push @lines, "$destination\n";
 353     }
 354
 355     for ( my $i = 0; $i <= $#{$linksarray}; $i++ )
 356     {
 357         my $onelink = ${$linksarray}[$i];
 358         my $destination = $onelink->{'destination'};
 359         my $destinationfile = $onelink->{'destinationfile'};
 360
 361         if(-e "$destdir$destination") {
 362             unlink "$destdir$destination";
 363         }
 364         symlink ("$destinationfile", "$destdir$destination") || die "Can't create symlink: $!";
 365         push @lines, "$destination\n";
 366     }
 367
 368     for ( my $i = 0; $i <= $#{$unixlinksarray}; $i++ )
 369     {
 370         my $onelink = ${$unixlinksarray}[$i];
 371         my $target = $onelink->{'Target'};
 372         my $destination = $onelink->{'destination'};
 373         my $cmd = "mkdir -p '" . dirname($destdir . $destination) . "'";
 374         system($cmd) && die "Failed to execute \"$cmd\"";
 375         $cmd = "ln -sf '$target' '$destdir$destination'";
 376
 377         system($cmd) && die "Failed \"$cmd\"";
 378         push @lines, "$destination\n";
 379     }
 380
 381     if ( $destdir ne "" )
 382     {
 383         my $filelist;
 384         my $fname = $installer::globals::destdir . "/$packagename";
 385         open ($filelist, ">$fname") || die "Can't open $fname: $!";
 386         print $filelist @lines;
 387         close ($filelist);
 388     }
 389
 390 }
 391
 392 ###########################################################
 393 # Selecting langpack items
 394 ###########################################################
 395
 396 sub select_langpack_items
 397 {
 398     my ( $itemsref, $itemname ) = @_;
 399
 400     installer::logger::include_header_into_logfile("Selecting RegistryItems for Language Packs");
 401
 402     my @itemsarray = ();
 403
 404     for ( my $i = 0; $i <= $#{$itemsref}; $i++ )
 405     {
 406         my $oneitem = ${$itemsref}[$i];
 407
 408         # Items with style "LANGUAGEPACK" have to be included into the patch
 409         my $styles = "";
 410         if ( $oneitem->{'Styles'} ) { $styles = $oneitem->{'Styles'}; }
 411         if (( $styles =~ /\bLANGUAGEPACK\b/ ) || ( $styles =~ /\bFORCELANGUAGEPACK\b/ )) { push(@itemsarray, $oneitem); }
 412     }
 413
 414     return \@itemsarray;
 415 }
 416
 417 ###########################################################
 418 # Selecting helppack items
 419 ###########################################################
 420
 421 sub select_helppack_items
 422 {
 423     my ( $itemsref, $itemname ) = @_;
 424
 425     installer::logger::include_header_into_logfile("Selecting RegistryItems for Help Packs");
 426
 427     my @itemsarray = ();
 428
 429     for ( my $i = 0; $i <= $#{$itemsref}; $i++ )
 430     {
 431         my $oneitem = ${$itemsref}[$i];
 432
 433         # Items with style "HELPPACK" have to be included into the patch
 434         my $styles = "";
 435         if ( $oneitem->{'Styles'} ) { $styles = $oneitem->{'Styles'}; }
 436         if (( $styles =~ /\bHELPPACK\b/ ) || ( $styles =~ /\bFORCEHELPPACK\b/ )) { push(@itemsarray, $oneitem); }
 437     }
 438
 439     return \@itemsarray;
 440 }
 441
 442 ###########################################################
 443 # Replacing %-variables with the content
 444 # of $allvariableshashref
 445 ###########################################################
 446
 447 sub replace_variables_in_string
 448 {
 449     my ( $string, $variableshashref ) = @_;
 450
 451     if ( $string =~ /^.*\%\w+.*$/ )
 452     {
 453         my $key;
 454
 455         # we want to substitute FOO_BR before FOO to avoid floating _BR suffixes
 456         foreach $key (sort { length ($b) <=> length ($a) } keys %{$variableshashref})
 457         {
 458             my $value = $variableshashref->{$key};
 459             $key = "\%" . $key;
 460             $string =~ s/\Q$key\E/$value/g;
 461         }
 462     }
 463
 464     return $string;
 465 }
 466
 467 #################################################################
 468 # Copying the files defined as ScpActions into the
 469 # installation set.
 470 #################################################################
 471
 472 sub put_scpactions_into_installset
 473 {
 474     my ($installdir) = @_;
 475
 476     installer::logger::include_header_into_logfile("Start: Copying scp action files into installation set");
 477
 478     for ( my $i = 0; $i <= $#installer::globals::allscpactions; $i++ )
 479     {
 480         my $onescpaction = $installer::globals::allscpactions[$i];
 481
 482         my $subdir = "";
 483         if ( $onescpaction->{'Subdir'} ) { $subdir = $onescpaction->{'Subdir'}; }
 484
 485         if ( $onescpaction->{'Name'} eq "loader.exe" ) { next; }    # do not copy this ScpAction loader
 486
 487         my $destdir = $installdir;
 488         $destdir =~ s/\Q$installer::globals::separator\E\s*$//;
 489         if ( $subdir ) { $destdir = $destdir . $installer::globals::separator . $subdir; }
 490
 491         my $sourcefile = $onescpaction->{'sourcepath'};
 492         my $destfile = $destdir . $installer::globals::separator . $onescpaction->{'DestinationName'};
 493
 494         if (( $subdir =~ /\// ) || ( $subdir =~ /\\/ ))
 495         {
 496             installer::systemactions::create_directory_structure($destdir);
 497         }
 498         else
 499         {
 500             installer::systemactions::create_directory($destdir);
 501         }
 502
 503         installer::systemactions::copy_one_file($sourcefile, $destfile);
 504
 505         if ( $onescpaction->{'UnixRights'} )
 506         {
 507             chmod oct($onescpaction->{'UnixRights'}), $destfile;
 508         }
 509
 510     }
 511
 512     installer::logger::include_header_into_logfile("End: Copying scp action files into installation set");
 513
 514 }
 515
 516 #################################################################
 517 # Collecting scp actions for all languages
 518 #################################################################
 519
 520 sub collect_scpactions
 521 {
 522     my ($allscpactions) = @_;
 523
 524     for ( my $i = 0; $i <= $#{$allscpactions}; $i++ )
 525     {
 526         push(@installer::globals::allscpactions, ${$allscpactions}[$i]);
 527     }
 528 }
 529
 530 ###########################################################
 531 # Adding additional variables into the variableshashref,
 532 # that are defined in include files in the source tree. The
 533 # names of the include files are stored in
 534 # ADD_INCLUDE_FILES (comma separated list).
 535 ###########################################################
 536
 537 sub add_variables_from_inc_to_hashref
 538 {
 539     my ($allvariables, $includepatharrayref) = @_;
 540
 541     my $infoline = "";
 542     my $includefilelist = $allvariables->{'ADD_INCLUDE_FILES'} || "";
 543
 544     for my $includefilename (split /,\s*/, $includefilelist)
 545     {
 546         $includefilename =~ s/^\s*//;
 547         $includefilename =~ s/\s*$//;
 548         $includefilenameref = $ENV{'SRCDIR'} . "/" . $includefilename;
 549         if ( ! -f $includefilenameref ) { installer::exiter::exit_program("Include file $includefilename ($includefilenameref) not found!\nADD_INCLUDE_FILES = $allvariables->{'ADD_INCLUDE_FILES'}", "add_variables_from_inc_to_hashref"); }
 550
 551         $infoline = "Including inc file: $includefilenameref \n";
 552         push( @installer::globals::globallogfileinfo, $infoline);
 553
 554         my $includefile = installer::files::read_file($includefilenameref);
 555
 556         for ( my $j = 0; $j <= $#{$includefile}; $j++ )
 557         {
 558             # Analyzing all "key=value" lines
 559             my $oneline = ${$includefile}[$j];
 560
 561             if ( $oneline =~ /^\s*(\S+)\s*\=\s*(.*?)\s*$/ ) # no white space allowed in key
 562             {
 563                 my $key = $1;
 564                 my $value = $2;
 565                 $allvariables->{$key} = $value;
 566                 $infoline = "Setting of variable: $key = $value\n";
 567                 push( @installer::globals::globallogfileinfo, $infoline);
 568             }
 569         }
 570     }
 571 }
 572
 573 ##############################################
 574 # Collecting all files from include paths
 575 ##############################################
 576
 577 sub collect_all_files_from_includepaths
 578 {
 579     my ($patharrayref) = @_;
 580
 581     installer::logger::globallog("Reading all directories: Start");
 582     installer::logger::print_message( "... reading include paths ...\n" );
 583     # empty the global
 584
 585     @installer::globals::allincludepaths =();
 586     my $infoline;
 587
 588     for ( my $i = 0; $i <= $#{$patharrayref}; $i++ )
 589     {
 590         $includepath = ${$patharrayref}[$i];
 591         installer::remover::remove_leading_and_ending_whitespaces(\$includepath);
 592
 593         if ( ! -d $includepath )
 594         {
 595             $infoline = "$includepath does not exist. (Can be removed from include path list?)\n";
 596             push( @installer::globals::globallogfileinfo, $infoline);
 597             next;
 598         }
 599
 600         my @sourcefiles = ();
 601         my $pathstring = "";
 602         installer::systemactions::read_full_directory($includepath, $pathstring, \@sourcefiles);
 603
 604         if ( ! ( $#sourcefiles > -1 ))
 605         {
 606             $infoline = "$includepath is empty. (Can be removed from include path list?)\n";
 607             push( @installer::globals::globallogfileinfo, $infoline);
 608         }
 609         else
 610         {
 611             my $number = $#sourcefiles + 1;
 612             $infoline = "Directory $includepath contains $number files (including subdirs)\n";
 613             push( @installer::globals::globallogfileinfo, $infoline);
 614
 615             my %allfileshash = ();
 616             $allfileshash{'includepath'} = $includepath;
 617
 618             for ( my $j = 0; $j <= $#sourcefiles; $j++ )
 619             {
 620                 $allfileshash{$sourcefiles[$j]} = 1;
 621             }
 622
 623             push(@installer::globals::allincludepaths, \%allfileshash);
 624         }
 625     }
 626
 627     $installer::globals::include_paths_read = 1;
 628
 629     installer::logger::globallog("Reading all directories: End");
 630     push( @installer::globals::globallogfileinfo, "\n");
 631 }
 632
 633 ##############################################
 634 # Searching for a file with the gid
 635 ##############################################
 636
 637 sub find_file_by_id
 638 {
 639     my ( $filesref, $gid ) = @_;
 640
 641     my $foundfile = 0;
 642     my $onefile;
 643
 644     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
 645     {
 646         $onefile = ${$filesref}[$i];
 647         my $filegid = $onefile->{'gid'};
 648
 649         if ( $filegid eq $gid )
 650         {
 651             $foundfile = 1;
 652             last;
 653         }
 654     }
 655
 656     if (! $foundfile ) { $onefile  = ""; }
 657
 658     return $onefile;
 659 }
 660
 661 #################################################
 662 # Generating paths for cygwin (second version)
 663 # This function generates smaller files for
 664 #################################################
 665
 666 sub generate_cygwin_paths
 667 {
 668     my ($filesref) = @_;
 669
 670     installer::logger::include_timestamp_into_logfile("Starting generating cygwin paths");
 671
 672     my $infoline = "Generating cygwin paths (generate_cygwin_paths)\n";
 673     push( @installer::globals::logfileinfo, $infoline);
 674
 675     my $max = 5000;  # number of paths in one file
 676
 677     my @pathcollector = ();
 678     my $startnumber = 0;
 679     my $counter = 0;
 680
 681     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
 682     {
 683         my $line = ${$filesref}[$i]->{'sourcepath'} . "\n";
 684         push(@pathcollector, $line);
 685         $counter++;
 686
 687         if (( $i == $#{$filesref} ) || ((( $counter % $max ) == 0 ) && ( $i > 0 )))
 688         {
 689             my $tmpfilename = "cygwinhelper_" . $i . ".txt";
 690             my $temppath = $installer::globals::temppath;
 691             $temppath =~ s/\Q$installer::globals::separator\E\s*$//;
 692             $tmpfilename = $temppath . $installer::globals::separator . $tmpfilename;
 693             $infoline = "Creating temporary file for cygwin conversion: $tmpfilename (contains $counter paths)\n";
 694             push( @installer::globals::logfileinfo, $infoline);
 695             if ( -f $tmpfilename ) { unlink $tmpfilename; }
 696
 697             installer::files::save_file($tmpfilename, \@pathcollector);
 698
 699             my $success = 0;
 700             my @cyg_sourcepathlist = qx{cygpath -w -f "$tmpfilename"};
 701             chomp @cyg_sourcepathlist;
 702
 703             # Validating the array, it has to contain the correct number of values
 704             my $new_paths = $#cyg_sourcepathlist + 1;
 705             if ( $new_paths == $counter ) { $success = 1; }
 706
 707             if ($success)
 708             {
 709                 $infoline = "Success: Successfully converted to cygwin paths!\n";
 710                 push( @installer::globals::logfileinfo, $infoline);
 711             }
 712             else
 713             {
 714                 $infoline = "ERROR: Failed to convert to cygwin paths!\n";
 715                 push( @installer::globals::logfileinfo, $infoline);
 716                 installer::exiter::exit_program("ERROR: Failed to convert to cygwin paths!", "generate_cygwin_paths");
 717             }
 718
 719             for ( my $j = 0; $j <= $#cyg_sourcepathlist; $j++ )
 720             {
 721                 my $number = $startnumber + $j;
 722                 ${$filesref}[$number]->{'cyg_sourcepath'} = $cyg_sourcepathlist[$j];
 723             }
 724
 725             if ( -f $tmpfilename ) { unlink $tmpfilename; }
 726
 727             @pathcollector = ();
 728             $startnumber = $startnumber + $max;
 729             $counter = 0;
 730         }
 731     }
 732
 733     # Checking existence fo cyg_sourcepath for every file
 734     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
 735     {
 736         if (( ! exists(${$filesref}[$i]->{'cyg_sourcepath'}) ) || ( ${$filesref}[$i]->{'cyg_sourcepath'} eq "" ))
 737         {
 738             $infoline = "ERROR: No cygwin sourcepath defined for file ${$filesref}[$i]->{'sourcepath'}\n";
 739             push( @installer::globals::logfileinfo, $infoline);
 740             installer::exiter::exit_program("ERROR: No cygwin sourcepath defined for file ${$filesref}[$i]->{'sourcepath'}!", "generate_cygwin_paths");
 741         }
 742     }
 743
 744     installer::logger::include_timestamp_into_logfile("Ending generating cygwin paths");
 745 }
 746
 747 ######################################################
 748 # Getting the first entry from a list of languages
 749 ######################################################
 750
 751 sub get_first_from_list
 752 {
 753     my ( $list ) = @_;
 754
 755     my $first = $list;
 756
 757     if ( $list =~ /^\s*(.+?),(.+)\s*$/) # "?" for minimal matching
 758     {
 759         $first = $1;
 760     }
 761
 762     return $first;
 763 }
 764
 765 ################################################
 766 # Setting all spellchecker languages
 767 ################################################
 768
 769 sub set_spellcheckerlanguages
 770 {
 771     my ( $productlanguagesarrayref, $allvariables ) = @_;
 772
 773     my %productlanguages = ();
 774     for ( my $i = 0; $i <= $#{$productlanguagesarrayref}; $i++ ) { $productlanguages{${$productlanguagesarrayref}[$i]} = 1;  }
 775
 776     my $spellcheckfilename = $allvariables->{'SPELLCHECKERFILE'};
 777
 778     my $spellcheckfileref = installer::scriptitems::get_sourcepath_from_filename_and_includepath(\$spellcheckfilename, "", 1);
 779
 780     if ($$spellcheckfileref eq "") { installer::exiter::exit_program("ERROR: Could not find $spellcheckfilename!", "set_spellcheckerlanguages"); }
 781
 782     my $infoline = "Using spellchecker file: $$spellcheckfileref \n";
 783     push( @installer::globals::globallogfileinfo, $infoline);
 784
 785     my $spellcheckfile = installer::files::read_file($$spellcheckfileref);
 786     my %spellcheckhash = ();
 787
 788     for ( my $j = 0; $j <= $#{$spellcheckfile}; $j++ )
 789     {
 790         # Analyzing all "key=value" lines
 791         my $oneline = ${$spellcheckfile}[$j];
 792
 793         if ( $oneline =~ /^\s*(\S+)\s*\=\s*\"(.*?)\"\s*$/ ) # no white space allowed in key
 794         {
 795             my $onelang = $1;
 796             my $languagelist = $2;
 797
 798             # Special handling for language packs. Only include the first language of the language list.
 799             # If no spellchecker shall be included, the keyword "EMPTY" can be used.
 800
 801             if ( $installer::globals::languagepack )
 802             {
 803                 my $first = get_first_from_list($languagelist);
 804
 805                 if ( $first eq "EMPTY" )     # no spellchecker into language pack
 806                 {
 807                     $languagelist = "";
 808                 }
 809                 else
 810                 {
 811                     $languagelist = $first;
 812                 }
 813             }
 814             else  # no language pack, so EMPTY is not required
 815             {
 816                 $languagelist =~ s/^\s*EMPTY\s*,//; # removing the entry EMPTY
 817             }
 818
 819             $spellcheckhash{$onelang} = $languagelist;
 820         }
 821     }
 822
 823     # Collecting all required languages in %installer::globals::spellcheckerlanguagehash
 824
 825     foreach my $lang (keys %productlanguages)
 826     {
 827         my $languagelist = "";
 828         if ( exists($spellcheckhash{$lang}) ) { $languagelist = $spellcheckhash{$lang}; }
 829         else { $languagelist = ""; }  # no dictionary unless defined in SPELLCHECKERFILE
 830
 831         my $langlisthash = installer::converter::convert_stringlist_into_hash(\$languagelist, ",");
 832         foreach my $onelang ( keys %{$langlisthash} ) { $installer::globals::spellcheckerlanguagehash{$onelang} = 1; }
 833     }
 834
 835     $installer::globals::analyze_spellcheckerlanguage = 1;
 836
 837     # Logging
 838
 839     my $langstring = "";
 840     foreach my $lang (sort keys %installer::globals::spellcheckerlanguagehash) { $langstring = $langstring . "," . $lang }
 841     $langstring =~ s/^\s*,//;
 842
 843     $infoline = "Collected spellchecker languages for spellchecker: $langstring \n";
 844     push( @installer::globals::globallogfileinfo, $infoline);
 845 }
 846
 847 ################################################
 848 # Including a license text into setup script
 849 ################################################
 850
 851 sub put_license_into_setup
 852 {
 853     my ($installdir, $includepatharrayref) = @_;
 854
 855     # find and read the license file
 856     my $licenselanguage = "en-US";                  # always english !
 857     my $licensefilename = "license";
 858     # my $licensefilename = "LICENSE" . ".txt";
 859     my $licenseincludepatharrayref = get_language_specific_include_paths($includepatharrayref, $licenselanguage);
 860
 861     my $licenseref = installer::scriptitems::get_sourcepath_from_filename_and_includepath(\$licensefilename, $licenseincludepatharrayref, 0);
 862     if ($$licenseref eq "") { installer::exiter::exit_program("ERROR: Could not find License file $licensefilename!", "put_license_into_setup"); }
 863     my $licensefile = installer::files::read_file($$licenseref);
 864
 865     # Read setup
 866     my $setupfilename = $installdir . $installer::globals::separator . "setup";
 867     my $setupfile = installer::files::read_file($setupfilename);
 868
 869     # Replacement
 870     my $infoline = "Adding licensefile into setup script\n";
 871     push( @installer::globals::logfileinfo, $infoline);
 872
 873     my $includestring = "";
 874     for ( my $i = 0; $i <= $#{$licensefile}; $i++ ) { $includestring = $includestring . ${$licensefile}[$i]; }
 875     for ( my $i = 0; $i <= $#{$setupfile}; $i++ ) { ${$setupfile}[$i] =~ s/LICENSEFILEPLACEHOLDER/$includestring/; }
 876
 877     # Write setup
 878     installer::files::save_file($setupfilename, $setupfile);
 879 }
 880
 881 #########################################################
 882 # Collecting all pkgmap files from an installation set
 883 #########################################################
 884
 885 sub collectpackagemaps
 886 {
 887     my ( $installdir, $languagestringref, $allvariables ) = @_;
 888
 889     installer::logger::include_header_into_logfile("Collecing all packagemaps (pkgmap):");
 890
 891     my $pkgmapdir = installer::systemactions::create_directories("pkgmap", $languagestringref);
 892     my $subdirname = $allvariables->{'UNIXPRODUCTNAME'} . "_pkgmaps";
 893     my $pkgmapsubdir = $pkgmapdir . $installer::globals::separator . $subdirname;
 894     if ( -d $pkgmapsubdir ) { installer::systemactions::remove_complete_directory($pkgmapsubdir); }
 895     if ( ! -d $pkgmapsubdir ) { installer::systemactions::create_directory($pkgmapsubdir); }
 896
 897     $installdir =~ s/\/\s*$//;
 898     # Collecting all packages in $installdir and its sub package ("packages")
 899     my $searchdir = $installdir . $installer::globals::separator . $installer::globals::epmoutpath;
 900
 901     my $allpackages = installer::systemactions::get_all_directories_without_path($searchdir);
 902
 903     for ( my $i = 0; $i <= $#{$allpackages}; $i++ )
 904     {
 905         my $pkgmapfile = $searchdir . $installer::globals::separator . ${$allpackages}[$i] . $installer::globals::separator . "pkgmap";
 906         my $destfilename = $pkgmapsubdir . $installer::globals::separator . ${$allpackages}[$i] . "_pkgmap";
 907         installer::systemactions::copy_one_file($pkgmapfile, $destfilename);
 908     }
 909
 910     # Create a tar gz file with all package maps
 911     my $tarfilename = $subdirname . ".tar";
 912     my $targzname = $tarfilename . ".gz";
 913     $systemcall = "cd $pkgmapdir; tar -cf - $subdirname | gzip > $targzname";
 914     installer::systemactions::make_systemcall($systemcall);
 915     installer::systemactions::remove_complete_directory($pkgmapsubdir, 1);
 916 }
 917
 918 1;