solenv/bin/modules/installer/windows/update.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::windows::update;
  20
  21 use strict;
  22 use warnings;
  23
  24 use installer::converter;
  25 use installer::exiter;
  26 use installer::files;
  27 use installer::globals;
  28 use installer::pathanalyzer;
  29 use installer::systemactions;
  30
  31 #################################################################################
  32 # Extracting all tables from an msi database
  33 #################################################################################
  34
  35 sub extract_all_tables_from_msidatabase
  36 {
  37     my ($fulldatabasepath, $workdir) = @_;
  38
  39     my $msidb = "msidb.exe";    # Has to be in the path
  40     my $infoline = "";
  41     my $systemcall = "";
  42     my $returnvalue = "";
  43     my $extraslash = "";        # Has to be set for non-ActiveState perl
  44
  45     # Export of all tables by using "*"
  46
  47     if ( $^O =~ /cygwin/i ) {
  48         # msidb.exe really wants backslashes. (And double escaping because system() expands the string.)
  49         $fulldatabasepath =~ s/\//\\\\/g;
  50         $workdir =~ s/\//\\\\/g;
  51         $extraslash = "\\";
  52     }
  53     if ( $^O =~ /linux/i) {
  54         $extraslash = "\\";
  55     }
  56
  57     $systemcall = $msidb . " -d " . $fulldatabasepath . " -f " . $workdir . " -e " . $extraslash . "*";
  58     $returnvalue = system($systemcall);
  59
  60     $infoline = "Systemcall: $systemcall\n";
  61     push( @installer::globals::logfileinfo, $infoline);
  62
  63     if ($returnvalue)
  64     {
  65         $infoline = "ERROR: Could not execute $systemcall !\n";
  66         push( @installer::globals::logfileinfo, $infoline);
  67         installer::exiter::exit_program("ERROR: Could not exclude tables from msi database: $fulldatabasepath !", "extract_all_tables_from_msidatabase");
  68     }
  69     else
  70     {
  71         $infoline = "Success: Executed $systemcall successfully!\n";
  72         push( @installer::globals::logfileinfo, $infoline);
  73     }
  74 }
  75
  76 #################################################################################
  77 # Collecting the keys from the first line of the idt file
  78 #################################################################################
  79
  80 sub collect_all_keys
  81 {
  82     my ($line) = @_;
  83
  84     my @allkeys = ();
  85     my $rownumber = 0;
  86     my $onekey = "";
  87
  88     while ( $line =~ /^\s*(\S+?)\t(.*)$/ )
  89     {
  90         $onekey = $1;
  91         $line = $2;
  92         $rownumber++;
  93         push(@allkeys, $onekey);
  94     }
  95
  96     # and the last key
  97
  98     $onekey = $line;
  99     $onekey =~ s/^\s*//g;
 100     $onekey =~ s/\s*$//g;
 101
 102     $rownumber++;
 103     push(@allkeys, $onekey);
 104
 105     return (\@allkeys, $rownumber);
 106 }
 107
 108 #################################################################################
 109 # Analyzing the content of one line of an idt file
 110 #################################################################################
 111
 112 sub get_oneline_hash
 113 {
 114     my ($line, $allkeys, $rownumber) = @_;
 115
 116     my $counter = 0;
 117     my %linehash = ();
 118
 119     $line =~ s/^\s*//;
 120     $line =~ s/\s*$//;
 121
 122     my $value = "";
 123     my $onekey = "";
 124
 125     while ( $line =~ /^(.*?)\t(.*)$/ )
 126     {
 127         $value = $1;
 128         $line = $2;
 129         $onekey = ${$allkeys}[$counter];
 130         $linehash{$onekey} = $value;
 131         $counter++;
 132     }
 133
 134     # the last column
 135
 136     $value = $line;
 137     $onekey = ${$allkeys}[$counter];
 138
 139     $linehash{$onekey} = $value;
 140
 141     return \%linehash;
 142 }
 143
 144 #################################################################################
 145 # Analyzing the content of an idt file
 146 #################################################################################
 147
 148 sub analyze_idt_file
 149 {
 150     my ($filecontent) = @_;
 151
 152     my %table = ();
 153     # keys are written in first line
 154     my ($allkeys, $rownumber) = collect_all_keys(${$filecontent}[0]);
 155
 156     for ( my $i = 0; $i <= $#{$filecontent}; $i++ )
 157     {
 158         if (( $i == 0 ) || ( $i == 1 ) || ( $i == 2 )) { next; }
 159
 160         my $onelinehash = get_oneline_hash(${$filecontent}[$i], $allkeys, $rownumber);
 161         my $linekey = $i - 2;  # ! : The linenumber is the unique key !? Always decrease by two, because of removed first three lines.
 162         $table{$linekey} = $onelinehash;
 163     }
 164
 165     return \%table;
 166 }
 167
 168 #################################################################################
 169 # Reading all idt files in a specified directory
 170 #################################################################################
 171
 172 sub read_all_tables_from_msidatabase
 173 {
 174     my ($workdir) = @_;
 175
 176     my %database = ();
 177
 178     my $ext = "idt";
 179
 180     my $allidtfiles = installer::systemactions::find_file_with_file_extension($ext, $workdir);
 181
 182     for ( my $i = 0; $i <= $#{$allidtfiles}; $i++ )
 183     {
 184         my $onefilename = ${$allidtfiles}[$i];
 185         my $longonefilename = $workdir . $installer::globals::separator . $onefilename;
 186         if ( ! -f $longonefilename ) { installer::exiter::exit_program("ERROR: Could not find idt file: $longonefilename!", "read_all_tables_from_msidatabase"); }
 187         my $filecontent = installer::files::read_file($longonefilename);
 188         my $idtcontent = analyze_idt_file($filecontent);
 189         if ($onefilename eq "Directory.idt") {
 190             collect_directories($filecontent, $longonefilename);
 191         }
 192         my $key = $onefilename;
 193         $key =~ s/\.idt\s*$//;
 194         $database{$key} = $idtcontent;
 195     }
 196
 197     return \%database;
 198 }
 199
 200 #################################################################################
 201 # Checking, if this is the correct database.
 202 #################################################################################
 203
 204 sub correct_database
 205 {
 206     my ($product, $pro, $langs, $languagestringref) = @_;
 207
 208     my $correct_database = 0;
 209
 210     # Comparing $product with $installer::globals::product and
 211     # $pro with $installer::globals::pro and
 212     # $langs with $languagestringref
 213
 214     my $product_is_good = 0;
 215
 216     my $localproduct = $installer::globals::product;
 217     if ( $installer::globals::languagepack ) { $localproduct = $localproduct . "LanguagePack"; }
 218     elsif ( $installer::globals::helppack ) { $localproduct = $localproduct . "HelpPack"; }
 219
 220     if ( $product eq $localproduct ) { $product_is_good = 1; }
 221
 222     if ( $product_is_good )
 223     {
 224         my $pro_is_good = 0;
 225
 226         if ((( $pro eq "pro" ) && ( $installer::globals::pro )) || (( $pro eq "nonpro" ) && ( ! $installer::globals::pro ))) { $pro_is_good = 1; }
 227
 228         if ( $pro_is_good )
 229         {
 230             my $langlisthash = installer::converter::convert_stringlist_into_hash(\$langs, ",");
 231             my $langstringhash = installer::converter::convert_stringlist_into_hash($languagestringref, "_");
 232
 233             my $not_included = 0;
 234             foreach my $onelang ( keys %{$langlisthash} )
 235             {
 236                 if ( ! exists($langstringhash->{$onelang}) )
 237                 {
 238                     $not_included = 1;
 239                     last;
 240                 }
 241             }
 242
 243             if ( ! $not_included )
 244             {
 245                 foreach my $onelanguage ( keys %{$langstringhash} )
 246                 {
 247                     if ( ! exists($langlisthash->{$onelanguage}) )
 248                     {
 249                         $not_included = 1;
 250                         last;
 251                     }
 252                 }
 253
 254                 if ( ! $not_included ) { $correct_database = 1; }
 255             }
 256         }
 257     }
 258
 259     return $correct_database;
 260 }
 261
 262 #################################################################################
 263 # Searching for the path to the reference database for this special product.
 264 #################################################################################
 265
 266 sub get_databasename_from_list
 267 {
 268     my ($filecontent, $languagestringref, $filename) = @_;
 269
 270     my $databasepath = "";
 271
 272     for ( my $i = 0; $i <= $#{$filecontent}; $i++ )
 273     {
 274         my $line = ${$filecontent}[$i];
 275         if ( $line =~ /^\s*$/ ) { next; } # empty line
 276         if ( $line =~ /^\s*\#/ ) { next; } # comment line
 277
 278         if ( $line =~ /^\s*(.+?)\s*\t+\s*(.+?)\s*\t+\s*(.+?)\s*\t+\s*(.+?)\s*$/ )
 279         {
 280             my $product = $1;
 281             my $pro = $2;
 282             my $langs = $3;
 283             my $path = $4;
 284
 285             if (( $pro ne "pro" ) && ( $pro ne "nonpro" )) { installer::exiter::exit_program("ERROR: Wrong syntax in file: $filename. Only \"pro\" or \"nonpro\" allowed in column 1! Line: \"$line\"", "get_databasename_from_list"); }
 286
 287             if ( correct_database($product, $pro, $langs, $languagestringref) )
 288             {
 289                 $databasepath = $path;
 290                 last;
 291             }
 292         }
 293         else
 294         {
 295             installer::exiter::exit_program("ERROR: Wrong syntax in file: $filename! Line: \"$line\"", "get_databasename_from_list");
 296         }
 297     }
 298
 299     return $databasepath;
 300 }
 301
 302 #################################################################################
 303 # Reading an existing database completely
 304 #################################################################################
 305
 306 sub readdatabase
 307 {
 308     my ($allvariables, $languagestringref, $includepatharrayref) = @_;
 309
 310     my $database = "";
 311     my $infoline = "";
 312
 313     if ( ! $allvariables->{'UPDATE_DATABASE_LISTNAME'} ) { installer::exiter::exit_program("ERROR: If \"UPDATE_DATABASE\" is set, \"UPDATE_DATABASE_LISTNAME\" is required.", "Main"); }
 314     my $listfilename = $allvariables->{'UPDATE_DATABASE_LISTNAME'};
 315
 316     # Searching the list in the include paths
 317     my $listname = installer::scriptitems::get_sourcepath_from_filename_and_includepath(\$listfilename, $includepatharrayref, 1);
 318     if ( $$listname eq "" ) { installer::exiter::exit_program("ERROR: List file not found: $listfilename !", "readdatabase"); }
 319     my $completelistname = $$listname;
 320
 321     # Reading list file
 322     my $listfile = installer::files::read_file($completelistname);
 323
 324     # Get name and path of reference database
 325     my $databasename = get_databasename_from_list($listfile, $languagestringref, $completelistname);
 326
 327     # If the correct database was not found, this is not necessarily an error. But in this case, this is not an update packaging process!
 328     if (( $databasename ) && ( $databasename ne "" )) # This is an update packaging process!
 329     {
 330         $installer::globals::updatedatabase = 1;
 331         installer::logger::print_message( "... update process, using database $databasename ...\n" );
 332         $infoline = "\nDatabase found in $completelistname: \"$databasename\"\n\n";
 333         # Saving in global variable
 334         $installer::globals::updatedatabasepath = $databasename;
 335     }
 336     else
 337     {
 338         $infoline = "\nNo database found in $completelistname. This is no update process!\n\n";
 339     }
 340     push( @installer::globals::logfileinfo, $infoline);
 341
 342     if ( $installer::globals::updatedatabase )
 343     {
 344         if ( ! -f $databasename ) { installer::exiter::exit_program("ERROR: Could not find reference database: $databasename!", "readdatabase"); }
 345
 346         my $msifilename = $databasename;
 347         installer::pathanalyzer::make_absolute_filename_to_relative_filename(\$msifilename);
 348
 349         installer::logger::include_timestamp_into_logfile("Performance Info: readdatabase start");
 350
 351         # create directory for unpacking
 352         my $databasedir = installer::systemactions::create_directories("database", $languagestringref);
 353
 354         # copy database
 355         my $fulldatabasepath = $databasedir . $installer::globals::separator . $msifilename;
 356         installer::systemactions::copy_one_file($databasename, $fulldatabasepath);
 357
 358         installer::logger::include_timestamp_into_logfile("Performance Info: readdatabase: before extracting tables");
 359
 360         # extract all tables from database
 361         extract_all_tables_from_msidatabase($fulldatabasepath, $databasedir);
 362
 363         installer::logger::include_timestamp_into_logfile("Performance Info: readdatabase: before reading tables");
 364
 365         # read all tables
 366         $database = read_all_tables_from_msidatabase($databasedir);
 367
 368         # Test output:
 369
 370         #   foreach my $key1 ( keys %{$database} )
 371         #   {
 372         #       print "Test1: $key1\n";
 373         #       foreach my $key2 ( keys %{$database->{$key1}} )
 374         #       {
 375         #           print "\tTest2: $key2\n";
 376         #           foreach my $key3 ( keys %{$database->{$key1}->{$key2}} )
 377         #           {
 378         #               print "\t\tTest3: $key3: $database->{$key1}->{$key2}->{$key3}\n";
 379         #           }
 380         #       }
 381         #   }
 382
 383         # Example: File table
 384
 385         # my $filetable = $database->{'File'};
 386         # foreach my $linenumber ( keys  %{$filetable} )
 387         # {
 388         #   print "Test Filenumber: $linenumber\n";
 389         #   foreach my $key ( keys %{$filetable->{$linenumber}} )
 390         #   {
 391         #       print "\t\tTest: $key: $filetable->{$linenumber}->{$key}\n";
 392         #   }
 393         # }
 394
 395         # Example: Searching for ProductCode in table Property
 396
 397         # my $column1 = "Property";
 398         # my $column2 = "Value";
 399         # my $searchkey = "ProductCode";
 400         # my $propertytable = $database->{'Property'};
 401         # foreach my $linenumber ( keys  %{$propertytable} )
 402         # {
 403         #   if ( $propertytable->{$linenumber}->{$column1} eq $searchkey )
 404         #   {
 405         #       print("Test: $searchkey : $propertytable->{$linenumber}->{$column2}\n");
 406         #   }
 407         # }
 408
 409         installer::logger::include_timestamp_into_logfile("Performance Info: readdatabase end");
 410     }
 411
 412     return $database;
 413 }
 414
 415 #########################################################################
 416 # Reading the file "Directory.idt".
 417 #########################################################################
 418
 419 sub collect_directories
 420 {
 421     my ($filecontent, $idtfilename) = @_;
 422
 423     for ( my $i = 0; $i <= $#{$filecontent}; $i++ )
 424     {
 425         if ( $i <= 2 ) { next; }                        # ignoring first three lines
 426         if ( ${$filecontent}[$i] =~ /^\s*$/ ) { next; } # ignoring empty lines
 427         # Format: Directory Directory_Parent    DefaultDir
 428         if ( ${$filecontent}[$i] =~ /^\s*(.+?)\t(.*?)\t(.*?)\s*$/ )
 429         {
 430             $installer::globals::merge_directory_hash{$1} = 1;
 431         }
 432         else
 433         {
 434             my $linecount = $i + 1;
 435             installer::exiter::exit_program("ERROR: Unknown line format in table \"$idtfilename\" (line $linecount) !", "collect_directories");
 436         }
 437     }
 438 }
 439
 440 #################################################################################
 441 # Files can be included in merge modules. This is also important for update.
 442 #################################################################################
 443
 444 sub readmergedatabase
 445 {
 446     my ( $mergemodules, $languagestringref, $includepatharrayref ) = @_;
 447
 448     installer::logger::include_timestamp_into_logfile("Performance Info: readmergedatabase start");
 449
 450     my $mergemoduledir = installer::systemactions::create_directories("mergedatabase", $languagestringref);
 451
 452     my %allmergefiles = ();
 453
 454     foreach my $mergemodule ( @{$mergemodules} )
 455     {
 456         my $filename = $mergemodule->{'Name'};
 457         my $mergefile = $ENV{'MSM_PATH'} . $filename;
 458
 459         if ( ! -f $mergefile ) { installer::exiter::exit_program("ERROR: msm file not found: $filename !", "readmergedatabase"); }
 460         my $completesource = $mergefile;
 461
 462         my $mergegid = $mergemodule->{'gid'};
 463         my $workdir = $mergemoduledir . $installer::globals::separator . $mergegid;
 464         if ( ! -d $workdir ) { installer::systemactions::create_directory($workdir); }
 465
 466         my $completedest = $workdir . $installer::globals::separator . $filename;
 467         installer::systemactions::copy_one_file($completesource, $completedest);
 468         if ( ! -f $completedest ) { installer::exiter::exit_program("ERROR: msm file not found: $completedest !", "readmergedatabase"); }
 469
 470         # extract all tables from database
 471         extract_all_tables_from_msidatabase($completedest, $workdir);
 472
 473         # read all tables
 474         my $onemergefile = read_all_tables_from_msidatabase($workdir);
 475
 476         $allmergefiles{$mergegid} = $onemergefile;
 477     }
 478
 479     foreach my $mergefilegid ( keys %allmergefiles )
 480     {
 481         my $onemergefile = $allmergefiles{$mergefilegid};
 482         my $filetable = $onemergefile->{'File'};
 483
 484         foreach my $linenumber ( keys %{$filetable} )
 485         {
 486             # Collecting all files from merge modules in global hash
 487             $installer::globals::mergemodulefiles{$filetable->{$linenumber}->{'File'}} = 1;
 488         }
 489     }
 490
 491     installer::logger::include_timestamp_into_logfile("Performance Info: readmergedatabase end");
 492 }
 493
 494 #################################################################################
 495 # Creating several useful hashes from old database
 496 #################################################################################
 497
 498 sub create_database_hashes
 499 {
 500     my ( $database ) = @_;
 501
 502     # 1. Hash ( Component -> UniqueFileName ), required in File table.
 503     # Read from File table.
 504
 505     my %uniquefilename = ();
 506     my %allupdatesequences = ();
 507     my %allupdatecomponents = ();
 508     my %allupdatefileorder = ();
 509     my %allupdatecomponentorder = ();
 510     my %revuniquefilename = ();
 511     my %revshortfilename = ();
 512     my %shortdirname = ();
 513     my %componentid = ();
 514     my %componentidkeypath = ();
 515     my %alloldproperties = ();
 516     my %allupdatelastsequences = ();
 517     my %allupdatediskids = ();
 518
 519     my $filetable = $database->{'File'};
 520
 521     foreach my $linenumber ( keys  %{$filetable} )
 522     {
 523         my $comp = $filetable->{$linenumber}->{'Component_'};
 524         my $uniquename = $filetable->{$linenumber}->{'File'};
 525         my $filename = $filetable->{$linenumber}->{'FileName'};
 526         my $sequence = $filetable->{$linenumber}->{'Sequence'};
 527
 528         my $shortname = "";
 529         if ( $filename =~ /^\s*(.*?)\|\s*(.*?)\s*$/ )
 530         {
 531             $shortname = $1;
 532             $filename = $2;
 533         }
 534
 535         # unique is the combination of $component and $filename
 536         my $key = "$comp/$filename";
 537
 538         if ( exists($uniquefilename{$key}) ) { installer::exiter::exit_program("ERROR: Component/FileName \"$key\" is not unique in table \"File\" !", "create_database_hashes"); }
 539
 540         my $value = $uniquename;
 541         if ( $shortname ne "" ) { $value = "$uniquename;$shortname"; }
 542         $uniquefilename{$key} = $value; # saving the unique keys and short names in hash
 543
 544         # Saving reverse keys too
 545         $revuniquefilename{$uniquename} = $key;
 546         if ( $shortname ne "" ) { $revshortfilename{$shortname} = $key; }
 547
 548         # Saving Sequences for unique names (and also components)
 549         $allupdatesequences{$uniquename} = $sequence;
 550         $allupdatecomponents{$uniquename} = $comp;
 551
 552         # Saving unique names and components for sequences
 553         $allupdatefileorder{$sequence} = $uniquename;
 554         $allupdatecomponentorder{$sequence} = $comp;
 555     }
 556
 557     # 2. Hash, required in Directory table.
 558
 559     my $dirtable = $database->{'Directory'};
 560
 561     foreach my $linenumber ( keys  %{$dirtable} )
 562     {
 563         my $dir = $dirtable->{$linenumber}->{'Directory'}; # this is a unique name
 564         my $defaultdir = $dirtable->{$linenumber}->{'DefaultDir'};
 565
 566         my $shortname = "";
 567         if ( $defaultdir =~ /^\s*(.*?)\|\s*(.*?)\s*$/ )
 568         {
 569             $shortname = $1;
 570             $shortdirname{$dir} = $shortname;   # collecting only the short names
 571         }
 572     }
 573
 574     # 3. Hash, collecting info from Component table.
 575     # ComponentID and KeyPath have to be reused.
 576
 577     my $comptable = $database->{'Component'};
 578
 579     foreach my $linenumber ( keys  %{$comptable} )
 580     {
 581         my $comp = $comptable->{$linenumber}->{'Component'};
 582         my $compid = $comptable->{$linenumber}->{'ComponentId'};
 583         my $keypath = $comptable->{$linenumber}->{'KeyPath'};
 584
 585         $componentid{$comp} = $compid;
 586         $componentidkeypath{$comp} = $keypath;
 587     }
 588
 589     # 4. Hash, property table, required for ProductCode and Installlocation.
 590
 591     my $proptable = $database->{'Property'};
 592
 593     foreach my $linenumber ( keys  %{$proptable} )
 594     {
 595         my $prop = $proptable->{$linenumber}->{'Property'};
 596         my $value = $proptable->{$linenumber}->{'Value'};
 597
 598         $alloldproperties{$prop} = $value;
 599     }
 600
 601     # 5. Media table, getting last sequence
 602
 603     my $mediatable = $database->{'Media'};
 604     $installer::globals::updatelastsequence = 0;
 605
 606     foreach my $linenumber ( keys  %{$mediatable} )
 607     {
 608         my $cabname = $mediatable->{$linenumber}->{'Cabinet'};
 609         my $lastsequence = $mediatable->{$linenumber}->{'LastSequence'};
 610         my $diskid = $mediatable->{$linenumber}->{'DiskId'};
 611         $allupdatelastsequences{$cabname} = $lastsequence;
 612         $allupdatediskids{$cabname} = $diskid;
 613
 614         if ( $lastsequence > $installer::globals::updatelastsequence ) { $installer::globals::updatelastsequence = $lastsequence; }
 615     }
 616
 617     $installer::globals::updatesequencecounter = $installer::globals::updatelastsequence;
 618
 619     return (\%uniquefilename, \%revuniquefilename, \%revshortfilename, \%allupdatesequences, \%allupdatecomponents, \%allupdatefileorder, \%allupdatecomponentorder, \%shortdirname, \%componentid, \%componentidkeypath, \%alloldproperties, \%allupdatelastsequences, \%allupdatediskids);
 620 }
 621
 622
 623 1;