]> 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:

f8b78c01a8843061714fd66b1926e4cb50f4daeb
[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
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
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 For example:
119
120   [src]
121   checkout = svn co svn://svn.example.com/src/trunk src
122   chain = true
123
124   [src/linux-2.6]
125   skip = small
126   checkout = git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
127
128   [default]
129   lib = \
130   small() {
131         case "$(hostname)" in; \
132         slug|snail); \
133                 return 0; ;; ; \
134         esac; \
135         return 1; \
136   }
137
138 =head1 AUTHOR
139
140 Copyright 2007 Joey Hess <joey@kitenet.net>
141
142 Licensed under the GNU GPL version 2 or higher.
143
144 http://kitenet.net/~joey/code/mr/
145
146 =cut
147
148 use warnings;
149 use strict;
150 use Getopt::Long;
151 use Cwd qw(getcwd abs_path);
152
153 my $directory=getcwd();
154 my $config="$ENV{HOME}/.mrconfig";
155 my $verbose=0;
156 my %config;
157 my %knownactions;
158
159 Getopt::Long::Configure("no_permute");
160 my $result=GetOptions(
161         "d=s" => sub { $directory=abs_path($_[1]) },
162         "c=s" => \$config,
163         "v" => \$verbose,
164 );
165 if (! $result || @ARGV < 1) {
166         die("Usage: mr [-d directory] action [params ...]\n");
167 }
168
169 loadconfig(\*DATA);
170 loadconfig($config);
171 #use Data::Dumper;
172 #print Dumper(\%config);
173
174 my $action=shift @ARGV;
175 if (! $knownactions{$action}) {
176         my @matches = grep { /^\Q$action\E/ } keys %knownactions;
177         if (@matches == 1) {
178                 $action=$matches[0];
179         }
180         else {
181                 die "mr: ambiguous action \"$action\" (matches @matches)\n";
182         }
183 }
184
185 my (@failed, @successful, @skipped);
186 my $first=1;
187 foreach my $topdir (sort keys %config) {
188         foreach my $subdir (sort keys %{$config{$topdir}}) {
189                 next if $subdir eq 'default';
190                 
191                 my $dir=$topdir.$subdir;
192
193                 if (defined $directory &&
194                     $dir ne $directory &&
195                     $dir !~ /^\Q$directory\E\//) {
196                         print "mr $action: $dir skipped per -d parameter ($directory)\n" if $verbose;
197                         push @skipped, $dir;
198                         next;
199                 }
200
201                 print "\n" unless $first;
202                 $first=0;
203
204                 action($action, $dir, $topdir, $subdir);
205
206         }
207 }
208
209 sub action {
210         my ($action, $dir, $topdir, $subdir) = @_;
211         
212         my $lib= exists $config{$topdir}{$subdir}{lib} ?
213                         $config{$topdir}{$subdir}{lib} : "";
214
215         if ($action eq 'checkout') {
216                 if (-d $dir) {
217                         print "mr $action: $dir already exists, skipping checkout\n" if $verbose;
218                         push @skipped, $dir;
219                         return;
220                 }
221                 $dir=~s/^(.*)\/[^\/]+\/?$/$1/;
222         }
223         elsif ($action eq 'update') {
224                 if (! -d $dir) {
225                         return action("checkout", $dir, $topdir, $subdir);
226                 }
227         }
228         
229         if (! chdir($dir)) {
230                 print STDERR "mr $action: failed to chdir to $dir: $!\n";
231                 push @skipped, $dir;
232         }
233
234         if (exists $config{$topdir}{$subdir}{skip}) {
235                 my $ret=system($lib.$config{$topdir}{$subdir}{skip});
236                 if ($ret >> 8 == 0) {
237                         print "mr $action: $dir skipped per config file\n" if $verbose;
238                         push @skipped, $dir;
239                         next;
240                 }
241         }
242
243         if (! exists $config{$topdir}{$subdir}{$action}) {
244                 print STDERR "mr $action: no defined $action command for $topdir$subdir, skipping\n";
245                 push @skipped, $dir;
246         }
247         else {
248                 print "mr $action: in $dir\n";
249                 my $command="set -e; ".$lib.
250                         "my_action(){ $config{$topdir}{$subdir}{$action} ; }; my_action ".
251                         join(" ", map { s/\//\/\//g; s/"/\"/g; '"'.$_.'"' } @ARGV);
252                 my $ret=system($command);
253                 if ($ret != 0) {
254                         print STDERR "mr $action: failed to run: $command\n" if $verbose;
255                         push @failed, $topdir.$subdir;
256                         if ($ret >> 8 != 0) {
257                                 print STDERR "mr $action: command failed\n";
258                         }
259                         elsif ($ret != 0) {
260                                 print STDERR "mr $action: command died ($ret)\n";
261                         }
262                 }
263                 else {
264                         push @successful, $dir;
265                 }
266         }
267 }
268
269 sub showstat {
270         my $count=shift;
271         my $singular=shift;
272         my $plural=shift;
273         if ($count) {
274                 return "$count ".($count > 1 ? $plural : $singular);
275         }
276         return;
277 }
278 print "\nmr $action: finished (".join("; ",
279         showstat($#successful+1, "successful", "successful"),
280         showstat($#failed+1, "failed", "failed"),
281         showstat($#skipped+1, "skipped", "skipped"),
282 ).")\n";
283 if (@failed) {
284         exit 1;
285 }
286 elsif (! @successful && @skipped) {
287         exit 1;
288 }
289 exit 0;
290
291 my %loaded;
292 sub loadconfig {
293         my $f=shift;
294
295         my @toload;
296
297         my $in;
298         my $dir;
299         if (ref $f eq 'GLOB') {
300                 $in=$f; 
301                 $dir="";
302         }
303         else {
304                 # $f might be a symlink
305                 my $absf=abs_path($f);
306                 if ($loaded{$absf}) {
307                         return;
308                 }
309                 $loaded{$absf}=1;
310
311                 print "mr: loading config $f\n" if $verbose;
312                 open($in, "<", $f) || die "mr: open $f: $!\n";
313                 ($dir)=$f=~/^(.*\/)[^\/]+$/;
314                 if (! defined $dir) {
315                         $dir=".";
316                 }
317                 $dir=abs_path($dir)."/";
318
319                 # copy in defaults from first parent
320                 my $parent=$dir;
321                 while ($parent=~s/^(.*)\/[^\/]+\/?$/$1/) {
322                         if (exists $config{$parent} &&
323                             exists $config{$parent}{default}) {
324                                 $config{$dir}{default}={ %{$config{$parent}{default}} };
325                                 last;
326                         }
327                 }
328         }
329
330         my $section;
331         while (<$in>) {
332                 chomp;
333                 next if /^\s*\#/ || /^\s*$/;
334                 if (/^\s*\[([^\]]*)\]\s*$/) {
335                         $section=$1;
336                 }
337                 elsif (/^\s*(\w+)\s*=\s*(.*)/) {
338                         my $parameter=$1;
339                         my $value=$2;
340
341                         # continuation line
342                         while ($value=~/(.*)\\$/) {
343                                 $value=$1.<$in>;
344                                 chomp $value;
345                         }
346
347                         if (! defined $section) {
348                                 die "$f line $.: parameter ($parameter) not in section\n";
349                         }
350                         if (! exists $config{$dir}{$section} &&
351                               exists $config{$dir}{default}) {
352                                 # copy in defaults
353                                 $config{$dir}{$section}={ %{$config{$dir}{default}} };
354                         }
355                         if ($parameter ne 'lib') {
356                                 $config{$dir}{$section}{$parameter}=$value;
357                                 $knownactions{$parameter}=1;
358                         }
359                         else {
360                                 $config{$dir}{$section}{$parameter}.=$value." ; ";
361                         }
362
363                         if ($parameter eq 'chain' &&
364                             length $dir && $section ne "default" &&
365                             -e $dir.$section."/.mrconfig" &&
366                             system($value) >> 8 == 0) {
367                                 push @toload, $dir.$section."/.mrconfig";
368                         }
369                 }
370                 else {
371                                 die "$f line $.: parse error\n";
372                 }
373         }
374         close $in;
375
376         foreach (@toload) {
377                 loadconfig($_);
378         }
379 }
380
381 # Finally, some useful actions that mr knows about by default.
382 # These can be overridden in ~/.mrconfig.
383 __DATA__
384 [default]
385 lib = \
386         error() { \
387                 echo "mr: $@" >&2; \
388                 exit 1; \
389         }
390 update = \
391         if [ -d .svn ]; then \
392                 svn update; \
393         elif [ -d .git ]; then \
394                 git pull origin master; \
395         else \
396                 error "unknown repo type"; \
397         fi
398 status = \
399         if [ -d .svn ]; then \
400                 svn status; \
401         elif [ -d .git ]; then \
402                 git status || true; \
403         else \
404                 error "unknown repo type"; \
405         fi
406 commit = \
407         if [ -d .svn ]; then \
408                 svn commit "$@"; \
409         elif [ -d .git ]; then \
410                 git commit -a "$@" && git push --all; \
411         else \
412                 error "unknown repo type"; \
413         fi