X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwStream.pm;h=6696cc35d4d1e24e402ab6ad49f03275a0761333;hp=285416d5df75b8f5c42a4cb9d79257fd71149578;hb=3c39f9c942a6975245fda878e9b957d8d3367662;hpb=bfd60ef4c2eff566481f1e40b18b7c3d1b3e43fa diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm index 285416d5..6696cc35 100644 --- a/lib/PublicInbox/WwwStream.pm +++ b/lib/PublicInbox/WwwStream.pm @@ -1,17 +1,33 @@ -# Copyright (C) 2016 all contributors +# Copyright (C) 2016-2019 all contributors # License: AGPL-3.0+ # # HTML body stream for which yields getline+close methods +# +# public-inbox-httpd favors "getline" response bodies to take a +# "pull"-based approach to feeding slow clients (as opposed to a +# more common "push" model) package PublicInbox::WwwStream; use strict; use warnings; use PublicInbox::Hval qw(ascii_html); -use URI; -use constant PI_URL => 'https://public-inbox.org/'; +our $TOR_URL = 'https://www.torproject.org/'; +our $CODE_URL = 'https://public-inbox.org/'; +our $PROJECT = 'public-inbox'; + +# noop for HTTP.pm (and any other PSGI servers) +sub close {} sub new { my ($class, $ctx, $cb) = @_; - bless { nr => 0, cb => $cb, ctx => $ctx }, $class; + + my $base_url = $ctx->{-inbox}->base_url($ctx->{env}); + chop $base_url; # no trailing slash for clone + bless { + nr => 0, + cb => $cb || *close, + ctx => $ctx, + base_url => $base_url, + }, $class; } sub response { @@ -23,17 +39,22 @@ sub response { sub _html_top ($) { my ($self) = @_; my $ctx = $self->{ctx}; - my $obj = $ctx->{-inbox}; - my $desc = ascii_html($obj->description); + my $ibx = $ctx->{-inbox}; + my $desc = ascii_html($ibx->description); my $title = $ctx->{-title_html} || $desc; my $upfx = $ctx->{-upfx} || ''; + my $help = $upfx.'_/text/help'; + my $color = $upfx.'_/text/color'; my $atom = $ctx->{-atom} || $upfx.'new.atom'; my $tip = $ctx->{-html_tip} || ''; - my $top = "$desc (Atom feed)"; - if ($obj->search) { + my $top = "$desc"; + my $links = "help / ". + "color / ". + "Atom feed"; + if ($ibx->search) { my $q_val = $ctx->{-q_value_html}; if (defined $q_val && $q_val ne '') { - $q_val = qq(\nvalue="$q_val" ); + $q_val = qq(\nvalue="$q_val"); } else { $q_val = ''; } @@ -41,64 +62,114 @@ sub _html_top ($) { my $extra = $ctx->{-extra_form_html} || ''; my $action = $upfx eq '' ? './' : $upfx; $top = qq{
$top} .
-			  qq{ } .
+			  qq{\n} .
 			  $extra .
 			  qq{} .
+			  ' ' . $links .
 			  q{
} } else { - $top = '
' . $top . '
'; + $top = '
' . $top . "\n" . $links . '
'; } "$title" . "" . - PublicInbox::Hval::STYLE . + $ctx->{www}->style($upfx) . "". $top . $tip; } +sub code_footer ($) { + my ($env) = @_; + my $u = PublicInbox::Hval::prurl($env, $CODE_URL); + qq(AGPL code for this site: git clone $u $PROJECT) +} + sub _html_end { my ($self) = @_; my $urls = 'Archives are clonable:'; my $ctx = $self->{ctx}; - my $obj = $ctx->{-inbox}; - my $desc = ascii_html($obj->description); - - my $http = $obj->base_url($ctx->{env}); - chop $http; - my %seen = ( $http => 1 ); - my @urls = ($http); - foreach my $u (@{$obj->cloneurl}) { + my $ibx = $ctx->{-inbox}; + my $desc = ascii_html($ibx->description); + + my (%seen, @urls); + my $http = $self->{base_url}; + my $max = $ibx->max_git_epoch; + my $dir = (split(m!/!, $http))[-1]; + if (defined($max)) { # v2 + $seen{$http} = 1; + for my $i (0..$max) { + # old parts my be deleted: + -d "$ibx->{inboxdir}/git/$i.git" or next; + my $url = "$http/$i"; + $seen{$url} = 1; + push @urls, "$url $dir/git/$i.git"; + } + } else { # v1 + $seen{$http} = 1; + push @urls, $http; + } + + # FIXME: epoch splits can be different in other repositories, + # use the "cloneurl" file as-is for now: + foreach my $u (@{$ibx->cloneurl}) { next if $seen{$u}; $seen{$u} = 1; push @urls, $u =~ /\Ahttps?:/ ? qq($u) : $u; } - if (scalar(@urls) == 1) { - $urls .= " git clone --mirror $http"; - } else { + + if (defined($max) || scalar(@urls) > 1) { $urls .= "\n" . join("\n", map { "\tgit clone --mirror $_" } @urls); + } else { + $urls .= " git clone --mirror $urls[0]"; + } + if (defined $max) { + my $addrs = $ibx->{address}; + $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY'; + $urls .= <{name} $dir/ $http \\ + $addrs + public-inbox-index $dir +EOF + } else { # v1 + $urls .= "\n"; } - my $url = PublicInbox::Hval::prurl($ctx->{env}, PI_URL); - '
'.join("\n",
-		'- ' . $desc,
+
+	my $cfg_link = ($ctx->{-upfx} // '').'_/text/config/raw';
+	$urls .= qq(\nExample config snippet for mirrors\n);
+	my @nntp = map { qq($_) } @{$ibx->nntp_url};
+	if (@nntp) {
+		$urls .= "\n";
+		$urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are';
+		$urls .= ' available over NNTP:';
+		$urls .= "\n\t" . join("\n\t", @nntp) . "\n";
+	}
+	if ($urls =~ m!\b[^:]+://\w+\.onion/!) {
+		$urls .= "\n note: .onion URLs require Tor: ";
+		$urls .= qq[$TOR_URL];
+	}
+	'
'.join("\n\n",
+		$desc,
 		$urls,
-		'Served with public-inbox: '.
-		qq(git clone $url public-inbox),
+		code_footer($ctx->{env})
 	).'
';
 }
 
+# callback for HTTP.pm (and any other PSGI servers)
 sub getline {
 	my ($self) = @_;
 	my $nr = $self->{nr}++;
 
 	return _html_top($self) if $nr == 0;
 
-	if (my $mid = $self->{cb}) { # middle
-		$mid = $mid->($nr, $self->{ctx}) and return $mid;
+	if (my $middle = $self->{cb}) {
+		$middle = $middle->($nr, $self->{ctx}) and return $middle;
 	}
 
 	delete $self->{cb} ? _html_end($self) : undef;
 }
 
-sub close {}
-
 1;