File Coverage

blib/lib/TeX/AutoTeX/Log.pm

Criterion	Covered	Total	%
statement	12	57	21.0
branch	0	22	0.0
condition	0	6	0.0
subroutine	4	11	36.3
pod	6	6	100.0
total	22	102	21.5

package TeX::AutoTeX::Log;

#
# $Id: Log.pm,v 1.10.2.5 2011/01/27 18:42:28 thorstens Exp $
# $Revision: 1.10.2.5 $
# $Source: /cvsroot/arxivlib/arXivLib/lib/TeX/AutoTeX/Log.pm,v $
#
# $Date: 2011/01/27 18:42:28 $
# $Author: thorstens $
#

use strict;
### use warnings;
use Carp;
use TeX::AutoTeX::Exception;

our ($VERSION) = '$Revision: 1.10.2.5 $' =~ m{ \$Revision: \s+ (\S+) }x;

use IO::Handle; #for autoflush

sub new {
  my $that  = shift;
  my $class = ref($that) || $that;
  my $self  = {
	       logfile => 'auto_gen_ps.log',
	       dir     => undef,
	       logfh   => undef,
	       dupefh  => undef,
	       verbose => 0,
	       @_
	      };
  if (!(defined $self->{dir} && -d $self->{dir})) {
    throw TeX::AutoTeX::FatalException 'TeX::AutoTeX::Log::new requires a directory (dir) option to write the log to'
  }
  bless $self, $class;
  $self->{dupefh}->autoflush(1) if $self->{dupefh};
  return $self;
}

sub open_logfile {
  my $self = shift;
  if (!$self->{logfile}) {
    throw TeX::AutoTeX::FatalException q{Can't open log file without a name.};
  }
  open($self->{logfh}, '>', "$self->{dir}/$self->{logfile}")
    || throw TeX::AutoTeX::FatalException "Could not open log file '$self->{logfile}' for writing.";
  return 1;
}

sub close_logfile {
  my $self = shift;
  if ($self->{logfh}) {
    close $self->{logfh} || carp q{couldn't close logfile};
    return 1;
  }
  return;
}

sub error {
  my ($self, $msg) = @_;
  $msg =~ s/\n\s*$//;
  $self->__logit('error', "$msg\n*** AutoTeX ABORTING ***\n");
  throw TeX::AutoTeX::FatalException $msg;
}

sub verbose {
  my ($self, $msg) = @_;
  $self->__logit('verbose', $msg) if $self->{verbose};
  return;
}

sub __logit {
  my ($self, $level, $msg) = @_;
  $msg = "[$level]: $msg\n";
  if ($self->{logfh}) {
    print {$self->{logfh}} $msg;
  }
  if ($self->{dupefh}) {
    print {$self->{dupefh}} $msg;
  }
  return;
}

sub to_stringref {
  my $self = shift;
  seek $self->{logfh}, 0, 1; # flush buffered log messages
  if (open my $LOG, '<', "$self->{dir}/$self->{logfile}") {
    my $logcontent;
    {
      local $/ = undef;
      $logcontent = <$LOG>;
    }
    close $LOG || carp q{couldn't close logfile};
    return \$logcontent;
  }
  carp q{can't open logfile};
  return;
}

1;

__END__