/usr/share/perl5/Mail/SpamAssassin/BayesStore/BDB.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 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 | # <@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>
=head1 NAME
Mail::SpamAssassin::BayesStore::BDB - BerkeleyDB Bayesian Storage Module Implementation
=head1 DESCRIPTION
This module implementes a BDB based bayesian storage module.
=cut
package Mail::SpamAssassin::BayesStore::BDB;
use strict;
use warnings;
# use bytes;
use re 'taint';
use Errno qw(EBADF);
#use Data::Dumper;
use File::Basename;
use File::Path;
BEGIN {
eval { require Digest::SHA; import Digest::SHA qw(sha1); 1 }
or do { require Digest::SHA1; import Digest::SHA1 qw(sha1) }
}
use Mail::SpamAssassin::BayesStore;
use Mail::SpamAssassin::Logger;
our @ISA = qw( Mail::SpamAssassin::BayesStore );
use constant HAS_BDB => eval { require BerkeleyDB; BerkeleyDB->import; };
my $rmw = DB_RMW;
my $next = DB_NEXT;
=head1 METHODS
=head2 new
public class (Mail::SpamAssassin::BayesStore::SQL) new (Mail::Spamassassin::Plugin::Bayes $bayes)
Description:
This methods creates a new instance of the Mail::SpamAssassin::BayesStore::BDB
object. It expects to be passed an instance of the Mail::SpamAssassin:Bayes
object which is passed into the Mail::SpamAssassin::BayesStore parent object.
=cut
sub new {
my $class = shift;
$class = ref($class) || $class;
my $self = $class->SUPER::new(@_);
$self->{supported_db_version} = 3;
$self->{is_really_open} = 0;
$self->{is_writable} = 0;
$self->{is_officially_open} = 0;
return $self;
}
sub DESTROY {
my $self = shift;
$self->_close_db;
}
=head2 tie_db_readonly
public instance (Boolean) tie_db_readonly ();
Description:
This method ensures that the database connection is properly setup and
working.
=cut
sub tie_db_readonly {
my($self) = @_;
#dbg("bayes: tie_db_readonly");
# my $result = ($self->{is_really_open} && !$self->{is_writable})
# || $self->_open_db(0);
my $result = $self->{is_really_open} || $self->_open_db(0);
dbg("bayes: tie_db_readonly, result is $result");
return $result;
}
=head2 tie_db_writable
public instance (Boolean) tie_db_writable ()
Description:
This method ensures that the database connection is properly setup and
working. If necessary it will initialize the database so that they can
begin using the database immediately.
=cut
sub tie_db_writable {
my($self) = @_;
#dbg("bayes: tie_db_writable");
my $result = ($self->{is_really_open} && $self->{is_writable})
|| $self->_open_db(1);
dbg("bayes: tie_db_writable, result is $result");
return $result;
}
=head2 _open_db
private instance (Boolean) _open_db (Boolean $writable)
Description:
This method ensures that the database connection is properly setup and
working. It will initialize a users bayes variables so that they
can begin using the database immediately.
=cut
sub _open_db {
my($self, $writable) = @_;
dbg("bayes: _open_db(%s, %s); BerkeleyDB %s, libdb %s",
$writable ? 'for writing' : 'for reading',
$self->{is_really_open} ? 'already open' : 'not yet open',
BerkeleyDB->VERSION, $BerkeleyDB::db_version);
# Always notice state changes
$self->{is_writable} = $writable;
return 1 if $self->{is_really_open};
#dbg("bayes: not already tied");
my $main = $self->{bayes}->{main};
if (!defined($main->{conf}->{bayes_path})) {
dbg("bayes: bayes_path not defined");
return 0;
}
#dbg("bayes: Reading db configs");
$self->read_db_configs();
my $path = dirname $main->sed_path($main->{conf}->{bayes_path});
#dbg("bayes: Path is $path");
# Path must exist or we must be in writable mode
if (-d $path) {
# All is cool
} elsif ($writable) {
# Create the path
eval {
mkpath($path, 0, (oct($main->{conf}->{bayes_file_mode}) & 0777));
};
warn("bayes: Couldn't create path: $@") if $@;
} else {
# FAIL
warn("bayes: bayes_path doesn't exist and can't create: $path");
return 0;
}
# Now we can set up our environment
my $flags = DB_INIT_LOCK|DB_INIT_LOG|DB_INIT_MPOOL|DB_INIT_TXN;
$flags |= DB_CREATE if $writable;
# DB_REGISTER|DB_RECOVER|
# In the Berkeley DB 4.7 release, the logging subsystem is configured
# using the DB_ENV->log_set_config method instead of the previously used
# DB_ENV->set_flags method. The DB_ENV->set_flags method no longer accepts
# flags DB_DIRECT_LOG, DB_DSYNC_LOG, DB_LOG_INMEMORY or DB_LOG_AUTOREMOVE.
# Applications should be modified to use the equivalent flags accepted by
# the DB_ENV->log_set_config method.
# -SetFlags => DB_LOG_AUTOREMOVE
dbg("bayes: %s environment: %s, 0x%x, %s",
$writable ? 'Opening or creating' : 'Opening existing',
$path, $flags, $main->{conf}->{bayes_file_mode});
unless ($self->{env} = BerkeleyDB::Env->new(
-Cachesize => 67108864, -Home => $path, -Flags => $flags,
-Mode => (oct($main->{conf}->{bayes_file_mode}) & 0666),
)) {
dbg("bayes: berkeleydb environment couldn't initialize: $BerkeleyDB::Error");
return 0;
}
$flags = $writable ? DB_CREATE : 0;
#dbg("bayes: Opening vars");
unless ($self->{handles}->{vars} = BerkeleyDB::Btree->new(
-Env => $self->{env}, -Filename => "vars.db", -Flags => $flags)) {
warn("bayes: couldn't open vars.db: $BerkeleyDB::Error");
delete $self->{handles}->{vars};
$self->untie_db;
return 0;
}
#dbg("bayes: Looking for db_version");
unless ($self->{db_version} = $self->_get(vars => "DB_VERSION")) {
if ($writable) {
$self->{db_version} = $self->DB_VERSION;
$self->{handles}->{vars}->db_put(DB_VERSION => $self->{db_version}) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
$self->{handles}->{vars}->db_put(NTOKENS => 0) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
dbg("bayes: new db, set db version %s and 0 tokens",$self->{db_version});
} else {
warn("bayes: vars.db not intialized: $BerkeleyDB::Error");
$self->untie_db;
return 0;
}
} elsif ($self->{db_version}) {
dbg("bayes: found bayes db version $self->{db_version}");
if ($self->{db_version} != $self->DB_VERSION) {
warn("bayes: bayes db version $self->{db_version} is not able to be used, aborting: $BerkeleyDB::Error");
$self->untie_db();
return 0;
}
}
#dbg("bayes: Opening tokens");
unless ($self->{handles}->{tokens} = BerkeleyDB::Btree->new(
-Env => $self->{env}, -Filename => "tokens.db",
-Flags => $flags, -Property => DB_REVSPLITOFF)) {
warn("bayes: couldn't open tokens.db: $BerkeleyDB::Error");
delete $self->{handles}->{tokens};
$self->untie_db;
return 0;
}
#dbg("bayes: Opening atime secondary DB");
unless ($self->{handles}->{atime} = BerkeleyDB::Btree->new(
-Env => $self->{env}, -Filename => "atime.db",
-Flags => $flags, -Property => DB_DUP|DB_DUPSORT)) {
warn("bayes: couldn't open atime.db: $BerkeleyDB::Error");
delete $self->{handles}->{atime};
$self->untie_db;
return 0;
}
#dbg("bayes: Opening seen DB");
unless ($self->{handles}->{seen} = BerkeleyDB::Btree->new(
-Env => $self->{env}, -Filename => "seen.db", -Flags => $flags)) {
warn("bayes: couldn't open tokens.db: $BerkeleyDB::Error");
delete $self->{handles}->{seen};
$self->untie_db;
return 0;
}
# This MUST be outside the transaction that opens the DB,
# or it just doesn't work. Dunno Why.
!$self->{handles}->{tokens}->associate($self->{handles}->{atime},
\&_extract_atime)
or die "Couldn't associate DBs: $BerkeleyDB::Error";
$self->{is_really_open} = 1;
$self->{is_officially_open} = 1;
dbg("bayes: _open_db done");
return 1;
}
=head2 untie_db
public instance () untie_db ()
Description:
Closes any open db handles. You can safely call this at any time.
=cut
sub untie_db {
my $self = shift;
dbg("bayes: pretend to be closing a database");
$self->{is_writable} = 0;
$self->{is_officially_open} = 0;
$self->{env}->txn_checkpoint(128, 1) if $self->{env};
for my $handle (keys %{$self->{handles}}) {
my $handles = $self->{handles};
if (defined $handles && $handles->{$handle}) {
$handles->{$handle}->db_sync == 0
or die "Couldn't sync $handle: $BerkeleyDB::Error";
}
}
return;
}
sub _close_db {
my $self = shift;
dbg("bayes: really closing a database");
$self->{is_writable} = 0;
$self->{is_really_open} = 0;
$self->{is_officially_open} = 0;
$self->{db_version} = undef;
for my $handle (keys %{$self->{handles}}) {
my $handles = $self->{handles};
if (defined $handles && $handles->{$handle}) {
dbg("bayes: closing database $handle");
eval { $handles->{$handle}->db_close }; # ignoring status
}
delete $handles->{$handle};
}
delete $self->{env};
return;
}
=head2 calculate_expire_delta
public instance (%) calculate_expire_delta (
Integer $newest_atime, Integer $start, Integer $max_expire_mult)
Description:
This method performs a calculation on the data to determine the
optimum atime for token expiration.
=cut
sub calculate_expire_delta {
my($self, $newest_atime, $start, $max_expire_mult) = @_;
dbg("bayes: calculate_expire_delta starting");
my %delta; # use a hash since an array is going to be very sparse
my $cursor = $self->{handles}->{atime}->db_cursor;
$cursor or die "Couldn't get cursor: $BerkeleyDB::Error";
my($atime, $value) = ("", "");
# Do the first pass, figure out atime delta by iterating over our
# *secondary* index, avoiding the decoding overhead
while ($cursor->c_get($atime, $value, $next) == 0) {
# Go through from $start * 1 to $start * 512, mark how many tokens
# we would expire
my $age = $newest_atime - $atime;
for (my $i = 1; $i <= $max_expire_mult; $i <<= 1) {
if ($age >= $start * $i) {
$delta{$i}++;
} else {
# If the token age is less than the expire delta, it'll be
# less for all upcoming checks too, so abort early.
last;
}
}
}
$cursor->c_close == 0
or die "Couldn't close cursor: $BerkeleyDB::Error";
undef $cursor;
dbg("bayes: calculate_expire_delta done");
return %delta;
}
=head2 token_expiration
public instance (Integer, Integer,
Integer, Integer) token_expiration (\% $opts,
Integer $newdelta,
@ @vars)
Description:
This method performs the database specific expiration of tokens based on
the passed in C<$newdelta> and C<@vars>.
=cut
sub token_expiration {
my($self, $opts, $newdelta, @vars) = @_;
dbg("bayes: Entering token_expiration");
my($kept, $deleted, $hapaxes, $lowfreq) = (0, 0, 0, 0);
# Reset stray too-new tokens
{
my $cursor = $self->{handles}->{atime}->db_cursor;
$cursor or die "Couldn't get cursor: $BerkeleyDB::Error";
# Grab the token for a tight RWM loop
my($atime, $flag) = ($vars[10], DB_SET_RANGE|$rmw);
# Find the first token eq or gt the current newest
while ($cursor->c_pget($atime, my $token, my $value, $flag) == 0) {
my($ts, $th, $current) = _unpack_token($value);
$self->{handles}->{tokens}->db_put($token,
_pack_token($ts, $th, $atime)) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
# We need to adjust our flag to continue on from the first rec
$flag = $next|$rmw;
}
$cursor->c_close == 0
or die "Couldn't close cursor: $BerkeleyDB::Error";
undef $cursor;
}
# Figure out how old is too old...
my $too_old = $vars[10] - $newdelta; # tooold = newest - delta
dbg("bayes: Too old is $too_old");
dbg("bayes: Getting db stats");
my $count;
# Estimate the number of keys to be deleted
{
my $stats = $self->{handles}->{atime}->db_stat(DB_FAST_STAT);
#dbg("bayes: Stats: %s", Dumper($stats));
# Scan if we've never gotten stats before
$stats = $self->{handles}->{atime}->db_stat if $stats->{bt_ndata} == 0;
#dbg("bayes: Stats: %s", Dumper($stats));
if ($self->{handles}->{atime}->db_key_range(
$too_old, my $less, my $equal, my $greater) == 0) {
dbg("bayes: less is $less, equal is $equal, greater is $greater");
$count = $stats->{bt_ndata} - $stats->{bt_ndata} * $greater;
}
}
dbg("bayes: Considering deleting $vars[3], $count");
# As long as too many tokens wouldn't be deleted
if ($vars[3] - $count >= 100000) {
dbg("bayes: Preparing to iterate");
my $cursor = $self->{handles}->{atime}->db_cursor;
$cursor or die "Couldn't get cursor: $BerkeleyDB::Error";
my ($atime, $oldest, $token, $value);
$atime = 0;
while ($cursor->c_pget($atime, $token, $value, $next) == 0) {
# We're traversing in order, so done
$oldest = $atime, last if $atime >= $too_old;
dbg("bayes: Deleting record");
$cursor->c_del;
$deleted++;
my($ts, $th, $atime) = _unpack_token($value);
if ($ts + $th == 1) {
$hapaxes++;
} elsif ($ts < 8 && $th < 8) {
$lowfreq++;
}
}
dbg("bayes: Done with cursor");
$cursor->c_close == 0
or die "Couldn't close cursor: $BerkeleyDB::Error";
undef $cursor;
$kept = $self->_get(vars => "NTOKENS", $rmw) - $deleted;
$self->{handles}->{vars}->db_put(NTOKENS => $kept) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
$self->{handles}->{vars}->db_put(LAST_EXPIRE => time) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
$self->{handles}->{vars}->db_put(OLDEST_TOKEN_AGE => $oldest) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
$self->{handles}->{vars}->db_put(LAST_EXPIRE_REDUCE => $deleted) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
$self->{handles}->{vars}->db_put(LAST_ATIME_DELTA => $newdelta) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
#$self->{handles}->{atime}->compact;
#$self->{handles}->{tokens}->compact;
#$self->{handles}->{vars}->compact;
} else {
dbg("bayes: Update vars to regenerate histogram");
# Make sure we regenerate our histogramn
$kept = $self->_get(vars => "NTOKENS");
$self->{handles}->{vars}->db_put(LAST_EXPIRE => time) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
$self->{handles}->{vars}->db_put(LAST_ATIME_DELTA => 0) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
$self->{handles}->{vars}->db_put(LAST_EXPIRE_REDUCE => 0) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
}
dbg("bayes: token_expiration done");
return($kept, $deleted, $hapaxes, $lowfreq);
}
=head2 sync_due
public instance (Boolean) sync_due ()
Description:
This method determines if a database sync is currently required.
Unused for BDB implementation.
=cut
sub sync_due {
return 0;
}
=head2 seen_get
public instance (String) seen_get (string $msgid)
Description:
This method retrieves the stored value, if any, for C<$msgid>. The return
value is the stored string ('s' for spam and 'h' for ham) or undef if C<$msgid>
is not found.
=cut
sub seen_get {
my($self, $msgid) = @_;
dbg("bayes: Entering seen_get");
my $value = $self->_get(seen => $msgid);
return $value;
}
=head2 seen_put
public (Boolean) seen_put (string $msgid, char $flag)
Description:
This method records C<$msgid> as the type given by C<$flag>. C<$flag> is one
of two values 's' for spam and 'h' for ham.
=cut
sub seen_put {
my($self, $msgid, $flag) = @_;
dbg("bayes: Entering seen_put");
$self->{handles}->{seen}->db_put($msgid, $flag) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
return 1;
}
=head2 seen_delete
public instance (Boolean) seen_delete (string $msgid)
Description:
This method removes C<$msgid> from the database.
=cut
sub seen_delete {
my($self, $msgid) = @_;
dbg("bayes: Entering seen_delete");
my $result;
my $status = $self->{handles}->{seen}->db_del($msgid);
if ($status == 0) {
$result = 1;
} elsif ($status == DB_NOTFOUND) {
$result = 0E0;
} else {
die "Couldn't delete record: $BerkeleyDB::Error";
}
return $result;
}
=head2 get_storage_variables
public instance (@) get_storage_variables ()
Description:
This method retrieves the various administrative variables used by
the Bayes process and database.
The values returned in the array are in the following order:
0: scan count base
1: number of spam
2: number of ham
3: number of tokens in db
4: last expire atime
5: oldest token in db atime
6: db version value
7: last journal sync
8: last atime delta
9: last expire reduction count
10: newest token in db atime
=cut
sub get_storage_variables {
my($self) = @_;
dbg("bayes: get_storage_variables starting");
my @values;
for my $token (qw{LAST_JOURNAL_SYNC NSPAM NHAM NTOKENS LAST_EXPIRE
OLDEST_TOKEN_AGE DB_VERSION LAST_JOURNAL_SYNC
LAST_ATIME_DELTA LAST_EXPIRE_REDUCE NEWEST_TOKEN_AGE}) {
my $value = $self->_get(vars => $token);
$value = 0 unless $value && $value =~ /\d+/;
push @values, $value;
}
dbg("bayes: get_storage_variables done");
return @values;
}
=head2 dump_tokens
public instance () dump_tokens (String $template, String $regex, Array @vars)
Description:
This method loops over all tokens, computing the probability for the token
and then printing it out according to the passed in token.
=cut
sub dump_db_toks { dump_tokens(@_) }
sub dump_tokens {
my($self, $template, $regex, @vars) = @_;
dbg("bayes: dump_tokens starting");
my $cursor = $self->{handles}->{tokens}->db_cursor;
$cursor or die "Couldn't get cursor: $BerkeleyDB::Error";
my ($token, $value) = ("", "");
while ($cursor->c_get($token, $value, $next) == 0) {
next if defined $regex && $token !~ /$regex/o;
my($ts, $th, $atime) = _unpack_token($value);
my $prob = $self->{bayes}->_compute_prob_for_token(
$token, $vars[1], $vars[2], $ts, $th) || 0.5;
my $encoded = unpack("H*",$token);
printf $template, $prob, $ts, $th, $atime, $encoded;
}
$cursor->c_close == 0
or die "Couldn't close cursor: $BerkeleyDB::Error";
undef $cursor;
dbg("bayes: dump_tokens done");
return 1;
}
=head2 set_last_expire
public instance (Boolean) set_last_expire (Integer $time)
Description:
This method sets the last expire time.
=cut
sub set_last_expire {
my($self, $time) = @_;
dbg("bayes: Entering set_last_expire");
$self->{handles}->{vars}->db_put(LAST_EXPIRE => $time) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
return 1;
}
=head2 get_running_expire_tok
public instance (String $time) get_running_expire_tok ()
Description:
This method determines if an expire is currently running and returns
the last time set.
There can be multiple times, so we just pull the greatest (most recent)
value.
=cut
sub get_running_expire_tok {
my($self) = @_;
dbg("bayes: Entering get_running_expire_tok");
my $value = $self->_get(vars => "RUNNING_EXPIRE") || "";
my $result;
$result = $value if $value =~ /^\d+$/;
dbg("bayes: get_running_expire_tok exiting with %s",
!defined $result ? 'UNDEF' : $result);
return $result;
}
=head2 set_running_expire_tok
public instance (String $time) set_running_expire_tok ()
Description:
This method sets the time that an expire starts running.
=cut
sub set_running_expire_tok {
my($self) = @_;
my $time = time;
$self->{handles}->{vars}->db_put(RUNNING_EXPIRE => $time) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
return $time;
}
=head2 remove_running_expire_tok
public instance (Boolean) remove_running_expire_tok ()
Description:
This method removes the row in the database that indicates that
and expire is currently running.
=cut
sub remove_running_expire_tok {
my($self) = @_;
my $status = $self->{handles}->{vars}->db_del("RUNNING_EXPIRE");
my $result;
if ($status == 0) {
$result = 1;
} elsif ($status == DB_NOTFOUND) {
$result = 0E0;
} else {
die "Couldn't delete record: $BerkeleyDB::Error";
}
return $result;
}
=head2 tok_get
public instance (Integer, Integer, Integer) tok_get (String $token)
Description:
This method retrieves a specificed token (C<$token>) from the database
and returns its spam_count, ham_count and last access time.
=cut
sub tok_get {
my($self, $token) = @_;
dbg("bayes: Entering tok_get");
my $array = $self->tok_get_all($token);
return !@$array ? () : (@{$array->[0]})[1,2,3];
}
=head2 tok_get_all
public instance (\@) tok_get (@ $tokens)
Description:
This method retrieves the specified tokens (C<$tokens>) from storage and
returns an array ref of arrays spam count, ham acount and last access time.
=cut
sub tok_get_all {
my($self, @keys) = @_;
#dbg("bayes: Entering tok_get_all");
my @results = $self->_mget(tokens => \@keys);
my @values;
for my $token (@keys) {
my $value = shift(@results);
push(@values, [$token, _unpack_token($value)]) if defined $value;
}
dbg("bayes: tok_get_all found %d tokens out of %d search keys",
scalar(@values), scalar(@keys));
#dbg("bayes: tok_get_all returning with %s", Dumper(\@values));
return \@values;
}
=head2 tok_count_change
public instance (Boolean) tok_count_change (
Integer $dspam, Integer $dham, String $token, String $newatime)
Description:
This method takes a C<$spam_count> and C<$ham_count> and adds it to
C<$tok> along with updating C<$tok>s atime with C<$atime>.
=cut
sub tok_count_change {
my($self, $dspam, $dham, $token, $newatime) = @_;
dbg("bayes: Entering tok_count_change");
$self->multi_tok_count_change($dspam, $dham, {$token => 1}, $newatime);
}
=head2 multi_tok_count_change
public instance (Boolean) multi_tok_count_change (
Integer $dspam, Integer $dham, \% $tokens, String $newatime)
Description:
This method takes a C<$dspam> and C<$dham> and adds it to all of the
tokens in the C<$tokens> hash ref along with updating each tokens
atime with C<$atime>.
=cut
sub multi_tok_count_change {
my($self, $dspam, $dham, $tokens, $newatime) = @_;
# Make sure we have some values
$dspam ||= 0;
$dham ||= 0;
$newatime ||= 0;
# No changes, just return
return 1 unless ($dspam or $dham);
# Collect this for updates at the end
my $newtokens = 0;
for my $token (keys %{$tokens}) {
#dbg("bayes: token %s", $tokens->{$token});
my $status = $self->{handles}->{tokens}->db_get($token => my $value, $rmw);
if ($status == 0) {
my ($spam, $ham, $oldatime) = _unpack_token($value);
$spam += $dspam;
$spam = 0 if $spam < 0;
$ham += $dham;
$ham = 0 if $ham < 0;
my $newvalue = _pack_token($spam, $ham, $newatime);
$self->{handles}->{tokens}->db_put($token => $newvalue) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
}
elsif ($status == DB_NOTFOUND) {
my $spam = $dspam;
$spam = 0 if $spam < 0;
my $ham = $dham;
$ham = 0 if $ham < 0;
my $newvalue = _pack_token($spam, $ham, $newatime);
$self->{handles}->{tokens}->db_put($token => $newvalue) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
$newtokens++;
}
else {
die "Couldn't get record: $BerkeleyDB::Error";
}
}
if ($newtokens) {
my $ntokens = $self->_get(vars => "NTOKENS", $rmw) || 0;
$ntokens += $newtokens;
$ntokens = 0 if $ntokens < 0;
$self->{handles}->{vars}->db_put(NTOKENS => $ntokens) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
}
my $newmagic = $self->_get(vars => "NEWEST_TOKEN_AGE", $rmw) || 0;
if ($newatime > $newmagic) {
$self->{handles}->{vars}->db_put(NEWEST_TOKEN_AGE => $newatime) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
}
my $oldmagic = $self->_get(vars => "OLDEST_TOKEN_AGE", $rmw) || time;
if ($newatime && $newatime < $oldmagic) {
$self->{handles}->{vars}->db_put(OLDEST_TOKEN_AGE => $newatime) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
}
return 1;
}
=head2 nspam_nham_get
public instance ($spam_count, $ham_count) nspam_nham_get ()
Description:
This method retrieves the total number of spam and the total number of
ham learned.
=cut
sub nspam_nham_get {
my($self) = @_;
dbg("bayes: Entering nspam_nham_get");
my @vars = $self->get_storage_variables();
($vars[1], $vars[2]);
}
=head2 nspam_nham_change
public instance (Boolean) nspam_nham_change (Integer $num_spam,
Integer $num_ham)
Description:
This method updates the number of spam and the number of ham in the database.
=cut
sub nspam_nham_change {
my($self, $ds, $dh) = @_;
my $nspam = $self->_get(vars => "NSPAM", $rmw) || 0;
$nspam += ($ds || 0);
$nspam = 0 if $nspam < 0;
$self->{handles}->{vars}->db_put(NSPAM => $nspam) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
my $nham = $self->_get(vars => "NHAM", $rmw) || 0;
$nham += ($dh || 0);
$nham = 0 if $nham < 0;
$self->{handles}->{vars}->db_put(NHAM => $nham) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
return 1;
}
=head2 tok_touch
public instance (Boolean) tok_touch (String $token,
String $atime)
Description:
This method updates the given tokens (C<$token>) atime.
The assumption is that the token already exists in the database.
We will never update to an older atime
=cut
sub tok_touch {
my($self, $token, $atime) = @_;
return $self->tok_touch_all([$token], $atime);
}
=head2 tok_touch_all
public instance (Boolean) tok_touch (\@ $tokens
String $atime)
Description:
This method does a mass update of the given list of tokens C<$tokens>,
if the existing token atime is < C<$atime>.
The assumption is that the tokens already exist in the database.
We should never be touching more than N_SIGNIFICANT_TOKENS, so we can
make some assumptions about how to handle the data (ie no need to
batch like we do in tok_get_all)
=cut
sub tok_touch_all {
my($self, $tokens, $newatime) = @_;
for my $token (@{$tokens}) {
my $status = $self->{handles}->{tokens}->db_get($token => my $value, $rmw);
if ($status == 0) {
my ($spam, $ham, $oldatime) = _unpack_token($value);
my $newvalue = _pack_token($spam, $ham, $newatime);
$self->{handles}->{tokens}->db_put($token => $newvalue) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
}
elsif ($status == DB_NOTFOUND) {
# Do nothing
}
else {
die "Couldn't get record: $BerkeleyDB::Error";
}
}
return 1;
}
=head2 cleanup
public instance (Boolean) cleanup ()
Description:
This method perfoms any cleanup necessary before moving onto the next
operation.
=cut
sub cleanup {
my ($self) = @_;
dbg("Running cleanup");
return 1;
}
=head2 get_magic_re
public instance (String) get_magic_re ()
Description:
This method returns a regexp which indicates a magic token.
Unused in BDB implementation.
=cut
use constant get_magic_re => undef;
=head2 sync
public instance (Boolean) sync (\% $opts)
Description:
This method performs a sync of the database
=cut
sub sync {
my($self, $opts) = @_;
dbg("Running sync");
return 1;
}
=head2 perform_upgrade
public instance (Boolean) perform_upgrade (\% $opts);
Description:
Performs an upgrade of the database from one version to another, not
currently used in this implementation.
=cut
sub perform_upgrade {
dbg("bayes: Entering perform_upgrade");
return 1;
}
=head2 clear_database
public instance (Boolean) clear_database ()
Description:
This method deletes all records for a particular user.
Callers should be aware that any errors returned by this method
could causes the database to be inconsistent for the given user.
=cut
sub clear_database {
my($self) = @_;
dbg("bayes: Entering clear_database");
$self->untie_db();
dbg("bayes: removing db.");
my $main = $self->{bayes}->{main};
my $path = $main->sed_path($main->{conf}->{bayes_path});
eval {rmpath($path)};
return 1;
}
=head2 backup_database
public instance (Boolean) backup_database ()
Description:
This method will dump the users database in a machine readable format.
=cut
sub backup_database {
my($self) = @_;
dbg("bayes: Entering backup_database");
return 0 unless $self->tie_db_writable;
my @vars = $self->get_storage_variables;
print "v\t$vars[6]\tdb_version # this must be the first line!!!\n";
print "v\t$vars[1]\tnum_spam\n";
print "v\t$vars[2]\tnum_nonspam\n";
my $tokens = $self->{handles}->{tokens}->db_cursor;
$tokens or die "Couldn't get cursor: $BerkeleyDB::Error";
my($token, $value) = ("", "");
while ($tokens->c_get($token, $value, $next) == 0) {
my($ts, $th, $atime) = _unpack_token($value);
my $encoded = unpack("H*", $token);
print "t\t$ts\t$th\t$atime\t$encoded\n";
}
$tokens->c_close == 0
or die "Couldn't close cursor: $BerkeleyDB::Error";
undef $tokens;
my $seen = $self->{handles}->{seen}->db_cursor;
$seen or die "Couldn't get cursor: $BerkeleyDB::Error";
$token = "";
while ($seen->c_get($token, $value, $next) == 0) {
print "s\t$token\t$value\n";
}
$seen->c_close == 0
or die "Couldn't close cursor: $BerkeleyDB::Error";
undef $seen;
$self->untie_db();
return 1;
}
=head2 restore_database
public instance (Boolean) restore_database (String $filename, Boolean $showdots)
Description:
This method restores a database from the given filename, C<$filename>.
Callers should be aware that any errors returned by this method
could causes the database to be inconsistent for the given user.
=cut
sub restore_database {
my ($self, $filename, $showdots) = @_;
dbg("bayes: Entering restore_database");
local *DUMPFILE;
if (!open(DUMPFILE, '<', $filename)) {
dbg("bayes: unable to open backup file $filename: $!");
return 0;
}
# This is the critical phase (moving sql around), so don't allow it
# to be interrupted.
local $SIG{'INT'} = 'IGNORE';
local $SIG{'HUP'} = 'IGNORE'
if !Mail::SpamAssassin::Util::am_running_on_windows();
local $SIG{'TERM'} = 'IGNORE';
unless ($self->clear_database()) {
return 0;
}
# we need to go ahead close the db connection so we can then open it up
# in a fresh state after clearing
$self->untie_db();
unless ($self->tie_db_writable()) {
return 0;
}
my $token_count = 0;
my $db_version;
my $num_spam;
my $num_ham;
my $error_p = 0;
my $line_count = 0;
my $line = <DUMPFILE>;
defined $line or die "Error reading dump file: $!";
$line_count++;
# We require the database version line to be the first in the file so we can
# figure out how to properly deal with the file. If it is not the first
# line then fail
if ($line =~ m/^v\s+(\d+)\s+db_version/) {
$db_version = $1;
} else {
dbg("bayes: database version must be the first line in the backup file, correct and re-run");
return 0;
}
unless ($db_version == 2 || $db_version == 3) {
warn("bayes: database version $db_version is unsupported, must be version 2 or 3");
return 0;
}
my $token_error_count = 0;
my $seen_error_count = 0;
for ($!=0; defined($line=<DUMPFILE>); $!=0) {
chomp($line);
$line_count++;
if ($line_count % 1000 == 0) {
print STDERR "." if $showdots;
}
if ($line =~ /^v\s+/) { # variable line
my @parsed_line = split(/\s+/, $line, 3);
my $value = $parsed_line[1] + 0;
if ($parsed_line[2] eq 'num_spam') {
$num_spam = $value;
} elsif ($parsed_line[2] eq 'num_nonspam') {
$num_ham = $value;
} else {
dbg("bayes: restore_database: skipping unknown line: $line");
}
} elsif ($line =~ /^t\s+/) { # token line
my @parsed_line = split(/\s+/, $line, 5);
my $spam_count = $parsed_line[1] + 0;
my $ham_count = $parsed_line[2] + 0;
my $atime = $parsed_line[3] + 0;
my $token = $parsed_line[4];
my $token_warn_p = 0;
my @warnings;
if ($spam_count < 0) {
$spam_count = 0;
push(@warnings, 'spam count < 0, resetting');
$token_warn_p = 1;
}
if ($ham_count < 0) {
$ham_count = 0;
push(@warnings, 'ham count < 0, resetting');
$token_warn_p = 1;
}
if ($spam_count == 0 && $ham_count == 0) {
dbg("bayes: token has zero spam and ham count, skipping");
next;
}
if ($atime > time()) {
$atime = time();
push(@warnings, 'atime > current time, resetting');
$token_warn_p = 1;
}
if ($token_warn_p) {
dbg("bayes: token (%s) has the following warnings:\n%s",
$token, join("\n",@warnings));
}
if ($db_version < 3) {
# versions < 3 use plain text tokens, so we need to convert to hash
$token = substr(sha1($token), -5);
} else {
# turn unpacked binary token back into binary value
$token = pack("H*",$token);
}
unless ($self->_put_token($token, $spam_count, $ham_count, $atime)) {
dbg("bayes: error inserting token for line: $line");
$token_error_count++;
}
$token_count++;
} elsif ($line =~ /^s\s+/) { # seen line
my @parsed_line = split(/\s+/, $line, 3);
my $flag = $parsed_line[1];
my $msgid = $parsed_line[2];
unless ($flag eq 'h' || $flag eq 's') {
dbg("bayes: unknown seen flag ($flag) for line: $line, skipping");
next;
}
unless ($msgid) {
dbg("bayes: blank msgid for line: $line, skipping");
next;
}
unless ($self->seen_put($msgid, $flag)) {
dbg("bayes: error inserting msgid in seen table for line: $line");
$seen_error_count++;
}
} else {
dbg("bayes: skipping unknown line: $line");
next;
}
if ($token_error_count >= 20) {
warn "bayes: encountered too many errors (20) while parsing token line, reverting to empty database and exiting\n";
$self->clear_database();
return 0;
}
if ($seen_error_count >= 20) {
warn "bayes: encountered too many errors (20) while parsing seen lines, reverting to empty database and exiting\n";
$self->clear_database();
return 0;
}
}
defined $line || $!==0 or
$!==EBADF ? dbg("bayes: error reading dump file: $!")
: die "error reading dump file: $!";
close(DUMPFILE) or die "Can't close dump file: $!";
print STDERR "\n" if $showdots;
unless (defined($num_spam)) {
dbg("bayes: unable to find num spam, please check file");
$error_p = 1;
}
unless (defined($num_ham)) {
dbg("bayes: unable to find num ham, please check file");
$error_p = 1;
}
if ($error_p) {
dbg("bayes: error(s) while attempting to load $filename, clearing database, correct and re-run");
$self->clear_database();
return 0;
}
if ($num_spam || $num_ham) {
unless ($self->nspam_nham_change($num_spam, $num_ham)) {
dbg("bayes: error updating num spam and num ham, clearing database");
$self->clear_database();
return 0;
}
}
dbg("bayes: parsed $line_count lines");
dbg("bayes: created database with $token_count tokens based on $num_spam spam messages and $num_ham ham messages");
$self->untie_db();
return 1;
}
=head2 db_readable
public instance (Boolean) db_readable()
Description:
This method returns a boolean value indicating if the database is in a
readable state.
=cut
sub db_readable {
my($self) = @_;
#dbg("bayes: Entering db_readable");
return $self->{is_really_open} && $self->{is_officially_open};
}
=head2 db_writable
public instance (Boolean) db_writable()
Description:
This method returns a boolean value indicating if the database is in a
writable state.
=cut
sub db_writable {
my($self) = @_;
dbg("bayes: Entering db_writable");
return $self->{is_really_open} && $self->{is_officially_open} &&
$self->{is_writable};
}
=head2 _extract_atime
private instance () _extract_atime (String $token,
String $value,
String $index)
Description:
This method ensures that the database connection is properly setup and
working. If appropriate it will initialize a users bayes variables so
that they can begin using the database immediately.
=cut
sub _extract_atime {
my ($token, $value) = @_;
#dbg("bayes: Entering _extract_atime");
my($ts, $th, $atime) = _unpack_token($value);
#dbg("bayes: _extract_atime found $atime for $token");
$_[2] = $atime;
#dbg("bayes: Leaving db_writable");
return 0;
}
=head2 _put_token
FIXME: This is rarely a good interface, because of the churn that will
often happen in the "magic" tokens. Open-code this stuff in the
presence of loops.
=cut
sub _put_token {
my($self, $token, $ts, $th, $atime) = @_;
dbg("bayes: Entering _put_token");
$ts ||= 0;
$th ||= 0;
dbg("bayes: $token has spam $ts, ham $th, atime $atime");
my $value = $self->_get(tokens => $token, $rmw);
my $exists_already = defined $value ? 1 : 0;
dbg("bayes: $token exists: $exists_already");
if ($ts == 0 && $th == 0) {
return unless $exists_already; # If the token doesn't exist, just return
my $ntokens = $self->_get(vars => "NTOKENS", $rmw);
$self->{handles}->{vars}->db_put(NTOKENS => --$ntokens) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
dbg("bayes: ntokens is $ntokens");
my $status = $self->{handles}->{tokens}->db_del($token);
$status == 0 || $status == DB_NOTFOUND
or die "Couldn't delete record: $BerkeleyDB::Error";
dbg("bayes: $token deleted");
} else {
unless ($exists_already) {
# If the token doesn't exist, raise the token count
my $ntokens = $self->_get(vars => "NTOKENS", $rmw);
$self->{handles}->{vars}->db_put(NTOKENS => ++$ntokens) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
dbg("bayes: ntokens is $ntokens");
}
my $newmagic = $self->_get(vars => "NEWEST_TOKEN_AGE", $rmw) || 0;
dbg("bayes: NEWEST_TOKEN_AGE is $newmagic");
if ($atime > $newmagic) {
dbg("bayes: Updating NEWEST_TOKEN_AGE");
$self->{handles}->{vars}->db_put(NEWEST_TOKEN_AGE => $atime) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
}
my $oldmagic = $self->_get(vars => "OLDEST_TOKEN_AGE", $rmw) || time;
dbg("bayes: OLDEST_TOKEN_AGE is $oldmagic");
if ($atime && $atime < $oldmagic) {
dbg("bayes: Updating OLDEST_TOKEN_AGE to $atime");
$self->{handles}->{vars}->db_put(OLDEST_TOKEN_AGE => $atime) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
}
my $value = _pack_token($ts, $th, $atime);
dbg("bayes: Setting $token to $value");
dbg("bayes: Handle is $self->{handles}->{tokens}");
$self->{handles}->{tokens}->db_put($token, $value) == 0
or die "Couldn't put record: $BerkeleyDB::Error";
}
dbg("bayes: Leaving _put_token");
return 1;
}
# token marshalling format for tokens.
# Since we may have many entries with few hits, especially thousands of hapaxes
# (1-occurrence entries), use a flexible entry format, instead of simply "2
# packed ints", to keep the memory and disk space usage down. In my
# 18k-message test corpus, only 8.9% have >= 8 hits in either counter, so we
# can use a 1-byte representation for the other 91% of low-hitting entries
# and save masses of space.
# This looks like: XXSSSHHH (XX = format bits, SSS = 3 spam-count bits, HHH = 3
# ham-count bits). If XX in the first byte is 11, it's packed as this 1-byte
# representation; otherwise, if XX in the first byte is 00, it's packed as
# "CLL", ie. 1 byte and 2 32-bit "longs" in perl pack format.
# Savings: roughly halves size of toks db, at the cost of a ~10% slowdown.
use constant FORMAT_FLAG => 0xc0; # 11000000
use constant ONE_BYTE_FORMAT => 0xc0; # 11000000
use constant TWO_LONGS_FORMAT => 0x00; # 00000000
use constant ONE_BYTE_SSS_BITS => 0x38; # 00111000
use constant ONE_BYTE_HHH_BITS => 0x07; # 00000111
sub _unpack_token {
my $value = shift || 0;
my($packed, $ts, $th, $atime) = unpack("CVVV", $value);
if (($packed & FORMAT_FLAG) == ONE_BYTE_FORMAT) {
return (($packed & ONE_BYTE_SSS_BITS) >> 3,
$packed & ONE_BYTE_HHH_BITS,
$ts || 0);
# The one-byte-format uses that first 32-bit long as atime
} elsif (($packed & FORMAT_FLAG) == TWO_LONGS_FORMAT) {
return ($ts || 0, $th || 0, $atime || 0);
} else {
warn "bayes: unknown packing format for bayes db, please re-learn: $packed";
return (0, 0, 0);
}
}
sub _pack_token {
my($ts, $th, $atime) = @_;
$ts ||= 0; $th ||= 0; $atime ||= 0;
if ($ts < 8 && $th < 8) {
return pack("CV", (ONE_BYTE_FORMAT | ($ts << 3) | $th) & 255, $atime);
} else {
return pack("CVVV", TWO_LONGS_FORMAT, $ts, $th, $atime);
}
}
sub _get {
my ($self, $table, $key, $flags) = @_;
$flags |= 0;
my $value = "";
my $status = $self->{handles}->{$table}->db_get($key => $value, $flags);
if ($status == 0) {
return $value;
} elsif ($status == DB_NOTFOUND) {
return;
} else {
die "Couldn't get record: $BerkeleyDB::Error";
}
}
sub _mget {
my ($self, $table, $keys, $flags) = @_;
my @results;
$flags |= 0;
my $handle = $self->{handles}->{$table};
for my $key (@$keys) {
my $value = "";
my $status = $handle->db_get($key => $value, $flags);
undef $value if $status != 0;
$status == 0 || $status == DB_NOTFOUND
or die "Couldn't get record: $BerkeleyDB::Error";
push(@results, $value);
}
return @results;
}
sub sa_die { Mail::SpamAssassin::sa_die(@_); }
1;
|