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);
use PublicInbox::Hval qw(ascii_html to_filename);
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', '%P', '%p', '%H', '%T', '%s',
+my $SHOW_FMT = '--pretty=format:'.join('%n', '%P', '%p', '%H', '%T', '%s', '%f',
'%an <%ae> %ai', '%cn <%ce> %ci', '%b%x00');
-sub html_page ($$$) {
- my ($ctx, $code, $strref) = @_;
+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};
$ctx->{-upfx} = '../../'; # from "/$INBOX/$OID/s/"
- my $res = html_oneshot($ctx, $code, $strref);
+ my $res = html_oneshot($ctx, $code, @_[2..$#_]);
$wcb ? $wcb->($res) : $res;
}
+sub dbg_log ($) {
+ my ($ctx) = @_;
+ my $log = delete $ctx->{lh} // die 'BUG: already captured debug log';
+ if (!seek($log, 0, 0)) {
+ warn "seek(log): $!";
+ return '<pre>debug log seek error</pre>';
+ }
+ $log = do { local $/; <$log> } // do {
+ warn "readline(log): $!";
+ return '<pre>debug log read error</pre>';
+ };
+ $ctx->{-linkify} //= PublicInbox::Linkify->new;
+ "<hr><pre>debug log:\n\n".
+ $ctx->{-linkify}->to_html($log).'</pre>';
+}
+
sub stream_blob_parse_hdr { # {parse_hdr} for Qspawn
my ($r, $bref, $ctx) = @_;
- my ($res, $logref) = delete @$ctx{qw(-res -logref)};
- my ($git, $oid, $type, $size, $di) = @$res;
+ my ($git, $oid, $type, $size, $di) = @{$ctx->{-res}};
my @cl = ('Content-Length', $size);
- if (!defined $r) { # error
- html_page($ctx, 500, $logref);
+ if (!defined $r) { # sysread error
+ html_page($ctx, 500, dbg_log($ctx));
} elsif (index($$bref, "\0") >= 0) {
[200, [qw(Content-Type application/octet-stream), @cl] ];
} else {
'text/plain; charset=UTF-8', @cl ] ];
}
if ($r == 0) {
- warn "premature EOF on $oid $$logref";
- return html_page($ctx, 500, $logref);
+ my $log = dbg_log($ctx);
+ warn "premature EOF on $oid $log";
+ return html_page($ctx, 500, $log);
}
- @$ctx{qw(-res -logref)} = ($res, $logref);
undef; # bref keeps growing
}
}
-sub stream_large_blob ($$$$) {
- my ($ctx, $res, $logref, $fn) = @_;
- $ctx->{-logref} = $logref;
+sub stream_large_blob ($$) {
+ my ($ctx, $res) = @_;
$ctx->{-res} = $res;
my ($git, $oid, $type, $size, $di) = @$res;
my $cmd = ['git', "--git-dir=$git->{git_dir}", 'cat-file', $type, $oid];
$qsp->psgi_return($env, undef, \&stream_blob_parse_hdr, $ctx);
}
-sub show_other_result ($$) {
+sub show_other_result ($$) { # tag
my ($bref, $ctx) = @_;
- 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);
+ if (my $qsp_err = delete $ctx->{-qsp_err}) {
+ return html_page($ctx, 500, dbg_log($ctx) .
+ "git show error:$qsp_err");
}
my $l = PublicInbox::Linkify->new;
utf8::decode($$bref);
- $$bref = '<pre>'. $l->to_html($$bref);
- $$bref .= '</pre><hr>' . $$logref;
- html_page($ctx, 200, $bref);
+ html_page($ctx, 200, '<pre>', $l->to_html($$bref), '</pre><hr>',
+ dbg_log($ctx));
}
sub cmt_title { # git->cat_async callback
sub show_commit_start { # ->psgi_qx callback
my ($bref, $ctx) = @_;
- my ($qsp_err, $logref) = delete @$ctx{qw(-qsp_err -logref)};
- if ($qsp_err) {
- $$logref .= "git show/patch-id error:$qsp_err";
- return html_page($ctx, 500, $logref);
+ if (my $qsp_err = delete $ctx->{-qsp_err}) {
+ return html_page($ctx, 500, dbg_log($ctx) .
+ "git show/patch-id error:$qsp_err");
}
my $patchid = (split(/ /, $$bref))[0]; # ignore commit
$ctx->{-q_value_html} = "patchid:$patchid" if defined $patchid;
chop(my $buf = do { local $/ = "\0"; <$fh> });
chomp $buf;
my ($P, $p);
- ($P, $p, @$ctx{qw(cmt_H cmt_T cmt_s cmt_au cmt_co cmt_b)})
- = split(/\n/, $buf, 8);
+ ($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
sub cmt_finalize {
my ($ctx) = @_;
- $ctx->{-linkify} = PublicInbox::Linkify->new;
+ $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;
$au =~ s/>/>$x/;
}
$_ = ascii_html($_) for ($au, $co);
- my $s = $ctx->{-linkify}->to_html(delete $ctx->{cmt_s});
- $ctx->{-title_html} = $s;
- my $upfx = $ctx->{-upfx} = '../../'; # from "/$INBOX/$OID/s/"
+ $au =~ s!(> +)([0-9]{4,}-\S+ \S+)!
+ my ($gt, $t) = ($1, $2);
+ $t =~ tr/ :-//d;
+ qq($gt<a
+href="$upfx?t=$t"
+title="list contemporary emails">$2</a>)
+ !e;
+ $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(\n parent $P->[0]);
+ $x = qq{ (<a
+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?
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]]);
}
-sub show_commit ($$$$) {
- my ($ctx, $res, $logref, $fn) = @_;
+sub stream_patch_parse_hdr { # {parse_hdr} for Qspawn
+ my ($r, $bref, $ctx) = @_;
+ if (!defined $r) { # sysread error
+ html_page($ctx, 500, dbg_log($ctx));
+ } elsif (index($$bref, "\n\n") >= 0) {
+ my $eml = bless { hdr => $bref }, 'PublicInbox::Eml';
+ my $fn = to_filename($eml->header('Subject') // '');
+ $fn = substr($fn // 'PATCH-no-subject', 6); # drop "PATCH-"
+ return [ 200, [ 'Content-Type', 'text/plain; charset=UTF-8',
+ 'Content-Disposition',
+ qq(inline; filename=$fn.patch) ] ];
+ } elsif ($r == 0) {
+ my $log = dbg_log($ctx);
+ warn "premature EOF on $ctx->{patch_oid} $log";
+ return html_page($ctx, 500, $log);
+ } else {
+ undef; # bref keeps growing until "\n\n"
+ }
+}
+
+sub show_patch ($$) {
+ my ($ctx, $res) = @_;
+ my ($git, $oid) = @$res;
+ my @cmd = ('git', "--git-dir=$git->{git_dir}",
+ qw(format-patch -1 --stdout -C),
+ "--signature=git format-patch -1 --stdout -C $oid", $oid);
+ my $qsp = PublicInbox::Qspawn->new(\@cmd);
+ $ctx->{env}->{'qspawn.wcb'} = delete $ctx->{-wcb};
+ $ctx->{patch_oid} = $oid;
+ $qsp->psgi_return($ctx->{env}, undef, \&stream_patch_parse_hdr, $ctx);
+}
+
+sub show_commit ($$) {
+ my ($ctx, $res) = @_;
+ return show_patch($ctx, $res) if ($ctx->{fn} // '') =~ /\.patch\z/;
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
my $e = { GIT_DIR => $git->{git_dir} };
my $qsp = PublicInbox::Qspawn->new($cmd, $e, { -C => "$ctx->{-tmp}" });
$qsp->{qsp_err} = \($ctx->{-qsp_err} = '');
- $ctx->{-logref} = $logref;
$ctx->{env}->{'qspawn.wcb'} = delete $ctx->{-wcb};
$ctx->{git} = $git;
$qsp->psgi_qx($ctx->{env}, undef, \&show_commit_start, $ctx);
}
-sub show_other ($$$$) {
- my ($ctx, $res, $logref, $fn) = @_;
+sub show_other ($$) {
+ my ($ctx, $res) = @_;
my ($git, $oid, $type, $size) = @$res;
- if ($size > $MAX_SIZE) {
- $$logref = "$oid is too big to show\n" . $$logref;
- return html_page($ctx, 200, $logref);
- }
+ $size > $MAX_SIZE and return html_page($ctx, 200,
+ 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);
$qsp->{qsp_err} = \($ctx->{-qsp_err} = '');
- $ctx->{-logref} = $logref;
$qsp->psgi_qx($ctx->{env}, undef, \&show_other_result, $ctx);
}
-# user_cb for SolverGit, called as: user_cb->($result_or_error, $uarg)
-sub solve_result {
- my ($res, $ctx) = @_;
- my ($log, $hints, $fn) = delete @$ctx{qw(lh hints fn)};
-
- unless (seek($log, 0, 0)) {
- warn "seek(log): $!";
- return html_page($ctx, 500, \'seek error');
+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");
}
- $log = do { local $/; <$log> };
+ 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.
- my $l = PublicInbox::Linkify->new;
- $log = '<pre>debug log:</pre><hr /><pre>' .
- $l->to_html($log) . '</pre>';
+<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);
+}
- $res or return html_page($ctx, 404, \$log);
- ref($res) eq 'ARRAY' or return html_page($ctx, 500, \$log);
+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) = @_;
+ my $hints = delete $ctx->{hints};
+ $res or return html_page($ctx, 404, dbg_log($ctx));
+ ref($res) eq 'ARRAY' or return html_page($ctx, 500, dbg_log($ctx));
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';
+ 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>)";
if ($size > $MAX_SIZE) {
- return stream_large_blob($ctx, $res, \$log, $fn) if defined $fn;
- $log = "<pre><b>Too big to show, download available</b>\n" .
- "$oid $type $size bytes $raw_link</pre>" . $log;
- return html_page($ctx, 200, \$log);
+ 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>
+blob $oid $size bytes $raw_link</pre>
+EOM
}
my $blob = $git->cat_file($oid);
if (!$blob) { # WTF?
my $e = "Failed to retrieve generated blob ($oid)";
warn "$e ($git->{git_dir})";
- $log = "<pre><b>$e</b></pre>" . $log;
- return html_page($ctx, 500, \$log);
+ return html_page($ctx, 500, "<pre><b>$e</b></pre>".dbg_log($ctx))
}
my $bin = index(substr($$blob, 0, $BIN_DETECT), "\0") >= 0;
- if (defined $fn) {
+ if (defined $ctx->{fn}) {
my $h = [ 'Content-Length', $size, 'Content-Type' ];
push(@$h, ($bin ? 'application/octet-stream' : 'text/plain'));
return delete($ctx->{-wcb})->([200, $h, [ $$blob ]]);
}
- if ($bin) {
- $log = "<pre>$oid $type $size bytes (binary)" .
- " $raw_link</pre>" . $log;
- return html_page($ctx, 200, \$log);
- }
+ $bin and return html_page($ctx, 200,
+ "<pre>blob $oid $size bytes (binary)" .
+ " $raw_link</pre>".dbg_log($ctx));
# TODO: detect + convert to ensure validity
utf8::decode($$blob);
my $nl = ($$blob =~ s/\r?\n/\n/sg);
my $pad = length($nl);
- $l->linkify_1($$blob);
+ ($ctx->{-linkify} //= PublicInbox::Linkify->new)->linkify_1($$blob);
my $ok = $hl->do_hl($blob, $path) if $hl;
if ($ok) {
$blob = $ok;
$$blob = ascii_html($$blob);
}
- # using some of the same CSS class names and ids as cgit
- $log = "<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>" . join('', map {
- sprintf("<a id=n$_ href=#n$_>% ${pad}u</a>\n", $_)
- } (1..$nl)) . '</pre></td>' .
- '<td><pre> </pre></td>'. # pad for non-CSS users
- "<td\nclass=lines><pre\nstyle='white-space:pre'><code>" .
- $l->linkify_2($$blob) .
- '</code></pre></td></tr></table>' . $log;
-
- html_page($ctx, 200, \$log);
+ "<tr><td\nclass=linenumbers><pre>";
+ $x .= sprintf("<a id=n$_ href=#n$_>% ${pad}u</a>\n", $_) for (1..$nl);
+ $x .= '</pre></td><td><pre> </pre></td>'. # pad for non-CSS users
+ "<td\nclass=lines><pre\nstyle='white-space:pre'><code>";
+
+ # using some of the same CSS class names and ids as cgit
+ html_page($ctx, 200, $x, $ctx->{-linkify}->linkify_2($$blob),
+ '</code></pre></td></tr></table>'.dbg_log($ctx));
}
# GET /$INBOX/$GIT_OBJECT_ID/s/