/usr/share/perl5/Mail/SpamAssassin/ArchiveIterator.pm is in spamassassin 3.4.2-1~deb9u1.
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 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 | # iterate over mail archives, calling a function on each message.
#
# <@LICENSE>
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to you under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# </@LICENSE>
package Mail::SpamAssassin::ArchiveIterator;
use strict;
use warnings;
# use bytes;
use re 'taint';
use Errno qw(ENOENT EACCES EBADF);
use Mail::SpamAssassin::Util;
use Mail::SpamAssassin::Constants qw(:sa);
use Mail::SpamAssassin::Logger;
use Mail::SpamAssassin::AICache;
# 256 KiB is a big email, unless stated otherwise
use constant BIG_BYTES => 256*1024;
our ( $MESSAGES, $AICache, %class_opts );
our @ISA = qw();
=head1 NAME
Mail::SpamAssassin::ArchiveIterator - find and process messages one at a time
=head1 SYNOPSIS
my $iter = new Mail::SpamAssassin::ArchiveIterator(
{
'opt_max_size' => 256 * 1024, # 0 implies no limit
'opt_cache' => 1,
}
);
$iter->set_functions( \&wanted, sub { } );
eval { $iter->run(@ARGV); };
sub wanted {
my($class, $filename, $recv_date, $msg_array) = @_;
...
}
=head1 DESCRIPTION
The Mail::SpamAssassin::ArchiveIterator module will go through a set
of mbox files, mbx files, and directories (with a single message per
file) and generate a list of messages. It will then call the C<wanted_sub>
and C<result_sub> functions appropriately per message.
=head1 METHODS
=over 4
=cut
###########################################################################
=item $item = new Mail::SpamAssassin::ArchiveIterator( [ { opt => val, ... } ] )
Constructs a new C<Mail::SpamAssassin::ArchiveIterator> object. You may
pass the following attribute-value pairs to the constructor. The pairs are
optional unless otherwise noted.
=over 4
=item opt_max_size
A value of option I<opt_max_size> determines a limit (number of bytes)
beyond which a message is considered large and is skipped by ArchiveIterator.
A value 0 implies no size limit, all messages are examined. An undefined
value implies a default limit of 256 KiB.
=item opt_all
Setting this option to true implicitly sets I<opt_max_size> to 0, i.e.
no limit of a message size, all messages are processes by ArchiveIterator.
For compatibility with SpamAssassin versions older than 3.4.0 which
lacked option I<opt_max_size>.
=item opt_scanprob
Randomly select messages to scan, with a probability of N, where N ranges
from 0.0 (no messages scanned) to 1.0 (all messages scanned). Default
is 1.0.
This setting can be specified separately for each target.
=item opt_before
Only use messages which are received after the given time_t value.
Negative values are an offset from the current time, e.g. -86400 =
last 24 hours; or as parsed by Time::ParseDate (e.g. '-6 months')
This setting can be specified separately for each target.
=item opt_after
Same as opt_before, except the messages are only used if after the given
time_t value.
This setting can be specified separately for each target.
=item opt_want_date
Set to 1 (default) if you want the received date to be filled in
in the C<wanted_sub> callback below. Set this to 0 to avoid this;
it's a good idea to set this to 0 if you can, as it imposes a performance
hit.
=item opt_skip_empty_messages
Set to 1 if you want to skip corrupt, 0-byte messages. The default is 0.
=item opt_cache
Set to 0 (default) if you don't want to use cached information to help speed
up ArchiveIterator. Set to 1 to enable. This setting requires C<opt_cachedir>
also be set.
=item opt_cachedir
Set to the path of a directory where you wish to store cached information for
C<opt_cache>, if you don't want to mix them with the input files (as is the
default). The directory must be both readable and writable.
=item wanted_sub
Reference to a subroutine which will process message data. Usually
set via set_functions(). The routine will be passed 5 values: class
(scalar), filename (scalar), received date (scalar), message content
(array reference, one message line per element), and the message format
key ('f' for file, 'm' for mbox, 'b' for mbx).
Note that if C<opt_want_date> is set to 0, the received date scalar will be
undefined.
=item result_sub
Reference to a subroutine which will process the results of the wanted_sub
for each message processed. Usually set via set_functions().
The routine will be passed 3 values: class (scalar), result (scalar, returned
from wanted_sub), and received date (scalar).
Note that if C<opt_want_date> is set to 0, the received date scalar will be
undefined.
=item scan_progress_sub
Reference to a subroutine which will be called intermittently during
the 'scan' phase of the mass-check. No guarantees are made as to
how frequently this may happen, mind you.
=item opt_from_regex
This setting allows for flexibility in specifying the mbox format From separator.
It defaults to the regular expression:
/^From \S+ ?(\S\S\S \S\S\S .?\d .?\d:\d\d:\d\d \d{4}|.?\d-\d\d-\d{4}_\d\d:\d\d:\d\d_)/
Some SpamAssassin programs such as sa-learn will use the configuration option
'mbox_format_from_regex' to override the default regular expression.
=back
=cut
sub new {
my $class = shift;
$class = ref($class) || $class;
my $self = shift;
if (!defined $self) { $self = { }; }
bless ($self, $class);
# If any of these options are set, we need to figure out the message's
# receive date at scan time. opt_after, opt_before, or opt_want_date
$self->{determine_receive_date} =
defined $self->{opt_after} || defined $self->{opt_before} ||
$self->{opt_want_date};
$self->{s} = [ ]; # spam, of course
$self->{h} = [ ]; # ham, as if you couldn't guess
$self->{access_problem} = 0;
if ($self->{opt_all}) {
$self->{opt_max_size} = 0;
} elsif (!defined $self->{opt_max_size}) {
$self->{opt_max_size} = BIG_BYTES;
}
$self;
}
###########################################################################
=item set_functions( \&wanted_sub, \&result_sub )
Sets the subroutines used for message processing (wanted_sub), and result
reporting. For more information, see I<new()> above.
=cut
sub set_functions {
my ($self, $wanted, $result) = @_;
$self->{wanted_sub} = $wanted if defined $wanted;
$self->{result_sub} = $result if defined $result;
}
###########################################################################
=item run ( @target_paths )
Generates the list of messages to process, then runs each message through the
configured wanted subroutine. Files which have a name ending in C<.gz> or
C<.bz2> will be properly uncompressed via call to C<gzip -dc> and C<bzip2 -dc>
respectively.
The target_paths array is expected to be either one element per path in the
following format: C<class:format:raw_location>, or a hash reference containing
key-value option pairs and a 'target' key with a value in that format.
The key-value option pairs that can be used are: opt_scanprob, opt_after,
opt_before. See the constructor method's documentation for more information
on their effects.
run() returns 0 if there was an error (can't open a file, etc,) and 1 if there
were no errors.
=over 4
=item class
Either 'h' for ham or 's' for spam. If the class is longer than 1 character,
it will be truncated. If blank, 'h' is default.
=item format
Specifies the format of the raw_location. C<dir> is a directory whose
files are individual messages, C<file> a file with a single message,
C<mbox> an mbox formatted file, or C<mbx> for an mbx formatted directory.
C<detect> can also be used. This assumes C<mbox> for any file whose path
contains the pattern C</\.mbox/i>, C<file> anything that is not a
directory, or C<directory> otherwise.
=item raw_location
Path to file or directory. File globbing is allowed using the
standard csh-style globbing (see C<perldoc -f glob>). C<~> at the
front of the value will be replaced by the C<HOME> environment
variable. Escaped whitespace is protected as well.
B<NOTE:> C<~user> is not allowed.
B<NOTE 2:> C<-> is not allowed as a raw location. To have
ArchiveIterator deal with STDIN, generate a temp file.
=back
=cut
sub run {
my ($self, @targets) = @_;
if (!defined $self->{wanted_sub}) {
warn "archive-iterator: set_functions never called";
return 0;
}
# scan the targets and get the number and list of messages
$self->_scan_targets(\@targets,
sub {
my($self, $date, $class, $format, $mail) = @_;
push(@{$self->{$class}}, _index_pack($date, $class, $format, $mail));
}
);
my $messages;
# for ease of memory, we'll play with pointers
$messages = $self->{s};
undef $self->{s};
push(@{$messages}, @{$self->{h}});
undef $self->{h};
$MESSAGES = scalar(@{$messages});
# go ahead and run through all of the messages specified
return $self->_run($messages);
}
sub _run {
my ($self, $messages) = @_;
while (my $message = shift @{$messages}) {
my($class, undef, $date, undef, $result) = $self->_run_message($message);
&{$self->{result_sub}}($class, $result, $date) if $result;
}
return ! $self->{access_problem};
}
############################################################################
## run_message and related functions to process a single message
sub _run_message {
my ($self, $msg) = @_;
my ($date, $class, $format, $mail) = _index_unpack($msg);
if ($format eq 'f') {
return $self->_run_file($class, $format, $mail, $date);
}
elsif ($format eq 'm') {
return $self->_run_mailbox($class, $format, $mail, $date);
}
elsif ($format eq 'b') {
return $self->_run_mbx($class, $format, $mail, $date);
}
}
sub _run_file {
my ($self, $class, $format, $where, $date) = @_;
if (!_mail_open($where)) {
$self->{access_problem} = 1;
return;
}
my $stat_errn = stat(INPUT) ? 0 : 0+$!;
if ($stat_errn == ENOENT) {
dbg("archive-iterator: no such input ($where)");
return;
}
elsif ($stat_errn != 0) {
warn "archive-iterator: no access to input ($where): $!";
return;
}
elsif (!-f _ && !-c _ && !-p _) {
warn "archive-iterator: not a plain file (or char.spec. or pipe) ($where)";
return;
}
my $opt_max_size = $self->{opt_max_size};
if (!$opt_max_size) {
# process any size
} elsif (!-f _) {
# must check size while reading
} elsif (-s _ > $opt_max_size) {
# skip too-big mails
# note that -s can only deal with files, it returns 0 on char.spec. STDIN
info("archive-iterator: skipping large message: ".
"file size %d, limit %d bytes", -s _, $opt_max_size);
close INPUT or die "error closing input file: $!";
return;
}
my @msg;
my $header;
my $len = 0;
my $str = '';
my($inbuf,$nread);
while ( $nread=read(INPUT,$inbuf,16384) ) {
$len += $nread;
if ($opt_max_size && $len > $opt_max_size) {
info("archive-iterator: skipping large message: read %d, limit %d bytes",
$len, $opt_max_size);
close INPUT or die "error closing input file: $!";
return;
}
$str .= $inbuf;
}
defined $nread or die "error reading: $!";
undef $inbuf;
@msg = split(/^/m, $str, -1); undef $str;
for my $j (0..$#msg) {
if ($msg[$j] =~ /^\015?$/) { $header = $j; last }
}
close INPUT or die "error closing input file: $!";
if ($date == AI_TIME_UNKNOWN && $self->{determine_receive_date}) {
$date = Mail::SpamAssassin::Util::receive_date(join('', splice(@msg, 0, $header)));
}
return($class, $format, $date, $where, &{$self->{wanted_sub}}($class, $where, $date, \@msg, $format));
}
sub _run_mailbox {
my ($self, $class, $format, $where, $date) = @_;
my ($file, $offset);
{ local($1,$2); # Bug 7140 (avoids perl bug [perl #123880])
($file, $offset) = ($where =~ m/(.*)\.(\d+)$/);
}
my @msg;
my $header;
if (!_mail_open($file)) {
$self->{access_problem} = 1;
return;
}
my $opt_max_size = $self->{opt_max_size};
dbg("archive-iterator: _run_mailbox %s, ofs %d, limit %d",
$file, $offset, $opt_max_size||0);
seek(INPUT,$offset,0) or die "cannot reposition file to $offset: $!";
my $size = 0;
for ($!=0; <INPUT>; $!=0) {
#Changed Regex to use option Per bug 6703
last if (substr($_,0,5) eq "From " && @msg && /$self->{opt_from_regex}/o);
$size += length($_);
push (@msg, $_);
# skip mails that are too big
if ($opt_max_size && $size > $opt_max_size) {
info("archive-iterator: skipping large message: ".
"%d lines, %d bytes, limit %d bytes",
scalar @msg, $size, $opt_max_size);
close INPUT or die "error closing input file: $!";
return;
}
if (!defined $header && /^\s*$/) {
$header = $#msg;
}
}
defined $_ || $!==0 or
$!==EBADF ? dbg("archive-iterator: error reading: $!")
: die "error reading: $!";
close INPUT or die "error closing input file: $!";
if ($date == AI_TIME_UNKNOWN && $self->{determine_receive_date}) {
$date = Mail::SpamAssassin::Util::receive_date(join('', splice(@msg, 0, $header)));
}
return($class, $format, $date, $where, &{$self->{wanted_sub}}($class, $where, $date, \@msg, $format));
}
sub _run_mbx {
my ($self, $class, $format, $where, $date) = @_;
my ($file, $offset) = ($where =~ m/(.*)\.(\d+)$/);
my @msg;
my $header;
if (!_mail_open($file)) {
$self->{access_problem} = 1;
return;
}
my $opt_max_size = $self->{opt_max_size};
dbg("archive-iterator: _run_mbx %s, ofs %d, limit %d",
$file, $offset, $opt_max_size||0);
seek(INPUT,$offset,0) or die "cannot reposition file to $offset: $!";
my $size = 0;
for ($!=0; <INPUT>; $!=0) {
last if ($_ =~ MBX_SEPARATOR);
$size += length($_);
push (@msg, $_);
# skip mails that are too big
if ($opt_max_size && $size > $opt_max_size) {
info("archive-iterator: skipping large message: ".
"%d lines, %d bytes, limit %d bytes",
scalar @msg, $size, $opt_max_size);
close INPUT or die "error closing input file: $!";
return;
}
if (!defined $header && /^\s*$/) {
$header = $#msg;
}
}
defined $_ || $!==0 or
$!==EBADF ? dbg("archive-iterator: error reading: $!")
: die "error reading: $!";
close INPUT or die "error closing input file: $!";
if ($date == AI_TIME_UNKNOWN && $self->{determine_receive_date}) {
$date = Mail::SpamAssassin::Util::receive_date(join('', splice(@msg, 0, $header)));
}
return($class, $format, $date, $where, &{$self->{wanted_sub}}($class, $where, $date, \@msg, $format));
}
############################################################################
## FUNCTIONS BELOW THIS POINT ARE FOR FINDING THE MESSAGES TO RUN AGAINST
############################################################################
sub _scan_targets {
my ($self, $targets, $bkfunc) = @_;
%class_opts = ();
foreach my $target (@${targets}) {
if (!defined $target) {
warn "archive-iterator: invalid (undef) value in target list";
next;
}
my %opts;
if (ref $target eq 'HASH') {
# e.g. { target => $target, opt_foo => 1, opt_bar => 0.4 ... }
foreach my $k (keys %{$target}) {
if ($k =~ /^opt_/) {
$opts{$k} = $target->{$k};
}
}
$target = $target->{target};
}
my ($class, $format, $rawloc) = split(/:/, $target, 3);
# "class"
if (!defined $format) {
warn "archive-iterator: invalid (undef) format in target list, $target";
next;
}
# "class:format"
if (!defined $rawloc) {
warn "archive-iterator: invalid (undef) raw location in target list, $target";
next;
}
if ($rawloc eq '-') {
warn 'archive-iterator: raw location "-" is not supported';
next;
}
# use ham by default, things like "spamassassin" can't specify the type
$class = substr($class, 0, 1) || 'h';
# keep a copy of the most recent message-selection options for
# each class
$class_opts{$class} = \%opts;
foreach my $k (keys %opts) {
$self->{$k} = $opts{$k};
}
$self->_set_default_message_selection_opts();
my @locations = $self->_fix_globs($rawloc);
foreach my $location (@locations) {
my $method;
# for this location only; 'detect' means they can differ for each location
my $thisformat = $format;
if ($format eq 'detect') {
# detect the format
my $stat_errn = stat($location) ? 0 : 0+$!;
if ($stat_errn == ENOENT) {
$thisformat = 'file'; # actually, no file - to be detected later
}
elsif ($stat_errn != 0) {
warn "archive-iterator: no access to $location: $!";
$thisformat = 'file';
}
elsif (-d _) {
# it's a directory
$thisformat = 'dir';
}
elsif ($location =~ /\.mbox/i) {
# filename indicates mbox
$thisformat = 'mbox';
}
else {
$thisformat = 'file';
}
}
if ($thisformat eq 'dir') {
$method = \&_scan_directory;
}
elsif ($thisformat eq 'mbox') {
$method = \&_scan_mailbox;
}
elsif ($thisformat eq 'file') {
$method = \&_scan_file;
}
elsif ($thisformat eq 'mbx') {
$method = \&_scan_mbx;
}
else {
warn "archive-iterator: format $thisformat (from $format) unknown!";
next;
}
# call the appropriate method
&{$method}($self, $class, $location, $bkfunc);
}
}
}
sub _mail_open {
my ($file) = @_;
# bug 5288: the "magic" version of open will strip leading and trailing
# whitespace from the expression. switch to the three-argument version
# of open which does not strip whitespace. see "perldoc -f open" and
# "perldoc perlipc" for more information.
# Assume that the file by default is just a plain file
my @expr = ( $file );
my $mode = '<';
# Handle different types of compressed files
if ($file =~ /\.gz$/) {
$mode = '-|';
unshift @expr, 'gunzip', '-cd';
}
elsif ($file =~ /\.bz2$/) {
$mode = '-|';
unshift @expr, 'bzip2', '-cd';
}
# Go ahead and try to open the file
if (!open (INPUT, $mode, @expr)) {
warn "archive-iterator: unable to open $file: $!\n";
return 0;
}
# bug 5249: mail could have 8-bit data, need this on some platforms
binmode INPUT or die "cannot set input file to binmode: $!";
return 1;
}
sub _set_default_message_selection_opts {
my ($self) = @_;
$self->{opt_scanprob} = 1.0 unless (defined $self->{opt_scanprob});
$self->{opt_want_date} = 1 unless (defined $self->{opt_want_date});
$self->{opt_cache} = 0 unless (defined $self->{opt_cache});
#Changed Regex to include boundaries for Communigate Pro versions (5.2.x and later). per Bug 6413
$self->{opt_from_regex} = '^From \S+ ?(\S\S\S \S\S\S .?\d .?\d:\d\d:\d\d \d{4}|.?\d-\d\d-\d{4}_\d\d:\d\d:\d\d_)' unless (defined $self->{opt_from_regex});
#STRIP LEADING AND TRAILING / FROM REGEX FOR OPTION
$self->{opt_from_regex} =~ s/^\///;
$self->{opt_from_regex} =~ s/\/$//;
dbg("archive-iterator: _set_default_message_selection_opts After: Scanprob[$self->{opt_scanprob}], want_date[$self->{opt_want_date}], cache[$self->{opt_cache}], from_regex[$self->{opt_from_regex}]");
}
############################################################################
sub _message_is_useful_by_date {
my ($self, $date) = @_;
if (!$self->{opt_after} && !$self->{opt_before}) {
# Not using the feature
return 1;
}
return 0 unless $date; # undef or 0 date = unusable
if (!$self->{opt_before}) {
# Just care about after
return $date > $self->{opt_after};
}
else {
return (($date < $self->{opt_before}) && ($date > $self->{opt_after}));
}
}
# additional check, based solely on a file's mod timestamp. we cannot
# make assumptions about --before, since the file may have been "touch"ed
# since the last message was appended; but we can assume that too-old
# files cannot contain messages newer than their modtime.
sub _message_is_useful_by_file_modtime {
my ($self, $date) = @_;
# better safe than sorry, if date is undef; let other stuff catch errors
return 1 unless $date;
if ($self->{opt_after}) {
return ($date > $self->{opt_after});
}
else {
return 1; # --after not in use
}
}
sub _scanprob_says_scan {
my ($self) = @_;
if (defined $self->{opt_scanprob} && $self->{opt_scanprob} < 1.0) {
if ( int( rand( 1 / $self->{opt_scanprob} ) ) != 0 ) {
return 0;
}
}
return 1;
}
############################################################################
# 0 850852128 atime
# 1 h class
# 2 m format
# 3 ./ham/goodmsgs.0 path
# put the date in first, big-endian packed format
# this format lets cmp easily sort by date, then class, format, and path.
sub _index_pack {
return pack("NAAA*", @_);
}
sub _index_unpack {
return unpack("NAAA*", $_[0]);
}
############################################################################
sub _scan_directory {
my ($self, $class, $folder, $bkfunc) = @_;
my(@files,@subdirs);
if (-d "$folder/new" && -d "$folder/cur" && -d "$folder/tmp") {
# Maildir format: bug 3003
for my $sub ("new", "cur") {
opendir (DIR, "$folder/$sub")
or die "Can't open '$folder/$sub' dir: $!\n";
# Don't learn from messages marked as deleted
# Or files starting with a leading dot
push @files, map { "$sub/$_" } grep { !/^\.|:2,.*T/ } readdir(DIR);
closedir(DIR) or die "error closing directory $folder: $!";
}
}
elsif (-f "$folder/cyrus.header") {
opendir(DIR, $folder)
or die "archive-iterator: can't open '$folder' dir: $!\n";
# cyrus metadata: http://unix.lsa.umich.edu/docs/imap/imap-lsa-srv_3.html
@files = grep { $_ ne '.' && $_ ne '..' &&
/^\S+$/ && !/^cyrus\.(?:index|header|cache|seen)/ }
readdir(DIR);
closedir(DIR) or die "error closing directory $folder: $!";
}
else {
opendir(DIR, $folder)
or die "archive-iterator: can't open '$folder' dir: $!\n";
# ignore ,234 (deleted or refiled messages) and MH metadata dotfiles
@files = grep { !/^[,.]/ } readdir(DIR);
closedir(DIR) or die "error closing directory $folder: $!";
}
$_ = "$folder/$_" for @files;
if (!@files) {
# this is not a problem; no need to warn about it
# warn "archive-iterator: readdir found no mail in '$folder' directory\n";
return;
}
$self->_create_cache('dir', $folder);
foreach my $file (@files) {
my $stat_errn = stat($file) ? 0 : 0+$!;
if ($stat_errn == ENOENT) {
# no longer there?
}
elsif ($stat_errn != 0) {
warn "archive-iterator: no access to $file: $!";
}
elsif (-f _ || -c _ || -p _) {
$self->_scan_file($class, $file, $bkfunc);
}
elsif (-d _) {
push(@subdirs, $file);
}
else {
warn "archive-iterator: $file is not a plain file or directory: $!";
}
}
undef @files; # release storage
# recurse into directories
foreach my $dir (@subdirs) {
$self->_scan_directory($class, $dir, $bkfunc);
}
if (defined $AICache) {
$AICache = $AICache->finish();
}
}
sub _scan_file {
my ($self, $class, $mail, $bkfunc) = @_;
$self->_bump_scan_progress();
# only perform these stat() operations if we're not using a cache;
# it's faster to perform lookups in the cache, and more accurate
if (!defined $AICache) {
my @s = stat($mail);
@s or warn "archive-iterator: no access to $mail: $!";
return unless $self->_message_is_useful_by_file_modtime($s[9]);
}
my $date = AI_TIME_UNKNOWN;
if ($self->{determine_receive_date}) {
unless (defined $AICache and $date = $AICache->check($mail)) {
# silently skip directories/non-files; some folders may
# contain extraneous dirs etc.
my $stat_errn = stat($mail) ? 0 : 0+$!;
if ($stat_errn != 0) {
warn "archive-iterator: no access to $mail: $!";
return;
}
elsif (!-f _) {
return;
}
my $header = '';
if (!_mail_open($mail)) {
$self->{access_problem} = 1;
return;
}
for ($!=0; <INPUT>; $!=0) {
last if /^\015?$/s;
$header .= $_;
}
defined $_ || $!==0 or
$!==EBADF ? dbg("archive-iterator: error reading: $!")
: die "error reading: $!";
close INPUT or die "error closing input file: $!";
return if ($self->{opt_skip_empty_messages} && $header eq '');
$date = Mail::SpamAssassin::Util::receive_date($header);
if (defined $AICache) {
$AICache->update($mail, $date);
}
}
return if !$self->_message_is_useful_by_date($date);
return if !$self->_scanprob_says_scan();
}
else {
return if ($self->{opt_skip_empty_messages} && (-z $mail));
}
&{$bkfunc}($self, $date, $class, 'f', $mail);
return;
}
sub _scan_mailbox {
my ($self, $class, $folder, $bkfunc) = @_;
my @files;
my $stat_errn = stat($folder) ? 0 : 0+$!;
if ($stat_errn == ENOENT) {
# no longer there?
}
elsif ($stat_errn != 0) {
warn "archive-iterator: no access to $folder: $!";
}
elsif (-f _) {
push(@files, $folder);
}
elsif (-d _) {
# passed a directory of mboxes
$folder =~ s/\/\s*$//; #Remove trailing slash, if there
if (!opendir(DIR, $folder)) {
warn "archive-iterator: can't open '$folder' dir: $!\n";
$self->{access_problem} = 1;
return;
}
while ($_ = readdir(DIR)) {
next if $_ eq '.' || $_ eq '..' || !/^[^\.]\S*$/;
# hmmm, ignores folders with spaces in the name???
$stat_errn = stat("$folder/$_") ? 0 : 0+$!;
if ($stat_errn == ENOENT) {
# no longer there?
}
elsif ($stat_errn != 0) {
warn "archive-iterator: no access to $folder/$_: $!";
}
elsif (-f _) {
push(@files, "$folder/$_");
}
}
closedir(DIR) or die "error closing directory $folder: $!";
}
else {
warn "archive-iterator: $folder is not a plain file or directory: $!";
}
foreach my $file (@files) {
$self->_bump_scan_progress();
if ($file =~ /\.(?:gz|bz2)$/) {
warn "archive-iterator: compressed mbox folders are not supported at this time\n";
$self->{access_problem} = 1;
next;
}
my @s = stat($file);
@s or warn "archive-iterator: no access to $file: $!";
next unless $self->_message_is_useful_by_file_modtime($s[9]);
my $info = {};
my $count;
$self->_create_cache('mbox', $file);
if ($self->{opt_cache}) {
if ($count = $AICache->count()) {
$info = $AICache->check();
}
}
unless ($count) {
if (!_mail_open($file)) {
$self->{access_problem} = 1;
next;
}
my $start = 0; # start of a message
my $where = 0; # current byte offset
my $first = ''; # first line of message
my $header = ''; # header text
my $in_header = 0; # are in we a header?
while (!eof INPUT) {
my $offset = $start; # byte offset of this message
my $header = $first; # remember first line
for ($!=0; <INPUT>; $!=0) {
if ($in_header) {
if (/^\015?$/s) {
$in_header = 0;
}
else {
$header .= $_;
}
}
#Changed Regex to use option Per bug 6703
if (substr($_,0,5) eq "From " && /$self->{opt_from_regex}/o) {
$in_header = 1;
$first = $_;
$start = $where;
$where = tell INPUT;
$where >= 0 or die "cannot obtain file position: $!";
last;
}
$where = tell INPUT;
$where >= 0 or die "cannot obtain file position: $!";
}
defined $_ || $!==0 or
$!==EBADF ? dbg("archive-iterator: error reading: $!")
: die "error reading: $!";
if ($header ne '') {
# next if ($self->{opt_skip_empty_messages} && $header eq '');
$self->_bump_scan_progress();
$info->{$offset} = Mail::SpamAssassin::Util::receive_date($header);
}
}
close INPUT or die "error closing input file: $!";
}
while(my($k,$v) = each %{$info}) {
if (defined $AICache && !$count) {
$AICache->update($k, $v);
}
if ($self->{determine_receive_date}) {
next if !$self->_message_is_useful_by_date($v);
}
next if !$self->_scanprob_says_scan();
&{$bkfunc}($self, $v, $class, 'm', "$file.$k");
}
if (defined $AICache) {
$AICache = $AICache->finish();
}
}
}
sub _scan_mbx {
my ($self, $class, $folder, $bkfunc) = @_;
my (@files, $fp);
my $stat_errn = stat($folder) ? 0 : 0+$!;
if ($stat_errn == ENOENT) {
# no longer there?
}
elsif ($stat_errn != 0) {
warn "archive-iterator: no access to $folder: $!";
}
elsif (-f _) {
push(@files, $folder);
}
elsif (-d _) {
# got passed a directory full of mbx folders.
$folder =~ s/\/\s*$//; # remove trailing slash, if there is one
if (!opendir(DIR, $folder)) {
warn "archive-iterator: can't open '$folder' dir: $!\n";
$self->{access_problem} = 1;
return;
}
while ($_ = readdir(DIR)) {
next if $_ eq '.' || $_ eq '..' || !/^[^\.]\S*$/;
# hmmm, ignores folders with spaces in the name???
$stat_errn = stat("$folder/$_") ? 0 : 0+$!;
if ($stat_errn == ENOENT) {
# no longer there?
}
elsif ($stat_errn != 0) {
warn "archive-iterator: no access to $folder/$_: $!";
}
elsif (-f _) {
push(@files, "$folder/$_");
}
}
closedir(DIR) or die "error closing directory $folder: $!";
}
else {
warn "archive-iterator: $folder is not a plain file or directory: $!";
}
foreach my $file (@files) {
$self->_bump_scan_progress();
if ($folder =~ /\.(?:gz|bz2)$/) {
warn "archive-iterator: compressed mbx folders are not supported at this time\n";
$self->{access_problem} = 1;
next;
}
my @s = stat($file);
@s or warn "archive-iterator: no access to $file: $!";
next unless $self->_message_is_useful_by_file_modtime($s[9]);
my $info = {};
my $count;
$self->_create_cache('mbx', $file);
if ($self->{opt_cache}) {
if ($count = $AICache->count()) {
$info = $AICache->check();
}
}
unless ($count) {
if (!_mail_open($file)) {
$self->{access_problem} = 1;
next;
}
# check the mailbox is in mbx format
$! = 0; $fp = <INPUT>;
defined $fp || $!==0 or
$!==EBADF ? dbg("archive-iterator: error reading: $!")
: die "error reading: $!";
if (!defined $fp) {
die "archive-iterator: error: mailbox not in mbx format - empty!\n";
} elsif ($fp !~ /\*mbx\*/) {
die "archive-iterator: error: mailbox not in mbx format!\n";
}
# skip mbx headers to the first email...
seek(INPUT,2048,0) or die "cannot reposition file to 2048: $!";
my $sep = MBX_SEPARATOR;
for ($!=0; <INPUT>; $!=0) {
if ($_ =~ /$sep/) {
my $offset = tell INPUT;
$offset >= 0 or die "cannot obtain file position: $!";
my $size = $2;
# gather up the headers...
my $header = '';
for ($!=0; <INPUT>; $!=0) {
last if (/^\015?$/s);
$header .= $_;
}
defined $_ || $!==0 or
$!==EBADF ? dbg("archive-iterator: error reading: $!")
: die "error reading: $!";
if (!($self->{opt_skip_empty_messages} && $header eq '')) {
$self->_bump_scan_progress();
$info->{$offset} = Mail::SpamAssassin::Util::receive_date($header);
}
# go onto the next message
seek(INPUT, $offset + $size, 0)
or die "cannot reposition file to $offset + $size: $!";
}
else {
die "archive-iterator: error: failure to read message body!\n";
}
}
defined $_ || $!==0 or
$!==EBADF ? dbg("archive-iterator: error reading: $!")
: die "error reading: $!";
close INPUT or die "error closing input file: $!";
}
while(my($k,$v) = each %{$info}) {
if (defined $AICache && !$count) {
$AICache->update($k, $v);
}
if ($self->{determine_receive_date}) {
next if !$self->_message_is_useful_by_date($v);
}
next if !$self->_scanprob_says_scan();
&{$bkfunc}($self, $v, $class, 'b', "$file.$k");
}
if (defined $AICache) {
$AICache = $AICache->finish();
}
}
}
############################################################################
sub _bump_scan_progress {
my ($self) = @_;
if (exists $self->{scan_progress_sub}) {
return unless ($self->{scan_progress_counter}++ % 50 == 0);
$self->{scan_progress_sub}->();
}
}
############################################################################
{
my $home;
sub _fix_globs {
my ($self, $path) = @_;
unless (defined $home) {
$home = $ENV{'HOME'};
# No $HOME set? Try to find it, portably.
unless ($home) {
if (!Mail::SpamAssassin::Util::am_running_on_windows()) {
$home = (Mail::SpamAssassin::Util::portable_getpwuid($<))[7];
} else {
my $vol = $ENV{'HOMEDRIVE'} || 'C:';
my $dir = $ENV{'HOMEPATH'} || '\\';
$home = File::Spec->catpath($vol, $dir, '');
}
# Fall back to no replacement at all.
$home ||= '~';
}
}
$path =~ s,^~/,${home}/,;
# protect/escape spaces: ./Mail/My Letters => ./Mail/My\ Letters
$path =~ s/(?<!\\)(\s)/\\$1/g;
# return csh-style globs: ./corpus/*.mbox => er, you know what it does ;)
return glob($path);
}
}
sub _create_cache {
my ($self, $type, $path) = @_;
if ($self->{opt_cache}) {
$AICache = Mail::SpamAssassin::AICache->new({
'type' => $type,
'prefix' => $self->{opt_cachedir},
'path' => $path,
});
}
}
############################################################################
1;
__END__
=back
=head1 SEE ALSO
C<Mail::SpamAssassin>
C<spamassassin>
C<mass-check>
=cut
# vim: ts=8 sw=2 et
|