]> git.madduck.net Git - code/myrepos.git/blob - mr

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

f2e4af5142c3518635d1541c077cf5c498d55b34
[code/myrepos.git] / mr
1 #!/usr/bin/perl
2
3 =head1 NAME
4
5 mr - a Multiple Repository management tool
6
7 =head1 SYNOPSIS
8
9 B<mr> [options] checkout
10
11 B<mr> [options] update
12
13 B<mr> [options] status
14
15 B<mr> [options] commit [-m "message"]
16
17 B<mr> [options] action [params ...]
18
19 =head1 DESCRIPTION
20
21 B<mr> is a Multiple Repository management tool. It allows you to register a
22 set of repositories in a .mrconfig file, and then checkout, update, or
23 perform other actions on all of the repositories at once.
24
25 Any mix of revision control systems can be used with B<mr>, and you can
26 define arbitrary actions for commands like "update", "checkout", or "commit".
27
28 The predefined commands should be fairly familiar to users of any revision
29 control system:
30
31 =over 4
32
33 =item checkout (or co)
34
35 Checks out all the registered repositories that are not already checked
36 out.
37
38 =item update
39
40 Updates each registered repository from its configured remote repository.
41
42 If a repository isn't checked out yet, it will first check it out.
43
44 =item status
45
46 Displays a status report for each registered repository, showing what
47 uncommitted changes are present in the repository.
48
49 =item commit (or ci)
50
51 Commits changes to each registered repository. (By default, changes
52 are pushed to the remote repository too, when using distributed systems
53 like git.)
54
55 The optional -m parameter allows specifying a commit message.
56
57 =back
58
59 Actions can be abbreviated to any unambiguous subsctring, so
60 "mr st" is equivilant to "mr status".
61
62 =head1 OPTIONS
63
64 =over 4
65
66 =item -d directory
67
68 Specifies the topmost directory that B<mr> should work in. The default is
69 the current working directory. B<mr> will operate on all registered
70 repositories at or under the directory.
71
72 =item -c mrconfig
73
74 Use the specified mrconfig file, instead of looking for on in your home
75 directory.
76
77 =item -v
78
79 Be verbose.
80
81 =back
82
83 =head1 FILES
84
85 B<mr> is configured by .mrconfig files. It starts by reading the .mrconfig
86 file in your home directory. Each repository specified in a .mrconfig file
87 can also have its own .mrconfig file in its root directory that can
88 optionally be used as well. So you could have a ~/.mrconfig that registers a
89 repository ~/src, that itself contains a ~/src/.mrconfig file, that in turn
90 registers several additional repositories.
91
92 The .mrconfig file uses a variant of the INI file format. Lines starting with
93 "#" are comments. Lines ending with "\" are continued on to the next line.
94 Sections specify where each repository is located, relative to the
95 directory that contains the .mrconfig file.
96
97 Within a section, each parameter defines a shell command to run to handle a
98 given action. Note that these shell commands are run in a "set -e" shell
99 environment, where any additional parameters you pass are available in
100 "$@". B<mr> cds into the repository directory before running
101 a command, except for the "checkout" command, which is run in the parent
102 of the repository directory, since the repository isn't checked out yet.
103
104 There are three special parameters. If the "skip" parameter is set and
105 its command returns nonzero, then B<mr> will skip acting on that repository.
106 If the "chain" parameter is set and its command returns nonzero, then B<mr>
107 will try to load a .mrconfig file from the root of the repository. (You
108 should avoid chaining from repositories with untrusted committers.) The
109 "lib" parameter can specify some shell code that will be run before each
110 command, this can be a useful way to define shell functions other commands
111 can use.
112
113 The "default" section allows setting up default handlers for each action,
114 and is overridden by the contents of other sections. mr contains default
115 handlers for the "update", "status", and "commit" actions, so normally
116 you only need to specify what to do for "checkout".
117
118 The "alias" section allows adding aliases for commands. Each parameter
119 is an alias, and its value is the command to run.
120
121 For example:
122
123   [src]
124   checkout = svn co svn://svn.example.com/src/trunk src
125   chain = true
126
127   [src/linux-2.6]
128   skip = small
129   checkout = git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
130
131   [default]
132   lib = \
133   small() {
134         case "$(hostname)" in; \
135         slug|snail); \
136                 return 0; ;; ; \
137         esac; \
138         return 1; \
139   }
140
141 =head1 AUTHOR
142
143 Copyright 2007 Joey Hess <joey@kitenet.net>
144
145 Licensed under the GNU GPL version 2 or higher.
146
147 http://kitenet.net/~joey/code/mr/
148
149 =cut
150
151 use warnings;
152 use strict;
153 use Getopt::Long;
154 use Cwd qw(getcwd abs_path);
155
156 my $directory=getcwd();
157 my $config="$ENV{HOME}/.mrconfig";
158 my $verbose=0;
159 my %config;
160 my %knownactions;
161 my %alias;
162
163 Getopt::Long::Configure("no_permute");
164 my $result=GetOptions(
165         "d=s" => sub { $directory=abs_path($_[1]) },
166         "c=s" => \$config,
167         "v" => \$verbose,
168 );
169 if (! $result || @ARGV < 1) {
170         die("Usage: mr [-d directory] action [params ...]\n");
171 }
172
173 loadconfig(\*DATA);
174 loadconfig($config);
175 #use Data::Dumper;
176 #print Dumper(\%config);
177
178 my $action=shift @ARGV;
179 if (! exists $knownactions{$action}) {
180         if (exists $alias{$action}) {
181                 $action=$alias{$action};
182         }
183         else {
184                 my @matches = grep { /^\Q$action\E/ }
185                         keys %knownactions, keys %alias;
186                 if (@matches == 1) {
187                         $action=$matches[0];
188                 }
189                 else {
190                         die "mr: ambiguous action \"$action\" (matches @matches)\n";
191                 }
192         }
193 }
194
195 my (@failed, @successful, @skipped);
196 my $first=1;
197 foreach my $topdir (sort keys %config) {
198         foreach my $subdir (sort keys %{$config{$topdir}}) {
199                 next if $subdir eq 'default';
200                 
201                 my $dir=$topdir.$subdir;
202
203                 if (defined $directory &&
204                     $dir ne $directory &&
205                     $dir !~ /^\Q$directory\E\//) {
206                         print "mr $action: $dir skipped per -d parameter ($directory)\n" if $verbose;
207                         push @skipped, $dir;
208                         next;
209                 }
210
211                 print "\n" unless $first;
212                 $first=0;
213
214                 action($action, $dir, $topdir, $subdir);
215
216         }
217 }
218
219 sub action {
220         my ($action, $dir, $topdir, $subdir) = @_;
221         
222         my $lib= exists $config{$topdir}{$subdir}{lib} ?
223                         $config{$topdir}{$subdir}{lib} : "";
224
225         if ($action eq 'checkout') {
226                 if (-d $dir) {
227                         print "mr $action: $dir already exists, skipping checkout\n" if $verbose;
228                         push @skipped, $dir;
229                         return;
230                 }
231                 $dir=~s/^(.*)\/[^\/]+\/?$/$1/;
232         }
233         elsif ($action eq 'update') {
234                 if (! -d $dir) {
235                         return action("checkout", $dir, $topdir, $subdir);
236                 }
237         }
238         
239         if (! chdir($dir)) {
240                 print STDERR "mr $action: failed to chdir to $dir: $!\n";
241                 push @skipped, $dir;
242         }
243
244         if (exists $config{$topdir}{$subdir}{skip}) {
245                 my $ret=system($lib.$config{$topdir}{$subdir}{skip});
246                 if ($ret >> 8 == 0) {
247                         print "mr $action: $dir skipped per config file\n" if $verbose;
248                         push @skipped, $dir;
249                         return;
250                 }
251         }
252
253         if (! exists $config{$topdir}{$subdir}{$action}) {
254                 print STDERR "mr $action: no defined $action command for $topdir$subdir, skipping\n";
255                 push @skipped, $dir;
256         }
257         else {
258                 print "mr $action: in $dir\n";
259                 my $command="set -e; ".$lib.
260                         "my_action(){ $config{$topdir}{$subdir}{$action} ; }; my_action ".
261                         join(" ", map { s/\//\/\//g; s/"/\"/g; '"'.$_.'"' } @ARGV);
262                 my $ret=system($command);
263                 if ($ret != 0) {
264                         print STDERR "mr $action: failed to run: $command\n" if $verbose;
265                         push @failed, $topdir.$subdir;
266                         if ($ret >> 8 != 0) {
267                                 print STDERR "mr $action: command failed\n";
268                         }
269                         elsif ($ret != 0) {
270                                 print STDERR "mr $action: command died ($ret)\n";
271                         }
272                 }
273                 else {
274                         push @successful, $dir;
275                 }
276         }
277 }
278
279 sub showstat {
280         my $count=shift;
281         my $singular=shift;
282         my $plural=shift;
283         if ($count) {
284                 return "$count ".($count > 1 ? $plural : $singular);
285         }
286         return;
287 }
288 print "\nmr $action: finished (".join("; ",
289         showstat($#successful+1, "successful", "successful"),
290         showstat($#failed+1, "failed", "failed"),
291         showstat($#skipped+1, "skipped", "skipped"),
292 ).")\n";
293 if (@failed) {
294         exit 1;
295 }
296 elsif (! @successful && @skipped) {
297         exit 1;
298 }
299 exit 0;
300
301 my %loaded;
302 sub loadconfig {
303         my $f=shift;
304
305         my @toload;
306
307         my $in;
308         my $dir;
309         if (ref $f eq 'GLOB') {
310                 $in=$f; 
311                 $dir="";
312         }
313         else {
314                 # $f might be a symlink
315                 my $absf=abs_path($f);
316                 if ($loaded{$absf}) {
317                         return;
318                 }
319                 $loaded{$absf}=1;
320
321                 print "mr: loading config $f\n" if $verbose;
322                 open($in, "<", $f) || die "mr: open $f: $!\n";
323                 ($dir)=$f=~/^(.*\/)[^\/]+$/;
324                 if (! defined $dir) {
325                         $dir=".";
326                 }
327                 $dir=abs_path($dir)."/";
328
329                 # copy in defaults from first parent
330                 my $parent=$dir;
331                 while ($parent=~s/^(.*)\/[^\/]+\/?$/$1/) {
332                         if (exists $config{$parent} &&
333                             exists $config{$parent}{default}) {
334                                 $config{$dir}{default}={ %{$config{$parent}{default}} };
335                                 last;
336                         }
337                 }
338         }
339
340         my $section;
341         while (<$in>) {
342                 chomp;
343                 next if /^\s*\#/ || /^\s*$/;
344                 if (/^\s*\[([^\]]*)\]\s*$/) {
345                         $section=$1;
346                 }
347                 elsif (/^\s*(\w+)\s*=\s*(.*)/) {
348                         my $parameter=$1;
349                         my $value=$2;
350
351                         # continuation line
352                         while ($value=~/(.*)\\$/) {
353                                 $value=$1.<$in>;
354                                 chomp $value;
355                         }
356
357                         if (! defined $section) {
358                                 die "$f line $.: parameter ($parameter) not in section\n";
359                         }
360                         if ($section ne 'alias' &&
361                             ! exists $config{$dir}{$section} &&
362                             exists $config{$dir}{default}) {
363                                 # copy in defaults
364                                 $config{$dir}{$section}={ %{$config{$dir}{default}} };
365                         }
366                         if ($section eq 'alias') {
367                                 $alias{$parameter}=$value;
368                         }
369                         elsif ($parameter eq 'lib') {
370                                 $config{$dir}{$section}{lib}.=$value." ; ";
371                         }
372                         else {
373                                 $config{$dir}{$section}{$parameter}=$value;
374                                 $knownactions{$parameter}=1;
375                                 if ($parameter eq 'chain' &&
376                                     length $dir && $section ne "default" &&
377                                     -e $dir.$section."/.mrconfig" &&
378                                     system($value) >> 8 == 0) {
379                                         push @toload, $dir.$section."/.mrconfig";
380                                 }
381                         }
382                 }
383                 else {
384                         die "$f line $.: parse error\n";
385                 }
386         }
387         close $in;
388
389         foreach (@toload) {
390                 loadconfig($_);
391         }
392 }
393
394 # Finally, some useful actions that mr knows about by default.
395 # These can be overridden in ~/.mrconfig.
396 __DATA__
397 [alias]
398         co = checkout
399         ci = commit
400 [default]
401 lib = \
402         error() { \
403                 echo "mr: $@" >&2; \
404                 exit 1; \
405         }
406 update = \
407         if [ -d .svn ]; then \
408                 svn update; \
409         elif [ -d .git ]; then \
410                 git pull origin master; \
411         else \
412                 error "unknown repo type"; \
413         fi
414 status = \
415         if [ -d .svn ]; then \
416                 svn status; \
417         elif [ -d .git ]; then \
418                 git status || true; \
419         else \
420                 error "unknown repo type"; \
421         fi
422 commit = \
423         if [ -d .svn ]; then \
424                 svn commit "$@"; \
425         elif [ -d .git ]; then \
426                 git commit -a "$@" && git push --all; \
427         else \
428                 error "unknown repo type"; \
429         fi