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 Date::Parse qw/str2time/;
11 use PublicInbox::MID qw/mid_clean/;
12 use PublicInbox::Address;
15 my ($class, $mime) = @_;
16 my $doc = Search::Xapian::Document->new;
17 $doc->add_term(PublicInbox::Search::xpfx('type') . 'mail');
19 bless { type => 'mail', doc => $doc, mime => $mime }, $class;
23 my ($class, $doc, $mid) = @_;
24 bless { doc => $doc, mime => undef, mid => $mid }, $class;
29 Search::Xapian::sortable_unserialise($doc->get_value($col));
33 my ($class, $doc) = @_;
34 my $data = $doc->get_data or return;
35 my $ts = get_val($doc, &PublicInbox::Search::TS);
37 my ($subj, $from, $refs, $to, $cc, $blob) = split(/\n/, $data);
50 # :bytes and :lines metadata in RFC 3977
51 sub bytes ($) { get_val($_[0]->{doc}, &PublicInbox::Search::BYTES) }
52 sub lines ($) { get_val($_[0]->{doc}, &PublicInbox::Search::LINES) }
53 sub num ($) { get_val($_[0]->{doc}, &PublicInbox::Search::NUM) }
56 my ($self, $field) = @_;
57 my $val = $self->{$field};
58 return $val if defined $val;
60 my $mime = $self->{mime} or return;
61 $val = $mime->header($field);
62 $val = '' unless defined $val;
65 $self->{$field} = $val;
68 sub subject ($) { __hdr($_[0], 'subject') }
69 sub to ($) { __hdr($_[0], 'to') }
70 sub cc ($) { __hdr($_[0], 'cc') }
72 # no strftime, that is locale-dependent
73 my @DoW = qw(Sun Mon Tue Wed Thu Fri Sat);
74 my @MoY = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
79 return unless defined $ts;
80 my ($sec, $min, $hour, $mday, $mon, $year, $wday) = gmtime($ts);
81 "$DoW[$wday], " . sprintf("%02d $MoY[$mon] %04d %02d:%02d:%02d +0000",
82 $mday, $year+1900, $hour, $min, $sec);
88 my $from = __hdr($self, 'from');
89 if (defined $from && !defined $self->{from_name}) {
90 my @n = PublicInbox::Address::names($from);
91 $self->{from_name} = join(', ', @n);
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;
110 my ($self, $blob) = @_;
111 my @rows = ($self->subject, $self->from, $self->references,
112 $self->to, $self->cc);
113 push @rows, $blob if defined $blob;
119 my $x = $self->{references};
120 defined $x ? $x : '';
123 sub _get_term_val ($$$) {
124 my ($self, $pfx, $re) = @_;
125 my $doc = $self->{doc};
126 my $end = $doc->termlist_end;
127 my $i = $doc->termlist_begin;
130 my $val = $i->get_termname;
131 $val =~ s/$re// and return $val;
137 my ($self, $mid) = @_;
141 } elsif (my $rv = $self->{mid}) {
144 $self->{mid} = _get_term_val($self, 'Q', qr/\AQ/) ||
149 sub _extract_mid { mid_clean(mid_mime($_[0]->mime)) }
152 my ($self, $x40) = @_;
154 $self->{blob} = $x40;
161 my ($self, $mime) = @_;
163 $self->{mime} = $mime;
171 my ($self, $doc_id) = @_;
172 if (defined $doc_id) {
173 $self->{doc_id} = $doc_id;
175 # TODO load from xapian
182 my $tid = $self->{thread};
183 return $tid if defined $tid;
184 $self->{thread} = _get_term_val($self, 'G', qr/\AG/); # *G*roup
189 my $path = $self->{path};
190 return $path if defined $path;
191 $self->{path} = _get_term_val($self, 'XPATH', qr/\AXPATH/); # path