]> git.ipfire.org Git - thirdparty/git.git/blame - contrib/examples/git-remote.perl
blame: prefer xsnprintf to strcpy for colors
[thirdparty/git.git] / contrib / examples / git-remote.perl
CommitLineData
e194cd1e
JH
1#!/usr/bin/perl -w
2
7deaec9a 3use strict;
e194cd1e
JH
4use Git;
5my $git = Git->repository();
6
7sub add_remote_config {
8 my ($hash, $name, $what, $value) = @_;
9 if ($what eq 'url') {
95775e53
JH
10 # Having more than one is Ok -- it is used for push.
11 if (! exists $hash->{'URL'}) {
12 $hash->{$name}{'URL'} = $value;
e194cd1e 13 }
e194cd1e
JH
14 }
15 elsif ($what eq 'fetch') {
16 $hash->{$name}{'FETCH'} ||= [];
17 push @{$hash->{$name}{'FETCH'}}, $value;
18 }
8bf0e3d1
JS
19 elsif ($what eq 'push') {
20 $hash->{$name}{'PUSH'} ||= [];
21 push @{$hash->{$name}{'PUSH'}}, $value;
22 }
e194cd1e
JH
23 if (!exists $hash->{$name}{'SOURCE'}) {
24 $hash->{$name}{'SOURCE'} = 'config';
25 }
26}
27
28sub add_remote_remotes {
29 my ($hash, $file, $name) = @_;
30
31 if (exists $hash->{$name}) {
32 $hash->{$name}{'WARNING'} = 'ignored due to config';
33 return;
34 }
35
36 my $fh;
37 if (!open($fh, '<', $file)) {
38 print STDERR "Warning: cannot open $file\n";
39 return;
40 }
41 my $it = { 'SOURCE' => 'remotes' };
42 $hash->{$name} = $it;
43 while (<$fh>) {
44 chomp;
45 if (/^URL:\s*(.*)$/) {
46 # Having more than one is Ok -- it is used for push.
47 if (! exists $it->{'URL'}) {
48 $it->{'URL'} = $1;
49 }
50 }
51 elsif (/^Push:\s*(.*)$/) {
8bf0e3d1
JS
52 $it->{'PUSH'} ||= [];
53 push @{$it->{'PUSH'}}, $1;
e194cd1e
JH
54 }
55 elsif (/^Pull:\s*(.*)$/) {
56 $it->{'FETCH'} ||= [];
57 push @{$it->{'FETCH'}}, $1;
58 }
59 elsif (/^\#/) {
60 ; # ignore
61 }
62 else {
63 print STDERR "Warning: funny line in $file: $_\n";
64 }
65 }
66 close($fh);
67}
68
69sub list_remote {
70 my ($git) = @_;
71 my %seen = ();
72 my @remotes = eval {
e0d10e1c 73 $git->command(qw(config --get-regexp), '^remote\.');
e194cd1e
JH
74 };
75 for (@remotes) {
b5a40a57 76 if (/^remote\.(\S+?)\.([^.\s]+)\s+(.*)$/) {
e194cd1e
JH
77 add_remote_config(\%seen, $1, $2, $3);
78 }
79 }
80
81 my $dir = $git->repo_path() . "/remotes";
82 if (opendir(my $dh, $dir)) {
83 local $_;
84 while ($_ = readdir($dh)) {
85 chomp;
86 next if (! -f "$dir/$_" || ! -r _);
87 add_remote_remotes(\%seen, "$dir/$_", $_);
88 }
89 }
90
91 return \%seen;
92}
93
94sub add_branch_config {
95 my ($hash, $name, $what, $value) = @_;
96 if ($what eq 'remote') {
97 if (exists $hash->{$name}{'REMOTE'}) {
98 print STDERR "Warning: more than one branch.$name.remote\n";
99 }
100 $hash->{$name}{'REMOTE'} = $value;
101 }
102 elsif ($what eq 'merge') {
103 $hash->{$name}{'MERGE'} ||= [];
104 push @{$hash->{$name}{'MERGE'}}, $value;
105 }
106}
107
108sub list_branch {
109 my ($git) = @_;
110 my %seen = ();
111 my @branches = eval {
e0d10e1c 112 $git->command(qw(config --get-regexp), '^branch\.');
e194cd1e
JH
113 };
114 for (@branches) {
115 if (/^branch\.([^.]*)\.(\S*)\s+(.*)$/) {
116 add_branch_config(\%seen, $1, $2, $3);
117 }
118 }
119
120 return \%seen;
121}
122
123my $remote = list_remote($git);
124my $branch = list_branch($git);
125
126sub update_ls_remote {
127 my ($harder, $info) = @_;
128
129 return if (($harder == 0) ||
130 (($harder == 1) && exists $info->{'LS_REMOTE'}));
131
31a92f6a 132 my @ref = map { s|refs/heads/||; $_; } keys %{$git->remote_refs($info->{'URL'}, [ 'heads' ])};
e194cd1e
JH
133 $info->{'LS_REMOTE'} = \@ref;
134}
135
7a8c9ec1 136sub list_wildcard_mapping {
e194cd1e
JH
137 my ($forced, $ours, $ls) = @_;
138 my %refs;
139 for (@$ls) {
140 $refs{$_} = 01; # bit #0 to say "they have"
141 }
142 for ($git->command('for-each-ref', "refs/remotes/$ours")) {
143 chomp;
144 next unless (s|^[0-9a-f]{40}\s[a-z]+\srefs/remotes/$ours/||);
145 next if ($_ eq 'HEAD');
146 $refs{$_} ||= 0;
147 $refs{$_} |= 02; # bit #1 to say "we have"
148 }
149 my (@new, @stale, @tracked);
150 for (sort keys %refs) {
151 my $have = $refs{$_};
152 if ($have == 1) {
153 push @new, $_;
154 }
155 elsif ($have == 2) {
156 push @stale, $_;
157 }
158 elsif ($have == 3) {
159 push @tracked, $_;
160 }
161 }
7a8c9ec1 162 return \@new, \@stale, \@tracked;
e194cd1e
JH
163}
164
7a8c9ec1 165sub list_mapping {
e194cd1e
JH
166 my ($name, $info) = @_;
167 my $fetch = $info->{'FETCH'};
168 my $ls = $info->{'LS_REMOTE'};
7a8c9ec1 169 my (@new, @stale, @tracked);
e194cd1e
JH
170
171 for (@$fetch) {
172 next unless (/(\+)?([^:]+):(.*)/);
173 my ($forced, $theirs, $ours) = ($1, $2, $3);
174 if ($theirs eq 'refs/heads/*' &&
175 $ours =~ /^refs\/remotes\/(.*)\/\*$/) {
176 # wildcard mapping
7a8c9ec1
SP
177 my ($w_new, $w_stale, $w_tracked)
178 = list_wildcard_mapping($forced, $1, $ls);
179 push @new, @$w_new;
180 push @stale, @$w_stale;
181 push @tracked, @$w_tracked;
e194cd1e
JH
182 }
183 elsif ($theirs =~ /\*/ || $ours =~ /\*/) {
184 print STDERR "Warning: unrecognized mapping in remotes.$name.fetch: $_\n";
185 }
186 elsif ($theirs =~ s|^refs/heads/||) {
187 if (!grep { $_ eq $theirs } @$ls) {
188 push @stale, $theirs;
189 }
190 elsif ($ours ne '') {
191 push @tracked, $theirs;
192 }
193 }
194 }
7a8c9ec1
SP
195 return \@new, \@stale, \@tracked;
196}
197
198sub show_mapping {
199 my ($name, $info) = @_;
200 my ($new, $stale, $tracked) = list_mapping($name, $info);
201 if (@$new) {
202 print " New remote branches (next fetch will store in remotes/$name)\n";
203 print " @$new\n";
204 }
205 if (@$stale) {
859607df 206 print " Stale tracking branches in remotes/$name (use 'git remote prune')\n";
7a8c9ec1 207 print " @$stale\n";
e194cd1e 208 }
7a8c9ec1 209 if (@$tracked) {
e194cd1e 210 print " Tracked remote branches\n";
7a8c9ec1 211 print " @$tracked\n";
e194cd1e
JH
212 }
213}
214
859607df
SP
215sub prune_remote {
216 my ($name, $ls_remote) = @_;
217 if (!exists $remote->{$name}) {
218 print STDERR "No such remote $name\n";
f4bb20cc 219 return 1;
859607df
SP
220 }
221 my $info = $remote->{$name};
222 update_ls_remote($ls_remote, $info);
223
224 my ($new, $stale, $tracked) = list_mapping($name, $info);
225 my $prefix = "refs/remotes/$name";
226 foreach my $to_prune (@$stale) {
227 my @v = $git->command(qw(rev-parse --verify), "$prefix/$to_prune");
228 $git->command(qw(update-ref -d), "$prefix/$to_prune", $v[0]);
229 }
f4bb20cc 230 return 0;
859607df
SP
231}
232
e194cd1e
JH
233sub show_remote {
234 my ($name, $ls_remote) = @_;
235 if (!exists $remote->{$name}) {
236 print STDERR "No such remote $name\n";
f4bb20cc 237 return 1;
e194cd1e
JH
238 }
239 my $info = $remote->{$name};
240 update_ls_remote($ls_remote, $info);
241
242 print "* remote $name\n";
243 print " URL: $info->{'URL'}\n";
244 for my $branchname (sort keys %$branch) {
59b2023f
JH
245 next unless (defined $branch->{$branchname}{'REMOTE'} &&
246 $branch->{$branchname}{'REMOTE'} eq $name);
e194cd1e
JH
247 my @merged = map {
248 s|^refs/heads/||;
249 $_;
250 } split(' ',"@{$branch->{$branchname}{'MERGE'}}");
251 next unless (@merged);
252 print " Remote branch(es) merged with 'git pull' while on branch $branchname\n";
253 print " @merged\n";
254 }
255 if ($info->{'LS_REMOTE'}) {
256 show_mapping($name, $info);
257 }
8bf0e3d1
JS
258 if ($info->{'PUSH'}) {
259 my @pushed = map {
260 s|^refs/heads/||;
6718f1f0 261 s|^\+refs/heads/|+|;
8bf0e3d1
JS
262 s|:refs/heads/|:|;
263 $_;
264 } @{$info->{'PUSH'}};
265 print " Local branch(es) pushed with 'git push'\n";
266 print " @pushed\n";
267 }
f4bb20cc 268 return 0;
e194cd1e
JH
269}
270
271sub add_remote {
b6f5da1e 272 my ($name, $url, $opts) = @_;
e194cd1e
JH
273 if (exists $remote->{$name}) {
274 print STDERR "remote $name already exists.\n";
275 exit(1);
276 }
e0d10e1c 277 $git->command('config', "remote.$name.url", $url);
b6f5da1e
JH
278 my $track = $opts->{'track'} || ["*"];
279
280 for (@$track) {
281 $git->command('config', '--add', "remote.$name.fetch",
38944390
JS
282 $opts->{'mirror'} ?
283 "+refs/$_:refs/$_" :
284 "+refs/heads/$_:refs/remotes/$name/$_");
b6f5da1e
JH
285 }
286 if ($opts->{'fetch'}) {
287 $git->command('fetch', $name);
288 }
289 if (exists $opts->{'master'}) {
290 $git->command('symbolic-ref', "refs/remotes/$name/HEAD",
291 "refs/remotes/$name/$opts->{'master'}");
292 }
293}
294
1918278e
TT
295sub update_remote {
296 my ($name) = @_;
7deaec9a 297 my @remotes;
1918278e
TT
298
299 my $conf = $git->config("remotes." . $name);
300 if (defined($conf)) {
301 @remotes = split(' ', $conf);
302 } elsif ($name eq 'default') {
7deaec9a 303 @remotes = ();
1918278e 304 for (sort keys %$remote) {
35c49eea 305 my $do_fetch = $git->config_bool("remote." . $_ .
1918278e 306 ".skipDefaultUpdate");
35c49eea 307 unless ($do_fetch) {
1918278e
TT
308 push @remotes, $_;
309 }
310 }
311 } else {
6c2a6022 312 print STDERR "Remote group $name does not exist.\n";
1918278e
TT
313 exit(1);
314 }
315 for (@remotes) {
316 print "Updating $_\n";
317 $git->command('fetch', "$_");
318 }
319}
320
61136044 321sub rm_remote {
683b5679 322 my ($name) = @_;
61136044
JB
323 if (!exists $remote->{$name}) {
324 print STDERR "No such remote $name\n";
6982ccec 325 return 1;
61136044
JB
326 }
327
328 $git->command('config', '--remove-section', "remote.$name");
329
330 eval {
331 my @trackers = $git->command('config', '--get-regexp',
332 'branch.*.remote', $name);
333 for (@trackers) {
334 /^branch\.(.*)?\.remote/;
335 $git->config('--unset', "branch.$1.remote");
336 $git->config('--unset', "branch.$1.merge");
337 }
338 };
339
683b5679 340 my @refs = $git->command('for-each-ref',
61136044
JB
341 '--format=%(refname) %(objectname)', "refs/remotes/$name");
342 for (@refs) {
7deaec9a 343 my ($ref, $object) = split;
61136044
JB
344 $git->command(qw(update-ref -d), $ref, $object);
345 }
6982ccec 346 return 0;
61136044
JB
347}
348
b6f5da1e 349sub add_usage {
beb5ab18 350 print STDERR "usage: git remote add [-f] [-t track]* [-m master] <name> <url>\n";
b6f5da1e 351 exit(1);
e194cd1e
JH
352}
353
7deaec9a 354my $VERBOSE = 0;
09ff69bb
AR
355@ARGV = grep {
356 if ($_ eq '-v' or $_ eq '--verbose') {
357 $VERBOSE=1;
358 0
359 } else {
360 1
361 }
362} @ARGV;
363
e194cd1e
JH
364if (!@ARGV) {
365 for (sort keys %$remote) {
09ff69bb
AR
366 print "$_";
367 print "\t$remote->{$_}->{URL}" if $VERBOSE;
368 print "\n";
e194cd1e
JH
369 }
370}
371elsif ($ARGV[0] eq 'show') {
372 my $ls_remote = 1;
373 my $i;
374 for ($i = 1; $i < @ARGV; $i++) {
375 if ($ARGV[$i] eq '-n') {
376 $ls_remote = 0;
377 }
378 else {
379 last;
380 }
381 }
382 if ($i >= @ARGV) {
f86cad71 383 print STDERR "usage: git remote show <remote>\n";
e194cd1e
JH
384 exit(1);
385 }
f4bb20cc 386 my $status = 0;
e194cd1e 387 for (; $i < @ARGV; $i++) {
f4bb20cc 388 $status |= show_remote($ARGV[$i], $ls_remote);
e194cd1e 389 }
f4bb20cc 390 exit($status);
e194cd1e 391}
1e592d65 392elsif ($ARGV[0] eq 'update') {
1918278e
TT
393 if (@ARGV <= 1) {
394 update_remote("default");
395 exit(1);
1e592d65 396 }
7deaec9a 397 for (my $i = 1; $i < @ARGV; $i++) {
1918278e 398 update_remote($ARGV[$i]);
1e592d65
TT
399 }
400}
859607df
SP
401elsif ($ARGV[0] eq 'prune') {
402 my $ls_remote = 1;
403 my $i;
404 for ($i = 1; $i < @ARGV; $i++) {
405 if ($ARGV[$i] eq '-n') {
406 $ls_remote = 0;
407 }
408 else {
409 last;
410 }
411 }
412 if ($i >= @ARGV) {
f86cad71 413 print STDERR "usage: git remote prune <remote>\n";
859607df
SP
414 exit(1);
415 }
f4bb20cc 416 my $status = 0;
859607df 417 for (; $i < @ARGV; $i++) {
f4bb20cc 418 $status |= prune_remote($ARGV[$i], $ls_remote);
859607df 419 }
f4bb20cc 420 exit($status);
859607df 421}
e194cd1e 422elsif ($ARGV[0] eq 'add') {
b6f5da1e
JH
423 my %opts = ();
424 while (1 < @ARGV && $ARGV[1] =~ /^-/) {
425 my $opt = $ARGV[1];
426 shift @ARGV;
427 if ($opt eq '-f' || $opt eq '--fetch') {
428 $opts{'fetch'} = 1;
429 next;
430 }
431 if ($opt eq '-t' || $opt eq '--track') {
432 if (@ARGV < 1) {
433 add_usage();
434 }
435 $opts{'track'} ||= [];
436 push @{$opts{'track'}}, $ARGV[1];
437 shift @ARGV;
438 next;
439 }
440 if ($opt eq '-m' || $opt eq '--master') {
441 if ((@ARGV < 1) || exists $opts{'master'}) {
442 add_usage();
443 }
444 $opts{'master'} = $ARGV[1];
445 shift @ARGV;
446 next;
447 }
38944390
JS
448 if ($opt eq '--mirror') {
449 $opts{'mirror'} = 1;
450 next;
451 }
b6f5da1e
JH
452 add_usage();
453 }
e194cd1e 454 if (@ARGV != 3) {
b6f5da1e 455 add_usage();
e194cd1e 456 }
b6f5da1e 457 add_remote($ARGV[1], $ARGV[2], \%opts);
e194cd1e 458}
61136044
JB
459elsif ($ARGV[0] eq 'rm') {
460 if (@ARGV <= 1) {
f86cad71 461 print STDERR "usage: git remote rm <remote>\n";
683b5679 462 exit(1);
61136044 463 }
6982ccec 464 exit(rm_remote($ARGV[1]));
61136044 465}
c03f7757 466else {
f86cad71 467 print STDERR "usage: git remote\n";
c03f7757 468 print STDERR " git remote add <name> <url>\n";
61136044 469 print STDERR " git remote rm <name>\n";
c03f7757 470 print STDERR " git remote show <name>\n";
859607df 471 print STDERR " git remote prune <name>\n";
1918278e 472 print STDERR " git remote update [group]\n";
c03f7757
QT
473 exit(1);
474}