-# Copyright (C) 2015 all contributors <meta@public-inbox.org>
-# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
+# Copyright (C) 2015-2018 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+#
+# Used by the web interface to link to messages outside of the our
+# public-inboxes. Mail threads may cross projects/threads; so
+# we should ensure users can find more easily find them on other
+# sites.
package PublicInbox::ExtMsg;
use strict;
use warnings;
-use URI::Escape qw(uri_escape_utf8);
use PublicInbox::Hval;
-use PublicInbox::MID qw/mid_compress mid2path/;
+use PublicInbox::MID qw/mid2path/;
+use PublicInbox::WwwStream;
+
+# TODO: user-configurable
+our @EXT_URL = (
+ # leading "//" denotes protocol-relative (http:// or https://)
+ '//marc.info/?i=%s',
+ '//www.mail-archive.com/search?l=mid&q=%s',
+ 'http://mid.gmane.org/%s',
+ 'https://lists.debian.org/msgid-search/%s',
+ '//docs.FreeBSD.org/cgi/mid.cgi?db=mid&id=%s',
+ 'https://www.w3.org/mid/%s',
+ 'http://www.postgresql.org/message-id/%s',
+ 'https://lists.debconf.org/cgi-lurker/keyword.cgi?'.
+ 'doc-url=/lurker&format=en.html&query=id:%s'
+);
sub ext_msg {
my ($ctx) = @_;
- my $pi_config = $ctx->{pi_config};
- my $listname = $ctx->{listname};
+ my $cur = $ctx->{-inbox};
my $mid = $ctx->{mid};
- eval { require PublicInbox::Search };
- my $have_xap = $@ ? 0 : 1;
- my @nox;
+ eval { require PublicInbox::Msgmap };
+ my $have_mm = $@ ? 0 : 1;
+ my (@ibx, @found);
- foreach my $k (keys %$pi_config) {
- $k =~ /\Apublicinbox\.([A-Z0-9a-z-]+)\.url\z/ or next;
- my $list = $1;
- next if $list eq $listname;
+ $ctx->{www}->{pi_config}->each_inbox(sub {
+ my ($other) = @_;
+ return if $other->{name} eq $cur->{name} || !$other->base_url;
- my $git_dir = $pi_config->{"publicinbox.$list.mainrepo"};
- defined $git_dir or next;
+ my $mm = $other->mm or return;
- my $url = $pi_config->{"publicinbox.$list.url"};
- defined $url or next;
-
- $url =~ s!/+\z!!;
-
- # try to find the URL with Xapian to avoid forking
- if ($have_xap) {
- my $doc_id = eval {
- my $s = PublicInbox::Search->new($git_dir);
- $s->find_unique_doc_id('mid', $mid);
- };
- if ($@) {
- # xapian not configured for this repo
- } else {
- # maybe we found it!
- return r302($url, $mid) if (defined $doc_id);
-
- # no point in trying the fork fallback if we
- # know Xapian is up-to-date but missing the
- # message in the current repo
- next;
+ # try to find the URL with Msgmap to avoid forking
+ my $num = $mm->num_for($mid);
+ if (defined $num) {
+ push @found, $other;
+ } else {
+ # no point in trying the fork fallback if we
+ # know Xapian is up-to-date but missing the
+ # message in the current repo
+ push @ibx, $other;
+ }
+ });
+
+ return exact($ctx, \@found, $mid) if @found;
+
+ # fall back to partial MID matching
+ my $n_partial = 0;
+ my @partial;
+
+ if (my $mm = $cur->mm) {
+ my $tmp_mid = $mid;
+ my $res = $mm->mid_prefixes($tmp_mid, 100);
+ if ($res && scalar(@$res)) {
+ $n_partial += scalar(@$res);
+ push @partial, [ $cur, $res ];
+ # fixup common errors:
+ } elsif ($tmp_mid =~ s,/[tTf],,) {
+ $res = $mm->mid_prefixes($tmp_mid, 100);
+ if ($res && scalar(@$res)) {
+ $n_partial += scalar(@$res);
+ push @partial, [ $cur, $res ];
}
}
-
- # queue up for forking after we've tried Xapian on all of them
- push @nox, { git_dir => $git_dir, url => $url };
}
- # Xapian not installed or configured for some repos
- my $path = "HEAD:" . mid2path($mid);
-
- foreach my $n (@nox) {
- my @cmd = ('git', "--git-dir=$n->{git_dir}", 'cat-file',
- '-t', $path);
- my $pid = open my $fh, '-|';
- defined $pid or die "fork failed: $!\n";
-
- if ($pid == 0) {
- open STDERR, '>', '/dev/null'; # ignore errors
- exec @cmd or die "exec failed: $!\n";
- } else {
- my $type = eval { local $/; <$fh> };
- close $fh;
- if ($? == 0 && $type eq "blob\n") {
- return r302($n->{url}, $mid);
+ # can't find a partial match in current inbox, try the others:
+ if (!$n_partial && length($mid) >= 16) {
+ my $tmp_mid = $mid;
+again:
+ foreach my $ibx (@ibx) {
+ my $mm = $ibx->mm or next;
+ my $res = $mm->mid_prefixes($tmp_mid, 100);
+ if ($res && scalar(@$res)) {
+ $n_partial += scalar(@$res);
+ push @partial, [ $ibx, $res ];
+ last if $n_partial >= 100;
}
}
+ # fixup common errors:
+ if (!$n_partial && $tmp_mid =~ s,/[tTf],,) {
+ goto again;
+ }
}
- # Fall back to external repos
+ my $code = 404;
+ my $h = PublicInbox::Hval->new_msgid($mid);
+ my $href = $h->{href};
+ my $html = $h->as_html;
+ my $title = "<$html> not found";
+ my $s = "<pre>Message-ID <$html>\nnot found\n";
+ if ($n_partial) {
+ $code = 300;
+ my $es = $n_partial == 1 ? '' : 'es';
+ $s .= "\n$n_partial partial match$es found:\n\n";
+ my $cur_name = $cur->{name};
+ foreach my $pair (@partial) {
+ my ($ibx, $res) = @$pair;
+ my $env = $ctx->{env} if $ibx->{name} eq $cur_name;
+ my $u = $ibx->base_url($env) or next;
+ foreach my $m (@$res) {
+ my $p = PublicInbox::Hval->new_msgid($m);
+ my $r = $p->{href};
+ my $t = $p->as_html;
+ $s .= qq{<a\nhref="$u$r/">$u$t/</a>\n};
+ }
+ }
+ }
+ my $ext = ext_urls($ctx, $mid, $href, $html);
+ if ($ext ne '') {
+ $s .= $ext;
+ $code = 300;
+ }
+ $ctx->{-html_tip} = $s .= '</pre>';
+ $ctx->{-title_html} = $title;
+ $ctx->{-upfx} = '../';
+ PublicInbox::WwwStream->response($ctx, $code);
+}
- [404, ['Content-Type'=>'text/plain'], ['Not found']];
+sub ext_urls {
+ my ($ctx, $mid, $href, $html) = @_;
+
+ # Fall back to external repos if configured
+ if (@EXT_URL && index($mid, '@') >= 0) {
+ my $env = $ctx->{env};
+ my $e = "\nPerhaps try an external site:\n\n";
+ foreach my $url (@EXT_URL) {
+ my $u = PublicInbox::Hval::prurl($env, $url);
+ my $r = sprintf($u, $href);
+ my $t = sprintf($u, $html);
+ $e .= qq{<a\nhref="$r">$t</a>\n};
+ }
+ return $e;
+ }
+ ''
}
-# Redirect to another public-inbox which is mapped by $pi_config
-sub r302 {
- my ($url, $mid) = @_;
- $url .= '/' . uri_escape_utf8($mid) . '/';
- [ 302,
- [ 'Location' => $url, 'Content-Type' => 'text/plain' ],
- [ "Redirecting to\n$url\n" ] ]
+sub exact {
+ my ($ctx, $found, $mid) = @_;
+ my $h = PublicInbox::Hval->new_msgid($mid);
+ my $href = $h->{href};
+ my $html = $h->as_html;
+ my $title = "<$html> found in ";
+ my $end = @$found == 1 ? 'another inbox' : 'other inboxes';
+ $ctx->{-title_html} = $title . $end;
+ $ctx->{-upfx} = '../';
+ my $ext_urls = ext_urls($ctx, $mid, $href, $html);
+ my $code = (@$found == 1 && $ext_urls eq '') ? 200 : 300;
+ $ctx->{-html_tip} = join('',
+ "<pre>Message-ID: <$html>\nfound in $end:\n\n",
+ (map {
+ my $u = $_->base_url;
+ qq(<a\nhref="$u$href/">$u$html/</a>\n)
+ } @$found),
+ $ext_urls, '</pre>');
+ PublicInbox::WwwStream->response($ctx, $code);
}
1;