solenv/bin/modules/installer/windows/component.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::component;
  20
  21 use installer::exiter;
  22 use installer::files;
  23 use installer::globals;
  24 use installer::windows::idtglobal;
  25 use installer::windows::language;
  26
  27 ##############################################################
  28 # Returning a globally unique ID (GUID) for a component
  29 # If the component is new, a unique guid has to be created.
  30 # If the component already exists, the guid has to be
  31 # taken from a list component <-> guid
  32 # Sample for a guid: {B68FD953-3CEF-4489-8269-8726848056E8}
  33 ##############################################################
  34
  35 sub get_component_guid
  36 {
  37     my ( $componentname, $componentidhashref ) = @_;
  38
  39     # At this time only a template
  40     my $returnvalue = "\{COMPONENTGUID\}";
  41
  42     if (( $installer::globals::updatedatabase ) && ( exists($componentidhashref->{$componentname}) ))
  43     {
  44         $returnvalue = $componentidhashref->{$componentname};
  45     }
  46
  47     # Returning a ComponentID, that is assigned in scp project
  48     if ( exists($installer::globals::componentid{$componentname}) )
  49     {
  50         $returnvalue = "\{" . $installer::globals::componentid{$componentname} . "\}";
  51     }
  52
  53     return $returnvalue;
  54 }
  55
  56 ##############################################################
  57 # Returning the directory for a file component.
  58 ##############################################################
  59
  60 sub get_file_component_directory
  61 {
  62     my ($componentname, $filesref, $dirref) = @_;
  63
  64     my ($onefile, $component, $onedir, $hostname, $uniquedir);
  65     my $found = 0;
  66
  67     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
  68     {
  69         $onefile =  ${$filesref}[$i];
  70         $component = $onefile->{'componentname'};
  71
  72         if ( $component eq $componentname )
  73         {
  74             $found = 1;
  75             last;
  76         }
  77     }
  78
  79     if (!($found))
  80     {
  81         # This component can be ignored, if it exists in a version with extension "_pff" (this was renamed in file::get_sequence_for_file() )
  82         my $ignore_this_component = 0;
  83         my $origcomponentname = $componentname;
  84         my $componentname = $componentname . "_pff";
  85
  86         for ( my $j = 0; $j <= $#{$filesref}; $j++ )
  87         {
  88             $onefile =  ${$filesref}[$j];
  89             $component = $onefile->{'componentname'};
  90
  91             if ( $component eq $componentname )
  92             {
  93                 $ignore_this_component = 1;
  94                 last;
  95             }
  96         }
  97
  98         if ( $ignore_this_component ) { return "IGNORE_COMP"; }
  99         else { installer::exiter::exit_program("ERROR: Did not find component \"$origcomponentname\" in file collection", "get_file_component_directory"); }
 100     }
 101
 102     my $localstyles = "";
 103
 104     if ( $onefile->{'Styles'} ) { $localstyles = $onefile->{'Styles'}; }
 105
 106     if ( $localstyles =~ /\bFONT\b/ )   # special handling for font files
 107     {
 108         return $installer::globals::fontsfolder;
 109     }
 110
 111     my $destdir = "";
 112
 113     if ( $onefile->{'Dir'} ) { $destdir = $onefile->{'Dir'}; }
 114
 115     my $destination = $onefile->{'destination'};
 116
 117     installer::pathanalyzer::get_path_from_fullqualifiedname(\$destination);
 118
 119     $destination =~ s/\Q$installer::globals::separator\E\s*$//;
 120
 121     # This path has to be defined in the directory collection at "HostName"
 122
 123     if ($destination eq "")     # files in the installation root
 124     {
 125         $uniquedir = "INSTALLLOCATION";
 126     }
 127     else
 128     {
 129         $found = 0;
 130
 131         for ( my $i = 0; $i <= $#{$dirref}; $i++ )
 132         {
 133             $onedir =   ${$dirref}[$i];
 134             $hostname = $onedir->{'HostName'};
 135
 136             if ( $hostname eq $destination )
 137             {
 138                 $found = 1;
 139                 last;
 140             }
 141         }
 142
 143         if (!($found))
 144         {
 145             installer::exiter::exit_program("ERROR: Did not find destination $destination in directory collection", "get_file_component_directory");
 146         }
 147
 148         $uniquedir = $onedir->{'uniquename'};
 149
 150         if ( $uniquedir eq $installer::globals::officeinstalldirectory )
 151         {
 152             $uniquedir = "INSTALLLOCATION";
 153         }
 154     }
 155
 156     $onefile->{'uniquedirname'} = $uniquedir;       # saving it in the file collection
 157
 158     return $uniquedir
 159 }
 160
 161 ##############################################################
 162 # Returning the directory for a registry component.
 163 # This cannot be a useful value
 164 ##############################################################
 165
 166 sub get_registry_component_directory
 167 {
 168     my $componentdir = "INSTALLLOCATION";
 169
 170     return $componentdir;
 171 }
 172
 173 ##############################################################
 174 # Returning the attributes for a file component.
 175 ##############################################################
 176
 177 sub get_file_component_attributes
 178 {
 179     my ($componentname, $filesref, $allvariables) = @_;
 180
 181     my $attributes;
 182
 183     $attributes = 2;
 184
 185     # special handling for font files
 186
 187     my $onefile;
 188     my $found = 0;
 189
 190     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
 191     {
 192         $onefile =  ${$filesref}[$i];
 193         my $component = $onefile->{'componentname'};
 194
 195         if ( $component eq $componentname )
 196         {
 197             $found = 1;
 198             last;
 199         }
 200     }
 201
 202     if (!($found))
 203     {
 204         installer::exiter::exit_program("ERROR: Did not find component in file collection", "get_file_component_attributes");
 205     }
 206
 207     my $localstyles = "";
 208
 209     if ( $onefile->{'Styles'} ) { $localstyles = $onefile->{'Styles'}; }
 210
 211     if ( $localstyles =~ /\bFONT\b/ )
 212     {
 213         $attributes = 8;    # font files will be deinstalled if the ref count is 0
 214     }
 215
 216     if ( $localstyles =~ /\bASSEMBLY\b/ )
 217     {
 218         $attributes = 0;    # Assembly files cannot run from source
 219     }
 220
 221     if ( $onefile->{'needs_user_registry_key'} )
 222     {
 223         $attributes = 4;    # Files in non advertised startmenu entries must have user registry key as KeyPath
 224     }
 225
 226     # Setting msidbComponentAttributes64bit, if this is a 64 bit installation set.
 227     if (( $allvariables->{'64BITPRODUCT'} ) && ( $allvariables->{'64BITPRODUCT'} == 1 )) { $attributes |= 256; }
 228
 229     return $attributes;
 230 }
 231
 232 ##############################################################
 233 # Returning the attributes for a registry component.
 234 # Always 4, indicating, the keypath is a defined in
 235 # table registry
 236 ##############################################################
 237
 238 sub get_registry_component_attributes
 239 {
 240     my ($componentname, $allvariables) = @_;
 241
 242     my $attributes;
 243
 244     $attributes = 4;
 245
 246     # Setting msidbComponentAttributes64bit, if this is a 64 bit installation set.
 247     if (( $allvariables->{'64BITPRODUCT'} ) && ( $allvariables->{'64BITPRODUCT'} == 1 )) { $attributes |= 256; }
 248
 249     # Setting msidbComponentAttributes64bit for 64 bit shell extension in 32 bit installer, too
 250     if ( $componentname =~ m/winexplorerext_x64/ ) { $attributes |= 256; }
 251
 252     # Setting msidbComponentAttributesPermanent
 253     if ( exists($installer::globals::dontdeletecomponents{$componentname}) ) { $attributes |= 16; }
 254
 255     return $attributes;
 256 }
 257
 258 ##############################################################
 259 # Returning the conditions for a component.
 260 # This is important for language dependent components
 261 # in multilingual installation sets.
 262 ##############################################################
 263
 264 sub get_file_component_condition
 265 {
 266     my ($componentname, $filesref) = @_;
 267
 268     my $condition = "";
 269
 270     if (exists($installer::globals::componentcondition{$componentname}))
 271     {
 272         $condition = $installer::globals::componentcondition{$componentname};
 273     }
 274
 275     # there can be also tree conditions for multilayer products
 276     if (exists($installer::globals::treeconditions{$componentname}))
 277     {
 278         if ( $condition eq "" )
 279         {
 280             $condition = $installer::globals::treeconditions{$componentname};
 281         }
 282         else
 283         {
 284             $condition = "($condition) And ($installer::globals::treeconditions{$componentname})";
 285         }
 286     }
 287
 288     return $condition
 289 }
 290
 291 ##############################################################
 292 # Returning the conditions for a registry component.
 293 ##############################################################
 294
 295 sub get_component_condition
 296 {
 297     my ($componentname) = @_;
 298
 299     my $condition;
 300
 301     $condition = "";    # Always ?
 302
 303     if (exists($installer::globals::componentcondition{$componentname}))
 304     {
 305         $condition = $installer::globals::componentcondition{$componentname};
 306     }
 307
 308     return $condition
 309 }
 310
 311 ####################################################################
 312 # Returning the keypath for a component.
 313 # This will be the name of the first file/registry, found in the
 314 # collection $itemsref
 315 # Attention: This has to be the unique (file)name, not the
 316 # real filename!
 317 ####################################################################
 318
 319 sub get_component_keypath
 320 {
 321     my ($componentname, $itemsref, $componentidkeypathhashref) = @_;
 322
 323     my $oneitem;
 324     my $found = 0;
 325     my $infoline = "";
 326
 327     for ( my $i = 0; $i <= $#{$itemsref}; $i++ )
 328     {
 329         $oneitem =  ${$itemsref}[$i];
 330         my $component = $oneitem->{'componentname'};
 331
 332         if ( $component eq $componentname )
 333         {
 334             $found = 1;
 335             last;
 336         }
 337     }
 338
 339     if (!($found))
 340     {
 341         installer::exiter::exit_program("ERROR: Did not find component in file/registry collection, function get_component_keypath", "get_component_keypath");
 342     }
 343
 344     my $keypath = $oneitem->{'uniquename'}; # "uniquename", not "Name"
 345
 346     # Special handling for updates from existing databases, because KeyPath must not change
 347     if (( $installer::globals::updatedatabase ) && ( exists($componentidkeypathhashref->{$componentname}) ))
 348     {
 349         $keypath = $componentidkeypathhashref->{$componentname};
 350         # -> check, if this is a valid key path?!
 351         if ( $keypath ne $oneitem->{'uniquename'} )
 352         {
 353             # Warning: This keypath was changed because of info from old database
 354             $infoline = "WARNING: The KeyPath for component \"$componentname\" was changed from \"$oneitem->{'uniquename'}\" to \"$keypath\" because of information from update database";
 355             push(@installer::globals::logfileinfo, $infoline);
 356         }
 357     }
 358
 359     if ( $oneitem->{'userregkeypath'} ) { $keypath = $oneitem->{'userregkeypath'}; }
 360
 361     # saving it in the file and registry collection
 362     $oneitem->{'keypath'} = $keypath;
 363
 364     return $keypath
 365 }
 366
 367 ###################################################################
 368 # Creating the file Componen.idt dynamically
 369 # Content:
 370 # Component ComponentId Directory_ Attributes Condition KeyPath
 371 ###################################################################
 372
 373 sub create_component_table
 374 {
 375     my ($filesref, $registryref, $dirref, $allfilecomponentsref, $allregistrycomponents, $basedir, $componentidhashref, $componentidkeypathhashref, $allvariables) = @_;
 376
 377     my @componenttable = ();
 378
 379     my ($oneline, $infoline);
 380
 381     installer::windows::idtglobal::write_idt_header(\@componenttable, "component");
 382
 383     # File components
 384
 385     for ( my $i = 0; $i <= $#{$allfilecomponentsref}; $i++ )
 386     {
 387         my %onecomponent = ();
 388
 389         $onecomponent{'name'} = ${$allfilecomponentsref}[$i];
 390         $onecomponent{'guid'} = get_component_guid($onecomponent{'name'}, $componentidhashref);
 391         $onecomponent{'directory'} = get_file_component_directory($onecomponent{'name'}, $filesref, $dirref);
 392         if ( $onecomponent{'directory'} eq "IGNORE_COMP" ) { next; }
 393         $onecomponent{'attributes'} = get_file_component_attributes($onecomponent{'name'}, $filesref, $allvariables);
 394         $onecomponent{'condition'} = get_file_component_condition($onecomponent{'name'}, $filesref);
 395         $onecomponent{'keypath'} = get_component_keypath($onecomponent{'name'}, $filesref, $componentidkeypathhashref);
 396
 397         $oneline = $onecomponent{'name'} . "\t" . $onecomponent{'guid'} . "\t" . $onecomponent{'directory'} . "\t"
 398                 . $onecomponent{'attributes'} . "\t" . $onecomponent{'condition'} . "\t" . $onecomponent{'keypath'} . "\n";
 399
 400         push(@componenttable, $oneline);
 401     }
 402
 403     # Registry components
 404
 405     for ( my $i = 0; $i <= $#{$allregistrycomponents}; $i++ )
 406     {
 407         my %onecomponent = ();
 408
 409         $onecomponent{'name'} = ${$allregistrycomponents}[$i];
 410         $onecomponent{'guid'} = get_component_guid($onecomponent{'name'}, $componentidhashref);
 411         $onecomponent{'directory'} = get_registry_component_directory();
 412         $onecomponent{'attributes'} = get_registry_component_attributes($onecomponent{'name'}, $allvariables);
 413         $onecomponent{'condition'} = get_component_condition($onecomponent{'name'});
 414         $onecomponent{'keypath'} = get_component_keypath($onecomponent{'name'}, $registryref, $componentidkeypathhashref);
 415
 416         $oneline = $onecomponent{'name'} . "\t" . $onecomponent{'guid'} . "\t" . $onecomponent{'directory'} . "\t"
 417                 . $onecomponent{'attributes'} . "\t" . $onecomponent{'condition'} . "\t" . $onecomponent{'keypath'} . "\n";
 418
 419         push(@componenttable, $oneline);
 420     }
 421
 422     # Saving the file
 423
 424     my $componenttablename = $basedir . $installer::globals::separator . "Componen.idt";
 425     installer::files::save_file($componenttablename ,\@componenttable);
 426     $infoline = "Created idt file: $componenttablename\n";
 427     push(@installer::globals::logfileinfo, $infoline);
 428 }
 429
 430 ####################################################################################
 431 # Returning a component for a scp module gid.
 432 # Pairs are saved in the files collector.
 433 ####################################################################################
 434
 435 sub get_component_name_from_modulegid
 436 {
 437     my ($modulegid, $filesref) = @_;
 438
 439     my $componentname = "";
 440
 441     for my $file ( @{$filesref} )
 442     {
 443         next if ( ! $file->{'modules'} );
 444
 445         my @filemodules = split /,\s*/, $file->{'modules'};
 446
 447         if (grep {$_ eq $modulegid} @filemodules)
 448         {
 449             $componentname = $file->{'componentname'};
 450             last;
 451         }
 452     }
 453
 454     return $componentname;
 455 }
 456
 457 ####################################################################################
 458 # Updating the file Environm.idt dynamically
 459 # Content:
 460 # Environment Name Value Component_
 461 ####################################################################################
 462
 463 sub set_component_in_environment_table
 464 {
 465     my ($basedir, $filesref) = @_;
 466
 467     my $infoline = "";
 468
 469     my $environmentfilename = $basedir . $installer::globals::separator . "Environm.idt";
 470
 471     if ( -f $environmentfilename )  # only do something, if file exists
 472     {
 473         my $environmentfile = installer::files::read_file($environmentfilename);
 474
 475         for ( my $i = 3; $i <= $#{$environmentfile}; $i++ ) # starting in line 4 of Environm.idt
 476         {
 477             if ( ${$environmentfile}[$i] =~ /^\s*(.*?)\t(.*?)\t(.*?)\t(.*?)\s*$/ )
 478             {
 479                 my $modulegid = $4; # in Environment table a scp module gid can be used as component replacement
 480
 481                 my $componentname = get_component_name_from_modulegid($modulegid, $filesref);
 482
 483                 if ( $componentname )   # only do something if a component could be found
 484                 {
 485                     $infoline = "Updated Environment table:\n";
 486                     push(@installer::globals::logfileinfo, $infoline);
 487                     $infoline = "Old line: ${$environmentfile}[$i]\n";
 488                     push(@installer::globals::logfileinfo, $infoline);
 489
 490                     ${$environmentfile}[$i] =~ s/$modulegid/$componentname/;
 491
 492                     $infoline = "New line: ${$environmentfile}[$i]\n";
 493                     push(@installer::globals::logfileinfo, $infoline);
 494
 495                 }
 496             }
 497         }
 498
 499         # Saving the file
 500
 501         installer::files::save_file($environmentfilename ,$environmentfile);
 502         $infoline = "Updated idt file: $environmentfilename\n";
 503         push(@installer::globals::logfileinfo, $infoline);
 504
 505     }
 506 }
 507
 508 1;