solenv/bin/modules/installer/control.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::control;
  20
  21 use Cwd;
  22 use installer::converter;
  23 use installer::exiter;
  24 use installer::files;
  25 use installer::globals;
  26 use installer::pathanalyzer;
  27 use installer::scriptitems;
  28 use installer::systemactions;
  29
  30 #########################################################
  31 # Function that can be used for additional controls.
  32 # Search happens in $installer::globals::patharray.
  33 #########################################################
  34
  35 sub check_needed_files_in_path
  36 {
  37     my ( $filesref ) = @_;
  38
  39     foreach $onefile ( @{$filesref} )
  40     {
  41         installer::logger::print_message( "...... searching $onefile ..." );
  42
  43         my $fileref = installer::scriptitems::get_sourcepath_from_filename_and_includepath_classic(\$onefile, $installer::globals::patharray , 0);
  44
  45         if ( $$fileref eq "" )
  46         {
  47             $error = 1;
  48             installer::logger::print_error( "$onefile not found\n" );
  49         }
  50         else
  51         {
  52             installer::logger::print_message( "\tFound: $$fileref\n" );
  53         }
  54     }
  55
  56     if ( $error )
  57     {
  58         installer::exiter::exit_program("ERROR: Could not find all needed files in path!", "check_needed_files_in_path");
  59     }
  60 }
  61
  62 #########################################################
  63 # Checking the local system
  64 # Checking existence of needed files in include path
  65 #########################################################
  66
  67 sub check_system_path
  68 {
  69     # The following files have to be found in the environment variable PATH
  70     # All platforms: zip
  71     # Windows only: "msiinfo.exe", "msidb.exe", "uuidgen.exe", "makecab.exe", "msitran.exe", "expand.exe" for msi database and packaging
  72
  73     if ($ENV{'CROSS_COMPILING'} eq 'YES')
  74     {
  75         # we build our own msi* etc. tools when cross-compiling
  76         $ENV{'PATH'} .= $installer::globals::pathseparator . $ENV{'WORKDIR_FOR_BUILD'} . '/LinkTarget/Executable';
  77     }
  78
  79     my $onefile;
  80     my $error = 0;
  81     my $pathvariable = $ENV{'PATH'};
  82     my $local_pathseparator = $installer::globals::pathseparator;
  83
  84     if( $^O =~ /cygwin/i )
  85     {
  86         # When using cygwin's perl the PATH variable is POSIX style and
  87         # has to be converted to DOS style for further use.
  88         $pathvariable = join ';',
  89                         map { $dir = qx{cygpath -m "$_"}; chomp($dir); $dir }
  90                         split /\Q$local_pathseparator\E\s*/, $pathvariable;
  91         $local_pathseparator = ';';
  92     }
  93     my $patharrayref = installer::converter::convert_stringlist_into_array(\$pathvariable, $local_pathseparator);
  94
  95     $installer::globals::patharray = $patharrayref;
  96
  97     my @needed_files_in_path = ();
  98
  99     if (($installer::globals::iswin) && ($installer::globals::iswindowsbuild))
 100     {
 101         @needed_files_in_path = ("zip.exe", "msiinfo.exe", "msidb.exe", "uuidgen", "makecab.exe", "msitran.exe", "expand.exe");
 102     }
 103     elsif ($installer::globals::isunix && $installer::globals::packageformat eq 'msi')
 104     {
 105         @needed_files_in_path = ("zip", "msiinfo.exe", "msidb.exe", "uuidgen", "makecab.exe", "msitran.exe", "cabextract");
 106     }
 107     elsif ($installer::globals::iswin)
 108     {
 109         @needed_files_in_path = ("zip.exe");
 110     }
 111     else
 112     {
 113         @needed_files_in_path = ("zip");
 114     }
 115
 116     foreach $onefile ( @needed_files_in_path )
 117     {
 118         installer::logger::print_message( "...... searching $onefile ..." );
 119
 120         my $fileref = installer::scriptitems::get_sourcepath_from_filename_and_includepath_classic(\$onefile, $patharrayref , 0);
 121
 122         if ( $$fileref eq "" )
 123         {
 124             $error = 1;
 125             installer::logger::print_error( "$onefile not found\n" );
 126         }
 127         else
 128         {
 129             installer::logger::print_message( "\tFound: $$fileref\n" );
 130             # Saving the absolut path for msitran.exe. This is required for the determination of the checksum.
 131             if ( $onefile eq "msitran.exe" ) { $installer::globals::msitranpath = $$fileref; }
 132         }
 133     }
 134
 135     if ( $error )
 136     {
 137         installer::exiter::exit_program("ERROR: Could not find all needed files in path!", "check_system_path");
 138     }
 139
 140     # checking for epm, which has to be in the path or in the solver
 141
 142     if (( $installer::globals::call_epm ) && (!($installer::globals::iswindowsbuild)))
 143     {
 144         my $onefile = "epm";
 145         my $fileref = installer::scriptitems::get_sourcepath_from_filename_and_includepath(\$onefile, $patharrayref , 0);
 146         if (!( $$fileref eq "" ))
 147         {
 148             $installer::globals::epm_in_path = 1;
 149
 150             if ( $$fileref =~ /^\s*\.\/epm\s*$/ )
 151             {
 152                 my $currentdir = cwd();
 153                 $$fileref =~ s/\./$currentdir/;
 154             }
 155
 156             $installer::globals::epm_path = $$fileref;
 157         }
 158     }
 159 }
 160
 161 ######################################################################
 162 # Determining the version of file makecab.exe
 163 ######################################################################
 164
 165 sub get_makecab_version
 166 {
 167     my $makecabversion = -1;
 168
 169     my $systemcall = "makecab.exe |";
 170     if ( $installer::globals::isunix )
 171     {
 172         $systemcall = "$ENV{'WORKDIR_FOR_BUILD'}/LinkTarget/Executable/makecab.exe |";
 173     }
 174     my @makecaboutput = ();
 175
 176     open (CAB, $systemcall);
 177     while (<CAB>) { push(@makecaboutput, $_); }
 178     close (CAB);
 179
 180     my $returnvalue = $?;   # $? contains the return value of the systemcall
 181
 182     if ($returnvalue)
 183     {
 184         $infoline = "ERROR: Could not execute \"$systemcall\"!\n";
 185         push( @installer::globals::globallogfileinfo, $infoline);
 186     }
 187     else
 188     {
 189         $infoline = "Success: Executed \"$systemcall\" successfully!\n";
 190         push( @installer::globals::globallogfileinfo, $infoline);
 191
 192         my $versionline = "";
 193
 194         for ( my $i = 0; $i <= $#makecaboutput; $i++ )
 195         {
 196             if ( $makecaboutput[$i] =~ /\bVersion\b/i )
 197             {
 198                 $versionline = $makecaboutput[$i];
 199                 last;
 200             }
 201         }
 202
 203         $infoline = $versionline;
 204         push( @installer::globals::globallogfileinfo, $infoline);
 205
 206         if ( $versionline =~ /\bVersion\b\s+(\d+[\d\.]+\d+)\s+/ )
 207         {
 208             $makecabversion = $1;
 209         }
 210
 211         # Only using the first number
 212
 213         if ( $makecabversion =~ /^\s*(\d+?)\D*/ )
 214         {
 215             $makecabversion = $1;
 216         }
 217
 218         $infoline = "Using version: " . $makecabversion . "\n";
 219         push( @installer::globals::globallogfileinfo, $infoline);
 220     }
 221
 222     return $makecabversion;
 223 }
 224
 225 ######################################################################
 226 # Checking the version of file makecab.exe
 227 ######################################################################
 228
 229 sub check_makecab_version
 230 {
 231     # checking version of makecab.exe
 232     # Now it is guaranteed, that makecab.exe is in the path
 233
 234     my $do_check = 1;
 235
 236     my $makecabversion = get_makecab_version();
 237
 238     my $infoline = "Tested version: " . $installer::globals::controlledmakecabversion . "\n";
 239     push( @installer::globals::globallogfileinfo, $infoline);
 240
 241     if ( $makecabversion < 0 ) { $do_check = 0; } # version could not be determined
 242
 243     if ( $do_check )
 244     {
 245         if ( $makecabversion < $installer::globals::controlledmakecabversion )
 246         {
 247             installer::exiter::exit_program("makecab.exe too old. Found version: \"$makecabversion\", required version: \"$installer::globals::controlledmakecabversion\"!", "check_makecab_version");
 248         }
 249     }
 250     else
 251     {
 252         $infoline = "Warning: No version check of makecab.exe\n";
 253         push( @installer::globals::globallogfileinfo, $infoline);
 254     }
 255 }
 256
 257 ######################################################################
 258 # Reading the environment variables for the paths in ziplist.
 259 # solarenvpath, os, pmiscpath
 260 ######################################################################
 261
 262 sub check_system_environment
 263 {
 264     my %variables = ();
 265     my $error = 0;
 266
 267     my @environmentvariables = qw(
 268         WORK_STAMP
 269         OUTPATH
 270         LOCAL_OUT
 271         LOCAL_COMMON_OUT
 272         WORKDIR
 273         SRCDIR
 274     );
 275
 276     for my $key ( @environmentvariables )
 277     {
 278         $variables{$key} = $ENV{$key} || "";
 279
 280         if ( $variables{$key} eq "" )
 281         {
 282             installer::logger::print_error( "$key not set in environment\n" );
 283             $error = 1;
 284         }
 285     }
 286
 287     if ( $error )
 288     {
 289         installer::exiter::exit_program("ERROR: Environment variable not set!", "check_system_environment");
 290     }
 291
 292     return \%variables;
 293 }
 294
 295 #############################################################
 296 # Controlling the log file at the end of the
 297 # packaging process
 298 #############################################################
 299
 300 sub check_logfile
 301 {
 302     my ($logfile) = @_;
 303
 304     my @errors = ();
 305     my @output = ();
 306     my $contains_error = 0;
 307
 308     my $ignore_error = 0;
 309     my $make_error_to_warning = 0;
 310
 311     for ( my $i = 0; $i <= $#{$logfile}; $i++ )
 312     {
 313         my $line = ${$logfile}[$i];
 314
 315         # Errors are all errors, but not the Windows installer table "Error.idt"
 316
 317         my $compareline = $line;
 318         $compareline =~ s/Error\.idt//g;    # removing all occurrences of "Error.idt"
 319         $compareline =~ s/Error\.ulf//g;    # removing all occurrences of "Error.ulf"
 320         $compareline =~ s/Error\.idl//g;    # removing all occurrences of "Error.idl"
 321         $compareline =~ s/Error\.html//g;   # removing all occurrences of "Error.html"
 322         $compareline =~ s/error\.py//g;     # removing all occurrences of "error.py"
 323         $compareline =~ s/error\.cpython-33\.py[oc]//g;  # removing all occurrences of "error-cpython"
 324         $compareline =~ s/libgpg-error-0.dll//g;
 325         $compareline =~ s/Error-xref\.html//g;
 326
 327         if ( $compareline =~ /\bError\b/i )
 328         {
 329             $contains_error = 1;
 330             push(@errors, $line);
 331
 332             if ( $ignore_error )
 333             {
 334                 $contains_error = 0;
 335                 $make_error_to_warning = 1;
 336             }
 337         }
 338     }
 339
 340     if ($contains_error)
 341     {
 342         my $line = "\n*********************************************************************\n";
 343         push(@output, $line);
 344         $line = "ERROR: The following errors occurred in packaging process:\n\n";
 345         push(@output, $line);
 346
 347         for ( my $i = 0; $i <= $#errors; $i++ )
 348         {
 349             $line = "$errors[$i]";
 350             push(@output, $line);
 351         }
 352
 353         $line = "*********************************************************************\n";
 354         push(@output, $line);
 355     }
 356     else
 357     {
 358         my $line = "";
 359
 360         if ( $make_error_to_warning )
 361         {
 362             $line = "\n*********************************************************************\n";
 363             push(@output, $line);
 364             $line = "The following errors in the log file were ignored:\n\n";
 365             push(@output, $line);
 366
 367             for ( my $i = 0; $i <= $#errors; $i++ )
 368             {
 369                 $line = "$errors[$i]";
 370                 push(@output, $line);
 371             }
 372
 373             $line = "*********************************************************************\n";
 374             push(@output, $line);
 375         }
 376
 377         $line = "\n***********************************************************\n";
 378         push(@output, $line);
 379         $line = "Successful packaging process!\n";
 380         push(@output, $line);
 381         $line = "***********************************************************\n";
 382         push(@output, $line);
 383     }
 384
 385     # printing the output file and adding it to the logfile
 386
 387     installer::logger::include_header_into_logfile("Summary:");
 388
 389     my $force = 1; # print this message even in 'quiet' mode
 390     for ( my $i = 0; $i <= $#output; $i++ )
 391     {
 392         my $line = "$output[$i]";
 393         installer::logger::print_message( "$line", $force );
 394         push( @installer::globals::logfileinfo, $line);
 395         push( @installer::globals::errorlogfileinfo, $line);
 396     }
 397
 398     return $contains_error;
 399 }
 400
 401 #############################################################
 402 # Reading the Windows list file for Windows language codes
 403 # Encoding field is no longer used. We use UTF-8 everywhere.
 404 #############################################################
 405
 406 sub read_lcidlist
 407 {
 408     my ($patharrayref) = @_;
 409
 410     if ( ! -f $installer::globals::lcidlistname ) { installer::exiter::exit_program("ERROR: Did not find Windows LCID list $installer::globals::lcidlistname!", "read_lcidlist"); }
 411
 412     my $infoline = "Found LCID file: $installer::globals::lcidlistname\n";
 413     push(@installer::globals::globallogfileinfo, $infoline);
 414
 415     my $lcidlist = installer::files::read_file($installer::globals::lcidlistname);
 416     my %msilanguage = ();
 417
 418     for ( my $i = 0; $i <= $#{$lcidlist}; $i++ )
 419     {
 420         my $line = ${$lcidlist}[$i];
 421         # de-mangle various potential DOS line-ending problems
 422         $line =~ s/\r//g;
 423         $line =~ s/\n//g;
 424         $line =~ s/\s*\#.*$//; # removing comments after "#"
 425         if ( $line =~ /^\s*$/ ) { next; }  # this is an empty line
 426
 427         if ( $line =~ /^\s*([\w-]+)\s+(\d+)\s+(\d+)\s*$/ )
 428         {
 429             my $onelanguage = $1;
 430             my $windowslanguage = $3;
 431             $msilanguage{$onelanguage} = $windowslanguage;
 432         }
 433         else
 434         {
 435             installer::exiter::exit_program("ERROR: Wrong syntax in Windows LCID list $installer::globals::lcidlistname in line $i: '$line'", "read_lcidlist");
 436         }
 437     }
 438     $installer::globals::msilanguage = \%msilanguage;
 439 }
 440
 441 #############################################################
 442 # Only for Windows and Linux (RPM)there is currently
 443 # a reliable mechanism to register extensions during
 444 # installation process. Therefore it is for all other
 445 # platforms forbidden to install oxt files into that
 446 # directory, in which they are searched for registration.
 447 #############################################################
 448
 449 sub check_oxtfiles
 450 {
 451     my ( $filesarray ) = @_;
 452
 453     for ( my $i = 0; $i <= $#{$filesarray}; $i++ )
 454     {
 455         my $onefile = ${$filesarray}[$i];
 456
 457         if (( $onefile->{'Name'} ) && ( $onefile->{'Dir'} ))
 458         {
 459             if (( $onefile->{'Name'} =~ /\.oxt\s*$/ ) && ( $onefile->{'Dir'} eq $installer::globals::extensioninstalldir ))
 460             {
 461                 installer::exiter::exit_program("There is currently only for Linux (RPM) and Windows a reliable mechanism to register extensions during installation.\nPlease remove file \"$onefile->{'gid'}\" from your installation set!\nYou can use \"\#ifdef WNT\" and \"\#ifdef LINUX\" in scp.", "check_oxtfiles");
 462             }
 463         }
 464     }
 465 }
 466
 467 #######################################################################
 468 # Setting global variable "$installer::globals::addsystemintegration"
 469 #######################################################################
 470
 471 sub set_addsystemintegration
 472 {
 473     my ($allvariables) = @_;
 474
 475     if ( $allvariables->{'ADDSYSTEMINTEGRATION'} ) { $installer::globals::addsystemintegration = 1; }
 476
 477     if ( $installer::globals::languagepack ) { $installer::globals::addsystemintegration = 0; }
 478     if ( $installer::globals::helppack ) { $installer::globals::addsystemintegration = 0; }
 479     if (( $installer::globals::packageformat eq "native" ) || ( $installer::globals::packageformat eq "portable" )) { $installer::globals::addsystemintegration = 0; }
 480
 481     my $infoline = "Value of \$installer::globals::addsystemintegration: $installer::globals::addsystemintegration\n";
 482     push( @installer::globals::globallogfileinfo, $infoline);
 483 }
 484
 485 1;