1 # Copyright (C) 2019-2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # wrapper for cgit(1) and git-http-backend(1) for browsing and
5 # serving git code repositories. Requires 'publicinbox.cgitrc'
6 # directive to be set in the public-inbox config file.
8 package PublicInbox::Cgit;
10 use PublicInbox::GitHTTPBackend;
12 # not bothering with Exporter for a one-off
13 *input_prepare = *PublicInbox::GitHTTPBackend::input_prepare;
14 *serve = *PublicInbox::GitHTTPBackend::serve;
16 use PublicInbox::Qspawn;
17 use PublicInbox::WwwStatic qw(r);
21 my $cgit_bin = $pi_config->{'publicinbox.cgitbin'};
22 my $cgit_data = $pi_config->{'publicinbox.cgitdata'};
24 # /var/www/htdocs/cgit is the default install path from cgit.git
25 # /usr/{lib,share}/cgit is where Debian puts cgit
26 # TODO: check other distros for common paths
27 unless (defined $cgit_bin) {
28 foreach (qw(/var/www/htdocs/cgit /usr/lib/cgit)) {
29 my $x = "$_/cgit.cgi";
35 unless (defined $cgit_data) {
36 my @dirs = qw(/var/www/htdocs/cgit /usr/share/cgit);
38 # local installs of cgit from source have
39 # CGIT_SCRIPT_PATH==CGIT_DATA_PATH by default,
40 # so we can usually infer the cgit_data path from cgit_bin
41 if (defined($cgit_bin) && $cgit_bin =~ m!\A(.+?)/[^/]+\z!) {
42 unshift @dirs, $1 if -d $1;
44 foreach my $d (@dirs) {
45 my $f = "$d/cgit.css";
51 ($cgit_bin, $cgit_data);
55 my ($class, $pi_config) = @_;
56 my ($cgit_bin, $cgit_data) = locate_cgit($pi_config);
60 cgit_data => $cgit_data,
61 pi_config => $pi_config,
64 $pi_config->fill_all; # fill in -code_repos mapped to inboxes
66 # some cgit repos may not be mapped to inboxes, so ensure those exist:
67 my $code_repos = $pi_config->{-code_repos};
68 foreach my $k (keys %$pi_config) {
69 $k =~ /\Acoderepo\.(.+)\.dir\z/ or next;
70 my $dir = $pi_config->{$k};
71 $code_repos->{$1} ||= PublicInbox::Git->new($dir);
73 while (my ($nick, $repo) = each %$code_repos) {
74 $self->{"\0$nick"} = $repo;
76 my $cgit_static = $pi_config->{-cgit_static};
77 my $static = join('|', map { quotemeta $_ } keys %$cgit_static);
78 $self->{static} = qr/\A($static)\z/;
82 # only what cgit cares about:
94 # XXX: cgit filters may care about more variables...
96 my $parse_cgi_headers = \&PublicInbox::GitHTTPBackend::parse_cgi_headers;
99 my ($self, $env) = @_;
100 my $path_info = $env->{PATH_INFO};
103 # handle requests without spawning cgit iff possible:
104 if ($path_info =~ m!\A/(.+?)/($PublicInbox::GitHTTPBackend::ANY)\z!ox) {
105 my ($nick, $path) = ($1, $2);
106 if (my PublicInbox::Git $git = $self->{"\0$nick"}) {
107 return serve($env, $git, $path);
109 } elsif ($path_info =~ m!$self->{static}! &&
110 defined($cgit_data = $self->{cgit_data})) {
111 my $f = $cgit_data.$1; # {static} only matches leading slash
112 return PublicInbox::WwwStatic::response($env, [], $f);
115 my $cgi_env = { PATH_INFO => $path_info };
116 foreach (@PASS_ENV) {
117 defined(my $v = $env->{$_}) or next;
120 $cgi_env->{'HTTPS'} = 'on' if $env->{'psgi.url_scheme'} eq 'https';
122 my $rdr = input_prepare($env) or return r(500);
123 my $qsp = PublicInbox::Qspawn->new($self->{cmd}, $cgi_env, $rdr);
124 my $limiter = $self->{pi_config}->limiter('-cgit');
125 $qsp->psgi_return($env, $limiter, $parse_cgi_headers);