Assorted typo fixes
[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
10use strict;
11
12
13BEGIN {
14
15our ($VERSION, @ISA, @EXPORT, @EXPORT_OK);
16
17# Totally unstable API.
18$VERSION = '0.01';
19
20
21=head1 SYNOPSIS
22
23 use Git;
24
25 my $version = Git::command_oneline('version');
26
8b9150e3
PB
27 git_cmd_try { Git::command_noisy('update-server-info') }
28 '%s failed w/ code %d';
b1edc53d
PB
29
30 my $repo = Git->repository (Directory => '/srv/git/cogito.git');
31
32
33 my @revs = $repo->command('rev-list', '--since=last monday', '--all');
34
d79850e1 35 my ($fh, $c) = $repo->command_output_pipe('rev-list', '--since=last monday', '--all');
b1edc53d 36 my $lastrev = <$fh>; chomp $lastrev;
8b9150e3 37 $repo->command_close_pipe($fh, $c);
b1edc53d 38
d43ba468
PB
39 my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ],
40 STDERR => 0 );
b1edc53d
PB
41
42=cut
43
44
45require Exporter;
46
47@ISA = qw(Exporter);
48
8b9150e3 49@EXPORT = qw(git_cmd_try);
b1edc53d
PB
50
51# Methods which can be called as standalone functions as well:
d79850e1
PB
52@EXPORT_OK = qw(command command_oneline command_noisy
53 command_output_pipe command_input_pipe command_close_pipe
8b9150e3 54 version exec_path hash_object git_cmd_try);
b1edc53d
PB
55
56
57=head1 DESCRIPTION
58
59This module provides Perl scripts easy way to interface the Git version control
60system. The modules have an easy and well-tested way to call arbitrary Git
61commands; in the future, the interface will also provide specialized methods
62for doing easily operations which are not totally trivial to do over
63the generic command interface.
64
65While some commands can be executed outside of any context (e.g. 'version'
5c94f87e 66or 'init'), most operations require a repository context, which in practice
b1edc53d
PB
67means getting an instance of the Git object using the repository() constructor.
68(In the future, we will also get a new_repository() constructor.) All commands
69called as methods of the object are then executed in the context of the
70repository.
71
d5c7721d
PB
72Part of the "repository state" is also information about path to the attached
73working copy (unless you work with a bare repository). You can also navigate
74inside of the working copy using the C<wc_chdir()> method. (Note that
75the repository object is self-contained and will not change working directory
76of your process.)
b1edc53d 77
d5c7721d 78TODO: In the future, we might also do
b1edc53d
PB
79
80 my $remoterepo = $repo->remote_repository (Name => 'cogito', Branch => 'master');
81 $remoterepo ||= Git->remote_repository ('http://git.or.cz/cogito.git/');
82 my @refs = $remoterepo->refs();
83
b1edc53d
PB
84Currently, the module merely wraps calls to external Git tools. In the future,
85it will provide a much faster way to interact with Git by linking directly
86to libgit. This should be completely opaque to the user, though (performance
87increate nonwithstanding).
88
89=cut
90
91
8b9150e3 92use Carp qw(carp croak); # but croak is bad - throw instead
97b16c06 93use Error qw(:try);
d5c7721d 94use Cwd qw(abs_path);
b1edc53d 95
b1edc53d
PB
96}
97
98
99=head1 CONSTRUCTORS
100
101=over 4
102
103=item repository ( OPTIONS )
104
105=item repository ( DIRECTORY )
106
107=item repository ()
108
109Construct a new repository object.
110C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
111Possible options are:
112
113B<Repository> - Path to the Git repository.
114
115B<WorkingCopy> - Path to the associated working copy; not strictly required
116as many commands will happily crunch on a bare repository.
117
d5c7721d
PB
118B<WorkingSubdir> - Subdirectory in the working copy to work inside.
119Just left undefined if you do not want to limit the scope of operations.
120
121B<Directory> - Path to the Git working directory in its usual setup.
122The C<.git> directory is searched in the directory and all the parent
123directories; if found, C<WorkingCopy> is set to the directory containing
124it and C<Repository> to the C<.git> directory itself. If no C<.git>
125directory was found, the C<Directory> is assumed to be a bare repository,
126C<Repository> is set to point at it and C<WorkingCopy> is left undefined.
127If the C<$GIT_DIR> environment variable is set, things behave as expected
128as well.
b1edc53d 129
b1edc53d
PB
130You should not use both C<Directory> and either of C<Repository> and
131C<WorkingCopy> - the results of that are undefined.
132
133Alternatively, a directory path may be passed as a single scalar argument
134to the constructor; it is equivalent to setting only the C<Directory> option
135field.
136
137Calling the constructor with no options whatsoever is equivalent to
d5c7721d
PB
138calling it with C<< Directory => '.' >>. In general, if you are building
139a standard porcelain command, simply doing C<< Git->repository() >> should
140do the right thing and setup the object to reflect exactly where the user
141is right now.
b1edc53d
PB
142
143=cut
144
145sub repository {
146 my $class = shift;
147 my @args = @_;
148 my %opts = ();
149 my $self;
150
151 if (defined $args[0]) {
152 if ($#args % 2 != 1) {
153 # Not a hash.
97b16c06
PB
154 $#args == 0 or throw Error::Simple("bad usage");
155 %opts = ( Directory => $args[0] );
b1edc53d
PB
156 } else {
157 %opts = @args;
158 }
d5c7721d
PB
159 }
160
161 if (not defined $opts{Repository} and not defined $opts{WorkingCopy}) {
162 $opts{Directory} ||= '.';
163 }
164
165 if ($opts{Directory}) {
166 -d $opts{Directory} or throw Error::Simple("Directory not found: $!");
167
168 my $search = Git->repository(WorkingCopy => $opts{Directory});
169 my $dir;
170 try {
171 $dir = $search->command_oneline(['rev-parse', '--git-dir'],
172 STDERR => 0);
173 } catch Git::Error::Command with {
174 $dir = undef;
175 };
b1edc53d 176
d5c7721d 177 if ($dir) {
71efe0ca
PB
178 $dir =~ m#^/# or $dir = $opts{Directory} . '/' . $dir;
179 $opts{Repository} = $dir;
d5c7721d
PB
180
181 # If --git-dir went ok, this shouldn't die either.
182 my $prefix = $search->command_oneline('rev-parse', '--show-prefix');
183 $dir = abs_path($opts{Directory}) . '/';
184 if ($prefix) {
185 if (substr($dir, -length($prefix)) ne $prefix) {
186 throw Error::Simple("rev-parse confused me - $dir does not have trailing $prefix");
187 }
188 substr($dir, -length($prefix)) = '';
b1edc53d 189 }
d5c7721d
PB
190 $opts{WorkingCopy} = $dir;
191 $opts{WorkingSubdir} = $prefix;
192
193 } else {
194 # A bare repository? Let's see...
195 $dir = $opts{Directory};
196
197 unless (-d "$dir/refs" and -d "$dir/objects" and -e "$dir/HEAD") {
198 # Mimick git-rev-parse --git-dir error message:
199 throw Error::Simple('fatal: Not a git repository');
200 }
201 my $search = Git->repository(Repository => $dir);
202 try {
203 $search->command('symbolic-ref', 'HEAD');
204 } catch Git::Error::Command with {
205 # Mimick git-rev-parse --git-dir error message:
206 throw Error::Simple('fatal: Not a git repository');
207 }
208
209 $opts{Repository} = abs_path($dir);
b1edc53d 210 }
d5c7721d
PB
211
212 delete $opts{Directory};
b1edc53d
PB
213 }
214
81a71734 215 $self = { opts => \%opts };
b1edc53d
PB
216 bless $self, $class;
217}
218
219
220=back
221
222=head1 METHODS
223
224=over 4
225
226=item command ( COMMAND [, ARGUMENTS... ] )
227
d43ba468
PB
228=item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
229
b1edc53d
PB
230Execute the given Git C<COMMAND> (specify it without the 'git-'
231prefix), optionally with the specified extra C<ARGUMENTS>.
232
d43ba468
PB
233The second more elaborate form can be used if you want to further adjust
234the command execution. Currently, only one option is supported:
235
236B<STDERR> - How to deal with the command's error output. By default (C<undef>)
237it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause
238it to be thrown away. If you want to process it, you can get it in a filehandle
239you specify, but you must be extremely careful; if the error output is not
240very short and you want to read it in the same process as where you called
241C<command()>, you are set up for a nice deadlock!
242
b1edc53d
PB
243The method can be called without any instance or on a specified Git repository
244(in that case the command will be run in the repository context).
245
246In scalar context, it returns all the command output in a single string
247(verbatim).
248
249In array context, it returns an array containing lines printed to the
250command's stdout (without trailing newlines).
251
252In both cases, the command's stdin and stderr are the same as the caller's.
253
254=cut
255
256sub command {
d79850e1 257 my ($fh, $ctx) = command_output_pipe(@_);
b1edc53d
PB
258
259 if (not defined wantarray) {
8b9150e3
PB
260 # Nothing to pepper the possible exception with.
261 _cmd_close($fh, $ctx);
b1edc53d
PB
262
263 } elsif (not wantarray) {
264 local $/;
265 my $text = <$fh>;
8b9150e3
PB
266 try {
267 _cmd_close($fh, $ctx);
268 } catch Git::Error::Command with {
269 # Pepper with the output:
270 my $E = shift;
271 $E->{'-outputref'} = \$text;
272 throw $E;
273 };
b1edc53d
PB
274 return $text;
275
276 } else {
277 my @lines = <$fh>;
67e4baf8 278 defined and chomp for @lines;
8b9150e3
PB
279 try {
280 _cmd_close($fh, $ctx);
281 } catch Git::Error::Command with {
282 my $E = shift;
283 $E->{'-outputref'} = \@lines;
284 throw $E;
285 };
b1edc53d
PB
286 return @lines;
287 }
288}
289
290
291=item command_oneline ( COMMAND [, ARGUMENTS... ] )
292
d43ba468
PB
293=item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
294
b1edc53d
PB
295Execute the given C<COMMAND> in the same way as command()
296does but always return a scalar string containing the first line
297of the command's standard output.
298
299=cut
300
301sub command_oneline {
d79850e1 302 my ($fh, $ctx) = command_output_pipe(@_);
b1edc53d
PB
303
304 my $line = <$fh>;
d5c7721d 305 defined $line and chomp $line;
8b9150e3
PB
306 try {
307 _cmd_close($fh, $ctx);
308 } catch Git::Error::Command with {
309 # Pepper with the output:
310 my $E = shift;
311 $E->{'-outputref'} = \$line;
312 throw $E;
313 };
b1edc53d
PB
314 return $line;
315}
316
317
d79850e1 318=item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
b1edc53d 319
d43ba468
PB
320=item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
321
b1edc53d
PB
322Execute the given C<COMMAND> in the same way as command()
323does but return a pipe filehandle from which the command output can be
324read.
325
d79850e1
PB
326The function can return C<($pipe, $ctx)> in array context.
327See C<command_close_pipe()> for details.
328
b1edc53d
PB
329=cut
330
d79850e1
PB
331sub command_output_pipe {
332 _command_common_pipe('-|', @_);
333}
b1edc53d 334
b1edc53d 335
d79850e1
PB
336=item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
337
d43ba468
PB
338=item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
339
d79850e1
PB
340Execute the given C<COMMAND> in the same way as command_output_pipe()
341does but return an input pipe filehandle instead; the command output
342is not captured.
343
344The function can return C<($pipe, $ctx)> in array context.
345See C<command_close_pipe()> for details.
346
347=cut
348
349sub command_input_pipe {
350 _command_common_pipe('|-', @_);
8b9150e3
PB
351}
352
353
354=item command_close_pipe ( PIPE [, CTX ] )
355
d79850e1 356Close the C<PIPE> as returned from C<command_*_pipe()>, checking
3dff5379 357whether the command finished successfully. The optional C<CTX> argument
8b9150e3 358is required if you want to see the command name in the error message,
d79850e1 359and it is the second value returned by C<command_*_pipe()> when
8b9150e3
PB
360called in array context. The call idiom is:
361
d79850e1
PB
362 my ($fh, $ctx) = $r->command_output_pipe('status');
363 while (<$fh>) { ... }
364 $r->command_close_pipe($fh, $ctx);
8b9150e3
PB
365
366Note that you should not rely on whatever actually is in C<CTX>;
367currently it is simply the command name but in future the context might
368have more complicated structure.
369
370=cut
371
372sub command_close_pipe {
373 my ($self, $fh, $ctx) = _maybe_self(@_);
374 $ctx ||= '<unknown>';
375 _cmd_close($fh, $ctx);
b1edc53d
PB
376}
377
378
379=item command_noisy ( COMMAND [, ARGUMENTS... ] )
380
381Execute the given C<COMMAND> in the same way as command() does but do not
382capture the command output - the standard output is not redirected and goes
383to the standard output of the caller application.
384
385While the method is called command_noisy(), you might want to as well use
386it for the most silent Git commands which you know will never pollute your
387stdout but you want to avoid the overhead of the pipe setup when calling them.
388
389The function returns only after the command has finished running.
390
391=cut
392
393sub command_noisy {
394 my ($self, $cmd, @args) = _maybe_self(@_);
d79850e1 395 _check_valid_cmd($cmd);
b1edc53d
PB
396
397 my $pid = fork;
398 if (not defined $pid) {
97b16c06 399 throw Error::Simple("fork failed: $!");
b1edc53d
PB
400 } elsif ($pid == 0) {
401 _cmd_exec($self, $cmd, @args);
402 }
8b9150e3
PB
403 if (waitpid($pid, 0) > 0 and $?>>8 != 0) {
404 throw Git::Error::Command(join(' ', $cmd, @args), $? >> 8);
b1edc53d
PB
405 }
406}
407
408
63df97ae
PB
409=item version ()
410
411Return the Git version in use.
412
63df97ae
PB
413=cut
414
18b0fc1c
PB
415sub version {
416 my $verstr = command_oneline('--version');
417 $verstr =~ s/^git version //;
418 $verstr;
419}
63df97ae
PB
420
421
eca1f6fd
PB
422=item exec_path ()
423
d5c7721d 424Return path to the Git sub-command executables (the same as
eca1f6fd
PB
425C<git --exec-path>). Useful mostly only internally.
426
eca1f6fd
PB
427=cut
428
18b0fc1c 429sub exec_path { command_oneline('--exec-path') }
eca1f6fd
PB
430
431
d5c7721d
PB
432=item repo_path ()
433
434Return path to the git repository. Must be called on a repository instance.
435
436=cut
437
438sub repo_path { $_[0]->{opts}->{Repository} }
439
440
441=item wc_path ()
442
443Return path to the working copy. Must be called on a repository instance.
444
445=cut
446
447sub wc_path { $_[0]->{opts}->{WorkingCopy} }
448
449
450=item wc_subdir ()
451
452Return path to the subdirectory inside of a working copy. Must be called
453on a repository instance.
454
455=cut
456
457sub wc_subdir { $_[0]->{opts}->{WorkingSubdir} ||= '' }
458
459
460=item wc_chdir ( SUBDIR )
461
462Change the working copy subdirectory to work within. The C<SUBDIR> is
463relative to the working copy root directory (not the current subdirectory).
464Must be called on a repository instance attached to a working copy
465and the directory must exist.
466
467=cut
468
469sub wc_chdir {
470 my ($self, $subdir) = @_;
d5c7721d
PB
471 $self->wc_path()
472 or throw Error::Simple("bare repository");
473
474 -d $self->wc_path().'/'.$subdir
475 or throw Error::Simple("subdir not found: $!");
476 # Of course we will not "hold" the subdirectory so anyone
477 # can delete it now and we will never know. But at least we tried.
478
479 $self->{opts}->{WorkingSubdir} = $subdir;
480}
481
482
dc2613de
PB
483=item config ( VARIABLE )
484
e0d10e1c 485Retrieve the configuration C<VARIABLE> in the same manner as C<config>
dc2613de
PB
486does. In scalar context requires the variable to be set only one time
487(exception is thrown otherwise), in array context returns allows the
488variable to be set multiple times and returns all the values.
489
490Must be called on a repository instance.
491
e0d10e1c 492This currently wraps command('config') so it is not so fast.
dc2613de
PB
493
494=cut
495
496sub config {
497 my ($self, $var) = @_;
498 $self->repo_path()
499 or throw Error::Simple("not a repository");
500
501 try {
502 if (wantarray) {
e0d10e1c 503 return $self->command('config', '--get-all', $var);
dc2613de 504 } else {
e0d10e1c 505 return $self->command_oneline('config', '--get', $var);
dc2613de
PB
506 }
507 } catch Git::Error::Command with {
508 my $E = shift;
509 if ($E->value() == 1) {
510 # Key not found.
511 return undef;
512 } else {
513 throw $E;
514 }
515 };
516}
517
518
c7a30e56
PB
519=item ident ( TYPE | IDENTSTR )
520
521=item ident_person ( TYPE | IDENTSTR | IDENTARRAY )
522
523This suite of functions retrieves and parses ident information, as stored
524in the commit and tag objects or produced by C<var GIT_type_IDENT> (thus
525C<TYPE> can be either I<author> or I<committer>; case is insignificant).
526
527The C<ident> method retrieves the ident information from C<git-var>
528and either returns it as a scalar string or as an array with the fields parsed.
529Alternatively, it can take a prepared ident string (e.g. from the commit
530object) and just parse it.
531
532C<ident_person> returns the person part of the ident - name and email;
533it can take the same arguments as C<ident> or the array returned by C<ident>.
534
535The synopsis is like:
536
537 my ($name, $email, $time_tz) = ident('author');
538 "$name <$email>" eq ident_person('author');
539 "$name <$email>" eq ident_person($name);
540 $time_tz =~ /^\d+ [+-]\d{4}$/;
541
542Both methods must be called on a repository instance.
543
544=cut
545
546sub ident {
547 my ($self, $type) = @_;
548 my $identstr;
549 if (lc $type eq lc 'committer' or lc $type eq lc 'author') {
550 $identstr = $self->command_oneline('var', 'GIT_'.uc($type).'_IDENT');
551 } else {
552 $identstr = $type;
553 }
554 if (wantarray) {
555 return $identstr =~ /^(.*) <(.*)> (\d+ [+-]\d{4})$/;
556 } else {
557 return $identstr;
558 }
559}
560
561sub ident_person {
562 my ($self, @ident) = @_;
563 $#ident == 0 and @ident = $self->ident($ident[0]);
564 return "$ident[0] <$ident[1]>";
565}
566
567
24c4b714 568=item hash_object ( TYPE, FILENAME )
b1edc53d 569
b1edc53d 570Compute the SHA1 object id of the given C<FILENAME> (or data waiting in
24c4b714
PB
571C<FILEHANDLE>) considering it is of the C<TYPE> object type (C<blob>,
572C<commit>, C<tree>).
b1edc53d 573
b1edc53d
PB
574The method can be called without any instance or on a specified Git repository,
575it makes zero difference.
576
577The function returns the SHA1 hash.
578
b1edc53d
PB
579=cut
580
18b0fc1c 581# TODO: Support for passing FILEHANDLE instead of FILENAME
e6634ac9
PB
582sub hash_object {
583 my ($self, $type, $file) = _maybe_self(@_);
18b0fc1c 584 command_oneline('hash-object', '-t', $type, $file);
e6634ac9 585}
b1edc53d
PB
586
587
8b9150e3 588
b1edc53d
PB
589=back
590
97b16c06 591=head1 ERROR HANDLING
b1edc53d 592
97b16c06 593All functions are supposed to throw Perl exceptions in case of errors.
8b9150e3
PB
594See the L<Error> module on how to catch those. Most exceptions are mere
595L<Error::Simple> instances.
596
597However, the C<command()>, C<command_oneline()> and C<command_noisy()>
598functions suite can throw C<Git::Error::Command> exceptions as well: those are
599thrown when the external command returns an error code and contain the error
600code as well as access to the captured command's output. The exception class
601provides the usual C<stringify> and C<value> (command's exit code) methods and
602in addition also a C<cmd_output> method that returns either an array or a
603string with the captured command output (depending on the original function
604call context; C<command_noisy()> returns C<undef>) and $<cmdline> which
605returns the command and its arguments (but without proper quoting).
606
d79850e1 607Note that the C<command_*_pipe()> functions cannot throw this exception since
8b9150e3
PB
608it has no idea whether the command failed or not. You will only find out
609at the time you C<close> the pipe; if you want to have that automated,
610use C<command_close_pipe()>, which can throw the exception.
611
612=cut
613
614{
615 package Git::Error::Command;
616
617 @Git::Error::Command::ISA = qw(Error);
618
619 sub new {
620 my $self = shift;
621 my $cmdline = '' . shift;
622 my $value = 0 + shift;
623 my $outputref = shift;
624 my(@args) = ();
625
626 local $Error::Depth = $Error::Depth + 1;
627
628 push(@args, '-cmdline', $cmdline);
629 push(@args, '-value', $value);
630 push(@args, '-outputref', $outputref);
631
632 $self->SUPER::new(-text => 'command returned error', @args);
633 }
634
635 sub stringify {
636 my $self = shift;
637 my $text = $self->SUPER::stringify;
638 $self->cmdline() . ': ' . $text . ': ' . $self->value() . "\n";
639 }
640
641 sub cmdline {
642 my $self = shift;
643 $self->{'-cmdline'};
644 }
645
646 sub cmd_output {
647 my $self = shift;
648 my $ref = $self->{'-outputref'};
649 defined $ref or undef;
650 if (ref $ref eq 'ARRAY') {
651 return @$ref;
652 } else { # SCALAR
653 return $$ref;
654 }
655 }
656}
657
658=over 4
659
660=item git_cmd_try { CODE } ERRMSG
661
662This magical statement will automatically catch any C<Git::Error::Command>
663exceptions thrown by C<CODE> and make your program die with C<ERRMSG>
664on its lips; the message will have %s substituted for the command line
665and %d for the exit status. This statement is useful mostly for producing
666more user-friendly error messages.
667
668In case of no exception caught the statement returns C<CODE>'s return value.
669
670Note that this is the only auto-exported function.
671
672=cut
673
674sub git_cmd_try(&$) {
675 my ($code, $errmsg) = @_;
676 my @result;
677 my $err;
678 my $array = wantarray;
679 try {
680 if ($array) {
681 @result = &$code;
682 } else {
683 $result[0] = &$code;
684 }
685 } catch Git::Error::Command with {
686 my $E = shift;
687 $err = $errmsg;
688 $err =~ s/\%s/$E->cmdline()/ge;
689 $err =~ s/\%d/$E->value()/ge;
690 # We can't croak here since Error.pm would mangle
691 # that to Error::Simple.
692 };
693 $err and croak $err;
694 return $array ? @result : $result[0];
695}
696
697
698=back
b1edc53d
PB
699
700=head1 COPYRIGHT
701
702Copyright 2006 by Petr Baudis E<lt>pasky@suse.czE<gt>.
703
704This module is free software; it may be used, copied, modified
705and distributed under the terms of the GNU General Public Licence,
706either version 2, or (at your option) any later version.
707
708=cut
709
710
711# Take raw method argument list and return ($obj, @args) in case
712# the method was called upon an instance and (undef, @args) if
713# it was called directly.
714sub _maybe_self {
715 # This breaks inheritance. Oh well.
716 ref $_[0] eq 'Git' ? @_ : (undef, @_);
717}
718
d79850e1
PB
719# Check if the command id is something reasonable.
720sub _check_valid_cmd {
721 my ($cmd) = @_;
722 $cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error::Simple("bad command: $cmd");
723}
724
725# Common backend for the pipe creators.
726sub _command_common_pipe {
727 my $direction = shift;
d43ba468
PB
728 my ($self, @p) = _maybe_self(@_);
729 my (%opts, $cmd, @args);
730 if (ref $p[0]) {
731 ($cmd, @args) = @{shift @p};
732 %opts = ref $p[0] ? %{$p[0]} : @p;
733 } else {
734 ($cmd, @args) = @p;
735 }
d79850e1
PB
736 _check_valid_cmd($cmd);
737
a6065b54 738 my $fh;
d3b1785f 739 if ($^O eq 'MSWin32') {
a6065b54
PB
740 # ActiveState Perl
741 #defined $opts{STDERR} and
742 # warn 'ignoring STDERR option - running w/ ActiveState';
743 $direction eq '-|' or
744 die 'input pipe for ActiveState not implemented';
bed118d6
AR
745 # the strange construction with *ACPIPE is just to
746 # explain the tie below that we want to bind to
747 # a handle class, not scalar. It is not known if
748 # it is something specific to ActiveState Perl or
749 # just a Perl quirk.
750 tie (*ACPIPE, 'Git::activestate_pipe', $cmd, @args);
751 $fh = *ACPIPE;
a6065b54
PB
752
753 } else {
754 my $pid = open($fh, $direction);
755 if (not defined $pid) {
756 throw Error::Simple("open failed: $!");
757 } elsif ($pid == 0) {
758 if (defined $opts{STDERR}) {
759 close STDERR;
760 }
761 if ($opts{STDERR}) {
762 open (STDERR, '>&', $opts{STDERR})
763 or die "dup failed: $!";
764 }
765 _cmd_exec($self, $cmd, @args);
d43ba468 766 }
d79850e1
PB
767 }
768 return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh;
769}
770
b1edc53d
PB
771# When already in the subprocess, set up the appropriate state
772# for the given repository and execute the git command.
773sub _cmd_exec {
774 my ($self, @args) = @_;
775 if ($self) {
d5c7721d
PB
776 $self->repo_path() and $ENV{'GIT_DIR'} = $self->repo_path();
777 $self->wc_path() and chdir($self->wc_path());
778 $self->wc_subdir() and chdir($self->wc_subdir());
b1edc53d 779 }
97b16c06
PB
780 _execv_git_cmd(@args);
781 die "exec failed: $!";
b1edc53d
PB
782}
783
8062f81c
PB
784# Execute the given Git command ($_[0]) with arguments ($_[1..])
785# by searching for it at proper places.
18b0fc1c 786sub _execv_git_cmd { exec('git', @_); }
8062f81c 787
b1edc53d
PB
788# Close pipe to a subprocess.
789sub _cmd_close {
8b9150e3 790 my ($fh, $ctx) = @_;
b1edc53d
PB
791 if (not close $fh) {
792 if ($!) {
793 # It's just close, no point in fatalities
794 carp "error closing pipe: $!";
795 } elsif ($? >> 8) {
8b9150e3
PB
796 # The caller should pepper this.
797 throw Git::Error::Command($ctx, $? >> 8);
b1edc53d
PB
798 }
799 # else we might e.g. closed a live stream; the command
800 # dying of SIGPIPE would drive us here.
801 }
802}
803
804
b1edc53d
PB
805sub DESTROY { }
806
807
a6065b54
PB
808# Pipe implementation for ActiveState Perl.
809
810package Git::activestate_pipe;
811use strict;
812
813sub TIEHANDLE {
814 my ($class, @params) = @_;
815 # FIXME: This is probably horrible idea and the thing will explode
816 # at the moment you give it arguments that require some quoting,
817 # but I have no ActiveState clue... --pasky
d3b1785f
AR
818 # Let's just hope ActiveState Perl does at least the quoting
819 # correctly.
820 my @data = qx{git @params};
a6065b54
PB
821 bless { i => 0, data => \@data }, $class;
822}
823
824sub READLINE {
825 my $self = shift;
826 if ($self->{i} >= scalar @{$self->{data}}) {
827 return undef;
828 }
829 return $self->{'data'}->[ $self->{i}++ ];
830}
831
832sub CLOSE {
833 my $self = shift;
834 delete $self->{data};
835 delete $self->{i};
836}
837
838sub EOF {
839 my $self = shift;
840 return ($self->{i} >= scalar @{$self->{data}});
841}
842
843
b1edc53d 8441; # Famous last words