chiark / gitweb /
some ---- comments
[topbloke.git] / Topbloke.pm
index 56055cf688bb42dc3a007c5603c7c2499b3b3fad..66139e15b4907913296a88227051309366499216 100644 (file)
@@ -1,13 +1,15 @@
 # -*- perl -*-
 
+package Topbloke;
+
 use strict;
 use warnings;
 
 use POSIX;
 use IO::File;
 use IPC::Open2;
-
-package Topbloke;
+use File::Path qw(make_path remove_tree);
+use File::Basename;
 
 BEGIN {
     use Exporter   ();
@@ -17,13 +19,15 @@ BEGIN {
     @ISA         = qw(Exporter);
     @EXPORT      = qw(debug
                      run_git run_git_1line run_git_check_nooutput
-                     run_git_test_anyoutput
-                     git_config git_dir chdir_toplevel
-                     current_branch parse_patch_spec
+                     run_git_test_anyoutput git_get_object
+                     git_config git_dir chdir_toplevel enable_reflog
+                     current_branch parse_patch_spec parse_patch_name
                      setup_config check_no_unwanted_metadata
+                     patch_matches_spec
                      foreach_patch
                      flagsfile_add_flag
-                     wf_start wf wf_abort wf_done wf_contents);
+                     wf_start wf wf_abort wf_done wf_contents
+                     closeout);
     %EXPORT_TAGS = ( );
     @EXPORT_OK   = qw();
 }
@@ -35,6 +39,8 @@ sub debug ($) {
     print STDERR "DEBUG: $msg\n" or die $!;
 }
 
