]> Sergey Matveev's repositories - public-inbox.git/blobdiff - lib/PublicInbox/ViewVCS.pm
No ext_urls
[public-inbox.git] / lib / PublicInbox / ViewVCS.pm
index 6b641b327edda74e4c9ba73539daef7d34878258..5fd466106f96ae432038c4279bc6c00292c94456 100644 (file)
@@ -49,7 +49,7 @@ my %GIT_MODE = (
 sub html_page ($$;@) {
        my ($ctx, $code) = @_[0, 1];
        my $wcb = delete $ctx->{-wcb};
-       $ctx->{-upfx} = '../../'; # from "/$INBOX/$OID/s/"
+       $ctx->{-upfx} //= '../../'; # from "/$INBOX/$OID/s/"
        my $res = html_oneshot($ctx, $code, @_[2..$#_]);
        $wcb ? $wcb->($res) : $res;
 }
@@ -62,9 +62,13 @@ sub dbg_log ($) {
                return '<pre>debug log seek error</pre>';
        }
        $log = do { local $/; <$log> } // do {
-               warn "readline(log): $!";
-               return '<pre>debug log read error</pre>';
+               if (!eof($log)) {
+                       warn "readline(log): $!";
+                       return '<pre>debug log read error</pre>';
+               }
+               '';
        };
+       return '' if $log eq '';
        $ctx->{-linkify} //= PublicInbox::Linkify->new;
        "<hr><pre>debug log:\n\n".
                $ctx->{-linkify}->to_html($log).'</pre>';
@@ -124,6 +128,27 @@ sub cmt_title { # git->cat_async callback
                cmt_finalize($ctx);
 }
 
+sub do_cat_async {
+       my ($ctx, $cb, @req) = @_;
+       # favor git(1) over Gcf2 (libgit2) for SHA-256 support
+       $ctx->{git}->cat_async($_, $cb, $ctx) for @req;
+       if ($ctx->{env}->{'pi-httpd.async'}) {
+               PublicInbox::GitAsyncCat::watch_cat($ctx->{git});
+       } else { # synchronous, generic PSGI
+               $ctx->{git}->cat_async_wait;
+       }
+}
+
+sub do_check_async {
+       my ($ctx, $cb, @req) = @_;
+       if ($ctx->{env}->{'pi-httpd.async'}) {
+               async_check($ctx, $_, $cb, $ctx) for @req;
+       } else { # synchronous, generic PSGI
+               $ctx->{git}->check_async($_, $cb, $ctx) for @req;
+               $ctx->{git}->check_async_wait;
+       }
+}
+
 sub show_commit_start { # ->psgi_qx callback
        my ($bref, $ctx) = @_;
        if (my $qsp_err = delete $ctx->{-qsp_err}) {
@@ -141,25 +166,20 @@ sub show_commit_start { # ->psgi_qx callback
        return cmt_finalize($ctx) if !$P;
        @{$ctx->{-cmt_P}} = split(/ /, $P);
        @{$ctx->{-cmt_p}} = split(/ /, $p); # abbreviated
-       if ($ctx->{env}->{'pi-httpd.async'}) {
-               for (@{$ctx->{-cmt_P}}) {
-                       ibx_async_cat($ctx, $_, \&cmt_title, $ctx);
-               }
-       } else { # synchronous
-               for (@{$ctx->{-cmt_P}}) {
-                       $ctx->{git}->cat_async($_, \&cmt_title, $ctx);
-               }
-               $ctx->{git}->cat_async_wait;
-       }
+       do_cat_async($ctx, \&cmt_title, @{$ctx->{-cmt_P}});
 }
 
 sub ibx_url_for {
        my ($ctx) = @_;
        $ctx->{ibx} and return; # fall back to $upfx
-       $ctx->{git} or return;
+       $ctx->{git} or die 'BUG: no {git}';
        if (my $ALL = $ctx->{www}->{pi_cfg}->ALL) {
-               return $ALL->base_url // $ALL->base_url($ctx->{env});
-       } elsif (my $ibx_names = $ctx->{git}->{ibx_names}) {
+               if (defined(my $u = $ALL->base_url($ctx->{env}))) {
+                       return wantarray ? ($u) : $u;
+               }
+       }
+       my @ret;
+       if (my $ibx_names = $ctx->{git}->{ibx_names}) {
                my $by_name = $ctx->{www}->{pi_cfg}->{-by_name};
                for my $name (@$ibx_names) {
                        my $ibx = $by_name->{$name} // do {
@@ -167,12 +187,13 @@ sub ibx_url_for {
                                next;
                        };
                        $ibx->isrch // next;
-                       return defined($ibx->{url}) ?
-                               prurl($ctx->{env}, $ibx->{url}) :
-                               "../../../$name/";
+                       my $u = defined($ibx->{url}) ?
+                               prurl($ctx->{env}, $ibx->{url}) : $name;
+                       $u .= '/' if substr($u, -1) ne '/';
+                       push @ret, $u;
                }
        }
-       undef;
+       wantarray ? (@ret) : $ret[0];
 }
 
 sub cmt_finalize {
@@ -190,13 +211,15 @@ sub cmt_finalize {
                $au =~ s/>/>$x/;
        }
        $_ = ascii_html($_) for ($au, $co);
+       my $ibx_url = ibx_url_for($ctx) // $upfx;
        $au =~ s!(&gt; +)([0-9]{4,}-\S+ \S+)!
                my ($gt, $t) = ($1, $2);
                $t =~ tr/ :-//d;
                qq($gt<a
-href="$upfx?t=$t"
+href="$ibx_url?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;
@@ -253,8 +276,10 @@ EOM
                        my $ibx_url = ibx_url_for($ctx);
                        my $alt;
                        if (defined $ibx_url) {
+                               $alt = " `$ibx_url'";
+                               $ibx_url =~ m!://! or
+                                       substr($ibx_url, 0, 0, '../../../');
                                $ibx_url = ascii_html($ibx_url);
-                               $alt = ' '.$ibx_url;
                        } else {
                                $ibx_url = $upfx;
                                $alt = '';
@@ -362,10 +387,18 @@ sub show_tree_result ($$) {
        my @ent = split(/\0/, $$bref);
        my $qp = delete $ctx->{qp};
        my $l = $ctx->{-linkify} //= PublicInbox::Linkify->new;
-       my $pfx = $qp->{b};
+       my $pfx = $ctx->{-path} // $qp->{b}; # {-path} is from RepoTree
        $$bref = "<pre><a href=#tree>tree</a> $ctx->{tree_oid}";
+       # $REPO/tree/$path already sets {-upfx}
+       my $upfx = $ctx->{-upfx} //= '../../';
        if (defined $pfx) {
-               if ($pfx eq '') {
+               $pfx =~ s!/+\z!!s;
+               if (my $t = $ctx->{-obj}) {
+                       my $t = ascii_html($t);
+                       $$bref .= <<EOM
+\n\$ git ls-tree -l $t # shows similar output on the CLI
+EOM
+               } elsif ($pfx eq '') {
                        $$bref .= "  (root)\n";
                } else {
                        my $x = ascii_html($pfx);
@@ -376,7 +409,7 @@ sub show_tree_result ($$) {
                $pfx = '';
                $$bref .= qq[  (<a href=#path>path</a> unknown)\n];
        }
-       my ($x, $m, $t, $oid, $sz, $f, $n);
+       my ($x, $m, $t, $oid, $sz, $f, $n, $gitlink);
        $$bref .= "\n   size    name";
        for (@ent) {
                ($x, $f) = split(/\t/, $_, 2);
@@ -387,27 +420,31 @@ sub show_tree_result ($$) {
                $n = ascii_html($f);
                if ($m eq 'g') { # gitlink submodule commit
                        $$bref .= "\ng\t\t$n @ <a\nhref=#g>commit</a>$oid";
+                       $gitlink = 1;
                        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 .= qq(\n$m\t$sz\t<a\nhref="$upfx$oid/s/?$q">$n</a>);
        }
        $$bref .= dbg_log($ctx);
        $$bref .= <<EOM;
-<pre>glossary
+<hr><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.
+reference blobs, sub-trees, or (rarely) 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.
+EOM
+
+       $$bref .= <<EOM if $gitlink;
 
 <dfn title="submodule commit"
 id=g>Commit</dfn> objects may be stored in trees to reference submodules.</pre>
@@ -416,7 +453,7 @@ EOM
        html_page($ctx, 200, $$bref);
 }
 
-sub show_tree ($$) {
+sub show_tree ($$) { # also used by RepoTree
        my ($ctx, $res) = @_;
        my ($git, $oid, undef, $size) = @$res;
        $size > $MAX_SIZE and return html_page($ctx, 200,
@@ -457,44 +494,55 @@ sub show_tag ($$) {
        my ($ctx, $res) = @_;
        my ($git, $oid) = @$res;
        $ctx->{git} = $git;
-       if ($ctx->{env}->{'pi-httpd.async'}) {
-               ibx_async_cat($ctx, $oid, \&show_tag_result, $ctx);
-       } else { # synchronous (generic PSGI)
-               $git->cat_async($oid, \&show_tag_result, $ctx);
-               $git->cat_async_wait;
-       }
+       do_cat_async($ctx, \&show_tag_result, $oid);
 }
 
 # 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));
+       $res or return html_page($ctx, 404, 'Not found', dbg_log($ctx));
+       ref($res) eq 'ARRAY' or
+               return html_page($ctx, 500, 'Internal error', dbg_log($ctx));
 
        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_tag($ctx, $res) if $type eq 'tag';
        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>)";
+       my $fn = $di->{path_b} // $hints->{path_b};
+       my $paths = $ctx->{-paths} //= do {
+               my $path = to_filename($fn // 'blob');
+               my $raw_more = qq[(<a\nhref="$path">raw</a>)];
+               my @def;
+
+               # XXX not sure if this is the correct wording
+               if (defined($fn)) {
+                       $raw_more .= qq(
+name: ${\ascii_html($fn)} \t # note: path name is non-authoritative<a
+href="#pathdef" id=top>(*)</a>);
+                       $def[0] = "<hr><pre\nid=pathdef>" .
+'(*) Git path names are given by the tree(s) the blob belongs to.
+    Blobs themselves have no identifier aside from the hash of its contents.'.
+qq(<a\nhref="#top">^</a></pre>);
+               }
+               [ $path, $raw_more, @def ];
+       };
+       $ctx->{-q_value_html} //= do {
+               my $s = defined($fn) ? 'dfn:'.ascii_html($fn).' ' : '';
+               $s.'dfpost:'.substr($oid, 0, 7);
+       };
+
        if ($size > $MAX_SIZE) {
                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>
+blob $oid $size bytes $paths->[1]</pre>
 EOM
        }
-       @{$ctx->{-paths}} = ($path, $raw_link);
        bless $ctx, 'PublicInbox::WwwStream'; # for DESTROY
        $ctx->{git} = $git;
-       if ($ctx->{env}->{'pi-httpd.async'}) {
-               ibx_async_cat($ctx, $oid, \&show_blob, $ctx);
-       } else { # synchronous
-               $git->cat_async($oid, \&show_blob, $ctx);
-               $git->cat_async_wait;
-       }
+       do_cat_async($ctx, \&show_blob, $oid);
 }
 
 sub show_blob { # git->cat_async callback
@@ -512,10 +560,10 @@ sub show_blob { # git->cat_async callback
                return delete($ctx->{-wcb})->([200, $h, [ $$blob ]]);
        }
 
-       my ($path, $raw_link) = @{delete $ctx->{-paths}};
+       my ($path, $raw_more, @def) = @{delete $ctx->{-paths}};
        $bin and return html_page($ctx, 200,
                                "<pre>blob $oid $size bytes (binary)" .
-                               " $raw_link</pre>".dbg_log($ctx));
+                               " $raw_more</pre>".dbg_log($ctx));
 
        # TODO: detect + convert to ensure validity
        utf8::decode($$blob);
@@ -531,7 +579,7 @@ sub show_blob { # git->cat_async callback
        }
 
        # using some of the same CSS class names and ids as cgit
-       my $x = "<pre>blob $oid $size bytes $raw_link</pre>" .
+       my $x = "<pre>blob $oid $size bytes $raw_more</pre>" .
                "<hr /><table\nclass=blob>".
                "<tr><td\nclass=linenumbers><pre>";
        # scratchpad in this loop is faster here than `printf $zfh':
@@ -539,7 +587,7 @@ sub show_blob { # git->cat_async callback
        $x .= '</pre></td><td><pre> </pre></td>'. # pad for non-CSS users
                "<td\nclass=lines><pre\nstyle='white-space:pre'><code>";
        html_page($ctx, 200, $x, $ctx->{-linkify}->linkify_2($$blob),
-               '</code></pre></td></tr></table>'.dbg_log($ctx));
+               '</code></pre></td></tr></table>'.dbg_log($ctx), @def);
 }
 
 # GET /$INBOX/$GIT_OBJECT_ID/s/
@@ -554,7 +602,10 @@ sub show ($$;$) {
        }
        $ctx->{fn} = $fn;
        $ctx->{-tmp} = File::Temp->newdir("solver.$oid_b-XXXX", TMPDIR => 1);
-       open $ctx->{lh}, '+>>', "$ctx->{-tmp}/solve.log" or die "open: $!";
+       unless ($ctx->{lh}) {
+               open $ctx->{lh}, '+>>', "$ctx->{-tmp}/solve.log" or
+                       die "open: $!";
+       }
        my $solver = PublicInbox::SolverGit->new($ctx->{ibx},
                                                \&solve_result, $ctx);
        $solver->{gits} //= [ $ctx->{git} ];