]> Sergey Matveev's repositories - public-inbox.git/blob - lib/PublicInbox/SearchIdx.pm
44f6bc1728a986e8259756da77773538a510d38b
[public-inbox.git] / lib / PublicInbox / SearchIdx.pm
1 # Copyright (C) 2015 all contributors <meta@public-inbox.org>
2 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
3 # based on notmuch, but with no concept of folders, files or flags
4 package PublicInbox::SearchIdx;
5 use strict;
6 use warnings;
7 use base qw(PublicInbox::Search);
8 use PublicInbox::MID qw/mid_clean mid_compress/;
9 *xpfx = *PublicInbox::Search::xpfx;
10
11 use constant {
12         PERM_UMASK => 0,
13         OLD_PERM_GROUP => 1,
14         OLD_PERM_EVERYBODY => 2,
15         PERM_GROUP => 0660,
16         PERM_EVERYBODY => 0664,
17 };
18
19 sub new {
20         my ($class, $git_dir, $writable) = @_;
21         my $dir = $class->xdir($git_dir);
22         require Search::Xapian::WritableDatabase;
23         my $flag = Search::Xapian::DB_OPEN;
24         my $self = bless { git_dir => $git_dir }, $class;
25         my $perm = $self->_git_config_perm;
26         my $umask = _umask_for($perm);
27         $self->{umask} = $umask;
28         $self->{xdb} = $self->with_umask(sub {
29                 if ($writable == 1) {
30                         require File::Path;
31                         File::Path::mkpath($dir);
32                         $flag = Search::Xapian::DB_CREATE_OR_OPEN;
33                 }
34                 Search::Xapian::WritableDatabase->new($dir, $flag);
35         });
36         $self;
37 }
38
39 sub add_message {
40         my ($self, $mime) = @_; # mime = Email::MIME object
41         my $db = $self->{xdb};
42
43         my $doc_id;
44         my $mid = mid_clean($mime->header('Message-ID'));
45         my $was_ghost = 0;
46         my $ct_msg = $mime->header('Content-Type') || 'text/plain';
47
48         eval {
49                 my $smsg = $self->lookup_message($mid);
50                 my $doc;
51
52                 if ($smsg) {
53                         $smsg->ensure_metadata;
54                         # convert a ghost to a regular message
55                         # it will also clobber any existing regular message
56                         $smsg->mime($mime);
57                         $doc = $smsg->{doc};
58
59                         my $type = xpfx('type');
60                         eval {
61                                 $doc->remove_term($type . 'ghost');
62                                 $was_ghost = 1;
63                         };
64
65                         # probably does not exist:
66                         eval { $doc->remove_term($type . 'mail') };
67                         $doc->add_term($type . 'mail');
68                 }  else {
69                         $smsg = PublicInbox::SearchMsg->new($mime);
70                         $doc = $smsg->{doc};
71                         $doc->add_term(xpfx('mid') . $mid);
72                 }
73
74                 my $subj = $smsg->subject;
75
76                 if ($subj ne '') {
77                         $doc->add_term(xpfx('subject') . $subj);
78
79                         my $path = $self->subject_path($subj);
80                         $doc->add_term(xpfx('path') . mid_compress($path));
81                 }
82
83                 my $ts = Search::Xapian::sortable_serialise($smsg->ts);
84                 $doc->add_value(PublicInbox::Search::TS, $ts);
85
86                 my $tg = $self->term_generator;
87
88                 $tg->set_document($doc);
89                 $tg->index_text($subj, 1, 'S') if $subj;
90                 $tg->increase_termpos;
91                 $tg->index_text($subj) if $subj;
92                 $tg->increase_termpos;
93
94                 $tg->index_text($smsg->from->format);
95                 $tg->increase_termpos;
96
97                 $mime->walk_parts(sub {
98                         my ($part) = @_;
99                         return if $part->subparts; # walk_parts already recurses
100                         my $ct = $part->content_type || $ct_msg;
101
102                         # account for filter bugs...
103                         $ct =~ m!\btext/plain\b!i or return;
104
105                         my (@orig, @quot);
106                         my $body = $part->body;
107                         $part->body_set('');
108                         my @lines = split(/\n/, $body);
109                         while (defined(my $l = shift @lines)) {
110                                 if ($l =~ /^\s*>/) {
111                                         push @quot, $l;
112                                 } else {
113                                         push @orig, $l;
114                                 }
115                         }
116                         if (@quot) {
117                                 $tg->index_text(join("\n", @quot), 0);
118                                 @quot = ();
119                                 $tg->increase_termpos;
120                         }
121                         if (@orig) {
122                                 $tg->index_text(join("\n", @orig));
123                                 @orig = ();
124                                 $tg->increase_termpos;
125                         }
126                 });
127
128                 if ($was_ghost) {
129                         $doc_id = $smsg->doc_id;
130                         $self->link_message($smsg, 0);
131                         $doc->set_data($smsg->to_doc_data);
132                         $db->replace_document($doc_id, $doc);
133                 } else {
134                         $self->link_message($smsg, 0);
135                         $doc->set_data($smsg->to_doc_data);
136                         $doc_id = $db->add_document($doc);
137                 }
138         };
139
140         if ($@) {
141                 warn "failed to index message <$mid>: $@\n";
142                 return undef;
143         }
144         $doc_id;
145 }
146
147 # returns deleted doc_id on success, undef on missing
148 sub remove_message {
149         my ($self, $mid) = @_;
150         my $db = $self->{xdb};
151         my $doc_id;
152         $mid = mid_clean($mid);
153
154         eval {
155                 $doc_id = $self->find_unique_doc_id('mid', $mid);
156                 $db->delete_document($doc_id) if defined $doc_id;
157         };
158
159         if ($@) {
160                 warn "failed to remove message <$mid>: $@\n";
161                 return undef;
162         }
163         $doc_id;
164 }
165
166 sub term_generator { # write-only
167         my ($self) = @_;
168
169         my $tg = $self->{term_generator};
170         return $tg if $tg;
171
172         $tg = Search::Xapian::TermGenerator->new;
173         $tg->set_stemmer($self->stemmer);
174
175         $self->{term_generator} = $tg;
176 }
177
178 sub next_doc_id { $_[0]->{xdb}->get_lastdocid + 1 }
179
180 # increments last_thread_id counter
181 # returns a 64-bit integer represented as a hex string
182 sub next_thread_id {
183         my ($self) = @_;
184         my $db = $self->{xdb};
185         my $last_thread_id = int($db->get_metadata('last_thread_id') || 0);
186
187         $db->set_metadata('last_thread_id', ++$last_thread_id);
188
189         $last_thread_id;
190 }
191
192 sub link_message {
193         my ($self, $smsg, $is_ghost) = @_;
194
195         if ($is_ghost) {
196                 $smsg->ensure_metadata;
197         } else {
198                 $self->link_message_to_parents($smsg);
199         }
200 }
201
202 sub link_message_to_parents {
203         my ($self, $smsg) = @_;
204         my $doc = $smsg->{doc};
205         my $mid = $smsg->mid;
206         my $mime = $smsg->mime;
207         my $refs = $mime->header('References');
208         my @refs = $refs ? ($refs =~ /<([^>]+)>/g) : ();
209         if (my $irt = $mime->header('In-Reply-To')) {
210                 # last References should be $irt
211                 # we will de-dupe later
212                 push @refs, mid_clean($irt);
213         }
214
215         my $tid;
216         if (@refs) {
217                 my %uniq = ($mid => 1);
218                 my @orig_refs = @refs;
219                 @refs = ();
220
221                 # prevent circular references via References: here:
222                 foreach my $ref (@orig_refs) {
223                         next if $uniq{$ref};
224                         $uniq{$ref} = 1;
225                         push @refs, $ref;
226                 }
227         }
228         if (@refs) {
229                 $smsg->{references_sorted} = '<'.join('><', @refs).'>';
230
231                 # first ref *should* be the thread root,
232                 # but we can never trust clients to do the right thing
233                 my $ref = shift @refs;
234                 $tid = $self->_resolve_mid_to_tid($ref);
235
236                 # the rest of the refs should point to this tid:
237                 foreach $ref (@refs) {
238                         my $ptid = $self->_resolve_mid_to_tid($ref);
239                         if ($tid ne $ptid) {
240                                 $self->merge_threads($tid, $ptid);
241                         }
242                 }
243         } else {
244                 $tid = $self->next_thread_id;
245         }
246         $doc->add_term(xpfx('thread') . $tid);
247 }
248
249 sub index_blob {
250         my ($self, $git, $blob) = @_;
251         my $mime = do_cat_mail($git, $blob) or return;
252         eval { $self->add_message($mime) };
253         warn "W: index_blob $blob: $@\n" if $@;
254 }
255
256 sub unindex_blob {
257         my ($self, $git, $blob) = @_;
258         my $mime = do_cat_mail($git, $blob) or return;
259         my $mid = $mime->header('Message-ID');
260         eval { $self->remove_message($mid) } if defined $mid;
261         warn "W: unindex_blob $blob: $@\n" if $@;
262 }
263
264 sub do_cat_mail {
265         my ($git, $blob) = @_;
266         my $mime = eval {
267                 my $str = $git->cat_file($blob);
268                 Email::MIME->new($str);
269         };
270         $@ ? undef : $mime;
271 }
272
273 sub index_sync {
274         my ($self, $head) = @_;
275         $self->with_umask(sub { $self->_index_sync($head) });
276 }
277
278 sub rlog {
279         my ($self, $range, $add_cb, $del_cb) = @_;
280         my $hex = '[a-f0-9]';
281         my $h40 = $hex .'{40}';
282         my $addmsg = qr!^:000000 100644 \S+ ($h40) A\t${hex}{2}/${hex}{38}$!;
283         my $delmsg = qr!^:100644 000000 ($h40) \S+ D\t${hex}{2}/${hex}{38}$!;
284         my $git_dir = $self->{git_dir};
285         require PublicInbox::GitCatFile;
286         my $git = PublicInbox::GitCatFile->new($git_dir);
287         my @cmd = ('git', "--git-dir=$git_dir", "log",
288                     qw/--reverse --no-notes --no-color --raw -r --no-abbrev/,
289                     $range);
290         my $latest;
291         my $pid = open(my $log, '-|', @cmd) or
292                 die('open` '.join(' ', @cmd) . " pipe failed: $!\n");
293         while (my $line = <$log>) {
294                 if ($line =~ /$addmsg/o) {
295                         $add_cb->($self, $git, $1);
296                 } elsif ($line =~ /$delmsg/o) {
297                         $del_cb->($self, $git, $1);
298                 } elsif ($line =~ /^commit ($h40)/o) {
299                         $latest = $1;
300                 }
301         }
302         close $log;
303         $latest;
304 }
305
306 # indexes all unindexed messages
307 sub _index_sync {
308         my ($self, $head) = @_;
309         my $db = $self->{xdb};
310         $head ||= 'HEAD';
311
312         $db->begin_transaction;
313         eval {
314                 my $latest = $db->get_metadata('last_commit');
315                 my $range = $latest eq '' ? $head : "$latest..$head";
316                 $latest = $self->rlog($range, *index_blob, *unindex_blob);
317                 $db->set_metadata('last_commit', $latest) if defined $latest;
318         };
319         if ($@) {
320                 warn "indexing failed: $@\n";
321                 $db->cancel_transaction;
322         } else {
323                 $db->commit_transaction;
324         }
325 }
326
327 # this will create a ghost as necessary
328 sub _resolve_mid_to_tid {
329         my ($self, $mid) = @_;
330
331         my $smsg = $self->lookup_message($mid) || $self->create_ghost($mid);
332         $smsg->thread_id;
333 }
334
335 sub create_ghost {
336         my ($self, $mid, $tid) = @_;
337
338         $tid = $self->next_thread_id unless defined $tid;
339
340         my $doc = Search::Xapian::Document->new;
341         $doc->add_term(xpfx('mid') . $mid);
342         $doc->add_term(xpfx('thread') . $tid);
343         $doc->add_term(xpfx('type') . 'ghost');
344
345         my $smsg = PublicInbox::SearchMsg->wrap($doc, $mid);
346         $self->link_message($smsg, 1);
347         $self->{xdb}->add_document($doc);
348
349         $smsg;
350 }
351
352 sub merge_threads {
353         my ($self, $winner_tid, $loser_tid) = @_;
354         my ($head, $tail) = $self->find_doc_ids('thread', $loser_tid);
355         my $thread_pfx = xpfx('thread');
356         my $db = $self->{xdb};
357
358         for (; $head != $tail; $head->inc) {
359                 my $docid = $head->get_docid;
360                 my $doc = $db->get_document($docid);
361                 $doc->remove_term($thread_pfx . $loser_tid);
362                 $doc->add_term($thread_pfx . $winner_tid);
363                 $db->replace_document($docid, $doc);
364         }
365 }
366
367 sub _read_git_config_perm {
368         my ($self) = @_;
369         my @cmd = ('git', "--git-dir=$self->{git_dir}",
370                    qw(config core.sharedRepository));
371         my $pid = open(my $fh, '-|', @cmd) or
372                 die('open `'.join(' ', @cmd) . " pipe failed: $!\n");
373         my $perm = <$fh>;
374         close $fh;
375         chomp $perm if defined $perm;
376         $perm;
377 }
378
379 sub _git_config_perm {
380         my $self = shift;
381         my $perm = scalar @_ ? $_[0] : _read_git_config_perm($self);
382         return PERM_GROUP if (!defined($perm) || $perm eq '');
383         return PERM_UMASK if ($perm eq 'umask');
384         return PERM_GROUP if ($perm eq 'group');
385         if ($perm =~ /\A(?:all|world|everybody)\z/) {
386                 return PERM_EVERYBODY;
387         }
388         return PERM_GROUP if ($perm =~ /\A(?:true|yes|on|1)\z/);
389         return PERM_UMASK if ($perm =~ /\A(?:false|no|off|0)\z/);
390
391         my $i = oct($perm);
392         return PERM_UMASK if ($i == PERM_UMASK);
393         return PERM_GROUP if ($i == OLD_PERM_GROUP);
394         return PERM_EVERYBODY if ($i == OLD_PERM_EVERYBODY);
395
396         if (($i & 0600) != 0600) {
397                 die "core.sharedRepository mode invalid: ".
398                     sprintf('%.3o', $i) . "\nOwner must have permissions\n";
399         }
400         ($i & 0666);
401 }
402
403 sub _umask_for {
404         my ($perm) = @_; # _git_config_perm return value
405         my $rv = $perm;
406         return umask if $rv == 0;
407
408         # set +x bit if +r or +w were set
409         $rv |= 0100 if ($rv & 0600);
410         $rv |= 0010 if ($rv & 0060);
411         $rv |= 0001 if ($rv & 0006);
412         (~$rv & 0777);
413 }
414
415 sub with_umask {
416         my ($self, $cb) = @_;
417         my $old = umask $self->{umask};
418         my $rv = eval { $cb->() };
419         my $err = $@;
420         umask $old;
421         die $err if $@;
422         $rv;
423 }
424
425 1;