solenv/bin/modules/installer/profiles.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::profiles;
  20
  21 use installer::converter;
  22 use installer::files;
  23 use installer::globals;
  24 use installer::logger;
  25 use installer::remover;
  26 use installer::systemactions;
  27
  28 #############################
  29 # Profiles
  30 #############################
  31
  32 #######################################################
  33 # Sorting the content of a profile
  34 #######################################################
  35
  36 sub sorting_profile {
  37     my ($profilesref) = @_;
  38
  39     my @sections;
  40     my %section_content;
  41
  42     for ( my $i = 0; $i < @{$profilesref}; $i++ ) {
  43         my $line = ${$profilesref}[$i];
  44
  45         # Skip unless this is a section (every second line)
  46         next unless ( $line =~ /^\s*(\[.*\])\s*$/ );
  47
  48         my $section = $1;
  49         my $next_line = ${$profilesref}[$i+1];
  50
  51         if ( ! exists $section_content{$section} ) {
  52             push @sections, $section;
  53         }
  54
  55         push @{ $section_content{$section} }, $next_line;
  56     }
  57
  58     my @profile;
  59
  60     for my $section (@sections) {
  61         push @profile, "$section\n";
  62         push @profile, @{ $section_content{$section} };
  63     }
  64
  65     return \@profile;
  66 }
  67
  68 #####################################################################
  69 # Adding the newly created profile into the file list
  70 #####################################################################
  71
  72 sub add_profile_into_filelist
  73 {
  74     my ($filesarrayref, $oneprofile, $completeprofilename, $allvariables) = @_;
  75
  76     my %profile = ();
  77
  78     # Taking the base data from a file in the root module
  79
  80     if ( ! $allvariables->{'ROOTMODULEGID'} ) { installer::exiter::exit_program("ERROR: ROOTMODULEGID must be defined in list file!", "add_profile_into_filelist"); }
  81     my $rootmodulegid = $allvariables->{'ROOTMODULEGID'};
  82     my $rootfile;
  83     foreach my $file (@{$filesarrayref}) {
  84         if ($file->{'modules'} eq $rootmodulegid)
  85         {
  86             $rootfile = $file;
  87             last;
  88         }
  89     }
  90     if (! defined $rootfile) {
  91         die "Could not find any file from module $rootmodulegid in list of files!";
  92     }
  93
  94     # copying all base data
  95     installer::converter::copy_item_object($rootfile, \%profile);
  96
  97     # and overriding all new values
  98
  99     $profile{'ismultilingual'} = 0;
 100     $profile{'sourcepath'} = $completeprofilename;
 101     $profile{'Name'} = $oneprofile->{'Name'};
 102     $profile{'UnixRights'} = "644";
 103     $profile{'gid'} = $oneprofile->{'gid'};
 104     $profile{'Dir'} = $oneprofile->{'Dir'};
 105     $profile{'destination'} = $oneprofile->{'destination'};
 106     $profile{'Styles'} = "";
 107     if ( $oneprofile->{'Styles'} ) { $profile{'Styles'} = $oneprofile->{'Styles'}; }
 108     $profile{'modules'} = $oneprofile->{'ModuleID'};    # Profiles can only be added completely to a module
 109
 110     push(@{$filesarrayref}, \%profile);
 111 }
 112
 113 ###################################################
 114 # Including Windows line ends in ini files
 115 # Profiles on Windows shall have \r\n line ends
 116 ###################################################
 117
 118 sub include_windows_lineends
 119 {
 120     my ($onefile) = @_;
 121
 122     for ( my $i = 0; $i <= $#{$onefile}; $i++ )
 123     {
 124         ${$onefile}[$i] =~ s/\r?\n$/\r\n/;
 125     }
 126 }
 127
 128 ####################################
 129 # Create profiles
 130 ####################################
 131
 132 sub create_profiles
 133 {
 134     my ($profilesref, $profileitemsref, $filesarrayref, $languagestringref, $allvariables) = @_;
 135
 136     my $infoline;
 137
 138     my $profilesdir = installer::systemactions::create_directories("profiles", $languagestringref);
 139
 140     installer::logger::include_header_into_logfile("Creating profiles:");
 141
 142     # Attention: The module dependencies from ProfileItems have to be ignored, because
 143     # the Profile has to be installed completely with all of its content and the correct name.
 144     # Only complete profiles can belong to a specified module, but not ProfileItems!
 145
 146     # iterating over all files
 147
 148     for ( my $i = 0; $i <= $#{$profilesref}; $i++ )
 149     {
 150         my $oneprofile = ${$profilesref}[$i];
 151         my $dir = $oneprofile->{'Dir'};
 152         if ( $dir eq "PREDEFINED_CONFIGDIR" ) { next; }     # ignoring the profile sversion file
 153
 154         my $profilegid = $oneprofile->{'gid'};
 155         my $profilename = $oneprofile->{'Name'};
 156
 157         my $localprofilesdir = $profilesdir . $installer::globals::separator . $profilegid; # uniqueness guaranteed by gid
 158         if ( ! -d $localprofilesdir ) { installer::systemactions::create_directory($localprofilesdir); }
 159
 160         my @onefile = ();
 161         my $profileempty = 1;
 162
 163         for ( my $j = 0; $j <= $#{$profileitemsref}; $j++ )
 164         {
 165             my $oneprofileitem = ${$profileitemsref}[$j];
 166
 167             my $styles = "";
 168             if ( $oneprofileitem->{'Styles'} ) { $styles = $oneprofileitem->{'Styles'}; }
 169             if ( $styles =~ /\bINIFILETABLE\b/ ) { next; }  # these values are written during installation, not during packing
 170
 171             my $profileid = $oneprofileitem->{'ProfileID'};
 172
 173             if ( $profileid eq $profilegid )
 174             {
 175                 my $section = $oneprofileitem->{'Section'};
 176                 my $key = $oneprofileitem->{'Key'};
 177                 my $value = $oneprofileitem->{'Value'};
 178                 for (my $pk = 1; $pk <= 50; $pk++)
 179                 {
 180                     my $key = "ValueList" . $pk;
 181                     if ( $oneprofileitem->{$key} )
 182                         { $value = $value . " " . $oneprofileitem->{$key} }
 183                 }
 184                 my $order = $oneprofileitem->{'Order'}; # ignoring order at the moment
 185
 186                 my $line = "[" . $section . "]" . "\n";
 187                 push(@onefile, $line);
 188                 $line = $key . "=" . $value . "\n";
 189                 push(@onefile, $line);
 190
 191                 $profileempty = 0;
 192             }
 193         }
 194
 195         if ( $profileempty ) { next; }  # ignoring empty profiles
 196
 197         # Sorting the array @onefile
 198         my $onefileref = sorting_profile(\@onefile);
 199
 200         if ( $installer::globals::iswin && $^O =~ /cygwin/i)      # Windows line ends only for Cygwin
 201         {
 202             include_windows_lineends($onefileref);
 203         }
 204
 205         # Saving the profile as a file
 206         $completeprofilename = $localprofilesdir . $installer::globals::separator . $profilename;
 207
 208         installer::files::save_file($completeprofilename, $onefileref);
 209
 210         # Adding the file to the filearray
 211         # Some data are set now, others are taken from the file "soffice.exe" ("soffice.bin")
 212         add_profile_into_filelist($filesarrayref, $oneprofile, $completeprofilename, $allvariables);
 213
 214         $infoline = "Created Profile: $completeprofilename\n";
 215         push( @installer::globals::logfileinfo, $infoline);
 216     }
 217
 218     $infoline = "\n";
 219     push( @installer::globals::logfileinfo, $infoline);
 220 }
 221
 222
 223 1;