X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Debbugs%2FLog.pm;h=2ae7af7b919705b1e859f55cfc686a0741ab980c;hb=ce7050c06e80846da12fcb947bc4d583d9e402fa;hp=c4d741e6ab46f322a9519075c2d60cbba416de64;hpb=46fa42780ecb746d7bec2fb01190b05584b9283e;p=debbugs.git

diff --git a/Debbugs/Log.pm b/Debbugs/Log.pm
index c4d741e..2ae7af7 100644
--- a/Debbugs/Log.pm
+++ b/Debbugs/Log.pm
@@ -37,8 +37,9 @@ BEGIN {
 
 use Carp;
 
-use Debbugs::Common qw(getbuglocation getbugcomponent);
+use Debbugs::Common qw(getbuglocation getbugcomponent make_list);
 use Params::Validate qw(:types validate_with);
+use Encode qw(encode is_utf8);
 
 =head1 NAME
 
@@ -50,6 +51,11 @@ The Debbugs::Log module provides a convenient way for scripts to read and
 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
@@ -169,7 +175,7 @@ sub new
 				spec   => {bug_num => {type => SCALAR,
 						       optional => 1,
 						      },
-					   logfh   => {type => SCALAR,
+					   logfh   => {type => HANDLE,
 						       optional => 1,
 						      },
 					   log_name => {type => SCALAR,
@@ -299,14 +305,36 @@ Takes a .log filehandle as input, and returns an array of all records in
 that file. Throws exceptions using die(), so you may want to wrap this in an
 eval().
 
+Uses exactly the same options as Debbugs::Log::new
+
 =cut
 
-sub read_log_records (*)
+sub read_log_records
 {
-    my $logfh = shift;
+    my %param;
+    if (@_ == 1) {
+	 ($param{logfh}) = @_;
+    }
+    else {
+	 %param = validate_with(params => \@_,
+				spec   => {bug_num => {type => SCALAR,
+						       optional => 1,
+						      },
+					   logfh   => {type => HANDLE,
+						       optional => 1,
+						      },
+					   log_name => {type => SCALAR,
+							optional => 1,
+						       },
+					  }
+			       );
+    }
+    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 @records;
-    my $reader = Debbugs::Log->new($logfh);
+    my $reader = Debbugs::Log->new(%param);
     while (defined(my $record = $reader->read_record())) {
 	push @records, $record;
     }
@@ -318,38 +346,79 @@ sub read_log_records (*)
 Takes a filehandle and a list of records as input, and prints the .log
 format representation of those records to that filehandle.
 
+=back
+
 =cut
 
-sub write_log_records (*@)
+sub write_log_records
 {
-    my $logfh = shift;
-    my @records = @_;
+    my %param = validate_with(params => \@_,
+			      spec   => {bug_num => {type => SCALAR,
+						     optional => 1,
+						    },
+					 logfh   => {type => HANDLE,
+						     optional => 1,
+						    },
+					 log_name => {type => SCALAR,
+						      optional => 1,
+						     },
+					 records => {type => HASHREF|ARRAYREF,
+						    },
+					},
+			     );
+    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 $logfh;
+    if (exists $param{logfh}) {
+	 $logfh = $param{logfh}
+    }
+    elsif (exists $param{log_name}) {
+	 $logfh = IO::File->new(">>$param{log_name}") or
+	      die "Unable to open bug log $param{log_name} for writing: $!";
+    }
+    elsif (exists $param{bug_num}) {
+	 my $location = getbuglocation($param{bug_num},'log');
+	 my $bug_log = getbugcomponent($param{bug_num},'log',$location);
+	 $logfh = IO::File->new($bug_log, 'r') or
+	      die "Unable to open bug log $bug_log for reading: $!";
+    }
+    my @records = make_list($param{records});
 
     for my $record (@records) {
 	my $type = $record->{type};
+	croak "record type '$type' with no text field" unless defined $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.
+	# croak "probably wrong encoding" if is_utf8($record->{text});
 	my ($text) = escape_log($record->{text});
-	die "type '$type' with no text field" unless defined $text;
 	if ($type eq 'autocheck') {
-	    print $logfh "\01\n$text\03\n";
+	    print {$logfh} "\01\n$text\03\n" or
+		die "Unable to write to logfile: $!";
 	} elsif ($type eq 'recips') {
-	    print $logfh "\02\n";
+	    print {$logfh} "\02\n";
 	    my $recips = $record->{recips};
 	    if (defined $recips) {
-		die "recips not undef or array"
+		croak "recips not undef or array"
 		    unless ref($recips) eq 'ARRAY';
-		print $logfh join("\04", @$recips) . "\n";
+		print {$logfh} join("\04", @$recips) . "\n" or
+		    die "Unable to write to logfile: $!";
 	    } else {
-		print $logfh "-t\n";
+		print {$logfh} "-t\n" or
+		    die "Unable to write to logfile: $!";
 	    }
 	    #$text =~ s/^([\01-\07\030])/\030$1/gm;
-	    print $logfh "\05\n$text\03\n";
+	    print {$logfh} "\05\n$text\03\n" or
+		die "Unable to write to logfile: $!";
 	} elsif ($type eq 'html') {
-	    print $logfh "\06\n$text\03\n";
+	    print {$logfh} "\06\n$text\03\n" or
+		die "Unable to write to logfile: $!";
 	} elsif ($type eq 'incoming-recv') {
 	    #$text =~ s/^([\01-\07\030])/\030$1/gm;
-	    print $logfh "\07\n$text\03\n";
+	    print {$logfh} "\07\n$text\03\n" or
+		die "Unable to write to logfile: $!";
 	} else {
-	    die "unknown type '$type'";
+	    croak "unknown record type type '$type'";
 	}
     }
 
@@ -366,12 +435,10 @@ Applies the log escape regex to the passed logfile.
 
 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;
 }
 
 
-=back
-
 =head1 CAVEATS
 
 This module does none of the formatting that bugreport.cgi et al do. It's