repo_read_index: don't discard the index
[git] / perl / Git.pm
1 =head1 NAME
2
3 Git - Perl interface to the Git version control system
4
5 =cut
6
7
8 package Git;
9
10 use 5.008;
11 use strict;
12
13
14 BEGIN {
15
16 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK);
17
18 # Totally unstable API.
19 $VERSION = '0.01';
20
21
22 =head1 SYNOPSIS
23
24   use Git;
25
26   my $version = Git::command_oneline('version');
27
28   git_cmd_try { Git::command_noisy('update-server-info') }
29               '%s failed w/ code %d';
30
31   my $repo = Git->repository (Directory => '/srv/git/cogito.git');
32
33
34   my @revs = $repo->command('rev-list', '--since=last monday', '--all');
35
36   my ($fh, $c) = $repo->command_output_pipe('rev-list', '--since=last monday', '--all');
37   my $lastrev = <$fh>; chomp $lastrev;
38   $repo->command_close_pipe($fh, $c);
39
40   my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ],
41                                         STDERR => 0 );
42
43   my $sha1 = $repo->hash_and_insert_object('file.txt');
44   my $tempfile = tempfile();
45   my $size = $repo->cat_blob($sha1, $tempfile);
46
47 =cut
48
49
50 require Exporter;
51
52 @ISA = qw(Exporter);
53
54 @EXPORT = qw(git_cmd_try);
55
56 # Methods which can be called as standalone functions as well:
57 @EXPORT_OK = qw(command command_oneline command_noisy
58                 command_output_pipe command_input_pipe command_close_pipe
59                 command_bidi_pipe command_close_bidi_pipe
60                 version exec_path html_path hash_object git_cmd_try
61                 remote_refs prompt
62                 get_tz_offset get_record
63                 credential credential_read credential_write
64                 temp_acquire temp_is_locked temp_release temp_reset temp_path
65                 unquote_path);
66
67
68 =head1 DESCRIPTION
69
70 This module provides Perl scripts easy way to interface the Git version control
71 system. The modules have an easy and well-tested way to call arbitrary Git
72 commands; in the future, the interface will also provide specialized methods
73 for doing easily operations which are not totally trivial to do over
74 the generic command interface.
75
76 While some commands can be executed outside of any context (e.g. 'version'
77 or 'init'), most operations require a repository context, which in practice
78 means getting an instance of the Git object using the repository() constructor.
79 (In the future, we will also get a new_repository() constructor.) All commands
80 called as methods of the object are then executed in the context of the
81 repository.
82
83 Part of the "repository state" is also information about path to the attached
84 working copy (unless you work with a bare repository). You can also navigate
85 inside of the working copy using the C<wc_chdir()> method. (Note that
86 the repository object is self-contained and will not change working directory
87 of your process.)
88
89 TODO: In the future, we might also do
90
91         my $remoterepo = $repo->remote_repository (Name => 'cogito', Branch => 'master');
92         $remoterepo ||= Git->remote_repository ('http://git.or.cz/cogito.git/');
93         my @refs = $remoterepo->refs();
94
95 Currently, the module merely wraps calls to external Git tools. In the future,
96 it will provide a much faster way to interact with Git by linking directly
97 to libgit. This should be completely opaque to the user, though (performance
98 increase notwithstanding).
99
100 =cut
101
102
103 use Carp qw(carp croak); # but croak is bad - throw instead
104 use Error qw(:try);
105 use Cwd qw(abs_path cwd);
106 use IPC::Open2 qw(open2);
107 use Fcntl qw(SEEK_SET SEEK_CUR);
108 use Time::Local qw(timegm);
109 }
110
111
112 =head1 CONSTRUCTORS
113
114 =over 4
115
116 =item repository ( OPTIONS )
117
118 =item repository ( DIRECTORY )
119
120 =item repository ()
121
122 Construct a new repository object.
123 C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
124 Possible options are:
125
126 B<Repository> - Path to the Git repository.
127
128 B<WorkingCopy> - Path to the associated working copy; not strictly required
129 as many commands will happily crunch on a bare repository.
130
131 B<WorkingSubdir> - Subdirectory in the working copy to work inside.
132 Just left undefined if you do not want to limit the scope of operations.
133
134 B<Directory> - Path to the Git working directory in its usual setup.
135 The C<.git> directory is searched in the directory and all the parent
136 directories; if found, C<WorkingCopy> is set to the directory containing
137 it and C<Repository> to the C<.git> directory itself. If no C<.git>
138 directory was found, the C<Directory> is assumed to be a bare repository,
139 C<Repository> is set to point at it and C<WorkingCopy> is left undefined.
140 If the C<$GIT_DIR> environment variable is set, things behave as expected
141 as well.
142
143 You should not use both C<Directory> and either of C<Repository> and
144 C<WorkingCopy> - the results of that are undefined.
145
146 Alternatively, a directory path may be passed as a single scalar argument
147 to the constructor; it is equivalent to setting only the C<Directory> option
148 field.
149
150 Calling the constructor with no options whatsoever is equivalent to
151 calling it with C<< Directory => '.' >>. In general, if you are building
152 a standard porcelain command, simply doing C<< Git->repository() >> should
153 do the right thing and setup the object to reflect exactly where the user
154 is right now.
155
156 =cut
157
158 sub repository {
159         my $class = shift;
160         my @args = @_;
161         my %opts = ();
162         my $self;
163
164         if (defined $args[0]) {
165                 if ($#args % 2 != 1) {
166                         # Not a hash.
167                         $#args == 0 or throw Error::Simple("bad usage");
168                         %opts = ( Directory => $args[0] );
169                 } else {
170                         %opts = @args;
171                 }
172         }
173
174         if (not defined $opts{Repository} and not defined $opts{WorkingCopy}
175                 and not defined $opts{Directory}) {
176                 $opts{Directory} = '.';
177         }
178
179         if (defined $opts{Directory}) {
180                 -d $opts{Directory} or throw Error::Simple("Directory not found: $opts{Directory} $!");
181
182                 my $search = Git->repository(WorkingCopy => $opts{Directory});
183                 my $dir;
184                 try {
185                         $dir = $search->command_oneline(['rev-parse', '--git-dir'],
186                                                         STDERR => 0);
187                 } catch Git::Error::Command with {
188                         $dir = undef;
189                 };
190
191                 if ($dir) {
192                         _verify_require();
193                         File::Spec->file_name_is_absolute($dir) or $dir = $opts{Directory} . '/' . $dir;
194                         $opts{Repository} = abs_path($dir);
195
196                         # If --git-dir went ok, this shouldn't die either.
197                         my $prefix = $search->command_oneline('rev-parse', '--show-prefix');
198                         $dir = abs_path($opts{Directory}) . '/';
199                         if ($prefix) {
200                                 if (substr($dir, -length($prefix)) ne $prefix) {
201                                         throw Error::Simple("rev-parse confused me - $dir does not have trailing $prefix");
202                                 }
203                                 substr($dir, -length($prefix)) = '';
204                         }
205                         $opts{WorkingCopy} = $dir;
206                         $opts{WorkingSubdir} = $prefix;
207
208                 } else {
209                         # A bare repository? Let's see...
210                         $dir = $opts{Directory};
211
212                         unless (-d "$dir/refs" and -d "$dir/objects" and -e "$dir/HEAD") {
213                                 # Mimic git-rev-parse --git-dir error message:
214                                 throw Error::Simple("fatal: Not a git repository: $dir");
215                         }
216                         my $search = Git->repository(Repository => $dir);
217                         try {
218                                 $search->command('symbolic-ref', 'HEAD');
219                         } catch Git::Error::Command with {
220                                 # Mimic git-rev-parse --git-dir error message:
221                                 throw Error::Simple("fatal: Not a git repository: $dir");
222                         }
223
224                         $opts{Repository} = abs_path($dir);
225                 }
226
227                 delete $opts{Directory};
228         }
229
230         $self = { opts => \%opts };
231         bless $self, $class;
232 }
233
234 =back
235
236 =head1 METHODS
237
238 =over 4
239
240 =item command ( COMMAND [, ARGUMENTS... ] )
241
242 =item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
243
244 Execute the given Git C<COMMAND> (specify it without the 'git-'
245 prefix), optionally with the specified extra C<ARGUMENTS>.
246
247 The second more elaborate form can be used if you want to further adjust
248 the command execution. Currently, only one option is supported:
249
250 B<STDERR> - How to deal with the command's error output. By default (C<undef>)
251 it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause
252 it to be thrown away. If you want to process it, you can get it in a filehandle
253 you specify, but you must be extremely careful; if the error output is not
254 very short and you want to read it in the same process as where you called
255 C<command()>, you are set up for a nice deadlock!
256
257 The method can be called without any instance or on a specified Git repository
258 (in that case the command will be run in the repository context).
259
260 In scalar context, it returns all the command output in a single string
261 (verbatim).
262
263 In array context, it returns an array containing lines printed to the
264 command's stdout (without trailing newlines).
265
266 In both cases, the command's stdin and stderr are the same as the caller's.
267
268 =cut
269
270 sub command {
271         my ($fh, $ctx) = command_output_pipe(@_);
272
273         if (not defined wantarray) {
274                 # Nothing to pepper the possible exception with.
275                 _cmd_close($ctx, $fh);
276
277         } elsif (not wantarray) {
278                 local $/;
279                 my $text = <$fh>;
280                 try {
281                         _cmd_close($ctx, $fh);
282                 } catch Git::Error::Command with {
283                         # Pepper with the output:
284                         my $E = shift;
285                         $E->{'-outputref'} = \$text;
286                         throw $E;
287                 };
288                 return $text;
289
290         } else {
291                 my @lines = <$fh>;
292                 defined and chomp for @lines;
293                 try {
294                         _cmd_close($ctx, $fh);
295                 } catch Git::Error::Command with {
296                         my $E = shift;
297                         $E->{'-outputref'} = \@lines;
298                         throw $E;
299                 };
300                 return @lines;
301         }
302 }
303
304
305 =item command_oneline ( COMMAND [, ARGUMENTS... ] )
306
307 =item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
308
309 Execute the given C<COMMAND> in the same way as command()
310 does but always return a scalar string containing the first line
311 of the command's standard output.
312
313 =cut
314
315 sub command_oneline {
316         my ($fh, $ctx) = command_output_pipe(@_);
317
318         my $line = <$fh>;
319         defined $line and chomp $line;
320         try {
321                 _cmd_close($ctx, $fh);
322         } catch Git::Error::Command with {
323                 # Pepper with the output:
324                 my $E = shift;
325                 $E->{'-outputref'} = \$line;
326                 throw $E;
327         };
328         return $line;
329 }
330
331
332 =item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
333
334 =item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
335
336 Execute the given C<COMMAND> in the same way as command()
337 does but return a pipe filehandle from which the command output can be
338 read.
339
340 The function can return C<($pipe, $ctx)> in array context.
341 See C<command_close_pipe()> for details.
342
343 =cut
344
345 sub command_output_pipe {
346         _command_common_pipe('-|', @_);
347 }
348
349
350 =item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
351
352 =item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
353
354 Execute the given C<COMMAND> in the same way as command_output_pipe()
355 does but return an input pipe filehandle instead; the command output
356 is not captured.
357
358 The function can return C<($pipe, $ctx)> in array context.
359 See C<command_close_pipe()> for details.
360
361 =cut
362
363 sub command_input_pipe {
364         _command_common_pipe('|-', @_);
365 }
366
367
368 =item command_close_pipe ( PIPE [, CTX ] )
369
370 Close the C<PIPE> as returned from C<command_*_pipe()>, checking
371 whether the command finished successfully. The optional C<CTX> argument
372 is required if you want to see the command name in the error message,
373 and it is the second value returned by C<command_*_pipe()> when
374 called in array context. The call idiom is:
375
376         my ($fh, $ctx) = $r->command_output_pipe('status');
377         while (<$fh>) { ... }
378         $r->command_close_pipe($fh, $ctx);
379
380 Note that you should not rely on whatever actually is in C<CTX>;
381 currently it is simply the command name but in future the context might
382 have more complicated structure.
383
384 =cut
385
386 sub command_close_pipe {
387         my ($self, $fh, $ctx) = _maybe_self(@_);
388         $ctx ||= '<unknown>';
389         _cmd_close($ctx, $fh);
390 }
391
392 =item command_bidi_pipe ( COMMAND [, ARGUMENTS... ] )
393
394 Execute the given C<COMMAND> in the same way as command_output_pipe()
395 does but return both an input pipe filehandle and an output pipe filehandle.
396
397 The function will return C<($pid, $pipe_in, $pipe_out, $ctx)>.
398 See C<command_close_bidi_pipe()> for details.
399
400 =cut
401
402 sub command_bidi_pipe {
403         my ($pid, $in, $out);
404         my ($self) = _maybe_self(@_);
405         local %ENV = %ENV;
406         my $cwd_save = undef;
407         if ($self) {
408                 shift;
409                 $cwd_save = cwd();
410                 _setup_git_cmd_env($self);
411         }
412         $pid = open2($in, $out, 'git', @_);
413         chdir($cwd_save) if $cwd_save;
414         return ($pid, $in, $out, join(' ', @_));
415 }
416
417 =item command_close_bidi_pipe ( PID, PIPE_IN, PIPE_OUT [, CTX] )
418
419 Close the C<PIPE_IN> and C<PIPE_OUT> as returned from C<command_bidi_pipe()>,
420 checking whether the command finished successfully. The optional C<CTX>
421 argument is required if you want to see the command name in the error message,
422 and it is the fourth value returned by C<command_bidi_pipe()>.  The call idiom
423 is:
424
425         my ($pid, $in, $out, $ctx) = $r->command_bidi_pipe('cat-file --batch-check');
426         print $out "000000000\n";
427         while (<$in>) { ... }
428         $r->command_close_bidi_pipe($pid, $in, $out, $ctx);
429
430 Note that you should not rely on whatever actually is in C<CTX>;
431 currently it is simply the command name but in future the context might
432 have more complicated structure.
433
434 C<PIPE_IN> and C<PIPE_OUT> may be C<undef> if they have been closed prior to
435 calling this function.  This may be useful in a query-response type of
436 commands where caller first writes a query and later reads response, eg:
437
438         my ($pid, $in, $out, $ctx) = $r->command_bidi_pipe('cat-file --batch-check');
439         print $out "000000000\n";
440         close $out;
441         while (<$in>) { ... }
442         $r->command_close_bidi_pipe($pid, $in, undef, $ctx);
443
444 This idiom may prevent potential dead locks caused by data sent to the output
445 pipe not being flushed and thus not reaching the executed command.
446
447 =cut
448
449 sub command_close_bidi_pipe {
450         local $?;
451         my ($self, $pid, $in, $out, $ctx) = _maybe_self(@_);
452         _cmd_close($ctx, (grep { defined } ($in, $out)));
453         waitpid $pid, 0;
454         if ($? >> 8) {
455                 throw Git::Error::Command($ctx, $? >>8);
456         }
457 }
458
459
460 =item command_noisy ( COMMAND [, ARGUMENTS... ] )
461
462 Execute the given C<COMMAND> in the same way as command() does but do not
463 capture the command output - the standard output is not redirected and goes
464 to the standard output of the caller application.
465
466 While the method is called command_noisy(), you might want to as well use
467 it for the most silent Git commands which you know will never pollute your
468 stdout but you want to avoid the overhead of the pipe setup when calling them.
469
470 The function returns only after the command has finished running.
471
472 =cut
473
474 sub command_noisy {
475         my ($self, $cmd, @args) = _maybe_self(@_);
476         _check_valid_cmd($cmd);
477
478         my $pid = fork;
479         if (not defined $pid) {
480                 throw Error::Simple("fork failed: $!");
481         } elsif ($pid == 0) {
482                 _cmd_exec($self, $cmd, @args);
483         }
484         if (waitpid($pid, 0) > 0 and $?>>8 != 0) {
485                 throw Git::Error::Command(join(' ', $cmd, @args), $? >> 8);
486         }
487 }
488
489
490 =item version ()
491
492 Return the Git version in use.
493
494 =cut
495
496 sub version {
497         my $verstr = command_oneline('--version');
498         $verstr =~ s/^git version //;
499         $verstr;
500 }
501
502
503 =item exec_path ()
504
505 Return path to the Git sub-command executables (the same as
506 C<git --exec-path>). Useful mostly only internally.
507
508 =cut
509
510 sub exec_path { command_oneline('--exec-path') }
511
512
513 =item html_path ()
514
515 Return path to the Git html documentation (the same as
516 C<git --html-path>). Useful mostly only internally.
517
518 =cut
519
520 sub html_path { command_oneline('--html-path') }
521
522
523 =item get_tz_offset ( TIME )
524
525 Return the time zone offset from GMT in the form +/-HHMM where HH is
526 the number of hours from GMT and MM is the number of minutes.  This is
527 the equivalent of what strftime("%z", ...) would provide on a GNU
528 platform.
529
530 If TIME is not supplied, the current local time is used.
531
532 =cut
533
534 sub get_tz_offset {
535         # some systmes don't handle or mishandle %z, so be creative.
536         my $t = shift || time;
537         my $gm = timegm(localtime($t));
538         my $sign = qw( + + - )[ $gm <=> $t ];
539         return sprintf("%s%02d%02d", $sign, (gmtime(abs($t - $gm)))[2,1]);
540 }
541
542 =item get_record ( FILEHANDLE, INPUT_RECORD_SEPARATOR )
543
544 Read one record from FILEHANDLE delimited by INPUT_RECORD_SEPARATOR,
545 removing any trailing INPUT_RECORD_SEPARATOR.
546
547 =cut
548
549 sub get_record {
550         my ($fh, $rs) = @_;
551         local $/ = $rs;
552         my $rec = <$fh>;
553         chomp $rec if defined $rs;
554         $rec;
555 }
556
557 =item prompt ( PROMPT , ISPASSWORD  )
558
559 Query user C<PROMPT> and return answer from user.
560
561 Honours GIT_ASKPASS and SSH_ASKPASS environment variables for querying
562 the user. If no *_ASKPASS variable is set or an error occoured,
563 the terminal is tried as a fallback.
564 If C<ISPASSWORD> is set and true, the terminal disables echo.
565
566 =cut
567
568 sub prompt {
569         my ($prompt, $isPassword) = @_;
570         my $ret;
571         if (exists $ENV{'GIT_ASKPASS'}) {
572                 $ret = _prompt($ENV{'GIT_ASKPASS'}, $prompt);
573         }
574         if (!defined $ret && exists $ENV{'SSH_ASKPASS'}) {
575                 $ret = _prompt($ENV{'SSH_ASKPASS'}, $prompt);
576         }
577         if (!defined $ret) {
578                 print STDERR $prompt;
579                 STDERR->flush;
580                 if (defined $isPassword && $isPassword) {
581                         require Term::ReadKey;
582                         Term::ReadKey::ReadMode('noecho');
583                         $ret = '';
584                         while (defined(my $key = Term::ReadKey::ReadKey(0))) {
585                                 last if $key =~ /[\012\015]/; # \n\r
586                                 $ret .= $key;
587                         }
588                         Term::ReadKey::ReadMode('restore');
589                         print STDERR "\n";
590                         STDERR->flush;
591                 } else {
592                         chomp($ret = <STDIN>);
593                 }
594         }
595         return $ret;
596 }
597
598 sub _prompt {
599         my ($askpass, $prompt) = @_;
600         return unless length $askpass;
601         $prompt =~ s/\n/ /g;
602         my $ret;
603         open my $fh, "-|", $askpass, $prompt or return;
604         $ret = <$fh>;
605         $ret =~ s/[\015\012]//g; # strip \r\n, chomp does not work on all systems (i.e. windows) as expected
606         close ($fh);
607         return $ret;
608 }
609
610 =item repo_path ()
611
612 Return path to the git repository. Must be called on a repository instance.
613
614 =cut
615
616 sub repo_path { $_[0]->{opts}->{Repository} }
617
618
619 =item wc_path ()
620
621 Return path to the working copy. Must be called on a repository instance.
622
623 =cut
624
625 sub wc_path { $_[0]->{opts}->{WorkingCopy} }
626
627
628 =item wc_subdir ()
629
630 Return path to the subdirectory inside of a working copy. Must be called
631 on a repository instance.
632
633 =cut
634
635 sub wc_subdir { $_[0]->{opts}->{WorkingSubdir} ||= '' }
636
637
638 =item wc_chdir ( SUBDIR )
639
640 Change the working copy subdirectory to work within. The C<SUBDIR> is
641 relative to the working copy root directory (not the current subdirectory).
642 Must be called on a repository instance attached to a working copy
643 and the directory must exist.
644
645 =cut
646
647 sub wc_chdir {
648         my ($self, $subdir) = @_;
649         $self->wc_path()
650                 or throw Error::Simple("bare repository");
651
652         -d $self->wc_path().'/'.$subdir
653                 or throw Error::Simple("subdir not found: $subdir $!");
654         # Of course we will not "hold" the subdirectory so anyone
655         # can delete it now and we will never know. But at least we tried.
656
657         $self->{opts}->{WorkingSubdir} = $subdir;
658 }
659
660
661 =item config ( VARIABLE )
662
663 Retrieve the configuration C<VARIABLE> in the same manner as C<config>
664 does. In scalar context requires the variable to be set only one time
665 (exception is thrown otherwise), in array context returns allows the
666 variable to be set multiple times and returns all the values.
667
668 =cut
669
670 sub config {
671         return _config_common({}, @_);
672 }
673
674
675 =item config_bool ( VARIABLE )
676
677 Retrieve the bool configuration C<VARIABLE>. The return value
678 is usable as a boolean in perl (and C<undef> if it's not defined,
679 of course).
680
681 =cut
682
683 sub config_bool {
684         my $val = scalar _config_common({'kind' => '--bool'}, @_);
685
686         # Do not rewrite this as return (defined $val && $val eq 'true')
687         # as some callers do care what kind of falsehood they receive.
688         if (!defined $val) {
689                 return undef;
690         } else {
691                 return $val eq 'true';
692         }
693 }
694
695
696 =item config_path ( VARIABLE )
697
698 Retrieve the path configuration C<VARIABLE>. The return value
699 is an expanded path or C<undef> if it's not defined.
700
701 =cut
702
703 sub config_path {
704         return _config_common({'kind' => '--path'}, @_);
705 }
706
707
708 =item config_int ( VARIABLE )
709
710 Retrieve the integer configuration C<VARIABLE>. The return value
711 is simple decimal number.  An optional value suffix of 'k', 'm',
712 or 'g' in the config file will cause the value to be multiplied
713 by 1024, 1048576 (1024^2), or 1073741824 (1024^3) prior to output.
714 It would return C<undef> if configuration variable is not defined.
715
716 =cut
717
718 sub config_int {
719         return scalar _config_common({'kind' => '--int'}, @_);
720 }
721
722 # Common subroutine to implement bulk of what the config* family of methods
723 # do. This currently wraps command('config') so it is not so fast.
724 sub _config_common {
725         my ($opts) = shift @_;
726         my ($self, $var) = _maybe_self(@_);
727
728         try {
729                 my @cmd = ('config', $opts->{'kind'} ? $opts->{'kind'} : ());
730                 unshift @cmd, $self if $self;
731                 if (wantarray) {
732                         return command(@cmd, '--get-all', $var);
733                 } else {
734                         return command_oneline(@cmd, '--get', $var);
735                 }
736         } catch Git::Error::Command with {
737                 my $E = shift;
738                 if ($E->value() == 1) {
739                         # Key not found.
740                         return;
741                 } else {
742                         throw $E;
743                 }
744         };
745 }
746
747 =item get_colorbool ( NAME )
748
749 Finds if color should be used for NAMEd operation from the configuration,
750 and returns boolean (true for "use color", false for "do not use color").
751
752 =cut
753
754 sub get_colorbool {
755         my ($self, $var) = @_;
756         my $stdout_to_tty = (-t STDOUT) ? "true" : "false";
757         my $use_color = $self->command_oneline('config', '--get-colorbool',
758                                                $var, $stdout_to_tty);
759         return ($use_color eq 'true');
760 }
761
762 =item get_color ( SLOT, COLOR )
763
764 Finds color for SLOT from the configuration, while defaulting to COLOR,
765 and returns the ANSI color escape sequence:
766
767         print $repo->get_color("color.interactive.prompt", "underline blue white");
768         print "some text";
769         print $repo->get_color("", "normal");
770
771 =cut
772
773 sub get_color {
774         my ($self, $slot, $default) = @_;
775         my $color = $self->command_oneline('config', '--get-color', $slot, $default);
776         if (!defined $color) {
777                 $color = "";
778         }
779         return $color;
780 }
781
782 =item remote_refs ( REPOSITORY [, GROUPS [, REFGLOBS ] ] )
783
784 This function returns a hashref of refs stored in a given remote repository.
785 The hash is in the format C<refname =\> hash>. For tags, the C<refname> entry
786 contains the tag object while a C<refname^{}> entry gives the tagged objects.
787
788 C<REPOSITORY> has the same meaning as the appropriate C<git-ls-remote>
789 argument; either a URL or a remote name (if called on a repository instance).
790 C<GROUPS> is an optional arrayref that can contain 'tags' to return all the
791 tags and/or 'heads' to return all the heads. C<REFGLOB> is an optional array
792 of strings containing a shell-like glob to further limit the refs returned in
793 the hash; the meaning is again the same as the appropriate C<git-ls-remote>
794 argument.
795
796 This function may or may not be called on a repository instance. In the former
797 case, remote names as defined in the repository are recognized as repository
798 specifiers.
799
800 =cut
801
802 sub remote_refs {
803         my ($self, $repo, $groups, $refglobs) = _maybe_self(@_);
804         my @args;
805         if (ref $groups eq 'ARRAY') {
806                 foreach (@$groups) {
807                         if ($_ eq 'heads') {
808                                 push (@args, '--heads');
809                         } elsif ($_ eq 'tags') {
810                                 push (@args, '--tags');
811                         } else {
812                                 # Ignore unknown groups for future
813                                 # compatibility
814                         }
815                 }
816         }
817         push (@args, $repo);
818         if (ref $refglobs eq 'ARRAY') {
819                 push (@args, @$refglobs);
820         }
821
822         my @self = $self ? ($self) : (); # Ultra trickery
823         my ($fh, $ctx) = Git::command_output_pipe(@self, 'ls-remote', @args);
824         my %refs;
825         while (<$fh>) {
826                 chomp;
827                 my ($hash, $ref) = split(/\t/, $_, 2);
828                 $refs{$ref} = $hash;
829         }
830         Git::command_close_pipe(@self, $fh, $ctx);
831         return \%refs;
832 }
833
834
835 =item ident ( TYPE | IDENTSTR )
836
837 =item ident_person ( TYPE | IDENTSTR | IDENTARRAY )
838
839 This suite of functions retrieves and parses ident information, as stored
840 in the commit and tag objects or produced by C<var GIT_type_IDENT> (thus
841 C<TYPE> can be either I<author> or I<committer>; case is insignificant).
842
843 The C<ident> method retrieves the ident information from C<git var>
844 and either returns it as a scalar string or as an array with the fields parsed.
845 Alternatively, it can take a prepared ident string (e.g. from the commit
846 object) and just parse it.
847
848 C<ident_person> returns the person part of the ident - name and email;
849 it can take the same arguments as C<ident> or the array returned by C<ident>.
850
851 The synopsis is like:
852
853         my ($name, $email, $time_tz) = ident('author');
854         "$name <$email>" eq ident_person('author');
855         "$name <$email>" eq ident_person($name);
856         $time_tz =~ /^\d+ [+-]\d{4}$/;
857
858 =cut
859
860 sub ident {
861         my ($self, $type) = _maybe_self(@_);
862         my $identstr;
863         if (lc $type eq lc 'committer' or lc $type eq lc 'author') {
864                 my @cmd = ('var', 'GIT_'.uc($type).'_IDENT');
865                 unshift @cmd, $self if $self;
866                 $identstr = command_oneline(@cmd);
867         } else {
868                 $identstr = $type;
869         }
870         if (wantarray) {
871                 return $identstr =~ /^(.*) <(.*)> (\d+ [+-]\d{4})$/;
872         } else {
873                 return $identstr;
874         }
875 }
876
877 sub ident_person {
878         my ($self, @ident) = _maybe_self(@_);
879         $#ident == 0 and @ident = $self ? $self->ident($ident[0]) : ident($ident[0]);
880         return "$ident[0] <$ident[1]>";
881 }
882
883 =item parse_mailboxes
884
885 Return an array of mailboxes extracted from a string.
886
887 =cut
888
889 # Very close to Mail::Address's parser, but we still have minor
890 # differences in some cases (see t9000 for examples).
891 sub parse_mailboxes {
892         my $re_comment = qr/\((?:[^)]*)\)/;
893         my $re_quote = qr/"(?:[^\"\\]|\\.)*"/;
894         my $re_word = qr/(?:[^]["\s()<>:;@\\,.]|\\.)+/;
895
896         # divide the string in tokens of the above form
897         my $re_token = qr/(?:$re_quote|$re_word|$re_comment|\S)/;
898         my @tokens = map { $_ =~ /\s*($re_token)\s*/g } @_;
899         my $end_of_addr_seen = 0;
900
901         # add a delimiter to simplify treatment for the last mailbox
902         push @tokens, ",";
903
904         my (@addr_list, @phrase, @address, @comment, @buffer) = ();
905         foreach my $token (@tokens) {
906                 if ($token =~ /^[,;]$/) {
907                         # if buffer still contains undeterminated strings
908                         # append it at the end of @address or @phrase
909                         if ($end_of_addr_seen) {
910                                 push @phrase, @buffer;
911                         } else {
912                                 push @address, @buffer;
913                         }
914
915                         my $str_phrase = join ' ', @phrase;
916                         my $str_address = join '', @address;
917                         my $str_comment = join ' ', @comment;
918
919                         # quote are necessary if phrase contains
920                         # special characters
921                         if ($str_phrase =~ /[][()<>:;@\\,.\000-\037\177]/) {
922                                 $str_phrase =~ s/(^|[^\\])"/$1/g;
923                                 $str_phrase = qq["$str_phrase"];
924                         }
925
926                         # add "<>" around the address if necessary
927                         if ($str_address ne "" && $str_phrase ne "") {
928                                 $str_address = qq[<$str_address>];
929                         }
930
931                         my $str_mailbox = "$str_phrase $str_address $str_comment";
932                         $str_mailbox =~ s/^\s*|\s*$//g;
933                         push @addr_list, $str_mailbox if ($str_mailbox);
934
935                         @phrase = @address = @comment = @buffer = ();
936                         $end_of_addr_seen = 0;
937                 } elsif ($token =~ /^\(/) {
938                         push @comment, $token;
939                 } elsif ($token eq "<") {
940                         push @phrase, (splice @address), (splice @buffer);
941                 } elsif ($token eq ">") {
942                         $end_of_addr_seen = 1;
943                         push @address, (splice @buffer);
944                 } elsif ($token eq "@" && !$end_of_addr_seen) {
945                         push @address, (splice @buffer), "@";
946                 } else {
947                         push @buffer, $token;
948                 }
949         }
950
951         return @addr_list;
952 }
953
954 =item hash_object ( TYPE, FILENAME )
955
956 Compute the SHA1 object id of the given C<FILENAME> considering it is
957 of the C<TYPE> object type (C<blob>, C<commit>, C<tree>).
958
959 The method can be called without any instance or on a specified Git repository,
960 it makes zero difference.
961
962 The function returns the SHA1 hash.
963
964 =cut
965
966 # TODO: Support for passing FILEHANDLE instead of FILENAME
967 sub hash_object {
968         my ($self, $type, $file) = _maybe_self(@_);
969         command_oneline('hash-object', '-t', $type, $file);
970 }
971
972
973 =item hash_and_insert_object ( FILENAME )
974
975 Compute the SHA1 object id of the given C<FILENAME> and add the object to the
976 object database.
977
978 The function returns the SHA1 hash.
979
980 =cut
981
982 # TODO: Support for passing FILEHANDLE instead of FILENAME
983 sub hash_and_insert_object {
984         my ($self, $filename) = @_;
985
986         carp "Bad filename \"$filename\"" if $filename =~ /[\r\n]/;
987
988         $self->_open_hash_and_insert_object_if_needed();
989         my ($in, $out) = ($self->{hash_object_in}, $self->{hash_object_out});
990
991         unless (print $out $filename, "\n") {
992                 $self->_close_hash_and_insert_object();
993                 throw Error::Simple("out pipe went bad");
994         }
995
996         chomp(my $hash = <$in>);
997         unless (defined($hash)) {
998                 $self->_close_hash_and_insert_object();
999                 throw Error::Simple("in pipe went bad");
1000         }
1001
1002         return $hash;
1003 }
1004
1005 sub _open_hash_and_insert_object_if_needed {
1006         my ($self) = @_;
1007
1008         return if defined($self->{hash_object_pid});
1009
1010         ($self->{hash_object_pid}, $self->{hash_object_in},
1011          $self->{hash_object_out}, $self->{hash_object_ctx}) =
1012                 $self->command_bidi_pipe(qw(hash-object -w --stdin-paths --no-filters));
1013 }
1014
1015 sub _close_hash_and_insert_object {
1016         my ($self) = @_;
1017
1018         return unless defined($self->{hash_object_pid});
1019
1020         my @vars = map { 'hash_object_' . $_ } qw(pid in out ctx);
1021
1022         command_close_bidi_pipe(@$self{@vars});
1023         delete @$self{@vars};
1024 }
1025
1026 =item cat_blob ( SHA1, FILEHANDLE )
1027
1028 Prints the contents of the blob identified by C<SHA1> to C<FILEHANDLE> and
1029 returns the number of bytes printed.
1030
1031 =cut
1032
1033 sub cat_blob {
1034         my ($self, $sha1, $fh) = @_;
1035
1036         $self->_open_cat_blob_if_needed();
1037         my ($in, $out) = ($self->{cat_blob_in}, $self->{cat_blob_out});
1038
1039         unless (print $out $sha1, "\n") {
1040                 $self->_close_cat_blob();
1041                 throw Error::Simple("out pipe went bad");
1042         }
1043
1044         my $description = <$in>;
1045         if ($description =~ / missing$/) {
1046                 carp "$sha1 doesn't exist in the repository";
1047                 return -1;
1048         }
1049
1050         if ($description !~ /^[0-9a-fA-F]{40} \S+ (\d+)$/) {
1051                 carp "Unexpected result returned from git cat-file";
1052                 return -1;
1053         }
1054
1055         my $size = $1;
1056
1057         my $blob;
1058         my $bytesLeft = $size;
1059
1060         while (1) {
1061                 last unless $bytesLeft;
1062
1063                 my $bytesToRead = $bytesLeft < 1024 ? $bytesLeft : 1024;
1064                 my $read = read($in, $blob, $bytesToRead);
1065                 unless (defined($read)) {
1066                         $self->_close_cat_blob();
1067                         throw Error::Simple("in pipe went bad");
1068                 }
1069                 unless (print $fh $blob) {
1070                         $self->_close_cat_blob();
1071                         throw Error::Simple("couldn't write to passed in filehandle");
1072                 }
1073                 $bytesLeft -= $read;
1074         }
1075
1076         # Skip past the trailing newline.
1077         my $newline;
1078         my $read = read($in, $newline, 1);
1079         unless (defined($read)) {
1080                 $self->_close_cat_blob();
1081                 throw Error::Simple("in pipe went bad");
1082         }
1083         unless ($read == 1 && $newline eq "\n") {
1084                 $self->_close_cat_blob();
1085                 throw Error::Simple("didn't find newline after blob");
1086         }
1087
1088         return $size;
1089 }
1090
1091 sub _open_cat_blob_if_needed {
1092         my ($self) = @_;
1093
1094         return if defined($self->{cat_blob_pid});
1095
1096         ($self->{cat_blob_pid}, $self->{cat_blob_in},
1097          $self->{cat_blob_out}, $self->{cat_blob_ctx}) =
1098                 $self->command_bidi_pipe(qw(cat-file --batch));
1099 }
1100
1101 sub _close_cat_blob {
1102         my ($self) = @_;
1103
1104         return unless defined($self->{cat_blob_pid});
1105
1106         my @vars = map { 'cat_blob_' . $_ } qw(pid in out ctx);
1107
1108         command_close_bidi_pipe(@$self{@vars});
1109         delete @$self{@vars};
1110 }
1111
1112
1113 =item credential_read( FILEHANDLE )
1114
1115 Reads credential key-value pairs from C<FILEHANDLE>.  Reading stops at EOF or
1116 when an empty line is encountered.  Each line must be of the form C<key=value>
1117 with a non-empty key.  Function returns hash with all read values.  Any white
1118 space (other than new-line character) is preserved.
1119
1120 =cut
1121
1122 sub credential_read {
1123         my ($self, $reader) = _maybe_self(@_);
1124         my %credential;
1125         while (<$reader>) {
1126                 chomp;
1127                 if ($_ eq '') {
1128                         last;
1129                 } elsif (!/^([^=]+)=(.*)$/) {
1130                         throw Error::Simple("unable to parse git credential data:\n$_");
1131                 }
1132                 $credential{$1} = $2;
1133         }
1134         return %credential;
1135 }
1136
1137 =item credential_write( FILEHANDLE, CREDENTIAL_HASHREF )
1138
1139 Writes credential key-value pairs from hash referenced by
1140 C<CREDENTIAL_HASHREF> to C<FILEHANDLE>.  Keys and values cannot contain
1141 new-lines or NUL bytes characters, and key cannot contain equal signs nor be
1142 empty (if they do Error::Simple is thrown).  Any white space is preserved.  If
1143 value for a key is C<undef>, it will be skipped.
1144
1145 If C<'url'> key exists it will be written first.  (All the other key-value
1146 pairs are written in sorted order but you should not depend on that).  Once
1147 all lines are written, an empty line is printed.
1148
1149 =cut
1150
1151 sub credential_write {
1152         my ($self, $writer, $credential) = _maybe_self(@_);
1153         my ($key, $value);
1154
1155         # Check if $credential is valid prior to writing anything
1156         while (($key, $value) = each %$credential) {
1157                 if (!defined $key || !length $key) {
1158                         throw Error::Simple("credential key empty or undefined");
1159                 } elsif ($key =~ /[=\n\0]/) {
1160                         throw Error::Simple("credential key contains invalid characters: $key");
1161                 } elsif (defined $value && $value =~ /[\n\0]/) {
1162                         throw Error::Simple("credential value for key=$key contains invalid characters: $value");
1163                 }
1164         }
1165
1166         for $key (sort {
1167                 # url overwrites other fields, so it must come first
1168                 return -1 if $a eq 'url';
1169                 return  1 if $b eq 'url';
1170                 return $a cmp $b;
1171         } keys %$credential) {
1172                 if (defined $credential->{$key}) {
1173                         print $writer $key, '=', $credential->{$key}, "\n";
1174                 }
1175         }
1176         print $writer "\n";
1177 }
1178
1179 sub _credential_run {
1180         my ($self, $credential, $op) = _maybe_self(@_);
1181         my ($pid, $reader, $writer, $ctx) = command_bidi_pipe('credential', $op);
1182
1183         credential_write $writer, $credential;
1184         close $writer;
1185
1186         if ($op eq "fill") {
1187                 %$credential = credential_read $reader;
1188         }
1189         if (<$reader>) {
1190                 throw Error::Simple("unexpected output from git credential $op response:\n$_\n");
1191         }
1192
1193         command_close_bidi_pipe($pid, $reader, undef, $ctx);
1194 }
1195
1196 =item credential( CREDENTIAL_HASHREF [, OPERATION ] )
1197
1198 =item credential( CREDENTIAL_HASHREF, CODE )
1199
1200 Executes C<git credential> for a given set of credentials and specified
1201 operation.  In both forms C<CREDENTIAL_HASHREF> needs to be a reference to
1202 a hash which stores credentials.  Under certain conditions the hash can
1203 change.
1204
1205 In the first form, C<OPERATION> can be C<'fill'>, C<'approve'> or C<'reject'>,
1206 and function will execute corresponding C<git credential> sub-command.  If
1207 it's omitted C<'fill'> is assumed.  In case of C<'fill'> the values stored in
1208 C<CREDENTIAL_HASHREF> will be changed to the ones returned by the C<git
1209 credential fill> command.  The usual usage would look something like:
1210
1211         my %cred = (
1212                 'protocol' => 'https',
1213                 'host' => 'example.com',
1214                 'username' => 'bob'
1215         );
1216         Git::credential \%cred;
1217         if (try_to_authenticate($cred{'username'}, $cred{'password'})) {
1218                 Git::credential \%cred, 'approve';
1219                 ... do more stuff ...
1220         } else {
1221                 Git::credential \%cred, 'reject';
1222         }
1223
1224 In the second form, C<CODE> needs to be a reference to a subroutine.  The
1225 function will execute C<git credential fill> to fill the provided credential
1226 hash, then call C<CODE> with C<CREDENTIAL_HASHREF> as the sole argument.  If
1227 C<CODE>'s return value is defined, the function will execute C<git credential
1228 approve> (if return value yields true) or C<git credential reject> (if return
1229 value is false).  If the return value is undef, nothing at all is executed;
1230 this is useful, for example, if the credential could neither be verified nor
1231 rejected due to an unrelated network error.  The return value is the same as
1232 what C<CODE> returns.  With this form, the usage might look as follows:
1233
1234         if (Git::credential {
1235                 'protocol' => 'https',
1236                 'host' => 'example.com',
1237                 'username' => 'bob'
1238         }, sub {
1239                 my $cred = shift;
1240                 return !!try_to_authenticate($cred->{'username'},
1241                                              $cred->{'password'});
1242         }) {
1243                 ... do more stuff ...
1244         }
1245
1246 =cut
1247
1248 sub credential {
1249         my ($self, $credential, $op_or_code) = (_maybe_self(@_), 'fill');
1250
1251         if ('CODE' eq ref $op_or_code) {
1252                 _credential_run $credential, 'fill';
1253                 my $ret = $op_or_code->($credential);
1254                 if (defined $ret) {
1255                         _credential_run $credential, $ret ? 'approve' : 'reject';
1256                 }
1257                 return $ret;
1258         } else {
1259                 _credential_run $credential, $op_or_code;
1260         }
1261 }
1262
1263 { # %TEMP_* Lexical Context
1264
1265 my (%TEMP_FILEMAP, %TEMP_FILES);
1266
1267 =item temp_acquire ( NAME )
1268
1269 Attempts to retrieve the temporary file mapped to the string C<NAME>. If an
1270 associated temp file has not been created this session or was closed, it is
1271 created, cached, and set for autoflush and binmode.
1272
1273 Internally locks the file mapped to C<NAME>. This lock must be released with
1274 C<temp_release()> when the temp file is no longer needed. Subsequent attempts
1275 to retrieve temporary files mapped to the same C<NAME> while still locked will
1276 cause an error. This locking mechanism provides a weak guarantee and is not
1277 threadsafe. It does provide some error checking to help prevent temp file refs
1278 writing over one another.
1279
1280 In general, the L<File::Handle> returned should not be closed by consumers as
1281 it defeats the purpose of this caching mechanism. If you need to close the temp
1282 file handle, then you should use L<File::Temp> or another temp file faculty
1283 directly. If a handle is closed and then requested again, then a warning will
1284 issue.
1285
1286 =cut
1287
1288 sub temp_acquire {
1289         my $temp_fd = _temp_cache(@_);
1290
1291         $TEMP_FILES{$temp_fd}{locked} = 1;
1292         $temp_fd;
1293 }
1294
1295 =item temp_is_locked ( NAME )
1296
1297 Returns true if the internal lock created by a previous C<temp_acquire()>
1298 call with C<NAME> is still in effect.
1299
1300 When temp_acquire is called on a C<NAME>, it internally locks the temporary
1301 file mapped to C<NAME>.  That lock will not be released until C<temp_release()>
1302 is called with either the original C<NAME> or the L<File::Handle> that was
1303 returned from the original call to temp_acquire.
1304
1305 Subsequent attempts to call C<temp_acquire()> with the same C<NAME> will fail
1306 unless there has been an intervening C<temp_release()> call for that C<NAME>
1307 (or its corresponding L<File::Handle> that was returned by the original
1308 C<temp_acquire()> call).
1309
1310 If true is returned by C<temp_is_locked()> for a C<NAME>, an attempt to
1311 C<temp_acquire()> the same C<NAME> will cause an error unless
1312 C<temp_release> is first called on that C<NAME> (or its corresponding
1313 L<File::Handle> that was returned by the original C<temp_acquire()> call).
1314
1315 =cut
1316
1317 sub temp_is_locked {
1318         my ($self, $name) = _maybe_self(@_);
1319         my $temp_fd = \$TEMP_FILEMAP{$name};
1320
1321         defined $$temp_fd && $$temp_fd->opened && $TEMP_FILES{$$temp_fd}{locked};
1322 }
1323
1324 =item temp_release ( NAME )
1325
1326 =item temp_release ( FILEHANDLE )
1327
1328 Releases a lock acquired through C<temp_acquire()>. Can be called either with
1329 the C<NAME> mapping used when acquiring the temp file or with the C<FILEHANDLE>
1330 referencing a locked temp file.
1331
1332 Warns if an attempt is made to release a file that is not locked.
1333
1334 The temp file will be truncated before being released. This can help to reduce
1335 disk I/O where the system is smart enough to detect the truncation while data
1336 is in the output buffers. Beware that after the temp file is released and
1337 truncated, any operations on that file may fail miserably until it is
1338 re-acquired. All contents are lost between each release and acquire mapped to
1339 the same string.
1340
1341 =cut
1342
1343 sub temp_release {
1344         my ($self, $temp_fd, $trunc) = _maybe_self(@_);
1345
1346         if (exists $TEMP_FILEMAP{$temp_fd}) {
1347                 $temp_fd = $TEMP_FILES{$temp_fd};
1348         }
1349         unless ($TEMP_FILES{$temp_fd}{locked}) {
1350                 carp "Attempt to release temp file '",
1351                         $temp_fd, "' that has not been locked";
1352         }
1353         temp_reset($temp_fd) if $trunc and $temp_fd->opened;
1354
1355         $TEMP_FILES{$temp_fd}{locked} = 0;
1356         undef;
1357 }
1358
1359 sub _temp_cache {
1360         my ($self, $name) = _maybe_self(@_);
1361
1362         _verify_require();
1363
1364         my $temp_fd = \$TEMP_FILEMAP{$name};
1365         if (defined $$temp_fd and $$temp_fd->opened) {
1366                 if ($TEMP_FILES{$$temp_fd}{locked}) {
1367                         throw Error::Simple("Temp file with moniker '" .
1368                                 $name . "' already in use");
1369                 }
1370         } else {
1371                 if (defined $$temp_fd) {
1372                         # then we're here because of a closed handle.
1373                         carp "Temp file '", $name,
1374                                 "' was closed. Opening replacement.";
1375                 }
1376                 my $fname;
1377
1378                 my $tmpdir;
1379                 if (defined $self) {
1380                         $tmpdir = $self->repo_path();
1381                 }
1382
1383                 my $n = $name;
1384                 $n =~ s/\W/_/g; # no strange chars
1385
1386                 ($$temp_fd, $fname) = File::Temp::tempfile(
1387                         "Git_${n}_XXXXXX", UNLINK => 1, DIR => $tmpdir,
1388                         ) or throw Error::Simple("couldn't open new temp file");
1389
1390                 $$temp_fd->autoflush;
1391                 binmode $$temp_fd;
1392                 $TEMP_FILES{$$temp_fd}{fname} = $fname;
1393         }
1394         $$temp_fd;
1395 }
1396
1397 sub _verify_require {
1398         eval { require File::Temp; require File::Spec; };
1399         $@ and throw Error::Simple($@);
1400 }
1401
1402 =item temp_reset ( FILEHANDLE )
1403
1404 Truncates and resets the position of the C<FILEHANDLE>.
1405
1406 =cut
1407
1408 sub temp_reset {
1409         my ($self, $temp_fd) = _maybe_self(@_);
1410
1411         truncate $temp_fd, 0
1412                 or throw Error::Simple("couldn't truncate file");
1413         sysseek($temp_fd, 0, SEEK_SET) and seek($temp_fd, 0, SEEK_SET)
1414                 or throw Error::Simple("couldn't seek to beginning of file");
1415         sysseek($temp_fd, 0, SEEK_CUR) == 0 and tell($temp_fd) == 0
1416                 or throw Error::Simple("expected file position to be reset");
1417 }
1418
1419 =item temp_path ( NAME )
1420
1421 =item temp_path ( FILEHANDLE )
1422
1423 Returns the filename associated with the given tempfile.
1424
1425 =cut
1426
1427 sub temp_path {
1428         my ($self, $temp_fd) = _maybe_self(@_);
1429
1430         if (exists $TEMP_FILEMAP{$temp_fd}) {
1431                 $temp_fd = $TEMP_FILEMAP{$temp_fd};
1432         }
1433         $TEMP_FILES{$temp_fd}{fname};
1434 }
1435
1436 sub END {
1437         unlink values %TEMP_FILEMAP if %TEMP_FILEMAP;
1438 }
1439
1440 } # %TEMP_* Lexical Context
1441
1442 =item prefix_lines ( PREFIX, STRING [, STRING... ])
1443
1444 Prefixes lines in C<STRING> with C<PREFIX>.
1445
1446 =cut
1447
1448 sub prefix_lines {
1449         my $prefix = shift;
1450         my $string = join("\n", @_);
1451         $string =~ s/^/$prefix/mg;
1452         return $string;
1453 }
1454
1455 =item unquote_path ( PATH )
1456
1457 Unquote a quoted path containing c-escapes as returned by ls-files etc.
1458 when not using -z or when parsing the output of diff -u.
1459
1460 =cut
1461
1462 {
1463         my %cquote_map = (
1464                 "a" => chr(7),
1465                 "b" => chr(8),
1466                 "t" => chr(9),
1467                 "n" => chr(10),
1468                 "v" => chr(11),
1469                 "f" => chr(12),
1470                 "r" => chr(13),
1471                 "\\" => "\\",
1472                 "\042" => "\042",
1473         );
1474
1475         sub unquote_path {
1476                 local ($_) = @_;
1477                 my ($retval, $remainder);
1478                 if (!/^\042(.*)\042$/) {
1479                         return $_;
1480                 }
1481                 ($_, $retval) = ($1, "");
1482                 while (/^([^\\]*)\\(.*)$/) {
1483                         $remainder = $2;
1484                         $retval .= $1;
1485                         for ($remainder) {
1486                                 if (/^([0-3][0-7][0-7])(.*)$/) {
1487                                         $retval .= chr(oct($1));
1488                                         $_ = $2;
1489                                         last;
1490                                 }
1491                                 if (/^([\\\042abtnvfr])(.*)$/) {
1492                                         $retval .= $cquote_map{$1};
1493                                         $_ = $2;
1494                                         last;
1495                                 }
1496                                 # This is malformed
1497                                 throw Error::Simple("invalid quoted path $_[0]");
1498                         }
1499                         $_ = $remainder;
1500                 }
1501                 $retval .= $_;
1502                 return $retval;
1503         }
1504 }
1505
1506 =item get_comment_line_char ( )
1507
1508 Gets the core.commentchar configuration value.
1509 The value falls-back to '#' if core.commentchar is set to 'auto'.
1510
1511 =cut
1512
1513 sub get_comment_line_char {
1514         my $comment_line_char = config("core.commentchar") || '#';
1515         $comment_line_char = '#' if ($comment_line_char eq 'auto');
1516         $comment_line_char = '#' if (length($comment_line_char) != 1);
1517         return $comment_line_char;
1518 }
1519
1520 =item comment_lines ( STRING [, STRING... ])
1521
1522 Comments lines following core.commentchar configuration.
1523
1524 =cut
1525
1526 sub comment_lines {
1527         my $comment_line_char = get_comment_line_char;
1528         return prefix_lines("$comment_line_char ", @_);
1529 }
1530
1531 =back
1532
1533 =head1 ERROR HANDLING
1534
1535 All functions are supposed to throw Perl exceptions in case of errors.
1536 See the L<Error> module on how to catch those. Most exceptions are mere
1537 L<Error::Simple> instances.
1538
1539 However, the C<command()>, C<command_oneline()> and C<command_noisy()>
1540 functions suite can throw C<Git::Error::Command> exceptions as well: those are
1541 thrown when the external command returns an error code and contain the error
1542 code as well as access to the captured command's output. The exception class
1543 provides the usual C<stringify> and C<value> (command's exit code) methods and
1544 in addition also a C<cmd_output> method that returns either an array or a
1545 string with the captured command output (depending on the original function
1546 call context; C<command_noisy()> returns C<undef>) and $<cmdline> which
1547 returns the command and its arguments (but without proper quoting).
1548
1549 Note that the C<command_*_pipe()> functions cannot throw this exception since
1550 it has no idea whether the command failed or not. You will only find out
1551 at the time you C<close> the pipe; if you want to have that automated,
1552 use C<command_close_pipe()>, which can throw the exception.
1553
1554 =cut
1555
1556 {
1557         package Git::Error::Command;
1558
1559         @Git::Error::Command::ISA = qw(Error);
1560
1561         sub new {
1562                 my $self = shift;
1563                 my $cmdline = '' . shift;
1564                 my $value = 0 + shift;
1565                 my $outputref = shift;
1566                 my(@args) = ();
1567
1568                 local $Error::Depth = $Error::Depth + 1;
1569
1570                 push(@args, '-cmdline', $cmdline);
1571                 push(@args, '-value', $value);
1572                 push(@args, '-outputref', $outputref);
1573
1574                 $self->SUPER::new(-text => 'command returned error', @args);
1575         }
1576
1577         sub stringify {
1578                 my $self = shift;
1579                 my $text = $self->SUPER::stringify;
1580                 $self->cmdline() . ': ' . $text . ': ' . $self->value() . "\n";
1581         }
1582
1583         sub cmdline {
1584                 my $self = shift;
1585                 $self->{'-cmdline'};
1586         }
1587
1588         sub cmd_output {
1589                 my $self = shift;
1590                 my $ref = $self->{'-outputref'};
1591                 defined $ref or undef;
1592                 if (ref $ref eq 'ARRAY') {
1593                         return @$ref;
1594                 } else { # SCALAR
1595                         return $$ref;
1596                 }
1597         }
1598 }
1599
1600 =over 4
1601
1602 =item git_cmd_try { CODE } ERRMSG
1603
1604 This magical statement will automatically catch any C<Git::Error::Command>
1605 exceptions thrown by C<CODE> and make your program die with C<ERRMSG>
1606 on its lips; the message will have %s substituted for the command line
1607 and %d for the exit status. This statement is useful mostly for producing
1608 more user-friendly error messages.
1609
1610 In case of no exception caught the statement returns C<CODE>'s return value.
1611
1612 Note that this is the only auto-exported function.
1613
1614 =cut
1615
1616 sub git_cmd_try(&$) {
1617         my ($code, $errmsg) = @_;
1618         my @result;
1619         my $err;
1620         my $array = wantarray;
1621         try {
1622                 if ($array) {
1623                         @result = &$code;
1624                 } else {
1625                         $result[0] = &$code;
1626                 }
1627         } catch Git::Error::Command with {
1628                 my $E = shift;
1629                 $err = $errmsg;
1630                 $err =~ s/\%s/$E->cmdline()/ge;
1631                 $err =~ s/\%d/$E->value()/ge;
1632                 # We can't croak here since Error.pm would mangle
1633                 # that to Error::Simple.
1634         };
1635         $err and croak $err;
1636         return $array ? @result : $result[0];
1637 }
1638
1639
1640 =back
1641
1642 =head1 COPYRIGHT
1643
1644 Copyright 2006 by Petr Baudis E<lt>pasky@suse.czE<gt>.
1645
1646 This module is free software; it may be used, copied, modified
1647 and distributed under the terms of the GNU General Public Licence,
1648 either version 2, or (at your option) any later version.
1649
1650 =cut
1651
1652
1653 # Take raw method argument list and return ($obj, @args) in case
1654 # the method was called upon an instance and (undef, @args) if
1655 # it was called directly.
1656 sub _maybe_self {
1657         UNIVERSAL::isa($_[0], 'Git') ? @_ : (undef, @_);
1658 }
1659
1660 # Check if the command id is something reasonable.
1661 sub _check_valid_cmd {
1662         my ($cmd) = @_;
1663         $cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error::Simple("bad command: $cmd");
1664 }
1665
1666 # Common backend for the pipe creators.
1667 sub _command_common_pipe {
1668         my $direction = shift;
1669         my ($self, @p) = _maybe_self(@_);
1670         my (%opts, $cmd, @args);
1671         if (ref $p[0]) {
1672                 ($cmd, @args) = @{shift @p};
1673                 %opts = ref $p[0] ? %{$p[0]} : @p;
1674         } else {
1675                 ($cmd, @args) = @p;
1676         }
1677         _check_valid_cmd($cmd);
1678
1679         my $fh;
1680         if ($^O eq 'MSWin32') {
1681                 # ActiveState Perl
1682                 #defined $opts{STDERR} and
1683                 #       warn 'ignoring STDERR option - running w/ ActiveState';
1684                 $direction eq '-|' or
1685                         die 'input pipe for ActiveState not implemented';
1686                 # the strange construction with *ACPIPE is just to
1687                 # explain the tie below that we want to bind to
1688                 # a handle class, not scalar. It is not known if
1689                 # it is something specific to ActiveState Perl or
1690                 # just a Perl quirk.
1691                 tie (*ACPIPE, 'Git::activestate_pipe', $cmd, @args);
1692                 $fh = *ACPIPE;
1693
1694         } else {
1695                 my $pid = open($fh, $direction);
1696                 if (not defined $pid) {
1697                         throw Error::Simple("open failed: $!");
1698                 } elsif ($pid == 0) {
1699                         if ($opts{STDERR}) {
1700                                 open (STDERR, '>&', $opts{STDERR})
1701                                         or die "dup failed: $!";
1702                         } elsif (defined $opts{STDERR}) {
1703                                 open (STDERR, '>', '/dev/null')
1704                                         or die "opening /dev/null failed: $!";
1705                         }
1706                         _cmd_exec($self, $cmd, @args);
1707                 }
1708         }
1709         return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh;
1710 }
1711
1712 # When already in the subprocess, set up the appropriate state
1713 # for the given repository and execute the git command.
1714 sub _cmd_exec {
1715         my ($self, @args) = @_;
1716         _setup_git_cmd_env($self);
1717         _execv_git_cmd(@args);
1718         die qq[exec "@args" failed: $!];
1719 }
1720
1721 # set up the appropriate state for git command
1722 sub _setup_git_cmd_env {
1723         my $self = shift;
1724         if ($self) {
1725                 $self->repo_path() and $ENV{'GIT_DIR'} = $self->repo_path();
1726                 $self->repo_path() and $self->wc_path()
1727                         and $ENV{'GIT_WORK_TREE'} = $self->wc_path();
1728                 $self->wc_path() and chdir($self->wc_path());
1729                 $self->wc_subdir() and chdir($self->wc_subdir());
1730         }
1731 }
1732
1733 # Execute the given Git command ($_[0]) with arguments ($_[1..])
1734 # by searching for it at proper places.
1735 sub _execv_git_cmd { exec('git', @_); }
1736
1737 # Close pipe to a subprocess.
1738 sub _cmd_close {
1739         my $ctx = shift @_;
1740         foreach my $fh (@_) {
1741                 if (close $fh) {
1742                         # nop
1743                 } elsif ($!) {
1744                         # It's just close, no point in fatalities
1745                         carp "error closing pipe: $!";
1746                 } elsif ($? >> 8) {
1747                         # The caller should pepper this.
1748                         throw Git::Error::Command($ctx, $? >> 8);
1749                 }
1750                 # else we might e.g. closed a live stream; the command
1751                 # dying of SIGPIPE would drive us here.
1752         }
1753 }
1754
1755
1756 sub DESTROY {
1757         my ($self) = @_;
1758         $self->_close_hash_and_insert_object();
1759         $self->_close_cat_blob();
1760 }
1761
1762
1763 # Pipe implementation for ActiveState Perl.
1764
1765 package Git::activestate_pipe;
1766 use strict;
1767
1768 sub TIEHANDLE {
1769         my ($class, @params) = @_;
1770         # FIXME: This is probably horrible idea and the thing will explode
1771         # at the moment you give it arguments that require some quoting,
1772         # but I have no ActiveState clue... --pasky
1773         # Let's just hope ActiveState Perl does at least the quoting
1774         # correctly.
1775         my @data = qx{git @params};
1776         bless { i => 0, data => \@data }, $class;
1777 }
1778
1779 sub READLINE {
1780         my $self = shift;
1781         if ($self->{i} >= scalar @{$self->{data}}) {
1782                 return undef;
1783         }
1784         my $i = $self->{i};
1785         if (wantarray) {
1786                 $self->{i} = $#{$self->{'data'}} + 1;
1787                 return splice(@{$self->{'data'}}, $i);
1788         }
1789         $self->{i} = $i + 1;
1790         return $self->{'data'}->[ $i ];
1791 }
1792
1793 sub CLOSE {
1794         my $self = shift;
1795         delete $self->{data};
1796         delete $self->{i};
1797 }
1798
1799 sub EOF {
1800         my $self = shift;
1801         return ($self->{i} >= scalar @{$self->{data}});
1802 }
1803
1804
1805 1; # Famous last words