1 # Copyright (C) 2016-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # HTML body stream for which yields getline+close methods
6 # public-inbox-httpd favors "getline" response bodies to take a
7 # "pull"-based approach to feeding slow clients (as opposed to a
8 # more common "push" model)
9 package PublicInbox::WwwStream;
12 use PublicInbox::Hval qw(ascii_html prurl);
13 our $TOR_URL = 'https://www.torproject.org/';
14 our $CODE_URL = 'https://public-inbox.org/public-inbox.git';
16 # noop for HTTP.pm (and any other PSGI servers)
20 my ($class, $ctx, $cb) = @_;
22 my $base_url = $ctx->{-inbox}->base_url($ctx->{env});
23 chop $base_url; # no trailing slash for clone
28 base_url => $base_url,
33 my ($class, $ctx, $code, $cb) = @_;
34 [ $code, [ 'Content-Type', 'text/html; charset=UTF-8' ],
35 $class->new($ctx, $cb) ]
40 my $ctx = $self->{ctx};
41 my $ibx = $ctx->{-inbox};
42 my $desc = ascii_html($ibx->description);
43 my $title = delete($ctx->{-title_html}) // $desc;
44 my $upfx = $ctx->{-upfx} || '';
45 my $help = $upfx.'_/text/help';
46 my $color = $upfx.'_/text/color';
47 my $atom = $ctx->{-atom} || $upfx.'new.atom';
48 my $top = "<b>$desc</b>";
49 my $links = "<a\nhref=\"$help\">help</a> / ".
50 "<a\nhref=\"$color\">color</a> / ".
51 "<a\nhref=\"$atom\">Atom feed</a>";
53 my $q_val = delete($ctx->{-q_value_html}) // '';
54 $q_val = qq(\nvalue="$q_val") if $q_val ne '';
55 # XXX gross, for SearchView.pm
56 my $extra = delete($ctx->{-extra_form_html}) // '';
57 my $action = $upfx eq '' ? './' : $upfx;
58 $top = qq{<form\naction="$action"><pre>$top} .
59 qq{\n<input\nname=q\ntype=text$q_val />} .
61 qq{<input\ntype=submit\nvalue=search />} .
65 $top = '<pre>' . $top . "\n" . $links . '</pre>';
67 "<html><head><title>$title</title>" .
68 qq(<link\nrel=alternate\ntitle="Atom feed"\n).
69 qq(href="$atom"\ntype="application/atom+xml"/>) .
70 $ctx->{www}->style($upfx) .
71 '</head><body>'. $top . (delete($ctx->{-html_tip}) // '');
76 my $u = prurl($env, $CODE_URL);
77 qq(AGPL code for this site: git clone <a\nhref="$u">$u</a>)
82 my $urls = 'Archives are clonable:';
83 my $ctx = $self->{ctx};
84 my $ibx = $ctx->{-inbox};
85 my $desc = ascii_html($ibx->description);
88 my $http = $self->{base_url};
89 my $max = $ibx->max_git_epoch;
90 my $dir = (split(m!/!, $http))[-1];
91 my %seen = ($http => 1);
92 if (defined($max)) { # v2
94 # old parts my be deleted:
95 -d "$ibx->{inboxdir}/git/$i.git" or next;
98 push @urls, "$url $dir/git/$i.git";
104 # FIXME: epoch splits can be different in other repositories,
105 # use the "cloneurl" file as-is for now:
106 foreach my $u (@{$ibx->cloneurl}) {
108 push @urls, $u =~ /\Ahttps?:/ ? qq(<a\nhref="$u">$u</a>) : $u;
111 if (defined($max) || scalar(@urls) > 1) {
113 join("\n", map { "\tgit clone --mirror $_" } @urls);
115 $urls .= " git clone --mirror $urls[0]";
118 my $addrs = $ibx->{address};
119 $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY';
123 # If you have public-inbox 1.1+ installed, you may
124 # initialize and index your mirror using the following commands:
125 public-inbox-init -V2 $ibx->{name} $dir/ $http \\
127 public-inbox-index $dir
133 my $cfg_link = ($ctx->{-upfx} // '').'_/text/config/raw';
134 $urls .= qq(\nExample <a\nhref="$cfg_link">config snippet</a> for mirrors\n);
135 my @nntp = map { qq(<a\nhref="$_">$_</a>) } @{$ibx->nntp_url};
138 $urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are';
139 $urls .= ' available over NNTP:';
140 $urls .= "\n\t" . join("\n\t", @nntp) . "\n";
142 if ($urls =~ m!\b[^:]+://\w+\.onion/!) {
143 $urls .= "\n note: .onion URLs require Tor: ";
144 $urls .= qq[<a\nhref="$TOR_URL">$TOR_URL</a>];
146 '<hr><pre>'.join("\n\n",
149 code_footer($ctx->{env})
150 ).'</pre></body></html>';
153 # callback for HTTP.pm (and any other PSGI servers)
156 my $nr = $self->{nr}++;
158 return _html_top($self) if $nr == 0;
160 if (my $middle = $self->{cb}) {
161 $middle = $middle->($nr, $self->{ctx}) and return $middle;
164 delete $self->{cb} ? _html_end($self) : undef;