perl/Git.pm: Honor SSH_ASKPASS as fallback if GIT_ASKPASS is not set
[git/git.git] / perl / Git.pm
CommitLineData
b1edc53d
PB
1=head1 NAME
2
3Git - Perl interface to the Git version control system
4
5=cut
6
7
8package Git;
9
d48b2841 10use 5.008;
b1edc53d
PB
11use strict;
12
13
14BEGIN {
15
16our ($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
8b9150e3
PB
28 git_cmd_try { Git::command_noisy('update-server-info') }
29 '%s failed w/ code %d';
b1edc53d
PB
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
d79850e1 36 my ($fh, $c) = $repo->command_output_pipe('rev-list', '--since=last monday', '--all');
b1edc53d 37 my $lastrev = <$fh>; chomp $lastrev;
8b9150e3 38 $repo->command_close_pipe($fh, $c);
b1edc53d 39
d43ba468
PB
40 my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ],
41 STDERR => 0 );
b1edc53d 42
7182530d
AR
43 my $sha1 = $repo->hash_and_insert_object('file.txt');
44 my $tempfile = tempfile();
45 my $size = $repo->cat_blob($sha1, $tempfile);
46
b1edc53d
PB
47=cut
48
49
50require Exporter;
51
52@ISA = qw(Exporter);
53
8b9150e3 54@EXPORT = qw(git_cmd_try);
b1edc53d
PB
55
56# Methods which can be called as standalone functions as well:
d79850e1
PB
57@EXPORT_OK = qw(command command_oneline command_noisy
58 command_output_pipe command_input_pipe command_close_pipe
d1a29af9 59 command_bidi_pipe command_close_bidi_pipe
89a56bfb 60 version exec_path html_path hash_object git_cmd_try
38ecf3a3 61 remote_refs prompt
836ff95d 62 temp_acquire temp_release temp_reset temp_path);
b1edc53d
PB
63
64
65=head1 DESCRIPTION
66
67This module provides Perl scripts easy way to interface the Git version control
68system. The modules have an easy and well-tested way to call arbitrary Git
69commands; in the future, the interface will also provide specialized methods
70for doing easily operations which are not totally trivial to do over
71the generic command interface.
72
73While some commands can be executed outside of any context (e.g. 'version'
5c94f87e 74or 'init'), most operations require a repository context, which in practice
b1edc53d
PB
75means getting an instance of the Git object using the repository() constructor.
76(In the future, we will also get a new_repository() constructor.) All commands
77called as methods of the object are then executed in the context of the
78repository.
79
d5c7721d
PB
80Part of the "repository state" is also information about path to the attached
81working copy (unless you work with a bare repository). You can also navigate
82inside of the working copy using the C<wc_chdir()> method. (Note that
83the repository object is self-contained and will not change working directory
84of your process.)
b1edc53d 85
d5c7721d 86TODO: In the future, we might also do
b1edc53d
PB
87
88 my $remoterepo = $repo->remote_repository (Name => 'cogito', Branch => 'master');
89 $remoterepo ||= Git->remote_repository ('http://git.or.cz/cogito.git/');
90 my @refs = $remoterepo->refs();
91
b1edc53d
PB
92Currently, the module merely wraps calls to external Git tools. In the future,
93it will provide a much faster way to interact with Git by linking directly
94to libgit. This should be completely opaque to the user, though (performance
9751a32a 95increase notwithstanding).
b1edc53d
PB
96
97=cut
98
99
8b9150e3 100use Carp qw(carp croak); # but croak is bad - throw instead
97b16c06 101use Error qw(:try);
48d9e6ae 102use Cwd qw(abs_path cwd);
d1a29af9 103use IPC::Open2 qw(open2);
e41352b2 104use Fcntl qw(SEEK_SET SEEK_CUR);
b1edc53d
PB
105}
106
107
108=head1 CONSTRUCTORS
109
110=over 4
111
112=item repository ( OPTIONS )
113
114=item repository ( DIRECTORY )
115
116=item repository ()
117
118Construct a new repository object.
119C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
120Possible options are:
121
122B<Repository> - Path to the Git repository.
123
124B<WorkingCopy> - Path to the associated working copy; not strictly required
125as many commands will happily crunch on a bare repository.
126
d5c7721d
PB
127B<WorkingSubdir> - Subdirectory in the working copy to work inside.
128Just left undefined if you do not want to limit the scope of operations.
129
130B<Directory> - Path to the Git working directory in its usual setup.
131The C<.git> directory is searched in the directory and all the parent
132directories; if found, C<WorkingCopy> is set to the directory containing
133it and C<Repository> to the C<.git> directory itself. If no C<.git>
134directory was found, the C<Directory> is assumed to be a bare repository,
135C<Repository> is set to point at it and C<WorkingCopy> is left undefined.
136If the C<$GIT_DIR> environment variable is set, things behave as expected
137as well.
b1edc53d 138
b1edc53d
PB
139You should not use both C<Directory> and either of C<Repository> and
140C<WorkingCopy> - the results of that are undefined.
141
142Alternatively, a directory path may be passed as a single scalar argument
143to the constructor; it is equivalent to setting only the C<Directory> option
144field.
145
146Calling the constructor with no options whatsoever is equivalent to
d5c7721d
PB
147calling it with C<< Directory => '.' >>. In general, if you are building
148a standard porcelain command, simply doing C<< Git->repository() >> should
149do the right thing and setup the object to reflect exactly where the user
150is right now.
b1edc53d
PB
151
152=cut
153
154sub repository {
155 my $class = shift;
156 my @args = @_;
157 my %opts = ();
158 my $self;
159
160 if (defined $args[0]) {
161 if ($#args % 2 != 1) {
162 # Not a hash.
97b16c06
PB
163 $#args == 0 or throw Error::Simple("bad usage");
164 %opts = ( Directory => $args[0] );
b1edc53d
PB
165 } else {
166 %opts = @args;
167 }
d5c7721d
PB
168 }
169
11b8a41c
PB
170 if (not defined $opts{Repository} and not defined $opts{WorkingCopy}
171 and not defined $opts{Directory}) {
172 $opts{Directory} = '.';
d5c7721d
PB
173 }
174
11b8a41c 175 if (defined $opts{Directory}) {
64abcc48 176 -d $opts{Directory} or throw Error::Simple("Directory not found: $opts{Directory} $!");
d5c7721d
PB
177
178 my $search = Git->repository(WorkingCopy => $opts{Directory});
179 my $dir;
180 try {
181 $dir = $search->command_oneline(['rev-parse', '--git-dir'],
182 STDERR => 0);
183 } catch Git::Error::Command with {
184 $dir = undef;
185 };
b1edc53d 186
d5c7721d 187 if ($dir) {
71efe0ca 188 $dir =~ m#^/# or $dir = $opts{Directory} . '/' . $dir;
fe53bbc9 189 $opts{Repository} = abs_path($dir);
d5c7721d
PB
190
191 # If --git-dir went ok, this shouldn't die either.
192 my $prefix = $search->command_oneline('rev-parse', '--show-prefix');
193 $dir = abs_path($opts{Directory}) . '/';
194 if ($prefix) {
195 if (substr($dir, -length($prefix)) ne $prefix) {
196 throw Error::Simple("rev-parse confused me - $dir does not have trailing $prefix");
197 }
198 substr($dir, -length($prefix)) = '';
b1edc53d 199 }
d5c7721d
PB
200 $opts{WorkingCopy} = $dir;
201 $opts{WorkingSubdir} = $prefix;
202
203 } else {
204 # A bare repository? Let's see...
205 $dir = $opts{Directory};
206
207 unless (-d "$dir/refs" and -d "$dir/objects" and -e "$dir/HEAD") {
9517e6b8 208 # Mimic git-rev-parse --git-dir error message:
f66bc5f9 209 throw Error::Simple("fatal: Not a git repository: $dir");
d5c7721d
PB
210 }
211 my $search = Git->repository(Repository => $dir);
212 try {
213 $search->command('symbolic-ref', 'HEAD');
214 } catch Git::Error::Command with {
9517e6b8 215 # Mimic git-rev-parse --git-dir error message:
f66bc5f9 216 throw Error::Simple("fatal: Not a git repository: $dir");
d5c7721d
PB
217 }
218
219 $opts{Repository} = abs_path($dir);
b1edc53d 220 }
d5c7721d
PB
221
222 delete $opts{Directory};
b1edc53d
PB
223 }
224
81a71734 225 $self = { opts => \%opts };
b1edc53d
PB
226 bless $self, $class;
227}
228
b1edc53d
PB
229=back
230
231=head1 METHODS
232
233=over 4
234
235=item command ( COMMAND [, ARGUMENTS... ] )
236
d43ba468
PB
237=item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
238
b1edc53d
PB
239Execute the given Git C<COMMAND> (specify it without the 'git-'
240prefix), optionally with the specified extra C<ARGUMENTS>.
241
d43ba468
PB
242The second more elaborate form can be used if you want to further adjust
243the command execution. Currently, only one option is supported:
244
245B<STDERR> - How to deal with the command's error output. By default (C<undef>)
246it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause
247it to be thrown away. If you want to process it, you can get it in a filehandle
248you specify, but you must be extremely careful; if the error output is not
249very short and you want to read it in the same process as where you called
250C<command()>, you are set up for a nice deadlock!
251
b1edc53d
PB
252The method can be called without any instance or on a specified Git repository
253(in that case the command will be run in the repository context).
254
255In scalar context, it returns all the command output in a single string
256(verbatim).
257
258In array context, it returns an array containing lines printed to the
259command's stdout (without trailing newlines).
260
261In both cases, the command's stdin and stderr are the same as the caller's.
262
263=cut
264
265sub command {
d79850e1 266 my ($fh, $ctx) = command_output_pipe(@_);
b1edc53d
PB
267
268 if (not defined wantarray) {
8b9150e3
PB
269 # Nothing to pepper the possible exception with.
270 _cmd_close($fh, $ctx);
b1edc53d
PB
271
272 } elsif (not wantarray) {
273 local $/;
274 my $text = <$fh>;
8b9150e3
PB
275 try {
276 _cmd_close($fh, $ctx);
277 } catch Git::Error::Command with {
278 # Pepper with the output:
279 my $E = shift;
280 $E->{'-outputref'} = \$text;
281 throw $E;
282 };
b1edc53d
PB
283 return $text;
284
285 } else {
286 my @lines = <$fh>;
67e4baf8 287 defined and chomp for @lines;
8b9150e3
PB
288 try {
289 _cmd_close($fh, $ctx);
290 } catch Git::Error::Command with {
291 my $E = shift;
292 $E->{'-outputref'} = \@lines;
293 throw $E;
294 };
b1edc53d
PB
295 return @lines;
296 }
297}
298
299
300=item command_oneline ( COMMAND [, ARGUMENTS... ] )
301
d43ba468
PB
302=item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
303
b1edc53d
PB
304Execute the given C<COMMAND> in the same way as command()
305does but always return a scalar string containing the first line
306of the command's standard output.
307
308=cut
309
310sub command_oneline {
d79850e1 311 my ($fh, $ctx) = command_output_pipe(@_);
b1edc53d
PB
312
313 my $line = <$fh>;
d5c7721d 314 defined $line and chomp $line;
8b9150e3
PB
315 try {
316 _cmd_close($fh, $ctx);
317 } catch Git::Error::Command with {
318 # Pepper with the output:
319 my $E = shift;
320 $E->{'-outputref'} = \$line;
321 throw $E;
322 };
b1edc53d
PB
323 return $line;
324}
325
326
d79850e1 327=item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
b1edc53d 328
d43ba468
PB
329=item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
330
b1edc53d
PB
331Execute the given C<COMMAND> in the same way as command()
332does but return a pipe filehandle from which the command output can be
333read.
334
d79850e1
PB
335The function can return C<($pipe, $ctx)> in array context.
336See C<command_close_pipe()> for details.
337
b1edc53d
PB
338=cut
339
d79850e1
PB
340sub command_output_pipe {
341 _command_common_pipe('-|', @_);
342}
b1edc53d 343
b1edc53d 344
d79850e1
PB
345=item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
346
d43ba468
PB
347=item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
348
d79850e1
PB
349Execute the given C<COMMAND> in the same way as command_output_pipe()
350does but return an input pipe filehandle instead; the command output
351is not captured.
352
353The function can return C<($pipe, $ctx)> in array context.
354See C<command_close_pipe()> for details.
355
356=cut
357
358sub command_input_pipe {
359 _command_common_pipe('|-', @_);
8b9150e3
PB
360}
361
362
363=item command_close_pipe ( PIPE [, CTX ] )
364
d79850e1 365Close the C<PIPE> as returned from C<command_*_pipe()>, checking
3dff5379 366whether the command finished successfully. The optional C<CTX> argument
8b9150e3 367is required if you want to see the command name in the error message,
d79850e1 368and it is the second value returned by C<command_*_pipe()> when
8b9150e3
PB
369called in array context. The call idiom is:
370
d79850e1
PB
371 my ($fh, $ctx) = $r->command_output_pipe('status');
372 while (<$fh>) { ... }
373 $r->command_close_pipe($fh, $ctx);
8b9150e3
PB
374
375Note that you should not rely on whatever actually is in C<CTX>;
376currently it is simply the command name but in future the context might
377have more complicated structure.
378
379=cut
380
381sub command_close_pipe {
382 my ($self, $fh, $ctx) = _maybe_self(@_);
383 $ctx ||= '<unknown>';
384 _cmd_close($fh, $ctx);
b1edc53d
PB
385}
386
d1a29af9
AR
387=item command_bidi_pipe ( COMMAND [, ARGUMENTS... ] )
388
389Execute the given C<COMMAND> in the same way as command_output_pipe()
390does but return both an input pipe filehandle and an output pipe filehandle.
391
392The function will return return C<($pid, $pipe_in, $pipe_out, $ctx)>.
393See C<command_close_bidi_pipe()> for details.
394
395=cut
396
397sub command_bidi_pipe {
398 my ($pid, $in, $out);
48d9e6ae
MO
399 my ($self) = _maybe_self(@_);
400 local %ENV = %ENV;
401 my $cwd_save = undef;
402 if ($self) {
403 shift;
404 $cwd_save = cwd();
405 _setup_git_cmd_env($self);
406 }
d1a29af9 407 $pid = open2($in, $out, 'git', @_);
48d9e6ae 408 chdir($cwd_save) if $cwd_save;
d1a29af9
AR
409 return ($pid, $in, $out, join(' ', @_));
410}
411
412=item command_close_bidi_pipe ( PID, PIPE_IN, PIPE_OUT [, CTX] )
413
414Close the C<PIPE_IN> and C<PIPE_OUT> as returned from C<command_bidi_pipe()>,
415checking whether the command finished successfully. The optional C<CTX>
416argument is required if you want to see the command name in the error message,
417and it is the fourth value returned by C<command_bidi_pipe()>. The call idiom
418is:
419
420 my ($pid, $in, $out, $ctx) = $r->command_bidi_pipe('cat-file --batch-check');
421 print "000000000\n" $out;
422 while (<$in>) { ... }
423 $r->command_close_bidi_pipe($pid, $in, $out, $ctx);
424
425Note that you should not rely on whatever actually is in C<CTX>;
426currently it is simply the command name but in future the context might
427have more complicated structure.
428
429=cut
430
431sub command_close_bidi_pipe {
108c2aaf 432 local $?;
d1a29af9
AR
433 my ($pid, $in, $out, $ctx) = @_;
434 foreach my $fh ($in, $out) {
435 unless (close $fh) {
436 if ($!) {
437 carp "error closing pipe: $!";
438 } elsif ($? >> 8) {
439 throw Git::Error::Command($ctx, $? >>8);
440 }
441 }
442 }
443
444 waitpid $pid, 0;
445
446 if ($? >> 8) {
447 throw Git::Error::Command($ctx, $? >>8);
448 }
449}
450
b1edc53d
PB
451
452=item command_noisy ( COMMAND [, ARGUMENTS... ] )
453
454Execute the given C<COMMAND> in the same way as command() does but do not
455capture the command output - the standard output is not redirected and goes
456to the standard output of the caller application.
457
458While the method is called command_noisy(), you might want to as well use
459it for the most silent Git commands which you know will never pollute your
460stdout but you want to avoid the overhead of the pipe setup when calling them.
461
462The function returns only after the command has finished running.
463
464=cut
465
466sub command_noisy {
467 my ($self, $cmd, @args) = _maybe_self(@_);
d79850e1 468 _check_valid_cmd($cmd);
b1edc53d
PB
469
470 my $pid = fork;
471 if (not defined $pid) {
97b16c06 472 throw Error::Simple("fork failed: $!");
b1edc53d
PB
473 } elsif ($pid == 0) {
474 _cmd_exec($self, $cmd, @args);
475 }
8b9150e3
PB
476 if (waitpid($pid, 0) > 0 and $?>>8 != 0) {
477 throw Git::Error::Command(join(' ', $cmd, @args), $? >> 8);
b1edc53d
PB
478 }
479}
480
481
63df97ae
PB
482=item version ()
483
484Return the Git version in use.
485
63df97ae
PB
486=cut
487
18b0fc1c
PB
488sub version {
489 my $verstr = command_oneline('--version');
490 $verstr =~ s/^git version //;
491 $verstr;
492}
63df97ae
PB
493
494
eca1f6fd
PB
495=item exec_path ()
496
d5c7721d 497Return path to the Git sub-command executables (the same as
eca1f6fd
PB
498C<git --exec-path>). Useful mostly only internally.
499
eca1f6fd
PB
500=cut
501
18b0fc1c 502sub exec_path { command_oneline('--exec-path') }
eca1f6fd
PB
503
504
89a56bfb
MH
505=item html_path ()
506
507Return path to the Git html documentation (the same as
508C<git --html-path>). Useful mostly only internally.
509
510=cut
511
512sub html_path { command_oneline('--html-path') }
513
38ecf3a3
SS
514=item prompt ( PROMPT )
515
516Query user C<PROMPT> and return answer from user.
517
8f3cab2b
SS
518Honours GIT_ASKPASS and SSH_ASKPASS environment variables for querying
519the user. If no *_ASKPASS variable is set or an error occoured,
38ecf3a3
SS
520the terminal is tried as a fallback.
521
522=cut
523
524sub prompt {
525 my ($prompt) = @_;
526 my $ret;
527 if (exists $ENV{'GIT_ASKPASS'}) {
528 $ret = _prompt($ENV{'GIT_ASKPASS'}, $prompt);
529 }
8f3cab2b
SS
530 if (!defined $ret && exists $ENV{'SSH_ASKPASS'}) {
531 $ret = _prompt($ENV{'SSH_ASKPASS'}, $prompt);
532 }
38ecf3a3
SS
533 if (!defined $ret) {
534 print STDERR $prompt;
535 STDERR->flush;
536 require Term::ReadKey;
537 Term::ReadKey::ReadMode('noecho');
538 $ret = '';
539 while (defined(my $key = Term::ReadKey::ReadKey(0))) {
540 last if $key =~ /[\012\015]/; # \n\r
541 $ret .= $key;
542 }
543 Term::ReadKey::ReadMode('restore');
544 print STDERR "\n";
545 STDERR->flush;
546 }
547 return $ret;
548}
549
550sub _prompt {
551 my ($askpass, $prompt) = @_;
552 return unless length $askpass;
553 my $ret;
554 open my $fh, "-|", $askpass, $prompt or return;
555 $ret = <$fh>;
556 $ret =~ s/[\015\012]//g; # strip \r\n, chomp does not work on all systems (i.e. windows) as expected
557 close ($fh);
558 return $ret;
559}
89a56bfb 560
d5c7721d
PB
561=item repo_path ()
562
563Return path to the git repository. Must be called on a repository instance.
564
565=cut
566
567sub repo_path { $_[0]->{opts}->{Repository} }
568
569
570=item wc_path ()
571
572Return path to the working copy. Must be called on a repository instance.
573
574=cut
575
576sub wc_path { $_[0]->{opts}->{WorkingCopy} }
577
578
579=item wc_subdir ()
580
581Return path to the subdirectory inside of a working copy. Must be called
582on a repository instance.
583
584=cut
585
586sub wc_subdir { $_[0]->{opts}->{WorkingSubdir} ||= '' }
587
588
589=item wc_chdir ( SUBDIR )
590
591Change the working copy subdirectory to work within. The C<SUBDIR> is
592relative to the working copy root directory (not the current subdirectory).
593Must be called on a repository instance attached to a working copy
594and the directory must exist.
595
596=cut
597
598sub wc_chdir {
599 my ($self, $subdir) = @_;
d5c7721d
PB
600 $self->wc_path()
601 or throw Error::Simple("bare repository");
602
603 -d $self->wc_path().'/'.$subdir
64abcc48 604 or throw Error::Simple("subdir not found: $subdir $!");
d5c7721d
PB
605 # Of course we will not "hold" the subdirectory so anyone
606 # can delete it now and we will never know. But at least we tried.
607
608 $self->{opts}->{WorkingSubdir} = $subdir;
609}
610
611
dc2613de
PB
612=item config ( VARIABLE )
613
e0d10e1c 614Retrieve the configuration C<VARIABLE> in the same manner as C<config>
dc2613de
PB
615does. In scalar context requires the variable to be set only one time
616(exception is thrown otherwise), in array context returns allows the
617variable to be set multiple times and returns all the values.
618
dc2613de
PB
619=cut
620
621sub config {
6942a3d7 622 return _config_common({}, @_);
dc2613de
PB
623}
624
625
35c49eea 626=item config_bool ( VARIABLE )
7b9a13ec 627
35c49eea
PB
628Retrieve the bool configuration C<VARIABLE>. The return value
629is usable as a boolean in perl (and C<undef> if it's not defined,
630of course).
7b9a13ec 631
7b9a13ec
TT
632=cut
633
35c49eea 634sub config_bool {
6942a3d7 635 my $val = scalar _config_common({'kind' => '--bool'}, @_);
7b9a13ec 636
6942a3d7
JH
637 # Do not rewrite this as return (defined $val && $val eq 'true')
638 # as some callers do care what kind of falsehood they receive.
639 if (!defined $val) {
640 return undef;
641 } else {
35c49eea 642 return $val eq 'true';
6942a3d7 643 }
7b9a13ec
TT
644}
645
9fef9e27
CS
646
647=item config_path ( VARIABLE )
648
649Retrieve the path configuration C<VARIABLE>. The return value
650is an expanded path or C<undef> if it's not defined.
651
9fef9e27
CS
652=cut
653
654sub config_path {
6942a3d7 655 return _config_common({'kind' => '--path'}, @_);
9fef9e27
CS
656}
657
6942a3d7 658
346d203b
JN
659=item config_int ( VARIABLE )
660
661Retrieve the integer configuration C<VARIABLE>. The return value
662is simple decimal number. An optional value suffix of 'k', 'm',
663or 'g' in the config file will cause the value to be multiplied
664by 1024, 1048576 (1024^2), or 1073741824 (1024^3) prior to output.
665It would return C<undef> if configuration variable is not defined,
666
346d203b
JN
667=cut
668
669sub config_int {
6942a3d7
JH
670 return scalar _config_common({'kind' => '--int'}, @_);
671}
672
673# Common subroutine to implement bulk of what the config* family of methods
674# do. This curently wraps command('config') so it is not so fast.
675sub _config_common {
676 my ($opts) = shift @_;
c2e357c2 677 my ($self, $var) = _maybe_self(@_);
346d203b
JN
678
679 try {
6942a3d7 680 my @cmd = ('config', $opts->{'kind'} ? $opts->{'kind'} : ());
c2e357c2 681 unshift @cmd, $self if $self;
6942a3d7
JH
682 if (wantarray) {
683 return command(@cmd, '--get-all', $var);
684 } else {
685 return command_oneline(@cmd, '--get', $var);
686 }
346d203b
JN
687 } catch Git::Error::Command with {
688 my $E = shift;
689 if ($E->value() == 1) {
690 # Key not found.
6942a3d7 691 return;
346d203b
JN
692 } else {
693 throw $E;
694 }
695 };
696}
7b9a13ec 697
b4c61ed6
JH
698=item get_colorbool ( NAME )
699
700Finds if color should be used for NAMEd operation from the configuration,
701and returns boolean (true for "use color", false for "do not use color").
702
703=cut
704
705sub get_colorbool {
706 my ($self, $var) = @_;
707 my $stdout_to_tty = (-t STDOUT) ? "true" : "false";
708 my $use_color = $self->command_oneline('config', '--get-colorbool',
709 $var, $stdout_to_tty);
710 return ($use_color eq 'true');
711}
712
713=item get_color ( SLOT, COLOR )
714
715Finds color for SLOT from the configuration, while defaulting to COLOR,
716and returns the ANSI color escape sequence:
717
718 print $repo->get_color("color.interactive.prompt", "underline blue white");
719 print "some text";
720 print $repo->get_color("", "normal");
721
722=cut
723
724sub get_color {
725 my ($self, $slot, $default) = @_;
726 my $color = $self->command_oneline('config', '--get-color', $slot, $default);
727 if (!defined $color) {
728 $color = "";
729 }
730 return $color;
731}
732
31a92f6a
PB
733=item remote_refs ( REPOSITORY [, GROUPS [, REFGLOBS ] ] )
734
735This function returns a hashref of refs stored in a given remote repository.
736The hash is in the format C<refname =\> hash>. For tags, the C<refname> entry
737contains the tag object while a C<refname^{}> entry gives the tagged objects.
738
739C<REPOSITORY> has the same meaning as the appropriate C<git-ls-remote>
a7793a74 740argument; either a URL or a remote name (if called on a repository instance).
31a92f6a
PB
741C<GROUPS> is an optional arrayref that can contain 'tags' to return all the
742tags and/or 'heads' to return all the heads. C<REFGLOB> is an optional array
743of strings containing a shell-like glob to further limit the refs returned in
744the hash; the meaning is again the same as the appropriate C<git-ls-remote>
745argument.
746
747This function may or may not be called on a repository instance. In the former
748case, remote names as defined in the repository are recognized as repository
749specifiers.
750
751=cut
752
753sub remote_refs {
754 my ($self, $repo, $groups, $refglobs) = _maybe_self(@_);
755 my @args;
756 if (ref $groups eq 'ARRAY') {
757 foreach (@$groups) {
758 if ($_ eq 'heads') {
759 push (@args, '--heads');
760 } elsif ($_ eq 'tags') {
761 push (@args, '--tags');
762 } else {
763 # Ignore unknown groups for future
764 # compatibility
765 }
766 }
767 }
768 push (@args, $repo);
769 if (ref $refglobs eq 'ARRAY') {
770 push (@args, @$refglobs);
771 }
772
773 my @self = $self ? ($self) : (); # Ultra trickery
774 my ($fh, $ctx) = Git::command_output_pipe(@self, 'ls-remote', @args);
775 my %refs;
776 while (<$fh>) {
777 chomp;
778 my ($hash, $ref) = split(/\t/, $_, 2);
779 $refs{$ref} = $hash;
780 }
781 Git::command_close_pipe(@self, $fh, $ctx);
782 return \%refs;
783}
784
785
c7a30e56
PB
786=item ident ( TYPE | IDENTSTR )
787
788=item ident_person ( TYPE | IDENTSTR | IDENTARRAY )
789
790This suite of functions retrieves and parses ident information, as stored
791in the commit and tag objects or produced by C<var GIT_type_IDENT> (thus
792C<TYPE> can be either I<author> or I<committer>; case is insignificant).
793
5354a56f 794The C<ident> method retrieves the ident information from C<git var>
c7a30e56
PB
795and either returns it as a scalar string or as an array with the fields parsed.
796Alternatively, it can take a prepared ident string (e.g. from the commit
797object) and just parse it.
798
799C<ident_person> returns the person part of the ident - name and email;
800it can take the same arguments as C<ident> or the array returned by C<ident>.
801
802The synopsis is like:
803
804 my ($name, $email, $time_tz) = ident('author');
805 "$name <$email>" eq ident_person('author');
806 "$name <$email>" eq ident_person($name);
807 $time_tz =~ /^\d+ [+-]\d{4}$/;
808
c7a30e56
PB
809=cut
810
811sub ident {
44617928 812 my ($self, $type) = _maybe_self(@_);
c7a30e56
PB
813 my $identstr;
814 if (lc $type eq lc 'committer' or lc $type eq lc 'author') {
44617928
FL
815 my @cmd = ('var', 'GIT_'.uc($type).'_IDENT');
816 unshift @cmd, $self if $self;
817 $identstr = command_oneline(@cmd);
c7a30e56
PB
818 } else {
819 $identstr = $type;
820 }
821 if (wantarray) {
822 return $identstr =~ /^(.*) <(.*)> (\d+ [+-]\d{4})$/;
823 } else {
824 return $identstr;
825 }
826}
827
828sub ident_person {
44617928
FL
829 my ($self, @ident) = _maybe_self(@_);
830 $#ident == 0 and @ident = $self ? $self->ident($ident[0]) : ident($ident[0]);
c7a30e56
PB
831 return "$ident[0] <$ident[1]>";
832}
833
834
24c4b714 835=item hash_object ( TYPE, FILENAME )
b1edc53d 836
58c8dd21
LW
837Compute the SHA1 object id of the given C<FILENAME> considering it is
838of the C<TYPE> object type (C<blob>, C<commit>, C<tree>).
b1edc53d 839
b1edc53d
PB
840The method can be called without any instance or on a specified Git repository,
841it makes zero difference.
842
843The function returns the SHA1 hash.
844
b1edc53d
PB
845=cut
846
18b0fc1c 847# TODO: Support for passing FILEHANDLE instead of FILENAME
e6634ac9
PB
848sub hash_object {
849 my ($self, $type, $file) = _maybe_self(@_);
18b0fc1c 850 command_oneline('hash-object', '-t', $type, $file);
e6634ac9 851}
b1edc53d
PB
852
853
7182530d
AR
854=item hash_and_insert_object ( FILENAME )
855
856Compute the SHA1 object id of the given C<FILENAME> and add the object to the
857object database.
858
859The function returns the SHA1 hash.
860
861=cut
862
863# TODO: Support for passing FILEHANDLE instead of FILENAME
864sub hash_and_insert_object {
865 my ($self, $filename) = @_;
866
867 carp "Bad filename \"$filename\"" if $filename =~ /[\r\n]/;
868
869 $self->_open_hash_and_insert_object_if_needed();
870 my ($in, $out) = ($self->{hash_object_in}, $self->{hash_object_out});
871
872 unless (print $out $filename, "\n") {
873 $self->_close_hash_and_insert_object();
874 throw Error::Simple("out pipe went bad");
875 }
876
877 chomp(my $hash = <$in>);
878 unless (defined($hash)) {
879 $self->_close_hash_and_insert_object();
880 throw Error::Simple("in pipe went bad");
881 }
882
883 return $hash;
884}
885
886sub _open_hash_and_insert_object_if_needed {
887 my ($self) = @_;
888
889 return if defined($self->{hash_object_pid});
890
891 ($self->{hash_object_pid}, $self->{hash_object_in},
892 $self->{hash_object_out}, $self->{hash_object_ctx}) =
48d9e6ae 893 $self->command_bidi_pipe(qw(hash-object -w --stdin-paths --no-filters));
7182530d
AR
894}
895
896sub _close_hash_and_insert_object {
897 my ($self) = @_;
898
899 return unless defined($self->{hash_object_pid});
900
901 my @vars = map { 'hash_object_' . $_ } qw(pid in out ctx);
902
452d36b1
AMS
903 command_close_bidi_pipe(@$self{@vars});
904 delete @$self{@vars};
7182530d
AR
905}
906
907=item cat_blob ( SHA1, FILEHANDLE )
908
909Prints the contents of the blob identified by C<SHA1> to C<FILEHANDLE> and
910returns the number of bytes printed.
911
912=cut
913
914sub cat_blob {
915 my ($self, $sha1, $fh) = @_;
916
917 $self->_open_cat_blob_if_needed();
918 my ($in, $out) = ($self->{cat_blob_in}, $self->{cat_blob_out});
919
920 unless (print $out $sha1, "\n") {
921 $self->_close_cat_blob();
922 throw Error::Simple("out pipe went bad");
923 }
924
925 my $description = <$in>;
926 if ($description =~ / missing$/) {
927 carp "$sha1 doesn't exist in the repository";
d683a0e0 928 return -1;
7182530d
AR
929 }
930
931 if ($description !~ /^[0-9a-fA-F]{40} \S+ (\d+)$/) {
932 carp "Unexpected result returned from git cat-file";
d683a0e0 933 return -1;
7182530d
AR
934 }
935
936 my $size = $1;
937
938 my $blob;
939 my $bytesRead = 0;
940
941 while (1) {
942 my $bytesLeft = $size - $bytesRead;
943 last unless $bytesLeft;
944
945 my $bytesToRead = $bytesLeft < 1024 ? $bytesLeft : 1024;
946 my $read = read($in, $blob, $bytesToRead, $bytesRead);
947 unless (defined($read)) {
948 $self->_close_cat_blob();
949 throw Error::Simple("in pipe went bad");
950 }
951
952 $bytesRead += $read;
953 }
954
955 # Skip past the trailing newline.
956 my $newline;
957 my $read = read($in, $newline, 1);
958 unless (defined($read)) {
959 $self->_close_cat_blob();
960 throw Error::Simple("in pipe went bad");
961 }
962 unless ($read == 1 && $newline eq "\n") {
963 $self->_close_cat_blob();
964 throw Error::Simple("didn't find newline after blob");
965 }
966
967 unless (print $fh $blob) {
968 $self->_close_cat_blob();
969 throw Error::Simple("couldn't write to passed in filehandle");
970 }
971
972 return $size;
973}
974
975sub _open_cat_blob_if_needed {
976 my ($self) = @_;
977
978 return if defined($self->{cat_blob_pid});
979
980 ($self->{cat_blob_pid}, $self->{cat_blob_in},
981 $self->{cat_blob_out}, $self->{cat_blob_ctx}) =
48d9e6ae 982 $self->command_bidi_pipe(qw(cat-file --batch));
7182530d
AR
983}
984
985sub _close_cat_blob {
986 my ($self) = @_;
987
988 return unless defined($self->{cat_blob_pid});
989
990 my @vars = map { 'cat_blob_' . $_ } qw(pid in out ctx);
991
452d36b1
AMS
992 command_close_bidi_pipe(@$self{@vars});
993 delete @$self{@vars};
7182530d 994}
8b9150e3 995
e41352b2
MG
996
997{ # %TEMP_* Lexical Context
998
836ff95d 999my (%TEMP_FILEMAP, %TEMP_FILES);
e41352b2
MG
1000
1001=item temp_acquire ( NAME )
1002
1003Attempts to retreive the temporary file mapped to the string C<NAME>. If an
1004associated temp file has not been created this session or was closed, it is
1005created, cached, and set for autoflush and binmode.
1006
1007Internally locks the file mapped to C<NAME>. This lock must be released with
1008C<temp_release()> when the temp file is no longer needed. Subsequent attempts
1009to retrieve temporary files mapped to the same C<NAME> while still locked will
1010cause an error. This locking mechanism provides a weak guarantee and is not
1011threadsafe. It does provide some error checking to help prevent temp file refs
1012writing over one another.
1013
1014In general, the L<File::Handle> returned should not be closed by consumers as
1015it defeats the purpose of this caching mechanism. If you need to close the temp
1016file handle, then you should use L<File::Temp> or another temp file faculty
1017directly. If a handle is closed and then requested again, then a warning will
1018issue.
1019
1020=cut
1021
1022sub temp_acquire {
bcdd1b44 1023 my $temp_fd = _temp_cache(@_);
e41352b2 1024
836ff95d 1025 $TEMP_FILES{$temp_fd}{locked} = 1;
e41352b2
MG
1026 $temp_fd;
1027}
1028
1029=item temp_release ( NAME )
1030
1031=item temp_release ( FILEHANDLE )
1032
1033Releases a lock acquired through C<temp_acquire()>. Can be called either with
1034the C<NAME> mapping used when acquiring the temp file or with the C<FILEHANDLE>
1035referencing a locked temp file.
1036
1037Warns if an attempt is made to release a file that is not locked.
1038
1039The temp file will be truncated before being released. This can help to reduce
1040disk I/O where the system is smart enough to detect the truncation while data
1041is in the output buffers. Beware that after the temp file is released and
1042truncated, any operations on that file may fail miserably until it is
1043re-acquired. All contents are lost between each release and acquire mapped to
1044the same string.
1045
1046=cut
1047
1048sub temp_release {
1049 my ($self, $temp_fd, $trunc) = _maybe_self(@_);
1050
836ff95d 1051 if (exists $TEMP_FILEMAP{$temp_fd}) {
e41352b2
MG
1052 $temp_fd = $TEMP_FILES{$temp_fd};
1053 }
836ff95d 1054 unless ($TEMP_FILES{$temp_fd}{locked}) {
e41352b2
MG
1055 carp "Attempt to release temp file '",
1056 $temp_fd, "' that has not been locked";
1057 }
1058 temp_reset($temp_fd) if $trunc and $temp_fd->opened;
1059
836ff95d 1060 $TEMP_FILES{$temp_fd}{locked} = 0;
e41352b2
MG
1061 undef;
1062}
1063
1064sub _temp_cache {
bcdd1b44 1065 my ($self, $name) = _maybe_self(@_);
e41352b2 1066
c14c8ceb
MG
1067 _verify_require();
1068
836ff95d 1069 my $temp_fd = \$TEMP_FILEMAP{$name};
e41352b2 1070 if (defined $$temp_fd and $$temp_fd->opened) {
836ff95d 1071 if ($TEMP_FILES{$$temp_fd}{locked}) {
8faea4f3
JS
1072 throw Error::Simple("Temp file with moniker '" .
1073 $name . "' already in use");
e41352b2
MG
1074 }
1075 } else {
1076 if (defined $$temp_fd) {
1077 # then we're here because of a closed handle.
1078 carp "Temp file '", $name,
1079 "' was closed. Opening replacement.";
1080 }
836ff95d 1081 my $fname;
bcdd1b44
MS
1082
1083 my $tmpdir;
1084 if (defined $self) {
1085 $tmpdir = $self->repo_path();
1086 }
1087
836ff95d 1088 ($$temp_fd, $fname) = File::Temp->tempfile(
bcdd1b44 1089 'Git_XXXXXX', UNLINK => 1, DIR => $tmpdir,
e41352b2 1090 ) or throw Error::Simple("couldn't open new temp file");
bcdd1b44 1091
e41352b2
MG
1092 $$temp_fd->autoflush;
1093 binmode $$temp_fd;
836ff95d 1094 $TEMP_FILES{$$temp_fd}{fname} = $fname;
e41352b2
MG
1095 }
1096 $$temp_fd;
1097}
1098
c14c8ceb
MG
1099sub _verify_require {
1100 eval { require File::Temp; require File::Spec; };
1101 $@ and throw Error::Simple($@);
1102}
1103
e41352b2
MG
1104=item temp_reset ( FILEHANDLE )
1105
1106Truncates and resets the position of the C<FILEHANDLE>.
1107
1108=cut
1109
1110sub temp_reset {
1111 my ($self, $temp_fd) = _maybe_self(@_);
1112
1113 truncate $temp_fd, 0
1114 or throw Error::Simple("couldn't truncate file");
1115 sysseek($temp_fd, 0, SEEK_SET) and seek($temp_fd, 0, SEEK_SET)
1116 or throw Error::Simple("couldn't seek to beginning of file");
1117 sysseek($temp_fd, 0, SEEK_CUR) == 0 and tell($temp_fd) == 0
1118 or throw Error::Simple("expected file position to be reset");
1119}
1120
836ff95d
MG
1121=item temp_path ( NAME )
1122
1123=item temp_path ( FILEHANDLE )
1124
1125Returns the filename associated with the given tempfile.
1126
1127=cut
1128
1129sub temp_path {
1130 my ($self, $temp_fd) = _maybe_self(@_);
1131
1132 if (exists $TEMP_FILEMAP{$temp_fd}) {
1133 $temp_fd = $TEMP_FILEMAP{$temp_fd};
1134 }
1135 $TEMP_FILES{$temp_fd}{fname};
1136}
1137
e41352b2 1138sub END {
836ff95d 1139 unlink values %TEMP_FILEMAP if %TEMP_FILEMAP;
e41352b2
MG
1140}
1141
1142} # %TEMP_* Lexical Context
1143
b1edc53d
PB
1144=back
1145
97b16c06 1146=head1 ERROR HANDLING
b1edc53d 1147
97b16c06 1148All functions are supposed to throw Perl exceptions in case of errors.
8b9150e3
PB
1149See the L<Error> module on how to catch those. Most exceptions are mere
1150L<Error::Simple> instances.
1151
1152However, the C<command()>, C<command_oneline()> and C<command_noisy()>
1153functions suite can throw C<Git::Error::Command> exceptions as well: those are
1154thrown when the external command returns an error code and contain the error
1155code as well as access to the captured command's output. The exception class
1156provides the usual C<stringify> and C<value> (command's exit code) methods and
1157in addition also a C<cmd_output> method that returns either an array or a
1158string with the captured command output (depending on the original function
1159call context; C<command_noisy()> returns C<undef>) and $<cmdline> which
1160returns the command and its arguments (but without proper quoting).
1161
d79850e1 1162Note that the C<command_*_pipe()> functions cannot throw this exception since
8b9150e3
PB
1163it has no idea whether the command failed or not. You will only find out
1164at the time you C<close> the pipe; if you want to have that automated,
1165use C<command_close_pipe()>, which can throw the exception.
1166
1167=cut
1168
1169{
1170 package Git::Error::Command;
1171
1172 @Git::Error::Command::ISA = qw(Error);
1173
1174 sub new {
1175 my $self = shift;
1176 my $cmdline = '' . shift;
1177 my $value = 0 + shift;
1178 my $outputref = shift;
1179 my(@args) = ();
1180
1181 local $Error::Depth = $Error::Depth + 1;
1182
1183 push(@args, '-cmdline', $cmdline);
1184 push(@args, '-value', $value);
1185 push(@args, '-outputref', $outputref);
1186
1187 $self->SUPER::new(-text => 'command returned error', @args);
1188 }
1189
1190 sub stringify {
1191 my $self = shift;
1192 my $text = $self->SUPER::stringify;
1193 $self->cmdline() . ': ' . $text . ': ' . $self->value() . "\n";
1194 }
1195
1196 sub cmdline {
1197 my $self = shift;
1198 $self->{'-cmdline'};
1199 }
1200
1201 sub cmd_output {
1202 my $self = shift;
1203 my $ref = $self->{'-outputref'};
1204 defined $ref or undef;
1205 if (ref $ref eq 'ARRAY') {
1206 return @$ref;
1207 } else { # SCALAR
1208 return $$ref;
1209 }
1210 }
1211}
1212
1213=over 4
1214
1215=item git_cmd_try { CODE } ERRMSG
1216
1217This magical statement will automatically catch any C<Git::Error::Command>
1218exceptions thrown by C<CODE> and make your program die with C<ERRMSG>
1219on its lips; the message will have %s substituted for the command line
1220and %d for the exit status. This statement is useful mostly for producing
1221more user-friendly error messages.
1222
1223In case of no exception caught the statement returns C<CODE>'s return value.
1224
1225Note that this is the only auto-exported function.
1226
1227=cut
1228
1229sub git_cmd_try(&$) {
1230 my ($code, $errmsg) = @_;
1231 my @result;
1232 my $err;
1233 my $array = wantarray;
1234 try {
1235 if ($array) {
1236 @result = &$code;
1237 } else {
1238 $result[0] = &$code;
1239 }
1240 } catch Git::Error::Command with {
1241 my $E = shift;
1242 $err = $errmsg;
1243 $err =~ s/\%s/$E->cmdline()/ge;
1244 $err =~ s/\%d/$E->value()/ge;
1245 # We can't croak here since Error.pm would mangle
1246 # that to Error::Simple.
1247 };
1248 $err and croak $err;
1249 return $array ? @result : $result[0];
1250}
1251
1252
1253=back
b1edc53d
PB
1254
1255=head1 COPYRIGHT
1256
1257Copyright 2006 by Petr Baudis E<lt>pasky@suse.czE<gt>.
1258
1259This module is free software; it may be used, copied, modified
1260and distributed under the terms of the GNU General Public Licence,
1261either version 2, or (at your option) any later version.
1262
1263=cut
1264
1265
1266# Take raw method argument list and return ($obj, @args) in case
1267# the method was called upon an instance and (undef, @args) if
1268# it was called directly.
1269sub _maybe_self {
d8b24b93 1270 UNIVERSAL::isa($_[0], 'Git') ? @_ : (undef, @_);
b1edc53d
PB
1271}
1272
d79850e1
PB
1273# Check if the command id is something reasonable.
1274sub _check_valid_cmd {
1275 my ($cmd) = @_;
1276 $cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error::Simple("bad command: $cmd");
1277}
1278
1279# Common backend for the pipe creators.
1280sub _command_common_pipe {
1281 my $direction = shift;
d43ba468
PB
1282 my ($self, @p) = _maybe_self(@_);
1283 my (%opts, $cmd, @args);
1284 if (ref $p[0]) {
1285 ($cmd, @args) = @{shift @p};
1286 %opts = ref $p[0] ? %{$p[0]} : @p;
1287 } else {
1288 ($cmd, @args) = @p;
1289 }
d79850e1
PB
1290 _check_valid_cmd($cmd);
1291
a6065b54 1292 my $fh;
d3b1785f 1293 if ($^O eq 'MSWin32') {
a6065b54
PB
1294 # ActiveState Perl
1295 #defined $opts{STDERR} and
1296 # warn 'ignoring STDERR option - running w/ ActiveState';
1297 $direction eq '-|' or
1298 die 'input pipe for ActiveState not implemented';
bed118d6
AR
1299 # the strange construction with *ACPIPE is just to
1300 # explain the tie below that we want to bind to
1301 # a handle class, not scalar. It is not known if
1302 # it is something specific to ActiveState Perl or
1303 # just a Perl quirk.
1304 tie (*ACPIPE, 'Git::activestate_pipe', $cmd, @args);
1305 $fh = *ACPIPE;
a6065b54
PB
1306
1307 } else {
1308 my $pid = open($fh, $direction);
1309 if (not defined $pid) {
1310 throw Error::Simple("open failed: $!");
1311 } elsif ($pid == 0) {
1312 if (defined $opts{STDERR}) {
1313 close STDERR;
1314 }
1315 if ($opts{STDERR}) {
1316 open (STDERR, '>&', $opts{STDERR})
1317 or die "dup failed: $!";
1318 }
1319 _cmd_exec($self, $cmd, @args);
d43ba468 1320 }
d79850e1
PB
1321 }
1322 return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh;
1323}
1324
b1edc53d
PB
1325# When already in the subprocess, set up the appropriate state
1326# for the given repository and execute the git command.
1327sub _cmd_exec {
1328 my ($self, @args) = @_;
48d9e6ae
MO
1329 _setup_git_cmd_env($self);
1330 _execv_git_cmd(@args);
1331 die qq[exec "@args" failed: $!];
1332}
1333
1334# set up the appropriate state for git command
1335sub _setup_git_cmd_env {
1336 my $self = shift;
b1edc53d 1337 if ($self) {
d5c7721d 1338 $self->repo_path() and $ENV{'GIT_DIR'} = $self->repo_path();
da159c77
FL
1339 $self->repo_path() and $self->wc_path()
1340 and $ENV{'GIT_WORK_TREE'} = $self->wc_path();
d5c7721d
PB
1341 $self->wc_path() and chdir($self->wc_path());
1342 $self->wc_subdir() and chdir($self->wc_subdir());
b1edc53d 1343 }
b1edc53d
PB
1344}
1345
8062f81c
PB
1346# Execute the given Git command ($_[0]) with arguments ($_[1..])
1347# by searching for it at proper places.
18b0fc1c 1348sub _execv_git_cmd { exec('git', @_); }
8062f81c 1349
b1edc53d
PB
1350# Close pipe to a subprocess.
1351sub _cmd_close {
8b9150e3 1352 my ($fh, $ctx) = @_;
b1edc53d
PB
1353 if (not close $fh) {
1354 if ($!) {
1355 # It's just close, no point in fatalities
1356 carp "error closing pipe: $!";
1357 } elsif ($? >> 8) {
8b9150e3
PB
1358 # The caller should pepper this.
1359 throw Git::Error::Command($ctx, $? >> 8);
b1edc53d
PB
1360 }
1361 # else we might e.g. closed a live stream; the command
1362 # dying of SIGPIPE would drive us here.
1363 }
1364}
1365
1366
7182530d
AR
1367sub DESTROY {
1368 my ($self) = @_;
1369 $self->_close_hash_and_insert_object();
1370 $self->_close_cat_blob();
1371}
b1edc53d
PB
1372
1373
a6065b54
PB
1374# Pipe implementation for ActiveState Perl.
1375
1376package Git::activestate_pipe;
1377use strict;
1378
1379sub TIEHANDLE {
1380 my ($class, @params) = @_;
1381 # FIXME: This is probably horrible idea and the thing will explode
1382 # at the moment you give it arguments that require some quoting,
1383 # but I have no ActiveState clue... --pasky
d3b1785f
AR
1384 # Let's just hope ActiveState Perl does at least the quoting
1385 # correctly.
1386 my @data = qx{git @params};
a6065b54
PB
1387 bless { i => 0, data => \@data }, $class;
1388}
1389
1390sub READLINE {
1391 my $self = shift;
1392 if ($self->{i} >= scalar @{$self->{data}}) {
1393 return undef;
1394 }
2f5b3980
AR
1395 my $i = $self->{i};
1396 if (wantarray) {
1397 $self->{i} = $#{$self->{'data'}} + 1;
1398 return splice(@{$self->{'data'}}, $i);
1399 }
1400 $self->{i} = $i + 1;
1401 return $self->{'data'}->[ $i ];
a6065b54
PB
1402}
1403
1404sub CLOSE {
1405 my $self = shift;
1406 delete $self->{data};
1407 delete $self->{i};
1408}
1409
1410sub EOF {
1411 my $self = shift;
1412 return ($self->{i} >= scalar @{$self->{data}});
1413}
1414
1415
b1edc53d 14161; # Famous last words