solenv/bin/modules/installer/logger.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: logger.pm,v $
  10 #
  11 # $Revision: 1.10 $
  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::logger;
  33
  34 use installer::files;
  35 use installer::globals;
  36
  37 ####################################################
  38 # Including header files into the logfile
  39 ####################################################
  40
  41 sub include_header_into_logfile
  42 {
  43     my ($message) = @_;
  44
  45     my $infoline;
  46
  47     $infoline = "\n" . get_time_string();
  48     push( @installer::globals::logfileinfo, $infoline);
  49
  50     $infoline = "######################################################\n";
  51     push( @installer::globals::logfileinfo, $infoline);
  52
  53     $infoline = "$message\n";
  54     push( @installer::globals::logfileinfo, $infoline);
  55
  56
  57     $infoline = "######################################################\n";
  58     push( @installer::globals::logfileinfo, $infoline);
  59 }
  60
  61 ####################################################
  62 # Including header files into the logfile
  63 ####################################################
  64
  65 sub include_header_into_globallogfile
  66 {
  67     my ($message) = @_;
  68
  69     my $infoline;
  70
  71     $infoline = "\n" . get_time_string();
  72     push( @installer::globals::globallogfileinfo, $infoline);
  73
  74     $infoline = "######################################################\n";
  75     push( @installer::globals::globallogfileinfo, $infoline);
  76
  77     $infoline = "$message\n";
  78     push( @installer::globals::globallogfileinfo, $infoline);
  79
  80
  81     $infoline = "######################################################\n";
  82     push( @installer::globals::globallogfileinfo, $infoline);
  83 }
  84
  85 ####################################################
  86 # Write timestamp into log file
  87 ####################################################
  88
  89 sub include_timestamp_into_logfile
  90 {
  91     my ($message) = @_;
  92
  93     my $infoline;
  94     my $timestring = get_time_string();
  95     $infoline = "$message\t$timestring";
  96     push( @installer::globals::logfileinfo, $infoline);
  97 }
  98
  99 ####################################################
 100 # Writing all variables content into the log file
 101 ####################################################
 102
 103 sub log_hashref
 104 {
 105     my ($hashref) = @_;
 106
 107     my $infoline = "\nLogging variable settings:\n";
 108     push(@installer::globals::globallogfileinfo, $infoline);
 109
 110     my $itemkey;
 111
 112     foreach $itemkey ( keys %{$hashref} )
 113     {
 114         my $line = "";
 115         my $itemvalue = "";
 116         if ( $hashref->{$itemkey} ) { $itemvalue = $hashref->{$itemkey}; }
 117         $line = $itemkey . "=" . $itemvalue . "\n";
 118         push(@installer::globals::globallogfileinfo, $line);
 119     }
 120
 121     $infoline = "\n";
 122     push(@installer::globals::globallogfileinfo, $infoline);
 123 }
 124
 125 #########################################################
 126 # Including global logging info into global log array
 127 #########################################################
 128
 129 sub globallog
 130 {
 131     my ($message) = @_;
 132
 133     my $infoline;
 134
 135     $infoline = "\n" . get_time_string();
 136     push( @installer::globals::globallogfileinfo, $infoline);
 137
 138     $infoline = "################################################################\n";
 139     push( @installer::globals::globallogfileinfo, $infoline);
 140
 141     $infoline = "$message\n";
 142     push( @installer::globals::globallogfileinfo, $infoline);
 143
 144     $infoline = "################################################################\n";
 145     push( @installer::globals::globallogfileinfo, $infoline);
 146
 147 }
 148
 149 ###############################################################
 150 # For each product (new language) a new log file is created.
 151 # Therefore the global logging has to be saved in this file.
 152 ###############################################################
 153
 154 sub copy_globalinfo_into_logfile
 155 {
 156     for ( my $i = 0; $i <= $#installer::globals::globallogfileinfo; $i++ )
 157     {
 158         push(@installer::globals::logfileinfo, $installer::globals::globallogfileinfo[$i]);
 159     }
 160 }
 161
 162 ###############################################################
 163 # For each product (new language) a new log file is created.
 164 # Therefore the global logging has to be saved in this file.
 165 ###############################################################
 166
 167 sub debuginfo
 168 {
 169     my  ( $message ) = @_;
 170
 171     $message = $message . "\n";
 172     push(@installer::globals::functioncalls, $message);
 173 }
 174
 175 ###############################################################
 176 # Saving the debug information.
 177 ###############################################################
 178
 179 sub savedebug
 180 {
 181     my ( $outputdir ) = @_;
 182
 183     installer::files::save_file($outputdir . $installer::globals::debugfilename, \@installer::globals::functioncalls);
 184     print_message( "... writing debug file " . $outputdir . $installer::globals::debugfilename . "\n" );
 185 }
 186
 187 ###############################################################
 188 # Starting the time
 189 ###############################################################
 190
 191 sub starttime
 192 {
 193     $installer::globals::starttime = time();
 194 }
 195
 196 ###############################################################
 197 # Convert time string
 198 ###############################################################
 199
 200 sub convert_timestring
 201 {
 202     my ($secondstring) = @_;
 203
 204     my $timestring = "";
 205
 206     if ( $secondstring < 60 )    # less than a minute
 207     {
 208         if ( $secondstring < 10 ) { $secondstring = "0" . $secondstring; }
 209         $timestring = "00\:$secondstring min\.";
 210     }
 211     elsif ( $secondstring < 3600 )
 212     {
 213         my $minutes = $secondstring / 60;
 214         my $seconds = $secondstring % 60;
 215         if ( $minutes =~ /(\d*)\.\d*/ ) { $minutes = $1; }
 216         if ( $minutes < 10 ) { $minutes = "0" . $minutes; }
 217         if ( $seconds < 10 ) { $seconds = "0" . $seconds; }
 218         $timestring = "$minutes\:$seconds min\.";
 219     }
 220     else        # more than one hour
 221     {
 222         my $hours = $secondstring / 3600;
 223         my $secondstring = $secondstring % 3600;
 224         my $minutes = $secondstring / 60;
 225         my $seconds = $secondstring % 60;
 226         if ( $hours =~ /(\d*)\.\d*/ ) { $hours = $1; }
 227         if ( $minutes =~ /(\d*)\.\d*/ ) { $minutes = $1; }
 228         if ( $hours < 10 ) { $hours = "0" . $hours; }
 229         if ( $minutes < 10 ) { $minutes = "0" . $minutes; }
 230         if ( $seconds < 10 ) { $seconds = "0" . $seconds; }
 231         $timestring = "$hours\:$minutes\:$seconds hours";
 232     }
 233
 234     return $timestring;
 235 }
 236
 237 ###############################################################
 238 # Returning time string for logging
 239 ###############################################################
 240
 241 sub get_time_string
 242 {
 243     my $currenttime = time();
 244     $currenttime = $currenttime - $installer::globals::starttime;
 245     $currenttime = convert_timestring($currenttime);
 246     $currenttime = localtime() . " \(" . $currenttime . "\)\n";
 247     return $currenttime;
 248 }
 249
 250 ###############################################################
 251 # Returning the age of a file (in seconds)
 252 ###############################################################
 253
 254 sub get_file_age
 255 {
 256     my ( $filename ) = @_;
 257
 258     my $filetime = (stat($filename))[9];
 259     my $timediff = time() - $filetime;
 260     return $timediff;
 261 }
 262
 263 ###############################################################
 264 # Stopping the time
 265 ###############################################################
 266
 267 sub stoptime
 268 {
 269     my $infoline = get_time_string();
 270     print_message( "$infoline" );
 271 }
 272
 273 ###############################################################
 274 # Set date string, format: yymmdd
 275 ###############################################################
 276
 277 sub set_installation_date
 278 {
 279     my $datestring = "";
 280
 281     my @timearray = localtime(time);
 282
 283     my $day = $timearray[3];
 284     my $month = $timearray[4] + 1;
 285     my $year = $timearray[5] - 100;
 286
 287     if ( $year < 10 ) { $year = "0" . $year; }
 288     if ( $month < 10 ) { $month = "0" . $month; }
 289     if ( $day < 10 ) { $day = "0" . $day; }
 290
 291     $datestring = $year . $month . $day;
 292
 293     return $datestring;
 294 }
 295
 296 ###############################################################
 297 # Console output: messages
 298 ###############################################################
 299
 300 sub print_message
 301 {
 302     my $message = shift;
 303     chomp $message;
 304     my $force = shift || 0;
 305     print "$message\n" if ( $force || ! $installer::globals::quiet );
 306     return;
 307 }
 308
 309 sub print_message_without_newline
 310 {
 311     my $message = shift;
 312     chomp $message;
 313     print "$message" if ( ! $installer::globals::quiet );
 314     return;
 315 }
 316
 317 ###############################################################
 318 # Console output: warnings
 319 ###############################################################
 320
 321 sub print_warning
 322 {
 323     my $message = shift;
 324     chomp $message;
 325     print STDERR "WARNING: $message";
 326     return;
 327 }
 328
 329 ###############################################################
 330 # Console output: errors
 331 ###############################################################
 332
 333 sub print_error
 334 {
 335     my $message = shift;
 336     chomp $message;
 337     print STDERR "\n**************************************************\n";
 338     print STDERR "ERROR: $message";
 339     print STDERR "\n**************************************************\n";
 340     return;
 341 }
 342
 343 1;