solenv/bin/modules/installer/windows/feature.pm

   1 #*************************************************************************
   2 #
   3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 #
   5 # Copyright 2008 by Sun Microsystems, Inc.
   6 #
   7 # OpenOffice.org - a multi-platform office productivity suite
   8 #
   9 # $RCSfile: feature.pm,v $
  10 #
  11 # $Revision: 1.24 $
  12 #
  13 # This file is part of OpenOffice.org.
  14 #
  15 # OpenOffice.org is free software: you can redistribute it and/or modify
  16 # it under the terms of the GNU Lesser General Public License version 3
  17 # only, as published by the Free Software Foundation.
  18 #
  19 # OpenOffice.org is distributed in the hope that it will be useful,
  20 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 # GNU Lesser General Public License version 3 for more details
  23 # (a copy is included in the LICENSE file that accompanied this code).
  24 #
  25 # You should have received a copy of the GNU Lesser General Public License
  26 # version 3 along with OpenOffice.org.  If not, see
  27 # <http://www.openoffice.org/license.html>
  28 # for a copy of the LGPLv3 License.
  29 #
  30 #*************************************************************************
  31
  32 package installer::windows::feature;
  33
  34 use installer::existence;
  35 use installer::exiter;
  36 use installer::files;
  37 use installer::globals;
  38 use installer::sorter;
  39 use installer::worker;
  40 use installer::windows::idtglobal;
  41 use installer::windows::language;
  42
  43 ##############################################################
  44 # Returning the gid for a feature.
  45 # Attention: Maximum length
  46 ##############################################################
  47
  48 sub get_feature_gid
  49 {
  50     my ($onefeature) = @_;
  51
  52     my $gid = "";
  53
  54     if ( $onefeature->{'gid'} ) { $gid = $onefeature->{'gid'}; }
  55
  56     # Attention: Maximum feature length is 38!
  57     installer::windows::idtglobal::shorten_feature_gid(\$gid);
  58
  59     return $gid
  60 }
  61
  62 ##############################################################
  63 # Returning the gid of the parent.
  64 # Attention: Maximum length
  65 ##############################################################
  66
  67 sub get_feature_parent
  68 {
  69     my ($onefeature) = @_;
  70
  71     my $parentgid = "";
  72
  73     if ( $onefeature->{'ParentID'} ) { $parentgid = $onefeature->{'ParentID'}; }
  74
  75     # The modules, hanging directly below the root, have to be root modules.
  76     # Only then it is possible to make the "real" root module invisible by
  77     # setting the display to "0".
  78
  79     if ( $parentgid eq $installer::globals::rootmodulegid ) { $parentgid = ""; }
  80
  81     # Attention: Maximum feature length is 38!
  82     installer::windows::idtglobal::shorten_feature_gid(\$parentgid);
  83
  84     return $parentgid
  85 }
  86
  87 ##############################################################
  88 # Returning the display for a feature.
  89 # 0: Feature is not shown
  90 # odd: subfeatures are shown
  91 # even:  subfeatures are not shown
  92 ##############################################################
  93
  94 sub get_feature_display
  95 {
  96     my ($onefeature) = @_;
  97
  98     my $display;
  99     my $parentid = "";
 100
 101     if ( $onefeature->{'ParentID'} ) { $parentid = $onefeature->{'ParentID'}; }
 102
 103     if ( $parentid eq "" )
 104     {
 105         $display = "0";                                                                 # root module is not visible
 106     }
 107     elsif ( $onefeature->{'gid'} eq "gid_Module_Prg")   # program module shows subfeatures
 108     {
 109         $display = "1";                                                                 # root module shows subfeatures
 110     }
 111     else
 112     {
 113         $display = "2";                                                                 # all other modules do not show subfeatures
 114     }
 115
 116     # special case: Feature has flag "HIDDEN_ROOT" -> $display is 0
 117     my $styles = "";
 118     if ( $onefeature->{'Styles'} ) { $styles = $onefeature->{'Styles'}; }
 119     if ( $styles =~ /\bHIDDEN_ROOT\b/ ) { $display = "0"; }
 120
 121     # Special handling for language modules. Only visible in multilingual installation set
 122     if (( $styles =~ /\bSHOW_MULTILINGUAL_ONLY\b/ ) && ( ! $installer::globals::ismultilingual )) { $display = "0"; }
 123
 124     # Special handling for c05office. No program module visible.
 125     if (( $onefeature->{'gid'} eq "gid_Module_Prg" ) && ( $installer::globals::product =~ /c05office/i )) { $display = "0";     }
 126
 127     # making all feature invisible in Language packs!
 128     if ( $installer::globals::languagepack ) { $display = "0"; }
 129
 130     return $display
 131 }
 132
 133 ##############################################################
 134 # Returning the level for a feature.
 135 ##############################################################
 136
 137 sub get_feature_level
 138 {
 139     my ($onefeature) = @_;
 140
 141     my $level = "20";   # the default
 142
 143     my $localdefault = "";
 144
 145     if ( $onefeature->{'Default'} ) { $localdefault = $onefeature->{'Default'}; }
 146
 147     if ( $localdefault eq "NO" )        # explicitely set Default = "NO"
 148     {
 149         $level = "200";                         # deselected in default installation, base is 100
 150         if ( $installer::globals::patch ) { $level = "20"; }
 151     }
 152
 153     # special handling for Java and Ada
 154     if ( $onefeature->{'Name'} )
 155     {
 156         if ( $onefeature->{'Name'} =~ /java/i ) { $level = $level + 40; }
 157     }
 158
 159     # if FeatureLevel is defined in scp, this will be used
 160
 161     if ( $onefeature->{'FeatureLevel'} ) { $level = $onefeature->{'FeatureLevel'}; }
 162
 163     return $level
 164 }
 165
 166 ##############################################################
 167 # Returning the directory for a feature.
 168 ##############################################################
 169
 170 sub get_feature_directory
 171 {
 172     my ($onefeature) = @_;
 173
 174     my $directory;
 175
 176     $directory = "INSTALLLOCATION";
 177
 178     return $directory
 179 }
 180
 181 ##############################################################
 182 # Returning the directory for a feature.
 183 ##############################################################
 184
 185 sub get_feature_attributes
 186 {
 187     my ($onefeature) = @_;
 188
 189     my $attributes;
 190
 191     # No advertising of features and no leaving on network.
 192     # Feature without parent must not have the "2"
 193
 194     my $parentgid = "";
 195     if ( $onefeature->{'ParentID'} ) { $parentgid = $onefeature->{'ParentID'}; }
 196
 197     if (( $parentgid eq "" ) || ( $parentgid eq $installer::globals::rootmodulegid )) { $attributes = "8"; }
 198     else { $attributes = "10"; }
 199
 200     return $attributes
 201 }
 202
 203 #################################################################################
 204 # Replacing one variable in one files
 205 #################################################################################
 206
 207 sub replace_one_variable
 208 {
 209     my ($translationfile, $variable, $searchstring) = @_;
 210
 211     for ( my $i = 0; $i <= $#{$translationfile}; $i++ )
 212     {
 213         ${$translationfile}[$i] =~ s/\%$searchstring/$variable/g;
 214     }
 215 }
 216
 217 #################################################################################
 218 # Replacing the variables in the feature names and descriptions
 219 #################################################################################
 220
 221 sub replace_variables
 222 {
 223     my ($translationfile, $variableshashref) = @_;
 224
 225     foreach $key (keys %{$variableshashref})
 226     {
 227         my $value = $variableshashref->{$key};
 228         replace_one_variable($translationfile, $value, $key);
 229     }
 230 }
 231
 232 #################################################################################
 233 # Collecting the feature recursively.
 234 #################################################################################
 235
 236 sub collect_modules_recursive
 237 {
 238     my ($modulesref, $parentid, $feature, $directaccess, $directgid, $directparent, $directsortkey, $sorted) = @_;
 239
 240     my @allchildren = ();
 241     my $childrenexist = 0;
 242
 243     # Collecting children from Module $parentid
 244
 245     my $modulegid;
 246     foreach $modulegid ( keys %{$directparent})
 247     {
 248         if ( $directparent->{$modulegid} eq $parentid )
 249         {
 250             my %childhash = ( "gid" => "$modulegid", "Sortkey" => "$directsortkey->{$modulegid}");
 251             push(@allchildren, \%childhash);
 252             $childrenexist = 1;
 253         }
 254     }
 255
 256     # Sorting children
 257
 258     if ( $childrenexist )
 259     {
 260         # Sort children
 261         installer::sorter::sort_array_of_hashes_numerically(\@allchildren, "Sortkey");
 262
 263         # Adding children to new array
 264         my $childhashref;
 265         foreach $childhashref ( @allchildren )
 266         {
 267             my $gid = $childhashref->{'gid'};
 268
 269             # Saving all lines, that have this 'gid'
 270
 271             my $unique;
 272             foreach $unique ( keys %{$directgid} )
 273             {
 274                 if ( $directgid->{$unique} eq $gid )
 275                 {
 276                     push(@{$feature}, ${$modulesref}[$directaccess->{$unique}]);
 277                     if ( $sorted->{$unique} == 1 ) { installer::exiter::exit_program("ERROR: Sorting feature failed! \"$unique\" already sorted.", "sort_feature"); }
 278                     $sorted->{$unique} = 1;
 279                 }
 280             }
 281
 282             collect_modules_recursive($modulesref, $gid, $feature, $directaccess, $directgid, $directparent, $directsortkey, $sorted);
 283         }
 284     }
 285 }
 286
 287 #################################################################################
 288 # Sorting the feature in specified order. Evaluated is the key "Sortkey", that
 289 # is set in scp2 projects.
 290 # The display order of modules in Windows Installer is dependent from the order
 291 # in the idt file. Therefore the order of the modules array has to be adapted
 292 # to the Sortkey order, before the idt file is created.
 293 #################################################################################
 294
 295 sub sort_feature
 296 {
 297     my ($modulesref) = @_;
 298
 299     my @feature = ();
 300
 301     my %directaccess = ();
 302     my %directparent = ();
 303     my %directgid = ();
 304     my %directsortkey = ();
 305     my %sorted = ();
 306
 307     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
 308     {
 309         my $onefeature = ${$modulesref}[$i];
 310
 311         my $uniquekey = $onefeature->{'uniquekey'};
 312         my $modulegid = $onefeature->{'gid'};
 313
 314         $directaccess{$uniquekey} = $i;
 315
 316         $directgid{$uniquekey} = $onefeature->{'gid'};
 317
 318         # ParentID and Sortkey are not saved for the 'uniquekey', but only for the 'gid'
 319
 320         if ( $onefeature->{'ParentID'} ) { $directparent{$modulegid} = $onefeature->{'ParentID'}; }
 321         else { $directparent{$modulegid} = ""; }
 322
 323         if ( $onefeature->{'Sortkey'} ) { $directsortkey{$modulegid} = $onefeature->{'Sortkey'}; }
 324         else { $directsortkey{$modulegid} = "9999"; }
 325
 326         # Bookkeeping:
 327         $sorted{$uniquekey} = 0;
 328     }
 329
 330     # Searching all feature recursively, beginning with ParentID = ""
 331     my $parentid = "";
 332     collect_modules_recursive($modulesref, $parentid, \@feature, \%directaccess, \%directgid, \%directparent, \%directsortkey, \%sorted);
 333
 334     # Bookkeeping
 335     my $modulekey;
 336     foreach $modulekey ( keys %sorted )
 337     {
 338         if ( $sorted{$modulekey} == 0 )
 339         {
 340             my $infoline = "Warning: Module \"$modulekey\" could not be sorted. Added to the end of the module array.\n";
 341             push(@installer::globals::logfileinfo, $infoline);
 342             push(@feature, ${$modulesref}[$directaccess{$modulekey}]);
 343         }
 344     }
 345
 346     return \@feature;
 347 }
 348
 349 #################################################################################
 350 # Adding a unique key to the modules array. The gid is not unique for
 351 # multilingual modules. Only the combination from gid and specific language
 352 # is unique. Uniqueness is required for sorting mechanism.
 353 #################################################################################
 354
 355 sub add_uniquekey
 356 {
 357     my ( $modulesref ) = @_;
 358
 359     for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
 360     {
 361         my $uniquekey = ${$modulesref}[$i]->{'gid'};
 362         if ( ${$modulesref}[$i]->{'specificlanguage'} ) { $uniquekey = $uniquekey . "_" . ${$modulesref}[$i]->{'specificlanguage'}; }
 363         ${$modulesref}[$i]->{'uniquekey'} = $uniquekey;
 364     }
 365 }
 366
 367 #################################################################################
 368 # Creating the file Feature.idt dynamically
 369 # Content:
 370 # Feature Feature_Parent Title Description Display Level Directory_ Attributes
 371 #################################################################################
 372
 373 sub create_feature_table
 374 {
 375     my ($modulesref, $basedir, $languagesarrayref, $allvariableshashref) = @_;
 376
 377     for ( my $m = 0; $m <= $#{$languagesarrayref}; $m++ )
 378     {
 379         my $onelanguage = ${$languagesarrayref}[$m];
 380
 381         my $infoline;
 382
 383         my @featuretable = ();
 384
 385         installer::windows::idtglobal::write_idt_header(\@featuretable, "feature");
 386
 387         for ( my $i = 0; $i <= $#{$modulesref}; $i++ )
 388         {
 389             my $onefeature = ${$modulesref}[$i];
 390
 391             # Java and Ada only, if the correct settings are set
 392             my $styles = "";
 393             if ( $onefeature->{'Styles'} ) { $styles = $onefeature->{'Styles'}; }
 394             if (( $styles =~ /\bJAVAMODULE\b/ ) && ( ! ($allvariableshashref->{'JAVAPRODUCT'} ))) { next; }
 395             if (( $styles =~ /\bADAMODULE\b/ ) && ( ! ($allvariableshashref->{'ADAPRODUCT'} ))) { next; }
 396
 397             # Controlling the language!
 398             # Only language independent feature or feature with the correct language will be included into the table
 399
 400             if (! (!(( $onefeature->{'ismultilingual'} )) || ( $onefeature->{'specificlanguage'} eq $onelanguage )) )  { next; }
 401
 402             my %feature = ();
 403
 404             $feature{'feature'} = get_feature_gid($onefeature);
 405             $feature{'feature_parent'} = get_feature_parent($onefeature);
 406             # if ( $onefeature->{'ParentID'} eq "" ) { $feature{'feature_parent'} = ""; }       # Root has no parent
 407             $feature{'Title'} = $onefeature->{'Name'};
 408             $feature{'Description'} = $onefeature->{'Description'};
 409             $feature{'Display'} = get_feature_display($onefeature);
 410             $feature{'Level'} = get_feature_level($onefeature);
 411             $feature{'Directory_'} = get_feature_directory($onefeature);
 412             $feature{'Attributes'} = get_feature_attributes($onefeature);
 413
 414             my $oneline = $feature{'feature'} . "\t" . $feature{'feature_parent'} . "\t" . $feature{'Title'} . "\t"
 415                     . $feature{'Description'} . "\t" . $feature{'Display'} . "\t" . $feature{'Level'} . "\t"
 416                     . $feature{'Directory_'} . "\t" . $feature{'Attributes'} . "\n";
 417
 418             push(@featuretable, $oneline);
 419
 420             # collecting all feature in global feature collector (so that properties can be set in property table)
 421             if ( ! installer::existence::exists_in_array($feature{'feature'}, \@installer::globals::featurecollector) )
 422             {
 423                 push(@installer::globals::featurecollector, $feature{'feature'});
 424             }
 425
 426             # collecting all language feature in feature collector for check of language selection
 427             if (( $styles =~ /\bSHOW_MULTILINGUAL_ONLY\b/ ) && ( $onefeature->{'ParentID'} ne $installer::globals::rootmodulegid ))
 428             {
 429                 $installer::globals::multilingual_only_modules{$feature{'feature'}} = 1;
 430             }
 431
 432             # collecting all application feature in global feature collector for check of application selection
 433             if ( $styles =~ /\bAPPLICATIONMODULE\b/ )
 434             {
 435                 $installer::globals::application_modules{$feature{'feature'}} = 1;
 436             }
 437         }
 438
 439         # Saving the file
 440
 441         my $featuretablename = $basedir . $installer::globals::separator . "Feature.idt" . "." . $onelanguage;
 442         installer::files::save_file($featuretablename ,\@featuretable);
 443         $infoline = "Created idt file: $featuretablename\n";
 444         push(@installer::globals::logfileinfo, $infoline);
 445     }
 446
 447 }
 448
 449 1;