]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/ViewVCS.pm
viewvcs: start improving display of git commits
[public-inbox.git] / lib / PublicInbox / ViewVCS.pm
index 6365f04547bca74359c611ea307a9b4f8f2f10be..96883f6ccbda5fe15c25b9e0463ae8bae7f3573d 100644 (file)
@@ -1,8 +1,7 @@
-# Copyright (C) 2019-2021 all contributors <meta@public-inbox.org>
+# Copyright (C) all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
 # show any VCS object, similar to "git show"
-# FIXME: we only show blobs for now
 #
 # This can use a "solver" to reconstruct blobs based on git
 # patches (with abbreviated OIDs in the header).  However, the
 package PublicInbox::ViewVCS;
 use strict;
 use v5.10.1;
+use File::Temp 0.19 (); # newdir
 use PublicInbox::SolverGit;
 use PublicInbox::WwwStream qw(html_oneshot);
 use PublicInbox::Linkify;
 use PublicInbox::Tmpfile;
+use PublicInbox::ViewDiff qw(flush_diff);
 use PublicInbox::Hval qw(ascii_html to_filename);
 my $hl = eval {
        require PublicInbox::HlMod;
@@ -29,6 +30,8 @@ my $hl = eval {
 my %QP_MAP = ( A => 'oid_a', a => 'path_a', b => 'path_b' );
 our $MAX_SIZE = 1024 * 1024; # TODO: configurable
 my $BIN_DETECT = 8000; # same as git
+my $SHOW_FMT = '--pretty=format:'.join('%n', '%H', '%T', '%P', '%s',
+       '%an <%ae>%x09%ai', '%cn <%ce>%x09%ci', '%b%x00');
 
 sub html_page ($$$) {
        my ($ctx, $code, $strref) = @_;
@@ -54,7 +57,7 @@ sub stream_blob_parse_hdr { # {parse_hdr} for Qspawn
                                'text/plain; charset=UTF-8', @cl ] ];
                }
                if ($r == 0) {
-                       warn "premature EOF on $oid $$logref\n";
+                       warn "premature EOF on $oid $$logref";
                        return html_page($ctx, 500, $logref);
                }
                @$ctx{qw(-res -logref)} = ($res, $logref);
@@ -76,10 +79,9 @@ sub stream_large_blob ($$$$) {
 
 sub show_other_result ($$) {
        my ($bref, $ctx) = @_;
-       my ($qsp, $logref) = delete @$ctx{qw(-qsp -logref)};
-       if (my $err = $qsp->{err}) {
-               utf8::decode($$err);
-               $$logref .= "git show error: $err";
+       my ($qsp_err, $logref) = delete @$ctx{qw(-qsp_err -logref)};
+       if ($qsp_err) {
+               $$logref .= "git show error:$qsp_err";
                return html_page($ctx, 500, $logref);
        }
        my $l = PublicInbox::Linkify->new;
@@ -89,6 +91,99 @@ sub show_other_result ($$) {
        html_page($ctx, 200, $bref);
 }
 
+sub show_commit_result ($$) {
+       my ($bref, $ctx) = @_;
+       my ($qsp_err, $logref, $tmp) = @$ctx{qw(-qsp_err -logref -tmp)};
+       if ($qsp_err) {
+               $$logref .= "git show/patch-id error:$qsp_err";
+               return html_page($ctx, 500, $logref);
+       }
+       my $upfx = $ctx->{-upfx} = '../../'; # from "/$INBOX/$OID/s/"
+       my $patchid = (split(/ /, $$bref))[0]; # ignore commit
+       if (defined $patchid) {
+               $ctx->{-q_value_html} = "patchid:$patchid";
+               $patchid = "\n  patchid $patchid";
+       } else {
+               $patchid = '';
+       }
+       my $l = $ctx->{-linkify} = PublicInbox::Linkify->new;
+       open my $fh, '<:utf8', "$tmp/h" or die "open $tmp/h: $!";
+       chop(my $buf = do { local $/ = "\0"; <$fh> });
+       my ($H, $T, $P, $s, $au, $co, $bdy) = split(/\n/, $buf, 7);
+       chomp $bdy;
+       # try to keep author and committer dates lined up
+       my $x = length($au) - length($co);
+       if ($x > 0) {
+               $x = ' ' x $x;
+               $co =~ s/\t/$x\t/;
+       } elsif ($x < 0) {
+               $x = ' ' x (-$x);
+               $au =~ s/\t/$x\t/;
+       }
+       $_ = ascii_html($_) for ($au, $co);
+       $_ = $l->to_html($_) for ($s, $bdy);
+       $ctx->{-title_html} = $s;
+       my @p = split(/ /, $P);
+       if (@p == 1) {
+               $P = qq(\n   parent <a href="$upfx$P/s/">$P</a>);
+       } elsif (@p > 1) {
+               $P = qq(\n  parents <a href="$upfx$p[0]/s/">$p[0]</a>\n);
+               shift @p;
+               $P .= qq(          <a href="$upfx$_/s/">$_</a>\n) for @p;
+               chop $P;
+       } else { # root commit
+               $P = ' (root commit)';
+       }
+       PublicInbox::WwwStream::html_init($ctx);
+       $ctx->zmore(<<EOM);
+<pre>   commit $H$P
+     tree <a href="$upfx$T/s/">$T</a>
+   author $au
+committer $co$patchid
+
+<b>$s</b>\n
+EOM
+       $ctx->zmore($bdy);
+       open $fh, '<', "$tmp/p" or die "open $tmp/p: $!";
+       if (-s $fh > $MAX_SIZE) {
+               $ctx->zmore("---\n patch is too large to show\n");
+       } else { # prepare flush_diff:
+               $buf = '';
+               $ctx->{obuf} = \$buf;
+               $ctx->{-apfx} = $ctx->{-spfx} = $upfx;
+               $ctx->{-anchors} = {};
+               $bdy = '';
+               read($fh, $bdy, -s _);
+               $bdy =~ s/\r?\n/\n/gs;
+               flush_diff($ctx, \$bdy);
+               $ctx->zmore($buf);
+       }
+       $x = $ctx->zflush($ctx->_html_end);
+       my $res_hdr = delete $ctx->{-res_hdr};
+       push @$res_hdr, 'Content-Length', length($x);
+       delete($ctx->{env}->{'qspawn.wcb'})->([200, $res_hdr, [$x]]);
+}
+
+sub show_commit ($$$$) {
+       my ($ctx, $res, $logref, $fn) = @_;
+       my ($git, $oid) = @$res;
+       # patch-id needs two passes, and we use the initial show to ensure
+       # a patch embedded inside the commit message body doesn't get fed
+       # to patch-id:
+       my $cmd = [ '/bin/sh', '-c',
+               "git show '$SHOW_FMT' -z --no-notes --no-patch $oid >h && ".
+               "git show --pretty=format:%n -M --stat -p $oid >p && ".
+               "git patch-id --stable <p" ];
+       my $xenv = { GIT_DIR => $git->{git_dir} };
+       my $tmp = File::Temp->newdir("show-$oid-XXXX", TMPDIR => 1);
+       my $qsp = PublicInbox::Qspawn->new($cmd, $xenv, { -C => "$tmp" });
+       $qsp->{qsp_err} = \($ctx->{-qsp_err} = '');
+       $ctx->{-logref} = $logref;
+       $ctx->{-tmp} = $tmp;
+       $ctx->{env}->{'qspawn.wcb'} = delete $ctx->{-wcb};
+       $qsp->psgi_qx($ctx->{env}, undef, \&show_commit_result, $ctx);
+}
+
 sub show_other ($$$$) {
        my ($ctx, $res, $logref, $fn) = @_;
        my ($git, $oid, $type, $size) = @$res;
@@ -99,10 +194,9 @@ sub show_other ($$$$) {
        my $cmd = ['git', "--git-dir=$git->{git_dir}",
                qw(show --encoding=UTF-8 --no-color --no-abbrev), $oid ];
        my $qsp = PublicInbox::Qspawn->new($cmd);
-       my $env = $ctx->{env};
-       $ctx->{-qsp} = $qsp;
+       $qsp->{qsp_err} = \($ctx->{-qsp_err} = '');
        $ctx->{-logref} = $logref;
-       $qsp->psgi_qx($env, undef, \&show_other_result, $ctx);
+       $qsp->psgi_qx($ctx->{env}, undef, \&show_other_result, $ctx);
 }
 
 # user_cb for SolverGit, called as: user_cb->($result_or_error, $uarg)
@@ -111,20 +205,20 @@ sub solve_result {
        my ($log, $hints, $fn) = delete @$ctx{qw(log hints fn)};
 
        unless (seek($log, 0, 0)) {
-               $ctx->{env}->{'psgi.errors'}->print("seek(log): $!\n");
+               warn "seek(log): $!";
                return html_page($ctx, 500, \'seek error');
        }
        $log = do { local $/; <$log> };
 
-       my $ref = ref($res);
        my $l = PublicInbox::Linkify->new;
        $log = '<pre>debug log:</pre><hr /><pre>' .
                $l->to_html($log) . '</pre>';
 
        $res or return html_page($ctx, 404, \$log);
-       $ref eq 'ARRAY' or return html_page($ctx, 500, \$log);
+       ref($res) eq 'ARRAY' or return html_page($ctx, 500, \$log);
 
        my ($git, $oid, $type, $size, $di) = @$res;
+       return show_commit($ctx, $res, \$log, $fn) if $type eq 'commit';
        return show_other($ctx, $res, \$log, $fn) if $type ne 'blob';
        my $path = to_filename($di->{path_b} // $hints->{path_b} // 'blob');
        my $raw_link = "(<a\nhref=$path>raw</a>)";
@@ -138,7 +232,7 @@ sub solve_result {
        my $blob = $git->cat_file($oid);
        if (!$blob) { # WTF?
                my $e = "Failed to retrieve generated blob ($oid)";
-               $ctx->{env}->{'psgi.errors'}->print("$e ($git->{git_dir})\n");
+               warn "$e ($git->{git_dir})";
                $log = "<pre><b>$e</b></pre>" . $log;
                return html_page($ctx, 500, \$log);
        }
@@ -194,7 +288,7 @@ sub show ($$;$) {
                $hints->{$to} = $v if $v ne '';
        }
 
-       $ctx->{'log'} = tmpfile("solve.$oid_b");
+       $ctx->{'log'} = tmpfile("solve.$oid_b") // die "tmpfile: $!";
        $ctx->{fn} = $fn;
        my $solver = PublicInbox::SolverGit->new($ctx->{ibx},
                                                \&solve_result, $ctx);