1 # Copyright (C) all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Standalone code repository viewer for users w/o cgit.
5 # This isn't intended to replicate all of cgit, but merely to be a
6 # "good enough" viewer with search support and some UI hints to encourage
7 # cloning + command-line usage.
8 package PublicInbox::WwwCoderepo;
10 use File::Temp 0.19 (); # newdir
11 use PublicInbox::ViewVCS;
12 use PublicInbox::WwwStatic qw(r);
13 use PublicInbox::GitHTTPBackend;
15 use PublicInbox::GitAsyncCat;
16 use PublicInbox::WwwStream;
17 use PublicInbox::Hval qw(ascii_html);
18 use PublicInbox::ViewDiff qw(uri_escape_path);
19 use PublicInbox::RepoSnapshot;
20 use PublicInbox::RepoAtom;
21 use PublicInbox::RepoTree;
23 my $EACH_REF = "git for-each-ref --sort=-creatordate --format='%(HEAD)%00".
24 join('%00', map { "%($_)" }
25 qw(objectname refname:short subject creatordate:short))."'";
27 # shared with PublicInbox::Cgit
28 sub prepare_coderepos {
30 my $pi_cfg = $self->{pi_cfg};
32 # TODO: support gitweb and other repository viewers?
33 $pi_cfg->parse_cgitrc(undef, 0);
35 my $code_repos = $pi_cfg->{-code_repos};
36 for my $k (grep(/\Acoderepo\.(?:.+)\.dir\z/, keys %$pi_cfg)) {
37 $k = substr($k, length('coderepo.'), -length('.dir'));
38 $code_repos->{$k} //= $pi_cfg->fill_code_repo($k);
41 # associate inboxes and extindices with coderepos for search:
42 for my $k (grep(/\Apublicinbox\.(?:.+)\.coderepo\z/, keys %$pi_cfg)) {
43 $k = substr($k, length('publicinbox.'), -length('.coderepo'));
44 my $ibx = $pi_cfg->lookup_name($k) // next;
45 $pi_cfg->repo_objs($ibx);
47 for my $k (grep(/\Aextindex\.(?:.+)\.coderepo\z/, keys %$pi_cfg)) {
48 $k = substr($k, length('extindex.'), -length('.coderepo'));
49 my $eidx = $pi_cfg->lookup_ei($k) // next;
50 $pi_cfg->repo_objs($eidx);
55 my ($cls, $pi_cfg) = @_;
56 my $self = bless { pi_cfg => $pi_cfg }, $cls;
57 prepare_coderepos($self);
58 $self->{snapshots} = do {
59 my $s = $pi_cfg->{'coderepo.snapshots'} // '';
60 $s eq 'all' ? \%PublicInbox::RepoSnapshot::FMT_TYPES :
61 +{ map { $_ => 1 } split(/\s+/, $s) };
63 $self->{$_} = 10 for qw(summary_branches summary_tags);
64 $self->{$_} = 10 for qw(summary_log);
70 my $wcb = delete($ctx->{env}->{'qspawn.wcb'}) or return; # already done
71 my @x = split(/\n\n/sm, delete($ctx->{-each_refs}));
72 PublicInbox::WwwStream::html_init($ctx);
76 my @r = split(/\n/s, pop(@x) // '');
77 my $last = pop(@r) if scalar(@r) > $ctx->{wcr}->{summary_log};
79 if (defined(my $tip = $ctx->{qp}->{h})) {
80 $tip_html .= ' '.ascii_html($tip).' --';
83 <pre><a id=log>\$</a> git log --pretty=format:'%h %s (%cs)%d'$tip_html
87 s/^ \(([^\)]+)\)// and $d = $1;
89 my ($H, $h, $cs, $s) = split(/ /, $_, 4);
90 print $zfh "<a\nhref=./$H/s/>$h</a> ", ascii_html($s),
92 print $zfh "\t(", ascii_html($d), ")\n" if $d;
94 print $zfh "# no commits, yet\n" if !@r;
95 print $zfh "...\n" if $last;
98 my ($bref, $oid, $ref_path) = @{delete $ctx->{-readme}};
100 my $l = PublicInbox::Linkify->new;
101 $$bref =~ s/\s*\z//sm;
102 my (undef, $path) = split(/:/, $ref_path, 2); # HEAD:README
103 print $zfh "\n<a id=readme>\$</a> " .
104 qq(git cat-file blob <a href="./$oid/s/?b=) .
105 ascii_html(uri_escape_path($path)) . q(">).
106 ascii_html($ref_path), "</a>\n",
107 $l->to_html($$bref), '</pre><hr><pre>';
111 print $zfh "<a id=heads># heads (aka `branches'):</a>\n\$ " .
112 "git for-each-ref --sort=-creatordate refs/heads" .
113 " \\\n\t--format='%(HEAD) ". # no space for %(align:) hint
114 "%(refname:short) %(subject) (%(creatordate:short))'\n";
115 @r = split(/^/sm, shift(@x) // '');
116 $last = pop(@r) if scalar(@r) > $ctx->{wcr}->{summary_branches};
118 my ($pfx, $oid, $ref, $s, $cd) = split(/\0/);
119 utf8::decode($_) for ($ref, $s);
121 my $align = length($ref) < 12 ? ' ' x (12 - length($ref)) : '';
122 print $zfh "$pfx <a\nhref=./$oid/s/>", ascii_html($ref),
123 "</a>$align ", ascii_html($s), " ($cd)\n";
125 print $zfh "# no heads (branches) yet...\n" if !@r;
126 print $zfh "...\n" if $last;
127 print $zfh "\n<a id=tags># tags:</a>\n\$ " .
128 "git for-each-ref --sort=-creatordate refs/tags" .
129 " \\\n\t--format='". # no space for %(align:) hint
130 "%(refname:short) %(subject) (%(creatordate:short))'\n";
131 @r = split(/^/sm, shift(@x) // '');
132 $last = pop(@r) if scalar(@r) > $ctx->{wcr}->{summary_tags};
133 my @s = sort keys %{$ctx->{wcr}->{snapshots}};
136 $n = $ctx->{git}->local_nick // die "BUG: $ctx->{git_dir} nick";
138 ($n) = ($n =~ m!([^/]+)\z!);
142 my (undef, $oid, $ref, $s, $cd) = split(/\0/);
143 utf8::decode($_) for ($ref, $s);
145 my $align = length($ref) < 12 ? ' ' x (12 - length($ref)) : '';
146 print $zfh "<a\nhref=./$oid/s/>", ascii_html($ref),
147 "</a>$align ", ascii_html($s), " ($cd)";
151 print $zfh "\t", join(' ', map {
152 qq{<a href="snapshot/$n$v.$_">$_</a>} } @s);
156 print $zfh "# no tags yet...\n" if !@r;
157 print $zfh "...\n" if $last;
158 $wcb->($ctx->html_done('</pre>'));
161 sub capture_refs ($$) { # psgi_qx callback to capture git-for-each-ref + git-log
162 my ($bref, $ctx) = @_;
163 my $qsp_err = delete $ctx->{-qsp_err};
164 $ctx->{-each_refs} = $$bref;
165 summary_finish($ctx) if $ctx->{-readme};
168 sub set_readme { # git->cat_async callback
169 my ($bref, $oid, $type, $size, $ctx) = @_;
170 my $ref_path = shift @{$ctx->{-nr_readme_tries}}; # e.g. HEAD:README
171 if ($type eq 'blob' && !$ctx->{-readme}) {
172 $ctx->{-readme} = [ $bref, $oid, $ref_path ];
173 } elsif (scalar @{$ctx->{-nr_readme_tries}} == 0) {
174 $ctx->{-readme} //= []; # nothing left to try
175 } # or try another README...
176 summary_finish($ctx) if $ctx->{-each_refs} && $ctx->{-readme};
180 my ($self, $ctx) = @_;
182 my $tip = $ctx->{qp}->{h}; # same as cgit
183 if (defined $tip && $tip eq '') {
184 delete $ctx->{qp}->{h};
187 my $nb = $self->{summary_branches} + 1;
188 my $nt = $self->{summary_tags} + 1;
189 my $nl = $self->{summary_log} + 1;
191 my @cmd = (qw(/bin/sh -c),
192 "$EACH_REF --count=$nb refs/heads; echo && " .
193 "$EACH_REF --count=$nt refs/tags; echo && " .
194 qq(git log -$nl --pretty=format:'%d %H %h %cs %s' "\$@" --));
195 push @cmd, '--', $tip if defined($tip);
196 my $qsp = PublicInbox::Qspawn->new(\@cmd,
197 { GIT_DIR => $ctx->{git}->{git_dir} });
198 $qsp->{qsp_err} = \($ctx->{-qsp_err} = '');
200 my @try = ("$tip:README", "$tip:README.md"); # TODO: configurable
201 $ctx->{-nr_readme_tries} = [ @try ];
202 $ctx->{git}->cat_async($_, \&set_readme, $ctx) for @try;
203 if ($ctx->{env}->{'pi-httpd.async'}) {
204 PublicInbox::GitAsyncCat::watch_cat($ctx->{git});
205 } else { # synchronous
206 $ctx->{git}->cat_async_wait;
208 sub { # $_[0] => PublicInbox::HTTP::{Identity,Chunked}
209 $ctx->{env}->{'qspawn.wcb'} = $_[0];
210 $qsp->psgi_qx($ctx->{env}, undef, \&capture_refs, $ctx);
214 sub srv { # endpoint called by PublicInbox::WWW
215 my ($self, $ctx) = @_;
216 my $path_info = $ctx->{env}->{PATH_INFO};
218 # handle clone requests
219 my $cr = $self->{pi_cfg}->{-code_repos};
220 if ($path_info =~ m!\A/(.+?)/($PublicInbox::GitHTTPBackend::ANY)\z!x) {
221 $git = $cr->{$1} and return
222 PublicInbox::GitHTTPBackend::serve($ctx->{env},$git,$2);
224 $path_info =~ m!\A/(.+?)/\z! and
225 ($ctx->{git} = $cr->{$1}) and return summary($self, $ctx);
226 $path_info =~ m!\A/(.+?)/([a-f0-9]+)/s/([^/]+)?\z! and
227 ($ctx->{git} = $cr->{$1}) and
228 return PublicInbox::ViewVCS::show($ctx, $2, $3);
230 if ($path_info =~ m!\A/(.+?)/tree/(.*)\z! and
231 ($ctx->{git} = $cr->{$1})) {
232 return PublicInbox::RepoTree::srv_tree($ctx, $2) // r(404);
236 if ($path_info =~ m!\A/(.+?)/snapshot/([^/]+)\z! and
237 ($ctx->{git} = $cr->{$1})) {
239 return PublicInbox::RepoSnapshot::srv($ctx, $2) // r(404);
242 if ($path_info =~ m!\A/(.+?)/atom/(.*)\z! and
243 ($ctx->{git} = $cr->{$1})) {
244 return PublicInbox::RepoAtom::srv_atom($ctx, $2) // r(404);
247 # enforce trailing slash:
248 if ($path_info =~ m!\A/(.+?)\z! and ($git = $cr->{$1})) {
249 my $qs = $ctx->{env}->{QUERY_STRING};
250 my $url = $git->base_url($ctx->{env});
251 $url .= "?$qs" if $qs ne '';
252 [ 301, [ Location => $url, 'Content-Type' => 'text/plain' ],
253 [ "Redirecting to $url\n" ] ];