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 the "gid_File_Lib_Oox"
  79
  80     my $vclgid = "gid_File_Lib_Oox";
  81     if ( $allvariables->{'GLOBALFILEGID'} ) { $vclgid = $allvariables->{'GLOBALFILEGID'}; }
  82     my ($vclfile) = grep {$_->{gid} eq $vclgid} @{$filesarrayref};
  83     if (! defined $vclfile) {
  84         die "Could not find file $vclgid in list of files!";
  85     }
  86
  87     # copying all base data
  88     installer::converter::copy_item_object($vclfile, \%profile);
  89
  90     # and overriding all new values
  91
  92     $profile{'ismultilingual'} = 0;
  93     $profile{'sourcepath'} = $completeprofilename;
  94     $profile{'Name'} = $oneprofile->{'Name'};
  95     $profile{'UnixRights'} = "644";
  96     $profile{'gid'} = $oneprofile->{'gid'};
  97     $profile{'Dir'} = $oneprofile->{'Dir'};
  98     $profile{'destination'} = $oneprofile->{'destination'};
  99     $profile{'Styles'} = "";
 100     if ( $oneprofile->{'Styles'} ) { $profile{'Styles'} = $oneprofile->{'Styles'}; }
 101     $profile{'modules'} = $oneprofile->{'ModuleID'};    # Profiles can only be added completely to a module
 102
 103     push(@{$filesarrayref}, \%profile);
 104 }
 105
 106 ###################################################
 107 # Including Windows line ends in ini files
 108 # Profiles on Windows shall have \r\n line ends
 109 ###################################################
 110
 111 sub include_windows_lineends
 112 {
 113     my ($onefile) = @_;
 114
 115     for ( my $i = 0; $i <= $#{$onefile}; $i++ )
 116     {
 117         ${$onefile}[$i] =~ s/\r?\n$/\r\n/;
 118     }
 119 }
 120
 121 ####################################
 122 # Create profiles
 123 ####################################
 124
 125 sub create_profiles
 126 {
 127     my ($profilesref, $profileitemsref, $filesarrayref, $languagestringref, $allvariables) = @_;
 128
 129     my $infoline;
 130
 131     my $profilesdir = installer::systemactions::create_directories("profiles", $languagestringref);
 132
 133     installer::logger::include_header_into_logfile("Creating profiles:");
 134
 135     # Attention: The module dependencies from ProfileItems have to be ignored, because
 136     # the Profile has to be installed completely with all of its content and the correct name.
 137     # Only complete profiles can belong to a specified module, but not ProfileItems!
 138
 139     # iterating over all files
 140
 141     for ( my $i = 0; $i <= $#{$profilesref}; $i++ )
 142     {
 143         my $oneprofile = ${$profilesref}[$i];
 144         my $dir = $oneprofile->{'Dir'};
 145         if ( $dir eq "PREDEFINED_CONFIGDIR" ) { next; }     # ignoring the profile sversion file
 146
 147         my $profilegid = $oneprofile->{'gid'};
 148         my $profilename = $oneprofile->{'Name'};
 149
 150         my $localprofilesdir = $profilesdir . $installer::globals::separator . $profilegid; # uniqueness guaranteed by gid
 151         if ( ! -d $localprofilesdir ) { installer::systemactions::create_directory($localprofilesdir); }
 152
 153         my @onefile = ();
 154         my $profileempty = 1;
 155
 156         for ( my $j = 0; $j <= $#{$profileitemsref}; $j++ )
 157         {
 158             my $oneprofileitem = ${$profileitemsref}[$j];
 159
 160             my $styles = "";
 161             if ( $oneprofileitem->{'Styles'} ) { $styles = $oneprofileitem->{'Styles'}; }
 162             if ( $styles =~ /\bINIFILETABLE\b/ ) { next; }  # these values are written during installation, not during packing
 163
 164             my $profileid = $oneprofileitem->{'ProfileID'};
 165
 166             if ( $profileid eq $profilegid )
 167             {
 168                 my $section = $oneprofileitem->{'Section'};
 169                 my $key = $oneprofileitem->{'Key'};
 170                 my $value = $oneprofileitem->{'Value'};
 171                 for (my $pk = 1; $pk <= 50; $pk++)
 172                 {
 173                     my $key = "ValueList" . $pk;
 174                     if ( $oneprofileitem->{$key} )
 175                         { $value = $value . " " . $oneprofileitem->{$key} }
 176                 }
 177                 my $order = $oneprofileitem->{'Order'}; # ignoring order at the moment
 178
 179                 my $line = "[" . $section . "]" . "\n";
 180                 push(@onefile, $line);
 181                 $line = $key . "=" . $value . "\n";
 182                 push(@onefile, $line);
 183
 184                 $profileempty = 0;
 185             }
 186         }
 187
 188         if ( $profileempty ) { next; }  # ignoring empty profiles
 189
 190         # Sorting the array @onefile
 191         my $onefileref = sorting_profile(\@onefile);
 192
 193         if ( $installer::globals::iswin && $^O =~ /cygwin/i)      # Windows line ends only for Cygwin
 194         {
 195             include_windows_lineends($onefileref);
 196         }
 197
 198         # Saving the profile as a file
 199         $completeprofilename = $localprofilesdir . $installer::globals::separator . $profilename;
 200
 201         installer::files::save_file($completeprofilename, $onefileref);
 202
 203         # Adding the file to the filearray
 204         # Some data are set now, others are taken from the file "soffice.exe" ("soffice.bin")
 205         add_profile_into_filelist($filesarrayref, $oneprofile, $completeprofilename, $allvariables);
 206
 207         $infoline = "Created Profile: $completeprofilename\n";
 208         push( @installer::globals::logfileinfo, $infoline);
 209     }
 210
 211     $infoline = "\n";
 212     push( @installer::globals::logfileinfo, $infoline);
 213 }
 214
 215
 216 1;