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;
11 use Date::Parse qw/str2time/;
12 use PublicInbox::MID qw/mid_clean/;
13 use PublicInbox::Address;
14 our $PFX2TERM_RE = undef;
15 use constant EPOCH_822 => 'Thu, 01 Jan 1970 00:00:00 +0000';
16 use POSIX qw(strftime);
19 my ($class, $mime) = @_;
20 my $doc = Search::Xapian::Document->new;
21 $doc->add_term(PublicInbox::Search::xpfx('type') . 'mail');
23 bless { type => 'mail', doc => $doc, mime => $mime }, $class;
27 my ($class, $doc, $mid) = @_;
28 bless { doc => $doc, mime => undef, mid => $mid }, $class;
33 Search::Xapian::sortable_unserialise($doc->get_value($col));
37 my ($class, $doc) = @_;
38 my $data = $doc->get_data or return;
39 my $ts = get_val($doc, &PublicInbox::Search::TS);
41 my ($subj, $from, $refs, $to, $cc, $blob) = split(/\n/, $data);
54 # :bytes and :lines metadata in RFC 3977
55 sub bytes ($) { get_val($_[0]->{doc}, &PublicInbox::Search::BYTES) }
56 sub lines ($) { get_val($_[0]->{doc}, &PublicInbox::Search::LINES) }
57 sub num ($) { get_val($_[0]->{doc}, &PublicInbox::Search::NUM) }
60 my ($self, $field) = @_;
61 my $val = $self->{$field};
62 return $val if defined $val;
64 my $mime = $self->{mime} or return;
65 $val = $mime->header($field);
66 $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 +0000', gmtime($ts));
87 my $from = __hdr($self, 'from');
88 if (defined $from && !defined $self->{from_name}) {
89 my @n = PublicInbox::Address::names($from);
90 $self->{from_name} = join(', ', @n);
97 my $from_name = $self->{from_name};
98 return $from_name if defined $from_name;
105 $self->{ts} ||= eval { str2time($self->mime->header('Date')) } || 0;
109 my ($self, $blob) = @_;
110 my @rows = ($self->subject, $self->from, $self->references,
111 $self->to, $self->cc);
112 push @rows, $blob if defined $blob;
118 my $x = $self->{references};
119 defined $x ? $x : '';
122 sub ensure_metadata {
124 my $doc = $self->{doc};
125 my $end = $doc->termlist_end;
127 unless (defined $PFX2TERM_RE) {
128 my $or = join('|', keys %PublicInbox::Search::PFX2TERM_RMAP);
129 $PFX2TERM_RE = qr/\A($or)/;
132 while (my ($pfx, $field) = each %PublicInbox::Search::PFX2TERM_RMAP) {
133 # ideally we'd move this out of the loop:
134 my $i = $doc->termlist_begin;
138 my $val = $i->get_termname;
140 if ($val =~ s/$PFX2TERM_RE//o) {
141 $self->{$field} = $val;
150 $self->ensure_metadata;
152 'Subject' => $self->subject,
153 'X-PI-From' => $self->from_name,
154 # prevent Email::Simple::Creator from running,
155 # this header is useless for threading as we use X-PI-TS
156 # for sorting and display:
158 'Message-ID' => "<$self->{mid}>",
159 'X-PI-TS' => $self->ts,
161 if (my $refs = $self->{references}) {
162 push @h, References => $refs;
164 my $mime = Email::MIME->create(header => \@h);
165 my $h = $mime->header_obj;
167 # set these headers manually since Encode::encode('MIME-Q', ...)
168 # will add spaces to long values when using header_str above.
170 # drop useless headers Email::MIME set for us
171 $h->header_set('Date');
172 $h->header_set('MIME-Version');
177 my ($self, $mid) = @_;
181 } elsif (my $rv = $self->{mid}) {
184 $self->ensure_metadata; # needed for ghosts
185 $self->{mid} ||= $self->_extract_mid;
189 sub _extract_mid { mid_clean(mid_mime($_[0]->mime)) }
192 my ($self, $x40) = @_;
194 $self->{blob} = $x40;
201 my ($self, $mime) = @_;
203 $self->{mime} = $mime;
211 my ($self, $doc_id) = @_;
212 if (defined $doc_id) {
213 $self->{doc_id} = $doc_id;
215 # TODO load from xapian
222 my $tid = $self->{thread};
223 return $tid if defined $tid;
224 $self->ensure_metadata;
230 my $path = $self->{path};
231 return $path if defined $path;
232 $self->ensure_metadata;