]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/ViewVCS.pm
viewvcs: show "blob $OID" rather than "$OID blob"
[public-inbox.git] / lib / PublicInbox / ViewVCS.pm
index fd95e24e3c54270e8a9bc1a138d13220938c8980..3b4fa393ed3ff16436db04a0dc3259d62825edbf 100644 (file)
@@ -21,7 +21,7 @@ use PublicInbox::GitAsyncCat;
 use PublicInbox::WwwStream qw(html_oneshot);
 use PublicInbox::Linkify;
 use PublicInbox::Tmpfile;
-use PublicInbox::ViewDiff qw(flush_diff);
+use PublicInbox::ViewDiff qw(flush_diff uri_escape_path);
 use PublicInbox::View;
 use PublicInbox::Eml;
 use Text::Wrap qw(wrap);
@@ -37,6 +37,14 @@ my $BIN_DETECT = 8000; # same as git
 my $SHOW_FMT = '--pretty=format:'.join('%n', '%P', '%p', '%H', '%T', '%s', '%f',
        '%an <%ae>  %ai', '%cn <%ce>  %ci', '%b%x00');
 
+my %GIT_MODE = (
+       '100644' => ' ', # blob
+       '100755' => 'x', # executable blob
+       '040000' => 'd', # tree
+       '120000' => 'l', # symlink
+       '160000' => 'g', # commit (gitlink)
+);
+
 sub html_page ($$;@) {
        my ($ctx, $code) = @_[0, 1];
        my $wcb = delete $ctx->{-wcb};
@@ -57,7 +65,7 @@ sub dbg_log ($) {
                return '<pre>debug log read error</pre>';
        };
        $ctx->{-linkify} //= PublicInbox::Linkify->new;
-       '<pre>debug log:</pre><hr /><pre>'.
+       "<hr><pre>debug log:\n\n".
                $ctx->{-linkify}->to_html($log).'</pre>';
 }
 
@@ -95,7 +103,7 @@ sub stream_large_blob ($$) {
        $qsp->psgi_return($env, undef, \&stream_blob_parse_hdr, $ctx);
 }
 
