1 # Copyright (C) 2015-2016 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
3 # based on notmuch, but with no concept of folders, files or flags
5 # Wraps a document inside our Xapian search index.
6 package PublicInbox::SearchMsg;
10 use Email::Address qw//;
12 use Date::Parse qw/str2time/;
13 use PublicInbox::MID qw/mid_clean/;
14 use Encode qw/find_encoding/;
15 my $enc_utf8 = find_encoding('UTF-8');
16 our $PFX2TERM_RE = undef;
17 use constant EPOCH_822 => 'Thu, 01 Jan 1970 00:00:00 +0000';
18 use POSIX qw(strftime);
21 my ($class, $mime) = @_;
22 my $doc = Search::Xapian::Document->new;
23 $doc->add_term(PublicInbox::Search::xpfx('type') . 'mail');
25 bless { type => 'mail', doc => $doc, mime => $mime }, $class;
29 my ($class, $doc, $mid) = @_;
30 bless { doc => $doc, mime => undef, mid => $mid }, $class;
35 Search::Xapian::sortable_unserialise($doc->get_value($col));
39 my ($class, $doc) = @_;
40 my $data = $doc->get_data;
41 my $ts = get_val($doc, &PublicInbox::Search::TS);
42 $data = $enc_utf8->decode($data);
43 my ($subj, $from, $refs, $to, $cc) = split(/\n/, $data);
55 # :bytes and :lines metadata in RFC 3977
56 sub bytes ($) { get_val($_[0]->{doc}, &PublicInbox::Search::BYTES) }
57 sub lines ($) { get_val($_[0]->{doc}, &PublicInbox::Search::LINES) }
58 sub num ($) { get_val($_[0]->{doc}, &PublicInbox::Search::NUM) }
61 my ($self, $field) = @_;
62 my $val = $self->{$field};
63 return $val if defined $val;
65 my $mime = $self->{mime} or return;
66 $val = $mime->header($field);
67 $val = '' unless defined $val;
69 $self->{$field} = $val;
72 sub subject ($) { __hdr($_[0], 'subject') }
73 sub to ($) { __hdr($_[0], 'to') }
74 sub cc ($) { __hdr($_[0], 'cc') }
78 my $date = __hdr($self, 'date');
79 return $date if defined $date;
81 return unless defined $ts;
82 $self->{date} = strftime('%a, %d %b %Y %T %z', gmtime($ts));
87 my $from = __hdr($self, 'from');
88 if (defined $from && !defined $self->{from_name}) {
89 $from =~ tr/\t\r\n/ /;
90 my @from = Email::Address->parse($from);
91 $self->{from_name} = $from[0]->name;
98 my $from_name = $self->{from_name};
99 return $from_name if defined $from_name;
106 $self->{ts} ||= eval { str2time($self->mime->header('Date')) } || 0;
111 join("\n", $self->subject, $self->from, $self->references,
112 $self->to, $self->cc);
117 my $x = $self->{references};
118 defined $x ? $x : '';
121 sub ensure_metadata {
123 my $doc = $self->{doc};
124 my $end = $doc->termlist_end;
126 unless (defined $PFX2TERM_RE) {
127 my $or = join('|', keys %PublicInbox::Search::PFX2TERM_RMAP);
128 $PFX2TERM_RE = qr/\A($or)/;
131 while (my ($pfx, $field) = each %PublicInbox::Search::PFX2TERM_RMAP) {
132 # ideally we'd move this out of the loop:
133 my $i = $doc->termlist_begin;
137 my $val = $i->get_termname;
139 if ($val =~ s/$PFX2TERM_RE//o) {
140 $self->{$field} = $val;
149 $self->ensure_metadata;
151 'Subject' => $self->subject,
152 'X-PI-From' => $self->from_name,
156 # prevent Email::Simple::Creator from running,
157 # this header is useless for threading as we use X-PI-TS
158 # for sorting and display:
160 'Message-ID' => "<$self->{mid}>",
161 'X-PI-TS' => $self->ts,
163 if (my $refs = $self->{references}) {
164 push @h, References => $refs;
166 my $mime = Email::MIME->create(header_str => \@hs, header => \@h);
167 my $h = $mime->header_obj;
169 # set these headers manually since Encode::encode('MIME-Q', ...)
170 # will add spaces to long values when using header_str above.
172 # drop useless headers Email::MIME set for us
173 $h->header_set('Date');
174 $h->header_set('MIME-Version');
179 my ($self, $mid) = @_;
183 } elsif (my $rv = $self->{mid}) {
186 $self->ensure_metadata; # needed for ghosts
187 $self->{mid} ||= $self->_extract_mid;
191 sub _extract_mid { mid_clean(mid_mime($_[0]->mime)) }
194 my ($self, $mime) = @_;
196 $self->{mime} = $mime;
204 my ($self, $doc_id) = @_;
205 if (defined $doc_id) {
206 $self->{doc_id} = $doc_id;
208 # TODO load from xapian
215 my $tid = $self->{thread};
216 return $tid if defined $tid;
217 $self->ensure_metadata;
223 my $path = $self->{path};
224 return $path if defined $path;
225 $self->ensure_metadata;