solenv/bin/modules/installer/files.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: files.pm,v $
  10 #
  11 # $Revision: 1.9 $
  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::files;
  33
  34 use installer::exiter;
  35 use installer::logger;
  36
  37 ############################################
  38 # File Operations
  39 ############################################
  40
  41 sub check_file
  42 {
  43     my ($arg) = @_;
  44
  45     if ( $installer::globals::debug ) { installer::logger::debuginfo("installer::files::check_file : $arg"); }
  46
  47     if(!( -f $arg ))
  48     {
  49         installer::exiter::exit_program("ERROR: Cannot find file $arg", "check_file");
  50     }
  51 }
  52
  53 sub read_file
  54 {
  55     my ($localfile) = @_;
  56     my @localfile = ();
  57
  58     if ( $installer::globals::debug ) { installer::logger::debuginfo("installer::files::read_file : $localfile"); }
  59
  60     open( IN, "<$localfile" ) || installer::exiter::exit_program("ERROR: Cannot open file $localfile for reading", "read_file");
  61
  62 #       Don't use "my @localfile = <IN>" here, because
  63 #       perl has a problem with the internal "large_and_huge_malloc" function
  64 #       when calling perl using MacOS 10.5 with a perl built with MacOS 10.4
  65     while ( $line = <IN> ) {
  66         push @localfile, $line;
  67     }
  68
  69     close( IN );
  70
  71     return \@localfile;
  72 }
  73
  74 ###########################################
  75 # Saving files, arrays and hashes
  76 ###########################################
  77
  78 sub save_file
  79 {
  80     my ($savefile, $savecontent) = @_;
  81
  82     if ( $installer::globals::debug ) { installer::logger::debuginfo("installer::files::save_file : $savefile : $#{$savecontent}"); }
  83
  84     if ( open( OUT, ">$savefile" ) )
  85     {
  86         print OUT @{$savecontent};
  87         close( OUT);
  88     }
  89     else
  90     {
  91         # it is useless to save a log file, if there is no write access
  92
  93         if ( $savefile =~ /\.log/ )
  94         {
  95             print "\n*************************************************\n";
  96             print "ERROR: Cannot write log file: $savefile";
  97             print "\n*************************************************\n";
  98             exit(-1);   # exiting the program to avoid endless loops
  99         }
 100
 101         installer::exiter::exit_program("ERROR: Cannot open file $savefile for writing", "save_file");
 102     }
 103 }
 104
 105 sub save_hash
 106 {
 107     my ($savefile, $hashref) = @_;
 108
 109     if ( $installer::globals::debug ) { installer::logger::debuginfo("installer::files::save_hash : $savefile"); }
 110
 111     my @printcontent = ();
 112
 113     my $itemkey;
 114
 115     foreach $itemkey ( keys %{$hashref} )
 116     {
 117         my $line = "";
 118         my $itemvalue = $hashref->{$itemkey};
 119         $line = $itemkey . "=" . $itemvalue . "\n";
 120         push(@printcontent, $line);
 121     }
 122
 123     open( OUT, ">$savefile" ) || installer::exiter::exit_program("ERROR: Cannot open file $savefile for writing", "save_hash");
 124     print OUT @printcontent;
 125     close( OUT);
 126 }
 127
 128 sub save_array_of_hashes
 129 {
 130     my ($savefile, $arrayref) = @_;
 131
 132     if ( $installer::globals::debug ) { installer::logger::debuginfo("installer::files::save_array_of_hashes : $savefile : $#{$arrayref}"); }
 133
 134     my @printcontent = ();
 135
 136     for ( my $i = 0; $i <= $#{$arrayref}; $i++ )
 137     {
 138         my $line = "";
 139         my $hashref = ${$arrayref}[$i];
 140         my $itemkey;
 141
 142         foreach $itemkey ( keys %{$hashref} )
 143         {
 144             my $itemvalue = $hashref->{$itemkey};
 145             $line = $line . $itemkey . "=" . $itemvalue . "\t";
 146         }
 147
 148         $line = $line . "\n";
 149
 150         push(@printcontent, $line);
 151     }
 152
 153     open( OUT, ">$savefile" ) || installer::exiter::exit_program("ERROR: Cannot open file $savefile for writing", "save_array_of_hashes");
 154     print OUT @printcontent;
 155     close( OUT);
 156 }
 157
 158 sub save_array_of_hashes_modules
 159 {
 160     my ($savefile, $arrayref) = @_;
 161
 162     if ( $installer::globals::debug ) { installer::logger::debuginfo("installer::files::save_array_of_hashes : $savefile : $#{$arrayref}"); }
 163
 164     my @printcontent = ();
 165
 166     for ( my $i = 0; $i <= $#{$arrayref}; $i++ )
 167     {
 168         my $line = "***************************************************\n";
 169         my $hashref = ${$arrayref}[$i];
 170         my $itemkey;
 171
 172         foreach $itemkey ( keys %{$hashref} )
 173         {
 174             my $itemvalue = $hashref->{$itemkey};
 175             $line = $line . $itemkey . "=" . $itemvalue . "\n";
 176         }
 177
 178         $line = $line . "\n";
 179
 180         push(@printcontent, $line);
 181     }
 182
 183     open( OUT, ">$savefile" ) || installer::exiter::exit_program("ERROR: Cannot open file $savefile for writing", "save_array_of_hashes");
 184     print OUT @printcontent;
 185     close( OUT);
 186 }
 187
 188 ###########################################
 189 # Binary file operations
 190 ###########################################
 191
 192 sub read_binary_file
 193 {
 194     my ($filename) = @_;
 195
 196     if ( $installer::globals::debug ) { installer::logger::debuginfo("installer::files::read_binary_file : $filename"); }
 197
 198     my $file;
 199
 200     open( IN, "<$filename" ) || installer::exiter::exit_program("ERROR: Cannot open file $filename for reading", "read_binary_file");
 201     binmode IN;
 202     seek IN, 0, 2;
 203     my $length = tell IN;
 204     seek IN, 0, 0;
 205     read IN, $file, $length;
 206     close IN;
 207
 208     return $file;
 209 }
 210
 211 sub save_binary_file
 212 {
 213     my ($file, $filename) = @_;
 214
 215     if ( $installer::globals::debug ) { installer::logger::debuginfo("installer::files::save_binary_file : $filename"); }
 216
 217     open( OUT, ">$filename" ) || installer::exiter::exit_program("ERROR: Cannot open file $filename for writing", "save_binary_file");
 218     binmode OUT;
 219     print OUT $file;
 220     close OUT;
 221 }
 222
 223 1;