X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FWwwStream.pm;h=880639b73d99fc6c8d8c82c63ae50b1b89a25f48;hb=HEAD;hp=01f7b31ba186001723d21dcbe2d3291e5f4383bc;hpb=21f5b7a8bcd942b19475c1c0c265f39dfdf93608;p=public-inbox.git diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm index 01f7b31b..880639b7 100644 --- a/lib/PublicInbox/WwwStream.pm +++ b/lib/PublicInbox/WwwStream.pm @@ -1,53 +1,119 @@ -# Copyright (C) 2016 all contributors +# Copyright (C) all contributors # License: AGPL-3.0+ # -# HTML body stream for which yields getline+close methods +# HTML body stream for which yields getline+close methods for +# generic PSGI servers and callbacks for public-inbox-httpd. +# +# See PublicInbox::GzipFilter parent class for more info. package PublicInbox::WwwStream; use strict; -use warnings; -use PublicInbox::Hval qw(ascii_html); -use URI; -our $TOR_URL = 'https://www.torproject.org/'; -our $TOR2WEB_URL = 'https://www.tor2web.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 || *close, ctx => $ctx }, $class; +use v5.10.1; +use parent qw(Exporter PublicInbox::GzipFilter); +our @EXPORT_OK = qw(html_oneshot); +use PublicInbox::Hval qw(ascii_html prurl ts2str); + +our $CODE_URL = [ qw( +http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/public-inbox.git +https://public-inbox.org/public-inbox.git) ]; + +sub base_url ($) { + my $ctx = shift; + my $base_url = ($ctx->{ibx} // $ctx->{git})->base_url($ctx->{env}); + chop $base_url; # no trailing slash for clone + $base_url; +} + +sub init { + my ($ctx, $cb) = @_; + $ctx->{cb} = $cb; + $ctx->{base_url} = base_url($ctx); + $ctx->{-res_hdr} = [ 'Content-Type' => 'text/html; charset=UTF-8' ]; + $ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($ctx->{-res_hdr}, + $ctx->{env}); + bless $ctx, __PACKAGE__; } -sub response { - my ($class, $ctx, $code, $cb) = @_; - [ $code, [ 'Content-Type', 'text/html; charset=UTF-8' ], - $class->new($ctx, $cb) ] +sub async_eml { # for async_blob_cb + my ($ctx, $eml) = @_; + $ctx->write($ctx->{cb}->($ctx, $eml)); } -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; +sub html_repo_top ($) { + my ($ctx) = @_; + my $git = $ctx->{git}; + my $desc = ascii_html($git->description); + my $title = delete($ctx->{-title_html}) // $desc; + my $upfx = $ctx->{-upfx} // ''; + my $atom = $ctx->{-atom} // (substr($upfx, -1) eq '/' ? + "${upfx}atom/" : "$upfx/atom/"); + my $top = ascii_html($git->{nick}); + $top = qq($top) if length($upfx); + $top .= <about / heads / tags +$desc +EOM + my @url = PublicInbox::ViewVCS::ibx_url_for($ctx); + if (@url) { + $ctx->{-has_srch} = 1; + my $base_url = base_url($ctx); + my ($pfx, $sfx) = ($base_url =~ m!\A(https?://[^/]+/)(.*)\z!i); + my $iupfx = '../' x (($sfx =~ tr!/!/!) + 1); + $pfx = ascii_html($pfx); + $pfx = qr/\A\Q$pfx\E/i; + my $tmp = $top; + $top = ''; + my ($s, $u, $same_host); + my $q_val = delete($ctx->{-q_value_html}) // ''; + $q_val = qq(\nvalue="$q_val") if $q_val ne ''; + for (@url) { + $u = $s = ascii_html($_); + substr($u, 0, 0, $iupfx) if $u !~ m!://!; + $s =~ s!$pfx!!; + $s =~ s!/\z!!; + $top .= qq{
$tmp} .
+				qq{} .
+				qq{} .
+				q{
}; + $tmp = ''; + } + } else { + $top = "
$top
"; + } + "$title" . + qq() . + $ctx->{www}->style($upfx) . + ''.$top; +} + +sub html_top ($) { + my ($ctx) = @_; + my $ibx = $ctx->{ibx} // return html_repo_top($ctx); + my $desc = ascii_html($ibx->description); + my $title = delete($ctx->{-title_html}) // $desc; my $upfx = $ctx->{-upfx} || ''; - my $help = $upfx.'_/text/help'; my $atom = $ctx->{-atom} || $upfx.'new.atom'; - my $tip = $ctx->{-html_tip} || ''; my $top = "$desc"; - my $links = "help / ". - "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 = ''; - } + if (my $t_max = $ctx->{-t_max}) { + $t_max = ts2str($t_max); + $top = qq($top); + # we had some kind of query, link to /$INBOX/?t=YYYYMMDDhhmmss + } elsif ($ctx->{qp}->{t}) { + $top = qq($top); + } elsif (length($upfx)) { + $top = qq($top); + } + my $code = $ibx->{coderepo} ? qq( / code) : ''; + # id=mirror must exist for legacy bookmarks + my $links = qq(Atom feed); + if ($ibx->isrch) { + 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{\n} .
@@ -59,71 +125,153 @@ sub _html_top ($) {
 		$top = '
' . $top . "\n" . $links . '
'; } "$title" . - "" . - PublicInbox::Hval::STYLE . - "". $top . $tip; + qq() . + $ctx->{www}->style($upfx) . + ''. $top . (delete($ctx->{-html_tip}) // ''); } -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}) { - next if $seen{$u}; - $seen{$u} = 1; - push @urls, $u =~ /\Ahttps?:/ ? qq($u) : $u; - } - if (scalar(@urls) == 1) { - $urls .= " git clone --mirror $http"; - } else { - $urls .= "\n" . - join("\n", map { "\tgit clone --mirror $_" } @urls); - } +sub inboxes { () } # TODO - my @nntp = map { qq($_) } @{$obj->nntp_url}; - if (@nntp) { - $urls .= "\n\n"; - $urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are'; - $urls .= ' available over NNTP:'; - $urls .= "\n\t" . join("\n\t", @nntp) . "\n"; +sub coderepos ($) { + my ($ctx) = @_; + $ctx->{ibx} // return inboxes($ctx); + my $cr = $ctx->{ibx}->{coderepo} // return (); + my $upfx = ($ctx->{-upfx} // ''). '../'; + my $pfx = $ctx->{base_url} //= $ctx->base_url; + my $up = $upfx =~ tr!/!/!; + $pfx =~ s!/[^/]+\z!/! for (1..$up); + $pfx .= '/' if substr($pfx, -1, 1) ne '/'; + my $buf = '' . + 'Code repositories for project(s) associated with this '. + $ctx->{ibx}->thing_type . "\n"; + for my $git (@{$ctx->{www}->{pi_cfg}->repo_objs($ctx->{ibx})}) { + for ($git->pub_urls($ctx->{env})) { + my $u = m!\A(?:[a-z\+]+:)?//!i ? $_ : $pfx.$_; + $u = ascii_html(prurl($ctx->{env}, $u)); + $buf .= qq(\n\t$u); + } } - if ($urls =~ m!\b[^:]+://\w+\.onion/!) { - $urls .= "\n note: .onion URLs require Tor: "; - $urls .= qq[$TOR_URL]; - if ($TOR2WEB_URL) { - $urls .= "\n or Tor2web: "; - $urls .= qq[$TOR2WEB_URL]; + ($buf); +} + +sub _html_end { + return ''; + my ($ctx) = @_; + my $upfx = $ctx->{-upfx} || ''; + my $m = "${upfx}_/text/mirror/"; + my $x = ''; + if ($ctx->{ibx} && $ctx->{ibx}->can('cloneurl')) { + $x = <mirroring instructions +for how to clone and mirror all data and code used for this inbox +EOF + my $has_nntp = @{$ctx->{ibx}->nntp_url($ctx)}; + my $has_imap = @{$ctx->{ibx}->imap_url($ctx)}; + if ($has_nntp || $has_imap) { + substr($x, -1, 1) = ";\n"; # s/\n/;\n + if ($has_nntp && $has_imap) { + $x .= <{ibx}) { # extindex + $x = <mirroring instructions on how to clone and mirror +all data and code used by this external index. +EOF + } elsif ($ctx->{git}) { # coderepo + $x = join('', map { "git clone $_\n" } + @{$ctx->{git}->cloneurl($ctx->{env})}); } - my $url = PublicInbox::Hval::prurl($ctx->{env}, $CODE_URL); - '
'.join("\n\n",
-		$desc,
-		$urls,
-		'AGPL code for this site: '.
-		qq(git clone $url $PROJECT)
-	).'
'; + chomp $x; + '
'.join("\n\n", coderepos($ctx), $x).'
' } # callback for HTTP.pm (and any other PSGI servers) sub getline { - my ($self) = @_; - my $nr = $self->{nr}++; + my ($ctx) = @_; + my $cb = $ctx->{cb} or return; + while (defined(my $x = $cb->($ctx))) { # x = smsg or scalar non-ref + if (ref($x)) { # smsg + my $eml = $ctx->{ibx}->smsg_eml($x) or next; + $ctx->{smsg} = $x; + return $ctx->translate($cb->($ctx, $eml)); + } else { # scalar + return $ctx->translate($x); + } + } + delete $ctx->{cb}; + $ctx->zflush(_html_end($ctx)); +} - return _html_top($self) if $nr == 0; +sub html_done ($;@) { + my $ctx = $_[0]; + my $bdy = $ctx->zflush(@_[1..$#_], _html_end($ctx)); + my $res_hdr = delete $ctx->{-res_hdr}; + push @$res_hdr, 'Content-Length', length($bdy); + [ 200, $res_hdr, [ $bdy ] ] +} - if (my $middle = $self->{cb}) { - $middle = $middle->($nr, $self->{ctx}) and return $middle; - } +sub html_oneshot ($$;@) { + my ($ctx, $code) = @_[0, 1]; + my $res_hdr = [ 'Content-Type' => 'text/html; charset=UTF-8', + 'Content-Length' => undef ]; + bless $ctx, __PACKAGE__; + $ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($res_hdr, $ctx->{env}); + my @top; + $ctx->{base_url} // do { + @top = html_top($ctx); + $ctx->{base_url} = base_url($ctx); + }; + my $bdy = $ctx->zflush(@top, @_[2..$#_], _html_end($ctx)); + $res_hdr->[3] = length($bdy); + [ $code, $res_hdr, [ $bdy ] ] +} + +sub async_next ($) { + my ($http) = @_; # PublicInbox::HTTP + my $ctx = $http->{forward} or return; + eval { + if (my $smsg = $ctx->{smsg} = $ctx->{cb}->($ctx)) { + $ctx->smsg_blob($smsg); + } else { + $ctx->write(_html_end($ctx)); + $ctx->close; # GzipFilter->close + } + }; + warn "E: $@" if $@; +} + +sub aresponse { + my ($ctx, $cb) = @_; + init($ctx, $cb); + $ctx->psgi_response(200, delete $ctx->{-res_hdr}); +} + +sub html_init { + my ($ctx) = @_; + $ctx->{base_url} = base_url($ctx); + my $h = $ctx->{-res_hdr} = ['Content-Type', 'text/html; charset=UTF-8']; + $ctx->{gz} = PublicInbox::GzipFilter::gz_or_noop($h, $ctx->{env}); + bless $ctx, __PACKAGE__; + print { $ctx->zfh } html_top($ctx); +} - delete $self->{cb} ? _html_end($self) : undef; +sub DESTROY { + my ($ctx) = @_; + $ctx->{git}->cleanup if $ctx->{git} && $ctx->{git}->{-tmp}; } 1;