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