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     # special handling for Java and Ada
 138     if ( $onefeature->{'Name'} )
 139     {
 140         if ( $onefeature->{'Name'} =~ /java/i ) { $level = $level + 40; }
 141     }
 142
 143     # if FeatureLevel is defined in scp, this will be used
 144
 145     if ( $onefeature->{'FeatureLevel'} ) { $level = $onefeature->{'FeatureLevel'}; }
 146
 147     return $level
 148 }
 149
 150 ##############################################################
 151 # Returning the directory for a feature.
 152 ##############################################################
 153
 154 sub get_feature_directory
 155 {
 156     my ($onefeature) = @_;
 157
 158     my $directory;
 159
 160     $directory = "INSTALLLOCATION";
 161
 162     return $directory
 163 }
 164
 165 ##############################################################
 166 # Returning the directory for a feature.
 167 ##############################################################
 168
 169 sub get_feature_attributes
 170 {
 171     my ($onefeature) = @_;
 172
 173     my $attributes;
 174
 175     # No advertising of features and no leaving on network.
 176     # Feature without parent must not have the "2"
 177
 178     my $parentgid = "";
 179     if ( $onefeature->{'ParentID'} ) { $parentgid = $onefeature->{'ParentID'}; }
 180
 181     if (( $parentgid eq "" ) || ( $parentgid eq $installer::globals::rootmodulegid )) { $attributes = "8"; }
 182     elsif ( get_feature_display($onefeature) eq "0" ) { $attributes = "26"; } # fdo#33798
 183     else { $attributes = "10"; }
 184
 185     return $attributes
 186 }
 187
 188 #################################################################################
 189 # Collecting the feature recursively.
 190 #################################################################################
 191
 192 sub collect_modules_recursive
 193 {
 194     my ($modulesref, $parentid, $feature, $directaccess, $directgid, $directparent, $directsortkey, $sorted) = @_;
 195
 196     my @allchildren = ();
 197     my $childrenexist = 0;
 198
 199     # Collecting children from Module $parentid
 200
 201     my $modulegid;
 202     foreach $modulegid ( keys %{$directparent})
 203     {
 204         if ( $directparent->{$modulegid} eq $parentid )
 205         {
 206             push @allchildren, [ $directsortkey->{$modulegid}, $modulegid ];
 207             $childrenexist = 1;
 208         }
 209     }
 210
 211     # Sorting children
 212
 213     if ( $childrenexist )
 214     {
 215         # Sort children
 216         @allchildren = map { $_->[1] }
 217                        sort { $a->[0] <=> $b->[0] }
 218                        @allchildren;
 219
 220         # Adding children to new array
 221         foreach my $gid ( @allchildren )
 222         {
 223             # Saving all lines, that have this 'gid'
 224
 225             my $unique;
 226             foreach $unique ( keys %{$directgid} )
 227             {
 228                 if ( $directgid->{$unique} eq $gid )
 229                 {
 230                     push(@{$feature}, ${$modulesref}[$directaccess->{$unique}]);
 231                     if ( $sorted->{$unique} == 1 ) { installer::exiter::exit_program("ERROR: Sorting feature failed! \"$unique\" already sorted.", "sort_feature"); }
 232                     $sorted->{$unique} = 1;
 233                 }
 234             }
 235
 236             collect_modules_recursive($modulesref, $gid, $feature, $directaccess, $directgid, $directparent, $directsortkey, $sorted);
 237         }
 238     }
 239 }
 240
 241 #################################################################################
 242 # Sorting the feature in specified order. Evaluated is the key "Sortkey", that
 243 # is set in scp2 projects.
 244 # The display order of modules in Windows Installer is dependent from the order
 245 # in the idt file. Therefore the order of the modules array has to be adapted
 246 # to the Sortkey order, before the idt file is created.
 247 #################################################################################
 248
 249 sub sort_feature
 250 {
 251     my ($modulesref) = @_;
 252
 253     my @feature = ();
 254
 255     my %directaccess = ();
 256     my %directparent = ();
 257     my %directgid = ();
 258     my %directsortkey = ();
 259     my %sorted = ();
 260
 261     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
 262     {
 263         my $onefeature = ${$modulesref}[$i];
 264
 265         my $uniquekey = $onefeature->{'uniquekey'};
 266         my $modulegid = $onefeature->{'gid'};
 267
 268         $directaccess{$uniquekey} = $i;
 269
 270         $directgid{$uniquekey} = $onefeature->{'gid'};
 271
 272         # ParentID and Sortkey are not saved for the 'uniquekey', but only for the 'gid'
 273
 274         if ( $onefeature->{'ParentID'} ) { $directparent{$modulegid} = $onefeature->{'ParentID'}; }
 275         else { $directparent{$modulegid} = ""; }
 276
 277         if ( $onefeature->{'Sortkey'} ) { $directsortkey{$modulegid} = $onefeature->{'Sortkey'}; }
 278         else { $directsortkey{$modulegid} = "9999"; }
 279
 280         # Bookkeeping:
 281         $sorted{$uniquekey} = 0;
 282     }
 283
 284     # Searching all feature recursively, beginning with ParentID = ""
 285     my $parentid = "";
 286     collect_modules_recursive($modulesref, $parentid, \@feature, \%directaccess, \%directgid, \%directparent, \%directsortkey, \%sorted);
 287
 288     # Bookkeeping
 289     my $modulekey;
 290     foreach $modulekey ( keys %sorted )
 291     {
 292         if ( $sorted{$modulekey} == 0 )
 293         {
 294             my $infoline = "Warning: Module \"$modulekey\" could not be sorted. Added to the end of the module array.\n";
 295             push(@installer::globals::logfileinfo, $infoline);
 296             push(@feature, ${$modulesref}[$directaccess{$modulekey}]);
 297         }
 298     }
 299
 300     return \@feature;
 301 }
 302
 303 #################################################################################
 304 # Adding a unique key to the modules array. The gid is not unique for
 305 # multilingual modules. Only the combination from gid and specific language
 306 # is unique. Uniqueness is required for sorting mechanism.
 307 #################################################################################
 308
 309 sub add_uniquekey
 310 {
 311     my ( $modulesref ) = @_;
 312
 313     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
 314     {
 315         my $uniquekey = ${$modulesref}[$i]->{'gid'};
 316         if ( ${$modulesref}[$i]->{'specificlanguage'} ) { $uniquekey = $uniquekey . "_" . ${$modulesref}[$i]->{'specificlanguage'}; }
 317         ${$modulesref}[$i]->{'uniquekey'} = $uniquekey;
 318     }
 319 }
 320
 321 #################################################################################
 322 # Creating the file Feature.idt dynamically
 323 # Content:
 324 # Feature Feature_Parent Title Description Display Level Directory_ Attributes
 325 #################################################################################
 326
 327 sub create_feature_table
 328 {
 329     my ($modulesref, $basedir, $languagesarrayref, $allvariableshashref) = @_;
 330
 331     for ( my $m = 0; $m <= $#{$languagesarrayref}; $m++ )
 332     {
 333         my $onelanguage = ${$languagesarrayref}[$m];
 334
 335         my $infoline;
 336
 337         my @featuretable = ();
 338
 339         installer::windows::idtglobal::write_idt_header(\@featuretable, "feature");
 340
 341         for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
 342         {
 343             my $onefeature = ${$modulesref}[$i];
 344
 345             # Java and Ada only, if the correct settings are set
 346             my $styles = "";
 347             if ( $onefeature->{'Styles'} ) { $styles = $onefeature->{'Styles'}; }
 348
 349             # Controlling the language!
 350             # Only language independent feature or feature with the correct language will be included into the table
 351             # But help packs are different. They have en-US added as setup language.
 352
 353             if (! (!(( $onefeature->{'ismultilingual'} )) || ( $onefeature->{'specificlanguage'} eq $onelanguage ) || $installer::globals::helppack ) )  { next; }
 354
 355             my %feature = ();
 356
 357             $feature{'feature'} = get_feature_gid($onefeature);
 358             $feature{'feature_parent'} = get_feature_parent($onefeature);
 359             $feature{'Title'} = $onefeature->{'Name'};
 360             $feature{'Description'} = $onefeature->{'Description'};
 361             $feature{'Description'} =~ s/\\\"/\"/g;  # no more masquerading of '"'
 362             $feature{'Display'} = get_feature_display($onefeature);
 363             $feature{'Level'} = get_feature_level($onefeature);
 364             $feature{'Directory_'} = get_feature_directory($onefeature);
 365             $feature{'Attributes'} = get_feature_attributes($onefeature);
 366
 367             my $oneline = $feature{'feature'} . "\t" . $feature{'feature_parent'} . "\t" . $feature{'Title'} . "\t"
 368                     . $feature{'Description'} . "\t" . $feature{'Display'} . "\t" . $feature{'Level'} . "\t"
 369                     . $feature{'Directory_'} . "\t" . $feature{'Attributes'} . "\n";
 370
 371             push(@featuretable, $oneline);
 372
 373             # collecting all feature in global feature collector (so that properties can be set in property table)
 374             if ( ! grep {$_ eq $feature{'feature'}} @installer::globals::featurecollector )
 375             {
 376                 push(@installer::globals::featurecollector, $feature{'feature'});
 377             }
 378
 379             # collecting all language feature in feature collector for check of language selection
 380             if (( $styles =~ /\bSHOW_MULTILINGUAL_ONLY\b/ ) && ( $onefeature->{'ParentID'} ne $installer::globals::rootmodulegid ))
 381             {
 382                 $installer::globals::multilingual_only_modules{$feature{'feature'}} = 1;
 383             }
 384
 385             # collecting all application feature in global feature collector for check of application selection
 386             if ( $styles =~ /\bAPPLICATIONMODULE\b/ )
 387             {
 388                 $installer::globals::application_modules{$feature{'feature'}} = 1;
 389             }
 390         }
 391
 392         # Saving the file
 393
 394         my $featuretablename = $basedir . $installer::globals::separator . "Feature.idt" . "." . $onelanguage;
 395         installer::files::save_file($featuretablename ,\@featuretable);
 396         $infoline = "Created idt file: $featuretablename\n";
 397         push(@installer::globals::logfileinfo, $infoline);
 398     }
 399
 400 }
 401
 402 1;