-sub show_other_result ($$) { # tag, tree, ...
+sub show_other_result ($$) { # tag
        my ($bref, $ctx) = @_;
        if (my $qsp_err = delete $ctx->{-qsp_err}) {
                return html_page($ctx, 500, dbg_log($ctx) .
@@ -128,8 +136,7 @@ sub show_commit_start { # ->psgi_qx callback
        chop(my $buf = do { local $/ = "\0"; <$fh> });
        chomp $buf;
        my ($P, $p);
-       ($P, $p, @$ctx{qw(cmt_H cmt_T cmt_s cmt_f cmt_au cmt_co cmt_b)})
-               = split(/\n/, $buf, 9);
+       ($P, $p, @{$ctx->{cmt_info}}) = split(/\n/, $buf, 9);
        return cmt_finalize($ctx) if !$P;
        @{$ctx->{-cmt_P}} = split(/ /, $P);
        @{$ctx->{-cmt_p}} = split(/ /, $p); # abbreviated
@@ -149,8 +156,8 @@ sub cmt_finalize {
        my ($ctx) = @_;
        $ctx->{-linkify} //= PublicInbox::Linkify->new;
        my $upfx = $ctx->{-upfx} = '../../'; # from "/$INBOX/$OID/s/"
+       my ($H, $T, $s, $f, $au, $co, $bdy) = @{delete $ctx->{cmt_info}};
        # try to keep author and committer dates lined up
-       my ($au, $co) = delete @$ctx{qw(cmt_au cmt_co)};
        my $x = length($au) - length($co);
        if ($x > 0) {
                $x = ' ' x $x;
@@ -167,46 +174,44 @@ sub cmt_finalize {
 href="$upfx?t=$t"
 title="list contemporary emails">$2</a>)
                !e;
-       my $s = $ctx->{-linkify}->to_html(delete $ctx->{cmt_s});
-       $ctx->{-title_html} = $s;
+       $ctx->{-title_html} = $s = $ctx->{-linkify}->to_html($s);
        my ($P, $p, $pt) = delete @$ctx{qw(-cmt_P -cmt_p -cmt_pt)};
        $_ = qq(<a href="$upfx$_/s/">).shift(@$p).'</a> '.shift(@$pt) for @$P;
        if (@$P == 1) {
                $x = qq{ (<a
-href="$ctx->{cmt_f}.patch">patch</a>)\n   parent $P->[0]};
+href="$f.patch">patch</a>)\n   <a href=#parent>parent</a> $P->[0]};
        } elsif (@$P > 1) {
-               $x = qq(\n  parents $P->[0]\n);
+               $x = qq(\n  <a href=#parents>parents</a> $P->[0]\n);
                shift @$P;
                $x .= qq(          $_\n) for @$P;
                chop $x;
        } else {
-               $x = ' (root commit)';
+               $x = ' (<a href=#root_commit>root commit</a>)';
        }
        PublicInbox::WwwStream::html_init($ctx);
        $ctx->zmore(<<EOM);
-<pre>   commit $ctx->{cmt_H}$x
-     tree <a href="$upfx$ctx->{cmt_T}/s/">$ctx->{cmt_T}</a>
+<pre>   <a href=#commit>commit</a> $H$x
+     <a href=#tree>tree</a> <a href="$upfx$T/s/">$T</a>
    author $au
 committer $co
 
 <b>$s</b>
 EOM
-       $x = delete $ctx->{cmt_b};
-       $ctx->zmore("\n", $ctx->{-linkify}->to_html($x)) if length($x);
-       undef $x;
+       $ctx->zmore("\n", $ctx->{-linkify}->to_html($bdy)) if length($bdy);
+       $bdy = '';
        open my $fh, '<:utf8', "$ctx->{-tmp}/p" or
                die "open $ctx->{-tmp}/p: $!";
        if (-s $fh > $MAX_SIZE) {
                $ctx->zmore("---\n patch is too large to show\n");
        } else { # prepare flush_diff:
-               $ctx->{obuf} = \$x;
+               read($fh, $x, -s _);
+               $ctx->{obuf} = \$bdy;
                $ctx->{-apfx} = $ctx->{-spfx} = $upfx;
-               read($fh, my $bdy, -s _);
-               $bdy =~ s/\r?\n/\n/gs;
-               $ctx->{-anchors} = {} if $bdy =~ /^diff --git /sm;
-               flush_diff($ctx, \$bdy); # undefs $bdy
-               $ctx->zmore($x);
-               undef $x;
+               $x =~ s/\r?\n/\n/gs;
+               $ctx->{-anchors} = {} if $x =~ /^diff --git /sm;
+               flush_diff($ctx, \$x); # undefs $x
+               $ctx->zmore($bdy);
+               undef $bdy;
                # TODO: should there be another textarea which attempts to
                # search for the exact email which was applied to make this
                # commit?
@@ -233,7 +238,24 @@ id=related><pre>find related emails, including ancestors/descendants/conflicts
 EOM
                }
        }
-       $x = $ctx->zflush($ctx->_html_end);
+       chop($x = <<EOM);
+<hr><pre>glossary
+--------
+<dfn
+id=commit>Commit</dfn> objects reference one tree, and zero or more parents.
+
+Single <dfn
+id=parent>parent</dfn> commits can typically generate a patch in
+unified diff format via `git format-patch'.
+
+Multiple <dfn id=parents>parents</dfn> means the commit is a merge.
+
+<dfn id=root_commit>Root commits</dfn> have no ancestor.  Note that it is
+possible to have multiple root commits when merging independent histories.
+
+Every commit references one top-level <dfn id=tree>tree</dfn> object.</pre>
+EOM
+       $x = $ctx->zflush($x, $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]]);
@@ -296,7 +318,7 @@ sub show_other ($$) {
        my ($ctx, $res) = @_;
        my ($git, $oid, $type, $size) = @$res;
        $size > $MAX_SIZE and return html_page($ctx, 200,
-                               "$oid is too big to show\n". dbg_log($ctx));
+               ascii_html($type)." $oid is too big to show\n". dbg_log($ctx));
        my $cmd = ['git', "--git-dir=$git->{git_dir}",
                qw(show --encoding=UTF-8 --no-color --no-abbrev), $oid ];
        my $qsp = PublicInbox::Qspawn->new($cmd);
@@ -304,6 +326,78 @@ sub show_other ($$) {
        $qsp->psgi_qx($ctx->{env}, undef, \&show_other_result, $ctx);
 }
 
+sub show_tree_result ($$) {
+       my ($bref, $ctx) = @_;
+       if (my $qsp_err = delete $ctx->{-qsp_err}) {
+               return html_page($ctx, 500, dbg_log($ctx) .
+                               "git ls-tree -z error:$qsp_err");
+       }
+       my @ent = split(/\0/, $$bref);
+       my $qp = delete $ctx->{qp};
+       my $l = $ctx->{-linkify} //= PublicInbox::Linkify->new;
+       my $pfx = $qp->{b};
+       $$bref = "<pre><a href=#tree>tree</a> $ctx->{tree_oid}";
+       if (defined $pfx) {
+               my $x = ascii_html($pfx);
+               $pfx .= '/';
+               $$bref .= qq(  <a href=#path>path</a>: $x</a>\n);
+       } else {
+               $pfx = '';
+               $$bref .= qq[  (<a href=#path>path</a> unknown)\n];
+       }
+       my ($x, $m, $t, $oid, $sz, $f, $n);
+       $$bref .= "\n   size    name";
+       for (@ent) {
+               ($x, $f) = split(/\t/, $_, 2);
+               undef $_;
+               ($m, $t, $oid, $sz) = split(/ +/, $x, 4);
+               $m = $GIT_MODE{$m} // '?';
+               utf8::decode($f);
+               $n = ascii_html($f);
+               if ($m eq 'g') { # gitlink submodule commit
+                       $$bref .= "\ng\t\t$n @ <a\nhref=#g>commit</a>$oid";
+                       next;
+               }
+               my $q = 'b='.ascii_html(uri_escape_path($pfx.$f));
+               if ($m eq 'd') { $n .= '/' }
+               elsif ($m eq 'x') { $n = "<b>$n</b>" }
+               elsif ($m eq 'l') { $n = "<i>$n</i>" }
+               $$bref .= qq(\n$m\t$sz\t<a\nhref="../../$oid/s/?$q">$n</a>);
+       }
+       $$bref .= dbg_log($ctx);
+       $$bref .= <<EOM;
+<pre>glossary
+--------
+<dfn
+id=tree>Tree</dfn> objects belong to commits or other tree objects.  Trees may
+reference blobs, sub-trees, or commits of submodules.
+
+<dfn
+id=path>Path</dfn> names are stored in tree objects, but trees do not know
+their own path name.  A tree's path name comes from their parent tree,
+or it is the root tree referenced by a commit object.  Thus, this web UI
+relies on the `b=' URI parameter as a hint to display the path name.
+
+<dfn title="submodule commit"
+id=g>Commit</dfn> objects may be stored in trees to reference submodules.</pre>
+EOM
+       chop $$bref;
+       html_page($ctx, 200, $$bref);
+}
+
+sub show_tree ($$) {
+       my ($ctx, $res) = @_;
+       my ($git, $oid, undef, $size) = @$res;
+       $size > $MAX_SIZE and return html_page($ctx, 200,
+                       "tree $oid is too big to show\n". dbg_log($ctx));
+       my $cmd = [ 'git', "--git-dir=$git->{git_dir}",
+               qw(ls-tree -z -l --no-abbrev), $oid ];
+       my $qsp = PublicInbox::Qspawn->new($cmd);
+       $ctx->{tree_oid} = $oid;
+       $qsp->{qsp_err} = \($ctx->{-qsp_err} = '');
+       $qsp->psgi_qx($ctx->{env}, undef, \&show_tree_result, $ctx);
+}
+
 # user_cb for SolverGit, called as: user_cb->($result_or_error, $uarg)
 sub solve_result {
        my ($res, $ctx) = @_;
@@ -313,6 +407,7 @@ sub solve_result {
 
        my ($git, $oid, $type, $size, $di) = @$res;
        return show_commit($ctx, $res) if $type eq 'commit';
+       return show_tree($ctx, $res) if $type eq 'tree';
        return show_other($ctx, $res) if $type ne 'blob';
        my $path = to_filename($di->{path_b} // $hints->{path_b} // 'blob');
        my $raw_link = "(<a\nhref=$path>raw</a>)";
@@ -320,7 +415,7 @@ sub solve_result {
                return stream_large_blob($ctx, $res) if defined $ctx->{fn};
                return html_page($ctx, 200, <<EOM . dbg_log($ctx));
 <pre><b>Too big to show, download available</b>
-"$oid $type $size bytes $raw_link</pre>
+blob $oid $size bytes $raw_link</pre>
 EOM
        }
 
@@ -339,7 +434,7 @@ EOM
        }
 
        $bin and return html_page($ctx, 200,
-                               "<pre>$oid $type $size bytes (binary)" .
+                               "<pre>blob $oid $size bytes (binary)" .
                                " $raw_link</pre>".dbg_log($ctx));
 
        # TODO: detect + convert to ensure validity
@@ -355,7 +450,7 @@ EOM
                $$blob = ascii_html($$blob);
        }
 
-       my $x = "<pre>$oid $type $size bytes $raw_link</pre>" .
+       my $x = "<pre>blob $oid $size bytes $raw_link</pre>" .
                "<hr /><table\nclass=blob>".
                "<tr><td\nclass=linenumbers><pre>";
        $x .= sprintf("<a id=n$_ href=#n$_>% ${pad}u</a>\n", $_) for (1..$nl);