use strict;
use vars qw($VERSION $DEBUG @EXPORT @EXPORT_OK %EXPORT_TAGS);
-use base qw(Exporter);
+use Exporter qw(import);
BEGIN {
$VERSION = 1.00;
@EXPORT = ();
%EXPORT_TAGS = (write => [qw(write_log_records),
],
- read => [qw(read_log_records),
+ read => [qw(read_log_records record_text record_regex),
],
misc => [qw(escape_log),
],
use Debbugs::Common qw(getbuglocation getbugcomponent make_list);
use Params::Validate qw(:types validate_with);
+use Encode qw(encode encode_utf8 is_utf8);
+use IO::InnerFile;
+use feature 'state';
=head1 NAME
write the .log files used by debbugs to store the complete textual records
of all bug transactions.
+Debbugs::Log does not decode utf8 into perl's internal encoding or
+encode into utf8 from perl's internal encoding. For html records and
+all recips, this should probably be done. For other records, this should
+not be needed.
+
=head2 The .log File Format
.log files consist of a sequence of records, of one of the following four
my %param;
if (@_ == 1) {
($param{logfh}) = @_;
+ $param{inner_file} = 0;
}
else {
- %param = validate_with(params => \@_,
- spec => {bug_num => {type => SCALAR,
- optional => 1,
- },
- logfh => {type => HANDLE,
- optional => 1,
- },
- log_name => {type => SCALAR,
- optional => 1,
- },
- }
- );
+ state $spec =
+ {bug_num => {type => SCALAR,
+ optional => 1,
+ },
+ logfh => {type => HANDLE,
+ optional => 1,
+ },
+ log_name => {type => SCALAR,
+ optional => 1,
+ },
+ inner_file => {type => BOOLEAN,
+ default => 0,
+ },
+ };
+ %param = validate_with(params => \@_,
+ spec => $spec,
+ );
}
- if (grep({exists $param{$_} and defined $param{$_}} qw(bug_num logfh log_name)) ne 1) {
- croak "Exactly one of bug_num, logfh, or log_name must be passed and must be defined";
+ if (grep({exists $param{$_} and defined $param{$_}}
+ qw(bug_num logfh log_name)) ne 1) {
+ croak "Exactly one of bug_num, logfh, or log_name ".
+ "must be passed and must be defined";
}
my $class = ref($this) || $this;
bless $self, $class;
if (exists $param{logfh}) {
- $self->{logfh} = $param{logfh}
- }
- elsif (exists $param{log_name}) {
- $self->{logfh} = IO::File->new($param{log_name},'r') or
- die "Unable to open bug log $param{log_name} for reading: $!";
- }
- elsif (exists $param{bug_num}) {
- my $location = getbuglocation($param{bug_num},'log');
- my $bug_log = getbugcomponent($param{bug_num},'log',$location);
- $self->{logfh} = IO::File->new($bug_log, 'r') or
- die "Unable to open bug log $bug_log for reading: $!";
+ $self->{logfh} = $param{logfh}
+ } else {
+ my $bug_log;
+ if (exists $param{bug_num}) {
+ my $location = getbuglocation($param{bug_num},'log');
+ $bug_log = getbugcomponent($param{bug_num},'log',$location);
+ } else {
+ $bug_log = $param{log_name};
+ }
+ if ($bug_log =~ m/\.gz$/) {
+ my $oldpath = $ENV{'PATH'};
+ $ENV{'PATH'} = '/bin:/usr/bin';
+ open($self->{logfh},'-|','gzip','-dc',$bug_log) or
+ die "Unable to open $bug_log for reading: $!";
+ $ENV{'PATH'} = $oldpath;
+ } else {
+ open($self->{logfh},'<',$bug_log) or
+ die "Unable to open $bug_log for reading: $!";
+ }
}
$self->{state} = 'kill-init';
$self->{linenum} = 0;
+ $self->{inner_file} = $param{inner_file};
return $self;
}
}
$this->{state} = $newstate;
-
if ($this->{state} =~ /^(autocheck|recips|html|incoming-recv)$/) {
- $record->{type} = $this->{state};
+ $record->{type} = $this->{state};
+ $record->{start} = $logfh->tell;
+ $record->{stop} = $logfh->tell;
+ $record->{inner_file} = $this->{inner_file};
} elsif ($this->{state} eq 'kill-end') {
+ if ($this->{inner_file}) {
+ $record->{fh} = IO::InnerFile->new($logfh,$record->{start},$record->{stop} - $record->{start})
+ }
return $record;
}
next;
}
-
+ $record->{stop} = $logfh->tell;
$_ = $line;
if ($this->{state} eq 'incoming-recv') {
my $pl = $_;
die "bad line '$pl' in state incoming-recv";
}
$this->{state} = 'go';
- $record->{text} .= "$_\n";
+ $record->{text} .= "$_\n" unless $this->{inner_file};
} elsif ($this->{state} eq 'html') {
- $record->{text} .= "$_\n";
+ $record->{text} .= "$_\n" unless $this->{inner_file};
} elsif ($this->{state} eq 'go') {
s/^\030//;
- $record->{text} .= "$_\n";
+ $record->{text} .= "$_\n" unless $this->{inner_file};
} elsif ($this->{state} eq 'go-nox') {
- $record->{text} .= "$_\n";
+ $record->{text} .= "$_\n" unless $this->{inner_file};
} elsif ($this->{state} eq 'recips') {
if (/^-t$/) {
undef $record->{recips};
$record->{recips} = [split /\04/, $_, -1];
}
$this->{state} = 'kill-body';
+ $record->{start} = $logfh->tell+2;
+ $record->{stop} = $logfh->tell+2;
+ $record->{inner_file} = $this->{inner_file};
} elsif ($this->{state} eq 'autocheck') {
- $record->{text} .= "$_\n";
+ $record->{text} .= "$_\n" unless $this->{inner_file};
next if !/^X-Debian-Bugs(-\w+)?: This is an autoforward from (\S+)/;
$this->{state} = 'autowait';
} elsif ($this->{state} eq 'autowait') {
- $record->{text} .= "$_\n";
+ $record->{text} .= "$_\n" unless $this->{inner_file};
next if !/^$/;
$this->{state} = 'go-nox';
} else {
log_name => {type => SCALAR,
optional => 1,
},
+ inner_file => {type => BOOLEAN,
+ default => 0,
+ },
}
);
}
for my $record (@records) {
my $type = $record->{type};
croak "record type '$type' with no text field" unless defined $record->{text};
- my ($text) = escape_log($record->{text});
+ # I am not sure if we really want to croak here; but this is
+ # almost certainly a bug if is_utf8 is on.
+ my $text = $record->{text};
+ if (is_utf8($text)) {
+ carp('Record text was in the wrong encoding (perl internal instead of utf8 octets)');
+ $text = encode_utf8($text)
+ }
+ ($text) = escape_log($text);
if ($type eq 'autocheck') {
print {$logfh} "\01\n$text\03\n" or
die "Unable to write to logfile: $!";
if (defined $recips) {
croak "recips not undef or array"
unless ref($recips) eq 'ARRAY';
+ my $wrong_encoding = 0;
+ my @recips =
+ map { if (is_utf8($_)) {
+ $wrong_encoding=1;
+ encode_utf8($_);
+ } else {
+ $_;
+ }} @$recips;
+ carp('Recipients was in the wrong encoding (perl internal instead of utf8 octets') if $wrong_encoding;
print {$logfh} join("\04", @$recips) . "\n" or
die "Unable to write to logfile: $!";
} else {
sub escape_log {
my @log = @_;
- return map { s/^([\01-\07\030])/\030$1/gm; $_ } @log;
+ return map {s/^([\01-\07\030])/\030$1/gm; $_ } @log;
+}
+
+
+sub record_text {
+ my ($record) = @_;
+ if ($record->{inner_file}) {
+ local $/;
+ my $text;
+ my $t = $record->{fh};
+ $text = <$t>;
+ $record->{fh}->seek(0,0);
+ return $text;
+ } else {
+ return $record->{text};
+ }
+}
+
+sub record_regex {
+ my ($record,$regex) = @_;
+ if ($record->{inner_file}) {
+ my @result;
+ my $fh = $record->{fh};
+ while (<$fh>) {
+ if (@result = $_ =~ m/$regex/) {
+ $record->{fh}->seek(0,0);
+ return @result;
+ }
+ }
+ $record->{fh}->seek(0,0);
+ return ();
+ } else {
+ my @result = $record->{text} =~ m/$regex/;
+ return @result;
+ return $record->{text};
+ }
}
projects / debbugs.git / blobdiff