X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FSearchMsg.pm;h=0fb2a07e43f5818f30acfe4ba4cfc8fdec60ce65;hb=23a4e44bedabe5b8b651346cabc2a870c5377a30;hp=a8f99bd5756d51179e9b7e998967ad755571907a;hpb=dbcc775378359cf41e57b9e9aa0ca6553722b479;p=public-inbox.git diff --git a/lib/PublicInbox/SearchMsg.pm b/lib/PublicInbox/SearchMsg.pm index a8f99bd5..0fb2a07e 100644 --- a/lib/PublicInbox/SearchMsg.pm +++ b/lib/PublicInbox/SearchMsg.pm @@ -1,18 +1,21 @@ -# Copyright (C) 2015, all contributors -# License: GPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +# Copyright (C) 2015-2016 all contributors +# License: AGPL-3.0+ # based on notmuch, but with no concept of folders, files or flags +# +# Wraps a document inside our Xapian search index. 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 mid_compress/; +use PublicInbox::MID qw/mid_clean/; +use PublicInbox::Address; 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'; +use POSIX qw(strftime); sub new { my ($class, $mime) = @_; @@ -27,44 +30,66 @@ sub wrap { bless { doc => $doc, mime => undef, mid => $mid }, $class; } +sub get_val ($$) { + my ($doc, $col) = @_; + Search::Xapian::sortable_unserialise($doc->get_value($col)); +} + sub load_doc { my ($class, $doc) = @_; my $data = $doc->get_data; + my $ts = get_val($doc, &PublicInbox::Search::TS); $data = $enc_utf8->decode($data); - my ($mid, $subj, $from, $date, $refs) = split(/\n/, $data); + my ($subj, $from, $refs, $to, $cc) = split(/\n/, $data); bless { doc => $doc, - mid => $mid, subject => $subj, - date => $date, - from_name => $from, - references_sorted => $refs, + ts => $ts, + from => $from, + references => $refs, + to => $to, + cc => $cc, }, $class; } -sub subject { +# :bytes and :lines metadata in RFC 3977 +sub bytes ($) { get_val($_[0]->{doc}, &PublicInbox::Search::BYTES) } +sub lines ($) { get_val($_[0]->{doc}, &PublicInbox::Search::LINES) } +sub num ($) { get_val($_[0]->{doc}, &PublicInbox::Search::NUM) } + +sub __hdr ($$) { + my ($self, $field) = @_; + my $val = $self->{$field}; + return $val if defined $val; + + my $mime = $self->{mime} or return; + $val = $mime->header($field); + $val = '' unless defined $val; + $val =~ tr/\n/ /; + $val =~ tr/\r//d; + $self->{$field} = $val; +} + +sub subject ($) { __hdr($_[0], 'subject') } +sub to ($) { __hdr($_[0], 'to') } +sub cc ($) { __hdr($_[0], 'cc') } + +sub date ($) { 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; + my $date = __hdr($self, 'date'); + return $date if defined $date; + my $ts = $self->{ts}; + return unless defined $ts; + $self->{date} = strftime('%a, %d %b %Y %T %z', gmtime($ts)); } -sub from { +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; + my $from = __hdr($self, 'from'); + if (defined $from && !defined $self->{from_name}) { + $self->{from_name} = PublicInbox::Address::from_name($from); } - $self->{from_name} = $from; - $self->{from}; + $from; } sub from_name { @@ -77,41 +102,24 @@ sub from_name { sub ts { my ($self) = @_; - my $ts = $self->{ts}; - return $ts if $ts; - $self->{ts} = eval { - str2time($self->date || $self->mime->header('Date')) - } || 0; -} - -sub date { - my ($self) = @_; - my $date = $self->{date}; - return $date if $date; - my $ts = eval { str2time($self->mime->header('Date')) }; - $self->{date} = POSIX::strftime('%Y-%m-%d %H:%M', gmtime($ts)); + $self->{ts} ||= eval { str2time($self->mime->header('Date')) } || 0; } sub to_doc_data { my ($self) = @_; - - $self->mid . "\n" . - $self->subject . "\n" . - $self->from_name . "\n". - $self->date . "\n" . - $self->references_sorted; + join("\n", $self->subject, $self->from, $self->references, + $self->to, $self->cc); } -sub references_sorted { +sub references { my ($self) = @_; - my $x = $self->{references_sorted}; + my $x = $self->{references}; defined $x ? $x : ''; } sub ensure_metadata { my ($self) = @_; my $doc = $self->{doc}; - my $i = $doc->termlist_begin; my $end = $doc->termlist_end; unless (defined $PFX2TERM_RE) { @@ -119,12 +127,17 @@ sub ensure_metadata { $PFX2TERM_RE = qr/\A($or)/; } - for (; $i != $end; $i->inc) { - my $val = $i->get_termname; + 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) { - my $field = $PublicInbox::Search::PFX2TERM_RMAP{$1}; - $self->{$field} = $val; + if ($val =~ s/$PFX2TERM_RE//o) { + $self->{$field} = $val; + } } } } @@ -134,36 +147,44 @@ sub mini_mime { my ($self) = @_; $self->ensure_metadata; my @h = ( - Subject => $self->subject, + 'Subject' => $self->subject, 'X-PI-From' => $self->from_name, - 'X-PI-Date' => $self->date, - 'X-PI-TS' => $self->ts, + # 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}) { + push @h, References => $refs; + } + my $mime = Email::MIME->create(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. - my $refs = $self->{references_sorted}; - my $mime = Email::MIME->create(header_str => \@h); - $mime->header_set('References', $refs) if (defined $refs); + # drop useless headers Email::MIME set for us + $h->header_set('Date'); + $h->header_set('MIME-Version'); $mime; } -sub mid { +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'); - $mid ? mid_compress(mid_clean($mid)) : $mid; -} +sub _extract_mid { mid_clean(mid_mime($_[0]->mime)) } sub mime { my ($self, $mime) = @_;