solenv/bin/modules/installer/windows/feature.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::feature;
  20
  21 use strict;
  22 use warnings;
  23
  24 use installer::exiter;
  25 use installer::files;
  26 use installer::globals;
  27 use installer::worker;
  28 use installer::windows::idtglobal;
  29 use installer::windows::language;
  30
  31 ##############################################################
  32 # Returning the gid for a feature.
  33 # Attention: Maximum length
  34 ##############################################################
  35
  36 sub get_feature_gid
  37 {
  38     my ($onefeature) = @_;
  39
  40     my $gid = "";
  41
  42     if ( $onefeature->{'gid'} ) { $gid = $onefeature->{'gid'}; }
  43
  44     # Attention: Maximum feature length is 38!
  45     installer::windows::idtglobal::shorten_feature_gid(\$gid);
  46
  47     return $gid
  48 }
  49
  50 ##############################################################
  51 # Returning the gid of the parent.
  52 # Attention: Maximum length
  53 ##############################################################
  54
  55 sub get_feature_parent
  56 {
  57     my ($onefeature) = @_;
  58
  59     my $parentgid = "";
  60
  61     if ( $onefeature->{'ParentID'} ) { $parentgid = $onefeature->{'ParentID'}; }
  62
  63     # The modules, hanging directly below the root, have to be root modules.
  64     # Only then it is possible to make the "real" root module invisible by
  65     # setting the display to "0".
  66
  67     if ( $parentgid eq $installer::globals::rootmodulegid ) { $parentgid = ""; }
  68
  69     # Attention: Maximum feature length is 38!
  70     installer::windows::idtglobal::shorten_feature_gid(\$parentgid);
  71
  72     return $parentgid
  73 }
  74
  75 ##############################################################
  76 # Returning the display for a feature.
  77 # 0: Feature is not shown
  78 # odd: subfeatures are shown
  79 # even:  subfeatures are not shown
  80 ##############################################################
  81
  82 sub get_feature_display
  83 {
  84     my ($onefeature) = @_;
  85
  86     my $display;
  87     my $parentid = "";
  88
  89     if ( $onefeature->{'ParentID'} ) { $parentid = $onefeature->{'ParentID'}; }
  90
  91     if ( $parentid eq "" )
  92     {
  93         $display = "0";                                 # root module is not visible
  94     }
  95     elsif ( $onefeature->{'gid'} eq "gid_Module_Prg")   # program module shows subfeatures
  96     {
  97         $display = "1";                                 # root module shows subfeatures
  98     }
  99     else
 100     {
 101         $display = "2";                                 # all other modules do not show subfeatures
 102     }
 103
 104     # special case: Feature has flag "HIDDEN_ROOT" -> $display is 0
 105     my $styles = "";
 106     if ( $onefeature->{'Styles'} ) { $styles = $onefeature->{'Styles'}; }
 107     if ( $styles =~ /\bHIDDEN_ROOT\b/ ) { $display = "0"; }
 108
 109     # Special handling for language modules. Only visible in multilingual installation set
 110     if (( $styles =~ /\bSHOW_MULTILINGUAL_ONLY\b/ ) && ( ! $installer::globals::ismultilingual )) { $display = "0"; }
 111
 112     # No program module visible.
 113     if ( $onefeature->{'gid'} eq "gid_Module_Prg" )  { $display = "0"; }
 114
 115     # making all feature invisible in Language packs and in Help packs!
 116     if ( $installer::globals::languagepack || $installer::globals::helppack ) { $display = "0"; }
 117
 118     return $display
 119 }
 120
 121 ##############################################################
 122 # Returning the level for a feature.
 123 ##############################################################
 124
 125 sub get_feature_level
 126 {
 127     my ($onefeature) = @_;
 128
 129     my $level = "20";   # the default
 130
 131     if ( $onefeature->{'Disabled'} )
 132     {
 133         if ( $onefeature->{'Disabled'} eq "YES" )    # Disabled = "YES"
 134         {
 135             $level = "0";               # disabled for installation at any INSTALLLEVEL
 136         }
 137     }
 138     elsif ( $onefeature->{'Default'} )
 139     {
 140         if ( $onefeature->{'Default'} eq "NO" )    # explicitly set Default = "NO"
 141         {
 142             $level = "200";             # deselected in default installation, base is 100
 143         }
 144     }
 145
 146     return $level
 147 }
 148
 149 ##############################################################
 150 # Returning the directory for a feature.
 151 ##############################################################
 152
 153 sub get_feature_directory
 154 {
 155     my ($onefeature) = @_;
 156
 157     my $directory;
 158
 159     $directory = "INSTALLLOCATION";
 160
 161     return $directory
 162 }
 163
 164 ##############################################################
 165 # Returning the directory for a feature.
 166 ##############################################################
 167
 168 sub get_feature_attributes
 169 {
 170     my ($onefeature) = @_;
 171
 172     my $attributes;
 173
 174     # 2 = msidbFeatureAttributesFollowParent
 175     # 8 = msidbFeatureAttributesDisallowAdvertise
 176     # 16 = msidbFeatureAttributesUIDisallowAbsent
 177
 178     # No advertising of features and no leaving on network.
 179     # Feature without parent must not have the "2"
 180
 181     my $parentgid = "";
 182     if ( $onefeature->{'ParentID'} ) { $parentgid = $onefeature->{'ParentID'}; }
 183
 184     if (( $parentgid eq "" ) || ( $parentgid eq $installer::globals::rootmodulegid )) { $attributes = "8"; }
 185     elsif ( $onefeature->{'Independent'} && ($onefeature->{'Independent'} eq "YES") ) { $attributes = "8"; }
 186     elsif ( get_feature_display($onefeature) eq "0" ) { $attributes = "26"; } # fdo#33798
 187     else { $attributes = "10"; }
 188
 189     return $attributes
 190 }
 191
 192 #################################################################################
 193 # Collecting the feature recursively.
 194 #################################################################################
 195
 196 sub collect_modules_recursive
 197 {
 198     my ($modulesref, $parentid, $feature, $directaccess, $directgid, $directparent, $directsortkey, $sorted) = @_;
 199
 200     my @allchildren = ();
 201     my $childrenexist = 0;
 202
 203     # Collecting children from Module $parentid
 204
 205     my $modulegid;
 206     foreach $modulegid ( keys %{$directparent})
 207     {
 208         if ( $directparent->{$modulegid} eq $parentid )
 209         {
 210             push @allchildren, [ $directsortkey->{$modulegid}, $modulegid ];
 211             $childrenexist = 1;
 212         }
 213     }
 214
 215     # Sorting children
 216
 217     if ( $childrenexist )
 218     {
 219         # Sort children
 220         @allchildren = map { $_->[1] }
 221                        sort { $a->[0] <=> $b->[0] }
 222                        @allchildren;
 223
 224         # Adding children to new array
 225         foreach my $gid ( @allchildren )
 226         {
 227             # Saving all lines, that have this 'gid'
 228
 229             my $unique;
 230             foreach $unique ( keys %{$directgid} )
 231             {
 232                 if ( $directgid->{$unique} eq $gid )
 233                 {
 234                     push(@{$feature}, ${$modulesref}[$directaccess->{$unique}]);
 235                     if ( $sorted->{$unique} == 1 ) { installer::exiter::exit_program("ERROR: Sorting feature failed! \"$unique\" already sorted.", "sort_feature"); }
 236                     $sorted->{$unique} = 1;
 237                 }
 238             }
 239
 240             collect_modules_recursive($modulesref, $gid, $feature, $directaccess, $directgid, $directparent, $directsortkey, $sorted);
 241         }
 242     }
 243 }
 244
 245 #################################################################################
 246 # Sorting the feature in specified order. Evaluated is the key "Sortkey", that
 247 # is set in scp2 projects.
 248 # The display order of modules in Windows Installer is dependent from the order
 249 # in the idt file. Therefore the order of the modules array has to be adapted
 250 # to the Sortkey order, before the idt file is created.
 251 #################################################################################
 252
 253 sub sort_feature
 254 {
 255     my ($modulesref) = @_;
 256
 257     my @feature = ();
 258
 259     my %directaccess = ();
 260     my %directparent = ();
 261     my %directgid = ();
 262     my %directsortkey = ();
 263     my %sorted = ();
 264
 265     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
 266     {
 267         my $onefeature = ${$modulesref}[$i];
 268
 269         my $uniquekey = $onefeature->{'uniquekey'};
 270         my $modulegid = $onefeature->{'gid'};
 271
 272         $directaccess{$uniquekey} = $i;
 273
 274         $directgid{$uniquekey} = $onefeature->{'gid'};
 275
 276         # ParentID and Sortkey are not saved for the 'uniquekey', but only for the 'gid'
 277
 278         if ( $onefeature->{'ParentID'} ) { $directparent{$modulegid} = $onefeature->{'ParentID'}; }
 279         else { $directparent{$modulegid} = ""; }
 280
 281         if ( $onefeature->{'Sortkey'} ) { $directsortkey{$modulegid} = $onefeature->{'Sortkey'}; }
 282         else { $directsortkey{$modulegid} = "9999"; }
 283
 284         # Bookkeeping:
 285         $sorted{$uniquekey} = 0;
 286     }
 287
 288     # Searching all feature recursively, beginning with ParentID = ""
 289     my $parentid = "";
 290     collect_modules_recursive($modulesref, $parentid, \@feature, \%directaccess, \%directgid, \%directparent, \%directsortkey, \%sorted);
 291
 292     # Bookkeeping
 293     my $modulekey;
 294     foreach $modulekey ( keys %sorted )
 295     {
 296         if ( $sorted{$modulekey} == 0 )
 297         {
 298             my $infoline = "Warning: Module \"$modulekey\" could not be sorted. Added to the end of the module array.\n";
 299             push(@installer::globals::logfileinfo, $infoline);
 300             push(@feature, ${$modulesref}[$directaccess{$modulekey}]);
 301         }
 302     }
 303
 304     return \@feature;
 305 }
 306
 307 #################################################################################
 308 # Adding a unique key to the modules array. The gid is not unique for
 309 # multilingual modules. Only the combination from gid and specific language
 310 # is unique. Uniqueness is required for sorting mechanism.
 311 #################################################################################
 312
 313 sub add_uniquekey
 314 {
 315     my ( $modulesref ) = @_;
 316
 317     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
 318     {
 319         my $uniquekey = ${$modulesref}[$i]->{'gid'};
 320         if ( ${$modulesref}[$i]->{'specificlanguage'} ) { $uniquekey = $uniquekey . "_" . ${$modulesref}[$i]->{'specificlanguage'}; }
 321         ${$modulesref}[$i]->{'uniquekey'} = $uniquekey;
 322     }
 323 }
 324
 325 #################################################################################
 326 # Creating the file Feature.idt dynamically
 327 # Content:
 328 # Feature Feature_Parent Title Description Display Level Directory_ Attributes
 329 #################################################################################
 330
 331 sub create_feature_table
 332 {
 333     my ($modulesref, $basedir, $languagesarrayref, $allvariableshashref) = @_;
 334
 335     for ( my $m = 0; $m <= $#{$languagesarrayref}; $m++ )
 336     {
 337         my $onelanguage = ${$languagesarrayref}[$m];
 338
 339         my $infoline;
 340
 341         my @featuretable = ();
 342
 343         installer::windows::idtglobal::write_idt_header(\@featuretable, "feature");
 344
 345         for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
 346         {
 347             my $onefeature = ${$modulesref}[$i];
 348
 349             # Java and Ada only, if the correct settings are set
 350             my $styles = "";
 351             if ( $onefeature->{'Styles'} ) { $styles = $onefeature->{'Styles'}; }
 352
 353             # Controlling the language!
 354             # Only language independent feature or feature with the correct language will be included into the table
 355             # But help packs are different. They have en-US added as setup language.
 356
 357             if (! (!(( $onefeature->{'ismultilingual'} )) || ( $onefeature->{'specificlanguage'} eq $onelanguage ) || $installer::globals::helppack ) )  { next; }
 358
 359             my %feature = ();
 360
 361             $feature{'feature'} = get_feature_gid($onefeature);
 362             $feature{'feature_parent'} = get_feature_parent($onefeature);
 363             $feature{'Title'} = $onefeature->{'Name'} // "";
 364             $feature{'Description'} = $onefeature->{'Description'} // "";
 365             $feature{'Description'} =~ s/\\\"/\"/g;  # no more masquerading of '"'
 366             $feature{'Display'} = get_feature_display($onefeature);
 367             $feature{'Level'} = get_feature_level($onefeature);
 368             $feature{'Directory_'} = get_feature_directory($onefeature);
 369             $feature{'Attributes'} = get_feature_attributes($onefeature);
 370
 371             my $oneline = $feature{'feature'} . "\t" . $feature{'feature_parent'} . "\t" . $feature{'Title'} . "\t"
 372                     . $feature{'Description'} . "\t" . $feature{'Display'} . "\t" . $feature{'Level'} . "\t"
 373                     . $feature{'Directory_'} . "\t" . $feature{'Attributes'} . "\n";
 374
 375             push(@featuretable, $oneline);
 376
 377             # collecting all feature in global feature collector (so that properties can be set in property table)
 378             if ( ! grep {$_ eq $feature{'feature'}} @installer::globals::featurecollector )
 379             {
 380                 push(@installer::globals::featurecollector, $feature{'feature'});
 381             }
 382
 383             # collecting all language feature in feature collector for check of language selection
 384             if (( $styles =~ /\bSHOW_MULTILINGUAL_ONLY\b/ ) && ( $onefeature->{'ParentID'} ne $installer::globals::rootmodulegid ))
 385             {
 386                 $installer::globals::multilingual_only_modules{$feature{'feature'}} = 1;
 387             }
 388
 389             # collecting all application feature in global feature collector for check of application selection
 390             if ( $styles =~ /\bAPPLICATIONMODULE\b/ )
 391             {
 392                 $installer::globals::application_modules{$feature{'feature'}} = 1;
 393             }
 394         }
 395
 396         # Saving the file
 397
 398         my $featuretablename = $basedir . $installer::globals::separator . "Feature.idt" . "." . $onelanguage;
 399         installer::files::save_file($featuretablename ,\@featuretable);
 400         $infoline = "Created idt file: $featuretablename\n";
 401         push(@installer::globals::logfileinfo, $infoline);
 402     }
 403
 404 }
 405
 406 1;