/usr/share/perl5/Mail/SpamAssassin/Plugin/BodyRuleBaseExtractor.pm is in spamassassin 3.4.1-8build1.
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 | # <@LICENSE>
# Copyright 2006 Apache Software Foundation
#
# Licensed 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>
=head1 NAME
Mail::SpamAssassin::Plugin::BodyRuleBaseExtractor - extract "bases" from body ruleset
=head1 SYNOPSIS
This is a plugin to extract "base" strings from SpamAssassin 'body' rules,
suitable for use in Rule2XSBody rules or other parallel matching algorithms.
=cut
package Mail::SpamAssassin::Plugin::BodyRuleBaseExtractor;
use Mail::SpamAssassin::Plugin;
use Mail::SpamAssassin::Logger;
use Mail::SpamAssassin::Util qw(untaint_var);
use Mail::SpamAssassin::Util::Progress;
use Errno qw(ENOENT EACCES EEXIST);
use Data::Dumper;
use strict;
use warnings;
use bytes;
use re 'taint';
use vars qw(@ISA);
@ISA = qw(Mail::SpamAssassin::Plugin);
use constant DEBUG_RE_PARSING => 0; # noisy!
# a few settings that control what kind of bases are output.
# treat all rules as lowercase for purposes of term extraction?
# $main->{bases_must_be_casei} = 1;
# $main->{bases_can_use_alternations} = 0; # /(foo|bar|baz)/
# $main->{bases_can_use_quantifiers} = 0; # /foo.*bar/ or /foo*bar/ or /foooo?bar/
# $main->{bases_can_use_char_classes} = 0; # /fo[opqr]bar/
# $main->{bases_split_out_alternations} = 1; # /(foo|bar|baz)/ => ["foo", "bar", "baz"]
# $main->{base_quiet} = 0; # silences progress output
# TODO: it would be nice to have a clean API to pass such settings
# through to plugins instead of hanging them off $main
##############################################################################
# testing purposes only
my $fixup_re_test;
#$fixup_re_test = 1; fixup_re("fr()|\\\\|"); die;
#$fixup_re_test = 1; fixup_re("\\x{1b}\$b"); die;
#$fixup_re_test = 1; fixup_re("\\33\$b"); die;
#$fixup_re_test = 1; fixup_re("[link]"); die;
#$fixup_re_test = 1; fixup_re("please do not resend your original message."); die;
###########################################################################
sub new {
my $class = shift;
my $mailsaobject = shift;
$class = ref($class) || $class;
my $self = $class->SUPER::new($mailsaobject);
bless ($self, $class);
$self->{show_progress} = !$mailsaobject->{base_quiet};
# $self->test(); exit;
return $self;
}
###########################################################################
sub finish_parsing_end {
my ($self, $params) = @_;
my $conf = $params->{conf};
$self->extract_bases($conf);
}
sub extract_bases {
my ($self, $conf) = @_;
my $main = $conf->{main};
if (!$main->{base_extract}) { return; }
$self->{show_progress} and
info("base extraction starting. this can take a while...");
$self->extract_set($conf, $conf->{body_tests}, 'body');
}
sub extract_set {
my ($self, $conf, $test_set, $ruletype) = @_;
foreach my $pri (keys %{$test_set}) {
my $nicepri = $pri; $nicepri =~ s/-/neg/g;
$self->extract_set_pri($conf, $test_set->{$pri}, $ruletype.'_'.$nicepri);
}
}
###########################################################################
sub extract_set_pri {
my ($self, $conf, $rules, $ruletype) = @_;
my @good_bases;
my @failed;
my $yes = 0;
my $no = 0;
my $count = 0;
my $start = time;
$self->{main} = $conf->{main}; # for use in extract_hints()
$self->{show_progress} and info ("extracting from rules of type $ruletype");
my $tflags = $conf->{tflags};
# attempt to find good "base strings" (simplified regexp subsets) for each
# regexp. We try looking at the regexp from both ends, since there
# may be a good long string of text at the end of the rule.
# require this many chars in a base string + delimiters for it to be viable
my $min_chars = 5;
my $progress;
$self->{show_progress} and $progress = Mail::SpamAssassin::Util::Progress->new({
total => (scalar keys %{$rules} || 1),
itemtype => 'rules',
});
my $cached = { };
my $cachefile;
if ($self->{main}->{bases_cache_dir}) {
$cachefile = $self->{main}->{bases_cache_dir}."/rules.$ruletype";
dbg("zoom: reading cache file $cachefile");
$cached = $self->read_cachefile($cachefile);
}
NEXT_RULE:
foreach my $name (keys %{$rules}) {
$self->{show_progress} and $progress and $progress->update(++$count);
my $rule = $rules->{$name};
my $cachekey = join "#", $name, $rule;
my $cent = $cached->{rule_bases}->{$cachekey};
if (defined $cent) {
if (defined $cent->{g}) {
dbg("zoom: YES (cached) $rule $name");
foreach my $ent (@{$cent->{g}}) {
# note: we have to copy these, since otherwise later
# modifications corrupt the cached data
push @good_bases, {
base => $ent->{base}, orig => $ent->{orig}, name => $ent->{name}
};
}
$yes++;
}
else {
dbg("zoom: NO (cached) $rule $name");
push @failed, { orig => $rule }; # no need to cache this
$no++;
}
next NEXT_RULE;
}
# ignore ReplaceTags rules
my $is_a_replacetags_rule = $conf->{rules_to_replace}->{$name};
my ($minlen, $lossy, @bases);
if (!$is_a_replacetags_rule) {
eval { # catch die()s
my ($qr, $mods) = $self->simplify_and_qr_regexp($rule);
($lossy, @bases) = $self->extract_hints($rule, $qr, $mods);
# dbg("zoom: %s %s -> %s", $name, $rule, join(", ", @bases));
1;
} or do {
my $eval_stat = $@ ne '' ? $@ : "errno=$!"; chomp $eval_stat;
dbg("zoom: giving up on regexp: $eval_stat");
};
if ($lossy && ($tflags->{$name}||'') =~ /\bmultiple\b/ &&
$self->{show_progress}) {
warn "\nzoom: rule $name will loop on SpamAssassin older than 3.3.2 ".
"running under Perl 5.12 or older, Bug 6558\n";
}
# if any of the extracted hints in a set are too short, the entire
# set is invalid; this is because each set of N hints represents just
# 1 regexp.
foreach my $str (@bases) {
my $len = length fixup_re($str); # bug 6143: count decoded characters
if ($len < $min_chars) { $minlen = undef; @bases = (); last; }
elsif (!defined($minlen) || $len < $minlen) { $minlen = $len; }
}
}
if ($is_a_replacetags_rule || !$minlen || !@bases) {
dbg("zoom: ignoring rule %s, %s", $name,
$is_a_replacetags_rule ? 'is a replace rule'
: !@bases ? 'no bases' : 'no minlen');
push @failed, { orig => $rule };
$cached->{rule_bases}->{$cachekey} = { };
$no++;
}
else {
# dbg("zoom: YES <base>$base</base> <origrule>$rule</origrule>");
# figure out if we have e.g. ["foo", "foob", "foobar"]; in this
# case, we only need to track ["foo"].
my %subsumed;
foreach my $base1 (@bases) {
foreach my $base2 (@bases) {
if ($base1 ne $base2 && $base1 =~ /\Q$base2\E/) {
$subsumed{$base1} = 1; # base2 is inside base1; discard the longer
}
}
}
my @forcache;
foreach my $base (@bases) {
next if $subsumed{$base};
push @good_bases, {
base => $base, orig => $rule, name => "$name,[l=$lossy]"
};
# *separate* copies for cache -- we modify the @good_bases entry
push @forcache, {
base => $base, orig => $rule, name => "$name,[l=$lossy]"
};
}
$cached->{rule_bases}->{$cachekey} = { g => \@forcache };
$yes++;
}
}
$self->{show_progress} and $progress and $progress->final();
dbg("zoom: $ruletype: found ".(scalar @good_bases).
" usable base strings in $yes rules, skipped $no rules");
# NOTE: re2c will attempt to provide the longest pattern that matched; e.g.
# ("food" =~ "foo" / "food") will return "food". So therefore if a pattern
# subsumes other patterns, we need to return hits for all of them. We also
# need to take care of the case where multiple regexps wind up sharing the
# same base.
#
# Another gotcha, an exception to the subsumption rule; if one pattern isn't
# entirely subsumed (e.g. "food" =~ "foo" / "ood"), then they will be
# returned as two hits, correctly. So we only have to be smart about the
# full-subsumption case; overlapping is taken care of for us, by re2c.
#
# TODO: there's a bug here. Since the code in extract_hints() has been
# modified to support more complex regexps, we can no longer simply assume
# that if pattern A is not contained in pattern B, that means that pattern B
# doesn't subsume it. Consider, for example, A="foo*bar" and
# B="morefobarry"; A is indeed subsumed by B, but we won't be able to test
# that without running the A RE match itself somehow against B.
# same issue remains with:
#
# "foo?bar" / "fobar"
# "fo(?:o|oo|)bar" / "fobar"
# "fo(?:o|oo)?bar" / "fobar"
# "fo(?:o*|baz)bar" / "fobar"
# "(?:fo(?:o*|baz)bar|blargh)" / "fobar"
#
# it's worse with this:
#
# "fo(?:o|oo|)bar" / "foo*bar"
#
# basically, this is impossible to compute without reimplementing most of
# re2c, and it appears the re2c developers don't plan to offer this:
# https://sourceforge.net/tracker/index.php?func=detail&aid=1540845&group_id=96864&atid=616203
$conf->{base_orig}->{$ruletype} = { };
$conf->{base_string}->{$ruletype} = { };
$count = 0;
$self->{show_progress} and $progress = Mail::SpamAssassin::Util::Progress->new({
total => (scalar @good_bases || 1),
itemtype => 'bases',
});
# this bit is annoyingly O(N^2). Rewrite the data -- the @good_bases
# array -- into a more efficient format, using arrays and with a little
# bit of precomputation, to go (quite a bit) faster
my @rewritten;
foreach my $set1 (@good_bases) {
my $base = $set1->{base};
next if (!$base || !$set1->{name});
push @rewritten, [
$base, # 0
$set1->{name}, # 1
$set1->{orig}, # 2
length $base, # 3
qr/\Q$base\E/, # 4
0 # 5, has_multiple flag
];
}
@good_bases = @rewritten;
foreach my $set1 (@good_bases) {
$self->{show_progress} and $progress and $progress->update(++$count);
my $base1 = $set1->[0]; next unless $base1;
my $name1 = $set1->[1];
my $orig1 = $set1->[2];
$conf->{base_orig}->{$ruletype}->{$name1} = $orig1;
my $len1 = $set1->[3];
foreach my $set2 (@good_bases) {
next if ($set1 == $set2);
my $base2 = $set2->[0]; next unless $base2;
my $name2 = $set2->[1];
# clobber exact dups; this can happen if a regexp outputs the
# same base string multiple times
if ($base1 eq $base2 &&
$name1 eq $name2 &&
$orig1 eq $set2->[2])
{
$set2->[0] = ''; # clobber
next;
}
# skip if it's too short to contain the other base string
next if ($len1 < $set2->[3]);
# skip if either already contains the other rule's name
# optimize: this can only happen if the base has more than
# one rule already attached, ie [5]
next if ($set2->[5] && $name2 =~ /(?: |^)\Q$name1\E(?: |$)/);
# don't use $name1 here, since another base in the set2 loop
# may have added $name2 since we set that
next if ($set1->[5] && $set1->[1] =~ /(?: |^)\Q$name2\E(?: |$)/);
# and finally check to see if it *does* contain the other base string
next if ($base1 !~ $set2->[4]);
# base2 is just a subset of base1
# dbg("zoom: subsuming '$base2' ($name2) into '$base1': [1]=$set1->[1] [5]=$set1->[5]");
$set1->[1] .= " ".$name2;
$set1->[5] = 1;
}
}
# we can still have duplicate cases; __FRAUD_PTS and __SARE_FRAUD_BADTHINGS
# both contain "killed" for example, pointing at different rules, which
# the above search hasn't found. Collapse them here with a hash
my %bases;
foreach my $set (@good_bases) {
my $base = $set->[0];
next unless $base;
if (defined $bases{$base}) {
$bases{$base} .= " ".$set->[1];
} else {
$bases{$base} = $set->[1];
}
}
undef @good_bases;
foreach my $base (keys %bases) {
# uniq the list, since there are probably dup rules listed
my %u;
for my $i (split ' ', $bases{$base}) {
next if exists $u{$i}; undef $u{$i};
}
$conf->{base_string}->{$ruletype}->{$base} = join ' ', sort keys %u;
}
$self->{show_progress} and $progress and $progress->final();
if ($cachefile) {
$self->write_cachefile ($cachefile, $cached);
}
my $elapsed = time - $start;
$self->{show_progress} and info ("$ruletype: ".
(scalar keys %{$conf->{base_string}->{$ruletype}}).
" base strings extracted in $elapsed seconds\n");
}
###########################################################################
# TODO:
# NO /no.{1,10}P(?:er|re)scription.{1,10}(?:needed|require|necessary)/i
# => should extract 'scription' somehow
# /time to refinance|refinanc\w{1,3}\b.{0,16}\bnow\b/i
# => should understand alternations; tricky
sub simplify_and_qr_regexp {
my $self = shift;
my $rule = shift;
my $main = $self->{main};
$rule = Mail::SpamAssassin::Util::regexp_remove_delimiters($rule);
# remove the regexp modifiers, keep for later
my $mods = '';
while ($rule =~ s/^\(\?([a-z]*)\)//) { $mods .= $1; }
# modifier removal
while ($rule =~ s/^\(\?-([a-z]*)\)//) {
foreach my $modchar (split '', $mods) {
$mods =~ s/$modchar//g;
}
}
my $lossy = 0;
# now: simplify aspects of the regexp. Bear in mind that we can
# simplify as long as we cause the regexp to become more general;
# more hits is OK, since false positives will be discarded afterwards
# anyway. Simplification that causes the regexp to *not* hit
# stuff that the "real" rule would hit, however, is a bad thing.
if ($main->{bases_must_be_casei}) {
$rule = lc $rule;
$lossy = 1;
$mods =~ s/i// and $lossy = 0;
# always case-i: /A(?i:ct) N(?i:ow)/ => /Act Now/
$rule =~ s/(?<!\\)\(\?i\:(.*?)\)/$1/gs and $lossy++;
# always case-i: /A(?-i:ct)/ => /Act/
$rule =~ s/(?<!\\)\(\?-i\:(.*?)\)/$1/gs and $lossy++;
# remove (?i)
$rule =~ s/\(\?i\)//gs;
}
else {
die "case-i" if $rule =~ /\(\?i\)/;
die "case-i" if $mods =~ /i/;
# always case-i: /A(?i:ct) N(?i:ow)/ => /Act Now/
$rule =~ s/(?<!\\)\(\?i\:(.*?)\)/$1/gs and die "case-i";
# we're already non-case-i so this is a no-op: /A(?-i:ct)/ => /Act/
$rule =~ s/(?<!\\)\(\?-i\:(.*?)\)/$1/gs;
}
# remove /m and /s modifiers
$mods =~ s/m// and $lossy++;
$mods =~ s/s// and $lossy++;
# remove (^|\b)'s
# T_KAM_STOCKTIP23 /(EXTREME INNOVATIONS|(^|\b)EXTI($|\b))/is
$rule =~ s/\(\^\|\\b\)//gs and $lossy++;
$rule =~ s/\(\$\|\\b\)//gs and $lossy++;
$rule =~ s/\(\\b\|\^\)//gs and $lossy++;
$rule =~ s/\(\\b\|\$\)//gs and $lossy++;
# remove (?!credit)
$rule =~ s/\(\?\![^\)]+\)//gs and $lossy++;
# remove \b's
$rule =~ s/(?<!\\)\\b//gs and $lossy++;
# remove the "?=" trick
# (?=[dehklnswxy])(horny|nasty|hot|wild|young|....etc...)
$rule =~ s/\(\?\=\[[^\]]+\]\)//gs;
$mods .= "L" if $lossy;
($rule, $mods);
}
sub extract_hints {
my $self = shift;
my $rawrule = shift;
my $rule = shift;
my $mods = shift;
my $main = $self->{main};
my $orig = $rule;
my $lossy = 0;
$mods =~ s/L// and $lossy++;
# if there are anchors, give up; we can't get much
# faster than these anyway
die "anchors" if $rule =~ /^\(?(?:\^|\\A)/;
# die "anchors" if $rule =~ /(?:\$|\\Z)\)?$/;
# just remove end-of-string anchors; they're slow so could gain
# from our speedup
$rule =~ s/(?<!\\)(?:\$|\\Z)\)?$// and $lossy++;
# simplify (?:..) to (..)
$main->{bases_allow_noncapture_groups} or
$rule =~ s/\(\?:/\(/g;
# simplify some grouping arrangements so they're easier for us to parse
# (foo)? => (foo|)
$rule =~ s/\((.*?)\)\?/\($1\|\)/gs;
# r? => (r|)
$rule =~ s/(?<!\\)(\w)\?/\($1\|\)/gs;
my ($tmpf, $tmpfh) = Mail::SpamAssassin::Util::secure_tmpfile();
$tmpfh or die "failed to create a temporary file";
untaint_var(\$tmpf);
print $tmpfh "use bytes; m{" . $rule . "}" . $mods
or die "error writing to $tmpf: $!";
close $tmpfh or die "error closing $tmpf: $!";
my $perl = $self->get_perl();
local *IN;
open (IN, "$perl -c -Mre=debug $tmpf 2>&1 |")
or die "cannot run $perl: ".exit_status_str($?,$!);
my($inbuf,$nread,$fullstr); $fullstr = '';
while ( $nread=read(IN,$inbuf,16384) ) { $fullstr .= $inbuf }
defined $nread or die "error reading from pipe: $!";
close IN or die "error closing pipe: $!";
unlink $tmpf or die "cannot unlink $tmpf: $!";
defined $fullstr or warn "empty result from a pipe";
# now parse the -Mre=debug output.
# perl 5.10 format
$fullstr =~ s/^.*\nFinal program:\n//gs;
# perl 5.6/5.8 format
$fullstr =~ s/^(?:.*\n|)size \d[^\n]*\n//gs;
$fullstr =~ s/^(?:.*\n|)first at \d[^\n]*\n//gs;
# common to all
$fullstr =~ s/\nOffsets:.*$//gs;
# clean up every other line that doesn't start with a space
$fullstr =~ s/^\S.*$//gm;
if ($fullstr !~ /((?:\s[^\n]+\n)+)/m) {
die "failed to parse Mre=debug output: $fullstr m{".$rule."}".$mods." $rawrule";
}
my $opsstr = $1;
# what's left looks like this:
# 1: EXACTF <v>(3)
# 3: ANYOF[1ILil](14)
# 14: EXACTF <a>(16)
# 16: CURLY {2,7}(29)
# 18: ANYOF[A-Za-z](0)
# 29: SPACE(30)
# 30: EXACTF <http://>(33)
# 33: END(0)
#
DEBUG_RE_PARSING and warn "Mre=debug output: $opsstr";
my @ops;
foreach my $op (split(/\n/s, $opsstr)) {
next unless $op;
if ($op =~ /^\s+\d+: (\s*)([A-Z]\w+)\b(.*?)\s*(?:\(\d+\))?$/) {
# perl 5.8: <xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...>(18)
# perl 5.10, 5.12, 5.14: <xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx>... (18)
push @ops, [ $1, $2, $3 ];
}
elsif ($op =~ /^ (\s*)<(.*)>\.\.\.\s*$/) {
# 5: TRIE-EXACT[im](44)
# <message contained attachments that have been blocked by guin>...
my $spcs = $1;
# we could use the entire length here, but it's easier to trim to
# the length of a perl 5.8.x/5.6.x EXACT* string; that way our test
# suite results will match, since the sa-update --list extraction will
# be the same for all versions. (The "..." trailer is important btw)
my $str = substr ($2, 0, 55);
push @ops, [ $spcs, '_moretrie', "<$str...>" ];
}
elsif ($op =~ /^ (\s*)(<.*>)\s*(?:\(\d+\))?$/) {
# 5: TRIE-EXACT[am](21)
# <am> (21)
# <might> (12)
push @ops, [ $1, '_moretrie', $2 ];
}
elsif ($op =~ /^ at .+ line \d+$/) {
next; # ' at /local/perl561/lib/5.6.1/i86pc-solaris/re.pm line 109':
}
else {
warn "cannot parse '$op': $opsstr";
next;
}
}
# unroll the branches; returns a list of versions.
# e.g. /foo(bar|baz)argh/ => [ "foobarargh", "foobazargh" ]
my @unrolled;
if ($main->{bases_split_out_alternations}) {
@unrolled = $self->unroll_branches(0, \@ops);
} else {
@unrolled = ( \@ops );
}
# now find the longest DFA-friendly string in each unrolled version
my @longests;
foreach my $opsarray (@unrolled) {
my $longestexact = '';
my $buf = '';
# use a closure to keep the code succinct
my $add_candidate = sub {
if (length $buf > length $longestexact) { $longestexact = $buf; }
$buf = '';
};
my $prevop;
foreach my $op (@{$opsarray}) {
my ($spcs, $item, $args) = @{$op};
next if ($item eq 'NOTHING');
# EXACT == case-sensitive
# EXACTF == case-i
# we can do both, since we canonicalize to lc.
if (!$spcs && $item =~ /^EXACT/ && $args =~ /<(.*)>/)
{
my $str = $1;
$buf .= $str;
if ($buf =~ s/\\x\{[0-9a-fA-F]{4,}\}.*$//) {
# a high Unicode codepoint, interpreted by perl 5.8.x. cut and stop
$add_candidate->();
}
if (length $str >= 55 && $buf =~ s/\.\.\.$//) {
# perl 5.8.x truncates with a "..." here! cut and stop
$add_candidate->();
}
}
# _moretrie == a TRIE-EXACT entry
elsif (!$spcs && $item =~ /^_moretrie/ && $args =~ /<(.*)>/)
{
$buf .= $1;
if (length $1 >= 55 && $buf =~ s/\.\.\.$//) {
# perl 5.8.x truncates with a "..." here! cut and stop
$add_candidate->();
}
}
# /(?:foo|bar|baz){2}/ results in a CURLYX beforehand
elsif ($item =~ /^EXACT/ &&
$prevop && !$prevop->[0] && $prevop->[1] =~ /^CURLYX/ &&
$prevop->[2] =~ /\{(\d+),/ && $1 >= 1 &&
$args =~ /<(.*)>/)
{
$buf .= $1;
if (length $1 >= 55 && $buf =~ s/\.\.\.$//) {
# perl 5.8.x truncates with a "..." here! cut and stop
$add_candidate->();
}
}
# CURLYX, for perl >= 5.9.5
elsif ($item =~ /^_moretrie/ &&
$prevop && !$prevop->[0] && $prevop->[1] =~ /^CURLYX/ &&
$prevop->[2] =~ /\{(\d+),/ && $1 >= 1 &&
$args =~ /<(.*)>/)
{
$buf .= $1;
if (length $1 >= 60 && $buf =~ s/\.\.\.$//) {
# perl 5.8.x truncates with a "..." here! cut and stop
$add_candidate->();
}
}
else {
# not an /^EXACT/; clear the buffer
$add_candidate->();
if ($item !~ /^(?:END|CLOSE\d|MINMOD)$/)
{
$lossy = 1;
DEBUG_RE_PARSING and warn "item $item makes regexp lossy";
}
}
$prevop = $op;
}
$add_candidate->();
if (!$longestexact) {
die "no long-enough string found in $rawrule";
# all unrolled versions must have a long string, otherwise
# we cannot reliably match all variants of the rule
} else {
push @longests, ($main->{bases_must_be_casei}) ?
lc $longestexact : $longestexact;
}
}
DEBUG_RE_PARSING and warn "longest base strings: /".join("/", @longests)."/";
return ($lossy, @longests);
}
###########################################################################
sub unroll_branches {
my ($self, $depth, $opslist) = @_;
die "too deep" if ($depth++ > 5);
my @ops = (@{$opslist}); # copy
my @pre_branch_ops;
my $branch_spcs;
my $trie_spcs;
my $open_spcs;
# our input looks something like this 2-level structure:
# 1: BOUND(2)
# 2: EXACT <Dear >(5)
# 5: BRANCH(9)
# 6: EXACT <IT>(8)
# 8: NALNUM(24)
# 9: BRANCH(23)
# 10: EXACT <Int>(12)
# 12: BRANCH(14)
# 13: NOTHING(21)
# 14: BRANCH(17)
# 15: EXACT <a>(21)
# 17: BRANCH(20)
# 18: EXACT <er>(21)
# 20: TAIL(21)
# 21: EXACT <net>(24)
# 23: TAIL(24)
# 24: EXACT < shop>(27)
# 27: END(0)
#
# or:
#
# 1: OPEN1(3)
# 3: BRANCH(6)
# 4: EXACT <v>(9)
# 6: BRANCH(9)
# 7: EXACT <\\/>(9)
# 9: CLOSE1(11)
# 11: CURLY {2,5}(14)
# 13: REG_ANY(0)
# 14: EXACT < g r a >(17)
# 17: ANYOF[a-z](28)
# 28: END(0)
#
# or:
#
# 1: EXACT <i >(3)
# 3: OPEN1(5)
# 5: TRIE-EXACT[am](21)
# <am> (21)
# <might> (12)
# 12: OPEN2(14)
# 14: TRIE-EXACT[ ](19)
# < be>
# <>
# 19: CLOSE2(21)
# 21: CLOSE1(23)
# 23: EXACT < c>(25)
DEBUG_RE_PARSING and warn "starting parse";
# this happens for /foo|bar/ instead of /(?:foo|bar)/ ; transform
# it into the latter. bit of a kludge to do this before the loop, but hey.
# note that it doesn't fix the CLOSE1/END ordering to be correct
if (scalar @ops > 1 && $ops[0]->[1] =~ /^BRANCH/) {
my @newops = ([ "", "OPEN1", "" ]);
foreach my $op (@ops) {
push @newops, [ " ".$op->[0], $op->[1], $op->[2] ];
}
push @newops, [ "", "CLOSE1", "" ];
@ops = @newops;
}
# iterate until we start a branch set. using
# /dkjfksl(foo|bar(baz|argh)boo)gab/ as an example, we're at "dkj..."
# just hitting an OPEN is not enough; wait until we see a TRIE-EXACT
# or a BRANCH, *then* unroll the most recent OPEN set.
while (1) {
my $op = shift @ops;
last unless defined $op;
my ($spcs, $item, $args) = @{$op};
DEBUG_RE_PARSING and warn "pre: [$spcs] $item $args";
if ($item =~ /^OPEN/) {
$open_spcs = $spcs;
next; # next will be a BRANCH or TRIE
} elsif ($item =~ /^TRIE/) {
$trie_spcs = $spcs;
last;
} elsif ($item =~ /^BRANCH/) {
$branch_spcs = $spcs;
last;
} elsif ($item =~ /^EXACT/ && defined $open_spcs) {
# perl 5.9.5 does this; f(o|oish) => OPEN, EXACT, TRIE-EXACT
push @pre_branch_ops, [ $open_spcs, $item, $args ];
next;
} elsif (defined $open_spcs) {
# OPEN not followed immediately by BRANCH, EXACT or TRIE-EXACT:
# ignore this OPEN block entirely and don't try to unroll it
undef $open_spcs;
} else {
push @pre_branch_ops, $op;
}
}
# no branches found? we're done unrolling on this one!
if (scalar @ops == 0) {
return [ @pre_branch_ops ];
}
# otherwise we're at the start of a new branch set
# /(foo|bar(baz|argh)boo)gab/
my @alts;
my @in_this_branch;
DEBUG_RE_PARSING and warn "entering branch: ".
"open='".(defined $open_spcs ? $open_spcs : 'undef')."' ".
"branch='".(defined $branch_spcs ? $branch_spcs : 'undef')."' ".
"trie='".(defined $trie_spcs ? $trie_spcs : 'undef')."'";
# indentation level to remove from "normal" ops (using a s///)
my $open_sub_spcs = ($branch_spcs ? $branch_spcs : "")." ";
my $trie_sub_spcs = "";
while (1) {
my $op = shift @ops;
last unless defined $op;
my ($spcs, $item, $args) = @{$op};
DEBUG_RE_PARSING and warn "in: [$spcs] $item $args";
if (defined $branch_spcs && $branch_spcs eq $spcs && $item =~ /^BRANCH/) { # alt
push @alts, [ @pre_branch_ops, @in_this_branch ];
@in_this_branch = ();
$open_sub_spcs = $branch_spcs." ";
$trie_sub_spcs = "";
next;
}
elsif (defined $branch_spcs && $branch_spcs eq $spcs && $item eq 'TAIL') { # end
push @alts, [ @pre_branch_ops, @in_this_branch ];
undef $branch_spcs;
$open_sub_spcs = "";
$trie_sub_spcs = "";
last;
}
elsif (defined $trie_spcs && $trie_spcs eq $spcs && $item eq '_moretrie') {
if (scalar @in_this_branch > 0) {
push @alts, [ @pre_branch_ops, @in_this_branch ];
}
# use $open_spcs instead of $trie_spcs (which is 2 spcs further indented)
@in_this_branch = ( [ $open_spcs, $item, $args ] );
$open_sub_spcs = ($branch_spcs ? $branch_spcs : "")." ";
$trie_sub_spcs = " ";
next;
}
elsif (defined $open_spcs && $open_spcs eq $spcs && $item =~ /^CLOSE/) { # end
push @alts, [ @pre_branch_ops, @in_this_branch ];
undef $branch_spcs;
undef $open_spcs;
undef $trie_spcs;
$open_sub_spcs = "";
$trie_sub_spcs = "";
last;
}
elsif ($item eq 'END') { # of string
push @alts, [ @pre_branch_ops, @in_this_branch ];
undef $branch_spcs;
undef $open_spcs;
undef $trie_spcs;
$open_sub_spcs = "";
$trie_sub_spcs = "";
last;
}
else {
if ($open_sub_spcs) {
# deindent the space-level to match the opening brace
$spcs =~ s/^$open_sub_spcs//;
# tries also add one more indent level in
$spcs =~ s/^$trie_sub_spcs//;
}
push @in_this_branch, [ $spcs, $item, $args ];
# note that we ignore ops at a deeper $spcs level entirely (until later!)
}
}
if (defined $branch_spcs) {
die "fell off end of string with a branch open: '$branch_spcs'";
}
# we're now after the branch set: /gab/
# @alts looks like [ /dkjfkslfoo/ , /dkjfkslbar(baz|argh)boo/ ]
foreach my $alt (@alts) {
push @{$alt}, @ops; # add all remaining ops to each one
# note that this could include more (?:...); we don't care, since
# those can be handled by recursing
}
# ok, parsed the entire ops list
# @alts looks like [ /dkjfkslfoogab/ , /dkjfkslbar(baz|argh)boogab/ ]
if (DEBUG_RE_PARSING) {
print "unrolled: "; foreach my $alt (@alts) { foreach my $o (@{$alt}) { print "{/$o->[0]/$o->[1]/$o->[2]} "; } print "\n"; }
}
# now recurse, to unroll the remaining branches (if any exist)
my @rets;
foreach my $alt (@alts) {
push @rets, $self->unroll_branches($depth, $alt);
}
if (DEBUG_RE_PARSING) {
print "unrolled post-recurse: "; foreach my $alt (@rets) { foreach my $o (@{$alt}) { print "{/$o->[0]/$o->[1]/$o->[2]} "; } print "\n"; }
}
return @rets;
}
###########################################################################
sub test {
my ($self) = @_;
$self->test_split_alt("foo", "/foo/");
$self->test_split_alt("(foo)", "/foo/");
$self->test_split_alt("foo(bar)baz", "/foobarbaz/");
$self->test_split_alt("x(foo|)", "/xfoo/ /x/");
$self->test_split_alt("fo(o|)", "/foo/ /fo/");
$self->test_split_alt("(foo|bar)", "/foo/ /bar/");
$self->test_split_alt("foo|bar", "/foo/ /bar/");
$self->test_split_alt("foo (bar|baz) argh", "/foo bar argh/ /foo baz argh/");
$self->test_split_alt("foo (bar|baz|bl(arg|at)) cough", "/foo bar cough/ /foo baz cough/ /foo blarg cough/ /foo blat cough/");
$self->test_split_alt("(s(otc|tco)k)", "/sotck/ /stcok/");
$self->test_split_alt("(business partner(s|ship|)|silent partner(s|ship|))", "/business partners/ /silent partners/ /business partnership/ /silent partnership/ /business partner/ /silent partner/");
}
sub test_split_alt {
my ($self, $in, $out) = @_;
my @got = $self->split_alt($in);
$out =~ s/^\///;
$out =~ s/\/$//;
my @want = split(/\/ \//, $out);
my $failed = 0;
if (scalar @want != scalar @got) {
warn "FAIL: results count don't match";
$failed++;
}
else {
my %got = map { $_ => 1 } @got;
foreach my $w (@want) {
if (!$got{$w}) {
warn "FAIL: '$w' not found";
$failed++;
}
}
}
if ($failed) {
print "want: /".join('/ /', @want)."/\n" or die "error writing: $!";
print "got: /".join('/ /', @got)."/\n" or die "error writing: $!";
return 0;
} else {
print "ok\n" or die "error writing: $!";
return 1;
}
}
###########################################################################
sub get_perl {
my ($self) = @_;
my $perl;
# allow user override of the perl interpreter to use when
# extracting base strings.
# TODO: expose this via sa-compile command-line option
my $fromconf = $self->{main}->{conf}->{re_parser_perl};
if ($fromconf) {
$perl = $fromconf;
} elsif ($^X =~ m|^/|) {
$perl = $^X;
} else {
use Config;
$perl = $Config{perlpath};
$perl =~ s|/[^/]*$|/$^X|;
}
untaint_var(\$perl);
return $perl;
}
###########################################################################
sub read_cachefile {
my ($self, $cachefile) = @_;
local *IN;
if (open(IN, "<".$cachefile)) {
my($inbuf,$nread,$str); $str = '';
while ( $nread=read(IN,$inbuf,16384) ) { $str .= $inbuf }
defined $nread or die "error reading from $cachefile: $!";
close IN or die "error closing $cachefile: $!";
untaint_var(\$str);
my $VAR1; # Data::Dumper
if (eval $str) {
return $VAR1; # Data::Dumper's naming
}
}
return { };
}
sub write_cachefile {
my ($self, $cachefile, $cached) = @_;
my $dump = Data::Dumper->new ([ $cached ]);
$dump->Deepcopy(1);
$dump->Purity(1);
$dump->Indent(1);
if (mkdir($self->{main}->{bases_cache_dir})) {
# successfully created
} elsif ($! == EEXIST) {
dbg("zoom: ok, cache directory already existed");
} else {
warn "cannot create a directory: $!";
}
open(CACHE, ">$cachefile") or warn "cannot write to $cachefile";
print CACHE ($dump->Dump, ";1;") or die "error writing: $!";
close CACHE or die "error closing $cachefile: $!";
}
=over 4
=item my ($cleanregexp) = fixup_re($regexp);
Converts encoded characters in a regular expression pattern into their
equivalent characters
=back
=cut
sub fixup_re {
my $re = shift;
if ($fixup_re_test) { print "INPUT: /$re/\n" or die "error writing: $!" }
my $output = "";
my $TOK = qr([\"\\]);
my $STATE;
local ($1,$2);
while ($re =~ /\G(.*?)($TOK)/gcs) {
my $pre = $1;
my $tok = $2;
if (length($pre)) {
$output .= "\"$pre\"";
}
if ($tok eq '"') {
$output .= '"\\""';
}
elsif ($tok eq '\\') {
$re =~ /\G(x\{[^\}]+\}|[0-7]{1,3}|.)/gcs or die "\\ at end of string!";
my $esc = $1;
if ($esc eq '"') {
$output .= '"\\""';
} elsif ($esc eq '\\') {
$output .= '"**BACKSLASH**"'; # avoid hairy escape-parsing
} elsif ($esc =~ /^x\{(\S+)\}\z/) {
$output .= '"'.chr(hex($1)).'"';
} elsif ($esc =~ /^[0-7]{1,3}\z/) {
$output .= '"'.chr(oct($esc)).'"';
} else {
$output .= "\"$esc\"";
}
}
else {
print "PRE: $pre\nTOK: $tok\n" or die "error writing: $!";
}
}
if (!defined(pos($re))) {
# no matches
$output .= "\"$re\"";
# Bug 6649: protect NL, NULL, ^Z, (and controls to stay on the safe side)
$output =~ s{([\000-\037\177\200\377])}{sprintf("\\%03o",ord($1))}gse;
}
elsif (pos($re) <= length($re)) {
$output =~ s{([\000-\037\177\200\377])}{sprintf("\\%03o",ord($1))}gse;
$output .= fixup_re(substr($re, pos($re)));
}
$output =~ s/^""/"/; # protect start and end quotes
$output =~ s/(?<!\\)""\z/"/;
$output =~ s/(?<!\\)""//g; # strip empty strings, or turn "abc""def" -> "abcdef"
$output =~ s/\*\*BACKSLASH\*\*/\\\\/gs;
if ($fixup_re_test) { print "OUTPUT: $output\n" or die "error writing: $!" }
return $output;
}
1;
|