chiark / gitweb /
FORMAT: put deps etc. in base branch where we need them
[topbloke.git] / Topbloke.pm
1 # -*- perl -*-
2
3 package Topbloke;
4
5 use strict;
6 use warnings;
7
8 use POSIX;
9 use IO::File;
10 use IPC::Open2;
11 use File::Path qw(make_path remove_tree);
12 use File::Basename;
13
14 BEGIN {
15     use Exporter   ();
16     our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
17
18     $VERSION     = 1.00;
19     @ISA         = qw(Exporter);
20     @EXPORT      = qw(debug $tiprefs $baserefs
21                       run_git run_git_1line run_git_check_nooutput
22                       run_git_test_anyoutput git_get_object
23                       git_config git_dir chdir_toplevel enable_reflog
24                       current_branch parse_patch_spec parse_patch_name
25                       setup_config check_no_unwanted_metadata
26                       patch_matches_spec
27                       foreach_patch
28                       propsfile_add_prop depsfile_add_dep
29                       wf_start wf wf_abort wf_done wf_contents
30                       closeout);
31     %EXPORT_TAGS = ( );
32     @EXPORT_OK   = qw();
33 }
34
35 our $git_command = 'git';
36
37 sub debug ($) {
38     my ($msg) = @_;
39     print STDERR "DEBUG: $msg\n" or die $!;
40 }
41
42 #----- general interaction with git -----
43
44 sub run_git {
45     # takes optional prefix arguments:
46     #    coderef    hook to call for each line read,
47     #                with $_ containing chomped line; if not supplied,
48     #                output is not read
49     #    scalarref  place to store exit status; if not supplied,
50     #                nonzero exit status is fatal
51     my ($estatusr,$linecallr);
52     while (ref $_[0]) {
53         my $ref = shift @_;
54         if (ref $ref eq 'SCALAR') {
55             $estatusr = $ref;
56         } elsif (ref $ref eq 'CODE') {
57             $linecallr = $ref;
58         } else {
59             die ref($ref)." @_ ?";
60         }
61     }
62     open GIT, "-|", $git_command, @_ or die $!;
63     if ($linecallr) {
64         while (<GIT>) {
65             chomp or die "$git_command @_ gave $_ ?";
66             $linecallr->();
67         }
68         GIT->eof or die $!;
69     }
70     if (!close GIT) {
71         die "$git_command @_ $!" if $!;
72         die unless $?;
73         die "$git_command @_ ($?)" unless $estatusr;
74         $$estatusr = $?;
75     } else {
76         $$estatusr = 0 if $estatusr;
77     }
78 }
79
80 sub run_git_1line {
81     my $l;
82     run_git(sub { $l = $_; }, @_);
83     die "git @_ ?" unless defined $l;
84     return $l;
85 }
86
87 sub run_git_check_nooutput {
88     my ($what) = shift @_;
89     run_git(sub { die "$what $_\n"; }, @_);
90 }
91
92 sub run_git_test_anyoutput {
93     my $any = 0;
94     run_git(sub { $any=1; }, @_);
95     return $any;
96 }
97
98 sub git_get_object ($) {
99     my ($objname) = @_;
100     our ($gro_pid, $gro_out, $gro_in);
101     if (!$gro_pid) {
102         $gro_pid = open2($gro_out, $gro_in, $git_command, qw(cat-file --batch))
103             or die $!;
104     }
105     #debug("git_get_object $objname");
106     $SIG{'PIPE'} = 'IGN';
107     print $gro_in $objname,"\n" or die $!;
108     $gro_in->flush or die "$objname $!";
109     $SIG{'PIPE'} = 'DFL';
110     my $l = <$gro_out>;
111     chomp $l or die "$objname $l ?";
112     #debug("git_get_object $objname => $l");
113     if ($l =~ m/ missing$/) {
114         return 'missing';
115     } elsif (my ($type,$bytes) = $l =~ m/^\S+ (\w+) (\d+)$/) {
116         my $data = '';
117         if ($bytes) {
118             (read $gro_out, $data, $bytes) == $bytes or die "$objname $!";
119         }
120         my $nl;
121         (read $gro_out, $nl, 1) == 1 or die "$objname $!";
122         $nl eq "\n" or die "$objname ?";
123         return ($type, $data);
124     } else {
125         die "$objname $l";
126     }
127 }
128
129 sub git_config ($$) {
130     my ($cfgvar, $default) = @_;
131     my ($l, $estatus);
132     run_git(\$estatus, sub { 
133         die if defined $l; 
134         $l = $_; },
135             qw(config), $cfgvar);
136     if (defined $l) {
137         die "$cfgvar ($estatus)" if $estatus;
138         return $l;
139     } else {
140         die "$cfgvar ($estatus)" unless $estatus==0 || $estatus==256;
141         return $default;
142     }
143 }
144
145 sub git_dir () {
146     our $git_dir;
147     if (!defined $git_dir) {
148         $git_dir = run_git_1line(qw(rev-parse --git-dir));
149     }
150     return $git_dir;
151 }
152
153 #----- specific interactions with git -----
154
155 sub chdir_toplevel () {
156     my $toplevel;
157     run_git(sub { $toplevel = $_; }, 
158             qw(rev-parse --show-toplevel));
159     die "not in working tree?\n" unless defined $toplevel;
160     chdir $toplevel or die "chdir toplevel $toplevel: $!\n";
161 }
162
163 sub enable_reflog ($) {
164     my ($branchref) = @_;
165     $branchref =~ m#^refs/# or die;
166     my $logsdir = git_dir().'/logs/';
167     my $dirname = $logsdir.dirname($branchref);
168     make_path($dirname) or die "$dirname $!";
169     open REFLOG, '>>', $logsdir.$branchref or die "$logsdir$branchref $!";
170     close REFLOG or die $!;
171 }    
172
173 sub check_no_unwanted_metadata ($) {
174     # for checking foreign branches aren't contaminated
175     my ($gitbranch) = @_;
176     run_git_check_nooutput('foreign unexpectedly contains',
177                            qw(ls-tree --name-only),
178                            "$gitbranch:",
179                            qw(.topbloke));
180 }
181
182 sub check_clean_tree ($) {
183     run_git_check_nooutput("operation requires working tree to be clean",
184                            qw(diff --name-only HEAD --));
185     run_git_check_nooutput("operation cannot proceed with staged changes",
186                            qw(diff --cached --name-only HEAD --));
187 }
188
189 #----- configuring a tree -----
190
191 sub setup_config () {
192     my (@files) = (qw(msg deps included props pprops));
193     my $version = 1;
194     foreach my $iteration (qw(0 1)) {
195         foreach my $file (@files) {
196             my $cfgname = "merge.topbloke-$file";
197             my ($current, $current_estatus);
198             run_git(\$current_estatus,
199                     sub { $current = $_; },
200                     qw(config), "$cfgname.driver");
201             $current = "## failed $current_estatus" if $current_estatus;
202             next if $current =~ m/^topbloke-merge-driver --v$version /o;
203             die "$file $current ?" if $iteration;
204             debug("setting merge driver $file");
205             run_git(qw(config), "$cfgname.name",
206                     "topbloke merge driver for $file");
207             run_git(qw(config), "$cfgname.driver",
208                     "topbloke-merge-driver --v$version".
209                     " $file %O %A %B %L");
210         }
211         my ($newattrs, $attrsfile);
212         foreach my $file (@files) {
213             my $path = ".topbloke/$file";
214             my $current = run_git_1line(qw(check-attr merge), $path);
215             $current =~ s#^\Q$path\E: merge: ## or die "$file $current ?";
216             my $want = "topbloke-$file";
217             next if $current eq $want;
218             die "$file $current ?" unless $current eq 'unspecified';
219             die "$file $current ?" if $iteration;
220             if (!$newattrs) {
221                 $attrsfile = git_dir()."/info/attributes";
222                 $newattrs = new IO::File "$attrsfile.tmp", 'w'
223                     or die "$attrsfile.tmp: $!";
224                 if (!open OA, '<', "$attrsfile") {
225                     die "$attrsfile $!" unless $!==&ENOENT;
226                 } else {
227                     while (<OA>) {
228                         print $newattrs $_ or die $!;
229                         print "\n" or die $! unless chomp;
230                     }
231                     die $! if OA->error;
232                     die $! unless close OA;
233                 }
234             }
235             print $newattrs "$path\tmerge=$want\n" or die $!;
236         }
237         last if !$newattrs;
238         close $newattrs or die $!;
239         rename "$attrsfile.tmp", "$attrsfile" or die $!;
240     }
241 }
242
243 #----- branch and patch specs and parsed patch names -----
244
245 our $tiprefs = 'refs/topbloke-tips';
246 our $baserefs = 'refs/topbloke-bases';
247
248 sub current_branch () {
249     open R, git_dir().'/HEAD' or die "open HEAD $!";
250     my $ref = <R>;  defined $ref or die $!;
251     close R;
252     chomp $ref or die;
253     if ($ref !~ s#^ref: ##) {
254         return {
255             Kind => 'detached',
256             Ref => $ref,
257         };
258     }
259     if ($ref =~ m#^refs/topbloke-(tip|base)s/([^/\@]*)\@([^/\@]*)/([^/]*)/#) {
260         my $fullname = "$2\@$3/$4/$'";
261         return {
262             Kind => $1,
263             Email => $2,
264             Domain => $3,
265             Date => $4,
266             Nick => $', #',
267             Ref => $ref,
268             DepSpec => $fullname,
269             Fullname => $fullname,
270         };
271     } elsif ($ref =~ m#^refs/heads/#) {
272         return {
273             Kind => 'foreign',
274             Ref => $ref,
275             DepSpec => ".f $ref",
276         };
277     } else {
278         return {
279             Kind => 'weird',
280             Ref => $ref,
281         };
282     }
283 }
284
285 sub parse_patch_name ($) {
286     my ($patch) = @_;
287     my ($eaddr, $date, $nick) = split /\//, $patch, 3;
288     defined $nick && length $nick or die "$patch ?";
289     my ($email, $domain) = $eaddr =~ m/^(.*)\@([^\@]+)$/
290         or die "$patch eaddr ?";
291     return {
292         Email => $email,
293         Domain => $domain,
294         Date => $date,
295         Nick => $nick,
296         Kind => 'tip',
297         DepSpec => $patch,
298         Fullname => $patch,
299         Ref => "refs/topbloke-tips/$patch",
300     };
301 }
302
303 sub parse_patch_spec ($) {
304     my ($orig) = @_;
305     local $_ = $orig;
306     my $spec = { }; # Email Domain DatePrefix DateNear Nick
307     my $set = sub {
308         my ($key,$val,$whats) = @_;
309         die "multiple $whats in patch spec\n" if exists $spec->{$key};
310         $spec->{$key} = $val;
311     };
312     my $rel_levels;
313     for (;;) {
314         if (s#([^/\@]*)\@([^/\@]*)/##) {
315             $set->('Email', $1, "email local parts") if length $1;
316             $set->('Domain', $2, "email domains") if length $1;
317         } elsif (s#([^/]*\~[^/]*)/##) {
318             my $dspec = $1;
319             $dspec =~ y/~/ /;
320             open DATE, "-|", 'date','+%s','-d',$dspec or die $!;
321             my $l = <DATE>;
322             close DATE or die "date parsing failed\n";
323             chomp $l or die;
324             $set->('DateNear', $l, 'nearby dates');
325         } elsif (s#^([0-9][^/]*)/##) {
326             my $dspec = $1;
327             $dspec =~ 
328       m/^\d{4}(?:-\d\d(?:-\d\d(?:T(?:\d\d(?:\d\d(?:\d\d(?:Z)?)?)?)?)?)?)?$/
329                 or die "bad date prefix \`$dspec'\n";
330             $set->('DatePrefix', $dspec, 'date prefixes');
331         } elsif (s#^\./##) {
332             $rel_levels ||= 1;
333         } elsif (s#^\.\./##) {
334             $rel_levels ||= 1;
335             $rel_levels++;
336         } else {
337             last;
338         }
339     }
340     if (defined $rel_levels) {
341         my $branch = current_branch();
342         if (!defined $branch->{Nick}) {
343             die "relative patch spec \`$orig',".
344                 " but current branch not a topbloke patch\n";
345         }
346         my ($ceaddr,$cdate,@l) = split /\//, $branch->{Nick};
347         @l >= $rel_levels or
348             die "relative patch spec \`$orig' has too many ../s\n";
349         $_ = (join '/', @l[0..$#l-$rel_levels]).'/'.$_;
350     } elsif (length) {
351         $spec->{Nick} = $_;
352     }
353     return $spec;
354 }
355
356 sub patch_matches_spec ($$) {
357     my ($parsedname, $spec) = @_;
358     foreach my $k (qw(Email Domain Nick)) {
359         debug("patch_matches_spec  mismatch $k"), return 0
360             if defined $spec->{$k} &&
361                $parsedname->{$k} ne $spec->{$k};
362     }
363     debug("patch_matches_spec  mismatch DatePrefix"), return 0
364         if defined $spec->{DatePrefix} &&
365            substr($parsedname->{Date}, 0, length $spec->{DatePrefix})
366                ne $spec->{DatePrefix};
367     debug("patch_matches_spec  match"), return 1;
368 }
369
370 #----- reading topbloke metadata -----
371
372 sub foreach_patch ($$$$) {
373     my ($spec, $deleted_ok, $want, $body) = @_;
374     # runs $body->($patch, $parsedname, \%props, \%deps, \%pprops, \%included)
375     #                                   $want->[0]   1        2         3
376     # where $deps->{$fullname} etc. are 1 for true or nonexistent for false
377     #  and if $want->[$item] is not true, the corresponding item may be undef
378     # and $parsedname is only valid if $spec is not undef
379     #  (say $spec { }  if you want the name parsed but no restrictions)
380     my @want = @$want;
381     $want[0] ||= !$deleted_ok;
382     run_git(sub {
383         debug("foreach_patch considering $_");
384         m/ / or die "$_ ?";
385         my $objname = $`;
386         my @out;
387         my $patch = substr($',19); #');
388         my $wantix = 0;
389         foreach my $file (qw(props deps pprops included)) {
390
391             if ($file eq 'deps') {
392                 # do this check after checking for deleted patches,
393                 # so we don't parse deleted patches' names
394                 # right, check the spec next
395                 if ($spec) {
396                     my $have = parse_patch_name($patch);
397                     debug("foreach_patch  mismatch"), return
398                         unless patch_matches_spec($have, $spec);
399                     unshift @out, $have;
400                 } else {
401                     unshift @out, undef;
402                 }
403             }
404
405             if (!$want[$wantix++]) {
406                 push @out, undef;
407                 next;
408             }
409
410             my ($got, $data) = git_get_object("$objname:.topbloke/$file");
411             die "$patch $file ?" unless defined $data;
412             my %data;
413             if ($file !~ m/props/) {
414                 $data{$_}=1 foreach split /\n/, $data;
415             } elseif {
416                 foreach (split /\n/, $data) {
417                     m/ / or m/$/;
418                     $data{$`} = $'; #';
419                 }
420             }
421
422             if ($file eq 'props') {
423                 debug("foreach_patch  Deleted"), return
424                     if !$deleted_ok && $data{Deleted};
425             }
426
427             push @out, \%data;
428         }
429         debug("foreach_patch  YES ".(join '', map { 0+defined } @out)), return
430         $body->($patch, @out);
431             },
432             qw(for-each-ref --format), '%(objectname) %(refname)',
433                 qw(refs/topbloke-tips));
434 }
435
436 #----- updating topbloke metadata -----
437
438 sub propsfile_set_prop ($$$) {
439     # set $value to undef to delete; returns old value
440     my ($propsfile, $prop, $value) = @_;
441     my $wf = wf_start(".topbloke/$propsfile");
442     my $oldvalue;
443     open FI, '<', ".topbloke/$propsfile" or die $!;
444     while (<FI>) {
445         chomp or die;
446         m/ / or m/$/;
447         if ($` eq $prop) {
448             die "prop $prop repeated in $propsfile ?!" if defined $oldvalue;
449             $oldvalue = $'; #';
450         } else {
451             wf($wf, "$_\n");
452         }
453     }
454     FI->error and die $!;
455     close FI or die $!;
456     wf($wf, "$prop $value\n") if defined $value;
457     wf_done($wf);
458     return $oldvalue;
459 }
460
461 sub depssfile_add_dep ($$) {
462     my ($depsfile, $depspec) = @_;
463     my $wf = wf_start(".topbloke/$depsfile");
464     open FI, '<', ".topbloke/$depsfile" or die $!;
465     while (<FI>) {
466         chomp or die;
467         die "dep $depspec already set in $depsfile ?!" if $_ eq $depspec;
468         wf($wf, "$_\n");
469     }
470     FI->error and die $!;
471     close FI or die $!;
472     wf($wf, "$depspec\n");
473     wf_done($wf);
474 }
475
476 #----- general utilities -----
477
478 sub wf_start ($) {
479     my ($path) = @_;
480     my $fh = new IO::File "$path.tmp", '>' or die "create $path.tmp: $!\n";
481     return [ $fh, $path ];
482 }
483
484 sub wf ($$) {
485     my ($wf, $data) = @_;
486     my ($fh, $path) = @$wf;
487     print $fh $data or die "write $path.tmp: $!\n";
488 }
489
490 sub wf_abort ($) {
491     my ($wf) = @_;
492     my ($fh, $path) = @$wf;
493     close $fh;
494     unlink "$path.tmp" or die "remove $path.tmp: $!\n";
495 }
496
497 sub wf_done ($) {
498     my ($wf) = @_;
499     my ($fh, $path) = @$wf;
500     close $fh or die "finish writing $path.tmp: $!\n";
501     rename "$path.tmp", $path or die "install new $path: $!\n";
502 }
503
504 sub wf_contents ($$) {
505     my ($path,$contents) = @_;
506     my $wf = wf_start($path);
507     wf($wf, $contents);
508     wf_done($wf);
509 }
510
511 sub closeout () {
512     STDOUT->error and die $!;
513     close STDOUT or die $!;
514 }
515
516 1;