X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwStream.pm;h=985e02622048b4a2ada72510aa84d4ab6273d7be;hb=e6b159cf3dd1267ea76029fdbf3048488242ef14;hp=d9abb5ab8068756d51c3f5aaae5b9098703744ce;hpb=21b7f9f282bd6b877f1da7a9d0169ce958191a34;p=public-inbox.git diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm index d9abb5ab..985e0262 100644 --- a/lib/PublicInbox/WwwStream.pm +++ b/lib/PublicInbox/WwwStream.pm @@ -1,17 +1,38 @@ -# Copyright (C) 2016 all contributors +# Copyright (C) 2016-2020 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/README.html'; +use bytes (); # length +use PublicInbox::Hval qw(ascii_html prurl); +our $TOR_URL = 'https://www.torproject.org/'; +our $CODE_URL = 'https://public-inbox.org/public-inbox.git'; + +# noop for HTTP.pm (and any other PSGI servers) +sub close {} + +sub base_url ($) { + my $ctx = shift; + my $base_url = $ctx->{-inbox}->base_url($ctx->{env}); + chop $base_url; # no trailing slash for clone + $base_url; +} sub new { my ($class, $ctx, $cb) = @_; - bless { nr => 0, cb => $cb, ctx => $ctx }, $class; + + bless { + nr => 0, + cb => $cb, + ctx => $ctx, + base_url => base_url($ctx), + }, $class; } sub response { @@ -23,87 +44,145 @@ sub response { sub _html_top ($) { my ($self) = @_; my $ctx = $self->{ctx}; - my $obj = $ctx->{-inbox}; - my $desc = ascii_html($obj->description); - my $title = $ctx->{-title_html} || $desc; + my $ibx = $ctx->{-inbox}; + my $desc = ascii_html($ibx->description); + my $title = delete($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 $q_val = $ctx->{-q_value_html}; - if (defined $q_val && $q_val ne '') { - $q_val = qq(\nvalue="$q_val" ); - } else { - $q_val = ''; - } + my $top = "$desc"; + my $links = "help / ". + "color / ". + "Atom feed"; + if ($ibx->search) { + my $q_val = delete($ctx->{-q_value_html}) // ''; + $q_val = qq(\nvalue="$q_val") if $q_val ne ''; # XXX gross, for SearchView.pm - my $extra = $ctx->{-extra_form_html} || ''; + my $extra = delete($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 . - "". $top . $tip; + qq() . + $ctx->{www}->style($upfx) . + ''. $top . (delete($ctx->{-html_tip}) // ''); +} + +sub code_footer ($) { + my ($env) = @_; + my $u = prurl($env, $CODE_URL); + qq(AGPL code for this site: git clone $u) } sub _html_end { my ($self) = @_; - my $urls = 'Archives are clone-able:'; + my $urls = 'Archives are clonable:'; my $ctx = $self->{ctx}; - my $obj = $ctx->{-inbox}; - my $desc = ascii_html($obj->description); - - # FIXME: cleanup - my $env = $ctx->{env}; - my $scheme = $env->{'psgi.url_scheme'}; - my $host_port = $env->{HTTP_HOST} || - "$env->{SERVER_NAME}:$env->{SERVER_PORT}"; - my $http = "$scheme://$host_port".($env->{SCRIPT_NAME} || '/'); - $http = URI->new($http . $obj->{name})->canonical->as_string; - my %seen = ( $http => 1 ); - my @urls = ($http); - foreach my $u (@{$obj->cloneurl}) { - next if $seen{$u}; - $seen{$u} = 1; + my $ibx = $ctx->{-inbox}; + my $desc = ascii_html($ibx->description); + + my @urls; + my $http = $self->{base_url}; + my $max = $ibx->max_git_epoch; + my $dir = (split(m!/!, $http))[-1]; + my %seen = ($http => 1); + if (defined($max)) { # v2 + 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 + 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}++; 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 $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"; } - my $url = PublicInbox::Hval::prurl($ctx->{env}, PI_URL); - '
'.join("\n",
-		'- ' . $desc,
+	if ($urls =~ m!\b[^:]+://\w+\.onion/!) {
+		$urls .= "\n note: .onion URLs require Tor: ";
+		$urls .= qq[$TOR_URL];
+	}
+	'
'.join("\n\n",
+		$desc,
 		$urls,
-		'served with software from public-inbox: '
-			."$url",
+		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 {}
+sub oneshot {
+	my ($ctx, $code, $sref) = @_;
+	my $self = bless {
+		ctx => $ctx,
+		base_url => base_url($ctx),
+	}, __PACKAGE__;
+	my @x = (_html_top($self), $sref ? $$sref : (), _html_end($self));
+	my $len = 0;
+	$len += bytes::length($_) for @x;
+	[ $code, [
+		'Content-Type' => 'text/html; charset=UTF-8',
+		'Content-Length' => $len
+	], \@x ];
+}
 
 1;