1 # Copyright (C) all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Unstable internal API.
5 # Used for on-the-fly duplicate detection in V2 inboxes.
6 # This is not stored in any database anywhere and may change
7 # as changes in duplicate detection are needed.
8 # See L<public-inbox-v2-format(5)> manpage for more details.
9 package PublicInbox::ContentHash;
12 use parent qw(Exporter);
13 our @EXPORT_OK = qw(content_hash content_digest git_sha);
14 use PublicInbox::MID qw(mids references);
15 use PublicInbox::MsgIter;
17 # not sure if less-widely supported hash families are worth bothering with
20 sub digest_addr ($$$) {
21 my ($dig, $h, $v) = @_;
24 $v =~ s/@([a-z0-9\_\.\-\(\)]*([A-Z])\S*)/'@'.lc($1)/ge;
26 $dig->add("$h\0$v\0");
31 my ($part, $depth, @idx) = @{$_[0]};
32 $dig->add("\0$depth:".join('.', @idx)."\0");
33 my $fn = $part->filename;
36 $dig->add("fn\0$fn\0");
38 my @d = $part->header('Content-Description');
44 my $ct = $part->content_type || 'text/plain';
45 my ($s, undef) = msg_part_text($part, $ct);
56 sub content_digest ($;$) {
58 $dig //= Digest::SHA->new(256);
60 # References: and In-Reply-To: get used interchangeably
61 # in some "duplicates" in LKML. We treat them the same
62 # in SearchIdx, so treat them the same for this:
63 # do NOT consider the Message-ID as part of the content_hash
64 # if we got here, we've already got Message-ID reuse
65 my %seen = map { $_ => 1 } @{mids($eml)};
66 for (grep { !$seen{$_}++ } @{references($eml)}) {
68 $dig->add("ref\0$_\0");
71 # Only use Sender: if From is not present
72 foreach my $h (qw(From Sender)) {
73 my @v = $eml->header($h) or next;
74 digest_addr($dig, $h, $_) foreach @v;
77 foreach my $h (qw(Subject Date)) {
78 my @v = $eml->header($h);
81 $dig->add("$h\0$v\0");
84 # Some mail processors will add " to unquoted names that were
85 # not in the original message. For the purposes of deduplication,
86 # do not take it into account:
87 foreach my $h (qw(To Cc)) {
88 my @v = $eml->header($h);
89 digest_addr($dig, $h, $_) foreach @v;
91 msg_iter($eml, \&content_dig_i, $dig);
95 sub content_hash ($) {
96 content_digest($_[0])->digest;
101 my $dig = Digest::SHA->new($n);
102 my $bref = ref($eml) eq 'SCALAR' ? $eml : \($eml->as_string);
103 $dig->add('blob '.length($$bref)."\0");