# Copyright (C) 2015 all contributors # License: GPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) # based on notmuch, but with no concept of folders, files or flags package PublicInbox::SearchMsg; use strict; use warnings; use Search::Xapian; use Email::Address qw//; use Email::Simple qw//; use POSIX qw//; use Date::Parse qw/str2time/; use PublicInbox::MID qw/mid_clean/; use Encode qw/find_encoding/; my $enc_utf8 = find_encoding('UTF-8'); our $PFX2TERM_RE = undef; use constant EPOCH_822 => 'Thu, 01 Jan 1970 00:00:00 +0000'; sub new { my ($class, $mime) = @_; my $doc = Search::Xapian::Document->new; $doc->add_term(PublicInbox::Search::xpfx('type') . 'mail'); bless { type => 'mail', doc => $doc, mime => $mime }, $class; } sub wrap { my ($class, $doc, $mid) = @_; bless { doc => $doc, mime => undef, mid => $mid }, $class; } sub load_doc { my ($class, $doc) = @_; my $data = $doc->get_data; my $ts = eval { no strict 'subs'; $doc->get_value(PublicInbox::Search::TS); }; $ts = Search::Xapian::sortable_unserialise($ts); $data = $enc_utf8->decode($data); my ($subj, $from, $refs) = split(/\n/, $data); bless { doc => $doc, subject => $subj, ts => $ts, from_name => $from, references_sorted => $refs, }, $class; } sub subject { my ($self) = @_; my $subj = $self->{subject}; return $subj if defined $subj; $subj = $self->{mime}->header('Subject'); $subj = '' unless defined $subj; $subj =~ tr/\n/ /; $self->{subject} = $subj; } sub from { my ($self) = @_; my $from = $self->mime->header('From') || ''; my @from; if ($from) { $from =~ tr/\n/ /; @from = Email::Address->parse($from); $self->{from} = $from[0]; $from = $from[0]->name; } $self->{from_name} = $from; $self->{from}; } sub from_name { my ($self) = @_; my $from_name = $self->{from_name}; return $from_name if defined $from_name; $self->from; $self->{from_name}; } sub ts { my ($self) = @_; $self->{ts} ||= eval { str2time($self->mime->header('Date')) } || 0; } sub to_doc_data { my ($self) = @_; PublicInbox::Search::subject_summary($self->subject) . "\n" . $self->from_name . "\n". $self->references_sorted; } sub references_sorted { my ($self) = @_; my $x = $self->{references_sorted}; defined $x ? $x : ''; } sub ensure_metadata { my ($self) = @_; my $doc = $self->{doc}; my $end = $doc->termlist_end; unless (defined $PFX2TERM_RE) { my $or = join('|', keys %PublicInbox::Search::PFX2TERM_RMAP); $PFX2TERM_RE = qr/\A($or)/; } while (my ($pfx, $field) = each %PublicInbox::Search::PFX2TERM_RMAP) { # ideally we'd move this out of the loop: my $i = $doc->termlist_begin; $i->skip_to($pfx); if ($i != $end) { my $val = $i->get_termname; if ($val =~ s/$PFX2TERM_RE//o) { $self->{$field} = $val; } } } } # for threading only sub mini_mime { my ($self) = @_; $self->ensure_metadata; my @hs = ( 'Subject' => $self->subject, 'X-PI-From' => $self->from_name, ); my @h = ( # prevent Email::Simple::Creator from running, # this header is useless for threading as we use X-PI-TS # for sorting and display: 'Date' => EPOCH_822, 'Message-ID' => "<$self->{mid}>", 'X-PI-TS' => $self->ts, ); if (my $refs = $self->{references_sorted}) { push @h, References => $refs; } my $mime = Email::MIME->create(header_str => \@hs, header => \@h); my $h = $mime->header_obj; # set these headers manually since Encode::encode('MIME-Q', ...) # will add spaces to long values when using header_str above. # drop useless headers Email::MIME set for us $h->header_set('Date'); $h->header_set('MIME-Version'); $mime; } sub mid { my ($self, $mid) = @_; if (defined $mid) { $self->{mid} = $mid; } elsif (my $rv = $self->{mid}) { $rv; } else { $self->ensure_metadata; # needed for ghosts $self->{mid} ||= $self->_extract_mid; } } sub _extract_mid { my ($self) = @_; my $mid = $self->mime->header('Message-ID'); defined $mid ? mid_clean($mid) : $mid; } sub mime { my ($self, $mime) = @_; if (defined $mime) { $self->{mime} = $mime; } else { # TODO load from git $self->{mime}; } } sub doc_id { my ($self, $doc_id) = @_; if (defined $doc_id) { $self->{doc_id} = $doc_id; } else { # TODO load from xapian $self->{doc_id}; } } sub thread_id { my ($self) = @_; my $tid = $self->{thread}; return $tid if defined $tid; $self->ensure_metadata; $self->{thread}; } sub path { my ($self) = @_; my $path = $self->{path}; return $path if defined $path; $self->ensure_metadata; $self->{path}; } 1;