solenv/bin/modules/installer/windows/featurecomponent.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: featurecomponent.pm,v $
  10 #
  11 # $Revision: 1.5 $
  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::featurecomponent;
  33
  34 use installer::converter;
  35 use installer::existence;
  36 use installer::exiter;
  37 use installer::files;
  38 use installer::globals;
  39 use installer::windows::idtglobal;
  40
  41 #################################################################################
  42 # Collecting all pairs of features and components from the files collector
  43 #################################################################################
  44
  45 sub create_featurecomponent_table_from_files_collector
  46 {
  47     my ($featurecomponenttableref, $filesref) = @_;
  48
  49     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
  50     {
  51         my $onefile = ${$filesref}[$i];
  52
  53         my $filecomponent = $onefile->{'componentname'};
  54         my $filemodules = $onefile->{'modules'};
  55
  56         if ( $filecomponent eq "" )
  57         {
  58             installer::exiter::exit_program("ERROR: No component defined for file $onefile->{'Name'}", "create_featurecomponent_table_from_files_collector");
  59         }
  60         if ( $filemodules eq "" )
  61         {
  62             installer::exiter::exit_program("ERROR: No modules found for file $onefile->{'Name'}", "create_featurecomponent_table_from_files_collector");
  63         }
  64
  65         my $filemodulesarrayref = installer::converter::convert_stringlist_into_array(\$filemodules, ",");
  66
  67         for ( my $j = 0; $j <= $#{$filemodulesarrayref}; $j++ )
  68         {
  69             my %featurecomponent = ();
  70
  71             my $onemodule = ${$filemodulesarrayref}[$j];
  72             $onemodule =~ s/\s*$//;
  73             $featurecomponent{'Feature'} = $onemodule;
  74             $featurecomponent{'Component'} = $filecomponent;
  75
  76             # Attention: Features are renamed, because the maximum length is 38.
  77             # But in the files collector ($filesref), the original names are saved.
  78
  79             installer::windows::idtglobal::shorten_feature_gid(\$featurecomponent{'Feature'});
  80
  81             $oneline = "$featurecomponent{'Feature'}\t$featurecomponent{'Component'}\n";
  82
  83             # control of uniqueness
  84
  85             if (! installer::existence::exists_in_array($oneline, $featurecomponenttableref))
  86             {
  87                 push(@{$featurecomponenttableref}, $oneline);
  88             }
  89         }
  90     }
  91 }
  92
  93 #################################################################################
  94 # Collecting all pairs of features and components from the registry collector
  95 #################################################################################
  96
  97 sub create_featurecomponent_table_from_registry_collector
  98 {
  99     my ($featurecomponenttableref, $registryref) = @_;
 100
 101     for ( my $i = 0; $i <= $#{$registryref}; $i++ )
 102     {
 103         my $oneregistry = ${$registryref}[$i];
 104
 105         my $registrycomponent = $oneregistry->{'componentname'};
 106         my $registrymodule = $oneregistry->{'ModuleID'};
 107
 108         if ( $registrycomponent eq "" )
 109         {
 110             installer::exiter::exit_program("ERROR: No component defined for registry $oneregistry->{'gid'}", "create_featurecomponent_table_from_registry_collector");
 111         }
 112         if ( $registrymodule eq "" )
 113         {
 114             installer::exiter::exit_program("ERROR: No modules found for registry $oneregistry->{'gid'}", "create_featurecomponent_table_from_registry_collector");
 115         }
 116
 117         my %featurecomponent = ();
 118
 119         $featurecomponent{'Feature'} = $registrymodule;
 120         $featurecomponent{'Component'} = $registrycomponent;
 121
 122         # Attention: Features are renamed, because the maximum length is 38.
 123         # But in the files collector ($filesref), the original names are saved.
 124
 125         installer::windows::idtglobal::shorten_feature_gid(\$featurecomponent{'Feature'});
 126
 127         $oneline = "$featurecomponent{'Feature'}\t$featurecomponent{'Component'}\n";
 128
 129         # control of uniqueness
 130
 131         if (! installer::existence::exists_in_array($oneline, $featurecomponenttableref))
 132         {
 133             push(@{$featurecomponenttableref}, $oneline);
 134         }
 135     }
 136 }
 137
 138 #################################################################################
 139 # Collecting all feature that are listed in the featurecomponent table.
 140 #################################################################################
 141
 142 sub collect_all_feature
 143 {
 144     my ($featurecomponenttable) = @_;
 145
 146     my @allfeature = ();
 147
 148     for ( my $i = 3; $i <= $#{$featurecomponenttable}; $i++ )   # beginning in line 4
 149     {
 150         my $oneline = ${$featurecomponenttable}[$i];
 151
 152         if ( $oneline =~ /^\s*(\S+)\s+(\S+)\s*$/ )
 153         {
 154             my $feature = $1;
 155
 156             if (! installer::existence::exists_in_array($feature, \@allfeature)) { push(@allfeature, $feature); }
 157         }
 158     }
 159
 160     return \@allfeature;
 161 }
 162
 163 #################################################################################
 164 # On Win98 and Win Me there seems to be the problem, that maximum 817
 165 # components can be added to a feature. Even if Windows Installer 2.0
 166 # is used.
 167 #################################################################################
 168
 169 sub check_number_of_components_at_feature
 170 {
 171     my ($featurecomponenttable) = @_;
 172
 173     my $infoline = "\nChecking number of components at features. Maximum is 817 (for Win 98 and Win Me)\n";
 174     push(@installer::globals::logfileinfo, $infoline);
 175
 176     my $allfeature = collect_all_feature($featurecomponenttable);
 177
 178     for ( my $i = 0; $i <= $#{$allfeature}; $i++ )
 179     {
 180         my $onefeature = ${$allfeature}[$i];
 181         my $featurecomponents = 0;
 182
 183         for ( my $j = 0; $j <= $#{$featurecomponenttable}; $j++ )
 184         {
 185             if ( ${$featurecomponenttable}[$j] =~ /^\s*\Q$onefeature\E\s+(\S+)\s*$/ ) { $featurecomponents++; }
 186         }
 187
 188         if ( $featurecomponents > 816 )
 189         {
 190             installer::exiter::exit_program("ERROR: More than 816 components ($featurecomponents) at feature $onefeature. This causes problems on Win 98 and Win Me!", "check_number_of_components_at_feature");
 191         }
 192
 193         # Logging the result
 194
 195         $infoline = "Number of components at feature $onefeature : $featurecomponents\n";
 196         push(@installer::globals::logfileinfo, $infoline);
 197     }
 198
 199     $infoline = "\n";
 200     push(@installer::globals::logfileinfo, $infoline);
 201 }
 202
 203 #################################################################################
 204 # Creating the file FeatureC.idt dynamically
 205 # Content:
 206 # Feature Component
 207 #################################################################################
 208
 209 sub create_featurecomponent_table
 210 {
 211     my ($filesref, $registryref, $basedir) = @_;
 212
 213     my @featurecomponenttable = ();
 214     my $infoline;
 215
 216     installer::windows::idtglobal::write_idt_header(\@featurecomponenttable, "featurecomponent");
 217
 218     # This is the first time, that features and componentes are related
 219     # Problem: How about created profiles, configurationfiles, services.rdb
 220     # -> simple solution: putting them all to the root module
 221     # Otherwise profiles and configurationfiles cannot be created the way, they are now created
 222     # -> especially a problem for the configurationfiles! # ToDo
 223     # Very good: All ProfileItems belong to the root
 224     # services.rdb belongs to the root anyway.
 225
 226     # At the moment only the files are related to components (and the files know their modules).
 227     # The component for each file is written into the files collector $filesinproductlanguageresolvedarrayref
 228
 229     create_featurecomponent_table_from_files_collector(\@featurecomponenttable, $filesref);
 230
 231     create_featurecomponent_table_from_registry_collector(\@featurecomponenttable, $registryref);
 232
 233     # Additional components have to be added here
 234
 235     # Checking, whether there are more than 817 components at a feature
 236
 237     check_number_of_components_at_feature(\@featurecomponenttable);
 238
 239     # Saving the file
 240
 241     my $featurecomponenttablename = $basedir . $installer::globals::separator . "FeatureC.idt";
 242     installer::files::save_file($featurecomponenttablename ,\@featurecomponenttable);
 243     $infoline = "Created idt file: $featurecomponenttablename\n";
 244     push(@installer::globals::logfileinfo, $infoline);
 245
 246 }
 247
 248 1;