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)
21 my $base_url = $ctx->{-inbox}->base_url($ctx->{env});
22 chop $base_url; # no trailing slash for clone
27 my ($class, $ctx, $cb) = @_;
33 base_url => base_url($ctx),
38 my ($class, $ctx, $code, $cb) = @_;
39 [ $code, [ 'Content-Type', 'text/html; charset=UTF-8' ],
40 $class->new($ctx, $cb) ]
45 my $ctx = $self->{ctx};
46 my $ibx = $ctx->{-inbox};
47 my $desc = ascii_html($ibx->description);
48 my $title = delete($ctx->{-title_html}) // $desc;
49 my $upfx = $ctx->{-upfx} || '';
50 my $help = $upfx.'_/text/help';
51 my $color = $upfx.'_/text/color';
52 my $atom = $ctx->{-atom} || $upfx.'new.atom';
53 my $top = "<b>$desc</b>";
54 my $links = "<a\nhref=\"$help\">help</a> / ".
55 "<a\nhref=\"$color\">color</a> / ".
56 "<a\nhref=\"$atom\">Atom feed</a>";
58 my $q_val = delete($ctx->{-q_value_html}) // '';
59 $q_val = qq(\nvalue="$q_val") if $q_val ne '';
60 # XXX gross, for SearchView.pm
61 my $extra = delete($ctx->{-extra_form_html}) // '';
62 my $action = $upfx eq '' ? './' : $upfx;
63 $top = qq{<form\naction="$action"><pre>$top} .
64 qq{\n<input\nname=q\ntype=text$q_val />} .
66 qq{<input\ntype=submit\nvalue=search />} .
70 $top = '<pre>' . $top . "\n" . $links . '</pre>';
72 "<html><head><title>$title</title>" .
73 qq(<link\nrel=alternate\ntitle="Atom feed"\n).
74 qq(href="$atom"\ntype="application/atom+xml"/>) .
75 $ctx->{www}->style($upfx) .
76 '</head><body>'. $top . (delete($ctx->{-html_tip}) // '');
81 my $u = prurl($env, $CODE_URL);
82 qq(AGPL code for this site: git clone <a\nhref="$u">$u</a>)
87 my $urls = 'Archives are clonable:';
88 my $ctx = $self->{ctx};
89 my $ibx = $ctx->{-inbox};
90 my $desc = ascii_html($ibx->description);
93 my $http = $self->{base_url};
94 my $max = $ibx->max_git_epoch;
95 my $dir = (split(m!/!, $http))[-1];
96 my %seen = ($http => 1);
97 if (defined($max)) { # v2
99 # old parts my be deleted:
100 -d "$ibx->{inboxdir}/git/$i.git" or next;
101 my $url = "$http/$i";
103 push @urls, "$url $dir/git/$i.git";
109 # FIXME: epoch splits can be different in other repositories,
110 # use the "cloneurl" file as-is for now:
111 foreach my $u (@{$ibx->cloneurl}) {
113 push @urls, $u =~ /\Ahttps?:/ ? qq(<a\nhref="$u">$u</a>) : $u;
116 if (defined($max) || scalar(@urls) > 1) {
118 join("\n", map { "\tgit clone --mirror $_" } @urls);
120 $urls .= " git clone --mirror $urls[0]";
123 my $addrs = $ibx->{address};
124 $addrs = join(' ', @$addrs) if ref($addrs) eq 'ARRAY';
128 # If you have public-inbox 1.1+ installed, you may
129 # initialize and index your mirror using the following commands:
130 public-inbox-init -V2 $ibx->{name} $dir/ $http \\
132 public-inbox-index $dir
138 my $cfg_link = ($ctx->{-upfx} // '').'_/text/config/raw';
139 $urls .= qq(\nExample <a\nhref="$cfg_link">config snippet</a> for mirrors\n);
140 my @nntp = map { qq(<a\nhref="$_">$_</a>) } @{$ibx->nntp_url};
143 $urls .= @nntp == 1 ? 'Newsgroup' : 'Newsgroups are';
144 $urls .= ' available over NNTP:';
145 $urls .= "\n\t" . join("\n\t", @nntp) . "\n";
147 if ($urls =~ m!\b[^:]+://\w+\.onion/!) {
148 $urls .= "\n note: .onion URLs require Tor: ";
149 $urls .= qq[<a\nhref="$TOR_URL">$TOR_URL</a>];
151 '<hr><pre>'.join("\n\n",
154 code_footer($ctx->{env})
155 ).'</pre></body></html>';
158 # callback for HTTP.pm (and any other PSGI servers)
161 my $nr = $self->{nr}++;
163 return _html_top($self) if $nr == 0;
165 if (my $middle = $self->{cb}) {
166 $middle = $middle->($nr, $self->{ctx}) and return $middle;
169 delete $self->{cb} ? _html_end($self) : undef;
173 my ($ctx, $code, $strref) = @_;
176 base_url => base_url($ctx),
178 [ $code, [ 'Content-Type', 'text/html; charset=UTF-8' ], [
179 _html_top($self), $strref ? $$strref : (), _html_end($self)