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