solenv/bin/modules/installer/windows/featurecomponent.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::featurecomponent;
  20
  21 use installer::converter;
  22 use installer::exiter;
  23 use installer::files;
  24 use installer::globals;
  25 use installer::windows::idtglobal;
  26
  27 #################################################################################
  28 # Collecting all pairs of features and components from the files collector
  29 #################################################################################
  30
  31 sub create_featurecomponent_table_from_files_collector
  32 {
  33     my ($featurecomponenttableref, $filesref) = @_;
  34
  35     for ( my $i = 0; $i <= $#{$filesref}; $i++ )
  36     {
  37         my $onefile = ${$filesref}[$i];
  38
  39         my $filecomponent = $onefile->{'componentname'};
  40         my $filemodules = $onefile->{'modules'};
  41
  42         if ( $filecomponent eq "" )
  43         {
  44             installer::exiter::exit_program("ERROR: No component defined for file $onefile->{'Name'}", "create_featurecomponent_table_from_files_collector");
  45         }
  46         if ( $filemodules eq "" )
  47         {
  48             installer::exiter::exit_program("ERROR: No modules found for file $onefile->{'Name'}", "create_featurecomponent_table_from_files_collector");
  49         }
  50
  51         my $filemodulesarrayref = installer::converter::convert_stringlist_into_array(\$filemodules, ",");
  52
  53         for ( my $j = 0; $j <= $#{$filemodulesarrayref}; $j++ )
  54         {
  55             my %featurecomponent = ();
  56
  57             my $onemodule = ${$filemodulesarrayref}[$j];
  58             $onemodule =~ s/\s*$//;
  59             $featurecomponent{'Feature'} = $onemodule;
  60             $featurecomponent{'Component'} = $filecomponent;
  61
  62             # Attention: Features are renamed, because the maximum length is 38.
  63             # But in the files collector ($filesref), the original names are saved.
  64
  65             installer::windows::idtglobal::shorten_feature_gid(\$featurecomponent{'Feature'});
  66
  67             $oneline = "$featurecomponent{'Feature'}\t$featurecomponent{'Component'}\n";
  68
  69             # control of uniqueness
  70
  71             if (! grep {$_ eq $oneline} @{$featurecomponenttableref})
  72             {
  73                 push(@{$featurecomponenttableref}, $oneline);
  74             }
  75         }
  76     }
  77 }
  78
  79 #################################################################################
  80 # Collecting all pairs of features and components from the registry collector
  81 #################################################################################
  82
  83 sub create_featurecomponent_table_from_registry_collector
  84 {
  85     my ($featurecomponenttableref, $registryref) = @_;
  86
  87     for ( my $i = 0; $i <= $#{$registryref}; $i++ )
  88     {
  89         my $oneregistry = ${$registryref}[$i];
  90
  91         my $registrycomponent = $oneregistry->{'componentname'};
  92         my $registrymodule = $oneregistry->{'ModuleID'};
  93
  94         if ( $registrycomponent eq "" )
  95         {
  96             installer::exiter::exit_program("ERROR: No component defined for registry $oneregistry->{'gid'}", "create_featurecomponent_table_from_registry_collector");
  97         }
  98         if ( $registrymodule eq "" )
  99         {
 100             installer::exiter::exit_program("ERROR: No modules found for registry $oneregistry->{'gid'}", "create_featurecomponent_table_from_registry_collector");
 101         }
 102
 103         my %featurecomponent = ();
 104
 105         $featurecomponent{'Feature'} = $registrymodule;
 106         $featurecomponent{'Component'} = $registrycomponent;
 107
 108         # Attention: Features are renamed, because the maximum length is 38.
 109         # But in the files collector ($filesref), the original names are saved.
 110
 111         installer::windows::idtglobal::shorten_feature_gid(\$featurecomponent{'Feature'});
 112
 113         $oneline = "$featurecomponent{'Feature'}\t$featurecomponent{'Component'}\n";
 114
 115         # control of uniqueness
 116
 117         if (! grep {$_ eq $oneline} @{$featurecomponenttableref})
 118         {
 119             push(@{$featurecomponenttableref}, $oneline);
 120         }
 121     }
 122 }
 123
 124 #################################################################################
 125 # Creating the file FeatureC.idt dynamically
 126 # Content:
 127 # Feature Component
 128 #################################################################################
 129
 130 sub create_featurecomponent_table
 131 {
 132     my ($filesref, $registryref, $basedir) = @_;
 133
 134     my @featurecomponenttable = ();
 135     my $infoline;
 136
 137     installer::windows::idtglobal::write_idt_header(\@featurecomponenttable, "featurecomponent");
 138
 139     # This is the first time, that features and componentes are related
 140     # Problem: How about created profiles, configurationfiles, services.rdb
 141     # -> simple solution: putting them all to the root module
 142     # Otherwise profiles and configurationfiles cannot be created the way, they are now created
 143     # -> especially a problem for the configurationfiles! # ToDo
 144     # Very good: All ProfileItems belong to the root
 145     # services.rdb belongs to the root anyway.
 146
 147     # At the moment only the files are related to components (and the files know their modules).
 148     # The component for each file is written into the files collector $filesinproductlanguageresolvedarrayref
 149
 150     create_featurecomponent_table_from_files_collector(\@featurecomponenttable, $filesref);
 151
 152     create_featurecomponent_table_from_registry_collector(\@featurecomponenttable, $registryref);
 153
 154     # Additional components have to be added here
 155
 156     # Saving the file
 157
 158     my $featurecomponenttablename = $basedir . $installer::globals::separator . "FeatureC.idt";
 159     installer::files::save_file($featurecomponenttablename ,\@featurecomponenttable);
 160     $infoline = "Created idt file: $featurecomponenttablename\n";
 161     push(@installer::globals::logfileinfo, $infoline);
 162
 163 }
 164
 165 1;