/usr/share/perl5/Mail/Mbox/MessageParser/Cache.pm is in libmail-mbox-messageparser-perl 1.5002-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 | package Mail::Mbox::MessageParser::Cache;
no strict;
@ISA = qw( Exporter Mail::Mbox::MessageParser );
use strict;
use Carp;
use Mail::Mbox::MessageParser;
use Mail::Mbox::MessageParser::MetaInfo;
use vars qw( $VERSION $DEBUG );
use vars qw( $CACHE );
$VERSION = sprintf "%d.%02d%02d", q/1.30.2/ =~ /(\d+)/g;
*ENTRY_STILL_VALID = \&Mail::Mbox::MessageParser::MetaInfo::ENTRY_STILL_VALID;
sub ENTRY_STILL_VALID;
*CACHE = \$Mail::Mbox::MessageParser::MetaInfo::CACHE;
*WRITE_CACHE = \&Mail::Mbox::MessageParser::MetaInfo::WRITE_CACHE;
*INITIALIZE_ENTRY = \&Mail::Mbox::MessageParser::MetaInfo::INITIALIZE_ENTRY;
sub WRITE_CACHE;
sub INITIALIZE_ENTRY;
*DEBUG = \$Mail::Mbox::MessageParser::DEBUG;
*dprint = \&Mail::Mbox::MessageParser::dprint;
sub dprint;
#-------------------------------------------------------------------------------
sub new
{
my ($proto, $self) = @_;
carp "Need file_name option" unless defined $self->{'file_name'};
carp "Need file_handle option" unless defined $self->{'file_handle'};
carp "Call SETUP_CACHE() before calling new()"
unless exists $Mail::Mbox::MessageParser::MetaInfo::CACHE_OPTIONS{'file_name'};
bless ($self, __PACKAGE__);
$self->_init();
return $self;
}
#-------------------------------------------------------------------------------
sub _init
{
my $self = shift;
WRITE_CACHE();
$self->SUPER::_init();
INITIALIZE_ENTRY($self->{'file_name'});
}
#-------------------------------------------------------------------------------
sub reset
{
my $self = shift;
$self->SUPER::reset();
# If we're in the middle of parsing this file, we need to reset the cache
INITIALIZE_ENTRY($self->{'file_name'});
}
#-------------------------------------------------------------------------------
sub _read_prologue
{
my $self = shift;
dprint "Reading mailbox prologue using cache";
my $prologue_length = $CACHE->{$self->{'file_name'}}{'emails'}[0]{'offset'};
my $total_amount_read = 0;
do {
$total_amount_read += read($self->{'file_handle'}, $self->{'prologue'},
$prologue_length-$total_amount_read, $total_amount_read);
} while ($total_amount_read != $prologue_length);
}
#-------------------------------------------------------------------------------
sub read_next_email
{
my $self = shift;
my $entry_became_invalidated = 0;
unless (defined $self->{'file_name'} &&
ENTRY_STILL_VALID($self->{'file_name'}))
{
$entry_became_invalidated = 1;
# Patch up the data structures for the Perl implementation
$self->{'CURRENT_LINE_NUMBER'} =
$CACHE->{$self->{'file_name'}}{'emails'}[$self->{'email_number'}]{'line_number'};
$self->{'CURRENT_OFFSET'} =
$CACHE->{$self->{'file_name'}}{'emails'}[$self->{'email_number'}]{'offset'};
$self->{'READ_CHUNK_SIZE'} =
$Mail::Mbox::MessageParser::Config{'read_chunk_size'};
$self->{'READ_BUFFER'} = '';
$self->{'END_OF_EMAIL'} = 0;
# Invalidate the remaining data
$#{ $CACHE->{$self->{'file_name'}}{'emails'} } = $self->{'email_number'};
bless ($self, 'Mail::Mbox::MessageParser::Perl');
return $self->read_next_email();
}
return undef if $self->end_of_file();
$self->{'email_line_number'} =
$CACHE->{$self->{'file_name'}}{'emails'}[$self->{'email_number'}]{'line_number'};
$self->{'email_offset'} =
$CACHE->{$self->{'file_name'}}{'emails'}[$self->{'email_number'}]{'offset'};
my $email = '';
$self->{'email_length'} =
$CACHE->{$self->{'file_name'}}{'emails'}[$self->{'email_number'}]{'length'};
{
my $total_amount_read = length($email);
do {
$total_amount_read += read($self->{'file_handle'}, $email,
$self->{'email_length'}-$total_amount_read, $total_amount_read);
} while ($total_amount_read != $self->{'email_length'});
}
unless ($CACHE->{$self->{'file_name'}}{'emails'}[$self->{'email_number'}]{'validated'}) {
my $current_time = localtime;
my $email_last_modified_time = localtime((stat($self->{'file_name'}))[9]);
my $cache_last_modified_time =
localtime((stat($Mail::Mbox::MessageParser::MetaInfo::CACHE_OPTIONS{'file_name'}))[9]);
die <<EOF;
Cache data not validated. This should not occur. Please send an email to
david\@coppit.org with the following information.
Debugging info:
- Current time: $current_time
- Email file: $self->{'file_name'}
- Email file last modified time: $email_last_modified_time
- Cache file: $Mail::Mbox::MessageParser::MetaInfo::CACHE_OPTIONS{'file_name'}
- Cache file last modified time: $cache_last_modified_time
- Email number: $self->{'email_number'}
- Email line number: $self->{'email_line_number'}
- Email offset: $self->{'email_offset'}
- Email length: $self->{'email_length'}
- Entry became invalidated?: $entry_became_invalidated
It would also be really helpful if you could send the cache and email file,
but I realize that many would not be comfortable doing that.
EOF
}
$self->{'email_number'}++;
$self->SUPER::read_next_email();
return \$email;
}
#-------------------------------------------------------------------------------
sub _print_debug_information
{
return unless $DEBUG;
my $self = shift;
$self->SUPER::_print_debug_information();
dprint "Valid cache entry exists: " .
($#{ $CACHE->{$self->{'file_name'}}{'emails'} } != -1 ? "Yes" : "No");
}
1;
__END__
# --------------------------------------------------------------------------
=head1 NAME
Mail::Mbox::MessageParser::Cache - A cache-based mbox folder reader
=head1 SYNOPSIS
#!/usr/bin/perl
use Mail::Mbox::MessageParser;
my $filename = 'mail/saved-mail';
my $filehandle = new FileHandle($filename);
# Set up cache
Mail::Mbox::MessageParser::SETUP_CACHE(
{ 'file_name' => '/tmp/cache' } );
my $folder_reader =
new Mail::Mbox::MessageParser( {
'file_name' => $filename,
'file_handle' => $filehandle,
'enable_cache' => 1,
} );
die $folder_reader unless ref $folder_reader;
warn "No cached information"
if $Mail::Mbox::MessageParser::Cache::UPDATING_CACHE;
# Any newlines or such before the start of the first email
my $prologue = $folder_reader->prologue;
print $prologue;
# This is the main loop. It's executed once for each email
while(!$folder_reader->end_of_file());
{
my $email = $folder_reader->read_next_email();
print $email;
}
=head1 DESCRIPTION
This module implements a cached-based mbox folder reader. It can only be used
when cache information already exists. Users must not instantiate this class
directly--use Mail::Mbox::MessageParser instead. The base MessageParser module
will automatically manage the use of cache and non-cache implementations.
=head2 METHODS AND FUNCTIONS
The following methods and functions are specific to the
Mail::Mbox::MessageParser::Cache package. For additional inherited ones, see
the Mail::Mbox::MessageParser documentation.
=over 4
=item $ref = new( { 'file_name' => <mailbox file name>,
'file_handle' => <mailbox file handle>, });
<file_name> - The full filename of the mailbox
<file_handle> - An opened file handle for the mailbox
The constructor for the class takes two parameters. I<file_name> is the
filename of the mailbox. This will be used as the cache key, so it's important
that it fully defines the path to the mailbox. The I<file_handle> argument is
the opened file handle to the mailbox. Both arguments are required.
Returns a reference to a Mail::Mbox::MessageParser object, or a string
describing the error.
=back
=head1 BUGS
No known bugs.
Contact david@coppit.org for bug reports and suggestions.
=head1 AUTHOR
David Coppit <david@coppit.org>.
=head1 LICENSE
This software is distributed under the terms of the GPL. See the file
"LICENSE" for more information.
=head1 HISTORY
This code was originally part of the grepmail distribution. See
http://grepmail.sf.net/ for previous versions of grepmail which included early
versions of this code.
=head1 SEE ALSO
Mail::Mbox::MessageParser
=cut
|