+#----- general interaction with git -----
+
 sub run_git {
     # takes optional prefix arguments:
     #    coderef    hook to call for each line read,
@@ -93,21 +99,27 @@ sub git_get_object ($) {
     my ($objname) = @_;
     our ($gro_pid, $gro_out, $gro_in);
     if (!$gro_pid) {
-       $gro_pid = IPC::Open2::open2($gro_out, $gro_in,
-                                    $git_command, qw(cat-file --batch))
+       $gro_pid = open2($gro_out, $gro_in, $git_command, qw(cat-file --batch))
            or die $!;
     }
+    #debug("git_get_object $objname");
     $SIG{'PIPE'} = 'IGN';
     print $gro_in $objname,"\n" or die $!;
     $gro_in->flush or die "$objname $!";
     $SIG{'PIPE'} = 'DFL';
     my $l = <$gro_out>;
     chomp $l or die "$objname $l ?";
+    #debug("git_get_object $objname => $l");
     if ($l =~ m/ missing$/) {
        return 'missing';
     } elsif (my ($type,$bytes) = $l =~ m/^\S+ (\w+) (\d+)$/) {
-       my $data;
-       read $gro_out, $data, $bytes == $bytes or die "$objname $!";
+       my $data = '';
+       if ($bytes) {
+           (read $gro_out, $data, $bytes) == $bytes or die "$objname $!";
+       }
+       my $nl;
+       (read $gro_out, $nl, 1) == 1 or die "$objname $!";
+       $nl eq "\n" or die "$objname ?";
        return ($type, $data);
     } else {
        die "$objname $l";
@@ -138,6 +150,8 @@ sub git_dir () {
     return $git_dir;
 }
 
+#----- specific interactions with git -----
+
 sub chdir_toplevel () {
     my $toplevel;
     run_git(sub { $toplevel = $_; }, 
@@ -146,6 +160,81 @@ sub chdir_toplevel () {
     chdir $toplevel or die "chdir toplevel $toplevel: $!\n";
 }
 
+sub enable_reflog ($) {
+    my ($branchref) = @_;
+    $branchref =~ m#^refs/# or die;
+    my $logsdir = git_dir().'/logs/';
+    my $dirname = $logsdir.dirname($branchref);
+    make_path($dirname) or die "$dirname $!";
+    open REFLOG, '>>', $logsdir.$branchref or die "$logsdir$branchref $!";
+    close REFLOG or die $!;
+}    
+
+sub check_no_unwanted_metadata ($) {
+    # for checking foreign branches aren't contaminated
+    my ($gitbranch) = @_;
+    run_git_check_nooutput('foreign unexpectedly contains',
+                          qw(ls-tree --name-only),
+                          "$gitbranch:",
+                          qw(.topbloke));
+}
+
+#----- configuring a tree -----
+
+sub setup_config () {
+    my (@files) = (qw(msg deps included flags pflags));
+    my $version = 1;
+    foreach my $iteration (qw(0 1)) {
+       foreach my $file (@files) {
+           my $cfgname = "merge.topbloke-$file";
+           my ($current, $current_estatus);
+           run_git(\$current_estatus,
+                   sub { $current = $_; },
+                   qw(config), "$cfgname.driver");
+           $current = "## failed $current_estatus" if $current_estatus;
+           next if $current =~ m/^topbloke-merge-driver --v$version /o;
+           die "$file $current ?" if $iteration;
+           debug("setting merge driver $file");
+           run_git(qw(config), "$cfgname.name",
+                   "topbloke merge driver for $file");
+           run_git(qw(config), "$cfgname.driver",
+                   "topbloke-merge-driver --v$version".
+                   " $file %O %A %B %L");
+       }
+       my ($newattrs, $attrsfile);
+       foreach my $file (@files) {
+           my $path = ".topbloke/$file";
+           my $current = run_git_1line(qw(check-attr merge), $path);
+           $current =~ s#^\Q$path\E: merge: ## or die "$file $current ?";
+           my $want = "topbloke-$file";
+           next if $current eq $want;
+           die "$file $current ?" unless $current eq 'unspecified';
+           die "$file $current ?" if $iteration;
+           if (!$newattrs) {
+               $attrsfile = git_dir()."/info/attributes";
+               $newattrs = new IO::File "$attrsfile.tmp", 'w'
+                   or die "$attrsfile.tmp: $!";
+               if (!open OA, '<', "$attrsfile") {
+                   die "$attrsfile $!" unless $!==&ENOENT;
+               } else {
+                   while (<OA>) {
+                       print $newattrs $_ or die $!;
+                       print "\n" or die $! unless chomp;
+                   }
+                   die $! if OA->error;
+                   die $! unless close OA;
+               }
+           }
+           print $newattrs "$path\tmerge=$want\n" or die $!;
+       }
+       last if !$newattrs;
+       close $newattrs or die $!;
+       rename "$attrsfile.tmp", "$attrsfile" or die $!;
+    }
+}
+
+#----- branch and patch specs and parsed patch names -----
+
 sub current_branch () {
     open R, git_dir().'/HEAD' or die "open HEAD $!";
     my $ref = <R>;  defined $ref or die $!;
@@ -158,6 +247,7 @@ sub current_branch () {
        };
     }
     if ($ref =~ m#^refs/topbloke-(tip|base)s/([^/\@]*)\@([^/\@]*)/([^/]*)/#) {
+       my $fullname = "$2\@$3/$4/$'";
        return {
            Kind => $1,
            Email => $2,
@@ -165,7 +255,8 @@ sub current_branch () {
            Date => $4,
            Nick => $', #',
            Ref => $ref,
-           DepSpec => "$2\@$3/$4/$'",
+           DepSpec => $fullname,
+           Fullname => $fullname,
        };
     } elsif ($ref =~ m#^refs/heads/#) {
        return {
@@ -192,6 +283,10 @@ sub parse_patch_name ($) {
        Domain => $domain,
        Date => $date,
        Nick => $nick,
+       Kind => 'tip',
+       DepSpec => $patch,
+       Fullname => $patch,
+       Ref => "refs/topbloke-tips/$patch",
     };
 }
 
@@ -248,67 +343,6 @@ sub parse_patch_spec ($) {
     return $spec;
 }
 
-sub setup_config () {
-    my (@files) = (qw(msg deps included flags pflags));
-    my $version = 1;
-    foreach my $iteration (qw(0 1)) {
-       foreach my $file (@files) {
-           my $cfgname = "merge.topbloke-$file";
-           my ($current, $current_estatus);
-           run_git(\$current_estatus,
-                   sub { $current = $_; },
-                   qw(config), "$cfgname.driver");
-           $current = "## failed $current_estatus" if $current_estatus;
-           next if $current =~ m/^topbloke-merge-driver --v$version /o;
-           die "$file $current ?" if $iteration;
-           debug("setting merge driver $file");
-           run_git(qw(config), "$cfgname.name",
-                   "topbloke merge driver for $file");
-           run_git(qw(config), "$cfgname.driver",
-                   "topbloke-merge-driver --v$version".
-                   " $file %O %A %B %L");
-       }
-       my ($newattrs, $attrsfile);
-       foreach my $file (@files) {
-           my $path = ".topbloke/$file";
-           my $current = run_git_1line(qw(check-attr merge), $path);
-           $current =~ s#^\Q$path\E: merge: ## or die "$file $current ?";
-           my $want = "topbloke-$file";
-           next if $current eq $want;
-           die "$file $current ?" unless $current eq 'unspecified';
-           die "$file $current ?" if $iteration;
-           if (!$newattrs) {
-               $attrsfile = git_dir()."/info/attributes";
-               $newattrs = new IO::File "$attrsfile.tmp", 'w'
-                   or die "$attrsfile.tmp: $!";
-               if (!open OA, '<', "$attrsfile") {
-                   die "$attrsfile $!" unless $!==&ENOENT;
-               } else {
-                   while (<OA>) {
-                       print $newattrs $_ or die $!;
-                       print "\n" or die $! unless chomp;
-                   }
-                   die $! if OA->error;
-                   die $! unless close OA;
-               }
-           }
-           print $newattrs "$path\tmerge=$want\n" or die $!;
-       }
-       last if !$newattrs;
-       close $newattrs or die $!;
-       rename "$attrsfile.tmp", "$attrsfile" or die $!;
-    }
-}
-
-sub check_no_unwanted_metadata ($) {
-    # for checking foreign branches aren't contaminated
-    my ($gitbranch) = @_;
-    run_git_check_nooutput('foreign unexpectedly contains',
-                          qw(ls-tree --name-only),
-                          "$gitbranch:",
-                          qw(.topbloke));
-}
-
 sub patch_matches_spec ($$) {
     my ($parsedname, $spec) = @_;
     foreach my $k (qw(Email Domain Nick)) {
@@ -323,6 +357,8 @@ sub patch_matches_spec ($$) {
     debug("patch_matches_spec  match"), return 1;
 }
 
+#----- reading topbloke metadata -----
+
 sub foreach_patch ($$$$) {
     my ($spec, $deleted_ok, $want, $body) = @_;
     # runs $body->($patch, $parsedname, \%flags, \%deps, \%pflags, \%included)
@@ -378,6 +414,8 @@ sub foreach_patch ($$$$) {
                qw(refs/topbloke-tips));
 }
 
+#----- updating topbloke metadata -----
+
 sub flagsfile_add_flag ($$) {
     # works on "deps" too
     my ($flagsfile, $flag) = @_;
@@ -394,6 +432,8 @@ sub flagsfile_add_flag ($$) {
     wf_done($wf);
 }
 
+#----- general utilities -----
+
 sub wf_start ($) {
     my ($path) = @_;
     my $fh = new IO::File "$path.tmp", '>' or die "create $path.tmp: $!\n";
@@ -427,4 +467,9 @@ sub wf_contents ($$) {
     wf_done($wf);
 }
 
+sub closeout () {
+    STDOUT->error and die $!;
+    close STDOUT or die $!;
+}
+
 1;